safe_monkeypatch 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 844de048f173e6086d969251524d92a7c31ed3ba
-  data.tar.gz: f96cd2f537e8060d2772adb966e85dd3a06daee5
+  metadata.gz: 38da338572140b59706ba5ba0021bae5605b9af7
+  data.tar.gz: b36380cd9a7a6818a2eaa2ae84ee7e4eaffc3b79
 SHA512:
-  metadata.gz: dab778853b53dc6c4f0c7fc4407779b85b47cfb5d30bae151ad465909ce5a17ef4cb5c6966e5d9296ac7983dfbe9d4d9ced54946e3e607b6691f59dd472c12d0
-  data.tar.gz: 6e5b91d0cb0058944fdd263a898da8a2f35fb7bb02bc217ff5fcdd5db334aab96c87851d0b16f8e8aa3ba7277df88021bc9bcc829a50b88f00f1914c46e5134a
+  metadata.gz: 0b1360b349f2d26ab655c2a7d8cfd954df14f67764dce80bab4c55b5d44c954eca5cedf5aa76bf287223edb147d39e8df98411454638bb6a64a1285da074cadb
+  data.tar.gz: 72cf5eef62fef71733b04a824a3bbf0b2fcf7d13595151afa8f4596f7f920a2dd195626d6293eb1a9150047c3b847e9afd226d00a7ad56ac64daa0f5b0abeda7

data/README.md

@@ -10,9 +10,10 @@ 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
+## Simple usage
+
+Assume some upstream in foo.gem:
 
-    # assume some upstream in foo.gem:
     class Foo
       def bar
         puts "do first thing"
@@ -21,12 +22,10 @@ since last time you've adapted your patch to the upstream.
       end
     end
 
-    # your code
-    class Foo
+And your code:
 
-      # 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"
+    class Foo
+      safe_monkeypatch :bar, md5: "", error: "patch for foo.gem v0.0.1"
 
       def bar
         puts "do first thing"
@@ -35,13 +34,63 @@ since last time you've adapted your patch to the upstream.
       end
     end
 
+**NOTE:** do this BEFORE monkeypatch happens
+
+You can also use any of Digest::*** checksum's methods: sha1 or even combine md5+sha1
+
 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
+    patch for foo.gem v0.0.1
+
+## Matching usage
+
+Unfortunately, if you have to support different versions of `foo.gem`, you have to monkeypatch all the
+variant implementation. Use blocks for this:
+
+    class Foo
+      safe_monkeypatch :bar, md5: 'some_checksum' do
+        def bar
+          "this works if upstream Foo#bar method has md5 of source equals 'some_checksum'
+        end
+      end
+
+      safe_monkeypatch :bar, md5: 'another_checksum' do
+        def bar
+          "this works if upstream Foo#bar method has md5 of source equals 'another_checksum'
+        end
+      end
+    end
+
+**Note:** if source of upstream change dramatically and you haven't such matching checksum,
+**you won't notice this**, as such use this method:
+
+    class Foo
+
+      # NOTE: insert this BEFORE ANY monkeypatch: list all checksum variants
+      safe_monkeypatch :bar, md5: ['some_checksum', 'another_checksum']
+
+      safe_monkeypatch :bar, md5: 'some_checksum' do
+        def bar
+          "this works if upstream Foo#bar method has md5 of source equals 'some_checksum'
+        end
+      end
+
+      safe_monkeypatch :bar, md5: 'another_checksum' do
+        def bar
+          "another patch"
+          "this works if upstream Foo#bar method has md5 of source equals 'another_checksum'
+        end
+      end
+    end
+
+Use block matching **always this way**. This will guarantee, that any of patches will be applied,
+or you'll get standard exception.
+
+## Advanced usage
 
 You can also use it without patched module scope (for proper error use patched class/module name):
 

data/lib/safe_monkeypatch.rb

@@ -36,12 +36,32 @@ class Module
       raise SafeMonkeypatch::ConfigurationError, "Provide at least one cypher name like: md5: '...'"
     end
 
+    found_match = false
+    error_parts = ["#{inspect}##{meth} expected to have"]
+
     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
+      actual = cypher.hexdigest(source)
+      found_match = if expected.is_a? Array
+                      expected.any? { |e| e == actual }
+                    else
+                      actual == expected
+                    end
+
+      unless found_match
+        error_parts << "#{cypher_name} expected: #{expected.inspect}, but has: #{actual.inspect}"
       end
     end
+
+    error_parts << info.to_s if info
+
+    if block_given? && found_match
+      yield
+    elsif block_given?
+      nil # pass
+    elsif not found_match
+      raise SafeMonkeypatch::UpstreamChanged, error_parts.join(" ")
+    end
   end
 end
 

data/safe_monkeypatch.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "safe_monkeypatch"
-  spec.version       = "0.0.1"
+  spec.version       = "0.1.0"
   spec.authors       = ["Vlad Bokov"]
   spec.email         = ["razum2um@mail.ru"]
   spec.summary       = %q{Patch methods without fear!}

data/spec/safe_monkeypatch_spec.rb

@@ -1,6 +1,7 @@
 require 'spec_helper'
 
 MD5_CHECKSUM = 'b1c5ef3149e6e0062e1c21c3ce8af7d8'
+SHA1_CHECKSUM = '31c701df5f245ac40a1f8cc958c77e4c4fa815df'
 
 RSpec.describe SafeMonkeypatch do
   subject { Foo.new }
@@ -13,7 +14,7 @@ RSpec.describe SafeMonkeypatch do
     end
   end
 
-  it "works as usual" do
+  it "works" do
     class Foo
       safe_monkeypatch :bar, md5: MD5_CHECKSUM
 
@@ -61,7 +62,7 @@ RSpec.describe SafeMonkeypatch do
       end
     }.to raise_error(
       SafeMonkeypatch::UpstreamChanged,
-      /Foo#bar expected to have md5 expected: 'invalid_checksum', but has: '#{MD5_CHECKSUM}'/
+      /Foo#bar expected to have md5 expected: "invalid_checksum", but has: "#{MD5_CHECKSUM}"/
     )
   end
 
@@ -70,7 +71,113 @@ RSpec.describe SafeMonkeypatch do
       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}'/
+      /Foo#bar expected to have md5 expected: "another_checksum", but has: "#{MD5_CHECKSUM}"/
     )
   end
+
+  describe "multiple cyphers" do
+    it "works" do
+      class Foo
+        safe_monkeypatch :bar, md5: MD5_CHECKSUM, sha1: SHA1_CHECKSUM
+
+        def bar
+          "patched bar"
+        end
+      end
+
+      expect(subject.bar).to eq "patched bar"
+    end
+
+    it "fails if some cypher is invalid" do
+      expect {
+        class Foo
+          safe_monkeypatch :bar, md5: MD5_CHECKSUM, sha1: 'invalid'
+
+          def bar
+            "patched bar"
+          end
+        end
+      }.to raise_error(
+        SafeMonkeypatch::UpstreamChanged,
+        /Foo#bar expected to have sha1 expected: "invalid", but has: "#{SHA1_CHECKSUM}"/
+      )
+    end
+
+    it "works with mutlipatch" do
+      expect(Kernel).to receive(:puts).once
+
+      class Foo
+        safe_monkeypatch :bar, md5: MD5_CHECKSUM, sha1: SHA1_CHECKSUM do
+          Kernel.puts
+
+          def bar
+            "patched bar"
+          end
+        end
+      end
+
+      expect(subject.bar).to eq "patched bar"
+    end
+  end
+
+  describe "multipatching" do
+    it "works" do
+      class Foo
+        safe_monkeypatch :bar, md5: 'invalid_checksum' do
+          def bar
+            "invalid patch"
+          end
+        end
+
+        safe_monkeypatch :bar, md5: MD5_CHECKSUM do
+          def bar
+            "patched bar"
+          end
+        end
+
+        safe_monkeypatch :bar, md5: 'another_checksum' do
+          def bar
+            "another patch"
+          end
+        end
+      end
+
+      expect(subject.bar).to eq "patched bar"
+    end
+
+    it "doesn't complain if no matching block found" do
+      class Foo
+        safe_monkeypatch :bar, md5: 'invalid_checksum' do
+          def bar
+            "invalid patch"
+          end
+        end
+      end
+
+      expect(subject.bar).to eq "bar"
+    end
+
+    it "complains if no matching block found if array given" do
+      expect {
+        class Foo
+          safe_monkeypatch :bar, md5: ['invalid_checksum', 'another_checksum']
+
+          safe_monkeypatch :bar, md5: 'invalid_checksum' do
+            def bar
+              "invalid patch"
+            end
+          end
+
+          safe_monkeypatch :bar, md5: 'another_checksum' do
+            def bar
+              "invalid patch"
+            end
+          end
+        end
+      }.to raise_error(
+        SafeMonkeypatch::UpstreamChanged,
+        /Foo#bar expected to have md5 expected: \["invalid_checksum", "another_checksum"\], but has: "#{MD5_CHECKSUM}"/
+      )
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: safe_monkeypatch
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Vlad Bokov