overrides 0.1.0

data/.gitignore

@@ -0,0 +1,14 @@
+*.gem
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+test/tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Karol Bucek
+
+MIT License
+
+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/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/overrides/version.rb

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

data/lib/overrides.rb

@@ -0,0 +1,96 @@
+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.
+#
+# Sample :
+#
+#     class Message
+#       extend Overrides
+#
+#       def do_send; end
+#       def sent_at; end
+#       def reply?; end
+#     end
+#
+#     class Notice < Message
+#       overrides
+#       def do_send; super; end
+#
+#       def reply?; nil; end
+#       def sent_at; nil; end
+#
+#       overrides :reply?, :sent_at
+#     end
+#
+#
+# Without arguments works with singleton methods as well :
+#
+#     class Message
+#       extend Overrides
+#
+#       def self.deliver(msg); end
+#     end
+#
+#     class Notice < Message
+#       overrides
+#       def self.deliver(msg); end
+#     end
+#
+# To hook it up for all classes/modules, simply do a :
+#
+#    Object.extend Overrides
+#
+# @author kares
+#
+module Overrides
+
+  Error = NoMethodError
+
+  def overrides(*names)
+    if names.empty? # next method
+      @_override = true
+    else
+      names.each do |name|
+        unless Overrides.overriden?(self, name)
+          raise Error, "previous (instance) method #{name.inspect} not found"
+        end
+      end
+    end
+  end
+
+  def method_added(name)
+    return super unless (@_override ||= nil); @_override = false
+    unless Overrides.overriden?(self, name, true)
+      raise Error, "previous (instance) method #{name.inspect} not found"
+    end
+    super
+  end
+
+  def singleton_method_added(name)
+    return super unless (@_override ||= nil); @_override = false
+    unless Overrides.overriden?(self, name, false)
+      raise Error, "previous singleton method #{name.inspect} not found"
+    end
+    super
+  end
+
+  def self.overriden?(klass, method, instance = true)
+    if instance
+      klass.included_modules.each do |mod|
+        return true if mod.instance_methods(true).include? method
+      end
+      return false unless klass.is_a?(Class) # "only" a Module ...
+      return klass.superclass.instance_methods(true).include? method
+    else
+      (class << klass; self; end).included_modules.each do |mod|
+        return true if mod.instance_methods(true).include? method
+      end
+      return false unless klass.is_a?(Class) # "only" a Module ...
+      return klass.superclass.methods(true).include? method
+    end
+  end
+
+end

data/overrides.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'overrides/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "overrides"
+  gem.version       = Overrides::VERSION
+  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.homepage      = "http://github.com/kares/overrides"
+  gem.license       = "MIT"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency "bundler", "~> 1.3"
+  gem.add_development_dependency "rake", "~> 10.1"
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: overrides
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Karol Bucek
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.1'
+description: ! 'An #overrides annotation for your (Ruby) methods.'
+email:
+- self@kares.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- Rakefile
+- lib/overrides.rb
+- lib/overrides/version.rb
+- overrides.gemspec
+homepage: http://github.com/kares/overrides
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1605842409600528455
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1605842409600528455
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: ! 'an #overrides annotation for your methods'
+test_files: []