decorations 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d114bfb9a30d1f5a382ea785ed9989beb4b02cdeb9961596cdaee14c1a9d74e
-  data.tar.gz: fbe4643ebba0cf10637fd5784d1c891494eec3b1657768f8e51b311ca4f9727e
+  metadata.gz: 19f65ba587fed4254a671f731a5ff34c0b477d16d72816fb70b75990b1677476
+  data.tar.gz: 13180ddcd9a0bfbcd88a31eeb86c085c912fd84d8a834724332c7afd34922357
 SHA512:
-  metadata.gz: 736e20f6624e3043951d689a78d69acf531928e9ae77544eab1e763975be528d44c9ceea6319339d8f542bd2ce649b8722785d8a27b9a948356b9871ff8075b1
-  data.tar.gz: 8fb9c4dc70da6d5faf762ec3ec9e99cb91a07d8beb58f45c8c803eaafbacd18c9d6011ba850b0b97497960804c0d3fc716e736a9dc89d3cfa7eb17c3cc8ae69f
+  metadata.gz: 4dea09bed3cd7f8a2409b11a5d8fa8cc34a23fd5b205aabc4a275e51d2f37b6759aa789980742e96c7dc9bbed438b7c944bf5178be2ebee409453c9f947d326e
+  data.tar.gz: 073f81ea30c740401218cd8d02c4e0e483170c82587de4e295b9ecb644ae32ef1a5117cd80cbdab9ce395e2509d5479656b42f11d57de01a85a0bc4e612979bd

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    decorations (1.0.1)
+    decorations (1.1.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -3,7 +3,7 @@
 [![Gem Version](https://badge.fury.io/rb/decorations.svg)](https://badge.fury.io/rb/decorations)
 [![Build Status](https://travis-ci.org/watmin/Ruby-decorations.svg?branch=master)](https://travis-ci.org/watmin/Ruby-decorations)
 
-Python like decorators for Ruby. Inspired by Rack and previous attempts at decorations
+Python like decorators for Ruby. Inspired by Rack, Rails and previous attempts at decorations. Only uses Ruby's standard library.
 
 ## Installation
 
@@ -44,6 +44,21 @@ class LoggingDecorator < Decorator
   end
 end
 
+class LoggingAroundDecorator < Decorator
+  around
+  def print_start_finish
+    @start_time = Time.now
+    puts "[#{@start_time}] #{decorated_class}.#{decorated_method.name} was called"
+
+    ret = yield
+
+    end_time = Time.now
+    puts "[#{end_time}] #{decorated_class}.#{decorated_method.name} has finished. Took #{end_time - @start_time} seconds"
+
+    ret
+  end
+end
+
 class Application
   extend Decorations
 
@@ -52,6 +67,11 @@ class Application
     a + b
   end
 
+  decorate LoggingAroundDecorator
+  def perform_task(a, b: 2)
+    a + b
+  end
+
   decorate LoggingDecorator
   def perform_task_with_a_block
     yield
@@ -64,6 +84,11 @@ app.perform_task(2, b: 2)
 # [2019-11-01 19:50:59 -0700] Application.perform_task has finished. Took 3.51e-05 seconds
 # => 4
 
+app.perform_another_task(2, b: 2)
+# [2019-11-02 15:32:19 -0700] Application.perform_another_task was called
+# [2019-11-02 15:32:19 -0700] Application.perform_another_task has finished. Took 3.04e-05 seconds
+# => 4
+
 app.perform_task_with_a_block { puts 'in a block' }
 # [2019-11-01 19:55:37 -0700] Application.perform_task_with_a_block was called
 # in a block

data/bin/console

@@ -2,6 +2,7 @@
 
 require 'bundler/setup'
 require 'decorations'
+require 'decorators/all'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -43,5 +44,27 @@ class Demo
   end
 end
 
+
+class HasIssues
+  extend Decorations
+
+  def initialize(starting_value)
+    @starting_value = starting_value
+  end
+
+  decorate RetryDecorator, tries: 3, backoff: true
+  def do_thing
+    loop do
+      @starting_value += 1
+      break if @starting_value % 3 == 0
+
+      raise StandardError, 'something is wrong'
+    end
+
+    puts 'it works'
+    9
+  end
+end
+
 require 'pry'
 Pry.start

data/lib/decorations.rb

@@ -48,29 +48,28 @@ module Decorations
   #   # => am I decorated?
   #
   # @api public
-  def decorate(klass, *args)
+  def decorate(klass, *args, &block)
     @decorators ||= []
-    @decorators << [klass, args]
+    @decorators << { klass: klass, args: args, block: block }
   end
 
   private
 
   ##
-  # Appends the decorators to the decorated_methods hash
+  # Builds an array of decorators for the method
   #
   # @param name [Symbol] the method name being decorated
-  # @param decorators [Array<Decorator>] the decorators defined
-  # @param decorated_methods [Hash] the decorated methods for the class
   #
-  # @return [Void]
+  # @return [Array<Decorator>]
   #
   # @api private
-  def append_decorations(name, decorators, decorated_methods)
-    decorators.each do |klass, args|
-      decoration = klass.new(*args)
-      decoration.__send__(:decorated_class=, self)
-      decoration.__send__(:decorated_method=, instance_method(name))
-      decorated_methods[name] << decoration
+  def build_decorators(name)
+    decorated_methods[name].map do |decoration|
+      decorator = decoration[:klass].new(*decoration[:args], &decoration[:block])
+      decorator.__send__(:decorated_class=, decoration[:decorated_class])
+      decorator.__send__(:decorated_method=, decoration[:decorated_method])
+
+      decorator
     end
   end
 
@@ -83,16 +82,20 @@ module Decorations
   #
   # @api private
   def method_added(name)
-    return if @disabled
     return unless @decorators
 
     @decorated_methods ||= Hash.new { |h, k| h[k] = [] }
-    append_decorations(name, @decorators, @decorated_methods)
+    @decorated_methods[name] = @decorators.map do |decorator|
+      decorator.merge(
+        decorated_class: self,
+        decorated_method: instance_method(name)
+      )
+    end
     @decorators = nil
 
     class_eval <<-RUBY_EVAL, __FILE__, __LINE__ + 1
       def #{name}(*args, &block)
-        chain = self.class.decorated_methods[#{name.inspect}].dup
+        chain = self.class.__send__(:build_decorators, #{name.inspect})
         Decorator.new.__send__(:call, self, chain, *args, &block)
       end
     RUBY_EVAL

data/lib/decorations/version.rb

@@ -3,5 +3,5 @@
 module Decorations
   ##
   # The version of the Ruby-decorations gem
-  VERSION = '1.0.1'
+  VERSION = '1.1.0'
 end

data/lib/decorator.rb

@@ -39,18 +39,71 @@ class Decorator
   #
   # @api private
   def call(this, chain, *args, &block)
+    execute_before_methods
+    ret = execute_around_methods(build_next_caller(this, chain, *args, &block))
+    execute_after_methods
+
+    ret
+  end
+
+  ##
+  # Produces a proc that invokes the next caller
+  #
+  # @param this [Instance] the instance of the object with the wrapper method
+  # @param chain [Array<Decorator>] the remaining decorators to be called
+  # @param args [Array<Object>] the arguments to pass to the wrapper method
+  # @param block [Proc] the block to pass to the wrapped method
+  #
+  # @return [Proc]
+  #
+  # @api private
+  def build_next_caller(this, chain, *args, &block)
     next_caller = chain.shift
 
-    self.class.__send__(:before_method)&.each { |method_name| __send__(method_name) }
+    if next_caller.nil?
+      proc { decorated_method.bind(this).call(*args, &block) }
+    else
+      proc { next_caller.__send__(:call, this, chain, *args, &block) }
+    end
+  end
 
-    ret = if next_caller.nil?
-            decorated_method.bind(this).call(*args, &block)
-          else
-            next_caller.__send__(:call, this, chain, *args, &block)
-          end
+  ##
+  # Executes the before methods
+  #
+  # @return [Void]
+  #
+  # @api private
+  def execute_before_methods
+    self.class.__send__(:before_method)&.each { |method_name| __send__(method_name) }
+  end
 
-    self.class.__send__(:after_method)&.each { |method_name| __send__(method_name) }
+  ##
+  # Executes the around methods
+  #
+  # @param next_caller [Proc] the proc to execute the next caller
+  #
+  # @return [Object] the result of the next_caller
+  #
+  # @api private
+  def execute_around_methods(next_caller)
+    arounds = self.class.__send__(:around_method)
+    if arounds.is_a?(Set)
+      ret = nil
+      arounds.each { |method_name| ret = __send__(method_name) { next_caller.call } }
+    else
+      ret = next_caller.call
+    end
 
     ret
   end
+
+  ##
+  # Executes the after methods
+  #
+  # @return [Void]
+  #
+  # @api private
+  def execute_after_methods
+    self.class.__send__(:after_method)&.each { |method_name| __send__(method_name) }
+  end
 end

data/lib/decorator_dsl.rb

@@ -17,7 +17,9 @@ module DecoratorDsl
     class << receiver
       private
 
-      attr_accessor :before_method, :before_set, :after_method, :after_set
+      attr_accessor :before_method, :before_set,
+                    :after_method, :after_set,
+                    :around_method, :around_set
     end
   end
 
@@ -29,7 +31,7 @@ module DecoratorDsl
   # @example
   #   class DecoratorDemo < Decorator
   #     before :print_message
-  #     def print_message(this, chain, *args)
+  #     def print_message
   #       puts "'#{decorated_class}' has '#{decorated_method.name}' decorated"
   #     end
   #   end
@@ -62,7 +64,7 @@ module DecoratorDsl
   # @example
   #   class DecoratorDemo < Decorator
   #     after
-  #     def print_message(this, chain, *args)
+  #     def print_message
   #       puts "'#{decorated_class}' has '#{decorated_method.name}' decorated"
   #     end
   #   end
@@ -87,6 +89,41 @@ module DecoratorDsl
     @after_set = true
   end
 
+  ##
+  # Adds the next method to be hook into executing around decorated method
+  #
+  # @return [Void]
+  #
+  # @example
+  #   class DecoratorDemo < Decorator
+  #     around
+  #     def print_message
+  #       puts "'#{decorated_class}' has '#{decorated_method.name}' decorated"
+  #       yield
+  #       puts "'#{decorated_class}' has '#{decorated_method.name}' decorated"
+  #     end
+  #   end
+  #
+  #   class Demo
+  #     extend Decorations
+  #
+  #     decorate DecoratorDemo
+  #     def demo_method
+  #       puts 'am I decorated?'
+  #     end
+  #   end
+  #
+  #   demo = Demo.new
+  #   demo.demo_method
+  #   # => am I decorated?
+  #   # => 'Demo' has 'demo_method' decorated
+  #
+  # @api public
+  def around
+    @around_method ||= Set.new
+    @around_set = true
+  end
+
   private
 
   ##
@@ -97,15 +134,20 @@ module DecoratorDsl
   # @return [Void]
   #
   # @api private
-  def method_added(name)
+  def method_added(name) # rubocop:disable Metrics/MethodLength
     if before_set
       @before_set = false
       @before_method << name
     end
 
-    return unless after_set
+    if after_set
+      @after_set = false
+      @after_method << name
+    end
+
+    return unless around_set
 
-    @after_set = false
-    @after_method << name
+    @around_set = false
+    @around_method << name
   end
 end

data/lib/decorators/all.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'retry_decorator'

data/lib/retry_decorator.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'decorator'
+
+##
+# Simple retry decorator
+class RetryDecorator < Decorator
+  ##
+  # Builds a new RetryDecorator
+  #
+  # @param tries [Integer] Number of retries to make
+  # @param from [Class] Exception class to recsue from
+  # @param backoff [Boolean] Whether or not sleep between retries
+  # @param sleep_duration [Integer] starting sleep value to increment
+  #
+  # @api private
+  def initialize(tries:, from: StandardError, backoff: false, sleep_duration: -1)
+    @tries = tries
+    @from = from
+    @backoff = backoff
+    @sleep_duration = sleep_duration
+  end
+
+  private
+
+  around
+  ##
+  # Peforms the retries around the decorated method
+  #
+  # @return [Void]
+  #
+  # @api private
+  def do_retries
+    yield
+  rescue @from => e
+    raise e unless (@tries -= 1).positive?
+
+    sleep (@sleep_duration += 1)**2 if @backoff # rubocop:disable Lint/ParenthesesAsGroupedExpression
+    retry
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: decorations
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - John Shields
@@ -160,6 +160,8 @@ files:
 - lib/decorations/version.rb
 - lib/decorator.rb
 - lib/decorator_dsl.rb
+- lib/decorators/all.rb
+- lib/retry_decorator.rb
 homepage: https://github.com/watmin/Ruby-decorations
 licenses:
 - MIT