emcee 0.1.6 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f84512c12570cf26feb1bad8ffaf319e6c6c1ff1
-  data.tar.gz: b472037fa77a3734c926253b8f1583ca3492e05c
+  metadata.gz: 8c387ce066ddbe7c70f67a78aaa1a73069136cbb
+  data.tar.gz: 73d6cd25ac0479920b3de9e64137faf64b6a1910
 SHA512:
-  metadata.gz: 651de8d67870c283eacb05f1edb9d6f93b0f74fcc860fe59f0470a381c3a1f644969b451f6225657d2f66339c776c0c31ee2fa814bd20d3d71f1b9569ff177ca
-  data.tar.gz: 82099ebba30e021ae3821d2b94b09b7b038e613962cbd7518db8b4cca40a88e92baa38efde566c6b930ea94ac47e66df90fe5f91d01021dd89806e442c54fff6
+  metadata.gz: cfa30497244debf49f23ba859b7d30983d524c7deec742151b6389c7afb145963e1a2071fb60ba03ddd86f9063612e162c9ed4ccee345ca1089625d13f984c5d
+  data.tar.gz: 7e3be5d29444812fd9443da6366fc49a39853ff40d0fb9b21f640b9ceec73279072771b6dfe1f0525bb9d48dfc9fa38b824a5ef8c98d8490b99e53df7bda8fc3

data/lib/emcee.rb

@@ -1,8 +1,8 @@
 require "emcee/version"
 
-require "emcee/helpers/action_view/asset_url_helper"
-require "emcee/helpers/action_view/asset_tag_helper"
-require "emcee/helpers/sprockets/view_helpers"
-require "emcee/helpers/sprockets/compressing_helpers"
+require "emcee/helpers/asset_url_helper"
+require "emcee/helpers/asset_tag_helper"
+require "emcee/helpers/sprockets_helper"
 
+require "emcee/loose_assets"
 require "emcee/railtie"

data/lib/emcee/compressors/html_compressor.rb

@@ -1,48 +1,17 @@
 module Emcee
-  module Compressors
-    # HtmlCompressor is our basic implementation of an html minifier. For
-    # sprockets to use it, it must have a compress method that only accepts a
-    # string and returns the compressed output.
-    #
-    # Our implementation only strips out html and javascript comments, and
-    # removes blank lines.
-    #
-    class HtmlCompressor
-      # Match html comments.
-      #
-      #   <!--
-      #   Comments
-      #   -->
-      #
-      HTML_COMMENTS = /\<!\s*--(?:.*?)(?:--\s*\>)/m
+  # HtmlCompressor is a very basic compressor that removes blank lines and
+  # comments from an HTML file.
+  class HtmlCompressor
+    HTML_COMMENTS     = /\<!\s*--(?:.*?)(?:--\s*\>)/m
+    JS_MULTI_COMMENTS = /\/\*(?:.*?)\*\//m
+    JS_COMMENTS       = /\/\/.*$/
+    BLANK_LINES       = /^[\s]*$\n/
 
-      # Match multi-line javascript/css comments.
-      #
-      #   /*
-      #   Comments
-      #   */
-      #
-      JS_MULTI_COMMENTS = /\/\*(?:.*?)\*\//m
+    def compress(string)
+      ops = [HTML_COMMENTS, JS_MULTI_COMMENTS, JS_COMMENTS, BLANK_LINES]
 
-      # Match single-line javascript comments.
-      #
-      #   // Comments
-      #
-      # This does not have the /m modifier, because we only want it to match a
-      # single line at a time.
-      #
-      JS_COMMENTS = /\/\/.*$/
-
-      # Match blank lines.
-      BLANK_LINES = /^[\s]*$\n/
-
-      # Remove comments and blank lines from our html.
-      def compress(string)
-        ops = [HTML_COMMENTS, JS_MULTI_COMMENTS, JS_COMMENTS, BLANK_LINES]
-
-        ops.reduce(string) do |output, op|
-          output.gsub(op, "")
-        end
+      ops.reduce(string) do |output, op|
+        output.gsub(op, "")
       end
     end
   end

data/lib/emcee/loose_assets.rb

@@ -0,0 +1,19 @@
+# Monkey patch Sprockets-rails so that loose html files are handled correctly.
+#
+# Not sure that modifying another gem's railtie is a good idea, but it works
+# for now.
+module Sprockets
+  class Railtie
+    # Remove the LOOSE_APP_ASSETS constant so we can modify it without Ruby
+    # complaining.
+    remove_const(:LOOSE_APP_ASSETS) if defined?(LOOSE_APP_ASSETS)
+
+    # Add .html to the loose app assets file extensions.
+    LOOSE_APP_ASSETS = lambda do |filename, path|
+      path =~ /app\/assets/ && !%w(.js .css .html).include?(File.extname(filename))
+    end
+
+    # Add the .html extension to the 'precompile' regex.
+    config.assets.precompile = [LOOSE_APP_ASSETS, /(?:\/|\\|\A)application\.(css|js|html)$/]
+  end
+end

data/lib/emcee/processors/directive_processor.rb

@@ -0,0 +1,33 @@
+module Emcee
+  # The `DirectiveProcessor` is responsible for parsing and evaluating
+  # directive comments in a source file.
+  class DirectiveProcessor < Sprockets::DirectiveProcessor
+    # Matches the entire header/directive block. This is everything from the
+    # top of the file, enclosed in html comments.
+    HEADER_PATTERN = /\A((?m:\s*)(<!--(?m:.*?)-->))+/
+
+    # Implement `render` so that it uses our own header pattern.
+    def render(context, locals)
+      @context = context
+      @pathname = context.pathname
+      @directory = File.dirname(@pathname)
+
+      @header  = data[HEADER_PATTERN, 0] || ""
+      @body    = $' || data
+      # Ensure body ends in a new line
+      @body += "\n" if @body != "" && @body !~ /\n\Z/m
+
+      @included_pathnames = []
+
+      @result = ""
+      @result.force_encoding(body.encoding)
+
+      @has_written_body = false
+
+      process_directives
+      process_source
+
+      @result
+    end
+  end
+end

data/lib/emcee/processors/import_processor.rb

@@ -0,0 +1,39 @@
+module Emcee
+  # ImportProcessor scans a file for html imports and adds them to the current
+  # required assets.
+  class ImportProcessor
+    # Match an html import tag.
+    #
+    #   <link rel="import" href="assets/example.html">
+    #
+    IMPORT_PATTERN = /^\s*<link .*rel=["']import["'].*>$/
+
+    # 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\.\/-]+)["']/
+
+    def process(context, data, directory)
+      require_assets(context, data, directory)
+      remove_imports(data)
+    end
+
+    private
+
+    def require_assets(context, data, directory)
+      data.scan(IMPORT_PATTERN) do |import_tag|
+        path = import_tag[HREF_PATH_PATTERN, :path]
+        return unless path
+
+        absolute_path = File.absolute_path(path, directory)
+        context.require_asset(absolute_path)
+      end
+    end
+
+    def remove_imports(data)
+      data.gsub(IMPORT_PATTERN, "")
+    end
+  end
+end

data/lib/emcee/processors/script_processor.rb

@@ -0,0 +1,67 @@
+module Emcee
+  # ScriptProcessor scans a document for external script references and inlines
+  # them into the current document.
+  class ScriptProcessor
+    # Match a script tag.
+    #
+    #   <script src="assets/example.js"></script>
+    #
+    SCRIPT_PATTERN = /^\s*<script .*src=["'].+\.js["']><\/script>$/
+
+    # Match the source path from a script tag. Captures the actual path.
+    #
+    #   src="/assets/example.js"
+    #
+    SRC_PATH_PATTERN = /src=["'](?<path>[\w\.\/-]+)["']/
+
+    # Match the indentation whitespace of a line
+    #
+    INDENT_PATTERN = /^(?<indent>\s*)/
+
+    def process(context, data, directory)
+      tags = find_tags(data)
+      paths = get_paths(tags)
+      indents = get_indents(tags)
+      contents = get_contents(paths, directory)
+      inline_scripts(data, tags, indents, contents)
+    end
+
+    private
+
+    def read_file(path)
+      File.read(path)
+    end
+
+    def find_tags(data)
+      data.scan(SCRIPT_PATTERN).map do |tag|
+        tag
+      end
+    end
+
+    def get_paths(tags)
+      tags.map do |tag|
+        tag[SRC_PATH_PATTERN, :path]
+      end
+    end
+
+    def get_indents(tags)
+      tags.map do |tag|
+        tag[INDENT_PATTERN, :indent] || ""
+      end
+    end
+
+    def get_contents(paths, directory)
+      paths.map do |path|
+        absolute_path = File.absolute_path(path, directory)
+        read_file(absolute_path)
+      end
+    end
+
+    def inline_scripts(data, tags, indents, contents)
+      tags.each_with_index.reduce(data) do |output, (tag, i)|
+        indent, content = indents[i], contents[i]
+        output.gsub(tag, "#{indent}<script>#{content}\n#{indent}</script>")
+      end
+    end
+  end
+end

data/lib/emcee/processors/stylesheet_processor.rb

@@ -0,0 +1,90 @@
+require "sass"
+
+module Emcee
+  # StylesheetProcessor scans a document for external stylesheet references and
+  # inlines them into the current document.
+  class StylesheetProcessor
+    # Match a stylesheet link tag.
+    #
+    #   <link rel="stylesheet" href="assets/example.css">
+    #
+    STYLESHEET_PATTERN = /^\s*<link .*rel=["']stylesheet["'].*>$/
+
+    # 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 indentation whitespace of a line
+    #
+    INDENT_PATTERN = /^(?<indent>\s*)/
+
+    def process(context, data, directory)
+      tags = find_tags(data)
+      paths = get_paths(tags)
+      indents = get_indents(tags)
+      contents = get_contents(paths, directory)
+      inline_styles(data, tags, indents, contents)
+    end
+
+    private
+
+    def read_file(path)
+      File.read(path)
+    end
+
+    def find_tags(data)
+      data.scan(STYLESHEET_PATTERN).map do |tag|
+        tag
+      end
+    end
+
+    def get_paths(tags)
+      tags.map do |tag|
+        tag[HREF_PATH_PATTERN, :path]
+      end
+    end
+
+    def get_indents(tags)
+      tags.map do |tag|
+        tag[INDENT_PATTERN, :indent] || ""
+      end
+    end
+
+    def get_contents(paths, directory)
+      paths.map do |path|
+        absolute_path = get_absolute_path(path, directory)
+        if sass?(absolute_path)
+          get_sass_content(absolute_path)
+        else
+          read_file(absolute_path)
+        end
+      end
+    end
+
+    def get_absolute_path(path, directory)
+      normal_path = File.absolute_path(path, directory)
+      sassy_path = File.absolute_path(path + ".scss", directory)
+      return sassy_path if File.file?(sassy_path)
+      normal_path
+    end
+
+    def get_sass_content(path)
+      content = read_file(path)
+      Sass::Engine.new(content, syntax: :scss).render
+    end
+
+    def sass?(path)
+      File.extname(path) == ".scss"
+    end
+
+    def inline_styles(data, tags, indents, contents)
+      tags.each_with_index.reduce(data) do |output, (tag, i)|
+        indent, content = indents[i], contents[i]
+        output.gsub(tag, "#{indent}<style>#{content}\n#{indent}</style>")
+      end
+    end
+  end
+end

data/lib/emcee/railtie.rb

@@ -1,39 +1,35 @@
-require "emcee/processors/html_processor"
+require "emcee/processors/directive_processor"
+require "emcee/processors/import_processor"
+require "emcee/processors/script_processor"
+require "emcee/processors/stylesheet_processor"
 require "emcee/compressors/html_compressor"
 
 module Emcee
   class Railtie < Rails::Railtie
-    initializer :add_html_processor do |app|
+    initializer :add_preprocessors do |app|
       app.assets.register_mime_type "text/html", ".html"
-      app.assets.register_preprocessor "text/html", Processors::HtmlProcessor
+      app.assets.register_preprocessor "text/html", DirectiveProcessor
     end
 
-    initializer :add_html_compressor do |app|
-      app.assets.html_compressor = Compressors::HtmlCompressor.new
+    initializer :add_postprocessors do |app|
+      app.assets.register_postprocessor "text/html", :import_processor do |context, data|
+        directory = File.dirname(context.pathname)
+        ImportProcessor.new.process(context, data, directory)
+      end
+      app.assets.register_postprocessor "text/html", :script_processor do |context, data|
+        directory = File.dirname(context.pathname)
+        ScriptProcessor.new.process(context, data, directory)
+      end
+      app.assets.register_postprocessor "text/html", :stylesheet_processor do |context, data|
+        directory = File.dirname(context.pathname)
+        StylesheetProcessor.new.process(context, data, directory)
+      end
     end
-  end
-end
 
-# Monkey patch Sprockets-rails so that loose html files are handled correctly.
-# In the /assets/elements directory, loose html files should be compiled into
-# application.html. They should not be carried over as single files.
-#
-# Not sure that modifying another gem's railtie is a good idea, but it works
-# for now.
-module Sprockets
-  class Railtie
-    # Horrible hack: remove this 'constant' so we can redefine it without ruby
-    # complaining.
-    remove_const(:LOOSE_APP_ASSETS) if defined?(LOOSE_APP_ASSETS)
-
-    # Ugly hack #1: redefine this 'constant' to recognize html files. Is there
-    # a way to extend instead of redefining?
-    LOOSE_APP_ASSETS = lambda do |filename, path|
-      path =~ /app\/assets/ && !%w(.js .css .html).include?(File.extname(filename))
+    initializer :add_compressors do |app|
+      app.assets.register_bundle_processor "text/html", :html_compressor do |context, data|
+        HtmlCompressor.new.compress(data)
+      end
     end
-
-    # Ugly hack #2: same as above (#1). Is there a way to extend this instead
-    # of redefining?
-    config.assets.precompile = [LOOSE_APP_ASSETS, /(?:\/|\\|\A)application\.(css|js|html)$/]
   end
 end

data/lib/emcee/version.rb

@@ -1,3 +1,3 @@
 module Emcee
-  VERSION = "0.1.6"
+  VERSION = "0.2.0"
 end

data/test/compressors_test.rb

@@ -2,7 +2,7 @@ require 'test_helper'
 
 class CompressorsTest < ActiveSupport::TestCase
   setup do
-    @compressor = Emcee::Compressors::HtmlCompressor.new
+    @compressor = Emcee::HtmlCompressor.new
   end
 
   test "compressor should remove html comments" do

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

@@ -6,5 +6,6 @@
  * can be referenced here using a relative path.
  *
  *= require test4
+ *= require compile/test5
  *= require_tree .
 -->

data/test/dummy/app/assets/elements/compile/test5.css.scss

@@ -0,0 +1,5 @@
+$color: red;
+
+p {
+  color: $color;
+}