decoratable 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6a8eadd3a9f64dd170469d9bf46f9765ce9d411a
-  data.tar.gz: e0daa4b811d58ef5b10b867b89743219b7a3ac0e
+  metadata.gz: ec20dff74a6642c85271dcb977529bcd33ca8174
+  data.tar.gz: 9ff3c561a008fff52d078a61ec2ab68630756580
 SHA512:
-  metadata.gz: b81d3a486e381d52d909002417d19c2578c63c3c784e5e2ee32357c7fe807eee8b902a5c4d640e7184d9fc4321de13f08f623a18c34c7decf7db01896b1f4208
-  data.tar.gz: c49567ab494c3e5ccd247adc8c0492c4b0186eb7086bbce37a6e579d288ab2b34f9abab76243ad65943d7eb5f2b630aa4c9007480505f0dabae6caf800ba1071
+  metadata.gz: c940d91c425fd100b43d850ae9e78522ae385a5dc9a52bd321b73c82b8f2f8411e6f4a53597699c657d4a5647d359cf15e30c70abc7198161494f74eeee5d65a
+  data.tar.gz: 6ef5795b503abba017d278c6bfdcd52c3d04d1929d99a7901829d0f09b14ac10e6db41c87188de9cf4d24d41c19e1b01e6ae3d123986948478bc5445596acba2

data/.travis.yml

@@ -1,8 +1,9 @@
 language: ruby
 rvm:
-  - 1.9.3
   - 2.0.0
-  - 2.1.0
-  - 2.2.0
+  - 2.1.6
+  - 2.2.2
   - ruby-head
   - jruby-head
+before_install:
+  - gem install bundler

data/README.rdoc

@@ -0,0 +1,100 @@
+= Decoratable
+
+Provides an easy way to define decorations that add common behaviour to your methods.
+
+== Installation
+
+    gem install decoratable
+
+== Requirements
+
+Decoratable does its magic via Module#prepend, which means:
+
+* MRI (1.9.3 and up) OR
+* JRuby 9000
+
+== Usage
+
+    require "decoratable"
+
+    module Retryable
+      # All methods defined in this module can decorate methods
+      extend Decoratable
+
+      def retryable(tries = 1, options = { on: [RuntimeError] })
+        attempt = 0
+        # To invoke the original method, simply use `yield`
+        yield
+      rescue *options[:on]
+        attempt += 1
+        attempt > tries ? raise : retry
+      end
+    end
+
+    module Pryable
+      extend Decoratable
+
+      def pryable
+        yield
+      rescue => e
+        require "pry"
+        binding.pry
+      end
+    end
+
+    module Measurable
+      extend Decoratable
+
+      def measurable(logger = Logger.new(STDOUT))
+        start = Time.now
+        yield
+      ensure
+        # The decoration has access to the original method
+        # args and any block passed in the original method call are also available
+        # via __args__ and __block__ respectively
+        original_method = __decorated_method__
+
+        method_location, line = original_method.source_location
+        marker = "#{original_method.owner}##{original_method.name}[#{method_location}:#{line}]"
+        duration = (Time.now - start).round(2)
+
+        logger.info "#{marker} took #{duration}s to run."
+      end
+    end
+
+    class Client
+      extend Measurable
+      extend Pryable
+      extend Retryable
+
+      # This method will automatically retry on TimeoutErrors, up to 3 times
+      retryable(tries = 3, on: [TimeoutError])
+      def get
+        …
+      end
+
+      # If an error is raised in this method, we'll automatically get a pry session
+      # to help us debug it
+      pryable
+      def post
+        …
+      end
+
+      # Log the time this method takes to run
+      measurable
+      def delete
+        …
+      end
+    end
+
+Decoratable provides a handful of decorations as part of the gem:
+
+  * require "decoratable/countable": keep a count each time a method gets called
+  * require "decoratable/debuggable": open a Ruby debug console (i.e. require "debug") if an error is raised
+  * require "decoratable/deprecatable": log a warning whenever a deprecated method gets called; logs the caller's location
+  * require "decoratable/hintable": add type hinting to your method arguments
+  * require "decoratable/memoizable": automatically memoize the return value of a method
+  * require "decoratable/pryable": open a Pry debug console (i.e. binding.pry) if an error is raised
+  * require "decoratable/retryable": automatically retry a number of times when a specified exception is raised
+
+More to be added as time goes on.

data/decoratable.gemspec

@@ -3,7 +3,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "decoratable"
-  spec.version       = "0.0.1"
+  spec.version       = "0.0.2"
   spec.authors       = ["ecin"]
   spec.email         = ["ecin@copypastel.com"]
   spec.description   = "Decorate your methods."
@@ -16,5 +16,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_development_dependency "minitest"
   spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake", ">= 10.0.0"
 end

data/lib/decoratable/deprecatable.rb

@@ -0,0 +1,12 @@
+require "decoratable"
+
+require "logger"
+
+module Deprecatable
+  extend Decoratable
+
+  def deprecatable(logger = Logger.new(STDOUT))
+    logger.warn("#{__decorated_method__.name} is deprecated. Called from: #{__original_caller__[0]}")
+    yield
+  end
+end

data/lib/decoratable.rb

@@ -91,6 +91,10 @@ module Decoratable
           alias_method "method_added_without_#{decoration_name}", :method_added
         end
 
+        unless method_defined?(:__original_caller__)
+          define_method(:__original_caller__) { @__original_caller__ }
+        end
+
         unless method_defined?(:__decorated_method__)
           define_method(:__decorated_method__) { @__decorated_method__ }
         end
@@ -126,6 +130,7 @@ module Decoratable
                 @__decorated_method__ = original_method
                 @__args__ = args
                 @__block__ = block
+                @__original_caller__ ||= caller
 
                 decoration_method.bind(self).call(*decorator_args) do
                   super(*args, &block)
@@ -134,6 +139,7 @@ module Decoratable
                 @__decorated_method__ = nil
                 @__args__ = nil
                 @__block__ = nil
+                @__original_caller__ = nil
               end
             end
           end

data/test/decoratable/deprecatable_test.rb

@@ -0,0 +1,40 @@
+require "test_helper"
+
+require "decoratable/deprecatable"
+require "decoratable/retryable"
+require "decoratable/memoizable"
+
+describe Deprecatable do
+  extend Memoizable
+
+  before do
+    # Need to assign to a local variable so it's accessible from
+    # the following class definition scope.
+    logger = mock_logger
+
+    klass = Class.new do
+      extend Deprecatable
+      extend Retryable
+
+      deprecatable(logger)
+      def old_method; end
+    end
+
+    @object = klass.new
+  end
+
+  it "prints a warning when a method is called" do
+    # If the `@object.old_method` line moves around, we'll have to modify the line arithmetic for the
+    # expected regex.
+    mock_logger.expect(:warn, nil, [/old_method is deprecated\. Called from: #{__FILE__}:#{__LINE__ + 2}/])
+
+    @object.old_method
+    mock_logger.verify
+  end
+
+  # Reusing library code in a test? Amazing!
+  memoizable
+  def mock_logger
+    Minitest::Mock.new
+  end
+end

data/test/decoratable_test.rb

@@ -142,9 +142,7 @@ describe Decoratable do
 
   def mock_logger
     logger = Minitest::Mock.new
-    logger.expect(:info, nil) do |message|
-      message =~ /took \d+\.\d+s to run/
-    end
+    logger.expect(:info, nil, [/took \d+\.\d+s to run/])
     logger
   end
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: decoratable
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - ecin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-04 00:00:00.000000000 Z
+date: 2016-11-26 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -24,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.0.0
 description: Decorate your methods.
 email:
 - ecin@copypastel.com
@@ -33,16 +61,19 @@ extra_rdoc_files: []
 files:
 - ".travis.yml"
 - Gemfile
+- README.rdoc
 - Rakefile
 - decoratable.gemspec
 - lib/decoratable.rb
 - lib/decoratable/countable.rb
 - lib/decoratable/debuggable.rb
+- lib/decoratable/deprecatable.rb
 - lib/decoratable/hintable.rb
 - lib/decoratable/memoizable.rb
 - lib/decoratable/pryable.rb
 - lib/decoratable/retryable.rb
 - test/decoratable/countable_test.rb
+- test/decoratable/deprecatable_test.rb
 - test/decoratable/hintable_test.rb
 - test/decoratable/memoizable_test.rb
 - test/decoratable/pryable_test.rb
@@ -69,16 +100,16 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Easily define decorations for your methods. Put a bow on it.
 test_files:
 - test/decoratable/countable_test.rb
+- test/decoratable/deprecatable_test.rb
 - test/decoratable/hintable_test.rb
 - test/decoratable/memoizable_test.rb
 - test/decoratable/pryable_test.rb
 - test/decoratable/retryable_test.rb
 - test/decoratable_test.rb
 - test/test_helper.rb
-has_rdoc: