easy_decorator 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9712b4b6313e508e2cff7302f664f5d96fa0bc9e073b82ba6bfb3ec026831e61
-  data.tar.gz: 9afdeb38a1b34ab102a571f9514ec8167718aadfddd68f8ffd0993c388227c30
+  metadata.gz: 982db95e1c4b8144dde9dfec4e93ce757f36dd4b9043a18a6dba47df7991b900
+  data.tar.gz: 4a40c620b429dc2475bae31593ea6cc4e923ad66e6e184224806f43c81c8f1c4
 SHA512:
-  metadata.gz: 3fd37f90cdda492cd0e17c84d33f6c5c47748ace2e4afbc952129efc37909c82001e34f7e0e47d2a015a19d370626ef361bdd8526c406cd3f46cae5e7e8cb267
-  data.tar.gz: b0e246be3a9ea5ed7fc80d547aa30aa9ff28a55fdb3d1e11212c6bb5d85f9bd0cfd7e73277e94e0cf11e919cba79e05a78fe03875331d21a6e30338c8e362d62
+  metadata.gz: 978d6ec8156a4ef3b2e5dcafb8fdbbc4cbe9b55cb3798f63be80584e80fc5af532f8d366be122396310ddc0695517f4eca35f613c9f403655b68d5c7521d1a43
+  data.tar.gz: fe31bf6a967dda3d2db6aa9b6981c4026c3bedb7f6a37bed1c61ef5adba510a2d360d4530e28d4d9418077f2116a69c7ae0a2baaf08b85417f22fdabf6f3ba0a

data/lib/easy_decorator.rb

@@ -3,36 +3,85 @@ require 'easy_decorator/errors'
 module EasyDecorator
   def self.included(base_klass)
     base_klass.extend(ClassMethods)
-    base_klass.instance_variable_set(:@decorated_methods, {})
+    base_klass.instance_variable_set(:@decorators, { method_buffer: [] })
     base_klass.define_method :wrapper do |&block|
       block
     end
   end
 
   module ClassMethods
-    def decorate(decorated, decorator)
-      @decorated_methods[decorated] ||= { method_chain: [], is_decorated: false }
-      @decorated_methods[decorated][:method_chain] << decorator
+    def decorate(decorator)
+      # get line number of decorator statement and add decorator method to the buffer
+      line_num = caller.first.split(':')[1]
+      @decorators[:method_buffer].prepend({ decorator: decorator, line: line_num })
+    end
+
+    def decorators
+      @decorators
     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|
-          decorator[:method_chain].then { |*funcs, base_func|
-            funcs.reduce(public_method(base_func)) { |acc, func|
-              public_method(func).call(acc, *args)
-            }
-          }.call(*args)
-        end
+      return if bypass_method_added(method_name)
+
+      # validate correct syntax
+      method_line = caller.first.split(':')[1]
+      validate_syntax(method_line)
+
+      source_method_name = "easy_decorator_#{method_name}".to_sym
+      alias_method source_method_name, method_name
+      method_chain = build_method_chain(method_name)
+      setup_decorated_method(method_name, method_chain)
+    end
+
+    private
+
+    def bypass_method_added(method_name)
+      [
+        method_name.to_s.start_with?('easy_decorator_'),
+        @decorators.key?(method_name),
+        @decorators[:method_buffer].empty?
+      ].any?
+    end
+
+    def build_method_chain(method_name)
+      validate_decorators(@decorators[:method_buffer])
+      @decorators[method_name] = @decorators[:method_buffer]
+      @decorators[:method_buffer] = []
+      source_method_name = "source_#{method_name}".to_sym
+      alias_method source_method_name, method_name
+
+      @decorators[method_name].map { |i| i[:decorator] } << source_method_name
+    end
+
+    def setup_decorated_method(method_name, method_chain)
+      define_method method_name do |*args|
+        method_chain.then do |*funcs, base_func|
+          funcs.reduce(public_method(base_func)) do |acc, func|
+            public_method(func).call(acc, *args)
+          end
+        end.call(*args)
+      end
+    end
+
+    def validate_syntax(method_line)
+      # verify decorators are declared directly before the method definition
+      line_nums = @decorators[:method_buffer].map { |m| m[:line].to_i }.reverse << method_line.to_i
+      is_valid = line_nums.each_cons(2).all? { |i| (i[1] - i[0]).eql? 1 }
+
+      unless is_valid
+        raise EasyDecorator::InvalidSyntax, 'Decorators must be declared on line(s) directly before method definition'
       end
+
+      is_valid
+    end
+
+    def validate_decorators(method_buffer)
+      invalid_methods = method_buffer.filter { |m| !method_defined? m[:decorator] }
+      is_valid = invalid_methods.empty?
+
+      raise(EasyDecorator::InvalidDecorator, "Decorator(s) not defined:\n\t#{invalid_methods}") unless is_valid
+
+      is_valid
     end
   end
 end

data/lib/easy_decorator/errors.rb

@@ -1,3 +1,5 @@
 module EasyDecorator
   class Error < StandardError; end
+  class InvalidSyntax < StandardError; end
+  class InvalidDecorator < StandardError; end
 end

data/lib/easy_decorator/version.rb

@@ -1,3 +1,3 @@
 module EasyDecorator
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: easy_decorator
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Josh Crank
@@ -11,7 +11,7 @@ cert_chain: []
 date: 2020-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -38,17 +38,54 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: rubocop-rspec
+  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: 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'
 description: Bring in Python's decorator pattern for Ruby methods.
 email: joshuatcrank@gmail.com
 executables: []
 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

data/.gitignore

@@ -1,56 +0,0 @@
-*.gem
-*.rbc
-/.config
-/coverage/
-/InstalledFiles
-/pkg/
-/spec/reports/
-/spec/examples.txt
-/test/tmp/
-/test/version_tmp/
-/tmp/
-
-# Used by dotenv library to load environment variables.
-# .env
-
-# Ignore Byebug command history file.
-.byebug_history
-
-## Specific to RubyMotion:
-.dat*
-.repl_history
-build/
-*.bridgesupport
-build-iPhoneOS/
-build-iPhoneSimulator/
-
-## Specific to RubyMotion (use of CocoaPods):
-#
-# We recommend against adding the Pods directory to your .gitignore. However
-# you should judge for yourself, the pros and cons are mentioned at:
-# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
-#
-# vendor/Pods/
-
-## Documentation cache and generated files:
-/.yardoc/
-/_yardoc/
-/doc/
-/rdoc/
-
-## Environment normalization:
-/.bundle/
-/vendor/bundle
-/lib/bundler/man/
-
-# for a library or gem, you might want to ignore these files since the code is
-# intended to run in multiple environments; otherwise, check them in:
-Gemfile.lock
-.ruby-version
-# .ruby-gemset
-
-# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
-.rvmrc
-
-# Used by RuboCop. Remote config files pulled in from inherit_from directive.
-# .rubocop-https?--*

data/Gemfile

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

data/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2020 Josh Crank
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

data/README.md

@@ -1,114 +0,0 @@
-# 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/easy_decorator.gemspec

@@ -1,30 +0,0 @@
-require_relative 'lib/easy_decorator/version'
-
-Gem::Specification.new do |gem|
-  gem.name        = 'easy_decorator'
-  gem.version     = EasyDecorator::VERSION
-  gem.date        = '2020-10-13'
-  gem.authors     = ['Josh Crank']
-  gem.email       = 'joshuatcrank@gmail.com'
-
-  gem.summary     = %q{A method decorator for Ruby.}
-  gem.description = %q{Bring in Python's decorator pattern for Ruby methods.}
-  gem.homepage    = 'https://github.com/jtcrank/easy_decorator'
-  gem.license     = 'MIT'
-  gem.required_ruby_version       = Gem::Requirement.new(">=2.6")
-
-  gem.metadata['homepage_uri']    = gem.homepage
-  gem.metadata['source_code_uri'] = gem.homepage
-  gem.metadata['changelog_uri']   = gem.homepage
-
-  gem.files = Dir.chdir(File.expand_path('..', __FILE__)) do
-    `git ls-files -z`.split("\x0").reject { |f|
-      f.match(%r{^(test|spec|features)/})
-    }
-  end
-
-  gem.require_paths = ['lib']
-  gem.add_development_dependency 'pry'
-  gem.add_development_dependency 'rspec'
-
-end