deface 0.6.1 → 0.7.0

data/README.markdown

@@ -1,7 +1,13 @@
+<p style="float:right;">
+  <a href="http://travis-ci.org/#!/railsdog/deface">
+    <img src="http://travis-ci.org/railsdog/deface.png">
+  </a>
+</p>
+
 Deface
 ======
 
-Deface is a library that allows you to customize ERB views in a Rails application without editing the underlying view.
+Deface is a library that allows you to customize HTML ERB views in a Rails application without editing the underlying view.
 
 It allows you to easily target html & erb elements as the hooks for customization using CSS selectors as supported by Nokogiri.
 
@@ -50,7 +56,9 @@ Optional
 
 * <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 comparsion.
+* <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>: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).
 
 * <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).
@@ -85,7 +93,7 @@ Inserts the contents of `shared/_comment.html.erb` after all instances of `div`
                           :insert_after => "div#comment_21", 
                           :partial => "shared/comment")
 
-Removes any ERB block containing the string `helper_method` in the `posts/new.html.erb` template, will also log if markup being removed does not match `<%= helper_method %>`
+Removes any ERB block containing the string `helper_method` in the `posts/new.html.erb` template, will also log if markup being removed does not exactly match `<%= helper_method %>`
 
      Deface::Override.new(:virtual_path => "posts/new", 
                           :name => "example-4", 
@@ -99,6 +107,46 @@ Sets (or adds if not present) the `class` and `title` attributes to all instance
                         :set_attributes => 'a#link',
                         :attributes => {:class => 'pretty', :title => 'This is a link'})
 
