deface 0.9.1 → 1.0.0.rc1

data/lib/deface/actions/element_action.rb

@@ -0,0 +1,13 @@
+module Deface
+  module Actions
+    class ElementAction < Action
+      attr_reader :source_element
+
+      def initialize(options = {})
+        super(options)
+        @source_element = options[:source_element]
+        raise(DefaceError, "No source_element option specified") unless @source_element
+      end
+    end
+  end
+end

data/lib/deface/actions/insert_after.rb

@@ -0,0 +1,9 @@
+module Deface
+  module Actions
+    class InsertAfter < ElementAction
+      def execute(target_element)
+        target_element.first.after(source_element)
+      end
+    end
+  end
+end

data/lib/deface/actions/insert_before.rb

@@ -0,0 +1,9 @@
+module Deface
+  module Actions
+    class InsertBefore < ElementAction
+      def execute(target_element)
+        target_element.first.before(source_element)
+      end
+    end
+  end
+end

data/lib/deface/actions/insert_bottom.rb

@@ -0,0 +1,14 @@
+module Deface
+  module Actions
+    class InsertBottom < ElementAction
+      def execute(target_element)
+        target_element = target_element.first
+        if target_element.children.size == 0
+          target_element.children = source_element
+        else
+          target_element.children.after(source_element)
+        end
+      end
+    end
+  end
+end

data/lib/deface/actions/insert_top.rb

@@ -0,0 +1,14 @@
+module Deface
+  module Actions
+    class InsertTop < ElementAction
+      def execute(target_element)
+        target_element = target_element.first
+        if target_element.children.size == 0
+          target_element.children = source_element
+        else
+          target_element.children.before(source_element)
+        end
+      end
+    end
+  end
+end

data/lib/deface/actions/remove.rb

@@ -0,0 +1,13 @@
+module Deface
+  module Actions
+    class Remove < Action
+      def execute(target_range)
+        target_range.map(&:remove)
+      end
+
+      def range_compatible?
+        true
+      end
+    end
+  end
+end

data/lib/deface/actions/remove_from_attributes.rb

@@ -0,0 +1,13 @@
+module Deface
+  module Actions
+    class RemoveFromAttributes < AttributeAction
+      def execute_for_attribute(target_element, name, value)
+        if target_element.attributes.key?(name)
+          target_element.set_attribute(name, target_element.attributes[name].value.gsub(value.to_s, '').strip)
+        elsif target_element.attributes.key?("data-erb-#{name}")
+          target_element.set_attribute("data-erb-#{name}", target_element.attributes["data-erb-#{name}"].value.gsub(value.to_s, '').strip)
+        end
+      end
+    end
+  end
+end

data/lib/deface/actions/replace.rb

@@ -0,0 +1,14 @@
+module Deface
+  module Actions
+    class Replace < ElementAction
+      def execute(target_range)
+        target_range.first.before(source_element)
+        target_range.map(&:remove)
+      end
+
+      def range_compatible?
+        true
+      end
+    end
+  end
+end

data/lib/deface/actions/replace_contents.rb

@@ -0,0 +1,19 @@
+module Deface
+  module Actions
+    class ReplaceContents < ElementAction
+      def execute(target_range)
+        if target_range.length == 1
+          target_range.first.children.remove
+          target_range.first.add_child(source_element)
+        else
+          target_range[1..-2].map(&:remove)
+          target_range.first.after(source_element)
+        end
+      end
+
+      def range_compatible?
+        true
+      end
+    end
+  end
+end

data/lib/deface/actions/set_attributes.rb

@@ -0,0 +1,12 @@
+module Deface
+  module Actions
+    class SetAttributes < AttributeAction
+      def execute_for_attribute(target_element, name, value)
+        target_element.remove_attribute(name)
+        target_element.remove_attribute("data-erb-#{name}")
+
+        target_element.set_attribute("data-erb-#{name}", value.to_s)
+      end
+    end
+  end
+end

data/lib/deface/actions/surround.rb

@@ -0,0 +1,24 @@
+module Deface
+  module Actions
+    class Surround < SurroundAction
+      def execute(target_range)
+        original_placeholders.each do |placeholder|
+          start = target_range[0].clone(1)
+          placeholder.replace start
+
+          target_range[1..-1].each do |element|
+            element = element.clone(1)
+            start.after element
+            start = element
+          end
+        end
+        target_range.first.before(source_element)
+        target_range.map(&:remove)
+      end
+
+      def range_compatible?
+        true
+      end
+    end
+  end
+end

data/lib/deface/actions/surround_action.rb

@@ -0,0 +1,15 @@
+module Deface
+  module Actions
+    class SurroundAction < ElementAction
+      def source_element
+        @cloned_source_element ||= super.clone(1)
+      end
+
+      def original_placeholders
+        @original_placeholders ||= source_element.css("code:contains('render_original')")
+        raise(DefaceError, "The surround action couldn't find <%= render_original %> in your template") unless @original_placeholders.first
+        @original_placeholders
+      end
+    end
+  end
+end

data/lib/deface/actions/surround_contents.rb

@@ -0,0 +1,33 @@
+module Deface
+  module Actions
+    class SurroundContents < SurroundAction
+      def execute(target_range)
+        if target_range.length == 1
+          target_element = target_range.first
+          original_placeholders.each do |placeholder|
+            placeholder.replace target_element.clone(1).children
+          end
+          target_element.children.remove
+          target_element.add_child(source_element)
+        else
+          original_placeholders.each do |placeholder|
+            start = target_range[1].clone(1)
+            placeholder.replace start
+
+            target_range[2...-1].each do |element|
+              element = element.clone(1)
+              start.after(element)
+              start = element
+            end
+          end
+          target_range.first.after(source_element)
+          target_range[1...-1].map(&:remove)
+        end
+      end
+
+      def range_compatible?
+        true
+      end
+    end
+  end
+end

data/lib/deface/applicator.rb

@@ -25,171 +25,18 @@ module Deface
             end
 
             override.parsed_document = doc
+            matches = override.matcher.matches(doc, log)
 
-            if override.end_selector.blank?
-              # single css selector
-
-              matches = doc.css(override.selector)
-
-              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
-
-              matches.each do |match|
-                override.validate_original(match)
-
-                case override.action
-                  when :remove
-                    match.replace ""
-                  when :replace
-                    match.replace override.source_element
-                  when :replace_contents
-                    match.children.remove
-                    match.add_child(override.source_element)
-                  when :surround, :surround_contents
-
-                    new_source = override.source_element.clone(1)
-
-                    if original = new_source.css("code:contains('render_original')").first
-                      if override.action == :surround
-                        original.replace match.clone(1)
-                        match.replace new_source
-                      elsif override.action == :surround_contents
-                        original.replace match.children
-                        match.children.remove
-                        match.add_child new_source
-                      end
-                    else
-                      #maybe we should log that the original wasn't found.
-                    end
-
-                  when :insert_before
-                    match.before override.source_element
-                  when :insert_after
-                    match.after override.source_element
-                  when :insert_top
-                    if match.children.size == 0
-                      match.children = override.source_element
-                    else
-                      match.children.before(override.source_element)
-                    end
-                  when :insert_bottom
-                    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|
-                      name = normalize_attribute_name(name)
-
-                      match.remove_attribute(name)
-                      match.remove_attribute("data-erb-#{name}")
-
-                      if match.attributes.key? name
-                        match.set_attribute name, value.to_s
-                      else
-                        match.set_attribute "data-erb-#{name}", value.to_s
-                      end
-                    end
-                  when :add_to_attributes
-                    override.attributes.each do |name, value|
-                      name = normalize_attribute_name(name)
-
-                      if match.attributes.key? name
-                        match.set_attribute name, match.attributes[name].value << " #{value}"
-                      elsif match.attributes.key? "data-erb-#{name}"
-                        match.set_attribute "data-erb-#{name}", match.attributes["data-erb-#{name}"].value << " #{value}"
-                      else
-                        match.set_attribute "data-erb-#{name}", value.to_s
-                      end
-
-                    end
-                  when :remove_from_attributes
-                    override.attributes.each do |name, value|
-                      name = normalize_attribute_name(name)
-
-                      if match.attributes.key? name
-                        match.set_attribute name, match.attributes[name].value.gsub(value.to_s, '').strip
-                      elsif match.attributes.key? "data-erb-#{name}"
-                        match.set_attribute "data-erb-#{name}", match.attributes["data-erb-#{name}"].value.gsub(value.to_s, '').strip
-                      end
-                    end
-
-                end
-
-              end
-            else
-              unless [:remove, :replace, :replace_contents, :surround, :surround_contents].include? override.action
-                raise Deface::NotSupportedError, ":#{override.action} action does not support :closing_selector"
-              end
-              # targeting range of elements as end_selector is present
-              starting, ending = select_endpoints(doc, override.selector, override.end_selector)
-
-              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)
-
-                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)
-                  when :surround, :surround_contents
-
-                    new_source = override.source_element.clone(1)
-
-                    if original = new_source.css("code:contains('render_original')").first
-
-                      if override.action == :surround
-                        start = elements[0].clone(1)
-                        original.replace start
-
-                        elements[1..-1].each do |element|
-                          element = element.clone(1)
-                          start.after element
-                          start = element
-                        end
-
-                        starting.before(new_source)
-                        elements.map &:remove
-
-
-                      elsif override.action == :surround_contents
-
-                        start = elements[1].clone(1)
-                        original.replace start
-
-                        elements[2...-1].each do |element|
-                          element = element.clone(1)
-                          start.after element
-                          start = element
-                        end
-
-                        starting.after(new_source)
-                        elements[1...-1].map &:remove
-                      end
-                    else
-                      #maybe we should log that the original wasn't found.
-                    end
-                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
-
-              end
+            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
 
+            if matches.empty?
+              override.failure = "failed to match :#{override.action} selector '#{override.selector}'"
+            else
+              override.failure = nil
+              matches.each {|match| override.execute_action match }
+            end
           end
 
           #prevents any caching by rails in development mode
@@ -202,41 +49,38 @@ module Deface
 
         source
       end
+    end
 
+    def execute_action(target_element)
+      validate_original(target_element)
+      create_action_command.execute(target_element)
+    end
 
-        def select_endpoints(doc, start, finish)
-          # targeting range of elements as end_selector is present
-          #
-          finish = "#{start} ~ #{finish}"
-          starting    = doc.css(start).first
-
-          ending = if starting && starting.parent
-            starting.parent.css(finish).first
-          else
-            doc.css(finish).first
-          end
-
-          return starting, ending
-
-        end
-
-        # finds all elements upto closing sibling in nokgiri document
-        #
-        def select_range(first, last)
-          first == last ? [first] : [first, *select_range(first.next, last)]
-        end
-
-        private
+    def execute_action_on_range(target_range)
+      create_action_command.execute_on_range(target_range)
+    end
 
-        def normalize_attribute_name(name)
-          name = name.to_s.gsub /"|'/, ''
+    def create_action_command
+      commands = Rails.application.config.deface.actions
+      command = commands.find { |command| command.to_sym == action }
+      raise(DefaceError, "Action #{action} not found") unless command
+      command.new(:source_element => safe_source_element, :attributes => attributes)
+    end
 
-          if /\Adata-erb-/ =~ name
-            name.gsub! /\Adata-erb-/, ''
-          end
+    def compatible_with_end_selector?
+      create_action_command.range_compatible?
+    end
 
-          name
+    def matcher
+      if end_selector.blank?
+        Deface::Matchers::Element.new(selector) # single css selector
+      else
+        unless compatible_with_end_selector?
+          raise Deface::NotSupportedError, ":#{action} action does not support :closing_selector"
         end
+        # targeting range of elements as end_selector is present
+        Deface::Matchers::Range.new(name, selector, end_selector)
+      end
     end
   end
 end