pattern_patch 0.5.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 45106665f7237be519a7a8ec49474ebe62305569e456c830275acfb447241ea0
-  data.tar.gz: bfa912c8f32295c8b1744cf0468e15b2e3138ce8bf0caedcbea0fbc0e1e7b7a7
+  metadata.gz: 020a46e316bbe314edeee3920555b57699d37ca1668d10f1d3e7c7b68325c523
+  data.tar.gz: 8cd9d162362f0a168f3950cce7b3a67083638fb55f629c89fbbc36ba89d73c6a
 SHA512:
-  metadata.gz: e022aec8c7b46d499f2c0a37af3c21cfe2ecf0bcb5859a0a48946d06a13a0bce897851925108c0f1f3bfe72df878f431ca3bfb5967c3c571f7c2798d3f953e2b
-  data.tar.gz: 6cb41a5b13b0d2a8b9bdd1857959d7ab74150fe2f1d2e9f8536fcec6a16fcef89e726f1904573098a98ef989c6c257e3e6ee48cf14fd0914c8c0a32f8b2f75bd
+  metadata.gz: bb2bdeb2fd23ff22dcd79741e37e449f10b808174d6401b74fbae472f97a53d3589db604c272f7ed34f98799f7ee3382009059ef3f18a9879296e7c55b811314
+  data.tar.gz: e65d3f77114df163c67fd263f9471b320f6656541ab5b13173405887926755f1a8ae9dbce44030368f9974d8d337309ce0a7366abca636a4c82c3d8095f9647e

data/lib/pattern_patch/core_ext/string.rb

@@ -3,7 +3,7 @@ class String
   # data from matches. Modifies the receiver. The receiver
   # need not match the matches.regexp.
   #
-  # :matches: A MatchData object returned by Regexp#match
+  # [matches] [MatchData] A MatchData object returned by Regexp#match
   def apply_matches!(matches)
     search_position = 0
     while (m = /\\(\d+)/.match(self, search_position))
@@ -19,7 +19,7 @@ class String
   # in self replaced by appropriate data from matches. The receiver
   # need not match the matches.regexp.
   #
-  # :matches: A MatchData object returned by Regexp#match
+  # [matches] [MatchData] A MatchData object returned by Regexp#match
   def apply_matches(matches)
     string = clone
     string.apply_matches! matches

data/lib/pattern_patch/patch.rb

@@ -3,14 +3,37 @@ require "erb"
 require "yaml"
 
 module PatternPatch
+  # The PatternPatch::Patch class defines a patch as an operation that
+  # may be applied to any file. Often the operation may also be reverted.
   class Patch
+    # Regexp defining one or more matching regions in a file.
     attr_accessor :regexp
+
+    # String with text to use in the patch operation. May contain ERB.
     attr_accessor :text
+
+    # Symbol specifying the patch mode: :append (default), :prepend or :replace
     attr_accessor :mode
+
+    # Setting this to true will apply the patch to all matches in the file.
+    # By default (when false), the patch is only applied to the first match.
     attr_accessor :global
+
+    # If set to a file path, the contents of that file will be used to populate
+    # the text attribute. Setting this after construction modifies the text
+    # field.
     attr_reader :text_file
 
     class << self
+      # Load a Patch from a YAML file. The following special processing applies:
+      # The mode field is converted to a symbol. The text_file field will be
+      # interpreted relative to the YAML file. A Regexp will be constructed from
+      # the regexp field using Regexp.new unless it is a String containing a
+      # Regexp literal using slash delimiters, e.g. /x/i. This format may be
+      # used to specify a Regexp with modifiers in YAML. Raises if the file
+      # cannot be loaded.
+      #
+      # [patch] [String] Path to a YAML file containing a patch definition.
       def from_yaml(path)
         hash = YAML.load_file(path).symbolize_keys
 
@@ -47,6 +70,11 @@ module PatternPatch
       end
     end
 
+    # Construct a new Patch from the options. The following fields are mapped
+    # to the corresponding attributes: :regexp, :text, :text_file, :mode,
+    # :global. Raises ArgumentError if both :text and :text_file are specified.
+    #
+    # [options] [Hash] Parameters used to construct the Patch
     def initialize(options = {})
       raise ArgumentError, "text and text_file are mutually exclusive" if options[:text] && options[:text_file]
 
@@ -68,15 +96,18 @@ module PatternPatch
       @text = File.read path if path
     end
 
+    # 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
+    # starting offset, in characters, from the beginning of the file.
+    #
+    # [files] [Array or String] One or more file paths to which to apply the patch.
+    # [options] [Hash] Options for applying the patch.
     def apply(files, options = {})
       offset = options[:offset] || 0
       files = [files] if files.kind_of? String
 
-      if options[:binding]
-        patch_text = ERB.new(text).result(options[:binding])
-      else
-        patch_text = text
-      end
+      patch_text = ERB.new(text).result options[:binding]
 
       files.each do |path|
         modified = Utilities.apply_patch File.read(path),
@@ -89,15 +120,18 @@ module PatternPatch
       end
     end
 
+    # 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
+    # starting offset, in characters, from the beginning of the file.
+    #
+    # [files] [Array or String] One or more file paths to which to apply the patch.
+    # [options] [Hash] Options for applying the patch.
     def revert(files, options = {})
       offset = options[:offset] || 0
       files = [files] if files.kind_of? String
 
-      if options[:binding]
-        patch_text = ERB.new(text).result(options[:binding])
-      else
-        patch_text = text
-      end
+      patch_text = ERB.new(text).result options[:binding]
 
       files.each do |path|
         modified = Utilities.revert_patch File.read(path),

data/lib/pattern_patch/version.rb

@@ -1,3 +1,3 @@
 module PatternPatch
-  VERSION = "0.5.1"
+  VERSION = "0.5.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pattern_patch
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors:
 - Jimmy Dee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-08 00:00:00.000000000 Z
+date: 2017-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport