deface 0.3.0 → 0.4.0

data/README.markdown

@@ -3,25 +3,12 @@ Deface
 
 Deface is a library that allows you to customize 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 both CSS and XPath selectors as supported by Nokogiri.
+It allows you to easily target html & erb elements as the hooks for customization using CSS selectors as supported by Nokogiri.
 
-Deface temporarily converts ERB files into a pseudo HTML markup that can be parsed and queired by Nokogiri, using the following approach:
-
-    <%= some ruby code %>
-
- becomes 
-
-    <code erb-loud> some ruby code </code>
-
-and 
-  
-    <% other ruby code %>
-
-  becomes
-
-    <code erb-silent> other ruby code </code>
+Demo & Testing
+---------------
+You can play with Deface and see it's parsing in action at [deface.heroku.com](http://deface.heroku.com)
 
-Deface overrides have full access to all variables accessible to the view being customized.
 
 Deface::Override
 =======
@@ -42,6 +29,10 @@ Action
 
 * <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, as the first child.
+
+* <tt>:insert_bottom</tt> - Inserts inside all elements that match the supplied selector, as the last child.
+
 Source
 ------
 * <tt>:text</tt> - String containing markup
@@ -83,3 +74,45 @@ Removes any instance of `<%= helper_method %>` in the `posts/new.html.erb" templ
      Deface::Override.new(:virtual_path => "posts/new", 
                           :name => "example-4", 
                           :remove => "code[erb-loud]:contains('helper_method')" )
+
+
+Implementation
+==============
+
+Deface temporarily converts ERB files into a pseudo HTML markup that can be parsed and queired by Nokogiri, using the following approach:
+
+    <%= some ruby code %> 
+
+     becomes 
+
+    <code erb-loud> some ruby code </code>
+
+and 
+  
+    <% other ruby code %>
+
+      becomes
+
+    <code erb-silent> other ruby code </code>
+
+ERB that is contained inside a HTML tag definition is converted slightly differently to ensure a valid HTML document that Nokogiri can parse:
+
+    <p id="<%= dom_id @product %>" <%= "style='display:block';" %>>
+   
+      becomes
+
+    <p data-erb-id="&lt;%= dom_id @product %&gt;"  data-erb-0="&lt;%= &quot;style='display:block';&quot; %&gt;">
+
+Deface overrides have full access to all variables accessible to the view being customized.
+
+Caveats
+======
+
+Due to the use of the Nokogiri library for parsing HTML / view files you need to 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.
+
+Parsing will fail and result in invalid output if ERB blocks are responsible for closing a HTML tag what was opened normally, i.e. don't do this:
+
+
+      <div <%= ">" %>
+
+

data/deface.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{deface}
-  s.version = "0.3.0"
+  s.version = "0.4.0"
 
   s.authors = ["Brian Quinn"]
   s.description = %q{Deface is a library that allows you to customize ERB views in a Rails application without editing the underlying view.}
@@ -15,7 +15,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 = %q{http://github.com/BDQ/Deface}
+  s.homepage = %q{http://github.com/railsdog/deface}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.summary = %q{Deface is a library that allows you to customize ERB views in Rails}

data/lib/deface/parser.rb

@@ -1,5 +1,4 @@
 require 'nokogiri'
-require 'erubis'
 require 'cgi'
 
 module Deface
@@ -7,6 +6,35 @@ module Deface
     # converts erb to markup
     #
     def self.erb_markup!(source)
+
+      #all opening html tags that contain <% %> blocks
+      source.scan(/<\w+[^<>]+(?:<%.*?%>[^<>]*)+/m).each do |line|
+
+        #regexs to catch <% %> inside attributes id="<% something %>" - with double, single or no quotes
+        erb_attrs_regexs = [/([\w-]+)(\s?=\s?)(")([^"]*<%.*?%>[^"]*)/m,
+          /([\w-]+)(\s?=\s?)(')([^']*<%.*?%>[^']*)'/m,
+          /([\w-]+)(\s?=\s?)()(<%.*?%>)(?:\s|>|\z)/m]
+
+        replace_line = erb_attrs_regexs.inject(line.clone) do |replace_line, regex|
+
+          replace_line = line.scan(regex).inject(replace_line) do |replace_line, match|
+            replace_line.sub("#{match[0]}#{match[1]}#{match[2]}#{match[3]}#{match[2]}") { |m| m = " data-erb-#{match[0]}=\"#{CGI.escapeHTML(match[3])}\"" }
+          end
+
+          replace_line
+        end
+
+
+        i = -1
+        #catch all <% %> inside tags id <p <%= test %>> , not inside attrs
+        replace_line.scan(/(<%.*?%>)/m).each do |match|
+          replace_line.sub!(match[0]) { |m| m = " data-erb-#{i += 1}=\"#{CGI.escapeHTML(match[0])}\"" }
+        end
+
+        source.sub!(line) { |m| m = replace_line }
+      end
+
+      #replaces all <% %> not inside opening html tags
       replacements = [ {"<%=" => "<code erb-loud>"},
                        {"<%"  => "<code erb-silent>"},
                        {"%>"  => "</code>"} ]
@@ -14,7 +42,7 @@ module Deface
       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]}")
+        source.sub!("#{match[0]}#{match[1]}#{match[2]}") { |m| m = "#{match[0]}#{CGI.escapeHTML(match[1])}#{match[2]}" }
       end
 
       source
@@ -25,18 +53,21 @@ module Deface
     def self.undo_erb_markup!(source)
       replacements = [ {"<code erb-silent>" => '<%'},
                        {"<code erb-loud>"   => '<%='},
-                       {"</code>"           => '%>'},
-                       {/(<|&lt;)code(\s|%20)erb-silent(&gt;|>)/ => '<%'},
-                       {/(<|&lt;)code(\s|%20)erb-loud(&gt;|>)/   => '<%='},
-                       {/(<|&lt;)\/code(&gt;|>)/                 => '%>'} ]
+                       {"</code>"           => '%>'}]
 
       replacements.each{ |h| h.each { |replace, with| source.gsub! replace, with } }
 
+      source.scan(/data-erb-(\d+)+=(['"])(.*?)\2/m).each do |match|
+        source.gsub!("data-erb-#{match[0]}=#{match[1]}#{match[2]}#{match[1]}") { |m| m = CGI.unescapeHTML(match[2]) }
+      end
+
+      source.scan(/data-erb-([\w-]+)+=(["'])(.*?)\2/m).each do |match|
+        source.gsub!("data-erb-#{match[0]}=#{match[1]}#{match[2]}#{match[1]}") { |m| "#{match[0]}=#{match[1]}#{CGI.unescapeHTML(match[2])}#{match[1]}" }
+      end
+
       #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]}")
+        source.gsub!("#{match[0]}#{match[1]}#{match[2]}") { |m| m = "#{match[0]}#{ CGI.unescapeHTML match[1] }#{match[2]}" }
       end
 
       source

data/spec/deface/parser_spec.rb

@@ -37,12 +37,34 @@ module Deface
         Deface::Parser.convert("<%= method_name %>").to_s.should == "<code erb-loud> method_name </code>"
       end
 
-      it "should convert nested <% ... %>" do
-        Deface::Parser.convert("<p id=\"<% method_name %>\"></p>").to_s.should == "<p id=\"&lt;code erb-silent&gt; method_name &lt;/code&gt;\"></p>"
+      it "should convert first <% ... %> inside html tag" do
+        Deface::Parser.convert("<p <% method_name %>></p>").to_s.should == "<p data-erb-0=\"&lt;% method_name %&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>"
+      it "should convert second <% ... %> inside html tag" do
+        Deface::Parser.convert("<p <% method_name %> <% x = y %>></p>").to_s.should == "<p data-erb-0=\"&lt;% method_name %&gt;\" data-erb-1=\"&lt;% x = y %&gt;\"></p>"
+      end
+
+      it "should convert <% ... %> inside double quoted attr value" do
+        Deface::Parser.convert("<p id=\"<% method_name %>\"></p>").to_s.should == "<p data-erb-id=\"&lt;% method_name %&gt;\"></p>"
+      end
+
+      it "should convert <% ... %> inside single quoted attr value" do
+        Deface::Parser.convert("<p id='<% method_name %>'></p>").to_s.should == "<p data-erb-id=\"&lt;% method_name %&gt;\"></p>"
+      end
+
+      it "should convert <% ... %> inside non-quoted attr value" do
+        Deface::Parser.convert("<p id=<% method_name %>></p>").to_s.should == "<p data-erb-id=\"&lt;% method_name %&gt;\"></p>"
+        Deface::Parser.convert("<p id=<% method_name %> alt=\"test\"></p>").to_s.should == "<p data-erb-id=\"&lt;% method_name %&gt;\" alt=\"test\"></p>"
+      end
+
+      it "should convert multiple <% ... %> inside html tag" do
+        Deface::Parser.convert(%q{<p <%= method_name %> alt="<% x = 'y' + 
+                               \"2\" %>" title='<% method_name %>' <%= other_method %></p>}).to_s.should == "<p data-erb-0=\"&lt;%= method_name %&gt;\" data-erb-alt=\"&lt;% x = 'y' + \n                               \\&quot;2\\&quot; %&gt;\" data-erb-title=\"&lt;% method_name %&gt;\" data-erb-1=\"&lt;%= other_method %&gt;\"></p>"
+      end
+
+      it "should convert <%= ... %> including href attribute" do
+        Deface::Parser.convert(%(<a href="<%= x 'y' + "z" %>">A Link</a>)).to_s.should == "<a data-erb-href=\"&lt;%= x 'y' + &quot;z&quot; %&gt;\">A Link</a>"
       end
 
       it "should escape contents code tags" do
@@ -59,21 +81,16 @@ module Deface
         Deface::Parser.undo_erb_markup!("<code erb-loud> method_name </code>").should == "<%= method_name %>"
       end
 
-      it "should revert nested <code erb-silent>" do
-        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>"
+      it "should revert data-erb-x attrs inside html tag" do
+        Deface::Parser.undo_erb_markup!("<p data-erb-0=\"&lt;% method_name %&gt;\" data-erb-1=\"&lt;% x = y %&gt;\"></p>").should == "<p <% method_name %> <% x = y %>></p>"
       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>"
+      it "should revert data-erb-id attr inside html tag" do
+        Deface::Parser.undo_erb_markup!("<p data-erb-id=\"&lt;% method_name &gt; 1 %&gt;\"></p>").should == "<p id=\"<% method_name > 1 %>\"></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>)
+      it "should revert data-erb-href attr inside html tag" do
+        Deface::Parser.undo_erb_markup!("<a data-erb-href=\"&lt;%= x 'y' + &quot;z&quot; %&gt;\">A Link</a>").should == %(<a href="<%= x 'y' + \"z\" %>">A Link</a>)
       end
 
       it "should unescape contents of code tags" do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: deface
 version: !ruby/object:Gem::Version 
-  hash: 19
-  prerelease: 
+  hash: 15
+  prerelease: false
   segments: 
   - 0
-  - 3
+  - 4
   - 0
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Brian Quinn
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-13 00:00:00 +01:00
+date: 2011-05-24 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -80,7 +80,7 @@ files:
 - spec/deface/template_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true
-homepage: http://github.com/BDQ/Deface
+homepage: http://github.com/railsdog/deface
 licenses: []
 
 post_install_message: 
@@ -109,7 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.5.0
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Deface is a library that allows you to customize ERB views in Rails