sinatra-sprockets-chain 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ba1701991fb4e0cb8faed0e744674ce9e01fff51
+  data.tar.gz: 5828e408a899f66feff358adbc64d43b94304673
+SHA512:
+  metadata.gz: 16f3abdafc6d13227db0c417ddcdc5e6104e53e99d5c694a7d0fdfab33b093ae803bdc91db508aa726f578e7d6969917986b5049b4a8b862dde8a22dd12903ce
+  data.tar.gz: 48007b5b3d7d4200908f105a8dfdc3f89b6ebe8fc678654e9a99afe741f1b17ebcf6a0b3b817d5b527926acf1b8fccad1cd469509386acf7bd16f21152734f94

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 Edson Hilios
+
+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.

data/README.md

@@ -0,0 +1,169 @@
+Sinatra::Sprockets
+==================
+
+Plug and play extension for sinatra that mimic rails assets pipeline through Sprockets.
+
+This gem allows you easly deploy assets via Sprockets assets pipeline just as Rails does, also help you configure the rake tasks for compression. The goal is to have a headless configuration extension and be tested (all other aren't) to give users a fast access to all Sprockets goodness.
+
+Installation & Usage
+--------------------
+
+Set on your Gemset file if you are using Bundler:
+
+```ruby
+gem 'sinatra-sprockets-wheel'
+# Don't forget the js evaluator: gem 'therubyracer'
+```
+
+If you are using the Classic style just require the extension.
+
+```
+require 'sinatra'
+require 'sinatra/sprockets'
+
+# ... Your app
+```
+
+On the other hand if you use the Modular approach, besides requiring register the extension on your Sinatra application.
+
+```ruby
+require 'sinatra/base'
+require 'sinatra/sprockets'
+
+class Hello < Sinatra::Base
+  register Sinatra::Sprockets
+
+  # ... Your app
+end
+```
+
+Following the default configuration you just need to create the `/assets` folder and Sprockets will search for `application.js` and `application.css` to precompile (if you want to set-up a different structure jump to the [configuration](#configuration) chapter). The default folder schema is:
+
+```
+hello/
+| assets/
+| | application.js
+| | application.css
+|
+| sinatra_app.rb
+```
+
+In the application.(js|css) you can include your requirements:
+
+```css
+/*
+ *= require vendor/normalize
+ *= require_self
+ *= require_tree .
+ */
+```
+
+```js
+//= require vendor/normalize
+//= require_self
+//= require_tree .
+```
+
+By default Sprockets don't serve your file in production so it's up to you compile them, just set-up your `Rakefile` and run the `assets:precompile` task.
+
+```ruby
+require 'sinatra/sprockets/task'
+require 'sintra_app'
+
+Sinatra::Sprockets.rake_tasks(App)
+```
+
+Helpers
+-------
+
+This gem come bundled with [sprockets-helpers](https://github.com/petebrowne/sprockets-helpers) to help the path resolution of your assets inside sprockets or your application. All methods available in the gem will be at your disposal has helper once you register the extension.
+
+```css
+body {
+  background-image: image-url('cat.png');
+}
+```
+
+```erb
+<img src="<%= image_path('hello.jpg') %>" />
+<script src="<%= javascript_path 'application' %>"></script>
+<link rel="stylesheet" href="<%= stylesheet_path 'application' %>">
+
+<%= javascript_tag 'application' %>
+<%= stylesheet_tag 'application' %>
+
+<!-- Handle the expansion of assets for debugging like Rails -->
+<%= javascript_tag 'application', expand: true %>
+```
+
+Configuration
+-------------
+
+You can control Sprockets entirely using Sinatra `set` configuration method. Bellow a list of the configuration:
+
+```ruby
+set :assets_prefix, '/assets'
+set :assets_path,   %w[
+  app/assets/vendor
+  app/assets/stylesheets
+  app/assets/javascripts
+  app/assets/images
+]
+set :assets_precompile,     %w(application.js application.css)
+set :assets_host,           'cdn.host.com'
+set :assets_protocol,       :https
+
+# Debug mode automatically sets
+# expand = true, digest = false, manifest = false
+set :assets_debug,          true
+
+set :assets_manifest_file,  File.join(public_folder, "assets/manifest.json")
+set :assets_css_compressor, :sass
+set :assets_js_compressor,  :uglifier
+```
+
+Minification
+------------
+
+As seen on the last example of the configurantion you can configure other libraries to compress your assets, Sinatra::Sprockets handle them transparently and it's up to you to require the gems.
+
+#### SASS
+
+```ruby
+gem 'sass'
+set :assets_css_compressor, :sass
+```
+
+#### Closure
+
+```ruby
+gem 'closure-compiler'
+set :assets_css_compressor, :closure
+```
+
+#### Uglifier
+
+```ruby
+gem 'uglifier'
+set :assets_css_compressor, :uglifier
+```
+
+#### Uglifier
+
+```ruby
+gem 'yui-compressor'
+set :assets_css_compressor, :yui
+```
+
+### Compass and others gems
+
+The integration is easily done by requiring the [sprockets-sass](https://github.com/petebrowne/sprockets-sass) gem.
+
+None the less any gem that have integration with the Sprockets will work seamlessly. If you need any other configuration you can call Sprockets configuration directly.
+
+Copyrights
+----------
+
+Copyrights 2012 [**Edson Hilios**](http://edson.hilios.com.br) edson (at) hilios (dot) com (dot) br
+
+This software is licensed under [MIT-LICENSE](https://github.com/hilios/sinatra-sprockets-wheel/blob/master/MIT-LICENSE)

data/lib/sinatra-sprockets-chain.rb

@@ -0,0 +1 @@
+require 'sinatra/sprockets'

data/lib/sinatra/sprockets.rb

@@ -0,0 +1,84 @@
+require 'sprockets'
+
+Dir[File.join(File.expand_path(File.dirname __FILE__), "sprockets/**/*.rb")].each { |file| require file }
+
+module Sinatra
+  module Sprockets
+    class << self
+      attr_accessor :sprockets
+
+      def registered(app)
+        return if app.root.nil?
+        # Sprockets configuration
+        app.set_default :assets_prefix,     '/assets'
+        app.set_default :assets_path,       %w(assets)
+        app.set_default :assets_precompile, %w(application.js application.css 
+          *.css *.js *.gif *.jpg *.png *.svg *.ttf *.otf *.eot *.woff)
+        # Compressors
+        app.set_default :assets_css_compressor, :none
+        app.set_default :assets_js_compressor,  :none
+        # Helpers options
+        app.set_default :assets_host,       ''
+        app.set_default :assets_protocol,   :relative
+        app.set_default :assets_digest,     true
+        app.set_default :assets_expand,     false
+        app.set_default :assets_debug,      false
+        # Set the manifest file path
+        app.set_default :assets_manifest_file,
+          File.join(app.public_folder, app.assets_prefix)
+        
+        app.configure do
+          # Create a Sprockets environment
+          sprockets ||= ::Sprockets::Environment.new(app.root)
+          app.set :sprockets, sprockets
+          # Append all paths to Sprockets
+          app.assets_path.each do |path|
+            path = File.join(app.root, path) unless path =~ /^\//
+            sprockets.append_path path
+          end
+          # Configure Sprockets::Helpers
+          ::Sprockets::Helpers.configure do |config|
+            config.environment = app.sprockets
+            config.prefix      = app.assets_prefix
+            config.public_path = app.public_folder
+            config.manifest    = ::Sprockets::Manifest.new(app.sprockets, 
+              app.assets_manifest_file)
+            # Optionals
+            config.asset_host  = app.assets_host
+            config.protocol    = app.assets_protocol
+            config.digest      = app.assets_digest
+            config.expand      = app.assets_expand
+            # Debug mode automatically sets
+            # expand = true, digest = false, manifest = false
+            config.debug       = app.assets_debug
+          end
+          # Add my helpers
+          app.helpers Helpers
+        end
+
+        app.configure :development do
+          # Register asset pipeline middleware so we don't need to route on .ru
+          app.use Server, app.sprockets, %r(#{app.assets_prefix})
+        end
+        
+        # Configure compression on production
+        app.configure :production do
+          # Set the CSS compressor
+          unless app.assets_css_compressor == :none
+            app.sprockets.css_compressor = app.assets_css_compressor
+          end
+          # Set the JS compressor
+          unless app.assets_js_compressor  == :none
+            app.sprockets.js_compressor  = app.assets_js_compressor
+          end
+        end
+      end
+    end
+
+    def set_default(key, default_value)
+      self.set(key, default_value) unless self.respond_to? key
+    end
+  end
+
+  register Sprockets
+end

data/lib/sinatra/sprockets/helpers.rb

@@ -0,0 +1,27 @@
+require 'sprockets-helpers'
+
+module Sinatra
+  module Sprockets
+    module Helpers
+      include ::Sprockets::Helpers
+
+      def stylesheets(*args)
+        args.map! do |asset|
+          asset = "#{asset}.css" if asset.is_a? Symbol
+          stylesheet_tag(asset)
+        end
+        args.join("")
+      end
+      alias_method :stylesheet, :stylesheets
+
+      def javascripts(*args)
+        args.map! do |asset|
+          asset = "#{asset}.js" if asset.is_a? Symbol
+          javascript_tag(asset)
+        end
+        args.join("")
+      end
+      alias_method :javascript, :javascripts
+    end
+  end
+end

data/lib/sinatra/sprockets/server.rb

@@ -0,0 +1,27 @@
+module Sinatra
+  module Sprockets
+    # http://stackoverflow.com/a/10679994
+    class Server
+      attr_reader :app, :engine, :path_prefix
+
+      def initialize(app, engine, path_prefix, &block)
+        @app = app
+        @engine = engine
+        @path_prefix = path_prefix
+        yield engine if block_given?
+      end
+
+      def call(env)
+        path = env["PATH_INFO"]
+        if path =~ path_prefix and not engine.nil?
+          env["PATH_INFO"].sub!(path_prefix, '')
+          engine.call(env)
+        else
+          app.call(env)
+        end
+      ensure
+        env["PATH_INFO"] = path
+      end
+    end
+  end
+end

data/lib/sinatra/sprockets/task.rb

@@ -0,0 +1,32 @@
+require 'rake'
+require 'rake/tasklib'
+require 'rake/sprocketstask'
+
+module Sinatra
+  module Sprockets
+    class Task < Rake::SprocketsTask
+      # Just create a wrapper for the Sprockets Task
+      def initialize(app)
+        super(:precompile)
+        @output       = File.join(app.public_folder, app.assets_prefix)
+        @assets       = app.assets_precompile
+        @environment  = app.sprockets
+
+        yield self if block_given?
+      end
+
+      def define
+        namespace :assets do
+          super
+        end
+      end
+
+      class << self
+        def define(app)
+          Task.new(app)
+        end
+        alias_method :define!, :define
+      end
+    end
+  end
+end

data/lib/sinatra/sprockets/version.rb

@@ -0,0 +1,5 @@
+module Sinatra
+  module Sprockets
+    VERSION = '0.0.1'
+  end
+end

data/test/app/assets/application.css

@@ -0,0 +1,6 @@
+/*
+ *= require_self
+ *= require_tree .
+ */
+
+ body{}

data/test/app/assets/application.js

@@ -0,0 +1,4 @@
+//= require_self
+//= require_tree .
+
+var app = {};

data/test/app/assets/other.css

@@ -0,0 +1 @@
+.other{}

data/test/app/assets/other.js

@@ -0,0 +1 @@
+var other = {};

data/test/app/mock.rb

@@ -0,0 +1,6 @@
+require 'sinatra/base'
+require './lib/sinatra/sprockets'
+
+class Mock < Sinatra::Base
+  register Sinatra::Sprockets
+end

data/test/sinatra/sprockets/helpers_test.rb

@@ -0,0 +1,27 @@
+require 'test_helper'
+
+class Sinatra::Sprockets::HelpersTest < MiniTest::Test
+
+  def app
+    mock_app do
+      get('/javascript')  { javascript_tag('application') }
+
+      get('/stylesheet')  { stylesheet_tag('application') }
+    end
+  end
+
+  def test_javascript_helper
+    get('/javascript')
+    assert last_response.ok?
+    assert_match %r(application-(.+?).js),      last_response.body
+    assert_match %r(<script (.+?)><\/script>),  last_response.body
+  end
+
+  def test_stylesheet_helper
+    get('/stylesheet')
+    assert last_response.ok?
+    assert_match %r(application-(.+?).css), last_response.body
+    assert_match %r(<link (.+?)>),          last_response.body
+  end
+
+end

data/test/sinatra/sprockets/server_test.rb

@@ -0,0 +1,38 @@
+require 'test_helper'
+
+class Sinatra::Sprockets::DevelopmentServerTest < MiniTest::Test
+  def app
+    mock_base_app do
+      # Set the app root manually
+      set :root, File.expand_path('test/app')
+      # Set enviroment before register the extension
+      set :environment, :development
+      register ::Sinatra::Sprockets
+    end
+  end
+
+  def test_assets_request_on_development
+    get('/assets/application.js')
+    assert last_response.ok?
+    assert_match /var app = {}/,    last_response.body, "Javascript did not required self"
+    assert_match /var other = {}/,  last_response.body, "Javascript did not required tree"
+    
+    get('/assets/application.css')
+    assert last_response.ok?
+    assert_match /body{}/,          last_response.body, "Stylesheet did not required self"
+    assert_match /.other{}/,        last_response.body, "Stylesheet did not required tree"
+  end
+end
+
+class Sinatra::Sprockets::ProductionServerTest < MiniTest::Test
+  def app
+    mock_app do
+      set :environment, :production
+    end
+  end
+
+  def test_assets_request_on_development
+    get('/assets/application.js')
+    assert_equal 404, last_response.status
+  end
+end

data/test/sinatra/sprockets/task_test.rb

@@ -0,0 +1,45 @@
+
+require 'test_helper'
+
+class Sprockets::Manifest
+  # Remove output from Sprockets tasks
+  def logger
+    @logger ||= Logger.new($stdout)
+    @logger.level = Logger::FATAL
+    @logger
+  end
+end
+
+class Sinatra::Sprockets::TasksHelper < MiniTest::Test
+  def test_order
+    :alpha
+  end
+  
+  def test_task_definition
+    assert_includes rake.tasks.map!(&:name), "assets:precompile"
+    assert_includes rake.tasks.map!(&:name), "assets:clobber"
+    assert_includes rake.tasks.map!(&:name), "assets:clean"
+  end
+
+  def test_0_precompile_task
+    rake["assets:precompile"].invoke
+    assert File.directory?(File.join(app.public_folder, app.assets_prefix))
+    # Ensure every file was precompiled
+    Dir['test/app/assets/**/*'].each do |file|
+      file = file[16...file.length]
+      path = app.sprockets[file].digest_path
+      path = File.join(app.public_folder, app.assets_prefix, path)
+      assert File.exists?(path)
+    end
+    # Ensure manifest file was created
+    manifest_file = ::Sprockets::Manifest.new(app.sprockets, 
+      File.join(app.public_folder, app.assets_prefix))
+    File.exists?(manifest_file.path)
+  end
+
+  def test_1_clobber_task
+    # Remove the compile directory
+    rake["assets:clobber"].invoke
+    refute File.directory?(File.join(app.public_folder, app.assets_prefix))
+  end
+end

data/test/sinatra/sprockets_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class Sinatra::SprocketsTest < MiniTest::Test
+  def test_start_the_sprockets_environmet
+    assert_instance_of Sprockets::Environment, app.sprockets
+    assert_equal app.root, app.sprockets.root
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,32 @@
+ENV['RACK_ENV'] = 'test'
+require 'app/mock'
+require 'rack/test'
+require 'minitest/autorun'
+
+class MiniTest::Test
+  include Rack::Test::Methods
+
+  def app
+    Mock
+  end
+
+  def mock_app(&block)
+    Class.new(Mock, &block)
+  end
+
+  def mock_base_app(&block)
+     Class.new(Sinatra::Base, &block)
+  end
+
+  def rake
+    require 'rake'
+    @rake ||= lambda {
+      rake = Rake::Application.new
+      Rake.application = rake
+      Rake::Task.define_task(:environment)
+      # Define the task
+      ::Sinatra::Sprockets::Task.define(app)
+      return rake
+    }.call
+  end
+end

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: sinatra-sprockets-chain
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Edson Hilios
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sprockets
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.10.0
+- !ruby/object:Gem::Dependency
+  name: sprockets-helpers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Plug and play extension for sinatra that mimic rails assets pipeline
+  through sprockets
+email:
+- edson.hilios@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- lib/sinatra/sprockets/helpers.rb
+- lib/sinatra/sprockets/server.rb
+- lib/sinatra/sprockets/task.rb
+- lib/sinatra/sprockets/version.rb
+- lib/sinatra/sprockets.rb
+- lib/sinatra-sprockets-chain.rb
+- test/app/assets/application.css
+- test/app/assets/application.js
+- test/app/assets/image.gif
+- test/app/assets/other.css
+- test/app/assets/other.js
+- test/app/mock.rb
+- test/sinatra/sprockets/helpers_test.rb
+- test/sinatra/sprockets/server_test.rb
+- test/sinatra/sprockets/task_test.rb
+- test/sinatra/sprockets_test.rb
+- test/test_helper.rb
+homepage: https://github.com/hilios/sinatra-sprockets
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Plug and play extension for sinatra that mimic rails assets pipeline through
+  sprockets
+test_files:
+- test/app/assets/application.css
+- test/app/assets/application.js
+- test/app/assets/image.gif
+- test/app/assets/other.css
+- test/app/assets/other.js
+- test/app/mock.rb
+- test/sinatra/sprockets/helpers_test.rb
+- test/sinatra/sprockets/server_test.rb
+- test/sinatra/sprockets/task_test.rb
+- test/sinatra/sprockets_test.rb
+- test/test_helper.rb