RubyGems - JackDanger-sweet_assets - Versions diffs - 1.2.0 - Mend

JackDanger-sweet_assets 1.2.0

Files changed (16) hide show

data/History.txt +16 -0
data/MIT-LICENSE +20 -0
data/Manifest.txt +15 -0
data/README.txt +49 -0
data/Rakefile +15 -0
data/init.rb +1 -0
data/install.rb +0 -0
data/lib/sweet_assets.rb +246 -0
data/rails/init.rb +11 -0
data/sweet_assets.gemspec +32 -0
data/test/sweet_assets_test.rb +170 -0
data/test/views/defaults/index.html.erb +7 -0
data/test/views/shortcut/index.html.erb +7 -0
data/test/views/web/index.html.erb +7 -0
data/uninstall.rb +1 -0
metadata +80 -0

data/History.txt ADDED

@@ -0,0 +1,16 @@
+=== 1.0.0 / 2008-03-11
+* 1 major enhancement
+  * First iteration complete.
+=== 2.0.1 / 2008-05-27
+* 2 major enhancements
+  * Completely rewritten.  Doesn't use <head> parsing magic.
+  * Supports media selection for stylesheets

data/MIT-LICENSE ADDED

@@ -0,0 +1,20 @@
+Copyright (c) 2007 [name of plugin creator]
+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/Manifest.txt ADDED

@@ -0,0 +1,15 @@
+History.txt
+MIT-LICENSE
+Manifest.txt
+README.txt
+Rakefile
+init.rb
+install.rb
+lib/sweet_assets.rb
+rails/init.rb
+sweet_assets.gemspec
+test/sweet_assets_test.rb
+test/views/defaults/index.html.erb
+test/views/shortcut/index.html.erb
+test/views/web/index.html.erb
+uninstall.rb

data/README.txt ADDED

@@ -0,0 +1,49 @@
+= SweetAssets
+http://github.com/JackDanger/sweet_assets
+== Description
+  Automate adding stylesheets and javascripts to your controller actions
+== Example
+  Any controller will include the stylesheet and javascript source files named after named after the contorller if the file exists:
+    class UsersController < ApplicationController
+      ...
+    end
+    http://mysite.com/users/ will have /stylesheets/users.css and /javascripts/users.js included if they exist.
+  Any controller can specify any other file to be added as a stylesheet:
+    class UsersController < ApplicationController
+      style_like :homes
+      script_like :gargantuan
+    end
+    http://mysite.com/users/ will have users.css, homes.css and gargantuan.js included
+  Any asset that needs to take precedence over others (i.e. should be linked after the other stylesheets) can be used with a bang (!)
+    class UsersController < ApplicationController
+      style_like :distort_reality!, :homes, :trees
+      script_like :basic_script, :super_enhancement!
+    end
+    http://mysite.com/users/ will have homes.css, and trees.css and basic_script.js linked before the <title> tag.
+    distort_reality.css and super_enhancement.js will be linked after the <title> tag.
+    Note: the controller-named assets (users.css and users.js in this case) will always
+    be applied with precedence.
+  If you need better control over where these assets appear you can use the same options as you would for a before_filter
+    class UsersController < ApplicationController
+      style_like :homes!, :only => :show
+      script_like :trees, :except => [:index, :show]
+    end
+  All linked assets will be cached into a single asset if caching is enabled.
+Copyright (c) 2007 Jack Danger Canty of adPickles Inc, released under the MIT license

data/Rakefile ADDED

@@ -0,0 +1,15 @@
+# -*- ruby -*-
+$:.unshift(File.dirname(__FILE__) + '/lib')
+require 'rubygems'
+require 'hoe'
+require "sweet_assets"
+Hoe.new('sweet_assets', SweetAssets::VERSION) do |p|
+  p.rubyforge_name = 'objectproxy' # if different than lowercase project name
+  p.developer('Jack Danger Canty', 'sweet_assets_gem@6brand.com')
+end
+# vim: syntax=Ruby

data/init.rb ADDED

	@@ -0,0 +1 @@
1	+ rails/init.rb

data/install.rb ADDED

File without changes

data/lib/sweet_assets.rb ADDED

@@ -0,0 +1,246 @@
+require 'cgi'
+require 'active_support'
+require 'action_view/helpers/url_helper'
+require 'action_view/helpers/asset_tag_helper'
+require 'action_view/helpers/tag_helper'
+require 'digest/md5'
+# USAGE:
+# style_like :dolphins # assumes :media => 'all'
+# style_like :home, :media => 'print'
+# style_like :users, :media => ['print', 'screen']
+# script_like :boats
+module SweetAssets
+  VERSION = '1.2.0'
+  DEFAULT_JAVASCRIPTS = ['prototype', 'effects', 'dragdrop', 'controls']
+  SCRIPT_PLACEHOLDER  = '<!--SWEET_JAVASCRIPTS-->'
+  STYLE_PLACEHOLDER   = '<!--SWEET_STYLESHEETS-->'
+  module ActionController
+    def self.included(base)
+      base.class_eval do
+        extend  ClassMethods
+        include InstanceMethods
+        include AppendAssetsAfterRescue
+        after_filter :apply_sweet_assets
+      end
+    end
+    module ClassMethods
+      def style_like(*assets)
+        prepend_before_filter do |controller|
+          controller.send :style_like, *assets
+        end
+      end
+      def script_like(*assets)
+        prepend_before_filter do |controller|
+          controller.send :script_like, *assets
+        end
+      end
+    end
+    module InstanceMethods
+      protected
+        # Apply the assets even if the filter chain was aborted
+        def call_filters(*args)
+          ret = super
+          apply_sweet_assets
+          ret
+        end
+        def style_like(*assets)
+          sweet_assets.style_like(*assets)
+        end
+        def script_like(*assets)
+          sweet_assets.script_like(*assets)
+        end
+        def sweet_assets
+          @sweet_assets ||= SweetAssets::Request.new(self)
+        end
+        def apply_sweet_assets
+          return if @sweet_assets_applied
+          if response.body.respond_to?(:gsub!)
+            response.body.gsub! SweetAssets::STYLE_PLACEHOLDER,  "\n#{sweet_assets.tags.stylesheets}"
+            response.body.gsub! SweetAssets::SCRIPT_PLACEHOLDER, "\n#{sweet_assets.tags.javascripts}"
+          end
+          @sweet_assets_applied = true
+        end
+    end
+  end
+  module ActionView
+    module Helpers
+      def style_like(*assets)
+        sweet_assets.style_like(*assets)
+      end
+      def script_like(*assets)
+        sweet_assets.script_like(*assets)
+      end
+      def sweet_stylesheets
+        SweetAssets::STYLE_PLACEHOLDER
+      end
+      def sweet_javascripts
+        SweetAssets::SCRIPT_PLACEHOLDER
+      end
+      protected
+        def sweet_assets
+          controller.send :sweet_assets
+        end
+    end
+  end
+  class Request
+    def initialize(controller)
+      @stylesheets = Array.new
+      @javascripts = Array.new
+      @controller  = controller
+      # use the assets named 'application'
+      style_like :application
+      script_like :application
+      # use the assets named after the controller at higher priority
+      style_like "#{@controller.class.controller_name}!"
+      script_like "#{@controller.class.controller_name}!"
+    end
+    def style_like(*assets)
+      options = HashWithIndifferentAccess.new(assets.extract_options!)
+      media = [options[:media]].flatten.compact
+      media = ['all'] if media.blank?
+      media.each do |medium|
+        medium = medium.to_s
+        assets.each do |asset|
+          asset = asset.to_s
+          if asset.ends_with?('!')
+            asset.gsub!(/!$/, '')
+            # remove a lower-priority entry if it exists for this medium
+            @stylesheets.delete({:file => asset, :medium => medium, :priority => 'low'})
+            @stylesheets << {:file => asset, :medium => medium, :priority => 'high'}
+          else
+            # don't add this entry if it's already set to high-priority
+            unless @stylesheets.include?({:file => asset, :medium => medium, :priority => 'high'})
+              @stylesheets << {:file => asset, :medium => medium, :priority => 'low'}
+            end
+          end
+        end
+      end
+    end
+    def script_like(*assets)
+      assets.each do |asset|
+        asset = asset.to_s
+        if 'defaults' == asset
+          DEFAULT_JAVASCRIPTS.each do |default|
+            @javascripts << {:file => default, :priority => 'first' }
+          end
+        elsif asset.ends_with?('!')
+          asset.gsub!(/!$/, '')
+          # remove a lower-priority entry if it exists
+          @javascripts.delete({:file => asset, :priority => 'low'})
+          @javascripts << {:file => asset, :priority => 'high'}
+        else
+          # don't add this entry if it's already set to high-priority
+          unless @javascripts.include?({:file => asset, :priority => 'high'})
+            @javascripts << {:file => asset, :priority => 'low'}
+          end
+        end
+      end
+    end
+    def tags
+      @tag_generator ||= TagGenerator.new(@stylesheets, @javascripts, @controller)
+    end
+  end
+  class TagGenerator
+    include ::ActionView::Helpers::TagHelper
+    include ::ActionView::Helpers::AssetTagHelper
+    def initialize(stylesheets, javascripts, controller)
+      @stylesheets = stylesheets
+      @javascripts = javascripts
+      @controller  = controller
+    end
+    def stylesheets
+      media = @stylesheets.map {|asset| asset[:medium] }.uniq
+      media.map do |medium|
+        files_in_order = ['low', 'high'].map do |priority|
+          files = @stylesheets.select do |asset|
+            asset[:medium] == medium && asset[:priority] == priority
+          end
+          files.map! {|asset| asset[:file] }
+          files.map! {|file| file =~ /\.css$/ ? file : "#{file}.css" }
+          # check that the files exist
+          unless RAILS_ENV.eql?('test')
+            files = files.select {|file| File.exists?( file.starts_with?('/') ? "#{RAILS_ROOT}/public#{file}" : "#{STYLESHEETS_DIR}/#{file}") }
+          end
+          files
+        end.flatten.uniq.compact
+        stylesheet_link_tag(*(files_in_order << {:media => medium, :cache => cached_file_name(files_in_order)}))
+      end.join("\n")
+    end
+    def javascripts
+      files_in_order = ['first', 'low', 'high'].map do |priority|
+        files = @javascripts.select {|asset| asset[:priority] == priority }
+        files.map! {|asset| asset[:file] }
+        files.map! {|file| file =~ /\.js$/ ? file : "#{file}.js" }
+        # check that the files exist
+        unless RAILS_ENV.eql?('test')
+          files = files.select {|file| File.exists?(file.starts_with?('/') ? "#{RAILS_ROOT}/public#{file}" : "#{JAVASCRIPTS_DIR}/#{file}") }
+        end
+        files
+      end.flatten.uniq.compact
+      files_in_order << {:cache => cached_file_name(files_in_order)}
+      javascript_include_tag *files_in_order
+    end
+    protected
+      def cached_file_name(filenames)
+        "sweet_assets_#{Digest::MD5.hexdigest(filenames.join('_'))}"
+      end
+end
+  # we're going to wrap our rescue_action around the top-level rescue_action method chain
+  # this ensures that we can apply the stylesheets even if the after filter was aborted due to an exception
+  module AppendAssetsAfterRescue
+    def self.included(base)
+      base.class_eval do
+        def initialize_with_append_sweet_assets_rescue_action(*args)
+          initialize_without_append_sweet_assets_rescue_action(*args)
+          self.class.send :alias_method_chain, :rescue_action, :append_sweet_assets unless respond_to?(:rescue_action_without_append_sweet_assets)
+        end
+        alias_method_chain :initialize, :append_sweet_assets_rescue_action unless respond_to?(:initialize_without_append_sweet_assets_rescue_action)
+      end
+    end
+    def rescue_action_with_append_sweet_assets(*args)
+      rescue_action_without_append_sweet_assets(*args)
+      apply_sweet_assets
+    end
+  end
+end

data/rails/init.rb ADDED

@@ -0,0 +1,11 @@
+require 'sweet_assets'
+ActionController::Base.class_eval do
+  include SweetAssets::ActionController
+end
+ActionView::Base.class_eval do
+  include SweetAssets::ActionView::Helpers
+end

data/sweet_assets.gemspec ADDED

@@ -0,0 +1,32 @@
+Gem::Specification.new do |s|
+  s.name = %q{sweet_assets}
+  s.version = "1.2.0"
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jack Danger Canty"]
+  s.date = %q{2009-03-19}
+  s.description = %q{Automate adding stylesheets and javascripts to your controller actions}
+  s.email = ["sweet_assets_gem@6brand.com"]
+  s.extra_rdoc_files = ["History.txt", "Manifest.txt", "README.txt"]
+  s.files = ["History.txt", "MIT-LICENSE", "Manifest.txt", "README.txt", "Rakefile", "init.rb", "install.rb", "lib/sweet_assets.rb", "rails/init.rb", "sweet_assets.gemspec", "test/sweet_assets_test.rb", "test/views/defaults/index.html.erb", "test/views/shortcut/index.html.erb", "test/views/web/index.html.erb", "uninstall.rb"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/JackDanger/sweet_assets}
+  s.rdoc_options = ["--main", "README.txt"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{objectproxy}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Automate adding stylesheets and javascripts to your controller actions}
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<hoe>, [">= 1.11.0"])
+    else
+      s.add_dependency(%q<hoe>, [">= 1.11.0"])
+    end
+  else
+    s.add_dependency(%q<hoe>, [">= 1.11.0"])
+  end
+end

data/test/sweet_assets_test.rb ADDED

@@ -0,0 +1,170 @@
+RAILS_ENV = 'test'
+require File.dirname(__FILE__) + '/../../../../config/environment'
+require 'test/unit'
+require 'rubygems'
+require 'action_controller/test_process'
+require File.dirname(__FILE__) + '/../init'
+ActionController::Base.view_paths = [File.dirname(__FILE__) + '/views/']
+# Re-raise errors caught by the controller.
+class WebController < ActionController::Base
+  style_like  :home
+  style_like  :users!
+  style_like  :extra
+  script_like :home
+  script_like :users!
+  script_like :extra
+end
+class ShortcutController < ActionController::Base
+  style_like :home!, :users
+  script_like :extra!, :home
+end
+class DefaultsController < ActionController::Base
+  script_like :defaults
+end
+class SweetAssetsTest < Test::Unit::TestCase
+  def setup
+    ActionController::Base.perform_caching = false
+    @controller = WebController.new
+    @request    = ActionController::TestRequest.new
+    @response   = ActionController::TestResponse.new
+  end
+  def teardown
+    delete_empty_recent_files
+  end
+  def test_each_stylesheet_should_appear
+    get :index
+    assert_response :success
+    assert_tag :link, :attributes => {:href => /stylesheets\/application.css/, :rel => 'stylesheet'}
+    assert_tag :link, :attributes => {:href => /stylesheets\/web.css/, :rel => 'stylesheet'}
+    assert_tag :link, :attributes => {:href => /stylesheets\/home.css/, :rel => 'stylesheet'}
+    assert_tag :link, :attributes => {:href => /stylesheets\/extra.css/, :rel => 'stylesheet'}
+    assert_tag :link, :attributes => {:href => /stylesheets\/users.css/, :rel => 'stylesheet'}
+    assert_select 'head > link', :count => 5
+  end
+  def test_bottom_stylesheets_should_appear_last
+    get :index
+    assert_response :success
+    location_of_extra_css = @response.body =~ /<link href="\/stylesheets\/extra.css/
+    location_of_home_css  = @response.body =~ /<link href="\/stylesheets\/home.css/
+    location_of_users_css = @response.body =~ /<link href="\/stylesheets\/users.css/
+    assert location_of_home_css < location_of_users_css
+    assert location_of_extra_css < location_of_users_css
+  end
+  def test_caching_stylesheets
+    ActionController::Base.perform_caching = true
+    with_stylesheets :application, :home, :web, :users, :extra do
+      with_javascripts :application, :home, :web, :users, :extra do
+        get :index
+      end
+    end
+    assert_response :success
+    assert_no_tag :link, :attributes => {:href => /stylesheets\/application.css/, :rel => 'stylesheet'}
+    assert_no_tag :link, :attributes => {:href => /stylesheets\/web.css/, :rel => 'stylesheet'}
+    assert_no_tag :link, :attributes => {:href => /stylesheets\/home.css/, :rel => 'stylesheet'}
+    assert_no_tag :link, :attributes => {:href => /stylesheets\/extra.css/, :rel => 'stylesheet'}
+    assert_no_tag :link, :attributes => {:href => /stylesheets\/users.css/, :rel => 'stylesheet'}
+    assert_tag :link, :attributes => {:href => /sweet_assets_([\w\d]{32}).css/, :rel => 'stylesheet'}
+    ActionController::Base.perform_caching = false
+  end
+  def test_caching_javascripts
+    ActionController::Base.perform_caching = true
+    with_stylesheets :home, :web, :users, :extra do
+      with_javascripts :home, :web, :users, :extra do
+        get :index
+      end
+    end
+    assert_response :success
+    assert_no_tag :script, :attributes => {:src => /javascripts\/web.js/}
+    assert_no_tag :script, :attributes => {:src => /javascripts\/home.js/}
+    assert_no_tag :script, :attributes => {:src => /javascripts\/extra.js/}
+    assert_no_tag :script, :attributes => {:src => /javascripts\/users.js/}
+    assert_tag :script, :attributes => {:src => /sweet_assets_([\w\d]{32}).js/}
+    ActionController::Base.perform_caching = false
+  end
+  def test_defaults_should_include_prototype_scriptaculous_and_application
+    @controller = DefaultsController.new
+    get :index
+    assert_tag :script, :attributes => {:src => /prototype.js/}
+    assert_tag :script, :attributes => {:src => /effects.js/}
+    assert_tag :script, :attributes => {:src => /dragdrop.js/}
+    assert_tag :script, :attributes => {:src => /controls.js/}
+    assert_tag :script, :attributes => {:src => /application.js/}
+  end
+  def test_shortcuts
+    @controller = ShortcutController.new
+    with_stylesheets :home, :web, :users, :extra do
+      with_javascripts :home, :web, :users, :extra do
+        get :index
+      end
+    end
+    assert_tag :link, :attributes => {:href => /home.css/, :rel => 'stylesheet'}
+    assert_tag :link, :attributes => {:href => /users.css/, :rel => 'stylesheet'}
+    assert_tag :script, :attributes => {:src => /extra.js/}
+    assert_tag :script, :attributes => {:src => /home.js/}
+    @controller = WebController.new
+  end
+  def delete_empty_recent_files
+    dirs = ["#{RAILS_ROOT}/public/stylesheets", "#{RAILS_ROOT}/public/javascripts"]
+    dirs.each do |dir|
+      Dir.entries(dir).each do |file|
+        if file =~ /(\.css|\.js)$/
+          filename = File.join(dir, file)
+          if File.exists?(filename) && File.read(filename).blank? && (File.ctime(filename) + 10.minutes) > Time.now
+            File.delete(filename)
+          end
+        end
+      end
+    end
+  end
+  # create some temporary css files for the duration of the block
+  def with_stylesheets(*files, &block)
+    @temp_stylesheet_files = []
+    files.each do |file|
+      filename = "#{RAILS_ROOT}/public/stylesheets/#{file}.css"
+      unless File.exists?(filename)
+        @temp_stylesheet_files << "#{RAILS_ROOT}/public/stylesheets/#{file}.css"
+        File.open(filename, 'w') {|f| f.write('') }
+      end
+    end
+    yield
+    @temp_stylesheet_files.each {|filename| File.delete(filename) }
+  end
+  # create some temporary javascript files for the duration of the block
+  def with_javascripts(*files, &block)
+    @temp_javascript_files = []
+    files.each do |file|
+      filename = "#{RAILS_ROOT}/public/javascripts/#{file}.js"
+      unless File.exists?(filename)
+        @temp_javascript_files << "#{RAILS_ROOT}/public/javascripts/#{file}.js"
+        File.open(filename, 'w') {|f| f.write('') }
+      end
+    end
+    yield
+    @temp_javascript_files.each {|filename| File.delete(filename) }
+  end
+end

data/test/views/defaults/index.html.erb ADDED

@@ -0,0 +1,7 @@
+<html>
+  <head>
+    <%= sweet_stylesheets %>
+    <%= sweet_javascripts %>
+  </head>
+  <body></body>
+</html>

data/test/views/shortcut/index.html.erb ADDED

@@ -0,0 +1,7 @@
+<html>
+  <head>
+    <%= sweet_stylesheets %>
+    <%= sweet_javascripts %>
+  </head>
+  <body></body>
+</html>

data/test/views/web/index.html.erb ADDED

@@ -0,0 +1,7 @@
+<html>
+  <head>
+    <%= sweet_stylesheets %>
+    <%= sweet_javascripts %>
+  </head>
+  <body></body>
+</html>

data/uninstall.rb ADDED

	@@ -0,0 +1 @@
1	+ # Uninstall hook code here

metadata ADDED

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: JackDanger-sweet_assets
+version: !ruby/object:Gem::Version
+  version: 1.2.0
+platform: ruby
+authors:
+- Jack Danger Canty
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2009-03-19 00:00:00 -07:00
+default_executable:
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hoe
+  type: :development
+  version_requirement:
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.11.0
+    version:
+description: Automate adding stylesheets and javascripts to your controller actions
+email:
+- sweet_assets_gem@6brand.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- History.txt
+- Manifest.txt
+- README.txt
+files:
+- History.txt
+- MIT-LICENSE
+- Manifest.txt
+- README.txt
+- Rakefile
+- init.rb
+- install.rb
+- lib/sweet_assets.rb
+- rails/init.rb
+- sweet_assets.gemspec
+- test/sweet_assets_test.rb
+- test/views/defaults/index.html.erb
+- test/views/shortcut/index.html.erb
+- test/views/web/index.html.erb
+- uninstall.rb
+has_rdoc: true
+homepage: http://github.com/JackDanger/sweet_assets
+post_install_message:
+rdoc_options:
+- --main
+- README.txt
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: "0"
+  version:
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: "0"
+  version:
+requirements: []
+rubyforge_project: objectproxy
+rubygems_version: 1.2.0
+signing_key:
+specification_version: 2
+summary: Automate adding stylesheets and javascripts to your controller actions
+test_files: []