easy_decorator 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a51c2c2a637daadfba8be3453ec7af886c5f484c2ec62a065bcc423f6f4d21c
-  data.tar.gz: e747a3b3b141dc49e69da1a7efba88e4752e1c06540037cbda78ebb830199f35
+  metadata.gz: 9712b4b6313e508e2cff7302f664f5d96fa0bc9e073b82ba6bfb3ec026831e61
+  data.tar.gz: 9afdeb38a1b34ab102a571f9514ec8167718aadfddd68f8ffd0993c388227c30
 SHA512:
-  metadata.gz: 0c1b39ac4a156d3ad49d04cbcf494394bcd3f7dbd881c98bc445c30bd3eaccc478c264b2e399ec76eab33bd187d786a437a96c7d9b73cffe8921bcc20795e0f1
-  data.tar.gz: 90904664433a98ff9a275ad5bc1c9beb8ea58cdab973dd3e6da0f80a5b08bf30bb8624752f17e1154ef7f37540941656cff78be4d15ab7fe43d58daab6e89082
+  metadata.gz: 3fd37f90cdda492cd0e17c84d33f6c5c47748ace2e4afbc952129efc37909c82001e34f7e0e47d2a015a19d370626ef361bdd8526c406cd3f46cae5e7e8cb267
+  data.tar.gz: b0e246be3a9ea5ed7fc80d547aa30aa9ff28a55fdb3d1e11212c6bb5d85f9bd0cfd7e73277e94e0cf11e919cba79e05a78fe03875331d21a6e30338c8e362d62

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -1,2 +1,114 @@
-# easy_decorator
-Python-like decorator pattern implemented in Ruby.
+# EasyDecorator
+
+EasyDecorator is a module that bring's in a Python-like method decorator pattern into Ruby.
+
+# Table of Contents
+
+* [Installation](#installation)
+* [Usage](#usage)
+  * [Include Module](#include-module)
+  * [Define Decorator](#define-decorator)
+  * [Decorating Methods](#decorating-methods)
+  * [Example](#example)
+* [Contributing](#contributing)
+
+# Installation
+### command line
+`$ gem install easy_decorator`
+
+### Gemfile
+```ruby
+# ./Gemfile
+
+source 'https://rubygems.org`
+# ...
+gem 'easy_decorator', '~> 0.2.0'
+```
+# Usage
+### Include Module
+```ruby
+# ./my_class.rb
+class MyClass
+  include EasyDecorator
+end
+```
+### Define Decorator
+A decorator should be defined as a method with an inner wrapper. Within the wrapper you can call the passed method via `func.call(*args)`.
+
+```ruby
+def my_decorator(func, *args)
+  wrapper do 
+    # code here
+    func.call(*args)
+    # code here
+  end
+end
+```
+\* `wrapper` is essentially syntactic sugar for a proc.
+
+### Decorating Methods
+```ruby
+decorate(:my_method, :my_decorator)
+def my_method(a, b)
+  # code here
+end
+```
+You can apply multiple decorators to a method, which will applies from last to first declared.
+
+```ruby
+decorate(:my_method, :outer_decorator)
+decorate(:my_method, :inner_decorator)
+def my_method(*args)
+  # ...
+end
+
+# is essentially the same as:
+outer_decorator(inner_decorator(public_method(:my_method))).call(*args)
+```
+
+### Example
+```ruby
+# ./calculator.rb
+
+class Calculator
+  # include module
+  include EasyDecorator
+
+  # define decorator
+  def calculate_time(func, *args)
+    wrap do
+      logger.info("Timing #{method_name}...")
+      start_time = Time.now
+      # call inner method
+      result = func.call(*args)
+      end_time = Time.now
+      logger.info("Processing Time: #{end_time - start_time}")
+
+      result
+    end
+  end
+
+  # decorate method
+  decorate(:add_numbers, :calculate_time)
+  def add_numbers(a, b)
+    return a + b
+  end
+end
+```
+Result:
+```
+$ Calculator.new.add_numbers(1,2)
+Timing add_numbers...
+Processing Time: 0.0001572930
+=> 3
+```
+
+# Contributing
+1. Fork the repo
+2. Create a your feature branch (`git checkout -b my-feature-branch`)
+3. Update CHANGELOG.md with a bulleted list of your changes under the `unreleased` heading.
+4. Include rspec tests for your changes
+5. Commit your changes to your branch (`git commit -am 'Added my feature'`)
+6. Push to your remote forked repo (`git push origin my-featuer-branch`)
+7. Create a new Pull Request
+Once I am able to review the pull request, I will either either approve and merge, or give feedback on it if I do not merge it. I will do my best to address Pull Requests as time allows.

data/lib/decorators/decorators.rb

@@ -0,0 +1,3 @@
+# Module for decorator helpers and utilities
+module Decorators
+end

data/lib/easy_decorator.rb

@@ -4,28 +4,35 @@ module EasyDecorator
   def self.included(base_klass)
     base_klass.extend(ClassMethods)
     base_klass.instance_variable_set(:@decorated_methods, {})
+    base_klass.define_method :wrapper do |&block|
+      block
+    end
   end
 
   module ClassMethods
-    def decorate(decorator, decorated)
-      @decorated_methods[decorated] = {
-        decorator: decorator,
-        is_decorated: false
-      }
+    def decorate(decorated, decorator)
+      @decorated_methods[decorated] ||= { method_chain: [], is_decorated: false }
+      @decorated_methods[decorated][:method_chain] << decorator
     end
 
     def method_added(method_name)
       decorator = @decorated_methods[method_name]
+
       if decorator && !decorator[:is_decorated]
         decorator[:is_decorated] = true
+
         source_method_name = "source_#{method_name}".to_sym
         alias_method source_method_name, method_name
+        decorator[:method_chain] << source_method_name
 
         define_method method_name do |*args|
-          send(decorator[:decorator], source_method_name, *args)
+          decorator[:method_chain].then { |*funcs, base_func|
+            funcs.reduce(public_method(base_func)) { |acc, func|
+              public_method(func).call(acc, *args)
+            }
+          }.call(*args)
         end
       end
     end
   end
 end
-

data/lib/easy_decorator/errors.rb

@@ -0,0 +1,3 @@
+module EasyDecorator
+  class Error < StandardError; end
+end

data/lib/easy_decorator/version.rb

@@ -0,0 +1,3 @@
+module EasyDecorator
+  VERSION = '0.2.0'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: easy_decorator
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Josh Crank
@@ -45,10 +45,14 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- Gemfile
 - LICENSE
 - README.md
 - easy_decorator.gemspec
+- lib/decorators/decorators.rb
 - lib/easy_decorator.rb
+- lib/easy_decorator/errors.rb
+- lib/easy_decorator/version.rb
 homepage: https://github.com/jtcrank/easy_decorator
 licenses:
 - MIT