sprockets-helpers 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 91a536e9415ef30fb8bc7e40401a72d0874b9a7df7bbc377934f1a69459860d7
-  data.tar.gz: 15ef2327c79b8bb7e8e92fd1a31516c2fa94c58d2918bc7459dab0351e11b158
+  metadata.gz: '068064e923da4422a80742ce0e1f6a840799722e22294992e6c6e35e44dff080'
+  data.tar.gz: c0a762b6b31bad8b4384fa7ef5a90ab84b5d56c0e576934f71b5b76f0e4acbd3
 SHA512:
-  metadata.gz: f345f8b35a2251db14f02f0c1fc6e1bafc9eace650761b80a675374810f65a697db7ef710b1a129422df9a0c1fe22b78685c810b44119953543be50b39f186ba
-  data.tar.gz: a8cc249ea9d27ac7160c73d07ad8f39fcad25a66a2f8cb1187d39a2898dde5a7c1a8205cff4050369014d9e9064d076c21fc8d7b47f9ae97ab8431f4ac0d825b
+  metadata.gz: 07eeb179f20c73a09b4ee1c24f0ccd91ff0b18e8584ae46db83013fdc52e8b211f5c15328794e55ac958916c7190875e5431093b459155994cf6b713402ed9e0
+  data.tar.gz: bcb76256c24bfe98c34c60b07ab10ab81933da61fd7baee351c434b4b93eaf4de9c44ad9fb8f58dd96ed388b1bf33e15f7ea2cb65333360362b13e493a93cd06

data/README.md

@@ -1,6 +1,6 @@
 # sprockets-helpers
 
-**Asset path helpers for Sprockets 3.x & <= 2.2 applications**
+**Asset path helpers for Sprockets 4.x & 3.x & <= 2.2 applications**
 
 Sprockets::Helpers adds the asset_path helpers, familiar to Rails developers, to Sprockets 2.x assets and applications.
 
@@ -222,6 +222,10 @@ class App < Sinatra::Base
 end
 ```
 
+## Roda Integration
+
+See: https://github.com/hmdne/roda-sprockets
+
 ## Copyright
 
 Copyright (c) 2011 [Peter Browne](http://petebrowne.com). See LICENSE for details.

data/lib/sprockets/helpers.rb

@@ -4,78 +4,30 @@ require 'sprockets/helpers/base_path'
 require 'sprockets/helpers/asset_path'
 require 'sprockets/helpers/file_path'
 require 'sprockets/helpers/manifest_path'
+require 'sprockets/helpers/settings'
 require 'uri'
+require 'forwardable'
 
 module Sprockets
   module Helpers
     class << self
-      # Indicates whenever we are using Sprockets 3.x.
-      attr_accessor :are_using_sprockets_3
+      extend Forwardable
 
-      # Link to assets from a dedicated server.
-      attr_accessor :asset_host
+      # Indicates whenever we are using Sprockets 3.x or higher.
+      attr_accessor :are_using_sprockets_3_plus
 
-      # When true, the asset paths will return digest paths.
-      attr_accessor :digest
+      # Indicates whenever we are using Sprockets 4.x or higher.
+      attr_accessor :are_using_sprockets_4_plus
 
-      # When true, expand assets.
-      attr_accessor :expand
+      # Settings of Sprockets::Helpers
+      attr_accessor :settings
 
-      # When true, force debug mode
-      # :debug => true equals
-      #   :expand   => true
-      #   :digest   => false
-      #   :manifest => false
-      attr_accessor :debug
-
-      # Set the Sprockets environment to search for assets.
-      # This defaults to the context's #environment method.
-      attr_accessor :environment
-
-      # The manifest file used for lookup
-      attr_accessor :manifest
-
-      # The base URL the Sprocket environment is mapped to.
-      # This defaults to '/assets'.
-      def prefix
-        @prefix ||= '/assets'
-        @prefix.is_a?(Array) ? "/#{@prefix.first}" : @prefix
-      end
-      attr_writer :prefix
-
-      # Customize the protocol when using asset hosts.
-      # If the value is :relative, A relative protocol ('//')
-      # will be used.
-      def protocol
-        @protocol ||= 'http://'
-      end
-      attr_writer :protocol
-
-      # The path to the public directory, where the assets
-      # not managed by Sprockets will be located.
-      # Defaults to './public'
-      def public_path
-        @public_path ||= './public'
-      end
-      attr_writer :public_path
-
-      # The default options for each asset path method. This is where you
-      # can change your default directories for the fallback directory.
-      def default_path_options
-        @default_path_options ||= {
-          :audio_path => { :dir => 'audios' },
-          :font_path => { :dir => 'fonts' },
-          :image_path => { :dir => 'images' },
-          :javascript_path => { :dir => 'javascripts', :ext => 'js' },
-          :stylesheet_path => { :dir => 'stylesheets', :ext => 'css' },
-          :video_path => { :dir => 'videos' }
-        }
-      end
-      attr_writer :default_path_options
+      # Access the settings directly for compatibility purposes.
+      def_delegators :@settings, *Settings.public_instance_methods(false)
 
       # Convience method for configuring Sprockets::Helpers.
       def configure
-        yield self
+        yield settings
       end
 
       # Hack to ensure methods from Sprockets::Helpers override the
@@ -92,8 +44,11 @@ module Sprockets
       end
     end
 
+    @settings = Settings.new
+
     # We are checking here to skip this at runtime
-    @are_using_sprockets_3 = Gem::Version.new(Sprockets::VERSION) >= Gem::Version.new('3.0')
+    @are_using_sprockets_3_plus = Gem::Version.new(Sprockets::VERSION) >= Gem::Version.new('3.0')
+    @are_using_sprockets_4_plus = Gem::Version.new(Sprockets::VERSION) >= Gem::Version.new('4.0')
 
     # Returns the path to an asset either in the Sprockets environment
     # or the public directory. External URIs are untouched.
@@ -128,9 +83,9 @@ module Sprockets
       uri = URI.parse(source)
       return source if uri.absolute?
 
-      options[:prefix] = Sprockets::Helpers.prefix unless options[:prefix]
+      options[:prefix] = sprockets_helpers_settings.prefix unless options[:prefix]
 
-      if Helpers.debug || options[:debug]
+      if sprockets_helpers_settings.debug || options[:debug]
         options[:manifest] = false
         options[:digest] = false
         options[:asset_host] = false
@@ -153,7 +108,9 @@ module Sprockets
 
     def asset_tag(source, options = {}, &block)
       raise ::ArgumentError, 'block missing' unless block
-      options = { :expand => !!Helpers.debug || !!Helpers.expand, :debug => Helpers.debug }.merge(options)
+      options = { :expand => (!!sprockets_helpers_settings.debug && !::Sprockets::Helpers.are_using_sprockets_4_plus) || 
+                             !!sprockets_helpers_settings.expand,
+                  :debug => sprockets_helpers_settings.debug }.merge(options)
 
       path = asset_path(source, options)
       output = if options[:expand] && path.respond_to?(:map)
@@ -167,7 +124,7 @@ module Sprockets
     end
 
     def javascript_tag(source, options = {})
-      options = Helpers.default_path_options[:javascript_path].merge(options)
+      options = sprockets_helpers_settings.default_path_options[:javascript_path].merge(options)
       asset_tag(source, options) do |path|
         %Q(<script src="#{path}" type="text/javascript"></script>)
       end
@@ -176,7 +133,7 @@ module Sprockets
     def stylesheet_tag(source, options = {})
       media = options.delete(:media)
       media_attr = media.nil? ? nil : " media=\"#{media}\""
-      options = Helpers.default_path_options[:stylesheet_path].merge(options)
+      options = sprockets_helpers_settings.default_path_options[:stylesheet_path].merge(options)
       asset_tag(source, options) do |path|
         %Q(<link rel="stylesheet" type="text/css" href="#{path}"#{media_attr}>)
       end
@@ -202,7 +159,7 @@ module Sprockets
     #   audio_path 'http://www.example.com/img/audio.mp3' # => 'http://www.example.com/img/audio.mp3'
     #
     def audio_path(source, options = {})
-      asset_path source, Helpers.default_path_options[:audio_path].merge(options)
+      asset_path source, sprockets_helpers_settings.default_path_options[:audio_path].merge(options)
     end
     alias_method :path_to_audio, :audio_path
 
@@ -226,7 +183,7 @@ module Sprockets
     #   font_path 'http://www.example.com/img/font.ttf' # => 'http://www.example.com/img/font.ttf'
     #
     def font_path(source, options = {})
-      asset_path source, Helpers.default_path_options[:font_path].merge(options)
+      asset_path source, sprockets_helpers_settings.default_path_options[:font_path].merge(options)
     end
     alias_method :path_to_font, :font_path
 
@@ -250,7 +207,7 @@ module Sprockets
     #   image_path 'http://www.example.com/img/edit.png' # => 'http://www.example.com/img/edit.png'
     #
     def image_path(source, options = {})
-      asset_path source, Helpers.default_path_options[:image_path].merge(options)
+      asset_path source, sprockets_helpers_settings.default_path_options[:image_path].merge(options)
     end
     alias_method :path_to_image, :image_path
 
@@ -275,7 +232,7 @@ module Sprockets
     #   javascript_path 'http://www.example.com/js/xmlhr.js' # => 'http://www.example.com/js/xmlhr.js'
     #
     def javascript_path(source, options = {})
-      asset_path source, Helpers.default_path_options[:javascript_path].merge(options)
+      asset_path source, sprockets_helpers_settings.default_path_options[:javascript_path].merge(options)
     end
     alias_method :path_to_javascript, :javascript_path
 
@@ -300,7 +257,7 @@ module Sprockets
     #   stylesheet_path 'http://www.example.com/css/style.css'   # => 'http://www.example.com/css/style.css'
     #
     def stylesheet_path(source, options = {})
-      asset_path source, Helpers.default_path_options[:stylesheet_path].merge(options)
+      asset_path source, sprockets_helpers_settings.default_path_options[:stylesheet_path].merge(options)
     end
     alias_method :path_to_stylesheet, :stylesheet_path
 
@@ -324,7 +281,7 @@ module Sprockets
     #   video_path 'http://www.example.com/img/video.mp4' # => 'http://www.example.com/img/video.mp4'
     #
     def video_path(source, options = {})
-      asset_path source, Helpers.default_path_options[:video_path].merge(options)
+      asset_path source, sprockets_helpers_settings.default_path_options[:video_path].merge(options)
     end
     alias_method :path_to_video, :video_path
 
@@ -332,19 +289,38 @@ module Sprockets
 
     # Returns the Sprockets environment #asset_path uses to search for
     # assets. This can be overridden for more control, if necessary.
-    # Defaults to Sprockets::Helpers.environment or the envrionment
+    # For even more control, you just need to override #sprockets_helper_settings.
+    # Defaults to sprockets_helpers_settings.environment or the environment
     # returned by #environment.
     def assets_environment
-      Helpers.environment || environment
+      sprockets_helpers_settings.environment || environment
+    end
+    
+    # Returns the Sprockets helpers settings. This can be overridden for
+    # more control, for instance if you want to support polyinstantiation
+    # in your application.
+    def sprockets_helpers_settings
+      Helpers.settings
     end
 
     def find_asset_path(uri, source, options = {})
-      if Helpers.manifest && options[:manifest] != false
-        manifest_path = Helpers.manifest.assets[uri.path]
+      options = options.merge(:sprockets_helpers_settings => sprockets_helpers_settings,
+                              :debug => sprockets_helpers_settings.debug)
+
+      if sprockets_helpers_settings.manifest && options[:manifest] != false
+        manifest_path = sprockets_helpers_settings.manifest.assets[uri.path]
         return Helpers::ManifestPath.new(uri, manifest_path, options) if manifest_path
       end
 
-      if Sprockets::Helpers.are_using_sprockets_3
+      if Sprockets::Helpers.are_using_sprockets_4_plus
+        resolved, _ = assets_environment.resolve(uri.path, pipeline: options[:debug] ? :debug : nil)
+
+        if resolved
+          return Helpers::AssetPath.new(uri, assets_environment[uri.path, pipeline: options[:debug] ? :debug : nil], assets_environment, options)
+        else
+          return Helpers::FilePath.new(uri, options)
+        end
+      elsif Sprockets::Helpers.are_using_sprockets_3_plus
         resolved, _ = assets_environment.resolve(uri.path)
 
         if resolved

data/lib/sprockets/helpers/asset_path.rb

@@ -7,10 +7,11 @@ module Sprockets
         @uri = uri
         @asset = asset
         @environment = environment
+        @options = options
         @options = {
           :body => false,
-          :digest => Helpers.digest,
-          :prefix => Helpers.prefix
+          :digest => sprockets_helpers_settings.digest,
+          :prefix => sprockets_helpers_settings.prefix
         }.merge options
 
         @uri.path = @options[:digest] ? asset.digest_path : asset.logical_path

data/lib/sprockets/helpers/base_path.rb

@@ -17,6 +17,10 @@ module Sprockets
         @options = options
       end
 
+      def sprockets_helpers_settings
+        @options[:sprockets_helpers_settings]
+      end
+
       # Returns the full path to the asset, complete with
       # timestamp.
       def to_s
@@ -53,7 +57,7 @@ module Sprockets
       def compute_asset_host # :nodoc:
         return nil if options[:asset_host] == false
 
-        if host = options[:asset_host] || Helpers.asset_host
+        if host = options[:asset_host] || sprockets_helpers_settings.asset_host
           if host.respond_to?(:call)
             host.call(uri.to_s)
           elsif host =~ /%d/
@@ -69,7 +73,7 @@ module Sprockets
       # Pick a scheme for the protocol if we are using
       # an asset host.
       def compute_scheme # :nodoc:
-        protocol = options[:protocol] || Helpers.protocol
+        protocol = options[:protocol] || sprockets_helpers_settings.protocol
 
         if protocol.nil? || protocol == :relative
           nil

data/lib/sprockets/helpers/file_path.rb

@@ -25,7 +25,7 @@ module Sprockets
       # Returns the mtime for the given path (relative to
       # the output path). Returns nil if the file doesn't exist.
       def compute_mtime # :nodoc:
-        public_path = File.join(Helpers.public_path, uri.path)
+        public_path = File.join(sprockets_helpers_settings.public_path, uri.path)
         
         if File.exist?(public_path)
           File.mtime(public_path)

data/lib/sprockets/helpers/manifest_path.rb

@@ -5,9 +5,10 @@ module Sprockets
     class ManifestPath < AssetPath
       def initialize(uri, path, options = {})
         @uri = uri
+        @options = options
         @options = {
           :body => false,
-          :prefix => Helpers.prefix
+          :prefix => sprockets_helpers_settings.prefix
         }.merge options
 
         @uri.path = path.to_s

data/lib/sprockets/helpers/settings.rb

@@ -0,0 +1,66 @@
+module Sprockets
+  module Helpers
+    class Settings
+      # Link to assets from a dedicated server.
+      attr_accessor :asset_host
+
+      # When true, the asset paths will return digest paths.
+      attr_accessor :digest
+
+      # When true, expand assets.
+      attr_accessor :expand
+
+      # When true, force debug mode
+      # :debug => true equals
+      #   :expand   => true (unless using >= Sprockets 4.0)
+      #   :digest   => false
+      #   :manifest => false
+      attr_accessor :debug
+
+      # Set the Sprockets environment to search for assets.
+      # This defaults to the context's #environment method.
+      attr_accessor :environment
+
+      # The manifest file used for lookup
+      attr_accessor :manifest
+
+      # The base URL the Sprocket environment is mapped to.
+      # This defaults to '/assets'.
+      def prefix
+        @prefix ||= '/assets'
+        @prefix.is_a?(Array) ? "/#{@prefix.first}" : @prefix
+      end
+      attr_writer :prefix
+
+      # Customize the protocol when using asset hosts.
+      # If the value is :relative, A relative protocol ('//')
+      # will be used.
+      def protocol
+        @protocol ||= 'http://'
+      end
+      attr_writer :protocol
+
+      # The path to the public directory, where the assets
+      # not managed by Sprockets will be located.
+      # Defaults to './public'
+      def public_path
+        @public_path ||= './public'
+      end
+      attr_writer :public_path
+
+      # The default options for each asset path method. This is where you
+      # can change your default directories for the fallback directory.
+      def default_path_options
+        @default_path_options ||= {
+          :audio_path => { :dir => 'audios' },
+          :font_path => { :dir => 'fonts' },
+          :image_path => { :dir => 'images' },
+          :javascript_path => { :dir => 'javascripts', :ext => 'js' },
+          :stylesheet_path => { :dir => 'stylesheets', :ext => 'css' },
+          :video_path => { :dir => 'videos' }
+        }
+      end
+      attr_writer :default_path_options
+    end
+  end
+end

data/lib/sprockets/helpers/version.rb

@@ -2,6 +2,6 @@
 
 module Sprockets
   module Helpers
-    VERSION = '1.3.0'
+    VERSION = '1.4.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sprockets-helpers
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Pete Browne
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-04-23 00:00:00.000000000 Z
+date: 2020-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sprockets
@@ -129,6 +129,7 @@ files:
 - lib/sprockets/helpers/base_path.rb
 - lib/sprockets/helpers/file_path.rb
 - lib/sprockets/helpers/manifest_path.rb
+- lib/sprockets/helpers/settings.rb
 - lib/sprockets/helpers/version.rb
 - spec/spec_helper.rb
 - spec/sprockets-helpers_spec.rb
@@ -137,7 +138,7 @@ homepage: https://github.com/petebrowne/sprockets-helpers
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -152,8 +153,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: Asset path helpers for Sprockets 2.x & 3.x applications
 test_files: