dassets 0.14.1 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
---- 
-SHA1: 
-  metadata.gz: 89a17e9e4689219cffdda2b968a4c481f9813591
-  data.tar.gz: 2a74fdbbc78e44ec82d23f1aabbc284d70f03397
-SHA512: 
-  metadata.gz: d19a0f7587afb5d0d19a9878a0667973474ef55a3d684d363a66cb750394249a97cf957cac9e99df6662fd72d32be6e9eb46794c7d121c7d7b45558f85dd0dd7
-  data.tar.gz: bf6bfb399f0ab12d21f50d58db6b6e39b22da71768660236ae21f287ebf3470477598dc95a397a39395c960980fd428bf6cf1968145975a65ab7db67da28041b
+---
+SHA256:
+  metadata.gz: 51a6c8bbf4e5b1a6cebb52c6da1ce5a6eae5714cf8cd410d2aa06a79737fc9b5
+  data.tar.gz: f97b79e8148698de5d6a1cd97419e34b416a1a03c4d9773e742614403fd9180d
+SHA512:
+  metadata.gz: a8310a78cfbbcb27795f0319303f1471625edb03e10a747e52c195a85f0b791adc41ed52a45aa4756525d67160bcbc50d788a45076f52f60513bd51ac5b63932
+  data.tar.gz: f01e81b5758d052dcf8b5e602eb1798e206ff1cb5c9ab8d80dfaf90c83841ce278e83e8dd3577f976c37fd05a073b66ff7cd57e27d3c11bfff092a1fdb93a967

data/.ruby-version

@@ -0,0 +1 @@
+2.5.5

data/Gemfile

@@ -1,5 +1,7 @@
 source "https://rubygems.org"
 
+ruby "~> 2.5"
+
 gemspec
 
-gem 'pry', "~> 0.9.0"
+gem "pry", "~> 0.12.2"

data/README.md

@@ -10,27 +10,25 @@ You have some css, js, images, etc files.  You want to update, deploy, and serve
 
 ```ruby
 # in config/dassets.rb
-require 'dassets'
+require "dassets"
 
 Dassets.configure do |c|
-
   # tell Dassets where to look for source files
-  c.source '/path/to/app/assets'
+  c.source "/path/to/app/assets"
 
   # (optional) tell Dassets where to store digested asset files
   # if none given, Dassets will not write any digested output
   # use this to "cache" digested assets to the public dir so that
   # your web server can serve them directly
-  c.file_store '/path/to/public' # default: `FileStore::NullStore.new`
-
+  c.file_store "/path/to/public" # default: `Dassets::NullFileStore.new`
 end
 ```
 
 ### Link To
 
-```rb
-Dassets['css/site.css'].url       # => "/css/site-123abc.css"
-Dassets['img/logos/main.jpg'].url # => "/img/logos/main-a1b2c3.jpg"
+```ruby
+Dassets["css/site.css"].url       # => "/css/site-123abc.css"
+Dassets["img/logos/main.jpg"].url # => "/img/logos/main-a1b2c3.jpg"
 ```
 
 ### Serve
@@ -39,7 +37,7 @@ Use the Dassets middleware to serve your digested asset files:
 
 ```ruby
 # `app` is a rack application
-require 'dassets/server'
+require "dassets/server"
 app.use Dassets::Server
 ```
 
@@ -75,16 +73,16 @@ Dassets.configure do |c|
   c.source /path/to/assets do |s|
     s.filter{ |paths| paths.reject{ |p| File.basename(p) =~ /^_/ } }
 
-    s.engine 'erb',  Dassets::Erb::Engine
-    s.engine 'scss', Dassets::Sass::Engine, {
-      :syntax => 'scss'
+    s.engine "erb",  Dassets::Erb::Engine
+    s.engine "scss", Dassets::Sass::Engine, {
+      "syntax" => "scss",
       # any other engine-specific options here
     }
   end
 end
 ```
 
