css_asset_tagger 1.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Redline Software Inc.
+
+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,39 @@
+# CssAssetTagger
+
+Adds asset query strings to assets found in css files.  This gem originated as a rails plugin well before the asset pipeline was part of rails.  This plugin is still useful in Rails 3.1+ apps though if the asset pipeline is not enabled.
+
+## Install
+
+In your Gemfile:  
+`gem 'css_asset_tagger', :git => 'git://github.com/redlinesoftware/css_asset_tagger.git'`
+
+## Example
+
+Simply install the plugin and css files will be updated to include asset tags for any found assets.
+
+before:  
+`background: url("/images/background.png") repeat-x scroll 0 0 #ffffff;`
+
+after:  
+`background: url(/images/background.png?1296473764) repeat-x scroll 0 0 #ffffff;`
+
+To modify the plugins behaviour, add an initializer file to config/initializers  
+
+* __perform_tagging__ - Flag to determine if the css files should be modified with asset tags.  
+    Defaults to tag in production only.
+* __css_paths__ - An array of css stylesheet paths. Defaults to the main stylesheets path.  
+    Defaults to ["#{Rails.root}/public/stylesheets"]
+* __asset_path__ - The main asset path to be used when looking for assets with absolute file references.  
+    Defaults to Rails.root.join('public')
+* __show_warnings__ - Set to true to see warnings for assets that can't be found on the filesystem or false to not show the warnings.  
+    Defaults to showing warnings in dev mode only.
+
+ex. config/initializers/css_tagger_options.rb
+
+    require 'css_asset_tagger_options'
+    
+    CssAssetTaggerOptions.setup do |config|
+      config.perform_tagging = true
+    end
+
+Copyright (c) 2009-2013 Redline Software Inc., released under the MIT license

data/lib/css_asset_tagger.rb

@@ -0,0 +1,41 @@
+class CssAssetTagger
+  def self.tag(paths, logger = nil)
+    logger ||= Logger.new($stderr)
+
+    paths.each do |path|
+      files = Dir.glob(File.join(path, '**/*.css'))
+      for file in files
+        css = File.read file
+        res = css.gsub!(/url\((?:"([^"]*)"|'([^']*)'|([^)]*))\)/mi) do |s|
+          # $1 is the double quoted string, $2 is single quoted, $3 is no quotes
+          uri = ($1 || $2 || $3).to_s.strip
+
+          # if the uri appears to begin with a protocol then the asset isn't on the local filesystem
+          # or if query string appears to exist already, the uri is returned as is
+          if uri =~ /[a-z]+:\/\//i || uri =~ /(\?|&)\d{10}/
+            "url(#{uri})"
+          else
+            # if the first char is a / then get the path of the file with respect to the absolute path of the asset files
+            # otherwise get the path relative to the current file
+            path = (uri.chars.first == '/' ? "#{CssAssetTaggerOptions.asset_path}#{uri}" : "#{File.dirname(file)}/#{uri}")
+
+            begin
+              # construct the uri with the associated asset query string
+              sep = (uri =~ /\?/).nil? ? '?' : '&'
+              "url(#{uri}#{sep}#{File.stat(path).mtime.to_i})"
+            rescue Errno::ENOENT
+              # the asset can't be found, so return the uri as is
+              logger.warn "CssAssetTagger: #{path} referenced from #{file} cannot be found." if CssAssetTaggerOptions.show_warnings
+              "url(#{uri})"
+            end
+          end
+        end
+
+        # write the new contents of the file out if asset tags were added
+        File.open(file, 'w'){|f| f.puts css} unless res.nil?
+      end
+    end
+  end
+end
+
+require 'css_asset_tagger/railtie' if defined?(Rails)

data/lib/css_asset_tagger/railtie.rb

@@ -0,0 +1,13 @@
+require 'rails/railtie'
+
+module CssAssetTaggerOptions
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      Dir[File.expand_path('../../tasks/*.rake', __FILE__)].each { |f| load f }
+    end
+
+    config.to_prepare do
+      CssAssetTagger.tag(CssAssetTaggerOptions.css_paths) if CssAssetTaggerOptions.perform_tagging
+    end
+  end
+end

data/lib/css_asset_tagger/version.rb

@@ -0,0 +1,3 @@
+module CssAssetTaggerOptions
+  VERSION = '1.1'.freeze
+end

data/lib/css_asset_tagger_options.rb

@@ -0,0 +1,14 @@
+module CssAssetTaggerOptions
+  mattr_accessor :perform_tagging, :css_paths, :asset_path, :show_warnings
+
+  if defined?(Rails)
+    @@perform_tagging = Rails.env.production?
+    @@css_paths = %W(#{Rails.root}/public/stylesheets)
+    @@asset_path = Rails.root.join('public')
+    @@show_warnings = Rails.env.development?
+  end
+
+  def self.setup
+    yield self
+  end
+end

data/lib/tasks/css_asset_tagger_tasks.rake

@@ -0,0 +1,9 @@
+require 'css_asset_tagger'
+require 'css_asset_tagger_options'
+
+namespace :css_asset_tagger do
+  desc "Add asset timestamps to assets found in the project stylesheets"
+  task :tag do
+    CssAssetTagger.tag CssAssetTaggerOptions.css_paths
+  end
+end

data/test/css_asset_tagger_test.rb

@@ -0,0 +1,37 @@
+require 'rubygems'
+
+require 'test/unit'
+require 'active_support/all'
+
+require 'css_asset_tagger'
+require 'css_asset_tagger_options'
+
+class CssAssetTaggerTest < Test::Unit::TestCase
+  ASSET_PATH = File.dirname(__FILE__)+'/assets'
+  TEST_STYLESHEET = ASSET_PATH+'/stylesheets/test.css'
+
+  def setup
+    CssAssetTaggerOptions.perform_tagging = true
+    CssAssetTaggerOptions.asset_path = [ASSET_PATH]
+    FileUtils.cp TEST_STYLESHEET+'.template', TEST_STYLESHEET
+  end
+
+  def teardown
+    FileUtils.rm TEST_STYLESHEET
+  end
+
+  def test_this_plugin
+    # TODO capture the warnings and test for them
+    # how is this done?
+    l = Logger.new STDOUT
+    l.level = Logger::ERROR
+
+    CssAssetTagger.tag [ASSET_PATH+'/stylesheets'], l
+
+    # set the timestamps for the relative and absolute images
+    abs_time = File.stat(ASSET_PATH+'/images/test.png').mtime.to_i
+    rel_time = File.stat(ASSET_PATH+'/stylesheets/images/test.png').mtime.to_i
+
+    assert_equal ERB.new(File.read(TEST_STYLESHEET+'.expected')).result(self.send(:binding)).to_s, File.read(TEST_STYLESHEET).to_s
+  end
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification 
+name: css_asset_tagger
+version: !ruby/object:Gem::Version 
+  hash: 13
+  prerelease: 
+  segments: 
+  - 1
+  - 1
+  version: "1.1"
+platform: ruby
+authors: 
+- Andrew Kaspick
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-02-06 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        version: "3.0"
+  type: :runtime
+  version_requirements: *id001
+description: Tags assets in Rails app css files with asset query strings.
+email: contact@plataformatec.com.br
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- MIT-LICENSE
+- README.md
+- lib/tasks/css_asset_tagger_tasks.rake
+- lib/css_asset_tagger_options.rb
+- lib/css_asset_tagger.rb
+- lib/css_asset_tagger/railtie.rb
+- lib/css_asset_tagger/version.rb
+- test/css_asset_tagger_test.rb
+homepage: https://github.com/redlinesoftware/css_asset_tagger
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Tags assets in Rails app css files with asset query strings.
+test_files: 
+- test/css_asset_tagger_test.rb