argparser 1.0.0 → 1.0.1

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+rvm:
+  - "1.8.7"
+  - "1.9.3"
+  - "2.0.0"
+  - "2.1" # latest 2.1.x
+  - "2.2" # latest 2.2.x
+  - "jruby-18mode"
+  - "jruby-19mode"
+script:
+  CODECLIMATE_REPO_TOKEN=3a1b48c656a57cdd02824699a1352f8a0648e9b41f3df18323b8c48bab22b5ce bundle exec rake test
+branches:
+  - "master"

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+gemspec
+gem 'codeclimate-test-reporter',  :group      => :development,
+                                  :require    => nil,
+                                  :platforms  => [:ruby_20]

data/HISTORY.md

@@ -0,0 +1,10 @@
+# 1.0.1
+2015-04-14
+
+* Some minor fixes and refactorings
+* MRI-1.8, jruby-1.8-mode support
+
+# 1.0.0
+2015-04-03
+
+* First public release

data/README.md

@@ -1,8 +1,10 @@
 # argparser
-Command line argument parser library, trying to follow POSIX and GNU guidelines.
+Yet another ruby command line argument parser library.
+
+[![Build Status](https://travis-ci.org/sinm/argparser.svg?branch=master)](https://travis-ci.org/sinm/argparser) [![Gem Version](https://badge.fury.io/rb/argparser.svg)](http://badge.fury.io/rb/argparser) [![Dependency Status](https://gemnasium.com/sinm/argparser.svg)](https://gemnasium.com/sinm/argparser) [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/sinm/argparser/master/LICENSE.txt) [![Code Climate](https://codeclimate.com/github/sinm/argparser/badges/gpa.svg)](https://codeclimate.com/github/sinm/argparser) [![Test Coverage](https://codeclimate.com/github/sinm/argparser/badges/coverage.svg)](https://codeclimate.com/github/sinm/argparser) [![Inline docs](http://inch-ci.org/github/sinm/argparser.svg?branch=master)](http://inch-ci.org/github/sinm/argparser)
 
 ## Installation
-`gem install argparser`, as usual.
+`gem install argparser` as usual.
 
 ## Usage by example
 Suppose there's a file named `example.rb` like this:
@@ -41,6 +43,8 @@ puts args['mode'].value.inspect # So we could use our options...
 puts args['file'].value         # Prints contents of a file
 ````
 
+This file located here: `lib/argparser/examples/example.rb`.
+
 Now, let's look at the output of example given in various cases.
 
 `$ ruby example.rb` is unsufficient:
@@ -82,12 +86,12 @@ Unknown option: a
 ````
 
 ## Consider more rules
-* `--help` and `--version` options provided for free unless specified.
-* printed synopsys provided for free unless specified
+* `--help` and `--version` options provided for free unless specified
+* printed synopsis provided for free unless specified
 * `:default` used if option has :argument and no value given, lowest priority
 * `:env  => 'ENV_VAR'` to pick default value from ENV, high priority
 * `:eval => 'ruby expr'` to pick default from eval(...), useful for read defaults from config files, so it has low priority
-* `--`-argument honored
+* `--` argument honored
 
 ## Documentation
 This README is all i could say in a rush. No other documentation provided at this moment, see the sources.
@@ -97,6 +101,3 @@ Don't hesistate to leave a report.
 
 ## License
 MIT for now.
-
-## TODO
-* Go steal milk for the hazards applied.

data/Rakefile

@@ -0,0 +1,17 @@
+#!/usr/bin/env rake
+require 'rake/testtask'
+
+Rake::TestTask.new :test do |t|
+  # t.test_files = FileList['spec/*_spec.rb']
+  t.pattern = 'spec/**/*_spec.rb'
+  t.libs.push 'spec'
+end
+
+task :build do
+  system('gem build argparser.gemspec')
+  # gem push argparser-1.0.0.gem
+  # gem uninstall argparser
+  # gem install argparser-1.0.0.gem
+end
+
+task :default   => :test

data/argparser.gemspec

@@ -1,19 +1,22 @@
 # coding: utf-8
-Gem::Specification.new do |spec|
-  spec.name          = 'argparser'
-  spec.version       = '1.0.0'
-  spec.authors       = ['sinm']
-  spec.email         = 'sinm.sinm@gmail.com'
-  spec.summary       = 'Command line argument parser'
-  spec.description   = '== Trying to follow POSIX and GNU guidelines'
-  spec.homepage      = 'https://github.com/sinm/argparser'
-  spec.license       = 'MIT'
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.require_paths = ['lib']
-
-  #spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  #spec.test_files    = spec.files.grep(%r{^test/})
-  #spec.add_development_dependency "bundler", "~> 1.7"
-  #spec.add_development_dependency "rake", "~> 10.0"
-  #spec.add_development_dependency "minitest" if RUBY_VERSION > '1.8'
+Gem::Specification.new do |s|
+  s.name          = 'argparser'
+  s.version       = '1.0.1'
+  s.authors       = ['sinm']
+  s.email         = 'sinm.sinm@gmail.com'
+  s.summary       = 'Yet another ruby command line argument parser library'
+  s.description   = '== Yet another ruby command line argument parser library'
+  s.homepage      = 'https://github.com/sinm/argparser'
+  s.license       = 'MIT'
+  s.files         = `git ls-files -z`.split("\x0")
+  s.test_files    = `git ls-files -z spec/`.split("\0")
+  s.require_paths = ['lib']
+  # s.extra_rdoc_files = 'README.md'
+  # s.rdoc_options  << '--title' << 'argparser' <<
+  #                      '--main' << 'README'     <<
+  #                      '--markup' << 'markdown' <<
+  #                      '--line-numbers'
+  s.add_development_dependency 'bundler',    '~> 1'
+  s.add_development_dependency 'rake',       '~> 10'
+  s.add_development_dependency 'minitest',   '~> 4'
 end

data/argparser.sublime-project

@@ -0,0 +1,27 @@
+{
+	"folders":
+	[
+		{
+			"path": "."
+		}
+	],
+  "build_systems":
+  [
+    {
+        "name": "Run tests",
+        "cmd": ["bundle", "exec", "rake", "test"],
+        "selector": "source.rb"
+    }
+  ],
+  "settings":
+  {
+    "ensure_newline_at_eof_on_save": true,
+    "rulers":
+    [
+      80
+    ],
+    "tab_size": 2,
+    "translate_tabs_to_spaces": true,
+    "trim_trailing_white_space_on_save": true
+  }
+}

data/lib/argparser.rb

@@ -1,28 +1,16 @@
-#__END__
-module Tulz
-  def hash2vars!(hash)
-    hash.each do |k, v|
-      next unless self.respond_to?(k)
-      instance_variable_set("@#{k}", v)
-    end
-  end
+# coding: utf-8
+require 'stringio'
 
-  def to_hash
-    instance_variables.reduce({}) { |hash, var|
-      hash[var[1..-1]] = instance_variable_get(var)
-      hash }
-  end
-
-  def safe_return(str)
-    eval(str)
-  rescue Exception
-    # intentionally left blank
-  end
-end
+require 'argparser/tools'
+require 'argparser/option'
+require 'argparser/default_parser'
 
 class ArgParser
-  include Tulz
-  OUT_VERSION = '%s %s %s'
+  include Tools
+  include DefaultParser
+
+  # Output messages used in the #terminate method
+  OUT_VERSION = '%s%s %s'
   OUT_COPYRIGHT = 'Copyright (C) %s'
   OUT_LICENSE = 'License: %s'
   OUT_HOMEPAGE = '%s home page: %s'
@@ -40,7 +28,7 @@ class ArgParser
   OUT_OPTION_EXPECTED = 'Expected option: %s'
   OUT_ARGUMENT_EXPECTED = 'Expected argument: %s'
   OUT_UNIQUE_NAME = 'Option name should be unique: %s'
-  INVALID_OPTION = 'Invalid option: %s'
+  OUT_INVALID_OPTION = 'Invalid value for option: %s'
   OPT_ENOUGH  = '--'
 
   # These options don't display their synopsis and given for free unless
@@ -49,76 +37,6 @@ class ArgParser
   OPT_VERSION = 'version'
   OPTS_RESERVED = [OPT_HELP, OPT_VERSION]
 
-  class Option
-    include Tulz
-    attr_reader   :names    # Names of an option (short, long, etc.)
-    attr_reader   :argument # Name of an argument, if present
-    attr_reader   :help     # Help string for an option
-    attr_reader   :validate # Lambda(option, parser) to validate an option
-    attr_reader   :default  # Default value for an option
-    attr_reader   :input    # Option is an input argument
-    attr_reader   :required # Option required
-    attr_reader   :multiple # Option may occure multiple times
-    attr_reader   :count    # Option occucences
-    attr_reader   :env      # Default option set by this ENV VAR, if any
-    attr_reader   :eval     # Default option set by this eval,
-                            # superseded by :env, if any
-                            # So, in order: value - env - eval - default
-    attr_accessor :value    # Values of an option, Array if multiple
-
-    def name
-      names.first
-    end
-
-    def initialize(o_manifest)
-      hash2vars!(o_manifest)
-      @names = Array(names).map(&:to_s).sort{|n1, n2| n1.size <=> n2.size}
-      @value = [] if multiple
-      @count = 0
-    end
-
-    def set_value(v)
-      @count += 1
-      multiple ? (@value << v).flatten! : @value = v
-    end
-
-    def value?
-      multiple ? !value.compact.empty? : !!value
-    end
-
-    def to_s
-      str = ''
-      str += (count     ? count.to_s : ' ')
-      str += (argument  ? 'A' : ' ')
-      str += (validate  ? 'V' : ' ')
-      str += (default   ? 'D' : ' ')
-      str += (input     ? 'I' : ' ')
-      str += (required  ? 'R' : ' ')
-      str += (multiple  ? 'M' : ' ')
-      str += " #{names.inspect}"
-      str += " #{value.inspect}" if value
-    end
-
-    def synopsis
-      if input
-        s = name.dup
-        s << '...' if multiple
-        s = "[#{s}]" if !required
-        return s
-      else
-        s = names.map{|n| n.size == 1 ? "-#{n}" : "--#{n}"}.join(', ')
-        s << " #{argument}" if argument
-        s = "[#{s}]" if !required
-        s << '...' if multiple
-        return s
-      end
-    end
-
-    def validate!(parser)
-      !validate || validate.call(self, parser)
-    end
-  end
-
   attr_reader :program    # Program name, REQUIRED
   attr_reader :package    # Set to nil if there's no package
   attr_reader :version    # Follow semantic versioning rules, REQUIRED
@@ -129,9 +47,10 @@ class ArgParser
   attr_reader :homepage   # Package or, if absent, program's home page
   attr_reader :synopsis   # Print this if present or construct from options
   attr_reader :help       # Print this if present or construct from options
-  attr_reader :options    # Options in a hash,
-                          # see ArgParser::Option class' attr_reader
+  attr_reader :options    # Array of options,
+                          # see ArgParser::Option class' attr_readers
 
+  # Returns option by any of its names given
   def [](name)
     options.find{|o| o.names.include?(name)}
   end
@@ -142,13 +61,10 @@ class ArgParser
   end
 
   def initialize(manifest)
-    manifest = {
-      :options    => []
-    }.merge(safe_return('$config.manifest') || {}).merge(manifest)
+    manifest = (safe_return('$config.manifest') || {}).merge(manifest)
     hash2vars!(manifest)
-    @options = (manifest[:options] || manifest['options'] || {}).map do |o|
-      Option.new(o)
-    end
+    @options = (manifest[:options] || manifest['options'] || []).
+      map {|o| o.kind_of?(Option) ? o : Option.new(o)}
     if !self['help']
       options << Option.new(:names    => OPT_HELP,
                             :help     => 'Print this help and exit.',
@@ -165,190 +81,50 @@ class ArgParser
     end
   end
 
-  def parse!(arguments = ARGV)
-    {:program => @program, :version => @version}.each do |k, v|
-      if !v || v.to_s.strip.empty?
-        terminate(2, OUT_MANIFEST_EXPECTED % k)
-      end
-    end
-
-    is = inputs
-    is.each_with_index do |i, index|
-      if index < is.length-1 and i.multiple
-        terminate(2, OUT_MULTIPLE_INPUTS % i.name)
-      end
-      if i.names.size > 1
-        terminate(2, OUT_MULTIPLE_NAMES % i.name)
-      end
-    end
-    first_optional = is.index{|i| !i.required} || is.size
-    last_required  = is.rindex{|i| i.required} || 0
-    if last_required > first_optional
-      terminate(2, OUT_REQUIRED % is[last_required].name)
-    end
-
-    names = {}
-    options.each do |option|
-      option.names.each do |name|
-        if name.strip.empty?
-          terminate(2, OUT_OPTION_NULL)
-        end
-        if names.has_key?(name)
-          terminate(2, OUT_UNIQUE_NAME % name)
-        end
-        names[name] = option
-      end
-      if option.required && option.default
-        terminate(2, OUT_REQUIRED_DEFAULT % option.name)
-      end
-    end
-
-    OPTS_RESERVED.each { |o|
-      next unless arguments.include?("--#{o}")
-      o = self[o]
-      o.set_value(nil)
-      o.validate!(self)
-    }
-
-    args = arguments.dup
-    enough = false
-    while (a = args.shift)
-      if a == OPT_ENOUGH
-        enough = true
-      elsif enough || (a =~ /^[^-]/) || (a == '-') # input argument
-        if (input = inputs.find{|i| !i.value || i.multiple})
-          input.set_value(a)
-        else
-          terminate(2, OUT_UNEXPECTED_ARGUMENT % a)
-        end
-      elsif a =~ /^--(.+)/ # long option
-        if $1.size > 1 && option = self[$1]
-          if option.argument
-            if args.empty?
-              terminate(2, $stderr.puts(OUT_OPTION_ARGUMENT_EXPECTED % a))
-            end
-            option.set_value(args.shift)
-          else
-            option.set_value(nil)
-          end
-        else
-          terminate(2, OUT_UNKNOWN_OPTION % $1)
-        end
-      elsif a =~ /^-([^-].*)/ # short option, may combine and has an arg at end
-        (opts = $1).chars.to_a.each_with_index do |char, index|
-          if (option = self[char])
-            if option.argument
-              if opts.size-1 == index
-                if args.empty?
-                  terminate(2, OUT_OPTION_ARGUMENT_EXPECTED % a)
-                else
-                  option.set_value(args.shift)
-                end
-              else
-                option.set_value(opts[index+1..-1])
-                break
-              end
-            else
-              option.set_value(nil)
-            end
-          else
-            terminate(2, OUT_UNKNOWN_OPTION % char)
-          end
-        end
-      else
-        terminate(2, OUT_UNKNOWN_OPTION % a)
-      end
-    end
-
-    options.each do |option|
-      if  !option.value? && (option.argument || option.input) &&
-          ((option.env      && (e = ENV[option.env])) ||
-          (option.eval      && (e = safe_return(option.eval))) ||
-          (!!option.default && (e = option.default)))
-            option.set_value(e)
-      end
-      if !option.multiple && option.count > 1
-        terminate(2, OUT_SINGLE_OPTION % option.name)
-      elsif option.required && option.count < 1
-        if option.input
-          terminate(2, OUT_ARGUMENT_EXPECTED % option.name)
-        else
-          terminate(2, OUT_OPTION_EXPECTED % option.name)
-        end
-      end
-    end
-
-    options.each { |o|
-      next if o.validate!(self)
-      terminate(2, INVALID_OPTION % o.name)
-    }
-    self
+  def terminate(code, str)
+    s = StringIO.new
+    s.puts(printed_synopsis) if code != 0
+    s.puts(str[-1] == "\n" ? str.chop : str)
+    on_exit(code, s.string)
   end
 
-  def terminate(code, str = nil)
-    stream = code == 0 ? $stdout : $stderr
-    stream.puts(printed_synopsis) if code != 0
-    if str
-      stream.print(str)
-      stream.puts() unless str[-1] == "\n"
-    end
-    exit!(code)
+  def on_exit(code, message)
+    (code == 0 ? $stdout : $stderr).print(message)
+    exit(code)
   end
 
   def printed_version
-    pk = (pk = @package) ? "(#{pk})" : ''
-    str = ''
-    str << (OUT_VERSION    % [@program, pk, @version]) + "\n"
-    str << (OUT_COPYRIGHT  % @copyright) + "\n"
-    str << (OUT_LICENSE    % @license) + "\n"
+    str = StringIO.new
+    pk = (pk = @package) ? " (#{pk})" : ''
+    str.puts(OUT_VERSION % [program, pk, version])
+    str.puts(OUT_COPYRIGHT % copyright) if copyright
+    str.puts(OUT_LICENSE % license) if license
+    str.string
   end
 
   def printed_help
-    str = printed_synopsis + "\n"
-    str << info + "\n\n" if info
+    str = StringIO.new
+    str.puts(printed_synopsis)
+    str.puts(info) if info
     if help
-      str << help + "\n"
+      str.puts(help)
     else
-      opts = []
-      options.select{|o| !o.input}.each do |o|
-        next unless h = o.help
-        h << "\n\tDefaults to: #{o.default}" if o.default
-        opts << [o.synopsis, h]
-      end
-      inputs.each do |i|
-        next unless i.help
-        help = i.help
-        help << "\n\tDefaults to: #{i.default}" if i.default
-        opts << [i.synopsis, help]
-      end
-      opts.each do |o|
-        str << "%s\n\t%s\n" % [o.first, o.last]
+      (options.select{|o| !o.input} + inputs).each do |o|
+        str.puts(o.printed_help)
       end
       # term_width = ENV['COLUMNS'] || `tput columns` || 80
-      # name_width = opts.reduce(0){|max, o| (sz = o.first.size) > max ? sz : max}
-      # help_width = term_width - (name_width += 1)
+      # width = opts.reduce(0){|max, o| (sz = o.first.size) > max ? sz : max}
+      # help_width = term_width - (width += 1)
       # if help_width < 32...
     end
-    str << (OUT_BUGS % @bugs) + "\n" if bugs
-    what = @package || @program
-    str << (OUT_HOMEPAGE % [what, @homepage]) + "\n" if homepage
-    str
+    str.puts(OUT_BUGS % bugs) if bugs
+    str.puts(OUT_HOMEPAGE % [(package||program), homepage]) if homepage
+    str.string
   end
 
   def printed_synopsis
     s = synopsis ||
-      (options.select{|o| !o.input} + inputs).map{|o|
-        OPTS_RESERVED.include?(o.name) ? nil : o.synopsis}.compact.join(' ')
-    "#{program} #{s}"
-  end
-
-  if __FILE__ == $0 # Some selftests... while hakin in an editor
-    $stdout.sync = true
-    $stderr.sync = true
-    ARGV = %w[--abcm first]
-    example = File.read('argparser/examples/example.rb')
-    example = example.split("\n")[1..-1].join("\n") # Cut 'require' string
-    eval(example) # Last line
+      (options.select{|o| !o.input} + inputs).map{|o| o.synopsis}.join(' ')
+    "Usage: #{program} #{s}"
   end
-
-end # the very end
+end