deface 1.6.0 → 1.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e130d9b889669220392d0fa6fe04ba7cd39604bf8b12edff68308b89d6f3f5f6
-  data.tar.gz: 997c7d4cc5d95a5a5168e70c9da588a9c56b7b67a404b0e4ffaf0410a06426b6
+  metadata.gz: 13f8d0d00b60a47809b55b1c260da178bf2ab6c4087a73b154b1d4e2abe4e51a
+  data.tar.gz: 44b725c4108968143fb985c15ce297666076b7093b29c97d0cf4f546ac5a9f23
 SHA512:
-  metadata.gz: 800d393fb3a99206dd0b7922e094458b806e114ab244c8229d37a392affa0faec9455caa85fdba554ece13c95c70064fc663a1644c41cb1b48d693aa35293a56
-  data.tar.gz: 713aaca8fa816ba00f9d66ac8b39596b4818099aff3aa533aa2301d56f1ccd6a15b650477b5621ca669a45b6c949b8f1699fbad4b1a7f339bc7e9ae32f460a8d
+  metadata.gz: 24e344680c4d7a72b1e1e10c8dc1c1e60bf2fb8234037ca95f361b67827307f6e3f4fd932168aa0c559d2015387b442cc0eee349cc792eeaa4f4970907cc7037
+  data.tar.gz: ae4600922bdd43fbfc3db5fec9f75bfa33bef4bca005130f6f13824deec82e1bfb1a9152c53eaf2893e36406e430c27c0487e79618d37719db1dcc3d9dc07f07

data/.gitignore

@@ -7,3 +7,4 @@ coverage/
 gemfiles/*.lock
 /.idea
 /sandbox
+*.gem

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/deface.gemspec

@@ -36,6 +36,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency('appraisal')
   spec.add_development_dependency('erubis')
+  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')

data/gemfiles/rails_6.1.gemfile

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

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
-      end
-      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,5 +1,9 @@
 # frozen_string_literal: true
 
 module Deface
-  VERSION = "1.6.0"
+  VERSION = '1.8.1'
+
+  def gem_version
+    Gem::Version.new(VERSION)
+  end
 end

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.0
+  version: 1.8.1
 platform: ruby
 authors:
 - Brian D Quinn
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-01-16 00:00:00.000000000 Z
+date: 2021-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -94,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: gem-release
+  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
@@ -209,6 +223,7 @@ files:
 - 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
@@ -326,7 +341,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: Deface is a library that allows you to customize ERB, Haml and Slim views