-This configuration says that Dassets, for assets in `/path/to/assets`, should 1) ignore any files beginning in `_` 2) process any files ending in `.erb` with the Erb engine and 3) process any files ending in `.scss` with the Sass engine (using 'scss' syntax).
+This configuration says that Dassets, for assets in `/path/to/assets`, should 1) ignore any files beginning in `_` 2) process any files ending in `.erb` with the Erb engine and 3) process any files ending in `.scss` with the Sass engine (using scss syntax).
 
 The goal here is to allow you to control how certain asset files are handled based on their location root.  This is handy for 3rd-paty gems that provide asset source files (such as [Romo](https://github.com/redding/romo)).  See https://github.com/redding/romo/blob/master/lib/romo/dassets.rb for an example of how Romo integrates with Dassets.
 
@@ -95,9 +93,9 @@ Combinations are a way to alias many asset files as a single asset.  Dassets res
 ```ruby
 Dassets.configure do |c|
   c.combination "css/special.css", [
-    'css/romo/normalize.css',
-    'css/romo/base.css',
-    'css/romo/component1.css'
+    "css/romo/normalize.css",
+    "css/romo/base.css",
+    "css/romo/component1.css",
   ]
 end
 ```
@@ -110,7 +108,7 @@ Combinations are treated just like regular asset files (think of them as a kind
 
 Add this line to your application's Gemfile:
 
-    gem 'dassets'
+    gem "dassets"
 
 And then execute:
 

data/dassets.gemspec

@@ -1,5 +1,5 @@
 # -*- encoding: utf-8 -*-
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "dassets/version"
 
@@ -11,17 +11,18 @@ Gem::Specification.new do |gem|
   gem.summary     = %q{Digested asset files}
   gem.description = %q{Digest and serve HTML asset files}
   gem.homepage    = "http://github.com/redding/dassets"
-  gem.license     = 'MIT'
+  gem.license     = "MIT"
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_development_dependency("assert",           ["~> 2.16.3"])
-  gem.add_development_dependency('assert-rack-test', ["~> 1.0.4"])
-  gem.add_development_dependency("sinatra",          ["~> 1.4"])
+  gem.required_ruby_version = "~> 2.5"
 
-  gem.add_dependency("rack", ["~> 1.0"])
+  gem.add_development_dependency("assert",           ["~> 2.19.0"])
+  gem.add_development_dependency("assert-rack-test", ["~> 1.1.0"])
+  gem.add_development_dependency("sinatra",          ["~> 2.1"])
 
+  gem.add_dependency("rack", ["~> 2.1"])
 end

data/lib/dassets.rb

@@ -1,30 +1,75 @@
-require 'dassets/version'
-require 'dassets/asset_file'
-require 'dassets/config'
-require 'dassets/source_file'
+# frozen_string_literal: true
+
+require "dassets/version"
+require "dassets/asset_file"
+require "dassets/config"
+require "dassets/source_file"
 
 module Dassets
+  AssetFileError = Class.new(RuntimeError)
+
+  def self.config
+    @config ||= Config.new
+  end
 
-  def self.config; @config ||= Config.new; end
   def self.configure(&block)
     block.call(self.config)
   end
 
   def self.init
-    @asset_files  ||= {}
-    @source_files   = SourceFiles.new(self.config.sources)
+    @asset_files ||= {}
+    @source_files = SourceFiles.new(self.config.sources)
   end
 
-  def self.[](digest_path)
+  def self.reset
+    @asset_files = {}
+    self.config.reset
+  end
+
+  def self.asset_file(digest_path)
     @asset_files[digest_path] ||= AssetFile.new(digest_path)
   end
 
+  def self.[](digest_path)
+    self.asset_file(digest_path).tap do |af|
+      if af.fingerprint.nil?
+        msg =
+          +"error digesting `#{digest_path}`.\n\nMake sure Dassets has " \
+          "either a combination or source file for this digest path. If " \
+          "this path is for a combination, make sure Dassets has either " \
+          "a combination or source file for each digest path of the " \
+          "combination.\n\n"
+
+        msg << "\nCombination digest paths:"
+        msg << (Dassets.combinations.keys.empty? ? " (none)\n\n" : "\n\n")
+        Dassets.combinations.keys.sort.each do |key|
+          bullet = "#{key} => "
+          values = Dassets.combinations[key].sort
+          msg << (
+            ["#{bullet}#{values.first}"] +
+            (values[1..-1] || []).map{ |v| "#{" "*bullet.size}#{v}" }
+          ).join("\n")
+          msg << "\n\n"
+        end
+
+        msg << "\nSource file digest paths:"
+        msg << (Dassets.source_files.keys.empty? ? " (none)\n\n" : "\n\n")
+        msg << Dassets.source_files.keys.sort.join("\n")
+
+        raise AssetFileError, msg
+      end
+    end
+  end
+
   def self.source_files
     @source_files
   end
 
-  module SourceFiles
+  def self.combinations
+    self.config.combinations
+  end
 
+  module SourceFiles
     def self.new(sources)
       # use a hash to store the source files so in the case two source files
       # have the same digest path, the last one *should* be correct since it
@@ -37,9 +82,7 @@ module Dassets
         hash
       end
     end
-
   end
-
 end
 
 Dassets.init

data/lib/dassets/asset_file.rb

@@ -1,10 +1,11 @@
-require 'rack/utils'
-require 'rack/mime'
-require 'dassets/source_proxy'
+# frozen_string_literal: true
+
+require "dassets/source_proxy"
+require "rack/utils"
+require "rack/mime"
 
 module Dassets; end
 class Dassets::AssetFile
-
   attr_reader :digest_path, :dirname, :extname, :basename, :source_proxy
 
   def initialize(digest_path)
@@ -12,10 +13,12 @@ class Dassets::AssetFile
     @dirname      = File.dirname(@digest_path)
     @extname      = File.extname(@digest_path)
     @basename     = File.basename(@digest_path, @extname)
-    @source_proxy = Dassets::SourceProxy.new(@digest_path, {
-      :content_cache     => Dassets.config.content_cache,
-      :fingerprint_cache => Dassets.config.fingerprint_cache
-    })
+    @source_proxy =
+      Dassets::SourceProxy.new(
+        @digest_path,
+        content_cache:     Dassets.config.content_cache,
+        fingerprint_cache: Dassets.config.fingerprint_cache,
+      )
   end
 
   def digest!
@@ -25,10 +28,10 @@ class Dassets::AssetFile
 
   def url
     path_basename = "#{@basename}-#{self.fingerprint}#{@extname}"
-    path = File.join(@dirname, path_basename).sub(/^\.\//, '').sub(/^\//, '')
+    path =
+      File.join(@dirname, path_basename).sub(/^\.\//, "").sub(/^\//, "")
     "#{dassets_base_url}/#{path}"
   end
-
   alias_method :href, :url
 
   def fingerprint
@@ -48,7 +51,7 @@ class Dassets::AssetFile
 
   def size
     return nil if !self.exists?
-    Rack::Utils.bytesize(self.content)
+    self.content.bytesize
   end
 
   def mime_type
@@ -75,5 +78,4 @@ class Dassets::AssetFile
   def dassets_base_url
     Dassets.config.base_url.to_s
   end
-
 end

data/lib/dassets/cache.rb

@@ -1,45 +1,39 @@
-module Dassets; end
-module Dassets::Cache
-
-  class MemCache
-    require 'thread'
-
-    # this is a thread-safe in-memory cache
-
-    def initialize
-      @hash = {}
-      @write_mutex = ::Mutex.new
-    end
+# frozen_string_literal: true
 
-    def keys
-      @hash.keys
-    end
+require "thread"
 
-    def [](key)
-      @hash[key]
-    end
-
-    def []=(key, value)
-      @write_mutex.synchronize{ @hash[key] = value }
-    end
+module Dassets; end
 
+# This is a thread-safe in-memory cache.
+class Dassets::MemCache
+  def initialize
+    @hash = {}
+    @write_mutex = ::Mutex.new
   end
 
-  class NoCache
-
-    # This is a no-op cache object.  This is the default cache in use and "turns
-    # off caching.
+  def keys
+    @hash.keys
+  end
 
-    def keys
-      []
-    end
+  def [](key)
+    @hash[key]
+  end
 
-    def [](key)
-    end
+  def []=(key, value)
+    @write_mutex.synchronize{ @hash[key] = value }
+  end
+end
 
-    def []=(key, value)
-    end
+# This is a no-op cache object. This is the default cache in use and "turns
+# off caching.
+class Dassets::NoCache
+  def keys
+    []
+  end
 
+  def [](key)
   end
 
+  def []=(key, value)
+  end
 end

data/lib/dassets/config.rb

@@ -1,63 +1,71 @@
-require 'pathname'
-require 'dassets/cache'
-require 'dassets/file_store'
-require 'dassets/source'
+# frozen_string_literal: true
 
-module Dassets
+require "pathname"
+require "dassets/cache"
+require "dassets/file_store"
+require "dassets/source"
 
-  class Config
+module Dassets; end
+class Dassets::Config
+  attr_reader :sources, :combinations
 
-    attr_reader :sources, :combinations
+  def initialize
+    super
+    self.reset
 
-    def initialize
-      super
-      @sources           = []
-      @combinations      = Hash.new{ |h, k| [k] } # digest pass-thru if none defined
-      @content_cache     = Dassets::Cache::NoCache.new
-      @fingerprint_cache = Dassets::Cache::NoCache.new
-      @file_store        = FileStore::NullStore.new
-    end
-
-    def base_url(value = nil)
-      set_base_url(value) if !value.nil?
-      @base_url
-    end
+    @content_cache     = Dassets::NoCache.new
+    @fingerprint_cache = Dassets::NoCache.new
+    @file_store        = Dassets::NullFileStore.new
+  end
 
-    def set_base_url(value)
-      @base_url = value
-    end
+  def reset
+    @sources      = []
+    @combinations = Hash.new { |h, k| [k] } # digest pass-thru if none defined
+    @file_store   = Dassets::NullFileStore.new
+  end
 
-    def file_store(value = nil)
-      if !value.nil?
-        @file_store = (value.kind_of?(FileStore) ? value : FileStore.new(value))
-      end
-      @file_store
-    end
+  def base_url(value = nil)
+    set_base_url(value) if !value.nil?
+    @base_url
+  end
 
-    def content_cache(cache = nil)
-      @content_cache = cache if !cache.nil?
-      @content_cache
-    end
+  def set_base_url(value)
+    @base_url = value
+  end
 
-    def fingerprint_cache(cache = nil)
-      @fingerprint_cache = cache if !cache.nil?
-      @fingerprint_cache
+  def file_store(value = nil)
+    if !value.nil?
+      @file_store =
+        if value.kind_of?(Dassets::FileStore)
+          value
+        else
+          Dassets::FileStore.new(value)
+        end
     end
+    @file_store
+  end
 
-    def source(path, &block)
-      @sources << Source.new(path).tap{ |s| block.call(s) if block }
-    end
+  def content_cache(cache = nil)
+    @content_cache = cache if !cache.nil?
+    @content_cache
+  end
 
-    def combination(key_digest_path, value_digest_paths)
-      @combinations[key_digest_path.to_s] = [*value_digest_paths]
-    end
+  def fingerprint_cache(cache = nil)
+    @fingerprint_cache = cache if !cache.nil?
+    @fingerprint_cache
+  end
 
-    def combination?(key_digest_path)
-      # a digest path is only considered a combination is it is not the default
-      # pass-thru above
-      @combinations[key_digest_path.to_s] != [key_digest_path]
-    end
+  def source(path, &block)
+    @sources << Dassets::Source.new(path).tap{ |s| block.call(s) if block }
+  end
 
+  def combination(key_digest_path, value_digest_paths)
+    @combinations[key_digest_path.to_s] = [*value_digest_paths]
   end
 
+  def combination?(key_digest_path)
+    # a digest path is only considered a combination is it is not the default
+    # pass-thru above
+    @combinations[key_digest_path.to_s] != [key_digest_path]
+  end
 end