deface 1.5.3 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6fdcb87226be6d4fc38d8b056826594fc3ceb74d9234efcd398817f39121e5a
-  data.tar.gz: 7183351e3cd1fe93e4f0d7321e5dbf78f42d9104b465ada920d352d05ebe88b9
+  metadata.gz: e130d9b889669220392d0fa6fe04ba7cd39604bf8b12edff68308b89d6f3f5f6
+  data.tar.gz: 997c7d4cc5d95a5a5168e70c9da588a9c56b7b67a404b0e4ffaf0410a06426b6
 SHA512:
-  metadata.gz: 828dd08f7d102616db1786851f3e3d9c68aac40a3bc4a2bb04b384d8638e6d38eec98ee76cc5c25d513feb649ea43ff9ad68897b7cb26e2c30fdbcc438d11cd9
-  data.tar.gz: cd2f685fd6ad04b559fafadfda375f6f5d58c480db307f34b0d2dddef062d02369f1ed3c8d2dd3f5d7f2a643fe33235291dd55f538a04f1119735eb46e71cbad
+  metadata.gz: 800d393fb3a99206dd0b7922e094458b806e114ab244c8229d37a392affa0faec9455caa85fdba554ece13c95c70064fc663a1644c41cb1b48d693aa35293a56
+  data.tar.gz: 713aaca8fa816ba00f9d66ac8b39596b4818099aff3aa533aa2301d56f1ccd6a15b650477b5621ca669a45b6c949b8f1699fbad4b1a7f339bc7e9ae32f460a8d

data/.gitignore

@@ -6,3 +6,4 @@ coverage/
 .bundle/
 gemfiles/*.lock
 /.idea
+/sandbox

data/.travis.yml

@@ -1,27 +1,26 @@
 script: "bundle exec rake"
 
-before_install:
-  - gem uninstall -v '>= 2' -i $(rvm gemdir)@global -ax bundler || true
-  - gem install bundler -v '< 2'
+cache:
+  bundler: true
 
 rvm:
-  - 2.3.7
-  - 2.4.4
-  - 2.5.1
+  - 2.5.8
+  - 2.6.6
+  - 2.7.2
+  - 3.0.0
+
 gemfile:
-  - gemfiles/rails_4.2.gemfile
-  - gemfiles/rails_5.0.gemfile
-  - gemfiles/rails_5.1.gemfile
   - gemfiles/rails_5.2.gemfile
   - gemfiles/rails_6.0.gemfile
-notifications:
-  email:
-    - brian@spreecommerce.com
-    - ryan@spreecommerce.com
+  - gemfiles/rails_6_1.gemfile
 
 matrix:
   exclude:
-  - rvm: 2.3.7
-    gemfile: gemfiles/rails_6.0.gemfile
-  - rvm: 2.4.4
+  - 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

data/Appraisals

@@ -1,19 +1,11 @@
-appraise 'rails-4.2' do
-  gem 'rails', '~> 4.2.0'
-end
-
-appraise 'rails-5.0' do
-  gem 'rails', '~> 5.0.0'
-end
-
-appraise 'rails-5.1' do
-  gem 'rails', '~> 5.1.0'
-end
-
 appraise 'rails-5.2' do
   gem 'rails', '~> 5.2.0'
 end
 
 appraise 'rails-6.0' do
-  gem 'rails', '~> 6.0.0.beta3'
+  gem 'rails', '~> 6.0.0'
+end
+
+appraise 'rails-6.1' do
+  gem 'rails', '~> 6.1.0'
 end

data/CHANGELOG.markdown

@@ -1,4 +1 @@
-## 1.0.0.rc4 (2013-09-04)
-
-* [BREAKING CHANGE] ERB blocks are no longer converted into <code erb-loud|erb-silent>, now they are <erb loud|silent> [jhawthorn]
-* Lots of other changes too numerous to list here in the first changelog entry, will get better going forward :)
+*See https://github.com/spree/deface/releases*

data/README.markdown

@@ -295,7 +295,7 @@ When using the DSL, overrides automatically take their name from the filename of
 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-->
+<!-- insert_bottom 'head' namespaced -->
 ```
 or activate it globally for all DSL overrides in your app's `application.rb` file:
 

data/bin/rails

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+if %w[e engine].include? ARGV.first
+  ARGV.shift # remove the first argument
+  exec "#{__dir__}/rails-engine", *ARGV
+else
+  exec "#{__dir__}/rails-sandbox", *ARGV
+end

data/bin/rails-engine

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails gems
+# installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('..', __dir__)
+ENGINE_PATH = File.expand_path('../lib/solidus_paypal_commerce_platform/engine', __dir__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require 'rails/all'
+require 'rails/engine/commands'

data/bin/rails-sandbox

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+app_root = 'sandbox'
+
+unless File.exist? "#{app_root}/bin/rails"
+  warn 'Creating the sandbox app...'
+  Dir.chdir "#{__dir__}/.." do
+    system "#{__dir__}/sandbox" or begin # rubocop:disable Style/AndOr
+      warn 'Automatic creation of the sandbox app failed'
+      exit 1
+    end
+  end
+end
+
+Dir.chdir app_root
+exec 'bin/rails', *ARGV

data/bin/sandbox

@@ -0,0 +1,40 @@
+#!/usr/bin/env bash
+
+gem_name="$(ruby -rpathname -e"puts Pathname(ARGV.first).join('../..').expand_path.glob('*.gemspec').first.basename('.gemspec')" -- $0)"
+
+# Stay away from the bundler env of the containing extension.
+function unbundled {
+  ruby -rbundler -e'b = proc {system *ARGV}; Bundler.respond_to?(:with_unbundled_env) ? Bundler.with_unbundled_env(&b) : Bundler.with_clean_env(&b)' -- $@
+}
+
+rm -rf ./sandbox
+unbundled bundle exec rails new sandbox \
+  --skip-bundle \
+  --skip-git \
+  --skip-javascript \
+  --skip-keeps \
+  --skip-rc \
+  --skip-spring \
+  --skip-test \
+  $@
+
+if [ ! -d "sandbox" ]; then
+  echo 'sandbox rails application failed'
+  exit 1
+fi
+
+cd ./sandbox
+cat <<RUBY >> Gemfile
+gem '$gem_name', path: '..'
+RUBY
+
+unbundled bundle install --gemfile Gemfile
+
+unbundled bundle exec rake db:drop db:create
+
+cd .. # Back to the project root.
+bin/sandbox-setup # Run any custom setup.
+
+echo
+echo "🚀 Sandbox app successfully created for $gem_name!"
+

data/bin/sandbox-setup

@@ -0,0 +1,24 @@
+#!/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>"
+)
+RUBY
+
+bin/rails runner "Post.create(title: 'Foo', body: 'Bar '*10)"

data/deface.gemspec

@@ -1,30 +1,45 @@
-Gem::Specification.new do |s|
-  s.name = "deface"
-  s.version = "1.5.3"
-
-  s.authors = ["Brian D Quinn"]
-  s.description = "Deface is a library that allows you to customize ERB, Haml and Slim views in a Rails application without editing the underlying view."
-  s.email = "brian@spreecommerce.com"
-  s.extra_rdoc_files = [
-    "README.markdown", "CHANGELOG.markdown"
-  ]
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.homepage = "https://github.com/spree/deface"
-  s.rdoc_options = ["--charset=UTF-8"]
-  s.require_paths = ["lib"]
-  s.summary = "Deface is a library that allows you to customize ERB, Haml and Slim views in Rails"
-
-  s.add_dependency('nokogiri', '>= 1.6')
-  s.add_dependency('rails', '>= 4.1')
-  s.add_dependency('rainbow', '>= 2.1.0')
-  s.add_dependency('polyglot')
-
-  s.add_development_dependency('appraisal')
-  s.add_development_dependency('erubis')
-  s.add_development_dependency('rspec', '>= 3.1.0')
-  s.add_development_dependency('haml', ['>= 4.0', '< 6'])
-  s.add_development_dependency('slim', '~> 3.0')
-  s.add_development_dependency('simplecov', '>= 0.6.4')
-  s.add_development_dependency('generator_spec', '~> 0.8')
+require_relative 'lib/deface/version'
+
+Gem::Specification.new do |spec|
+  spec.name = "deface"
+  spec.version = Deface::VERSION
+  spec.authors = ["Brian D Quinn"]
+  spec.email = "brian@spreecommerce.com"
+
+  spec.summary = "Deface is a library that allows you to customize ERB, Haml and Slim views in Rails"
+  spec.description = "Deface is a library that allows you to customize ERB, Haml and Slim views in a Rails application without editing the underlying view."
+  spec.homepage = "https://github.com/spree/deface#readme"
+  spec.license = "MIT"
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/spree/deface'
+  spec.metadata['changelog_uri'] = 'https://github.com/spree/deface/releases'
+
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  files = Dir.chdir(__dir__) { `git ls-files -z`.split("\x0") }
+
+  spec.files = files.grep_v(%r{^(test|spec|features)/})
+  spec.test_files = files.grep(%r{^(test|spec|features)/})
+  spec.bindir = "exe"
+  spec.executables = files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.rdoc_options = ["--charset=UTF-8"]
+  spec.extra_rdoc_files = ["README.markdown"]
+
+  spec.add_dependency('nokogiri', '>= 1.6')
+  spec.add_dependency('rails', '>= 5.2')
+  spec.add_dependency('rainbow', '>= 2.1.0')
+  spec.add_dependency('polyglot')
+
+  spec.add_development_dependency('appraisal')
+  spec.add_development_dependency('erubis')
+  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('simplecov', '>= 0.6.4')
+  spec.add_development_dependency('generator_spec', '~> 0.8')
+  spec.add_development_dependency('pry')
 end

data/gemfiles/rails_6.0.gemfile

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

data/gemfiles/{rails_4.2.gemfile → rails_6_1.gemfile}

@@ -2,7 +2,7 @@
 
 source "https://rubygems.org"
 
-gem "rails", "~> 4.2.0"
+gem "rails", "~> 6.1.0"
 
 group :test do
   gem "test-unit"

data/lib/deface.rb

@@ -1,5 +1,6 @@
 require "action_view"
 require "action_controller"
+require "deface/errors"
 require "deface/template_helper"
 require "deface/original_validator"
 require "deface/applicator"
@@ -38,18 +39,21 @@ require "deface/matchers/range"
 require "deface/environment"
 require "deface/precompiler"
 
+require "deface/railtie" if defined?(Rails)
+
 module Deface
-  if defined?(Rails)
-    require "deface/railtie"
+  @before_rails_6 = ActionView.gem_version < Gem::Version.new('6.0.0')
+  @template_class = @before_rails_6 ? ActionView::CompiledTemplates : ActionDispatch::DebugView
+
+  def self.before_rails_6?
+    @before_rails_6
+  end
+
+  def self.template_class
+    @template_class
   end
 
   if defined?(ActiveSupport::Digest)
     Deface::Digest.digest_class = ActiveSupport::Digest
   end
-
-  # Exceptions
-  class DefaceError < StandardError; end
-
-  class NotSupportedError < DefaceError; end
-
 end

data/lib/deface/action_view_extensions.rb

@@ -1,51 +1,50 @@
-ActionView::Template.class_eval do
-  alias_method :initialize_without_deface, :initialize
-
-  def initialize(source, identifier, handler, details)
-    syntax = determine_syntax(handler)
-
-    if Rails.application.config.deface.enabled && should_be_defaced?(syntax)
-
-      processed_source = Deface::Override.apply(source.to_param, details, true, syntax)
-
-      # 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
+module Deface::ActionViewExtensions
+  def self.determine_syntax(handler)
+    return unless Rails.application.config.deface.enabled
+
+    if handler.to_s == "Haml::Plugin"
+      :haml
+    elsif handler.class.to_s == "Slim::RailsTemplate"
+      :slim
+    elsif handler.to_s.demodulize == "ERB" || handler.class.to_s.demodulize == "ERB"
+      :erb
     else
-      processed_source = source.to_param
+      nil
     end
-
-    initialize_without_deface(processed_source, identifier, handler, details)
   end
 
-  alias_method :render_without_deface, :render
+  module DefacedTemplate
+    def initialize(source, identifier, handler, details)
+      syntax = Deface::ActionViewExtensions.determine_syntax(handler)
 
-  # refresh view to get source again if
-  # view needs to be recompiled
-  #
-  def render(view, locals, buffer=nil, &block)
+      if syntax
+        processed_source = Deface::Override.apply(source.to_param, details, true, syntax)
 
-    if Gem.loaded_specs["rails"].version < Gem::Version.new("6.0.0.beta1") && view.is_a?(ActionView::CompiledTemplates)
-      mod = ActionView::CompiledTemplates
-    elsif Gem.loaded_specs["rails"].version >= Gem::Version.new("6.0.0.beta1")  && view.is_a?(ActionDispatch::DebugView)
-      mod = ActionDispatch::DebugView
-    else
-      mod = view.singleton_class
-    end
+        # 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
+      end
 
-    if @compiled && !mod.instance_methods.map(&:to_s).include?(method_name)
-      @compiled = false
-      @source = refresh(view).source
+      super(processed_source, identifier, handler, **details)
     end
-    render_without_deface(view, locals, buffer, &block)
-  end
 
-  protected
+    # 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
 
-    alias_method :method_name_without_deface, :method_name
+      if @compiled && !mod.instance_methods.include?(method_name.to_sym)
+        @compiled = false
+        @source = refresh(view).source
+      end
+      super(view, locals, buffer, &block)
+    end
 
     # inject deface hash into compiled view method name
     # used to determine if recompilation is needed
@@ -54,49 +53,24 @@ ActionView::Template.class_eval do
       deface_hash = Deface::Override.digest(:virtual_path => @virtual_path)
 
       #we digest the whole method name as if it gets too long there's problems
-      "_#{Deface::Digest.hexdigest("#{deface_hash}_#{method_name_without_deface}")}"
+      "_#{Deface::Digest.hexdigest("#{deface_hash}_#{super}")}"
     end
 
-  private
-
-    def should_be_defaced?(syntax)
-      syntax != :unknown
-    end
-
-    def determine_syntax(handler)
-      if handler.to_s == "Haml::Plugin"
-        :haml
-      elsif handler.class.to_s == "Slim::RailsTemplate"
-        :slim
-      elsif handler.to_s.demodulize == "ERB" || handler.class.to_s.demodulize == "ERB"
-        :erb
-      else
-        :unknown
-      end
-    end
-end
+    ActionView::Template.prepend self
+  end
 
-# Rails 6 fix
-# https://github.com/rails/rails/commit/ec5c946138f63dc975341d6521587adc74f6b441
-# https://github.com/rails/rails/commit/ccfa01c36e79013881ffdb7ebe397cec733d15b2#diff-dfb6e0314ad9639bab460ea64871aa47R27
-if defined?( ActionView::Template::Handlers::ERB::Erubi)
-  ActionView::Template::Handlers::ERB::Erubi.class_eval do
+  # Rails 6 fix.
+  #
+  # https://github.com/rails/rails/commit/ec5c946138f63dc975341d6521587adc74f6b441
+  # https://github.com/rails/rails/commit/ccfa01c36e79013881ffdb7ebe397cec733d15b2#diff-dfb6e0314ad9639bab460ea64871aa47R27
+  module ErubiHandlerFix
     def initialize(input, properties = {})
-      @newline_pending = 0
-
-      # Dup properties so that we don't modify argument
-      properties = Hash[properties]
-      properties[:preamble]   = "@output_buffer = output_buffer || ActionView::OutputBuffer.new;"
-      properties[:postamble]  = "@output_buffer.to_s"
-      properties[:bufvar]     = "@output_buffer"
-      properties[:escapefunc] = ""
-
+      properties[:preamble] = "@output_buffer = output_buffer || ActionView::OutputBuffer.new;"
       super
     end
-  end
-end
 
-#fix for Rails 3.1 not setting virutal_path anymore (BOO!)
-if defined?(ActionView::Resolver::Path)
-  ActionView::Resolver::Path.class_eval { alias_method :virtual, :to_s }
+    # We use include to place the module between the class' call to super and the
+    # actual execution within Erubi::Engine.
+    ActionView::Template::Handlers::ERB::Erubi.include self unless Deface.before_rails_6?
+  end
 end

data/lib/deface/applicator.rb

@@ -48,10 +48,8 @@ module Deface
             end
           end
 
-          if Rails.gem_version < Gem::Version.new('6.0.0')
-            #prevents any caching by rails in development mode
-            details[:updated_at] = Time.now
-          end
+          # Prevents any caching by rails in development mode.
+          details[:updated_at] = Time.now if Deface.before_rails_6?
 
           source = doc.to_s
 

data/lib/deface/environment.rb

@@ -57,13 +57,7 @@ module Deface
       Deface::DSL::Loader.register
 
       # check all railties / engines / extensions / application for overrides
-      railties = if Rails.version >= "4.0"
-        app.railties._all
-      else
-        app.railties.all
-      end
-
-      railties.dup.push(app).each do |railtie|
+      app.railties._all.dup.push(app).each do |railtie|
         next unless railtie.respond_to? :root
         load_overrides(railtie)
       end
@@ -89,11 +83,9 @@ module Deface
         paths ||= ["app/overrides"]
 
         paths.each do |path|
-          if Rails.version[0..2] >= "3.2"
-            # add path to watchable_dir so Rails will call to_prepare on file changes
-            # allowing overrides to be updated / reloaded in development mode.
-            Rails.application.config.watchable_dirs[root.join(path).to_s] = [:rb, :deface]
-          end
+          # add path to watchable_dir so Rails will call to_prepare on file changes
+          # allowing overrides to be updated / reloaded in development mode.
+          Rails.application.config.watchable_dirs[root.join(path).to_s] = [:rb, :deface]
 
           Dir.glob(root.join path, "**/*.rb") do |c|
             Rails.application.config.cache_classes ? require(c) : load(c)

data/lib/deface/errors.rb

@@ -0,0 +1,5 @@
+module Deface
+  class DefaceError < StandardError; end
+
+  class NotSupportedError < DefaceError; end
+end

data/lib/deface/override.rb

@@ -211,28 +211,22 @@ module Deface
 
     private
 
-      # check if method is compiled for the current virtual path
-      #
-      def expire_compiled_template
-        if Gem.loaded_specs["rails"].version < Gem::Version.new("6.0.0.beta1")
-          if compiled_method_name = ActionView::CompiledTemplates.instance_methods.detect { |name| name =~ /#{args[:virtual_path].gsub(/[^a-z_]/, '_')}/ }
-            #if the compiled method does not contain the current deface digest
-            #then remove the old method - this will allow the template to be
-            #recompiled the next time it is rendered (showing the latest changes)
-
-            unless compiled_method_name =~ /\A_#{self.class.digest(:virtual_path => @args[:virtual_path])}_/
-              ActionView::CompiledTemplates.send :remove_method, compiled_method_name
-            end
-          end
-        else
-          if compiled_method_name = ActionDispatch::DebugView.instance_methods.detect { |name| name =~ /#{args[:virtual_path].gsub(/[^a-z_]/, '_')}/ }
-            unless compiled_method_name =~ /\A_#{self.class.digest(:virtual_path => @args[:virtual_path])}_/
-              ActionDispatch::DebugView.send :remove_method, compiled_method_name
-            end
-          end
-        end
+    # Check if method is compiled for the current virtual path.
+    #
+    # If the compiled method does not contain the current deface digest
+    # then remove the old method - this will allow the template to be
+    # recompiled the next time it is rendered (showing the latest changes).
+    def expire_compiled_template
+      virtual_path = args[:virtual_path]
+
+      method_name = Deface.template_class.instance_methods.detect do |name|
+        name =~ /#{virtual_path.gsub(/[^a-z_]/, '_')}/
       end
 
+      if method_name && method_name !~ /\A_#{self.class.digest(virtual_path: virtual_path)}_/
+        Deface.template_class.send :remove_method, method_name
+      end
+    end
   end
 
 end

data/lib/deface/railtie.rb

@@ -39,13 +39,7 @@ module Deface
       tweak_eager_loading(app)
 
       # railites / engines / extensions
-      railties = if Rails.version >= "4.0"
-        app.railties._all
-      else
-        app.railties.all
-      end
-
-      railties.each do |railtie|
+      app.railties._all.each do |railtie|
         next unless railtie.respond_to?(:root) && railtie.config.respond_to?(:eager_load_paths)
 
         tweak_eager_loading(railtie)
@@ -95,7 +89,7 @@ module Deface
       paths_to_reject = railtie.config.eager_load_paths.select { |path| path.to_s  =~ /app\/overrides\z/ }
       railtie.config.eager_load_paths = railtie.config.eager_load_paths.reject { |path| path.in?(paths_to_reject) }
 
-      if Rails.version >= "6.0" && Rails.configuration.autoloader == :zeitwerk
+      if Rails.configuration.respond_to?(:autoloader) && Rails.configuration.autoloader == :zeitwerk
         Rails.autoloaders.each { |autoloader| autoloader.ignore(*paths_to_reject) }
       end
     end

data/lib/deface/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Deface
+  VERSION = "1.6.0"
+end

data/spec/deface/action_view_template_spec.rb

@@ -1,101 +1,146 @@
 require 'spec_helper'
 
-module ActionView
-  describe Template do
-    include_context "mock Rails.application"
-
-    describe "with no overrides defined" do
-      before(:each) do
-        @updated_at = Time.now - 600
-        @template = ActionView::Template.new("<p>test</p>", "/some/path/to/file.erb", ActionView::Template::Handlers::ERB, {:virtual_path=>"posts/index", :format=>:html, :updated_at => @updated_at})
-        #stub for Rails < 3.1
-        unless defined?(@template.updated_at)
-          allow(@template).to receive(:updated_at).and_return(@updated_at)
-        end
-      end
+describe Deface::ActionViewExtensions do
+  include_context "mock Rails.application"
 
-      it "should initialize new template object" do
-        expect(@template.is_a?(ActionView::Template)).to eq(true)
-      end
+  before supports_updated_at: true do
+    skip "Current Rails doesn't support the updated_at attribute on ActionView" unless supports_updated_at?
+  end
 
-      it "should return unmodified source" do
-        expect(@template.source).to eq("<p>test</p>")
-      end
+  let(:template) { ActionView::Template.new(
+    source,
+    path,
+    handler,
+    **options,
+    **(supports_updated_at? ? {updated_at: updated_at} : {})
+  ) }
+
+  let(:source) { "<p>test</p>" }
+  let(:path) { "/some/path/to/file.erb" }
+  let(:handler) { ActionView::Template::Handlers::ERB }
+  let(:options) {{
+    virtual_path: virtual_path,
+    format: format,
+    locals: {}
+  }}
+  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
+    it "should initialize new template object" do
+      expect(template.is_a?(ActionView::Template)).to eq(true)
+    end
 
-      it "should not change updated_at" do
-        expect(@template.updated_at).to eq(@updated_at)
-      end
+    it "should return unmodified source" do
+      expect(template.source).to eq("<p>test</p>")
+    end
 
+    it "should not change updated_at", :supports_updated_at do
+      expect(template.updated_at).to eq(updated_at)
     end
+  end
 
-    describe "with a single remove override defined" do
-      before(:each) do
-        @updated_at = Time.now - 300
-        Deface::Override.new(:virtual_path => "posts/index", :name => "Posts#index", :remove => "p", :text => "<h1>Argh!</h1>")
-        @template = ActionView::Template.new("<p>test</p><%= raw(text) %>", "/some/path/to/file.erb", ActionView::Template::Handlers::ERB, {:virtual_path=>"posts/index", :format=>:html, :updated_at => @updated_at})
-        #stub for Rails < 3.1
-        unless defined?(@template.updated_at)
-          allow(@template).to receive(:updated_at).and_return(@updated_at + 500)
-        end
-      end
+  describe "with a single remove override defined" do
+    let(:updated_at) { Time.now - 300 }
+    let(:source) { "<p>test</p><%= raw(text) %>" }
 
-      it "should return modified source" do
-        expect(@template.source).to eq("<%= raw(text) %>")
-      end
+    before do
+      Deface::Override.new(virtual_path: "posts/index", name: "Posts#index", remove: "p", text: "<h1>Argh!</h1>")
+    end
 
-      if Rails.gem_version >= Gem::Version.new('6.0.0')
-        it "should not change updated_at" do
-          expect(@template.updated_at).to eq(@updated_at)
-        end
-      else
-        it "should change updated_at" do
-          expect(@template.updated_at).to be > @updated_at
-        end
-      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
-      let(:template) { ActionView::Template.new("<p>test</p>", "/some/path/to/file.erb", ActionView::Template::Handlers::ERB, {:virtual_path=>"posts/index", :format=>:html, :updated_at => (Time.now - 100)}) }
+  describe "#method_name" do
+    before do
+      ActionView::Template.define_method(
+        :method_name_without_deface,
+        ActionView::Template.instance_method(:method_name)
+      )
+    end
 
-      it "should return hash of overrides plus original method_name " do
-        deface_hash = Deface::Override.digest(:virtual_path => 'posts/index')
+    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("_#{Digest::MD5.new.update("#{deface_hash}_#{template.send(:method_name_without_deface)}").hexdigest}")
-      end
+      expect(template.send(:method_name)).to eq(method_name)
+    end
+  end
 
-      it "should alias original method_name method" do
-        expect(template.send(:method_name_without_deface)).to match /\A__some_path_to_file_erb_+[0-9]+_+[0-9]+\z/
-      end
+  describe "non erb or haml template" do
+    let(:source) { "xml.post => :blah" }
+    let(:path) { "/some/path/to/file.erb" }
+    let(:handler) { ActionView::Template::Handlers::Builder }
+    let(:updated_at) { Time.now - 100 }
+    let(:format) { :xml }
+
+    before(:each) do
+      Deface::Override.new(virtual_path: "posts/index", name: "Posts#index", remove: "p")
     end
 
-    describe "non erb or haml template" do
-      before(:each) do
-        Deface::Override.new(:virtual_path => "posts/index", :name => "Posts#index", :remove => "p")
-        @template = ActionView::Template.new("xml.post => :blah", "/some/path/to/file.erb", ActionView::Template::Handlers::Builder, {:virtual_path=>"posts/index", :format=>:xml, :updated_at => (Time.now - 100)})
-      end
+    it "should return unmodified source" do
+      expect(template.source).to eq("xml.post => :blah")
+      expect(template.source).not_to include("=&gt;")
+    end
+  end
 
-      it "should return unmodified source" do
-        #if processed, source would include "=&gt;"
-        expect(@template.source).to eq("xml.post => :blah")
+  describe ".determine_syntax(handler)" do
+    let(:source) { "xml.post => :blah" }
+    let(:format) { :xml }
+
+    # Not so BDD, but it keeps us from making mistakes in the future for instance,
+    # we test ActionView::Template here with a handler == ....::Handlers::ERB,
+    # while in rails it seems it's an instance of ...::Handlers::ERB.
+    it "recognizes supported syntaxes" do
+      expectations = { Haml::Plugin => :haml,
+                       ActionView::Template::Handlers::ERB => :erb,
+                       ActionView::Template::Handlers::ERB.new => :erb,
+                       ActionView::Template::Handlers::Builder => nil }
+      expectations.each do |handler, expected|
+        expect(template.is_a?(ActionView::Template)).to eq(true)
+        expect(described_class.determine_syntax(handler)).to eq(expected), "unexpected result for handler #{handler}"
       end
     end
+  end
 
-    describe "#should_be_defaced?(handler) method" do
-      #not so BDD, but it keeps us from making mistakes in the future
-      #for instance, we test ActionView::Template here with a handler == ....::Handlers::ERB,
-      #while in rails it seems it's an instance of ...::Handlers::ERB
-      it "should be truthy only for haml/erb handlers and their instances" do
-        expectations = { Haml::Plugin => true,
-                         ActionView::Template::Handlers::ERB => true,
-                         ActionView::Template::Handlers::ERB.new => true,
-                         ActionView::Template::Handlers::Builder => false }
-        expectations.each do |handler, expected|
-          @template = ActionView::Template.new("xml.post => :blah", "/some/path/to/file.erb", handler, {:virtual_path=>"posts/index", :format=>:xml, :updated_at => (Time.now - 100)})
-          expect(@template.is_a?(ActionView::Template)).to eq(true)
-          syntax = @template.send(:determine_syntax, handler)
-          expect(@template.send(:should_be_defaced?, syntax)).to eq(expected), "unexpected result for handler "+handler.to_s
-        end
+  describe '#render' do
+    let(:source) { "<p>test</p><%= raw(text) %>".inspect }
+    let(:local_assigns) { {text: "some <br> text"} }
+    let(:lookup_context) { ActionView::LookupContext.new(["#{__dir__}/views"]) }
+    let(:view) do
+      if Rails::VERSION::STRING >= '6.1'
+        ActionView::Base.with_empty_template_cache.new(lookup_context, {}, nil)
+      else
+        ActionView::Base.new(lookup_context)
       end
     end
+    let(:options) { {
+      virtual_path: virtual_path,
+      format: format,
+      locals: local_assigns.keys
+    } }
+
+    let!(:deface) {
+      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
   end
 end

data/spec/deface/environment_spec.rb

@@ -19,8 +19,6 @@ module Deface
       Deface::Override.new(:virtual_path => "posts/new", :name => "Posts#new", :replace => "h1", :text => "<h1>argh!</h1>")
     end
 
-    let(:railties_collection_accessor) { Rails.version >= "4.0" ? :_all : :all }
-
     describe ".overrides" do
 
       it "should return all overrides" do
@@ -37,7 +35,7 @@ module Deface
         before do
           allow(Rails.application).to receive_messages :root => Pathname.new(File.join(File.dirname(__FILE__), '..', "assets"))
           allow(Rails.application).to receive_messages :paths => {}
-          allow(Rails.application).to receive_message_chain :railties, railties_collection_accessor => []
+          allow(Rails.application).to receive_message_chain :railties, :_all => []
 
           expect(Deface::DSL::Loader).to receive(:register)
         end
@@ -54,7 +52,7 @@ module Deface
         end
 
         it "should enumerate_and_load nil when railtie has no app/overrides path set" do
-          allow(Rails.application).to receive_message_chain :railties, railties_collection_accessor => [double('railtie', :root => "/some/path")]
+          allow(Rails.application).to receive_message_chain :railties, :_all => [double('railtie', :root => "/some/path")]
 
           expect(Rails.application.config.deface.overrides).to receive(:enumerate_and_load).with(nil, Rails.application.root)
           expect(Rails.application.config.deface.overrides).to receive(:enumerate_and_load).with(nil, "/some/path")
@@ -62,7 +60,7 @@ module Deface
         end
 
         it "should enumerate_and_load path when railtie has app/overrides path set" do
-          allow(Rails.application).to receive_message_chain :railties, railties_collection_accessor => [ double('railtie', :root => "/some/path", :paths => {"app/overrides" => ["app/some_path"] } )]
+          allow(Rails.application).to receive_message_chain :railties, :_all => [ double('railtie', :root => "/some/path", :paths => {"app/overrides" => ["app/some_path"] } )]
 
           expect(Rails.application.config.deface.overrides).to receive(:enumerate_and_load).with(nil, Rails.application.root)
           expect(Rails.application.config.deface.overrides).to receive(:enumerate_and_load).with(["app/some_path"] , "/some/path")
@@ -70,7 +68,7 @@ module Deface
         end
 
         it "should enumerate_and_load railties first, followed by the application iteslf" do
-          allow(Rails.application).to receive_message_chain :railties, railties_collection_accessor => [ double('railtie', :root => "/some/path", :paths => {"app/overrides" => ["app/some_path"] } )]
+          allow(Rails.application).to receive_message_chain :railties, :_all => [ double('railtie', :root => "/some/path", :paths => {"app/overrides" => ["app/some_path"] } )]
 
           expect(Rails.application.config.deface.overrides).to receive(:enumerate_and_load).with(["app/some_path"] , "/some/path").ordered
           expect(Rails.application.config.deface.overrides).to receive(:enumerate_and_load).with(nil, Rails.application.root).ordered
@@ -79,7 +77,7 @@ module Deface
 
         it "should ignore railtie with no root" do
           railtie = double('railtie')
-          allow(Rails.application).to receive_message_chain :railties, railties_collection_accessor => [railtie]
+          allow(Rails.application).to receive_message_chain :railties, :_all => [railtie]
 
           expect(railtie).to receive(:respond_to?).with(:root)
           expect(railtie).not_to receive(:respond_to?).with(:paths)
@@ -101,7 +99,7 @@ module Deface
 
         it "should keep a reference to which railtie/app defined the override" do
           allow(Rails.application).to receive_messages :root => assets_path, :paths => {"app/overrides" => ["dummy_app"] }
-          allow(Rails.application).to receive_message_chain :railties, railties_collection_accessor => [ engine ]
+          allow(Rails.application).to receive_message_chain :railties, :_all => [ engine ]
 
           Rails.application.config.deface.overrides.load_all(Rails.application)
 
@@ -127,10 +125,8 @@ module Deface
         end
 
         it "should add paths to watchable_dir when running Rails 3.2" do
-          if Rails.version[0..2] >= '3.2'
-            Rails.application.config.deface.overrides.send(:enumerate_and_load, ["app/gold"], root)
-            expect(Rails.application.config.watchable_dirs).to eq({"/some/path/app/gold" => [:rb, :deface] })
-          end
+          Rails.application.config.deface.overrides.send(:enumerate_and_load, ["app/gold"], root)
+          expect(Rails.application.config.watchable_dirs).to eq({"/some/path/app/gold" => [:rb, :deface] })
         end
 
       end

data/spec/deface/override_spec.rb

@@ -561,7 +561,7 @@ module Deface
 
     describe "#expire_compiled_template" do
       it "should remove compiled method when method name matches virtual path but not digest" do
-        if Gem.loaded_specs["rails"].version < Gem::Version.new("6.0.0.beta1")
+        if Deface.before_rails_6?
           instance_methods_count = ActionView::CompiledTemplates.instance_methods.size
 
           module ActionView::CompiledTemplates
@@ -598,7 +598,7 @@ module Deface
       end
 
       it "should not remove compiled method when virtual path and digest matach" do
-        if Gem.loaded_specs["rails"].version < Gem::Version.new("6.0.0.beta1")
+        if Deface.before_rails_6?
           instance_methods_count = ActionView::CompiledTemplates.instance_methods.size
 
           module ActionView::CompiledTemplates

data/spec/spec_helper.rb

@@ -2,13 +2,12 @@ require 'simplecov'
 SimpleCov.start 'rails'
 require 'rspec'
 require 'active_support'
-require 'action_view'
-require 'action_controller'
 require 'deface'
 require 'rails/generators'
 # have to manually require following for testing purposes
 require 'deface/action_view_extensions'
 require 'rails/version'
+require 'pry'
 
 #adding fake class as it's needed by haml 4.0, don't
 #want to have to require the entire rails stack in specs.
@@ -42,7 +41,7 @@ RSpec.configure do |config|
   config.mock_framework = :rspec
 end
 
-if Gem.loaded_specs["rails"].version < Gem::Version.new("6.0.0.beta1")
+if Deface.before_rails_6?
   module ActionView::CompiledTemplates
     #empty module for testing purposes
   end
@@ -69,9 +68,7 @@ shared_context "mock Rails" do
     allow(Rails.application.config).to receive(:deface).and_return ActiveSupport::OrderedOptions.new
     Rails.application.config.deface.enabled = true
 
-    if Rails.version[0..2] >= '3.2'
-      allow(Rails.application.config).to receive(:watchable_dirs).and_return({})
-    end
+    allow(Rails.application.config).to receive(:watchable_dirs).and_return({})
 
     allow(Rails).to receive(:root).and_return Pathname.new('spec/dummy')
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deface
 version: !ruby/object:Gem::Version
-  version: 1.5.3
+  version: 1.6.0
 platform: ruby
 authors:
 - Brian D Quinn
-autorequire: 
-bindir: bin
+autorequire:
+bindir: exe
 cert_chain: []
-date: 2019-10-17 00:00:00.000000000 Z
+date: 2021-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: rainbow
   requirement: !ruby/object:Gem::Requirement
@@ -170,6 +170,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
 description: Deface is a library that allows you to customize ERB, Haml and Slim views
   in a Rails application without editing the underlying view.
 email: brian@spreecommerce.com
@@ -177,7 +191,6 @@ executables: []
 extensions: []
 extra_rdoc_files:
 - README.markdown
-- CHANGELOG.markdown
 files:
 - ".gitignore"
 - ".rspec"
@@ -188,13 +201,15 @@ files:
 - MIT-LICENSE
 - README.markdown
 - Rakefile
+- bin/rails
+- bin/rails-engine
+- bin/rails-sandbox
+- bin/sandbox
+- bin/sandbox-setup
 - deface.gemspec
-- gemfiles/rails_4.2.gemfile
-- gemfiles/rails_5.0.gemfile
-- gemfiles/rails_5.1.gemfile
 - gemfiles/rails_5.2.gemfile
 - gemfiles/rails_6.0.gemfile
-- init.rb
+- gemfiles/rails_6_1.gemfile
 - lib/deface.rb
 - lib/deface/action_view_extensions.rb
 - lib/deface/actions/action.rb
@@ -218,6 +233,7 @@ files:
 - lib/deface/dsl/context.rb
 - lib/deface/dsl/loader.rb
 - lib/deface/environment.rb
+- lib/deface/errors.rb
 - lib/deface/generators
 - lib/deface/haml_converter.rb
 - lib/deface/matchers/element.rb
@@ -240,6 +256,7 @@ files:
 - lib/deface/sources/text.rb
 - lib/deface/template_helper.rb
 - lib/deface/utils/failure_finder.rb
+- lib/deface/version.rb
 - lib/generators/deface/USAGE
 - lib/generators/deface/override_generator.rb
 - lib/generators/deface/templates/override.html.erb.deface
@@ -286,10 +303,14 @@ files:
 - spec/spec_helper.rb
 - tasks/precompile.rake
 - tasks/utils.rake
-homepage: https://github.com/spree/deface
-licenses: []
-metadata: {}
-post_install_message: 
+homepage: https://github.com/spree/deface#readme
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/spree/deface#readme
+  source_code_uri: https://github.com/spree/deface
+  changelog_uri: https://github.com/spree/deface/releases
+post_install_message:
 rdoc_options:
 - "--charset=UTF-8"
 require_paths:
@@ -298,15 +319,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Deface is a library that allows you to customize ERB, Haml and Slim views
   in Rails

data/gemfiles/rails_5.0.gemfile

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

data/gemfiles/rails_5.1.gemfile

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

data/init.rb

@@ -1 +0,0 @@
-require 'deface'