maca-arguments 0.4.7.8

data/History.txt

@@ -0,0 +1,13 @@
+== 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

data/Manifest.txt

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

data/README.rdoc

@@ -0,0 +1,92 @@
+= arguments
+
+Keyword arguments support now!
+
+== 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
+
+      named_args_for :meth
+
+      class << self
+        def class_method(a = :a, b = :b, c = :c)
+          [a,b,c]
+        end
+        named_args_for :class_method
+      end
+    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]
+    
+
+
+* #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
+* 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]
+
+
+== 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.
+* If last argument is a Hash is taken as an options Hash and not assigned to the argument varible, if you want to pass a has as a last argument use keywords.
+
+== TODO
+
+Don't use last argument (Hash) as options if passed total number of args.
+
+== REQUIREMENTS:
+
+Ruby 1.8.6:
+
+- ParseTree >= 3.0.3
+- Ruby2Ruby 1.1.9
+
+== INSTALL:
+
+    sudo gem install maca-arguments –source http://gems.github.com
+
+== 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,30 @@
+%w[rubygems rake rake/clean fileutils newgem rubigen hoe].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/arguments'
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new('arguments', Arguments::VERSION) do |p|
+  p.developer('Macario Ortega', 'macarui@gmail.com')
+  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  # p.rubyforge_name       = p.name # TODO this is default value
+
+  p.extra_deps = [
+    ['ParseTree','>= 3.0.3'],
+    ['ruby2ruby', '= 1.1.9']
+  ]
+
+  p.extra_dev_deps = [
+    ['newgem', ">= #{::Newgem::VERSION}"]
+  ]
+  
+  p.clean_globs |= %w[**/.DS_Store tmp *.log]
+  # path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
+  # p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+  p.rsync_args = '-av --delete --ignore-errors'
+end
+
+require 'newgem/tasks' # load /tasks/*.rake
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# task :default => [:spec, :features]

data/lib/arguments.rb

@@ -0,0 +1,11 @@
+$:.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.4.7'
+end

data/lib/arguments/class.rb

