sinatra-exstatic-assets 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e890fc9a6623a37de61efc6f09c3684ec341dcb3
-  data.tar.gz: 2b8bc414cecc3afeb0a00f1cd2cc4aa5a66b2d13
+  metadata.gz: 05a627944971257f2082ae5953e5df01c2f65965
+  data.tar.gz: edeb2413e71cd8139c9d44618be83f2c2ddfb450
 SHA512:
-  metadata.gz: ddcf6487fe8a4d35c2e24d5f5364a28acacc1bc92b395f2f285f7c6e9543bac3ae8cd9c6d273f286e4af354f0e156ac8a456f817f5274f828a543910aea34e71
-  data.tar.gz: 844dafe2fb40aa786c3465a02a3d5a1c0c2289c916796d00e35a62b29ca0158d56b49523a6a70536921a5dfbf85a83941c8e2d8d7de527f800a901a97b641094
+  metadata.gz: ecd83526a18cc3f4221186585705acb464f3f317a7318fe99f21eda4c890daa933621eb3147b46868faf848fa8361427d36b5ef36f2fd904c8b1fa95e613064a
+  data.tar.gz: b82d28f9c9eba146b27803ba630030783e8812f54b4e4a5f75db00f8eef6838843ca9fe701bb4562cb0516d0fee98dccaeb04fd4c066765281cc6a942a21e693

data/CHANGES.md

@@ -1,5 +1,13 @@
 # CH CH CH CHANGES! #
 
+## Friday the 2nd of December 2016, v3.1.0 ##
+
+- Fixed a subtle bug with script_name.
+- Improved favicon method.
+- Added timestamp formatting.
+
+----
+
 ## Wednesday the 26th of August 2015, v3.0.0 ##
 
 - Fixed typo where `script_tag` had overwritten `script_name`.

data/Gemfile

@@ -10,6 +10,7 @@ end
 group :test do
   gem "rspec"
   gem "rspec-its"
+  gem "mocha"
   gem "rack-test"
   gem "simplecov"
   gem 'turn', :require => false
@@ -22,6 +23,7 @@ group :development do
   gem "rake"
   unless RUBY_ENGINE == 'jruby' || RUBY_ENGINE == "rbx"
     gem "pry-byebug"
+    gem "pry-doc"
   end
   gem 'webrick', '~> 1.3.1' # get rid of stupid warnings.
 end

data/README.md

@@ -85,6 +85,22 @@ Here's a quick example, but there are more in the `examples` directory:
 
 There is also more detailed documentation on each helper in the {Sinatra::Exstatic::Helpers} API docs.
 
+## Formats ##
+
+The time format is the result of the file's `mtime`. If you wish for a different kind of format, SHA1 of the file is available (and I may add more). To use:
+
+      require 'sinatra/exstatic_assets/formats'
+      register Sinatra::Exstatic
+
+      configure do
+        set :timestamp_format, :sha1
+      end
+
+And now the value returned will be the SHA1 hash of the file. You can override the choice by passing the `timestamp_format` to the method:
+
+      = css_tag "/css/screen.css", timestamp_format: :mtime
+
+
 ### TODO ###
 
 * Make it easy to pass in caching options.

data/examples/app/views/index.erb

@@ -19,13 +19,32 @@ rel="bookmark">Usage</a>
     <header>
         <h3>stylesheet_tag</h3>
     </header>
-    <p>The code:
-    </p>
-    <code>stylesheet_tag "/css/screen.css"</code>
-    <p>Output:</p>
-    <samp>
-      <%= Rack::Utils.escape_html( stylesheet_tag "/css/screen.css") %>
-    </samp>
+    <section>
+      <h3>Default use:</h3>
+      <p>By default, the querystring is appended with parameter of "ts" (for <strong>t</strong>ime<strong>s</strong>tamp) and the mtime of the file.
+      <p>The code:
+      </p>
+      <code>stylesheet_tag "/css/screen.css"</code>
+      <p>Output:</p>
+      <samp>
+        <%= Rack::Utils.escape_html( stylesheet_tag "/css/screen.css") %>
+      </samp>
+    </section>
+    <section>
+      <h3>Alternative timestamp format</h3>
+      <p>You can choose to take an SHA1 of the file instead:</p>
+      <code>stylesheet_tag "/css/screen.css", timestamp_format: :sha1</code>
+      <p>Output:</p>
+      <samp>
+        <%= Rack::Utils.escape_html( stylesheet_tag "/css/screen.css", timestamp_format: :sha1) %>
+      </samp>
+      <p>To set the timestamp for all calls, use the settings object:</p>
+      <code>set :timestamp_format, :sha1</code>
+      <p>It's set to :mtime_int by default. The timestamp formatting applies to all method calls (except for favicon, because favicons aren't cached in the same manner) but can be overridden by including the option in the method call e.g.</p>
+      <code>set :timestamp_format, :sha1</code>
+      <code>stylesheet_tag "/css/screen.css", timestamp_format: :mtime_int</code>
+      <p>Would mean that the resultant stylesheet would have an SHA1 string appended, but other method calls without the "timestamp_format: :mtime_int" would have an mtime appended.</p>
+    </section>
     <footer><p>Also known as:
       <ul>
         <li><code>css_tag</code></li>
@@ -37,13 +56,17 @@ rel="bookmark">Usage</a>
     <header>
       <h3>javascript_tag</h3>
     </header>
-    <p>The code:
-    </p>
-    <code>javascript_tag "http://code.jquery.com/jquery-1.9.1.min.js"</code>
-    <p>Output:</p>
-    <samp>
-      <%= Rack::Utils.escape_html( javascript_tag "http://code.jquery.com/jquery-1.9.1.min.js") %>
-    </samp>
+    <section>
+      <h3>Using a URL</h3>
+      <p>The code:
+      </p>
+      <code>javascript_tag "http://code.jquery.com/jquery-1.9.1.min.js"</code>
+      <p>Output:</p>
+      <samp>
+        <%= Rack::Utils.escape_html( javascript_tag "http://code.jquery.com/jquery-1.9.1.min.js") %>
+      </samp>
+      <p>When a URL is given, no timestamp is appended. If the javascript was a file, then like stylesheet_tag above, it would have a timestamp appended.</p>
+    </section>
     <footer><p>Also known as:
       <ul>
         <li><code>javascript_include_tag</code></li>

data/examples/app2/main.rb

@@ -17,5 +17,9 @@ module Example
     get "/deeper" do
       erb :index
     end
+
+    get "/deeper/and-deeper" do
+      erb :index
+    end
   end
 end

data/examples/app2/views/index.erb

@@ -94,7 +94,7 @@ rel="bookmark">Usage</a>
     <code>favicon_tag</code>
     <p>Output:</p>
     <samp>
-      <%= Rack::Utils.escape_html( favicon_tag url_options: {script_tag: false} ) %>
+      <%= Rack::Utils.escape_html( favicon_tag ) %>
     </samp>
     <footer><p>Also known as:
       <ul>

data/examples/app2/views/layout.erb

@@ -5,7 +5,7 @@
 	<title>Example</title>
 	<%= favicon_tag %>
 	<%= stylesheet_tag 'http://fonts.googleapis.com/css?family=Quicksand|Faster+One|Cherry+Swash:700|Titillium+Web', rel: 'stylesheet', type: 'text/css' %>
-	<%= stylesheet_tag "/css/base.css" %>
+	<%= stylesheet_tag "/css/base.css", script_name: false %>
 	<%= stylesheet_tag "/css/screen.css" %>
 	<%= javascript_tag "http://code.jquery.com/jquery-1.9.1.min.js" %>
 	

data/lib/sinatra/exstatic_assets/formats.rb

@@ -0,0 +1,31 @@
+require_relative "../exstatic_assets.rb"
+
+module Sinatra
+  module Exstatic
+    # Extends the Asset class, for using types of format
+    # other than mtime_int
+    # Just require this file and then use the format of your choice.
+    # @example
+    #
+    #   require 'sinatra/exstatic_assets/formats'
+    #
+    #   configure do
+    #     # Set all timestamps to use SHA1 of the file.
+    #     app.set :timestamp_format, :sha1
+    #   end
+    #
+    #   # or just call it on an individual basis:
+    #   stylesheet_tag "css/main.css", timestamp_format: :sha1
+    module Formats
+
+      def sha1
+        Digest::SHA1.file(fullpath).hexdigest
+      end
+    
+    end
+
+    class Asset
+      include Formats
+    end
+  end
+end

data/lib/sinatra/exstatic_assets/version.rb

@@ -1,6 +1,6 @@
 module Sinatra
   module Exstatic
     # Library version
-    VERSION = "3.0.0"
+    VERSION = "3.1.0"
   end
 end

data/lib/sinatra/exstatic_assets.rb

@@ -1,4 +1,5 @@
 require 'sinatra/base'
+require 'digest/sha1'
 
 # @see https://sinatrarb.com/intro The framework
 module Sinatra
@@ -57,18 +58,20 @@ module Sinatra
 
 
     # Encapsulates an asset, be it a stylesheet, an image…
-    class Asset < ::String
+    class Asset < String
 
       attr_reader :fullpath
 
       # @param [String] filename Either the file name (and path relative to the public folder) or the external HTTP link.
       # @param [String] asset_dir The asset directory. When used with Sinatra this will default to the directory defined by the `public_folder` setting.
-      def initialize( filename, asset_dir=nil ) # TODO failure strategy
+      def initialize( filename, asset_dir=nil, timestamp_format=nil ) # TODO failure strategy
         if asset_dir.nil?
+          # TODO should this strip the leading slash?
           filename, asset_dir = [File.basename(filename), File.dirname(filename)]
         end
         # TODO fail if asset_dir.nil?
         super filename
+        @timestamp_format = timestamp_format
         @fullpath = File.join( asset_dir, filename ) unless is_uri?
       end
 
@@ -76,7 +79,7 @@ module Sinatra
       # If the asset is a local file this gets the timestamp.
       # @return [Integer]
       def timestamp
-        @timestamp ||= !is_uri? && exists? && mtime_int
+        @timestamp ||= !is_uri? && exists? && send(@timestamp_format)
       end
 
       # Takes the timestamp and returns it as a querystring.
@@ -135,16 +138,38 @@ module Sinatra
       # @option options [TrueClass] :script_name Whether to prepend the SCRIPT_NAME env variable.
       # @return [String]
       # @see Sinatra::Helpers#uri
-      def sss_url_for(addr, options=nil)
-        options ||= {}
-        opts = {timestamp: true}.merge options
-        absolute = opts.delete :absolute
+      def sss_url_for(addr, options, url_opts)
+        absolute = url_opts.delete :absolute
         absolute = false if absolute.nil?
+        scr = url_opts.delete(:script_name)
         script_name =
-          !addr.is_uri? ||
-          opts.delete(:script_name) && addr.start_with?("/")
-
+          if addr.is_uri?
+            false
+          elsif addr.start_with?("/")
+            scr.nil? ?
+              true :
+              scr
+          else
+            false
+          end
         href = uri addr, absolute, script_name
+
+        timestamp =
+          if scr == false
+            false
+          else
+            #   timestamp |
+            #       nil       t
+            #       f     |   f
+            #       t     |   t
+            if options[:timestamp] && options[:timestamp] == false
+              false
+            else
+              true
+            end
+          end
+        opts = {timestamp: timestamp}.merge options
+
         addr.respond_to?(:querystring) && opts[:timestamp] ?
           "#{href}#{addr.querystring}" :
           href
@@ -167,10 +192,9 @@ module Sinatra
       # @option options [Hash] :url_options Options for devising the URL.
       # @option options [TrueClass] :script_name Whether to prepend the SCRIPT_NAME env variable.
       # @return [Tag]
-      def sss_stylesheet_tag(source, options = {})
-        asset_dir = options.delete(:asset_dir) || settings.public_folder
-        asset = Asset.new source, asset_dir
-        href = sss_url_for( asset, options.delete(:url_options) )
+      def sss_stylesheet_tag(source, options, url_opts)
+        asset = Asset.new source, options.delete(:asset_dir), options.delete(:timestamp_format)
+        href = sss_url_for asset, options, url_opts
         Tag.new "link", DEFAULT_CSS.merge(:href => href)
                                    .merge(options)
       end
@@ -179,15 +203,15 @@ module Sinatra
       # Default options for the javascript script tags.
       DEFAULT_JS = {
 #         :type => "text/javascript", 
-        :charset => "utf-8"
+        :charset => "utf-8",
       }
 
 
       # Produce a javascript script tag.
       # @see #sss_stylesheet_tag but there is no `closed` option here.
-      def sss_javascript_tag(source, options = {})
-        asset = Asset.new source, settings.public_folder
-        href = sss_url_for asset, options.delete(:url_options)
+      def sss_javascript_tag(source, options, url_opts)
+        asset = Asset.new source, options.delete(:asset_dir), options.delete(:timestamp_format)
+        href = sss_url_for asset, options, url_opts
         Tag.new("script", DEFAULT_JS.merge(:src => href)
                                             .merge(options)          
         ) {}
@@ -197,19 +221,43 @@ module Sinatra
       # Make's sure the options don't get mixed up with the other args.
       def sss_extract_options(a)
         opts = a.last.respond_to?(:keys) ?
-          a.pop :
+          a.pop || {} :
           {}
-        opts ||= {}
-        [a, opts]
+
+        url_opts = opts.empty? ?
+          {} :
+          {
+            absolute: opts.delete(:absolute),
+            script_name: opts.delete(:script_name),
+          }.reject{|k,v| v.nil? }
+        a = [nil] if a == []
+        [a, opts, url_opts]
       end
 
 
       # @see #sss_stylesheet_tag
-      def sss_image_tag(source, options = {})
-        options[:src] = sss_url_for Asset.new( source, settings.public_folder ), options.delete(:url_options)
+      def sss_image_tag(source, options, url_opts)
+        options[:src] = sss_url_for Asset.new( source, options.delete(:asset_dir), options.delete(:timestamp_format) ), options, url_opts
         Tag.new "img", options
       end
 
+
+      # @param [String] source
+      # @param [Hash] options
+      # @option options [TrueClass] :script_name whether to append the script_name environment variable or not
+      # @example
+      #   favicon_tag
+      #   # => <link href="/favicon.ico" rel="icon">
+      def sss_favicon_tag(source, options, url_opts)
+        source = "/favicon.ico" if source.nil? or source.empty?
+
+        # xhtml style like <link rel="shortcut icon" href="http://example.com/myicon.ico" />
+        options[:rel] ||= settings.xhtml ? "shortcut icon" : "icon"
+        asset = Asset.new source, options.delete(:asset_dir), options.delete(:timestamp_format)
+        options[:href] = sss_url_for asset, options.merge(timestamp: false), url_opts
+        Tag.new "link", options
+      end
+
     end
 
     # These are the helpers available to a Sinatra app using the extension.
@@ -259,11 +307,17 @@ module Sinatra
       #   @example
       #     javascript_tag "http://code.jquery.com/jquery-1.9.1.min.js"
       #     # => <script charset="utf-8" src="http://code.jquery.com/jquery-1.9.1.min.js"></script>
