deface 0.5.5 → 0.5.6

data/README.markdown

@@ -50,6 +50,13 @@ Optional
 
 * <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>: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).
+  * <tt>:sequence => {:before => "*override_name*"}</tt> - where "*override_name*" is the name of an override defined for the 
+                                              same virutal_path, the current override will be appplied before 
+                                              the named override passed.
+  * <tt>:sequence => {:after => "*override_name*")</tt> - the current override will be applied after the named override passed.
+
 Examples
 ========
 

data/deface.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{deface}
-  s.version = "0.5.5"
+  s.version = "0.5.6"
 
   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.}

data/lib/deface/override.rb

@@ -41,8 +41,15 @@ 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>: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:
+    #   :sequence => n - where n is a positive or negative integer (lower numbers get applied first, default 100).
+    #   :sequence => {:before => "override_name"} - where "override_name" is the name of an override defined for the 
+    #                                               same virutal_path, the current override will be appplied before 
+    #                                               the named override passed.
+    #   :sequence => {:after => "override_name") - the current override will be applied after the named override passed.
+    #
     def initialize(args)
       @args = args
 
@@ -63,6 +70,43 @@ module Deface
       @args[:name]
     end
 
+    def sequence
+      return 100 unless @args.key?(:sequence)
+      if @args[:sequence].is_a? Hash
+        key = @args[:virtual_path].to_sym
+
+        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
+          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
+          else
+            return 100
+          end
+        else
+          #should never happen.. tut tut!
+          return 100
+        end
+
+      else
+        return @args[:sequence].to_i 
+      end
+    rescue SystemStackError
+      if defined?(Rails) 
+        Rails.logger.error "\e[1;32mDeface: [WARNING]\e[0m Circular sequence dependency includes override named: '#{self.name}' on '#{@args[:virtual_path]}'."
+      end
+
+      return 100
+    end
+
     def action
       (@@actions & @args.keys).first
     end
@@ -200,7 +244,7 @@ module Deface
       result = []
       result << @@all[virtual_path.to_sym].try(:values)
 
-      result.flatten.compact
+      result.flatten.compact.sort_by &:sequence
     end
 
     private

data/lib/deface/template_helper.rb

@@ -4,12 +4,12 @@ module Deface
     # used to find source for a partial or template using virutal_path
     def load_template_source(virtual_path, partial)
       parts = virtual_path.split("/")
-
+      prefix = []
       if parts.size == 2
-        prefix = ""
+        prefix << ""
         name = virtual_path
       else
-        prefix = parts.shift
+        prefix << parts.shift
         name = parts.join("/")
       end
 

data/spec/deface/override_spec.rb

@@ -140,6 +140,38 @@ module Deface
 
     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"})
+        @second = Deface::Override.new(:virtual_path => "posts/index", :name => "second", :insert_after => "li", :text => "<li>second</li>", :sequence => {:after => "first"})
+        @first = Deface::Override.new(:virtual_path => "posts/index", :name => "first", :replace => "li", :text => "<li>first</li>")
+
+        @third.sequence.should == 102
+        @second.sequence.should == 101
+        @first.sequence.should == 100
+      end
+
+      it "should calculate correct before sequences" do
+        @second = Deface::Override.new(:virtual_path => "posts/index", :name => "second", :insert_after => "li", :text => "<li>second</li>", :sequence => 99)
+        @first = Deface::Override.new(:virtual_path => "posts/index", :name => "first", :replace => "li", :text => "<li>first</li>", :sequence => {:before => "second"})
+
+        @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
+
   end
 
 end

data/spec/deface/template_spec.rb

@@ -125,5 +125,23 @@ module ActionView
       end
     end
 
+
+    describe "with mulitple sequenced overrides defined" do
+      before(:all) 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>")
+
+        @template = ActionView::Template.new("<ul><li>replaced</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></ul>"
+      end
+    end
+
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: deface
 version: !ruby/object:Gem::Version 
-  hash: 1
+  hash: 7
   prerelease: false
   segments: 
   - 0
   - 5
-  - 5
-  version: 0.5.5
+  - 6
+  version: 0.5.6
 platform: ruby
 authors: 
 - Brian Quinn
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-03 00:00:00 +01:00
+date: 2011-07-04 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency