decorations 0.1.4 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 31bf145c0d39101e6c4aaf1c1ef9bc4d44286e72fbbac2c2cf15bac1e94764d6
-  data.tar.gz: 29c49a2c78b92a09d15b8aee25e2730d54ff2d79e9f688819d546d00b097c269
+  metadata.gz: e4ee3f37027bf274381c6141e50c22890fffb443c765339da9810715528403a1
+  data.tar.gz: 0453c34181729f003cbe2434597a4554e97345b7e747ca5eb69fb17dda3a7bbe
 SHA512:
-  metadata.gz: 2c242c574f807b2d6a2d27448e38c86895892b5e785c2da95238865b717482274f7d3aa285690bed21cff93398ffb87d852183fdd460e62b2b805ff2e699d18c
-  data.tar.gz: c22dbe2455e391069b6ad9c765b6159e061ad046e0be6fd4173626aaec986bdc1c352d6eb0df474c1520b0a80c9114e61414f14d5218290170364f759b0ade14
+  metadata.gz: 3ed165419148484137d8651336a6d2811509a61418ba33b2673246dda6aa244fc18ff5c4b40142a430e12e2f21ef8c678651bb0740f10d1de8bc6ab8a086abb6
+  data.tar.gz: 45b0edd2d3f819c28d80df2edad449396eac6ebbc878d071a574d3161fac889a5aafdc84639c0a338315101ad63c5bd979dce7711ffc350c2a4fe4ee61206222

data/Gemfile.lock

@@ -1,35 +1,17 @@
 PATH
   remote: .
   specs:
-    decorations (0.1.4)
+    decorations (1.0.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.0)
     coderay (1.1.2)
-    coveralls (0.7.1)
-      multi_json (~> 1.3)
-      rest-client
-      simplecov (>= 0.7)
-      term-ansicolor
-      thor
     diff-lcs (1.3)
-    docile (1.3.2)
-    domain_name (0.5.20190701)
-      unf (>= 0.0.5, < 1.0.0)
     gem-release (2.1.1)
-    http-accept (1.7.0)
-    http-cookie (1.0.3)
-      domain_name (~> 0.5)
     jaro_winkler (1.5.4)
-    json (2.2.0)
     method_source (0.9.2)
-    mime-types (3.3)
-      mime-types-data (~> 3.2015)
-    mime-types-data (3.2019.1009)
-    multi_json (1.14.1)
-    netrc (0.11.0)
     parallel (1.18.0)
     parser (2.6.5.0)
       ast (~> 2.4.0)
@@ -41,11 +23,6 @@ GEM
       yard (~> 0.9.11)
     rainbow (3.0.0)
     rake (10.5.0)
-    rest-client (2.1.0)
-      http-accept (>= 1.7.0, < 2.0)
-      http-cookie (>= 1.0.2, < 2.0)
-      mime-types (>= 1.16, < 4.0)
-      netrc (~> 0.8)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
@@ -67,18 +44,6 @@ GEM
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 1.7)
     ruby-progressbar (1.10.1)
-    simplecov (0.17.1)
-      docile (~> 1.1)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
-    term-ansicolor (1.7.1)
-      tins (~> 1.0)
-    thor (0.20.3)
-    tins (1.22.0)
-    unf (0.1.4)
-      unf_ext
-    unf_ext (0.0.7.6)
     unicode-display_width (1.6.0)
     yard (0.9.20)
     yardstick (0.9.9)
@@ -89,16 +54,13 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 1.16)
-  coveralls
   decorations!
   gem-release
   pry
   pry-doc
   rake (~> 10.0)
-  rest-client (>= 1.8.0)
   rspec (~> 3.0)
   rubocop
-  simplecov
   yard
   yardstick
 

data/README.md

@@ -2,7 +2,6 @@
 
 [![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)
-[![Coverage Status](https://coveralls.io/repos/github/watmin/Ruby-decorations/badge.svg?branch=master)](https://coveralls.io/github/watmin/Ruby-decorations?branch=master)
 
 Python like decorators for Ruby. Inspired by Rack and previous attempts at decorations
 
@@ -24,22 +23,22 @@ Or install it yourself as:
 
 ## Usage
 
-Create a class that will have decorated methods and create decator classes to before actions.
-
-The decorator class must:
-* implement #call
-* must invoke call\_next(this, chain, \*args)
-* must return the result of call\_next.
+Create a class that will have decorated methods and create decator classes to be executed around the decorated method.
 
 ```ruby
 require 'decorations'
 
 class LoggingDecorator < Decorator
-  def call(this, chain, *args)
-    puts "[#{Time.now}] #{decorated_class}.#{decorated_method.name} was called"
-    result = call_next(this, chain, *args)
-    puts "[#{Time.now}] #{decorated_class}.#{decorated_method.name} has finished"
-    result
+  before
+  def print_started
+    @start_time = Time.now
+    puts "[#{@start_time}] #{decorated_class}.#{decorated_method.name} was called"
+  end
+
+  after
+  def print_finished
+    end_time = Time.now
+    puts "[#{end_time}] #{decorated_class}.#{decorated_method.name} has finished. Took #{end_time - @start_time} seconds"
   end
 end
 
@@ -47,16 +46,72 @@ class Application
   extend Decorations
 
   decorate LoggingDecorator
-  def perform_task
-    2 + 2
+  def perform_task(a, b: 2)
+    a + b
+  end
+
+  decorate LoggingDecorator
+  def perform_task_with_a_block
+    yield
   end
 end
 
 app = Application.new
-app.perform_task
-# => [2019-10-31 02:00:31 -0700] Application.perform_task was called
-# => [2019-10-31 02:00:31 -0700] Application.perform_task has finished
+app.perform_task(2, b: 2)
+# [2019-11-01 19:50:59 -0700] Application.perform_task was called
+# [2019-11-01 19:50:59 -0700] Application.perform_task has finished. Took 3.51e-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
+# [2019-11-01 19:55:37 -0700] Application.perform_task_with_a_block has finished. Took 5.32e-05 seconds
+# => nil
+```
+
+You can also pass in parameters to decorator methods:
+
+```
+class AnotherDecorator < Decorator
+  def initialize(some, params)
+    @some = some
+    @params = params
+  end
+
+  before
+  def puts_some
+    puts @some
+  end
+
+  after
+  def puts_params
+    puts @params
+  end
+end
+
+class AnotherDemo
+  extends Decorations
+
+  decorate AnotherDecorator, 'value 1', 'value 2'
+  def another_method
+    puts 'running puts in yet another method'
+  end
+end
+
+demo = AnotherDemo.new
+demo.another_method
+# value 1
+# running puts in yet another method
+# value 2
+# => nil
+
+```
+
+When testing decorated methods, execute `Decorations.disable` before requiring your source files. In your spec\_helper.rb add the following lines before your library is loaded:
+
+```ruby
+require 'decorations'
+Decorations.disable
 ```
 
 ## Development

data/bin/console

@@ -7,9 +7,19 @@ require 'decorations'
 # with your gem easier. You can also use a different console, if you like.
 
 class DecoratorDemo < Decorator
-  def call(this, chain, *args)
+  before
+  def print_message
     puts "'#{decorated_class}' has '#{decorated_method.name}' decorated"
-    call_next(this, chain, *args)
+  end
+
+  after
+  def do_math
+    puts 2 + 2
+  end
+
+  after
+  def something_else
+    puts 'something else'
   end
 end
 
@@ -20,6 +30,17 @@ class Demo
   def demo_method
     puts 'am I decorated?'
   end
+
+  decorate DecoratorDemo
+  def demo_block
+    yield
+  end
+
+  decorate DecoratorDemo
+  def demo_kwargs(first: 1, second: nil)
+    puts "first is #{first}"
+    puts "second is #{second}"
+  end
 end
 
 require 'pry'

data/decorations.gemspec

@@ -30,15 +30,12 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'bundler', '~> 1.16'
-  spec.add_development_dependency 'coveralls'
   spec.add_development_dependency 'gem-release'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'pry-doc'
   spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rest-client', '>= 1.8.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rubocop'
-  spec.add_development_dependency 'simplecov'
   spec.add_development_dependency 'yard'
   spec.add_development_dependency 'yardstick'
 end

data/lib/decorations.rb

@@ -20,6 +20,19 @@ module Decorations
     end
   end
 
+  ##
+  # Disables injecting decorations. Necessary for testing decorated methods
+  #
+  # @return [Void]
+  #
+  # @example
+  #   Decorations.disable
+  #
+  # @api public
+  def self.disable
+    @disabled = true
+  end
+
   ##
   # Decorates a method execute's the klass' #call method around the decorated method
   #
@@ -67,7 +80,10 @@ module Decorations
   # @api private
   def append_decorations(name, decorators, decorated_methods)
     decorators.each do |klass, args|
-      decorated_methods[name] << klass.new(self, instance_method(name), *args)
+      decoration = klass.new(*args)
+      decoration.__send__(:decorated_class=, self)
+      decoration.__send__(:decorated_method=, instance_method(name))
+      decorated_methods[name] << decoration
     end
   end
 
@@ -80,6 +96,7 @@ module Decorations
   #
   # @api private
   def method_added(name)
+    return if @disabled
     return unless @decorators
 
     @decorated_methods ||= Hash.new { |h, k| h[k] = [] }
@@ -87,9 +104,9 @@ module Decorations
     @decorators = nil
 
     class_eval <<-RUBY_EVAL, __FILE__, __LINE__ + 1
-      def #{name}(*args, &blk)
+      def #{name}(*args, &block)
         chain = self.class.decorated_methods[#{name.inspect}].dup
-        Decorator.new(self, :method_added).call_next(self, chain, *args, &blk)
+        Decorator.new.__send__(:call, self, chain, *args, &block)
       end
     RUBY_EVAL
   end

data/lib/decorations/version.rb

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

data/lib/decorator.rb

@@ -1,71 +1,56 @@
 # frozen_string_literal: true
 
+require 'decorator_dsl'
+
 ##
 # Base decorator class
 class Decorator
+  extend DecoratorDsl
+
+  private
+
   ##
-  # @!attribute [r] decorated_class
+  # @!attribute [a] decorated_class
   # The class being decorated
   #
   # @return [Class]
   #
-  # @example
-  #   decorator.decoated_class #=> Class
-  #
-  # @api public
-  attr_reader :decorated_class
+  # @api private
+  attr_accessor :decorated_class
 
   ##
-  # @!attribute [r] decorated_class
+  # @!attribute [a] decorated_class
   # The method being decorated
   #
   # @return [Symbol]
   #
-  # @example
-  #   decorator.decorated_method #=> Symbol
-  #
-  # @api public
-  attr_reader :decorated_method
-
-  ##
-  # Decorator constructor interface
-  #
-  # @param decorated_class [Class] The class that is being decorated
-  # @param decorated_method [Symbol] The method that is being decorated
-  #
-  # @return [Decorator]
-  #
   # @api private
-  def initialize(decorated_class, decorated_method)
-    @decorated_class = decorated_class
-    @decorated_method = decorated_method
-  end
+  attr_accessor :decorated_method
 
   ##
   # The hook to call chained decorations
   #
   # @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 args [Array<Object>] the arguments to pass to the wrapper method
+  # @param block [Proc] the block to pass to the wrapped method
   #
   # @return [Object] the return value of the next_caller
   #
-  # @example
-  #   class DecoratorDemo < Decorator
-  #     def call(this, chain, *args)
-  #       puts "'#{decorated_class}' has '#{decorated_method.name}' decorated"
-  #       call_next(this, chain, *args)
-  #     end
-  #   end
-  #
-  # @api public
-  def call_next(this, chain, *args)
+  # @api private
+  def call(this, chain, *args, &block)
     next_caller = chain.shift
 
-    if next_caller.nil?
-      decorated_method.bind(this).call(*args)
-    else
-      next_caller.call(this, chain, *args)
-    end
+    self.class.__send__(:before_method)&.each { |method_name| __send__(method_name) }
+
+    ret = if next_caller.nil?
+            decorated_method.bind(this).call(*args, &block)
+          else
+            next_caller.__send__(:call, this, chain, *args, &block)
+          end
+
+    self.class.__send__(:after_method)&.each { |method_name| __send__(method_name) }
+
+    ret
   end
 end

data/lib/decorator_dsl.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+require 'set'
+
+##
+# DSL for Decorator to define before and after hooks for a wrapped method
+module DecoratorDsl
+  ##
+  # Injects the DSL attributes in the class received
+  #
+  # @param receiver [Class] the class extending DecoratorDsl
+  #
+  # @return [Void]
+  #
+  # @api private
+  def self.extended(receiver)
+    class << receiver
+      private
+
+      attr_accessor :before_method, :before_set, :after_method, :after_set
+    end
+  end
+
+  ##
+  # Adds the next method to be hook into executing before decorated method
+  #
+  # @return [Void]
+  #
+  # @example
+  #   class DecoratorDemo < Decorator
+  #     before :print_message
+  #     def print_message(this, chain, *args)
+  #       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
+  #   # => 'Demo' has 'demo_method' decorated
+  #   # => am I decorated?
+  #
+  # @api public
+  def before
+    @before_method ||= Set.new
+    @before_set = true
+  end
+
+  ##
+  # Adds the next method to be hook into executing after decorated method
+  #
+  # @return [Void]
+  #
+  # @example
+  #   class DecoratorDemo < Decorator
+  #     after
+  #     def print_message(this, chain, *args)
+  #       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 after
+    @after_method ||= Set.new
+    @after_set = true
+  end
+
+  private
+
+  ##
+  # Hooks the methods defined for a class
+  #
+  # @param name [Symbol] the name of the method being defined
+  #
+  # @return [Void]
+  #
+  # @api private
+  def method_added(name)
+    if before_set
+      @before_set = false
+      @before_method << name
+    end
+
+    return unless after_set
+
+    @after_set = false
+    @after_method << name
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: decorations
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 1.0.0
 platform: ruby
 authors:
 - John Shields
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-31 00:00:00.000000000 Z
+date: 2019-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -24,20 +24,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.16'
-- !ruby/object:Gem::Dependency
-  name: coveralls
-  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: gem-release
   requirement: !ruby/object:Gem::Requirement
@@ -94,20 +80,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: rest-client
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.8.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.8.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -136,20 +108,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  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: yard
   requirement: !ruby/object:Gem::Requirement
@@ -202,6 +160,7 @@ files:
 - lib/decorations.rb
 - lib/decorations/version.rb
 - lib/decorator.rb
+- lib/decorator_dsl.rb
 homepage: https://github.com/watmin/Ruby-decorations
 licenses:
 - MIT