arguments 0.6

data/History.txt

@@ -0,0 +1,22 @@
+== 0.4 2009-06-30
+
+* 1 major enhancement:
+  * Initial release
+  * Works with Ruby 1.8.6 and 1.9.1
+
+== 0.4.2 2009-07-03
+
+* Fixed a Bug where not passing arguments would rise try to call #key? on nil
+
+== 0.4.3 2009-07-07
+
+* Fixed a serious bug where default values could not be overriden by passing arguments without keyword
+
+== 0.6 2009-08-06
+
+* Fixed a bug where converting a block to proc argument using ampersand would blow method call
+* Passing a keyword not corresponding to an argument name raises an error
+* Using RubyParser in Ruby 1.9.1 instead of Regexp to extract argument names and default values
+* Method definition that uses splat operator is now ignored
+* Last Hash argument is not used for assigning argument values if total number of arguments has been passed
+* named_arguments_for can be called passing a Class method name eg: named_args_for :instance_method, 'self.class_method'

data/Manifest.txt

@@ -0,0 +1,12 @@
+History.txt
+Manifest.txt
+README.rdoc
+Rakefile
+arguments.gemspec
+lib/arguments.rb
+lib/arguments/class.rb
+lib/arguments/mri.rb
+lib/arguments/vm.rb
+spec/arguments_spec.rb
+spec/klass.rb
+spec/module.rb

data/README.rdoc

@@ -0,0 +1,114 @@
+= arguments
+
+http://github.com/maca/arguments
+
+== DESCRIPTION:
+
+You don't have to wait until Ruby 2.0 to get (named|keyword) arguments support.
+Arguments has been tested with Ruby 1.8.6 and ruby 1.9.1 and eventually will work with JRuby (if someone is interested in contributing, I guess is possible since merb-action-args works with JRuby)
+
+== SYNOPSIS:
+
+    require 'arguments'
+    
+    class Example
+      def meth(a = :a, b = :b, c = :c)
+        [a,b,c]
+      end
+       
+      class << self
+        def class_method(a = :a, b = :b, c = :c)
+          [a,b,c]
+        end
+        
+        def other_class_method(a = :a, b = :b, c = :c)
+          [a,b,c]
+        end        
+        named_args_for :class_method
+      end
+      
+      named_args_for :meth, :'self.other_class_method'
+    end
+    
+    nu = Example.new
+    nu.meth #=> [:a,:b,:c]
+    nu.meth(1, :c => Class) #=> [1,:b,Class]
+    nu.meth(:b => nil, :a => 'something') #=> ['something', nil, :c]
+    
+    Example.class_method(:b => nil, :a => 'something') #=> ['something', nil, :c]
+    Example.other_class_method(:b => nil, :a => 'something') #=> ['something', nil, :c]
+    
+    
+
+
+* #named_arguments_for is aliased as #named_args_for and #named_args
+* Calling #named_args_for without arguments patches all previously declared methods in scope
+* Last Hash argument is used to assign argument values unless passing all accepted arguments:
+
+  nu.meth(1, :c => 'string') #=> [1, :b, 'string']
+  nu.meth(1, 2, :a => 'string')  #=> [1, 2, {:a => 'string'}]
+
+* Any number of method names (Symbol or String) corresponding to existing methods can be passed
+* Methods with no optionals won't be patched (will behave as usual with no named params)
+* Same for methods with splatted arguments and for native methods (not declared in Ruby)
+* Keyword argument take precedence over argument order:
+      
+      nu.meth(10, :a => -10) #=> [-10, :b, :c]
+      
+* pasing a key not corresponding to an argument name will raise ArgumentError:
+
+      nu.meth(10, :four => -10) #=> ArgumentError: `four` is not an argument name.
+
+== LIMITATIONS
+
+* Performance penalty occurs only in 1.8.6 due to ParseTree use and only while calling Class#named_args\_for, penalty while calling the actuall method is neglectable.
+* With Ruby 1.8.6 it can patch methods declared with eval, with 1.9.1 only methods declared in a source file.
+
+== REQUIREMENTS:
+
+- Ruby2Ruby 1.1.9
+
+Ruby 1.8.6:
+- ParseTree >= 3.0.3
+
+Ruby 1.9.1
+- RubyParser >= 2.0.2
+
+== INSTALL:
+
+    sudo gem install arguments --source http://gemcutter.org
+
+== LATEST CHANGES (0.6)
+
+* Fixed a bug where converting a block to proc argument using ampersand would blow method call
+* Passing a keyword not corresponding to an argument name raises an error
+* Using RubyParser in Ruby 1.9.1 instead of Regexp to extract argument names and default values
+* Method definition that uses splat operator is now ignored
+* Last Hash argument is not used for assigning argument values if total number of arguments has been passed
+* named_arguments_for can be called passing a Class method name eg: named_args_for :instance_method, 'self.class_method'
+
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Macario Ortega
+
+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,15 @@
+require 'rubygems'
+require 'hoe'
+require './lib/arguments'
+
+Hoe.plugin :newgem
+
+$hoe = Hoe.spec 'arguments' do
+  self.developer 'Macario Ortega', 'macarui@gmail.com'
+  # self.url 'http://github.com/maca/arguments'
+  self.extra_deps = [
+    ['ruby_parser', '>= 2.0.2'],
+    ['ParseTree',   '>= 3.0.3'],
+    ['ruby2ruby',    '= 1.1.9']
+  ]
+end

