help_parser 1.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9580ecb3144e3be88b6961efc2e1edae53964c01
+  data.tar.gz: 8924fbd437d234ab59ce1f1bc319be6f9287b93d
+SHA512:
+  metadata.gz: d4f0bc72cefd932f76302436d2f898267169a7fc847af683d225333d8d2a7423e9919266b69e03e3168604b6683c4ee1fedbd930d90c837b914f6a601203dac3
+  data.tar.gz: e0af58d61f6825f2e72615a3fafc352a3f8b7296b5cfa0f559e3ed5092eaaf8ac9fc2b9306146e292200e9fd77281d2dd0e6595f2d582635b23e9a3f3064e75b

data/History.txt

@@ -0,0 +1 @@
+=== 0.0.0 / 2013-12-04

data/Manifest.txt

@@ -0,0 +1,23 @@
+History.txt
+Manifest.txt
+README.rdoc
+Rakefile
+TODO.txt
+examples/command_suite
+examples/implementation_error_duplicate_key
+examples/implementation_error_redefinition
+examples/implementation_error_terminal
+examples/simple
+features/edge.feature
+features/simple.feature
+features/step_definitions/help_parser_steps.rb
+features/suite.feature
+help_parser.gemspec
+lib/help_parser.rb
+lib/help_parser/help_parser.rb
+lib/help_parser/version.rb
+tasks/gemspecker.rb
+tasks/manifester.rb
+tasks/syntaxer.rb
+tasks/unit_tests.rb
+test/help_parser.rb

data/README.rdoc

@@ -0,0 +1,72 @@
+= HelpParser
+
+github :: https://www.github.com/carlosjhr64/help_parser
+rubygems :: https://rubygems.org/gems/help_parser
+
+== DESCRIPTION:
+
+_HelpParser_ - Parses your help text to define your command line options.
+
+== FEATURES/PROBLEMS:
+
+* long to short option mapping
+* --no-lopt sets lopt to false
+
+== SYNOPSIS:
+
+  require 'help_parser'
+  include HELP_PARSER
+  HELP = <<HELP
+  Usage:
+    mycmdapp [options] command
+  Options:
+    -h --help      Show this help and exit
+    -v --version   Show the version and exit
+    -q --quiet     Be quiet
+    -V --verbose   Say more about whats going on
+  HELP
+  begin
+    OPTIONS = HelpParser.new('1.0.0', HELP)
+    puts "Tracing..." unless OPTIONS[:quiet]
+    puts "More tracing..." if OPTIONS[:V] # verbose
+    # mycmdapp code continues...
+    # ...
+  rescue UsageException
+    puts $!.message # User just wants help or version
+    exit 0  # Not an error
+  rescue UsageError
+    STDERR.puts '*** '+$!.message+' ***'
+    STDERR.puts $!.obj.help
+    exit 64 # Usage error exit code
+  end
+
+See `examples/command_suite` for an example of how to build a command suite with _HelpParser_.
+
+== INSTALL:
+
+  $ sudo gem install help_parser
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2013 CarlosJHR64
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,94 @@
+require 'find'
+
+module RakingTasks
+  def RakingTasks.git_tag_list
+    `git tag --list`.strip.split("\n")
+  end
+
+  def RakingTasks.git_status_porcelain
+    `git status --porcelain`.strip
+  end
+
+  def RakingTasks.gemspec_files
+    `ls ./*.gemspec 2> /dev/null`.strip.split("\n")
+  end
+
+  def RakingTasks.uniq_gemspec_file
+    gemspecs = RakingTasks.gemspec_files
+    raise "Gemspec file not found" if gemspecs.length == 0
+    raise "Mutiple gemspec files found" if gemspecs.length > 1
+    gemspecs.first
+  end
+
+  def RakingTasks.pkg_gem_files
+    `ls ./pkg/*.gem 2> /dev/null`.strip.split("\n")
+  end
+
+  def RakingTasks.gem_files
+    `ls ./*.gem 2> /dev/null`.strip.split("\n")
+  end
+
+  def RakingTasks.uniq_gem_file
+    gems = RakingTasks.gem_files
+    raise "Gem file not found" if gems.length == 0
+    raise "Multiple gem files found" if gems.length > 1
+    gems.first
+  end
+
+  def RakingTasks.gem_build
+    raise "Git status not clear" unless RakingTasks.git_status_porcelain.length == 0
+    gems = RakingTasks.gem_files
+    raise "Found gem files: #{gems.join(',')}" unless gems.length == 0
+    gemspec = RakingTasks.uniq_gemspec_file
+    system("gem build #{gemspec}")
+  end
+
+  def RakingTasks.load_existing_tasks
+    if Dir.exist?('./tasks')
+      Find.find('./tasks') do |fn|
+        require fn if fn=~/\.rb/
+      end
+    end
+  end
+end
+RakingTasks.load_existing_tasks
+
+desc 'By default, run git status'
+task :default do
+  system('git status')
+end
+
+desc 'Cucumbers tests'
+task :cucumber do
+  system('cucumber -f progress')
+end
+
+desc 'Runs all tests'
+task :'test-all' => [:syntaxer, :'unit-tests', :cucumber]
+
+desc 'Builds pre-release gem for testing, not published.'
+task :gem_build do
+  RakingTasks.gem_build
+end
+
+desc 'pushes to rubygems and git'
+task :publish, :version do |t, args|
+  version = args[:version]
+  tags = RakingTasks.git_tag_list
+  raise "#{version} in git tag list" if tags.include?(version)
+  RakingTasks.gem_build
+  gem = File.basename RakingTasks.uniq_gem_file
+  raise "#{version} did not match gem file" unless gem.include?(version)
+  pkgem = File.join('pkg', gem)
+  raise "pkg/#{gem} exists!?" if File.exist? pkgem
+  if system("gem push #{gem}")
+    File.rename(gem, pkgem)
+    File.open('./History.txt', 'a'){|fh| fh.puts "=== #{version} / #{Time.now}"}
+    File.open('./History.txt', 'a'){|fh| fh.puts `md5sum #{pkgem}`}
+    system("git commit -m '#{version}' ./History.txt")
+    system("git tag '#{version}'")
+    system('git push')
+  else
+    File.unlink(gem)
+  end
+end

data/examples/command_suite

@@ -0,0 +1,130 @@
+#!/usr/bin/env ruby
+require 'json'
+require 'rainbow'
+
+############################################################
+# Here I show how one might structure a command suite
+# using HelpParser.  The output is for cucumber testing.
+############################################################
+
+VERSION = '10.02.3'
+NAME = File.basename($PROGRAM_NAME) # command_suite
+GLOBAL_HELP = <<GLOBAL_HELP
+This is a test script for HelpParser.
+
+Usage:
+
+  #{NAME} [global options] command [command options] [arguments...]
+
+Global Options:
+
+  -h --help      Show this help and exit
+  -v --version   Show the version and exit
+  -q --quiet     Be quiet
+  -V --verbose   Say more about whats going on
+
+  --string=STRING      A String value
+  --float=FLOAT        A Float value
+  --integer=INTEGER    An Integer value
+  --array=val1,val2... An Array of values
+
+Commands:
+
+  first    The first command
+  second   The second command
+
+This script is being runned by Ruby #{RUBY_VERSION}.
+GLOBAL_HELP
+
+FIRST_HELP = <<FIRST
+#{NAME}-first is the first command of the test script for HelpParser.
+Usage: #{NAME} [global options] first [options]
+Options:
+  -h --help             Show this help and exit
+  --string=STRING      A String value
+  --float=FLOAT        A Float value
+  --integer=INTEGER    An Integer value
+  --array=val1,val2... An Array of values
+FIRST
+
+SECOND_HELP = <<SECOND
+#{NAME}-second is the second command of the test script for HelpParser.
+Usage: #{NAME} [global options] second [options]
+Options:
+  -h --help             Show this help and exit
+  --string=STRING      A String value
+  --float=FLOAT        A Float value
+  --integer=INTEGER    An Integer value
+  --array=val1,val2... An Array of values
+SECOND
+
+begin
+  $LOAD_PATH << File.expand_path(File.dirname(__FILE__) + '/../lib')
+  require 'help_parser'
+  include HELP_PARSER
+
+  GLOBAL_OPTIONS = HelpParser.new(VERSION, GLOBAL_HELP)
+
+  STRING  = GLOBAL_OPTIONS[:string,  'string1', 'string2']
+  FLOAT   = GLOBAL_OPTIONS[:float,   1.0,        2.0]
+  INTEGER = GLOBAL_OPTIONS[:integer, 1,          2]
+  ARRAY   = GLOBAL_OPTIONS[:array,   [],        [1,'two',3.0]]
+
+  GLOBAL_OPTIONS.usage_error "Need command." if ARGV.empty?
+  COMMAND = ARGV.shift
+  # I see suites this way:
+  #   system("command #{ARGV.join(' ')}")
+  # but...
+  case COMMAND
+  when 'first'
+    # Just going to reuse VERSION, although
+    # the comand could have it's own version number.
+    OPTIONS = HelpParser.new(VERSION, FIRST_HELP)
+    # CONST  = OPTIONS[key,     missing_key, missing_value]
+    CSTRING  = OPTIONS[:string,  'string1', 'string2']
+    CFLOAT   = OPTIONS[:float,   1.0,        2.0]
+    CINTEGER = OPTIONS[:integer, 1,          2]
+    CARRAY   = OPTIONS[:array,   [],        [1,'two',3.0]]
+  when 'second'
+    OPTIONS = HelpParser.new(VERSION, SECOND_HELP)
+    CSTRING  = OPTIONS[:string,  'string1', 'string2']
+    CFLOAT   = OPTIONS[:float,   1.0,        2.0]
+    CINTEGER = OPTIONS[:integer, 1,          2]
+    CARRAY   = OPTIONS[:array,   [],        [1,'two',3.0]]
+  else
+    GLOBAL_OPTIONS.usage_error "Unrecognized command #{COMMAND}."
+  end
+
+  OUTPUT = {
+    :exception => '',
+    :message=> '',
+    :command => COMMAND,
+    :options => OPTIONS,
+    :global_options => GLOBAL_OPTIONS,
+    # Constants from Global
+    :string  => STRING,
+    :float   => FLOAT,
+    :integer => INTEGER,
+    :array   => ARRAY,
+    # Constants from Command
+    :cstring  => CSTRING,
+    :cfloat   => CFLOAT,
+    :cinteger => CINTEGER,
+    :carray   => CARRAY,
+  }
+
+rescue Exception
+  STDERR.puts $!.message.chomp.color(:blue)
+  STDERR.puts $!.backtrace.join("\n").color(:red)
+  OUTPUT = {
+    :exception => $!.class.to_s,
+    :message=> $!.message,
+    # These below might be undefined:
+    :command => (COMMAND||=''),
+    :global_options => (GLOBAL_OPTIONS||={}),
+    :command_options => (OPTIONS||={}),
+    :options => ($!.respond_to?(:obj))? $!.obj : {},
+  }
+end
+
+puts JSON.pretty_generate OUTPUT

