overridable 0.3.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 梁智敏
+
+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.markdown

@@ -0,0 +1,147 @@
+# Overridable
+
+Overridable is a pure ruby library which helps you to make your methods which are defined in classes to be able to be overrided by mixed-in modules.
+
+## Why?
+
+We all know that it's impossible for modules to override methods that are defined in classes when they are included. For example:
+    class Thing
+      def foo
+        'Thing.foo'
+      end
+    end
+    
+    module Redef
+      def foo
+        'Redef.foo'
+      end
+    end
+    
+    Thing.send :include, Redef
+    Thing.new.foo #=> Thing.foo # not Redef.foo
+
+Usually, in order to achieve that goal, we will write the Redef module like this:
+    module Redef
+      def foo_with_redef
+        'Redef.foo'
+      end
+      # you can also do this by: alias_method_chain :foo, :redef, if you use ActiveSupport.
+      alias foo_without_redef foo
+      alias foo foo_with_redef
+    end
+    
+    Thing.send :include, Redef
+    Thing.new.foo #=> Redef.foo
+
+So it will likely become a with/without hell in your code ( you can find dozens of such methods in Rails' code ). And *overridable* is a library that provides a neat mean to resolve this problem.
+
+## How?
+
+There are two ways to do this with *overridable*: in class or in module.
+
+### In class
+
+Remember Thing and Redef in our first example? Let's make some changes:
+    require 'overridable'
+    
+    Thing.class_eval {
+      include Overridable
+      overrides :foo
+      
+      include Redef
+    }
+    
+    Thing.new.foo #=> Redef.foo
+That's it! You can specify which methods can be overrided by `overrides` method. One more example based on the previous one:
+    Thing.class_eval {
+      def bar; 'Thing.bar' end
+      def baz; 'Thing.baz' end
+      def id;  'Thing'     end
+
+      overrides :bar, :baz
+    }
+    
+    Redef.module_eval {
+      def bar; 'Redef.bar' end
+      def baz; 'Redef baz' end
+      def id;  'Redef'     end
+    }
+    
+    thing = Thing.new
+    thing.bar #=> 'Redef.bar'
+    thing.baz #=> 'Redef.baz'
+    thing.id  #=> 'Thing'
+Of course it's not the end of our story ;) How could I call this *override* if we cannot use `super`? Continue our example:
+    Redef.module_eval {
+      def bar
+        parent = super
+        me = 'Redef.bar'
+        "I'm #{me} and I overrided #{parent}"
+      end
+    }
+
+    Thing.new.bar => I'm Redef.bar and I overrided Thing.bar
+
+### In module
+
+If you have many methods in your module and find that it's too annoying to use `overrides`, then you can mix Overridable::ModuleMixin in your module. Example ( we all like examples, don't we? ):
+    class Thing
+      def method_one; ... end
+      def method_two; ... end
+      ...
+      def method_n;   ... end
+    end
+    
+    module Redef
+      include Overridable::ModuleMixin
+    
+      def method_one; ... end
+      def method_two; ... end
+      ...
+      def method_n;   ... end
+    end
+
+    Thing.send :include, Redef #=> method_one, method_two, ..., method_n are all overrided.
+
+## Install
+
+    gem source -a http://gemcutter.org # you neednot do this if you have already had gemcutter in your source list
+    gem install overridable
+
+## Dependencies
+
+* Ruby >= 1.8.7
+* riot >= 0.10.0 just for test
+* yard >= 0.4.0  just for generating document
+
+## Test
+
+    $> cd $GEM_HOME/gems/overridable-x.y.z
+    $> rake test # requires riot
+
+## TODO
+
+These features **only** will be added when they are asked for.
+
+* :all and :except for overrides 
+      overrides :all, :except => [:whatever, :excepts]
+* override with block    
+      override :foo do |*args|
+        super # or not
+        # any other stuff
+      end
+* tell me what's missing.
+
+## Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2009 梁智敏. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,54 @@
+#--*-- encoding: UTF-8 --*--
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "overridable"
+    gem.summary = %Q{Override methods without method alias.}
+    gem.description = %Q{Overridable is a pure ruby library which helps you to make your methods which are defined in classes to be able to be overrided by mixed-in modules.}
+    gem.email = "liang.gimi@gmail.com"
+    gem.homepage = "http://github.com/Gimi/overridable"
+    gem.authors = ["梁智敏(Gimi Liang)"]
+    gem.add_development_dependency "riot", ">= 0.10.0"
+    gem.add_development_dependency "yard", ">= 0.4.0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+0.3.0

data/lib/overridable.rb

@@ -0,0 +1,146 @@
+# Including this module in your class will give your class the ability to make its methods to be overridable by included modules. Let's look at some examples for easier understanding.
+# @example
+#   class Thing
+#     def foo
+#       puts 'Thing.foo'
+#     end
+#   end
+#
+#   module Foo
+#     def foo
+#       puts 'Foo.foo'
+#     end
+#   end
+#
+#   # If you don't use Overridable, you will get:
+#   Thing.send :include, Foo
+#   Thing.new.foo #=> print: Thing.foo\n
+#
+#   # If you use Overridable *before* you include the module, things will become to be:
+#   Thing.class_eval {
+#     include Overridable
+#     overrides :foo # specifies which methods can be overrided.
+#     include Foo
+#   }
+#   Thing.new.foo => print: Foo.foo\n
+#
+# You are not just limited to write a brandnew method, but also call the original method by `super`.
+# @example
+#   # Let's change the Foo module in the previous example:
+#   module Foo
+#     def foo
+#       super
+#       puts 'Foo.foo'
+#     end
+#   end
+#
+#   Thing.new.foo #=> print: Thing.foo\nFoo.foo\n
+#
+# Thanks to this feature, you don't need method chains any more! ;)
+#
+# You can also use Overridable::ModuleMixin to make things even a bit easier for some situations. See Overridable::ModuleMixin for details.
+module Overridable
+
+  # If your module includes this module, then classes which include your module
+  # will make their methods which also defined in your module overridable.
+  # Let's watch an example:
+  # @example
+  #   module YourModule
+  #     include Overridable::ModuleMixin
+  #
+  #     def foo
+  #       super
+  #       puts "foo in your module"
+  #     end
+  #   end
+  #
+  #   class YourClass
+  #     def foo
+  #       puts "foo in your class"
+  #     end
+  #   end
+  #
+  #   YourClass.new.foo #=> print: foo in your class\n
+  #
+  #   YourClass.send :include, YourModule
+  #
+  #   YourClass.new.foo #=> print: foo in your class\nfoo in your module\n
+  #
+  # __NOTE__: If you need a custom `append_features` method in your module,
+  # define that method before include this module in yours, or this is not
+  # going to work.
+  # @example
+  #   module YourModule
+  #     def self.append_features mod
+  #       # things ...
+  #     end
+  #
+  #     include Overridable::ModuleMixin
+  #   end
+  module ModuleMixin
+    def self.append_features mod #:nodoc:
+      class << mod
+        include Overridable
+        overrides :append_features
+        include ClassMethods
+      end
+    end
+
+    module ClassMethods
+      def append_features mod #:nodoc:
+        # these must be done in `append_features`, not `included`
+        mod.send :include, Overridable
+        mod.overrides *(
+          public_instance_methods +
+          protected_instance_methods +
+          private_instance_methods
+        )
+        super
+      end
+    end
+  end
+
+  def self.included mod #:nodoc:
+    mod.extend ClassMethods
+  end
+
+  module ClassMethods #:nodoc:
+    # Specifies which methods can be overrided.
+    # @param [Symbol,String] method_names specifies one or more methods which can be overrided.
+    # @return nil
+    def overrides *method_names
+      return unless self.is_a?(Class) # do nothing if it's a module
+      methods =
+        method_names.map { |m| instance_method m rescue nil } \
+                    .compact \
+                    .select { |m| m.owner == self }
+      unless methods.empty?
+        # All overrided methods are defined in the same module
+        is_module_defined =
+          if method(:const_defined?).arity > 0 # 1.8.x
+            self.const_defined?(:OverridedMethods)
+          else # 1.9
+            self.const_defined?(:OverridedMethods, false)
+          end
+
+        unless is_module_defined
+          self.const_set(:OverridedMethods, Module.new)
+          include self.const_get(:OverridedMethods)
+        end
+        mod = const_get(:OverridedMethods)
+
+        old_verbose, $VERBOSE = $VERBOSE, nil # supress warnings
+        methods.each { |m|
+          remove_method m.name
+          mod.send :define_method, m.name do |*args, &blk|
+            m.bind(self).call(*args, &blk)
+          end
+        }
+        $VERBOSE = old_verbose
+
+        nil
+      end
+    end
+  end
+
+end

data/test/modulemixin_test.rb

@@ -0,0 +1,48 @@
+require 'teststrap'
+
+context "A module which includes Overridable::ModuleMixin has some methods defined in it." do
+  setup {
+    module SomeModule
+      include Overridable::ModuleMixin
+
+      def foo
+        'SomeModule.foo'
+      end
+
+      def bar a
+        super + 'SomeModule.bar'
+      end
+    end
+
+    SomeModule
+  }
+
+  context "A class which has the same methods that are defined in that module," do
+    setup {
+      class SomeClass
+        def foo
+          'SomeClass.foo'
+        end
+
+        private
+        def bar a
+          'SomeClass.bar'
+        end
+      end
+
+      SomeClass
+    }
+
+    context "includes that module." do
+      setup { topic.send :include, SomeModule; topic }
+
+      asserts("foo should be overrided.") {
+        topic.new.foo
+      }.equals('SomeModule.foo')
+      asserts("bar should be overrided.") {
+        #topic.new.send :bar, :whatever
+        topic.new.bar :whatever
+      }.equals('SomeClass.bar' + 'SomeModule.bar')
+    end
+  end
+end

data/test/overridable_test.rb

@@ -0,0 +1,164 @@
+require 'teststrap'
+
+context "a classes with some methods defined in it" do
+  setup {
+    class Thing
+      def no_arguments
+        'This is Thing.'
+      end
+
+      def one_argument a
+        a
+      end
+
+      def any_arguments *args
+        args.join('-')
+      end
+
+      def with_block *args, &blk
+        blk.call(*args)
+      end
+
+      def keep_unchanged
+        'unchanged'
+      end
+    end
+
+    Thing
+  }
+
+  context "includes a module which has the sames methods" do
+    setup {
+      module ModuleA
+        def no_arguments
+          'This is ModuleA.'
+        end
+
+        def one_argument a
+          a * 10
+        end
+
+        def any_arguments *args
+          args.join('_')
+        end
+
+        def with_block *args, &blk
+          blk.call(*args.map! { |a| a * 10 })
+        end
+
+        def keep_unchanged
+          'changed'
+        end
+      end
+
+      topic.send :include, ModuleA
+      topic
+    }
+
+    # If these tests fail, that means we don't need this library any more ;)
+    asserts("no_arguments should not be overrided") { topic.new.no_arguments } \
+      .equals('This is Thing.')
+    asserts("one_argument should not be overrided") { topic.new.one_argument(10) } \
+      .equals(10)
+    asserts("any_arguments should not be overrided") { topic.new.any_arguments('a', 'b', 'c') } \
+      .equals(%w[a b c].join('-'))
+    asserts("with_block should not be overrided") { topic.new.with_block('a', 'b', 'c') { |*args| args.join('-') } } \
+      .equals(%w[a b c].join('-'))
+    asserts("keep_unchanged should not be overrided") { topic.new.keep_unchanged } \
+      .equals('unchanged')
+  end
+
+  context "includes Overridable and specifies methods to be overrided," do
+    setup {
+      topic.class_eval {
+        include Overridable
+        overrides :no_arguments, :one_argument, :any_arguments, :with_block
+      }
+
+      topic
+    }
+
+    context "then includes a module which has the same methods" do
+      setup {
+        module ModuleB
+          def no_arguments
+            'This is ModuleB.'
+          end
+
+          def one_argument a
+            a * 10
+          end
+
+          def any_arguments *args
+            args.join('_')
+          end
+
+          def with_block *args, &blk
+            blk.call(*args.map! { |a| a * 10 })
+          end
+
+          def keep_unchanged
+            'changed'
+          end
+        end
+
+        topic.send :include, ModuleB
+        topic
+      }
+
+      asserts("no_arguments have been overrided") { topic.new.no_arguments } \
+        .equals('This is ModuleB.')
+      asserts("one_argument have been overrided") { topic.new.one_argument(10) } \
+        .equals(10 * 10)
+      asserts("any_arguments have been overrided") { topic.new.any_arguments('a', 'b', 'c') } \
+        .equals(%w[a b c].join('_'))
+      asserts("with_block have been overrided") { topic.new.with_block('a', 'b', 'c') { |*args| args.join('-') } } \
+        .equals(%w[a b c].map! { |e| e * 10 }.join('-'))
+      asserts("keep_unchanged should not be overrided") { topic.new.keep_unchanged } \
+        .equals('unchanged')
+    end
+
+    context "then includes a module with the same methods which call super in their bodies." do
+      setup {
+        module ModuleC
+          def no_arguments
+            super +
+            'This is ModuleC.'
+          end
+
+          def one_argument a
+            super + 123
+          end
+
+          def any_arguments *args
+            [super, args.join('_')].join('@')
+          end
+
+          def with_block *args, &blk
+            super(*args.map! { |e| "|#{e}|" }, &blk)
+          end
+
+          def keep_unchanged
+            super
+            'changed'
+          end
+        end
+
+        topic.send :include, ModuleC
+        topic
+      }
+
+      asserts("no_arguments have been overrided and work properly.") { topic.new.no_arguments } \
+        .equals('This is Thing.' + 'This is ModuleC.')
+      asserts("one_argument have been overrided and work properly.") { topic.new.one_argument(10) } \
+        .equals(10 + 123)
+      asserts("any_arguments have been overrided and work properly.") { topic.new.any_arguments('a', 'b', 'c') } \
+        .equals([%w[a b c].join('-'), %w[a b c].join('_')].join('@'))
+      asserts("with_block have been overrided and work properly.") { topic.new.with_block('a', 'b', 'c') { |*args| args.join('-') } } \
+        .equals(%w[a b c].map! { |e| "|#{e}|" }.join('-'))
+      asserts("keep_unchanged should not be overrided") { topic.new.keep_unchanged } \
+        .equals('unchanged')
+    end
+  end
+
+end

data/test/teststrap.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'riot'
+require 'overridable'
+
+# colorize is incompatible with Ruby 1.9 at this point
+# and riot requires colorize
+::PLATFORM = ::RUBY_PLATFORM unless defined?(::PLATFORM)

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: overridable
+version: !ruby/object:Gem::Version 
+  version: 0.3.0
+platform: ruby
+authors: 
+- "\xE6\xA2\x81\xE6\x99\xBA\xE6\x95\x8F(Gimi Liang)"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-24 00:00:00 +08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: riot
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.10.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: yard
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.4.0
+    version: 
+description: Overridable is a pure ruby library which helps you to make your methods which are defined in classes to be able to be overrided by mixed-in modules.
+email: liang.gimi@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- lib/overridable.rb
+- test/modulemixin_test.rb
+- test/overridable_test.rb
+- test/teststrap.rb
+has_rdoc: true
+homepage: http://github.com/Gimi/overridable
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Override methods without method alias.
+test_files: 
+- test/overridable_test.rb
+- test/modulemixin_test.rb
+- test/teststrap.rb