pattern_patch 0.5.5 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f6f40628b47488df4f90cfa6a5b50d081920599c96d010fd74885dad790e0b8
-  data.tar.gz: f0cb442292000db601602c3e8540a6989b87c99efbc43aa8736ca5331cb51cc3
+  metadata.gz: 9e20771a9100042d880f37afca70c6bf547b167777a8c58a342a637e62fd36ed
+  data.tar.gz: f357bd192396f04a8a6757e6ab2736244d12e32679420bb80691836b77235961
 SHA512:
-  metadata.gz: 6f0267701568351d0fb97de38756fa62c8ffb1700784ba0ebaed121e19d544600565f5f58eb76ce1ae3fd1cca76c23547963133cba9989590d74008ef924d569
-  data.tar.gz: cb8c146fc40df297a83d2579e8dc8580fd5c959d75934fc2e0354c6edea87f8aa370a538dc4aa1833dfa2ad9505c59d34151737576025b53612e113eec98d73a
+  metadata.gz: 5183c3381e5fcc3e5b4da29832ed62bd66471c23eee239839441f89592c5fe07535e066e9575cee6ec9fa565dce9efe8e608664ed33700bc70daec051ae9a49a
+  data.tar.gz: 77cf6f4416a96a82c205b5fc8747323b2ad1ad12f39babc0dcc0b5eef01e887362dd7b509627c38d47c11f03606172613b2e7c51b7d2799497e46765d8c90881

data/lib/pattern_patch/core_ext/hash.rb

@@ -0,0 +1,16 @@
+class Hash
+  # #transform_keys not available in 2.3
+  def symbolize_keys
+    each_with_object({}) do |ary, hash|
+      key, value = *ary
+      hash[key.to_sym] = value
+    end
+  end
+
+  def symbolize_keys!
+    hash = symbolize_keys
+    clear
+    hash.each { |k, v| self[k] = v }
+    nil
+  end
+end

data/lib/pattern_patch/core_ext.rb

@@ -1 +1,2 @@
-require "pattern_patch/core_ext/string"
+require 'pattern_patch/core_ext/hash'
+require 'pattern_patch/core_ext/string'

data/lib/pattern_patch/patch.rb

@@ -1,6 +1,7 @@
-require "active_support/core_ext/hash"
-require "erb"
-require "yaml"
+require 'erb'
+require 'yaml'
+require_relative 'core_ext/hash'
+require_relative 'renderer'
 
 module PatternPatch
   # The PatternPatch::Patch class defines a patch as an operation that
@@ -116,7 +117,7 @@ module PatternPatch
 
     # Applies the patch to one or more files. ERB is processed in the text
     # field, whether it comes from a text_file or not. Pass a Binding to
-    # ERB using the :binding option. Pass the :offset option to specify a
+    # ERB using the :binding option or a Hash of locals. Pass the :offset option to specify a
     # starting offset, in characters, from the beginning of the file.
     #
     # @param files [Array, String] One or more file paths to which to apply the patch.
@@ -125,6 +126,7 @@ module PatternPatch
     # @option options [Integer] :offset (0) Offset in characters
     # @option options [Object, nil] :safe_level (PatternPatch.safe_level) A valid value for $SAFE for use with ERb
     # @option options [String] :trim_mode (PatternPatch.trim_mode) A valid ERb trim mode
+    # @option options [Hash] :locals A Hash of local variables for rendering the template
     # @raise [ArgumentError] In case of invalid mode (other than :append, :prepend, :replace)
     def apply(files, options = {})
       offset = options[:offset] || 0
@@ -133,7 +135,16 @@ module PatternPatch
       safe_level = options[:safe_level] || PatternPatch.safe_level
       trim_mode = options[:trim_mode] || PatternPatch.trim_mode
 
-      patch_text = ERB.new(text, safe_level, trim_mode).result options[:binding]
+      locals = options[:locals]
+
+      raise ArgumentError, ':binding is incompatible with :locals' if options[:binding] && locals
+
+      renderer = Renderer.new text, safe_level, trim_mode
+      if locals.nil?
+        patch_text = renderer.render options[:binding]
+      else
+        patch_text = renderer.render locals
+      end
 
       files.each do |path|
         modified = Utilities.apply_patch File.read(path),
@@ -148,7 +159,7 @@ module PatternPatch
 
     # Reverse the effect of a patch on one or more files. ERB is processed in the text
     # field, whether it comes from a text_file or not. Pass a Binding to
-    # ERB using the :binding option. Pass the :offset option to specify a
+    # ERB using the :binding option or a Hash of locals. Pass the :offset option to specify a
     # starting offset, in characters, from the beginning of the file.
     #
     # @param files [Array, String] One or more file paths to which to apply the patch.
@@ -157,6 +168,7 @@ module PatternPatch
     # @option options [Integer] :offset (0) Offset in characters
     # @option options [Object, nil] :safe_level (PatternPatch.safe_level) A valid value for $SAFE for use with ERb
     # @option options [String] :trim_mode (PatternPatch.trim_mode) A valid ERb trim mode
+    # @option options [Hash] :locals A Hash of local variables for rendering the template
     # @raise [ArgumentError] In case of invalid mode (other than :append or :prepend)
     def revert(files, options = {})
       offset = options[:offset] || 0
@@ -165,7 +177,16 @@ module PatternPatch
       safe_level = options[:safe_level] || PatternPatch.safe_level
       trim_mode = options[:trim_mode] || PatternPatch.trim_mode
 
-      patch_text = ERB.new(text, safe_level, trim_mode).result options[:binding]
+      locals = options[:locals]
+
+      raise ArgumentError, ':binding is incompatible with :locals' if options[:binding] && locals
+
+      renderer = Renderer.new text, safe_level, trim_mode
+      if locals.nil?
+        patch_text = renderer.render options[:binding]
+      else
+        patch_text = renderer.render locals
+      end
 
       files.each do |path|
         modified = Utilities.revert_patch File.read(path),

data/lib/pattern_patch/renderer.rb

@@ -0,0 +1,62 @@
+require_relative 'core_ext/hash'
+require 'rubygems'
+
+module PatternPatch
+  # Provides a fairly clean binding for resolving locals in Ruby < 2.5.
+  # All locals become method calls in the binding passed to ERB. A separate
+  # class (instead of a Module, e.g.) means minimal clutter in the set of
+  # methods available to the binding.
+  class Renderer
+    class << self
+      def is_ruby3?
+        version = Gem::Version.new RUBY_VERSION
+        requirement = Gem::Requirement.new '>= 3'
+        requirement =~ version
+      end
+    end
+
+    def initialize(text, safe_level = nil, trim_mode = nil)
+      if self.class.is_ruby3?
+        @template = ERB.new text, trim_mode: trim_mode
+      else
+        @template = ERB.new text, safe_level, trim_mode
+      end
+      @locals = {}
+    end
+
+    # Render an ERB template with a binding or locals.
+    #     renderer = Renderer.new template_text
+    #     result = renderer.render binding
+    #     result = renderer.render a: 'foo', b: 1
+    # @param locals_or_binding [Hash, Binding] a Hash of locals or a Binding
+    # @return the result of rendering the template
+    # @raise ArgumentError for invalid locals
+    def render(locals_or_binding = {})
+      # Pass a Binding this way.
+      return @template.result(locals_or_binding) unless locals_or_binding.kind_of?(Hash)
+
+      @locals = locals_or_binding.symbolize_keys
+      # Any local that corresponds to a method name in this class is invalid
+      # because it cannot trigger method_missing. The same goes for
+      # locals_or_binding, the only local variable.
+      # Avoid new methods and local variables, which will be visible in the binding.
+      # Could validate only for Ruby < 2.5, but better to be consistent.
+      if @locals.any? { |l| respond_to?(l) || l == :locals_or_binding }
+        raise ArgumentError, "Invalid locals: #{@locals.select { |l| respond_to?(l) || l == :locals_or_binding }.map(&:to_str).join ', '}"
+      end
+
+      if @template.respond_to? :result_with_hash
+        # ERB#result_with_hash requires Ruby 2.5.
+        @template.result_with_hash locals_or_binding
+      else
+        @template.result binding
+      end
+    end
+
+    def method_missing(method_sym, *args, &block)
+      return super unless @locals.key?(method_sym)
+
+      @locals[method_sym]
+    end
+  end
+end

data/lib/pattern_patch/utilities.rb

@@ -29,6 +29,7 @@ module PatternPatch
 
           contents = "#{matches.pre_match}#{patched_pattern}#{matches.post_match}"
           break unless global
+
           search_position = matches.pre_match.length + patched_pattern.length
         end
         contents
@@ -71,6 +72,7 @@ module PatternPatch
           reverted_text = matches[0].sub(text.apply_matches(matches), '')
           contents = "#{matches.pre_match}#{reverted_text}#{matches.post_match}"
           break unless global
+
           search_position = matches.pre_match.length + reverted_text.length
         end
 

data/lib/pattern_patch/version.rb

@@ -1,3 +1,3 @@
 module PatternPatch
-  VERSION = "0.5.5"
+  VERSION = "1.1.0"
 end

data/lib/pattern_patch.rb

@@ -46,9 +46,36 @@ module PatternPatch
     # @raise [ConfigurationError] If patch_dir is nil or is not a valid directory path
     def patch(name)
       raise ConfigurationError, "patch_dir has not been set" if patch_dir.nil?
-      raise ConfigurationError, "patch_dir is not a directory" unless Dir.exist?(patch_dir)
+      raise ConfigurationError, "patch_dir #{patch_dir} is not a directory" unless Dir.exist?(patch_dir)
+
       Patch.from_yaml File.join(patch_dir, "#{name}.yml")
     end
+
+    # Useful to configure PatternPatch without using the class
+    # (PatternPatch.patch_dir=), ivar (@patch_dir) or explicit
+    # setter (self.patch_dir=).
+    #
+    #     include PatternPatch::Methods
+    #     patch_config do |c|
+    #       c.patch_dir = 'lib/assets/patches'
+    #       c.trim_mode = '<>'
+    #     end
+    #
+    # or
+    #
+    #     include PatternPatch::Methods
+    #     patch_config.patch_dir = 'lib/assets/patches'
+    #     patch_config.trim_mode = '<>'
+    #
+    # @yield self if block_given?
+    # @return self or return value of block
+    def patch_config(&block)
+      if block_given?
+        yield self
+      else
+        self
+      end
+    end
   end
 
   class << self

metadata

@@ -1,155 +1,147 @@
 --- !ruby/object:Gem::Specification
 name: pattern_patch
 version: !ruby/object:Gem::Version
-  version: 0.5.5
+  version: 1.1.0
 platform: ruby
 authors:
 - Jimmy Dee
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-12-29 00:00:00.000000000 Z
+date: 2022-12-06 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '4.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.16'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.16'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.12'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '12.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.8'
 - !ruby/object:Gem::Dependency
-  name: rspec-simplecov
+  name: rspec_junit_formatter
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.4'
 - !ruby/object:Gem::Dependency
-  name: rspec_junit_formatter
+  name: rspec-simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.50.0
+        version: 1.39.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.50.0
+        version: 1.39.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.16'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.9'
 description: This is a utility gem that identifies positions in any text using regular
   expressions and then inserts patch text at the specified location or replaces matching
   text. Many patches can be reverted.
@@ -160,32 +152,34 @@ extra_rdoc_files: []
 files:
 - lib/pattern_patch.rb
 - lib/pattern_patch/core_ext.rb
+- lib/pattern_patch/core_ext/hash.rb
 - lib/pattern_patch/core_ext/string.rb
 - lib/pattern_patch/patch.rb
+- lib/pattern_patch/renderer.rb
 - lib/pattern_patch/utilities.rb
 - lib/pattern_patch/version.rb
 homepage: http://github.com/jdee/pattern_patch
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.4
-signing_key: 
+rubygems_version: 3.2.33
+signing_key:
 specification_version: 4
 summary: Apply and revert pattern-based patches to text files of any kind
 test_files: []