sinatra-exstatic-assets 2.0.0

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.rspec

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - ruby-head
+
+# whitelist
+branches:
+  only:
+    - master
+    - develop

data/CHANGES.md

@@ -0,0 +1,9 @@
+# CH CH CH CHANGES! #
+
+## Saturday the 25th of May 2013, v2.0.0 ##
+
+* First release as the renamed library.
+* Bumped version number to 2 to make complete break from previous version numbers.
+* Added this file!
+
+----

data/Gemfile

@@ -0,0 +1,29 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in sinatra-static-assets.gemspec
+gemspec
+
+group :example do
+  gem "sinatra"
+end
+
+group :test do
+  gem "rspec"
+  gem "rack-test"
+  gem "simplecov"
+  gem 'turn', :require => false
+  gem "rack-test-accepts", :require => "rack/test/accepts"
+end
+
+group :development do
+  gem 'json', '~> 1.7.7'
+  gem "rake"
+  gem "wirble"
+  gem "reek"
+  gem 'webrick', '~> 1.3.1' # get rid of stupid warnings.
+end
+
+group :documentation do
+  gem "yard"
+  gem "maruku"
+end

data/LICENCE

@@ -0,0 +1,27 @@
+(The MIT License)
+
+Copyright (c) 2009 Wlodek Bzyl, 2013 Iain Barnett
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+
+Addendum!
+
+The photos linked to from Flickr in the examples are not covered by this licence and are given under a Creative Commons licence. Follow the links to Flickr see the licence details.

data/README.md

@@ -0,0 +1,76 @@
+## Sinatra Exstatic Assets ##
+
+### Master branch build status ###
+
+[![Build Status](https://travis-ci.org/yb66/sinatra-exstatic-assets.png?branch=master)](https://travis-ci.org/yb66/sinatra-exstatic-assets)
+
+### Preamble ###
+
+This is a fork/reworking of [wbzyl](https://github.com/wbzyl/sinatra-static-assets)'s library. I had many of the same requirements that the original library catered for, but some different ones too, and the beauty of open source code is you get to scratch your own itch! Many thanks to the contributors to that library for all their hard work and sharing the code.
+
+### What does it do? ###
+
+It's a Sinatra extension that has some handy helpers for dealing with static assets, like stylesheets and images, in your views.
+
+### What's different from the other library? ###
+
+* There's no `link_to` method (it doesn't handle assets so it was cut).
+* There was a mutex in the library to handle timestamps and race conditions around that. That's gone.
+* The helpers now look at the timestamp for the file they're linking to, and add that as a querystring parameter to the link displayed in the view. This will help client browsers cache the file (add something like Rack Cache to aid with this).
+* There are some new options to give more control over whether the script_tag environment variable is prepended.
+* More aliases, and shorter aliases.
+* The tests are now a mixture of integration and unit test, but written using RSpec. There's also test coverage via SimpleCov, which is close to 100%.
+* More API docs via Yardoc.
+
+### Version numbers ###
+
+This library uses [semver](http://semver.org/) to version the **library**. That means the library version is ***not*** an indicator of quality but a way to manage changes.
+
+
+### Installation ###
+
+Via Bundler, put this in your Gemfile:
+
+    gem "sinatra-exstatic-assets", :require => "sinatra/exstatic_assets", :git => "https://github.com/yb66/sinatra-exstatic-assets.git", :branch => "develop"
+
+### Usage ###
+
+Here's a quick example, but there are more in the `examples` directory:
+
+    require 'sinatra'
+    require 'haml' # the lib doesn't rely on Haml, it's engine agnostic:)
+    require 'sinatra/exstatic_assets'
+    
+    get "/" do
+      haml :index
+    end
+    
+    @@ layout
+    !!!
+    %title Example
+    = favicon
+    = css_tag "/css/screen.css"
+    = js_tag "/js/helpers.js"
+    = js_tag "http://code.jquery.com/jquery-1.9.1.min.js" 
+    %body
+      = yield
+    
+    @@ index
+    %dt
+      %dd This is an interesting photo
+      %dl
+        %a{ href: "http://www.flickr.com/photos/redfernneil/1317915651/" }
+          = img "http://www.flickr.com/photos/redfernneil/1317915651/" width: 500, height: 250, alt: "Something about the photo"
+
+There is also more detailed documentation on each helper in the {Sinatra::Exstatic::Helpers} API docs.
+
+### TODO ###
+
+* Make it easy to pass in caching options.
+* Default dirs set up for things like /css, /images etc.
+* An image link tag.
+* Caching of the timestamps (but I'm not sure it's needed or worth it).
+
+### Licence ###
+
+See the LICENCE file.

data/Rakefile

@@ -0,0 +1,38 @@
+require 'bundler/gem_tasks'
+
+desc "(Re-) generate documentation and place it in the docs/ dir. Open the index.html file in there to read it."
+task :docs => [:"docs:environment", :"docs:yard"]
+
+namespace :docs do
+
+  task :environment do
+    ENV["RACK_ENV"] = "documentation"
+  end
+
+  require 'yard'
+
+  YARD::Rake::YardocTask.new :yard do |t|
+    t.files   = ['lib/**/*.rb']
+    t.options = ['-odocs/'] # optional
+  end
+
+end
+
+namespace :examples do
+
+  desc "Run the examples."
+  task :run do
+    exec "bundle exec rackup examples/config.ru"
+  end
+
+end
+
+
+task :default => "spec"
+
+require 'rspec/core/rake_task'
+
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = "./spec/**/*_spec.rb"
+end

data/examples/app/main.rb

@@ -0,0 +1,13 @@
+require 'sinatra/base'
+require 'sinatra/exstatic_assets'
+
+module Example
+  class App < Sinatra::Base
+    register Sinatra::Exstatic
+
+    get "/" do
+      erb :index
+    end
+  
+  end
+end

data/examples/app/public/css/base.css

@@ -0,0 +1,93 @@
+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;
+}

data/examples/app/public/css/screen.css

@@ -0,0 +1,8 @@
+* {
+    font-family: 'Titillium Web', sans-serif;
+}
+
+header[role=banner] h1 {
+    font-family: 'Faster One', sans-serif;
+    font-size: 46px; margin: 0px;
+}

data/examples/app/views/index.erb

@@ -0,0 +1,90 @@
+<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>
+      <%= Rack::Utils.escape_html( stylesheet_tag "/css/screen.css") %>
+    </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>
+      <%= Rack::Utils.escape_html( javascript_tag "http://code.jquery.com/jquery-1.9.1.min.js") %>
+    </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>
+      <%= Rack::Utils.escape_html( image_tag "http://farm3.staticflickr.com/2474/3609420787_f7fc0e53c7.jpg", width: "500", height: "375", alt: "Magic Ball" ) %>
+    </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>
+      <%= Rack::Utils.escape_html( favicon_tag ) %>
+    </samp>
+    <footer><p>Also known as:
+      <ul>
+        <li><code>favicon</code></li>
+      </ul>
+    </footer>
+  </section>
+</section>

data/examples/app/views/layout.erb

@@ -0,0 +1,40 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta charset="utf-8" />
+	<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/screen.css" %>
+	<%= javascript_tag "http://code.jquery.com/jquery-1.9.1.min.js" %>
+	
+</head>
+
+<body>
+  <header role='banner'>
+  <a href="http://www.flickr.com/photos/28931095@N03/3609420787/" title="Magic Ball by Sam Bald, on Flickr"><%= image_tag "http://farm3.staticflickr.com/2474/3609420787_f7fc0e53c7.jpg", width: "500", height: "375", alt: "Magic Ball" %></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>
+    <%= yield %>
+  </article>
+  
+  
+  <footer>
+      <p>&copy; <%= Time.now.year %> See the LICENCE file for more.</p>
+  </footer>
+</body>
+</html>