@@ -0,0 +1,72 @@
+module NamedArgs
+  def named_arguments_for *methods
+    methods = instance_methods - Object.methods if methods.empty?
+    
+    methods.each do |meth|
+      if(meth.to_s.include?('.'))
+         # they may have passed in a parameter like :klass.method for a class method
+         klass, meth = meth.to_s.split('.')
+         klass = eval(klass) # from "Klass" to Klass
+         klass = (class << klass; self; end)
+         names = Arguments.names klass, meth
+      else
+        names  = Arguments.names self, meth
+        klass = self
+      end
+      next if names.empty? || names.any?{|name| name[0] == :"*args"}
+      
+      assigns = []
+      names.each_with_index do |name, index|
+        unless name.size == 1
+          # optionals
+          assigns << <<-RUBY_EVAL
+            #{ name.first } =
+            if opts.key?(:#{ name.first })
+              opts[:#{ name.first }]
+            else
+              args.size >= #{ index + 1 } ? args[#{ index }] : #{ name.last }
+            end
+          RUBY_EVAL
+        else
+          # requireds
+          assigns << <<-RUBY_EVAL 
+            begin
+              #{ name.first } = opts.key?(:#{ name.first }) ? opts[:#{ name.first }] : args.fetch(#{ index })
+            rescue 
+              raise ArgumentError.new('passing `#{ name.first }` is required')
+            end
+          RUBY_EVAL
+        end
+      end
+
+      line_loc = __LINE__
+      new_code = <<-RUBY_EVAL
+        def __new_#{ meth } *args, &block
+          opts = args.last.kind_of?( Hash ) ? args.pop : {}
+          #{ assigns.join("\n") }
+          __original_#{ meth } #{ names.collect{ |n| n.first }.join(', ') }, &block
+        end
+        
+        alias __original_#{ meth } #{ meth }
+        alias #{ meth } __new_#{ meth }
+      RUBY_EVAL
+
+      puts "wrapping #{ meth } with this code #{new_code}" if $VERBOSE
+
+      begin
+        klass.module_eval new_code, __FILE__ + '.approximately', line_loc + 1
+      rescue SyntaxError => e
+          puts "warning--unable to wrap method #{ meth } -- possibly a syntax exception or it's not all on one line in 1.9 -- #{new_code}"
+          throw e
+      end
+        
+    end
+  end
+
+  alias :named_args_for :named_arguments_for
+  alias :named_args     :named_arguments_for
+  
+end
+
+class Class; include NamedArgs; end
+class Module; include NamedArgs; end

data/lib/arguments/mri.rb

@@ -0,0 +1,28 @@
+require 'rubygems'
+gem 'ParseTree', '>= 3.0.3'
+require 'parse_tree'
+
+gem 'ruby2ruby', '= 1.1.9'
+require 'ruby2ruby'
+
+module Arguments
+  def self.names klass, method
+    args = ParseTree.translate( klass, method ).assoc(:scope).assoc(:block).assoc(:args)
+    args = args[1..-1]
+    return [] if args.empty?
+    if args.last.instance_of? Array
+      vals = args.pop[1..-1]
+    else
+      # if it has no optionals then vals is empty
+      vals = []
+    end
+
+    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/vm.rb

@@ -0,0 +1,12 @@
+
+module Arguments
+  def self.names klass, method
+    source, line = klass.instance_method( method ).source_location rescue klass.method( method ).source_location
+    return [] unless source and line
+    str = IO.readlines(source)[ line - 1 ]
+    return [] if str.match(/\*\w+/)
+    throw 'poor comma' + str if str  =~ /,\W*&/
+    str.match(/def\s*\w+\s*\(?\s*([^)\n]*)/)[1] #This could look better
+      .scan(/(\w+)(?:\s*=\s*([^,]+))|(\w+)/).map{ |e| e.compact  }.collect{|e2| e2[1].gsub!(/\W*\&.*/, '') if e2[1]; e2}
+  end
+end

data/spec/arguments_spec.rb

@@ -0,0 +1,142 @@
+require "#{ File.dirname __FILE__ }/../lib/arguments"
+require 'benchmark'
+
+describe Arguments do
+
+  before do
+    Object.send(:remove_const, 'Klass') rescue nil
+    load "#{ File.dirname __FILE__ }/klass.rb"
+    load "#{ File.dirname __FILE__ }/module.rb"
+    @instance = Klass.new
+  end
+  
+  it "should respond to named_arguments" do
+    Klass.send( :named_arguments_for, :three )
+  end
+  
+  it "should not respond to named_arguments" do
+    lambda { Klass.new.send( :named_arguments_for ) }.should raise_error( NoMethodError )
+  end
+  
+  it "should get argument names with literals" do
+    Arguments.names( Klass, :two ).collect{ |a, b| [a.to_sym, b].compact }.
+      should == [[:one], [:two, "2"], [:three, "Klass.new"]]
+  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 )
+    lambda { @instance.two( :three => 3 ) }.should raise_error(ArgumentError)
+  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 override defaults on standard passing" do
+    Klass.send( :named_arguments_for, :asr )
+    @instance.asr(0, 1, 2, :curve => 3).should == [0,1,2,3]
+  end
+
+  it "should work with methods that have no optionals" do
+    Klass.send( :named_arguments_for, :go5 )
+    @instance.go5(1, 2).should == [1,2]
+    @instance.go5(1, :b => 3).should == [1,3]
+    @instance.go5(:a => 4, :b => 5).should == [4, 5]
+  end
+ 
+  it "should work with class methods" do
+    Klass.asr(0, 1, 2, :curve => 3).should == [0,1,2,3]
+  end
+  
+  it "should work with class methods" do
+    Klass.send( :named_arguments_for, :"Klass.class_method")
+    Klass.class_method(:a => 1).should == 1
+  end
+
+  it "should work with class methods called like :self.method_name" do
+    Klass.send( :named_arguments_for, :"self.class_method2")
+    Klass.class_method2(:a => 1).should == 1
+  end
+
+  it "should work with class methods passed in by string instead of symboL" do
+    Klass.send( :named_arguments_for, "self.class_method3")
+    Klass.class_method3(:a => 1).should == 1
+  end
+
+  it "should not patch methods that accept no args" do
+    # Arguments.should_not_receive(:names)
+    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, :"*args" => 3).should == []
+
+    Klass.send( :named_arguments_for, :splatted3 )
+    @instance.splatted3(:a => 1, :"*args" => 3).should == []
+    @instance.splatted3(1, :b => 2, :args => 1).should == [{:b => 2, :args => 1}]
+
+    Klass.send( :named_arguments_for, :splatted4 )
+    @instance.splatted4(1, :b => 2, :args => 1).should == []
+
+  end
+  
+  it "should patch methods with no optionals" do
+    Klass.send( :named_arguments_for, :no_opts )
+    lambda { @instance.no_opts(1,2, :a => 1)}.should raise_error(ArgumentError)
+    @instance.no_opts(1,2, :c => 1).should == 1
+  end
+  
+  it "should patch all methods" do
+    Klass.send( :named_args )
+  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 work with modules too" do
+    TestMod.send( :named_arguments_for, :go)
+    IncludesTestMod.new.go(:a => 1).should == 1
+  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,68 @@
+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 go5(a, b)
+    [a, b] 
+  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, *args
+    args
+  end
+
+  def splatted3 a, *args
+    args
+  end
+  
+  def splatted4 a, b=1, *args
+    args
+  end
+
+  def no_opts a, b, c
+    c
+  end
+  
+  class << self
+    def asr attackTime = 3, sustainLevel = 2, releaseTime = 1, curve = 0
+      [attackTime, sustainLevel, releaseTime, curve]
+    end
+    named_arguments_for :asr
+
+    def class_method(a)
+      a
+    end
+
+    def class_method2(a)
+      a
+    end
+    
+    def class_method3(a)
+      a
+    end
+  end
+  
+  def == other
+    self.class == other.class
+  end
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification 
+name: maca-arguments
+version: !ruby/object:Gem::Version 
+  version: 0.4.7.8
+platform: ruby
+authors: 
+- Macario Ortega
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-03 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !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: newgem
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.4.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.7
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.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
+email: 
+- macarui@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- lib/arguments.rb
+- lib/arguments/class.rb
+- lib/arguments/mri.rb
+- lib/arguments/vm.rb
+- spec/arguments_spec.rb
+- spec/klass.rb
+has_rdoc: true
+homepage: 
+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: 2
+summary: You don't have to wait until Ruby 2.0 to get (named|keyword) arguments support
+test_files: []
+