method_annotation 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 50ca39e5550c0558a052b033392152609b16fe44
-  data.tar.gz: db0c10bf08d8359be47e4fd6d26ccf0319ae8ce6
+  metadata.gz: 0802696a0b56864210fca87400a1eed6cb3d2a55
+  data.tar.gz: 77796f9574b8e5960eaed6124b83d37ef40bd7b8
 SHA512:
-  metadata.gz: 49df694fcde6fed0de4f1540bc519062abf73ae46a8028614fec7de36cb45437fc650a602f135446993ca85282335ad720ebc46eb150bf08a0f8f07c0d477c5b
-  data.tar.gz: 7dd58f1e8398f54519b89b301883c4a7a0646cf7e28495f32f15d4a6ddae7f7dc42f5d6de95a44a27397ce1550bcde2da1a1007be87cc6215d77986787c27385
+  metadata.gz: e4a3cb331d6df26e4e388478f962c30f93e51b2cf7046b757e3f41b1d0d19c9eeb5e1d8bc44547f1bd2919824584476155fc0e2b02866d2f688bd0a0686de94a
+  data.tar.gz: f7416d92b49837291247be07fe0f5cd00df3c73c438a8728d914bfaaa9dd9a9b98567356b757d74e0bb07ab745a4a097c2d7f1cc6ee29b30c5c1be896b6ffe3c

data/Gemfile.lock

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

data/README.md

@@ -1,8 +1,7 @@
 # MethodAnnotation
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/method_annotation`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+MethodAnnotation You can define the Chuwake function method.
+Note translation function can also be added simply tagged to only cross-processing from applications.
 
 ## Installation
 
@@ -12,17 +11,222 @@ Add this line to your application's Gemfile:
 gem 'method_annotation'
 ```
 
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
+install it yourself as:
 
     $ gem install method_annotation
 
 ## Usage
 
-TODO: Write usage instructions here
+First, let's create your MethodAnnotation class
+
+    require 'method_annotation'
+
+    class MyMethodAnnotation < MethodAnnotation::Base
+    end
+
+Next, let's add your class to the method
+
+    class Foo
+      # To include a MethodAnnotation::Enable to enable MethodAnnotation
+      include MethodAnnotation::Enable
+
+      # write "#{your annotation class}.name.underscore"
+      # ex) MyMethodAnnotation => my_method_annotation
+      my_method_annotation
+      def bar
+      end
+    end
+
+You can define an annotation in this way
+
+
+About MethodAnnotation
+- .describe .description
+
+  You can set forth a description
+
+      class MyMethodAnnotation < MethodAnnotation::Base
+        describe 'sample annotation'
+      end
+
+      MyMethodAnnotation.description
+      => "sample annotation"
+
+- .list
+
+  Your class that defines your class, you get a list of methods
+
+      MyMethodAnnotation.list
+      => [[Foo, :bar]]
+
+- .before
+
+  You can define the processing to be performed in method execution before the target
+
+      class MyMethodAnnotation < MethodAnnotation::Base
+        # args is the argument of the method of target
+        before do |*args|
+          puts 'before'
+        end
+      end
+    
+      class Foo
+        include MethodAnnotation::Enable
+
+        my_method_annotation
+        def bar
+          puts 'bar'
+        end
+      end
+
+      Foo.new.bar
+      => before
+      => bar
+
+- .after
+
+  You can define the processing to be performed in method execution after the target
+
+      class MyMethodAnnotation < MethodAnnotation::Base
+        # args is the argument of the method of target
+        after do |*args|
+          puts 'after'
+        end
+      end
+    
+      class Foo
+        include MethodAnnotation::Enable
+
+        my_method_annotation
+        def bar
+          puts 'bar'
+        end
+      end
+
+      Foo.new.bar
+      => bar
+      => after
+
+- .around
+
+  It is possible to define a process that encompasses the method of the target
+
+      class MyMethodAnnotation < MethodAnnotation::Base
+        # original is proc methods of target
+        around do |original, *args| 
+          puts 'before'
+          original.call(*args)
+          puts 'after'
+        end
+      end
+    
+      class Foo
+        include MethodAnnotation::Enable
+
+        my_method_annotation
+        def bar
+          puts 'bar'
+        end
+      end
+
+      Foo.new.bar
+      => before
+      => bar
+      => after
+
+Example1
+
+    class PutsArg < MethodAnnotation::Base
+      describe 'output the arguments of the method'
+
+      before do |*args| 
+        puts '-------args-------'
+        puts args 
+        puts '------------------'
+      end
+    end
+    
+    PutsArg.description
+    => "output the arguments of the method"    
+
+    class Foo
+      include MethodAnnotation::Enable
+
+      # write "#{your annotation class}.name.underscore"
+      puts_arg
+      def hoge(arg1, arg2)
+        puts 'hoge'
+      end
+
+      puts_arg
+      def hogehoge(a: nil, b: nil)
+        puts 'hogehoge'
+      end
+    end   
+
+    Foo.new.hoge('abc', 123)
+    => -------args-------
+    => abc
+    => 123
+    => ------------------
+    => hoge
+    
+    Foo.new.hogehoge(a: 'xyz')
+    => -------args-------
+    => {:a=>"xyz"}
+    => ------------------
+    => hogehoge
+
+Example2
+
+    class TimeMeasurement < MethodAnnotation::Base
+      describe 'measure the processing time of the method'
+
+      around do |original, *args| 
+        start = Time.now
+        original.call(*args)
+        puts "#{Time.now - start} sec"
+      end
+    end
+    
+    class Bar
+      include MethodAnnotation::Enable
+      
+      time_measurement
+      def hoge(sleep_sec)
+        sleep sleep_sec
+      end
+    end
+    
+    Bar.new.hoge(5)
+    => 5.001199044 sec
+
+Example3
+
+    class ArgsToString < MethodAnnotation::Base
+      describe 'convert the arguments to string'
+
+      around do |original, *args| 
+        original.call(*args.map(&:to_s))
+      end
+    end
+    
+    class Baz
+      include MethodAnnotation::Enable
+
+      args_to_string
+      time_measurement
+      def hoge(arg1, arg2)
+        puts "arg1.class: #{arg1.class}"
+        puts "arg2.class: #{arg2.class}"
+        sleep 3
+      end
+    end
+
+    Baz.new.hoge(123, { a: 'A' })
+    => arg1.class: String
+    => arg2.class: String
+    => 3.000860474 sec
 
 ## Development
 

data/lib/method_annotation/version.rb

@@ -1,3 +1,3 @@
 module MethodAnnotation
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/method_annotation.gemspec

@@ -18,6 +18,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = Gem::Requirement.create('2.2.1')
+
   #if spec.respond_to?(:metadata)
   #  spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com' to prevent pushes to rubygems.org, or delete to allow pushes to any server."
   #end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: method_annotation
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - masatoshi-watanuki
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-12-10 00:00:00.000000000 Z
+date: 2015-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -91,9 +91,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.2.1
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="