okuribito 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3763c8c0fbdd9746f7e5d50595cb3c07d27e2eb5
-  data.tar.gz: b16c90b7bc3cee2fa02bf79983fa7b960a0c0f4c
+  metadata.gz: d7493f6fcde494c7876664a9e9f08bd7ead6f424
+  data.tar.gz: 457a6555c87a74574bcd5e9876522116af76659c
 SHA512:
-  metadata.gz: ad61526fedb01ab3b98455ff22bfa06d22c3b2ed7e09496f17df83683915c6b9ee2794a99ee4b26d63702038dd876aabf2d1ebfbe9f027b2aee589846dc6be43
-  data.tar.gz: ae050960f27604a7e1a91cda18a808f99db126030e734e39b1738c471fa8c63ca0123a83fc655ec14aedc7461da3a8d1f614c4e6e474377d19c3ee54a890e5be
+  metadata.gz: 7a2b5d71abdf9659e15a197e4a2dcb4f3eef06609ef5b1a823c2f04cf7d5fc9e7fd0f86fb1e05a7c63d7114fbbd1886b8f59b01a4c3d7c84722d043e38f6e966
+  data.tar.gz: 36048f58088c47ee0598c0cdb1cbd7737de7e119a62ca4c72a78f012db7a7a4caadf9da8158509d81928f96fd27df43d4ab1ca72a1e219ff6c663243f5f3045d

data/.rubocop.yml

@@ -0,0 +1,29 @@
+AllCops:
+  Exclude:
+    - 'okuribito.gemspec'
+    - 'spec/spec_helper.rb'
+
+Documentation:
+  Enabled: false
+
+LineLength:
+  Max: 100
+  Exclude:
+    - "spec/**/*"
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+  SupportedStyles:
+    - double_quotes
+
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+Metrics/PerceivedComplexity:
+  Max: 10
+
+Metrics/MethodLength:
+  Max: 20
+
+Metrics/AbcSize:
+  Max: 30

data/Gemfile

@@ -1,2 +1,2 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 gemspec

data/README.md

@@ -1,8 +1,11 @@
+[![CircleCI](https://circleci.com/gh/muramurasan/okuribito/tree/master.svg?style=svg)](https://circleci.com/gh/muramurasan/okuribito/tree/master)
+
 # Okuribito
 
 ![okuribito](okuribito_logo.png)
 
 Okuribito is a gem to judge whether methods should be sent to the heaven :innocent:.
+In other words, it can be used in order to extract the obsolete method.
 Okuribito was named after a japanese movie.
 
 ## Installation
@@ -32,6 +35,28 @@ Micropost:
   - '.from_users_followed_by'
 ```
 
+By writing the following code to start the monitoring of the method.
+
+```ruby
+okuribito = Okuribito::OkuribitoPatch.new do |method_name, obj_name, caller_info|
+  # TODO: do something as you like!
+end
+okuribito.apply("okuribito.yml")
+```
+
+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|
+  # TODO: do something as you like!
+end
+okuribito.apply("okuribito.yml")
+```
+
+### ex: Ruby On Rails
+
 Edit `application.rb`
 
 ```ruby
@@ -103,7 +128,7 @@ end
 okuribito = Okuribito::OkuribitoPatch.new do |method_name, obj_name, caller_info|
   uri = URI.parse("https://hooks.slack.com/services/xxx...")
   params = {
-      text: "OKURIBITO detected a method call.",
+      text: "OKURIBITO detect a method call.",
       username: "OKURIBITO",
       icon_emoji: ":innocent:",
       attachments: [{
@@ -125,7 +150,7 @@ end
 ```
 
 ### Other ideas
-- Send to Fluentd, TreasureData
+- Send to Fluentd, TreasureData, Slack...
 
 ## License
 

data/Rakefile

@@ -3,4 +3,4 @@ require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/lib/okuribito.rb

@@ -9,14 +9,28 @@ module Okuribito
     INSTANCE_METHOD_SYMBOL = "#".freeze
     PATTERN = /\A(?<symbol>[#{CLASS_METHOD_SYMBOL}#{INSTANCE_METHOD_SYMBOL}])(?<method_name>.+)\z/
 
-    def initialize(&callback)
+    def initialize(opt = {}, &callback)
       @callback = callback
+      @opt ||= opt
     end
 
-    module PatchModule
-      def define_okuribito_patch(method_name)
+    module SimplePatchModule
+      def define_okuribito_patch(method_name, _opt = {})
         define_method(method_name) do |*args|
-          yield(self.to_s, caller) if block_given?
+          yield(to_s, caller) if block_given?
+          super(*args)
+        end
+      end
+    end
+
+    module FunctionalPatchModule
+      def define_okuribito_patch(method_name, opt = {})
+        instance_variable_set("@#{method_name}_called", false)
+        define_method(method_name) do |*args|
+          if block_given? && !instance_variable_get("@#{method_name}_called")
+            yield(to_s, caller)
+            instance_variable_set("@#{method_name}_called", true) if opt[:once_detect]
+          end
           super(*args)
         end
       end
@@ -30,36 +44,43 @@ module Okuribito
     end
 
     def patch_okuribito(class_name, observe_methods)
-      callback = @callback # スコープを乗り越えるために使用.
+      callback = @callback
+      opt ||= @opt
       klass = class_name.constantize
 
       klass.class_eval do
-        instance_method_patch = Module.new.extend(PatchModule)
-        class_method_patch    = Module.new.extend(PatchModule)
+        if opt.present?
+          instance_method_patch = Module.new.extend(FunctionalPatchModule)
+          class_method_patch    = Module.new.extend(FunctionalPatchModule)
+        else
+          instance_method_patch = Module.new.extend(SimplePatchModule)
+          class_method_patch    = Module.new.extend(SimplePatchModule)
+        end
         instance_method_patched = 0
         class_method_patched    = 0
 
         observe_methods.each do |observe_method|
           next unless md = PATTERN.match(observe_method)
-          symbol, method_name = md[:symbol], md[:method_name].to_sym
+          symbol = md[:symbol]
+          method_name = md[:method_name].to_sym
 
           case symbol
-            when INSTANCE_METHOD_SYMBOL
-              next unless klass.instance_methods.include?(method_name)
-              instance_method_patch.module_eval do
-                define_okuribito_patch(method_name) do |obj_name, caller_info|
-                  callback.call(method_name, obj_name, caller_info)
-                end
+          when INSTANCE_METHOD_SYMBOL
+            next unless klass.instance_methods.include?(method_name)
+            instance_method_patch.module_eval do
+              define_okuribito_patch(method_name, opt) do |obj_name, caller_info|
+                callback.call(method_name, obj_name, caller_info)
               end
-              instance_method_patched += 1
-            when CLASS_METHOD_SYMBOL
-              next unless klass.respond_to?(method_name)
-              class_method_patch.module_eval do
-                define_okuribito_patch(method_name) do |obj_name, caller_info|
-                  callback.call(method_name, obj_name, caller_info)
-                end
+            end
+            instance_method_patched += 1
+          when CLASS_METHOD_SYMBOL
+            next unless klass.respond_to?(method_name)
+            class_method_patch.module_eval do
+              define_okuribito_patch(method_name, opt) do |obj_name, caller_info|
+                callback.call(method_name, obj_name, caller_info)
               end
-              class_method_patched += 1
+            end
+            class_method_patched += 1
           end
         end
         prepend instance_method_patch if instance_method_patched > 0

data/lib/okuribito/version.rb

@@ -1,3 +1,3 @@
 module Okuribito
-  VERSION = "0.1.1"
+  VERSION = "0.1.3".freeze
 end

data/okuribito.gemspec

@@ -35,4 +35,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.12"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: okuribito
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - muramurasan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-04 00:00:00.000000000 Z
+date: 2016-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -80,6 +80,20 @@ dependencies:
     - - ~>
       - !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'
 description: Okuribito monitors the method call by the yaml.
 email:
 - ym.works1985@gmail.com
@@ -89,6 +103,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .rubocop.yml
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt