deface 0.1.0 → 0.2.0

data/README.markdown

@@ -11,7 +11,7 @@ Deface temporarily converts ERB files into a pseudo HTML markup that can be pars
 
  becomes 
 
-    <erb-loud> some ruby code </erb-loud>
+    <code erb-loud> some ruby code </code>
 
 and 
   
@@ -19,7 +19,7 @@ and
 
   becomes
 
-    <erb-silent> other ruby code </erb-silent>
+    <code erb-silent> other ruby code </code>
 
 Deface overrides have full access to all variables accessible to the view being customized.
 
@@ -30,9 +30,7 @@ A new instance of the Deface::Override class is initialized for each customizati
 
 Target
 ------
-* <tt>:file_path</tt> - The relative file path of the template / partial where the override should take effect eg: *"shared/_person"*, *"admin/posts/new"* this will apply to all controller actions that use the specified template.
-
-* <tt>:virtual_path</tt> - The controller and action name where the override should take effect eg: *"controller/action"* or *"posts/index"* will apply to all layouts, templates and partials that are used in the rendering of the specified action.
+* <tt>:virtual_path</tt> - The template / partial / layout where the override should take effect eg: *"shared/_person"*, *"admin/posts/new"* this will apply to all controller actions that use the specified template.
 
 Action
 ------
@@ -54,27 +52,34 @@ Source
 
 Optional
 --------
-* <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` or `:file_path`
+* <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`
 
 Examples
 ========
 
 Replaces all instances of _h1_ in the `posts/_form.html.erb` partial with `<h1>New Post</h1>`
 
-    Deface::Override.new(:file_path => "posts/_form", :name => "example-1", :replace => "h1", :text => "<h1>New Post</h1>")
+     Deface::Override.new(:virtual_path => "posts/_form", 
+                          :name => "example-1", 
+                          :replace => "h1", 
+                          :text => "<h1>New Post</h1>")
 
-Inserts `<%= link_to "List Comments", comments_url(post) %>` before all instances of `p` with css class `comment` in any layout / template / partial used when rendering _PostsController#index_ action:
+Inserts `<%= link_to "List Comments", comments_url(post) %>` before all instances of `p` with css class `comment` in `posts/index.html.erb`
 
-    Deface::Override.new(:virtual_path => "posts/index", :name => "example-2", :insert_before => "p.comment", :text => "<%= link_to "List Comments", comments_url(post) %>")
+     Deface::Override.new(:virtual_path => "posts/index", 
+                          :name => "example-2", 
+                          :insert_before => "p.comment",
+                          :text => "<%= link_to "List Comments", comments_url(post) %>")
 
-Inserts the contents of `shared/_comment.html.erb` after all instances of `div` with an id of `comment_21` in any layout / template / partial used when rendering _PostsController#show_ action:
+Inserts the contents of `shared/_comment.html.erb` after all instances of `div` with an id of `comment_21` in `posts/show.html.erb`
 
-    Deface::Override.new(:virtual_path => "posts/show", :name => "example-3", :insert_after => "div#comment_21", :partial => "shared/comment")
+     Deface::Override.new(:virtual_path => "posts/show", 
+                          :name => "example-3",
+                          :insert_after => "div#comment_21", 
+                          :partial => "shared/comment")
 
 Removes any instance of `<%= helper_method %>` in the `posts/new.html.erb" template:
 
-    Deface::Override.new(:file_path => "posts/new", :name => "example-4", :remove => "erb-loud:contains('helper_method')" )
-
-
-
-
+     Deface::Override.new(:virtual_path => "posts/new", 
+                          :name => "example-4", 
+                          :remove => "code[erb-loud]:contains('helper_method')" )

data/Rakefile

@@ -28,7 +28,9 @@ begin
   Jeweler::Tasks.new do |gem|
     gem.name = "deface"
     gem.summary = "Deface is a library that allows you to customize ERB views in Rails"
+    gem.description = "Deface is a library that allows you to customize ERB views in a Rails application without editing the underlying view."
     gem.email = "brian@railsdog.com"
+    gem.homepage = "http://github.com/BDQ/Deface"
     gem.authors = ["Brian Quinn"]
     gem.files = Dir["*", "{lib}/**/*"]
     gem.add_dependency("nokogiri", "~> 1.4.3")

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/deface.gemspec

@@ -5,11 +5,12 @@
 
 Gem::Specification.new do |s|
   s.name = %q{deface}
-  s.version = "0.1.0"
+  s.version = "0.2.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-30}
+  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"
@@ -26,6 +27,7 @@ Gem::Specification.new do |s|
      "lib/deface/override.rb",
      "lib/deface/parser.rb"
   ]
+  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}

data/lib/deface/action_view_extensions.rb

@@ -2,7 +2,7 @@ ActionView::Template.class_eval do
   alias_method :rails_initialize, :initialize
 
   def initialize(source, identifier, handler, details)
-    overrides = Deface::Override.find(details.merge({:file_path => identifier}))
+    overrides = Deface::Override.find(details)
 
     unless overrides.empty?
       doc = Deface::Parser.convert_fragment(source)
@@ -26,7 +26,7 @@ ActionView::Template.class_eval do
 
       source = doc.to_s
 
-      Deface::Parser.undo_erb_markup(source)
+      Deface::Parser.undo_erb_markup!(source)
     end
 
     rails_initialize(source, identifier, handler, details)

data/lib/deface/override.rb

@@ -1,10 +1,9 @@
 module Deface
   class Override
-    cattr_accessor :virtual, :file, :actions
+    cattr_accessor :all, :actions
     attr_accessor :args
 
-    @@virtual ||= {}
-    @@file ||= {}
+    @@all ||= {}
     @@actions = [:remove, :replace, :insert_after, :insert_before]
 
     # Initializes new override, you must supply only one Target, Action & Source
@@ -12,13 +11,9 @@ module Deface
     #
     # ==== Target
     #
-    # * <tt>:file_path</tt> - The relative file path of the template / partial where
+    # * <tt>:virtual_path</tt> - The path of the template / partial where
     #   the override should take effect eg: "shared/_person", "admin/posts/new"
     #   this will apply to all controller actions that use the specified template
-    # * <tt>:virtual_path</tt> - The controller and action name where
-    #   the override should take effect eg: "controller/action" or "posts/index"
-    #   will apply to all layouts, templates and partials that are used in the
-    #   rendering of the specified action.
     #
     # ==== Action
     #
@@ -36,22 +31,15 @@ module Deface
     # ==== Optional
     #
     # * <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 or :file_path
+    #   This needs to be unique within the same :virtual_path
 
     def initialize(args)
       @args = args
 
-      if args.key?(:virtual_path)
-        key = args[:virtual_path].to_sym
+      key = args[:virtual_path].to_sym
 
-        @@virtual[key] ||= {}
-        @@virtual[key][args[:name].to_s.parameterize] = self
-      elsif args.key?(:file_path)
-        key = args[:file_path]
-
-        @@file[key] ||= {}
-        @@file[key][args[:name].to_s.parameterize] = self
-      end
+      @@all[key] ||= {}
+      @@all[key][args[:name].to_s.parameterize] = self
     end
 
     def selector
@@ -71,19 +59,16 @@ module Deface
         @args[:text]
       end
 
-      Deface::Parser::ERB.compile(erb)
+      Deface::Parser.erb_markup!(erb)
     end
 
     def self.find(details)
-      return [] unless self.virtual || self.file
+      return [] unless @@all
 
       result = []
 
       virtual_path = details[:virtual_path]
-      result << @@virtual[virtual_path.to_sym].try(:values) if virtual_path
-
-      file_path = details[:file_path]
-      result << @@file.map { |key,overrides| overrides.try(:values) if file_path =~ /#{key}/ } if file_path
+      result << @@all[virtual_path.to_sym].try(:values)
 
       result.flatten.compact
     end

data/lib/deface/parser.rb

@@ -3,88 +3,38 @@ require 'erubis'
 
 module Deface
   class Parser
+    # converts erb to markup
+    #
+    def self.erb_markup!(source)
+      replacements = [ {"<%=" => "<code erb-loud>"},
+                       {"<%"  => "<code erb-silent>"},
+                       {"%>"  => "</code>"} ]
+
+      replacements.each{ |h| h.each { |replace, with| source.gsub! replace, with } }
+      source
+    end
+
     # undoes ERB markup generated by Deface::Parser::ERB
     #
-    def self.undo_erb_markup(source)
-      source.gsub! /(<|&lt;)erb-silent(&gt;|>)/, '<% '
-      source.gsub! /(<|&lt;)erb-loud(&gt;|>)/, '<%= '
-      source.gsub! /(<|&lt;)\/erb-(loud|silent)(&gt;|>)/, ' %>'
-      source.gsub! /(?!=<%=?)&gt;(?=.*%>)/, '>'
+    def self.undo_erb_markup!(source)
+      replacements = [ {"<code erb-silent>" => '<%'},
+                       {"<code erb-loud>"   => '<%='},
+                       {"</code>"           => '%>'},
+                       {/(<|&lt;)code erb-silent(&gt;|>)/ => '<%'},
+                       {/(<|&lt;)code erb-loud(&gt;|>)/   => '<%='},
+                       {/(<|&lt;)\/code(&gt;|>)/          => '%>'},
+                       {/(?!=<%=?)&gt;(?=.*%>)/           => '>'},
+                       {/(?!=<%=?)&lt;(?=.*%>)/           => '<'}]
+
+      replacements.each{ |h| h.each { |replace, with| source.gsub! replace, with } }
       source
     end
 
 
     def self.convert_fragment(source)
-      source = Deface::Parser::ERB.compile(source)
+      erb_markup!(source)
       Nokogiri::HTML::DocumentFragment.parse(source)
     end
 
-    # A class for converting ERB code into a format that's easier
-    # for css & xpath querying4
-
-    # the erb tags are converted to html tags in the following way.
-    # `<% ... %>` is converted into `<erb-silent> ... </erb-silent>`.
-    # `<%= ... %>` is converted into `<erb-loud> ... </erb-loud>`.
-    #
-    class ERB < Erubis::Basic::Engine
-      # Compiles an ERB template into a HTML document containing `erb-` tags.
-      # 100% borrowed from HTML2HAML .. thank you team HAML.
-      #
-      # @param template [String] The ERB template
-      # @return [String] The output document
-      def self.compile(template)
-        new(template).src
-      end
-
-      # not supported (yet?)
-      def escaped_expr(code)
-        raise "Not Supported"
-      end
-
-      # The conversion has no preamble.
-      def add_preamble(src); end
-
-      # The conversion has no postamble.
-      def add_postamble(src); end
-
-      # Concatenates the text onto the source buffer.
-      #
-      # @param src [String] The source buffer
-      # @param text [String] The raw text to add to the buffer
-      def add_text(src, text)
-        src << text
-      end
-
-      # Concatenates a silent Ruby statement onto the source buffer.
-      # This uses the `<erb-silent>` tag
-      #
-      # @param src [String] The source buffer
-      # @param code [String] The Ruby statement to add to the buffer
-      def add_stmt(src, code)
-        src << whitespace(code) << "<erb-silent>" << code.strip << "</erb-silent>"
-      end
-
-      # Concatenates a Ruby expression that's printed to the document
-      # onto the source buffer.
-      # This uses the `<erb-silent>` tag
-      #
-      # @param src [String] The source buffer
-      # @param code [String] The Ruby expression to add to the buffer
-      def add_expr_literal(src, code)
-        src << whitespace(code) << "<erb-loud>" << code.strip << "</erb-loud>"
-      end
-
-      # not supported (yet?)
-      def add_expr_debug(src, code)
-         raise "Not Supported"
-      end
-
-      private
-        def whitespace(code)
-          arr = code.scan /^(\s*)/
-          res = arr.flatten.first
-          res.length==1 ? "" : res
-        end
-    end
   end
 end

data/spec/deface/override_spec.rb

@@ -4,7 +4,6 @@ module Deface
   describe Override do
     before(:each) do
       @override = Deface::Override.new(:virtual_path => "posts/index", :name => "Posts#index", :replace => "h1", :text => "<h1>Argh!</h1>")
-      @override2 = Deface::Override.new(:file_path => "posts/index", :name => "Posts#index", :replace => "h1", :text => "<h1>Argh!</h1>")
     end
 
     it "should return correct action" do
@@ -22,22 +21,12 @@ module Deface
       Deface::Override.find({:virtual_path => "posts/index"}).size.should == 1
     end
 
-    it "should find by file_path" do
-      Deface::Override.find({:file_path => "/full/path/to/posts/index.html.erb"}).size.should == 1
-    end
-
     describe "#new" do
 
-      it "should increase virtual#size by 1" do
+      it "should increase all#size by 1" do
         expect {
           Deface::Override.new(:virtual_path => "posts/new", :name => "Posts#new", :replace => "h1", :text => "<h1>argh!</h1>")
-        }.to change{Deface::Override.virtual.size}.by(1)
-      end
-
-      it "should increase file#size by 1" do
-        expect {
-          Deface::Override.new(:file_path => "posts/new", :name => "Posts#new", :replace => "h1", :text => "<h1>argh!</h1>")
-        }.to change{Deface::Override.file.size}.by(1)
+        }.to change{Deface::Override.all.size}.by(1)
       end
     end
 
@@ -87,10 +76,10 @@ module Deface
         @replacement = Deface::Override.new(:virtual_path => "posts/index", :name => "Posts#index", :replace => "h1", :text => "<h1>Arrrr!</h1>")
       end
 
-      it "should not increase virtual#size by 1" do
+      it "should not increase all#size by 1" do
         expect {
           Deface::Override.new(:virtual_path => "posts/index", :name => "Posts#index", :replace => "h1", :text => "<h1>Arrrr!</h1>")
-        }.to change{Deface::Override.virtual.size}.by(0)
+        }.to change{Deface::Override.all.size}.by(0)
 
       end
 

data/spec/deface/parser_spec.rb

@@ -9,37 +9,37 @@ module Deface
       end
 
       it "should convert <% ... %>" do
-        Deface::Parser.convert_fragment("<% method_name %>").to_s.should == "<erb-silent>method_name</erb-silent>"
+        Deface::Parser.convert_fragment("<% 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 == "<erb-loud>method_name</erb-loud>"
+        Deface::Parser.convert_fragment("<%= 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;erb-silent&gt;method_name&lt;/erb-silent&gt;\"></p>"
+        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>"
       end
 
       it "should convert nested <%= ... %>" do
-        Deface::Parser.convert_fragment("<p id=\"<%= method_name %>\"></p>").to_s.should == "<p id=\"&lt;erb-loud&gt;method_name&lt;/erb-loud&gt;\"></p>"
+        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>"
       end
     end
 
     describe "#undo_erb_markup" do
-      it "should revert <erb-silent>" do
-        Deface::Parser.undo_erb_markup("<erb-silent>method_name</erb-silent>").should == "<% method_name %>"
+      it "should revert <code erb-silent>" do
+        Deface::Parser.undo_erb_markup!("<code erb-silent> method_name </code>").should == "<% method_name %>"
       end
 
-      it "should revert <erb-loud>" do
-        Deface::Parser.undo_erb_markup("<erb-loud>method_name</erb-loud>").should == "<%= method_name %>"
+      it "should revert <code erb-loud>" do
+        Deface::Parser.undo_erb_markup!("<code erb-loud> method_name </code>").should == "<%= method_name %>"
       end
 
-      it "should revert nested <erb-silent>" do
-        Deface::Parser.undo_erb_markup("<tr id=\"&lt;erb-silent&gt;method_name&lt;/erb-silent&gt;\"></tr>").should == "<tr id=\"<% method_name %>\"></tr>"
+      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 <erb-loud>" do
-        Deface::Parser.undo_erb_markup("<tr id=\"&lt;erb-loud&gt;method_name&lt;/erb-loud&gt;\"></tr>").should == "<tr id=\"<%= method_name %>\"></tr>"
+      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
 
     end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: deface
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Brian Quinn
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-30 00:00:00 +01:00
+date: 2010-08-31 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -50,7 +50,7 @@ dependencies:
         version: 3.0.0
   type: :runtime
   version_requirements: *id002
-description: 
+description: Deface is a library that allows you to customize ERB views in a Rails application without editing the underlying view.
 email: brian@railsdog.com
 executables: []
 
@@ -74,7 +74,7 @@ files:
 - spec/deface/template_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true
-homepage: 
+homepage: http://github.com/BDQ/Deface
 licenses: []
 
 post_install_message: