extend_method 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 372070b56fd8127c90f489f2f0720fe675d36a6c
+  data.tar.gz: 1dd64e082d8b67b2720eac751f377d480fbf137d
+SHA512:
+  metadata.gz: b90664ac5e96dc8c532c2da30488a37725ef88ad56e6bf160ea55eee9080f8e0d1c2011b9b2b55eba3cc84326a23d498ddbdd68bd93fd1b2bf10ee1f8e035f8b
+  data.tar.gz: ceec20dd2ce2743334999499cf507242d2abcff721da06c32b512ce66f80ffb6a20f53b94a8d1b7c89f3323f321ed19b5d4a37839739d8d873d823f4d0234855

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,4 @@
+/.idea
+/Gemfile.lock
+.bundle
+/coverage

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - "1.9.3"
+  - "2.0.0"
+  - "2.1.0"
+before_install:
+  - gem update --system
+  - gem --version
+script: bundle exec rake test

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,27 @@
+Copyright (c) 2014, Eric Bollens.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+ are permitted provided that the following conditions are met:
+
+  * Redistributions of source code must retain the above copyright notice,
+    this list of conditions and the following disclaimer.
+
+  * Redistributions in binary form must reproduce the above copyright notice,
+    this list of conditions and the following disclaimer in the documentation
+    and/or other materials provided with the distribution.
+
+  * Neither the name of the University of California nor the names of its
+    contributors may be used to endorse or promote products derived from this
+    software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+ ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,129 @@
+# extend_method
+
+Dry and simple gem for method overriding in non-inheritance contexts.
+
+## Status
+
+This implementation is a **release candidate**.
+
+[![Code Climate](https://codeclimate.com/github/ebollens/ruby-extend_method.png)](https://codeclimate.com/github/ebollens/ruby-extend_method) [![Build Status](https://travis-ci.org/ebollens/ruby-extend_method.png)](https://travis-ci.org/ebollens/ruby-extend_method) [![Coverage Status](https://coveralls.io/repos/ebollens/ruby-extend_method/badge.png)](https://coveralls.io/r/ebollens/ruby-extend_method) [![Dependency Status](https://gemnasium.com/ebollens/ruby-extend_method.png)](https://gemnasium.com/ebollens/ruby-extend_method)
+
+Please report issues in the [issue tracker](https://github.com/ebollens/ruby-extend_method/issues). [Pull requests](https://github.com/ebollens/ruby-extend_method/pulls) are welcome.
+
+## License
+
+The extend_method library is **open-source software** licensed under the BSD 3-clause license. The full text of the license may be found in the [LICENSE](https://github.com/ebollens/ruby-extend_method/blob/master/LICENSE) file.
+
+## Credits
+
+This library is written and maintained by Eric Bollens.
+
+## Usage
+
+Require the gem:
+
+```ruby
+require 'extend_method'
+```
+
+The `extend_method` class method can then be included as:
+
+```ruby
+class Example
+
+  class << self
+    include ExtendMethod
+  end
+
+end
+```
+
+A motivating example showing some of the major features:
+
+```ruby
+module Base
+
+  def set val
+    @val = val
+  end
+
+  def get
+    @val
+  end
+
+end
+
+class Extended
+
+  include Base
+
+  class << self
+    include ExtendMethod
+  end
+
+  extend_method :set do |val|
+    parent_method "#{val}!"
+  end
+
+  extend_method :get do
+    "foo#{parent_method}"
+  end
+
+  extend_method :other do
+    if has_parent_method?
+      parent_method
+    else
+      # do something else
+    end
+  end
+
+end
+
+example = new Extended
+example.set 'bar'
+assert 'foobar!' == example.get
+```
+
+The `extend_method` class method takes a symbol for the method name and a block that extends the method, exposing the previous version of the method as `parent_method`:
+
+```ruby
+class Example
+
+  def basic_example
+    # ..
+  end
+
+  extend_method :basic_example do
+    # ..
+    val = parent_method
+    # ..
+  end
+
+end
+```
+
+To determine if a parent method exists, use the `has_parent_method?` method:
+
+```ruby
+class Example
+
+  extend_method :optional_parent_method_example do |*args|
+    # ..
+    parent_method(*args) if has_parent_method?
+    # ..
+  end
+
+end
+```
+
+The block accepts arguments for what's passed to the method:
+
+```ruby
+class Example
+
+  extend_method :argument_example do |val|
+    "foo#{parent_method val}"
+  end
+
+end
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require 'rake'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList['test/init.rb', 'test/**/*.rb']
+end

data/extend_method.gemspec

@@ -0,0 +1,19 @@
+Gem::Specification.new do |s|
+
+  s.name        = 'extend_method'
+  s.version     = '1.0.0'
+  s.summary     = 'Simple mechanism for extending an existing method'
+  s.authors     = ['Eric Bollens']
+  s.email       = ['ebollens@ucla.edu']
+  s.homepage    = 'https://github.com/ebollens/ruby-extend_method'
+  s.license     = 'BSD'
+
+  s.files         = `git ls-files`.split($/)
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ['lib']
+
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'coveralls'
+
+end

data/lib/extend_method.rb

@@ -0,0 +1,140 @@
+module ExtendMethod
+
+  def extend_method method_name, &block
+
+    ExtendMethod::Strategy.new(self, method_name, block).execute!
+
+  end
+
+  class Strategy
+
+    attr_reader :method_name
+    attr_reader :previous_method_name
+    attr_reader :has_previous_method_name
+    attr_reader :previous_method
+    attr_reader :block
+
+    def initialize klass, method_name, block
+
+      @class = klass
+      @method_name = method_name
+      @previous_method_name = :parent_method
+      @has_previous_method_name = :has_parent_method?
+      @block = block
+
+      begin
+        @previous_method = @class.instance_method(@method_name)
+      rescue NameError => e
+        @previous_method = e
+      end
+
+      @instance = nil
+      @previous_method_original = nil
+      @has_previous_method_original = nil
+
+    end
+
+    def bind! instance
+
+      @instance = instance
+
+    end
+
+    def bound?
+
+      !@instance.nil?
+
+    end
+
+    def unbind!
+
+      @instance = nil
+
+    end
+
+    def save_state!
+
+      raise 'Instance state already saved' if saved_state?
+
+      if @instance.class.method_defined?(previous_method_name)
+        @previous_method_original = @instance.class.send(:instance_method, previous_method_name)
+      else
+        @previous_method_original = false
+      end
+
+      if @instance.class.method_defined?(has_previous_method_name)
+        @has_previous_method_original = @instance.class.send(:instance_method, has_previous_method_name)
+      else
+        @has_previous_method_original = false
+      end
+
+    end
+
+    def saved_state?
+
+      raise 'No bound instance' unless bound?
+
+      !@previous_method_original.nil?
+
+    end
+
+    def restore_state!
+
+      raise 'Instance state not saved' unless saved_state?
+
+      @instance.class.send(:remove_method, previous_method_name)
+      @instance.class.send(:define_method, previous_method_name, @previous_method_original) if @previous_method_original
+      @previous_method_original = nil
+
+      @instance.class.send(:remove_method, has_previous_method_name)
+      @instance.class.send(:define_method, has_previous_method_name, @has_previous_method_original) if @has_previous_method_original
+      @has_previous_method_original = nil
+
+    end
+
+    def run! *args
+
+      @instance.instance_exec *args, &block
+
+    end
+
+    def prepare!
+
+      method_name = @method_name
+      previous_method = @previous_method
+
+      @instance.class.send(:define_method, previous_method_name) do |*args|
+        unless previous_method.is_a? NameError
+          previous_method.bind(self).call(*args)
+        else
+          raise NameError.new "undefined method `previous' in `extend_method' because `#{method_name}' is not previously defined for class `#{self.class.name}'"
+        end
+      end
+
+      @instance.class.send(:define_method, has_previous_method_name) do |*args|
+        !previous_method.is_a?(NameError)
+      end
+
+    end
+
+    def execute!
+
+      strategy = self
+
+      @class.send(:define_method, method_name) do |*args|
+
+        strategy.bind! self
+        strategy.save_state!
+        strategy.prepare!
+        return_value = strategy.run! *args
+        strategy.restore_state!
+        strategy.unbind!
+        return_value
+
+      end
+
+    end
+
+  end
+
+end

data/test/extend_method.rb

@@ -0,0 +1,98 @@
+require 'test/unit'
+require 'extend_method'
+
+class TestExtendMethod < Test::Unit::TestCase
+
+  class Base
+    attr_reader :val
+    attr_accessor :attr
+    def initialize val = nil
+      @val = val
+      @attr = nil
+    end
+    def set_val val
+      @val = val
+    end
+    def get_val
+      @val
+    end
+    def parent_method
+      "bar"
+    end
+    def with_parent_method
+
+    end
+  end
+
+  class Extended < Base
+    class << self
+      include ExtendMethod
+    end
+    extend_method :initialize do |value = nil|
+      parent_method value ? "initialize:#{value}" : nil
+    end
+    extend_method :set_val do |value|
+      parent_method "set:#{value}"
+    end
+    extend_method :attr= do |val|
+      parent_method "attr:#{val}"
+    end
+    extend_method :get_val do
+      "get:#{parent_method}"
+    end
+    extend_method :with_parent_method do
+      has_parent_method?
+    end
+    extend_method :without_parent_method do
+      has_parent_method?
+    end
+    extend_method :parent_method do
+      "foo#{parent_method}"
+    end
+  end
+
+  def test_extend_method
+    val = 'test'
+    base = Base.new
+    assert base.val == nil
+    base.set_val val
+    assert base.val == val
+    extended = Extended.new
+    assert extended.val == nil
+    extended.set_val val
+    assert extended.val == "set:#{val}"
+    assert extended.get_val == "get:set:#{val}"
+  end
+
+  def test_extend_method_initialize
+    val = 'test'
+    base = Base.new val
+    assert base.val == val
+    extended = Extended.new val
+    assert extended.val == "initialize:#{val}"
+  end
+
+  def test_extend_method_attr_accessor
+    val = 'test'
+    base = Base.new
+    assert base.attr == nil
+    base.attr = val
+    assert base.attr == val
+    extended = Extended.new
+    assert extended.attr == nil
+    extended.attr = val
+    assert extended.attr == "attr:#{val}"
+  end
+
+  def test_extend_method_has_parent_method?
+    extended = Extended.new
+    assert extended.with_parent_method
+    assert !extended.without_parent_method
+  end
+
+  def test_extend_method_parent_method
+    extended = Extended.new
+    assert 'foobar' == extended.parent_method
+  end
+
+end

data/test/init.rb

@@ -0,0 +1,7 @@
+require 'simplecov'
+require 'coveralls'
+
+SimpleCov.formatter = Coveralls::SimpleCov::Formatter
+SimpleCov.start do
+  add_filter '/test/'
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: extend_method
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Eric Bollens
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: coveralls
+  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: 
+email:
+- ebollens@ucla.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .coveralls.yml
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- extend_method.gemspec
+- lib/extend_method.rb
+- test/extend_method.rb
+- test/init.rb
+homepage: https://github.com/ebollens/ruby-extend_method
+licenses:
+- BSD
+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.0.14
+signing_key: 
+specification_version: 4
+summary: Simple mechanism for extending an existing method
+test_files:
+- test/extend_method.rb
+- test/init.rb