emcee 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fb57be0dd8aa54269cad7513113aecae19cc050b
-  data.tar.gz: 5b088d3adeadf5be4fddbc4896d212be3a14aa05
+  metadata.gz: 6ef8c2343235af9adfdfca951fce261b485cb8a9
+  data.tar.gz: 32286f3d1f8d3ee071d61a8baeb7877029bd63f9
 SHA512:
-  metadata.gz: 9b749f99a257f213979bc70167e002e0d818bea8c8760b396a03cd937f2c08f7eda2a54b2a67f7753954331953b218ac75f7e67f53c8a2a1f3e22eef6fa35eb8
-  data.tar.gz: 8400a030e328ecd2ef69a3dfef0cd13a6a983f07f3c2f2866547ee5477c92492838d11eeba4ecfa91245a9eabaa727a3ece76ad0155a10906e48c81a479482b3
+  metadata.gz: 2157456f4bfda8ddcdd94e75fa190066c571c3b3aa868e27550f572ecba940d030a307844bde3c2092ce6496afe9d2f22fdc503156c67780c427fe1a374d6375
+  data.tar.gz: d68fa85fb967dc7bebde6626f6fc91ba81e0cebe6e2cc97fa3826686ad0149e509acb322c55e9fa1c3280b3c5f3b2634d02e25e356231a35eb1cf9aef55bd01f

data/lib/emcee/processors/html_processor.rb

@@ -14,6 +14,12 @@ module Emcee
     # work for us.
     #
     class HtmlProcessor < Sprockets::DirectiveProcessor
+      include Emcee::Processors::Includes
+      protected :process_imports
+      protected :process_stylesheets
+      protected :process_scripts
+      private   :read_file
+
       # Matches the entire header/directive block. This is everything from the
       # top of the file, enclosed in html comments.
       #
@@ -40,37 +46,6 @@ module Emcee
       #
       DIRECTIVE_PATTERN = /^\W*=\s*(\w+.*?)$/
 
-      # Match an html import tag.
-      #
-      #   <link rel="import" href="example.html">
-      #
-      IMPORT_PATTERN = /^<link .*rel=["']import["'].*>$/
-
-      # Match a stylesheet link tag.
-      #
-      #   <link rel="stylesheet" href="example.css">
-      #
-      STYLESHEET_PATTERN = /^ +<link .*rel=["']stylesheet["'].*>$/
-
-      # Match a script tag.
-      #
-      #   <script src="assets/example.js"></script>
-      #
-      SCRIPT_PATTERN = /^ *<script .*src=["'].+\.js["']><\/script>$/
-
-      # Match the path from the href attribute of an html import or stylesheet
-      # include tag. Captures the actual path.
-      #
-      #   href="/assets/example.css"
-      #
-      HREF_PATH_PATTERN = /href=["'](?<path>[\w\.\/-]+)["']/
-
-      # Match the source path from a script tag. Captures the actual path.
-      #
-      #   src="/assets/example.js"
-      #
-      SRC_PATH_PATTERN = /src=["'](?<path>[\w\.\/-]+)["']/
-
       # Render takes the actual text of the file and does our processing to it.
       # This is based on the standard render method on Sprockets's
       # DirectiveProcessor.
@@ -93,63 +68,13 @@ module Emcee
         @has_written_body = false
 
         process_directives
-        process_imports
-        process_stylesheets
-        process_scripts
+        @body = process_imports(@body, @context, @directory)
+        @body = process_stylesheets(@body, @directory)
+        @body = process_scripts(@body, @directory)
         process_source
 
         @result
       end
-
-      protected
-        # Scan the body for html imports. If any are found, tell sprockets to
-        # require their files like we would for a directive.
-        def process_imports
-          body.scan(IMPORT_PATTERN) do |import_tag|
-            if path = import_tag[HREF_PATH_PATTERN, :path]
-              absolute_path = File.absolute_path(path, @directory)
-              context.require_asset(absolute_path)
-            end
-          end
-
-          @body.gsub!(IMPORT_PATTERN, "")
-        end
-
-        # Scan the body for external stylesheet references. If any are found,
-        # inline the files in place of the references.
-        def process_stylesheets
-          to_inline = []
-
-          body.scan(STYLESHEET_PATTERN) do |stylesheet_tag|
-            if path = stylesheet_tag[HREF_PATH_PATTERN, :path]
-              absolute_path = File.absolute_path(path, @directory)
-              stylesheet_contents = File.read(absolute_path)
-              to_inline << [stylesheet_tag, "<style>\n" + stylesheet_contents + "</style>\n"]
-            end
-          end
-
-          to_inline.each do |(tag, contents)|
-            @body.gsub!(tag, contents)
-          end
-        end
-
-        # Scan the body for external script references. If any are found, inline
-        # the files in place of the references.
-        def process_scripts
-          to_inline = []
-
-          body.scan(SCRIPT_PATTERN) do |script_tag|
-            if path = script_tag[SRC_PATH_PATTERN, :path]
-              absolute_path = File.absolute_path(path, @directory)
-              script_contents = File.read(absolute_path)
-              to_inline << [script_tag, "<script>\n" + script_contents + "</script>\n"]
-            end
-          end
-
-          to_inline.each do |(tag, contents)|
-            @body.gsub!(tag, contents)
-          end
-        end
     end
   end
 end

data/lib/emcee/processors/processor_includes.rb

@@ -0,0 +1,98 @@
+module Emcee
+  module Processors
+    # This module has method definition that we will include into HtmlProcessor.
+    #
+    # We seperate these out to make them easier to test. Testing a class that inherits
+    # from Sprockets::DirectiveProcessor (which our HtmlProcessor does) is not
+    # straightforward.
+    #
+    module Includes
+      # Match an html import tag.
+      #
+      #   <link rel="import" href="assets/example.html">
+      #
+      IMPORT_PATTERN = /^ *<link .*rel=["']import["'].*>$/
+
+      # Match a stylesheet link tag.
+      #
+      #   <link rel="stylesheet" href="assets/example.css">
+      #
+      STYLESHEET_PATTERN = /^ *<link .*rel=["']stylesheet["'].*>$/
+
+      # Match a script tag.
+      #
+      #   <script src="assets/example.js"></script>
+      #
+      SCRIPT_PATTERN = /^ *<script .*src=["'].+\.js["']><\/script>$/
+
+      # Match the path from the href attribute of an html import or stylesheet
+      # include tag. Captures the actual path.
+      #
+      #   href="/assets/example.css"
+      #
+      HREF_PATH_PATTERN = /href=["'](?<path>[\w\.\/-]+)["']/
+
+      # Match the source path from a script tag. Captures the actual path.
+      #
+      #   src="/assets/example.js"
+      #
+      SRC_PATH_PATTERN = /src=["'](?<path>[\w\.\/-]+)["']/
+
+      # Return a file's contents as text. This is split out as a method so that
+      # we can test the other methods in this module without actually reading from
+      # the filesystem.
+      def read_file(path)
+        File.read(path)
+      end
+
+      # Scan the body for html imports. If any are found, tell sprockets to
+      # require their files like we would for a directive. Then remove the import.
+      def process_imports(body, context, directory)
+        body.scan(IMPORT_PATTERN) do |import_tag|
+          if path = import_tag[HREF_PATH_PATTERN, :path]
+            absolute_path = File.absolute_path(path, directory)
+            context.require_asset(absolute_path)
+          end
+        end
+
+        body.gsub(IMPORT_PATTERN, "")
+      end
+
+      # Scan the body for external stylesheet references. If any are found,
+      # inline the files in place of the references.
+      def process_stylesheets(body, directory)
+        to_inline = []
+
+        body.scan(STYLESHEET_PATTERN) do |stylesheet_tag|
+          if path = stylesheet_tag[HREF_PATH_PATTERN, :path]
+            absolute_path = File.absolute_path(path, directory)
+            stylesheet_contents = read_file(absolute_path)
+            to_inline << [stylesheet_tag, "<style>" + stylesheet_contents + "</style>"]
+          end
+        end
+
+        to_inline.reduce(body) do |output, (tag, contents)|
+          output.gsub(tag, contents)
+        end
+      end
+
+      # Scan the body for external script references. If any are found, inline
+      # the files in place of the references.
+      def process_scripts(body, directory)
+        to_inline = []
+
+        body.scan(SCRIPT_PATTERN) do |script_tag|
+          if path = script_tag[SRC_PATH_PATTERN, :path]
+            absolute_path = File.absolute_path(path, directory)
+            script_contents = read_file(absolute_path)
+            to_inline << [script_tag, "<script>" + script_contents + "</script>"]
+          end
+        end
+
+        to_inline.reduce(body) do |output, (tag, contents)|
+          output.gsub(tag, contents)
+        end
+      end
+    end
+  end
+end

data/lib/emcee/railtie.rb

@@ -1,3 +1,4 @@
+require "emcee/processors/processor_includes"
 require "emcee/processors/html_processor"
 require "emcee/compressors/html_compressor"
 

data/lib/emcee/version.rb

@@ -1,3 +1,3 @@
 module Emcee
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/test/compressors_test.rb

@@ -1,4 +1,4 @@
-require 'test_Helper'
+require 'test_helper'
 
 class CompressorsTest < ActiveSupport::TestCase
   setup do
@@ -6,36 +6,80 @@ class CompressorsTest < ActiveSupport::TestCase
   end
 
   test "compressor should remove html comments" do
-    content = "<!--\nHere\nAre\nSome Comments\n-->\n<span>test</span>\n"
-    assert_equal "<span>test</span>\n", @compressor.compress(content)
+    content = %q{
+      <!--
+        What will we do with all
+        of these html comments?
+      -->
+      <span>The span to end all spans</span>
+    }
+    assert_equal "\n" + @compressor.compress(content), %q{
+      <span>The span to end all spans</span>
+    }
   end
 
   test "compressor should remove multi-line javascript comments" do
-    content = "<script>\n/*\nHere\nAre\nA Bunch\nOf Comments\n*/\n</script>\n"
-    assert_equal "<script>\n</script>\n", @compressor.compress(content)
+    content = %q{
+      <script>
+        /*
+        Here are some comments that
+        go over many, many lines.
+        */
+      </script>
+    }
+    assert_equal "\n" + @compressor.compress(content), %q{
+      <script>
+      </script>
+    }
   end
 
   test "compressor should remove single-line javascript comments" do
-    content = "<script>\n// Here\n// Are Yet\n// Some More\n// Of The\n// Comments\n</script>\n"
-    assert_equal "<script>\n</script>\n", @compressor.compress(content)
+    content = %q{
+      <script>
+        // Here is a comment.
+        // Here is another coment.
+      </script>
+    }
+    assert_equal "\n" + @compressor.compress(content), %q{
+      <script>
+      </script>
+    }
   end
 
   test "compressor should remove css comments" do
     content = %q{
-<style>
-  h1 {
-    /*
-    Make it pink
-    */
-    color: pink;
-  }
-</style>
-}
-  assert_equal "<style>\n  h1 {\n    color: pink;\n  }\n</style>\n", @compressor.compress(content)
+      <style>
+        h1 {
+          /*
+          Make it pink
+          */
+          color: pink;
+        }
+      </style>
+    }
+    assert_equal "\n" + @compressor.compress(content), %q{
+      <style>
+        h1 {
+          color: pink;
+        }
+      </style>
+    }
   end
 
   test "compressor should remove blank lines" do
-    content = "<p>test</p>\n\n\n\n\n\n<p>oh yeah</p>"
-    assert_equal "<p>test</p>\n<p>oh yeah</p>", @compressor.compress(content)
+    content = %q{
+      <p>test</p>
+
+
+
+      <p>oh yeah</p>
+
+      <p>test</p>
+    }
+    assert_equal "\n" + @compressor.compress(content), %q{
+      <p>test</p>
+      <p>oh yeah</p>
+      <p>test</p>
+    }
   end
 end

data/test/dummy/app/assets/elements/application.html

@@ -5,8 +5,6 @@
  * Any html files within this directory, lib/assets/elements, or vendor/assets/elements
  * can be referenced here using a relative path.
  *
- *= require test1
- *= require test/test2
  *= require test4
  *= require_tree .
 -->

data/test/dummy/app/assets/elements/test/test3.css

@@ -0,0 +1,3 @@
+p {
+  color: pink;
+}

data/test/dummy/app/assets/elements/test/test3.html

@@ -1 +1,2 @@
+<link rel="stylesheet" href="test3.css">
 <p>test3</p>

data/test/dummy/log/development.log

@@ -10,3 +10,204 @@ Started GET "/assets/application.css?body=1" for 127.0.0.1 at 2014-03-04 20:48:1
 
 
 Started GET "/assets/application.js?body=1" for 127.0.0.1 at 2014-03-04 20:48:17 -0500
+
+
+Started GET "/" for 127.0.0.1 at 2014-03-05 07:08:48 -0500
+Processing by DummyController#index as HTML
+  Rendered dummy/index.html.erb within layouts/application (0.9ms)
+Completed 200 OK in 62ms (Views: 61.7ms | ActiveRecord: 0.0ms)
+
+
+Started GET "/assets/application.css?body=1" for 127.0.0.1 at 2014-03-05 07:08:48 -0500
+
+
+Started GET "/assets/application.js?body=1" for 127.0.0.1 at 2014-03-05 07:08:48 -0500
+
+
+Started GET "/assets/test/test3.html?body=1" for 127.0.0.1 at 2014-03-05 07:08:56 -0500
+
+
+Started GET "/assets/test/test2.html?body=1" for 127.0.0.1 at 2014-03-05 07:09:06 -0500
+
+
+Started GET "/assets/test/test2.html?body=1" for 127.0.0.1 at 2014-03-05 07:09:08 -0500
+
+
+Started GET "/" for 127.0.0.1 at 2014-03-05 07:10:19 -0500
+Processing by DummyController#index as HTML
+  Rendered dummy/index.html.erb within layouts/application (0.1ms)
+Completed 200 OK in 38ms (Views: 38.2ms | ActiveRecord: 0.0ms)
+
+
+Started GET "/assets/application.css?body=1" for 127.0.0.1 at 2014-03-05 07:10:19 -0500
+
+
+Started GET "/assets/application.js?body=1" for 127.0.0.1 at 2014-03-05 07:10:19 -0500
+
+
+Started GET "/assets/test/test3.html?body=1" for 127.0.0.1 at 2014-03-05 07:10:22 -0500
+
+
+Started GET "/assets/test/test3.css" for 127.0.0.1 at 2014-03-05 07:10:23 -0500
+
+
+Started GET "/" for 127.0.0.1 at 2014-03-05 07:29:57 -0500
+Processing by DummyController#index as HTML
+  Rendered dummy/index.html.erb within layouts/application (1.1ms)
+Completed 200 OK in 88ms (Views: 87.9ms | ActiveRecord: 0.0ms)
+
+
+Started GET "/assets/application.css?body=1" for 127.0.0.1 at 2014-03-05 07:29:58 -0500
+
+
+Started GET "/assets/application.js?body=1" for 127.0.0.1 at 2014-03-05 07:29:58 -0500
+
+
+Started GET "/" for 127.0.0.1 at 2014-03-05 07:30:10 -0500
+Processing by DummyController#index as HTML
+  Rendered dummy/index.html.erb within layouts/application (0.1ms)
+Completed 200 OK in 4ms (Views: 4.2ms | ActiveRecord: 0.0ms)
+
+
+Started GET "/assets/application.css?body=1" for 127.0.0.1 at 2014-03-05 07:30:10 -0500
+
+
+Started GET "/assets/application.js?body=1" for 127.0.0.1 at 2014-03-05 07:30:10 -0500
+
+
+Started GET "/assets/test1.html?body=1" for 127.0.0.1 at 2014-03-05 07:30:16 -0500
+
+
+Started GET "/assets/test/test2.html?body=1" for 127.0.0.1 at 2014-03-05 07:30:26 -0500
+
+
+Started GET "/assets/test/test3.html?body=1" for 127.0.0.1 at 2014-03-05 07:30:36 -0500
+
+
+Started GET "/assets/test/test3.css" for 127.0.0.1 at 2014-03-05 07:30:37 -0500
+
+
+Started GET "/assets/test4.html?body=1" for 127.0.0.1 at 2014-03-05 07:30:48 -0500
+
+
+Started GET "/" for 127.0.0.1 at 2014-03-05 07:31:48 -0500
+Processing by DummyController#index as HTML
+  Rendered dummy/index.html.erb within layouts/application (0.0ms)
+Completed 200 OK in 4ms (Views: 3.9ms | ActiveRecord: 0.0ms)
+
+
+Started GET "/assets/application.css?body=1" for 127.0.0.1 at 2014-03-05 07:31:49 -0500
+
+
+Started GET "/assets/application.js?body=1" for 127.0.0.1 at 2014-03-05 07:31:49 -0500
+
+
+Started GET "/assets/test/test3.html?body=1" for 127.0.0.1 at 2014-03-05 07:31:51 -0500
+
+
+Started GET "/assets/test/test3.css" for 127.0.0.1 at 2014-03-05 07:31:51 -0500
+
+
+Started GET "/" for 127.0.0.1 at 2014-03-05 07:32:19 -0500
+Processing by DummyController#index as HTML
+  Rendered dummy/index.html.erb within layouts/application (1.0ms)
+Completed 200 OK in 46ms (Views: 45.5ms | ActiveRecord: 0.0ms)
+
+
+Started GET "/assets/application.css?body=1" for 127.0.0.1 at 2014-03-05 07:32:19 -0500
+
+
+Started GET "/assets/application.js?body=1" for 127.0.0.1 at 2014-03-05 07:32:19 -0500
+
+
+Started GET "/assets/test/test3.html?body=1" for 127.0.0.1 at 2014-03-05 07:32:21 -0500
+
+
+Started GET "/assets/test/test3.css" for 127.0.0.1 at 2014-03-05 07:32:21 -0500
+
+
+Started GET "/assets/test/test3.css" for 127.0.0.1 at 2014-03-05 07:32:25 -0500
+
+
+Started GET "/" for 127.0.0.1 at 2014-03-05 07:32:45 -0500
+Processing by DummyController#index as HTML
+  Rendered dummy/index.html.erb within layouts/application (1.0ms)
+Completed 200 OK in 65ms (Views: 65.0ms | ActiveRecord: 0.0ms)
+
+
+Started GET "/assets/application.css?body=1" for 127.0.0.1 at 2014-03-05 07:32:45 -0500
+
+
+Started GET "/assets/application.js?body=1" for 127.0.0.1 at 2014-03-05 07:32:45 -0500
+
+
+Started GET "/assets/test/test3.html?body=1" for 127.0.0.1 at 2014-03-05 07:32:48 -0500
+
+
+Started GET "/" for 127.0.0.1 at 2014-03-05 07:38:40 -0500
+Processing by DummyController#index as HTML
+  Rendered dummy/index.html.erb within layouts/application (0.9ms)
+Completed 200 OK in 45ms (Views: 44.3ms | ActiveRecord: 0.0ms)
+
+
+Started GET "/assets/application.css?body=1" for 127.0.0.1 at 2014-03-05 07:38:41 -0500
+
+
+Started GET "/assets/application.js?body=1" for 127.0.0.1 at 2014-03-05 07:38:41 -0500
+
+
+Started GET "/assets/application.html?body=1" for 127.0.0.1 at 2014-03-05 07:38:48 -0500
+
+
+Started GET "/assets/test1.html?body=1" for 127.0.0.1 at 2014-03-05 07:38:56 -0500
+
+
+Started GET "/assets/test/test2.html?body=1" for 127.0.0.1 at 2014-03-05 07:39:03 -0500
+
+
+Started GET "/assets/test/test3.html?body=1" for 127.0.0.1 at 2014-03-05 07:39:09 -0500
+
+
+Started GET "/assets/test4.html?body=1" for 127.0.0.1 at 2014-03-05 07:39:15 -0500
+
+
+Started GET "/" for 127.0.0.1 at 2014-03-05 09:00:08 -0500
+Processing by DummyController#index as HTML
+  Rendered dummy/index.html.erb within layouts/application (0.9ms)
+Completed 200 OK in 44ms (Views: 44.0ms | ActiveRecord: 0.0ms)
+
+
+Started GET "/assets/application.css?body=1" for 127.0.0.1 at 2014-03-05 09:00:08 -0500
+
+
+Started GET "/assets/application.js?body=1" for 127.0.0.1 at 2014-03-05 09:00:08 -0500
+
+
+Started GET "/assets/application.html?body=1" for 127.0.0.1 at 2014-03-05 09:00:15 -0500
+
+
+Started GET "/assets/test1.html?body=1" for 127.0.0.1 at 2014-03-05 09:00:22 -0500
+
+
+Started GET "/assets/test/test2.html?body=1" for 127.0.0.1 at 2014-03-05 09:00:28 -0500
+
+
+Started GET "/assets/test/test3.html?body=1" for 127.0.0.1 at 2014-03-05 09:00:38 -0500
+
+
+Started GET "/assets/test4.html?body=1" for 127.0.0.1 at 2014-03-05 09:00:53 -0500
+
+
+Started GET "/" for 127.0.0.1 at 2014-03-05 09:02:08 -0500
+Processing by DummyController#index as HTML
+  Rendered dummy/index.html.erb within layouts/application (0.1ms)
+Completed 200 OK in 32ms (Views: 31.5ms | ActiveRecord: 0.0ms)
+
+
+Started GET "/assets/application.css?body=1" for 127.0.0.1 at 2014-03-05 09:02:08 -0500
+
+
+Started GET "/assets/application.js?body=1" for 127.0.0.1 at 2014-03-05 09:02:08 -0500
+
+
+Started GET "/assets/test4.html?body=1" for 127.0.0.1 at 2014-03-05 09:02:13 -0500