pattern_patch 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5ee5cc07a5f245d8290d1ab831cdaa3474e5a720
+  data.tar.gz: 2e7dca10edda17d2db442fc8493e96ff00cfea68
+SHA512:
+  metadata.gz: dcc4cc20528c5bc172beec3217a3f4de751fe52b212b0567a6703d1674e32b25427ff8cab293ab3f25bfa329bc0253a2e2a6f168444681fd1dfe3f5ef2f695e7
+  data.tar.gz: 1b6501fa7dc885a39fbe3961e5ebc5292c7e81460349216209103702a787dd9a28aba49c66e9a77984d997d3c8ec7189666e8725259e61fd494ef635beccff02

data/lib/pattern_patch.rb

@@ -0,0 +1,3 @@
+require "pattern_patch/string"
+require "pattern_patch/utilities"
+require "pattern_patch/version"

data/lib/pattern_patch/string.rb

@@ -0,0 +1,28 @@
+class String
+  # Replace capture group references in self with appropriate
+  # data from matches. Modifies the receiver. The receiver
+  # need not match the matches.regexp.
+  #
+  # :matches: A MatchData object returned by Regexp#match
+  def apply_matches!(matches)
+    search_position = 0
+    while (m = /\\(\d+)/.match(self, search_position))
+      capture_group = m[1].to_i
+      search_position = index m[0]
+      gsub! m[0], matches[capture_group]
+      search_position += matches[capture_group].length
+    end
+    nil
+  end
+
+  # Return a copy of the receiver with capture group references
+  # in self replaced by appropriate data from matches. The receiver
+  # need not match the matches.regexp.
+  #
+  # :matches: A MatchData object returned by Regexp#match
+  def apply_matches(matches)
+    string = clone
+    string.apply_matches! matches
+    string
+  end
+end

data/lib/pattern_patch/utilities.rb

@@ -0,0 +1,77 @@
+module PatternPatch
+  class Utilities
+    class << self
+      # Add the specified text after the specified pattern.
+      # Returns a modified copy of the string.
+      #
+      # :contents: A string to modify, e.g. the contents of a file
+      # :regexp: A regular expression specifying a pattern to be matched
+      # :text: Text to be appended to the specified pattern
+      # :global: Boolean flag. If true, patch all occurrences of the regex.
+      # :mode: :append, :prepend or :replace to specify how to apply the patch
+      # :offset: Starting position for matching
+      def apply_patch(contents, regexp, text, global, mode, offset)
+        search_position = offset
+        while (matches = regexp.match(contents, search_position))
+          patched_pattern =
+            case mode
+            when :append
+              "#{matches[0]}#{text.apply_matches matches}"
+            when :prepend
+              "#{text.apply_matches matches}#{matches[0]}"
+            when :replace
+              matches[0].sub regexp, text
+            else
+              raise ArgumentError, "Invalid mode argument. Specify :append, :prepend or :replace."
+            end
+
+          contents = "#{matches.pre_match}#{patched_pattern}#{matches.post_match}"
+          break unless global
+          search_position = matches.pre_match.length + patched_pattern.length
+        end
+        contents
+      end
+
+      # Reverts a patch. Use the same arguments that were supplied to apply_patch.
+      # The mode argument can only be :append or :prepend. Patches using :replace
+      # cannot be reverted.
+      # Returns a modified copy of the string.
+      #
+      # :contents: A string to modify, e.g. the contents of a file
+      # :regexp: A regular expression specifying a pattern to be matched
+      # :text: Text to be appended to the specified pattern
+      # :global: Boolean flag. If true, patch all occurrences of the regex.
+      # :mode: :append or :prepend. :replace patches cannot be reverted automatically.
+      # :offset: Starting position for matching
+      def revert_patch(contents, regexp, text, global, mode, offset)
+        search_position = offset
+        regexp_string = regexp.to_s
+
+        patched_regexp =
+          case mode
+          when :append
+            /#{regexp_string}#{text}/m
+          when :prepend
+            # TODO: Capture groups aren't currently revertible in :prepend mode.
+            # This patched regexp can turn into something like /\1.*(\d+)/.
+            # The capture group reference cannot occur in the regexp before definition
+            # of the group. This would have to be transformed to something like
+            # /(\d+).*\1/. Patch reversion is probably not a major use case right
+            # now, so ignore for the moment.
+            /#{text}#{regexp_string}/m
+          else
+            raise ArgumentError, "Invalid mode argument. Specify :append or :prepend."
+          end
+
+        while (matches = patched_regexp.match(contents, search_position))
+          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
+
+        contents
+      end
+    end
+  end
+end

data/lib/pattern_patch/version.rb

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

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: pattern_patch
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jimmy Dee
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-10-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+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.
+email: jgvdthree@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/pattern_patch.rb
+- lib/pattern_patch/string.rb
+- lib/pattern_patch/utilities.rb
+- lib/pattern_patch/version.rb
+homepage: http://github.com/jdee/pattern_patch
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Apply and revert pattern-based patches to text files of any kind
+test_files: []