data/arguments.gemspec

@@ -0,0 +1,49 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{arguments}
+  s.version = "0.6"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Macario Ortega"]
+  s.date = %q{2010-01-17}
+  s.description = %q{You don't have to wait until Ruby 2.0 to get (named|keyword) arguments support.
+Arguments has been tested with Ruby 1.8.6 and ruby 1.9.1 and eventually will work with JRuby (if someone is interested in contributing, I guess is possible since merb-action-args works with JRuby)}
+  s.email = ["macarui@gmail.com"]
+  s.extra_rdoc_files = ["History.txt", "Manifest.txt"]
+  s.files = ["History.txt", "Manifest.txt", "README.rdoc", "Rakefile", "arguments.gemspec", "lib/arguments.rb", "lib/arguments/class.rb", "lib/arguments/mri.rb", "lib/arguments/vm.rb", "spec/arguments_spec.rb", "spec/klass.rb", "spec/module.rb"]
+  s.homepage = %q{http://github.com/maca/arguments}
+  s.rdoc_options = ["--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{arguments}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{You don't have to wait until Ruby 2.0 to get (named|keyword) arguments support}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<ruby_parser>, [">= 2.0.2"])
+      s.add_runtime_dependency(%q<ParseTree>, [">= 3.0.3"])
+      s.add_runtime_dependency(%q<ruby2ruby>, ["= 1.1.9"])
+      s.add_development_dependency(%q<rubyforge>, [">= 2.0.3"])
+      s.add_development_dependency(%q<gemcutter>, [">= 0.3.0"])
+      s.add_development_dependency(%q<hoe>, [">= 2.5.0"])
+    else
+      s.add_dependency(%q<ruby_parser>, [">= 2.0.2"])
+      s.add_dependency(%q<ParseTree>, [">= 3.0.3"])
+      s.add_dependency(%q<ruby2ruby>, ["= 1.1.9"])
+      s.add_dependency(%q<rubyforge>, [">= 2.0.3"])
+      s.add_dependency(%q<gemcutter>, [">= 0.3.0"])
+      s.add_dependency(%q<hoe>, [">= 2.5.0"])
+    end
+  else
+    s.add_dependency(%q<ruby_parser>, [">= 2.0.2"])
+    s.add_dependency(%q<ParseTree>, [">= 3.0.3"])
+    s.add_dependency(%q<ruby2ruby>, ["= 1.1.9"])
+    s.add_dependency(%q<rubyforge>, [">= 2.0.3"])
+    s.add_dependency(%q<gemcutter>, [">= 0.3.0"])
+    s.add_dependency(%q<hoe>, [">= 2.5.0"])
+  end
+end

data/lib/arguments.rb

@@ -0,0 +1,27 @@
+gem 'ruby2ruby', '= 1.1.9'
+require 'ruby2ruby'
+
+$:.unshift(File.dirname(__FILE__)) unless $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+require 'arguments/class'
+
+RUBY_VERSION.to_f >= 1.9 ? require( 'arguments/vm' ) : require( 'arguments/mri' )
+
+module Arguments
+  VERSION = '0.6'
+  
+  def self.names klass, method
+    args = ast_for_method(klass, method).assoc(:args)
+    args = args[1..-1]
+    
+    return [] if args.empty? or args.last.is_a?(Symbol)
+    vals = args.pop[1..-1]
+
+    args.collect do |arg|
+      if val = vals.find{ |v| v[1] == arg }
+        [arg, Ruby2Ruby.new.process(val.last)]
+      else
+        [arg]
+      end
+    end
+  end
+end

data/lib/arguments/class.rb

@@ -0,0 +1,51 @@
+class Class
+  def named_arguments_for *methods
+    methods = instance_methods - Object.methods if methods.empty?
+        
+    methods.each do |meth|
+      meth    = meth.to_s
+      klass   = meth.sub!(/^self./, '') ? (class << self; self; end) : self
+      names   = Arguments.names klass, meth
+      next if names.empty? or names.inject(false) { |bol, pair| bol || /^\*/ === pair.first.to_s }
+      assigns = []
+      names.pop if /^&/ === names[-1][0].to_s
+      
+      names.each_with_index do |name, index|
+        unless name.size == 1
+          assigns << <<-RUBY_EVAL
+            #{ name.first } =
+            if opts.key? :#{ name.first }
+              opts.delete :#{ name.first }
+            else
+              args.size >= #{ index + 1 } ? args[#{ index }] : #{ name.last }
+            end
+          RUBY_EVAL
+        else
+          assigns << <<-RUBY_EVAL 
+            begin
+              #{ name.first } = opts.key?(:#{ name.first }) ? opts.delete(:#{ name.first }) : args.fetch(#{ index })
+            rescue 
+              raise ArgumentError.new('passing `#{ name.first }` is required')
+            end
+          RUBY_EVAL
+        end
+      end
+
+      klass.module_eval <<-RUBY_EVAL, __FILE__, __LINE__
+        def __#{ meth }_with_keyword_arguments *args, &block
+          opts = args.last.kind_of?( Hash ) && args.size < #{ names.size } ? args.pop : {}
+          #{ assigns.join("\n") }
+          unless opts.empty?
+            raise ArgumentError.new("`\#{ opts.keys.join(', ') }` \#{ opts.size == 1 ? 'is not a recognized argument keyword' : 'are not recognized argument keywords' }") 
+          end
+          __original_#{ meth } #{ names.collect{ |n| n.first }.join(', ') }, &block
+        end
+        
+        alias __original_#{ meth } #{ meth }
+        alias #{ meth } __#{ meth }_with_keyword_arguments
+      RUBY_EVAL
+    end
+  end
+  alias :named_args_for :named_arguments_for
+  alias :named_args     :named_arguments_for
+end

data/lib/arguments/mri.rb

@@ -0,0 +1,9 @@
+gem 'ParseTree', '>= 3.0.3'
+require 'parse_tree'
+
+module Arguments
+  def self.ast_for_method klass, method
+    ParseTree.translate( klass, method ).assoc(:scope).assoc(:block)
+  end
+end
+

data/lib/arguments/vm.rb

@@ -0,0 +1,21 @@
+gem 'ruby_parser', '>= 2.0.2'
+require 'ruby_parser'
+
+module Arguments
+  class PermissiveRubyParser < RubyParser
+    def on_error t, val, vstack
+      @rescue = vstack.first
+    end
+
+    def parse str, file = "(string)"
+      super || @rescue
+    end
+  end
+  
+  def self.ast_for_method klass, method
+    source, line = klass.instance_method(method).source_location
+    str = IO.readlines( source )[ (line-1)..-1 ].join
+    ast = PermissiveRubyParser.new.parse( str )
+    ast.assoc( :defn ) or ast
+  end
+end

data/spec/arguments_spec.rb

@@ -0,0 +1,151 @@
+require 'rubygems'
+require "#{ dir = File.dirname __FILE__ }/../lib/arguments"
+require 'benchmark'
+
+
+# TODO: Refactor specs for clarity and better coverage
+describe Arguments do
+
+  before do
+    Object.send(:remove_const, 'Klass') rescue nil
+    load "#{ dir }/klass.rb"
+    @instance = Klass.new
+  end
+
+  it "should not respond to named_arguments" do
+    lambda { Klass.new.send( :named_arguments_for ) }.should raise_error( NoMethodError )
+  end
+
+  it "shouldn't break defaults" do
+    @instance.two(1).should == [1, 2, Klass.new]
+  end
+  
+  it "should allow passing named argument" do
+    Klass.send( :named_arguments_for, :two )
+    @instance.two(1, :three => 3).should == [1, 2, 3]
+  end
+  
+  it "should raise ArgumentError if not passing required params" do
+    Klass.send( :named_arguments_for, :two )
+    error =
+    begin 
+      @instance.two( :three => 3 )
+    rescue ArgumentError => e
+      e
+    end
+    error.to_s.should == "passing `one` is required"
+  end
+  
+  it "should override passed value with hash" do
+    Klass.send( :named_arguments_for, :two )
+    @instance.two( :one => nil ).should == [nil, 2, Klass.new]
+  end
+  
+  it "should allow overriding with nil" do
+    Klass.send( :named_arguments_for, :two )
+    @instance.two( 1, :three => nil ).should == [1, 2, nil]
+  end
+  
+  it "should pass block" do
+    Klass.send( :named_arguments_for, :with_block )
+    @instance.with_block( 1, :three => nil, :two => 'something' ){ :block }.should == [1, 'something', nil, :block]
+  end
+  
+  it "should patch methods that accept proc as argument" do
+    Klass.send( :named_arguments_for, :with_block2 )
+    @instance.with_block2(1, :three => nil, :two => 'something'){ :block }.should == [1, 'something', nil, :block]
+  end
+  
+  it "should override defaults on standard passing" do
+    Klass.send( :named_arguments_for, :asr )
+    @instance.asr(0, 1, :curve => 3).should == [0, 1, 1, 3]
+  end
+
+  it "should work with class methods" do
+    (class << Klass; self; end).send( :named_arguments_for, :k_method )
+    Klass.k_method(:d => :d).should == [1, 2, 3, :d]
+  end
+  
+  it "should override defaults on standard passing" do
+    Klass.send( :named_arguments_for, 'self.k_method' )
+    Klass.k_method(:d => :d).should == [1, 2, 3, :d]
+  end
+  
+  it "should not use options if all arguments are passed" do
+    Klass.send( :named_arguments_for, :two )
+    @instance.two( 1, 2, :three => nil ).should == [1, 2, {:three => nil}]
+  end
+  
+  it "should raise ArgumentError if passing a not recoginized keyword" do
+    Klass.send( :named_arguments_for, :two )
+    error =
+    begin 
+      @instance.two( 1, :four => nil )
+    rescue ArgumentError => e
+      e
+    end
+    error.to_s.should == "`four` is not a recognized argument keyword"
+  end
+  
+  it "should raise ArgumentError if passing recoginized keywords" do
+    Klass.send( :named_arguments_for, :two )
+    error =
+    begin 
+      @instance.two( 1, :four => nil, :five => nil  )
+    rescue ArgumentError => e
+      e
+    end
+    error.to_s.should == "`four, five` are not recognized argument keywords"
+  end
+  
+  it "should not patch methods that accept no args" do
+    Klass.send( :named_arguments_for, :no_args )
+    lambda { @instance.no_args(1) }.should raise_error(ArgumentError)
+    @instance.no_args.should be_nil
+  end
+  
+  it "should not patch methods that use splatter op" do
+    Klass.send( :named_arguments_for, :splatted )
+    @instance.splatted(1, :args => 1).should == [1, {:args => 1}]
+  
+    Klass.send( :named_arguments_for, :splatted2 )
+    @instance.splatted2(:a => 1, :"*rest" => 3).should == [{:a => 1, :'*rest' => 3}, []]
+  
+    Klass.send( :named_arguments_for, :splatted3 )
+    @instance.splatted3(:a => 1, :"*args" => 3).should == [{:a => 1, :"*args" => 3}, []]
+    @instance.splatted3(1, :b => 2, :args => 1).should == [1, [{:b => 2, :args => 1}]]
+  
+    Klass.send( :named_arguments_for, :splatted4 )
+    @instance.splatted4(1, :b => 2, :args => 1).should == [1, {:b => 2, :args => 1}, []]
+  end
+  
+  it "should not patch methods with no optionals" do
+    Klass.send( :named_arguments_for, :no_opts )
+    @instance.method(:no_opts).arity.should == 3
+  end
+  
+  it "should patch all methods" do
+    Klass.send( :named_args )
+    @instance.two(1, :three => 3).should == [1, 2, 3]
+  end
+  
+  it "should benchmark without hack" do
+    puts Benchmark.measure {
+      1_000.times do
+        @instance.with_block( 1, :three => nil ){ :block }
+      end
+    }
+  end
+  
+
+  it "should benchmark with hack" do
+    puts Benchmark.measure {
+      Klass.send( :named_arguments_for, :with_block )
+    }
+    puts Benchmark.measure {
+      1_000.times do
+        @instance.with_block( 1, :three => nil ){ :block }
+      end
+    }
+  end
+end

data/spec/klass.rb

@@ -0,0 +1,58 @@
+class Klass
+  def three one = 1, two = 2, three = 3
+    [one, two, three]
+  end
+  
+  def two one, two = 2, three = Klass.new
+    [one, two, three]
+  end
+  
+  def with_block one, two = 2, three = 3
+    [one, two, three, yield]
+  end
+  
+  def with_block2 one, two = 2, three = 3, &action
+    [one, two, three, action.call]
+  end
+
+  def asr attackTime = 3, sustainLevel = 2, releaseTime = 1, curve = 0
+    [attackTime, sustainLevel, releaseTime, curve]
+  end
+  
+  def no_args
+  end
+
+  def splatted *args
+    args
+  end
+
+  def splatted2 a=1, *rest
+    [a, rest]
+  end
+
+  def splatted3 a, *rest
+    [a, rest]
+  end
+  
+  def splatted4 a, b=1, *rest
+    [a, b, rest]
+  end
+
+  def no_opts a, b, c
+    [a, b, c]
+  end
+  
+  class << self
+    def asr attackTime = 3, sustainLevel = 2, releaseTime = 1, curve = 0
+      [attackTime, sustainLevel, releaseTime, curve]
+    end
+    
+    def k_method a = 1, b = 2, c = 3, d = 4
+      [a, b, c, d]
+    end
+  end
+  
+  def == other
+    self.class == other.class
+  end
+end

data/spec/module.rb

@@ -0,0 +1,9 @@
+module TestMod; 
+ def go(a) 
+   a
+ end
+end 
+
+class IncludesTestMod
+ include TestMod
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification 
+name: arguments
+version: !ruby/object:Gem::Version 
+  version: "0.6"
+platform: ruby
+authors: 
+- Macario Ortega
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-17 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: ruby_parser
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.0.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: ParseTree
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 3.0.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: ruby2ruby
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 1.1.9
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rubyforge
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.0.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: gemcutter
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.3.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.5.0
+    version: 
+description: |-
+  You don't have to wait until Ruby 2.0 to get (named|keyword) arguments support.
+  Arguments has been tested with Ruby 1.8.6 and ruby 1.9.1 and eventually will work with JRuby (if someone is interested in contributing, I guess is possible since merb-action-args works with JRuby)
+email: 
+- macarui@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- arguments.gemspec
+- lib/arguments.rb
+- lib/arguments/class.rb
+- lib/arguments/mri.rb
+- lib/arguments/vm.rb
+- spec/arguments_spec.rb
+- spec/klass.rb
+- spec/module.rb
+has_rdoc: true
+homepage: http://github.com/maca/arguments
+licenses: []
+
+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"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: arguments
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: You don't have to wait until Ruby 2.0 to get (named|keyword) arguments support
+test_files: []
+