method_decorators 0.9.3 → 0.9.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6785de47236233823f549e66f287ee890f124a26
+  data.tar.gz: 4ecf3e013b9f697ae331f0b437141527a8cf9d09
+SHA512:
+  metadata.gz: 20d7254686c1318bf47f5c652c2ca58fbfcd00beb215beebaa506997a0c36c4428e3c5074cec2783ba7a344a30aff039395fc24143e8ba1a5bd65148b7526bce
+  data.tar.gz: da3881d7736c32a1ecc9412b1fcacef497f7668d0d34a412bb5a758dbc1ab4f3f738b35aaf6858950600e0bcd3a766cc76dc60ee4194bdf0b79abaa22d82f05b

data/.travis.yml

@@ -3,10 +3,10 @@ rvm:
   - 1.8.7
   - 1.9.2
   - 1.9.3
+  - 2.0.0
   - jruby-18mode
   - jruby-19mode
-  - rbx-18mode
-  - rbx-19mode
+  - rbx-2.1.1
   - ruby-head
   - jruby-head
-  - ree
+  - ree

data/README.md

@@ -2,6 +2,8 @@
 
 Python's function decorators for Ruby.
 
+I probably wouldn't use this in production.
+
 ## Installation
 `gem install method_decorators`
 
@@ -11,11 +13,13 @@ 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 decorate the method.
 
 ```ruby
-class Math
+require "method_decorators/memoize"
+
+class MyMath
   extend MethodDecorators
 
-  +MethodDecorators::Memoized
-  def fib(n)
+  +MethodDecorators::Memoize
+  def self.fib(n)
     if n <= 1
       1
     else
@@ -23,6 +27,8 @@ class Math
     end
   end
 end
+
+puts MyMath.fib(200)
 ```
 
 You can also decorate with an instance of a decorator, rather than the class. This is useful for configuring specific options for the decorator.

data/lib/method_decorators/deprecated.rb

@@ -0,0 +1,84 @@
+require 'method_decorators'
+
+module MethodDecorators
+  # Example:
+  #   class MyClass
+  #     extend MethodDecorators
+  #
+  #     +MethodDecorators::Deprecated
+  #     def deprecated_method
+  #       brand_new_method
+  #     end
+  #   end
+  # When deprecated_method is called, message
+  #   "MyClass#deprecated_method is deprecated"
+  # is output.
+  #
+  # Another example:
+  #   class MyClass
+  #     extend MethodDecorators
+  #
+  #     +MethodDecorators::Deprecated.new('deprecated_method will be removed in the future')
+  #     def deprecated_method
+  #       brand_new_method
+  #     end
+  #   end
+  # Above output given message
+  #   "deprecated_method will be removed in the future"
+  #
+  # Custom message example:
+  #   class MyClass
+  #     extend MethodDecorators
+  #
+  #     +MethodDecorators::Deprecated.new {|class_name, method_name| "#{class_name}##{method_name} will be removed in the future. Use #{class_name}#brand_new_method instead"}
+  #     def deprecated_method
+  #       brand_new_method
+  #     end
+  #   end
+  # Outputs
+  #   "MyClass#deprecated_method will be removed in the future. Use MyClass#brand_new_method instead"
+  # As you see, you can use class name as the first argument and method name as the second in the block.
+  #
+  # Formatter example:
+  #   class Formatter2
+  #     def call(class_name, method_name)
+  #       "#{class_name}##{method_name} will be removed after the next version. Use #{class_name}#brand_new_method instead"
+  #     end
+  #   end
+  #   class MyClass
+  #     extend MethodDecorators
+  #
+  #     formatter1 = ->(class_mane, method_name) {"#{class_name}##{method_name} will be removed in the next version. Use #{class_name}#brand_new_method instead"}
+  #     +MethodDecorators::Deprecated.new(formatter1)
+  #     def very_old_method
+  #       brand_new_method
+  #     end
+  #
+  #     + MethodDecorators::Deprecated.new(Formatter2.new)
+  #     def deprecated_method
+  #       brand_new_method
+  #     end
+  #   end
+  # Outputs
+  #   "MyClass#deprecated_method will be removed in the future. Use MyClass#brand_new_method instead"
+  # You can give any object which responds to method "call" like Proc.
+  class Deprecated < Decorator
+    DEFAULT_FORMATTER = lambda {|class_name, method_name| "#{class_name}##{method_name} is deprecated"}
+    def initialize(message=nil, &blk)
+      @message = message || blk || DEFAULT_FORMATTER
+    end
+
+    def call(orig, this, *args, &blk)
+      warn message(this.class, orig.name)
+      orig.call(*args, &blk)
+    end
+
+    def message(class_name, method_name)
+      if @message.respond_to? :call
+        @message.call(class_name, method_name)
+      else
+        @message.to_s
+      end
+    end
+  end
+end

data/lib/method_decorators/memoize.rb

@@ -2,6 +2,10 @@ require "method_decorators"
 
 module MethodDecorators
   class Memoize < Decorator
+    def initialize
+      @memo_ivar = "@_memoize_cache#{rand(10**10)}"
+    end
+
     def call(orig, this, *args, &blk)
       return cache(this)[args] if cache(this).has_key?(args)
       cache(this)[args] = orig.call(*args, &blk)
@@ -9,7 +13,10 @@ module MethodDecorators
 
     private
     def cache(this)
-      this.instance_variable_get("@_memoize_cache") || this.instance_variable_set("@_memoize_cache", {})
+      memo_ivar = @memo_ivar
+      this.instance_eval do
+        instance_variable_get(memo_ivar) || instance_variable_set(memo_ivar, {})
+      end
     end
   end
 end

data/lib/method_decorators/version.rb

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

data/spec/decorators/deprecated.rb

@@ -0,0 +1,115 @@
+require 'spec_helper'
+require 'method_decorators/deprecated'
+require 'stringio'
+
+describe MethodDecorators::Deprecated do
+  let(:method) { double(:method, :call => 'return value of original method', :name => 'deprecated_method') }
+
+  describe '#call' do
+    subject { MethodDecorators::Deprecated.new }
+
+    it 'calls original method' do
+      method.should_receive(:call)
+      subject.call(method, nil)
+    end
+
+    it 'warns' do
+      subject.should_receive(:warn)
+      subject.call(method, nil)
+    end
+
+    context 'when string given on initializing' do
+      subject { MethodDecorators::Deprecated.new('custom message') }
+
+      it 'warns with given string' do
+        subject.should_receive(:warn).with('custom message')
+        subject.call(method, nil)
+      end
+    end
+
+    context 'when block given on initializing' do
+      subject { MethodDecorators::Deprecated.new {|klass, method| "#{klass}##{method}"} }
+
+      it 'warns with message formatted by the block' do
+        subject.should_receive(:warn).with('NilClass#deprecated_method')
+        subject.call(method, nil)
+      end
+    end
+
+    context 'when object which has #call method given on initializing' do
+      subject { MethodDecorators::Deprecated.new(lambda { |klass, method| "#{klass}##{method}" }) }
+
+      it 'warns with message formatted by the object' do
+        subject.should_receive(:warn).with('NilClass#deprecated_method')
+        subject.call(method, nil)
+      end
+    end
+  end
+
+  describe 'acceptance' do
+    before do
+      $stderr = StringIO.new
+      subject.deprecated_method
+      $stderr.rewind
+    end
+
+    let(:klass) {
+      Class.new Base do
+        +MethodDecorators::Deprecated
+        def deprecated_method
+          'return value of original method'
+        end
+      end
+    }
+    subject { klass.new }
+
+    it 'warns' do
+      expect($stderr.read).to eq("#{klass}#deprecated_method is deprecated\n")
+    end
+
+    context 'when string given on initializing' do
+      let(:klass) {
+        Class.new Base do
+          +MethodDecorators::Deprecated.new('custom message')
+          def deprecated_method
+            'return value of original method'
+          end
+        end
+      }
+
+      it 'warns with given string' do
+        expect($stderr.read).to eq("custom message\n")
+      end
+    end
+
+    context 'when block given on initializing' do
+      let(:klass) {
+        Class.new Base do
+          +MethodDecorators::Deprecated.new {|class_name, method_name| "#{class_name}##{method_name} is deprecated"}
+          def deprecated_method
+            'return value of original method'
+          end
+        end
+      }
+
+      it 'warns with message formatted by the block' do
+        expect($stderr.read).to eq("#{klass}#deprecated_method is deprecated\n")
+      end
+    end
+
+    context 'when object witch has #call method givn on initializing' do
+      let(:klass) {
+        Class.new Base do
+          +MethodDecorators::Deprecated.new(lambda { |class_name, method_name| "#{class_name}##{method_name} is deprecated" })
+          def deprecated_method
+            'return value of original method'
+          end
+        end
+      }
+
+      it 'warns with message formatted by the object' do
+        expect($stderr.read).to eq("#{klass}#deprecated_method is deprecated\n")
+      end
+    end
+  end
+end

data/spec/decorators/memoize_spec.rb

@@ -43,6 +43,16 @@ describe MethodDecorators::Memoize do
           @count += 1
           rand
         end
+
+        +MethodDecorators::Memoize
+        def zero
+          0
+        end
+
+        +MethodDecorators::Memoize
+        def one
+          1
+        end
       end
     end
     subject { klass.new }
@@ -54,6 +64,11 @@ describe MethodDecorators::Memoize do
       #subject.count.should == 1
     end
 
+    it "memoizes call to different methods separately" do
+      subject.zero.should eql 0
+      subject.one.should eql 1
+    end
+
     context "with two instances of the decorated class" do
       let(:o1) { subject }
       let(:o2) { klass.new }

data/spec/decorators/within_spec.rb

@@ -13,7 +13,7 @@ describe MethodDecorators::Within do
 
     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)
+      expect{ subject.call(method, nil) }.to_not raise_error
     end
   end
 
@@ -36,7 +36,7 @@ describe MethodDecorators::Within do
 
     context "with shorter execution period" do
       it "finishes within the timeout period" do
-        expect{ subject.do_it(1) }.to_not raise_error(Timeout::Error)
+        expect{ subject.do_it(1) }.to_not raise_error
       end
     end
   end

data/spec/method_decorators_spec.rb

@@ -96,7 +96,7 @@ describe MethodDecorators do
 
       it "works" do
         subject.six.should == '6'
-      end    
+      end
     end
 
     describe "that takes args" do
@@ -193,7 +193,7 @@ describe MethodDecorators do
 
       it "works" do
         subject.six.should == '6'
-      end    
+      end
     end
 
     describe "that takes args" do

metadata

@@ -1,38 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: method_decorators
 version: !ruby/object:Gem::Version
-  version: 0.9.3
-  prerelease: 
+  version: 0.9.4
 platform: ruby
 authors:
 - Michael Fairley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-04 00:00:00.000000000 Z
+date: 2014-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70128902042200 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70128902042200
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70128902041760 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70128902041760
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Python's function decorators for Ruby
 email:
 - michaelfairley@gmail.com
@@ -56,12 +61,14 @@ files:
 - lib/method_decorators/decorators/memoize.rb
 - lib/method_decorators/decorators/precondition.rb
 - lib/method_decorators/decorators/retry.rb
+- lib/method_decorators/deprecated.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/deprecated.rb
 - spec/decorators/memoize_spec.rb
 - spec/decorators/precondition_spec.rb
 - spec/decorators/retry_spec.rb
@@ -73,29 +80,29 @@ files:
 - spec/support/stringify.rb
 homepage: http://github.com/michaelfairley/method_decorators
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.7
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Python's function decorators for Ruby
 test_files:
+- spec/decorators/deprecated.rb
 - spec/decorators/memoize_spec.rb
 - spec/decorators/precondition_spec.rb
 - spec/decorators/retry_spec.rb
@@ -105,4 +112,3 @@ test_files:
 - spec/support/add_n.rb
 - spec/support/reverse.rb
 - spec/support/stringify.rb
-has_rdoc: