middleman-sprockets 3.3.4 → 3.3.6

data/fixtures/bower-individual-outputdir-app/config.rb

@@ -0,0 +1,6 @@
+sprockets.append_path File.join(root, 'bower_components')
+
+sprockets.append_path File.join(root, 'vendor/assets/components')
+sprockets.import_asset('underscore/underscore.js') { 'underscore.js' }
+sprockets.import_asset('lightbox2/img/close.png') { |logical_path| Pathname.new('hello_world') + logical_path }
+sprockets.import_asset('lightbox2/js/lightbox.js')

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

@@ -0,0 +1 @@
+//= require underscore/underscore

data/fixtures/bower-individual-outputdir-app/vendor/assets/components/lightbox2/.bower.json

@@ -0,0 +1,34 @@
+{
+  "name": "lightbox",
+  "homepage": "http://lokeshdhakar.com/projects/lightbox2/",
+  "authors": [
+    "Lokesh Dhakar <lokesh.dhakar@gmail.com>"
+  ],
+  "description": "The original Lightbox script. Uses jQuery.",
+  "main": "js/lightbox.js",
+  "keywords": [
+    "lightbox",
+    "overlay",
+    "jquery",
+    "gallery",
+    "images"
+  ],
+  "license": "CC BY 2.5",
+  "ignore": [
+    "**/.*",
+    "Gruntfile.js",
+    "node_modules",
+    "bower_components",
+    "test",
+    "tests"
+  ],
+  "_release": "05ffb8e6d5",
+  "_resolution": {
+    "type": "branch",
+    "branch": "master",
+    "commit": "05ffb8e6d524762ded286b0c33cebab5347cf34a"
+  },
+  "_source": "https://github.com/dg-vrnetze/revealjs-lightbox2.git",
+  "_target": "*",
+  "_originalSource": "https://github.com/dg-vrnetze/revealjs-lightbox2.git"
+}

data/fixtures/bower-individual-outputdir-app/vendor/assets/components/lightbox2/bower.json

@@ -0,0 +1,26 @@
+{
+  "name": "lightbox",
+  "version": "2.7.1",
+  "homepage": "http://lokeshdhakar.com/projects/lightbox2/",
+  "authors": [
+    "Lokesh Dhakar <lokesh.dhakar@gmail.com>"
+  ],
+  "description": "The original Lightbox script. Uses jQuery.",
+  "main": "js/lightbox.js",
+  "keywords": [
+    "lightbox",
+    "overlay",
+    "jquery",
+    "gallery",
+    "images"
+  ],
+  "license": "CC BY 2.5",
+  "ignore": [
+    "**/.*",
+    "Gruntfile.js",
+    "node_modules",
+    "bower_components",
+    "test",
+    "tests"
+  ]
+}

data/fixtures/bower-individual-outputdir-app/vendor/assets/components/lightbox2/js/lightbox.js

@@ -0,0 +1,2 @@
+function test1() {
+}

data/fixtures/bower-individual-outputdir-app/vendor/assets/components/lightbox2/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "lightbox",
+  "version": "2.7.1",
+  "author": "Lokesh Dhakar",
+  "description": "Lightbox is small javascript library used to overlay images on top of the current page. It's a snap to setup and works on all modern browsers.",
+  "keywords": [
+    "lightbox",
+    "lightbox2",
+    "overlay",
+    "image",
+    "gallery"
+  ],
+  "homepage": "http://lokeshdhakar.com/projects/lightbox2/",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/lokesh/lightbox2.git"
+  },
+  "bugs": {
+    "url": "https://github.com/lokesh/lightbox2/issues"
+  },
+  "licenses": [
+    {
+      "type": "Creative Commons Attribution 2.5 License",
+      "url": "http://creativecommons.org/licenses/by/2.5/"
+    }
+  ],
+  "devDependencies": {
+    "grunt": "~0.4.2",
+    "grunt-contrib-compass": "^0.7.2",
+    "grunt-contrib-watch": "^0.5.3",
+    "grunt-contrib-connect": "^0.7.1",
+    "grunt-ftp-deploy": "^0.1.1",
+    "grunt-contrib-uglify": "~0.4.0",
+    "grunt-contrib-jshint": "~0.9.2",
+    "grunt-exec": "~0.4.5"
+  }
+}

data/lib/middleman-sprockets/asset.rb

@@ -0,0 +1,185 @@
+# encoding: utf-8
+module Middleman
+  module Sprockets
+    # Asset 
+    class Asset
+
+      private
+
+      attr_reader :relative_source_path, :base_name, :destination_directory, :source_directory
+
+      public
+
+      attr_reader :source_path
+
+      # Create instance
+      #
+      # @param [Pathname] logical_path
+      #   The logical path to the asset given in config.rb
+      #
+      # @param [proc] output_dir
+      #   An individual output directory for that particular asset
+      def initialize(source_path, options)
+        source_directory = options.fetch(:source_directory, nil)
+
+        fail ArgumentError, 'Missing argument source_directory' unless source_directory
+
+        @source_directory     = source_directory
+
+        @source_path          = Pathname.new(source_path)
+        @relative_source_path = @source_path.relative_path_from(Pathname.new(source_directory))
+        @base_name            = @source_path.basename
+        @import_it            = false
+      end
+
+      # Should the asset imported?
+      #
+      # @return [true, false]
+      #   Is true if it should be imported
+      def import?
+        valid? && (in_trusted_source_directory? || import_it?)
+      end
+
+      # Check on file type
+      #
+      # @return [true, false]
+      #   Is true if has type
+      def has_type?(t)
+        type == t
+      end
+
+      # Path where the asset should be stored
+      #
+      # @return [Pathname]
+      #    Returns `destination_path` if set, otherwise build result: destination_directory + relative_source_path
+      #
+      # @raise [::Sprockets::FileNotFound]
+      #   Raise error if destination_directory was not set previously from outside
+      def destination_path
+        return @destination_path if @destination_path
+
+        fail ::Sprockets::FileNotFound, "Couldn't find an appropriate output directory for '#{destination_directory}' - halting because it was explicitly requested via 'import_asset'" unless destination_directory
+
+        destination_directory + relative_source_path
+      end
+
+      # Sets the destination_path
+      #
+      # @param [String,Pathname] path
+      #   The output path for asset as string or pathname. It will be converted
+      #   to `Pathname`.
+      def destination_path=(path)
+        @destination_path = Pathname.new path
+      end
+
+      # Set destination directory
+      #  
+      #  @param [String] path
+      #    The path to the destination directory
+      #
+      #  @return [Pathname]
+      #    The path as pathname
+      def destination_directory=(path)
+        @destination_directory = Pathname.new path
+      end
+
+      # Check if given path matches source_path
+      #
+      # @param [String] path
+      #   The path to be checked
+      # @return [true, false]
+      #   The result of check
+      def match?(path)
+        source_path == Pathname.new(path)
+      end
+
+      # Tell asset that it is importable
+      def import_it
+        @import_it = true # single =
+      end
+
+      private
+
+      def in_trusted_source_directory?
+        is_in_images_directory? || is_in_fonts_directory?
+      end
+
+      def type
+        if is_in_images_directory? or is_image?
+          :image
+        elsif is_in_scripts_directory? or is_script?
+          :script
+        elsif is_in_stylesheets_directory? or is_stylesheet?
+          :stylesheet
+        elsif is_in_fonts_directory? or is_font?
+          :font
+        else
+          :unknown
+        end
+      end
+
+      def file?
+        source_path.file?
+      end
+
+      def partial?
+        base_name.start_with? '_'
+      end
+
+      # Is it a valid asset
+      # @return [true, false]
+      #   If the asset is valid return true
+      def valid?
+        file? && !partial?
+      end
+
+      def import_it?
+        @import_it == true # double =
+      end
+
+      def has_extname?(*exts)
+        exts.any? { |e| extname == e }
+      end
+
+      def extname
+        source_path.extname
+      end
+
+      def has_real_path?(path)
+        real_path == path
+      end
+
+      def is_in_images_directory?
+        source_directory.end_with?('images', 'img') 
+      end
+
+      def is_in_fonts_directory?
+        source_directory.end_with?('fonts') 
+      end
+
+      def is_in_scripts_directory?
+        source_directory.end_with?('javascripts', 'js')
+      end
+
+      def is_in_stylesheets_directory?
+        source_directory.end_with?('stylesheets', 'css') 
+      end
+
+      def is_image?
+        has_extname?('.gif', '.png', '.jpg', '.jpeg', '.svg', '.svg.gz')
+      end
+
+      def is_stylesheet?
+        has_extname?('.css', '.sass', '.scss', '.styl', '.less')
+      end
+
+      def is_font?
+        has_extname?('.ttf', '.woff', '.eot', '.otf')
+      end
+
+      def is_script?
+        has_extname?('.js', '.coffee')
+      end
+    end
+  end
+end

data/lib/middleman-sprockets/asset_list.rb

@@ -0,0 +1,41 @@
+# encoding: utf-8
+module Middleman
+  module Sprockets
+    class AssetList
+      private
+
+      attr_reader :assets
+
+      public
+
+      def initialize(assets = [])
+        @assets = Array(assets)
+      end
+
+      # Find candidate in list
+      #
+      # @param [#source_path] candidate
+      #   The candidate to search for
+      #
+      # @yield
+      #   This blocks gets the candidate found
+      def lookup(candidate, &block)
+        found_asset = assets.find { |a| a.match? candidate.source_path }
+
+        block.call(candidate, found_asset) if block_given? && found_asset
+
+        found_asset
+      end
+
+      # Append asset to list
+      #
+      # @param [Asset]
+      #   The asset to be appended
+      def add(asset)
+        assets << asset
+      end
+      alias_method :<<, :add
+
+    end
+  end
+end

data/lib/middleman-sprockets/config_only_environment.rb

@@ -21,8 +21,8 @@ module Middleman
       end
 
       def apply_to_environment(environment)
-        @imported_assets.each do |asset|
-          environment.import_asset asset
+        @imported_assets.each do |(path, directory)|
+          environment.import_asset path, &directory
         end
 
         @appended_paths.each do |path|
@@ -34,8 +34,8 @@ module Middleman
         end
       end
 
-      def import_asset(asset_logical_path)
-        @imported_assets << asset_logical_path
+      def import_asset(asset_logical_path, &output_directory)
+        @imported_assets << [asset_logical_path, output_directory]
       end
 
       def append_path(path)

data/lib/middleman-sprockets/environment.rb

@@ -214,8 +214,13 @@ module Middleman
       end
 
       # Tell Middleman to build this asset, referenced as a logical path.
-      def import_asset(asset_logical_path)
-        imported_assets << asset_logical_path
+      def import_asset(asset_logical_path, &determine_output_dir)
+        args = []
+        args << asset_logical_path
+        args << determine_output_dir if block_given?
+
+        imported_assets << ImportedAsset.new(*args)
+
         @app.sitemap.rebuild_resource_list!(:sprockets_import_asset)
       end
     end

data/lib/middleman-sprockets/extension.rb

@@ -1,5 +1,9 @@
 require "sprockets"
 require "sprockets-sass"
+require "middleman-sprockets/pathname_extensions"
+require "middleman-sprockets/asset"
+require "middleman-sprockets/imported_asset"
+require "middleman-sprockets/asset_list"
 require "middleman-sprockets/config_only_environment"
 require "middleman-sprockets/environment"
 require "middleman-sprockets/asset_tag_helpers"
@@ -53,7 +57,7 @@ module Middleman
       @environment = ::Middleman::Sprockets::Environment.new(app, :debug_assets => debug_assets)
       config_environment.apply_to_environment(@environment)
 
-      add_assets_from_gems
+      append_paths_from_gems
 
       # Setup Sprockets Sass options
       if app.config.defines_setting?(:sass)
@@ -70,64 +74,40 @@ module Middleman
 
     # Add sitemap resource for every image in the sprockets load path
     def manipulate_resource_list(resources)
-      imported_assets = []
-      environment.imported_assets.each do |asset_logical_path|
-        assets = []
-        environment.resolve(asset_logical_path) do |asset|
-          assets << asset
-          @app.logger.debug "== Importing Sprockets asset #{asset}"
-        end
-        raise ::Sprockets::FileNotFound, "couldn't find asset '#{asset_logical_path}'" if assets.empty?
-        imported_assets += assets
+      imported_assets = Middleman::Sprockets::AssetList.new
+
+      environment.imported_assets.each do |asset|
+        asset.resolve_path_with environment
+        @app.logger.debug "== Importing Sprockets asset #{asset.real_path}"
+
+        imported_assets << asset
       end
 
       resources_list = []
       environment.paths.each do |load_path|
-        candidate_dir = nil
-        export_all = false
-        if load_path.end_with?('/images')
-          candidate_dir = @app.config[:images_dir]
-          export_all = true
-        elsif load_path.end_with?('/fonts')
-          candidate_dir = @app.config[:fonts_dir]
-          export_all = true
-        elsif load_path.end_with?('/stylesheets')
-          candidate_dir = @app.config[:css_dir]
-        elsif load_path.end_with?('/javascripts')
-          candidate_dir = @app.config[:js_dir]
-        end
-
         environment.each_entry(load_path) do |path|
-          next unless path.file?
-          next if path.basename.to_s.start_with?('_')
-
-          next unless export_all || imported_assets.include?(path)
-
-          # For all imported assets that aren't in an obvious directory, figure out their
-          # type (and thus output directory) via extension.
-          output_dir = if candidate_dir
-                         candidate_dir
-                       else
-                         case File.extname(path)
-                         when '.js', '.coffee'
-                           @app.config[:js_dir]
-                         when '.css', '.sass', '.scss', '.styl', '.less'
-                           @app.config[:css_dir]
-                         when '.gif', '.png', '.jpg', '.jpeg', '.svg', '.svg.gz'
-                           @app.config[:images_dir]
-                         when '.ttf', '.woff', '.eot', '.otf'
-                           @app.config[:fonts_dir]
-                         end
-                       end
-
-          if !output_dir
-            raise ::Sprockets::FileNotFound, "couldn't find an appropriate output directory for '#{path}' - halting because it was explicitly requested via 'import_asset'"
+          asset = Middleman::Sprockets::Asset.new(path, source_directory: load_path)
+
+          imported_assets.lookup(asset) do |candidate, found_asset| 
+            candidate.destination_path = found_asset.output_path if found_asset.output_path
+            candidate.import_it
+          end
+
+          next unless asset.import?
+
+          if asset.has_type? :image
+            asset.destination_directory = @app.config[:images_dir]
+          elsif asset.has_type? :script
+            asset.destination_directory = @app.config[:js_dir]
+          elsif asset.has_type? :font
+            asset.destination_directory = @app.config[:fonts_dir]
+          elsif asset.has_type? :stylesheet
+            asset.destination_directory = @app.config[:css_dir]
           end
 
-          base_path = path.sub("#{load_path}/", '')
-          new_path = @app.sitemap.extensionless_path(File.join(output_dir, base_path))
+          new_path = @app.sitemap.extensionless_path(asset.destination_path.to_s)
 
-          next if @app.sitemap.find_resource_by_destination_path(new_path)
+          next if @app.sitemap.find_resource_by_destination_path(new_path.to_s)
           resources_list << ::Middleman::Sitemap::Resource.new(@app.sitemap, new_path.to_s, path.to_s)
         end
       end
@@ -137,7 +117,7 @@ module Middleman
     private
 
     # Add any directories from gems with Rails-like paths to sprockets load path
-    def add_assets_from_gems
+    def append_paths_from_gems
       try_paths = [
                    %w{ assets },
                    %w{ app },