deface 1.7.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7beeaa21dc8761d6d24072002e6c90c5f7e08f283e603b8404e0b4003e68e557
-  data.tar.gz: 35b96c7138f0c3c5309e35d030bdd758d8c5d9f856924805d5004e5925134423
+  metadata.gz: 9060884c364b0a4472ddfc9bc76ddc213c67dbe6565eb62592facd1ab6b52183
+  data.tar.gz: dd5c46b0211214d0f2dd703bc5c5fe6f8dc880179050154414ac4ca83b11aa66
 SHA512:
-  metadata.gz: 6e21f73d0d80ae1806cfa6e6ec0244f38f281b87c398a0606a12debb566bdd20458627cbfad341df85a8c72b8c7b16d83bdeec3b36cac071112c07612ef60d75
-  data.tar.gz: 2dac481cd10a35a8d3916af3fbaff0f155f9a7ca9828be454a39fa1c9a4f6c25bf8946a05b7274f1df7025476314cea113be50ffd8a948184bd4ca13619c5022
+  metadata.gz: 11be9726027369b1cdf3aee30d33f5919c9027a900f594569fc001eea61a5f510c714a17b450bbee10da95911dda1c7eb9f9d68adebc54c7461009103d66fd7d
+  data.tar.gz: 349650343bac57b3dbd94033f8cc65c237e1931d857a64e4a415cba6acfd7a03e19f9ef0a8998edd70179566464f573b4d69d3cba01f4d39b0bc072540971748

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

@@ -8,6 +8,22 @@ 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",
@@ -36,6 +52,30 @@ File.write 'sandbox/app/overrides/improved_posts.rb', <<~RUBY
     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

data/lib/deface/action_view_extensions.rb

@@ -19,23 +19,27 @@ module Deface::ActionViewExtensions
 
       # 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,
+      )
+
+      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
 
-      if (syntax = Deface::ActionViewExtensions.determine_syntax(@handler))
         # Modify the existing string instead of returning a copy
-        source.replace Deface::Override.apply(
-          source, {
-            locals: @locals,
-            format: @format,
-            variant: @variant,
-            virtual_path: @virtual_path,
-          },
-          true,
-          syntax
+        @source.replace Deface::Override.apply_overrides(
+          Deface::Override.convert_source(source, syntax: syntax),
+          overrides: overrides
         )
-        @handler = ActionView::Template::Handlers::ERB
       end
 
-      source
+      @source
     end
 
     private

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

@@ -35,14 +35,17 @@ module Deface
           original_enabled = Rails.application.config.deface.enabled
           Rails.application.config.deface.enabled = apply_overrides
 
-          if (syntax = Deface::ActionViewExtensions.determine_syntax(view.handler))
-            details = {
-              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),
-            }
-            source = Deface::Override.apply(source, details, true, syntax)
+          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

data/lib/deface/version.rb

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

data/spec/deface/action_view_template_spec.rb

@@ -46,7 +46,7 @@ describe Deface::ActionViewExtensions do
     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 }
@@ -119,5 +119,35 @@ describe Deface::ActionViewExtensions do
 
       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.7.0
+  version: 1.8.0
 platform: ruby
 authors:
 - Brian D Quinn
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-02-19 00:00:00.000000000 Z
+date: 2021-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri