bubot 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5164f040c4ac3f870f748ebd333ffc0a755b4e5f
-  data.tar.gz: d31db432a0ae70aedb45aeb98ec43b1f5a699581
+  metadata.gz: 8764e8dfff1268e2c54d7248d67d3ef8d6ad96ff
+  data.tar.gz: a928121e7306a845b1cc17b3ea3f676163047f94
 SHA512:
-  metadata.gz: c5bf37ee1f8e8f37b1bd236e37dc86066c3ac341b4e3c78243abcc0e48d99a8d7a9b925214e637dacbb4be373bd65a9314171e55991ff5ccae4c64fc830860d0
-  data.tar.gz: 23dc04269ed4d55b84d93583c49cd98cd19ac55fbec4ee1ad55752fd4de7e7596704f05b12cbda67a88cc388861a7b7dafb05782dbef54923582e2d71052381e
+  metadata.gz: f6fde114e83d818bfe1d267fbae30dc55cfebf60b21b1833f722015aa4c76a775c48089d8c7d0def03ea94ce4646b8f9b9494a786c2876ccdfc73683d505a38b
+  data.tar.gz: 62d5d55a37d2653d7ea238e6a418bf6c2421a817c4f56d466b46e4541fc2190fad3763302e86aec833c94b7b1ec6357f0dbf88ad0e07b0da20b75542dc9878b6

data/README.md

@@ -1,6 +1,11 @@
 # Bubot
 
-Take action when methods take too long
+Watch a method. If it takes longer than a specified amount of time,
+execute a block. It's a callback that only happens after a threshold.
+
+## Requirements
+
+    ruby > 2.0.0
 
 ## Installation
 
@@ -20,18 +25,53 @@ Or install it yourself as:
 
 Extend Bubot in your class.
 
-This gives you the class method `.watch(:method_name, threshold)`.
+This gives you the class method `.watch(:method_name, options)`.
+
+If a watched method takes longer than options[:timeout], the block will execute.
+Remember, the timeout is 0 by default so if you don't pass it a timeout, the
+block will always execute (like a callback)
+
+### Example
+
+```ruby
+class WebAPI
+  include Bubot
+
+  watch(:response, timeout: 2) do |web_api_object, time_it_took, method_response|
+    puts web_api_object   # => web_api_object instance
+    puts time_it_took     # => 3.5 (seconds)
+    puts method_response  # => "body"
+  end
 
-If a watched method takes longer than the specified amount of time (threshold), the block will execute.
+  def response
+    sleep 3
+    "body"
+  end
+end
+```
+
+You can also pass any object that responds to `call` by using the `:with`
+option.
 
 ```ruby
-class Foo
-    extend Bubot
+class LoggingStrategy
+
+  def self.call(web_api_object, time_it_took, method_response)
+    puts web_api_object   # => web_api_object instance
+    puts time_it_took     # => 5.2 (seconds)
+    puts method_response  # => "body"
+  end
+
+end
+
+class WebAPI
+  include Bubot
 
-    watch(:bar, 1) { run_some_code }
+  watch :response, timeout: 3, with: LoggingStrategy
 
-    def bar
-        sleep 1.1
-    end
+  def response
+    sleep 5
+    "body"
+  end
 end
 ```

data/Rakefile

@@ -1 +1,5 @@
 require "bundler/gem_tasks"
+
+task :default do
+  system "rspec"
+end

data/bubot.gemspec

@@ -21,4 +21,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec", "~> 2.14.1"
   spec.add_development_dependency "pry"
+
+  spec.add_dependency "activesupport"
 end

data/lib/bubot.rb

@@ -1,48 +1,51 @@
 require "bubot/version"
+require "active_support/concern"
+require "active_support/callbacks"
+require "active_support/core_ext/module/aliasing"
 
 module Bubot
+  extend ActiveSupport::Concern
+  include ActiveSupport::Callbacks
 
-  def watch(method_name, options={})
-    defaults = { timeout: 0 }
-    defaults.merge!(options)
-    define_method("#{method_name}_with_feature") do |*args, &block|
-      start_time = Time.now
+  module ClassMethods
+    def watch(method_name, timeout: 0, with: nil, &block)
+      define_callbacks method_name
 
-      method_return_value = send("#{method_name}_without_feature".to_sym, *args, &block)
+      past_time_block = with || (block if block_given?)
 
-      if (total_time = Time.now - start_time) >= defaults[:timeout]
-        if options[:with]
-          options[:with].call(self, total_time, method_return_value)
-        else
-          yield(self, total_time, method_return_value)
+      define_method("#{method_name}_with_bubot") do |*args, &block|
+        run_callbacks method_name do
+          send("#{method_name}_without_bubot".to_sym, *args, &block)
         end
       end
 
-      method_return_value
-    end
+      alias_method_chain_or_register_for_chaining method_name
 
-    alias_method_chain_or_register(method_name)
-  end
+      set_callback method_name, :around, ->(r, &block) do
+        start_time = Time.now
 
-  private
+        method_return_value = block.call
 
-  def alias_method_chain_or_register(method_name)
-    if method_defined?(method_name)
-      alias_method_chain(method_name)
-    else
-      (@method_names ||= []).push(method_name)
+        if (total_time = Time.now - start_time) >= timeout
+          past_time_block.call(self, total_time, method_return_value)
+        end
+      end
     end
-  end
 
-  def method_added(method_name)
-    if (@method_names ||= []).delete(method_name)
-      alias_method_chain(method_name)
+    private
+
+    def alias_method_chain_or_register_for_chaining(method_name)
+      if method_defined?(method_name)
+        alias_method_chain(method_name, :bubot)
+      else
+        (@method_names ||= []).push(method_name)
+      end
     end
-  end
 
-  def alias_method_chain(method_name)
-    alias_method "#{method_name}_without_feature".to_sym, method_name
-    alias_method  method_name, "#{method_name}_with_feature".to_sym
+    def method_added(method_name)
+      if (@method_names ||= []).delete(method_name)
+        alias_method_chain(method_name, :bubot)
+      end
+    end
   end
-
 end

data/lib/bubot/version.rb

@@ -1,3 +1,3 @@
 module Bubot
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

data/spec/bubot_spec.rb

@@ -12,7 +12,7 @@ end
 
 class Qux
   include Foo
-  extend Bubot
+  include Bubot
 
   watch :not_too_slow, timeout: 0.005 do
     Baz.buz
@@ -39,7 +39,7 @@ describe Bubot do
 
       it "watch is before the method" do
         class Before
-          extend Bubot
+          include Bubot
           watch(:next_method, timeout: 0.001) { Baz.buz }
           def next_method; sleep 0.002; end
         end
@@ -50,7 +50,7 @@ describe Bubot do
 
       it "watch is after the method" do
         class After
-          extend Bubot
+          include Bubot
           def previous_method; sleep 0.002; end
           watch(:previous_method, timeout: 0.001) { Baz.buz }
         end
@@ -63,7 +63,7 @@ describe Bubot do
     context "timeout is optional" do
       it "timeout is not passed" do
         class NoTimeout
-          extend Bubot
+          include Bubot
           watch(:without_timeout) { Baz.buz }
           def without_timeout() end
         end
@@ -77,7 +77,7 @@ describe Bubot do
       it "does nothing and does not break" do
         expect do
           class MethodDoesNotExist
-            extend Bubot
+            include Bubot
             watch(:dont_exist, timeout: 0.001) { Baz.buz }
           end
         end.not_to raise_error
@@ -93,7 +93,7 @@ describe Bubot do
         end
 
         class PassesSelf
-          extend Bubot
+          include Bubot
           watch(:pass_self, timeout: 0.001) do |instance|
             ReceivesSelfStrategy.execute(instance)
           end
@@ -114,7 +114,7 @@ describe Bubot do
         end
 
         class PassesTime
-          extend Bubot
+          include Bubot
           watch(:pass_time, timeout: 0.001) do |instance, time|
             ReceivesTimeStrategy.execute(instance, time)
           end
@@ -138,7 +138,7 @@ describe Bubot do
         end
 
         class PassesReturnValue
-          extend Bubot
+          include Bubot
           watch(:pass_return_value, timeout: 0.001) do |instance, time, return_value|
             ReceivesReturnValueStrategy.execute(instance, time, return_value)
           end
@@ -169,7 +169,7 @@ describe Bubot do
         end
 
         class UsingWith
-          extend Bubot
+          include Bubot
 
           watch :original, with: RespondingStrategy
 
@@ -191,7 +191,7 @@ describe Bubot do
     describe "the original method" do
       it "redefines the method to return the original value" do
         class OriginalMethod
-          extend Bubot
+          include Bubot
 
           watch :original do
             #something
@@ -209,7 +209,7 @@ describe Bubot do
 
       it "accepts the original methods arguments" do
         class OriginalArguments
-          extend Bubot
+          include Bubot
 
           watch :arguments do
             #something
@@ -221,14 +221,14 @@ describe Bubot do
         end
 
         original_class = OriginalArguments.new
-        expect(original_class).to receive(:arguments_without_feature).with("foo", "bar")
+        expect(original_class).to receive(:arguments_without_bubot).with("foo", "bar")
         original_class.arguments('foo', 'bar')
 
       end
 
       it "accepts the original methods block" do
         class OriginalBlock
-          extend Bubot
+          include Bubot
 
           watch :with_block do
             #something

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bubot
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Micah Cooper
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-27 00:00:00.000000000 Z
+date: 2014-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -67,6 +67,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Take action when methods take too long
 email:
 - mrmicahcooper@gmail.com
@@ -107,7 +121,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.0
+rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
 summary: Take action when methods take too long