sinatra-sprockets-ext 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sinatra-sprockets.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Andrew Marshall
+
+MIT License
+
+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,47 @@
+# Sinatra::Sprockets
+
+Sinatra extension for Sprockets integration.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sinatra-sprockets-ext', :require => 'sinatra/sprockets'
+
+Currently requires 1.9 (1.8 is near end-of-life anyway).
+
+## Usage
+
+Register the plugin in your `app.rb`:
+
+    register Sinatra::Sprockets
+
+In your `config.ru`, add a mapping for Sprockets:
+
+    map "/#{Sinatra::Sprockets.config.prefix}" do
+      run Sinatra::Sprockets.environment
+    end
+
+Optionally configure as needed. Configuration is similar to Rails's Asset Pipeline.
+Below is an example configuration with some options showing the default values:
+
+    Sinatra::Sprockets.configure do |config|
+      config.compile = false         # On-the-fly compilation
+      config.compress = false        # Compress assets
+      config.digest = false          # Append a digest to URLs
+      config.css_compressor = false  # CSS compressor instance
+      config.js_compressor = false   # JS compressor instance
+    end
+
+All options and their defaults are shown in `lib/sinatra-sprockets/configuration.rb`.
+
+You'll also get helper functions that will be familiar to those who use Rails:
+
+- `javascript_include_tag :asset_name`
+- `stylesheet_link_tag :asset_name`
+- `asset_path :asset_name`
+
+## Credits & License
+
+Copyright ©2012 J. Andrew Marshall. All rights reserved.
+License is available in the LICENSE file.

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/sinatra/sprockets/asset_paths.rb

