safe_monkeypatch 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 844de048f173e6086d969251524d92a7c31ed3ba
+  data.tar.gz: f96cd2f537e8060d2772adb966e85dd3a06daee5
+SHA512:
+  metadata.gz: dab778853b53dc6c4f0c7fc4407779b85b47cfb5d30bae151ad465909ce5a17ef4cb5c6966e5d9296ac7983dfbe9d4d9ced54946e3e607b6691f59dd472c12d0
+  data.tar.gz: 6e5b91d0cb0058944fdd263a898da8a2f35fb7bb02bc217ff5fcdd5db334aab96c87851d0b16f8e8aa3ba7277df88021bc9bcc829a50b88f00f1914c46e5134a

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.1
+  - jruby-19mode
+  - rbx

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in safe_monkeypatch.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Vlad Bokov
+
+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/README.md

@@ -0,0 +1,56 @@
+# SafeMonkeypatch
+
+[![Gem Version][GV img]][Gem Version]
+[![Build Status][BS img]][Build Status]
+
+**If you can, please, DO NOT monkeypatch.**
+
+Sometimes I patch ActiveRecord, but ain't sure if
+it's gonna break in the next version of Rails. This gem
+would raise an error if monkey patched method has changed
+since last time you've adapted your patch to the upstream.
+
+## Usage
+
+    # assume some upstream in foo.gem:
+    class Foo
+      def bar
+        puts "do first thing"
+        puts "do second thing"
+        puts "do something else"
+      end
+    end
+
+    # your code
+    class Foo
+
+      # you can use any of Digest::*** checksum's methods: sha1, etc.
+      # NOTE: do this BEFORE monkeypatch happens
+      safe_monkeypatch :bar, md5: "", error: "my additional info for exception"
+
+      def bar
+        puts "do first thing"
+        # puts "do second thing" # don't do that
+        puts "do something else"
+      end
+    end
+
+Until upstream code isn't changed, it's working like usual.
+But if the new version changes the implementation of `Foo#bar` method, an
+error is raised **while startup time**
+(unless you monkeypatch in runtime, but now you're on your own):
+
+    SafeMonkeypatch::UpstreamChanged: Foo#bar expected to have md5 checksum: "", but has: ""
+    my additional info for exception
+
+You can also use it without patched module scope (for proper error use patched class/module name):
+
+    Foo.safe_monkeypatch Foo.instance_method(:bar), md5: 'invalid_checksum'
+
+Happy monkeypatching :)
+
+[Gem Version]: https://rubygems.org/gems/safe_monkeypatch
+[Build Status]: https://travis-ci.org/razum2um/safe_monkeypatch
+
+[GV img]: https://badge.fury.io/rb/safe_monkeypatch.png
+[BS img]: https://travis-ci.org/razum2um/safe_monkeypatch.png

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require 'bundler/setup'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+

data/lib/safe_monkeypatch.rb

@@ -0,0 +1,47 @@
+require "digest"
+require "method_source"
+
+module SafeMonkeypatch
+  extend self
+
+  class UpstreamChanged < StandardError
+  end
+
+  class ConfigurationError < StandardError
+  end
+
+  class InvalidMethod < StandardError
+  end
+end
+
+class Module
+  def safe_monkeypatch(meth, options={})
+    options = options.dup
+    info = options.delete(:error)
+
+    if meth.is_a? UnboundMethod
+      method = meth
+      meth = method.name
+    else
+      begin
+        method = instance_method(meth)
+      rescue NameError => e
+        raise SafeMonkeypatch::InvalidMethod, "#{inspect} has no method #{meth} anymore"
+      end
+    end
+
+    source = method.source
+
+    if options.empty?
+      raise SafeMonkeypatch::ConfigurationError, "Provide at least one cypher name like: md5: '...'"
+    end
+
+    options.each do |cypher_name, expected|
+      cypher = Digest.const_get(cypher_name.upcase)
+      if (actual = cypher.hexdigest(source)) != expected
+        raise SafeMonkeypatch::UpstreamChanged, "#{inspect}##{meth} expected to have #{cypher_name} expected: '#{expected}', but has: '#{actual}'\n#{info}".strip
+      end
+    end
+  end
+end
+

data/safe_monkeypatch.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "safe_monkeypatch"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Vlad Bokov"]
+  spec.email         = ["razum2um@mail.ru"]
+  spec.summary       = %q{Patch methods without fear!}
+  spec.description   = %q{Checksums method source and raises if upstream has changed.}
+  spec.homepage      = "https://github.com/razum2um/safe_monkeypatch"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "method_source"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/spec/safe_monkeypatch_spec.rb

@@ -0,0 +1,76 @@
+require 'spec_helper'
+
+MD5_CHECKSUM = 'b1c5ef3149e6e0062e1c21c3ce8af7d8'
+
+RSpec.describe SafeMonkeypatch do
+  subject { Foo.new }
+
+  before do
+    class Foo
+      def bar
+        "bar"
+      end
+    end
+  end
+
+  it "works as usual" do
+    class Foo
+      safe_monkeypatch :bar, md5: MD5_CHECKSUM
+
+      def bar
+        "patched bar"
+      end
+    end
+
+    expect(subject.bar).to eq "patched bar"
+  end
+
+  it 'raises if none cypher is given' do
+    expect {
+      class Foo
+        safe_monkeypatch :bar
+
+        def bar
+          "patch!"
+        end
+      end
+    }.to raise_error SafeMonkeypatch::ConfigurationError
+  end
+
+  it "raises if method disappear" do
+    expect {
+      class Foo
+        undef :bar
+        safe_monkeypatch :bar, md5: MD5_CHECKSUM
+
+        def bar
+          "patched disappeared"
+        end
+      end
+    }.to raise_error SafeMonkeypatch::InvalidMethod
+  end
+
+  it "raises if method has changed" do
+    expect {
+      class Foo
+        safe_monkeypatch :bar, md5: 'invalid_checksum'
+
+        def bar
+          "patched changed"
+        end
+      end
+    }.to raise_error(
+      SafeMonkeypatch::UpstreamChanged,
+      /Foo#bar expected to have md5 expected: 'invalid_checksum', but has: '#{MD5_CHECKSUM}'/
+    )
+  end
+
+  it "accepts custom UnboundMethod" do
+    expect {
+      Foo.safe_monkeypatch Foo.instance_method(:bar), md5: 'another_checksum'
+    }.to raise_error(
+      SafeMonkeypatch::UpstreamChanged,
+      /Foo#bar expected to have md5 expected: 'another_checksum', but has: '#{MD5_CHECKSUM}'/
+    )
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+require "safe_monkeypatch"
+
+RSpec.configure do |config|
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  if config.files_to_run.one?
+    config.default_formatter = 'doc'
+  end
+
+  config.order = :random
+  Kernel.srand config.seed
+
+  config.expect_with :rspec do |expectations|
+    expectations.syntax = :expect
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.syntax = :expect
+    mocks.verify_partial_doubles = true
+  end
+end
+

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: safe_monkeypatch
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Vlad Bokov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: method_source
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: rspec
+  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: Checksums method source and raises if upstream has changed.
+email:
+- razum2um@mail.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/safe_monkeypatch.rb
+- safe_monkeypatch.gemspec
+- spec/safe_monkeypatch_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/razum2um/safe_monkeypatch
+licenses:
+- MIT
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Patch methods without fear!
+test_files:
+- spec/safe_monkeypatch_spec.rb
+- spec/spec_helper.rb