sprockets_relative_url 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f6828c7133914066d3801a9db6b921e185ff23d3
-  data.tar.gz: fd1d1436b1eef3bd5cb65160fb9460c8d98d9df6
+  metadata.gz: 7f178dd2d77344289848a57b1ad03e3fda57ed14
+  data.tar.gz: c66cc99fd140581195a2b974e24674b09991c929
 SHA512:
-  metadata.gz: bbad6f0dad17a64b955d96be5ff18606cd1bf5edb228f3843f51c7044a1a67465ce386874d56ab57da95ef2a27ef55b3e61e4d15e5de00ce3b2193dfe6b5c76a
-  data.tar.gz: 898bdae3a5367c1e515204bb8a81d133913a1b5e0605aea57aea3828d9f568627112b629676c10caf51597caf05dff2a6c0b5e9f541b0a2edd22358af27b0e4f
+  metadata.gz: 74be7143490d14c696eee9e5a57e746011b58a74963856e6fff290a829176cf4ec7e2aef939cf64ad2d493579bd447c2c37b1af0991eb63ea8440b29591582e0
+  data.tar.gz: 2383006eab8ca1236d8fe2a7086f9d24d366c58e87a699457cbc686bff43f8ef6906964d5c42fdb1ed339c6f763bf0a7b0c713529062b8936457bba15ff4e722

data/.rubocop.yml

@@ -1,2 +1,5 @@
 Documentation:
   Enabled: false
+
+Encoding:
+  Enabled: false

data/.simplecov

@@ -1,3 +1,10 @@
+require 'coveralls'
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+
 SimpleCov.start do
   add_filter('spec')
 end

data/.travis.yml

@@ -0,0 +1,8 @@
+---
+language: ruby
+rvm:
+  - 2.1.1
+  - 2.0.0
+  - 1.9.3
+  - jruby-1.7.11
+  - rbx-2.2.10

data/README.md

@@ -1,5 +1,26 @@
 # Sprockets Relative URL support
 
+[![Gem Version][GV img]][Gem Version]
+[![Build Status][BS img]][Build Status]
+[![Dependency Status][DS img]][Dependency Status]
+[![Code Climate][CC img]][Code Climate]
+[![Coverage Status][CS img]][Coverage Status]
+[![Semantic Versioning][SV img]][Semantic Versioning]
+
+[Gem Version]: https://rubygems.org/gems/sprockets_relative_url
+[Build Status]: https://travis-ci.org/smangelsdorf/sprockets_relative_url
+[Dependency Status]: https://gemnasium.com/smangelsdorf/sprockets_relative_url
+[Code Climate]: https://codeclimate.com/github/smangelsdorf/sprockets_relative_url
+[Coverage Status]: https://coveralls.io/r/smangelsdorf/sprockets_relative_url
+[Semantic Versioning]: http://semver.org
+
+[GV img]: https://img.shields.io/gem/v/sprockets_relative_url.svg
+[BS img]: https://img.shields.io/travis/smangelsdorf/sprockets_relative_url.svg
+[DS img]: https://img.shields.io/gemnasium/smangelsdorf/sprockets_relative_url.svg
+[CC img]: https://img.shields.io/codeclimate/github/smangelsdorf/sprockets_relative_url.svg
+[CS img]: https://img.shields.io/coveralls/smangelsdorf/sprockets_relative_url.svg
+[SV img]: http://img.shields.io/badge/semver-%E2%9C%94-brightgreen.svg
+
 Fixes relative URLs in CSS assets using Sprockets.
 
 Each asset is resolved from Sprockets, and its relative URL will be rewritten to
@@ -7,16 +28,19 @@ use a precompiled version. By adding this preprocessor, CSS frameworks can be
 minified and combined into your `application.css` file without any need to
 rewrite the `url()` values in their CSS.
 
-Tested with:
+Tested Rubies:
 
-- Rails
-- TODO: Sinatra
+- MRI 1.9.3, 2.0.0, 2.1.x
+- JRuby 1.7.x
+- Rubinius 2.2.x
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'sprockets_relative_url'
+```ruby
+gem 'sprockets_relative_url'
+```
 
 ## Usage
 
@@ -24,17 +48,57 @@ Add this line to your application's Gemfile:
 
 Add the processor to the Rails asset pipeline:
 
-    Rails.application.assets
-      .register_postprocessor('text/css', SprocketsRelativeUrl::Processor)
+```ruby
+# config/initializers/sprockets_relative_url.rb
+Rails.application.assets
+  .register_postprocessor('text/css', SprocketsRelativeUrl::Processor)
+```
+
+Ensure referenced assets are being precompiled. For example:
+
+```ruby
+# config/application.rb
+config.assets.precompile << /(fonts|images)\/.*/
+```
+
+### Standalone Sprockets
+
+```ruby
+env = Sprockets::Environment.new
+env.append_path('app/assets')
+env.register_postprocessor('text/css', SprocketsRelativeUrl::Processor)
+```
+
+Similar to the Rails setup above, you will need to ensure that referenced assets
+are being precompiled.
+
+## Caveats
+
+This library uses a regular expression to grab `url(...)` values out of CSS,
+which has some drawbacks:
+
+* No support for escaped parentheses inside URLs:
+
+    ```css
+    background: url(images/mainbg\(white\).png);
+    ```
+
+    This issue is addressed by ignoring any URL which contains a backslash
+    character, but this obviously means that escaped characters in a URL are
+    prohibited. Special characters can be URL encoded to work around this.
 
-### Sinatra
+* Deliberately malformed CSS can probably trick the regular expression into
+    matching something it shouldn't. This should never be an issue, but it's
+    worth mentioning.
 
-TODO
+These could be fixed properly by building a full CSS parser into the processor,
+but the additional complexity is prohibitive.
 
 ## Contributing
 
 1. Fork it ( https://github.com/smangelsdorf/sprockets_relative_url/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+4. Verify project tests and style (`rake`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create a new Pull Request

data/Rakefile

@@ -1 +1,8 @@
 require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+task default: [:spec, :rubocop]

data/lib/sprockets_relative_url/processor.rb

@@ -1,37 +1,45 @@
 module SprocketsRelativeUrl
   class Processor < Sprockets::Processor
     CSS_URL_REGEXP = /
-      (?<=\burl\()      # Match url\( prefix
+      (?<=[^a-zA-Z0-9_-]url\()  # Match url\( prefix
       \s*
-      (?<q>['"]?)       # Opening quote
-      (?<path>[^\)]+?)  # Capture actual path
-      \k<q>             # Backref for closing quote
+      (?<q>['"]?)               # Opening quote
+      (?<path>[^\)]+?)          # Capture actual path
+      \k<q>                     # Backref for closing quote
       \s*
-      (?=\))            # Match \) terminator
+      (?=\))                    # Match \) terminator
     /x
 
+    private_constant :CSS_URL_REGEXP
+
     def evaluate(context, *)
       data.gsub(CSS_URL_REGEXP) do
         path = Regexp.last_match[:path]
-
         next path if should_skip?(path)
-        root_relative_path(context, path)
+
+        uri = URI.parse(path)
+        next path if uri.absolute?
+
+        uri.path = root_relative_path(context, uri.path)
+        uri.to_s
       end
     end
 
     private
 
     def root_relative_path(context, path)
-      asset_full_path = context.pathname.parent.join(path)
+      decoded = URI.decode(path)
+      asset_full_path = context.pathname.parent.join(decoded)
       asset = context.environment.find_asset(asset_full_path)
 
       return path if asset.nil?
 
-      context.asset_path(asset.logical_path)
+      encoded = URI.encode(asset.logical_path)
+      context.asset_path(encoded)
     end
 
     def should_skip?(path)
-      path.start_with?('/') || path.include?('\\') || URI.parse(path).absolute?
+      path.start_with?('/') || path.include?('\\')
     end
   end
 end

data/lib/sprockets_relative_url/version.rb

@@ -1,3 +1,3 @@
 module SprocketsRelativeUrl
-  VERSION = '0.0.1'
+  VERSION = '1.0.0'
 end

data/spec/sprockets_relative_url/processor_spec.rb

@@ -16,8 +16,8 @@ describe SprocketsRelativeUrl::Processor do
   end
   let(:asset_prefix) { '/assets' }
 
-  let(:files) { %w(images/background.gif css/extra/test.gif) }
-  let(:hash) { SecureRandom.hex(20) }
+  let(:files) { %w(images/background.gif css/extra/test.gif images/\.gif) }
+  let(:hash) { Time.now.to_i.to_s }
 
   subject { SprocketsRelativeUrl::Processor.new { data } }
 
@@ -25,7 +25,7 @@ describe SprocketsRelativeUrl::Processor do
     files.each do |file|
       pathname = base_path.join(file)
       pathname.parent.mkpath
-      pathname.write('') unless pathname.exist?
+      pathname.open('w').close unless pathname.exist?
     end
 
     allow(context).to receive(:asset_path) do |s|
@@ -116,6 +116,31 @@ describe SprocketsRelativeUrl::Processor do
     include_examples 'rewrite the url'
   end
 
+  context 'with url encoding' do
+    let(:data) { 'background: url(../images/%5c.gif)' }
+    let(:expected) { %r{background: url\(/assets/images/%5[cC]-\h+\.gif\)} }
+
+    include_examples 'rewrite the url'
+  end
+
+  context 'with query parameters' do
+    let(:data) { 'background: url(../images/background.gif?1)' }
+    let(:expected) do
+      %r{background: url\(/assets/images/background-\h+\.gif\?1\)}
+    end
+
+    include_examples 'rewrite the url'
+  end
+
+  context 'with a url fragment' do
+    let(:data) { 'background: url(../images/background.gif#1)' }
+    let(:expected) do
+      %r{background: url\(/assets/images/background-\h+\.gif#1\)}
+    end
+
+    include_examples 'rewrite the url'
+  end
+
   context 'with a root-relative url' do
     let(:data) { 'background: url(/images/background.gif)' }
     include_examples 'leave the url alone'

data/sprockets_relative_url.gemspec

@@ -24,6 +24,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.6'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'coveralls'
 
   spec.add_runtime_dependency 'sprockets', '~> 2.12'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sprockets_relative_url
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Shaun Mangelsdorf
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-03 00:00:00.000000000 Z
+date: 2014-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: guard
@@ -108,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sprockets
   requirement: !ruby/object:Gem::Requirement
@@ -133,6 +147,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".simplecov"
+- ".travis.yml"
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -171,3 +186,4 @@ summary: Fixes relative URLs in CSS assets using Sprockets.
 test_files:
 - spec/spec_helper.rb
 - spec/sprockets_relative_url/processor_spec.rb
+has_rdoc: