easy_callbacks 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cce1c2beaaac84b2bffb1e31f5050fd266a9579d
+  data.tar.gz: 2a110c619bdd06c0bedbf78a7fb0e2cd6b10db03
+SHA512:
+  metadata.gz: 2aa984d05872a945035ce437e0469013bf71ad60022fe88a2b5e0dc8f70aa56b80a35a4df5c84e050765fe53dc877679ca59cdb84d70739327abda2d84c1568f
+  data.tar.gz: b6183b1cc3fed10ee38d11e59c28a224c9edf92fa57f4c8fc843d501d9ce47a34716cce032848c1b0b313526a32add6f82e06865fab0b45bba9bc083401f7eda

data/.gitignore

@@ -0,0 +1,16 @@
+/.project
+/.bundle
+*.sqlite3
+log/*
+tmp/*
+rdoc/*
+doc/*
+*~
+*.lock
+*.DS_Store
+*.swp
+*.out
+.idea/*
+coverage/*
+.keep
+.gitkeep

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.3.0@easy_callbacks

data/Gemfile

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

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 YOURNAME
+
+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.rdoc

@@ -0,0 +1,89 @@
+= Easy Callbacks
+
+Provide callbacks support for Ruby classes.
+
+== Example
+
+    class SomeClass
+
+        def some_method(some_arg)
+            puts some_arg
+        end
+
+        include EasyCallbacks::Base
+
+        # named callbacks
+        before :some_method, :do_it_before
+        around :some_method, :do_it_around
+        after :some_method, :do_it_after
+
+        # anonymous callbacks
+        before :some_method do |some_arg, callback_details|
+            # ...
+        end
+
+        def do_it_before(some_arg, callback_details)
+            # ...
+        end
+
+        def do_it_around(some_arg, callback_details)
+            # ...
+        end
+
+        def do_it_after(some_arg, callback_details)
+            # ...
+        end
+
+    end
+
+=== Callback Details
+
+The second argument is a Hash containing some callback call details:
+
+For named callbacks:
+
+    {
+        class: SomeClass,
+        target: :some_method,
+        type: :before,
+        callback_name: :do_it_before,
+        proc: nil
+    }
+
+For anonymous callbacks:
+
+    {
+        class: SomeClass,
+        target: :some_method,
+        type: :before,
+        callback_name: nil,
+        proc: '#<Proc:0x00000002655a20@...>'
+    }
+
+For around callbacks (with success):
+
+    {
+        class: SomeClass,
+        target: :some_method,
+        type: :around,
+        callback_name: :do_it_around,
+        proc: nil,
+        return_type: :success,
+        return_object: nil
+    }
+
+For around callbacks (with error):
+
+    {
+        class: SomeClass,
+        target: :some_method,
+        type: :around,
+        callback_name: :do_it_around,
+        proc: nil,
+        return_type: :error,
+        return_object: '#<StandardError: StandardError>'
+    }
+
+===
+
+{<img src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" alt="Donate" />}[https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=9KHDLTWYK9A62]

data/Rakefile

@@ -0,0 +1,33 @@
+# Rakefile for rake        -*- ruby -*-
+
+# Copyright 2003, 2004, 2005 by Jim Weirich (jim@weirichhouse.org)
+# All rights reserved.
+
+# This file may be distributed under an MIT style license.  See
+# MIT-LICENSE for details.
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'rdoc/task'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.verbose = true
+  t.test_files = FileList['test/**/test_*.rb']
+end
+
+RDoc::Task.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'EasyCallbacks'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = %w(--color)
+end
+
+task :default => :spec

data/easy_callbacks.gemspec

@@ -0,0 +1,27 @@
+$:.push File.expand_path('../lib', __FILE__)
+
+require 'easy_callbacks/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'easy_callbacks'
+  s.version     = EasyCallbacks::VERSION
+  s.authors     = ['r4z3c']
+  s.email       = ['r4z3c.43@gmail.com']
+  s.homepage    = 'https://github.com/r4z3c/easy_callbacks.git'
+  s.summary     = 'Set callbacks for Ruby class methods'
+  s.description = 'Provide callbacks support for Ruby classes'
+  s.licenses    = %w(MIT)
+
+  s.files = `git ls-files`.split("\n")
+  s.test_files = s.files.grep(%r{^(test|spec|features)/})
+
+  s.require_paths = %w(lib)
+
+  s.add_dependency 'bundler', '~>1'
+  s.add_dependency 'activesupport', '~>4'
+  s.add_dependency 'method_decorator', '~>1'
+
+  s.add_development_dependency 'rspec', '~>3'
+  s.add_development_dependency 'simplecov', '~>0'
+  s.add_development_dependency 'model-builder', '~>2'
+end

data/lib/easy_callbacks/base.rb

@@ -0,0 +1,112 @@
+require 'method_decorator'
+
+module EasyCallbacks
+  module Base extend ActiveSupport::Concern
+
+    included do
+
+      include MethodDecorator
+
+      TYPES = %w(before around after)
+
+      class << self
+
+        attr_accessor :callbacks
+
+        def method_missing(method_sym, *args, &block)
+          if TYPES.include? method_sym.to_s
+            target = args.first
+            callback_name = args.count.eql?(1) ? nil : args.last
+            handle_method_missing method_sym, target, callback_name, &block
+          else
+            super method_sym, *args, &block
+          end
+        end
+
+        private
+
+        def handle_method_missing(type, target, callback_name, &block)
+          push_callback type, target, callback_name, &block
+          decorate_target target
+        end
+
+        def push_callback(type, target, callback_name)
+          initialize_callbacks type
+          self.callbacks[type].push target: target,
+                                    callback_name: callback_name,
+                                    proc: (block_given? ? Proc.new : nil)
+        end
+
+        def initialize_callbacks(type)
+          self.callbacks ||= {}
+          self.callbacks[type] ||= []
+        end
+
+        def decorate_target(target)
+          decorate_method target do |*args, &block|
+            execute_callbacks_for :before, target, nil, *args, &block
+            result, error = execute_original_method target, *args, &block
+
+            additional_options = error ?
+              { return_type: :error, return_object: error } :
+              { return_type: :success, return_object: result }
+
+            execute_callbacks_for :around, target, additional_options, *args, &block
+
+            raise error if error
+
+            execute_callbacks_for :after, target, nil, *args, &block
+
+            result
+          end unless method_defined? original_method_name_for(target)
+        end
+
+        def respond_to_missing?(target, include_private=false)
+          TYPES.include?(target) ? true : super ;
+        end
+
+      end
+
+      def execute_callbacks_for(type, target, additional_options, *args, &block)
+        get_callbacks_for(type).select { |c| c[:target].eql? target }.each do |callback|
+          cn = callback[:callback_name]
+          proc = callback[:proc]
+          t = callback[:target]
+          arguments = args + [
+              class: callbacks_holder,
+              target: t,
+              type: type,
+              callback_name: cn,
+              proc: proc
+          ];
+
+          arguments.last.merge! additional_options if additional_options
+
+          proc.nil? ? send(cn, *arguments, &block) : proc.call(*arguments, &block)
+        end
+      end
+
+      def get_callbacks_for(type)
+        callbacks_holder.callbacks[type]
+      end
+
+      def callbacks_holder
+        self.class.eql?(Class) ? self.singleton_class : self.class
+      end
+
+      def execute_original_method(target, *args, &block)
+        result = error = nil
+
+        begin
+          result = call_original_method target, *args, &block
+        rescue => e
+          error = e
+        end
+
+        return result, error
+      end
+
+    end
+
+  end
+end

data/lib/easy_callbacks/version.rb

@@ -0,0 +1,3 @@
+module EasyCallbacks
+  VERSION = '0.0.1'
+end

data/lib/easy_callbacks.rb

@@ -0,0 +1,17 @@
+module EasyCallbacks
+
+  ROOT = File.expand_path(File.join(File.dirname(__FILE__),'..'))
+
+  class << self
+
+    def load_easy_callbacks
+      Dir[File.expand_path(File.join(ROOT,'lib','easy_callbacks','**/*.rb'))].each do |file|
+        require file
+      end
+    end
+
+  end
+
+  load_easy_callbacks
+
+end

data/spec/lib/easy_callbacks/base_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+require 'support/some_class'
+
+describe EasyCallbacks::Base do
+
+  let(:instance) { SomeClass.new }
+
+  it do
+    expect_instance_for_puts_with('before_1: some_arg')
+    expect_class_for_puts_with('before_2: some_arg')
+    expect_instance_for_puts_with('some_method: some_arg')
+    expect_instance_for_puts_with('around_1: some_arg')
+    expect_class_for_puts_with('around_2: some_arg')
+    expect_instance_for_puts_with('after_1: some_arg')
+    expect_class_for_puts_with('after_2: some_arg')
+
+    instance.some_method(:some_arg)
+  end
+
+  def expect_instance_for_puts_with(expected)
+    expect(instance).to receive(:puts).with(expected).ordered
+  end
+
+  def expect_class_for_puts_with(expected)
+    expect(SomeClass).to receive(:puts).with(expected).ordered
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'active_support'
+require 'method_decorator'
+require 'simplecov'
+
+SimpleCov.start
+
+require 'easy_callbacks'

data/spec/support/some_class.rb

@@ -0,0 +1,36 @@
+class SomeClass
+
+  def some_method(some_arg)
+    puts "some_method: #{some_arg}"
+  end
+
+  include EasyCallbacks::Base
+
+  before :some_method, :before_1
+  before :some_method do |some_arg, callback_details|
+    puts "before_2: #{some_arg}"
+  end
+
+  around :some_method, :around_1
+  around :some_method do |some_arg, callback_details|
+    puts "around_2: #{some_arg}"
+  end
+
+  after :some_method, :after_1
+  after :some_method do |some_arg, callback_details|
+    puts "after_2: #{some_arg}"
+  end
+
+  def before_1(some_arg, callback_details)
+    puts "before_1: #{some_arg}"
+  end
+
+  def around_1(some_arg, callback_details)
+    puts "around_1: #{some_arg}"
+  end
+
+  def after_1(some_arg, callback_details)
+    puts "after_1: #{some_arg}"
+  end
+
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: easy_callbacks
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- r4z3c
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: method_decorator
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !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: model-builder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+description: Provide callbacks support for Ruby classes
+email:
+- r4z3c.43@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- Gemfile
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- easy_callbacks.gemspec
+- lib/easy_callbacks.rb
+- lib/easy_callbacks/base.rb
+- lib/easy_callbacks/version.rb
+- spec/lib/easy_callbacks/base_spec.rb
+- spec/spec_helper.rb
+- spec/support/some_class.rb
+homepage: https://github.com/r4z3c/easy_callbacks.git
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Set callbacks for Ruby class methods
+test_files:
+- spec/lib/easy_callbacks/base_spec.rb
+- spec/spec_helper.rb
+- spec/support/some_class.rb