help_parser 1.0.2

data/lib/help_parser/version.rb

@@ -0,0 +1,3 @@
+module HELP_PARSER
+  VERSION = '1.0.2'
+end

data/tasks/gemspecker.rb

@@ -0,0 +1,60 @@
+#!/usr/bin/env ruby
+require 'date'
+
+module Gemspecker
+def self.task
+
+name        = File.basename(Dir.getwd)
+version     = File.read("lib/#{name}/version.rb").match(/\d+\.\d+\.\d+/)[0]
+date        = Date.today.to_s
+author      = `git config user.name`.strip
+email       = `git config user.email`.strip
+            # get the first readme, preferably rdoc.
+readme      = `ls README.rdoc README.txt README* 2> /dev/null`.split.first.strip
+description = File.read(readme).match(/DESCRIPTION:([^=]*)/i)[1].strip
+summary     = description.split(/\n\n/).first
+
+# ./name.gemspec
+File.open("./#{name}.gemspec", 'w') do |gemspec|
+
+### Gem Specification ####
+gemspec.puts <<EOT
+Gem::Specification.new do |s|
+
+  s.name     = '#{name}'
+  s.version  = '#{version}'
+
+  s.homepage = 'https://github.com/#{author.downcase}/#{name}'
+
+  s.author   = '#{author}'
+  s.email    = '#{email}'
+
+  s.date     = '#{date}'
+  s.licenses = ['MIT']
+
+  s.description = <<DESCRIPTION
+#{description}
+DESCRIPTION
+
+  s.summary = <<SUMMARY
+#{summary}
+SUMMARY
+
+  s.extra_rdoc_files = ['#{readme}']
+  s.rdoc_options     = ["--main", "#{readme}"]
+
+  s.require_paths = ["lib"]
+  s.files = %w(
+#{`git ls-files`})
+
+end
+EOT
+
+end
+end
+end
+
+desc "Create/Update gemspec"
+task :gemspecker do
+  Gemspecker.task
+end

data/tasks/manifester.rb

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+require 'date'
+
+module Manifester
+  def self.task
+    system('git ls-files > Manifest.txt')
+  end
+end
+
+desc "Creates/Updates Manifest"
+task :manifester do
+  Manifester.task
+end

data/tasks/syntaxer.rb

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+require 'find'
+require 'open3'
+require 'rainbow'
+
+module Syntaxer
+  def self.task
+    count = 0
+    Find.find('.') do |fn|
+      if fn=~/\.rb$/
+        stdout, stderr, process = Open3.capture3("ruby -c #{fn}")
+        unless process.exitstatus == 0
+          count += 1
+          puts stderr.chomp.color(:red)
+        end
+      end
+    end
+    puts "No syntax errors found.".color(:green) if count == 0
+  end
+end
+
+desc "Checks *.rb's syntax"
+task :syntaxer do
+  Syntaxer.task
+end

data/tasks/unit_tests.rb

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+require 'find'
+
+module UnitTests
+  def self.task
+    count = 0
+    Find.find('./test') do |fn|
+      if fn=~/\.rb$/
+        system("ruby -I ./lib #{fn} --verbose=progress")
+      end
+    end
+  end
+end
+
+desc "Runs unit tests"
+task :'unit-tests' do
+  UnitTests.task
+end

data/test/help_parser.rb

@@ -0,0 +1,250 @@
+require 'test/unit'
+require 'help_parser/help_parser'
+
+class Test_HELP_PARSER_HelpParser < Test::Unit::TestCase
+  include HELP_PARSER
+
+  class Mock
+    include HELP_PARSER::Errors
+    def version
+      'version'
+    end
+    def help
+      'help'
+    end
+  end
+
+  MOCK = Mock.new
+
+  def test_001_usage_error_new
+    assert_raises(UsageError){ raise UsageError, ['message', self] }
+    obj = message = nil
+    begin
+      raise UsageError, ['message', self]
+    rescue Exception
+      message = $!.message
+      obj = $!.obj if $!.respond_to?(:obj)
+    end
+    assert(message = 'message')
+    refute(obj.nil?)
+    assert(obj == self)
+  end
+
+  def test_002_implementation_error_new
+    assert_raises(ImplementationError){ raise ImplementationError, ['message', self] }
+    obj = nil
+    begin
+      raise ImplementationError, ['message', self]
+    rescue Exception
+      message = $!.message
+      obj = $!.obj if $!.respond_to?(:obj)
+    end
+    assert(message = 'message')
+    refute(obj.nil?)
+    assert(obj == self)
+  end
+
+  def test_003_usage_exception_new
+    assert_raises(UsageException){ raise UsageException, ['message', self] }
+    obj = nil
+    begin
+      raise UsageException, ['message', self]
+    rescue Exception
+      message = $!.message
+      obj = $!.obj if $!.respond_to?(:obj)
+    end
+    assert(message = 'message')
+    refute(obj.nil?)
+    assert(obj == self)
+  end
+
+  def test_004_help_exception_new
+    assert_raises(HelpException){ raise HelpException, MOCK }
+    obj = nil
+    begin
+      raise HelpException, MOCK
+    rescue Exception
+      message = $!.message
+      obj = $!.obj if $!.respond_to?(:obj)
+    end
+    assert(message = 'help')
+    refute(obj.nil?)
+    assert(obj == MOCK)
+  end
+
+  def test_005_version_exception_new
+    assert_raises(VersionException){ raise VersionException, MOCK }
+    obj = nil
+    begin
+      raise VersionException, MOCK
+    rescue Exception
+      message = $!.message
+      obj = $!.obj if $!.respond_to?(:obj)
+    end
+    assert(message = 'version')
+    refute(obj.nil?)
+    assert(obj == MOCK)
+  end
+
+  def test_006_usage_exceptions
+    message = error = 'none'
+    begin
+      raise VersionException, MOCK
+    rescue StandardError
+      error = 'standard'
+    rescue Exception
+      error = 'exception'
+      message = $!.message
+    end
+    assert_equal(error, 'exception')
+    assert_equal(message, 'version')
+
+    error = 'none'
+    begin
+      raise HelpException, MOCK
+    rescue StandardError
+      error = 'standard'
+    rescue Exception
+      error = 'exception'
+      message = $!.message
+    end
+    assert_equal(error, 'exception')
+    assert_equal(message, 'help')
+  end
+
+  def test_007_usage_errors
+    message = error = 'none'
+    begin
+      raise UsageError, ['error', MOCK]
+    rescue StandardError
+      message = $!.message
+      error = 'standard'
+    rescue Exception
+      error = 'exception'
+      message = 'wrong'
+    end
+    assert_equal(error, 'standard')
+    assert_equal(message, 'error')
+
+    error = 'none'
+    begin
+      raise ImplementationError, ['error', MOCK]
+    rescue StandardError
+      message = $!.message
+      error = 'standard'
+    rescue Exception
+      error = 'exception'
+      message = 'wrong'
+    end
+    assert_equal(error, 'standard')
+    assert_equal(message, 'error')
+  end
+
+  def test_008_to_value
+    [['1', Integer], ['1.0', Float], ['One', String], ['1,2.0,Three', Array]].each do |string, type|
+      value = HelpParser::Function.to_value(string)
+      assert( value.kind_of?(type) )
+    end
+  end
+
+  def test_009_str2sym
+    assert_equal(HelpParser.str2sym('abcd'), :abcd)
+    assert_equal(HelpParser.str2sym('ab-cd'), :ab_cd)
+    assert_equal(HelpParser.str2sym('ab_cd'), :ab_cd)
+  end
+
+  def test_010_raise_error
+    assert_raises(UsageError){ MOCK.usage_error('usage error') }
+    assert_raises(ImplementationError){ MOCK.implementation_error('implementation error') }
+
+    obj = error = message = 'none'
+    begin
+      MOCK.usage_error('usage error')
+    rescue Exception
+      error = $!.class
+      message = $!.message
+      obj = $!.obj if $!.respond_to?(:obj)
+    end
+    assert_equal(error,   UsageError)
+    assert_equal(message, 'usage error')
+    assert_equal(obj,     MOCK)
+
+    obj = error = message = 'none'
+    begin
+      MOCK.implementation_error('implementation error')
+    rescue Exception
+      error = $!.class
+      message = $!.message
+      obj = $!.obj if $!.respond_to?(:obj)
+    end
+    assert_equal(error,   ImplementationError)
+    assert_equal(message, 'implementation error')
+    assert_equal(obj,     MOCK)
+  end
+
+  def test_011_parse
+    argv = [
+      '-a', '-bcd', '--e', '--fgh',
+      '--i=z', '--jklm=y', '--nop=1', '--q=2.0', '--r=1,2.0,Three',
+      '--no-st'
+    ]
+
+    options = {}
+    parsed = HelpParser.parse(argv, MOCK){|key, value| options[key]=value}
+
+    assert_equal  options['a'],    true
+    assert_equal  options['b'],    true
+    assert_equal  options['c'],    true
+    assert_equal  options['d'],    true
+    assert_equal  options['e'],    true
+    assert_equal  options['fgh'],  true
+
+    assert_equal  options['i'],    'z'
+    assert_equal  options['jklm'], 'y'
+    assert_equal  options['nop'],   1
+    assert_equal  options['q'],     2.0
+    assert_equal  options['r'],    [1,2.0,'Three']
+
+    assert_equal  options['st'],   false
+
+    refute    options.has_key?('bcd')
+    refute    options.has_key?('f')
+    refute    options.has_key?('g')
+    refute    options.has_key?('h')
+    refute    options.has_key?('no-st')
+    refute    options.has_key?('no_st')
+
+    assert_raises(UsageError){ HelpParser.parse(['--no-key=true'], MOCK){ } }
+    assert_nothing_raised(UsageError){ HelpParser.parse(['--no-key'], MOCK){ } }
+  end
+
+  # HelpParser#new, HelpParser#[], and HelpParser#defaults
+  # are mostly tested via cucumber.
+  # I'm just going to do some quick tests.
+
+  def test_012_new
+    argv = [
+      '-a', '-bcd', '--e', '--fgh',
+      '--i=z', '--jklm=y', '--nop=1', '--q=2.0', '--r=1,2.0,Three',
+    ]
+    help = "-a\n-b\n-c\n-d\n-e\n--fgh\n-i\n--jklm\n--nop\n--q\n--r"
+    assert_nothing_raised{ HelpParser.new(argv,   '0.1.0', help) }
+    assert_nothing_raised{ HelpParser.new('0.0.0', argv,   help) }
+    assert_nothing_raised{ HelpParser.new('0.1.0', help,   argv) }
+  end
+
+  def test_013_defaults
+    options = HelpParser.new('0', '--var', [''])
+    options.defaults!(:var, 'A', 'B')
+    assert_equal( options[:var], 'A' )
+
+    options = HelpParser.new('0', '--var', ['--var'])
+    options.defaults!(:var, 'A', 'B')
+    assert_equal( options[:var], 'B' )
+
+    options = HelpParser.new('0', '--var', ['--var=C'])
+    options.defaults!(:var, 'A', 'B')
+    assert_equal( options[:var], 'C' )
+  end
+ 
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: help_parser
+version: !ruby/object:Gem::Version
+  version: 1.0.2
+platform: ruby
+authors:
+- CarlosJHR64
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-13 00:00:00.000000000 Z
+dependencies: []
+description: |
+  _HelpParser_ - Parses your help text to define your command line options.
+email: carlosjhr64@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+files:
+- 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
+homepage: https://github.com/carlosjhr64/help_parser
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--main"
+- README.rdoc
+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.0.3
+signing_key: 
+specification_version: 4
+summary: _HelpParser_ - Parses your help text to define your command line options.
+test_files: []