Merge pull request #10 from jdee/erb-improvements

ERb improvements

Author: jdee

README.md

@@ -117,6 +117,20 @@ PatternPatch::Patch.new(
 
 This is particularly useful with a `text_file` argument.
 
+The `#apply` and `#revert` methods also accept `:safe_level` and `:trim_mode`
+options for use with ERb. These can be set at the global level using
+`PatternPatch.safe_level` and `PatternPatch.trim_mode`. The `#safe_level`
+and '#trim_mode' attributes in the `Methods` module are convenience methods
+to set and retrieve these global values.
+
+```Ruby
+PatternPatch::Patch.new(
+  regexp: /x/,
+  text_file: "template.erb",
+  mode: :replace
+).apply file_path, trim_mode: "<>"
+```
+
 #### Regular expressions with modifiers in YAML
 
 The `regexp` field in a YAML file may be specified with or without slashes

lib/pattern_patch.rb

@@ -1,3 +1,4 @@
+require "forwardable"
 require "pattern_patch/core_ext"
 require "pattern_patch/patch"
 require "pattern_patch/utilities"
@@ -8,19 +9,37 @@
 #
 # @author Jimmy Dee (https://github.com/jdee)
 module PatternPatch
+  extend Forwardable
+
   # Generic exception class for PatternPatch exceptions
   class Error < RuntimeError; end
 
   # Exception generated by patch method when patch_dir is not set properly
   class ConfigurationError < Error; end
 
   module Methods
+    extend Forwardable
+
     # @!attribute patch_dir
     # Set this to conveniently load patches from a common folder with
     # the patch method.
     # @return [String] Path to a directory for use with patch
     attr_accessor :patch_dir
 
+    # @!attribute safe_level
+    # Set the default safe level to use with ERb. This is the same as the value
+    # of PatternPatch.safe_level.
+    # @return [Object, nil] The current default safe level for ERb
+    def_delegator "PatternPatch", :safe_level, :safe_level
+    def_delegator "PatternPatch", :safe_level=, :safe_level=
+
+    # @!attribute trim_mode
+    # Set the default trim mode to use with ERb. This is the same as the value
+    # of PatternPatch.trim_mode.
+    # @return [String, nil] The current default trim mode for ERb
+    def_delegator "PatternPatch", :trim_mode, :trim_mode
+    def_delegator "PatternPatch", :trim_mode=, :trim_mode=
+
     # Loads a patch from the patch_dir
     # @param name [#to_s] Name of a patch to load from the patch_dir
     # @return [Patch] A patch loaded from the patch_dir
@@ -32,5 +51,17 @@ def patch(name)
     end
   end
 
+  class << self
+    # @!attribute safe_level
+    # The default safe level to use with ERb. Defaults to nil.
+    # @return [Object, nil] The current default safe level for ERb
+    attr_accessor :safe_level
+
+    # @!attribute trim_mode
+    # The default trim mode to use with ERb. Defaults to nil.
+    # @return [String, nil] The current default trim mode for ERb
+    attr_accessor :trim_mode
+  end
+
   extend Methods
 end

lib/pattern_patch/patch.rb

@@ -123,12 +123,17 @@ def text_file=(path)
     # @param options [Hash] Options for applying the patch.
     # @option options [Binding] :binding (nil) A Binding object to use when rendering ERB
     # @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
     # @raise [ArgumentError] In case of invalid mode (other than :append, :prepend, :replace)
     def apply(files, options = {})
       offset = options[:offset] || 0
       files = [files] if files.kind_of? String
 
-      patch_text = ERB.new(text).result options[:binding]
+      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]
 
       files.each do |path|
         modified = Utilities.apply_patch File.read(path),
@@ -150,12 +155,17 @@ def apply(files, options = {})
     # @param options [Hash] Options for applying the patch.
     # @option options [Binding] :binding (nil) A Binding object to use when rendering ERB
     # @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
     # @raise [ArgumentError] In case of invalid mode (other than :append or :prepend)
     def revert(files, options = {})
       offset = options[:offset] || 0
       files = [files] if files.kind_of? String
 
-      patch_text = ERB.new(text).result options[:binding]
+      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]
 
       files.each do |path|
         modified = Utilities.revert_patch File.read(path),

spec/methods_spec.rb

@@ -1,9 +1,21 @@
+include PatternPatch::Methods
+
 describe PatternPatch::Methods do
   it 'has an attr_accessor :patch_dir' do
     expect(PatternPatch).to respond_to(:patch_dir)
     expect(PatternPatch).to respond_to(:patch_dir=)
   end
 
+  it 'has an attr_accessor :safe_level' do
+    expect(PatternPatch).to respond_to(:safe_level)
+    expect(PatternPatch).to respond_to(:safe_level=)
+  end
+
+  it 'has an attr_accessor :trim_mode' do
+    expect(PatternPatch).to respond_to(:trim_mode)
+    expect(PatternPatch).to respond_to(:trim_mode=)
+  end
+
   describe '::patch' do
     it 'raises if patch_dir is nil' do
       expect do
@@ -28,4 +40,24 @@
       expect(PatternPatch.patch(:foo)).to be_a PatternPatch::Patch
     end
   end
+
+  describe '#safe_level' do
+    it 'delegates to the PatternPatch module' do
+      PatternPatch.safe_level = 0
+      expect(safe_level).to eq 0
+
+      self.safe_level = 1
+      expect(PatternPatch.safe_level).to eq 1
+    end
+  end
+
+  describe '#trim_mode' do
+    it 'delegates to the PatternPatch module' do
+      PatternPatch.trim_mode = "-"
+      expect(trim_mode).to eq "-"
+
+      self.trim_mode = "<>"
+      expect(PatternPatch.trim_mode).to eq "<>"
+    end
+  end
 end