deface 1.6.2 → 1.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d70515c1f6f72cef4d6b7d34d936e5fac929ddda6a896cbd9c0c30dddff8c19e
-  data.tar.gz: e6950eb7f793b4111513744ddb48d7ad7a83a918a1f9b8850619b41c7864f515
+  metadata.gz: f95e0d9ff0d9928f8791253e4ce8a96e8c3dfda75505f1f6f9d96d5b50ee20cc
+  data.tar.gz: 5db5672c1fc4c8e43a591674a6d60950a6b70e48f54adbcb9d3f0a380ad2e039
 SHA512:
-  metadata.gz: fd12b650a9104d57bc0b17c7a88324ff77008516e0fa789724f0622f59b26160050ac1eafa9dc42c73b51a93942ccb9c45902761e629f525fd32685a62afbdc9
-  data.tar.gz: 4924e7dfd0a97adf3acebe4f4f15c5d3146e64aea5f75b9d64c0ac5746f9320678988d23af84b196ef30a2e8f1e4f1e8e37d546a5bad676fb12c6fecfc63e596
+  metadata.gz: 5b36c2c608cc51a7975a97da0931e351be90dc4a19d4c51bc37d3f5fe6a0023ed31a6b67ed01d6b17105ded32edf6b1d6cfd1a1bd538471a52790fbb526f1cf6
+  data.tar.gz: 8cf7a37e8af2c13cfcbdeaf039434fd8736e777ec7fb2a2ceeb7186b0a49e4d931c14459e882d71d5d10b527ab523f9f1d6500f452c6acb2b5746b6c015aa99b

data/.github/dependabot.yml

@@ -0,0 +1,7 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: daily
+  open-pull-requests-limit: 10

data/.github/workflows/main.yml

@@ -0,0 +1,45 @@
+on:
+  - push
+  - pull_request
+
+jobs:
+  build:
+    name: "ruby ${{ matrix.combo.ruby }} / ${{ matrix.combo.gemfile }}"
+    strategy:
+      matrix:
+        combo:
+          # TODO: re-enable commented combos and expand the matrix to Ruby 3.1 and Rails 7+
+
+          # - ruby: "3.0"
+          #   gemfile: "rails_6_1"
+          # - ruby: "2.7"
+          #   gemfile: "rails_6_1"
+          - ruby: "2.6"
+            gemfile: "rails_6_1"
+          - ruby: "2.5"
+            gemfile: "rails_6_1"
+
+          # - ruby: "2.7"
+          #   gemfile: "rails_6_0"
+          - ruby: "2.6"
+            gemfile: "rails_6_0"
+          - ruby: "2.5"
+            gemfile: "rails_6_0"
+
+          - ruby: "2.5"
+            gemfile: "rails_5_2"
+
+    runs-on: ubuntu-latest
+
+    env:
+      GEMFILE_PATH: gemfiles/${{ matrix.combo.gemfile }}.gemfile
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.combo.ruby }}
+      - name: Setup project
+        run: bin/setup
+      - name: Run test
+        run: "bundle exec rake"

data/Appraisals

@@ -1,11 +1,26 @@
 appraise 'rails-5.2' do
-  gem 'rails', '~> 5.2.0'
+  %w[
+    actionview
+    railties
+  ].each do |rails_gem|
+    gem rails_gem, '~> 5.2.0'
+  end
 end
 
 appraise 'rails-6.0' do
-  gem 'rails', '~> 6.0.0'
+  %w[
+    actionview
+    railties
+  ].each do |rails_gem|
+    gem rails_gem, '~> 6.0.0'
+  end
 end
 
 appraise 'rails-6.1' do
-  gem 'rails', '~> 6.1.0'
+  %w[
+    actionview
+    railties
+  ].each do |rails_gem|
+    gem rails_gem, '~> 6.1.0'
+  end
 end

data/CONTRIBUTING.md

@@ -0,0 +1,12 @@
+# Contributing
+
+## Setup you development environment
+
+1. Clone the repo
+2. Run `bin/setup` to install dependencies
+3. Run `bin/sandbox` to (re)generate the sandbox application for local experiments
+
+## To run specs locally on the matrix of supported versions
+
+1. Run `bundle exec appraisal install`
+2. Run `bundle exec appraisal rake`

data/README.markdown

@@ -1,41 +1,13 @@
-<p style="float:right;">
-  <a href="http://secure.travis-ci.org/spree/deface">
-    <img src="https://secure.travis-ci.org/spree/deface.svg?branch=master">
-  </a>
-</p>
+# Deface
 
-Deface
-======
+[![Travis build](https://secure.travis-ci.org/spree/deface.svg?branch=master)](https://travis-ci.com/github/spree/deface)
 
 Deface is a library that allows you to customize HTML (ERB, Haml and Slim) views in a Rails application without editing the underlying view.
 
 It allows you to easily target html & erb elements as the hooks for customization using CSS selectors as supported by Nokogiri.
 
 
-Upgrading from 0.9 to 1.0
--------------------------
-
-If you are updating from 0.9.x to 1.0.0 or higher, there's a major internal change you should be aware of.
-
-Previously, erb blocks (i.e. <%= some_method %>) were converted as:
-
-```html
-  <code erb-loud> some_method </code>
-```
-They are now converted to:
-
-```html
-  <erb loud> some_method </erb>
-```
-
-This change will affect any Override that uses a selector that matches on `code` or `code[erb-loud]` or `code[erb-silent]` etc, they should be updated to `erb`, `erb[loud]` or `erb[silent]`, etc.
-
-Note: HAML & SLIM are preconverted to ERB before Deface parsers them, so the same conversions are happening there.
-
-See the [Implementation](#implementation) section below for more details.
-
-Usage
------
+## Usage
 
 There are two ways of using Deface:
 
@@ -46,10 +18,9 @@ Both methods are interoperable, so you can use a mix, and redefine overrides def
 
 
 
-Using Deface::Override
-----------------------
+## Using Deface::Override
 
-A new instance of the Deface::Override class is initialized for each customization you wish to define. When initializing a new override you must supply only one Target, Action & Source parameter and any number of Optional parameters. 
+A new instance of the Deface::Override class is initialized for each customization you wish to define. When initializing a new override you must supply only one Target, Action & Source parameter and any number of Optional parameters.
 
 **Note:** the source parameter is not required when the ````:remove, :set_attributes, :add_to_attributes, :remove_from_attributes```` actions are specified.
 
@@ -59,77 +30,77 @@ You should save your overrides in the ````app/overrides````, normally one overri
 
 ### Target
 
-* <tt>:virtual_path</tt> - The template / partial / layout where the override should take effect eg: *"shared/_person"*, *"admin/posts/new"* this will apply to all controller actions that use the specified template.
+* `:virtual_path` - The template / partial / layout where the override should take effect eg: *"shared/_person"*, *"admin/posts/new"* this will apply to all controller actions that use the specified template.
 
 ### Action
 
-* <tt>:remove</tt> - Removes all elements that match the supplied selector
+* `:remove` - Removes all elements that match the supplied selector
 
-* <tt>:replace</tt> - Replaces all elements that match the supplied selector
+* `:replace` - Replaces all elements that match the supplied selector
 
-* <tt>:replace_contents</tt> - Replaces the contents of all elements that match the supplied selector
+* `:replace_contents` - Replaces the contents of all elements that match the supplied selector
 
-* <tt>:surround</tt> - Surrounds all elements that match the supplied selector, expects replacement markup to contain <%= render_original %> placeholder
+* `:surround` - Surrounds all elements that match the supplied selector, expects replacement markup to contain <%= render_original %> placeholder
 
-* <tt>:surround_contents</tt> - Surrounds the contents of all elements that match the supplied selector, expects replacement markup to contain <%= render_original %> placeholder
+* `:surround_contents` - Surrounds the contents of all elements that match the supplied selector, expects replacement markup to contain <%= render_original %> placeholder
 
-* <tt>:insert_after</tt> - Inserts after all elements that match the supplied selector
+* `:insert_after` - Inserts after all elements that match the supplied selector
 
-* <tt>:insert_before</tt> - Inserts before all elements that match the supplied selector
+* `:insert_before` - Inserts before all elements that match the supplied selector
 
-* <tt>:insert_top</tt> - Inserts inside all elements that match the supplied selector, as the first child.
+* `:insert_top` - Inserts inside all elements that match the supplied selector, as the first child.
 
-* <tt>:insert_bottom</tt> - Inserts inside all elements that match the supplied selector, as the last child.
+* `:insert_bottom` - Inserts inside all elements that match the supplied selector, as the last child.
 
-* <tt>:set_attributes</tt> - Sets attributes on all elements that match the supplied selector, replacing existing attribute value if present or adding if not. Expects :attributes option to be passed.
+* `:set_attributes` - Sets attributes on all elements that match the supplied selector, replacing existing attribute value if present or adding if not. Expects :attributes option to be passed.
 
-* <tt>:add_to_attributes</tt> - Appends value to attributes on all elements that match the supplied selector, adds attribute if not present. Expects :attributes option to be passed.
+* `:add_to_attributes` - Appends value to attributes on all elements that match the supplied selector, adds attribute if not present. Expects :attributes option to be passed.
 
-* <tt>:remove_from_attributes</tt> - Removes value from attributes on all elements that match the supplied selector. Expects :attributes option to be passed.
+* `:remove_from_attributes` - Removes value from attributes on all elements that match the supplied selector. Expects :attributes option to be passed.
 
 ### Source
 
-* <tt>:text</tt> - String containing markup
+* `:text` - String containing markup
 
-* <tt>:partial</tt> - Relative path to a partial
+* `:partial` - Relative path to a partial
 
-* <tt>:template</tt> - Relative path to a template
+* `:template` - Relative path to a template
 
-* <tt>:cut</tt> - Cuts (i.e. copies and removes) an element or a range of elements from the current template as the source, using css selector(s). Supports two versions:
-  * <tt>selector</tt> -  A single string css selector (first match is used).
-  * <tt>{:start => 'selector_a', :end => 'selector_b'}</tt> - select a range of elements using :start and :end css selectors. The end element must be a sibling of the first/starting element.
+* `:cut` - Cuts (i.e. copies and removes) an element or a range of elements from the current template as the source, using css selector(s). Supports two versions:
+  * `selector` -  A single string css selector (first match is used).
+  * `{:start => 'selector_a', :end => 'selector_b'}` - select a range of elements using :start and :end css selectors. The end element must be a sibling of the first/starting element.
 
-* <tt>:copy</tt> - Copies an element or a range of elements from the current template as the source, using css selector(s). Supports two versions:
-  * <tt>selector</tt> -  A single string css selector (first match is used).
-  * <tt>{:start => 'selector_a', :end => 'selector_b'}</tt> - select a range of elements using :start and :end css selectors. The end element must be a sibling of the first/starting element.
+* `:copy` - Copies an element or a range of elements from the current template as the source, using css selector(s). Supports two versions:
+  * `selector` -  A single string css selector (first match is used).
+  * `{:start => 'selector_a', :end => 'selector_b'}` - select a range of elements using :start and :end css selectors. The end element must be a sibling of the first/starting element.
 
 ### Optional
 
-* <tt>:name</tt> - Unique name for override so it can be identified and modified later. This needs to be unique within the same `:virtual_path`
+* `:name` - Unique name for override so it can be identified and modified later. This needs to be unique within the same `:virtual_path`
 
-* <tt>:disabled</tt> - When set to true the override will not be applied.
+* `:disabled` - When set to true the override will not be applied.
 
-* <tt>:original</tt> - Either a string containing the original markup that is being overridden, or a string that is the SHA1 digest of the original markup. If supplied Deface will log when the original markup changes, which helps highlight overrides that need attention when upgrading versions of the source application. Only really warranted for :replace overrides. NB: All whitespace is stripped before comparison. To generate the SHA1 digest do: `Digest::SHA1.hexdigest(original_markup_string.gsub(/\s/, ''))`
+* `:original` - Either a string containing the original markup that is being overridden, or a string that is the SHA1 digest of the original markup. If supplied Deface will log when the original markup changes, which helps highlight overrides that need attention when upgrading versions of the source application. Only really warranted for :replace overrides. NB: All whitespace is stripped before comparison. To generate the SHA1 digest do: `Digest::SHA1.hexdigest(original_markup_string.gsub(/\s/, ''))`
 
-* <tt>:closing_selector</tt> - A second css selector targeting an end element, allowing you to select a range of elements to apply an action against. The :closing_selector only supports the :replace, :remove and :replace_contents actions, and the end element must be a sibling of the first/starting element. Note the CSS general sibling selector (~) is used to match the first element after the opening selector (see below for an example).
+* `:closing_selector` - A second css selector targeting an end element, allowing you to select a range of elements to apply an action against. The :closing_selector only supports the :replace, :remove and :replace_contents actions, and the end element must be a sibling of the first/starting element. Note the CSS general sibling selector (~) is used to match the first element after the opening selector (see below for an example).
 
-* <tt>:sequence</tt> - Used to order the application of an override for a specific virtual path, helpful when an override depends on another override being applied first, supports:
-  * <tt>:sequence => n</tt> - where n is a positive or negative integer (lower numbers get applied first, default 100).
-  * <tt>:sequence => {:before => "*override_name*"}</tt> - where "*override_name*" is the name of an override defined for the 
-                                              same virtual_path, the current override will be appplied before 
+* `:sequence` - Used to order the application of an override for a specific virtual path, helpful when an override depends on another override being applied first, supports:
+  * `:sequence => n` - where n is a positive or negative integer (lower numbers get applied first, default 100).
+  * `:sequence => {:before => "*override_name*"}` - where "*override_name*" is the name of an override defined for the
+                                              same virtual_path, the current override will be appplied before
                                               the named override passed.
-  * <tt>:sequence => {:after => "*override_name*"}</tt> - the current override will be applied after the named override passed.
+  * `:sequence => {:after => "*override_name*"}` - the current override will be applied after the named override passed.
 
-* <tt>:attributes</tt> - A hash containing all the attributes to be set on the matched elements, eg: :attributes => {:class => "green", :title => "some string"}
+* `:attributes` - A hash containing all the attributes to be set on the matched elements, eg: :attributes => {:class => "green", :title => "some string"}
 
 ### Examples
 
 Replaces all instances of `h1` in the `posts/_form.html.erb` partial with `<h1>New Post</h1>`
 
 ```ruby
-Deface::Override.new(:virtual_path => "posts/_form", 
-                     :name => "example-1", 
-                     :replace => "h1", 
+Deface::Override.new(:virtual_path => "posts/_form",
+                     :name => "example-1",
+                     :replace => "h1",
                      :text => "<h1>New Post</h1>")
 ```
 
@@ -146,8 +117,8 @@ end
 Inserts `<%= link_to "List Comments", comments_url(post) %>` before all instances of `p` with css class `comment` in `posts/index.html.erb`
 
 ```ruby
-Deface::Override.new(:virtual_path => "posts/index", 
-                     :name => "example-2", 
+Deface::Override.new(:virtual_path => "posts/index",
+                     :name => "example-2",
                      :insert_before => "p.comment",
                      :text => "<%= link_to 'List Comments', comments_url(post) %>")
 ```
@@ -155,17 +126,17 @@ Deface::Override.new(:virtual_path => "posts/index",
 Inserts the contents of `shared/_comment.html.erb` after all instances of `div` with an id of `comment_21` in `posts/show.html.erb`
 
 ```ruby
-Deface::Override.new(:virtual_path => "posts/show", 
+Deface::Override.new(:virtual_path => "posts/show",
                      :name => "example-3",
-                     :insert_after => "div#comment_21", 
+                     :insert_after => "div#comment_21",
                      :partial => "shared/comment")
 ```
 
 Removes any ERB block containing the string `helper_method` in the `posts/new.html.erb` template, will also log if markup being removed does not exactly match `<%= helper_method %>`
 
 ```ruby
-Deface::Override.new(:virtual_path => "posts/new", 
-                     :name => "example-4", 
+Deface::Override.new(:virtual_path => "posts/new",
+                     :name => "example-4",
                      :remove => "erb[loud]:contains('helper_method')",
                      :original => "<%= helper_method %>")
 ```
@@ -173,13 +144,13 @@ Deface::Override.new(:virtual_path => "posts/new",
 Wraps the `div` with id of `products` in ruby if statement, the <%= render_original %> in the `text` indicates where the matching content should be re-included.
 
 ```ruby
-Deface::Override.new(:virtual_path => "posts/new", 
-                     :name => "example-5", 
+Deface::Override.new(:virtual_path => "posts/new",
+                     :name => "example-5",
                      :surround => "div#products",
                      :text => "<% if @product.present? %><%= render_original %><% end %>")
 ```
 
-Sets (or adds if not present) the `class` and `title` attributes to all instances of `a` with an id of `link` in `posts/index.html.erb` 
+Sets (or adds if not present) the `class` and `title` attributes to all instances of `a` with an id of `link` in `posts/index.html.erb`
 
 ```ruby
 Deface::Override.new(:virtual_path => 'posts/index',
@@ -203,7 +174,7 @@ Deface scopes overrides by virtual_path (or partial / template file), that means
 
 ### Redefining Overrides
 
-You can redefine an existing override by simply declaring a new override with the same <tt>:virtual_path</tt>, <tt>:name</tt> and [action](#action) that was originally used.
+You can redefine an existing override by simply declaring a new override with the same `:virtual_path`, `:name` and [action](#action) that was originally used.
 You do not need to resupply all the values originally used, just the ones you want to change:
 
 ```ruby
@@ -231,8 +202,7 @@ This can also be activated globally for all DSL overrides in your app's `applica
 config.deface.namespaced = true # default is false
 ```
 
-Using the Deface DSL (.deface files)
-------------------------------------
+## Using the Deface DSL (.deface files)
 
 Instead of defining Deface::Override instances directly, you can alternatively add `.deface` files to the `app/overrides` folder and Deface will automatically pick them up.
 The path of each override should match the path of the view template you want to modify, say for example if you have a template at:
@@ -267,7 +237,7 @@ and including haml source:
 You can include all the additional options you can normally use when defining a Deface::Override manually, a more complex example:
 
 ```html
-<!-- replace_contents 'h1' closing_selector 'div#intro' 
+<!-- replace_contents 'h1' closing_selector 'div#intro'
   sequence :before => 'my_other_override'
   disabled -->
 <p>This is a complicated example</p>
@@ -290,21 +260,22 @@ or
 
 #### Namespacing
 
-When using the DSL, overrides automatically take their name from the filename of the file in which they are defined 
-(ie `my_override.html.erb.deface` becomes `my_override`) so overrides with the same filename will replace each other, 
+When using the DSL, overrides automatically take their name from the filename of the file in which they are defined
+(ie `my_override.html.erb.deface` becomes `my_override`) so overrides with the same filename will replace each other,
 even if they are defined in separate engines. If you want to avoid this, you can use the `namespaced` option :
 
 ```erb
 <!-- insert_bottom 'head' namespaced -->
 ```
+
 or activate it globally for all DSL overrides in your app's `application.rb` file:
 
 ```ruby
 config.deface.namespaced = true # default is false
 ```
 
-Each override will then have its name namespaced to the engine in which it was defined 
-(ie `my_override.html.erb.deface` defined in `MyEngine` becomes `my_engine_my_override`), 
+Each override will then have its name namespaced to the engine in which it was defined
+(ie `my_override.html.erb.deface` defined in `MyEngine` becomes `my_engine_my_override`),
 allowing overrides in different engines with identical filenames to co-exist.
 
 ### DSL usage for overrides that do not include markup
@@ -323,29 +294,27 @@ attributes :alt => 'Click here to search'
 ```
 
 
-Rake Tasks
-----------
+## Rake Tasks
 
 Deface includes a couple of rake tasks that can be helpful when defining or debugging overrides.
 
-**deface:get_result** - Will list the original contents of a partial or template, the overrides that have been defined for a that file, and the resulting markup. *get_result* takes a single argument which is the virtual path of the template / partial:
+`rake deface:get_result` - Will list the original contents of a partial or template, the overrides that have been defined for a that file, and the resulting markup. *get_result* takes a single argument which is the virtual path of the template / partial:
 
     rake deface:get_result[shared/_head]
 
     rake deface:get_result['admin/products/index']
 
-**deface:test_selector** - Applies a given CSS selector against a partial or template and outputs the markup for each match (if any). *test_selector* requires two arguments, the first is the virtual_path for the partial / template, the second is the CSS selector to apply:
+`rake deface:test_selector` - Applies a given CSS selector against a partial or template and outputs the markup for each match (if any). *test_selector* requires two arguments, the first is the virtual_path for the partial / template, the second is the CSS selector to apply:
 
     rake deface:test_selector[shared/_head,title]
 
     rake deface:test_selector['admin/products/index','div.toolbar']
 
-**deface:precompile** - Generates compiled views that contain all overrides applied. See `Production & Precompiling` section below for more.
+`rake deface:precompile` - Generates compiled views that contain all overrides applied. See `Production & Precompiling` section below for more.
 
     rake deface:precompile
 
-Production & Precompiling
--------------------------
+## Production & Precompiling
 
 Deface now supports precompiling where all overrides are loaded and applied to the original views and the resulting templates are then saved to your application's `app/compiled_views` directory. To precompile run:
 
@@ -380,19 +349,34 @@ end
 after 'deploy:updated', 'deface:precompile'
 ```
 
+## Upgrading from 0.9 to 1.0
+
+If you are updating from 0.9.x to 1.0.0 or higher, there's a major internal change you should be aware of.
+
+Previously, erb blocks (i.e. <%= some_method %>) were converted as:
+
+```html
+  <code erb-loud> some_method </code>
+```
+They are now converted to:
+
+```html
+  <erb loud> some_method </erb>
+```
+
+This change will affect any Override that uses a selector that matches on `code` or `code[erb-loud]` or `code[erb-silent]` etc, they should be updated to `erb`, `erb[loud]` or `erb[silent]`, etc.
 
-Demo & Testing
---------------
-You can play with Deface and see its parsing in action at [deface.heroku.com](http://deface.heroku.com)
+Note: HAML & SLIM are preconverted to ERB before Deface parsers them, so the same conversions are happening there.
+
+See the [Implementation](#implementation) section below for more details.
 
 
-Implementation
-==============
+# Implementation
 
-Deface temporarily converts ERB files into a pseudo HTML markup that can be parsed and queired by Nokogiri, using the following approach:
+Deface temporarily converts ERB files into a pseudo HTML markup that can be parsed and queried by Nokogiri, using the following approach:
 
 ```erb
-<%= some ruby code %> 
+<%= some ruby code %>
 ```
 
 becomes:
@@ -401,8 +385,8 @@ becomes:
 <erb loud> some ruby code </erb>
 ```
 
-and 
-  
+and
+
 ```erb
 <% other ruby code %>
 ```
@@ -418,7 +402,7 @@ ERB that is contained inside a HTML tag definition is converted slightly differe
 ```erb
 <p id="<%= dom_id @product %>" <%= "style='display:block';" %>>
 ```
-   
+
 becomes:
 
 ```html
@@ -428,8 +412,8 @@ becomes:
 Deface overrides have full access to all variables accessible to the view being customized.
 
 
-Caveats
-======
+# Caveats
+
 Deface uses the amazing Nokogiri library (and in turn libxml) for parsing HTML / view files, in some circumstances either Deface's own pre-parser or libxml's will fail to correctly parse a template. You can avoid such issues by ensuring your templates contain valid HTML. Some other caveats include:
 
 1. Ensure that your layout views include doctype, html, head and body tags in a single file, as Nokogiri will create such elements if it detects any of these tags have been incorrectly nested.

data/Rakefile

@@ -5,8 +5,12 @@ require 'rdoc/task'
 require 'rspec'
 require 'rspec/core/rake_task'
 
+require 'bundler'
+Bundler.require
+Bundler::GemHelper.install_tasks
+
 desc 'Default: run specs'
-task :default => :spec  
+task :default => :spec
 RSpec::Core::RakeTask.new do |t|
   t.pattern = "spec/**/*_spec.rb"
 end

data/bin/sandbox

@@ -26,6 +26,8 @@ fi
 cd ./sandbox
 cat <<RUBY >> Gemfile
 gem '$gem_name', path: '..'
+gem 'haml'
+gem 'slim'
 RUBY
 
 unbundled bundle install --gemfile Gemfile

data/bin/sandbox-setup

@@ -1,24 +1,89 @@
-#!/usr/bin/env bash
-
-bin/rails g scaffold Post title body
-bin/rails db:migrate
-
-mkdir sandbox/app/overrides
-
-echo <<RUBY >> sandbox/app/overrides/sparkling_title.rb
-Deface::Override.new(
-  virtual_path: "posts/show",
-  name: "sparkling_title",
-  replace: 'p:nth-child(2)',
-  text: "<h1>✨<%= @post.title %>✨</h1>"
-)
-
-Deface::Override.new(
-  virtual_path: "posts/show",
-  name: "sparkling_body",
-  replace: 'p:nth-child(3)',
-  text: "<p style='border:2px gray solid; padding: 1rem;'><%= @post.body %></p>"
-)
+#!/usr/bin/env ruby
+
+require 'fileutils'
+extend FileUtils
+
+system 'bin/rails g scaffold Post title body'
+system 'bin/rails db:migrate'
+
+mkdir_p 'sandbox/app/overrides'
+
+File.write 'sandbox/app/views/posts/_haml_partial.html.haml', <<~HAML
+  %h2 hello from haml
+HAML
+
+File.write 'sandbox/app/views/posts/_slim_partial.html.slim', <<~SLIM
+  h2 hello from slim
+SLIM
+
+File.write 'sandbox/app/views/posts/_haml_defaced_partial.html.haml', <<~HAML
+  %h3 hello from defaced haml
+HAML
+
+File.write 'sandbox/app/views/posts/_slim_defaced_partial.html.slim', <<~SLIM
+  h3 hello from defaced slim
+SLIM
+
+File.write 'sandbox/app/overrides/improved_posts.rb', <<~RUBY
+  Deface::Override.new(
+    virtual_path: "posts/show",
+    name: "sparkling_post_title",
+    replace: 'p:nth-child(2)',
+    text: "<h1>✨<%= @post.title %>✨</h1>"
+  )
+
+  Deface::Override.new(
+    virtual_path: "posts/show",
+    name: "modern_style_post_body",
+    replace: 'p:nth-child(3)',
+    text: "<p style='border:2px gray solid; padding: 1rem;'><%= @post.body %></p>"
+  )
+
+  Deface::Override.new(
+    virtual_path: "posts/index",
+    name: "sparkling_posts_title",
+    replace: 'tr td:first-child',
+    text: "<td>✨<%= post.title %>✨</td>"
+  )
+
+  Deface::Override.new(
+    virtual_path: "posts/index",
+    name: "modern_style_post_body",
+    replace: 'tr td:nth-child(2)',
+    text: "<td style='border:2px gray solid; padding: 1rem;'><%= post.body %></d>"
+  )
+
+  Deface::Override.new(
+    virtual_path: "posts/index",
+    name: "haml_and_slim_partials",
+    insert_before: 'table',
+    text: "
+      <header><%= render 'haml_partial' %><%= render 'slim_partial' %></header>
+      <section><%= render 'haml_defaced_partial' %><%= render 'slim_defaced_partial' %></section>
+    "
+  )
+
+  Deface::Override.new(
+    virtual_path: "posts/_haml_defaced_partial",
+    name: "haml_deface",
+    insert_before: 'h3',
+    text: "<h4>HAML subtitle</h4>"
+  )
+
+  Deface::Override.new(
+    virtual_path: "posts/_slim_defaced_partial",
+    name: "slim_deface",
+    insert_before: 'h3',
+    text: "<h4>SLIM subtitle</h4>"
+  )
+RUBY
+
+File.write 'sandbox/config/routes.rb', <<~RUBY
+  Rails.application.routes.draw do
+    resources :posts
+    root to: "posts#index"
+  end
 RUBY
 
-bin/rails runner "Post.create(title: 'Foo', body: 'Bar '*10)"
+system "bin/rails", "runner", "Post.create(title: 'Foo', body: 'Bar '*10)"
+system "bin/rails", "runner", "Post.create(title: 'Baz', body: 'Boz '*10)"

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/deface.gemspec

@@ -30,7 +30,13 @@ Gem::Specification.new do |spec|
   spec.extra_rdoc_files = ["README.markdown"]
 
   spec.add_dependency('nokogiri', '>= 1.6')
-  spec.add_dependency('rails', '>= 5.2')
+
+  %w[
+    actionview
+    railties
+  ].each do |rails_gem|
+    spec.add_dependency(rails_gem, '>= 5.2')
+  end
   spec.add_dependency('rainbow', '>= 2.1.0')
   spec.add_dependency('polyglot')
 
@@ -39,7 +45,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency('gem-release')
   spec.add_development_dependency('rspec', '>= 3.1.0')
   spec.add_development_dependency('haml', ['>= 4.0', '< 6'])
-  spec.add_development_dependency('slim', '~> 3.0')
+  spec.add_development_dependency('slim', '~> 4.1')
   spec.add_development_dependency('simplecov', '>= 0.6.4')
   spec.add_development_dependency('generator_spec', '~> 0.8')
   spec.add_development_dependency('pry')

data/gemfiles/rails_5.2.gemfile

@@ -2,7 +2,8 @@
 
 source "https://rubygems.org"
 
-gem "rails", "~> 5.2.0"
+gem "actionview", "~> 5.2.0"
+gem "railties", "~> 5.2.0"
 
 group :test do
   gem "test-unit"

data/gemfiles/rails_6.0.gemfile

@@ -2,7 +2,8 @@
 
 source "https://rubygems.org"
 
-gem "rails", "~> 6.0.0"
+gem "actionview", "~> 6.0.0"
+gem "railties", "~> 6.0.0"
 
 group :test do
   gem "test-unit"

data/gemfiles/rails_6.1.gemfile

@@ -0,0 +1,14 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "actionview", "~> 6.1.0"
+gem "railties", "~> 6.1.0"
+
+group :test do
+  gem "test-unit"
+  gem "pry"
+  gem "pry-byebug"
+end
+
+gemspec path: "../"

data/gemfiles/rails_6_1.gemfile

@@ -2,7 +2,12 @@
 
 source "https://rubygems.org"
 
-gem "rails", "~> 6.1.0"
+%w[
+  actionview
+  railties
+].each do |rails_gem|
+  gem rails_gem, "~> 6.1.0"
+end
 
 group :test do
   gem "test-unit"

data/lib/deface/action_view_extensions.rb

@@ -14,46 +14,56 @@ module Deface::ActionViewExtensions
   end
 
   module DefacedTemplate
-    def initialize(source, identifier, handler, details)
-      syntax = Deface::ActionViewExtensions.determine_syntax(handler)
+    def encode!
+      return super unless Rails.application.config.deface.enabled
 
-      if syntax
-        processed_source = Deface::Override.apply(source.to_param, details, true, syntax)
+      # Before Rails 6 encode! returns nil
+      source = Deface.before_rails_6? ? (super; @source) : super
+      syntax = Deface::ActionViewExtensions.determine_syntax(@handler)
+      overrides = Deface::Override.find(
+        locals: @locals,
+        format: @format,
+        variant: @variant,
+        virtual_path: @virtual_path,
+      )
 
-        # force change in handler before continuing to original Rails method
-        # as we've just converted some other template language into ERB!
-        #
-        if [:slim, :haml].include?(syntax) && processed_source != source.to_param
-          handler = ActionView::Template::Handlers::ERB
+      if syntax && overrides.any?
+        # Prevents any caching by rails in development mode.
+        @updated_at = Time.now if Deface.before_rails_6?
+        @handler = ActionView::Template::Handlers::ERB
+
+        # Modify the existing string instead of returning a copy
+        new_source = Deface::Override.apply_overrides(
+          Deface::Override.convert_source(source, syntax: syntax),
+          overrides: overrides
+        )
+
+        if Deface.before_rails_6?
+          @source.replace new_source
+        else
+          source.replace new_source
         end
-      else
-        processed_source = source.to_param
       end
 
-      super(processed_source, identifier, handler, **details)
+      source
     end
 
-    # refresh view to get source again if
-    # view needs to be recompiled
-    #
-    def render(view, locals, buffer=nil, &block)
-      mod = view.is_a?(Deface.template_class) ? Deface.template_class : view.singleton_class
+    private
 
-      if @compiled && !mod.instance_methods.include?(method_name.to_sym)
-        @compiled = false
-        @source = refresh(view).source if respond_to?(:refresh)
-      end
-      buffer.nil? ? super(view, locals, buffer, &block) : super(view, locals, **buffer, &block)
-    end
+    def compile!(view)
+      return super unless Rails.application.config.deface.enabled
 
-    # inject deface hash into compiled view method name
-    # used to determine if recompilation is needed
-    #
-    def method_name
-      deface_hash = Deface::Override.digest(:virtual_path => @virtual_path)
+      @compile_mutex.synchronize do
+        current_deface_hash = Deface::Override.digest(virtual_path: @virtual_path)
+        @deface_hash = current_deface_hash if @deface_hash.nil?
 
-      #we digest the whole method name as if it gets too long there's problems
-      "_#{Deface::Digest.hexdigest("#{deface_hash}_#{super}")}"
+        if @deface_hash != current_deface_hash
+          @compiled = nil
+          @deface_hash = current_deface_hash
+        end
+      end
+
+      super
     end
 
     ActionView::Template.prepend self

data/lib/deface/applicator.rb

@@ -6,58 +6,70 @@ module Deface
       def apply(source, details, log=true, syntax=:erb)
         overrides = find(details)
 
-        if log && overrides.size > 0
-          Rails.logger.debug "\e[1;32mDeface:\e[0m #{overrides.size} overrides found for '#{details[:virtual_path]}'"
-        end
+        return source if overrides.empty?
 
-        unless overrides.empty?
-          case syntax
-          when :haml
-            #convert haml to erb before parsing before
-            source = Deface::HamlConverter.new(source.to_param).result
-          when :slim
-            source = Deface::SlimConverter.new(source.to_param).result
-          end
+        Rails.logger.debug "\e[1;32mDeface:\e[0m #{overrides.size} overrides found for '#{details[:virtual_path]}'" if log
 
-          doc = Deface::Parser.convert(source)
+        apply_overrides(
+          convert_source(source, syntax: syntax),
+          overrides: overrides,
+          log: log
+        )
+      end
 
-          overrides.each do |override|
-            if override.disabled?
-              Rails.logger.debug("\e[1;32mDeface:\e[0m '#{override.name}' is disabled") if log
-              next
-            end
+      # applies specified overrides to given source
+      def apply_overrides(source, overrides:, log: true)
 
-            override.parsed_document = doc
-            matches = override.matcher.matches(doc, log)
+        doc = Deface::Parser.convert(source)
 
-            if log
-              Rails.logger.send(matches.size == 0 ? :error : :debug, "\e[1;32mDeface:\e[0m '#{override.name}' matched #{matches.size} times with '#{override.selector}'")
+        overrides.each do |override|
+          if override.disabled?
+            Rails.logger.debug("\e[1;32mDeface:\e[0m '#{override.name}' is disabled") if log
+            next
+          end
 
-              # temporarily check and notify on use of old selector styles.
-              #
-              if matches.empty? && override.selector.match(/code|erb-loud|erb-silent/)
-                Rails.logger.error "\e[1;32mDeface: [WARNING]\e[0m Override '#{override.name}' may be using an invalid selector of '#{override.selector}', <code erb-loud|silent> tags are now <erb loud|silent>"
-              end
-            end
+          override.parsed_document = doc
+          matches = override.matcher.matches(doc, log)
+
+          if log
+            Rails.logger.send(matches.size == 0 ? :error : :debug, "\e[1;32mDeface:\e[0m '#{override.name}' matched #{matches.size} times with '#{override.selector}'")
 
-            if matches.empty?
-              override.failure = "failed to match :#{override.action} selector '#{override.selector}'"
-            else
-              override.failure = nil
-              matches.each {|match| override.execute_action match }
+            # temporarily check and notify on use of old selector styles.
+            #
+            if matches.empty? && override.selector.match(/code|erb-loud|erb-silent/)
+              Rails.logger.error "\e[1;32mDeface: [WARNING]\e[0m Override '#{override.name}' may be using an invalid selector of '#{override.selector}', <code erb-loud|silent> tags are now <erb loud|silent>"
             end
           end
 
-          # Prevents any caching by rails in development mode.
-          details[:updated_at] = Time.now if Deface.before_rails_6?
+          if matches.empty?
+            override.failure = "failed to match :#{override.action} selector '#{override.selector}'"
+          else
+            override.failure = nil
+            matches.each {|match| override.execute_action match }
+          end
+        end
 
-          source = doc.to_s
+        source = doc.to_s
 
-          Deface::Parser.undo_erb_markup!(source)
-        end
+        Deface::Parser.undo_erb_markup!(source)
 
         source
       end
+
+      # converts the source to a supported syntax (ERB)
+      def convert_source(source, syntax:)
+        # convert haml/slim to erb before parsing before
+        case syntax
+        when :erb
+          source
+        when :haml
+          Deface::HamlConverter.new(source.to_s).result
+        when :slim
+          Deface::SlimConverter.new(source.to_s).result
+        else
+          raise "unsupported syntax: #{syntax}"
+        end
+      end
     end
 
     def execute_action(target_element)

data/lib/deface/template_helper.rb

@@ -1,32 +1,58 @@
 module Deface
   module TemplateHelper
+    def self.lookup_context
+      @lookup_context ||= ActionView::LookupContext.new(
+        ActionController::Base.view_paths, {:formats => [:html]}
+      )
+    end
 
     # used to find source for a partial or template using virtual_path
-    def load_template_source(virtual_path, partial, apply_overrides=true)
+    def load_template_source(virtual_path, partial, apply_overrides=true, lookup_context: Deface::TemplateHelper.lookup_context)
       parts = virtual_path.split("/")
-      prefix = []
+
       if parts.size == 2
-        prefix << ""
+        prefix = ""
         name = virtual_path
       else
-        prefix << parts.shift
+        prefix = parts.shift
         name = parts.join("/")
       end
 
-      #this needs to be reviewed for production mode, overrides not present
-      Rails.application.config.deface.enabled = apply_overrides
-      @lookup_context ||= ActionView::LookupContext.new(ActionController::Base.view_paths, {:formats => [:html]})
-      view = @lookup_context.disable_cache do
-        @lookup_context.find(name, prefix, partial)
-      end
+      view = lookup_context.disable_cache { lookup_context.find(name, [prefix], partial) }
 
-      if view.handler.to_s == "Haml::Plugin"
-        Deface::HamlConverter.new(view.source).result
-      elsif view.handler.class.to_s == "Slim::RailsTemplate"
-        Deface::SlimConverter.new(view.source).result
-      else
-        view.source
+      source =
+        if view.handler.to_s == "Haml::Plugin"
+          Deface::HamlConverter.new(view.source).result
+        elsif view.handler.class.to_s == "Slim::RailsTemplate"
+          Deface::SlimConverter.new(view.source).result
+        else
+          view.source
+        end
+
+      if apply_overrides
+        begin
+          # This needs to be reviewed for production mode, overrides not present
+          original_enabled = Rails.application.config.deface.enabled
+          Rails.application.config.deface.enabled = apply_overrides
+
+          syntax = Deface::ActionViewExtensions.determine_syntax(view.handler)
+          overrides = Deface::Override.find(
+            locals: view.instance_variable_get(:@locals),
+            format: view.instance_variable_get(:@format),
+            variant: view.instance_variable_get(:@variant),
+            virtual_path: view.instance_variable_get(:@virtual_path),
+          )
+
+          if syntax && overrides.any?
+            source = Deface::Override.convert_source(source, syntax: syntax)
+            source = Deface::Override.apply_overrides(source, overrides: overrides)
+          end
+        ensure
+          Rails.application.config.deface.enabled = original_enabled
+        end
       end
+
+      source
     end
 
     #gets source erb for an element

data/lib/deface/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Deface
-  VERSION = '1.6.2'
+  VERSION = '1.8.2'
 
   def gem_version
     Gem::Version.new(VERSION)

data/spec/deface/action_view_template_spec.rb

@@ -3,8 +3,12 @@ require 'spec_helper'
 describe Deface::ActionViewExtensions do
   include_context "mock Rails.application"
 
-  before supports_updated_at: true do
-    skip "Current Rails doesn't support the updated_at attribute on ActionView" unless supports_updated_at?
+  before after_rails_6: true do
+    skip "This spec is targeted at Rails v6+" if Deface.before_rails_6?
+  end
+
+  before before_rails_6: true do
+    skip "This spec is targeted at Rails before v6+" unless Deface.before_rails_6?
   end
 
   let(:template) { ActionView::Template.new(
@@ -12,7 +16,7 @@ describe Deface::ActionViewExtensions do
     path,
     handler,
     **options,
-    **(supports_updated_at? ? {updated_at: updated_at} : {})
+    **(Deface.before_rails_6? ? {updated_at: updated_at} : {})
   ) }
 
   let(:source) { "<p>test</p>" }
@@ -26,7 +30,6 @@ describe Deface::ActionViewExtensions do
   let(:format) { :html }
   let(:virtual_path) { "posts/index" }
 
-  let(:supports_updated_at?) { Deface.before_rails_6? }
   let(:updated_at) { Time.now - 600 }
 
   describe "with no overrides defined" do
@@ -38,46 +41,12 @@ describe Deface::ActionViewExtensions do
       expect(template.source).to eq("<p>test</p>")
     end
 
-    it "should not change updated_at", :supports_updated_at do
+    it "should not change updated_at", :before_rails_6 do
       expect(template.updated_at).to eq(updated_at)
     end
   end
 
-  describe "with a single remove override defined" do
-    let(:updated_at) { Time.now - 300 }
-    let(:source) { "<p>test</p><%= raw(text) %>" }
-
-    before do
-      Deface::Override.new(virtual_path: "posts/index", name: "Posts#index", remove: "p", text: "<h1>Argh!</h1>")
-    end
-
-    it "should return modified source" do
-      expect(template.source).to eq("<%= raw(text) %>")
-    end
-
-    it "should change updated_at", :supports_updated_at do
-      expect(template.updated_at).to be > updated_at
-    end
-  end
-
-  describe "#method_name" do
-    before do
-      ActionView::Template.define_method(
-        :method_name_without_deface,
-        ActionView::Template.instance_method(:method_name)
-      )
-    end
-
-    it "returns hash of overrides plus original method_name " do
-      deface_hash = Deface::Override.digest(virtual_path: 'posts/index')
-      super_method = template.method(:method_name).super_method
-      method_name = "_#{Digest::MD5.new.update("#{deface_hash}_#{super_method.call}").hexdigest}"
-
-      expect(template.send(:method_name)).to eq(method_name)
-    end
-  end
-
-  describe "non erb or haml template" do
+  describe "unsupported template" do
     let(:source) { "xml.post => :blah" }
     let(:path) { "/some/path/to/file.erb" }
     let(:handler) { ActionView::Template::Handlers::Builder }
@@ -130,17 +99,55 @@ describe Deface::ActionViewExtensions do
       locals: local_assigns.keys
     } }
 
-    let!(:deface) {
+    it 'renders the template modified by deface using :replace' do
       Deface::Override.new(
         virtual_path: virtual_path,
         name: "Posts#index",
         replace: "p",
         text: "<h1>Argh!</h1>"
       )
-    }
 
-    it 'renders the template modified by deface' do
       expect(template.render(view, local_assigns)).to eq(%{"<h1>Argh!</h1>some <br> text"})
     end
+
+    it 'renders the template modified by deface using :remove' do
+      Deface::Override.new(
+        virtual_path: virtual_path,
+        name: "Posts#index",
+        remove: "p",
+      )
+
+      expect(template.render(view, local_assigns)).to eq(%{"some <br> text"})
+    end
+
+    context 'with a haml template' do
+      let(:source) { "%p test\n= raw(text)\n" }
+      let(:handler) { Haml::Plugin }
+
+      it 'renders the template modified by deface using :remove' do
+        Deface::Override.new(
+          virtual_path: virtual_path,
+          name: "Posts#index",
+          remove: "p",
+        )
+
+        expect(template.render(view, local_assigns)).to eq(%{\nsome <br> text})
+      end
+    end
+
+    context 'with a slim template' do
+      let(:source) { "p test\n= raw(text)\n" }
+      let(:handler) { Slim::RailsTemplate.new }
+
+      it 'renders the template modified by deface using :remove' do
+        Deface::Override.new(
+          virtual_path: virtual_path,
+          name: "Posts#index",
+          remove: "p",
+        )
+
+        expect(template.render(view, local_assigns)).to eq(%{\nsome <br> text\n})
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deface
 version: !ruby/object:Gem::Version
-  version: 1.6.2
+  version: 1.8.2
 platform: ruby
 authors:
 - Brian D Quinn
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-02-10 00:00:00.000000000 Z
+date: 2022-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -25,7 +25,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.6'
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: actionview
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -148,14 +162,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.1'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -206,11 +220,13 @@ extensions: []
 extra_rdoc_files:
 - README.markdown
 files:
+- ".github/dependabot.yml"
+- ".github/workflows/main.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - Appraisals
 - CHANGELOG.markdown
+- CONTRIBUTING.md
 - Gemfile
 - MIT-LICENSE
 - README.markdown
@@ -220,9 +236,11 @@ files:
 - bin/rails-sandbox
 - bin/sandbox
 - bin/sandbox-setup
+- bin/setup
 - deface.gemspec
 - gemfiles/rails_5.2.gemfile
 - gemfiles/rails_6.0.gemfile
+- gemfiles/rails_6.1.gemfile
 - gemfiles/rails_6_1.gemfile
 - lib/deface.rb
 - lib/deface/action_view_extensions.rb
@@ -340,7 +358,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
 summary: Deface is a library that allows you to customize ERB, Haml and Slim views

data/.travis.yml

@@ -1,26 +0,0 @@
-script: "bundle exec rake"
-
-cache:
-  bundler: true
-
-rvm:
-  - 2.5.8
-  - 2.6.6
-  - 2.7.2
-  - 3.0.0
-
-gemfile:
-  - gemfiles/rails_5.2.gemfile
-  - gemfiles/rails_6.0.gemfile
-  - gemfiles/rails_6_1.gemfile
-
-matrix:
-  exclude:
-  - rvm: 2.6.6
-    gemfile: gemfiles/rails_5.2.gemfile
-  - rvm: 2.7.2
-    gemfile: gemfiles/rails_5.2.gemfile
-  - rvm: 3.0.0
-    gemfile: gemfiles/rails_5.2.gemfile
-  - rvm: 3.0.0
-    gemfile: gemfiles/rails_6.0.gemfile