method_annotation 0.2.2 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6925dc1e7c828cfddd9bae35a14119041f722ed1
-  data.tar.gz: 5bec416ec9822fe12f64dc3d69bc53ae2bba7676
+  metadata.gz: 4bc62c8971f19084f3a63abe630311f503fbf7bb
+  data.tar.gz: 38b89482d48bef69aae4ae0c799bb9b6a37d1aeb
 SHA512:
-  metadata.gz: 11686070fb63ee1b266a8a9937533334df0ce28d11ae005ca8dea818b6fd114cfe6245a2895517d1efaf6ca4d2a34525823cc10af5be1295243cfd2082ef7677
-  data.tar.gz: 5a4c2d5465879dd8cb092011dbcac391a38dd1926ab1f7922a50ad0b5d9f3d4134a16c858a9abb3522f689f28ed4577e0e0ba072d4c4b1adc5635efe07c7d776
+  metadata.gz: 56635664591df2b3aab37acd70fda1164ed47705e631a7dbefa6fab0bd642652c2d44e7e2977cf1bda2e067dd3e3d745218b54ff0baf1d93102e6629e7c06d1b
+  data.tar.gz: 60f5f195f0fa08477a8cd8a9510034ddb2e80fd22f38174d3fd7ca581eaeaeb348314bce375b3318e8f731fa2a3727b943763812d63da7c82d308c2cbc5e7b97

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    method_annotation (0.2.2)
+    method_annotation (0.3.1)
       activesupport (~> 4.2.3)
 
 GEM

data/README.md

@@ -30,7 +30,8 @@ Next, let's add your class to the method
       # To include a MethodAnnotation::Enable to enable MethodAnnotation
       include MethodAnnotation::Enable
 
-      # write "#{your annotation class}.name.underscore"
+      # write annotaion_name or 
+      # "#{your annotation class}.name.underscore"
       # ex) MyMethodAnnotation => my_method_annotation
       my_method_annotation
       def bar
@@ -76,12 +77,13 @@ About MethodAnnotation
 
       class MyMethodAnnotation < MethodAnnotation::Base
         # args is the argument of the method of target
-        before do |*args|
+        # param class is MethodAnnotation::Parameter
+        before do |param|
           puts 'before'
         end
 
         # args is the argument of the method of target
-        after do |*args|
+        after do |param|
           puts 'after'
         end
       end
@@ -106,9 +108,9 @@ About MethodAnnotation
 
       class MyMethodAnnotation < MethodAnnotation::Base
         # original is proc methods of target
-        around do |original, *args| 
+        around do |param| 
           puts 'before'
-          return_value = original.call(*args)
+          return_value = param.original.call(param)
           puts 'after'
 
           return_value
@@ -131,7 +133,7 @@ About MethodAnnotation
 
 - MethodAnnotation::Cache
 
-  It is cached after the second time the execution result of the method is returned from the cache
+  It is cached after the second time the execution result of the method is returned from the cache.
 
       require 'method_annotation'
 
@@ -154,26 +156,48 @@ About MethodAnnotation
       foo.bar
       => "return value"
 
+- MethodAnnotation::Trace
+
+  It is will trace the method. This is still a prototype.
+
+      require 'method_annotation'
+
+      class Foo
+        include MethodAnnotation::Enable
+
+        trace
+        def bar
+          Hoge.new.hogehoge
+        end
+      end
+
+      class Hoge
+        def hogehoge
+        end
+      end
+
+      Foo.new.bar
+      => <===== Foo.bar trace =====>
+      => (irb):15: in `hogehoge'
+      => (irb):9: in `bar'
+      => <=========================>
+
 Example1
 
     class PutsArg < MethodAnnotation::Base
       self.annotation_name = 'puts_arg'
       self.describe = 'output the arguments of the method'
 
-      before do |*args| 
+      before do |params| 
         puts '-------args-------'
-        puts args 
+        puts *params.args
         puts '------------------'
       end
     end
     
-    PutsArg.describe
-    => "output the arguments of the method"    
-
     class Foo
       include MethodAnnotation::Enable
 
-      # write annotation_name or "#{your annotation class}.name.underscore"
       puts_arg
       def hoge(arg1, arg2)
         puts 'hoge'
@@ -203,9 +227,9 @@ Example2
     class TimeMeasurement < MethodAnnotation::Base
       self.describe = 'measure the processing time of the method'
 
-      around do |original, *args| 
+      around do |param| 
         start = Time.now
-        return_value = original.call(*args)
+        return_value = param.original.call(param)
         puts "#{Time.now - start} sec"
 
         return_value
@@ -229,8 +253,9 @@ Example3
     class ArgsToString < MethodAnnotation::Base
       self.describe = 'convert the arguments to string'
 
-      around do |original, *args| 
-        original.call(*args.map(&:to_s))
+      around do |param| 
+        remake_param = MethodAnnotation::Parameter.new(args: param.args.map(&:to_s))
+        param.original.call(remake_param)
       end
     end
     

data/lib/method_annotation.rb

@@ -6,9 +6,11 @@ module MethodAnnotation
 
   autoload :Base
   autoload :Enable
+  autoload :Parameter
 
   eager_autoload do
     autoload :Cache
+    autoload :Trace
   end
 end
 

data/lib/method_annotation/cache.rb

@@ -3,11 +3,11 @@ module MethodAnnotation
     self.annotation_name = 'cache'
     self.describe = 'It is cached after the second time the execution result of the method is returned from the cache'
 
-    around do |original, *args|
+    around do |param|
       @__chached ||= {}
 
-      key = "#{self.class}__#{__method__}".to_sym
-      @__chached[key] = original.call(*args) unless @__chached.key?(key)
+      key = "#{self.class}__#{param.method_name}".to_sym
+      @__chached[key] = param.original.call(param) unless @__chached.key?(key)
 
       @__chached[key]
     end

data/lib/method_annotation/enable.rb

@@ -35,17 +35,27 @@ module MethodAnnotation
                 end
               end
 
-              annotation_map[:before_procs].try(:each) { |blk| instance_exec(*args, &blk) }
-              original = ->(*params) { instance_eval { super(*params, &block) } }
+              param = Parameter.new(args: args, method_name: name)
+
+              # do before
+              annotation_map[:before_procs].try(:each) { |blk| instance_exec(param, &blk) }
+
+              # do around
+              last_block = ->(parameter) { instance_eval { super(*parameter.args, &block) } }
               if annotation_map[:around_procs].present?
-                chain = annotation_map[:around_procs].reverse.inject(original) do |block_chain, blk|
-                  ->(*params) { instance_exec(block_chain, *params, &blk) }
+                 last_block = annotation_map[:around_procs].reverse.inject(last_block) do |block_chain, blk|
+                  ->(parameter) do 
+                    instance_exec(
+                      Parameter.new(original: block_chain, args: parameter.args, method_name: parameter.method_name),
+                      &blk
+                    )
+                  end
                 end
-                return_value = instance_exec(*args, &chain)
-              else
-                return_value = original.call(*args)
               end
-              annotation_map[:after_procs].try(:each) { |blk| instance_exec(*args, &blk) }
+              return_value = last_block.call(param)
+
+              # do after
+              annotation_map[:after_procs].try(:each) { |blk| instance_exec(param, &blk) }
               return_value
             end
 

data/lib/method_annotation/parameter.rb

@@ -0,0 +1,11 @@
+module MethodAnnotation
+  class Parameter
+    attr_accessor :original, :args, :method_name
+
+    def initialize(original: nil, args: nil, method_name: nil)
+      @original = original
+      @args = args
+      @method_name = method_name
+    end
+  end
+end

data/lib/method_annotation/trace.rb

@@ -0,0 +1,22 @@
+module MethodAnnotation
+  class Trace < MethodAnnotation::Base
+    self.annotation_name = 'trace'
+    self.describe = 'Output the trace. It is still a prototype'
+
+    around do |param|
+      results = []
+      trace = TracePoint.new(:call) do |tp|
+        results << "  #{tp.path}:#{tp.lineno}: in `#{tp.method_id}'"
+      end
+
+      return_value = nil
+      trace.enable { return_value = param.original.call(param) }
+
+      start_message = "<===== #{self.class}.#{param.method_name} trace =====>"
+      puts start_message
+      results.reverse.each { |v| puts v }
+      return_value
+      puts "<#{'=' * (start_message.size - 2)}>"
+    end
+  end
+end

data/lib/method_annotation/version.rb

@@ -1,3 +1,3 @@
 module MethodAnnotation
-  VERSION = "0.2.2"
+  VERSION = "0.3.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: method_annotation
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.1
 platform: ruby
 authors:
 - masatoshi-watanuki
@@ -87,6 +87,8 @@ files:
 - lib/method_annotation/base.rb
 - lib/method_annotation/cache.rb
 - lib/method_annotation/enable.rb
+- lib/method_annotation/parameter.rb
+- lib/method_annotation/trace.rb
 - lib/method_annotation/version.rb
 - method_annotation.gemspec
 homepage: https://github.com/masatoshi-watanuki/gems/tree/master/method_annotation