sinatra-exstatic-assets 2.0.0

data/lib/sinatra/exstatic_assets/version.rb

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

data/sinatra-exstatic-assets.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+
+$:.push File.expand_path("../lib", __FILE__)
+require "sinatra/exstatic_assets/version"
+
+Gem::Specification.new do |s|
+  s.name        = "sinatra-exstatic-assets"
+  s.version     = Sinatra::Exstatic::VERSION
+  s.authors     = ["Włodek Bzyl", "Iain Barnett"]
+  s.email       = ["iainspeed@gmail.com"]
+  s.homepage    = "https://github.com/yb66/sinatra-exstatic-assets"
+  s.summary     = %q{A Sinatra extension of helpers for static assets.}
+  s.description = %q{Helpers for writing the HTML and caching of static assets. A fork of Sinatra Static Assets.}
+
+  s.add_dependency 'sinatra'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_paths = ["lib"]
+end

data/spec/spec_helper.rb

@@ -0,0 +1,38 @@
+# encoding: UTF-8
+
+require 'rspec'
+Spec_dir = File.expand_path( File.dirname __FILE__ )
+
+
+# code coverage
+require 'simplecov'
+SimpleCov.start do
+  add_filter "/vendor/"
+  add_filter "/bin/"
+end
+
+require "rack/test"
+ENV['RACK_ENV'] ||= 'test'
+ENV["EXPECT_WITH"] ||= "racktest"
+
+
+require "logger"
+logger = Logger.new STDOUT
+logger.level = Logger::DEBUG
+logger.datetime_format = '%a %d-%m-%Y %H%M '
+LOgger = logger
+
+
+Dir[ File.join( Spec_dir, "/support/**/*.rb")].each do |f| 
+  logger.info "requiring #{f}"
+  require f
+end
+
+require 'rack/test/accepts'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+
+  config.include Rack::Test::Accepts, :type => :request
+end
+

data/spec/static_assets_spec.rb

@@ -0,0 +1,156 @@
+require 'spec_helper'
+require_relative "../lib/sinatra/exstatic_assets.rb"
+
+module Sinatra
+module Exstatic
+
+describe Asset, :time_sensitive do
+  let(:asset_dir) { "app/public" }
+  subject(:asset){ Asset.new filename, asset_dir }
+  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_false }
+    its(:querystring) { should == "?ts=#{Time.now.to_i}" }
+  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" }
+    it { should_not be_nil }
+    it { should == expected }
+    its(:fullpath) { should be_nil }
+    its(:timestamp) { should == false }
+    its(:"is_uri?") { should be_true }
+    its(:querystring) { should be_nil }
+  end
+end
+
+describe Tag do
+  subject { tag }
+  context "Given a group of options" do
+    let(:tag) {
+      Tag.new "link", 
+              { :type => "text/css",
+                :charset => "utf-8",
+                :media => "projection",
+                :rel => "stylesheet",
+                :href => "/bar/stylesheets/winter.css"
+              }
+    }
+    let(:expected) { %Q!<link charset="utf-8" href="/bar/stylesheets/winter.css" media="projection" rel="stylesheet" type="text/css" />! }
+    it { should == expected }
+
+    context "That include closed=false" do
+        let(:tag) {
+          Tag.new "link", 
+                  { :type => "text/css",
+                    :charset => "utf-8",
+                    :media => "projection",
+                    :rel => "stylesheet",
+                    :href => "/bar/stylesheets/winter.css",
+                    :closed => false
+                  }
+        }
+      let(:expected) { %Q!<link charset="utf-8" href="/bar/stylesheets/winter.css" media="projection" rel="stylesheet" type="text/css">! }
+      it { should == expected }
+    end
+  end
+end
+
+
+class FakeObject
+  include Sinatra::Exstatic::Private
+  def uri( addr, absolute, script_tag )
+    script_tag ? File.join( ENV["SCRIPT_NAME"], addr) : addr
+  end
+  def settings
+    self
+  end
+  def public_folder
+    "app/public"
+  end
+end
+describe "Private methods", :time_sensitive do
+  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
+  }
+  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" }
+    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_not be_nil }
+    it { should == expected }
+  end
+  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 }
+    it { should_not be_nil }
+    it { should == expected }
+  end
+  context "Images" 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 }
+  end
+end
+
+end # Exstatic
+end # Sinatra
+
+describe "Using them with a Sinatra app", :time_sensitive do
+  include_context "All routes"
+  let(:expected) { File.read File.expand_path(fixture_file, File.dirname(__FILE__)) }
+  before do
+    Sinatra::Exstatic::Asset.any_instance
+                                  .stub(:exists?)
+                                  .and_return(true)
+
+    Sinatra::Exstatic::Asset.any_instance
+                                  .stub(:mtime_int)
+                                  .and_return(1367612251)
+  end
+  context "Main" do
+    let(:fixture_file) { "./support/fixtures/main.txt" }
+    before do
+      get "/"
+    end
+    it_should_behave_like "Any route"
+    subject { last_response.body }
+    it { should == expected }
+  end
+  context "Sub" do
+    let(:fixture_file) { "./support/fixtures/app2.txt" }
+    before do
+      get "/app2"
+    end
+    it_should_behave_like "Any route"
+    subject { last_response.body }
+    it { should == expected }
+  end
+end

data/spec/support/fixtures/app2.txt

@@ -0,0 +1,144 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta charset="utf-8" />
+	<title>Example</title>
+	<link href="/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="/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>
+	
+</head>
+
+<body>
+  <header role='banner'>
+  <a href="http://www.flickr.com/photos/tjt195/12470738/" title="Greased Lightning by tarotastic, on Flickr"><img alt="Greased Lightning" height="375" src="http://farm1.staticflickr.com/10/12470738_fc0212bf8c.jpg" width="500" /></a>
+      <hgroup>
+          <h1>Sinatra Exstatic Assets</h1>
+          <h2>Helpers for your JS, CSS and anything static</h2>
+      </hgroup>
+  </header>
+  
+  <nav>
+      <ul>
+          <li><a href="/">Main app</a></li>
+          <li><a href="/app2">App 2</a></li>
+          <li><a href="https://rubygems.org/gems/sinatra-exstatic-assets">Rubygems</a></li>
+          <li><a href="https://github.com/yb66/sinatra-exstatic-assets">Source code</a></li>
+      </ul>
+  </nav>
+  <article>
+    <header>
+    <h1>
+        <a href="#" title="Link to this post" 
+rel="bookmark">Usage</a>
+    </h1>
+</header>
+<p>Note that there is a Main App and an App2. This is to demonstrate that you can give links relative to the app, but if they are mounted with an extra prefix (using Rack#map, for example) the helper will respect that and produce the right href attribute.</p>
+<section><header><h2>Installation and loading</h2></header>
+  <p>Start by installing:</p>
+  <code>gem 'sinatra-exstatic-assets'</code>
+  <p>Then require it in your Sinatra app.</p>
+  <code>require 'sinatra/exstatic_assets'</code>
+</section>
+<section>
+  <header><h2>The helpers</h2></header>
+  <p>Use these helpers in your views.</p>
+  <p>To add an attribute to a helper, pass it as an option, e.g. <code>width: "500"</code></p>
+  <p>Sometimes, you won't want the script tag (e.g. "/app2") prepended to the url, like in the case of a favicon. In that case you can pass in <code>url_options: {script_tag: false}</code> to the helper, e.g. <code>favicon_tag url_options: {script_tag: false}</code></p>
+  <section id='stylesheet_tag'>
+    <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;app2&#x2F;css&#x2F;screen.css?ts=1367612251&quot; media=&quot;screen&quot; rel=&quot;stylesheet&quot; &#x2F;&gt;
+    </samp>
+    <footer><p>Also known as:
+      <ul>
+        <li><code>css_tag</code></li>
+        <li><code>stylesheet</code></li>
+      </ul>
+    </footer>
+  </section>
+  <section id='javascript_tag'>
+    <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>
+    <p>The code:
+    </p>
+    <code>javascript_tag "/js/helpers.js"</code>
+    <p>Output:</p>
+    <samp>
+      &lt;script charset=&quot;utf-8&quot; src=&quot;&#x2F;app2&#x2F;js&#x2F;helpers.js?ts=1367612251&quot;&gt;&lt;&#x2F;script&gt;
+    </samp>
+    <footer><p>Also known as:
+      <ul>
+        <li><code>javascript_include_tag</code></li>
+        <li><code>js_tag</code></li>
+        <li><code>script_tag</code></li>
+      </ul> 
+    </footer>
+  </section>
+  <section id='image_tag'>
+    <header>
+      <h3>image_tag</h3>
+    </header>
+    <p>The code:
+    </p>
+    <code>image_tag "http://farm1.staticflickr.com/10/12470738_fc0212bf8c.jpg", width: "500", height: "375", alt: "Greased Lightning"</code>
+    <p>Output:</p>
+    <samp>
+      &lt;img alt=&quot;Greased Lightning&quot; height=&quot;375&quot; src=&quot;http:&#x2F;&#x2F;farm1.staticflickr.com&#x2F;10&#x2F;12470738_fc0212bf8c.jpg&quot; width=&quot;500&quot; &#x2F;&gt;
+    </samp>
+    <p>The code:
+    </p>
+    <code>image_tag "/images/turnip.jpg", width: "500", height: "375", alt: "Turnip"</code>
+    <p>Output:</p>
+    <samp>
+      &lt;img alt=&quot;Turnip&quot; height=&quot;375&quot; src=&quot;&#x2F;app2&#x2F;images&#x2F;turnip.jpg?ts=1367612251&quot; width=&quot;500&quot; &#x2F;&gt;
+    </samp>
+    <footer><p>Also known as:
+      <ul>
+        <li><code>img_tag</code></li>
+        <li><code>img</code></li>
+      </ul>
+    </footer>
+  </section>
+  <section id='favicon_tag'>
+    <header>
+      <h3>favicon_tag</h3>
+    </header>
+    <p>The code:
+    </p>
+    <code>favicon_tag</code>
+    <p>Output:</p>
+    <samp>
+      &lt;link href=&quot;&#x2F;favicon.ico&quot; rel=&quot;icon&quot; &#x2F;&gt;
+    </samp>
+    <footer><p>Also known as:
+      <ul>
+        <li><code>favicon</code></li>
+      </ul>
+    </footer>
+  </section>
+</section>
+  </article>
+  
+  
+  <footer>
+      <p>&copy; 2013 See the LICENCE file for more.</p>
+  </footer>
+</body>
+</html>

data/spec/support/fixtures/main.txt

@@ -0,0 +1,129 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta charset="utf-8" />
+	<title>Example</title>
+	<link href="/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="/css/base.css?ts=1367612251" media="screen" rel="stylesheet" />
+	<link charset="utf-8" href="/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>
+	
+</head>
+
+<body>
+  <header role='banner'>
+  <a href="http://www.flickr.com/photos/28931095@N03/3609420787/" title="Magic Ball by Sam Bald, on Flickr"><img alt="Magic Ball" height="375" src="http://farm3.staticflickr.com/2474/3609420787_f7fc0e53c7.jpg" width="500" /></a>
+      <hgroup>
+          <h1>Sinatra Exstatic Assets</h1>
+          <h2>Helpers for your JS, CSS and anything static</h2>
+      </hgroup>
+  </header>
+  
+  <nav>
+      <ul>
+          <li><a href="/">Main app</a></li>
+          <li><a href="/app2">App 2</a></li>
+          <li><a href="https://rubygems.org/gems/sinatra-exstatic-assets">Rubygems</a></li>
+          <li><a href="https://github.com/yb66/sinatra-exstatic-assets">Source code</a></li>
+      </ul>
+  </nav>
+  <article>
+    <header>
+    <h1>
+        <a href="#" title="Link to this post" 
+rel="bookmark">Usage</a>
+    </h1>
+</header>
+<p>Note that there is a Main App and an App2. This is to demonstrate that you can give links relative to the app, but if they are mounted with an extra prefix (using Rack#map, for example) the helper will respect that and produce the right href attribute.</p>
+<section><header><h2>Installation and loading</h2></header>
+  <p>Start by installing:</p>
+  <code>gem 'sinatra-exstatic-assets'</code>
+  <p>Then require it in your Sinatra app.</p>
+  <code>require 'sinatra/exstatic_assets'</code>
+</section>
+<section>
+<section>
+  <header><h2>The helpers</h2></header>
+  <p>Use these helpers in your views.<p>
+  <section id='stylesheet_tag'>
+    <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>
+    <footer><p>Also known as:
+      <ul>
+        <li><code>css_tag</code></li>
+        <li><code>stylesheet</code></li>
+      </ul>
+    </footer>
+  </section>
+  <section id='javascript_tag'>
+    <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>
+    <footer><p>Also known as:
+      <ul>
+        <li><code>javascript_include_tag</code></li>
+        <li><code>js_tag</code></li>
+        <li><code>script_tag</code></li>
+      </ul> 
+    </footer>
+  </section>
+  <section id='image_tag'>
+    <header>
+      <h3>image_tag</h3>
+    </header>
+    <p>The code:
+    </p>
+    <code>image_tag "http://farm3.staticflickr.com/2474/3609420787_f7fc0e53c7.jpg", width: "500", height: "375", alt: "Magic Ball"</code>
+    <p>Output:</p>
+    <samp>
+      &lt;img alt=&quot;Magic Ball&quot; height=&quot;375&quot; src=&quot;http:&#x2F;&#x2F;farm3.staticflickr.com&#x2F;2474&#x2F;3609420787_f7fc0e53c7.jpg&quot; width=&quot;500&quot; &#x2F;&gt;
+    </samp>
+    <footer><p>Also known as:
+      <ul>
+        <li><code>img_tag</code></li>
+        <li><code>img</code></li>
+      </ul>
+    </footer>
+  </section>
+  <section id='favicon_tag'>
+    <header>
+      <h3>favicon_tag</h3>
+    </header>
+    <p>The code:
+    </p>
+    <code>favicon_tag</code>
+    <p>Output:</p>
+    <samp>
+      &lt;link href=&quot;&#x2F;favicon.ico&quot; rel=&quot;icon&quot; &#x2F;&gt;
+    </samp>
+    <footer><p>Also known as:
+      <ul>
+        <li><code>favicon</code></li>
+      </ul>
+    </footer>
+  </section>
+</section>
+  </article>
+  
+  
+  <footer>
+      <p>&copy; 2013 See the LICENCE file for more.</p>
+  </footer>
+</body>
+</html>