args_parser 0.1.6 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fd18f8f99cc8aab89d1ae2e1f03caa13c9f7acda
-  data.tar.gz: 36ad2bd87477a51ad8741c8c5eb78bdc7dac9201
+  metadata.gz: 8706a4d57149332f2b0483eec8d6c7c90c19f962
+  data.tar.gz: fb8a7fbaf3e694abc577082eaafeaa4f16662f04
 SHA512:
-  metadata.gz: e105284a49feb4fbc5ade8f6f1eaa8c6355319526c6ffb0341ded36e460e808996d937d4c4fa42bf22cfbacfee3c4ff5b15b8df32c8a342b285b92ffde3f7009
-  data.tar.gz: 8d198872228f2e349e830798916aa569b79f66ccb48f810e67112dabda4a0882bd863f8d771870acd0392f7b656cb9db1a58d4dd5f282d56071352a46dc6cdd5
+  metadata.gz: fd315c4245616b89b3f8494f6d4f35a8869ad3308a9c94a3b4e4411d39627c319aad8c7bce9e8828b418fdb27e4c7491090792486e90266ee524c1013016b866
+  data.tar.gz: f379f7430584f20152ba143072be5b485f1e3dd61c08f87e133a75874f6a142401c68e60f3afb9c0351e4bc8f0354e6d89c0452c7603831e1b7c3d7300895a3d

data/History.txt

@@ -1,3 +1,10 @@
+=== 0.2.0 2013-08-26
+
+* add "on" event
+* fix equal_style sample
+* refactoring
+* specify license in gemspec
+
 === 0.1.6 2013-06-08
 
 * fix gem description

data/README.md

@@ -7,9 +7,7 @@ args_parser
 
 Requirements
 ------------
-* Ruby 1.8.7+
-* Ruby 1.9.3+
-* JRuby 1.6.7+
+- Ruby 1.8.7 ~ 2.0.0
 
 
 Install
@@ -57,9 +55,10 @@ end
 puts "saved! => #{args[:output]}"
 ```
 
-equal style
+### equal style
 
-    % ruby samples/twitter_timeline.rb --user=shokai --fav --rt
+    % ruby samples/equal_style.rb --help
+    % ruby samples/equal_style.rb --user=shokai hello world  --a=1234
 
 parse equal style ARGV
 ```ruby
@@ -74,7 +73,7 @@ Test
 
     % gem install bundler
     % bundle install
-    % rake test
+    % bundle exec rake test
 
 
 Contributing

data/args_parser.gemspec

@@ -10,6 +10,7 @@ Gem::Specification.new do |gem|
   gem.description   = %q{Parse/Filter/Validate ARGV from command line with DSL.}
   gem.summary       = gem.description
   gem.homepage      = "http://shokai.github.com/args_parser"
+  gem.license       = "MIT"
 
   gem.files         = `git ls-files`.split($/).reject{|i| i=="Gemfile.lock" }
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

data/lib/args_parser.rb

@@ -1,6 +1,4 @@
-$:.unshift(File.dirname(__FILE__)) unless
-  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
-
+require 'args_parser/main'
 require 'args_parser/parser'
 require 'args_parser/styles/default'
 require 'args_parser/styles/equal'

data/lib/args_parser/config.rb

@@ -1,9 +1,9 @@
 module ArgsParser
   class Config
-    def self.default
-      {
-        :style => :default
-      }
-    end
+
+    DEFAULT = {
+      :style => :default
+    }
+
   end
 end

data/lib/args_parser/filter.rb

@@ -1,8 +1,10 @@
-
 module ArgsParser
   class Filter
-    def filters
-      @filters ||= []
+
+    attr_reader :filters
+
+    def initialize
+      @filters = []
     end
 
     def add(name, filter)

data/lib/args_parser/main.rb

@@ -0,0 +1,12 @@
+module ArgsParser
+
+  def self.parse(argv=[], config={}, &block)
+    Config::DEFAULT.each do |k,v|
+      config[k] = v unless config[k]
+    end
+    parser = Parser.new(config, &block)
+    parser.parse argv
+    parser
+  end
+
+end

data/lib/args_parser/parser.rb

@@ -1,13 +1,4 @@
-
 module ArgsParser
-  def self.parse(argv=[], config={}, &block)
-    Config.default.each do |k,v|
-      config[k] = v unless config[k]
-    end
-    parser = Parser.new(config, &block)
-    parser.parse argv
-    parser
-  end
 
   class Parser
     attr_reader :argv, :params, :aliases
@@ -18,9 +9,8 @@ module ArgsParser
     end
 
     def initialize(config, &block)
-      unless block_given?
-        raise ArgumentError, 'initialize block was not given'
-      end
+      raise ArgumentError, 'initialize block was not given' unless block_given?
+
       @config = config
       @argv = []
       @params = Hash.new{|h,k|
@@ -35,6 +25,7 @@ module ArgsParser
       @aliases = {}
       @filter = Filter.new
       @validator = Validator.new
+      @ons = []
 
       filter do |v|
         (v.kind_of? String and v =~ /^-?\d+$/) ? v.to_i : v
@@ -50,7 +41,7 @@ module ArgsParser
         exit 1
       end
 
-      instance_eval(&block)
+      instance_eval &block
     end
 
     private
@@ -64,36 +55,43 @@ module ArgsParser
     end
 
     def filter(name=nil, &block)
-      if block_given?
-        @filter.add name, block
-      end
+      @filter.add name, block if block_given?
     end
 
     def on_filter_error(err=nil, name=nil, value=nil, &block)
       if block_given?
         @on_filter_error = block
-      else
-        @on_filter_error.call(err, name, value) if @on_filter_error
+      elsif @on_filter_error.kind_of? Proc
+        @on_filter_error.call(err, name, value)
       end
     end
 
     def validate(name, message, &block)
-      if block_given?
-        @validator.add name, message, block
-      end
+      @validator.add name, message, block if block_given?
     end
 
     def on_validate_error(err=nil, name=nil, value=nil, &block)
       if block_given?
         @on_validate_error = block
+      elsif @on_validate_error.kind_of? Proc
+        @on_validate_error.call(err, name, value)
+      end
+    end
+
+    def on(name, &block)
+      name = name.to_sym
+      if block_given?
+        @ons.push :name => name, :callback => block
       else
-        @on_validate_error.call(err, name, value) if @on_validate_error
+        @ons.each do |event|
+          event[:callback].call(self[name]) if event[:name] == name
+        end
       end
     end
 
     def default(key)
       d = params[key.to_sym][:default]
-      (d and d.kind_of? Proc) ? d.call : d
+      d.kind_of?(Proc) ? d.call : d
     end
 
     public
@@ -102,7 +100,7 @@ module ArgsParser
     end
 
     def parse(argv)
-      method("parse_style_#{@config[:style]}".to_sym).call(argv)
+      send "parse_style_#{@config[:style]}", argv
       params.each do |name, param|
         next if [nil, true].include? param[:value]
         begin
@@ -119,27 +117,25 @@ module ArgsParser
           on_validate_error ValidationError.new(msg), name, param[:value]
         end
       end
+      params.keys.each do |name|
+        on name if has_option? name or has_param? name
+      end
     end
 
     def [](key)
-      params[key.to_sym][:value] or default(key)
+      params[key.to_sym][:value] || default(key)
     end
 
     def []=(key, value)
       params[key.to_sym][:value] = value
     end
 
-    def has_option?(*opt)
-      !(opt.flatten.map{|i|
-          self[i] == true
-        }.include? false)
+    def has_option?(*opts)
+      !opts.flatten.find{|i| self[i] != true}
     end
 
-    def has_param?(*param_)
-      !(param_.flatten.map{|i|
-          v = self[i]
-          (v != nil and v != true) ? true : false
-        }.include? false)
+    def has_param?(*params)
+      !params.flatten.find{|i| self[i] == nil or self[i] == true }
     end
 
     def inspect
@@ -154,24 +150,20 @@ module ArgsParser
       params_ = Array.new
       params.each do |k,v|
         v[:name] = k
-        params_ << v
+        params_.push v
       end
-      params_ = params_.delete_if{|i|
-        i[:index] < 0
-      }.sort{|a,b|
-        a[:index] <=> b[:index]
-      }
+      params_ = params_.reject{|i| i[:index] < 0 }.sort{|a,b| a[:index] <=> b[:index] }
 
       len = params_.map{|i|
-        line = " -#{i[:name]}"
-        line += " (-#{i[:alias]})" if i[:alias]
-        line.size
+        (i[:alias] ?
+         " -#{i[:name]} (-#{i[:alias]})" :
+         " -#{i[:name]}").size
       }.max
 
       "options:\n" + params_.map{|i|
-        line = " -#{i[:name]}"
-        line += " (-#{i[:alias]})" if i[:alias]
-        line = line.ljust(len+2)
+        line = (i[:alias] ?
+                " -#{i[:name]} (-#{i[:alias]})" :
+                " -#{i[:name]}").ljust(len+2)
         line += i[:description].to_s
         line += " : default - #{default i[:name]}" if i[:default]
         line

data/lib/args_parser/styles/default.rb

@@ -11,7 +11,7 @@ module ArgsParser
             k = arg.scan(is_key)[0][0].strip.to_sym
             k = aliases[k]  if aliases[k]
           else
-            self.argv.push arg
+            @argv.push arg
           end
         else
           if arg =~ is_key

data/lib/args_parser/styles/equal.rb

@@ -12,11 +12,11 @@ module ArgsParser
       is_param = /^-+([^-=\s]+)=(.+)$/
       argv.each_with_index do |arg, i|
         if arg =~ is_option
-          k,v = [arg.scan(is_option)[0][0], true]
+          k,v = arg.scan(is_option)[0][0], true
         elsif arg =~ is_param
           k,v = arg.scan(is_param)[0]
         else
-          self.argv.push arg
+          @argv.push arg
         end
         if k and v
           k = k.strip.to_sym

data/lib/args_parser/validator.rb

@@ -1,8 +1,10 @@
-
 module ArgsParser
   class Validator
-    def validators
-      @validators ||= []
+
+    attr_reader :validators
+
+    def initialize
+      @validators = []
     end
 
     def add(name, message, validator)

data/lib/args_parser/version.rb

@@ -1,3 +1,3 @@
 module ArgsParser
-  VERSION = '0.1.6'
+  VERSION = '0.2.0'
 end

data/samples/equal_style.rb

@@ -0,0 +1,18 @@
+$:.unshift File.expand_path '../lib', File.dirname(__FILE__)
+
+require 'args_parser'
+
+args = ArgsParser.parse ARGV, :style => :equal do
+  arg :help, 'show help', :alias => :h
+
+  on :help do |v|
+    STDERR.puts help
+    STDERR.puts "e.g.  ruby equal_style.rb --user=shokai hello world  --a=1234"
+    exit 1
+  end
+end
+
+puts "== args"
+p args
+puts "== args.argv"
+p args.argv

data/test/test_args_parser.rb

@@ -20,45 +20,45 @@ class TestArgsParser < MiniTest::Test
   end
 
   def test_first
-    assert @parser.first == 'test'
+    assert_equal @parser.first, 'test'
   end
 
   def test_argv
-    assert @parser.argv == ['test', 'foo', 'bar']
+    assert_equal @parser.argv, ['test', 'foo', 'bar']
   end
 
   def test_arg
-    assert @parser[:input] == 'http://shokai.org'
+    assert_equal @parser[:input], 'http://shokai.org'
   end
 
   def test_alias
-    assert @parser[:output] == './out'
+    assert_equal @parser[:output], './out'
   end
 
   def test_string_access
-    assert @parser['output'] == './out'
+    assert_equal @parser['output'], './out'
   end
 
   def test_cast_integer
-    assert @parser[:depth] == 30
-    assert @parser[:depth].class == Fixnum
+    assert_equal @parser[:depth], 30
+    assert_equal @parser[:depth].class, Fixnum
   end
 
   def test_cast_float
-    assert @parser[:pi] == 3.14
-    assert @parser[:pi].class == Float
+    assert_equal @parser[:pi], 3.14
+    assert_equal @parser[:pi].class, Float
   end
 
   def test_filter
-    assert @parser[:name] == 'shokai'
+    assert_equal @parser[:name], 'shokai'
   end
 
   def test_missing_arg
-    assert @parser[:b] != true
+    assert_equal @parser[:b], nil
   end
 
   def test_switch
-    assert @parser[:help] == true
+    assert_equal @parser[:help], true
   end
 
   def test_has_param?

data/test/test_args_parser_style_equal.rb

@@ -20,45 +20,45 @@ class TestArgsParserStyleEqual < MiniTest::Test
   end
 
   def test_first
-    assert @parser.first == 'test'
+    assert_equal @parser.first, 'test'
   end
 
   def test_argv
-    assert @parser.argv == ['test', 'foo', 'bar']
+    assert_equal @parser.argv, ['test', 'foo', 'bar']
   end
 
   def test_arg
-    assert @parser[:input] == 'http://shokai.org'
+    assert_equal @parser[:input], 'http://shokai.org'
   end
 
   def test_alias
-    assert @parser[:output] == './out'
+    assert_equal @parser[:output], './out'
   end
 
   def test_string_access
-    assert @parser['output'] == './out'
+    assert_equal @parser['output'], './out'
   end
 
   def test_cast_integer
-    assert @parser[:depth] == -30
-    assert @parser[:depth].class == Fixnum
+    assert_equal @parser[:depth], -30
+    assert_equal @parser[:depth].class, Fixnum
   end
 
   def test_cast_float
-    assert @parser[:pi] == -3.14
-    assert @parser[:pi].class == Float
+    assert_equal @parser[:pi], -3.14
+    assert_equal @parser[:pi].class, Float
   end
 
   def test_filter
-    assert @parser[:name] == 'shokai'
+    assert_equal @parser[:name], 'shokai'
   end
 
   def test_missing_arg
-    assert @parser[:b] != true
+    assert_equal @parser[:b], nil
   end
 
   def test_switch
-    assert @parser[:help] == true
+    assert_equal @parser[:help], true
   end
 
   def test_has_param?

data/test/test_default.rb

@@ -11,11 +11,11 @@ class TestArgsParserDefault < MiniTest::Test
   end
 
   def test_default
-    assert @parser[:name] == 'shokai'
+    assert_equal @parser[:name], 'shokai'
   end
 
   def test_overwrite
-    assert @parser[:age] == 40
+    assert_equal @parser[:age], 40
   end
 
   def test_name

data/test/test_helper.rb

@@ -1,5 +1,4 @@
 require 'rubygems'
-require 'bundler/setup'
 require 'minitest/autorun'
 
 $:.unshift File.expand_path '../lib', File.dirname(__FILE__)

data/test/test_on.rb

@@ -0,0 +1,26 @@
+require File.expand_path 'test_helper', File.dirname(__FILE__)
+
+class TestArgsParserOn < MiniTest::Test
+
+  def test_filter_error
+    argv = ['--h', '--say', 'hello']
+    help_called = false
+    say_called = false
+    args = ArgsParser.parse argv do
+      arg :help, 'show help', :alias => :h
+      arg :say, 'string'
+
+      on :say do |v|
+        say_called = v
+      end
+
+      on :help do
+        help_called = true
+      end
+    end
+
+    assert_equal say_called, "hello"
+    assert_equal help_called, true
+  end
+
+end

data/test/test_validator.rb

@@ -12,7 +12,7 @@ class TestArgsParserValidator < MiniTest::Test
       validate :url, 'invalid URL' do |v|
         v =~ Regexp.new("^https?://.+$")
       end
-      
+
       on_validate_error do |err, name, value|
         @@err = err
         @@name = name
@@ -22,8 +22,8 @@ class TestArgsParserValidator < MiniTest::Test
   end
 
   def test_validate_error
-    assert @@name == :url
-    assert @@value == 'hptt://shokai.org'
-    assert @@err.class == ArgsParser::ValidationError
+    assert_equal @@name, :url
+    assert_equal @@value, 'hptt://shokai.org'
+    assert_equal @@err.class, ArgsParser::ValidationError
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: args_parser
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.2.0
 platform: ruby
 authors:
 - Sho Hashimoto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-08 00:00:00.000000000 Z
+date: 2013-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -84,22 +84,25 @@ files:
 - lib/args_parser/config.rb
 - lib/args_parser/error.rb
 - lib/args_parser/filter.rb
+- lib/args_parser/main.rb
 - lib/args_parser/parser.rb
 - lib/args_parser/styles/default.rb
 - lib/args_parser/styles/equal.rb
 - lib/args_parser/validator.rb
 - lib/args_parser/version.rb
 - samples/download_webpage.rb
-- samples/twitter_timeline.rb
+- samples/equal_style.rb
 - test/test_args_parser.rb
 - test/test_args_parser_style_equal.rb
 - test/test_default.rb
 - test/test_filter.rb
 - test/test_helper.rb
+- test/test_on.rb
 - test/test_validator.rb
 - test/test_version.rb
 homepage: http://shokai.github.com/args_parser
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -117,7 +120,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.0.5
 signing_key: 
 specification_version: 4
 summary: Parse/Filter/Validate ARGV from command line with DSL.
@@ -127,6 +130,6 @@ test_files:
 - test/test_default.rb
 - test/test_filter.rb
 - test/test_helper.rb
+- test/test_on.rb
 - test/test_validator.rb
 - test/test_version.rb
-has_rdoc: 

data/samples/twitter_timeline.rb

@@ -1,72 +0,0 @@
-#!/usr/bin/env ruby
-## equal style sample app
-## % gem install twitter --version=3.7.0
-
-$:.unshift File.expand_path '../lib', File.dirname(__FILE__)
-require 'rubygems'
-require 'args_parser'
-gem 'twitter', '< 4.0.0', '>= 3.7.0'
-require 'twitter'
-
-args = ArgsParser.parse ARGV, :style => :equal do
-  arg :user, 'user', :alias => :u
-  arg :favorite, 'show favorites', :alias => :fav
-  arg :retweet, 'show retweets', :alias => :rt
-  arg :help, 'show help', :alias => :h
-
-  filter :user do |v|
-    v.to_s.strip
-  end
-
-  validate :user, "invalid twitter screen_name" do |v|
-    v =~ /^[a-zA-Z0-9_]+$/
-  end
-end
-
-if args.has_option? :help or !args.has_param? :user
-  STDERR.puts "Twitter Timeline\n=="
-  STDERR.puts args.help
-  STDERR.puts "e.g.  ruby #{$0} --user=ymrl"
-  STDERR.puts "e.g.  ruby #{$0} --user=ymrl --fav"
-  STDERR.puts "e.g.  ruby #{$0} --user=ymrl --fav --rt"
-  exit 1
-end
-
-p args
-
-Twitter::configure do
-end
-
-data = []
-Twitter::user_timeline(args[:user]).each do |i|
-  data.push(:id => i.id,
-            :name => i.user.screen_name,
-            :text => i.text,
-            :date => i.created_at)
-end
-
-if args.has_option? :favorite
-  Twitter::favorites(args[:user]).each do |i|
-    data.push(:id => i.id,
-              :name => i.user.screen_name,
-              :text => i.text,
-              :date => i.created_at)
-  end
-end
-
-if args.has_option? :retweet
-  Twitter::retweeted_by_user(args[:user]).each do |i|
-    data.push(:id => i.id,
-              :name => i.user.screen_name,
-              :text => i.text,
-              :date => i.created_at)
-  end
-end
-
-data.uniq{|i|
-  i[:id]
-}.sort{|a,b|
-  a[:date] <=> b[:date]
-}.each{|i|
-  puts "@#{i[:name]}\t#{i[:text]}"
-}