thorero-assets 0.9.4

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 YOUR NAME
+
+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

@@ -0,0 +1,250 @@
+merb-assets
+===========
+
+Provides extra functionality related to assets:
+
+	# Assets bundling.
+	# Assets hosts.
+	# Helpers to add asset links to views.
+	# Deployment-time assets processing (for instance, with YUI Compressor).
+
+Quick overview of the API
+==============================
+
+  # asset_path generates path for asset taking type and name.
+	# UniqueAssetPath class handles generation of paths using subdomains.
+	# AbstractAssetBundler is the base asset bundlers class.
+
+	# auto_link generates conventional asset tags based on controller/action.
+	# link_to creates anchor tag (a tag).
+	# image_tag creates img tag.
+	
+	# escape_js escapes JavaScript.
+	# js method translates object into JSON.
+	
+	# require_js is smart(-er) way to do includes just once per page no matter
+	  how many times partial use it.
+	# require_css is like require_js but for JavaScript.
+		 
+	# js_include_tag is used when you need to include script tag with bundling.
+	# css_include_tag works like js_include_tag but for stylesheets.
+	# include_required_js generates script tags for previously included files.
+	# include_required_css generates link tags for previously included files.
+
+	# uniq_js_path generates a script tag for path with asset subdomain.
+	# uniq_css_path generates a link tag for path with asset subdomain.	
+
+
+Examples
+===========
+
+auto_link to include asset tags using convention:
+
+  We want all possible matches in the FileSys up to the action name
+     Given:  controller_name = "namespace/controller"
+             action_name     = "action"
+  If all files are present should generate link/script tags for:
+     namespace.(css|js)
+     namespace/controller.(css|js)
+     namespace/controller/action.(css|js)
+
+link_to and image_tag to make anchor and image tags:
+
+  image_tag('foo.gif') 
+  # => <img src='/images/foo.gif' />
+  
+  image_tag('foo.gif', :class => 'bar') 
+  # => <img src='/images/foo.gif' class='bar' />
+
+  image_tag('foo.gif', :path => '/files/') 
+  # => <img src='/files/foo.gif' />
+
+  image_tag('http://test.com/foo.gif')
+  # => <img src="http://test.com/foo.gif">
+
+  image_tag('charts', :path => '/dynamic/')
+  or 
+  image_tag('/dynamic/charts')
+  # => <img src="/dynamic/charts">
+
+  link_to("The Merb home page", "http://www.merbivore.com/")
+    # => <a href="http://www.merbivore.com/">The Merb home page</a>
+
+  link_to("The Ruby home page", "http://www.ruby-lang.org", {'class' => 'special', 'target' => 'blank'})
+    # => <a href="http://www.ruby-lang.org" class="special" target="blank">The Ruby home page</a>
+
+  link_to p.title, "/blog/show/#{p.id}"
+    # => <a href="/blog/show/13">The Entry Title</a>
+
+uniq_css_tag and uniq_js_tag for paths with asset subdomains:
+
+  uniq_css_tag("my")
+  #=> <link href="http://assets2.my-awesome-domain.com/stylesheets/my.css" type="text/css" />
+
+  uniq_js_tag("my")
+  #=> <script type="text/javascript" src="http://assets2.my-awesome-domain.com/javascripts/my.js"></script>
+
+  uniq_js_path("my")
+  #=> "http://assets2.my-awesome-domain.com/javascripts/my.js"
+
+  uniq_js_path(["admin/secrets","home/signup"])
+  #=> ["http://assets2.my-awesome-domain.com/javascripts/admin/secrets.js", 
+         "http://assets1.my-awesome-domain.com/javascripts/home/signup.js"]
+
+re_js and require_css, include_required_js and include_requried_css
+quire assets in parts/partials just once:		
+
+ 
+ In your application layout:
+ 
+   js_include_tag :prototype, :lowpro, :bundle => :base
+ 
+ In your controller layout:
+ 
+   require_js :bundle => :posts
+
+ The require_js method can be used to require any JavaScript file anywhere
+ in your templates. Regardless of how many times a single script is
+ included with require_js, Merb will only include it once in the header.
+
+   # File: app/views/layouts/application.html.erb
+
+   <html>
+     <head>
+       <%= include_required_js %>
+       <%= include_required_css %>
+     </head>
+     <body>
+       <%= catch_content :layout %>
+     </body>
+   </html>
+ 
+   # File: app/views/whatever/_part1.herb
+
+   <% require_js  'this' -%>
+   <% require_css 'that', 'another_one' -%>
+ 
+   # File: app/views/whatever/_part2.herb
+
+   <% require_js 'this', 'something_else' -%>
+   <% require_css 'that' -%>
+
+   # File: app/views/whatever/index.herb
+
+   <%= partial(:part1) %>
+   <%= partial(:part2) %>
+
+   # Will generate the following in the final page...
+   <html>
+     <head>
+       <script src="/javascripts/this.js" type="text/javascript"></script>
+       <script src="/javascripts/something_else.js" type="text/javascript"></script>
+       <link href="/stylesheets/that.css" media="all" rel="Stylesheet" type="text/css"/>
+       <link href="/stylesheets/another_one.css" media="all" rel="Stylesheet" type="text/css"/>
+     </head>
+     .
+     .
+     .
+   </html>		
+
+   # my_action.herb has a call to require_css 'style'
+   # File: layout/application.html.erb
+   include_required_css
+   # => <link href="/stylesheets/style.css" media="all" rel="Stylesheet" type="text/css"/>
+
+   # my_action.herb has a call to require_css 'style', 'ie-specific'
+   # File: layout/application.html.erb
+   include_required_css
+   # => <link href="/stylesheets/style.css" media="all" rel="Stylesheet" type="text/css"/>
+   #    <link href="/stylesheets/ie-specific.css" media="all" rel="Stylesheet" type="text/css"/>
+
+   # my_action.herb has a call to require_js 'jquery'
+   # File: layout/application.html.erb
+   include_required_js
+   # => <script src="/javascripts/jquery.js" type="text/javascript"></script>
+
+   # my_action.herb has a call to require_js 'jquery', 'effects', 'validation'
+   # File: layout/application.html.erb
+   include_required_js
+   # => <script src="/javascripts/jquery.js" type="text/javascript"></script>
+   #    <script src="/javascripts/effects.js" type="text/javascript"></script>
+   #    <script src="/javascripts/validation.js" type="text/javascript"></script>
+
+   <% require_css('style') %>
+   # A subsequent call to include_required_css will render...
+   # => <link href="/stylesheets/style.css" media="all" rel="Stylesheet" type="text/css"/>
+
+   <% require_css('style', 'ie-specific') %>
+   # A subsequent call to include_required_css will render...
+   # => <link href="/stylesheets/style.css" media="all" rel="Stylesheet" type="text/css"/>
+   #    <link href="/stylesheets/ie-specific.css" media="all" rel="Stylesheet" type="text/css"/>
+
+   <% require_js 'jquery' %>
+   # A subsequent call to include_required_js will render...
+   # => <script src="/javascripts/jquery.js" type="text/javascript"></script>
+
+   <% require_js 'jquery', 'effects' %>
+   # A subsequent call to include_required_js will render...
+   # => <script src="/javascripts/jquery.js" type="text/javascript"></script>
+   #    <script src="/javascripts/effects.js" type="text/javascript"></script>
+
+css_include_tag and js_include_tag that do not use asset subdomains:
+		
+   css_include_tag 'style'
+   # => <link href="/stylesheets/style.css" media="all" rel="Stylesheet" type="text/css" charset="utf-8" />
+
+   css_include_tag 'style.css', 'layout'
+   # => <link href="/stylesheets/style.css" media="all" rel="Stylesheet" type="text/css" charset="utf-8" />
+   #    <link href="/stylesheets/layout.css" media="all" rel="Stylesheet" type="text/css" charset="utf-8" />
+
+   css_include_tag :menu
+   # => <link href="/stylesheets/menu.css" media="all" rel="Stylesheet" type="text/css" charset="utf-8" />
+
+   css_include_tag :style, :screen
+   # => <link href="/stylesheets/style.css" media="all" rel="Stylesheet" type="text/css" charset="utf-8" />
+   #    <link href="/stylesheets/screen.css" media="all" rel="Stylesheet" type="text/css" charset="utf-8" />
+ 
+  css_include_tag :style, :media => :print
+  # => <link href="/stylesheets/style.css" media="print" rel="Stylesheet" type="text/css" charset="utf-8" />
+
+  css_include_tag :style, :charset => 'iso-8859-1'
+  # => <link href="/stylesheets/style.css" media="print" rel="Stylesheet" type="text/css" charset="iso-8859-1" />
+
+   js_include_tag 'jquery'
+   # => <script src="/javascripts/jquery.js" type="text/javascript"></script>
+
+   js_include_tag 'moofx.js', 'upload'
+   # => <script src="/javascripts/moofx.js" type="text/javascript"></script>
+   #    <script src="/javascripts/upload.js" type="text/javascript"></script>
+
+   js_include_tag :effects
+   # => <script src="/javascripts/effects.js" type="text/javascript"></script>
+
+   js_include_tag :jquery, :validation
+   # => <script src="/javascripts/jquery.js" type="text/javascript"></script>
+   #    <script src="/javascripts/validation.js" type="text/javascript"></script>
+
+Utility methods examples
+==========================
+		
+  uniq_css_path("my")
+  #=> "http://assets2.my-awesome-domain.com/stylesheets/my.css"
+
+  uniq_css_path(["admin/secrets","home/signup"])
+  #=> ["http://assets2.my-awesome-domain.com/stylesheets/admin/secrets.css", 
+         "http://assets1.my-awesome-domain.com/stylesheets/home/signup.css"]
+
+  uniq_path("/javascripts/my.js","/javascripts/my.css")
+  #=> ["http://assets2.my-awesome-domain.com/javascripts/my.js", "http://assets1.my-awesome-domain.com/javascripts/my.css"]
+
+  uniq_path(["/javascripts/my.js","/stylesheets/my.css"])
+  #=> ["http://assets2.my-awesome-domain.com/javascripts/my.js", "http://assets1.my-awesome-domain.com/stylesheets/my.css"]
+
+  uniq_path(%w(/javascripts/my.js /stylesheets/my.css))
+  #=> ["http://assets2.my-awesome-domain.com/javascripts/my.js", "http://assets1.my-awesome-domain.com/stylesheets/my.css"]
+
+  uniq_path('/stylesheets/somearbitrary.css')
+  #=> "http://assets3.my-awesome-domain.com/stylesheets/somearbitrary.css"
+
+  uniq_path('/images/hostsexypicture.jpg')
+  #=>"http://assets1.my-awesome-domain.com/images/hostsexypicture.jpg"

data/Rakefile

@@ -0,0 +1,63 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require "extlib"
+require 'merb-core/tasks/merb_rake_helper'
+
+##############################################################################
+# Package && release
+##############################################################################
+RUBY_FORGE_PROJECT  = "thorero"
+PROJECT_URL         = "http://merbivore.com"
+PROJECT_SUMMARY     = "Merb plugin that provides the helpers for assets and asset bundling"
+PROJECT_DESCRIPTION = PROJECT_SUMMARY
+
+GEM_AUTHOR = "Ezra Zygmuntowicz"
+GEM_EMAIL  = "ez@engineyard.com"
+
+GEM_NAME    = "thorero-assets"
+PKG_BUILD   = ENV['PKG_BUILD'] ? '.' + ENV['PKG_BUILD'] : ''
+GEM_VERSION = (Merb::MORE_VERSION rescue "0.9.4") + PKG_BUILD
+
+RELEASE_NAME    = "REL #{GEM_VERSION}"
+
+require "extlib/tasks/release"
+
+spec = Gem::Specification.new do |s|
+  s.rubyforge_project = RUBY_FORGE_PROJECT
+  s.name = GEM_NAME
+  s.version = GEM_VERSION
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["README", "LICENSE", 'TODO']
+  s.summary = PROJECT_SUMMARY
+  s.description = PROJECT_DESCRIPTION
+  s.author = GEM_AUTHOR
+  s.email = GEM_EMAIL
+  s.homepage = PROJECT_URL
+  s.add_dependency('merb-core', '>= 0.9.4')
+  s.require_path = 'lib'
+  s.files = %w(LICENSE README Rakefile TODO) + Dir.glob("{lib,spec}/**/*")
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc "Install the gem"
+task :install => [:package] do
+  sh %{#{sudo} gem install #{install_home} pkg/#{GEM_NAME}-#{GEM_VERSION} --no-update-sources}
+end
+
+namespace :jruby do
+
+  desc "Run :package and install the resulting .gem with jruby"
+  task :install => :package do
+    sh %{#{sudo} jruby -S gem install #{install_home} pkg/#{GEM_NAME}-#{GEM_VERSION}.gem --no-rdoc --no-ri}
+  end
+
+end
+
+desc "Run specs"
+task :spec do
+  sh %{spec -r spec/spec_helper.rb spec/*_spec.rb}
+end

data/TODO

@@ -0,0 +1,5 @@
+TODO:
+Fix LICENSE with your name
+Fix Rakefile with your name and contact info
+Add your code to lib/merb-haml.rb
+Add your Merb rake tasks to lib/merb-haml/merbtasks.rb

data/lib/merb-assets.rb

@@ -0,0 +1,14 @@
+require 'merb-assets/assets'
+require 'merb-assets/assets_mixin'
+
+Merb::BootLoader.before_app_loads do
+  Merb::Controller.send(:include, Merb::AssetsMixin)
+end
+
+
+Merb::Plugins.config[:asset_helpers] = {
+    :max_hosts => 4,
+    :asset_domain => "assets%s",
+    :domain => "my-awesome-domain.com",
+    :use_ssl => false
+  } if Merb::Plugins.config[:asset_helpers].nil?

data/lib/merb-assets/assets.rb

@@ -0,0 +1,242 @@
+module Merb
+  module Assets
+    
+    # Check whether the assets should be bundled.
+    #
+    # ==== Returns
+    # Boolean::
+    #   True if the assets should be bundled (e.g., production mode or
+    #   :bundle_assets is explicitly enabled).
+    def self.bundle?
+      (Merb.environment == 'production') ||
+      (!!Merb::Config[:bundle_assets])
+    end
+    
+    # Helpers for handling asset files.
+    module AssetHelpers
+      ASSET_FILE_EXTENSIONS = {
+        :javascript => ".js",
+        :stylesheet => ".css"
+      }
+      
+      # Returns the URI path to a particular asset file. If +local_path+ is
+      # true, returns the path relative to the Merb.root, not the public
+      # directory. Uses the path_prefix, if any is configured.
+      # 
+      # ==== Parameters
+      # asset_type<Symbol>:: Type of the asset (e.g. :javascript).
+      # filename<~to_s>:: The path to the file.
+      # local_path<Boolean>::
+      #   If true, the returned path will be relative to the Merb.root,
+      #   otherwise it will be the public URI path. Defaults to false.
+      #
+      # ==== Returns
+      # String:: The path to the asset.
+      #
+      # ==== Examples
+      #   asset_path(:javascript, :dingo)
+      #   # => "/javascripts/dingo.js"
+      #
+      #   asset_path(:javascript, :dingo, true)
+      #   # => "public/javascripts/dingo.js"
+      def asset_path(asset_type, filename, local_path = false)
+        filename = filename.to_s
+        if filename !~ /#{'\\' + ASSET_FILE_EXTENSIONS[asset_type]}\Z/ && filename.index('?').nil?
+          filename = "#{filename}#{ASSET_FILE_EXTENSIONS[asset_type]}" # don't modify receiver
+        end
+        if filename !~ %r{^(/|https?://)}
+          filename = "/#{asset_type}s/#{filename}"
+        end
+        if local_path
+          return "public#{filename}"
+        else
+          return "#{Merb::Config[:path_prefix]}#{filename}"
+        end
+      end
+    end
+    
+    # Helper for creating unique paths to a file name
+    # Can increase speend for browsers that are limited to a certain number of connections per host 
+    # for downloading static files (css, js, images...)
+    class UniqueAssetPath
+      class << self
+        # Builds the path to the file based on the name
+        # 
+        # ==== Parameters
+        # filename<String>:: Name of file to generate path for
+        #
+        # ==== Returns
+        # String:: The path to the asset.
+        #
+        # ==== Examples
+        #   build("/javascripts/my_fancy_script.js")
+        #   # => "https://assets5.my-awesome-domain.com/javascripts/my_fancy_script.js"
+        #
+        def build(filename)
+          config = Merb::Plugins.config[:asset_helpers]
+          #%{#{(USE_SSL ? 'https' : 'http')}://#{sprintf(config[:asset_domain],self.calculate_host_id(file))}.#{config[:domain]}/#{filename}}
+          path = config[:use_ssl] ? 'https://' : 'http://'
+          path << sprintf(config[:asset_domain],self.calculate_host_id(filename)) << ".#{config[:domain]}"
+          path << "/" if filename.index('/') != 0
+          path << filename
+        end
+      
+        protected
+        
+        # Calculates the id for the host
+        def calculate_host_id(filename)
+          ascii_total = 0
+          filename.each_byte {|byte|
+            ascii_total += byte
+          }
+          (ascii_total % Merb::Plugins.config[:asset_helpers][:max_hosts] + 1)
+        end
+      end
+    end
+    
+    # An abstract class for bundling text assets into single files.
+    class AbstractAssetBundler
+      
+      class_inheritable_accessor :cached_bundles
+      self.cached_bundles ||= []
+      
+      class << self
+        
+        # Mark a bundle as cached.
+        #
+        # ==== Parameters
+        # name<~to_s>:: Name of the bundle
+        #
+        def cache_bundle(name)
+          cached_bundles.push(name.to_s)
+        end
+        
+        # Purge a bundle from the cache.
+        #
+        # ==== Parameters
+        # name<~to_s>:: Name of the bundle
+        #
+        def purge_bundle(name)
+          cached_bundles.delete(name.to_s)
+        end
+        
+        # Test if a bundle has been cached.
+        #
+        # ==== Parameters
+        # name<~to_s>:: Name of the bundle
+        #
+        # ==== Returns
+        # Boolean:: Whether the bundle has been cached or not.
+        def cached_bundle?(name)
+          cached_bundles.include?(name.to_s)
+        end
+        
+        # ==== Parameters
+        # &block:: A block to add as a post-bundle callback.
+        #
+        # ==== Examples
+        #   add_callback { |filename| `yuicompressor #{filename}` }
+        def add_callback(&block)
+          callbacks << block
+        end
+        alias_method :after_bundling, :add_callback
+        
+        # Retrieve existing callbacks.
+        #
+        # ==== Returns
+        # Array[Proc]:: An array of existing callbacks.
+        def callbacks
+          @callbacks ||= []
+          return @callbacks
+        end
+        
+        # The type of asset for which the bundler is responsible. Override
+        # this method in your bundler code.
+        #
+        # ==== Raises
+        # NotImplementedError:: This method is implemented by the bundler.
+        #
+        # ==== Returns
+        # Symbol:: The type of the asset
+        def asset_type
+          raise NotImplementedError, "should return a symbol for the first argument to be passed to asset_path"
+        end
+      end
+
+      # ==== Parameters
+      # name<~to_s>::
+      #   Name of the bundle. If name is true, it will be converted to :all.
+      # *files<String>:: Names of the files to bundle.
+      def initialize(name, *files)
+        @bundle_name = name == true ? :all : name
+        @bundle_filename = asset_path(self.class.asset_type, @bundle_name, true)
+        @files = files.map { |f| asset_path(self.class.asset_type, f, true) }
+      end
+      
+      # Creates the new bundled file, executing all the callbacks.
+      #
+      # ==== Returns
+      # Symbol:: Name of the bundle.
+      def bundle!
+        # TODO: push it out to the helper level so we don't have to create the helper object.
+        unless self.class.cached_bundle?(@bundle_name)
+          # skip regeneration of new bundled files - preventing multiple merb apps stepping on eachother
+          # file needs to be older than 60 seconds to be regenerated
+          if File.exist?(@bundle_filename) && File.mtime(@bundle_filename) >= Time.now - 60
+            return @bundle_name # serve the old file for now - to be regenerated later
+          end
+          bundle_files(@bundle_filename, *@files)
+          if File.exist?(@bundle_filename)
+            self.class.callbacks.each { |c| c.call(@bundle_filename) }
+            Merb.logger.info("Assets: bundled :#{@bundle_name} into #{File.basename(@bundle_filename)}")
+            self.class.cache_bundle(@bundle_name)
+          end
+        end
+        return @bundle_name
+      end
+      
+    protected
+      
+      include Merb::Assets::AssetHelpers # for asset_path
+      
+      # Bundle all the files into one.
+      #
+      # ==== Parameters
+      # filename<String>:: Name of the bundle file.
+      # *files<String>:: Filenames to be bundled.
+      def bundle_files(filename, *files)
+        File.open(filename, "w") do |f|
+          f.flock(File::LOCK_EX)
+          files.each { |file| f.puts(File.read(file)) }
+          f.flock(File::LOCK_UN)
+        end
+      end
+      
+    end
+    
+    # Bundles javascripts into a single file:
+    # 
+    #   javascripts/#{name}.js
+    class JavascriptAssetBundler < AbstractAssetBundler
+
+      # ==== Returns
+      # Symbol:: The asset type, i.e. :javascript.
+      def self.asset_type
+        :javascript
+      end
+    end
+    
+    # Bundles stylesheets into a single file:
+    # 
+    #   stylesheets/#{name}.css
+    class StylesheetAssetBundler < AbstractAssetBundler
+
+      # ==== Returns
+      # Symbol:: The asset type, i.e. :stylesheet.
+      def self.asset_type
+        :stylesheet
+      end
+    end
+    
+  end
+end