middleman-sprockets 3.0.11 → 3.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: aa7d0080651243d4dcebda2e3b0331031da0e96e
+  data.tar.gz: 7bfc7aa5dff00b290ec486ea20ca24908833eca5
+SHA512:
+  metadata.gz: 85f41fa46b95f6b74aeb3ca3a7249dd95cc35838cbfcdf7453c53eed8b215a8697bbc12e0e813def7c7a540ec9b9f426bea39e05c3a72d55369b49a5268dea86
+  data.tar.gz: d4675f3b632e72aac0858e5514648acfb4ded84c1b16346cbe2168044400f533736a53705fbfc1303ca77514939031b61630465fdab08e96020d3f454e2ef20f

data/.gitignore

@@ -5,3 +5,4 @@ tmp
 .sass-cache
 pkg
 build
+.ruby-version

data/.travis.yml

@@ -8,6 +8,10 @@ rvm:
 
 script: "bundle exec rake test"
 
+gemfile:
+  - Gemfile
+  - Gemfile-3.1
+  
 env: TEST=true
 
 matrix:

data/CHANGELOG.md

@@ -0,0 +1,25 @@
+master
+===
+
+* Hack around infinite recursion between bootstrap-sass and sprockets-sass. middleman/middleman#864
+* Fix for fonts in Sass files having ".font" appended to them. middleman/middleman#866.
+* Enable in-memory caching in Sprockets, so unchanged assets don't get recompiled when other assets change. #25
+* Refuse to serve gem-assets that haven't been added to the Middleman sitemap. #23
+* Allow importing JS/CSS assets from gems by their logical path, using `sprockets.import_asset`. #23
+* Fix a bug where, when `:debug_assets` was enabled, refreshing the page would produce the wrong JavaScript include path. #26
+
+3.0.11
+===
+
+* Fonts are now included in the Sprockets load path.
+* When `:debug_assets` is on, do not add `?body=1` multiple times. #24
+* :js_assets_paths configuration is deprecated in favor of just calling sprockets.append_path. #22
+* Sprockets integration, especially with regard to helper methods, is significantly improved. #22
+* Images and fonts from gems added to the Sprockets load path will now be copied to the build output. #22 
+* Compatibility with newer Sprockets versions.
+
+3.0.10
+===
+
+* No longer expire Sprockets index in development mode. #18
+

data/Gemfile

@@ -1,13 +1,6 @@
 source 'https://rubygems.org'
 
-git "git://github.com/middleman/middleman.git", :branch => "master" do
-  gem "middleman"
-  gem "middleman-core"
-  gem "middleman-more"
-end
-#gem "middleman", :path => '../middleman'
-
-# Specify your gem's dependencies in middleman-blog.gemspec
+# Specify your gem's dependencies in middleman-sprockets.gemspec
 gemspec
 
 # Build and doc tools
@@ -16,15 +9,20 @@ gem "yard",     "~> 0.8.0"
 
 # Test tools
 gem "cucumber" 
-gem "fivemat",  "~> 1.1.0"
+gem "fivemat"
 gem "aruba"
-gem "rspec",    "~> 2.12"
-gem 'gherkin', '<= 2.11.6'
+gem "builder", "~> 3.0.0"
+gem "rspec"
 
 # For actual tests
-gem "jquery-rails", '2.0.1', :require => false
-gem "bootstrap-sass", :require => false
+# Make sure to lock down the versions of the asset gems
+# so they don't cause asset hashes to change.
+gem "jquery-rails", '2.2.1', :require => false
+gem "bootstrap-sass", '2.3.1.0', :require => false
+
+gem 'jquery_mobile_rails', '1.3.0', :require => false
+gem 'sprockets', '~> 2.2.1', :require => false
+
 gem "ejs", "~> 1.1.1"
 gem "eco", "~> 1.0.0"
-gem "erubis", "~> 2.7.0"
-gem 'jquery_mobile_rails', '~>1.2.0', :require => false
+gem "erubis", "~> 2.7.0"

data/Gemfile-3.1

@@ -0,0 +1,31 @@
+source 'https://rubygems.org'
+
+gem "middleman", "3.1.0", :github => "middleman/middleman"
+
+# Specify your gem's dependencies in middleman-sprockets.gemspec
+gemspec
+
+# Build and doc tools
+gem "rake",     "~> 10.0.3"
+gem "yard",     "~> 0.8.0"
+
+# Test tools
+gem "cucumber" 
+gem "fivemat"
+gem "aruba"
+gem "builder", "~> 3.0.0"
+gem "rspec"
+
+# For actual tests
+# Make sure to lock down the versions of the asset gems
+# so they don't cause asset hashes to change.
+gem "jquery-rails", '2.2.1', :require => false
+gem "bootstrap-sass", '2.3.1.0', :require => false
+
+gem 'jquery_mobile_rails', '1.3.0', :require => false
+gem 'sprockets', '~> 2.2.1', :require => false
+gem 'rack', '1.4.5', :require => false
+
+gem "ejs", "~> 1.1.1"
+gem "eco", "~> 1.0.0"
+gem "erubis", "~> 2.7.0"

data/features/asset_hash.feature

@@ -8,7 +8,7 @@ Feature: Assets get a file hash appended to their and references to them are upd
       | images/100px-5fd6fb90.jpg |
       | images/100px-5fd6fb90.gif |
       | javascripts/application-df677242.js |
-      | stylesheets/site-b7f4d02f.css |
+      | stylesheets/site-570b0b7d.css |
       | index.html |
       | subdir/index.html |
       | other/index.html |
@@ -20,50 +20,51 @@ Feature: Assets get a file hash appended to their and references to them are upd
       | stylesheets/site.css |
       
     And the file "javascripts/application-df677242.js" should contain "img.src = '/images/100px-5fd6fb90.jpg'"
-    And the file "stylesheets/site-b7f4d02f.css" should contain 'background-image: url("../images/100px-5fd6fb90.jpg")'
-    And the file "index.html" should contain 'href="stylesheets/site-b7f4d02f.css"'
+    And the file "stylesheets/site-570b0b7d.css" should contain 'background-image: url("../images/100px-5fd6fb90.jpg")'
+    And the file "index.html" should contain 'href="stylesheets/site-570b0b7d.css"'
     And the file "index.html" should contain 'src="javascripts/application-df677242.js"'
     And the file "index.html" should contain 'src="images/100px-5fd6fb90.jpg"'
-    And the file "subdir/index.html" should contain 'href="../stylesheets/site-b7f4d02f.css"'
+    And the file "subdir/index.html" should contain 'href="../stylesheets/site-570b0b7d.css"'
     And the file "subdir/index.html" should contain 'src="../javascripts/application-df677242.js"'
     And the file "subdir/index.html" should contain 'src="../images/100px-5fd6fb90.jpg"'
-    And the file "other/index.html" should contain 'href="../stylesheets/site-b7f4d02f.css"'
+    And the file "other/index.html" should contain 'href="../stylesheets/site-570b0b7d.css"'
     And the file "other/index.html" should contain 'src="../javascripts/application-df677242.js"'
     And the file "other/index.html" should contain 'src="../images/100px-5fd6fb90.jpg"'
     
   Scenario: Hashed assets work in preview server
     Given the Server is running at "asset-hash-app"
     When I go to "/"
-    Then I should see 'href="stylesheets/site-b7f4d02f.css"'
+    Then I should see 'href="stylesheets/site-570b0b7d.css"'
+    Then I should see 'href="stylesheets/jquery-mobile-044da59f.css"'
     And I should see 'src="javascripts/application-df677242.js"'
     And I should see 'src="images/100px-5fd6fb90.jpg"'
     When I go to "/subdir/"
-    Then I should see 'href="../stylesheets/site-b7f4d02f.css"'
+    Then I should see 'href="../stylesheets/site-570b0b7d.css"'
     And I should see 'src="../javascripts/application-df677242.js"'
     And I should see 'src="../images/100px-5fd6fb90.jpg"'
     When I go to "/other/"
-    Then I should see 'href="../stylesheets/site-b7f4d02f.css"'
+    Then I should see 'href="../stylesheets/site-570b0b7d.css"'
     And I should see 'src="../javascripts/application-df677242.js"'
     And I should see 'src="../images/100px-5fd6fb90.jpg"'
     When I go to "/javascripts/application-df677242.js"
     Then I should see "img.src = '/images/100px-5fd6fb90.jpg'"
-    When I go to "/stylesheets/site-b7f4d02f.css"
+    When I go to "/stylesheets/site-570b0b7d.css"
     Then I should see 'background-image: url("../images/100px-5fd6fb90.jpg")'
