method_args 0.0.3

data/README

@@ -0,0 +1,56 @@
+= Download
+Type 'gem install method_args' or download manually at 
+http://rubyforge.org/projects/method-args
+
+= Synopses
+
+This extension adds args method to the Method class. Example:
+  
+  require 'method_args'
+  class X
+    def hello(foo, bar)
+      nil
+    end
+  end
+  x = X.new
+  m = x.method(:hello)
+  m.args  # => [:foo, :bar]
+
+  
+To differentiate between the different types of arguments that could be returned the library provides
+ Method#required_args
+ Method#optional_args
+ Method#splat_arg
+For example:
+  
+  class X
+    def hello(i, love = 2, *techno)
+    end
+  end
+  method = X.new.method(:hello)
+  method.required_args # => [:i]
+  method.optional_args # => [:love]
+  method.splat_arg # => :techno
+  
+Method#args does not support methods written in C (and never will). To test if you can call args methods on a certain method use Method#args?. Example:
+
+  X.new.args? # => true
+  built_in = "string".method(:split)
+  built_in.args? # => false
+  built_in.args  # => raises StandardError
+
+Method#args does not support block arguments (but might in the future).
+
+= Acknowledgments
+Most of the code here is extracted from ParseTree by Ryan Davis
+
+= License
+(The MIT License)
+
+Copyright (c) 2007 Ryan Dahl <ry@tinyclouds.org>
+
+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, sub-license, 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 NON-INFRINGEMENT. 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,43 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/clean'
+require 'rake/gempackagetask'
+
+CLEAN.add 'method_args.o'
+CLOBBER.add %w{Makefile mkmf.log method_args.{bundle,so,obj,pdb,lib,def,exp}}
+PKG_FILES = %w{README Rakefile extconf.rb test.rb method_args.c}
+
+Rake::TestTask.new do |t|
+  t.test_files = 'test.rb'
+  t.verbose = true
+end
+
+spec = Gem::Specification.new do |s|
+  s.version = '0.0.3'
+  s.name    = 'method_args'
+  s.summary = 'Provides Method#args for inspecting arguments'
+  s.description = s.summary
+  s.test_files  = 'test.rb'
+  s.author = 'Ry Dahl'
+  s.email  = 'ry@tinyclouds.org'
+  s.files  = PKG_FILES
+  s.extensions   = 'extconf.rb'
+  s.require_path = '.'
+  s.autorequire  = 'rake'
+  s.required_ruby_version = '>= 1.8.4'
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.need_zip = true
+end
+
+task :default => [:compile, :test]
+
+desc 'Compile the code'
+task :compile => ['Makefile'] do |t| 
+  sh 'make'
+end
+
+file 'Makefile' do |t| 
+  ruby 'extconf.rb'
+end

data/extconf.rb

@@ -0,0 +1,6 @@
+require 'mkmf'
+
+dir_config("method_args")
+#have_library("c", "main")
+
+create_makefile("method_args")

data/method_args.c

@@ -0,0 +1,218 @@
+#include <stdio.h>
+#include <ruby.h>
+#include <node.h>
+#include <version.h>
+
+/* <DebugStuff> use the --debug argument to ruby to enable */
+const char *node_names[] = {"METHOD", "FBODY", "CFUNC", "SCOPE", "BLOCK", 
+  "IF", "CASE", "WHEN", "OPT_N", "WHILE", "UNTIL", "ITER", "FOR", "BREAK", 
+  "NEXT", "REDO", "RETRY", "BEGIN", "RESCUE", "RESBODY", "ENSURE", "AND", 
+  "OR", "NOT", "MASGN", "LASGN", "DASGN", "DASGN_CURR", "GASGN", "IASGN", 
+  "CDECL", "CVASGN", "CVDECL", "OP_ASGN1", "OP_ASGN2", "OP_ASGN_AND", 
+  "OP_ASGN_OR", "CALL", "FCALL", "VCALL", "SUPER", "ZSUPER", "ARRAY", 
+  "ZARRAY", "HASH", "RETURN", "YIELD", "LVAR", "DVAR", "GVAR", "IVAR", 
+  "CONST", "CVAR", "NTH_REF", "BACK_REF", "MATCH", "MATCH2", "MATCH3", 
+  "LIT", "STR", "DSTR", "XSTR", "DXSTR", "EVSTR", "DREGX", "DREGX_ONCE", 
+  "ARGS", "ARGSCAT", "ARGSPUSH", "SPLAT", "TO_ARY", "SVALUE", "BLOCK_ARG", 
+  "BLOCK_PASS", "DEFN", "DEFS", "ALIAS", "VALIAS", "UNDEF", "CLASS", "MODULE",
+  "SCLASS", "COLON2", "COLON3", "CREF", "DOT2", "DOT3", "FLIP2", "FLIP3", 
+  "ATTRSET", "SELF", "NIL", "TRUE", "FALSE", "DEFINED", "NEWLINE", "POSTEXE",
+  "ALLOCA", "DMETHOD", "BMETHOD", "MEMO", "IFUNC", "DSYM", "ATTRASGN", "LAST"
+};
+
+void inspect_node(NODE *n) {
+  if(n) {
+    fprintf(stderr, "node %s: %s%s%s\n",
+      node_names[nd_type(n)],
+      (RNODE(n)->u1.node != NULL ? "u1 " : "   "),
+      (RNODE(n)->u2.node != NULL ? "u2 " : "   "),
+      (RNODE(n)->u3.node != NULL ? "u3 " : "   "));
+  } else {
+    fprintf(stderr, "null node!\n");
+  }
+}
+/* </DebugStuff> */
+
+NODE* get_arg_node(NODE *body) {
+  NODE *node = NULL, *block, *args;
+  
+  if(RTEST(ruby_debug)) { inspect_node(body); } 
+  if(!body) { return NULL; }  
+  
+  block = body->nd_next;
+  if(RTEST(ruby_debug)) { inspect_node(block); }
+  if(!block) { return NULL; }
+  
+  args = block->nd_head;
+  if(RTEST(ruby_debug)) { inspect_node(args); }
+  if(!args) { return NULL; }
+  
+  return args;
+}
+
+NODE* get_body_node(VALUE method) { 
+#if RUBY_VERSION_CODE < 190
+  /* Exposing struct METHOD is terrible but allows for easily accessing  body.
+   * We're moving to 1.9 soon so we don't need to do this in the future */
+  struct METHOD { 
+    VALUE klass, rklass;
+    VALUE recv;
+    ID id, oid;
+    int safe_level;
+    NODE *body;
+  };
+  struct METHOD *data;
+  Data_Get_Struct(method, struct METHOD, data);
+  return data->body;
+#else
+  /* 1.9 has Method#receiver. use it instead of peeking at secret structures 
+   */
+  ID id;
+  VALUE recv;
+  recv = rb_funcall(method, rb_intern('receiver'), 0);
+  id = rb_to_id(recv);
+  st_lookup(RCLASS(recv)->m_tbl, id, &n);
+  return (NODE*)n;
+#endif
+}
+
+VALUE required_args(ID* locals, int max_args) {
+  int i;
+  VALUE arg_array = rb_ary_new();  
+  for (i = 0; i < max_args; i++) {
+    rb_ary_push(arg_array, ID2SYM(locals[i + 3]));
+  }
+  
+  if(RTEST(ruby_debug)) {
+    fprintf(stderr, "required_args: %s\n",
+      RSTRING(rb_funcall(arg_array, rb_intern("inspect"), 0))->ptr);
+  }
+  
+  return arg_array;
+}
+
+VALUE optional_args(NODE *args, ID *locals, int max_args) {
+  NODE *optnode;
+  int i;
+  VALUE arg_array = rb_ary_new();  
+  
+  i =  max_args; 
+  for(optnode = args->nd_opt; optnode; optnode = optnode->nd_next) {
+    rb_ary_push(arg_array, ID2SYM(locals[i + 3]));
+    i++;
+  }
+  
+  if(RTEST(ruby_debug)) {
+    fprintf(stderr, "optional_args: %s\n",
+      RSTRING(rb_funcall(arg_array, rb_intern("inspect"), 0))->ptr);
+  }
+  
+  return arg_array;
+}
+
+VALUE optional_args_length(NODE *args) {
+  NODE *optnode;
+  int l=0;
+  
+  for(optnode = args->nd_opt; optnode; optnode = optnode->nd_next) { l++; }
+  return l;
+}
+
+/* arg_index should be optional_args.length + max_args */
+VALUE splat_arg(NODE *args, ID *locals, int max_args) {
+  long arg_count = (long)args->nd_rest;
+  int arg_index = optional_args_length(args) + max_args;
+  
+  if(RTEST(ruby_debug)) {
+    fprintf(stderr, "splat_arg: arg_count = %ld\n", arg_count);
+    fprintf(stderr, "splat_arg: arg_index = %d\n", arg_index);
+  } 
+  
+  /* splat argument */
+  if (arg_count > 0 && locals[arg_index + 3]) {
+    if(RTEST(ruby_debug)) { fprintf(stderr, "hello world\n"); }
+    return ID2SYM(locals[arg_index + 3]);
+  } else {
+    return Qnil;
+  }
+}
+
+VALUE rb_method_args_p(VALUE self) {
+  return get_arg_node(get_body_node(self)) ? Qtrue : Qfalse;
+}
+
+VALUE rb_method_args(VALUE self) {
+  NODE *args, *body = get_body_node(self);    
+  ID *locals;
+  VALUE array, splat;
+  int max_args;
+  
+  if(rb_method_args_p(self) == Qfalse) { 
+    rb_raise(rb_eStandardError, "Cannot find arguments for this method");    
+  }
+    
+  args = get_arg_node(body);
+  locals = body->nd_tbl;
+  max_args = args->nd_cnt;
+  
+  array = required_args(locals, max_args);
+  rb_ary_concat(array, optional_args(args, locals, max_args));
+  if((splat = splat_arg(args, locals, max_args)) != Qnil) {
+    rb_ary_push(array, splat);
+  }
+  
+  return array;
+}
+
+VALUE rb_method_required_args(VALUE self) {
+  NODE *args, *body;
+  
+  if(rb_method_args_p(self) == Qfalse) { 
+    rb_raise(rb_eStandardError, "Cannot find arguments for this method");    
+  }
+    
+  body = get_body_node(self);
+  args = get_arg_node(body);
+  
+  return required_args(body->nd_tbl, args->nd_cnt);
+}
+
+VALUE rb_method_optional_args(VALUE self) {
+  NODE *args, *body;
+  
+  if(rb_method_args_p(self) == Qfalse) { 
+    rb_raise(rb_eStandardError, "Cannot find arguments for this method");    
+  }  
+  body = get_body_node(self);
+  args = get_arg_node(body);
+  
+  return optional_args(get_arg_node(body), body->nd_tbl, args->nd_cnt);  
+}
+
+VALUE rb_method_splat_arg(VALUE self) {
+  NODE *args, *body = get_body_node(self);    
+  ID *locals;
+  int max_args; 
+  
+  if(rb_method_args_p(self) == Qfalse) { 
+    rb_raise(rb_eStandardError, "Cannot find arguments for this method");    
+  }
+  
+  args = get_arg_node(body);
+  locals = body->nd_tbl;
+  max_args = args->nd_cnt;
+  
+  return splat_arg(args, locals, max_args);
+}
+
+void Init_method_args() {
+  VALUE rb_cMethod;
+  rb_cMethod = rb_const_get(rb_cObject, rb_intern("Method"));
+  rb_define_method(rb_cMethod, "args", rb_method_args, 0);
+  rb_define_method(rb_cMethod, "required_args", rb_method_required_args, 0);
+  rb_define_method(rb_cMethod, "optional_args", rb_method_optional_args, 0);
+  rb_define_method(rb_cMethod, "splat_arg", rb_method_splat_arg, 0);
+  // rb_define_method(rb_cMethod, "block_arg", rb_method_block_arg, 0);
+  
+  rb_define_method(rb_cMethod, "args?", rb_method_args_p, 0);
+}

data/test.rb

@@ -0,0 +1,109 @@
+require 'test/unit'
+require 'method_args'
+
+class A
+  # Value of @@expected is [[required args], [optional args], splat arg]
+  @@expected = {}
+  
+  @@expected[:normal] = [[:alpha, :beta], [], nil]
+  def normal(alpha, beta); 2; end
+  def self.normal(alpha, beta); 2; end
+    
+    
+  @@expected[:no_arguments] = [[], [], nil]
+  def no_arguments
+    w = 2
+    "hello world"
+  end
+  def self.no_arguments
+    w = 2
+    "hello world"
+  end
+  
+  @@expected[:normal_and_optional] = [[:alpha], [:beta, :gamma], nil]
+  def normal_and_optional(alpha, beta = 2, gamma = 3)
+    2
+  end
+  def self.normal_and_optional(alpha, beta = 2, gamma = 3)
+    2
+  end
+  
+  @@expected[:with_splat] = [[:alpha], [], :beta]
+  def with_splat(alpha, *beta)
+    5
+  end
+  def self.with_splat(alpha, *beta)
+    5
+  end
+  
+  @@expected[:optional_w_splat] = [[], [:alpha], :beta]
+  def optional_w_splat(alpha=2, *beta); 5; end
+  def self.optional_w_splat(alpha=2, *beta); 5; end
+  
+  @@expected[:only_splat] = [[], [], :alpha]
+  def only_splat(*alpha); 5; end
+  def self.only_splat(*alpha); 5; end
+  
+  @@expected[:with_block] = [[:alpha], [], nil]
+  def with_block(alpha, &beta)
+    alpha
+    yield
+    2
+  end
+  def self.with_block(alpha, &beta)
+    alpha
+    yield
+    2
+  end
+end
+
+class MethodTest < Test::Unit::TestCase
+  
+  def setup
+    @methods = A.class_eval "@@expected"
+  end
+  
+  def each_method
+    [A.new, A].each do |object|
+      @methods.each_pair do |name, expected|
+        yield object.method(name), expected
+      end
+    end
+  end
+  
+  def test_required_args
+    each_method do |method, expected|
+      assert_equal expected[0], method.required_args, method.inspect
+    end
+  end
+  
+  def test_optional_args
+    each_method do |method, expected|
+      assert_equal expected[1], method.optional_args, method.inspect
+    end
+  end
+  
+  def test_splat_arg
+    each_method do |method, expected|
+      assert_equal expected[2], method.splat_arg, method.inspect
+    end
+  end
+  
+  def test_args
+    each_method do |method, expected|
+      assert_equal expected.flatten.compact, method.args, method.inspect
+    end
+  end
+  
+  def test_args?
+    each_method do |method, expected|
+      assert_equal true, method.args?, method.inspect
+    end
+  end
+  
+  def test_build_in_methods
+    m = "hello".method(:split)
+    assert_equal false, m.args?
+    assert_raises(StandardError) { m.args }
+  end
+end

metadata

@@ -0,0 +1,50 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.2
+specification_version: 1
+name: method_args
+version: !ruby/object:Gem::Version 
+  version: 0.0.3
+date: 2007-09-06 00:00:00 +02:00
+summary: Provides Method#args for inspecting arguments
+require_paths: 
+- .
+email: ry@tinyclouds.org
+homepage: 
+rubyforge_project: 
+description: Provides Method#args for inspecting arguments
+autorequire: rake
+default_executable: 
+bindir: bin
+has_rdoc: false
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.8.4
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Ry Dahl
+files: 
+- README
+- Rakefile
+- extconf.rb
+- test.rb
+- method_args.c
+test_files: 
+- test.rb
+rdoc_options: []
+
+extra_rdoc_files: []
+
+executables: []
+
+extensions: 
+- extconf.rb
+requirements: []
+
+dependencies: []
+