middleman-sprockets 4.0.0.beta.1 → 4.0.0.rc.1

data/fixtures/bower-individual-outputdir-app/source/javascripts/application.js

@@ -1 +1,4 @@
+//= link "underscore/underscore.js"
+//= link "lightbox2/img/close.png"
+//= link "lightbox2/js/lightbox.js"
 //= require underscore/underscore

data/fixtures/bower-multiple-assets-app/config.rb

@@ -1,7 +1 @@
-set :css_dir, 'stylesheets'
-set :js_dir, 'javascripts'
-set :images_dir, 'images'
-
-sprockets.append_path File.join(root, 'vendor/assets/components')
-sprockets.import_asset 'lightbox2/img/close.png'
-sprockets.import_asset 'lightbox2/js/lightbox.js'
+sprockets.append_path File.join(root, 'vendor/assets/components')

data/fixtures/bower-multiple-assets-app/source/javascripts/core.js

@@ -0,0 +1,2 @@
+//= link "lightbox2/img/close.png"
+//= link "lightbox2/js/lightbox.js"

data/fixtures/jquery-mobile-app/source/javascripts/app.js

@@ -0,0 +1 @@
+//= link "jquery.mobile"

data/fixtures/sprockets-app/config.rb

@@ -1,7 +1,2 @@
 set :js_dir, "library/js"
 set :css_dir, "library/css"
-
-after_configuration do
-  sprockets.import_asset "vendored.css"
-  sprockets.import_asset "coffee.js"
-end

data/fixtures/sprockets-app/source/library/css/bootstrap_include.css.scss

@@ -1 +1 @@
-//= require "bootstrap.scss"
+//= require "bootstrap.scss"

data/fixtures/sprockets-app/source/library/css/plain.css

@@ -1,3 +1,5 @@
+/*= link "vendored.css" */
+
 #helloWorld {
   color: red;
 }

data/fixtures/sprockets-app/source/library/css/sprockets_base2.css.scss

@@ -1 +1 @@
-@import "sprockets_sub";
+@import "sprockets_sub.css";

data/fixtures/sprockets-app/source/library/js/jquery_include.js

@@ -1 +1 @@
-//= require "jquery"
+//= require "jquery"

data/fixtures/sprockets-app/source/library/js/plain.js

@@ -1,3 +1,6 @@
+//= link "vendored_js"
+//= link "coffee"
+
 function hellowWorld() {
   
 }

data/fixtures/sprockets-app2/source/stylesheets/sprockets_base2.css.scss

@@ -1 +1 @@
-@import "sprockets_sub";
+@import "sprockets_sub.css";

data/fixtures/sprockets-imported-asset-path-conflicts-app/config.rb

@@ -1,4 +1,4 @@
 set :css_dir, "assets/css"
 
 sprockets.append_path File.join(root, 'resources/assets')
-sprockets.import_asset "stylesheets/test"
+# sprockets.import_asset "stylesheets/test"

data/fixtures/sprockets-imported-assets-match-multiple-paths-app/config.rb

@@ -1,4 +1,4 @@
 set :css_dir, "assets/css"
 
 sprockets.append_path File.join(root, 'vendor/assets')
-sprockets.import_asset "css/test"
+# sprockets.import_asset "css/test"

data/fixtures/sprockets-multiple-extensions-app/config.rb

@@ -1,4 +1 @@
 sprockets.append_path File.join(root, 'vendor/assets/components')
-sprockets.import_asset('font-awesome/fonts/fontawesome-webfont-bower.svg.gz')
-sprockets.import_asset('jquery/jquery.min.js')
-sprockets.import_asset('jquery/jquery.asdf.asdf.js.min.asdf')

data/fixtures/sprockets-multiple-extensions-app/source/stylesheets/app.css.scss

@@ -0,0 +1,3 @@
+//= link "font-awesome/fonts/fontawesome-webfont-bower.svg.gz"
+//= link "jquery/jquery.min.js"
+//= link "jquery/jquery.asdf.asdf.js.min.asdf"

data/fixtures/sprockets-svg-font-app/config.rb

@@ -1,5 +1 @@
 sprockets.append_path File.join(root, 'vendor/assets/components')
-sprockets.import_asset('blub/images/drawing-bower.svg')
-sprockets.import_asset('font-awesome/fonts/fontawesome-webfont-bower.svg')
-sprockets.import_asset('font-awesome/fonts/fontawesome-webfont-bower.svg.gz')
-sprockets.import_asset('font-awesome/fonts/fontawesome-webfont-bower.ttf.gz')

data/fixtures/sprockets-svg-font-app/source/stylesheets/app.css.scss

@@ -0,0 +1,4 @@
+//= link "blub/images/drawing-bower.svg"
+//= link "font-awesome/fonts/fontawesome-webfont-bower.svg"
+//= link "font-awesome/fonts/fontawesome-webfont-bower.svg.gz"
+//= link "font-awesome/fonts/fontawesome-webfont-bower.ttf.gz"

data/lib/middleman-sprockets.rb

@@ -1,11 +1,6 @@
 require "middleman-core"
 
-params = [:sprockets]
-
-# If we're in v4
-params << { auto_activate: :before_configuration } if Middleman::Extensions.method(:register).arity != -1
-
-Middleman::Extensions.register(*params) do
+Middleman::Extensions.register(:sprockets, auto_activate: :before_configuration) do
   require "middleman-sprockets/extension"
   Middleman::SprocketsExtension
 end

data/lib/middleman-sprockets/extension.rb

@@ -1,148 +1,206 @@
 require "sprockets"
-require "sprockets-sass"
-require "middleman-sprockets/asset"
-require "middleman-sprockets/imported_asset"
-require "middleman-sprockets/config_only_environment"
-require "middleman-sprockets/environment"
-require "middleman-sprockets/asset_tag_helpers"
-
-class Sprockets::Sass::SassTemplate
-  # Get the default, global Sass options. Start with Compass's
-  # options, if it's available.
-  def default_sass_options
-    if defined?(Compass) && defined?(Compass.configuration)
-      merge_sass_options Compass.configuration.to_sass_engine_options.dup, Sprockets::Sass.options
-    else
-      Sprockets::Sass.options.dup
-    end
-  end
-end
-
-IS_V4 = ::Middleman::Extension.respond_to? :expose_to_config
+require "middleman-core/sitemap/resource"
 
-# Sprockets extension
 module Middleman
   class SprocketsExtension < Extension
-    option :debug_assets, false, 'Split up each required asset into its own script/style tag instead of combining them (development only)'
-
     attr_reader :environment
 
-    if IS_V4
-      expose_to_config sprockets: :environment
-      expose_to_template sprockets: :environment
-    end
-
-    # This module gets mixed into both the Middleman instance and the Middleman class,
-    # so that it's available in config.rb
-    module SprocketsAccessor
-      # The sprockets environment
-      # @return [Middleman::MiddlemanSprocketsEnvironment]
-      def sprockets
-        extensions[:sprockets].environment
-      end
-    end
+    expose_to_config sprockets: :environment
 
     def initialize(app, options_hash={}, &block)
-      require "middleman-sprockets/sass_function_hack"
-      require "middleman-sprockets/sass_utils"
-
       super
 
-      # Start out with a stub environment that can only be configured (paths and such)
-      @environment = ::Middleman::Sprockets::ConfigOnlyEnvironment.new
+      @inline_asset_references = Set.new
 
-      # v3
-      app.send :include, SprocketsAccessor if !IS_V4
-    end
+      @environment = ::Sprockets::Environment.new
 
-    helpers do
-      include SprocketsAccessor if !IS_V4
-      include ::Middleman::Sprockets::AssetTagHelpers
+      app.config.define_setting :sprockets_imported_asset_path, "assets", "Where under source should imported assets be placed."
     end
 
     def after_configuration
-      begin
-        require 'ejs'
-        ::Tilt.register ::Sprockets::EjsTemplate, 'ejs'
-      rescue LoadError
-      end
+      @environment.append_path((app.source_dir + app.config[:js_dir]).to_s)
+      @environment.append_path((app.source_dir + app.config[:css_dir]).to_s)
 
-      begin
-        require 'eco'
-        ::Tilt.register ::Sprockets::EcoTemplate, 'eco'
-      rescue LoadError
-      end
-
-      ::Tilt.register ::Sprockets::JstProcessor, 'jst'
-
-      if app.respond_to?(:template_extensions)
-        app.template_extensions :jst => :js, :eco => :js, :ejs => :js
-      end
+      append_paths_from_gems
 
-      if app.config.defines_setting?(:debug_assets) && !options.setting(:debug_assets).value_set?
-        options[:debug_assets] = app.config[:debug_assets]
+      the_app = app
+      the_env = environment
+
+      @environment.context_class.send(:define_method, :app) { the_app }
+      @environment.context_class.send(:define_method, :data) { the_app.data }
+      @environment.context_class.send(:define_method, :env) { the_env }
+
+      @environment.context_class.class_eval do
+        def asset_path(path, options = {})
+          # Handle people calling with the Middleman/Padrino asset path signature
+          if path.is_a?(::Symbol) && !options.is_a?(::Hash)
+            kind = path
+            path = options
+          else
+
+          kind = case options[:type]
+                 when :image then :images
+                 when :font then :fonts
+                 when :javascript then :js
+                 when :stylesheet then :css
+                 else options[:type]
+                 end
+          end
+
+          if app.extensions[:sprockets].check_asset(path)
+            "/#{app.config[:sprockets_imported_asset_path]}/#{path}"
+          else
+            app.asset_path(kind, path)
+          end
+        end
       end
+    end
 
-      config_environment = @environment
-      debug_assets = !app.build? && options[:debug_assets]
-      @environment = ::Middleman::Sprockets::Environment.new(app, :debug_assets => debug_assets)
-      config_environment.apply_to_environment(@environment)
-
-      append_paths_from_gems
-      import_images_and_fonts_from_gems
+    def base_resource?(r)
+      r.class.ancestors.first == ::Middleman::Sitemap::Resource
+    end
 
-      # Setup Sprockets Sass options
-      if app.config.defines_setting?(:sass)
-        app.config[:sass].each { |k, v| ::Sprockets::Sass.options[k] = v }
+    def js?(r)
+      begin
+        r.source_file.start_with?((app.source_dir + app.config[:js_dir]).to_s)
+      rescue
+        require 'pry'
+        binding.pry
       end
+    end
 
-      # Intercept requests to /javascripts and /stylesheets and pass to sprockets
-      our_sprockets = self.environment
+    def css?(r)
+      r.source_file.start_with?((app.source_dir + app.config[:css_dir]).to_s)
+    end
 
-      [app.config[:js_dir], app.config[:css_dir], app.config[:images_dir], app.config[:fonts_dir]].each do |dir|
-        app.map("/#{dir}") { run our_sprockets }
+    def check_asset(path)
+      if asset = environment[path]
+        @inline_asset_references << path
+        true
+      else
+        false
       end
     end
 
-    # Add sitemap resource for every image in the sprockets load path
     def manipulate_resource_list(resources)
-      resources_list = []
-
-      environment.prune_imported_assets!
-      environment.imported_assets.each do |imported_asset|
-        asset = Middleman::Sprockets::Asset.new @app, imported_asset.logical_path, environment
+      sprockets, non_sprockets = resources.partition do |r|
+        base_resource?(r) && (js?(r) || css?(r))
+      end
 
-        if imported_asset.output_path
-          destination = imported_asset.output_path
+      non_sprockets + sprockets.reduce([]) do |sum, r|
+        sprockets_path = if js?(r)
+          r.path.sub(%r{^#{app.config[:js_dir]}\/}, '')
         else
-          destination = @app.sitemap.extensionless_path( asset.destination_path.to_s )
+          r.path.sub(%r{^#{app.config[:css_dir]}\/}, '')
         end
 
-        # next if @app.sitemap.find_resource_by_destination_path destination.to_s
+        sprockets_resource = generate_resource(r.path, r.source_file, sprockets_path)
+        sum << sprockets_resource
 
-        resource = ::Middleman::Sitemap::Resource.new( @app.sitemap, destination.to_s, asset.source_path.to_s )
-        resource.add_metadata options: { sprockets: { logical_path: imported_asset.logical_path }}
+        if sprockets_resource.respond_to?(:sprockets_asset)
+          sprockets_resource.sprockets_asset.links.each do |a|
+            asset = environment[a]
+            path = "#{app.config[:sprockets_imported_asset_path]}/#{asset.logical_path}"
+            sum << generate_resource(path, asset.filename, asset.logical_path)
+          end
+        end
 
-        resources_list << resource
+        sum
+      end + @inline_asset_references.map do |path|
+        asset = environment[path]
+        path = "#{app.config[:sprockets_imported_asset_path]}/#{asset.logical_path}"  
+        generate_resource(path, asset.filename, asset.logical_path)
       end
-
-      resources + resources_list
     end
 
     private
 
-    # Add any directories from gems with Rails-like paths to sprockets load path
-    def append_paths_from_gems
-      root_paths = rubygems_latest_specs.map(&:full_gem_path) << app.root
-      base_paths = %w[assets app app/assets vendor vendor/assets lib lib/assets]
-      asset_dirs = %w[javascripts js stylesheets css images img fonts]
+    def generate_resource(path, source_file, sprockets_path)
+      begin
+        SprocketsResource.new(app.sitemap, path, source_file, sprockets_path, environment)
+      rescue Exception => e
+        raise e if app.build?
+
+        ext = File.extname(path)
+        error_message = if ext == '.css'
+          css_exception_response(e)
+        elsif ext == '.js'
+          javascript_exception_response(e)
+        else
+          e.to_s
+        end
 
-      root_paths.product(base_paths.product(asset_dirs)).each do |root, (base, asset)|
-        path = File.join(root, base, asset)
-        environment.append_path(path) if File.directory?(path)
+        ::Middleman::Sitemap::StringResource.new(app.sitemap, path, error_message)
       end
     end
 
+    # Returns a JavaScript response that re-throws a Ruby exception
+    # in the browser
+    def javascript_exception_response(exception)
+      err  = "#{exception.class.name}: #{exception.message}\n  (in #{exception.backtrace[0]})"
+      "throw Error(#{err.inspect})"
+    end
+
+    # Returns a CSS response that hides all elements on the page and
+    # displays the exception
+    def css_exception_response(exception)
+      message   = "\n#{exception.class.name}: #{exception.message}"
+      backtrace = "\n  #{exception.backtrace.first}"
+
+      <<-CSS
+        html {
+          padding: 18px 36px;
+        }
+
+        head {
+          display: block;
+        }
+
+        body {
+          margin: 0;
+          padding: 0;
+        }
+
+        body > * {
+          display: none !important;
+        }
+
+        head:after, body:before, body:after {
+          display: block !important;
+        }
+
+        head:after {
+          font-family: sans-serif;
+          font-size: large;
+          font-weight: bold;
+          content: "Error compiling CSS asset";
+        }
+
+        body:before, body:after {
+          font-family: monospace;
+          white-space: pre-wrap;
+        }
+
+        body:before {
+          font-weight: bold;
+          content: "#{escape_css_content(message)}";
+        }
+
+        body:after {
+          content: "#{escape_css_content(backtrace)}";
+        }
+      CSS
+    end
+
+    # Escape special characters for use inside a CSS content("...") string
+    def escape_css_content(content)
+      content.
+        gsub('\\', '\\\\005c ').
+        gsub("\n", '\\\\000a ').
+        gsub('"',  '\\\\0022 ').
+        gsub('/',  '\\\\002f ')
+    end
+
     # Backwards compatible means of finding all the latest gemspecs
     # available on the system
     #
@@ -157,17 +215,43 @@ module Middleman
       end
     end
 
-    def import_images_and_fonts_from_gems
-      valid_paths = environment.paths
-          .reject { |p| p.start_with?(app.source_dir.to_s) }
-          .select { |p| p.end_with?('images') || p.end_with?('fonts') }
+    # Add any directories from gems with Rails-like paths to sprockets load path
+    def append_paths_from_gems
+      root_paths = rubygems_latest_specs.map(&:full_gem_path) << app.root
+      base_paths = %w[assets app app/assets vendor vendor/assets lib lib/assets]
+      asset_dirs = %w[javascripts js stylesheets css images img fonts]
+
+      root_paths.product(base_paths.product(asset_dirs)).each do |root, (base, asset)|
+        path = File.join(root, base, asset)
+        environment.append_path(path) if File.directory?(path)
+      end
+    end
+
+    class SprocketsResource < ::Middleman::Sitemap::Resource
+      def initialize(store, path, source_file, sprockets_path, environment)
+        @path = path
+        @sprockets_path = sprockets_path
+        @environment = environment
+        @source = sprockets_asset.source
 
-      environment.files_in_paths(valid_paths).each do |(path, load_path)|
-        if path.file? && !path.basename.to_s.start_with?('_')
-          logical_path = path.sub /^#{load_path}/, ''
-          environment.imported_assets << Middleman::Sprockets::ImportedAsset.new(logical_path)
-        end
+        super(store, path, source_file)
+      end
+
+      def template?
+        true
+      end
+
+      def render(*)
+        @source
+      end
+
+      def sprockets_asset
+        @environment[@sprockets_path]
+      end
+
+      def binary?
+        false
       end
     end
   end
-end
+end