deface 1.0.0.rc2 → 1.0.0.rc3

data/.travis.yml

@@ -1,16 +1,12 @@
 script: "bundle exec rake"
 rvm:
-  - 1.8.7
-  - 1.9.2
   - 1.9.3
   - 2.0.0
-  - jruby-18mode
-  - jruby-19mode
 gemfile:
   - gemfiles/rails3_1.gemfile
   - gemfiles/rails3_2.gemfile
+  - gemfiles/rails4_0.gemfile
   - gemfiles/haml4_0.gemfile
-
 notifications:
   email:
     - brian@spreecommerce.com

data/Gemfile

@@ -1,4 +1,5 @@
 source 'https://rubygems.org'
 
-gemspec
+gem 'rails', ENV['RAILS'] || '~> 3.2.13'
 
+gemspec

data/README.markdown

@@ -7,7 +7,7 @@
 Deface
 ======
 
-Deface is a library that allows you to customize HTML (ERB and HAML) views in a Rails application without editing the underlying view.
+Deface is a library that allows you to customize HTML (ERB, Haml and Slim) 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 CSS selectors as supported by Nokogiri.
 
@@ -59,7 +59,7 @@ You should save your overrides in the ````app/overrides````, normally one overri
 
 * <tt>:insert_bottom</tt> - Inserts inside all elements that match the supplied selector, as the last child.
 
-* <tt>:set_</tt> - Sets attributes on all elements that match the supplied selector, replacing existing attribute value if present or adding if not. Expects :attributes option to be passed.
+* <tt>:set_attributes</tt> - Sets attributes on all elements that match the supplied selector, replacing existing attribute value if present or adding if not. Expects :attributes option to be passed.
 
 * <tt>:add_to_attributes</tt> - Appends value to attributes on all elements that match the supplied selector, adds attribute if not present. Expects :attributes option to be passed.
 

data/deface.gemspec

@@ -1,26 +1,27 @@
 Gem::Specification.new do |s|
   s.name = "deface"
-  s.version = "1.0.0.rc2"
+  s.version = "1.0.0.rc3"
 
   s.authors = ["Brian D Quinn"]
-  s.description = "Deface is a library that allows you to customize ERB & HAML views in a Rails application without editing the underlying view."
+  s.description = "Deface is a library that allows you to customize ERB, Haml and Slim views in a Rails application without editing the underlying view."
   s.email = "brian@spreecommerce.com"
   s.extra_rdoc_files = [
     "README.markdown"
   ]
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.homepage = "http://github.com/railsdog/deface"
+  s.homepage = "https://github.com/spree/deface"
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.summary = "Deface is a library that allows you to customize ERB & HAML views in Rails"
+  s.summary = "Deface is a library that allows you to customize ERB, Haml and Slim views in Rails"
 
-  s.add_dependency('nokogiri', '~> 1.5.9')
-  s.add_dependency('rails', '~> 3.1')
+  s.add_dependency('nokogiri', '~> 1.6.0')
+  s.add_dependency('rails', '>= 3.1')
   s.add_dependency('colorize', '>= 0.5.8')
 
   s.add_development_dependency('rspec', '>= 2.11.0')
   s.add_development_dependency('haml', '>= 3.1.4')
+  s.add_development_dependency('slim', '>= 2.0.0')
   s.add_development_dependency('simplecov', '>= 0.6.4')
   s.add_development_dependency('generator_spec', '~> 0.8.5')
 end

data/gemfiles/rails4_0.gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem "rails", "~> 4.0.0.rc1"
+
+gemspec :path => "../"

data/lib/deface.rb

@@ -11,6 +11,7 @@ require "deface/sources/source"
 require "deface/sources/text"
 require "deface/sources/erb"
 require "deface/sources/haml"
+require "deface/sources/slim"
 require "deface/sources/partial"
 require "deface/sources/template"
 require "deface/sources/copy"
@@ -46,5 +47,5 @@ module Deface
   class DefaceError < StandardError; end
 
   class NotSupportedError < DefaceError; end
-  
+
 end

data/lib/deface/action_view_extensions.rb

@@ -2,12 +2,16 @@ ActionView::Template.class_eval do
   alias_method :initialize_without_deface, :initialize
 
   def initialize(source, identifier, handler, details)
-    if Rails.application.config.deface.enabled && should_be_defaced?(handler)
-      haml = handler.to_s == "Haml::Plugin"
+    syntax = determine_syntax(handler)
 
-      processed_source = Deface::Override.apply(source, details, true, haml )
+    if Rails.application.config.deface.enabled && should_be_defaced?(syntax)
 
-      if haml && processed_source != source
+      processed_source = Deface::Override.apply(source, details, true, syntax)
+
+      # force change in handler before continuing to original Rails method
+      # as we've just converted some other template language into ERB!
+      #
+      if [:slim, :haml].include?(syntax) && processed_source != source
         handler = ActionView::Template::Handlers::ERB
       end
     else
@@ -53,8 +57,20 @@ ActionView::Template.class_eval do
 
   private
 
-    def should_be_defaced?(handler)
-      handler.to_s.demodulize == "ERB" || handler.class.to_s.demodulize == "ERB" || handler.to_s == "Haml::Plugin"
+    def should_be_defaced?(syntax)
+      syntax != :unknown
+    end
+
+    def determine_syntax(handler)
+      if handler.to_s == "Haml::Plugin"
+        :haml
+      elsif handler.class.to_s == "Slim::RailsTemplate"
+        :slim
+      elsif handler.to_s.demodulize == "ERB" || handler.class.to_s.demodulize == "ERB"
+        :erb
+      else
+        :unknown
+      end
     end
 end
 

data/lib/deface/applicator.rb

@@ -3,7 +3,7 @@ module Deface
     module ClassMethods
       # applies all applicable overrides to given source
       #
-      def apply(source, details, log=true, haml=false)
+      def apply(source, details, log=true, syntax=:erb)
         overrides = find(details)
 
         if log && overrides.size > 0
@@ -11,9 +11,12 @@ module Deface
         end
 
         unless overrides.empty?
-          if haml
+          case syntax
+          when :haml
             #convert haml to erb before parsing before
             source = Deface::HamlConverter.new(source).result
+          when :slim
+            source = Slim::ERBConverter.new.call(source)
           end
 
           doc = Deface::Parser.convert(source)

data/lib/deface/dsl/loader.rb

@@ -6,8 +6,8 @@ module Deface
   module DSL
     class Loader
       def self.load(filename, options = nil, &block)
-        unless File.basename(filename) =~ /^[^\.]+(.html.(erb|haml)){0,1}.deface$/
-          raise "Deface::DSL does not know how to read '#{filename}'. Override files should end with just .deface, .html.erb.deface, or .html.haml.deface"
+        unless File.basename(filename) =~ /^[^\.]+(.html.(erb|haml|slim)){0,1}.deface$/
+          raise "Deface::DSL does not know how to read '#{filename}'. Override files should end with just .deface, .html.erb.deface, .html.haml.deface or .html.slim.deface"
         end
 
         unless file_in_dir_below_overrides?(filename)
@@ -37,6 +37,15 @@ module Deface
             context.instance_eval(dsl_commands)
             context.haml(the_rest)
             context.create_override
+          elsif context_name.end_with?('.html.slim')
+            dsl_commands, the_rest = extract_dsl_commands_from_slim(file_contents)
+
+            context_name = context_name.gsub('.html.slim', '')
+            context = Context.new(context_name)
+            context.virtual_path(determine_virtual_path(filename))
+            context.instance_eval(dsl_commands)
+            context.slim(the_rest)
+            context.create_override
           else
             context = Context.new(context_name)
             context.virtual_path(determine_virtual_path(filename))
@@ -99,7 +108,12 @@ module Deface
         [dsl_commands, file_contents]
       end
 
-      private 
+      class << self
+        alias_method :extract_dsl_commands_from_slim, :extract_dsl_commands_from_haml
+      end
+
+
+      private
 
       def self.starts_with_html_comment?(line)
         line.lstrip.index('<!--') == 0
@@ -126,4 +140,4 @@ module Deface
       end
     end
   end
-end
+end

data/lib/deface/environment.rb

@@ -3,14 +3,15 @@ module Deface
         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]
+  DEFAULT_SOURCES = [ Sources::Text, Sources::Erb, Sources::Haml, Sources::Slim, Sources::Partial, Sources::Template, Sources::Cut, Sources::Copy]
 
   class Environment
-    attr_accessor :overrides, :enabled, :haml_support, :namespaced
+    attr_accessor :overrides, :enabled, :haml_support, :namespaced, :slim_support
     def initialize
       @overrides    = Overrides.new
       @enabled      = true
       @haml_support = false
+      @slim_support = false
       @actions      = []
       @sources      = []
       @namespaced   = false
@@ -51,16 +52,21 @@ module Deface
     end
 
     def load_all(app)
-      #clear overrides before reloading them
+      # clear overrides before reloading them
       app.config.deface.overrides.all.clear
       Deface::DSL::Loader.register
 
       # check all railties / engines / extensions / application for overrides
-      app.railties.all.dup.push(app).each do |railtie|
+      railties = if Rails.version >= "4.0"
+        app.railties._all
+      else
+        app.railties.all
+      end
+
+      railties.dup.push(app).each do |railtie|
         next unless railtie.respond_to? :root
         load_overrides(railtie)
       end
-
     end
 
     def early_check

data/lib/deface/parser.rb

@@ -71,23 +71,29 @@ module Deface
         source.gsub!("#{match[0]}#{match[1]}#{match[2]}") { |m| m = "#{match[0]}#{ CGI.unescapeHTML match[1] }#{match[2]}" }
       end
 
+      if RUBY_PLATFORM == 'java'
+        #un-escapes changes from Nokogiri under Java, where " are converted to %22 when in an attribute of an element
+        #
+        source.scan(/(<%.*?)((?:(?!%>)[\s\S])*)(%>)/).each do |match|
+          source.gsub!("#{match[0]}#{match[1]}#{match[2]}") { |m| m = "#{match[0]}#{ match[1].gsub('%22', '"') }#{match[2]}" }
+        end
+      end
+
       source
     end
 
     def self.convert(source)
-      if source.encoding_aware?
-        # Look for # encoding: *. If we find one, we'll encode the
-        # String in that encoding, otherwise, we'll use the
-        # default external encoding.
-        encoding = source.scan(/#{ActionView::Template::Handlers::ERB.const_get(:ENCODING_TAG)}/).first.try(:last) || Encoding.default_external
-
-        # Tag the source with the default external encoding
-        # or the encoding specified in the file
-        source.force_encoding(encoding)
-
-        unless source.valid_encoding?
-          raise ActionView::WrongEncodingError.new(source, encoding)
-        end
+      # Look for # encoding: *. If we find one, we'll encode the
+      # String in that encoding, otherwise, we'll use the
+      # default external encoding.
+      encoding = source.scan(/#{ActionView::Template::Handlers::ERB.const_get(:ENCODING_TAG)}/).first.try(:last) || Encoding.default_external
+
+      # Tag the source with the default external encoding
+      # or the encoding specified in the file
+      source.force_encoding(encoding)
+
+      unless source.valid_encoding?
+        raise ActionView::WrongEncodingError.new(source, encoding)
       end
 
       erb_markup!(source)
@@ -100,6 +106,5 @@ module Deface
         Nokogiri::HTML::DocumentFragment.parse(source)
       end
     end
-
   end
 end

data/lib/deface/railtie.rb

@@ -39,9 +39,14 @@ module Deface
       app.config.eager_load_paths.reject! {|path| path  =~ /app\/overrides\z/ }
 
       # railites / engines / extensions
-      app.railties.all.each do |railtie|
-        next unless railtie.respond_to? :root
+      railties = if Rails.version >= "4.0"
+        app.railties._all
+      else
+        app.railties.all
+      end
 
+      railties.each do |railtie|
+        next unless railtie.respond_to? :root
         railtie.config.eager_load_paths.reject! {|path| path  =~ /app\/overrides\z/ }
       end
     end
@@ -63,6 +68,11 @@ module Deface
           require 'deface/haml_converter'
         end
 
+        if defined?(Slim)
+          app.config.deface.slim_support = true
+          require 'slim/erb_converter'
+        end
+
         # catchs any overrides that we required manually
         app.config.deface.overrides.early_check
 

data/lib/deface/sources/slim.rb

@@ -0,0 +1,13 @@
+module Deface
+  module Sources
+    class Slim < Source
+      def self.execute(override)
+        if Rails.application.config.deface.slim_support
+          ::Slim::ERBConverter.new.call(override.args[:slim])
+        else
+          raise Deface::NotSupportedError, "`#{override.name}` supplies :slim source, but slim_support is not detected."
+        end
+      end
+    end
+  end
+end

data/lib/deface/template_helper.rb

@@ -22,6 +22,8 @@ module Deface
 
       if view.handler.to_s == "Haml::Plugin"
         Deface::HamlConverter.new(view.source).result
+      elsif view.handler.class.to_s == "Slim::RailsTemplate"
+        Slim::ERBConverter.new.call(view.source)
       else
         view.source
       end

data/lib/generators/deface/templates/override.html.slim.deface

@@ -0,0 +1,3 @@
+/
+  insert_after 'h1'
+h2 These robots are awesome.

data/spec/assets/shared/_hi.html.slim

@@ -0,0 +1 @@
+div class="some" id="message"= "Hi, World!"

data/spec/assets/shared/public.html.slim

@@ -0,0 +1,5 @@
+#content
+  .left
+     p= print_information
+  .right(id=@right)
+    = render :partial => "sidebar"

data/spec/deface/action_view_template_spec.rb

@@ -86,7 +86,8 @@ module ActionView
         expectations.each do |handler, expected|
           @template = ActionView::Template.new("xml.post => :blah", "/some/path/to/file.erb", handler, {:virtual_path=>"posts/index", :format=>:xml, :updated_at => (Time.now - 100)})
           @template.is_a?(ActionView::Template).should == true
-          @template.send(:should_be_defaced?, handler).should eq(expected), "unexpected result for handler "+handler.to_s
+          syntax = @template.send(:determine_syntax, handler)
+          @template.send(:should_be_defaced?, syntax).should eq(expected), "unexpected result for handler "+handler.to_s
         end
       end
     end

data/spec/deface/dsl/loader_spec.rb

@@ -10,7 +10,7 @@ describe Deface::DSL::Loader do
         filename = 'app/overrides/example_name.deface'
 
         lambda { Deface::DSL::Loader.load(filename) }.should_not raise_error(
-          "Deface::DSL does not know how to read 'app/overrides/example_name.deface'. Override files should end with just .deface, .html.erb.deface, or .html.haml.deface")        
+          "Deface::DSL does not know how to read 'app/overrides/example_name.deface'. Override files should end with just .deface, .html.erb.deface, .html.haml.deface or .html.slim.deface")
       end
 
       it 'should succeed if file ends with .html.erb.deface' do
@@ -18,7 +18,7 @@ describe Deface::DSL::Loader do
         filename = 'app/overrides/example_name.html.erb.deface'
 
         lambda { Deface::DSL::Loader.load(filename) }.should_not raise_error(
-          "Deface::DSL does not know how to read 'app/overrides/example_name.html.erb.deface'. Override files should end with just .deface, .html.erb.deface, or .html.haml.deface")        
+          "Deface::DSL does not know how to read 'app/overrides/example_name.html.erb.deface'. Override files should end with just .deface, .html.erb.deface, .html.haml.deface or .html.slim.deface")
       end
 
       it 'should succeed if file ends with .html.haml.deface' do
@@ -26,7 +26,15 @@ describe Deface::DSL::Loader do
         filename = 'app/overrides/example_name.html.haml.deface'
 
         lambda { Deface::DSL::Loader.load(filename) }.should_not raise_error(
-          "Deface::DSL does not know how to read 'app/overrides/example_name.html.haml.deface'. Override files should end with just .deface, .html.erb.deface, or .html.haml.deface")
+          "Deface::DSL does not know how to read 'app/overrides/example_name.html.haml.deface'. Override files should end with just .deface, .html.erb.deface, .html.haml.deface or .html.slim.deface")
+      end
+
+      it 'should succeed if file ends with .html.slim.deface' do
+        file = mock('deface file')
+        filename = 'app/overrides/example_name.html.slim.deface'
+
+        lambda { Deface::DSL::Loader.load(filename) }.should_not raise_error(
+          "Deface::DSL does not know how to read 'app/overrides/example_name.html.slim.deface'. Override files should end with just .deface, .html.erb.deface, .html.haml.deface or .html.slim.deface")
       end
 
       it 'should fail if file ends with .blargh.deface' do
@@ -34,7 +42,7 @@ describe Deface::DSL::Loader do
         filename = 'app/overrides/example_name.blargh.deface'
 
         lambda { Deface::DSL::Loader.load(filename) }.should raise_error(
-          "Deface::DSL does not know how to read 'app/overrides/example_name.blargh.deface'. Override files should end with just .deface, .html.erb.deface, or .html.haml.deface")
+          "Deface::DSL does not know how to read 'app/overrides/example_name.blargh.deface'. Override files should end with just .deface, .html.erb.deface, .html.haml.deface or .html.slim.deface")
       end
 
       it "should suceed if parent directory has a dot(.) in it's name" do
@@ -42,7 +50,7 @@ describe Deface::DSL::Loader do
         filename = 'app/overrides/parent.dir.with.dot/example_name.html.haml.deface'
 
         lambda { Deface::DSL::Loader.load(filename) }.should_not raise_error(
-          "Deface::DSL does not know how to read 'app/overrides/parent.dir.with.dot/example_name.html.haml.deface'. Override files should end with just .deface, .html.erb.deface, or .html.haml.deface")
+          "Deface::DSL does not know how to read 'app/overrides/parent.dir.with.dot/example_name.html.haml.deface'. Override files should end with just .deface, .html.erb.deface, .html.haml.deface or .html.slim.deface")
       end
     end
 
@@ -124,6 +132,31 @@ describe Deface::DSL::Loader do
       Deface::DSL::Loader.load(filename)
     end
 
+    it 'should set the virtual_path for a .html.slim.deface file in a directory below overrides' do
+      file = mock('html/slim/deface file')
+      filename = 'app/overrides/path/to/view/example_name.html.slim.deface'
+      File.should_receive(:open).with(filename).and_yield(file)
+
+      override_name = 'example_name'
+      context = mock('dsl context')
+      Deface::DSL::Context.should_receive(:new).with(override_name).
+        and_return(context)
+
+      file_contents = mock('file contents')
+      file.should_receive(:read).and_return(file_contents)
+
+      Deface::DSL::Loader.should_receive(:extract_dsl_commands_from_slim).
+        with(file_contents).
+        and_return(['dsl commands', 'slim'])
+
+      context.should_receive(:virtual_path).with('path/to/view').ordered
+      context.should_receive(:instance_eval).with('dsl commands').ordered
+      context.should_receive(:slim).with('slim').ordered
+      context.should_receive(:create_override).ordered
+
+      Deface::DSL::Loader.load(filename)
+    end
+
   end
 
   context '.register' do
@@ -220,6 +253,28 @@ describe Deface::DSL::Loader do
       dsl_commands.should == ""
       the_rest.should == example
     end
+  end
+
+  context '.extract_dsl_commands_from_slim' do
+    it 'should work in the simplest case' do
+      example = "/ test 'command'\n/ another 'command'\nh1 Wow!"
+      dsl_commands, the_rest = Deface::DSL::Loader.extract_dsl_commands_from_slim(example)
+      dsl_commands.should == "test 'command'\nanother 'command'\n"
+      the_rest.should == "h1 Wow!"
+    end
 
+    it 'should work with a block style comment using spaces' do
+      example = "/\n  test 'command'\n  another 'command'\nh1 Wow!"
+      dsl_commands, the_rest = Deface::DSL::Loader.extract_dsl_commands_from_slim(example)
+      dsl_commands.should == "\ntest 'command'\nanother 'command'\n"
+      the_rest.should == "h1 Wow!"
+    end
+
+    it 'should leave internal comments alone' do
+      example = "br\n/ test 'command'\n/ another 'command'\nh1 Wow!"
+      dsl_commands, the_rest = Deface::DSL::Loader.extract_dsl_commands_from_erb(example)
+      dsl_commands.should == ""
+      the_rest.should == example
+    end
   end
 end