deface 1.4.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 45c7cd1e4905de8fa0fda34bb4c1bed199d1b7b3544417da3caf6470624150d3
-  data.tar.gz: 0f9750691bc12ff9b1f140c4b9406f7d8b88148151c664205a9abf734925981d
+  metadata.gz: e130d9b889669220392d0fa6fe04ba7cd39604bf8b12edff68308b89d6f3f5f6
+  data.tar.gz: 997c7d4cc5d95a5a5168e70c9da588a9c56b7b67a404b0e4ffaf0410a06426b6
 SHA512:
-  metadata.gz: ac8f3a409db476df004e1665ae1583f5d6aa8e4a16d2d6a9a562511efc27c902b573f1557abc101566878f8b20013b3d316082d4ad61c5af7ec2229e0d0c8a44
-  data.tar.gz: 630f4f01132534f6fe7c5807b5615b91a54f9e5f19952a53bf10ab75418bcdf6cb79c82c275291a7d8782ba2623293da9b9bdf777d4d8614919e1e94a15d0ec5
+  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

@@ -1,6 +1,6 @@
 <p style="float:right;">
   <a href="http://secure.travis-ci.org/spree/deface">
-    <img src="https://secure.travis-ci.org/spree/deface.png?branch=master">
+    <img src="https://secure.travis-ci.org/spree/deface.svg?branch=master">
   </a>
 </p>
 
@@ -116,7 +116,7 @@ You should save your overrides in the ````app/overrides````, normally one overri
 * <tt>:sequence</tt> - Used to order the application of an override for a specific virtual path, helpful when an override depends on another override being applied first, supports:
   * <tt>:sequence => n</tt> - where n is a positive or negative integer (lower numbers get applied first, default 100).
   * <tt>:sequence => {:before => "*override_name*"}</tt> - where "*override_name*" is the name of an override defined for the 
-                                              same virutal_path, the current override will be appplied before 
+                                              same virtual_path, the current override will be appplied before 
                                               the named override passed.
   * <tt>:sequence => {:after => "*override_name*"}</tt> - the current override will be applied after the named override passed.
 
@@ -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.4.0"
-
-  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,49 +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 view.is_a?(ActionView::Base)
-      mod = ActionView::Base
-    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
@@ -52,29 +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
+    ActionView::Template.prepend self
+  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
+  # 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 = {})
+      properties[:preamble] = "@output_buffer = output_buffer || ActionView::OutputBuffer.new;"
+      super
     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