okuribito 0.0.1 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 554a0e1bcd2a985c3f08ec493efad06bf0b58b95
-  data.tar.gz: 3a419fbe576efd5143466f5b1aecf084378c2a68
+  metadata.gz: 3763c8c0fbdd9746f7e5d50595cb3c07d27e2eb5
+  data.tar.gz: b16c90b7bc3cee2fa02bf79983fa7b960a0c0f4c
 SHA512:
-  metadata.gz: 46165e2cceca9ad323f05fb647fe40c4c717362462ce4dbd1832cd4f7da8cc529a284f193c5ac35908bd32b76a7e566b1682dca2542f78a7e55b1584572d7f2d
-  data.tar.gz: f62c2bf61de45c6cc502d24d06b1fe8fbad45628200889c9f43a6ea55f5bb449ab275933dc9073cc64b8d1cf48462bbd35219eea8a076ba66cb9eaa30d61ed8e
+  metadata.gz: ad61526fedb01ab3b98455ff22bfa06d22c3b2ed7e09496f17df83683915c6b9ee2794a99ee4b26d63702038dd876aabf2d1ebfbe9f027b2aee589846dc6be43
+  data.tar.gz: ae050960f27604a7e1a91cda18a808f99db126030e734e39b1738c471fa8c63ca0123a83fc655ec14aedc7461da3a8d1f614c4e6e474377d19c3ee54a890e5be

data/Gemfile

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

data/README.md

@@ -37,43 +37,95 @@ Edit `application.rb`
 ```ruby
 class OkuribitoSetting < Rails::Railtie
   config.after_initialize do
-    okuribito = Okuribito::OkuribitoPatch.new(
-      {
-        console: "back_trace",
-        slack: "https://hooks.slack.com/services/xxxxxxxxx/xxxxxxxxxx/xxxxxxxxxxxxxxxxxxxxxxxx",
-        logging: "log/okuribito/method_called.log",
-        first_prepended: "log/okuribito/first_prepended.log"
-      }
-    )
+    okuribito = Okuribito::OkuribitoPatch.new do |method_name, obj_name, caller_info|
+      # TODO: do something as you like!
+    end
     okuribito.apply("okuribito.yml")
   end
 end
 ```
 
-### console
-Setting for console outout.
-- `plain` is the simplest 1 line log.
-- `back_trace` shows back trace in detail.
+## The smallest example
 
-### slack
-Setting for slack notification.
+```ruby
+require "bundler/setup"
+require "okuribito"
+
+class TestTarget
+  def self.deprecated_self_method
+  end
+
+  def deprecated_method
+  end
+end
+
+okuribito = Okuribito::OkuribitoPatch.new do |method_name, obj_name, caller_info|
+  puts "#{obj_name} #{method_name} #{caller_info[0]}"
+end
+okuribito.apply("okuribito.yml")
+
+TestTarget.deprecated_self_method
+TestTarget.new.deprecated_method
+```
+
+Setting file:
 
-### logging
-Setting for logging.
+```okuribito.yml
+TestTarget:
+  - ".deprecated_self_method"
+  - "#deprecated_method"
 
-### first_prepended
-Setting for logging to save when you started to monitor.
+```
+
+Output:
 
-## Development
+```output
+TestTarget deprecated_self_method example.rb:17:in `<main>'
+#<TestTarget:0x007fd1e11ce368> deprecated_method example.rb:18:in `<main>'
+```
 
-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.
+## Callback examples
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+### Full stacktrace
 
-## Contributing
+```ruby
+okuribito = Okuribito::OkuribitoPatch.new do |method_name, obj_name, caller_info|
+  puts "#############################################################"
+  puts "#{obj_name} #{method_name} #{caller_info[0]}"
+  puts "#############################################################"
+  puts caller_info
+end
+```
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/okuribito. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+### Send to slack
+
+```ruby
+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.",
+      username: "OKURIBITO",
+      icon_emoji: ":innocent:",
+      attachments: [{
+                        fields: [{
+                                     title: "#{obj_name}::#{method_name}",
+                                     value: "#{caller_info[0]}",
+                                     short: false
+                                 }]
+                    }]
+  }
+  http = Net::HTTP.new(uri.host, uri.port)
+  http.use_ssl = true
+  http.start do
+    request = Net::HTTP::Post.new(uri.path)
+    request.set_form_data(payload: params.to_json)
+    http.request(request)
+  end
+end
+```
 
+### Other ideas
+- Send to Fluentd, TreasureData
 
 ## License
 

data/circle.yml

@@ -0,0 +1,4 @@
+machine:
+  timezone: Asia/Tokyo
+  ruby:
+    version: 2.0.0

data/lib/okuribito.rb

@@ -2,66 +2,18 @@ require "okuribito/version"
 require "yaml"
 require "active_support"
 require "active_support/core_ext"
-require "net/http"
-require "uri"
-require "json"
-require "logger"
 
 module Okuribito
   class OkuribitoPatch
-    CLASS_METHOD_SYMBOL = "."
-    INSTANCE_METHOD_SYMBOL = "#"
+    CLASS_METHOD_SYMBOL = ".".freeze
+    INSTANCE_METHOD_SYMBOL = "#".freeze
     PATTERN = /\A(?<symbol>[#{CLASS_METHOD_SYMBOL}#{INSTANCE_METHOD_SYMBOL}])(?<method_name>.+)\z/
 
-    def initialize(options = {})
-      @options = options
+    def initialize(&callback)
+      @callback = callback
     end
 
     module PatchModule
-      def disp_console_by_okuribito(method_name, obj_name, caller_info, type)
-        case type
-        when "plane"
-          puts "#{obj_name} : #{method_name} is called."
-        when "back_trace"
-          puts "#############################################################"
-          puts "# #{obj_name} : #{method_name} is called."
-          puts "#############################################################"
-          puts caller_info
-        end
-      end
-
-      def notificate_slack_by_okuribito(method_name, obj_name, caller_info, url)
-        uri  = URI.parse(url)
-        params = {
-          text: "OKURIBITO detected a method call.",
-          username: "OKURIBITO",
-          icon_emoji: ":innocent:",
-          attachments: [{
-            fields: [{
-               title: "#{obj_name}::#{method_name}",
-               value: "#{caller_info[0]}",
-               short: false
-             }]
-          }]
-        }
-        http = Net::HTTP.new(uri.host, uri.port)
-        http.use_ssl = true
-        http.start do
-          request = Net::HTTP::Post.new(uri.path)
-          request.set_form_data(payload: params.to_json)
-          http.request(request)
-        end
-      end
-
-      def logging_by_okuribito(symbol, method_name, obj_name, caller_info, log_path)
-        logger = Logger.new(log_path)
-        logger.formatter = proc{|severity, datetime, progname, message|
-          "#{datetime}, #{message}\n"
-        }
-
-        logger.info("#{obj_name}#{symbol}#{method_name} : #{caller_info[0]}")
-      end
-
       def define_okuribito_patch(method_name)
         define_method(method_name) do |*args|
           yield(self.to_s, caller) if block_given?
@@ -74,12 +26,11 @@ module Okuribito
       yaml = YAML.load_file(yaml_path)
       yaml.each do |class_name, observe_methods|
         patch_okuribito(class_name, observe_methods)
-        logging_prepended(class_name, observe_methods, @options[:first_prepended]) unless @options[:first_prepended].nil?
       end
     end
 
     def patch_okuribito(class_name, observe_methods)
-      options = @options # スコープを乗り越えるために使用.
+      callback = @callback # スコープを乗り越えるために使用.
       klass = class_name.constantize
 
       klass.class_eval do
@@ -97,9 +48,7 @@ module Okuribito
               next unless klass.instance_methods.include?(method_name)
               instance_method_patch.module_eval do
                 define_okuribito_patch(method_name) do |obj_name, caller_info|
-                  disp_console_by_okuribito(method_name, obj_name, caller_info, options[:console]) unless options[:console].nil?
-                  notificate_slack_by_okuribito(method_name, obj_name, caller_info, options[:slack]) unless options[:slack].nil?
-                  logging_by_okuribito(symbol, method_name, obj_name, caller_info, options[:logging]) unless options[:logging].nil?
+                  callback.call(method_name, obj_name, caller_info)
                 end
               end
               instance_method_patched += 1
@@ -107,9 +56,7 @@ module Okuribito
               next unless klass.respond_to?(method_name)
               class_method_patch.module_eval do
                 define_okuribito_patch(method_name) do |obj_name, caller_info|
-                  disp_console_by_okuribito(method_name, obj_name, caller_info, options[:console]) unless options[:console].nil?
-                  notificate_slack_by_okuribito(method_name, obj_name, caller_info, options[:slack]) unless options[:slack].nil?
-                  logging_by_okuribito(symbol, method_name, obj_name, caller_info, options[:logging]) unless options[:logging].nil?
+                  callback.call(method_name, obj_name, caller_info)
                 end
               end
               class_method_patched += 1
@@ -119,26 +66,5 @@ module Okuribito
         singleton_class.send(:prepend, class_method_patch) if class_method_patched > 0
       end
     end
-
-    def logging_prepended(class_name, observe_methods, log_path)
-      # ファイル読み出して、クラス名+メソッド名だけを配列に保持する.
-      methods = []
-      if File.exist?(log_path)
-        File.open(log_path) { |f| methods = f.read.split("\n") }
-        methods.slice!(0)
-        methods.map! { |m| m.split(",")[1] }
-      end
-
-      logger = Logger.new(log_path)
-      logger.formatter = proc{|severity, datetime, progname, message|
-        "#{datetime},#{message}\n"
-      }
-
-      observe_methods.each do |observe_method|
-        method_full_name = "#{class_name}#{observe_method}"
-        logger.info(method_full_name) unless methods.include?(method_full_name)
-      end
-
-    end
   end
-end
+end

data/lib/okuribito/version.rb

@@ -1,3 +1,3 @@
 module Okuribito
-  VERSION = "0.0.1"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: okuribito
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.1
 platform: ruby
 authors:
 - muramurasan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-21 00:00:00.000000000 Z
+date: 2016-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -90,11 +90,11 @@ files:
 - .gitignore
 - .rspec
 - CODE_OF_CONDUCT.md
+- Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/console
-- bin/setup
+- circle.yml
 - lib/okuribito.rb
 - lib/okuribito/version.rb
 - okuribito.gemspec

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "okuribito"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here