overrides 0.1.0 → 0.10.0

data/.travis.yml

@@ -0,0 +1,6 @@
+rvm:
+  - 1.8.7
+  - 1.9.3
+  - 2.0.0
+  - jruby
+# before_script: gem install bundler

data/README.md

@@ -0,0 +1,83 @@
+# Overrides
+
+An #overrides annotation for your (Ruby) methods.
+
+Inspired by Java's [@Override][1].
+
+
+## Install
+
+    $ gem install overrides
+
+or add this line to your application's *Gemfile* (and `bundle`) :
+
+    gem 'overrides'
+
+optionally add  `:require => 'overrides/for_all'` to have `overrides` available
+in all classes/modules as a built-in (singleton) method.
+
+
+## Usage
+
+Let's have a base class with `Overrides` pulled in :
+
+    class Message
+      extend Overrides
+
+      def self.deliver(msg); end
+
+      def do_send; end
+      def sent_at; end
+      def reply?; end
+    end
+
+a notice would be a message sub-type, note how `overrides` gets used :
+
+    class Notice < Message
+      overrides
+      def do_send; super; end
+
+      def reply?; nil; end
+      def sent_at; nil; end
+
+      overrides :reply?, :sent_at
+    end
+
+ without args (before method) works with singleton methods as well :
+
+    class Notice < Message
+      overrides
+      def self.deliver(msg); end
+    end
+
+**NOTE:** there's no global name-space pollution by default, thus you'll need
+to hook up the `Overrides` module (or extend `Object` to pull it in for all).
+
+### "Java"
+
+Here's how you use it with JRuby to "annotate" method overrides :
+
+    require 'overrides/for_all'
+
+    class NonEmptyList < java.util.ArrayList
+
+      def initialize
+        super(); add nil
+      end
+
+      overrides
+      def clear; super; add nil; end
+
+      def isEmpty; false; end
+      overrides :isEmpty
+
+    end
+
+
+## Copyright
+
+Copyright (c) 2013 [Karol Bucek](http://kares.org).
+See LICENSE.txt (http://en.wikipedia.org/wiki/MIT_License) for details.
+
+[0]: https://github.com/kares/overrides
+[1]: http://docs.oracle.com/javase/7/docs/api/java/lang/Override.html

data/Rakefile

@@ -1 +1,8 @@
 require "bundler/gem_tasks"
+
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+  t.pattern = "test/*_test.rb"
+end
+
+task :default => :test

data/lib/overrides.rb

@@ -2,10 +2,11 @@ require 'overrides/version'
 
 # Allows for an #overrides annotation for your methods.
 #
-# Thus might help you e.g. during refactoring (method renaming) to assure methods
-# expected to call a super will fail early during def time instead of when called.
+# This might help during refactoring (method renaming) to assure methods
+# expected to be overriding another (and calling super) fail early during
+# definition time instead of when called.
 #
-# Sample :
+# Usage :
 #
 #     class Message
 #       extend Overrides
@@ -26,7 +27,7 @@ require 'overrides/version'
 #     end
 #
 #
-# Without arguments works with singleton methods as well :
+# Without arguments (before method) works with singleton methods as well :
 #
 #     class Message
 #       extend Overrides
@@ -47,13 +48,19 @@ require 'overrides/version'
 #
 module Overrides
 
-  Error = NoMethodError
+  # Custom (missing method error) raised from {#overrides}.
+  class Error < NoMethodError; end
 
   def overrides(*names)
-    if names.empty? # next method
+    if names.empty? # next method def - singleton or instance
       @_override = true
     else
-      names.each do |name|
+      names.each do |name| # only for instance methods
+        unless Overrides.includes_method? self.instance_methods(false), name
+          msg = "(instance) method #{name.inspect} not found in "
+          raise NoMethodError,
+            msg << ( self.is_a?(Class) ? 'class ' : 'module ' ) << self.inspect
+        end
         unless Overrides.overriden?(self, name)
           raise Error, "previous (instance) method #{name.inspect} not found"
         end
@@ -61,6 +68,7 @@ module Overrides
     end
   end
 
+  # @private
   def method_added(name)
     return super unless (@_override ||= nil); @_override = false
     unless Overrides.overriden?(self, name, true)
@@ -69,6 +77,7 @@ module Overrides
     super
   end
 
+  # @private
   def singleton_method_added(name)
     return super unless (@_override ||= nil); @_override = false
     unless Overrides.overriden?(self, name, false)
@@ -77,20 +86,32 @@ module Overrides
     super
   end
 
+  # Checks if a method was previously available in the given module's method
+  # resolution chain. Assumes instance methods by default.
   def self.overriden?(klass, method, instance = true)
     if instance
       klass.included_modules.each do |mod|
-        return true if mod.instance_methods(true).include? method
+        return true if includes_method? mod.instance_methods(true), method
       end
       return false unless klass.is_a?(Class) # "only" a Module ...
-      return klass.superclass.instance_methods(true).include? method
+      return includes_method? klass.superclass.instance_methods(true), method
     else
       (class << klass; self; end).included_modules.each do |mod|
-        return true if mod.instance_methods(true).include? method
+        return true if includes_method? mod.instance_methods(true), method
       end
       return false unless klass.is_a?(Class) # "only" a Module ...
-      return klass.superclass.methods(true).include? method
+      return includes_method? klass.superclass.methods(true), method
     end
   end
 
+  # @private
+  def self.includes_method?(methods, name)
+    methods.include? name
+  end
+
+  # @private
+  def self.includes_method?(methods, name)
+    methods.include? name.to_s
+  end if RUBY_VERSION < '1.9'
+
 end

data/lib/overrides/for_all.rb

@@ -0,0 +1,2 @@
+require 'overrides'
+Object.extend Overrides

data/lib/overrides/version.rb

@@ -1,3 +1,3 @@
 module Overrides
-  VERSION = '0.1.0'
+  VERSION = '0.10.0'
 end

data/overrides.gemspec

@@ -9,7 +9,9 @@ Gem::Specification.new do |gem|
   gem.authors       = ["Karol Bucek"]
   gem.email         = ["self@kares.org"]
   gem.summary       = %q{an #overrides annotation for your methods}
-  gem.description   = %q{An #overrides annotation for your (Ruby) methods.}
+  gem.description   = %q{Helps during refactoring (method renaming) to assure
+  methods expected to be overriding another (and calling super) fail early during
+  definition time instead of when called.}
   gem.homepage      = "http://github.com/kares/overrides"
   gem.license       = "MIT"
 
@@ -18,6 +20,7 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test)/})
   gem.require_paths = ["lib"]
 
+  gem.add_development_dependency "minitest", "~> 3.0"
   gem.add_development_dependency "bundler", "~> 1.3"
   gem.add_development_dependency "rake", "~> 10.1"
 end

data/test/overrides_test.rb

@@ -0,0 +1,178 @@
+require 'bundler/setup' # if RUBY_VERSION < '1.9'
+
+require 'overrides'
+
+require 'minitest/autorun'
+
+class OverridesTest < MiniTest::Unit::TestCase; end
+
+# ========================================
+
+class Ferko
+
+  extend Overrides
+
+  def kuk; 'ferko-kuk'; end
+  def muk; 'ferko-muk'; end
+
+  overrides
+  def to_s
+    'ferko' + super.to_s
+  end
+
+  def self.hoja; 'hoja-ferko'; end
+
+end
+
+OverridesTest.class_eval do
+
+  def test_overrides_builtin_method
+    assert Ferko.new.to_s
+  end
+
+  def test_methods_stay_the_same
+    assert_equal 'ferko-kuk', Ferko.new.kuk
+    assert_equal 'hoja-ferko', Ferko.hoja
+  end
+
+end
+
+# ========================================
+
+class Jozko < Ferko
+
+  overrides
+  def kuk; super; 'jozko-kuk'; end
+
+  def muk; 'jozko-muk'; end
+  def tuk; 'jozko-tuk'; end
+
+  overrides :muk
+
+end
+
+OverridesTest.class_eval do
+
+  def test_overrides_inherited_methods
+    assert_equal 'jozko-kuk',  Jozko.new.kuk
+    assert_equal 'jozko-muk',  Jozko.new.muk
+    assert_equal 'jozko-tuk',  Jozko.new.tuk
+  end
+
+end
+
+# ========================================
+
+class Jozko
+
+  overrides
+  def self.hoja; super; 'hoja-jozko'; end
+
+end
+
+OverridesTest.class_eval do
+
+  def test_overrides_singleton_method
+    assert_equal 'hoja-jozko', Jozko.hoja
+  end
+
+end
+
+# ========================================
+
+class Janko < Ferko
+
+  def kuk; super; 'janko-kuk'; end
+  def muk; super; 'janko-muk'; end
+
+  overrides :muk, :kuk
+
+end
+
+OverridesTest.class_eval do
+
+  def test_overrides_multiple_at_once
+    assert_equal 'janko-kuk',  Janko.new.kuk
+    assert_equal 'janko-muk',  Janko.new.muk
+  end
+
+end
+
+# ========================================
+
+class Jozko
+
+  def jak; 'jozko-jak'; end
+
+end
+
+OverridesTest.class_eval do
+
+  def test_uses_no_method_error
+    assert_kind_of NoMethodError, Overrides::Error.new
+  end
+
+  def test_fails_when_override_not_met
+    assert_raises Overrides::Error do
+      Jozko.class_eval do
+        overrides :jak
+      end
+    end
+
+    assert_raises Overrides::Error do
+      Jozko.class_eval do
+        overrides
+        def tak; end
+      end
+    end
+
+    assert_raises Overrides::Error do
+      Jozko.class_eval do
+        overrides
+        def self.kuk; end
+      end
+    end
+  end
+
+end
+
+# ========================================
+
+class Ferko
+  def sak; end
+end
+
+class Petko < Ferko
+end
+
+OverridesTest.class_eval do
+
+  def test_fails_when_method_not_defined
+    assert_raises NoMethodError do
+      Petko.class_eval do
+        overrides :sak
+      end
+    end
+  end
+
+end
+
+# ========================================
+
+class Otakar
+  def coje; 'tha-nic'; end
+end
+
+class Bohuslav < Otakar; end
+
+OverridesTest.class_eval do
+
+  def test_works_for_all_when_required
+    require 'overrides/for_all'
+    Bohuslav.class_eval do
+      overrides
+      def coje; 'ta-daco'; end
+    end
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: overrides
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.10.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-15 00:00:00.000000000 Z
+date: 2013-11-16 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -43,7 +59,9 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '10.1'
-description: ! 'An #overrides annotation for your (Ruby) methods.'
+description: ! "Helps during refactoring (method renaming) to assure\n  methods expected
+  to be overriding another (and calling super) fail early during\n  definition time
+  instead of when called."
 email:
 - self@kares.org
 executables: []
@@ -51,12 +69,16 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE.txt
+- README.md
 - Rakefile
 - lib/overrides.rb
+- lib/overrides/for_all.rb
 - lib/overrides/version.rb
 - overrides.gemspec
+- test/overrides_test.rb
 homepage: http://github.com/kares/overrides
 licenses:
 - MIT
@@ -72,7 +94,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1605842409600528455
+      hash: 3588119150367271522
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -81,11 +103,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1605842409600528455
+      hash: 3588119150367271522
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: ! 'an #overrides annotation for your methods'
-test_files: []
+test_files:
+- test/overrides_test.rb