sinatra-assetpack 0.0.5

data/.gitignore

@@ -0,0 +1 @@
+/Gemfile.lock

data/Gemfile

@@ -0,0 +1,2 @@
+source :rubygems
+gemspec

data/HISTORY.md

@@ -0,0 +1,45 @@
+v0.0.5 - Aug 30, 2011
+---------------------
+
+### Fixed:
+  * Fix build failing when it finds directories.
+
+### Added:
+  * Added an example app in `example/`.
+
+v0.0.4 - Aug 30, 2011
+---------------------
+
+### Fixed:
+  * Ruby 1.8 compatibility. Yay!
+  * Fixed images always being square.
+  * Assets are now ordered properly.
+
+### Changed:
+  * the config format for `js_compression` and family. In your `assets` block, 
+  you now have to use `js_compression :closure` instead of `js_compression = 
+  :closure`.
+  * Use simple CSS compression by default.
+
+v0.0.3 - Aug 30, 2011
+---------------------
+
+### Added:
+  * Images in CSS defined in `url(...)` params are now cache-busted.
+  * Add support for embedded images in CSS.
+  * `rake assetpack:build` now also outputs images.
+
+v0.0.2 - Aug 29, 2011
+---------------------
+
+### Added:
+  * Added the `img` helper.
+  * Added support for filetypes used in @font-face.
+
+### Fixed:
+  * The gem now installs the correct dependencies.
+
+v0.0.1 - Aug 29, 2011
+---------------------
+
+Initial release.

data/README.md

@@ -0,0 +1,248 @@
+# Sinatra AssetPack
+#### Asset packer for Sinatra
+
+This is *the* most convenient way to set up your CSS/JS (and images) in a 
+Sinatra app. Seriously. No need for crappy routes to render Sass or whatever.
+No-siree!
+
+1. Drop your JavaScript/CoffeeScript files in `/app/js`
+2. Drop your CSS/sass/less/scss files in `/app/css`
+3. Add `register Sinatra::AssetPack` and set up options to your app
+4. Use `<%= css :application %>` to your layouts instead of messy *<script>* and 
+   *<link>* tags
+5. BOOM! You're in business baby!
+
+Setup
+-----
+
+ * Bundler: `gem 'sinatra-assetpack'`
+ * Else: `$ gem install sinatra-assetpack`
+
+Install the plugin and add some options. (Feel free to omit the *Optional* 
+    items, they're listed here for posterity):
+
+``` ruby
+require 'sinatra/assetpack'
+
+class Main < Sinatra::Base
+  set :root, File.dirname(__FILE__)
+  register Sinatra::AssetPack
+
+  assets {
+    serve '/js',     from: 'app/js'        # Optional
+    serve '/css',    from: 'app/css'       # Optional
+    serve '/images', from: 'app/images'    # Optional
+
+    js :app, '/js/app.js', [
+      '/js/vendor/**/*.js',
+      '/js/app/**/*.js'
+    ]
+
+    css :application, '/css/application.css', [
+      '/css/screen.css'
+    ]
+
+    js_compression  :jsmin      # Optional
+    css_compression :sass       # Optional
+  }
+end
+```
+
+In your layouts:
+
+``` erb
+<%= css :application, :media => 'screen' %>
+<%= js  :app %>
+```
+
+*(Use haml? Great! Use `!= css :youreawesome`.)*
+
+And then what?
+--------------
+
+If you're on **development** mode, it serves each of the files as so:
+
+``` html
+<link rel='stylesheet' href='/css/screen.849289.css' media='screen' type='text/css' />
+<script type='text/javascript' src='/js/vendor/jquery.283479.js'></script>
+<script type='text/javascript' src='/js/vendor/underscore.589491.js'></script>
+<script type='text/javascript' src='/js/app/main.589491.js'></script>
+```
+
+If you're on **production** mode, it serves a compressed version in the URLs you specify:
+
+``` html
+<link rel='stylesheet' href='/css/application.849289.css' media='screen' type='text/css' />
+<script type='text/javascript' src='/js/app.589491.js'></script>
+```
+
+Features
+--------
+
+ * __CoffeeScript support__: Just add your coffee files in one of the paths 
+ served (in the example, `app/js/hello.coffee`) and they will be available as JS 
+ files (`http://localhost:4567/js/hello.js`).
+
+ * __Sass/Less/SCSS support__: Works the same way. Place your dynamic CSS files 
+ in there (say, `app/css/screen.sass`) and they will be available as CSS files 
+ (`http://localhost:4567/css/screen.css`).
+
+ * __Cache busting__: the `css` and `js` helpers automatically ensures the URL 
+ is based on when the file was last modified. The URL `/js/jquery.js` may be 
+ translated to `/js/jquery.8237898.js` to ensure visitors always get the latest 
+ version.
+
+ * __Images support__: Image filenames in your CSS will automatically get a 
+ cache-busting suffix (eg, `/images/icon.742958.png`).
+
+ * __Embedded images support__: You can embed images in your CSS files as 
+ `data:` URIs by simply adding `?embed` to the end of your URL.
+
+ * __No intermediate files needed__: You don't need to generate compiled files.
+ You can, but it's optional. Keeps your source repo clean!
+
+ * __Auto minification (with caching)__: JS and CSS files will be compressed as 
+ needed.
+
+ * __Heroku support__: Oh yes. That's right.
+
+Compressors
+-----------
+
+By default, AssetPack uses [JSMin](http://rubygems.org/gems/jsmin) for JS 
+minifaction, and simple regexes for CSS minification. You can specify other
+compressors in the `assets` block:
+
+``` ruby
+assets {
+  js_compression  :jsmin    # :jsmin | :yui | :closure
+  css_compression :simple   # :simple | :sass | :yui | :sqwish
+}
+```
+
+
+### YUI Compressor
+
+``` ruby
+assets {
+  js_compression  :yui
+  css_compression :yui
+  js_compression_options { :munge => true }  # Munge variable names
+}
+```
+
+For YUI compression, you need the YUI compressor gem.
+
+ * Bundler? Add to *Gemfile*: `gem 'yui-compressor', :require => 'yui/compressor'`
+ * Else, `gem install yui-compressor`
+
+### SASS compression
+
+``` ruby
+assets {
+  css_compression :sass
+}
+```
+
+For SASS compression, you need the Sass gem.
+
+ * Bundler? Add to *Gemfile*: `gem 'sass'`
+ * Else, `gem install sass`
+
+### Sqwish CSS compression
+
+``` ruby
+assets {
+  css_compression :sqwish
+  css_compression_options { :strict => true }
+}
+```
+
+[Sqwish](http://github.com/ded/sqwish) is a NodeJS-based CSS compressor.  To use 
+Sqwish with AssetPack, install it using `npm install -g sqwish`. You need NodeJS 
+and NPM installed.
+
+### Google Closure compression
+
+``` ruby
+assets {
+  js_compression :closure
+  js_compression_options { :level => "SIMPLE_OPTIMIZATIONS" }
+}
+```
+
+This uses the [Google closure compiler service](http://closure-compiler.appspot.com/home)
+to compress your JavaScript.
+
+Available levels: `WHITESPACE_ONLY`, `SIMPLE_OPTIMIZATIONS`, `ADVANCED_OPTIMIZATIONS`
+
+Images
+------
+
+To show images, use the `img` helper.
+This automatically adds width, height, and a cache buster thingie.
+
+``` html
+<!-- Original: --> <%= img '/images/email.png' %>
+<!-- Output:   --> <img src='/images/email.873842.png' width='16' height='16' />
+```
+
+In your CSS files, `url()`'s will automatically be translated.
+
+``` css
+/* Original: */    .email { background: url(/images/email.png); }
+/* Output:   */    .email { background: url(/images/email.6783478.png); }
+```
+
+Want to embed images as `data:` URI's? Sure! Just add `?embed` at the end of the 
+URL.
+
+``` css
+/* Original: */    .email { background: url(/images/email.png?embed); }
+/* Output:   */    .email { background: url(data:image/png;base64,NF8dG3I...); } 
+```
+
+Need to build the files?
+------------------------
+
+Actually, you don't need to--this is optional! But add this to your Rakefile:
+
+``` ruby
+APP_FILE  = 'app.rb'
+APP_CLASS = 'Main'
+
+require 'sinatra/assetpack/rake'
+```
+
+Now:
+
+    $ rake assetpack:build
+
+This will create files in `/public`.
+
+Need Compass support?
+---------------------
+
+No, AssetPack doesn't have built-in Compass support, but you can use [Sinatra 
+Support](http://sinefunc.com/sinatra-support):
+
+``` ruby
+# gem install sinatra/support
+Encoding.default_external = 'utf-8'
+require 'sinatra/support'
+
+class Main
+  register Sinatra::CompassSupport
+end
+```
+
+To do
+-----
+
+AssetPack will eventually have:
+
+ * `rake assetpack:build` should be able to output to another folder
+ * Cache folder support (best if your app has many workers)
+ * Refactor *Compressor* module
+ * CDN (Cloudfront, S3) support
+ * Better support for Compass sprites

data/Rakefile

@@ -0,0 +1,3 @@
+task :test do
+  Dir['test/*_test.rb'].each { |f| load f }
+end

data/example/.gitignore

@@ -0,0 +1 @@
+public

data/example/Rakefile

@@ -0,0 +1,7 @@
+$:.unshift File.expand_path('../../lib', __FILE__)
+
+APP_FILE  = 'app.rb'
+APP_CLASS = 'App'
+
+require 'sinatra/assetpack/rake'
+

data/example/app.rb

@@ -0,0 +1,28 @@
+$:.unshift File.expand_path('../../lib', __FILE__)
+
+require 'sinatra/base'
+require 'sinatra/assetpack'
+
+class App < Sinatra::Base
+  set :root, File.dirname(__FILE__)
+  register Sinatra::AssetPack
+
+  assets do
+    js :main, '/js/main.js', [
+      '/js/vendor/*.js',
+      '/js/app.js'
+    ]
+
+    css :main, '/css/main.css', [
+      '/css/*.css'
+    ]
+  end
+
+  get '/' do
+    erb :index
+  end
+end
+
+if __FILE__ == $0
+  App.run!
+end

data/example/app/css/test.sass

@@ -0,0 +1,11 @@
+// This is SASS!
+
+#image_embedding_test
+  background: url(/images/icon.png?embed)
+  width: 16px
+  height: 16px
+
+/* This should have a cache-buster number.
+ */
+#cache_bust_test
+  background: url(/images/icon.png)

data/example/app/js/app.js

@@ -0,0 +1,3 @@
+("App.js goes here.");
+
+

data/example/app/js/vendor/jquery.js

@@ -0,0 +1,2 @@
+("jQuery goes here.");
+

data/example/app/js/vendor/jquery.plugin.js

@@ -0,0 +1,2 @@
+("A jQuery plugin goes here.");
+

data/example/app/js/vendor/underscore.js

@@ -0,0 +1,2 @@
+("Underscore.js goes here.");
+

data/example/views/index.erb

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8" />
+    <title></title>
+
+    <!-- These should include all the JS files defined in the app. -->
+    <%= js  :main %>
+    <%= css :main %>
+</head>
+<body>
+    <h1>Hello!</h1>
+    <h4>View the source of this file to see the JS files as they were included.</h4>
+
+    <h3>Image test:</h3>
+
+    <!-- This should have width and height. -->
+    <%= img '/images/icon.png' %>
+
+    <h3>Image embedding test:</h3>
+    <div id="image_embedding_test">
+        <!-- This should have a CSS background that uses a data: URI. --> 
+        <!-- Inspect that <div> to see. -->
+    </div>
+</body>
+</html>

data/lib/sinatra/assetpack.rb

@@ -0,0 +1,55 @@
+require 'rack/test'
+
+module Sinatra
+  module AssetPack
+    def self.registered(app)
+      unless app.root?
+        raise Error, "Please set :root in your Sinatra app."
+      end
+
+      app.extend  ClassMethods
+      app.helpers Helpers
+    end
+
+    # Returns a list of formats that can be served.
+    # Anything not in this list will be rejected.
+    def self.supported_formats
+      @supported_formats ||= %w(css js png jpg gif otf eot ttf woff)
+    end
+
+    # Returns a map of what MIME format each Tilt type returns.
+    def self.tilt_formats
+      @formats ||= {
+        'scss' => 'css',
+        'sass' => 'css',
+        'less' => 'css',
+        'coffee' => 'js'
+      }
+    end
+
+    # Returns the inverse of tilt_formats.
+    def self.tilt_formats_reverse
+      re = Hash.new { |h, k| h[k] = Array.new }
+      formats.each { |tilt, out| re[out] << tilt }
+      out
+    end
+
+    PREFIX = File.dirname(__FILE__)
+
+    autoload :ClassMethods,  "#{PREFIX}/assetpack/class_methods"
+    autoload :Options,       "#{PREFIX}/assetpack/options"
+    autoload :Helpers,       "#{PREFIX}/assetpack/helpers"
+    autoload :HtmlHelpers,   "#{PREFIX}/assetpack/html_helpers"
+    autoload :BusterHelpers, "#{PREFIX}/assetpack/buster_helpers"
+    autoload :Package,       "#{PREFIX}/assetpack/package"
+    autoload :Compressor,    "#{PREFIX}/assetpack/compressor"
+    autoload :Image,         "#{PREFIX}/assetpack/image"
+    autoload :Css,           "#{PREFIX}/assetpack/css"
+    autoload :Configurator,  "#{PREFIX}/assetpack/configurator"
+    autoload :HashArray,     "#{PREFIX}/assetpack/hasharray"
+
+    Error = Class.new(StandardError)
+
+    require "#{PREFIX}/assetpack/version"
+  end
+end