method_wrapper 0.1.0

data/.gitignore

@@ -0,0 +1,3 @@
+autotest/*
+*.gem
+.bundle

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+gemspec
+

data/Gemfile.lock

@@ -0,0 +1,27 @@
+PATH
+  remote: .
+  specs:
+    method_wrapper (0.1.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    rspec (2.0.1)
+      rspec-core (~> 2.0.1)
+      rspec-expectations (~> 2.0.1)
+      rspec-mocks (~> 2.0.1)
+    rspec-core (2.0.1)
+    rspec-expectations (2.0.1)
+      diff-lcs (>= 1.1.2)
+    rspec-mocks (2.0.1)
+      rspec-core (~> 2.0.1)
+      rspec-expectations (~> 2.0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (>= 1.0.0.rc.5)
+  method_wrapper!
+  rspec (>= 2.0.0)

data/README.rdoc

@@ -0,0 +1,74 @@
+= Method Wrapper
+
+<em>Lightweight method wrapper in Ruby.</em>
+
+== Introduction
+
+This gem help you to to wrap new features around (before and after) existing methods call on Any classes.
+
+The before_ and after_ callbacks will run as soon as you call wrapped method.
+
+== Installation
+
+  gem install method_wrapper
+
+== Examples
+  require 'method_wrapper'
+
+  class Klass
+    include MethodWrapper
+    wrap_methods :method_name
+
+    def method_name
+      puts 'hi'
+    end
+
+    def before_method_name
+      puts "calls before method name"
+    end
+
+    def after_method_name
+      puts "calls after method name"
+    end
+  end
+
+You can also has partial callback
+  require 'method_wrapper'
+
+  class Klass
+    include MethodWrapper
+    wrap_methods :method_name, :second_method_name
+
+    def method_name
+      puts 'hi'
+    end
+
+    def second_method_name
+      puts 'hello'
+    end
+
+    def before_method_name
+      puts "calls before method name"
+    end
+
+    def after_method_name
+      puts "calls after method name"
+    end
+
+    def after_second_method_name
+      puts "calls after second method name"
+    end
+  end
+
+You can also open the existing classes to wrap methods
+  require 'method_wrapper'
+
+  class String
+    include MethodWrapper
+    wrap_methods :reverse
+
+    def before_reverse
+      puts "calls before string reverse"
+    end
+  end
+

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/lib/method_wrapper/version.rb

@@ -0,0 +1,4 @@
+module MethodWrapper
+  VERSION = "0.1.0"
+end
+

data/lib/method_wrapper.rb

@@ -0,0 +1,52 @@
+module MethodWrapper
+  def self.included(base)
+    base.instance_variable_set(:@_wrapped_methods, [])
+    base.extend ClassMethods
+  end
+
+  private
+  def invoke_method(name)
+    send(name) if respond_to? name, true
+  end
+
+  module ClassMethods
+    def method_added(name)
+      return if @_disable_hook_method_added
+
+      _wrap_method!(name) if @_wrapped_methods.include? name
+    end
+
+    def wrap_methods(*args)
+      @_wrapped_methods = args
+
+      @_wrapped_methods.each do |name|
+        _wrap_method!(name) if instance_method_defined? name
+      end
+    end
+
+    private
+    def _wrap_method!(name)
+      @_disable_hook_method_added = true
+
+      origin_method_name = "origin_#{name}"
+      origin_method = instance_method(name)
+
+      alias_method origin_method_name, name
+
+      define_method(name) do |*args, &block|
+        invoke_method("before_#{name}")
+        return_result = origin_method.bind(self).call(*args, &block)
+        invoke_method("after_#{name}")
+
+        return_result
+      end
+
+      @_disable_hook_method_added = false
+    end
+
+    def instance_method_defined?(name)
+      instance_methods.include? name.to_sym
+    end
+  end
+end
+

data/method_wrapper.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+require 'method_wrapper/version'
+
+Gem::Specification.new do |s|
+  s.name        = "method_wrapper"
+  s.version     = MethodWrapper::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Samnang Chhun"]
+  s.email       = ["samnang.chhun@gmail.com"]
+  s.homepage    = "http://github.com/samnang/method_wrapper"
+  s.summary     = "How easy to wrap new features around (before and after) existing methods call with method_wrapper."
+  s.description = "This gem help you to to wrap new features around (before and after) existing methods call on Any classes. The before_ and after_ callbacks will run as soon as you call wrapped method."
+
+  s.required_rubygems_version = ">= 1.3.6"
+  s.rubyforge_project         = "[none]"
+
+  s.add_development_dependency "bundler", ">= 1.0.0.rc.5"
+  s.add_development_dependency "rspec", ">= 2.0.0"
+
+  s.files        = `git ls-files`.split("\n")
+  s.require_path = 'lib'
+end
+

data/spec/class_builder.rb

@@ -0,0 +1,83 @@
+class ClassBuilder
+  class << self
+    def a_class_has_methods_and_calls_after_methods_defined
+      Class.new do
+        include MethodWrapper
+
+        def method_name
+        end
+
+        def second_method_name
+        end
+
+        wrap_methods :method_name, :second_method_name
+      end
+    end
+
+    def a_class_has_methods_and_calls_before_methods_defined
+      Class.new do
+        include MethodWrapper
+        wrap_methods :method_name, :second_method_name
+
+        def method_name
+        end
+
+        def second_method_name
+        end
+      end
+    end
+
+    def a_class_has_before_and_after_wrap_methods
+      Class.new do
+        include MethodWrapper
+        wrap_methods :method_name
+
+        def method_name
+        end
+
+        private
+        def before_method_name
+          @has_called_before_callback = true
+        end
+
+        def after_method_name
+          @has_called_after_callback = true
+        end
+      end
+    end
+
+    def a_class_has_partial_callback
+      Class.new do
+        include MethodWrapper
+
+        def method_name
+        end
+
+        private
+        def before_method_name
+          @has_called_before_callback = true
+        end
+
+        wrap_methods :method_name
+      end
+    end
+
+    def a_class_has_method_with_args_and_block
+      Class.new do
+        include MethodWrapper
+        wrap_methods :method_name
+
+        def method_name(param)
+          @param = param
+          yield
+        end
+
+        private
+        def after_method_name
+          @has_called_after_callback = true
+        end
+      end
+    end
+  end
+end
+

data/spec/method_wrapper_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+describe MethodWrapper do
+  describe ".wrap_methods, stores methods that want to wrap" do
+    it "calls after method defined" do
+      klass = ClassBuilder.a_class_has_methods_and_calls_after_methods_defined
+
+      verify_wrapped_methods(klass)
+    end
+
+    it "calls before method defined" do
+      klass = ClassBuilder.a_class_has_methods_and_calls_before_methods_defined
+
+      verify_wrapped_methods(klass)
+    end
+
+    def verify_wrapped_methods(klass)
+      klass.instance_variable_get(:@_wrapped_methods).should ==
+        [:method_name, :second_method_name]
+    end
+  end
+
+  context "invoke the wrapped methods" do
+    it "should invoke _before_method_name and after_method_name" do
+      klass = ClassBuilder.a_class_has_before_and_after_wrap_methods
+      obj = klass.new
+
+      obj.method_name
+
+      obj.instance_variable_get(:@has_called_before_callback).should eql(true)
+      obj.instance_variable_get(:@has_called_after_callback).should eql(true)
+    end
+
+    it "should ignore callbacks if user hasn't defined" do
+      klass = ClassBuilder.a_class_has_partial_callback
+      obj = klass.new
+
+      obj.method_name
+
+      obj.instance_variable_get(:@has_called_before_callback).should eql(true)
+    end
+
+    it "should be able to invoke the method with args and block" do
+      klass = ClassBuilder.a_class_has_method_with_args_and_block
+      obj = klass.new
+      has_called = false
+
+      obj.method_name("value") do
+        has_called = true
+      end
+
+      obj.instance_variable_get(:@param).should eql("value")
+      has_called.should eql(true)
+      obj.instance_variable_get(:@has_called_after_callback).should eql(true)
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'rspec'
+
+require_relative 'class_builder'
+require_relative '../lib/method_wrapper.rb'
+

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification 
+name: method_wrapper
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Samnang Chhun
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-30 00:00:00 +07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        - rc
+        - 5
+        version: 1.0.0.rc.5
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 0
+        version: 2.0.0
+  type: :development
+  version_requirements: *id002
+description: This gem help you to to wrap new features around (before and after) existing methods call on Any classes. The before_ and after_ callbacks will run as soon as you call wrapped method.
+email: 
+- samnang.chhun@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.rdoc
+- Rakefile
+- lib/method_wrapper.rb
+- lib/method_wrapper/version.rb
+- method_wrapper.gemspec
+- spec/class_builder.rb
+- spec/method_wrapper_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/samnang/method_wrapper
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: "[none]"
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: How easy to wrap new features around (before and after) existing methods call with method_wrapper.
+test_files: []
+