optparsegen 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c224a84b9f8bc19e937d687806e1171f2b8d9c00
+  data.tar.gz: aed0a9eda0f3e95194a4f0e4320dee8d263fe4eb
+SHA512:
+  metadata.gz: 58d646498865d522f5eb80e81c52005cd77cb26469e153b4acebfb690ff4a4f0d3af6ff6a50f6b6c78313ff720794791c67dccd8c5e04172ffb6c0459d09c5b0
+  data.tar.gz: fdc547b174c848784af0c117d4310142c48ef8991b375295273a927c519857b2020377b84f2e9f571ff40286df5064d5cf8ef8e7edc7cf0bb1b8bfea00e0dc24

data/bin/optparsegen

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+require 'optparse'
+require 'optparsegen'
+
+options = Struct.new(:format).new(:scopt)
+
+OptionParser.new do |opts|
+  opts.banner = %Q(Usage: #{File.basename($0)} [options] <file>
+
+optparsegen converts program usage text into equivalent ruby 'optparse'
+code. It reads the text from the filename passed as the only argument
+on the command line or from standard input.
+
+Options:
+)
+
+  opts.on('-f', '--format', '=[FORMAT]', [:scopt], 'Input usage text format. Default: scopt') do |v|
+    options.format = v
+  end
+
+  opts.on_tail('-h', '--help', 'Show this message.') do
+    puts opts
+    exit
+  end
+end.parse!
+
+OptParseGen.generate(ARGF.read, options.format)

data/lib/optparsegen/scopt.rb

@@ -0,0 +1,109 @@
+class OptParseGen::ScoptParser
+  def initialize(input)
+    @tape = input
+    @options = []
+    @current = OptParseGen::Option.new
+  end
+
+  def parse
+    state = :parse_any
+
+    while state != nil
+      lchomp_until!(is_not_space)
+      state = send(state)
+    end
+
+    @options
+  end
+
+  private
+  def is_not_space
+    /[^\s]/
+  end
+  
+  def is_space
+    /\s/
+  end
+
+  def lchomp_until!(matches)
+    p = @tape.index(matches)
+    if p == nil
+      @tape.slice!(-1)
+    else
+      @tape.slice!(0, p)
+    end
+  end
+
+  def parse_any
+    case
+      when @tape.start_with?('-') then
+        @tape.slice!(0, 1)
+        :parse_opt
+      when (p = @tape.index("\n")) != nil then
+        @tape.slice!(0, p)
+        :parse_any
+      else
+        nil
+    end
+  end
+
+  def parse_opt
+    if @tape[0] == '-'
+      @tape.slice!(0)
+      :parse_opt_name
+    else
+      :parse_opt_short
+    end
+  end
+
+  def parse_opt_short
+    short = lchomp_until!(is_space).chop!
+    if short
+      @current.short = short
+      :parse_any
+    else
+      raise 'expected short option name'
+    end
+  end
+
+  def parse_opt_name
+    name = lchomp_until!(is_space)
+    if name
+      @current.name = name
+      :parse_opt_value_or_desc
+    else
+      raise 'expected option name'
+    end
+  end
+
+  def parse_opt_value_or_desc
+    if @tape.start_with?('<')
+      :parse_opt_value
+    else
+      :parse_opt_desc
+    end
+  end
+
+  def parse_opt_value
+    value = lchomp_until!(is_space)
+    if value
+      # TODO: Handle value examples.
+      # @current.value = value
+      :parse_opt_desc
+    else
+      raise 'expected value'
+    end
+  end
+
+  def parse_opt_desc
+    desc = lchomp_until!("\n")
+    if desc
+      @current.description = desc
+      @options.push(@current)
+      @current = OptParseGen::Option.new
+      :parse_any
+    else
+      raise 'expected description'
+    end
+  end
+end

data/lib/optparsegen.rb

@@ -0,0 +1,13 @@
+# The main entry point for OptParseGen.
+class OptParseGen
+  # Represents a single option.
+  Option = Struct.new(:name, :short, :description)
+
+  # Generates 'optparse' code from the given input and format.
+  def self.generate(input, format)
+    require "optparsegen/#{format}"
+    parser = OptParseGen.const_get("#{format.capitalize}Parser").new(input)
+    options = parser.parse
+    puts options
+  end
+end

data/test/test_scopt.rb

@@ -0,0 +1,40 @@
+require 'minitest/autorun'
+require 'optparsegen'
+require 'optparsegen/scopt'
+
+class ScoptParserTest < Minitest::Test
+  def test_basic_parse
+    input = 'Usage: myprogram [options]
+
+  --help                   Shows this usage text.
+  -d, --work-date <value>  Generate data for this date. Default: 2017-01-02
+  -i, --input-dir <value>  Load input data from this directory. Default: hdfs:///path/to/input
+  -o, --output-dir <value>
+                           Output generated data to this directory. Default: hdfs:///path/to/output
+  -x, --extra-jars <jar1>,<jar2>...
+                           Extra jars to include.
+'
+
+    options = parse(input)
+
+    assert_equal(5, options.size)
+    assert_equal('extra-jars help input-dir output-dir work-date', options.map { |o| o.name }.sort.join(' '))
+    assert_equal('Extra jars to include.', options.find { |o| o.name == 'extra-jars' }.description)
+  end
+
+  def test_parse_error
+    input = 'Usage: myprogram [options]
+
+  --help
+'
+    err = assert_raises RuntimeError do
+      parse(input)
+    end
+    assert_equal('expected description', err.message)
+  end
+
+  private
+  def parse(input)
+    OptParseGen::ScoptParser.new(input).parse
+  end
+end

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: optparsegen
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tyler Sommer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-04 00:00:00.000000000 Z
+dependencies: []
+description: 
+email: 
+executables:
+- optparsegen
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/optparsegen
+- lib/optparsegen.rb
+- lib/optparsegen/scopt.rb
+- test/test_scopt.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Generate ruby optparse code from usage text.
+test_files:
+- test/test_scopt.rb