RubyGems - jeremyboles-smart-asset-helper - Versions diffs - 0.1.0 - Mend

jeremyboles-smart-asset-helper 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (12) hide show

data/CHANGELOG.rdoc +3 -0
data/MIT-LICENSE +20 -0
data/README.rdoc +31 -0
data/Rakefile +40 -0
data/init.rb +14 -0
data/lib/action_view/helpers/smart_asset_helper.rb +85 -0
data/lib/action_view/helpers/smarter_asset_tag_helper.rb +30 -0
data/lib/asset_manager.rb +87 -0
data/test/small_asset_helper_test.rb +5 -0
data/test/test_helper.rb +3 -0
data/uninstall.rb +1 -0
metadata +78 -0

data/CHANGELOG.rdoc ADDED Viewed

@@ -0,0 +1,3 @@
+== 0.1.0, released 2009-04-16
+* Initial release

data/MIT-LICENSE ADDED Viewed

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Jeremy Boles
+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.rdoc ADDED Viewed

@@ -0,0 +1,31 @@
+= SmartAssetHelper
+SmartAssetHelper is a utility that add a number of conveniences for dealing with CSS and Javascript files. The library sprung out of a distain for how "dirty" my CSS and Javascript organization would get over time. SmartAssetHelper introduces an opinionated way to organize CSS and Javascript files and also contains a number of convenient helper methods to make your life easier.
+== Example
+SmartAssetHelper introduces two new methods for including CSS and Javascript within your <head> tag:
+  # app/views/layouts/application.html.erb
+  <html>
+    <head>
+      <%= include_stylesheets 'global' %>
+      <%= include_javascript :default %>
+    </head>
+    <body>
+      <%= yield %>
+    </body>
+  </html>
+The <code>include_stylesheets</code> and <code>include_javascript</code> helper methods will include asset files that have been 'required' by helper methods:
+  # app/views/users/new.html.erb
+  <% require_stylesheet 'form %>
+  <% require_javascript 'validations' %>
+  ...
+When the <code>include_stylesheets</code> and <code>include_javascript</code> methods are passed the <code>:auto => true</code> parameter, they will automatically include assets based on the request parameters (if the files exists).  For example, a request to <code>UsersController#index</code> will automatically include stylesheets at <code>/stylesheets/users.css</code> and <code>/stylesheets/users/index.css</code>, if they exsist.
+Copyright (c) 2009 (Jeremy Boles)[http://jeremyboles.com/], released under the MIT license

data/Rakefile ADDED Viewed

@@ -0,0 +1,40 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+desc 'Default: run unit tests.'
+task :default => :test
+desc 'Test the small_asset_helper plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+desc 'Generate documentation for the small_asset_helper plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'SmallAssetHelper'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+desc %{Update ".manifest" with the latest list of project filenames.}
+task :manifest do
+  list = `git ls-files --full-name --exclude=*.gemspec --exclude=.*`.chomp.split("\n")
+  if spec_file = Dir['*.gemspec'].first
+    spec = File.read spec_file
+    spec.gsub! /^(\s* s.(test_)?files \s* = \s* )( \[ [^\]]* \] | %w\( [^)]* \) )/mx do
+      assignment = $1
+      bunch = $2 ? list.grep(/^test\//) : list
+      '%s%%w(%s)' % [assignment, bunch.join(' ')]
+    end
+    File.open(spec_file, 'w') { |f| f << spec }
+  end
+  File.open('.manifest', 'w') { |f| f << list.join("\n") }
+end

data/init.rb ADDED Viewed

@@ -0,0 +1,14 @@
+require 'action_view/helpers/smart_asset_helper'
+require 'action_view/helpers/smarter_asset_tag_helper'
+ActionView::Base.class_eval do
+  include ActionView::Helpers::SmartAssetHelper
+  include ActionView::Helpers::SmarterAssetTagHelper
+end
+ActionController::Base.class_eval do
+  before_filter :create_asset_manager_instance
+  def create_asset_manager_instance
+    @_asset_manager = AssetManager.new
+  end
+end

data/lib/action_view/helpers/smart_asset_helper.rb ADDED Viewed

@@ -0,0 +1,85 @@
+require 'asset_manager'
+module ActionView
+  module Helpers
+    module SmartAssetHelper
+      # Prevent a javscript file from being required
+      def deny_javascript(*javascripts)
+        @_asset_manager.deny(:js, javascripts)
+      end
+      # Prevent a stylesheet file from being required
+      def deny_stylesheet(*stylesheets)
+        @_asset_manager.deny(:css, stylesheets)
+      end
+      # Print required javascript
+      def include_javascript(*args)
+        options = extract_options(args)
+        javascript = javascript_include_tag(*include_assets(:js, args, options))
+        javascript += ie_assets(:js, args) if options[:ie]
+        javascript.gsub("\n", '')
+      end
+      # Print required stylesheets
+      def include_stylesheets(*args)
+        options = extract_options(args)
+        stylesheets = stylesheet_link_tag(*include_assets(:css, args, options))
+        stylesheets += ie_assets(:css, args) if options[:ie]
+        stylesheets.gsub("\n", '')
+      end
+      # Require bot Javscript and CSS
+      def require_assets(*assets)
+        require_stylesheet(*assets)
+        require_javascript(*assets)
+      end
+      # Request a javascript to be outputed by include_javascript
+      def require_javascript(*javascripts)
+        @_asset_manager.add(:js, javascripts)
+      end
+      # Request a stylesheet to be outputed by include_stylesheets
+      def require_stylesheet(*stylesheets)
+        @_asset_manager.add(:css, stylesheets)
+      end
+    private
+      def conditional_comment(text, version)
+        "<!--[if IE #{version}]>#{text}<![endif]-->"
+      end
+      def extract_options(args)
+        options = args.delete(args.last) if args.last.is_a?(Hash)
+        options || {}
+      end
+      def ie_assets(asset_type, args)
+        ie_assets = ''
+        %w{ 6 7 8 }.each do |v|
+          assets = @_asset_manager.required_with_extra(asset_type, "ie#{v}")
+          unless assets.blank?
+            assets = case asset_type
+              when :css : stylesheet_link_tag(assets)
+              when :js : javascript_include_tag(assets)
+            end
+            ie_assets += conditional_comment(assets.to_s, v)
+          end
+        end
+        ie_assets
+      end
+      def include_assets(asset_type, args, options)
+        @_asset_manager.append(asset_type, args) unless args.empty?
+        @_asset_manager.auto_add(asset_type, params) if options[:auto]
+        @_asset_manager.required(asset_type)
+      end
+    end
+  end
+end

data/lib/action_view/helpers/smarter_asset_tag_helper.rb ADDED Viewed

@@ -0,0 +1,30 @@
+module ActionView
+  module Helpers
+    module SmarterAssetTagHelper
+      def self.included(base)
+        base.send :include, InstanceMethods
+        base.send :alias_method_chain, :javascript_include_tag, :query_strings
+      end
+      module InstanceMethods
+        # This is to cope with Rails appending '.js' to things like Google maps API and other things
+        # that have query strings
+        def javascript_include_tag_with_query_strings(*sources)
+          query_strings_sources = sources.flatten.select { |s| s =~ /[\?]/ }
+          sources = sources.flatten - query_strings_sources
+          script_tag(query_strings_sources) + javascript_include_tag_without_query_strings(*sources)
+        end
+        def script_tag(*sources)
+          sources.map do |s|
+            content_tag(:script, '', :src => s, :type => 'text/javascript')
+          end.join
+        end
+      end
+    end
+  end
+end

data/lib/asset_manager.rb ADDED Viewed

@@ -0,0 +1,87 @@
+class AssetManager
+  ASSET_DIR = {
+    :js => ActionView::Helpers::AssetTagHelper::JAVASCRIPTS_DIR,
+    :css => ActionView::Helpers::AssetTagHelper::STYLESHEETS_DIR
+  }
+  SHORTCUTS = {
+    :css => {},
+    :js => { :defaults => ActionView::Helpers::AssetTagHelper::JAVASCRIPT_DEFAULT_SOURCES }
+  }
+  def initialize
+    @denied = { :css => [], :js => [] }
+    @required = { :css => [], :js => [] }
+  end
+  # Add assets to the list of required assets
+  def add(asset_type, *assets)
+    @required[asset_type] << assets
+  end
+  # Append assets to the front of the list of assets
+  def append(asset_type, *assets)
+    @required[asset_type] = assets + @required[asset_type]
+  end
+  # Automaticly add assets based the controller/action params, if they exsist
+  def auto_add(asset_type, request_params)
+    files, prefix = [], ''
+    (request_params[:controller] + '/' + request_params[:action]).split('/').each do |path|
+      path = prefix + path
+      asset_path = "#{path}.#{asset_type}"
+      file_path = "#{ASSET_DIR[asset_type]}/#{asset_path}"
+      files << path if File.exists?(file_path)
+      prefix = path + '/'
+    end
+    self.add(asset_type, files)
+  end
+  # Prevent an asset from being required
+  def deny(asset_type, *assets)
+    @denied[asset_type] << assets
+  end
+  # Returns a list of assets that have been required
+  def required(asset_type)
+    files = extract(asset_type)
+    files = process_shortcuts(asset_type, files)
+    files
+  end
+  def required_with_extra(asset_type, extra)
+    files = []
+    self.required(asset_type).each do |file|
+      path = "#{file}-#{extra}"
+      asset_path = "#{path}.#{asset_type}"
+      file_path = "#{ASSET_DIR[asset_type]}/#{asset_path}"
+      files << path if File.exists?(file_path)
+    end
+    files
+  end
+private
+  # Extracts the required files, unique and honoring denied assets
+  def extract(asset_type)
+    seen_files = @denied[asset_type].flatten
+    required_files = @required[asset_type].flatten.inject([]) do |required, files|
+      files_to_include = files.to_a - seen_files
+      seen_files += files_to_include
+      required << files_to_include unless files_to_include.empty?
+      required
+    end.flatten
+  end
+  # Processes the shortcuts
+  def process_shortcuts(asset_type, files)
+    files.flatten.map do |file|
+      file = SHORTCUTS[asset_type][file] if SHORTCUTS[asset_type].has_key?(file)
+      file
+    end.flatten
+  end
+end

data/test/small_asset_helper_test.rb ADDED Viewed

@@ -0,0 +1,5 @@
+require 'test_helper'
+class SmallAssetHelperTest < ActiveSupport::TestCase
+end

data/test/test_helper.rb ADDED Viewed

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'active_support'
+require 'active_support/test_case'

data/uninstall.rb ADDED Viewed

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

metadata ADDED Viewed

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: jeremyboles-smart-asset-helper
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jeremy Boles
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2009-04-19 00:00:00 -07:00
+default_executable:
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  type: :runtime
+  version_requirement:
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "="
+      - !ruby/object:Gem::Version
+        version: 2.3.2
+    version:
+description: SmartAssetHelper helps ease some of the pain with dealing and organizing stylesheet and javascript files.
+email: jeremy@jeremyboles.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+- MIT-LICENSE
+- CHANGELOG.rdoc
+files:
+- CHANGELOG.rdoc
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- init.rb
+- lib/action_view/helpers/smart_asset_helper.rb
+- lib/action_view/helpers/smarter_asset_tag_helper.rb
+- lib/asset_manager.rb
+- test/small_asset_helper_test.rb
+- test/test_helper.rb
+- uninstall.rb
+has_rdoc: true
+homepage: http://github.com/jeremyboles/smart-asset-helper/wikis
+post_install_message:
+rdoc_options:
+- --main
+- README.rdoc
+- --inline-source
+- --charset=UTF-8
+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:
+rubygems_version: 1.2.0
+signing_key:
+specification_version: 2
+summary: A simple Rails plugin for dealing with stylesheet and javascript management and organization.
+test_files:
+- test/small_asset_helper_test.rb
+- test/test_helper.rb