garfio 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0998e556317f91f784ca15cb6cb924b1a5c2c701
+  data.tar.gz: e3bfc9f37e78bb6a03da96dd999c9d99c56d9cfa
+SHA512:
+  metadata.gz: 12506e7eddecf8fae636bdbf59fef3c0d35c41ce7befe86d036388cbc80f4f35fd706ad4497d8e02a2135b81178ef1e1423809dae5b49e30dbab8bd43d2ac787
+  data.tar.gz: d543c6c2ee16022340e6f30a9411550e9f13c567ac8e03c97880da0c77a3d17548f5aec9b2d72d91eb317be2539da0cfb9381e3bd234b83fb1ade3d028251c46

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Julio Lopez
+
+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

@@ -0,0 +1,84 @@
+Garfio
+====
+
+Garfio helps you to build hooks in your ruby objects, is minimalist and completely framework-agnostic
+
+## Introduction
+
+With few lines of code, one method compilation and no method missing Garfio with an easy way lets you to launch callbacks before and after of the methods of your objects.
+
+## Installation
+
+Installing Garfio is as simple as running:
+
+```
+$ gem install garfio
+```
+
+Include Garfio in your Gemfile with gem 'garfio' or require it with require 'garfio'.
+
+Usage
+-----
+
+Once you have extend Garfio, you can define your before and after callbacks in the `set_hook` method, your callback recognize the method sending his name as symbol
+
+```ruby
+class User
+  extend Garfio
+
+  def send_greeting
+    puts "preparing the welcome message"
+  end
+
+  def register_user
+    puts "registering user"
+  end
+
+  def send_mailer
+    puts "sending to your email"
+  end
+
+  set_hook :register_user do
+    before :send_greeting
+    after :send_mailer
+  end
+end
+
+User.new.register_user
+#=> preparing the welcome message
+#=> registering user
+#=> sending to your email
+```
+
+Is not neccesary indicate both callbacks, you can work with just before or after
+
+```ruby
+  set_hook :register_user do
+    before :send_greeting
+  end
+```
+
+Also you can send blocks to your callbacks
+```ruby
+set_hook :register_user do
+  before { puts "hello user!" }
+  after { puts "Ok, bye" }
+end
+
+User.new.register_user
+#=> hello user!
+#=> registering user
+#=> Ok, bye
+```
+
+And you can take advantage of them to do more complex stuff
+
+```ruby
+set_hook :register_user do
+  after do
+    update_status_with("activate")
+    send_mailer
+    notify_friends
+  end
+end
+```

data/garfio.gemspec

@@ -0,0 +1,20 @@
+require "./lib/garfio"
+
+Gem::Specification.new do |s|
+  s.name              = "garfio"
+  s.version           = Garfio::VERSION
+  s.summary           = "Garfio helps you to build hooks in your ruby objects"
+  s.description       = "With few lines of code, one method compilation and no method missing Garfio with an easy way lets you to launch callbacks before and after of the methods of your objects."
+  s.authors           = ["Julio Lopez"]
+  s.email             = ["ljuliom@gmail.com"]
+  s.homepage          = "http://github.com/TheBlasfem/garfio"
+  s.files = Dir[
+    "LICENSE",
+    "README.md",
+    "lib/**/*.rb",
+    "*.gemspec",
+    "test/**/*.rb"
+  ]
+  s.license           = "MIT"
+  s.add_development_dependency "cutest", "1.1.3"
+end

data/lib/garfio.rb

@@ -0,0 +1,47 @@
+# Copyright (c) 2015 Julio Lopez
+
+# 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.
+module Garfio
+  VERSION = "1.0.0"
+
+  class GarfioHooks
+    attr_reader :hook_before, :hook_after
+    def initialize(&block)
+      instance_eval &block
+    end
+
+    private
+    [:before, :after].each do |name|
+      define_method name do |method_name = nil, &block|
+        instance_variable_set("@hook_#{name}", method_name || block)
+      end
+    end
+  end
+
+  def set_hook(original_method, _v = "", &block)
+    gar = GarfioHooks.new &block
+    send :alias_method, "old_#{original_method}", original_method
+    send :define_method, original_method do |*args|
+      _v.is_a?(Proc) ? instance_eval(&_v) : send(_v) if _v = gar.hook_before
+      return_value = send "old_#{original_method}", *args
+      _v.is_a?(Proc) ? instance_eval(&_v) : send(_v) if _v = gar.hook_after
+      return_value
+    end
+  end
+end

data/test/test_garfio.rb

@@ -0,0 +1,152 @@
+require File.expand_path("../lib/garfio", File.dirname(__FILE__))
+
+class User
+  extend Garfio
+
+  def initialize
+    @@sum = 0
+  end
+
+  def send_greeting
+    @@sum += 1
+  end
+
+  def register_user(n = 2)
+    @@sum += n
+  end
+
+  def send_mail
+    @@sum += 3
+  end
+
+  def some_method(n = 4)
+    @@sum += n
+  end
+
+  def some_other_method(n = 5)
+    @@sum += n
+  end
+
+  def get_sum
+    @@sum
+  end
+end
+
+scope do
+  test "hook before" do
+    u = Class.new(User) do
+        set_hook :register_user do
+          before :send_greeting
+        end
+      end
+    u_instance = u.new
+    u_instance.register_user
+
+    assert_equal 3, u_instance.get_sum
+  end
+
+  test "hook after" do
+    u = Class.new(User) do
+        set_hook :register_user do
+          after :send_mail
+        end
+      end
+    u_instance = u.new
+    u_instance.register_user
+
+    assert_equal 5, u_instance.get_sum
+  end
+
+  test "hook before and after" do
+    u = Class.new(User) do
+        set_hook :register_user do
+          before :send_greeting
+          after :send_mail
+        end
+      end
+    u_instance = u.new
+    u_instance.register_user
+
+    assert_equal 6, u_instance.get_sum
+  end
+
+  test "respecting the sending variable" do
+    u = Class.new(User) do
+        set_hook :register_user do
+          before :send_greeting
+          after :send_mail
+        end
+      end
+    u_instance = u.new
+    u_instance.register_user(10)
+
+    assert_equal 14, u_instance.get_sum
+  end
+
+  test "sending a block in before" do
+    u = Class.new(User) do
+        set_hook :register_user do
+          before { some_method }
+        end
+      end
+    u_instance = u.new
+    u_instance.register_user
+
+    assert_equal 6, u_instance.get_sum
+  end
+
+  test "sending a complex block in before" do
+    u = Class.new(User) do
+        set_hook :register_user do
+          before do
+            some_method 5
+            some_other_method 8
+          end
+        end
+      end
+    u_instance = u.new
+    u_instance.register_user
+
+    assert_equal 15, u_instance.get_sum
+  end
+
+  test "sending a block in after" do
+    u = Class.new(User) do
+        set_hook :register_user do
+          after { some_method }
+        end
+      end
+    u_instance = u.new
+    u_instance.register_user
+
+    assert_equal 6, u_instance.get_sum
+  end
+
+  test "sending a complex block in after" do
+    u = Class.new(User) do
+        set_hook :register_user do
+          after do
+            some_method 5
+            some_other_method 8
+          end
+        end
+      end
+    u_instance = u.new
+    u_instance.register_user
+
+    assert_equal 15, u_instance.get_sum
+  end
+
+  test "hook method return a value" do
+    u = Class.new(User) do
+        set_hook :register_user do
+          after do
+            some_method 5
+            some_other_method 8
+          end
+        end
+      end
+    u_instance = u.new
+    assert_equal 2, u_instance.register_user
+  end
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: garfio
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Julio Lopez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cutest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.1.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.1.3
+description: With few lines of code, one method compilation and no method missing
+  Garfio with an easy way lets you to launch callbacks before and after of the methods
+  of your objects.
+email:
+- ljuliom@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- garfio.gemspec
+- lib/garfio.rb
+- test/test_garfio.rb
+homepage: http://github.com/TheBlasfem/garfio
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Garfio helps you to build hooks in your ruby objects
+test_files: []