deface 1.6.2 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d70515c1f6f72cef4d6b7d34d936e5fac929ddda6a896cbd9c0c30dddff8c19e
-  data.tar.gz: e6950eb7f793b4111513744ddb48d7ad7a83a918a1f9b8850619b41c7864f515
+  metadata.gz: 7beeaa21dc8761d6d24072002e6c90c5f7e08f283e603b8404e0b4003e68e557
+  data.tar.gz: 35b96c7138f0c3c5309e35d030bdd758d8c5d9f856924805d5004e5925134423
 SHA512:
-  metadata.gz: fd12b650a9104d57bc0b17c7a88324ff77008516e0fa789724f0622f59b26160050ac1eafa9dc42c73b51a93942ccb9c45902761e629f525fd32685a62afbdc9
-  data.tar.gz: 4924e7dfd0a97adf3acebe4f4f15c5d3146e64aea5f75b9d64c0ac5746f9320678988d23af84b196ef30a2e8f1e4f1e8e37d546a5bad676fb12c6fecfc63e596
+  metadata.gz: 6e21f73d0d80ae1806cfa6e6ec0244f38f281b87c398a0606a12debb566bdd20458627cbfad341df85a8c72b8c7b16d83bdeec3b36cac071112c07612ef60d75
+  data.tar.gz: 2dac481cd10a35a8d3916af3fbaff0f155f9a7ca9828be454a39fa1c9a4f6c25bf8946a05b7274f1df7025476314cea113be50ffd8a948184bd4ca13619c5022

data/bin/sandbox-setup

@@ -1,24 +1,49 @@
-#!/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/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>"
+  )
+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/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,46 @@ 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
 
-        # 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
-        end
-      else
-        processed_source = source.to_param
+      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
+        )
+        @handler = ActionView::Template::Handlers::ERB
       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/template_helper.rb

@@ -1,32 +1,55 @@
 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
+
+          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)
+          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.7.0'
 
   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,45 +41,11 @@ 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
     let(:source) { "xml.post => :blah" }
     let(:path) { "/some/path/to/file.erb" }
@@ -130,17 +99,25 @@ 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
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deface
 version: !ruby/object:Gem::Version
-  version: 1.6.2
+  version: 1.7.0
 platform: ruby
 authors:
 - Brian D Quinn
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-02-10 00:00:00.000000000 Z
+date: 2021-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -223,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
@@ -340,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