emcee 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fb57be0dd8aa54269cad7513113aecae19cc050b
+  data.tar.gz: 5b088d3adeadf5be4fddbc4896d212be3a14aa05
+SHA512:
+  metadata.gz: 9b749f99a257f213979bc70167e002e0d818bea8c8760b396a03cd937f2c08f7eda2a54b2a67f7753954331953b218ac75f7e67f53c8a2a1f3e22eef6fa35eb8
+  data.tar.gz: 8400a030e328ecd2ef69a3dfef0cd13a6a983f07f3c2f2866547ee5477c92492838d11eeba4ecfa91245a9eabaa727a3ece76ad0155a10906e48c81a479482b3

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 Andrew Huth
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Emcee'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/emcee.rb

@@ -0,0 +1,7 @@
+require "emcee/version"
+
+require "emcee/helpers/action_view"
+require "emcee/helpers/sprockets_view"
+require "emcee/helpers/sprockets_compressing"
+
+require "emcee/railtie"

data/lib/emcee/compressors/html_compressor.rb

@@ -0,0 +1,49 @@
+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
+
+      # Match multi-line javascript/css comments.
+      #
+      #   /*
+      #   Comments
+      #   */
+      #
+      JS_MULTI_COMMENTS = /\/\*(?:.*?)\*\//m
+
+      # 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
+      end
+    end
+  end
+end

data/lib/emcee/helpers/action_view.rb

@@ -0,0 +1,34 @@
+module ActionView
+  module Helpers
+    module AssetUrlHelper
+      ASSET_EXTENSIONS.merge!({ html: '.html' })
+      ASSET_PUBLIC_DIRECTORIES.merge!({ html: '/elements' })
+
+      # Convenience method for html based on javascript_path.
+      def html_path(source, options = {})
+        path_to_asset(source, { type: :html }.merge!(options))
+      end
+      alias_method :path_to_html, :html_path
+    end
+
+    module AssetTagHelper
+      # Custom view helper used to create an html import. Will search the asset
+      # directories for the sources.
+      #
+      #   html_import_tag("navigation")
+      #
+      def html_import_tag(*sources)
+        options = sources.extract_options!.stringify_keys
+        path_options = options.extract!('protocol').symbolize_keys
+
+        sources.uniq.map { |source|
+          tag_options = {
+            "rel" => "import",
+            "href" => path_to_html(source, path_options)
+          }.merge!(options)
+          tag(:link, tag_options)
+        }.join("\n").html_safe
+      end
+    end
+  end
+end

data/lib/emcee/helpers/sprockets_compressing.rb

@@ -0,0 +1,32 @@
+module Sprockets
+  module Compressing
+    def html_compressor
+      @html_compressor if defined? @html_compressor
+    end
+
+    # Assign a compressor to run on 'text/html' assets.
+    #
+    # The compressor object must respond to 'compress'.
+    def html_compressor=(compressor)
+      unregister_bundle_processor 'text/html', html_compressor if html_compressor
+      @html_compressor = nil
+      return unless compressor
+
+      if compressor.is_a?(Symbol)
+        compressor = compressors['text/html'][compressor] || raise(Error, "unknown compressor: #{compressor}")
+      end
+
+      if compressor.respond_to?(:compress)
+        klass = Class.new(Processor) do
+          @name = "html_compressor"
+          @processor = proc { |context, data| compressor.compress(data) }
+        end
+        @html_compressor = :html_compressor
+      else
+        @html_compressor = klass = compressor
+      end
+
+      register_bundle_processor "text/html", klass
+    end
+  end
+end

data/lib/emcee/helpers/sprockets_view.rb

@@ -0,0 +1,29 @@
+module Sprockets
+  module Rails
+    module Helper
+      # Custom view helper used to create an html import. This same method is
+      # already defined in ActionView. We pull out the sources here, before
+      # calling back to ActionView's.
+      #
+      # Based on Sprocket's javascript_include_tag.
+      def html_import_tag(*sources)
+        options = sources.extract_options!.stringify_keys
+        if options["debug"] != false && request_debug_assets?
+          sources.map { |source|
+            #check_errors_for(source)
+            if asset = lookup_asset_for_path(source, type: :html)
+              asset.to_a.map do |a|
+                super(path_to_html(a.logical_path, debug: true), options)
+              end
+            else
+              super(source, options)
+            end
+          }.flatten.uniq.join("\n").html_safe
+        else
+          sources.push(options)
+          super(*sources)
+        end
+      end
+    end
+  end
+end

data/lib/emcee/processors/html_processor.rb

@@ -0,0 +1,155 @@
+module Emcee
+  module Processors
+    # HtmlProcessor processes html files by doing 4 things:
+    #
+    # 1. Stripping out asset pipeline directives and processing the associated
+    #    files.
+    # 2. Stripping out html imports and processing those files.
+    # 3. Stripping out external stylesheet includes, and inlining those sheets
+    #    where they were called.
+    # 4. Stripping out external script tags, and inlining those scripts where
+    #    they were called.
+    #
+    # It inherits from Sprocket::DirectiveProcessor, which does most of the
+    # work for us.
+    #
+    class HtmlProcessor < Sprockets::DirectiveProcessor
+      # Matches the entire header/directive block. This is everything from the
+      # top of the file, enclosed in html comments.
+      #
+      # ---
+      #
+      # \A                matches the beginning of the string
+      # (?m:\s*)          matches whitespace, including \n
+      # (<!--(?m:.*?)-->) matches html comments and their content
+      #
+      HEADER_PATTERN = /\A((?m:\s*)(<!--(?m:.*?)-->))+/
+
+      # Matches the an asset pipeline directive.
+      #
+      #   *= require_tree .
+      #
+      # ---
+      #
+      # ^         matches the beginning of the line
+      # \W*       matches any non-word character, zero or more times
+      # =         matches =, obviously
+      # \s*       matches any whitespace character, zero or more times
+      # (\w+.*?)  matches a group of characters, starting with a letter or number
+      # $         matches the end of the line
+      #
+      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.
+      #
+      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_imports
+        process_stylesheets
+        process_scripts
+        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/railtie.rb

@@ -0,0 +1,15 @@
+require "emcee/processors/html_processor"
+require "emcee/compressors/html_compressor"
+
+module Emcee
+  class Railtie < Rails::Railtie
+    initializer :add_html_processor do |app|
+      app.assets.register_mime_type "text/html", ".html"
+      app.assets.register_preprocessor "text/html", Processors::HtmlProcessor
+    end
+
+    initializer :add_html_compressor do |app|
+      app.assets.html_compressor = Compressors::HtmlCompressor.new
+    end
+  end
+end

data/lib/emcee/version.rb

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

data/lib/generators/emcee/install/install_generator.rb

@@ -0,0 +1,23 @@
+module Emcee
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+
+      desc "Adds an html import tag into your layout, adds a manifest to assets/elements/application.html, and adds a vendor/assets/elements directory"
+
+      def copy_application_manifest
+        empty_directory "app/assets/elements"
+        copy_file "application.html", "app/assets/elements/application.html"
+      end
+
+      def create_vendor_directory
+        empty_directory "vendor/assets/elements"
+        create_file "vendor/assets/elements/.keep"
+      end
+
+      def add_html_import_to_layout
+        insert_into_file "app/views/layouts/application.html.erb", "<%= html_import_tag \"application\" %>\n\t\t", before: "<%= csrf_meta_tags %>"
+      end
+    end
+  end
+end

data/lib/generators/emcee/install/templates/application.html

@@ -0,0 +1,9 @@
+<!--
+ * This is a manifest file that'll be compiled into application.html, which will include all the files
+ * listed below and their dependencies.
+ *
+ * Any html files within this directory, lib/assets/elements, or vendor/assets/elements
+ * can be referenced here using a relative path.
+ *
+ *= require_tree .
+-->

data/lib/tasks/emcee_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :emcee do
+#   # Task goes here
+# end

data/test/compressors_test.rb

@@ -0,0 +1,41 @@
+require 'test_Helper'
+
+class CompressorsTest < ActiveSupport::TestCase
+  setup do
+    @compressor = Emcee::Compressors::HtmlCompressor.new
+  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)
+  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)
+  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)
+  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)
+  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)
+  end
+end