method_decorators 0.9.0 → 0.9.1

data/.gitignore

@@ -3,6 +3,7 @@
 .bundle
 .config
 .yardoc
+.rvmrc
 Gemfile.lock
 InstalledFiles
 _yardoc

data/Contributors.md

@@ -0,0 +1,4 @@
+Thanks to everyone who's contributed.
+
+- Micah Frost - @mfrost
+- Isaac Sanders - @isaacsanders

data/History.md

@@ -0,0 +1,8 @@
+0.9.1
+=====
+- Added Memoize, Retry, and Precondition [@mfrost]
+
+
+0.9.0
+=====
+- Initial release!

data/README.md

@@ -11,7 +11,7 @@ Python's function decorators for Ruby.
 Extend MethodDecorators in a class where you want to use them, and then stick `+DecoratorName` before your method declaration to use it.
 
 ```ruby
-class SlowMath
+class Math
   extend MethodDecorators
 
   +Memoized
@@ -25,6 +25,27 @@ class SlowMath
 end
 ```
 
+You can also decorate with an instance of a decorator, rather than the class. This is useful for configuring specific options for the decorator.
+
+```ruby
+class ExternalService
+  extend MethodDecorators
+
+  +Retry.new(3)
+  def request
+    ...
+  end
+end
+```
+
+### Included decorators
+
+Include these with `require 'method_decorators/decorators/name_of_decorator'`, or all at once with `require 'method_decorators/decorators'`.
+
+- 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
+- Precondition - raises an error if the precondition (passed as a block) is not met
+
 ### Defining a decorator
 
 ```ruby
@@ -35,4 +56,7 @@ class Transactional < MethodDecorator
     end
   end
 end
-```
+```
+
+## License
+MethodDecorators is available under the MIT license and is freely available for all use, including personal, commercial, and academic. See LICENSE for details.

data/lib/method_decorators/decorators/memoize.rb

@@ -0,0 +1,11 @@
+class Memoize < MethodDecorator
+  def initialize
+    @cache ||= {}
+    super
+  end
+
+  def call(orig, *args, &blk)
+    return @cache[args] if @cache.has_key?(args)
+    @cache[args] = orig.call(*args, &blk)
+  end
+end

data/lib/method_decorators/decorators/precondition.rb

@@ -0,0 +1,18 @@
+class Precondition < MethodDecorator
+  def initialize(&blk)
+    @block = blk
+  end
+
+  def call(orig, *args, &blk)
+    unless passes?(orig.receiver, *args)
+      raise ArgumentError, "failed precondition"
+    end
+    orig.call(*args, &blk)
+  end
+
+private
+
+  def passes?(context, *args)
+    context.instance_exec(*args, &@block)
+  end
+end

data/lib/method_decorators/decorators/retry.rb

@@ -0,0 +1,16 @@
+class Retry < MethodDecorator
+  def initialize(max)
+    @max = max
+  end
+
+  def call(orig, *args, &blk)
+    attempts = 0
+    begin
+      attempts += 1
+      orig.call(*args, &blk)
+    rescue
+      retry  if attempts < @max
+      raise
+    end
+  end
+end

data/lib/method_decorators/decorators.rb

@@ -0,0 +1 @@
+Dir[File.dirname(__FILE__) + '/decorators/*.rb'].each {|file| require file }

data/lib/method_decorators/version.rb

@@ -1,3 +1,3 @@
 module MethodDecorators
-  VERSION = "0.9.0"
+  VERSION = "0.9.1"
 end

data/lib/method_decorators.rb

@@ -5,18 +5,17 @@ module MethodDecorators
     super
     orig_method = instance_method(name)
 
+    decorators = MethodDecorator.current_decorators
+    return  if decorators.empty?
+
     if    private_method_defined?(name);   visibility = :private
     elsif protected_method_defined?(name); visibility = :protected
     else                                   visibility = :public
     end
 
-    decorators = MethodDecorator.current_decorators
-    return  if decorators.empty?
-
     define_method(name) do |*args, &blk|
-      decorators.reduce(orig_method.bind(self)) do |callable, decorator|
-        lambda{|*a, &b| decorator.call(callable, *a, &b) }
-      end.call(*args, &blk)
+      decorated = MethodDecorators.decorate_callable(orig_method.bind(self), decorators)
+      decorated.call(*args, &blk)
     end
 
     case visibility
@@ -33,9 +32,14 @@ module MethodDecorators
     return  if decorators.empty?
 
     MethodDecorators.define_others_singleton_method(self, name) do |*args, &blk|
-      decorators.reduce(orig_method) do |callable, decorator|
-        lambda{|*a, &b| decorator.call(callable, *a, &b) }
-      end.call(*args, &blk)
+      decorated = MethodDecorators.decorate_callable(orig_method, decorators)
+      decorated.call(*args, &blk)
+    end
+  end
+
+  def self.decorate_callable(orig, decorators)
+    decorators.reduce(orig) do |callable, decorator|
+      lambda{ |*a, &b| decorator.call(callable, *a, &b) }
     end
   end
 
@@ -66,4 +70,4 @@ class MethodDecorator
   def +@
     @@current_decorators.unshift(self)
   end
-end
+end

data/spec/decorators/memoize_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+require 'method_decorators/decorators/memoize'
+
+describe Memoize do
+  describe "#call" do
+    let(:method) { double(:method, :call => :calculation) }
+    subject { Memoize.new }
+
+    it "calculates the value the first time the arguments are supplied" do
+      method.should_receive(:call)
+      subject.call(method, 10)
+    end
+
+    it "stores the value of the method call" do
+      method.stub(:call).and_return(:foo, :bar)
+      subject.call(method, 10).should == :foo
+      subject.call(method, 10).should == :foo
+    end
+
+    it "memoizes the return value and skips the call the second time" do
+      subject.call(method, 10)
+      method.should_not_receive(:call)
+      subject.call(method, 10)
+    end
+
+    it "memoizes different values for different arguments" do
+      method.stub(:call).with(10).and_return(:foo, :bar)
+      method.stub(:call).with(20).and_return(:bar, :foo)
+      subject.call(method, 10).should == :foo
+      subject.call(method, 10).should == :foo
+      subject.call(method, 20).should == :bar
+      subject.call(method, 20).should == :bar
+    end
+  end
+
+  describe "acceptance" do
+    let(:klass) do
+      Class.new Base do
+        +Memoize
+        def count
+          @count ||= 0
+          @count += 1
+        end
+      end
+    end
+    subject { klass.new }
+
+    it "memoizes calls to the method" do
+      subject.count.should == 1
+      subject.count.should == 1
+    end
+  end
+end

data/spec/decorators/precondition_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+require 'method_decorators/decorators/precondition'
+
+describe Precondition do
+  let(:receiver) { double(:receiver) }
+  let(:method) { double(:method, :call => :secret, :receiver => receiver) }
+  let(:block) { proc { |arg| true } }
+  subject { Precondition.new(&block) }
+
+  describe "#call" do
+    it "raises when the precondition fails" do
+      subject.stub(:passes?){ false }
+      expect{ subject.call(method) }.to raise_error(ArgumentError)
+    end
+
+    it "executes the method when authorization succeeds" do
+      subject.stub(:passes?){ true }
+      subject.call(method).should == :secret
+    end
+  end
+
+  describe "acceptance" do
+    let(:klass) do
+      Class.new Base do
+        def initialize(x)
+          @x = x
+        end
+
+        +Precondition.new{ |a| a + @x < 10 }
+        def multiply(a)
+	  a * @x
+        end
+      end
+    end
+    subject { klass.new(3) }
+
+    it "calls the method if the precondition passes" do
+      subject.multiply(2).should == 6
+    end
+
+    it "raises if the precondition passes" do
+      expect{ subject.multiply(8) }.to raise_error(ArgumentError)
+    end
+  end
+end

data/spec/decorators/retry_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+require 'method_decorators/decorators/retry'
+
+describe Retry do
+  let(:method) { double(:method, :call => false) }
+  subject { Retry.new(3) }
+
+  describe "#call" do
+    it "executes the method again if the first time failed " do
+      method.stub(:call){ raise }
+
+      method.should_receive(:call).exactly(3).times
+      expect{ subject.call(method) }.to raise_error
+    end
+
+    it "does not retry the method if it succeeds" do
+      method.should_receive(:call).once.and_return(3)
+      subject.call(method).should == 3
+    end
+  end
+
+  describe "acceptance" do
+    let(:klass) do
+      Class.new Base do
+        +Retry.new(3)
+        def do_it(magic_number)
+          @times ||= 0
+          @times += 1
+          raise  if @times == magic_number
+          @times
+        end
+      end
+    end
+    subject { klass.new }
+
+    it "memoizes calls to the method" do
+      subject.do_it(1).should == 2
+    end
+  end
+end

data/spec/method_decorators_spec.rb

@@ -1,9 +1,5 @@
 require 'spec_helper'
 
-class Base
-  extend MethodDecorators
-end
-
 describe MethodDecorators do
   subject { klass.new }
 

data/spec/spec_helper.rb

@@ -4,6 +4,10 @@ require 'support/stringify'
 require 'support/add_n'
 require 'support/reverse'
 
+class Base
+  extend MethodDecorators
+end
+
 # This file was generated by the `rspec --init` command. Conventionally, all
 # specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
 # Require this file using `require "spec_helper.rb"` to ensure that it is only

metadata

@@ -1,43 +1,42 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: method_decorators
-version: !ruby/object:Gem::Version 
-  hash: 59
+version: !ruby/object:Gem::Version
+  version: 0.9.1
   prerelease: 
-  segments: 
-  - 0
-  - 9
-  - 0
-  version: 0.9.0
 platform: ruby
-authors: 
+authors:
 - Michael Fairley
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-04-24 00:00:00 Z
+date: 2012-05-01 00:00:00.000000000 Z
 dependencies: []
-
 description: Python's function decorators for Ruby
-email: 
+email:
 - michaelfairley@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .rspec
 - .travis.yml
+- Contributors.md
 - Gemfile
+- History.md
 - LICENSE
 - README.md
 - Rakefile
 - lib/method_decorators.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/version.rb
 - method_decorators.gemspec
+- spec/decorators/memoize_spec.rb
+- spec/decorators/precondition_spec.rb
+- spec/decorators/retry_spec.rb
 - spec/method_decorators_spec.rb
 - spec/spec_helper.rb
 - spec/support/add_n.rb
@@ -45,38 +44,32 @@ files:
 - spec/support/stringify.rb
 homepage: http://github.com/michaelfairley/method_decorators
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
 rubygems_version: 1.8.17
 signing_key: 
 specification_version: 3
 summary: Python's function decorators for Ruby
-test_files: 
+test_files:
+- spec/decorators/memoize_spec.rb
+- spec/decorators/precondition_spec.rb
+- spec/decorators/retry_spec.rb
 - spec/method_decorators_spec.rb
 - spec/spec_helper.rb
 - spec/support/add_n.rb