Class: Opener::PropertyTagger::CLI

Inherits:
Object
  • Object
show all
Defined in:
lib/opener/property_tagger/cli.rb

Overview

CLI wrapper around Opener::PropertyTagger using OptionParser.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeCLI

Returns a new instance of CLI.



14
15
16
# File 'lib/opener/property_tagger/cli.rb', line 14

def initialize
  @parser = configure_slop
end

Instance Attribute Details

#parserSlop (readonly)

Returns:

  • (Slop)


11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
# File 'lib/opener/property_tagger/cli.rb', line 11

class CLI
  attr_reader :parser

  def initialize
    @parser = configure_slop
  end

  ##
  # @param [Array] argv
  #
  def run(argv = ARGV)
    parser.parse(argv)
  end

  ##
  # @return [Slop]
  #
  def configure_slop
    return Slop.new(:strict => false, :indent => 2, :help => true) do
      banner 'Usage: property-tagger [OPTIONS] -- [PYTHON OPTIONS]'

      separator <<-EOF.chomp

About:

Component for finding the properties in a KAF document. This command reads
input from STDIN.

Examples:

Processing a KAF file:

    cat some_file.kaf | property-tagger

Displaying the underlying kernel options:

    property-tagger -- --help

      EOF

      separator "\nOptions:\n"

      on :v, :version, 'Shows the current version' do
        abort "property-tagger v#{VERSION} on #{RUBY_DESCRIPTION}"
      end

      on :'no-time', 'Disables adding of timestamps'

      on :ugly, 'Disables pretty formatting of XML (faster)'

      run do |opts, args|
        tagger = PropertyTagger.new(
          :args    => args,
          :no_time => opts[:'no-time'],
          :pretty  => !opts[:ugly]
        )

        input  = STDIN.tty? ? nil : STDIN.read

        puts tagger.run(input)
      end
    end
  end
end

Instance Method Details

#configure_slopSlop

Returns:

  • (Slop)


28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
# File 'lib/opener/property_tagger/cli.rb', line 28

def configure_slop
  return Slop.new(:strict => false, :indent => 2, :help => true) do
    banner 'Usage: property-tagger [OPTIONS] -- [PYTHON OPTIONS]'

    separator <<-EOF.chomp

About:

    Component for finding the properties in a KAF document. This command reads
    input from STDIN.

Examples:

    Processing a KAF file:

  cat some_file.kaf | property-tagger

    Displaying the underlying kernel options:

  property-tagger -- --help

    EOF

    separator "\nOptions:\n"

    on :v, :version, 'Shows the current version' do
      abort "property-tagger v#{VERSION} on #{RUBY_DESCRIPTION}"
    end

    on :'no-time', 'Disables adding of timestamps'

    on :ugly, 'Disables pretty formatting of XML (faster)'

    run do |opts, args|
      tagger = PropertyTagger.new(
        :args    => args,
        :no_time => opts[:'no-time'],
        :pretty  => !opts[:ugly]
      )

      input  = STDIN.tty? ? nil : STDIN.read

      puts tagger.run(input)
    end
  end
end

#run(argv = ARGV) ⇒ Object

Parameters:

  • argv (Array) (defaults to: ARGV)


21
22
23
# File 'lib/opener/property_tagger/cli.rb', line 21

def run(argv = ARGV)
  parser.parse(argv)
end