data/examples/implementation_error_duplicate_key

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+# This is used by cucumber for testing.
+# It has a bad help text.
+require 'json'
+require 'rainbow'
+$LOAD_PATH << File.expand_path(File.dirname(__FILE__) + '/../lib')
+require 'help_parser'
+include HELP_PARSER
+HELP = <<HELP
+Usage:
+  simple [options] arguments...
+Options:
+  -z --zebra
+  -a --zebra
+HELP
+output = {
+  :exception => '',
+  :message => '',
+}
+begin
+  OPTIONS = HelpParser.new('1.2.3', HELP)
+rescue Exception
+  STDERR.puts $!.obj.help.chomp.color(:blue)
+  STDERR.puts $!.message.chomp.color(:red)
+  output = {
+    :exception => $!.class.to_s,
+    :message => $!.message,
+  }
+end
+puts JSON.pretty_generate output

data/examples/implementation_error_redefinition

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# This is used by cucumber for testing.
+# It has a bad help text.
+require 'json'
+require 'rainbow'
+$LOAD_PATH << File.expand_path(File.dirname(__FILE__) + '/../lib')
+require 'help_parser'
+include HELP_PARSER
+HELP = <<HELP
+Usage:
+  simple [options] arguments...
+Options:
+  -z --help
+HELP
+output = {
+  :exception => '',
+  :message => '',
+}
+begin
+  OPTIONS = HelpParser.new('1.2.3', HELP)
+rescue Exception
+  STDERR.puts $!.obj.help.chop.color(:blue)
+  STDERR.puts $!.message.chomp.color(:red)
+  output = {
+    :exception => $!.class.to_s,
+    :message => $!.message,
+  }
+end
+puts JSON.pretty_generate output

data/examples/implementation_error_terminal

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+# This is used by cucumber for testing.
+# It has a bad help text.
+require 'json'
+require 'rainbow'
+$LOAD_PATH << File.expand_path(File.dirname(__FILE__) + '/../lib')
+require 'help_parser'
+include HELP_PARSER
+HELP = <<HELP
+Usage:
+  simple [options] arguments...
+Options:
+  -a --aaa
+  -b --a
+HELP
+output = {
+  :exception => '',
+  :message => '',
+}
+begin
+  OPTIONS = HelpParser.new('1.2.3', HELP)
+rescue Exception
+  STDERR.puts $!.obj.help.chomp.color(:blue)
+  STDERR.puts $!.message.chomp.color(:red)
+  output = {
+    :exception => $!.class.to_s,
+    :message => $!.message,
+  }
+end
+puts JSON.pretty_generate output

data/examples/simple

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# This is used by cucumber for testing.
+require 'json'
+require 'rainbow'
+$LOAD_PATH << File.expand_path(File.dirname(__FILE__) + '/../lib')
+require 'help_parser'
+include HELP_PARSER
+HELP = <<HELP
+Usage:
+  simple [options] arguments...
+Options:
+  -h --help         Help already in dictionary
+                    Missing version in dictionary
+  --nocomment
+  -s --long=VALUE   Full template
+  --V               Single characters can have long format
+  -k                Short option does not need a long option
+HELP
+begin
+  OPTIONS = HelpParser.new('1.2.3', HELP)
+  data = { :exception => '', :message => '', :options => OPTIONS }
+  puts JSON.pretty_generate data
+rescue Exception
+  STDERR.puts $!.message.chomp.color(:blue)
+  STDERR.puts $!.backtrace.join("\n").color(:red)
+  data = { :exception => $!.class, :message => $!.message, :options => $!.obj }
+  data[:options] = ($!.respond_to?(:obj))? $!.obj : {}
+  puts JSON.pretty_generate data
+end