deface 0.9.1 → 1.0.0.rc1

data/lib/deface/dsl/context.rb

@@ -19,7 +19,7 @@ module Deface
         @virtual_path = name
       end
 
-      Deface::Override.actions.each do |action_name|
+      def self.define_action_method(action_name)
         define_method(action_name) do |selector|
           if @action.present?
             Rails.logger.error "\e[1;32mDeface: [WARNING]\e[0m Multiple action methods have been called. The last one will be used."
@@ -29,7 +29,7 @@ module Deface
         end
       end
 
-      Deface::Override.sources.each do |source_name|
+      def self.define_source_method(source_name)
         define_method(source_name) do |value|
           if @source.present?
             Rails.logger.error "\e[1;32mDeface: [WARNING]\e[0m Multiple source methods have been called. The last one will be used."
@@ -62,6 +62,10 @@ module Deface
       def disabled
         @options[:disabled] = true
       end
+
+      def namespaced
+        @options[:namespaced] = true
+      end
     end
   end
-end
+end

data/lib/deface/dsl/loader.rb

@@ -36,7 +36,7 @@ module Deface
             context.virtual_path(determine_virtual_path(filename))
             context.instance_eval(dsl_commands)
             context.haml(the_rest)
-            context.create_override            
+            context.create_override
           else
             context = Context.new(context_name)
             context.virtual_path(determine_virtual_path(filename))
@@ -61,7 +61,10 @@ module Deface
             comment = html_file_contents[first_open_comment_index..first_close_comment_index+2]
           end
 
-          dsl_commands << comment.gsub('<!--', '').gsub('-->', '').strip + "\n"
+          comment.gsub('<!--', '').gsub('-->', '').strip.scan(/[^\s"']+|"[^"]*"|'[^']*'/).each do |part|
+            dsl_commands =~ /('|")\z/ || part =~ /\w\z/ ? dsl_commands << "\n" : dsl_commands << ' '
+            dsl_commands << part
+          end
 
           html_file_contents = html_file_contents.gsub(comment, '')
         end

data/lib/deface/environment.rb

@@ -1,12 +1,42 @@
 module Deface
+  DEFAULT_ACTIONS = [ Actions::Remove, Actions::Replace, Actions::ReplaceContents, Actions::Surround,
+        Actions::SurroundContents, Actions::InsertBefore, Actions::InsertAfter, Actions::InsertTop,
+        Actions::InsertBottom, Actions::SetAttributes, Actions::AddToAttributes, Actions::RemoveFromAttributes ]
+
+  DEFAULT_SOURCES = [ Sources::Text, Sources::Erb, Sources::Haml, Sources::Partial, Sources::Template, Sources::Cut, Sources::Copy]
 
   class Environment
-    attr_accessor :overrides, :enabled, :haml_support
+    attr_accessor :overrides, :enabled, :haml_support, :namespaced
     def initialize
       @overrides    = Overrides.new
       @enabled      = true
       @haml_support = false
+      @actions      = []
+      @sources      = []
+      @namespaced   = false
+
+      Deface::DEFAULT_ACTIONS.each { |action| register_action(action) }
+      Deface::DEFAULT_SOURCES.each { |source| register_source(source) }
+    end
+
+    def register_action(action)
+      @actions << action
+      Deface::DSL::Context.define_action_method(action.to_sym)
+    end
+
+    def actions
+      @actions.dup
     end
+
+    def register_source(source)
+      @sources << source
+      Deface::DSL::Context.define_source_method(source.to_sym)
+    end
+
+    def sources
+      @sources.dup
+    end
+
   end
 
   class Environment::Overrides

data/lib/deface/haml_converter.rb

@@ -1,9 +1,6 @@
 module Deface
-  class HamlConverter < Haml::Engine
-    def result
-      Deface::Parser.undo_erb_markup! String.new(render)
-    end
 
+  module HamlCompilerMethods
     def push_script(text, preserve_script, in_tag = false, preserve_tag = false,
                     escape_html = false, nuke_inner_whitespace = false)
       push_text "<%= #{text.strip} %>"
@@ -17,7 +14,9 @@ module Deface
     def push_silent(text, can_suppress = false)
       push_text "<% #{text.strip} %>"
     end
+  end
 
+  module HamlParserMethods
     def parse_old_attributes(line)
       attributes_hash, rest, last_line = super(line)
 
@@ -34,7 +33,6 @@ module Deface
 
       return attributes, rest, last_line
     end
-
     private
 
       # coverts { attributes into deface compatibily attributes
@@ -72,6 +70,36 @@ module Deface
 
         attrs.join(', ')
       end
+  end
 
+  class HamlConverter < Haml::Engine
+
+    # spec coverage will always be bad on one-side
+    # or the other of this if, travis-ci gemfile takes
+    # care of 3.2 haml side for now (until 3.2 is relased)
+    # then we should reverse to test 3.1 with gemfile
+    #
+    if Haml::VERSION >= "3.2"
+      class Compiler < Haml::Compiler
+        include HamlCompilerMethods
+      end
+
+      class Parser < Haml::Parser
+        include HamlParserMethods
+      end
+
+      def initialize(template, options = {})
+        options[:compiler_class] = Compiler
+        options[:parser_class]   = Parser
+        super(template, options)
+      end
+    else
+      include HamlParserMethods
+      include HamlCompilerMethods
+    end
+
+    def result
+      Deface::Parser.undo_erb_markup! String.new(render)
+    end
   end
 end

data/lib/deface/matchers/element.rb

@@ -0,0 +1,13 @@
+module Deface
+  module Matchers
+    class Element
+      def initialize(selector)
+        @selector = selector
+      end
+
+      def matches(document, log=true)
+        document.css(@selector).map { |match| [match] }
+      end
+    end
+  end
+end

data/lib/deface/matchers/range.rb

@@ -0,0 +1,52 @@
+module Deface
+  module Matchers
+    class Range
+      def initialize(name, selector, end_selector)
+        @name = name
+        @selector = selector
+        @end_selector = end_selector
+      end
+
+      def matches(document, log=true)
+        starting, ending = select_endpoints(document, @selector, @end_selector)
+
+        if starting && ending
+          if log
+            Rails.logger.info("\e[1;32mDeface:\e[0m '#{@name}' matched starting with '#{@selector}' and ending with '#{@end_selector}'")
+          end
+
+          return [select_range(starting, ending)]
+        else
+          if starting.nil?
+            Rails.logger.info("\e[1;32mDeface:\e[0m '#{@name}' failed to match with starting selector '#{@selector}'")
+          else
+            Rails.logger.info("\e[1;32mDeface:\e[0m '#{@name}' failed to match with end selector '#{@end_selector}'")
+          end
+          return []
+        end
+      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
+    end
+  end
+end

data/lib/deface/override.rb

@@ -1,16 +1,14 @@
 module Deface
   class Override
-    include TemplateHelper
     include OriginalValidator
+    include Applicator
     extend Applicator::ClassMethods
     extend Search::ClassMethods
 
-    cattr_accessor :actions, :sources, :_early, :current_railtie
-    attr_accessor :args, :parsed_document
+    cattr_accessor :_early, :current_railtie
+    attr_accessor :args, :parsed_document, :failure
 
     @@_early = []
-    @@actions = [:remove, :replace, :replace_contents, :surround, :surround_contents, :insert_after, :insert_before, :insert_top, :insert_bottom, :set_attributes, :add_to_attributes, :remove_from_attributes]
-    @@sources = [:text, :erb, :haml, :partial, :template, :cut, :copy]
 
     # Initializes new override, you must supply only one Target, Action & Source
     # parameter for each override (and any number of Optional parameters).
@@ -32,6 +30,7 @@ module Deface
       raise(ArgumentError, ":virtual_path must be defined") if args[:virtual_path].blank?
 
       args[:text] = content.call if block_given?
+      args[:name] = "#{current_railtie.underscore}_#{args[:name]}" if Rails.application.try(:config).try(:deface).try(:namespaced) || args.delete(:namespaced)
 
       virtual_key = args[:virtual_path].to_sym
       name_key = args[:name].to_s.parameterize
@@ -44,13 +43,13 @@ module Deface
         @args = self.class.all[virtual_key][name_key].args
 
         #check if the action is being redefined, and reject old action
-        if (@@actions & args.keys).present?
-          @args.reject!{|key, value| (@@actions & @args.keys).include? key }
+        if (self.class.actions & args.keys).present?
+          @args.reject!{|key, value| (self.class.actions & @args.keys).include? key }
         end
 
         #check if the source is being redefined, and reject old action
-        if (@@sources & args.keys).present?
-          @args.reject!{|key, value| (@@sources & @args.keys).include? key }
+        if (Deface::DEFAULT_SOURCES.map(&:to_sym) & args.keys).present?
+          @args.reject!{|key, value| (Deface::DEFAULT_SOURCES.map(&:to_sym) & @args.keys).include? key }
         end
 
         @args.merge!(args)
@@ -122,69 +121,34 @@ module Deface
     end
 
     def action
-      (@@actions & @args.keys).first
+      (self.class.actions & @args.keys).first
     end
 
+    # Returns the markup to be inserted / used
+    #
     def source
-      erb = case source_argument
-      when :partial
-        load_template_source(@args[:partial], true)
-      when :template
-        load_template_source(@args[:template], false)
-      when :text
-        @args[:text]
-      when :erb
-        @args[:erb]
-      when :cut
-        cut = @args[:cut]
-
-        if cut.is_a? Hash
-          starting, ending = self.class.select_endpoints(self.parsed_document, cut[:start], cut[:end])
-
-          range = self.class.select_range(starting, ending)
-          range.map &:remove
-
-          Deface::Parser.undo_erb_markup! range.map(&:to_s).join
-
-        else
-          Deface::Parser.undo_erb_markup! self.parsed_document.css(cut).first.remove.to_s.clone
-        end
-
-      when :copy
-        copy = @args[:copy]
-
-        if copy.is_a? Hash
-          starting, ending = self.class.select_endpoints(self.parsed_document, copy[:start], copy[:end])
-
-          range = self.class.select_range(starting, ending)
-
-          Deface::Parser.undo_erb_markup! range.map(&:to_s).join
-        else
-         Deface::Parser.undo_erb_markup! parsed_document.css(copy).first.to_s.clone
-        end
+      sources = Rails.application.config.deface.sources
+      source = sources.find { |source| source.to_sym == source_argument }
+      raise(DefaceError, "Source #{source} not found.") unless source
 
-      when :haml
-        if Rails.application.config.deface.haml_support
-          haml_engine = Deface::HamlConverter.new(@args[:haml])
-          haml_engine.render
-        else
-          raise Deface::NotSupportedError, "`#{self.name}` supplies :haml source, but haml_support is not detected."
-        end
-      end
-
-      erb
+      source.execute(self) || ''
     end
 
     # Returns a :symbol for the source argument present
     #
     def source_argument
-      @@sources.detect { |source| @args.key? source }
+      Deface::DEFAULT_SOURCES.detect { |source| @args.key? source.to_sym }.try :to_sym
     end
 
     def source_element
       Deface::Parser.convert(source.clone)
     end
 
+    def safe_source_element
+      return unless source_argument
+      source_element
+    end
+
     def disabled?
       @args.key?(:disabled) ? @args[:disabled] : false
     end
@@ -194,6 +158,8 @@ module Deface
       @args[:closing_selector]
     end
 
+    # returns attributes hash for attribute related actions
+    #
     def attributes
       @args[:attributes] || []
     end
@@ -227,6 +193,11 @@ module Deface
       Rails.application.config.deface.overrides.all
     end
 
+    def self.actions
+      Rails.application.config.deface.actions.map &:to_sym
+    end
+
+
     private
 
       # check if method is compiled for the current virtual path

data/lib/deface/sources/copy.rb

@@ -0,0 +1,15 @@
+module Deface
+  module Sources
+    class Copy < Source
+      def self.execute(override)
+        copy = override.args[:copy]
+        if copy.is_a? Hash
+          range = Deface::Matchers::Range.new('Copy', copy[:start], copy[:end]).matches(override.parsed_document).first
+          Deface::Parser.undo_erb_markup! range.map(&:to_s).join
+        else
+         Deface::Parser.undo_erb_markup! override.parsed_document.css(copy).first.to_s.clone
+        end
+      end
+    end
+  end
+end

data/lib/deface/sources/cut.rb

@@ -0,0 +1,25 @@
+module Deface
+  module Sources
+    class Cut < Source
+      def self.execute(override)
+        cut = override.args[:cut]
+        if cut.is_a? Hash
+          range = Deface::Matchers::Range.new('Cut', cut[:start], cut[:end]).matches(override.parsed_document).first
+          range.map &:remove
+
+          Deface::Parser.undo_erb_markup! range.map(&:to_s).join
+
+        else
+          element = override.parsed_document.css(cut).first
+
+          if element.nil?
+            override.failure = "failed to match :cut selector '#{cut}'"
+            nil
+          else
+            Deface::Parser.undo_erb_markup! element.remove.to_s.clone
+          end
+        end
+      end
+    end
+  end
+end

data/lib/deface/sources/erb.rb

@@ -0,0 +1,9 @@
+module Deface
+  module Sources
+    class Erb < Source
+      def self.execute(override)
+        override.args[:erb]
+      end
+    end
+  end
+end

data/lib/deface/sources/haml.rb

@@ -0,0 +1,14 @@
+module Deface
+  module Sources
+    class Haml < Source
+      def self.execute(override)
+        if Rails.application.config.deface.haml_support
+          haml_engine = Deface::HamlConverter.new(override.args[:haml])
+          haml_engine.render
+        else
+          raise Deface::NotSupportedError, "`#{override.name}` supplies :haml source, but haml_support is not detected."
+        end
+      end
+    end
+  end
+end

data/lib/deface/sources/partial.rb

@@ -0,0 +1,13 @@
+module Deface
+  module Sources
+    class Partial < Source
+      class << self
+        include TemplateHelper
+      end
+
+      def self.execute(override)
+        load_template_source(override.args[:partial], true)
+      end
+    end
+  end
+end