binding_ninja 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3d3854a6100c403b0db08ad5f0c4c6c4e4b2c527
-  data.tar.gz: b2b6748aa0b7c8195c94f69c5d80798908d87d69
+  metadata.gz: 57eeb87ad943b9ab0093e5cbbd33ee92891a2180
+  data.tar.gz: 1a5246c9bdb73a8b83ed7f01c5f61c6882df4349
 SHA512:
-  metadata.gz: e62aebf9862aa927ef2112aa8f6abac2f4b85ac93bef9a4c15417e2bc720000ee21051c033acfc17a0585d302949d9aed8c56352e9df33aced3741a4efb41776
-  data.tar.gz: af4d430af39734eaa1f63205aa4f115dc258eb4a724c2e662828d381d892056b29d3304ed1f3c626fb9baefc09058467202885029c1d40e826a7fe546aee3dba
+  metadata.gz: 1fadddaa3dd7b0f6cb31bbb9c1f531f4777ec83315b843fe7655cbcf49399ba3ae8e50e3a7288f6637d30e082374d9965d97ef36d073fe2ff24dd49bef57bacc
+  data.tar.gz: f7c154b4bc8de3a28e39c02ec4dd2645e82724839e843bdd9d71b6ab3af7891c5aa545d52c2274ce1cc7b8ec694fdb20d6ccfb7c97566552d951d03add4ffd4f

data/README.md

@@ -1,7 +1,9 @@
 # BindingNinja
+[![Gem Version](https://badge.fury.io/rb/binding_ninja.svg)](https://badge.fury.io/rb/binding_ninja)
 [![Build Status](https://travis-ci.org/joker1007/binding_ninja.svg?branch=master)](https://travis-ci.org/joker1007/binding_ninja)
 
 This is method wrapper for passing binding of method caller implcitly.
+And this is lightweight alternative of [binding_of_caller](https://github.com/banister/binding_of_caller)
 
 ## Installation
 
@@ -64,6 +66,70 @@ Foo.new.foo2(1, 2)
 `:if` option can accept Proc object and Symbol object.
 If option accepts a proc or symbol, uses result of evaluating the proc or method named by the symbol.
 
+## Compare to binding_of_caller
+```ruby
+require "benchmark/ips"
+require "binding_ninja"
+require "binding_of_caller"
+
+class Foo
+  extend BindingNinja
+
+  auto_inject_binding def foo1(b)
+    b.local_variables
+  end
+
+  def foo2
+    binding.of_caller(1).local_variables
+  end
+
+  def foo3(b)
+    b.local_variables
+  end
+  auto_inject_binding :foo3, if: :enable_auto_inject_binding?
+
+  def enable_auto_inject_binding?
+    true
+  end
+end
+
+foo = Foo.new
+
+p foo.foo1
+p foo.foo2
+p foo.foo3
+
+Benchmark.ips do |x|
+  x.report("binding_ninja") { foo.foo1 }
+  x.report("binding_ninja_with_condition") { foo.foo3 }
+  x.report("binding_of_caller") { foo.foo2 }
+
+  x.compare!
+end
+```
+
+```
+Warming up --------------------------------------
+       binding_ninja   106.598k i/100ms
+binding_ninja_with_condition
+                        49.660k i/100ms
+   binding_of_caller     6.799k i/100ms
+Calculating -------------------------------------
+       binding_ninja      1.351M (± 0.4%) i/s -      6.822M in   5.051283s
+binding_ninja_with_condition
+                        566.555k (± 0.3%) i/s -      2.880M in   5.083895s
+   binding_of_caller     69.968k (± 0.8%) i/s -    353.548k in   5.053337s
+
+Comparison:
+       binding_ninja:  1350619.1 i/s
+binding_ninja_with_condition:   566555.1 i/s - 2.38x  slower
+   binding_of_caller:    69968.2 i/s - 19.30x  slower
+
+```
+
+13x - 16x faster than binding_of_caller.
+And binding_ninja has very simple code base.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/benchmark.rb

@@ -0,0 +1,38 @@
+require "benchmark/ips"
+require "binding_ninja"
+require "binding_of_caller"
+
+class Foo
+  extend BindingNinja
+
+  auto_inject_binding def foo1(b)
+    b.local_variables
+  end
+
+  def foo2
+    binding.of_caller(1).local_variables
+  end
+
+  def foo3(b)
+    b.local_variables
+  end
+  auto_inject_binding :foo3, if: :enable_auto_inject_binding?
+
+  def enable_auto_inject_binding?
+    true
+  end
+end
+
+foo = Foo.new
+
+p foo.foo1
+p foo.foo2
+p foo.foo3
+
+Benchmark.ips do |x|
+  x.report("binding_ninja") { foo.foo1 }
+  x.report("binding_ninja_with_condition") { foo.foo3 }
+  x.report("binding_of_caller") { foo.foo2 }
+
+  x.compare!
+end

data/ext/binding_ninja/binding_ninja.c

@@ -2,6 +2,8 @@
 
 VALUE rb_mBindingNinja;
 static VALUE auto_inject_binding_invoke(int argc, VALUE *argv, VALUE self);
+static VALUE auto_inject_binding_invoke_without_cond(int argc, VALUE *argv, VALUE self);
+static VALUE auto_inject_binding_invoke_stub(int argc, VALUE *argv, VALUE self);
 
 static ID options_id;
 
@@ -13,6 +15,8 @@ auto_inject_binding(int argc, VALUE *argv, VALUE mod)
     static ID keyword_ids[1];
     VALUE extensions, ext_mod, method_sym, options, opt, cond;
 
+    cond = Qundef;
+
     if (!keyword_ids[0]) {
       keyword_ids[0] = rb_intern("if");
     }
@@ -21,11 +25,11 @@ auto_inject_binding(int argc, VALUE *argv, VALUE mod)
       extensions_id = rb_intern("@auto_inject_binding_extensions");
     }
 
-    if (rb_cvar_defined(mod, options_id)) {
-      options = rb_cvar_get(mod, options_id);
+    if (rb_ivar_defined(mod, options_id)) {
+      options = rb_ivar_get(mod, options_id);
     } else {
       options = rb_hash_new();
-      rb_cvar_set(mod, options_id, options);
+      rb_ivar_set(mod, options_id, options);
     }
 
     rb_scan_args(argc, argv, "1:", &method_sym, &opt);
@@ -51,7 +55,18 @@ auto_inject_binding(int argc, VALUE *argv, VALUE mod)
     if (rb_mod_include_p(mod, ext_mod) == Qfalse) {
       rb_prepend_module(mod, ext_mod);
     }
-    rb_define_method_id(ext_mod, mid, auto_inject_binding_invoke, -1);
+
+    if (cond == Qundef) {
+      rb_define_method_id(ext_mod, mid, auto_inject_binding_invoke_without_cond, -1);
+    } else if (rb_obj_is_proc(cond) || SYMBOL_P(cond)) {
+      rb_define_method_id(ext_mod, mid, auto_inject_binding_invoke, -1);
+    } else {
+      if (RTEST(cond)) {
+        rb_define_method_id(ext_mod, mid, auto_inject_binding_invoke_without_cond, -1);
+      } else {
+        rb_define_method_id(ext_mod, mid, auto_inject_binding_invoke_stub, -1);
+      }
+    }
 
     return method_sym;
 }
@@ -59,7 +74,7 @@ auto_inject_binding(int argc, VALUE *argv, VALUE mod)
 static VALUE
 auto_inject_binding_invoke(int argc, VALUE *argv, VALUE self)
 {
-  VALUE method_sym, options, binding, args_ary, cond;
+  VALUE method_sym, ext_mod, options, binding, args_ary, cond;
   static VALUE dummy_proc_args, dummy_method_arg[0];
 
   if (!dummy_proc_args) {
@@ -68,7 +83,7 @@ auto_inject_binding_invoke(int argc, VALUE *argv, VALUE self)
   }
 
   method_sym = ID2SYM(rb_frame_this_func());
-  options = rb_cvar_get(CLASS_OF(self), options_id);
+  options = rb_funcall(CLASS_OF(self), rb_intern("auto_inject_binding_options"), 0);
 
   cond = rb_hash_lookup2(options, method_sym, Qtrue);
 
@@ -92,11 +107,31 @@ auto_inject_binding_invoke(int argc, VALUE *argv, VALUE self)
   return rb_call_super(argc + 1, RARRAY_CONST_PTR(args_ary));
 }
 
+
+static VALUE
+auto_inject_binding_invoke_without_cond(int argc, VALUE *argv, VALUE self)
+{
+  VALUE args_ary, binding;
+  args_ary = rb_ary_new_from_values(argc, argv);
+  binding = rb_binding_new();
+  rb_ary_unshift(args_ary, binding);
+  return rb_call_super(argc + 1, RARRAY_CONST_PTR(args_ary));
+}
+
+static VALUE
+auto_inject_binding_invoke_stub(int argc, VALUE *argv, VALUE self)
+{
+  VALUE args_ary;
+  args_ary = rb_ary_new_from_values(argc, argv);
+  rb_ary_unshift(args_ary, Qnil);
+  return rb_call_super(argc + 1, RARRAY_CONST_PTR(args_ary));
+}
+
 void
 Init_binding_ninja(void)
 {
   rb_mBindingNinja = rb_define_module("BindingNinja");
-  options_id = rb_intern("@@__auto_inject_binding_options");
+  options_id = rb_intern("@auto_inject_binding_options");
   rb_ivar_set(rb_mBindingNinja, rb_intern("@auto_inject_binding_extensions"), rb_hash_new());
   rb_define_private_method(rb_mBindingNinja, "auto_inject_binding", auto_inject_binding, -1);
 }

data/lib/binding_ninja.rb

@@ -2,4 +2,34 @@ require "binding_ninja/version"
 require "binding_ninja/binding_ninja"
 
 module BindingNinja
+  def auto_inject_binding_options
+    {}
+  end
+
+  METHOD_DEFINER = ->(klass) do
+    unless klass.method_defined?(:auto_inject_binding_options)
+      options = {}
+      klass.class_eval do
+        @auto_inject_binding_options = options
+      end
+
+      klass.define_singleton_method(:auto_inject_binding_options) do
+        super().merge(options)
+      end
+    end
+  end
+
+  def inherited(klass)
+    super
+    METHOD_DEFINER.call(klass)
+  end
+
+  def included(klass)
+    super
+    METHOD_DEFINER.call(klass)
+  end
+
+  def self.extended(klass)
+    METHOD_DEFINER.call(klass)
+  end
 end

data/lib/binding_ninja/version.rb

@@ -1,3 +1,3 @@
 module BindingNinja
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: binding_ninja
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - joker1007
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-24 00:00:00.000000000 Z
+date: 2017-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,6 +80,7 @@ files:
 - Gemfile
 - README.md
 - Rakefile
+- benchmark.rb
 - bin/console
 - bin/setup
 - binding_ninja.gemspec
@@ -107,7 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: pass binding of method caller implicitly