deface 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 97ffccb90e6da94c30f13a7e7fa0ff5cb58b46e0
-  data.tar.gz: 53c04295d2d4ce3d84247cd92a235c65aae26463
+  metadata.gz: 362600d10ec6ef2e0156d59d64d4dd8f3fb92a20
+  data.tar.gz: 9900d892be3f317070b21aa8f0d81d2c12d9b44b
 SHA512:
-  metadata.gz: 25ae8cc02921a14f84262ee46bfb5e940314e652abd05bfc72a87c403471039fe83326d4a7ef3869e3fd1994654fb109492f71f5b8baa46558e8f850a499c0af
-  data.tar.gz: bc8523db0265c48f27a56ca31a82893c82ccb029e70098255d80a6f911438ab5241d5f0022118fcc156c9e43b4b030e7da737f1ccfb51676ce8ac77d58a9802e
+  metadata.gz: 665ab9e4c61bfcb42d9812688f7d3abdd5f8a79724c0e7e4f7be062f2abff6e5c578644d6088cf6786110fca1cb878920be2e37cfac1f3841d990a37f2a67e0e
+  data.tar.gz: 46e41b81bb39faa7bb21b5f7581c66f0edc73e423b80ddd7b5519a23a3f087caf0de53e739939576212baa87fe461fab15752d67f5c36d72ef836b191855cc3a

data/.gitignore

@@ -3,3 +3,4 @@
 pkg
 Gemfile.lock
 coverage/
+.bundle/

data/Gemfile

@@ -3,8 +3,9 @@ source 'https://rubygems.org'
 gem 'rails', ENV['RAILS'] || '~> 3.2.13'
 
 group :test do
-  gem "pry"
-  gem "pry-byebug"
+  gem 'test-unit'
+  gem 'pry'
+  gem 'pry-byebug'
 end
 
 gemspec

data/README.markdown

@@ -1,8 +1,4 @@
-<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>
+[![Build Status](https://travis-ci.org/DefaceCommunity/deface.svg?branch=master)](https://travis-ci.org/DefaceCommunity/deface)
 
 Deface
 ======
@@ -308,7 +304,7 @@ allowing overrides in different engines with identical filenames to co-exist.
 
 ### DSL usage for overrides that do not include markup
 
-If your override does not require any markup, for example actions including ````:remove, :set_attributes, :remove_from_attributes, :add_to_attrbiutes```` you can exclude the "html.erb" or "html.haml" from the file name and you do not need to wrap the arguments in a comment.
+If your override does not require any markup, for example actions including ````:remove, :set_attributes, :remove_from_attributes, :add_to_attributes```` you can exclude the "html.erb" or "html.haml" from the file name and you do not need to wrap the arguments in a comment.
 
 So the override filename becomes simply:
 
@@ -412,11 +408,7 @@ Deface uses the amazing Nokogiri library (and in turn libxml) for parsing HTML /
 
 1. Ensure that your layout views include doctype, html, head and body tags in a single file, as Nokogiri will create such elements if it detects any of these tags have been incorrectly nested.
 
-2. Parsing will fail and result in invalid output if ERB blocks are responsible for closing an HTML tag that was opened normally, i.e. don't do this:
-
-```html
-&lt;div <%= ">" %>
-```
+2. Parsing will fail and result in invalid output if ERB blocks are responsible for closing an HTML tag that was opened normally, i.e. don't do this: `&lt;div <%= ">" %>`
 
 3. Gems or Spree Extensions that add overrides to your application will load them in the order they are added to your Gemfile.
 

data/deface.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "deface"
-  s.version = "1.0.1"
+  s.version = "1.0.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."
@@ -10,7 +10,7 @@ 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/spree/deface"
+  s.homepage = "https://github.com/DefaceCommunity/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"
@@ -20,9 +20,9 @@ Gem::Specification.new do |s|
   s.add_dependency('colorize', '>= 0.5.8')
   s.add_dependency('polyglot')
 
-  s.add_development_dependency('rspec', '>= 2.11.0')
+  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('slim', '>= 2.0.0') # 2.0.1 breaks slim loader specs
   s.add_development_dependency('simplecov', '>= 0.6.4')
   s.add_development_dependency('generator_spec', '~> 0.8')
 end

data/lib/deface/applicator.rb

@@ -16,7 +16,7 @@ module Deface
             #convert haml to erb before parsing before
             source = Deface::HamlConverter.new(source).result
           when :slim
-            source = Slim::ERBConverter.new.call(source)
+            source = Deface::SlimConverter.new(source).result
           end
 
           doc = Deface::Parser.convert(source)

data/lib/deface/dsl/loader.rb

@@ -19,42 +19,50 @@ module Deface
 
           file_contents = file.read
 
-          if context_name.end_with?('.html.erb')
-            dsl_commands, the_rest = extract_dsl_commands_from_erb(file_contents)
-
-            context_name = context_name.gsub('.html.erb', '')
-            context = Context.new(context_name)
-            context.virtual_path(determine_virtual_path(filename))
-            context.instance_eval(dsl_commands)
-            context.erb(the_rest)
-            context.create_override
-          elsif context_name.end_with?('.html.haml')
-            dsl_commands, the_rest = extract_dsl_commands_from_haml(file_contents)
-
-            context_name = context_name.gsub('.html.haml', '')
-            context = Context.new(context_name)
-            context.virtual_path(determine_virtual_path(filename))
-            context.instance_eval(dsl_commands)
-            context.haml(the_rest)
-            context.create_override
-          elsif context_name.end_with?('.html.slim')
-            dsl_commands, the_rest = extract_dsl_commands_from_slim(file_contents)
-
-            context_name = context_name.gsub('.html.slim', '')
-            context = Context.new(context_name)
-            context.virtual_path(determine_virtual_path(filename))
-            context.instance_eval(dsl_commands)
-            context.slim(the_rest)
-            context.create_override
-          else
-            context = Context.new(context_name)
-            context.virtual_path(determine_virtual_path(filename))
-            context.instance_eval(file_contents)
-            context.create_override
-          end
+          build_context(context_name, filename, file_contents)
         end
       end
 
+      def self.build_context(context_name, filename, file_contents)
+        send build_context_method_name(context_name), context_name, filename, file_contents
+      end
+
+      def self.build_context_method_name(context_name)
+        ext = File.extname(context_name).gsub(".", '')
+        ext = "other" if ext.empty?
+        "build_#{ext}_context"
+      end
+
+      def self.build_erb_context(context_name, filename, file_contents)
+        build_context_and_extract_dsl_from('erb', context_name, filename, file_contents)
+      end
+
+      def self.build_haml_context(context_name, filename, file_contents)
+        build_context_and_extract_dsl_from('haml', context_name, filename, file_contents)
+      end
+
+      def self.build_slim_context(context_name, filename, file_contents)
+        build_context_and_extract_dsl_from('slim', context_name, filename, file_contents)
+      end
+
+      def self.build_context_and_extract_dsl_from(type, context_name, filename, file_contents)
+        dsl_commands, the_rest = send "extract_dsl_commands_from_#{type}", (file_contents)
+
+        context_name = context_name.gsub(".html.#{type}", '')
+        context = Context.new(context_name)
+        context.virtual_path(determine_virtual_path(filename))
+        context.instance_eval(dsl_commands)
+        context.send type, the_rest
+        context.create_override
+      end
+
+      def self.build_other_context(context_name, filename, file_contents)
+        context = Context.new(context_name)
+        context.virtual_path(determine_virtual_path(filename))
+        context.instance_eval(file_contents)
+        context.create_override
+      end
+
       def self.register
         Polyglot.register('deface', Deface::DSL::Loader)
       end
@@ -140,4 +148,4 @@ module Deface
       end
     end
   end
-end
+end

data/lib/deface/railtie.rb

@@ -46,7 +46,7 @@ module Deface
       end
 
       railties.each do |railtie|
-        next unless railtie.respond_to? :root
+        next unless railtie.respond_to?(:root) && railtie.config.respond_to?(:eager_load_paths)
         railtie.config.eager_load_paths.reject! {|path| path  =~ /app\/overrides\z/ }
       end
     end
@@ -70,7 +70,7 @@ module Deface
 
         if defined?(Slim)
           app.config.deface.slim_support = true
-          require 'slim/erb_converter'
+          require 'deface/slim_converter'
         end
 
         # catchs any overrides that we required manually

data/lib/deface/slim_converter.rb

@@ -0,0 +1,15 @@
+require 'slim/erb_converter'
+
+module Deface
+  class SlimConverter
+
+    def initialize(template, options = {})
+      @template = template
+    end
+
+    def result
+      ::Slim::ERBConverter.new.call(@template).gsub /<%\s*%>/, ''
+    end
+
+  end
+end

data/lib/deface/sources/copy.rb

@@ -7,7 +7,7 @@ module Deface
           range = Deface::Matchers::Range.new('Copy', copy[:start], copy[:end]).matches(override.parsed_document).first
           Deface::Parser.undo_erb_markup! range.map(&:to_s).join
         else
-         Deface::Parser.undo_erb_markup! override.parsed_document.css(copy).first.to_s.clone
+          Deface::Parser.undo_erb_markup! override.parsed_document.css(copy).first.to_s.clone
         end
       end
     end

data/lib/deface/sources/slim.rb

@@ -3,11 +3,11 @@ module Deface
     class Slim < Source
       def self.execute(override)
         if Rails.application.config.deface.slim_support
-          ::Slim::ERBConverter.new.call(override.args[:slim])
+          Deface::SlimConverter.new(override.args[:slim]).result
         else
           raise Deface::NotSupportedError, "`#{override.name}` supplies :slim source, but slim_support is not detected."
         end
       end
     end
   end
-end
+end

data/lib/deface/template_helper.rb

@@ -23,7 +23,7 @@ module Deface
       if view.handler.to_s == "Haml::Plugin"
         Deface::HamlConverter.new(view.source).result
       elsif view.handler.class.to_s == "Slim::RailsTemplate"
-        Slim::ERBConverter.new.call(view.source)
+        Deface::SlimConverter.new(view.source).result
       else
         view.source
       end

data/spec/deface/action_view_template_spec.rb

@@ -10,20 +10,20 @@ module ActionView
         @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)
-          @template.stub(:updated_at).and_return(@updated_at)
+          allow(@template).to receive(:updated_at).and_return(@updated_at)
         end
       end
 
       it "should initialize new template object" do
-        @template.is_a?(ActionView::Template).should == true
+        expect(@template.is_a?(ActionView::Template)).to eq(true)
       end
 
       it "should return unmodified source" do
-        @template.source.should == "<p>test</p>"
+        expect(@template.source).to eq("<p>test</p>")
       end
 
       it "should not change updated_at" do
-        @template.updated_at.should == @updated_at
+        expect(@template.updated_at).to eq(@updated_at)
       end
 
     end
@@ -35,16 +35,16 @@ module ActionView
         @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)
-          @template.stub(:updated_at).and_return(@updated_at + 500)
+          allow(@template).to receive(:updated_at).and_return(@updated_at + 500)
         end
       end
 
       it "should return modified source" do
-        @template.source.should == "<%= raw(text) %>"
+        expect(@template.source).to eq("<%= raw(text) %>")
       end
 
       it "should change updated_at" do
-        @template.updated_at.should > @updated_at
+        expect(@template.updated_at).to be > @updated_at
       end
     end
 
@@ -54,11 +54,11 @@ module ActionView
       it "should return hash of overrides plus original method_name " do
         deface_hash = Deface::Override.digest(:virtual_path => 'posts/index')
 
-        template.send(:method_name).should == "_#{Digest::MD5.new.update("#{deface_hash}_#{template.send(:method_name_without_deface)}").hexdigest}"
+        expect(template.send(:method_name)).to eq("_#{Digest::MD5.new.update("#{deface_hash}_#{template.send(:method_name_without_deface)}").hexdigest}")
       end
 
       it "should alias original method_name method" do
-        template.send(:method_name_without_deface).should match /\A__some_path_to_file_erb_+[0-9]+_+[0-9]+\z/
+        expect(template.send(:method_name_without_deface)).to match /\A__some_path_to_file_erb_+[0-9]+_+[0-9]+\z/
       end
     end
 
@@ -70,7 +70,7 @@ module ActionView
 
       it "should return unmodified source" do
         #if processed, source would include "=&gt;"
-        @template.source.should == "xml.post => :blah"
+        expect(@template.source).to eq("xml.post => :blah")
       end
     end
 
@@ -85,9 +85,9 @@ module ActionView
                          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)})
-          @template.is_a?(ActionView::Template).should == true
+          expect(@template.is_a?(ActionView::Template)).to eq(true)
           syntax = @template.send(:determine_syntax, handler)
-          @template.send(:should_be_defaced?, syntax).should eq(expected), "unexpected result for handler "+handler.to_s
+          expect(@template.send(:should_be_defaced?, syntax)).to eq(expected), "unexpected result for handler "+handler.to_s
         end
       end
     end

data/spec/deface/actions/add_to_attributes_spec.rb

@@ -14,8 +14,8 @@ module Deface
         it "should return modified source" do
           attrs = attributes_to_sorted_array(Dummy.apply(source, {:virtual_path => "posts/index"}))
 
-          attrs["class"].value.should == "button pretty"
-          attrs["alt"].value.should == "something interesting"
+          expect(attrs["class"].value).to eq("button pretty")
+          expect(attrs["alt"].value).to eq("something interesting")
         end
       end
 
@@ -27,8 +27,8 @@ module Deface
         it "should return modified source" do
           attrs = attributes_to_sorted_array(Dummy.apply(source, {:virtual_path => "posts/index"}))
 
-          attrs["class"].value.should == "button <%= add_class %>"
-          attrs["src"].value.should == "path/to/button.png"
+          expect(attrs["class"].value).to eq("button <%= add_class %>")
+          expect(attrs["src"].value).to eq("path/to/button.png")
         end
       end
 
@@ -40,8 +40,8 @@ module Deface
         it "should return modified source" do
           attrs = attributes_to_sorted_array(Dummy.apply(source, {:virtual_path => "posts/index"}))
 
-          attrs["class"].value.should == "button <%= add_class %>"
-          attrs["src"].value.should == "path/to/button.png"
+          expect(attrs["class"].value).to eq("button <%= add_class %>")
+          expect(attrs["src"].value).to eq("path/to/button.png")
         end
       end
 
@@ -53,8 +53,8 @@ module Deface
         it "should return modified source" do
           attrs = attributes_to_sorted_array(Dummy.apply(source, {:virtual_path => "posts/index"}))
 
-          attrs["class"].value.should == "<%= get_class %> <%= get_some_other_class %>"
-          attrs["src"].value.should == "path/to/button.png"
+          expect(attrs["class"].value).to eq("<%= get_class %> <%= get_some_other_class %>")
+          expect(attrs["src"].value).to eq("path/to/button.png")
         end
       end
     end

data/spec/deface/actions/insert_after_spec.rb

@@ -11,7 +11,7 @@ module Deface
         let(:source) { "<div><img class=\"button\" src=\"path/to/button.png\"></div>" }
 
         it "should return modified source" do
-          Dummy.apply(source, {:virtual_path => "posts/index"}).gsub("\n", "").should == "<div><img class=\"button\" src=\"path/to/button.png\"><% help %></div>"
+          expect(Dummy.apply(source, {:virtual_path => "posts/index"}).gsub("\n", "")).to eq("<div><img class=\"button\" src=\"path/to/button.png\"><% help %></div>")
         end
       end
     end

data/spec/deface/actions/insert_before_spec.rb

@@ -11,7 +11,7 @@ module Deface
         let(:source) { "<ul><li>first</li><li>second</li><li>third</li></ul>" }
 
         it "should return modified source" do
-          Dummy.apply(source, {:virtual_path => "posts/index"}).gsub("\n", "").should == "<ul><li>first</li><li>second</li><li>third</li><%= help %></ul>"
+          expect(Dummy.apply(source, {:virtual_path => "posts/index"}).gsub("\n", "")).to eq("<ul><li>first</li><li>second</li><li>third</li><%= help %></ul>")
         end
       end
     end

data/spec/deface/actions/insert_bottom_spec.rb

@@ -11,7 +11,7 @@ module Deface
         let(:source) { "<ul><li>first</li><li>second</li><li>third</li></ul>" }
 
         it "should return modified source" do
-          Dummy.apply(source, {:virtual_path => "posts/index"}).gsub("\n", "").should == "<ul><li>first</li><li>second</li><li>third</li><li>I'm always last</li></ul>"
+          expect(Dummy.apply(source, {:virtual_path => "posts/index"}).gsub("\n", "")).to eq("<ul><li>first</li><li>second</li><li>third</li><li>I'm always last</li></ul>")
         end
       end
 
@@ -20,7 +20,7 @@ module Deface
         let(:source) { "<ul></ul>" }
 
         it "should return modified source" do
-          Dummy.apply(source, {:virtual_path => "posts/index"}).gsub("\n", "").should == "<ul><li>I'm always last</li></ul>"
+          expect(Dummy.apply(source, {:virtual_path => "posts/index"}).gsub("\n", "")).to eq("<ul><li>I'm always last</li></ul>")
         end
       end
     end

data/spec/deface/actions/insert_top_spec.rb

@@ -11,7 +11,7 @@ module Deface
         let(:source) { "<ul><li>first</li><li>second</li><li>third</li></ul>" }
 
         it "should return modified source" do
-          Dummy.apply(source, {:virtual_path => "posts/index"}).gsub("\n", "").should == "<ul><li>me first</li><li>first</li><li>second</li><li>third</li></ul>"
+          expect(Dummy.apply(source, {:virtual_path => "posts/index"}).gsub("\n", "")).to eq("<ul><li>me first</li><li>first</li><li>second</li><li>third</li></ul>")
         end
       end
 
@@ -20,7 +20,7 @@ module Deface
         let(:source) { "<ul></ul>" }
 
         it "should return modified source" do
-          Dummy.apply(source, {:virtual_path => "posts/index"}).gsub("\n", "").should == "<ul><li>first</li><li>second</li><li>third</li></ul>"
+          expect(Dummy.apply(source, {:virtual_path => "posts/index"}).gsub("\n", "")).to eq("<ul><li>first</li><li>second</li><li>third</li></ul>")
         end
       end
     end

data/spec/deface/actions/remove_from_attributes_spec.rb

@@ -14,7 +14,7 @@ module Deface
         it "should return modified source" do
           attrs = attributes_to_sorted_array(Dummy.apply(source, {:virtual_path => "posts/index"}))
 
-          attrs["class"].value.should == "button"
+          expect(attrs["class"].value).to eq("button")
         end
       end
 
@@ -26,8 +26,8 @@ module Deface
         it "should return modified source" do
           attrs = attributes_to_sorted_array(Dummy.apply(source, {:virtual_path => "posts/index"}))
 
-          attrs["class"].value.should == "button"
-          attrs["src"].value.should == "path/to/button.png"
+          expect(attrs["class"].value).to eq("button")
+          expect(attrs["src"].value).to eq("path/to/button.png")
         end
       end
 
@@ -39,8 +39,8 @@ module Deface
         it "should return modified source" do
           attrs = attributes_to_sorted_array(Dummy.apply(source, {:virtual_path => "posts/index"}))
 
-          attrs["class"].value.should == "button"
-          attrs["src"].value.should == "path/to/button.png"
+          expect(attrs["class"].value).to eq("button")
+          expect(attrs["src"].value).to eq("path/to/button.png")
         end
       end
 
@@ -50,7 +50,7 @@ module Deface
         let(:source) { "<img class=\"button\" src=\"path/to/button.png\">" }
 
         it "should return unmodified source" do
-          Dummy.apply(source, {:virtual_path => "posts/index"}).should == "<img class=\"button\" src=\"path/to/button.png\">" 
+          expect(Dummy.apply(source, {:virtual_path => "posts/index"})).to eq("<img class=\"button\" src=\"path/to/button.png\">") 
         end
       end
 
@@ -60,7 +60,7 @@ module Deface
         let(:source) { "<img src=\"path/to/button.png\">" }
 
         it "should return unmodified source" do
-          Dummy.apply(source, {:virtual_path => "posts/index"}).should == "<img src=\"path/to/button.png\">" 
+          expect(Dummy.apply(source, {:virtual_path => "posts/index"})).to eq("<img src=\"path/to/button.png\">") 
         end
       end
 
@@ -72,8 +72,8 @@ module Deface
         it "should return modified source" do
           attrs = attributes_to_sorted_array(Dummy.apply(source, {:virtual_path => "posts/index"}))
 
-          attrs["class"].value.should == "<%= get_class %>"
-          attrs["src"].value.should == "path/to/button.png"
+          expect(attrs["class"].value).to eq("<%= get_class %>")
+          expect(attrs["src"].value).to eq("path/to/button.png")
         end
       end
     end