padrino-assets 0.2.2 → 0.3.0

data/.gitignore

@@ -1,4 +1,6 @@
-*.gem
-.bundle
-Gemfile.lock
-pkg/*
+*.gem
+archive/*
+doc/*
+.yardoc
+.bundle
+Gemfile.lock

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,7 @@
+lang: ruby
+script: rspec
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - jruby
+  - ruby-head

data/.yardopts

@@ -0,0 +1,10 @@
+--no-save
+--no-private
+--title Padrino Assets
+--markup-provider redcarpet
+--markup markdown
+lib/**/*.rb
+-
+README.md
+CHANGELOG.md
+LICENSE

data/CHANGELOG.md

@@ -1,9 +1,12 @@
-# Version History
-
-### 0.2.0 - (January 17, 2012)
-* The current `request` is now passed to **:assets_host** when a `Proc` is used
-* Added the rake task `assets:compress` for [deflating](http://en.wikipedia.org/wiki/Gzip) assets
-* Basic support for asset minification
-
-### 0.1.0 - (January 12, 2012)
+# Version History
+
+### 0.3.0 - IN DEVELOPMENT
+* Now uses [Sprockets](https://github.com/sstephenson/sprockets) `context_class` in-order to make helpers available to all assets
+
+### 0.2.0 - (January 17, 2012)
+* The current `request` is now passed to **:assets_host** when a `Proc` is used
+* Added the rake task `assets:compress` for [deflating](http://en.wikipedia.org/wiki/Gzip) assets
+* Basic support for asset minification
+
+### 0.1.0 - (January 12, 2012)
 * Initial release

data/Gemfile

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

data/LICENSE

@@ -1,19 +1,19 @@
-Copyright (c) 2012 Benjamin Bloch
-
-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
+Copyright (c) 2012 Benjamin Bloch
+
+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

@@ -1,64 +1,126 @@
-# Padrino Assets
-
-### Overview
-
-Padrino assets is a plugin for the [Padrino](https://github.com/padrino/padrino-framework) web framework which makes use of the [Rack](https://github.com/rack/rack) plugin [Sprockets](https://github.com/sstephenson/sprockets) to manage and compile web assets.
-
-### Setup & Installation
-
-Include it in your project's `Gemfile` with Bundler:
-
-``` ruby
-gem 'padrino-assets'
-```
-
-Modify your `app/app.rb` file to register the plugin:
-
-``` ruby
-class ExampleApplication < Padrino::Application
-  register Padrino::Assets
-end
-```
-
-Modify your `config.ru` file to mount the environment:
-
-``` ruby
-map '/assets' do
-  run Padrino::Assets.environment
-end
-```
-
-By default, Sprockets is configured to load assets from your project's `app/assets` and `lib/assets` directories. Any files stored in these directories are readily available to the included helpers and will be served by the Sprockets middleware.
-
-Because of this the following directories are no longer used and will instead be served statically:
-
-* `public/images`
-* `public/stylesheets`
-* `public/javascripts`
-
-You should now be storing your assets in the following directories:
-
-* `app/assets/images`
-* `app/assets/stylesheets`
-* `app/assets/javascripts`
-
-Should your project need to add additional paths you can do so by adding the following line:
-
-``` ruby
-Padrino::Assets.load_paths << 'path/to/my/assets'
-```
-
-### Dependencies
-
-* [Padrino-Core](https://github.com/padrino/padrino-framework) and [Padrino-Helpers](https://github.com/padrino/padrino-framework)
-* [Ruby](http://www.ruby-lang.org/en) >= 1.9.2
-* [Sprockets](https://github.com/sstephenson/sprockets)
-
-### TODO
-
-* Additional documentation
-* Tests
-
-### Copyright
-
-Copyright © 2012 Benjamin Bloch (Cirex). See LICENSE for details.
+# Padrino Assets
+
+Overview
+--------
+
+Padrino assets is a plugin for the [Padrino](https://github.com/padrino/padrino-framework) web framework which uses [Sprockets](https://github.com/sstephenson/sprockets) to manage and compile web assets.
+
+Setup & Installation
+--------------------
+
+Include it in your project's `Gemfile`
+
+``` ruby
+gem 'padrino-assets'
+```
+
+Modify your `app/app.rb` file to register the plugin:
+
+``` ruby
+class ExampleApplication < Padrino::Application
+  register Padrino::Assets
+end
+```
+* __Note:__ Because `padrino-assets` overrides some existing helpers the above must be placed below `Padrino::Helpers`
+
+Modify your `config.ru` file to mount the environment:
+
+``` ruby
+map '/assets' do
+  run Padrino::Assets.environment
+end
+```
+
+By default, Sprockets is configured to load assets from your project's `app/assets` and `lib/assets` directories. Any files stored in these directories are readily available to the included helpers, and will be served by the Sprockets middleware.
+
+Because of this the following directories are no longer used, and will be served statically:
+
+* public/images
+* public/stylesheets
+* public/javascripts
+
+You should now be storing your assets in the following directories:
+
+* app/assets/images
+* app/assets/stylesheets
+* app/assets/javascripts
+
+Should your project need to add additional paths you can easily do so by adding the following line:
+
+``` ruby
+Padrino::Assets.load_paths << 'path/to/my/assets'
+```
+
+Configuration
+-------------
+
+Although the defaults are enough to get you started. There are several configuration options available to further customize this plugin to your project's personal needs. The following options can be changed at anytime with `set`, `enable`, or `disable`.
+
+#### :assets_host
+Is the URL to the external server currently hosting your assets. Generally, you only set this option if you want to host your assets on a separate server or service such as Amazon S3.
+
+When a `Proc` is used, the current asset, and request will be passed to it as arguments:
+
+``` ruby
+set :assets_hosts, ->(asset, request) do
+  if request.ssl?
+    'https://secure.assets.com'
+  else
+    'http://assets.com'
+  end
+end
+```
+
+Of course if you don't need anything flashy a string will suffice:
+
+``` ruby
+set :assets_host, 'http://assets.com'
+```
+
+#### :compress_assets
+If enabled, will automatically compress, and gzip your assets to save server bandwidth.
+Due to the Java dependencies, and the lack of a suitable pure Ruby alternative, a default compressor is not __currently__ provided.
+
+#### :precompile_assets
+Is an array of assets that will be compiled when the task `assets:precompile` is run.
+Once compiled, an MD5 checksum is calculated and inserted into the file name.
+This checksum serves as a way to version your assets so that they can be properly cached by web browsers.
+
+To filter which assets are compiled you have a few options. As an example, using a regular expression:
+
+``` ruby
+set :precompile_assets, [/^\w\.(?!(?:css|js)$)/i]
+```
+
+The above would compile all assets that do not have the extension `.css` or `.js`.
+
+Or if you prefer, a collection of files would work too:
+
+``` ruby
+set :precompile_assets, [
+  'jquery.js',
+  'jquery.unobtrusive.js',
+  'application.css',
+  'pony.jpg'
+]
+```
+
+If you are deploying to a production environment it is recommended that you precompile your assets so that they can be statically served by your web server. In a development environment, your assets will be compiled with every request.
+
+Dependencies
+------------
+
+* [Padrino-Core](https://github.com/padrino/padrino-framework)
+* [Padrino-Helpers](https://github.com/padrino/padrino-framework)
+* [Ruby](http://www.ruby-lang.org/en) >= 1.9.2
+* [Sprockets](https://github.com/sstephenson/sprockets)
+
+TODO
+----
+
+* Additional documentation
+
+Copyright
+---------
+
+Copyright &copy; 2012 Benjamin Bloch (Cirex). See LICENSE for details.

data/Rakefile

@@ -1,7 +1,30 @@
-require 'rake'
-require 'rake/testtask'
-
-Rake::TestTask.new do |test|
-  test.test_files = FileList['test/**/test_*.rb']
-  test.verbose = true
-end
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+require 'padrino-assets/version'
+
+require 'rake'
+require 'yard'
+require 'rspec'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new do |task|
+  task.pattern = 'spec/**/*_spec.rb'
+end
+
+YARD::Rake::YardocTask.new
+
+task :build do
+  `gem build padrino-assets.gemspec`
+end
+
+task :install => :build do
+  `gem install padrino-assets-#{Padrino::Assets::VERSION}.gem`
+end
+
+desc 'Releases the current version into the wild'
+task :release => :build do
+  `git tag -a v#{Padrino::Assets::VERSION} -m "Version #{Padrino::Assets::VERSION}"`
+  `gem push padrino-assets-#{Padrino::Assets::VERSION}.gem`
+  `git push --tags`
+end
+
+task :default => :spec

data/lib/padrino-assets.rb

@@ -1,91 +1,154 @@
-require 'padrino-core'
-require 'padrino-helpers'
-
-FileSet.glob_require('padrino-assets/**/*.rb', __FILE__)
-
-module Padrino
-  module Assets
-    class << self
-      ##
-      # Returns a list of paths Sprockets will use in order to find assets used by the project
-      #
-      # @return [Array]
-      #   List of assets paths
-      #
-      # @example
-      #   Padrino::Assets.load_paths << Padrino.root('vendor', '**', 'assets')
-      #
-      # @since 0.1.0
-      # @api public
-      def load_paths
-        @_load_paths ||= ['app/assets/**', 'lib/assets/**'].map do |file|
-          Dir[Padrino.root(file)]
-        end.flatten
-      end
-
-      ##
-      # Returns the configured Sprockets environment
-      #
-      # @return [Sprockets::Environment]
-      #   Sprockets environment
-      #
-      # @since 0.1.0
-      # @api public
-      def environment
-        @_environment
-      end
-
-      ##
-      # Returns a compiled manifest of our assets
-      #
-      # @return [Sprockets::Manifest]
-      #   Sprockets manifest
-      #
-      # @since 0.1.0
-      # @api public
-      def manifest
-        @_manifest
-      end
-
-      # @private
-      def registered(app)
-        app.helpers Helpers
-        app.set :assets_prefix,   '/assets'
-        app.set :assets_version,  1.0
-        app.set :assets_host,     nil
-        app.set :compress_assets, true
-        app.set :js_compressor,   nil
-        app.set :css_compressor,  nil
-        app.set :index_assets,    -> { app.environment == :production }
-        app.set :manifest_file,   -> { File.join(app.public_folder, app.assets_prefix, 'manifest.json') }
-        app.set :precompile_assets,  [ /^.+\.(?!js|css).+$/i, /^application\.(js|css)$/i ]
-
-        require 'sprockets'
-
-        Padrino.after_load do
-          @_environment = Sprockets::Environment.new(app.root) do |environment|
-            environment.logger  = app.logger
-            environment.version = app.assets_version
-            if defined?(Padrino::Cache)
-              if app.respond_to?(:caching) && app.caching?
-                environment.cache = app.cache
-              end
-            end
-
-            if app.compress_assets?
-              environment.js_compressor  = app.js_compressor
-              environment.css_compressor = app.css_compressor
-            end
-          end
-
-          load_paths.each { |path| environment.append_path(path) }
-
-          @_environment = environment.index if app.index_assets?
-          @_manifest = Sprockets::Manifest.new(environment, app.manifest_file)
-        end
-
-        Padrino::Tasks.files << Dir[File.dirname(__FILE__) + '/tasks/**/*.{rake,rb}']
-      end
-    end
-  end
-end
+# encoding: utf-8
+require 'padrino-core'
+require 'padrino-helpers'
+
+FileSet.glob_require('padrino-assets/**/*.rb', __FILE__)
+
+module Padrino
+  module Assets
+    class << self
+      ###
+      # Returns a list of paths Sprockets will use in order to find assets used by the project
+      #
+      # @return [Array]
+      #   List of assets paths
+      #
+      # @example
+      #   Padrino::Assets.load_paths << Dir[Padrino.root('vendor', '**', 'assets')]
+      #
+      # @since 0.1.0
+      # @api public
+      def load_paths
+        @_load_paths ||= ['app/assets/**', 'lib/assets/**'].map do |directory|
+          Dir[Padrino.root(directory)]
+        end.flatten
+      end
+
+      ###
+      # Returns the configured Sprockets environment
+      #
+      # @return [Sprockets::Environment]
+      #   Sprockets environment
+      #
+      # @see https://github.com/sstephenson/sprockets/blob/master/lib/sprockets/environment.rb
+      #
+      # @since 0.1.0
+      # @api public
+      def environment
+        @_environment
+      end
+
+      ###
+      # Returns a compiled manifest of our assets
+      #
+      # @return [Sprockets::Manifest]
+      #   Sprockets manifest
+      #
+      # @see https://github.com/sstephenson/sprockets/blob/master/lib/sprockets/manifest.rb
+      #
+      # @since 0.1.0
+      # @api public
+      def manifest
+        @_manifest
+      end
+
+      ###
+      # Returns a list of available asset compressors
+      #
+      # @return [Hash]
+      #   List of available asset compressors
+      #
+      # @since 0.3.0
+      # @api public
+      def compressors
+        @_compressors ||= Hash.new { |k, v| k[v] = Hash.new }
+      end
+
+      ###
+      # Registers an asset compressor for use with Sprockets
+      #
+      # @param [Symbol] type
+      #   The type of compressor you are registering (:js, :css)
+      #
+      # @example
+      #   Padrino::Assets.register_compressor :js,  :simple => 'SimpleCompressor'
+      #   Padrino::Assets.register_compressor :css, :simple => 'SimpleCompressor'
+      #
+      # @since 0.3.0
+      # @api public
+      def register_compressor(type, compressor)
+        compressors[type].merge!(compressor)
+      end
+
+      # @since 0.3.0
+      # @api private
+      def find_registered_compressor(type, compressor)
+        return compressor unless compressor.is_a?(Symbol)
+
+        if compressor = compressors[type][compressor]
+           compressor = compressor.safe_constantize
+        end
+
+        compressor.respond_to?(:new) ? compressor.new : compressor
+      end
+
+      # @private
+      def registered(app)
+        app.helpers Helpers
+        app.set :assets_prefix,   '/assets'
+        app.set :assets_version,  1.0
+        app.set :assets_host,     nil
+        app.set :compress_assets, true
+        app.set :js_compressor,   nil
+        app.set :css_compressor,  nil
+        app.set :index_assets,    -> { app.environment == :production }
+        app.set :manifest_file,   -> { File.join(app.public_folder, app.assets_prefix, 'manifest.json') }
+        app.set :precompile_assets,  [ /^\w+\.(?!(?:js|css)$)/i, /^application\.(js|css)$/i ]
+
+        # FIXME: Temporary fix for `padrino start`
+        app.get '/assets/*' do
+          env['PATH_INFO'].gsub!('/assets', '')
+          Padrino::Assets.environment.call(env)
+        end
+
+        Padrino.after_load do
+          require 'sprockets'
+
+          environment = Sprockets::Environment.new(Padrino.root)
+
+          environment.logger  = app.logger
+          environment.version = app.assets_version
+
+          if defined?(Padrino::Cache)
+            if app.respond_to?(:caching) && app.caching?
+              environment.cache = app.cache
+            end
+          end
+
+          if app.compress_assets?
+            environment.js_compressor  = find_registered_compressor(:js,  app.js_compressor)
+            environment.css_compressor = find_registered_compressor(:css, app.css_compressor)
+          end
+
+          load_paths.flatten.each do |path|
+            environment.append_path(path)
+          end
+
+          environment.context_class.class_eval do
+            include Helpers
+          end
+
+          @_environment = app.index_assets ? environment.index : environment
+          @_manifest    = Sprockets::Manifest.new(@_environment, app.manifest_file)
+        end
+
+        Padrino::Tasks.files << Dir[File.dirname(__FILE__) + '/tasks/**/*.rake']
+      end
+    end
+
+    register_compressor :css, :yui      => 'YUI::CssCompressor'
+    register_compressor :js,  :yui      => 'YUI::JavaScriptCompressor'
+    register_compressor :js,  :closure  => 'Closure::Compiler'
+    register_compressor :js,  :uglifier => 'Uglifier'
+  end # Assets
+end # Padrino