@@ -0,0 +1,134 @@
+module Sinatra::Sprockets
+  module Helpers
+    class AssetPaths
+      class AssetNotPrecompiledError < StandardError; end
+
+      def initialize config
+        @config = config
+      end
+
+      def asset_for(source, ext)
+        source = source.to_s
+        return nil if is_uri?(source)
+        source = rewrite_extension(source, nil, ext)
+        asset_environment[source]
+      rescue Sprockets::FileOutsidePaths
+        nil
+      end
+
+      def digest_for(logical_path)
+        if @config.digest && @config.digests && (digest = @config.digests[logical_path])
+          return digest
+        end
+
+        if @config.compile
+          if @config.digest && asset = asset_environment[logical_path]
+            return asset.digest_path
+          end
+          return logical_path
+        else
+          raise AssetNotPrecompiledError.new("#{logical_path} isn't precompiled")
+        end
+      end
+
+      def rewrite_asset_path(source, dir, options = {})
+        if source[0] == ?/
+          source
+        else
+          source = digest_for(source) unless options[:digest] == false
+          source = File.join(dir, source)
+          source = "/#{source}" unless source =~ /^\//
+          source
+        end
+      end
+
+      def rewrite_extension(source, dir, ext)
+        if ext && File.extname(source) != ".#{ext}"
+          "#{source}.#{ext}"
+        else
+          source
+        end
+      end
+
+      def compute_public_path(source, dir, options = {})
+        source = source.to_s
+        unless is_uri?(source)
+          source = rewrite_extension(source, dir, options[:ext]) if options[:ext]
+          source = rewrite_asset_path(source, dir, options)
+          source = rewrite_relative_url_root(source, @config.relative_url_root)
+          source = rewrite_host_and_protocol(source, options[:protocol])
+        end
+        source
+      end
+
+      def is_uri?(path)
+        path =~ %r{^[-a-z]+://|^cid:|^//}
+      end
+
+      def rewrite_host_and_protocol(source, protocol = nil)
+        host = compute_asset_host(source)
+        if host && !is_uri?(host)
+          if (protocol || default_protocol) == :request && !has_request?
+            host = nil
+          else
+            host = "#{compute_protocol(protocol)}#{host}"
+          end
+        end
+        host ? "#{host}#{source}" : source
+      end
+
+      def rewrite_relative_url_root(source, relative_url_root)
+        relative_url_root && !source.starts_with?("#{relative_url_root}/") ? "#{relative_url_root}#{source}" : source
+      end
+
+      def compute_asset_host(source)
+        if host = @config.host
+          if host.respond_to?(:call)
+            args = [source]
+            arity = arity_of(host)
+            if arity > 1 && request.nil?
+              invalid_asset_host!("Remove the second argument to your asset_host Proc if you do not need the request.")
+            end
+            args << current_request if (arity > 1 || arity < 0) && has_request?
+            host.call(*args)
+          else
+            (host =~ /%d/) ? host % (Zlib.crc32(source) % 4) : host
+          end
+        end
+      end
+
+      def default_protocol
+        @config.default_protocol || (request.nil?? :relative : :request)
+      end
+
+      def compute_protocol(protocol)
+        protocol ||= default_protocol
+        case protocol
+        when :request
+          if request.nil?
+            invalid_asset_host!("The protocol requested was :request. Consider using :relative instead.")
+          end
+          request.protocol
+        when :relative
+          "//"
+        else
+          "#{protocol}://"
+        end
+      end
+
+      def arity_of(callable)
+        callable.respond_to?(:arity) ? callable.arity : callable.method(:call).arity
+      end
+
+      def invalid_asset_host!(help_message)
+        raise ActionController::RoutingError, "This asset host cannot be computed without a request in scope. #{help_message}"
+      end
+
+      private
+
+      def asset_environment
+        Sinatra::Sprockets.environment
+      end
+    end
+  end
+end

data/lib/sinatra/sprockets/configuration.rb

@@ -0,0 +1,28 @@
+module Sinatra::Sprockets
+  DEFAULT_OPTIONS = {
+    app: nil,
+    debug: false,
+    digest: false,
+    compile: false,
+    compress: false,
+    host: nil,
+    manifest_path: 'public/assets',
+    paths: %w[images javascripts stylesheets],
+    precompile: [ /\w+\.(?!js|css).+/, /application.(css|js)$/ ],
+    prefix: 'assets',
+    relative_url_root: ENV['RACK_RELATIVE_URL_ROOT'],
+    css_compressor: false,
+    js_compressor: false
+  }
+
+  class Configuration < Struct.new(*DEFAULT_OPTIONS.keys)
+    attr_accessor *DEFAULT_OPTIONS.keys, :digests
+
+    def initialize
+      DEFAULT_OPTIONS.each do |key, value|
+        send "#{key}=".to_sym, value
+      end
+      @digests = {}
+    end
+  end
+end

data/lib/sinatra/sprockets/helpers.rb

@@ -0,0 +1,78 @@
+module Sinatra::Sprockets
+  module Helpers
+    def asset_path source, options = {}
+        source = source.logical_path if source.respond_to?(:logical_path)
+        path = asset_paths.compute_public_path(source, config.prefix, options.merge(:body => true))
+        options[:body] ? "#{path}?body=1" : path
+    end
+
+    def image_path source, options = {}
+      asset_path source, { dir: 'images' }.merge(options)
+    end
+
+    def javascript_path source, options = {}
+      asset_path source, { dir: 'javascripts', ext: 'js' }.merge(options)
+    end
+
+    def stylesheet_path source, options = {}
+      asset_path source, { dir: 'stylesheets', ext: 'css' }.merge(options)
+    end
+
+    def javascript_include_tag(*sources)
+      debug   = config.debug
+      body    = false
+      digest  = config.digest
+
+      sources.collect do |source|
+        if debug && asset = asset_paths.asset_for(source, 'js')
+          asset.to_a.map do |dep|
+            src = asset_path(dep, :ext => 'js', :body => true, :digest => digest)
+            "<script src=#{src} type='application/javascript'></script>"
+          end
+        else
+          src = asset_path(source, :ext => 'js', :body => body, :digest => digest)
+          "<script src=#{src} type='application/javascript'></script>"
+        end
+      end.join("\n")
+    end
+
+    def stylesheet_link_tag(*sources)
+      options = {}
+      debug   = config.debug
+      body    = false
+      digest  = config.digest
+
+      sources.collect do |source|
+        if debug && asset = asset_paths.asset_for(source, 'css')
+          asset.to_a.map do |dep|
+            href = asset_path(dep, :ext => 'css', :body => true, :protocol => :request, :digest => digest)
+            "<link href='#{href}' media='screen' rel='stylesheet', type='text/css' />"
+          end
+        else
+          href = asset_path(source, :ext => 'css', :body => body, :protocol => :request, :digest => digest)
+          "<link href='#{href}' media='screen' rel='stylesheet', type='text/css' />"
+        end
+      end.join("\n")
+    end
+
+    def asset_path(source, options={})
+      source = source.logical_path if source.respond_to?(:logical_path)
+      path = asset_paths.compute_public_path(source, config.prefix, options.merge(:body => true))
+      options[:body] ? "#{path}?body=1" : path
+    end
+
+    private
+
+    def assets_environment
+      Sinatra::Sprockets.environment
+    end
+
+    def asset_paths
+      @asset_paths ||= AssetPaths.new Sinatra::Sprockets.config
+    end
+
+    def config
+      Sinatra::Sprockets.config
+    end
+  end
+end

data/lib/sinatra/sprockets/static_compiler.rb

@@ -0,0 +1,61 @@
+require 'fileutils'
+
+module Sinatra::Sprockets
+  class StaticCompiler
+    attr_accessor :env, :target, :paths
+
+    def initialize(env, target, paths, options = {})
+      @env = env
+      @target = target
+      @paths = paths
+      @digest = options.key?(:digest) ? options.delete(:digest) : true
+      @manifest = options.key?(:manifest) ? options.delete(:manifest) : true
+      @manifest_path = options.delete(:manifest_path) || target
+    end
+
+    def compile
+      manifest = {}
+      env.each_logical_path do |logical_path|
+        next unless compile_path?(logical_path)
+        if asset = env.find_asset(logical_path)
+          manifest[logical_path] = write_asset(asset)
+        end
+      end
+      write_manifest(manifest) if @manifest
+    end
+
+    def write_manifest(manifest)
+      FileUtils.mkdir_p(@manifest_path)
+      File.open("#{@manifest_path}/manifest.yml", 'wb') do |f|
+        YAML.dump(manifest, f)
+      end
+    end
+
+    def write_asset(asset)
+      path_for(asset).tap do |path|
+        filename = File.join(target, path)
+        FileUtils.mkdir_p File.dirname(filename)
+        asset.write_to(filename)
+        asset.write_to("#{filename}.gz") if filename.to_s =~ /\.(css|js)$/
+      end
+    end
+
+    def compile_path?(logical_path)
+      paths.each do |path|
+        case path
+        when Regexp
+          return true if path.match(logical_path)
+        when Proc
+          return true if path.call(logical_path)
+        else
+          return true if File.fnmatch(path.to_s, logical_path)
+        end
+      end
+      false
+    end
+
+    def path_for(asset)
+      @digest ? asset.digest_path : asset.logical_path
+    end
+  end
+end

data/lib/sinatra/sprockets/version.rb

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

data/lib/sinatra/sprockets.rb

@@ -0,0 +1,41 @@
+require "sinatra/sprockets/version"
+require "sinatra/sprockets/asset_paths"
+require "sinatra/sprockets/configuration"
+require "sinatra/sprockets/helpers"
+
+module Sinatra
+  module Sprockets
+    def self.configure
+      yield config
+    end
+
+    def self.config
+      @config ||= Configuration.new
+    end
+
+    def self.environment
+      @environment
+    end
+
+    def self.registered app
+      config.app = app
+
+      @environment = ::Sprockets::Environment.new app.root
+
+      config.paths.each do |path|
+        environment.append_path File.join(config.app.root, config.prefix, path)
+        environment.append_path File.join(config.app.root, 'lib', config.prefix, path)
+      end
+
+      if config.compress
+        environment.css_compressor = config.css_compressor
+        environment.js_compressor = config.js_compressor
+      end
+
+      app.helpers Helpers
+      environment.context_class.instance_eval do
+        include Helpers
+      end
+    end
+  end
+end

data/sinatra-sprockets.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/sinatra/sprockets/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Andrew Marshall"]
+  gem.email         = ["andrew@johnandrewmarshall.com"]
+  gem.description   = %q{Sinatra plugin for Sprockets integration}
+  gem.summary       = %q{Sinatra plugin for Sprockets integration}
+  gem.homepage      = "http://johnandrewmarshall.com/projects/sinatra-sprockets"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "sinatra-sprockets-ext"
+  gem.require_paths = ["lib"]
+  gem.version       = Sinatra::Sprockets::VERSION
+
+  gem.add_dependency "sprockets"
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: sinatra-sprockets-ext
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Andrew Marshall
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sprockets
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Sinatra plugin for Sprockets integration
+email:
+- andrew@johnandrewmarshall.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/sinatra/sprockets.rb
+- lib/sinatra/sprockets/asset_paths.rb
+- lib/sinatra/sprockets/configuration.rb
+- lib/sinatra/sprockets/helpers.rb
+- lib/sinatra/sprockets/static_compiler.rb
+- lib/sinatra/sprockets/version.rb
+- sinatra-sprockets.gemspec
+homepage: http://johnandrewmarshall.com/projects/sinatra-sprockets
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Sinatra plugin for Sprockets integration
+test_files: []
+has_rdoc: