sane_patch 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e05bf4fc6e133c3ae6c6ded26adc3b11647bc5258f714307011779b05f5a4bd8
-  data.tar.gz: 2968b9196978abcd0d3b06a7871b9131cd30bc8075b95587596d084732468373
+  metadata.gz: dd06cfb6785effd7bfbc07c1c212ef2b43d6ca480a46b9a180d06800f2790740
+  data.tar.gz: '05435385730e1d6da0d6215f614e1c2a871ae2e286aeb53b2ea74af1d04ebb69'
 SHA512:
-  metadata.gz: 4060048796877c10e0a96270bd6f44b5a389b14eccf112e88da4ba680a86eda1bbf50b4d8cbd2ae3f4854ef12062a9984c1f576f8cd22bd56eb6e81105515b6f
-  data.tar.gz: 1b41773116b9166343b98616ac0d51f6aa4e39e5c1d66809cbe98cd56da48bd48add8e0034312bc3bdf81a0bde83e2e33c256d653fa18434cff1b464678a1e11
+  metadata.gz: 35d37b2964aeb895dd90b92c2b414f23c127363f83e8f2b3b9a06d9dd33b96f26450fab623cd7f63b0f2be9f45ce8ff5679277b3412767a551a9b7a9361b9fe2
+  data.tar.gz: '08754a0f5d071c5c4fe9bbcc6764beedc6f2014b78da60b91abcca2849228ff25ec0743d4bba0be328e7448f97406881552bc3178eaf5abfcd483ace07151fa4'

data/.travis.yml

@@ -4,4 +4,16 @@ language: ruby
 cache: bundler
 rvm:
   - 2.6.3
-before_install: gem install bundler -v 2.0.1
+  - ruby-head
+
+matrix:
+  fast_finish: true
+  allow_failures:
+    - rvm: ruby-head
+
+before_install:
+  - gem update --system
+  - gem install bundler -v 2.0.1
+
+script:
+  - bundle exec rspec

data/CHANGELOG.md

@@ -0,0 +1,19 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.2.0] - 2019-06-25
+### Added
+- Added test-suite covering existing functionality by [@PikachuEXE](https://github.com/PikachuEXE)
+- Added the ability to specify more complex version constraints, we now support all constraints supported by [`RubyGems`](http://docs.seattlerb.org/rubygems/Gem/Requirement.html) thanks to the work of [@PikachuEXE](https://github.com/PikachuEXE) and [@jrochkind](https://github.com/jrochkind).
+
+### Changed
+- Fix Typo in code example used in README.
+- Fix Typo in `gemspec` description.
+- Use custom `SanePatch::Errors::GemAbsent` instead of `ArgumentError` when a unloaded gem is patched. `SanePatch::Errors::GemAbsent` inherits `ArgumentError`.
+- Use custom `SanePatch::Errors::IncompatibleVersion` instead of `RuntimeError` when a loaded gem does not meet the requirements of a patch. For backwards compatibility reasons `SanePatch::Errors::IncompatibleVersion` inherits `RuntimeError`.
+

data/CODE_OF_CONDUCT.md

@@ -55,7 +55,7 @@ further defined and clarified by project maintainers.
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at joel@electricfeel.com. All
+reported by contacting the project team at hello@joel.am. All
 complaints will be reviewed and investigated and will result in a response that
 is deemed necessary and appropriate to the circumstances. The project team is
 obligated to maintain confidentiality with regard to the reporter of an incident.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sane_patch (0.1.0)
+    sane_patch (0.2.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,3 +1,5 @@
+<img src="https://raw.githubusercontent.com/Jcambass/sane_patch/master/logo.png" width="100" height="100">
+
 # SanePatch
 
 SanePatch is a simple and non intrusive helper that aims to make monkey patching a little bit safer.
@@ -32,74 +34,93 @@ The usage of SanePatch is straight forward:
 
 ```ruby
 SanePatch.patch('<gem name>', '<current gem version>') do
-    # Apply your patches here the same way as usual.
-  end
+  # Apply your patches here the same way as usual.
+end
 ```
 
 A more specific example:
 
 ```ruby
+Greeter.greet # => 'Hello'
 
-   Greeter.greet # => 'Hello'
-
-  # Let's patch the `Greeter.greet` method to output 'Hello Folks'
-  module GreeterPatch
-    def greet
-      "#{super} Folks"
-    end
+# Let's patch the `Greeter.greet` method to output 'Hello Folks'
+module GreeterPatch
+  def greet
+    "#{super} Folks"
   end
+end
 
-  # We currently have version 1.1.0 of the greeter gem
-  SanePatch.patch('greeter', '1.1.0') do
-    Greeter.prepend(GreeterPatch)
-  end
+# We currently have version 1.1.0 of the greeter gem
+SanePatch.patch('greeter', '1.1.0') do
+  Greeter.prepend(GreeterPatch)
+end
 
-  Greeter.greet # => 'Hello Folk'
+Greeter.greet # => 'Hello Folks'
 ```
 
 If somebody updates the gem version the patch will raise as soon as its code path is executed:
 ```
-It looks like the greeter gem was upgraded. (RuntimeError)
-There are patches in place that need to be verified.
-Make sure that the patch at initializers/greeter_patch.rb:8 is still needed and working.
+SanePatch::Errors::IncompatibleVersion:
+  It looks like the greeter gem was upgraded.
+  There are patches in place that need to be verified.
+  Make sure that the patch at initializers/greeter_patch.rb:8 is still needed and working.
 ```
 
+### Complex version constraints
+
+SanePatch supports all [version constraints](http://docs.seattlerb.org/rubygems/Gem/Requirement.html) you know and love from RubyGems.
+
+```ruby
+SanePatch.patch('greeter', '~> 1.1.0') { # your patch }
+SanePatch.patch('greeter', '> 1.1.0') { # your patch }
+SanePatch.patch('greeter', '< 1.1.0') { # your patch }
+```
+
+It even supports version ranges based on multiple constraints:
+
+```ruby
+SanePatch.patch('greeter', '> 1.0.0', '< 1.1.0') { # your patch }
+```
+
+This is especially useful if you patch a bug where you know the affected gem versions.
+
 ### Providing additional information
 
 If you patch a known bug in a gem it might be useful to provide additional information why the patch is needed and when it can be removed.
 
 ```ruby
- Greeter.silence # => nil
+Greeter.silence # => nil
 
- module GreeterPatch
-    def silence
-      ''
-    end
+module GreeterPatch
+  def silence
+    ''
   end
+end
 
-  details = <<-MSG
-    The `silence` method should output an empty string rather than nil.
-    This is a known issue and will be fixed in the next realase.
-    See: https://github.com/Jcambass/greeter/issues/45
-  MSG
+details = <<-MSG
+  The `silence` method should output an empty string rather than nil.
+  This is a known issue and will be fixed in the next release.
+  See: https://github.com/Jcambass/greeter/issues/45
+MSG
 
-  SanePatch.patch('greeter', '1.1.0', details: details) do
-    Greeter.prepend(GreeterPatch)
-  end
+SanePatch.patch('greeter', '1.1.0', details: details) do
+  Greeter.prepend(GreeterPatch)
+end
 
-  Greeter.silence # => ''
+Greeter.silence # => ''
 ```
 
 The additionally provided details will also show up in the exception message.
 
 ```
-It looks like the greeter gem was upgraded. (RuntimeError)
-There are patches in place that need to be verified.
-Make sure that the patch at initializers/greeter_patch.rb:8 is still needed and working.
-Details:
-The `silence` method should output an empty string rather than nil.
-This is a known issue and will be fixed in the next realase.
-See: https://github.com/Jcambass/greeter/issues/45
+SanePatch::Errors::IncompatibleVersion:
+  It looks like the greeter gem was upgraded.
+  There are patches in place that need to be verified.
+  Make sure that the patch at initializers/greeter_patch.rb:8 is still needed and working.
+  Details:
+  The `silence` method should output an empty string rather than nil.
+  This is a known issue and will be fixed in the next release.
+  See: https://github.com/Jcambass/greeter/issues/45
 ```
 
 ## Contributing
@@ -112,4 +133,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the SanePatch project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/Jambass/sane_patch/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the SanePatch project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/Jcambass/sane_patch/blob/master/CODE_OF_CONDUCT.md).

data/lib/sane_patch.rb

@@ -1,12 +1,17 @@
 require "sane_patch/version"
 
 module SanePatch
-  def self.patch(gem_name, version, details: nil)
+  module Errors
+    GemAbsent           = Class.new(ArgumentError)
+    IncompatibleVersion = Class.new(RuntimeError)
+  end
+
+  def self.patch(gem_name, *requirements, details: nil)
     gem_spec = Gem.loaded_specs[gem_name]
-    patched_version = Gem::Version.new(version)
-    raise ArgumentError, "Can't patch unloaded gem #{gem_name}" unless gem_spec
+    raise Errors::GemAbsent, "Can't patch unloaded gem #{gem_name}" unless gem_spec
 
-    if gem_spec.version == patched_version
+    gem_requirement = Gem::Requirement.create(requirements)
+    if gem_requirement.satisfied_by?(gem_spec.version)
       yield
     else
       message = <<~ERROR
@@ -14,9 +19,9 @@ module SanePatch
         There are patches in place that need to be verified.
         Make sure that the patch at #{caller_locations.first} is still needed and working.
       ERROR
-      message += "Details: \n #{details}" if details
+      message += "Details:\n#{details}" if details
 
-      raise message
+      raise Errors::IncompatibleVersion, message
     end
   end
 end

data/lib/sane_patch/version.rb

@@ -1,3 +1,3 @@
 module SanePatch
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/sane_patch.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["hello@joel.am"]
 
   spec.summary       = %q{Making monkey patches sane again}
-  spec.description   = %q{SanePatch will prevent gem upgrades from sillently breaking your monkey patches.}
+  spec.description   = %q{SanePatch will prevent gem upgrades from silently breaking your monkey patches.}
   spec.homepage      = "https://github.com/Jcambass/sane_patch"
   spec.license       = "MIT"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sane_patch
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Joel Ambass
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-23 00:00:00.000000000 Z
+date: 2019-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,7 +52,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: SanePatch will prevent gem upgrades from sillently breaking your monkey
+description: SanePatch will prevent gem upgrades from silently breaking your monkey
   patches.
 email:
 - hello@joel.am
@@ -63,6 +63,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -71,6 +72,7 @@ files:
 - Rakefile
 - lib/sane_patch.rb
 - lib/sane_patch/version.rb
+- logo.png
 - sane_patch.gemspec
 homepage: https://github.com/Jcambass/sane_patch
 licenses: