get_args 1.0.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Clinton R. Nixon
+
+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/README.rdoc

@@ -0,0 +1,30 @@
+= get_args
+
+Extracted from Merb, get_args allows you to query a method for its argument names and defaults.
+
+This gem exists so you can get this functionality without having to include all of Merb.
+
+== Usage
+
+    class Dummy
+      def one_arg(foo); end
+      def multiple_args(foo, bar, baz); end
+      def optional_args(foo, bar = 1); end
+      def star_args(*foo); end
+    end
+
+    Dummy.instance_method(:one_arg).get_args
+    # => [[[:foo]], []]
+
+    Dummy.instance_method(:multiple_args).get_args
+    # => [[[:foo], [:bar], [:baz]], []]
+
+    Dummy.instance_method(:optional_args).get_args
+    # => [[[:foo], [:bar, 1]], [:bar]]
+
+    Dummy.instance_method(:star_args).get_args
+    # => [[[%s[*foo]]], []]
+
+== Copyright
+
+Copyright (c) 2009 Clinton R. Nixon. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,43 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "get_args"
+    gemspec.summary = "Allows one to introspect on the argument names and defaults for a method."
+    gemspec.description = %Q[
+      Extracted from Merb, get_args allows you to query a method for its argument names and defaults.
+      
+      This gem exists so you can get this functionality without having to include all of Merb.
+    ].strip
+    gemspec.email = "crnixon@gmail.com"
+    gemspec.homepage = "http://github.com/crnixon/get_args"
+    gemspec.authors = ["maiha", "Yehuda Katz"]
+    gemspec.add_dependency('extlib', '>= 0.9.13')
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "get_args #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/get_args.rb

@@ -0,0 +1,20 @@
+require 'extlib'
+
+$:.push(File.dirname(__FILE__))
+
+if RUBY_PLATFORM == "java"
+  require 'jruby_args'
+elsif RUBY_VERSION < "1.9"
+  require 'mri_args'
+else
+  require 'vm_args'
+end
+
+class UnboundMethod
+  include GetArgs
+end
+
+class Method
+  include GetArgs
+end
+

data/lib/jruby_args.rb

@@ -0,0 +1,67 @@
+require 'java'
+require 'jruby'
+
+module GetArgs
+  Methods = org.jruby.internal.runtime.methods
+
+  def get_args
+    real_method = JRuby.reference(self)
+
+    # hack to expose a protected field; could be improved in 1.1.5
+    method_field = org.jruby.RubyMethod.java_class.declared_field(:method)
+
+    method_field.accessible = true
+    
+    dyn_method = method_field.value(real_method)
+
+    case dyn_method
+    when Methods.MethodArgs
+      return build_args(dyn_method.args_node)
+    else
+      raise "Can't get args from method: #{self}"
+    end
+  end
+
+  def build_args(args_node)
+    args = []
+    required = []
+    optional = []
+
+    # required args
+    if (args_node.args && args_node.args.size > 0)
+      required << args_node.args.child_nodes.map { |arg| [arg.name.to_s.intern] }
+    end
+    
+    # optional args
+    if (args_node.opt_args && args_node.opt_args.size > 0)
+      optional << args_node.opt_args.child_nodes.map do |arg|
+        name = arg.name.to_s.intern
+        value_node = arg.value_node
+        case value_node
+        when org.jruby.ast::FixnumNode
+          value = value_node.value
+        when org.jruby.ast::SymbolNode
+          value = value_node.get_symbol(JRuby.runtime)
+        when org.jruby.ast::StrNode
+          value = value_node.value
+        else
+          value = nil
+        end
+        [name, value]
+      end
+    end
+
+    first_args = required.first
+    optional.first.each {|arg| first_args << arg} if optional.first
+    
+    args = [first_args]
+    
+    rest = args_node.rest_arg_node
+    args << (rest ? rest.name.to_s.intern : nil)
+    
+    block = args_node.block_arg_node
+    args << (block ? block.name.to_s.intern : nil)
+
+    args
+  end
+end

data/lib/mri_args.rb

@@ -0,0 +1,88 @@
+require 'parse_tree'
+require 'ruby2ruby'
+
+class ParseTreeArray < Array
+  R2R = Object.const_defined?(:Ruby2Ruby) ? Ruby2Ruby : RubyToRuby
+  
+  def self.translate(*args)
+    sexp = ParseTree.translate(*args)
+    # ParseTree.translate returns [nil] if called on an inherited method, so walk
+    # up the inheritance chain to find the class that the method was defined in
+    unless sexp.first
+      klass = args.first.ancestors.detect do |klass| 
+        klass.public_instance_methods(false).include?(args.last.to_s)
+      end
+      sexp = ParseTree.translate(klass, args.last) if klass
+    end
+    sexp = Unifier.new.process(sexp)
+    self.new(sexp)
+  end
+  
+  def deep_array_node(type = nil)
+    each do |node|
+      return ParseTreeArray.new(node) if node.is_a?(Array) && (!type || node[0] == type)
+      next unless node.is_a?(Array)
+      return ParseTreeArray.new(node).deep_array_node(type)
+    end
+    nil
+  end
+
+  def arg_nodes
+    self[1..-1].inject([]) do |sum,item|
+      sum << [item] unless item.is_a?(Array)
+      sum
+    end
+  end
+  
+  def get_args
+    if arg_node = deep_array_node(:args)
+      # method defined with def keyword
+      args = arg_node.arg_nodes
+      default_node = arg_node.deep_array_node(:block)
+      return [args, []] unless default_node
+    else
+      # assuming method defined with Module#define_method
+      return [[],[]]
+    end
+    
+    # if it was defined with def, and we found the default_node,
+    # that should bring us back to regularly scheduled programming..
+    lasgns = default_node[1..-1]
+    lasgns.each do |asgn|
+      args.assoc(asgn[1]) << eval(R2R.new.process(asgn[2]))
+    end
+    [args, (default_node[1..-1].map { |asgn| asgn[1] })]
+  end
+
+end
+
+# Used in mapping controller arguments to the params hash.
+# NOTE: You must have the 'ruby2ruby' gem installed for this to work.
+#
+# ==== Examples
+#   # In PostsController
+#   def show(id)  #=> id is the same as params[:id]
+module GetArgs
+  
+  # ==== Returns
+  # Array:: Method arguments and their default values.
+  #
+  # ==== Examples
+  #   class Example
+  #     def hello(one,two="two",three)
+  #     end
+  #
+  #     def goodbye
+  #     end
+  #   end
+  #
+  #   Example.instance_method(:hello).get_args
+  #     #=> [[:one], [:two, "two"], [:three, "three"]]
+  #   Example.instance_method(:goodbye).get_args  #=> nil
+  def get_args
+    klass, meth = self.to_s.split(/ /).to_a[1][0..-2].split("#")
+    # Remove stupidity for #<Method: Class(Object)#foo>
+    klass = $` if klass =~ /\(/
+    ParseTreeArray.translate(Object.full_const_get(klass), meth).get_args
+  end
+end

data/lib/vm_args.rb

@@ -0,0 +1,27 @@
+begin
+  require "methopara"
+rescue
+  puts "Make sure you have methopara http://github.com/genki/methopara installed if you want to use action args on Ruby 1.9"
+end
+
+module GetArgs
+  def get_args
+    unless respond_to?(:parameters)
+      raise NotImplementedError, "Ruby #{RUBY_VERSION} doesn't support #{self.class}#parameters"
+    end
+
+    required = []
+    optional = []
+
+    parameters.each do |(type, name)|
+      if type == :opt
+        required << [name, nil]
+        optional << name
+      else
+        required << [name]
+      end
+    end
+
+    return [required, optional]
+  end
+end

data/test/helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'get_args'
+
+class Test::Unit::TestCase
+end

data/test/test_get_args.rb

@@ -0,0 +1,17 @@
+require 'helper'
+
+class Dummy
+  def one_arg(foo); end
+  def multiple_args(foo, bar, baz); end
+  def optional_args(foo, bar = 1); end
+  def star_args(*foo); end
+end
+
+class TestGetArgs < Test::Unit::TestCase
+  def test_get_args
+    assert_equal [[[:foo]], []], Dummy.instance_method(:one_arg).get_args
+    assert_equal [[[:foo], [:bar], [:baz]], []], Dummy.instance_method(:multiple_args).get_args
+    assert_equal [[[:foo], [:bar, 1]], [:bar]], Dummy.instance_method(:optional_args).get_args
+    assert_equal [[[%s[*foo]]], []], Dummy.instance_method(:star_args).get_args
+  end
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification 
+name: get_args
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- maiha
+- Yehuda Katz
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-11 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: extlib
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.13
+    version: 
+description: |-
+  Extracted from Merb, get_args allows you to query a method for its argument names and defaults.
+        
+        This gem exists so you can get this functionality without having to include all of Merb.
+email: crnixon@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/get_args.rb
+- lib/jruby_args.rb
+- lib/mri_args.rb
+- lib/vm_args.rb
+- test/helper.rb
+- test/test_get_args.rb
+has_rdoc: true
+homepage: http://github.com/crnixon/get_args
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Allows one to introspect on the argument names and defaults for a method.
+test_files: 
+- test/helper.rb
+- test/test_get_args.rb