deface 0.2.0 → 0.3.0

data/.gitignore

@@ -0,0 +1,3 @@
+*.swp
+.DS_Store
+pkg

data/deface.gemspec

@@ -5,39 +5,20 @@
 
 Gem::Specification.new do |s|
   s.name = %q{deface}
-  s.version = "0.2.0"
+  s.version = "0.3.0"
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Brian Quinn"]
-  s.date = %q{2010-08-31}
   s.description = %q{Deface is a library that allows you to customize ERB views in a Rails application without editing the underlying view.}
   s.email = %q{brian@railsdog.com}
   s.extra_rdoc_files = [
     "README.markdown"
   ]
-  s.files = [
-    "MIT-LICENSE",
-     "README.markdown",
-     "Rakefile",
-     "VERSION",
-     "deface.gemspec",
-     "init.rb",
-     "lib/deface.rb",
-     "lib/deface/action_view_extensions.rb",
-     "lib/deface/override.rb",
-     "lib/deface/parser.rb"
-  ]
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.homepage = %q{http://github.com/BDQ/Deface}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.7}
   s.summary = %q{Deface is a library that allows you to customize ERB views in Rails}
-  s.test_files = [
-    "spec/deface/override_spec.rb",
-     "spec/deface/parser_spec.rb",
-     "spec/deface/template_spec.rb",
-     "spec/spec_helper.rb"
-  ]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION

data/lib/deface.rb

@@ -1,5 +1,6 @@
 require "action_view"
 require "action_controller"
 require "deface/action_view_extensions"
+require "deface/template_helper"
 require "deface/override"
 require "deface/parser"

data/lib/deface/action_view_extensions.rb

@@ -2,32 +2,7 @@ ActionView::Template.class_eval do
   alias_method :rails_initialize, :initialize
 
   def initialize(source, identifier, handler, details)
-    overrides = Deface::Override.find(details)
-
-    unless overrides.empty?
-      doc = Deface::Parser.convert_fragment(source)
-
-      overrides.each do |override|
-        doc.css(override.selector).each do |match|
-
-          match.replace case override.action
-            when :remove
-              ""
-            when :replace
-              Deface::Parser.convert_fragment(override.source.clone)
-            when :insert_before
-              Deface::Parser.convert_fragment(override.source.clone << match.to_s)
-            when :insert_after
-              Deface::Parser.convert_fragment(match.to_s << override.source.clone)
-          end
-
-        end
-      end
-
-      source = doc.to_s
-
-      Deface::Parser.undo_erb_markup!(source)
-    end
+    source = Deface::Override.apply(source, details)
 
     rails_initialize(source, identifier, handler, details)
   end

data/lib/deface/override.rb

@@ -1,10 +1,12 @@
 module Deface
   class Override
+    include Deface::TemplateHelper
+
     cattr_accessor :all, :actions
     attr_accessor :args
 
     @@all ||= {}
-    @@actions = [:remove, :replace, :insert_after, :insert_before]
+    @@actions = [:remove, :replace, :insert_after, :insert_before, :insert_top, :insert_bottom]
 
     # Initializes new override, you must supply only one Target, Action & Source
     # parameter for each override (and any number of Optional parameters).
@@ -21,6 +23,8 @@ module Deface
     # * <tt>:replace</tt> - Replaces 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
+    # * <tt>:insert_bottom</tt> - Inserts inside all elements that match the supplied selector, after all existing child
     #
     # ==== Source
     #
@@ -32,10 +36,15 @@ module Deface
     #
     # * <tt>:name</tt> - Unique name for override so it can be identified and modified later.
     #   This needs to be unique within the same :virtual_path
+    # * <tt>:disabled</tt> - When set to true the override will not be applied.
+
 
     def initialize(args)
       @args = args
 
+      raise(ArgumentError, "Invalid action") if self.action.nil?
+      raise(ArgumentError, ":virtual_path must be defined") if args[:virtual_path].blank?
+
       key = args[:virtual_path].to_sym
 
       @@all[key] ||= {}
@@ -46,6 +55,10 @@ module Deface
       @args[self.action]
     end
 
+    def name
+      @args[:name]
+    end
+
     def action
       (@@actions & @args.keys).first
     end
@@ -62,8 +75,100 @@ module Deface
       Deface::Parser.erb_markup!(erb)
     end
 
+    def source_element
+      @converted_source ||= Deface::Parser.convert(source.clone).to_s
+    end
+
+    def disabled?
+      @args.key?(:disabled) ? @args[:disabled] : false
+    end
+
+    def end_selector
+      @args[:closing_selector]
+    end
+
+    # applies all applicable overrides to given source
+    #
+    def self.apply(source, details)
+      overrides = find(details)
+      @enable_logging ||= (defined?(Rails) == "constant" ? true : false)
+
+      if @enable_logging && overrides.size > 0
+        Rails.logger.info "\e[1;32mDeface:\e[0m #{overrides.size} overrides found for #{details[:virtual_path]}"
+      end
+
+      unless overrides.empty?
+        doc = Deface::Parser.convert(source)
+
+        overrides.each do |override|
+          if override.disabled?
+            if @enable_logging
+              Rails.logger.info "\e[1;32mDeface:\e[0m #{override.name} is disabled"
+            end
+            next
+          end
+
+          if override.end_selector.blank?
+            # single css selector
+
+            matches = doc.css(override.selector)
+
+            if @enable_logging
+              Rails.logger.info "\e[1;32mDeface:\e[0m #{override.name} matched #{matches.size} times with #{override.selector}"
+            end
+
+            matches.each do |match|
+              case override.action
+                when :remove
+                  match.replace ""
+                when :replace
+                  match.replace 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)
+                when :insert_bottom
+                  match.children.after(override.source_element)
+              end
+
+            end
+          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
+              ending = doc.css(override.end_selector).first
+            end
+
+            if starting && ending
+              elements = select_range(starting, ending)
+
+              if override.action == :replace
+                starting.before(override.source_element)
+              end
+
+              #now remove all matched elements
+              elements.map &:remove
+            end
+          end
+
+        end
+
+        source = doc.to_s
+
+        Deface::Parser.undo_erb_markup!(source)
+      end
+
+      source
+    end
+
+    # finds all applicable overrides for supplied template
+    #
     def self.find(details)
-      return [] unless @@all
+      return [] if @@all.empty? || details.empty?
 
       result = []
 
@@ -74,16 +179,10 @@ module Deface
     end
 
     private
-      def load_template_source(virtual_path, partial)
-        parts = virtual_path.split("/")
-
-        @lookup_context ||= ActionView::LookupContext.new(ActionController::Base.view_paths, {:formats => [:html]})
-
-        if parts.size == 2
-          return @lookup_context.find(parts[1], parts[0], partial).source
-        else
-          return ""
-        end
+      # finds all elements upto closing sibling in nokgiri document
+      #
+      def self.select_range(first, last)
+        first == last ? [first] : [first, *select_range(first.next, last)]
       end
 
   end

data/lib/deface/parser.rb

@@ -1,5 +1,6 @@
 require 'nokogiri'
 require 'erubis'
+require 'cgi'
 
 module Deface
   class Parser
@@ -11,6 +12,11 @@ module Deface
                        {"%>"  => "</code>"} ]
 
       replacements.each{ |h| h.each { |replace, with| source.gsub! replace, with } }
+
+      source.scan(/(<code.*?>)((?:(?!<\/code>)[\s\S])*)(<\/code>)/).each do |match|
+        source.gsub!("#{match[0]}#{match[1]}#{match[2]}", "#{match[0]}#{CGI.escapeHTML(match[1])}#{match[2]}")
+      end
+
       source
     end
 
@@ -20,20 +26,30 @@ module Deface
       replacements = [ {"<code erb-silent>" => '<%'},
                        {"<code erb-loud>"   => '<%='},
                        {"</code>"           => '%>'},
-                       {/(<|&lt;)code erb-silent(&gt;|>)/ => '<%'},
-                       {/(<|&lt;)code erb-loud(&gt;|>)/   => '<%='},
-                       {/(<|&lt;)\/code(&gt;|>)/          => '%>'},
-                       {/(?!=<%=?)&gt;(?=.*%>)/           => '>'},
-                       {/(?!=<%=?)&lt;(?=.*%>)/           => '<'}]
+                       {/(<|&lt;)code(\s|%20)erb-silent(&gt;|>)/ => '<%'},
+                       {/(<|&lt;)code(\s|%20)erb-loud(&gt;|>)/   => '<%='},
+                       {/(<|&lt;)\/code(&gt;|>)/                 => '%>'} ]
 
       replacements.each{ |h| h.each { |replace, with| source.gsub! replace, with } }
+
+      #un-escape changes from Nokogiri and erb-markup!
+      source.scan(/(<%.*?)((?:(?!%>)[\s\S])*)(%>)/).each do |match|
+        escaped = URI.unescape match[1]
+        escaped = CGI.unescapeHTML CGI.unescapeHTML(escaped)
+        source.gsub!("#{match[0]}#{match[1]}#{match[2]}", "#{match[0]}#{escaped}#{match[2]}")
+      end
+
       source
     end
 
-
-    def self.convert_fragment(source)
+    def self.convert(source)
       erb_markup!(source)
-      Nokogiri::HTML::DocumentFragment.parse(source)
+
+      if source =~ /(<html.*?)((?:(?!>)[\s\S])*)(>)/
+        Nokogiri::HTML::Document.parse(source)
+      else
+        Nokogiri::HTML::DocumentFragment.parse(source)
+      end
     end
 
   end

data/lib/deface/template_helper.rb

@@ -0,0 +1,21 @@
+module Deface
+  module TemplateHelper
+
+    # used to find source for a partial or template using virutal_path
+    def load_template_source(virtual_path, partial)
+      parts = virtual_path.split("/")
+
+      if parts.size == 2
+        prefix = ""
+        name = virtual_path
+      else
+        prefix = parts.shift
+        name = parts.join("/")
+      end
+
+      @lookup_context ||= ActionView::LookupContext.new(ActionController::Base.view_paths, {:formats => [:html]})
+
+      @lookup_context.find(name, prefix, partial).source
+    end
+  end
+end

data/spec/assets/admin/posts/index.html.erb

@@ -0,0 +1 @@
+<h1>Manage Posts</h1>

data/spec/assets/shared/_post.html.erb

@@ -0,0 +1 @@
+<p>I'm from shared/post partial</p>

data/spec/assets/shared/person.html.erb

@@ -0,0 +1 @@
+<p>I'm from shared/person template</p>

data/spec/deface/override_spec.rb

@@ -17,8 +17,14 @@ module Deface
       @override.selector.should == "h1"
     end
 
-    it "should find by virtual_path" do
-      Deface::Override.find({:virtual_path => "posts/index"}).size.should == 1
+    describe "#find" do
+      it "should find by virtual_path" do
+        Deface::Override.find({:virtual_path => "posts/index"}).size.should == 1
+      end
+
+      it "should return empty array when no details hash passed" do
+        Deface::Override.find({}).should == []
+      end
     end
 
     describe "#new" do
@@ -71,6 +77,17 @@ module Deface
 
     end
 
+    describe "#source_element" do
+      before(:each) do
+        @override = Deface::Override.new(:virtual_path => "posts/index", :name => "Posts#index", :replace => "h1", :text => "<%= method 'x' & 'y' %>")
+      end
+
+      it "should return memoized escaped source" do
+        @override.source_element
+        @override.source_element.should == "<code erb-loud> method 'x' &amp;amp; 'y' </code>"
+      end
+    end
+
     describe "when redefining an existing virutal_path and name" do
       before(:each) do
         @replacement = Deface::Override.new(:virtual_path => "posts/index", :name => "Posts#index", :replace => "h1", :text => "<h1>Arrrr!</h1>")

data/spec/deface/parser_spec.rb

@@ -3,25 +3,50 @@ require 'spec_helper'
 module Deface
   describe Parser do
 
-    describe "#convert_fragment" do
-      it "should parse html" do
-        Deface::Parser.convert_fragment("<h1>Hello</h1>").to_s.should == "<h1>Hello</h1>"
+    describe "#convert" do
+      it "should parse html fragment" do
+        Deface::Parser.convert("<h1>Hello</h1>").should be_an_instance_of(Nokogiri::HTML::DocumentFragment)
+        Deface::Parser.convert("<h1>Hello</h1>").to_s.should == "<h1>Hello</h1>"
+        Deface::Parser.convert("<title>Hello</title>").should be_an_instance_of(Nokogiri::HTML::DocumentFragment)
+        Deface::Parser.convert("<title>Hello</title>").to_s.should == "<title>Hello</title>"
+      end
+
+      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 = 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 = 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
       end
 
       it "should convert <% ... %>" do
-        Deface::Parser.convert_fragment("<% method_name %>").to_s.should == "<code erb-silent> method_name </code>"
+        Deface::Parser.convert("<% method_name %>").to_s.should == "<code erb-silent> method_name </code>"
       end
 
       it "should convert <%= ... %>" do
-        Deface::Parser.convert_fragment("<%= method_name %>").to_s.should == "<code erb-loud> method_name </code>"
+        Deface::Parser.convert("<%= method_name %>").to_s.should == "<code erb-loud> method_name </code>"
       end
 
       it "should convert nested <% ... %>" do
-        Deface::Parser.convert_fragment("<p id=\"<% method_name %>\"></p>").to_s.should == "<p id=\"&lt;code erb-silent&gt; method_name &lt;/code&gt;\"></p>"
+        Deface::Parser.convert("<p id=\"<% method_name %>\"></p>").to_s.should == "<p id=\"&lt;code erb-silent&gt; method_name &lt;/code&gt;\"></p>"
+      end
+
+      it "should convert nested <%= ... %> including href attribute" do
+        Deface::Parser.convert(%(<a href="<%= x 'y' + "z" %>">A Link</a>)).to_s.should == "<a href=\"&lt;code%20erb-loud&gt;%20x%20'y'%20+%20%22z%22%20&lt;/code&gt;\">A Link</a>"
       end
 
-      it "should convert nested <%= ... %>" do
-        Deface::Parser.convert_fragment("<p id=\"<%= method_name %>\"></p>").to_s.should == "<p id=\"&lt;code erb-loud&gt; method_name &lt;/code&gt;\"></p>"
+      it "should escape contents code tags" do
+        Deface::Parser.convert("<% method_name(:key => 'value') %>").to_s.should == "<code erb-silent> method_name(:key =&gt; 'value') </code>"
       end
     end
 
@@ -38,10 +63,24 @@ module Deface
         Deface::Parser.undo_erb_markup!("<p id=\"&lt;code erb-silent&gt; method_name > 1 &lt;/code&gt;\"></p>").should == "<p id=\"<% method_name > 1 %>\"></p>"
       end
 
+      it "should revert nested <code erb-silent> including href attribute" do
+        Deface::Parser.undo_erb_markup!("<a href=\"&lt;code%20erb-silent&gt;%20method_name%20&lt;/code&gt;\">A Link</a>").should == "<a href=\"<% method_name %>\">A Link</a>"
+      end
+
       it "should revert nested <code erb-loud>" do
         Deface::Parser.undo_erb_markup!("<p id=\"&lt;code erb-loud&gt; method_name < 2 &lt;/code&gt;\"></p>").should == "<p id=\"<%= method_name < 2 %>\"></p>"
       end
 
+      it "should revert nested <code erb-loud> including href attribute" do
+        Deface::Parser.undo_erb_markup!("<a href=\"&lt;code%20erb-loud&gt;%20x%20'y'%20+%20'z'%20&lt;/code&gt;\">A Link</a>").should == %(<a href="<%= x 'y' + 'z' %>">A Link</a>)
+        Deface::Parser.undo_erb_markup!("<a href=\"&lt;code%20erb-loud&gt;%20x%20'y'%20+%20%22z%22%20&lt;/code&gt;\">A Link</a>").should == %(<a href="<%= x 'y' + "z" %>">A Link</a>)
+      end
+
+      it "should unescape contents of code tags" do
+        Deface::Parser.undo_erb_markup!("<% method(:key =&gt; 'value' %>").should == "<% method(:key => 'value' %>"
+        Deface::Parser.undo_erb_markup!("<% method(:key =&gt; 'value'\n %>").should == "<% method(:key => 'value'\n %>"
+      end
+
     end
 
   end

data/spec/deface/template_helper_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+module Deface
+  describe TemplateHelper do
+    include Deface::TemplateHelper
+
+    describe "load_template_source" do
+      before do
+        #stub view paths to be local spec/assets directory
+        ActionController::Base.stub(:view_paths).and_return([File.join(File.dirname(__FILE__), '..', "assets")])
+      end
+
+      it "should return source for partial" do
+        load_template_source("shared/_post", false).should == "<p>I'm from shared/post partial</p>\n"
+      end
+
+      it "should return source for template" do
+        load_template_source("shared/person", false).should == "<p>I'm from shared/person template</p>\n"
+      end
+
+      it "should return source for namespaced template" do
+        load_template_source("admin/posts/index", false).should == "<h1>Manage Posts</h1>\n"
+      end
+
+      it "should raise exception for non-existing file" do
+        lambda { load_template_source("tester/_post", false) }.should raise_error(ActionView::MissingTemplate)
+      end
+
+    end
+  end
+end

data/spec/deface/template_spec.rb

@@ -70,6 +70,48 @@ module ActionView
         end
       end
 
+      describe "with a single insert_top override defined" do
+        before(:all) 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>",
+                                               "/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>me first</li><li>first</li><li>second</li><li>third</li></ul>"
+        end
+      end
+
+      describe "with a single insert_bottom override defined" do
+        before(:all) 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>",
+                                               "/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><li>I'm always last</li></ul>"
+        end
+      end
+
+
+      describe "with a single disabled override defined" do
+        before(:all) 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
+
+        it "should return unmodified source" do
+          @template.source.should == "<p>test</p><%= raw(text) %>"
+        end
+      end
+
     end
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: deface
 version: !ruby/object:Gem::Version 
-  hash: 23
-  prerelease: false
+  hash: 19
+  prerelease: 
   segments: 
   - 0
-  - 2
+  - 3
   - 0
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Brian Quinn
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-31 00:00:00 +01:00
+date: 2011-04-13 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -59,6 +59,7 @@ extensions: []
 extra_rdoc_files: 
 - README.markdown
 files: 
+- .gitignore
 - MIT-LICENSE
 - README.markdown
 - Rakefile
@@ -69,8 +70,13 @@ files:
 - lib/deface/action_view_extensions.rb
 - lib/deface/override.rb
 - lib/deface/parser.rb
+- lib/deface/template_helper.rb
+- spec/assets/admin/posts/index.html.erb
+- spec/assets/shared/_post.html.erb
+- spec/assets/shared/person.html.erb
 - 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
 has_rdoc: true
@@ -103,12 +109,16 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.5.0
 signing_key: 
 specification_version: 3
 summary: Deface is a library that allows you to customize ERB views in Rails
 test_files: 
+- spec/assets/admin/posts/index.html.erb
+- spec/assets/shared/_post.html.erb
+- spec/assets/shared/person.html.erb
 - 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