padrino-assets 0.1.0

data/.gitignore

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

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+# Version History
+
+### 0.1.0 - (January 12, 2012)
+* Initial release

data/Gemfile

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

data/LICENSE

@@ -0,0 +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
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,45 @@
+# 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
+```
+
+### 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
+
+* Support for CSS/Javascript minification
+* Additional documentation
+* Tests
+
+### Copyright
+
+Copyright © 2012 Benjamin Bloch (Cirex). See LICENSE for details.

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/examples/nginx.md

@@ -0,0 +1,11 @@
+Nginx Configuration Example
+=============================
+
+``` nginx
+location ~ ^/(assets)/  {
+  add_header Cache-Control public;
+  root /path/to/public;
+  gzip_static on;
+  expires max;
+}
+```

data/lib/padrino-assets.rb

@@ -0,0 +1,81 @@
+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')
+      #
+      # @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
+      #
+      # @api public
+      def environment
+        @_environment
+      end
+
+      ##
+      # Returns a compiled manifest of our assets
+      #
+      # @return [Sprockets::Manifest]
+      #   Sprockets manifest
+      #
+      # @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 :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
+          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

data/lib/padrino-assets/helpers.rb

@@ -0,0 +1,372 @@
+module Padrino
+  module Assets
+    module Helpers
+      ##
+      # Returns an HTML stylesheet link tag for the specified sources
+      #
+      # @overload include_stylesheet(sources, options = {})
+      #   @param [Array<String, Symbol>] sources
+      #     Sources
+      #   @param [Hash] options
+      #     HTML options
+      #   @option options [String] :media ('screen')
+      #     Specifies the type of device the linked document is optimized for
+      #
+      # @return [String]
+      #   Stylesheet link tag for +sources+ with specified +options+.
+      #
+      # @example
+      #   include_stylesheets :application, :theme
+      #   # => <link href="/assets/application.css" media="screen" rel="stylesheet" type="text/css">
+      #   # => <link href="/assets/theme.css" media="screen" rel="stylesheet" type="text/css">
+      #
+      #   include_stylesheet :handheld, media: 'handheld'
+      #   # => <link href="/assets/handheld.css" media="handheld" rel="stylesheet" type="text/css">
+      #
+      #   include_stylesheet 'http://www.example.com/style.css'
+      #   # => <link href="http://www.example.com/style.css" media="screen" rel="stylesheet" type="text/css">
+      #
+      # @since 0.1.0
+      # @api public
+      def include_stylesheet(*sources)
+        options = sources.extract_options!.symbolize_keys
+        options.reverse_merge!(media: 'screen', rel: 'stylesheet', type: 'text/css')
+        sources.collect do |source|
+          tag(:link, options.reverse_merge(href: asset_path(source, :css)))
+        end.join("\n")
+      end
+      alias_method :include_stylesheets,    :include_stylesheet
+      alias_method :stylesheet_include_tag, :include_stylesheet
+
+      ##
+      # Returns an HTML script tag for the specified sources
+      #
+      # @overload include_javascript(sources, options={})
+      #   @param [Array<String, Symbol>] sources
+      #     Sources
+      #   @param [Hash] options
+      #     HTML options
+      #
+      # @return [String]
+      #   Script tag for +sources+ with specified +options+.
+      #
+      # @example
+      #   include_javascript :application, :jquery
+      #   # => <script type="text/javascript" src="/assets/application.js"></script>
+      #   # => <script type="text/javascript" src="/assets/jquery.js"></script>
+      #
+      #   include_javascript 'http://www.example.com/application.js'
+      #   # => <script type="text/javascript" src="http://www.example.com/application.js"></script>
+      #
+      # @since 0.1.0
+      # @api public
+      def include_javascript(*sources)
+        options = sources.extract_options!.symbolize_keys
+        options.reverse_merge!(type: 'text/javascript', content: '')
+        sources.collect do |source|
+          tag(:script, options.reverse_merge(src: asset_path(source, :js)))
+        end.join("\n")
+      end
+      alias_method :include_javascripts,    :include_javascript
+      alias_method :javascript_include_tag, :include_javascript
+
+      ##
+      # Returns an HTML image element with given sources and options
+      #
+      # @overload image(sources, options={})
+      #   @param [String] source
+      #     Sources
+      #   @param [Hash] options
+      #     HTML options
+      #   @option options [String] :id
+      #     Specifies the identifier of the image
+      #   @option options [String] :class
+      #     Specifies the class of the image
+      #   @option options [String] :size
+      #     Specifies the width and height of the image
+      #   @option options [Integer] :width
+      #     Specifies the width of the image
+      #   @option options [Integer] :height
+      #     Specifies the height of the image
+      #   @option options [String] :alt
+      #     Specifies an alternate text for an image
+      #
+      # @return [String]
+      #   Image tag with +url+ and specified +options+.
+      #
+      # @example
+      #   image 'example.png'
+      #   # => <img src="/assets/example.png" alt="Example" />
+      #
+      #   image 'example.png', size: '40x40'
+      #   # => <img src="/assets/example.png" width="40" height="40" alt="Example" />
+      #
+      #   image 'example.png', width: 40
+      #   # => <img src="/assets/example.png" width="40" alt="Example" />
+      #
+      #   image 'example.png', height: 40
+      #   # => <img src="/assets/example.png" height="40" alt="Example" />
+      #
+      #   image 'example.png', alt: 'My Little Pony'
+      #   # => <img src="/assets/example.png" alt="My Little Pony" />
+      #
+      #   image 'http://www.example.com/example.png'
+      #   # => <img src="http://www.example.com/example.png" />
+      #
+      #   images 'example.png', 'example.jpg'
+      #   # => <img src="/assets/example.png" alt="Example" />
+      #   # => <img src="/assets/example.jpg" alt="Example" />
+      #
+      # @since 0.1.0
+      # @api public
+      def image(*sources)
+        options = sources.extract_options!.symbolize_keys
+
+        if size = options.delete(:size)
+          options[:width], options[:height] = size.split('x') if size =~ /^[0-9]+x[0-9]+$/
+        end
+
+        sources.collect do |source|
+          tag(:img, options.reverse_merge(src: asset_path(source)))
+        end.join("\n")
+      end
+      alias_method :images,    :image
+      alias_method :image_tag, :image
+
+      ##
+      # Return an HTML video element with given sources and options
+      #
+      # @overload video(sources, options={})
+      #   @param [Array<String>] sources
+      #     Sources
+      #   @param [Hash] options
+      #     HTML options
+      #   @option options [String] :id
+      #     Specifies the identifier of the video
+      #   @option options [String] :class
+      #     Specifies the class of the video
+      #   @option options [String] :size
+      #     Specifies the width and height of the video
+      #   @option options [Integer] :width
+      #     Specifies the width of the video
+      #   @option options [Integer] :height
+      #     Specifies the height of the video
+      #   @option options [String] :preload
+      #     Specifies the method the web browser should use to preload the video
+      #   @option options [String] :poster
+      #     Specifies an image to be shown while the video is downloading, or until the user hits the play button
+      #   @option options [Boolean] :controls
+      #     Should the video controls be shown if present
+      #   @option options [Boolean] :muted
+      #     Should the video automatically start off muted
+      #   @option options [Boolean] :autoplay
+      #     Should the video automatically play when it's ready
+      #   @option options [Boolean] :loop
+      #     Should the video automatically loop when it's done
+      #
+      # @return [String]
+      #   Video tag with +url+ and specified +options+
+      #
+      # @example
+      #   video 'example.webm'
+      #   # => <video src="/assets/example.webm" />
+      #
+      #   video 'example.webm', controls: true, autoplay: true
+      #   # => <video src="/assets/example.webm" controls="controls" autoplay="autoplay" />
+      #
+      #   video 'example.webm', loop: true
+      #   # => <video src="/assets/example.webm" loop="loop" />
+      #
+      #   video 'example.webm', size: '40x40'
+      #   # => <video src="/assets/example.webm" width="40" height="40" />
+      #
+      #   video 'example.webm', height: 40
+      #   # => <video src="/assets/example.webm" height="40" />
+      #
+      #   video 'example.webm', width: 40
+      #   # => <video src="/assets/example.webm" width="40" />
+      #
+      #   video 'http://www.example.com/example.webm'
+      #   # => <video src="http://www.example.com/example.webm" />
+      #
+      #   videos 'example.webm', 'example.mov'
+      #   # => <video>
+      #   # =>   <source src="/assets/example.webm" />
+      #   # =>   <source src="/assets/example.mov" />
+      #   # => </video>
+      #
+      # @since 0.1.0
+      # @api public
+      def video(*sources)
+        options = sources.extract_options!.symbolize_keys
+
+        if size = options.delete(:size)
+          options[:width], options[:height] = size.split('x') if size =~ /^[0-9]+x[0-9]+$/
+        end
+
+        if sources.is_a?(Array)
+          content_tag(:video, options) do
+            sources.collect { |source| tag(:source, src: asset_path(source)) }.join
+          end
+        else
+          tag(:video, options.reverse_merge(src: asset_path(sources)))
+        end
+      end
+      alias_method :videos,    :video
+      alias_method :video_tag, :video
+
+      ##
+      # Returns an HTML audio element with given sources and options
+      #
+      # @overload audio(sources, options={})
+      #   @param [Array<String>] sources
+      #     Sources
+      #   @param [Hash] options
+      #     HTML options
+      #   @option options [String] :id
+      #     Specifies the identifier of the audio
+      #   @option options [String] :class
+      #     Specifies the class of the audio
+      #   @option options [String] :preload
+      #     Specifies the method the web browser should use to preload the audio 
+      #   @option options [Boolean] :controls
+      #     Should the audio controls be shown if present
+      #   @option options [Boolean] :autoplay
+      #     Should the audio automatically play when it's ready
+      #   @option options [Boolean] :loop
+      #     Should the audio automatically loop when it's done
+      #
+      # @return [String]
+      #   Audio tag with +url+ and specified +options+
+      #
+      # @example
+      #   audio 'example.ogg'
+      #   # => <audio src="/assets/example.ogg" />
+      #
+      #   audio 'example.ogg', controls: true, autoplay: true
+      #   # => <audio src="/assets/example.ogg" controls="controls" autoplay="autoplay" />
+      #
+      #   audio 'example.ogg', loop: true
+      #   # => <audio src="/assets/example.ogg" loop="loop" />
+      #
+      #   audio 'http://www.example.com/example.ogg'
+      #   # => <audio src="http://www.example.com/example.ogg" />
+      #
+      #   audios 'example.ogg', 'example.mp4'
+      #   # => <audio>
+      #   # =>   <source src="/assets/example.ogg" />
+      #   # =>   <source src="/assets/example.mp4" />
+      #   # => </audio>
+      #
+      # @since 0.1.0
+      # @api public
+      def audio(*sources)
+        options = sources.extract_options!.symbolize_keys
+
+        if sources.is_a?(Array)
+          content_tag(:audio, options) do
+            sources.collect { |source| tag(:source, src: asset_path(source)) }.join
+          end
+        else
+          tag(:audio, options.reverse_merge(src: asset_path(sources)))
+        end
+      end
+      alias_method :audios,    :audio
+      alias_method :audio_tag, :audio
+
+      ##
+      # Determines whether or not the provided source is a valid URI
+      #
+      # @param [String] source
+      #   URI Source
+      #
+      # @return [Boolean]
+      #
+      # @example
+      #   is_uri?('http://www.example.com')
+      #   # => true
+      #
+      #   is_uri?('www.example.com')
+      #   # => false
+      #
+      #   is_uri?('//example.com')
+      #   # => true
+      #
+      #   is_uri?('/example/example.css')
+      #   # => true
+      #
+      # @since 0.1.0
+      # @api public
+      def is_uri?(source)
+        !!(source =~ %r(^[a-z]+://|^//?))
+      end
+
+      ##
+      # Returns a modified asset source based on the current application settings
+      #
+      # @overload asset_path(source, extension = nil)
+      #   @param [String] source
+      #     Source
+      #   @param [Symbol] extension (nil)
+      #     File extension
+      #
+      # @return [String]
+      #   Modified source based on application settings
+      #
+      # @example
+      #   asset_path('example.webm')
+      #   # => '/assets/example.webm'
+      #
+      #   asset_path('stylesheet', :css)
+      #   # => '/assets/stylesheet.css'
+      #
+      #   asset_path('http://www.example.com/stylesheet.css')
+      #   # => 'http://www.example.com/stylesheet.css'
+      #
+      # @since 0.1.0
+      # @api public
+      def asset_path(source, extension = nil)
+        return source if is_uri?(source)
+        source = source.to_s
+        source = rewrite_extension(source, extension)
+        source = rewrite_asset(source)
+        source = rewrite_asset_path(source)
+        source = rewrite_asset_host(source)
+        source
+      end
+
+    private
+
+      # @private
+      def rewrite_extension(source, extension)
+        if extension && File.extname(source).empty?
+          "#{source}.#{extension}"
+        else
+          source
+        end
+      end
+
+      # @private
+      def rewrite_asset(source)
+        if settings.index_assets? && asset = Assets.manifest.assets[source]
+          source = asset
+        end
+        source
+      end
+
+      # @private
+      def rewrite_asset_path(source)
+        source = File.join(settings.assets_prefix, source)
+        source = "/#{source}" unless source[0] == ?/
+        source
+      end
+
+      # @private
+      def rewrite_asset_host(source)
+        host = settings.assets_host
+        host = host.call(source) if host.respond_to?(:call)
+        host ? "#{host}#{source}" : source
+      end
+    end
+  end
+end

data/lib/padrino-assets/version.rb

@@ -0,0 +1,5 @@
+module Padrino
+  module Assets
+    VERSION = '0.1.0'
+  end
+end

data/lib/tasks/cleanup.rake

@@ -0,0 +1,8 @@
+namespace :assets do
+  desc 'Removes backups for existing assets'
+  task :cleanup, :quanity do |task, args|
+	  quanity  = args['quanity'] || 2
+	  manifest = Padrino::Assets.manifest
+	  manifest.cleanup(quanity)
+  end
+end

data/lib/tasks/clobber.rake

@@ -0,0 +1,7 @@
+namespace :assets do
+  desc 'Deletes all compiled assets'
+  task :clobber do
+	  manifest = Padrino::Assets.manifest
+	  manifest.clobber
+  end
+end

data/lib/tasks/compress.rake

@@ -0,0 +1 @@
+

data/lib/tasks/precompile.rake

@@ -0,0 +1,26 @@
+namespace :assets do
+  desc 'Compiles all assets'
+  task :precompile do
+    environment = Padrino::Assets.environment
+    manifest = Padrino::Assets.manifest
+    apps = Padrino.mounted_apps
+    apps.each do |app|
+      app = app.app_obj
+
+      app.precompile_assets.each do |path|
+        environment.each_logical_path.each do |logical_path|
+          case path
+          when Regexp
+            next unless path.match(logical_path)
+          when Proc
+            next unless path.call(logical_path)
+          else
+            next unless File.fnmatch(path.to_s, logical_path)
+          end
+
+          manifest.compile(logical_path)
+        end
+      end
+    end
+  end
+end

data/padrino-assets.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'padrino-assets/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'padrino-assets'
+  s.version     = Padrino::Assets::VERSION
+  s.authors     = ['Benjamin Bloch']
+  s.email       = ['cirex@gamesol.org']
+  s.homepage    = 'https://github.com/Cirex/padrino-assets'
+  s.description = 'A plugin for the Padrino web framework which uses Sprockets to manage and compile assets'
+  s.summary     = s.description
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_dependency 'sprockets', '~> 2.2.0'
+  
+  s.add_dependency 'padrino-core'
+  s.add_dependency 'padrino-helpers'
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: padrino-assets
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Benjamin Bloch
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-12 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sprockets
+  requirement: &8494660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *8494660
+- !ruby/object:Gem::Dependency
+  name: padrino-core
+  requirement: &8564010 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *8564010
+- !ruby/object:Gem::Dependency
+  name: padrino-helpers
+  requirement: &8566720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *8566720
+description: A plugin for the Padrino web framework which uses Sprockets to manage
+  and compile assets
+email:
+- cirex@gamesol.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- examples/nginx.md
+- lib/padrino-assets.rb
+- lib/padrino-assets/helpers.rb
+- lib/padrino-assets/version.rb
+- lib/tasks/cleanup.rake
+- lib/tasks/clobber.rake
+- lib/tasks/compress.rake
+- lib/tasks/precompile.rake
+- padrino-assets.gemspec
+homepage: https://github.com/Cirex/padrino-assets
+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.15
+signing_key: 
+specification_version: 3
+summary: A plugin for the Padrino web framework which uses Sprockets to manage and
+  compile assets
+test_files: []
+has_rdoc: