sane_patch 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e05bf4fc6e133c3ae6c6ded26adc3b11647bc5258f714307011779b05f5a4bd8
+  data.tar.gz: 2968b9196978abcd0d3b06a7871b9131cd30bc8075b95587596d084732468373
+SHA512:
+  metadata.gz: 4060048796877c10e0a96270bd6f44b5a389b14eccf112e88da4ba680a86eda1bbf50b4d8cbd2ae3f4854ef12062a9984c1f576f8cd22bd56eb6e81105515b6f
+  data.tar.gz: 1b41773116b9166343b98616ac0d51f6aa4e39e5c1d66809cbe98cd56da48bd48add8e0034312bc3bdf81a0bde83e2e33c256d653fa18434cff1b464678a1e11

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 2.0.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+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
+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.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    sane_patch (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.0)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  sane_patch!
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Joel Ambass
+
+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,115 @@
+# SanePatch
+
+SanePatch is a simple and non intrusive helper that aims to make monkey patching a little bit safer.
+
+It achieves this by only applying your patches to a specific version of a gem and raising a exception if the gem version changed. This means that you will always double check that your patches still work after upgrading gems. No surprises anymore!
+
+## But wait.. Isn't monkey patching bad?
+
+As with many things in life there is no pure good or bad. Monkey patching can be dangerous in certain situations and should be avoided sometimes but there are reasons to use it.
+
+Good reasons to monkey patch a gem could be:
+- Fixing a small bug in a broken gem until a new version of it is released.
+- Performance optimizing a specific method of a gem that is used in a hot code path.
+- Probably many more...
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sane_patch'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+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
+```
+
+A more specific example:
+
+```ruby
+
+   Greeter.greet # => 'Hello'
+
+  # 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
+
+  Greeter.greet # => 'Hello Folk'
+```
+
+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.
+```
+
+### 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
+
+ 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
+
+  SanePatch.patch('greeter', '1.1.0', details: details) do
+    Greeter.prepend(GreeterPatch)
+  end
+
+  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
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Jcambass/sane_patch. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## 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).

data/Rakefile

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

data/lib/sane_patch.rb

@@ -0,0 +1,22 @@
+require "sane_patch/version"
+
+module SanePatch
+  def self.patch(gem_name, version, 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
+
+    if gem_spec.version == patched_version
+      yield
+    else
+      message = <<~ERROR
+        It looks like the #{gem_name} gem was upgraded.
+        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
+
+      raise message
+    end
+  end
+end

data/lib/sane_patch/version.rb

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

data/sane_patch.gemspec

@@ -0,0 +1,39 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "sane_patch/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "sane_patch"
+  spec.version       = SanePatch::VERSION
+  spec.authors       = ["Joel Ambass"]
+  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.homepage      = "https://github.com/Jcambass/sane_patch"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/Jcambass/sane_patch"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: sane_patch
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joel Ambass
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-05-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: SanePatch will prevent gem upgrades from sillently breaking your monkey
+  patches.
+email:
+- hello@joel.am
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sane_patch.rb
+- lib/sane_patch/version.rb
+- sane_patch.gemspec
+homepage: https://github.com/Jcambass/sane_patch
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Jcambass/sane_patch
+  source_code_uri: https://github.com/Jcambass/sane_patch
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Making monkey patches sane again
+test_files: []