safe_monkey_patching 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c7ced24c8b951983501b1c890c3b0caa643f9b2e68f366465741fd5493a8e24f
+  data.tar.gz: eda8d97d249ef17c44d909c23eb20d034f64d049ac96f862c16afaeb375dc63b
+SHA512:
+  metadata.gz: 754b46804461f1181097339ba7975d5f81d8f6081f443660b6392e40601f2c171cdb5c371996d89c50d3a1670154f4bde765e4c1ff9f5d21a1f1a1423c1379dd
+  data.tar.gz: 94fc54058102b2439807d3b5d1379390c4c85f532d5d80d53a835f3612ef74097aa646a3cb4207faee4e4364bbd2b27819ea40cdcd40df7282351f9fb506d812

data/README.md

@@ -0,0 +1,39 @@
+# safe_monkey_patching
+
+**Przykład**
+```ruby
+module ActiveJob
+  class Base
+    class << self
+      monkey_patch :deserialize
+
+      def deserialize(job_data)
+        ...
+      end
+    end
+  end
+end
+````
+
+metoda `#monkey_patch` generuje hash kodu źródłowego `#deserialize` (tej oryginalnej) i zapisze go do pliku
+```yml
+---
+ActiveJob::Core::ClassMethods:
+  deserialize:
+    sha1: c29634da4f1731775868a6eba5efc837dd711a54
+```
+a więc, gdy podbijemy railsy i zmieni się kod źródłowy, to `gif diff` nam o tym powie 🤩
+
+
+```diff
+
+diff --git a/monkey_patchs.yml b/monkey_patchs.yml
+
+ ActiveJob::Core::ClassMethods:
+   deserialize:
+-    sha1: c29634da4f1731775868a6eba5efc837dd711a54
++    sha1: 131d3acf24768b30a3ccb1052591b1cdb603f0cd
+```
+
+Dzięki temu będziemy wiedzieli, że trzeba tam zajrzeć 🥳
+

data/lib/safe_monkey_patching.rb

@@ -0,0 +1,82 @@
+module SafeMonkeyPatching
+  module Behavior
+    class << self
+      def load_store(path)
+        begin
+          YAML.load_file(path)
+        rescue Errno::ENOENT
+          {}
+        end
+      end
+
+      def gems_with_patches
+        (@gem_paths || []).uniq
+      end
+
+      def add_gem_with_patch(path)
+        @gem_paths ||= []
+        @gem_paths << path
+      end
+    end
+
+    where = ENV.fetch('SAFE_MONKEY_PATCHING_STORE_PATH', '.')
+    ERROR_LOCATION = File.join(where, "WRONG_MONKEY_PATCHES.txt")
+
+    unless ENV['GITHUB_SHA']
+      begin
+        File.delete(ERROR_LOCATION)
+      rescue Errno::ENOENT
+      end
+    end
+
+    def monkey_patch(method_sym)
+      caller = caller_locations.first.path
+      gem_path = Gem::Specification.find do |spec|
+        File.fnmatch(File.join(spec.full_gem_path, '*'), caller)
+      end&.full_gem_path || Rails.root
+
+      SafeMonkeyPatching::Behavior.add_gem_with_patch(gem_path)
+      return unless Rails.env.test?
+
+      method = instance_method(method_sym)
+      database = SafeMonkeyPatching::Behavior.load_store(File.join(gem_path, 'monkey_patches-new.yml'))
+
+      method_entry = { method.owner.to_s => { method.name.to_s =>
+                                                { 'sha1' => Digest::SHA1.hexdigest(method.source) } } }
+
+      new_database = database.merge(method_entry)
+      File.open(File.join(gem_path, 'monkey_patches-new.yml'), 'w') do |f|
+        f.puts(new_database.to_yaml)
+      end
+    end
+  end
+end
+
+class Object
+  prepend SafeMonkeyPatching::Behavior
+end
+
+at_exit do
+  return unless Rails.env.test?
+  SafeMonkeyPatching::Behavior.gems_with_patches.each do |gem_path|
+    old_patches = SafeMonkeyPatching::Behavior.load_store(File.join(gem_path, "monkey_patches-old.yml")).to_yaml
+    new_patches = SafeMonkeyPatching::Behavior.load_store(File.join(gem_path, "monkey_patches-new.yml")).to_yaml
+
+    FileUtils.mv(File.join(gem_path, "monkey_patches-new.yml"),
+                 File.join(gem_path, "monkey_patches-old.yml"))
+
+    diff = Diffy::Diff.new(old_patches, new_patches)
+
+    if diff.to_s.size.positive?
+      $stderr.puts 'Wrong monkeypatches!'.red.bold
+      $stderr.puts gem_path
+      $stderr.puts diff.to_s(:color)
+
+      open(ERROR_LOCATION, 'a') do |f|
+        f.puts("\n")
+        f.puts(gem_path)
+        f.puts(diff.to_s)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: safe_monkey_patching
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andrzej Bisewski
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-12-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: diffy
+  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'
+description: Safe monaky patching
+email: andrzej@bisewski.dev
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/safe_monkey_patching.rb
+homepage:
+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: []
+rubygems_version: 3.0.9
+signing_key:
+specification_version: 4
+summary: Safe monkey patching
+test_files: []