watchdog 0.1.0

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT LICENSE
+
+Copyright (c) 2011 Wegowise Inc.
+
+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.md

@@ -0,0 +1,71 @@
+Description
+===========
+
+Watchdog ensures your extensions and monkey patches don't redefine existing methods as well as get redefined by others.
+
+Install
+=======
+
+    $ gem install watchdog
+
+Usage
+=====
+
+Let's say we want to add an instance method to String with extension module ToDate:
+
+    module ToDate
+      def to_date
+        Date.parse(self)
+      end
+    end
+
+    String.send :include, ToDate
+
+What happens if String#to_date already exists? What happens if another gem redefines that method
+later? Breakage.
+
+Watchdog watches over these concerns with a simple extend:
+
+    module ToDate
+      extend Watchdog
+
+      def to_date
+        Date.parse(self)
+      end
+    end
+
+    String.send :include, ToDate
+
+Now if String#to_date already exists, watchdog raises a runtime error. Same goes if someone tries to
+redefine the method later:
+
+    >> class String; def to_date; p 'HAHAHA'; end; end
+    Watchdog::ExtensionMethodExistsError: Date not allowed to redefine extension method from ToDate#to_date
+        ./lib/watchdog.rb:13:in `guard'
+        ./lib/watchdog/german_shepard.rb:23:in `method_added'
+        (ripl):3
+
+Watchdog also guards over extension modules that define class methods:
+
+
+    module DaysTillXmas
+      extend Watchdog
+
+      def days_till_xmas
+        Date.new(Date.today.year, 12, 25) - Date.today
+      end
+    end
+
+    Date.extend DaysTillXmas
+    # Date.days_till_xmas ->  253  NOOOO...
+
+Credits
+=======
+
+Thanks to Wegowise for open-source time to make this possible!
+
+
+License
+=======
+
+See LICENSE file

data/Rakefile

@@ -0,0 +1,39 @@
+require 'rake'
+require 'fileutils'
+
+def gemspec_name
+  @gemspec_name ||= Dir['*.gemspec'][0]
+end
+
+def gemspec
+  @gemspec ||= eval(File.read(gemspec_name), binding, gemspec_name)
+end
+
+desc "Build the gem"
+task :gem=>:gemspec do
+  sh "gem build #{gemspec_name}"
+  FileUtils.mkdir_p 'pkg'
+  FileUtils.mv "#{gemspec.name}-#{gemspec.version}.gem", 'pkg'
+end
+
+desc "Install the gem locally"
+task :install => :gem do
+  sh %{gem install pkg/#{gemspec.name}-#{gemspec.version}}
+end
+
+desc "Generate the gemspec"
+task :generate do
+  puts gemspec.to_ruby
+end
+
+desc "Validate the gemspec"
+task :gemspec do
+  gemspec.validate
+end
+
+desc 'Run tests'
+task :test do |t|
+  sh 'rspec spec'
+end
+
+task :default => :test

data/lib/watchdog.rb

@@ -0,0 +1,38 @@
+require 'watchdog/error'
+require 'watchdog/german_shepard'
+require 'watchdog/version'
+
+module Watchdog
+  # Maps objects or modules to their extension modules
+  class <<self; attr_accessor :extensions; end
+  self.extensions = {}
+
+  # Guards extension methods from being overwritten
+  def self.guard(obj, meth)
+    if extensions[obj].instance_methods.map(&:to_sym).include?(meth)
+      raise ExtensionMethodExistsError.new(meth, obj, extensions[obj])
+    end
+  end
+
+  def self.setup_guard(extension, extended)
+    extensions[extended] = extension
+    extended.extend GermanShepard
+  end
+
+  def append_features(mod)
+    Watchdog.setup_guard(self, mod)
+    existing = mod.private_instance_methods + mod.instance_methods
+    (existing & self.instance_methods).each do |m|
+      raise MethodExistsError.new(m, self, mod)
+    end
+    super
+  end
+
+  def extend_object(obj)
+    Watchdog.setup_guard(self, obj)
+    self.instance_methods.each do |m|
+      raise MethodExistsError.new(m, self, obj) if obj.respond_to?(m, true)
+    end
+    super
+  end
+end

data/lib/watchdog/error.rb

@@ -0,0 +1,16 @@
+module Watchdog
+  class Error < StandardError
+    def initialize(meth, from, to)
+      mtype = to.is_a?(Module) ? '#' : '.'
+      super self.class::MESSAGE % [from, "#{to}#{mtype}#{meth}"]
+    end
+  end
+
+  class MethodExistsError < Error
+    MESSAGE = "%s not allowed to redefine existing method %s"
+  end
+
+  class ExtensionMethodExistsError < Error
+    MESSAGE = "%s not allowed to redefine extension method from %s"
+  end
+end

data/lib/watchdog/german_shepard.rb

@@ -0,0 +1,28 @@
+module Watchdog
+  module GermanShepard
+    def self.create_guard(meth, obj)
+      meta = class <<obj; self end
+      original = meta.instance_method(meth)
+      meta.send(:define_method, meth) do |m|
+        Watchdog.guard(self, m)
+        original.bind(obj).call(m)
+      end
+    end
+
+    def self.extend_object(obj)
+      if obj.respond_to? :method_added
+        create_guard :method_added, obj
+      elsif obj.respond_to? :singleton_method_added
+        create_guard :singleton_method_added, obj
+      end
+      super
+    end
+
+    [:singleton_method_added, :method_added].each do |m|
+      define_method(m) do |meth|
+        Watchdog.guard(self, meth)
+        super(meth)
+      end
+    end
+  end
+end

data/lib/watchdog/version.rb

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

data/spec/watchdog_spec.rb

@@ -0,0 +1,94 @@
+require 'watchdog'
+
+describe Watchdog do
+  def create_methods(obj, *meths)
+    obj_class = obj.is_a?(Module) ? obj : class << obj; self; end
+    meths.each {|e| obj_class.send(:define_method, e) {} }
+    obj
+  end
+
+  context "when extended" do
+    let(:extensions) { create_methods Module.new.extend(Watchdog), :blah }
+
+    context "new extension method" do
+      it "doesn't raise error if no existing methods conflict" do
+        existing = Object.new
+        lambda { existing.extend extensions }.should_not raise_error
+      end
+
+      it "raises error if existing public methods conflict" do
+        existing = create_methods Object.new, :blah
+        lambda { existing.extend extensions }.should raise_error(Watchdog::MethodExistsError, /\.blah/)
+      end
+
+      it "raises error if existing private methods conflict" do
+        existing = create_methods Object.new, :blah
+        class <<existing; self.send :private, :blah; end
+        lambda { existing.extend extensions }.should raise_error(Watchdog::MethodExistsError)
+      end
+    end
+
+    context "new method" do
+      it "doesn't raise error if it doesn't redefine extension methods" do
+        existing = Object.new.extend extensions
+        lambda { def existing.bling; end }.should_not raise_error
+      end
+
+      it "raises error if it redefines extension methods" do
+        existing = Object.new.extend extensions
+        lambda { def existing.blah; end }.should raise_error(Watchdog::ExtensionMethodExistsError)
+      end
+
+      it "raises error if it redefines extension methods for object with singleton_method_added" do
+        existing = Object.new
+        def existing.singleton_method_added(meth); end
+        existing.extend extensions
+        lambda { def existing.blah; end }.should raise_error(Watchdog::ExtensionMethodExistsError)
+      end
+    end
+  end
+
+  context "when included" do
+    let(:extensions) { create_methods Module.new.extend(Watchdog), :blah }
+
+    context "new extension method" do
+      it "doesn't raise error if no existing methods conflict" do
+        existing = Module.new
+        lambda { existing.send :include, extensions }.should_not raise_error
+      end
+
+      it "raises error if existing public methods conflict" do
+        existing = create_methods Module.new, :blah
+        lambda { existing.send :include, extensions }.should raise_error(Watchdog::MethodExistsError, /#blah/)
+      end
+
+      it "raises error if existing private methods conflict" do
+        existing = create_methods Module.new, :blah
+        existing.send :private, :blah
+        lambda { existing.send :include, extensions }.should raise_error(Watchdog::MethodExistsError)
+      end
+    end
+
+    context "new method" do
+      it "doesn't raise error if it doesn't redefine extension methods" do
+        existing = Module.new.send :include, extensions
+        lambda { existing.send(:define_method, :bling) { } }.should_not raise_error
+      end
+
+      it "raises error if it redefines extension methods" do
+        existing = Module.new.send :include, extensions
+        lambda {
+          existing.send(:define_method, :blah) { }
+        }.should raise_error(Watchdog::ExtensionMethodExistsError)
+      end
+
+      it "raises error if it redefines extension methods for module with method_added" do
+        existing = Module.new { def self.method_added(meth); end }
+        existing.send :include, extensions
+        lambda {
+          existing.send(:define_method, :blah) { }
+        }.should raise_error(Watchdog::ExtensionMethodExistsError)
+      end
+    end
+  end
+end

data/watchdog.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require 'rubygems' unless defined? Gem
+require File.dirname(__FILE__) + "/lib/watchdog/version"
+
+Gem::Specification.new do |s|
+  s.name        = "watchdog"
+  s.version     = Watchdog::VERSION
+  s.authors     = ["Gabriel Horner"]
+  s.email       = "ghorner@wegowise.com"
+  s.homepage    = "http://github.com/wegowise/watchdog"
+  s.summary = "Watches over your extensions and monkey patches"
+  s.description =  "Watchdog ensures your extensions and monkey patches don't redefine existing methods as well as get redefined by others."
+  s.required_rubygems_version = ">= 1.3.6"
+  s.files = Dir.glob(%w[{lib,spec}/**/*.rb [A-Z]*.{txt,rdoc,md} *.gemspec]) + %w{Rakefile}
+  s.extra_rdoc_files = ["README.md", "LICENSE.txt"]
+  s.license = 'MIT'
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification 
+name: watchdog
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Gabriel Horner
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-16 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: Watchdog ensures your extensions and monkey patches don't redefine existing methods as well as get redefined by others.
+email: ghorner@wegowise.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+- LICENSE.txt
+files: 
+- lib/watchdog/error.rb
+- lib/watchdog/german_shepard.rb
+- lib/watchdog/version.rb
+- lib/watchdog.rb
+- spec/watchdog_spec.rb
+- LICENSE.txt
+- README.md
+- watchdog.gemspec
+- Rakefile
+has_rdoc: true
+homepage: http://github.com/wegowise/watchdog
+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"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.1
+signing_key: 
+specification_version: 3
+summary: Watches over your extensions and monkey patches
+test_files: []
+