method_decorators 0.9.2 → 0.9.3

data/Contributors.md

@@ -2,3 +2,4 @@ Thanks to everyone who's contributed.
 
 - Micah Frost - @mfrost
 - Isaac Sanders - @isaacsanders
+- Toby Hsieh - @tobyhs

data/Gemfile

@@ -2,6 +2,3 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in method_decorators.gemspec
 gemspec
-
-gem 'rake'
-gem 'rspec'

data/History.md

@@ -1,3 +1,12 @@
+0.9.3
+=====
+- Fix double require bugs [@tobyhs]
+- Namespace Decorator, Memoize, Precondition, Retry, and Within under MethodDecorators:: [@tobyhs]
+
+0.9.2
+=====
+- Pass `this` (the receiver of the decorated method) to the decorators. Fixes `Precondition` with multiple preconditions and `Memoize`.
+
 0.9.1
 =====
 - Added Memoize, Retry, and Precondition [@mfrost]

data/README.md

@@ -8,13 +8,13 @@ Python's function decorators for Ruby.
 ## Usage
 
 ### Using a decorator
-Extend MethodDecorators in a class where you want to use them, and then stick `+DecoratorName` before your method declaration to use it.
+Extend MethodDecorators in a class where you want to use them, and then stick `+DecoratorName` before your method declaration to decorate the method.
 
 ```ruby
 class Math
   extend MethodDecorators
 
-  +Memoized
+  +MethodDecorators::Memoized
   def fib(n)
     if n <= 1
       1
@@ -31,7 +31,21 @@ You can also decorate with an instance of a decorator, rather than the class. Th
 class ExternalService
   extend MethodDecorators
 
-  +Retry.new(3)
+  +MethodDecorators::Retry.new(3)
+  def request
+    ...
+  end
+end
+```
+
+You can also set multiple decorators for your methods. Each decorator executes within the previously declared decorator. i.e. they are nested, as expected to be.
+
+```ruby
+class ExternalService
+  extend MethodDecorators
+
+  +MethodDecorators::Retry.new(3)
+  +MethodDecorators::Within.new(2.seconds)
   def request
     ...
   end
@@ -40,16 +54,17 @@ end
 
 ### Included decorators
 
-Include these with `require 'method_decorators/decorators/name_of_decorator'`, or all at once with `require 'method_decorators/decorators'`.
+Include these with `require 'method_decorators/name_of_decorator'`, or all at once with `require 'method_decorators/all'`.
 
 - Memoize - caches the result of the method for each arg combination it's called with
 - Retry - retries the method up to n (passed in to the constructor) times if the method errors
+- Within - times outs if a request doesn't complete within n seconds
 - Precondition - raises an error if the precondition (passed as a block) is not met
 
 ### Defining a decorator
 
 ```ruby
-class Transactional < MethodDecorator
+class Transactional < MethodDecorators::Decorator
   def call(wrapped, this, *args, &blk)
     ActiveRecord::Base.transaction do
       wrapped.call(*args, &blk)

data/lib/method_decorators/all.rb

@@ -0,0 +1,5 @@
+require "method_decorators/memoize"
+require "method_decorators/retry"
+require "method_decorators/precondition"
+require "method_decorators/within"
+

data/lib/method_decorators/decorator.rb

@@ -0,0 +1,19 @@
+module MethodDecorators
+  class Decorator
+    @@current_decorators = []
+
+    def self.current_decorators
+      decs = @@current_decorators
+      @@current_decorators = []
+      decs
+    end
+
+    def self.+@
+      +new
+    end
+
+    def +@
+      @@current_decorators.unshift(self)
+    end
+  end
+end

data/lib/method_decorators/decorators/memoize.rb

@@ -1,11 +1,2 @@
-class Memoize < MethodDecorator
-  def call(orig, this, *args, &blk)
-    return cache(this)[args] if cache(this).has_key?(args)
-    cache(this)[args] = orig.call(*args, &blk)
-  end
-
-private
-  def cache(this)
-    this.instance_variable_get("@_memoize_cache") || this.instance_variable_set("@_memoize_cache", {})
-  end
-end
+require "method_decorators/memoize"
+::Memoize = MethodDecorators::Memoize

data/lib/method_decorators/decorators/precondition.rb

@@ -1,18 +1,2 @@
-class Precondition < MethodDecorator
-  def initialize(&blk)
-    @block = blk
-  end
-
-  def call(orig, this, *args, &blk)
-    unless passes?(this, *args)
-      raise ArgumentError, "failed precondition"
-    end
-    orig.call(*args, &blk)
-  end
-
-private
-
-  def passes?(context, *args)
-    context.instance_exec(*args, &@block)
-  end
-end
+require "method_decorators/precondition"
+Precondition = MethodDecorators::Precondition

data/lib/method_decorators/decorators/retry.rb

@@ -1,16 +1,2 @@
-class Retry < MethodDecorator
-  def initialize(max)
-    @max = max
-  end
-
-  def call(orig, this, *args, &blk)
-    attempts = 0
-    begin
-      attempts += 1
-      orig.call(*args, &blk)
-    rescue
-      retry  if attempts < @max
-      raise
-    end
-  end
-end
+require "method_decorators/retry"
+::Retry = MethodDecorators::Retry

data/lib/method_decorators/decorators.rb

@@ -1 +1,2 @@
+# This is deprecated. Use `require "method_decorators/all"` instead.
 Dir[File.dirname(__FILE__) + '/decorators/*.rb'].each {|file| require file }

data/lib/method_decorators/memoize.rb

@@ -0,0 +1,15 @@
+require "method_decorators"
+
+module MethodDecorators
+  class Memoize < Decorator
+    def call(orig, this, *args, &blk)
+      return cache(this)[args] if cache(this).has_key?(args)
+      cache(this)[args] = orig.call(*args, &blk)
+    end
+
+    private
+    def cache(this)
+      this.instance_variable_get("@_memoize_cache") || this.instance_variable_set("@_memoize_cache", {})
+    end
+  end
+end

data/lib/method_decorators/precondition.rb

@@ -0,0 +1,22 @@
+require "method_decorators"
+
+module MethodDecorators
+  class Precondition < Decorator
+    def initialize(&blk)
+      @block = blk
+    end
+
+    def call(orig, this, *args, &blk)
+      unless passes?(this, *args)
+        raise ArgumentError, "failed precondition"
+      end
+      orig.call(*args, &blk)
+    end
+
+  private
+
+    def passes?(context, *args)
+      context.instance_exec(*args, &@block)
+    end
+  end
+end

data/lib/method_decorators/retry.rb

@@ -0,0 +1,20 @@
+require "method_decorators"
+
+module MethodDecorators
+  class Retry < Decorator
+    def initialize(max)
+      @max = max
+    end
+
+    def call(orig, this, *args, &blk)
+      attempts = 0
+      begin
+        attempts += 1
+        orig.call(*args, &blk)
+      rescue
+        retry  if attempts < @max
+        raise
+      end
+    end
+  end
+end

data/lib/method_decorators/version.rb

@@ -1,3 +1,3 @@
 module MethodDecorators
-  VERSION = "0.9.2"
+  VERSION = "0.9.3"
 end

data/lib/method_decorators/within.rb

@@ -0,0 +1,16 @@
+require "method_decorators"
+require 'timeout'
+
+module MethodDecorators
+  class Within < Decorator
+    def initialize(timeout)
+      @seconds = timeout
+    end
+
+    def call(orig, this, *args, &blk)
+      Timeout::timeout(@seconds) do
+        orig.call(*args, &blk)
+      end
+    end
+  end
+end

data/lib/method_decorators.rb

@@ -1,11 +1,12 @@
 require "method_decorators/version"
+require "method_decorators/decorator"
 
 module MethodDecorators
   def method_added(name)
     super
     orig_method = instance_method(name)
 
-    decorators = MethodDecorator.current_decorators
+    decorators = Decorator.current_decorators
     return  if decorators.empty?
 
     if    private_method_defined?(name);   visibility = :private
@@ -28,7 +29,7 @@ module MethodDecorators
     super
     orig_method = method(name)
 
-    decorators = MethodDecorator.current_decorators
+    decorators = Decorator.current_decorators
     return  if decorators.empty?
 
     MethodDecorators.define_others_singleton_method(self, name) do |*args, &blk|
@@ -53,21 +54,3 @@ module MethodDecorators
     end
   end
 end
-
-class MethodDecorator
-  @@current_decorators = []
-
-  def self.current_decorators
-    decs = @@current_decorators
-    @@current_decorators = []
-    decs
-  end
-
-  def self.+@
-    +new
-  end
-
-  def +@
-    @@current_decorators.unshift(self)
-  end
-end

data/method_decorators.gemspec

@@ -1,5 +1,7 @@
 # -*- encoding: utf-8 -*-
-require File.expand_path('../lib/method_decorators/version', __FILE__)
+lib_dir = File.expand_path('lib', File.dirname(__FILE__))
+$LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
+require 'method_decorators/version'
 
 Gem::Specification.new do |gem|
   gem.authors       = ["Michael Fairley"]
@@ -14,4 +16,7 @@ Gem::Specification.new do |gem|
   gem.name          = "method_decorators"
   gem.require_paths = ["lib"]
   gem.version       = MethodDecorators::VERSION
+
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rspec"
 end

data/spec/decorators/memoize_spec.rb

@@ -1,11 +1,11 @@
 require 'spec_helper'
-require 'method_decorators/decorators/memoize'
+require 'method_decorators/memoize'
 
-describe Memoize do
+describe MethodDecorators::Memoize do
   describe "#call" do
     let(:method) { double(:method, :call => :calculation) }
     let(:this) { Object.new }
-    subject { Memoize.new }
+    subject { MethodDecorators::Memoize.new }
 
     it "calculates the value the first time the arguments are supplied" do
       method.should_receive(:call)
@@ -37,7 +37,7 @@ describe Memoize do
   describe "acceptance" do
     let(:klass) do
       Class.new Base do
-        +Memoize
+        +MethodDecorators::Memoize
         def count
           @count ||= 0
           @count += 1

data/spec/decorators/precondition_spec.rb

@@ -1,11 +1,11 @@
 require 'spec_helper'
-require 'method_decorators/decorators/precondition'
+require 'method_decorators/precondition'
 
-describe Precondition do
+describe MethodDecorators::Precondition do
   let(:receiver) { double(:receiver) }
   let(:method) { double(:method, :call => :secret, :receiver => receiver) }
   let(:block) { proc { |arg| true } }
-  subject { Precondition.new(&block) }
+  subject { MethodDecorators::Precondition.new(&block) }
 
   describe "#call" do
     it "raises when the precondition fails" do
@@ -26,13 +26,13 @@ describe Precondition do
           @x = x
         end
 
-        +Precondition.new{ |a| a + @x < 10 }
+        +MethodDecorators::Precondition.new{ |a| a + @x < 10 }
         def multiply(a)
 	  a * @x
         end
 
-        +Precondition.new{ |a| a + @x == 10 }
-        +Precondition.new{ |a| a * @x == 21 }
+        +MethodDecorators::Precondition.new{ |a| a + @x == 10 }
+        +MethodDecorators::Precondition.new{ |a| a * @x == 21 }
         def concat(a)
           "#{@x}#{a}"
         end

data/spec/decorators/retry_spec.rb

@@ -1,9 +1,9 @@
 require 'spec_helper'
-require 'method_decorators/decorators/retry'
+require 'method_decorators/retry'
 
-describe Retry do
+describe MethodDecorators::Retry do
   let(:method) { double(:method, :call => false) }
-  subject { Retry.new(3) }
+  subject { MethodDecorators::Retry.new(3) }
 
   describe "#call" do
     it "executes the method again if the first time failed " do
@@ -22,7 +22,7 @@ describe Retry do
   describe "acceptance" do
     let(:klass) do
       Class.new Base do
-        +Retry.new(3)
+        +MethodDecorators::Retry.new(3)
         def do_it(magic_number)
           @times ||= 0
           @times += 1

data/spec/decorators/within_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+require 'method_decorators/within'
+
+describe MethodDecorators::Within do
+  let(:method) { double(:method, :call => false) }
+  subject { MethodDecorators::Within.new(2) }
+
+  describe "#call" do
+    it "raises when the timeout seconds have elapsed" do
+      method.stub(:call){ sleep 3 }
+      expect{ subject.call(method, nil) }.to raise_error(Timeout::Error)
+    end
+
+    it "does not raise when the method has finished execution before timeout" do
+      method.stub(:call){ sleep 1 }
+      expect{ subject.call(method, nil) }.to_not raise_error(Timeout::Error)
+    end
+  end
+
+  describe "acceptance" do
+    let(:klass) do
+      Class.new Base do
+        +MethodDecorators::Within.new(2)
+        def do_it(execution_period)
+          sleep(execution_period)
+        end
+      end
+    end
+    subject { klass.new }
+
+    context "with longer execution period" do
+      it "raises if the timeout period has elapsed" do
+        expect{ subject.do_it(3) }.to raise_error(Timeout::Error)
+      end
+    end
+
+    context "with shorter execution period" do
+      it "finishes within the timeout period" do
+        expect{ subject.do_it(1) }.to_not raise_error(Timeout::Error)
+      end
+    end
+  end
+end

data/spec/support/add_n.rb

@@ -1,4 +1,4 @@
-class AddN < MethodDecorator
+class AddN < MethodDecorators::Decorator
   def initialize(n)
     @n = n
   end
@@ -6,4 +6,4 @@ class AddN < MethodDecorator
   def call(orig, this, *args, &blk)
     orig.call(*args, &blk) + @n
   end
-end
+end

data/spec/support/reverse.rb

@@ -1,5 +1,5 @@
-class Reverse < MethodDecorator
+class Reverse < MethodDecorators::Decorator
   def call(orig, this, *args, &blk)
     orig.call(*args.reverse, &blk)
   end
-end
+end

data/spec/support/stringify.rb

@@ -1,4 +1,4 @@
-class Stringify < MethodDecorator
+class Stringify < MethodDecorators::Decorator
   def call(orig, this, *args, &blk)
     orig.call(*args, &blk).to_s
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: method_decorators
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 0.9.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,30 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-15 00:00:00.000000000 Z
-dependencies: []
+date: 2013-03-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70128902042200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70128902042200
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70128902041760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70128902041760
 description: Python's function decorators for Ruby
 email:
 - michaelfairley@gmail.com
@@ -28,15 +50,22 @@ files:
 - README.md
 - Rakefile
 - lib/method_decorators.rb
+- lib/method_decorators/all.rb
+- lib/method_decorators/decorator.rb
 - lib/method_decorators/decorators.rb
 - lib/method_decorators/decorators/memoize.rb
 - lib/method_decorators/decorators/precondition.rb
 - lib/method_decorators/decorators/retry.rb
+- lib/method_decorators/memoize.rb
+- lib/method_decorators/precondition.rb
+- lib/method_decorators/retry.rb
 - lib/method_decorators/version.rb
+- lib/method_decorators/within.rb
 - method_decorators.gemspec
 - spec/decorators/memoize_spec.rb
 - spec/decorators/precondition_spec.rb
 - spec/decorators/retry_spec.rb
+- spec/decorators/within_spec.rb
 - spec/method_decorators_spec.rb
 - spec/spec_helper.rb
 - spec/support/add_n.rb
@@ -62,7 +91,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.17
+rubygems_version: 1.8.7
 signing_key: 
 specification_version: 3
 summary: Python's function decorators for Ruby
@@ -70,8 +99,10 @@ test_files:
 - spec/decorators/memoize_spec.rb
 - spec/decorators/precondition_spec.rb
 - spec/decorators/retry_spec.rb
+- spec/decorators/within_spec.rb
 - spec/method_decorators_spec.rb
 - spec/spec_helper.rb
 - spec/support/add_n.rb
 - spec/support/reverse.rb
 - spec/support/stringify.rb
+has_rdoc: