deface 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 362600d10ec6ef2e0156d59d64d4dd8f3fb92a20
-  data.tar.gz: 9900d892be3f317070b21aa8f0d81d2c12d9b44b
+  metadata.gz: 502de62f408e71f17bd0754e127f96fffbe75972
+  data.tar.gz: 279f46ffaf3840eba89f84b4523e67df977656c4
 SHA512:
-  metadata.gz: 665ab9e4c61bfcb42d9812688f7d3abdd5f8a79724c0e7e4f7be062f2abff6e5c578644d6088cf6786110fca1cb878920be2e37cfac1f3841d990a37f2a67e0e
-  data.tar.gz: 46e41b81bb39faa7bb21b5f7581c66f0edc73e423b80ddd7b5519a23a3f087caf0de53e739939576212baa87fe461fab15752d67f5c36d72ef836b191855cc3a
+  metadata.gz: d7601eb9876b5731d7c1742a79b509f2fc03e3e670ce31283f8e642f4e7a6f77840c3f6ffdc68955517c548723768ce2b5f1a607eca39be63af813150ab8e4c9
+  data.tar.gz: d74468452500ad67931db222bf4eb4697cab2a6530471e6e10e46dbda1e9d3bc78f00956588457e8091be186ff4a290b961931820a5e10b2fc17581c229667c5

data/.gitignore

@@ -4,3 +4,5 @@ pkg
 Gemfile.lock
 coverage/
 .bundle/
+gemfiles/*.lock
+/.idea

data/.travis.yml

@@ -1,12 +1,16 @@
 script: "bundle exec rake"
 rvm:
-  - 1.9.3
-  - 2.0.0
+  - 2.1.10
+  - 2.2.5
+  - 2.3.1
 gemfile:
-  - gemfiles/rails3_1.gemfile
-  - gemfiles/rails3_2.gemfile
-  - gemfiles/rails4_0.gemfile
-  - gemfiles/haml4_0.gemfile
+  - gemfiles/rails_4.1.gemfile
+  - gemfiles/rails_4.2.gemfile
+  - gemfiles/rails_5.0.gemfile
+matrix:
+  exclude:
+    - rvm: 2.1.10
+      gemfile: gemfiles/rails_5.0.gemfile
 notifications:
   email:
     - brian@spreecommerce.com

data/Appraisals

@@ -0,0 +1,11 @@
+appraise 'rails-4.1' do
+  gem 'rails', '~> 4.1.0'
+end
+
+appraise 'rails-4.2' do
+  gem 'rails', '~> 4.2.0'
+end
+
+appraise 'rails-5.0' do
+  gem 'rails', '>= 5.0.0.alpha', '< 5.1'
+end

data/Gemfile

@@ -1,7 +1,5 @@
 source 'https://rubygems.org'
 
-gem 'rails', ENV['RAILS'] || '~> 3.2.13'
-
 group :test do
   gem 'test-unit'
   gem 'pry'

data/README.markdown

@@ -1,4 +1,8 @@
-[![Build Status](https://travis-ci.org/DefaceCommunity/deface.svg?branch=master)](https://travis-ci.org/DefaceCommunity/deface)
+<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">
+  </a>
+</p>
 
 Deface
 ======
@@ -105,7 +109,7 @@ You should save your overrides in the ````app/overrides````, normally one overri
 
 * <tt>:disabled</tt> - When set to true the override will not be applied.
 
-* <tt>:original</tt> - String containing original markup that is being overridden. If supplied Deface will log when the original markup changes, which helps highlight overrides that need attention when upgrading versions of the source application. Only really warranted for :replace overrides. NB: All whitespace is stripped before comparison.
+* <tt>:original</tt> - Either a string containing the original markup that is being overridden, or a string that is the SHA1 digest of the original markup. If supplied Deface will log when the original markup changes, which helps highlight overrides that need attention when upgrading versions of the source application. Only really warranted for :replace overrides. NB: All whitespace is stripped before comparison. To generate the SHA1 digest do: `Digest::SHA1.hexdigest(original_markup_string.gsub(/\s/, ''))`
 
 * <tt>:closing_selector</tt> - A second css selector targeting an end element, allowing you to select a range of elements to apply an action against. The :closing_selector only supports the :replace, :remove and :replace_contents actions, and the end element must be a sibling of the first/starting element. Note the CSS general sibling selector (~) is used to match the first element after the opening selector (see below for an example).
 
@@ -190,7 +194,7 @@ Remove an entire ERB if statement (and all it's contents) in the 'admin/products
 Deface::Override.new(:virtual_path => 'admin/products/index',
                      :name => "remove_if_statement",
                      :remove => "erb[silent]:contains('if @product.sold?')",
-                     :closing_selector => "erb[silent]:contains('end')"
+                     :closing_selector => "erb[silent]:contains('end')")
 ```
 
 ### Scope
@@ -344,16 +348,37 @@ Production & Precompiling
 
 Deface now supports precompiling where all overrides are loaded and applied to the original views and the resulting templates are then saved to your application's `app/compiled_views` directory. To precompile run:
 
-     bundle exec rake deface:precompile
+     DEFACE_ENABLED=true bundle exec rake deface:precompile
 
 It's important to disable Deface once precompiling is used to prevent overrides getting applied twice. To disable add the following line to your application's `production.rb` file:
 
 ```ruby
-config.deface.enabled = false
+config.deface.enabled = ENV['DEFACE_ENABLED'] == 'true'
 ```
 
 NOTE: You can also use precompiling in development mode.
 
+### Adding to Capistrano
+
+Adding the following to your `deploy.rb` will automatically compile the views during deploy
+
+```ruby
+namespace :deface do
+  desc "Pre-compile Deface overrides into templates"
+  task :precompile do
+    on roles(:app) do
+      within release_path do
+        with rails_env: fetch(:rails_env), deface_enabled: true do
+          execute :rake, 'deface:precompile'
+        end
+      end
+    end
+  end
+end
+
+after 'deploy:updated', 'deface:precompile'
+```
+
 
 Demo & Testing
 --------------

data/deface.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "deface"
-  s.version = "1.0.2"
+  s.version = "1.1.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."
@@ -10,19 +10,20 @@ Gem::Specification.new do |s|
   ]
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.homepage = "https://github.com/DefaceCommunity/deface"
+  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.0')
-  s.add_dependency('rails', '>= 3.1')
+  s.add_dependency('rails', '>= 4.1')
   s.add_dependency('colorize', '>= 0.5.8')
   s.add_dependency('polyglot')
 
+  s.add_development_dependency('appraisal')
   s.add_development_dependency('rspec', '>= 3.1.0')
-  s.add_development_dependency('haml', '>= 3.1.4')
-  s.add_development_dependency('slim', '>= 2.0.0') # 2.0.1 breaks slim loader specs
+  s.add_development_dependency('haml', '~> 4.0')
+  s.add_development_dependency('slim', '~> 3.0')
   s.add_development_dependency('simplecov', '>= 0.6.4')
   s.add_development_dependency('generator_spec', '~> 0.8')
 end

data/gemfiles/rails_4.1.gemfile

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

data/gemfiles/rails_4.2.gemfile

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

data/gemfiles/rails_5.0.gemfile

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

data/lib/deface/railtie.rb

@@ -36,7 +36,7 @@ module Deface
     initializer "deface.tweak_eager_loading", :before => :set_load_path do |app|
 
       # application
-      app.config.eager_load_paths.reject! {|path| path  =~ /app\/overrides\z/ }
+      app.config.eager_load_paths.reject! {|path| path.to_s  =~ /app\/overrides\z/ }
 
       # railites / engines / extensions
       railties = if Rails.version >= "4.0"
@@ -47,7 +47,7 @@ module Deface
 
       railties.each do |railtie|
         next unless railtie.respond_to?(:root) && railtie.config.respond_to?(:eager_load_paths)
-        railtie.config.eager_load_paths.reject! {|path| path  =~ /app\/overrides\z/ }
+        railtie.config.eager_load_paths.reject! {|path| path.to_s  =~ /app\/overrides\z/ }
       end
     end
 

data/spec/deface/template_helper_spec.rb

@@ -33,7 +33,8 @@ module Deface
         end
 
         it "should return converted source for template containing slim" do
-          expect(load_template_source("shared/public", false).gsub(/\s/, '')).to include('print_information')
+          result = "<divid=\"content\"><divclass=\"left\"><p><%=::Temple::Utils.escape_html_safe((print_information))%></p></div><divclass=\"right\"<%_slim_codeattributes1=@right;if_slim_codeattributes1;if_slim_codeattributes1==true%>id=\"\"<%else%>id=\"<%=::Temple::Utils.escape_html_safe((_slim_codeattributes1))%>\"<%end;end%>><%=::Temple::Utils.escape_html_safe((render:partial=>\"sidebar\"))%></div></div>"
+          expect(load_template_source("shared/public", false).gsub(/\s/, '')).to eq result
         end
 
         it "should return source for namespaced template" do
@@ -54,7 +55,6 @@ module Deface
           Deface::Override.new(:virtual_path => "shared/person", :name => "shared#person", :replace => "p", :text => "<h1>Argh!</h1>")
           Deface::Override.new(:virtual_path => "shared/_hello", :name => "shared#hello", :replace_contents => "div#message", :text => "<%= 'Goodbye World!' %>")
           Deface::Override.new(:virtual_path => "shared/pirate", :name => "shared#pirate", :replace => "p", :text => "<h1>Argh!</h1>")
-          Deface::Override.new(:virtual_path => "shared/public", :name => "shared#public", :replace => "p", :text => "<h1>Ahoy!</h1>")
           Deface::Override.new(:virtual_path => "admin/posts/index", :name => "admin#posts#index", :replace => "h1", :text => "<h1>Argh!</h1>")
         end
 
@@ -83,7 +83,8 @@ module Deface
         end
 
         it "should return converted and overridden source for template containing slim" do
-          expect(load_template_source("shared/public", false).gsub(/\s/, '')).to include("<h1>Ahoy!</h1>")
+          result = "<divid=\"content\"><divclass=\"left\"><p><%=::Temple::Utils.escape_html_safe((print_information))%></p></div><divclass=\"right\"<%_slim_codeattributes1=@right;if_slim_codeattributes1;if_slim_codeattributes1==true%>id=\"\"<%else%>id=\"<%=::Temple::Utils.escape_html_safe((_slim_codeattributes1))%>\"<%end;end%>><%=::Temple::Utils.escape_html_safe((render:partial=>\"sidebar\"))%></div></div>"
+          expect(load_template_source("shared/public", false).gsub(/\s/, '')).to eq result
         end
 
         it "should return source for namespaced template including overrides" do

data/spec/deface/utils/failure_finder_spec.rb

@@ -1,11 +1,14 @@
 require 'spec_helper'
 require 'deface/utils/failure_finder'
 
+require 'active_support/testing/stream' if Rails::VERSION::MAJOR >= 5
+
 module Deface
   module Utils
     describe FailureFinder do
       include Deface::Utils::FailureFinder
       include Deface::TemplateHelper
+      include ActiveSupport::Testing::Stream if Rails::VERSION::MAJOR >= 5
       include_context "mock Rails.application"
 
       before do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deface
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Brian D Quinn
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-13 00:00:00.000000000 Z
+date: 2016-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '4.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '4.1'
 - !ruby/object:Gem::Dependency
   name: colorize
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  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
@@ -84,30 +98,30 @@ dependencies:
   name: haml
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.4
+        version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.4
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: slim
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -148,16 +162,16 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- Appraisals
 - CHANGELOG.markdown
 - Gemfile
 - MIT-LICENSE
 - README.markdown
 - Rakefile
 - deface.gemspec
-- gemfiles/haml4_0.gemfile
-- gemfiles/rails3_1.gemfile
-- gemfiles/rails3_2.gemfile
-- gemfiles/rails4_0.gemfile
+- gemfiles/rails_4.1.gemfile
+- gemfiles/rails_4.2.gemfile
+- gemfiles/rails_5.0.gemfile
 - init.rb
 - lib/deface.rb
 - lib/deface/action_view_extensions.rb
@@ -248,7 +262,7 @@ files:
 - spec/spec_helper.rb
 - tasks/precompile.rake
 - tasks/utils.rake
-homepage: https://github.com/DefaceCommunity/deface
+homepage: https://github.com/spree/deface
 licenses: []
 metadata: {}
 post_install_message: 
@@ -268,9 +282,47 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Deface is a library that allows you to customize ERB, Haml and Slim views
   in Rails
-test_files: []
+test_files:
+- spec/assets/admin/posts/index.html.erb
+- spec/assets/dummy_app/overrides/posts/index/app_override.html.erb.deface
+- spec/assets/dummy_app/overrides/posts/precompileme/precompileme.html.erb.deface
+- spec/assets/dummy_engine/overrides/users/index/engine_override.html.erb.deface
+- spec/assets/posts/precompileme.html.erb
+- spec/assets/shared/_hello.html.haml
+- spec/assets/shared/_hi.html.slim
+- spec/assets/shared/_post.html.erb
+- spec/assets/shared/person.html.erb
+- spec/assets/shared/pirate.html.haml
+- spec/assets/shared/public.html.slim
+- spec/deface/action_view_template_spec.rb
+- spec/deface/actions/add_to_attributes_spec.rb
+- spec/deface/actions/insert_after_spec.rb
+- spec/deface/actions/insert_before_spec.rb
+- spec/deface/actions/insert_bottom_spec.rb
+- spec/deface/actions/insert_top_spec.rb
+- spec/deface/actions/remove_from_attributes_spec.rb
+- spec/deface/actions/remove_spec.rb
+- spec/deface/actions/replace_contents_spec.rb
+- spec/deface/actions/replace_spec.rb
+- spec/deface/actions/set_attributes_spec.rb
+- spec/deface/actions/surround_contents_spec.rb
+- spec/deface/actions/surround_spec.rb
+- spec/deface/applicator_spec.rb
+- spec/deface/dsl/context_spec.rb
+- spec/deface/dsl/loader_spec.rb
+- spec/deface/environment_spec.rb
+- spec/deface/haml_converter_spec.rb
+- spec/deface/override_spec.rb
+- spec/deface/parser_spec.rb
+- spec/deface/precompiler_spec.rb
+- spec/deface/search_spec.rb
+- spec/deface/slim_converter_spec.rb
+- spec/deface/template_helper_spec.rb
+- spec/deface/utils/failure_finder_spec.rb
+- spec/generators/deface/override_generator_spec.rb
+- spec/spec_helper.rb

data/gemfiles/haml4_0.gemfile

@@ -1,5 +0,0 @@
-source 'https://rubygems.org'
-
-gem 'haml', '~> 4.0.0'
-
-gemspec :path=>"../"

data/gemfiles/rails3_1.gemfile

@@ -1,5 +0,0 @@
-source 'https://rubygems.org'
-
-gem "rails", "~> 3.1.0"
-
-gemspec :path=>"../"

data/gemfiles/rails3_2.gemfile

@@ -1,5 +0,0 @@
-source 'https://rubygems.org'
-
-gem "rails", "~> 3.2.0"
-
-gemspec :path=>"../"

data/gemfiles/rails4_0.gemfile

@@ -1,5 +0,0 @@
-source 'https://rubygems.org'
-
-gem "rails", "~> 4.0.0.rc1"
-
-gemspec :path => "../"