+Remove an entire ERB if statement (and all it's contents) in the 'admin/products/index.html.erb' template, using the :closing_selector.
+
+    Deface::Override.new(:virtual_path => 'admin/products/index',
+                         :name => "remove_if_statement",
+                         :remove => "code[:erb-silent]:contains('if @product.sold?')",
+                         :closing_selector => "code[:erb-silent]:contains('end')"
+
+Scope
+=====
+
+Deface scopes overrides by virtual_path (or partial / template file), that means all override names only need to be unique within that single file.
+
+Redefining Overrides
+====================
+
+You can redefine an existing override by simply declaring a new override with the same <tt>:virtual_path</tt> and <tt>:name</tt> that was originally used.
+You do not need to resupply all the values originally used, just the ones you want to change:
+
+   Deface::Override.new(:virtual_path => 'posts/index',
+                        :name => 'add_attrs_to_a_link',
+                        :disabled => true)
+
+Rake Tasks
+==========
+
+Deface includes a couple of rake tasks that can be helpful when defining or debugging overrides.
+
+**deface:get_result** - Will list the original contents of a partial or template, the overrides that have been defined for a that file, and the resulting markup. *get_result* takes a single argument which is the virtual path of the template / partial:
+
+    rake deface:get_result[shared/_head]
+
+    rake deface:get_result['admin/products/index']
+
+**deface:test_selector** - Applies a given CSS selector against a parital or template and outputs the markup for each match (if any). *test_selector* requires two arguments, the first is the virtual_path for the partial / template, the second is the CSS selector to apply:
+
+    rake deface:test_selector[shared/_head,title]
+
+    rake deface:test_selector['admin/products/index','div.toolbar']
+
+
 Implementation
 ==============
 

data/Rakefile

@@ -1,24 +1,12 @@
 require 'rake'
 require 'rubygems'
 require 'rake/testtask'
-require 'rake/rdoctask'
+require 'rdoc/task'
 require 'rspec'
 require 'rspec/core/rake_task'
 
 desc 'Default: run specs'
 task :default => :spec  
-Rspec::Core::RakeTask.new do |t|
+RSpec::Core::RakeTask.new do |t|
   t.pattern = "spec/**/*_spec.rb"
 end
-
-
-task :default => :spec
-
-desc 'Generate documentation for the deface plugin.'
-Rake::RDocTask.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'Spreme'
-  rdoc.options << '--line-numbers' << '--inline-source'
-  rdoc.rdoc_files.include('README')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end

data/deface.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "deface"
-  s.version = "0.6.1"
+  s.version = "0.7.0"
 
   s.authors = ["Brian D Quinn"]
   s.description = "Deface is a library that allows you to customize ERB views in a Rails application without editing the underlying view."

data/lib/deface.rb

@@ -4,7 +4,10 @@ require "deface/action_view_extensions"
 require "deface/template_helper"
 require "deface/override"
 require "deface/parser"
+require "deface/environment"
 
 module Deface
-  require 'deface/railtie' if defined?(Rails)
+  if defined?(Rails)
+    require "deface/railtie"
+  end
 end

data/lib/deface/environment.rb

@@ -0,0 +1,30 @@
+module Deface
+
+  class Environment
+    attr_accessor :overrides
+    def initialize
+      @overrides = Overrides.new
+    end
+  end
+
+  class Environment::Overrides
+    attr_accessor :all
+
+    def initialize
+      @all = {}
+    end
+
+    def find(*args)
+      Deface::Override.find(*args)
+    end
+
+      def early_check
+        Deface::Override._early.each do |args|
+          Deface::Override.new(args)
+        end
+
+        Deface::Override._early.clear
+      end
+  end
+end
+

data/lib/deface/override.rb

@@ -2,11 +2,12 @@ module Deface
   class Override
     include Deface::TemplateHelper
 
-    cattr_accessor :all, :actions
+    cattr_accessor :actions, :_early
     attr_accessor :args
 
-    @@all ||= {}
-    @@actions = [:remove, :replace, :insert_after, :insert_before, :insert_top, :insert_bottom, :set_attributes]
+    @@_early = []
+    @@actions = [:remove, :replace, :replace_contents, :insert_after, :insert_before, :insert_top, :insert_bottom, :set_attributes]
+    @@sources = [:text, :partial, :template]
 
     # Initializes new override, you must supply only one Target, Action & Source
     # parameter for each override (and any number of Optional parameters).
@@ -21,6 +22,7 @@ module Deface
     #
     # * <tt>:remove</tt> - Removes all elements that match the supplied selector
     # * <tt>:replace</tt> - Replaces all elements that match the supplied selector
+    # * <tt>:replace_contents</tt> - Replaces the contents of all elements that match the supplied selector
     # * <tt>:insert_after</tt> - Inserts after all elements that match the supplied selector
     # * <tt>:insert_before</tt> - Inserts before all elements that match the supplied selector
     # * <tt>:insert_top</tt> - Inserts inside all elements that match the supplied selector, before all existing child
@@ -42,6 +44,10 @@ module Deface
     #   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 comparsion.
+    # * <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.
     # * <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:
@@ -53,15 +59,43 @@ module Deface
     # * <tt>:attributes</tt> - A hash containing all the attributes to be set on the matched elements, eg: :attributes => {:class => "green", :title => "some string"}
     #
     def initialize(args)
-      @args = args
+      unless Rails.application.try(:config).try(:deface)
+        @@_early << args
+        warn "[WARNING] Deface railtie has not initialized yet, override '#{args[:name]}' is being declared too early."
+        return
+      end
 
-      raise(ArgumentError, "Invalid action") if self.action.nil?
+      raise(ArgumentError, ":name must be defined") unless args.key? :name
       raise(ArgumentError, ":virtual_path must be defined") if args[:virtual_path].blank?
 
-      key = args[:virtual_path].to_sym
+      virtual_key = args[:virtual_path].to_sym
+      name_key = args[:name].to_s.parameterize 
+
+      self.class.all[virtual_key] ||= {}
+
+      if self.class.all[virtual_key].has_key? name_key
+        #updating exisiting override
+
+        @args = self.class.all[virtual_key][name_key].args
 
-      @@all[key] ||= {}
-      @@all[key][args[:name].to_s.parameterize] = self
+        #check if the action is being redefined, and reject old action
+        if (@@actions & args.keys).present?
+          @args.reject!{|key, value| (@@actions & @args.keys).include? key }
+        end
+
+        #check if the source is being redefined, and reject old action
+        if (@@sources & args.keys).present?
+          @args.reject!{|key, value| (@@sources & @args.keys).include? key }
+        end
+
+        @args.merge!(args)
+      else
+        #initializing new override
+        @args = args
+        raise(ArgumentError, ":action is invalid") if self.action.nil?
+      end
+
+      self.class.all[virtual_key][name_key] = self
     end
 
     def selector
@@ -80,16 +114,16 @@ module Deface
         if @args[:sequence].key? :before
           ref_name = @args[:sequence][:before]
 
-          if @@all[key].key? ref_name.to_s
-            return @@all[key][ref_name.to_s].sequence - 1
+          if self.class.all[key].key? ref_name.to_s
+            return self.class.all[key][ref_name.to_s].sequence - 1
           else
             return 100
           end
         elsif @args[:sequence].key? :after
           ref_name = @args[:sequence][:after]
 
-          if @@all[key].key? ref_name.to_s
-            return @@all[key][ref_name.to_s].sequence + 1
+          if self.class.all[key].key? ref_name.to_s
+            return self.class.all[key][ref_name.to_s].sequence + 1
           else
             return 100
           end
@@ -139,7 +173,7 @@ module Deface
 
       valid = self.original_source.to_s.gsub(/\s/, '') == match.to_s.gsub(/\s/, '')
 
-      if !valid && defined?(Rails) == "constant"
+      if !valid && defined?(Rails.logger) == "constant"
         Rails.logger.error "\e[1;32mDeface: [WARNING]\e[0m The original source for '#{self.name}' has changed, this override should be reviewed to ensure it's still valid."
       end
 
@@ -151,7 +185,8 @@ module Deface
     end
 
     def end_selector
-      @args[:closing_selector]
+      return nil if @args[:closing_selector].blank?
+      "#{self.selector} ~ #{@args[:closing_selector]}"
     end
 
     def attributes
@@ -164,12 +199,10 @@ module Deface
       overrides = find(details)
 
       if log
-        @enable_logging ||= defined?(Rails) 
-      else
-        @enable_logging = false
+        log = defined?(Rails.logger) 
       end
 
-      if @enable_logging && overrides.size > 0
+      if log && overrides.size > 0
         Rails.logger.info "\e[1;32mDeface:\e[0m #{overrides.size} overrides found for '#{details[:virtual_path]}'"
       end
 
@@ -178,7 +211,7 @@ module Deface
 
         overrides.each do |override|
           if override.disabled?
-            Rails.logger.info("\e[1;32mDeface:\e[0m '#{override.name}' is disabled") if @enable_logging
+            Rails.logger.info("\e[1;32mDeface:\e[0m '#{override.name}' is disabled") if log
             next
           end
 
@@ -187,7 +220,7 @@ module Deface
 
             matches = doc.css(override.selector)
 
-            if @enable_logging
+            if log
               Rails.logger.send(matches.size == 0 ? :error : :info, "\e[1;32mDeface:\e[0m '#{override.name}' matched #{matches.size} times with '#{override.selector}'")
             end
 
@@ -199,14 +232,25 @@ module Deface
                   match.replace ""
                 when :replace
                   match.replace override.source_element
+                when :replace_contents
+                  match.children.remove 
+                  match.add_child(override.source_element)
                 when :insert_before
                   match.before override.source_element
                 when :insert_after
                   match.after override.source_element
                 when :insert_top
-                  match.children.before(override.source_element)
+                  if match.children.size == 0
+                    match.children = override.source_element
+                  else
+                    match.children.before(override.source_element)
+                  end
                 when :insert_bottom
-                  match.children.after(override.source_element)
+                  if match.children.size == 0
+                    match.children = override.source_element
+                  else
+                    match.children.after(override.source_element)
+                  end
                 when :set_attributes
                   override.attributes.each do |name, value|
                     match.set_attribute(name.to_s, value.to_s)
@@ -217,6 +261,7 @@ module Deface
           else
             # targeting range of elements as end_selector is present
             starting    = doc.css(override.selector).first
+
             if starting && starting.parent
               ending = starting.parent.css(override.end_selector).first
             else
@@ -224,14 +269,29 @@ module Deface
             end
 
             if starting && ending
+              if log
+                Rails.logger.info("\e[1;32mDeface:\e[0m '#{override.name}' matched starting with '#{override.selector}' and ending with '#{override.end_selector}'")
+              end
+
               elements = select_range(starting, ending)
 
-              if override.action == :replace
-                starting.before(override.source_element)
+              case override.action
+                when :remove
+                  elements.map &:remove
+                when :replace
+                  starting.before(override.source_element)
+                  elements.map &:remove
+                when :replace_contents
+                  elements[1..-2].map &:remove
+                  starting.after(override.source_element)
+              end
+            else
+              if starting.nil?
+                Rails.logger.info("\e[1;32mDeface:\e[0m '#{override.name}' failed to match with starting selector '#{override.selector}'")
+              else
+                Rails.logger.info("\e[1;32mDeface:\e[0m '#{override.name}' failed to match with end selector '#{override.end_selector}'")
               end
 
-              #now remove all matched elements
-              elements.map &:remove
             end
           end
 
@@ -251,17 +311,22 @@ module Deface
     # finds all applicable overrides for supplied template
     #
     def self.find(details)
-      return [] if @@all.empty? || details.empty?
+      return [] if self.all.empty? || details.empty?
 
       virtual_path = details[:virtual_path]
       return [] if virtual_path.nil?
 
       result = []
-      result << @@all[virtual_path.to_sym].try(:values)
+      result << self.all[virtual_path.to_sym].try(:values)
 
       result.flatten.compact.sort_by &:sequence
     end
 
+
+    def self.all
+      Rails.application.config.deface.overrides.all
+    end
+
     private
       # finds all elements upto closing sibling in nokgiri document
       #

data/lib/deface/railtie.rb

@@ -3,5 +3,10 @@ module Deface
     rake_tasks do
       load File.join([File.dirname(__FILE__) , "../../tasks/deface.rake"])
     end
+
+    initializer "deface.environment" do |app|
+      app.config.deface = Deface::Environment.new
+      app.config.deface.overrides.early_check
+    end
   end
 end

data/spec/deface/environment_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+module Deface
+  describe Environment do
+    include_context "mock Rails"
+
+    before(:each) do 
+      #declare this override (early) before Rails.application.deface is present
+      silence_warnings do
+        Deface::Override._early.clear
+        Deface::Override.new(:virtual_path => "posts/edit", :name => "Posts#edit", :replace => "h1", :text => "<h1>Urgh!</h1>")
+      end
+    end
+
+    include_context "mock Rails.application"
+
+    before(:each) do
+      Deface::Override.new(:virtual_path => "posts/index", :name => "Posts#index", :replace => "h1", :text => "<h1>Argh!</h1>")
+      Deface::Override.new(:virtual_path => "posts/new", :name => "Posts#new", :replace => "h1", :text => "<h1>argh!</h1>")
+    end
+
+    describe ".overrides" do
+
+      it "should return all overrides" do
+        Rails.application.config.deface.overrides.all.size.should == 2
+        Rails.application.config.deface.overrides.all.should == Deface::Override.all 
+      end
+
+      it "should find overrides" do
+        Rails.application.config.deface.overrides.find(:virtual_path => "posts/new").size.should == 1
+      end
+    end
+
+    describe "#_early" do
+      it "should contain one override" do
+        Deface::Override._early.size.should == 1
+      end
+
+      it "should initialize override and be emtpy after early_check" do
+        before_count = Rails.application.config.deface.overrides.all.size
+        Rails.application.config.deface.overrides.early_check
+
+         Deface::Override._early.size.should == 0
+         Rails.application.config.deface.overrides.all.size.should == (before_count + 1)
+      end
+    end
+
+  end
+end

data/spec/deface/override_spec.rb

@@ -2,12 +2,15 @@ require 'spec_helper'
 
 module Deface
   describe Override do
+    include_context "mock Rails.application"
+
     before(:each) do
       @override = Deface::Override.new(:virtual_path => "posts/index", :name => "Posts#index", :replace => "h1", :text => "<h1>Argh!</h1>")
     end
 
     it "should return correct action" do
       Deface::Override.actions.each do |action|
+        Rails.application.config.deface.overrides.all.clear
         @override = Deface::Override.new(:virtual_path => "posts/index", :name => "Posts#index", action => "h1", :text => "<h1>Argh!</h1>")
         @override.action.should == action
       end
@@ -29,21 +32,28 @@ module Deface
       end
     end
 
-    describe "#validate_original" do
+    describe "#validate_original when :original is not present" do
       before(:each) do
-        @original = Deface::Override.new(:virtual_path => "posts/index", :name => "Posts#index", :replace => "h1", :text => "<h1>Argh!</h1>", :original => "<p><%= something %></p>")
+        @original = Deface::Override.new(:virtual_path => "posts/index", :name => "Posts#index", :replace => "h1", :text => "<h1>Argh!</h1>")
       end
 
-      it "should return true when :original is not present" do
-        @override.validate_original("").should be_true
+      it "should not validate" do
+        @override.validate_original("<p>this gets ignored</p>").should be_true
+      end
+
+    end
+
+    describe "#validate_original when :original is present" do
+      before(:each) do
+        @original = Deface::Override.new(:virtual_path => "posts/index", :name => "Posts#index", :replace => "h1", :text => "<h1>Argh!</h1>", :original => "<p><%= something %></p>")
       end
 
-      it "should return true when :original present, and input contains similar (ignoring whitespace)" do
+      it "should return true when input contains similar (ignoring whitespace)" do
         @original.validate_original("<p><code erb-loud> something </code></p>").should be_true
         @original.validate_original("<p><code erb-loud>something\n</code>  </p>").should be_true
       end
 
-      it "should return false when :original present, and input contains different string" do
+      it "should return false when and input contains different string" do
         @original.validate_original("wrong").should be_false
       end
     end
@@ -121,25 +131,60 @@ module Deface
       end
     end
 
-    describe "when redefining an existing virutal_path and name" do
+    describe "when redefining an override without changing action or source type" do
       before(:each) do
-        @replacement = Deface::Override.new(:virtual_path => "posts/index", :name => "Posts#index", :replace => "h1", :text => "<h1>Arrrr!</h1>")
+        Rails.application.config.deface.overrides.all.clear
+        @override    = Deface::Override.new(:virtual_path => "posts/index", :name => "Posts#index", :text => "<h1>Argh!</h1>", :replace => "h1")
+        expect {
+          @replacement = Deface::Override.new(:virtual_path => "posts/index", :name => "Posts#index", :text => "<h1>Arrrr!</h1>")
+        }.to change{Rails.application.config.deface.overrides.all.size}.by(0)
+      end
+
+      it "should return new source" do
+        @replacement.source.should_not == "<h1>Argh!</h1>"
+        @replacement.source.should == "<h1>Arrrr!</h1>"
       end
 
-      it "should not increase all#size by 1" do
+    end
+
+    describe "when redefining an override when changing action" do
+      before(:each) do
+        Rails.application.config.deface.overrides.all.clear
+        @override    = Deface::Override.new(:virtual_path => "posts/index", :name => "Posts#index", :replace => "h1")
         expect {
-          Deface::Override.new(:virtual_path => "posts/index", :name => "Posts#index", :replace => "h1", :text => "<h1>Arrrr!</h1>")
-        }.to change{Deface::Override.all.size}.by(0)
+          @replacement = Deface::Override.new(:virtual_path => "posts/index", :name => "Posts#index", :insert_after => "h1")
+        }.to change{Rails.application.config.deface.overrides.all.size}.by(0)
+      end
+
+      it "should return new action" do
+        @replacement.action.should == :insert_after
+      end
+
+      it "should remove old action" do
+        @replacement.args.has_key?(:replace).should be_false
+      end
+
+    end
+
+    describe "when redefining an override when changing source type" do
+      before(:each) do
+        #stub view paths to be local spec/assets directory
+        ActionController::Base.stub(:view_paths).and_return([File.join(File.dirname(__FILE__), '..', "assets")])
 
+        Rails.application.config.deface.overrides.all.clear
+        @override    = Deface::Override.new(:virtual_path => "posts/index", :name => "Posts#index", :partial => "shared/post", :replace => "h1")
+        expect {
+          @replacement = Deface::Override.new(:virtual_path => "posts/index", :name => "Posts#index", :text => "<p>I do be a pirate!</p>")
+        }.to change{Rails.application.config.deface.overrides.all.size}.by(0)
       end
 
       it "should return new source" do
-        @replacement.source.should_not == @override.source
-        @replacement.source.should == "<h1>Arrrr!</h1>"
+        @override.source.should == "<p>I do be a pirate!</p>"
       end
 
     end
 
+
     describe "#sequence" do
       it "should calculate correct after sequences" do
         @third = Deface::Override.new(:virtual_path => "posts/index", :name => "third", :insert_after => "li:contains('second')", :text => "<li>third</li>", :sequence => {:after => "second"})
@@ -157,19 +202,38 @@ module Deface
 
         @second.sequence.should == 99
         @first.sequence.should == 98
-
       end
 
-      
       it "should calculate correct sequences with invalid hash" do
         @second = Deface::Override.new(:virtual_path => "posts/index", :name => "second", :insert_after => "li", :text => "<li>second</li>", :sequence => {})
         @first = Deface::Override.new(:virtual_path => "posts/show", :name => "first", :replace => "li", :text => "<li>first</li>", :sequence => {:before => "second"})
 
         @second.sequence.should == 100
         @first.sequence.should == 100
+      end
+
+    end
+
 
+    describe "#end_selector" do
+      it "should return nil when closing_selector is not defined" do
+        @override.end_selector.should be_nil
       end
 
+      it "should return nil when closing_selector is an empty string" do
+        @override = Deface::Override.new(:virtual_path => "posts/index", :name => "Posts#index", :replace => "h1", :closing_selector => "", :text => "<h1>Argh!</h1>")
+        @override.end_selector.should be_nil
+      end
+
+      it "should return nil when closing_selector is nil" do
+        @override = Deface::Override.new(:virtual_path => "posts/index", :name => "Posts#index", :replace => "h1", :closing_selector => nil, :text => "<h1>Argh!</h1>")
+        @override.end_selector.should be_nil
+      end
+
+      it "should return combined sibling selector when closing_selector is present" do
+        @override = Deface::Override.new(:virtual_path => "posts/index", :name => "Posts#index", :replace => "h1", :closing_selector => "h4", :text => "<h1>Argh!</h1>")
+        @override.end_selector.should == "h1 ~ h4"
+      end
     end
 
   end

data/spec/deface/parser_spec.rb

@@ -14,19 +14,27 @@ module Deface
       it "should parse html document" do
         parsed = Deface::Parser.convert("<html><head><title>Hello</title></head><body>test</body>")
         parsed.should be_an_instance_of(Nokogiri::HTML::Document)
-        parsed = parsed.to_s.split("\n")[1..-1]
-        parsed.should == "<html>\n<head><title>Hello</title></head>\n<body>test</body>\n</html>".split("\n") #ignore doctype added by noko
+        parsed = parsed.to_s.split("\n")[1..-1] #ignore doctype added by noko
+
+        if RUBY_VERSION < "1.9"
+          parsed.should == "<html>\n<head><title>Hello</title></head>\n<body>test</body>\n</html>".split("\n")
+        else
+          parsed.should == "<html>\n<head>\n<meta http-equiv=\"Content-Type\" content=\"text/html; charset=US-ASCII\">\n<title>Hello</title>\n</head>\n<body>test</body>\n</html>".split("\n")
+        end
 
         parsed = Deface::Parser.convert("<html><title>test</title></html>")
         parsed.should be_an_instance_of(Nokogiri::HTML::Document)
-        parsed = parsed.to_s.split("\n")[1..-1]
-        parsed.should == "<html><head><title>test</title></head></html>".split("\n") #ignore doctype added by noko
-
+        parsed = parsed.to_s.split("\n")[1..-1] #ignore doctype added by noko
+        if RUBY_VERSION < "1.9"
+          parsed.should == ["<html><head><title>test</title></head></html>"]
+        else
+          parsed.should == "<html><head>\n<meta http-equiv=\"Content-Type\" content=\"text/html; charset=US-ASCII\">\n<title>test</title>\n</head></html>".split("\n")
+        end
 
         parsed = Deface::Parser.convert("<html><p>test</p></html>")
         parsed.should be_an_instance_of(Nokogiri::HTML::Document)
-        parsed = parsed.to_s.split("\n")[1..-1]
-        parsed.should == "<html><body><p>test</p></body></html>".split("\n") #ignore doctype added by noko
+        parsed = parsed.to_s.split("\n")[1..-1] #ignore doctype added by noko
+        parsed.should == "<html><body><p>test</p></body></html>".split("\n") 
       end
 
       it "should parse body tag" do

data/spec/deface/template_helper_spec.rb

@@ -2,6 +2,7 @@ require 'spec_helper'
 
 module Deface
   describe TemplateHelper do
+    include_context "mock Rails.application"
     include Deface::TemplateHelper
 
     describe "load_template_source" do
@@ -30,8 +31,9 @@ module Deface
       end
 
       describe "with overrides defined" do
-        before(:all) do
-          Deface::Override.all.clear
+        include_context "mock Rails.application"
+
+        before(:each) do
           Deface::Override.new(:virtual_path => "shared/_post", :name => "shared#post", :remove => "p")
           Deface::Override.new(:virtual_path => "shared/person", :name => "shared#person", :replace => "p", :text => "<h1>Argh!</h1>")
           Deface::Override.new(:virtual_path => "admin/posts/index", :name => "admin#posts#index", :replace => "h1", :text => "<h1>Argh!</h1>")

data/spec/deface/template_spec.rb

@@ -2,9 +2,7 @@ require 'spec_helper'
 
 module ActionView
   describe Template do
-    before(:all) do
-      Deface::Override.all.clear
-    end
+    include_context "mock Rails.application"
 
     describe "with no overrides defined" do
       before(:each) do
@@ -50,8 +48,19 @@ module ActionView
       end
     end
 
+    describe "with a single remove override with closing_selector defined" do
+      before(:each) do
+        Deface::Override.new(:virtual_path => "posts/index", :name => "Posts#index", :remove => "h1", :closing_selector => "h2")
+        @template = ActionView::Template.new("<h2>I should be safe</h2><span>Before!</span><h1>start</h1><p>some junk</p><div>more junk</div><h2>end</h2><span>After!</span>", "/some/path/to/file.erb", ActionView::Template::Handlers::ERB, {:virtual_path=>"posts/index", :format=>:html})
+      end
+
+      it "should return modified source" do
+        @template.source.should == "<h2>I should be safe</h2><span>Before!</span><span>After!</span>"
+      end
+    end
+
     describe "with a single replace override defined" do
-      before(:all) do
+      before(:each) do
         Deface::Override.new(:virtual_path => "posts/index", :name => "Posts#index", :replace => "p", :text => "<h1>Argh!</h1>")
         @template = ActionView::Template.new("<p>test</p>", "/some/path/to/file.erb", ActionView::Template::Handlers::ERB, {:virtual_path=>"posts/index", :format=>:html})
       end
@@ -61,8 +70,41 @@ module ActionView
       end
     end
 
+    describe "with a single replace override with closing_selector defined" do
+      before(:each) do
+        Deface::Override.new(:virtual_path => "posts/index", :name => "Posts#index", :replace => "h1", :closing_selector => "h2", :text => "<span>Argh!</span>")
+        @template = ActionView::Template.new("<h1>start</h1><p>some junk</p><div>more junk</div><h2>end</h2>", "/some/path/to/file.erb", ActionView::Template::Handlers::ERB, {:virtual_path=>"posts/index", :format=>:html})
+      end
+
+      it "should return modified source" do
+        @template.source.should == "<span>Argh!</span>"
+      end
+    end
+
+    describe "with a single replace_contents override defined" do
+      before(:each) do
+        Deface::Override.new(:virtual_path => "posts/index", :name => "Posts#index", :replace_contents => "p", :text => "<h1>Argh!</h1>")
+        @template = ActionView::Template.new("<p><span>Hello</span>I am not a <em>pirate</em></p>", "/some/path/to/file.erb", ActionView::Template::Handlers::ERB, {:virtual_path=>"posts/index", :format=>:html})
+      end
+
+      it "should return modified source" do
+        @template.source.should == "<p><h1>Argh!</h1></p>"
+      end
+    end
+
+    describe "with a single replace_contents override with closing_selector defined" do
+      before(:each) do
+        Deface::Override.new(:virtual_path => "posts/index", :name => "Posts#index", :replace_contents => "h1", :closing_selector => "h2", :text => "<span>Argh!</span>")
+        @template = ActionView::Template.new("<h1>start</h1><p>some junk</p><div>more junk</div><h2>end</h2>", "/some/path/to/file.erb", ActionView::Template::Handlers::ERB, {:virtual_path=>"posts/index", :format=>:html})
+      end
+
+      it "should return modified source" do
+        @template.source.should == "<h1>start</h1><span>Argh!</span><h2>end</h2>"
+      end
+    end
+
     describe "with a single insert_after override defined" do
-      before(:all) do
+      before(:each) do
         Deface::Override.new(:virtual_path => "posts/index", :name => "Posts#index", :insert_after => "img.button", :text => "<% help %>")
 
         @template = ActionView::Template.new("<div><img class=\"button\" src=\"path/to/button.png\"></div>",
@@ -77,7 +119,7 @@ module ActionView
     end
 
     describe "with a single insert_before override defined" do
-      before(:all) do
+      before(:each) do
         Deface::Override.new(:virtual_path => "posts/index", :name => "Posts#index", :insert_after => "ul li:last", :text => "<%= help %>")
 
         @template = ActionView::Template.new("<ul><li>first</li><li>second</li><li>third</li></ul>",
@@ -92,7 +134,7 @@ module ActionView
     end
 
     describe "with a single insert_top override defined" do
-      before(:all) do
+      before(:each) do
         Deface::Override.new(:virtual_path => "posts/index", :name => "Posts#index", :insert_top => "ul", :text => "<li>me first</li>")
 
         @template = ActionView::Template.new("<ul><li>first</li><li>second</li><li>third</li></ul>",
@@ -106,8 +148,23 @@ module ActionView
       end
     end
 
+    describe "with a single insert_top override defined when targetted elemenet has no children" do
+      before(:each) do
+        Deface::Override.new(:virtual_path => "posts/index", :name => "Posts#index", :insert_top => "ul", :text => "<li>first</li><li>second</li><li>third</li>")
+
+        @template = ActionView::Template.new("<ul></ul>",
+                                             "/path/to/file.erb",
+                                             ActionView::Template::Handlers::ERB,
+                                             {:virtual_path=>"posts/index", :format=>:html})
+      end
+
+      it "should return modified source" do
+        @template.source.gsub("\n", "").should == "<ul><li>first</li><li>second</li><li>third</li></ul>"
+      end
+    end
+
     describe "with a single insert_bottom override defined" do
-      before(:all) do
+      before(:each) do
         Deface::Override.new(:virtual_path => "posts/index", :name => "Posts#index", :insert_bottom => "ul", :text => "<li>I'm always last</li>")
 
         @template = ActionView::Template.new("<ul><li>first</li><li>second</li><li>third</li></ul>",
@@ -121,8 +178,23 @@ module ActionView
       end
     end
 
+    describe "with a single insert_bottom override defined when targetted elemenet has no children" do
+      before(:each) do
+        Deface::Override.new(:virtual_path => "posts/index", :name => "Posts#index", :insert_bottom => "ul", :text => "<li>I'm always last</li>")
+
+        @template = ActionView::Template.new("<ul></ul>",
+                                             "/path/to/file.erb",
+                                             ActionView::Template::Handlers::ERB,
+                                             {:virtual_path=>"posts/index", :format=>:html})
+      end
+
+      it "should return modified source" do
+        @template.source.gsub("\n", "").should == "<ul><li>I'm always last</li></ul>"
+      end
+    end
+
     describe "with a single set_attributes override defined" do
-      before(:all) do
+      before(:each) do
         Deface::Override.new(:virtual_path => "posts/index", :name => "Posts#index", :set_attributes => 'img', 
                                       :attributes => {:class => 'pretty', :alt => 'something interesting'})
 
@@ -138,7 +210,7 @@ module ActionView
     end
 
     describe "with a single disabled override defined" do
-      before(:all) do
+      before(:each) do
         Deface::Override.new(:virtual_path => "posts/index", :name => "Posts#index", :remove => "p", :text => "<h1>Argh!</h1>", :disabled => true)
         @template = ActionView::Template.new("<p>test</p><%= raw(text) %>", "/some/path/to/file.erb", ActionView::Template::Handlers::ERB, {:virtual_path=>"posts/index", :format=>:html})
       end
@@ -148,9 +220,8 @@ module ActionView
       end
     end
 
-
     describe "with mulitple sequenced overrides defined" do
-      before(:all) do
+      before(:each) do
         Deface::Override.new(:virtual_path => "posts/index", :name => "third", :insert_after => "li:contains('second')", :text => "<li>third</li>", :sequence => {:after => "second"})
         Deface::Override.new(:virtual_path => "posts/index", :name => "second", :insert_after => "li", :text => "<li>second</li>", :sequence => {:after => "first"})
         Deface::Override.new(:virtual_path => "posts/index", :name => "first", :replace => "li", :text => "<li>first</li>")

data/spec/spec_helper.rb

@@ -3,3 +3,27 @@ require 'rspec'
 require 'action_view'
 require 'action_controller'
 require 'deface'
+
+RSpec.configure do |config|
+  config.mock_framework = :rspec
+end
+
+shared_context "mock Rails" do
+  before(:each) do
+    unless defined? Rails
+      Rails = mock 'Rails'
+    end
+    Rails.stub :application => mock('application')
+    Rails.application.stub :config => mock('config')
+    Rails.application.config.stub :cache_classes => true
+    Rails.application.config.stub :deface => nil
+  end
+end
+
+shared_context "mock Rails.application" do
+  include_context "mock Rails"
+
+  before(:each) do
+    Rails.application.config.stub :deface => Deface::Environment.new
+  end
+end

data/tasks/deface.rake

@@ -1,10 +1,13 @@
+require 'deface'
+
 namespace :deface do
-  desc 'Gets source of html element from template.'
-  task :get_source, [:template_path, :selector] => [:environment] do |t, args|
-    include Deface::TemplateHelper
+  include Deface::TemplateHelper
+
+  desc 'Applies selectors to given partial/template, and returns match(s) source.'
+  task :test_selector, [:virtual_path, :selector] => [:environment] do |t, args|
 
     begin
-      source = load_template_source(args[:template_path], false)
+      source = load_template_source(args[:virtual_path], false)
       output = element_source(source, args[:selector])
     rescue
       puts "Failed to find tempalte/partial"
@@ -15,7 +18,7 @@ namespace :deface do
     if output.empty?
       puts "0 matches found"
     else
-      puts "Querying '#{args[:template_path]}' for '#{args[:selector]}'"
+      puts "Querying '#{args[:virtual_path]}' for '#{args[:selector]}'"
       output.each_with_index do |content, i|
         puts "---------------- Match #{i+1} ----------------"
         puts content
@@ -23,4 +26,34 @@ namespace :deface do
     end
 
   end
+
+
+  desc 'Get the resulting markup for a partial/template'
+  task :get_result, [:virtual_path] => [:environment] do |t,args|
+    puts "---------------- Before ----------------"
+    before = load_template_source(args[:virtual_path], false, false).dup
+    puts before
+    puts ""
+
+    overrides = Deface::Override.find(:virtual_path => args[:virtual_path])
+    puts "---------------- Overrides (#{overrides.size})--------"
+    overrides.each do |override|
+      puts "- '#{override.name}' will#{ ' NOT' if override.args[:disabled]} be applied."
+    end
+    puts ""
+
+    puts "---------------- After ----------------"
+    after = load_template_source(args[:virtual_path], false, true).dup
+    puts after
+
+    begin
+      puts ""
+      puts "---------------- Diff -----------------"
+      puts Diffy::Diff.new(before, after).to_s(:color)
+    rescue
+      puts "Add 'diffy' to your Gemfile to see the diff."
+    end
+
+  end
+
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: deface
 version: !ruby/object:Gem::Version 
-  hash: 5
+  hash: 3
   prerelease: 
   segments: 
   - 0
-  - 6
-  - 1
-  version: 0.6.1
+  - 7
+  - 0
+  version: 0.7.0
 platform: ruby
 authors: 
 - Brian D Quinn
@@ -15,8 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-27 00:00:00 +01:00
-default_executable: 
+date: 2011-10-05 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: nokogiri
@@ -84,6 +83,7 @@ files:
 - init.rb
 - lib/deface.rb
 - lib/deface/action_view_extensions.rb
+- lib/deface/environment.rb
 - lib/deface/override.rb
 - lib/deface/parser.rb
 - lib/deface/railtie.rb
@@ -91,13 +91,13 @@ files:
 - spec/assets/admin/posts/index.html.erb
 - spec/assets/shared/_post.html.erb
 - spec/assets/shared/person.html.erb
+- spec/deface/environment_spec.rb
 - spec/deface/override_spec.rb
 - spec/deface/parser_spec.rb
 - spec/deface/template_helper_spec.rb
 - spec/deface/template_spec.rb
 - spec/spec_helper.rb
 - tasks/deface.rake
-has_rdoc: true
 homepage: http://github.com/railsdog/deface
 licenses: []
 
@@ -127,7 +127,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Deface is a library that allows you to customize ERB views in Rails
@@ -135,6 +135,7 @@ test_files:
 - spec/assets/admin/posts/index.html.erb
 - spec/assets/shared/_post.html.erb
 - spec/assets/shared/person.html.erb
+- spec/deface/environment_spec.rb
 - spec/deface/override_spec.rb
 - spec/deface/parser_spec.rb
 - spec/deface/template_helper_spec.rb