deface 1.5.2 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 040fb8885174112590762a0220dfeb4c1597ff6f4f54804be959d60a9eb80924
-  data.tar.gz: f87d8e95f18c21a1e75b445556723232365a25003bfdce3898a90c0889eab52d
+  metadata.gz: 7beeaa21dc8761d6d24072002e6c90c5f7e08f283e603b8404e0b4003e68e557
+  data.tar.gz: 35b96c7138f0c3c5309e35d030bdd758d8c5d9f856924805d5004e5925134423
 SHA512:
-  metadata.gz: 39cab3b39f780056f9c47354f20b868d2409eec007bab49f2b60af96392d34d38d412cd9cee634a64847dcab23552c7a7814b2eb5cebd70534ab380feb7833f8
-  data.tar.gz: 4d2e948527682681bb53fc8e37aeb7b6f9f71b77f571606ed3e78d59991ae8e7362d6d6319af7f1eb50b0cc52fe279d8bab3daa2f7b34df0b29992a134dae677
+  metadata.gz: 6e21f73d0d80ae1806cfa6e6ec0244f38f281b87c398a0606a12debb566bdd20458627cbfad341df85a8c72b8c7b16d83bdeec3b36cac071112c07612ef60d75
+  data.tar.gz: 2dac481cd10a35a8d3916af3fbaff0f155f9a7ca9828be454a39fa1c9a4f6c25bf8946a05b7274f1df7025476314cea113be50ffd8a948184bd4ca13619c5022

data/.gitignore

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

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,49 @@
+#!/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
+
+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

@@ -1,30 +1,46 @@
-Gem::Specification.new do |s|
-  s.name = "deface"
-  s.version = "1.5.2"
-
-  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('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('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/gemfiles/{rails_5.0.gemfile → rails_6_1.gemfile}

@@ -2,7 +2,7 @@
 
 source "https://rubygems.org"
 
-gem "rails", "~> 5.0.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,102 +1,76 @@
-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
-
-  # refresh view to get source again if
-  # view needs to be recompiled
-  #
-  def render(view, locals, buffer=nil, &block)
-
-    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
+  module DefacedTemplate
+    def encode!
+      return super unless Rails.application.config.deface.enabled
+
+      # Before Rails 6 encode! returns nil
+      source = Deface.before_rails_6? ? (super; @source) : super
+
+      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
 
-    if @compiled && !mod.instance_methods.map(&:to_s).include?(method_name)
-      @compiled = false
-      @source = refresh(view).source
+      source
     end
-    render_without_deface(view, locals, buffer, &block)
-  end
 
-  protected
+    private
 
-    alias_method :method_name_without_deface, :method_name
+    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}_#{method_name_without_deface}")}"
-    end
-
-  private
+        if @deface_hash != current_deface_hash
+          @compiled = nil
+          @deface_hash = current_deface_hash
+        end
+      end
 
-    def should_be_defaced?(syntax)
-      syntax != :unknown
+      super
     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