-    When I go to "/stylesheets/jquery-mobile-67e48856.css"
-    Then I should see 'background-image: url("../images/jquery-mobile/icons-18-white-4a0ff57b.png")'
+    When I go to "/stylesheets/jquery-mobile-044da59f.css"
+    Then I should see 'background-image: url("../images/jquery-mobile/icons-18-white-1681b2cc.png")'
 
   Scenario: Enabling an asset host still produces hashed files and references  
     Given the Server is running at "asset-hash-host-app"
     When I go to "/"
-    Then I should see 'href="http://middlemanapp.com/stylesheets/site-1fdf4fb5.css"'
+    Then I should see 'href="http://middlemanapp.com/stylesheets/site-72c69c91.css"'
     And I should see 'src="http://middlemanapp.com/images/100px-5fd6fb90.jpg"'
     When I go to "/subdir/"
-    Then I should see 'href="http://middlemanapp.com/stylesheets/site-1fdf4fb5.css"'
+    Then I should see 'href="http://middlemanapp.com/stylesheets/site-72c69c91.css"'
     And I should see 'src="http://middlemanapp.com/images/100px-5fd6fb90.jpg"'
     When I go to "/other/"
-    Then I should see 'href="http://middlemanapp.com/stylesheets/site-1fdf4fb5.css"'
+    Then I should see 'href="http://middlemanapp.com/stylesheets/site-72c69c91.css"'
     And I should see 'src="http://middlemanapp.com/images/100px-5fd6fb90.jpg"'
-    When I go to "/stylesheets/site-1fdf4fb5.css"
+    When I go to "/stylesheets/site-72c69c91.css"
     Then I should see 'background-image: url("http://middlemanapp.com/images/100px-5fd6fb90.jpg")'
 
   Scenario: The asset hash should change when a SASS partial changes

data/features/sprockets_gems.feature

@@ -2,7 +2,7 @@ Feature: Sprockets Gems
   Scenario: Sprockets can pull jQuery from gem
     Given the Server is running at "sprockets-app"
     When I go to "/library/js/jquery_include.js"
-    Then I should see "var jQuery ="
+    Then I should see "window.jQuery ="
   
   Scenario: Sprockets can pull CSS from gem
     Given the Server is running at "sprockets-app"
@@ -41,3 +41,20 @@ Feature: Sprockets Gems
     Given the Server is running at "jquery-mobile-app"
     When I go to "/stylesheets/base.css"
     Then I should see 'url("../images/jquery-mobile/icons-36-white.png")'
+
+  Scenario: JS/CSS from gems aren't aumatically in the site
+    Given the Server is running at "jquery-mobile-app"
+    When I go to "/javascripts/jquery.mobile.js"
+    Then I should get a response with status "404"
+
+  Scenario: JS/CSS from gems can be declared to be accessible
+    Given a fixture app "jquery-mobile-app"
+    Given a file named "config.rb" with:
+      """
+      after_configuration do
+        sprockets.import_asset 'jquery.mobile'
+      end
+      """
+    And the Server is running at "jquery-mobile-app"
+    When I go to "/javascripts/jquery.mobile.js"
+    Then I should get a response with status "200"

data/fixtures/asset-hash-app/source/layout.erb

@@ -4,6 +4,7 @@
     <meta charset="utf-8">
 
     <%= stylesheet_link_tag "site" %>
+    <%= stylesheet_link_tag "jquery-mobile" %>
     <%= javascript_include_tag "application" %>
     <%= yield_content :head %>
   </head>

data/lib/middleman-sprockets/extension.rb

@@ -1,5 +1,6 @@
 require "sprockets"
 require "sprockets-sass"
+require "middleman-sprockets/sass_function_hack"
 
 # Sprockets extension
 module Middleman::Sprockets
@@ -12,12 +13,12 @@ module Middleman::Sprockets
       # Add class methods to context
       app.send :include, InstanceMethods
 
-      app.after_configuration do
-        helpers JavascriptTagHelper
+      app.helpers JavascriptTagHelper
 
-        ::Tilt.register ::Sprockets::EjsTemplate, 'ejs'
-        ::Tilt.register ::Sprockets::EcoTemplate, 'eco'
+      ::Tilt.register ::Sprockets::EjsTemplate, 'ejs'
+      ::Tilt.register ::Sprockets::EcoTemplate, 'eco'
 
+      app.after_configuration do
         # Add any gems with (vendor|app|.)/assets/javascripts to paths
         # also add similar directories from project root (like in rails)
         try_paths = [
@@ -72,9 +73,43 @@ module Middleman::Sprockets
   class MiddlemanSprocketsEnvironment < ::Sprockets::Environment
     # Setup
     def initialize(app)
+      @imported_assets = []
       @app = app
+
       super app.source_dir
 
+      # By default, sprockets has no cache! Give it an in-memory one using a Hash
+      @cache = {}
+
+      enhance_context_class!
+
+      # Remove compressors, we handle these with middleware
+      unregister_bundle_processor 'application/javascript', :js_compressor
+      unregister_bundle_processor 'text/css', :css_compressor
+
+      # configure search paths
+      append_path app.js_dir
+      append_path app.css_dir
+      append_path app.images_dir
+      append_path app.fonts_dir
+
+      # add custom assets paths to the scope
+      app.js_assets_paths.each do |p|
+        warn ":js_assets_paths is deprecated. Call sprockets.append_path instead."
+        append_path p
+      end if app.respond_to?(:js_assets_paths)
+
+      # Stylus support
+      if defined?(::Stylus)
+        require 'stylus/sprockets'
+        ::Stylus.setup(self, app.styl)
+      end
+    end
+
+    # Add our own customizations to the Sprockets context class
+    def enhance_context_class!
+      app = @app
+
       # Make the app context available to Sprockets
       context_class.send(:define_method, :app) { app }
 
@@ -106,7 +141,9 @@ module Middleman::Sprockets
 
         # Expand logical font asset path.
         def font_path(path, options={})
-          asset_path(path, :type => :font)
+          # Knock .fonts off the end, because Middleman < 3.1 doesn't handle fonts
+          # in asset_path
+          asset_path(path, :type => :font).sub(/\.fonts$/, '')
         end
 
         # Expand logical javascript asset path.
@@ -133,29 +170,8 @@ module Middleman::Sprockets
           super || app.respond_to?(method, include_private)
         end
       end
-
-      # Remove compressors, we handle these with middleware
-      unregister_bundle_processor 'application/javascript', :js_compressor
-      unregister_bundle_processor 'text/css', :css_compressor
-
-      # configure search paths
-      append_path app.js_dir
-      append_path app.css_dir
-      append_path app.images_dir
-      append_path app.fonts_dir
-
-      # add custom assets paths to the scope
-      app.js_assets_paths.each do |p|
-        warn ":js_assets_paths is deprecated. Call sprockets.append_path instead."
-        append_path p
-      end if app.respond_to?(:js_assets_paths)
-
-      # Stylus support
-      if defined?(::Stylus)
-        require 'stylus/sprockets'
-        ::Stylus.setup(self, app.styl)
-      end
     end
+    private :enhance_context_class!
 
     # Override Sprockets' default digest function to *not*
     # change depending on the exact Sprockets version. It still takes
@@ -195,10 +211,34 @@ module Middleman::Sprockets
 
     def call(env)
       # Set the app current path based on the full URL so that helpers work
-      full_path = File.join(env['SCRIPT_NAME'], env['PATH_INFO'])
-      @app.current_path = ::Middleman::Util.normalize_path(full_path)
+      request_path = URI.decode(File.join(env['SCRIPT_NAME'], env['PATH_INFO']))
+      if request_path.respond_to? :force_encoding
+        request_path.force_encoding('UTF-8')
+      end
+      resource = @app.sitemap.find_resource_by_destination_path(request_path)
+
+      if !resource
+        response = ::Rack::Response.new
+        response.status = 404
+        response.write """<html><body><h1>File Not Found</h1><p>#{request_path}</p>
+          <p>If this is an an asset from a gem, add <tt>sprockets.import_asset '#{File.basename(request_path)}'</tt>
+          to your <tt>config.rb</tt>.</body>"""
+        return response.finish
+      end
+
+      @app.current_path = request_path
+
       super
     end
+
+    # A list of Sprockets logical paths for assets that should be brought into the
+    # Middleman application and built.
+    attr_accessor :imported_assets
+
+    # Tell Middleman to build this asset, referenced as a logical path.
+    def import_asset(asset_logical_path)
+      imported_assets << asset_logical_path
+    end
   end
 
   module JavascriptTagHelper
@@ -216,7 +256,7 @@ module Middleman::Sprockets
           dependencies_paths = sprockets[source].to_a.map do |dependency|
             # if sprockets sees "?body=1" it only gives back the body
             # of the script without the dependencies included
-            dependency.logical_path << "?body=1" unless dependency.logical_path.end_with?("?body=1")
+            dependency.logical_path + "?body=1"
           end
 
           super(dependencies_paths, options)
@@ -234,19 +274,43 @@ module Middleman::Sprockets
 
     # Add sitemap resource for every image in the sprockets load path
     def manipulate_resource_list(resources)
+      sprockets = @app.sprockets
+
+      imported_assets = []
+      sprockets.imported_assets.each do |asset_logical_path|
+        assets = []
+        sprockets.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.concat(assets)
+      end
+
       resources_list = []
-       @app.sprockets.paths.each do |load_path|
+      sprockets.paths.each do |load_path|
         output_dir = nil
+        export_all = false
         if load_path.end_with?('/images')
           output_dir = @app.images_dir
+          export_all = true
         elsif load_path.end_with?('/fonts')
           output_dir = @app.fonts_dir
+          export_all = true
+        elsif load_path.end_with?('/stylesheets')
+          output_dir = @app.css_dir
+        elsif load_path.end_with?('/javascripts')
+          output_dir = @app.js_dir
         end
 
         if output_dir
-          @app.sprockets.each_entry(load_path) do |path|
+          sprockets.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)
+
             base_path = path.sub("#{load_path}/", '')
+
             new_path = File.join(output_dir, base_path)
             resources_list << ::Middleman::Sitemap::Resource.new(@app.sitemap, new_path.to_s, path.to_s)
           end

data/lib/middleman-sprockets/sass_function_hack.rb

@@ -0,0 +1,20 @@
+# sprockets-sass implements an image_url function that calls over to image_path. But bootstrap-sass
+# defines an image_path function that calls image_url! To avoid the probem in bootstrap-sass (and anyone
+# who tries something similar, this redefines sprockets-sass' function to not refer to image_path.
+#
+# See https://github.com/middleman/middleman/issues/864 for more info.
+#x
+module Sass::Script::Functions
+  def image_url(source, options = {}, cache_buster = nil)
+    # Work with the Compass #image_url API
+    if options.respond_to? :value
+      case options.value
+      when true
+        return ::Sass::Script::String.new sprockets_context.image_path(source.value).to_s, :string
+      else
+        options = {}
+      end
+    end
+    ::Sass::Script::String.new "url(\"#{sprockets_context.image_path(source.value, map_options(options)).to_s}\")"
+  end
+end

data/lib/middleman-sprockets/version.rb

@@ -1,5 +1,5 @@
 module Middleman
   module Sprockets
-    VERSION = "3.0.11"
+    VERSION = "3.1.0"
   end
 end

data/middleman-sprockets.gemspec

@@ -20,5 +20,5 @@ Gem::Specification.new do |s|
   
   s.add_dependency("middleman-more", [">= 3.0.11"])
   s.add_dependency("sprockets", ["~> 2.1"])
-  s.add_dependency("sprockets-sass", ["~> 0.9.1"])
+  s.add_dependency("sprockets-sass", ["~> 1.0.0"])
 end

metadata

@@ -1,36 +1,32 @@
 --- !ruby/object:Gem::Specification
 name: middleman-sprockets
 version: !ruby/object:Gem::Version
-  version: 3.0.11
-  prerelease: 
+  version: 3.1.0
 platform: ruby
 authors:
 - Thomas Reynolds
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-14 00:00:00.000000000 Z
+date: 2013-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: middleman-more
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 3.0.11
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 3.0.11
 - !ruby/object:Gem::Dependency
   name: sprockets
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -46,19 +41,17 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: sprockets-sass
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: 1.0.0
 description: Sprockets support for Middleman
 email:
 - me@tdreyno.com
@@ -68,7 +61,9 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .travis.yml
+- CHANGELOG.md
 - Gemfile
+- Gemfile-3.1
 - LICENSE
 - README.md
 - Rakefile
@@ -161,38 +156,32 @@ files:
 - fixtures/sprockets-images-app/vendor/assets/images/cat-2.jpg
 - lib/middleman-sprockets.rb
 - lib/middleman-sprockets/extension.rb
+- lib/middleman-sprockets/sass_function_hack.rb
 - lib/middleman-sprockets/version.rb
 - lib/middleman_extension.rb
 - middleman-sprockets.gemspec
 homepage: https://github.com/middleman/middleman-sprockets
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -471944256885700963
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -471944256885700963
 requirements: []
 rubyforge_project: middleman-sprockets
-rubygems_version: 1.8.24
+rubygems_version: 2.0.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Sprockets support for Middleman
 test_files:
 - features/asset_hash.feature