-      %w{image_tag stylesheet_tag javascript_tag}.each do |method_name|
-        define_method method_name do |*sources|
-          list, options = sss_extract_options sources
+      %w{image_tag stylesheet_tag javascript_tag favicon_tag}.each do |method_name|
+        define_method method_name do |*args|
+          list, options, url_opts = sss_extract_options args
           list.map {|source|
-            send "sss_#{method_name}", source, options
+            asset_dir = options.delete(:asset_dir) ||
+                        settings.static_assets_dir ||
+                        settings.public_folder
+            timestamp_format = options.delete(:timestamp_format) ||
+                                settings.timestamp_format ||
+                                :mtime_int # default
+            send "sss_#{method_name}", source, options.merge({asset_dir: asset_dir, timestamp_format: timestamp_format}), url_opts
           }.join "\n"
         end
       end
@@ -276,34 +330,18 @@ module Sinatra
       alias_method :js_tag, :javascript_tag
       alias_method :script_tag, :javascript_tag
 
-      # @param [String] source
-      # @param [Hash] options
-      # @option options [Hash] :url_options script_name
-      # @example
-      #   favicon_tag
-      #   # => <link href="/favicon.ico" rel="icon">
-      def favicon_tag(*args)
-        source, options = sss_extract_options args
-        source = "favicon.ico" if source.nil? or source.empty?
-
-        # xhtml style like <link rel="shortcut icon" href="http://example.com/myicon.ico" />
-        options[:rel] ||= settings.xhtml ? "shortcut icon" : "icon"
-
-        url_options = options.delete(:url_options) || {}
-        options[:href] = sss_url_for(Asset.new(source), url_options.merge(timestamp: false))
-        
-        Tag.new "link", options
-      end
-
       alias_method :link_favicon_tag, :favicon_tag
       alias_method :favicon, :favicon_tag
 
     end
 
     # Extending
+    # @see {Sinatra::Exstatic::Formats} to extend timestamp_format
     def self.registered(app)
       app.helpers Exstatic::Helpers
       app.disable :xhtml
+      app.set :static_assets_dir, nil
+      app.set :timestamp_format, :mtime_int
     end
   end
 

data/spec/spec_helper.rb

@@ -3,12 +3,13 @@
 require 'rspec'
 require 'rspec/its'
 Spec_dir = File.expand_path( File.dirname __FILE__ )
-
+require 'pry-byebug' if ENV["DEBUG"]
 
 # code coverage
 require 'simplecov'
 SimpleCov.start do
   add_filter "/vendor/"
+  add_filter "/vendor.noindex/"
   add_filter "/bin/"
 end
 
@@ -33,7 +34,11 @@ require 'rack/test/accepts'
 require 'timecop'
 
 RSpec.configure do |config|
-  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.mock_with :mocha
+
+  config.expect_with :rspec do |c|
+    c.syntax = [:should, :expect]
+  end
 
   config.include Rack::Test::Accepts, :type => :request
 

data/spec/static_assets_spec.rb

@@ -1,30 +1,62 @@
 require 'spec_helper'
-require_relative "../lib/sinatra/exstatic_assets.rb"
+#require_relative "../lib/sinatra/exstatic_assets.rb"
+require_relative "../lib/sinatra/exstatic_assets/formats.rb"
 
 module Sinatra
 module Exstatic
 
+shared_context "mtime timestamp" do
+  before(:each) do
+    File.expects(:"exists?").with(fullpath)
+                            .at_least_once
+                            .returns(true)
+    File.expects(:mtime).with(fullpath)
+                        .returns(time)
+  end
+end
+
 describe Asset, :time_sensitive do
+  shared_examples "for Asset file" do
+    its(:fullpath) { should == fullpath }
+    its(:"is_uri?") { should be_falsy }
+    it { should_not be_nil }
+    it { should == expected }
+  end
   let(:asset_dir) { "app/public" }
-  subject(:asset){ Asset.new filename, asset_dir }
+  let(:time) { Time.now }
+  subject(:asset){ Asset.new filename, asset_dir, timestamp_format }
   context "Given a file" do
-    let(:fullpath) { File.join asset_dir, filename }
-    before do
-      File.stub(:"exists?").with(fullpath).and_return(true)
-      File.stub(:mtime).with(fullpath).and_return(Time.now)
-    end
     let(:filename) { "image.jpg" }
     let(:expected) { "image.jpg" }
-    it { should_not be_nil }
-    it { should == expected }
-    its(:fullpath) { should == fullpath }
-    its(:timestamp) { should == Time.now.to_i }
-    its(:"is_uri?") { should be_falsy }
-    its(:querystring) { should == "?ts=#{Time.now.to_i}" }
+    let(:fullpath) { File.join asset_dir, filename }
+    context "Using mtime as the timestamp" do
+      let(:timestamp_format) { :mtime_int }
+      context "" do
+        include_context "mtime timestamp"
+        its(:timestamp) { should == Time.now.to_i }
+        its(:querystring) { should == "?ts=#{Time.now.to_i}" }
+      end
+      include_examples "for Asset file"
+    end
+    context "Using sha1 as the timestamp" do
+      let(:timestamp_format) { :sha1 }
+      context "" do
+        before do
+          digest_mock = mock()
+          digest_mock.expects(:hexdigest).returns( "871cb4397c5f5f146cc5583088b12c7d0a8ddc97" )
+          File.expects(:"exists?").with(fullpath).returns(true)
+          Digest::SHA1.expects(:file).with(fullpath).returns(digest_mock)
+        end
+        its(:timestamp) { should == "871cb4397c5f5f146cc5583088b12c7d0a8ddc97" }
+        its(:querystring) { should == %Q!?ts=#{"871cb4397c5f5f146cc5583088b12c7d0a8ddc97"}! }
+      end
+      include_examples "for Asset file"
+    end
   end
   context "Given a url" do
     let(:filename) { "http://code.jquery.com/jquery-1.9.1.min.js" }
     let(:expected) { "http://code.jquery.com/jquery-1.9.1.min.js" }
+    let(:timestamp_format) { :mtime_int }
     it { should_not be_nil }
     it { should == expected }
     its(:fullpath) { should be_nil }
@@ -69,8 +101,11 @@ end
 
 class FakeObject
   include Sinatra::Exstatic::Private
-  def uri( addr, absolute, script_tag )
-    script_tag ? File.join( ENV["SCRIPT_NAME"], addr) : addr
+  def initialize script_name=nil
+    @script_name = script_name || public_folder
+  end
+  def uri( addr, absolute, script_name )
+    script_name ? File.join( @script_name, addr) : addr
   end
   def settings
     self
@@ -78,58 +113,78 @@ class FakeObject
   def public_folder
     "app/public"
   end
+  def xhtml
+    @xhtml ||= false
+  end
 end
+
 describe "Private methods", :time_sensitive do
+  let(:script_name) { "/bar" }
+  let(:fullpath) { File.join asset_dir, filename }
+  let(:asset_dir) { "app/public/" }
+  let(:time) { Time.now.to_i }
+  let(:timestamp_format) { :mtime_int }
   let(:o) {
     # A double, I couldn't get RSpec's to work with this
     # probably because they're not well documented
     # hint hint RSpec team
-    o = FakeObject.new
+    o = FakeObject.new script_name
   }
-  let(:script_name) { "/bar" }
-  let(:fullpath) { File.join asset_dir, filename }
-  let(:asset_dir) { "app/public/" }
-  let(:time) { Time.now.to_i }
-  before do
-    ENV["SCRIPT_NAME"] = script_name
-    File.stub(:"exists?").with(fullpath).and_return(true)
-    File.stub(:mtime).with(fullpath).and_return(time)
-  end
-  context "Stylesheets" do
-    let(:url) { "/stylesheets/winter.css" }
-    let(:filename) { "/stylesheets/winter.css" }
-    context "Given a filename" do
-      context "But no options" do
-        let(:expected) { %Q!<link charset="utf-8" href="/bar/stylesheets/winter.css?ts=#{time}" media="screen" rel="stylesheet" />! }
-        subject { o.send :sss_stylesheet_tag, url }
-        it { should == expected }
+  
+  context "Favicon" do
+    let(:url) { "/favicon.ico" }
+    let(:filename) { "favicon.ico" }
+    let(:expected) { %Q!<link href="/bar/favicon.ico" rel="icon" />! }
+    subject {
+      o.send :sss_favicon_tag, url, {asset_dir: asset_dir}, {}
+    }
+    it { should == expected }
+  end
+  context "Accessing the file system" do
+    include_context "mtime timestamp" do
+    end
+    context "Stylesheets" do
+      before do
+        ENV["SCRIPT_NAME"] = script_name
       end
-      context "with options" do
-        context "media=print" do
-          let(:expected) { %Q!<link charset="utf-8" href="/bar/stylesheets/winter.css?ts=#{time}" media="print" rel="stylesheet" />! }
-          subject { o.send :sss_stylesheet_tag, url, media: "print" }
-          it { should == expected }       
+      let(:url) { "/stylesheets/winter.css" }
+      let(:filename) { "/stylesheets/winter.css" }
+      context "Given a filename" do
+        context "But no options" do
+          let(:expected) { %Q!<link charset="utf-8" href="/bar/stylesheets/winter.css?ts=#{time}" media="screen" rel="stylesheet" />! }
+          subject { o.send :sss_stylesheet_tag, url, {asset_dir: asset_dir, timestamp_format: timestamp_format}, {} }
+          it { should == expected }
+        end
+        context "with options" do
+          context "media=print" do
+            let(:expected) { %Q!<link charset="utf-8" href="/bar/stylesheets/winter.css?ts=#{time}" media="print" rel="stylesheet" />! }
+            subject { o.send :sss_stylesheet_tag, url, {asset_dir: asset_dir,media: "print", timestamp_format: timestamp_format}, {} }
+            it { should == expected }       
+          end
         end
       end
     end
-    it { should_not be_nil }
-  end
-  context "Javascripts" do
+    context "Javascripts" do
     let(:url) { "/js/get_stuff.js" }
     let(:filename) { "/js/get_stuff.js" }
     let(:expected) { %Q!<script charset="utf-8" src="/bar/js/get_stuff.js?ts=#{time}"></script>! }
-    subject { o.send :sss_javascript_tag, url }
+    subject { o.send :sss_javascript_tag, url, {asset_dir: asset_dir, timestamp_format: timestamp_format}, {} }
     it { should_not be_nil }
     it { should == expected }
   end
+  end
   context "Images" do
     context "Local" do
       let(:url) { "/images/foo.png" }
       let(:filename) { "/images/foo.png" }
       let(:expected) { %Q!<img src="/bar/images/foo.png?ts=#{time}" />! }
-      subject { o.send :sss_image_tag, url }
-      it { should_not be_nil }
-      it { should == expected }
+      subject { o.send :sss_image_tag, url, {asset_dir: asset_dir, timestamp_format: :mtime_int}, {} }
+      
+      context "Using mtime as the timestamp" do
+        include_context "mtime timestamp"
+        it { should_not be_nil }
+        it { should == expected }
+      end
     end
     context "Remote" do
       let(:url) { "http://example.org/images/foo.png" }
@@ -137,7 +192,7 @@ describe "Private methods", :time_sensitive do
       let(:expected) { %Q!<img src="#{url}" />! }
       subject { 
         o.send  :sss_image_tag,
-                url
+                url, {asset_dir: asset_dir}, {}
       }
       it { should_not be_nil }
       it { should == expected }
@@ -148,7 +203,7 @@ describe "Private methods", :time_sensitive do
       let(:expected) { %Q!<img src="#{url}" />! }
       subject { 
         o.send  :sss_image_tag,
-                url
+                url, {asset_dir: asset_dir}, {}
       }
       it { should_not be_nil }
       it { should == expected }
@@ -164,12 +219,14 @@ describe "Using them with a Sinatra app", :time_sensitive do
   let(:expected) { File.read File.expand_path(fixture_file, File.dirname(__FILE__)) }
   before do
     Sinatra::Exstatic::Asset.any_instance
-                                  .stub(:exists?)
-                                  .and_return(true)
+                                  .expects(:exists?)
+                                  .at_least_once
+                                  .returns(true)
 
     Sinatra::Exstatic::Asset.any_instance
-                                  .stub(:mtime_int)
-                                  .and_return(1367612251)
+                                  .expects(:mtime_int)
+                                  .at_least_once
+                                  .returns(1367612251)
   end
   context "Main" do
     context "/" do
@@ -210,5 +267,14 @@ describe "Using them with a Sinatra app", :time_sensitive do
       subject { last_response.body }
       it { should == expected }
     end
+    context "/app2/deeper" do
+      let(:fixture_file) { "./support/fixtures/app2-deeper.html" }
+      before do
+        get "/app2/deeper/and-deeper"
+      end
+      it_should_behave_like "Any route"
+      subject { last_response.body }
+      it { should == expected }
+    end
   end
 end

data/spec/support/fixtures/app-deeper.html

@@ -50,13 +50,32 @@ rel="bookmark">Usage</a>
     <header>
         <h3>stylesheet_tag</h3>
     </header>
-    <p>The code:
-    </p>
-    <code>stylesheet_tag "/css/screen.css"</code>
-    <p>Output:</p>
-    <samp>
-      &lt;link charset=&quot;utf-8&quot; href=&quot;&#x2F;css&#x2F;screen.css?ts=1367612251&quot; media=&quot;screen&quot; rel=&quot;stylesheet&quot; &#x2F;&gt;
-    </samp>
+    <section>
+      <h3>Default use:</h3>
+      <p>By default, the querystring is appended with parameter of "ts" (for <strong>t</strong>ime<strong>s</strong>tamp) and the mtime of the file.
+      <p>The code:
+      </p>
+      <code>stylesheet_tag "/css/screen.css"</code>
+      <p>Output:</p>
+      <samp>
+        &lt;link charset=&quot;utf-8&quot; href=&quot;&#x2F;css&#x2F;screen.css?ts=1367612251&quot; media=&quot;screen&quot; rel=&quot;stylesheet&quot; &#x2F;&gt;
+      </samp>
+    </section>
+    <section>
+      <h3>Alternative timestamp format</h3>
+      <p>You can choose to take an SHA1 of the file instead:</p>
+      <code>stylesheet_tag "/css/screen.css", timestamp_format: :sha1</code>
+      <p>Output:</p>
+      <samp>
+        &lt;link charset=&quot;utf-8&quot; href=&quot;&#x2F;css&#x2F;screen.css?ts=702cc1975cea5e2e6558680532502615c01e762a&quot; media=&quot;screen&quot; rel=&quot;stylesheet&quot; &#x2F;&gt;
+      </samp>
+      <p>To set the timestamp for all calls, use the settings object:</p>
+      <code>set :timestamp_format, :sha1</code>
+      <p>It's set to :mtime_int by default. The timestamp formatting applies to all method calls (except for favicon, because favicons aren't cached in the same manner) but can be overridden by including the option in the method call e.g.</p>
+      <code>set :timestamp_format, :sha1</code>
+      <code>stylesheet_tag "/css/screen.css", timestamp_format: :mtime_int</code>
+      <p>Would mean that the resultant stylesheet would have an SHA1 string appended, but other method calls without the "timestamp_format: :mtime_int" would have an mtime appended.</p>
+    </section>
     <footer><p>Also known as:
       <ul>
         <li><code>css_tag</code></li>
@@ -68,13 +87,17 @@ rel="bookmark">Usage</a>
     <header>
       <h3>javascript_tag</h3>
     </header>
-    <p>The code:
-    </p>
-    <code>javascript_tag "http://code.jquery.com/jquery-1.9.1.min.js"</code>
-    <p>Output:</p>
-    <samp>
-      &lt;script charset=&quot;utf-8&quot; src=&quot;http:&#x2F;&#x2F;code.jquery.com&#x2F;jquery-1.9.1.min.js&quot;&gt;&lt;&#x2F;script&gt;
-    </samp>
+    <section>
+      <h3>Using a URL</h3>
+      <p>The code:
+      </p>
+      <code>javascript_tag "http://code.jquery.com/jquery-1.9.1.min.js"</code>
+      <p>Output:</p>
+      <samp>
+        &lt;script charset=&quot;utf-8&quot; src=&quot;http:&#x2F;&#x2F;code.jquery.com&#x2F;jquery-1.9.1.min.js&quot;&gt;&lt;&#x2F;script&gt;
+      </samp>
+      <p>When a URL is given, no timestamp is appended. If the javascript was a file, then like stylesheet_tag above, it would have a timestamp appended.</p>
+    </section>
     <footer><p>Also known as:
       <ul>
         <li><code>javascript_include_tag</code></li>

data/spec/support/fixtures/app2-deeper.html

@@ -5,7 +5,7 @@
 	<title>Example</title>
 	<link href="/app2/favicon.ico" rel="icon" />
 	<link charset="utf-8" href="http://fonts.googleapis.com/css?family=Quicksand|Faster+One|Cherry+Swash:700|Titillium+Web" media="screen" rel="stylesheet" type="text/css" />
-	<link charset="utf-8" href="/app2/css/base.css?ts=1367612251" media="screen" rel="stylesheet" />
+	<link charset="utf-8" href="/css/base.css" media="screen" rel="stylesheet" />
 	<link charset="utf-8" href="/app2/css/screen.css?ts=1367612251" media="screen" rel="stylesheet" />
 	<script charset="utf-8" src="http://code.jquery.com/jquery-1.9.1.min.js"></script>
 	

data/spec/support/fixtures/app2.html

@@ -5,7 +5,7 @@
 	<title>Example</title>
 	<link href="/app2/favicon.ico" rel="icon" />
 	<link charset="utf-8" href="http://fonts.googleapis.com/css?family=Quicksand|Faster+One|Cherry+Swash:700|Titillium+Web" media="screen" rel="stylesheet" type="text/css" />
-	<link charset="utf-8" href="/app2/css/base.css?ts=1367612251" media="screen" rel="stylesheet" />
+	<link charset="utf-8" href="/css/base.css" media="screen" rel="stylesheet" />
 	<link charset="utf-8" href="/app2/css/screen.css?ts=1367612251" media="screen" rel="stylesheet" />
 	<script charset="utf-8" src="http://code.jquery.com/jquery-1.9.1.min.js"></script>
 	

data/spec/support/fixtures/main.html

@@ -50,13 +50,32 @@ rel="bookmark">Usage</a>
     <header>
         <h3>stylesheet_tag</h3>
     </header>
-    <p>The code:
-    </p>
-    <code>stylesheet_tag "/css/screen.css"</code>
-    <p>Output:</p>
-    <samp>
-      &lt;link charset=&quot;utf-8&quot; href=&quot;&#x2F;css&#x2F;screen.css?ts=1367612251&quot; media=&quot;screen&quot; rel=&quot;stylesheet&quot; &#x2F;&gt;
-    </samp>
+    <section>
+      <h3>Default use:</h3>
+      <p>By default, the querystring is appended with parameter of "ts" (for <strong>t</strong>ime<strong>s</strong>tamp) and the mtime of the file.
+      <p>The code:
+      </p>
+      <code>stylesheet_tag "/css/screen.css"</code>
+      <p>Output:</p>
+      <samp>
+        &lt;link charset=&quot;utf-8&quot; href=&quot;&#x2F;css&#x2F;screen.css?ts=1367612251&quot; media=&quot;screen&quot; rel=&quot;stylesheet&quot; &#x2F;&gt;
+      </samp>
+    </section>
+    <section>
+      <h3>Alternative timestamp format</h3>
+      <p>You can choose to take an SHA1 of the file instead:</p>
+      <code>stylesheet_tag "/css/screen.css", timestamp_format: :sha1</code>
+      <p>Output:</p>
+      <samp>
+        &lt;link charset=&quot;utf-8&quot; href=&quot;&#x2F;css&#x2F;screen.css?ts=702cc1975cea5e2e6558680532502615c01e762a&quot; media=&quot;screen&quot; rel=&quot;stylesheet&quot; &#x2F;&gt;
+      </samp>
+      <p>To set the timestamp for all calls, use the settings object:</p>
+      <code>set :timestamp_format, :sha1</code>
+      <p>It's set to :mtime_int by default. The timestamp formatting applies to all method calls (except for favicon, because favicons aren't cached in the same manner) but can be overridden by including the option in the method call e.g.</p>
+      <code>set :timestamp_format, :sha1</code>
+      <code>stylesheet_tag "/css/screen.css", timestamp_format: :mtime_int</code>
+      <p>Would mean that the resultant stylesheet would have an SHA1 string appended, but other method calls without the "timestamp_format: :mtime_int" would have an mtime appended.</p>
+    </section>
     <footer><p>Also known as:
       <ul>
         <li><code>css_tag</code></li>
@@ -68,13 +87,17 @@ rel="bookmark">Usage</a>
     <header>
       <h3>javascript_tag</h3>
     </header>
-    <p>The code:
-    </p>
-    <code>javascript_tag "http://code.jquery.com/jquery-1.9.1.min.js"</code>
-    <p>Output:</p>
-    <samp>
-      &lt;script charset=&quot;utf-8&quot; src=&quot;http:&#x2F;&#x2F;code.jquery.com&#x2F;jquery-1.9.1.min.js&quot;&gt;&lt;&#x2F;script&gt;
-    </samp>
+    <section>
+      <h3>Using a URL</h3>
+      <p>The code:
+      </p>
+      <code>javascript_tag "http://code.jquery.com/jquery-1.9.1.min.js"</code>
+      <p>Output:</p>
+      <samp>
+        &lt;script charset=&quot;utf-8&quot; src=&quot;http:&#x2F;&#x2F;code.jquery.com&#x2F;jquery-1.9.1.min.js&quot;&gt;&lt;&#x2F;script&gt;
+      </samp>
+      <p>When a URL is given, no timestamp is appended. If the javascript was a file, then like stylesheet_tag above, it would have a timestamp appended.</p>
+    </section>
     <footer><p>Also known as:
       <ul>
         <li><code>javascript_include_tag</code></li>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sinatra-exstatic-assets
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Włodek Bzyl
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-26 00:00:00.000000000 Z
+date: 2016-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -49,7 +49,6 @@ files:
 - examples/app/views/index.erb
 - examples/app/views/layout.erb
 - examples/app2/main.rb
-- examples/app2/public/css/base.css
 - examples/app2/public/css/screen.css
 - examples/app2/public/favicon.ico
 - examples/app2/public/js/helpers.js
@@ -61,6 +60,7 @@ files:
 - examples/views/layout.erb
 - lib/sinatra/exstatic-assets.rb
 - lib/sinatra/exstatic_assets.rb
+- lib/sinatra/exstatic_assets/formats.rb
 - lib/sinatra/exstatic_assets/version.rb
 - sinatra-exstatic-assets.gemspec
 - spec/spec_helper.rb

data/examples/app2/public/css/base.css

@@ -1,93 +0,0 @@
-body {
-    width: 480px; margin: 0px 30px;
-}
-
-
-header[role=banner] h2 {
-    font-size: 18px; margin: 0px; color: #888;
-    font-style: italic;
-}
-
-ul { list-style-type: none }
-
-nav ul {
-    list-style: none; padding: 0px; display: block;
-    clear: right; background-color: #888;
-    padding-left: 4px; height: 24px;
-}
-
-nav ul li {
-    display: inline; padding: 0px 20px 5px 10px;
-    height: 24px; border-right: 1px solid #ccc;
-}
-
-nav ul li a {
-    color: #993333; text-decoration: none;
-    font-size: 13px; font-weight: bold;
-}
-
-nav ul li a:hover {
-    color: #fff;
-}
-
-article > header time {
-    font-size: 14px; display: block; width: 26px;
-    padding: 2px; text-align: center; background-color: #993333;
-    color: #fff; font-weight: bold; -moz-border-radius: 6px;
-    -webkit-border-radius: 6px; border-radius: 6px; float: left;
-    margin-bottom: 10px;
-}
-
-article > header time span {
-    font-size: 10px; font-weight: normal;
-    text-transform: uppercase;
-}
-
-article > header h1 {
-    font-size: 30px; float: left;
-    margin:0;
-    margin-left: 14px;
-    text-shadow: 2px 2px 5px #333;
-}
-
-article > header h1 a {
-    color: #993333;
-}
-
-section > header h3 {
-  border-bottom: 1px dotted;
-  border-left: 1px dotted;
-  padding-left: 5px;
-}
-
-article > section {
-  margin-top: 30px;
-}
-article section section{
-  margin-bottom: 40px;
-}
-
-article > section header h1 {
-    font-size: 16px;
-}
-
-article p {
-    clear: both;
-}
-
-footer p {
-    text-align: center; font-size: 12px;
-    color: #888; margin-top: 24px;
-}
-
-code {
-  background: #E6E6E6;
-  border: 1px solid #D8D8D8;
-  display: block;
-  margin-bottom: 10px;
-}
-
-samp {
-  background: #F5F6CE;
-  display: block;
-}