okuribito 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3c86eaef77f4c3b58eea32fad2807357ef3283d3
-  data.tar.gz: a1917f0eecd807c567fd710cc422a52107c5500d
+  metadata.gz: 88bb0983550c0142944b2032b5a2b3163326fbe4
+  data.tar.gz: fb8d80772642747ddd4c4346c67de6911f951f6e
 SHA512:
-  metadata.gz: 6a1c28a5e844c0ceb2b978ca1cc030ca233021249e7a7b1cf8a1218ae8cb05e5825a09fb846e82005a1c89bb7ae7df2c12f6b01c9ddce50d13de9160bf3f094a
-  data.tar.gz: e4800ed07e2903fb9b570a657303db012483663b4a44cd33a9412a75093943148401a380c6299366e6497f8a94ccfcc16e66e6b494cf0708713ade80e1fb6dba
+  metadata.gz: 96e688e28032eb99c33f486c0647c2111704ba849b0de4160ff5617ed2275ba352d9b66bdc3000bd7d4df5257e2b23764109a20ecf2f59e25b83136b48c5542c
+  data.tar.gz: 8e83adc2fb3c9b1e63206d2cdaf88ae625cbaa98fbcdf228daff76da9c51179c71a59b94f2fae43440428e273d22ef2b42a04f991e4c5ec5b205adfce045c982

data/.rubocop.yml

@@ -27,3 +27,7 @@ Metrics/MethodLength:
 
 Metrics/AbcSize:
   Max: 40
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'

data/README.md

@@ -48,7 +48,7 @@ Admin::Manage:
 By writing the following code to start the monitoring of the method.
 
 ```ruby
-okuribito = Okuribito::OkuribitoPatch.new do |method_name, obj_name, caller_info|
+okuribito = Okuribito::Request.new do |method_name, obj_name, caller_info|
   # do something as you like!
 end
 okuribito.apply("config/okuribito.yml")
@@ -59,7 +59,7 @@ You can also give the option.
 `once_detect`: When it detects a method call, and run only once the code that has been set.
 
 ```ruby
-okuribito = Okuribito::OkuribitoPatch.new(once_detect: true) do |method_name, obj_name, caller_info|
+okuribito = Okuribito::Request.new(once_detect: true) do |method_name, obj_name, caller_info|
   # do something as you like!
 end
 okuribito.apply("config/okuribito.yml")
@@ -68,10 +68,10 @@ okuribito.apply("config/okuribito.yml")
 You can also monitor a single method with a string specification.
 
 ```ruby
-okuribito = Okuribito::OkuribitoPatch.new do |method_name, obj_name, caller_info|
+okuribito = Okuribito::Request.new do |method_name, obj_name, caller_info|
   # do something as you like!
 end
-okuribito.apply("TestTarget#deprecated_method")
+okuribito.apply_one("TestTarget#deprecated_method")
 ```
 
 You can use the following parameters when executing arbitrary code.
@@ -84,10 +84,10 @@ You can use the following parameters when executing arbitrary code.
 * args
 
 ```ruby
-okuribito = Okuribito::OkuribitoPatch.new do |method_name, obj_name, caller_info, class_name, symbol, args|
+okuribito = Okuribito::Request.new do |method_name, obj_name, caller_info, class_name, symbol, args|
   # do something as you like!
 end
-okuribito.apply("TestTarget#deprecated_method_with_args")
+okuribito.apply_one("TestTarget#deprecated_method_with_args")
 ```
 
 ### ex: Ruby On Rails
@@ -97,7 +97,7 @@ Edit `application.rb`
 ```ruby
 class OkuribitoSetting < Rails::Railtie
   config.after_initialize do
-    okuribito = Okuribito::OkuribitoPatch.new do |method_name, obj_name, caller_info|
+    okuribito = Okuribito::Request.new do |method_name, obj_name, caller_info|
       # do something as you like!
     end
     okuribito.apply("config/okuribito.yml")
@@ -119,7 +119,7 @@ class TestTarget
   end
 end
 
-okuribito = Okuribito::OkuribitoPatch.new do |method_name, obj_name, caller_info|
+okuribito = Okuribito::Request.new do |method_name, obj_name, caller_info|
   puts "#{obj_name} #{method_name} #{caller_info[0]}"
 end
 okuribito.apply("config/okuribito.yml")
@@ -149,7 +149,7 @@ TestTarget deprecated_self_method example.rb:17:in `<main>'
 ### Full stacktrace
 
 ```ruby
-okuribito = Okuribito::OkuribitoPatch.new do |method_name, obj_name, caller_info|
+okuribito = Okuribito::Request.new do |method_name, obj_name, caller_info|
   puts "#############################################################"
   puts "#{obj_name} #{method_name} #{caller_info[0]}"
   puts "#############################################################"
@@ -161,6 +161,11 @@ okuribito.apply("config/okuribito.yml")
 ### Other ideas
 - Send to Fluentd, TreasureData, Slack...
 
+## Compatibility
+- `Okuribito::OkuribitoPatch` has backward compatibility, but it is old class!
+- Later version 0.3.0, you should use `Okuribito::Request`
+
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/okuribito.rb

@@ -1,110 +1,6 @@
+# frozen_string_literal: true
 require "okuribito/version"
-require "yaml"
-require "active_support"
-require "active_support/core_ext"
+require "okuribito/okuribito_patch"
 
 module Okuribito
-  class OkuribitoPatch
-    CLASS_METHOD_SYMBOL = ".".freeze
-    INSTANCE_METHOD_SYMBOL = "#".freeze
-    PATTERN = /\A(?<symbol>[#{CLASS_METHOD_SYMBOL}#{INSTANCE_METHOD_SYMBOL}])(?<method_name>.+)\z/
-
-    module SimplePatchModule
-      private
-
-      def define_patch(method_name, _patch, _id, _opt = {})
-        define_method(method_name) do |*args|
-          yield(to_s, caller) if block_given?
-          super(*args)
-        end
-      end
-    end
-
-    module FunctionalPatchModule
-      private
-
-      def define_patch(method_name, patch, id, opt = {})
-        sn = method_name.to_s.gsub(/\?/, "__q").gsub(/!/, "__e").gsub(/=/, "__eq")
-        patch.instance_variable_set("@#{sn}_#{id}_called", false)
-        define_method(method_name) do |*args|
-          if block_given? && !patch.instance_variable_get("@#{sn}_#{id}_called")
-            yield(to_s, caller)
-            patch.instance_variable_set("@#{sn}_#{id}_called", true) if opt[:once_detect]
-          end
-          super(*args)
-        end
-      end
-    end
-
-    def initialize(opt = {}, &callback)
-      @callback = callback
-      @opt ||= opt
-    end
-
-    def apply(yaml_path)
-      yaml = YAML.load_file(yaml_path)
-      yaml.each do |class_name, observe_methods|
-        patch_okuribito(class_name, observe_methods)
-      end
-    end
-
-    def apply_one(full_method_name)
-      class_name, symbol, method_name = full_method_name.split(/(\.|#)/)
-      patch_okuribito(class_name, [symbol + method_name])
-    end
-
-    private
-
-    def patch_okuribito(full_class_name, observe_methods)
-      callback = @callback
-      opt ||= @opt
-      klass = full_class_name.constantize
-      uniq_constant = full_class_name.gsub(/::/, "Sp")
-      i_method_patch = patch_module(opt, "#{uniq_constant}InstancePatch")
-      c_method_patch = patch_module(opt, "#{uniq_constant}ClassPatch")
-      i_method_patched = 0
-      c_method_patched = 0
-
-      klass.class_eval do
-        observe_methods.each do |observe_method|
-          next unless (md = PATTERN.match(observe_method))
-          symbol = md[:symbol]
-          method_name = md[:method_name].to_sym
-
-          case symbol
-          when INSTANCE_METHOD_SYMBOL
-            next unless klass.instance_methods.include?(method_name)
-            i_method_patch.module_eval do
-              define_patch(method_name, i_method_patch, "i", opt) do |obj_name, caller_info|
-                callback.call(method_name, obj_name, caller_info, full_class_name, symbol)
-              end
-            end
-            i_method_patched += 1
-          when CLASS_METHOD_SYMBOL
-            next unless klass.respond_to?(method_name)
-            c_method_patch.module_eval do
-              define_patch(method_name, c_method_patch, "c", opt) do |obj_name, caller_info|
-                callback.call(method_name, obj_name, caller_info, full_class_name, symbol)
-              end
-            end
-            c_method_patched += 1
-          end
-        end
-        prepend i_method_patch if i_method_patched > 0
-        singleton_class.send(:prepend, c_method_patch) if c_method_patched > 0
-      end
-    end
-
-    def patch_module(opt, patch_name)
-      if opt.present?
-        if FunctionalPatchModule.const_defined?(patch_name)
-          Module.new.extend(FunctionalPatchModule)
-        else
-          FunctionalPatchModule.const_set(patch_name, Module.new.extend(FunctionalPatchModule))
-        end
-      else
-        Module.new.extend(SimplePatchModule)
-      end
-    end
-  end
 end

data/lib/okuribito/okuribito_patch.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+require "okuribito/request"
+
+# TODO: Remain for backward compatibility, but actually should delete this class.
+module Okuribito
+  class OkuribitoPatch < Request
+  end
+end

data/lib/okuribito/patch_module.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+module Okuribito
+  module SimplePatchModule
+    private
+
+    def define_patch(method_name, _patch, _id, _opt = {})
+      define_method(method_name) do |*args|
+        yield(to_s, caller) if block_given?
+        super(*args)
+      end
+    end
+  end
+
+  module FunctionalPatchModule
+    private
+
+    def define_patch(method_name, patch, id, opt = {})
+      sn = method_name.to_s.gsub(/\?/, "__q").gsub(/!/, "__e").gsub(/=/, "__eq")
+      patch.instance_variable_set("@#{sn}_#{id}_called", false)
+      define_method(method_name) do |*args|
+        if block_given? && !patch.instance_variable_get("@#{sn}_#{id}_called")
+          yield(to_s, caller)
+          patch.instance_variable_set("@#{sn}_#{id}_called", true) if opt[:once_detect]
+        end
+        super(*args)
+      end
+    end
+  end
+end

data/lib/okuribito/patcher.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+require "okuribito/patch_module"
+require "active_support"
+require "active_support/core_ext"
+
+module Okuribito
+  class Patcher
+    CLASS_METHOD_SYMBOL = ".".freeze
+    INSTANCE_METHOD_SYMBOL = "#".freeze
+    PATTERN = /\A(?<symbol>[#{CLASS_METHOD_SYMBOL}#{INSTANCE_METHOD_SYMBOL}])(?<method_name>.+)\z/
+
+    def initialize(opt, callback)
+      @opt = opt
+      @callback = callback
+    end
+
+    def patch_okuribito(full_class_name, observe_methods)
+      opt = @opt
+      callback = @callback
+      klass = full_class_name.safe_constantize
+      unless klass
+        process_undefined_class(full_class_name)
+        return
+      end
+      uniq_constant = full_class_name.gsub(/::/, "Sp")
+      i_method_patch = patch_module("#{uniq_constant}InstancePatch", opt)
+      c_method_patch = patch_module("#{uniq_constant}ClassPatch", opt)
+      i_method_patched = 0
+      c_method_patched = 0
+
+      klass.class_eval do
+        observe_methods.each do |observe_method|
+          next unless (md = PATTERN.match(observe_method))
+          symbol = md[:symbol]
+          method_name = md[:method_name].to_sym
+
+          case symbol
+          when INSTANCE_METHOD_SYMBOL
+            next unless klass.instance_methods.include?(method_name)
+            i_method_patch.module_eval do
+              define_patch(method_name, i_method_patch, "i", opt) do |obj_name, caller_info|
+                callback.call(method_name, obj_name, caller_info, full_class_name, symbol)
+              end
+            end
+            i_method_patched += 1
+          when CLASS_METHOD_SYMBOL
+            next unless klass.respond_to?(method_name)
+            c_method_patch.module_eval do
+              define_patch(method_name, c_method_patch, "c", opt) do |obj_name, caller_info|
+                callback.call(method_name, obj_name, caller_info, full_class_name, symbol)
+              end
+            end
+            c_method_patched += 1
+          end
+        end
+        prepend i_method_patch if i_method_patched > 0
+        singleton_class.send(:prepend, c_method_patch) if c_method_patched > 0
+      end
+    end
+
+    private
+
+    def patch_module(patch_name, opt)
+      if opt.present?
+        if FunctionalPatchModule.const_defined?(patch_name)
+          Module.new.extend(FunctionalPatchModule)
+        else
+          FunctionalPatchModule.const_set(patch_name, Module.new.extend(FunctionalPatchModule))
+        end
+      else
+        Module.new.extend(SimplePatchModule)
+      end
+    end
+
+    def process_undefined_class(_full_class_name)
+      # do nothing....
+    end
+  end
+end

data/lib/okuribito/request.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+require "okuribito/patcher"
+require "yaml"
+
+module Okuribito
+  class Request
+    def initialize(opt = {}, &callback)
+      @patcher = Patcher.new(opt, callback)
+    end
+
+    def apply(yaml_path)
+      yaml = YAML.load_file(yaml_path)
+      yaml.each do |class_name, observe_methods|
+        @patcher.patch_okuribito(class_name, observe_methods)
+      end
+    end
+
+    def apply_one(full_method_name)
+      class_name, symbol, method_name = full_method_name.split(/(\.|#)/)
+      @patcher.patch_okuribito(class_name, [symbol + method_name])
+    end
+  end
+end

data/lib/okuribito/version.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Okuribito
-  VERSION = "0.2.3".freeze
+  VERSION = "0.3.0".freeze
 end

metadata

@@ -1,83 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: okuribito
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - muramurasan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-02-05 00:00:00.000000000 Z
+date: 2018-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.0.0
 description: Okuribito monitors the method call, and exec specified code.
@@ -87,9 +87,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .rubocop.yml
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -97,6 +97,10 @@ files:
 - Rakefile
 - circle.yml
 - lib/okuribito.rb
+- lib/okuribito/okuribito_patch.rb
+- lib/okuribito/patch_module.rb
+- lib/okuribito/patcher.rb
+- lib/okuribito/request.rb
 - lib/okuribito/version.rb
 - okuribito.gemspec
 - okuribito_logo.png
@@ -110,17 +114,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Okuribito monitors the method call, and exec specified code.