sprockets_relative_url 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f6828c7133914066d3801a9db6b921e185ff23d3
+  data.tar.gz: fd1d1436b1eef3bd5cb65160fb9460c8d98d9df6
+SHA512:
+  metadata.gz: bbad6f0dad17a64b955d96be5ff18606cd1bf5edb228f3843f51c7044a1a67465ce386874d56ab57da95ef2a27ef55b3e61e4d15e5de00ce3b2193dfe6b5c76a
+  data.tar.gz: 898bdae3a5367c1e515204bb8a81d133913a1b5e0605aea57aea3828d9f568627112b629676c10caf51597caf05dff2a6c0b5e9f541b0a2edd22358af27b0e4f

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--format documentation

data/.rubocop.yml

@@ -0,0 +1,2 @@
+Documentation:
+  Enabled: false

data/.simplecov

@@ -0,0 +1,3 @@
+SimpleCov.start do
+  add_filter('spec')
+end

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sprockets_relative_url.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,14 @@
+guard :rspec, cmd: 'bundle exec rspec' do
+  watch(/^spec\/.+_spec\.rb$/)
+  watch(/^lib\/(.+)\.rb$/)     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb') { 'spec' }
+end
+
+guard :rubocop do
+  watch('Gemfile')
+  watch('Guardfile')
+  watch('Rakefile')
+  watch(/.+\.gemspec$/)
+  watch(/.+\.rb$/)
+  watch(/(?:.+\/)?\.rubocop\.yml$/) { |m| File.dirname(m[0]) }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Shaun Mangelsdorf
+
+MIT License
+
+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,40 @@
+# Sprockets Relative URL support
+
+Fixes relative URLs in CSS assets using Sprockets.
+
+Each asset is resolved from Sprockets, and its relative URL will be rewritten to
+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:
+
+- Rails
+- TODO: Sinatra
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sprockets_relative_url'
+
+## Usage
+
+### Rails
+
+Add the processor to the Rails asset pipeline:
+
+    Rails.application.assets
+      .register_postprocessor('text/css', SprocketsRelativeUrl::Processor)
+
+### Sinatra
+
+TODO
+
+## 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

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/lib/sprockets_relative_url/processor.rb

@@ -0,0 +1,37 @@
+module SprocketsRelativeUrl
+  class Processor < Sprockets::Processor
+    CSS_URL_REGEXP = /
+      (?<=\burl\()      # Match url\( prefix
+      \s*
+      (?<q>['"]?)       # Opening quote
+      (?<path>[^\)]+?)  # Capture actual path
+      \k<q>             # Backref for closing quote
+      \s*
+      (?=\))            # Match \) terminator
+    /x
+
+    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)
+      end
+    end
+
+    private
+
+    def root_relative_path(context, path)
+      asset_full_path = context.pathname.parent.join(path)
+      asset = context.environment.find_asset(asset_full_path)
+
+      return path if asset.nil?
+
+      context.asset_path(asset.logical_path)
+    end
+
+    def should_skip?(path)
+      path.start_with?('/') || path.include?('\\') || URI.parse(path).absolute?
+    end
+  end
+end

data/lib/sprockets_relative_url/version.rb

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

data/lib/sprockets_relative_url.rb

@@ -0,0 +1,9 @@
+require 'sprockets'
+
+require 'sprockets_relative_url/version'
+
+module SprocketsRelativeUrl
+  # Your code goes here...
+end
+
+require 'sprockets_relative_url/processor'

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'simplecov'
+
+RSpec.configure do |config|
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  config.order = :random
+  Kernel.srand config.seed
+
+  config.expect_with :rspec do |expectations|
+    expectations.syntax = :expect
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.syntax = :expect
+    mocks.verify_partial_doubles = true
+  end
+end

data/spec/sprockets_relative_url/processor_spec.rb

@@ -0,0 +1,148 @@
+require 'sprockets_relative_url'
+
+describe SprocketsRelativeUrl::Processor do
+  let(:env) do
+    Sprockets::Environment.new.tap do |env|
+      env.append_path('tmp')
+    end
+  end
+
+  let(:base_path) { Pathname.new(File.expand_path('./tmp')) }
+  let(:context) do
+    double(
+      pathname: base_path + 'css' + 'application.css',
+      environment: env
+    )
+  end
+  let(:asset_prefix) { '/assets' }
+
+  let(:files) { %w(images/background.gif css/extra/test.gif) }
+  let(:hash) { SecureRandom.hex(20) }
+
+  subject { SprocketsRelativeUrl::Processor.new { data } }
+
+  before do
+    files.each do |file|
+      pathname = base_path.join(file)
+      pathname.parent.mkpath
+      pathname.write('') unless pathname.exist?
+    end
+
+    allow(context).to receive(:asset_path) do |s|
+      base, _, suffix = s.rpartition('.')
+      File.join(asset_prefix, "#{base}-#{hash}.#{suffix}")
+    end
+  end
+
+  shared_examples 'rewrite the url' do
+    it 'rewrites the url' do
+      expect(subject.evaluate(context)).to match expected
+    end
+  end
+
+  shared_examples 'leave the url alone' do
+    it 'leaves the url alone' do
+      expect(subject.evaluate(context)).to be == data
+    end
+  end
+
+  context 'with a simple url' do
+    let(:data) { 'background: url(../images/background.gif)' }
+    let(:expected) do
+      %r{\Abackground: url\(/assets/images/background-\h+\.gif\)\z}
+    end
+
+    include_examples 'rewrite the url'
+
+    context 'with single quotes' do
+      let(:data) { "background: url('../images/background.gif')" }
+      include_examples 'rewrite the url'
+    end
+
+    context 'with double quotes' do
+      let(:data) { 'background: url("../images/background.gif")' }
+      include_examples 'rewrite the url'
+    end
+
+    context 'with surrounding whitespace' do
+      let(:data) { 'background: url( ../images/background.gif )' }
+      include_examples 'rewrite the url'
+
+      context 'with single quotes' do
+        let(:data) { "background: url( '../images/background.gif' )" }
+        include_examples 'rewrite the url'
+      end
+
+      context 'with double quotes' do
+        let(:data) { 'background: url( "../images/background.gif" )' }
+        include_examples 'rewrite the url'
+      end
+    end
+  end
+
+  context 'with an expected hash' do
+    let(:hash) { '1234abcd' }
+    let(:data) { 'background: url(../images/background.gif)' }
+    let(:expected) { 'background: url(/assets/images/background-1234abcd.gif)' }
+
+    include_examples 'rewrite the url'
+  end
+
+  context 'with a different asset prefix' do
+    let(:asset_prefix) { '/differentpath' }
+    let(:data) { 'background: url(../images/background.gif)' }
+    let(:expected) do
+      %r{\Abackground: url\(/differentpath/images/background-\h+\.gif\)\z}
+    end
+
+    include_examples 'rewrite the url'
+  end
+
+  context 'with trailing text' do
+    let(:data) { 'background: url(../images/background.gif) repeat-x' }
+    let(:expected) do
+      %r{\Abackground: url\(/assets/images/background-\h+\.gif\) repeat-x\z}
+    end
+
+    include_examples 'rewrite the url'
+  end
+
+  context 'with a lower relative url' do
+    let(:data) { 'background: url(extra/test.gif)' }
+    let(:expected) do
+      %r{\Abackground: url\(/assets/css/extra/test-\h+\.gif\)\z}
+    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'
+  end
+
+  context 'with an absolute url' do
+    let(:data) { 'background: url(http://example.com/images/background.gif)' }
+    include_examples 'leave the url alone'
+  end
+
+  context 'with a non-existent file' do
+    let(:data) { 'background: url(../images/nonexistent.gif)' }
+    include_examples 'leave the url alone'
+  end
+
+  context 'with preceding characters' do
+    let(:data) { 'background: nurl(../images/background.gif)' }
+    include_examples 'leave the url alone'
+  end
+
+  context 'with escaped characters' do
+    let(:data) { 'background: url(../\ images/background.gif)' }
+    include_examples 'leave the url alone'
+  end
+
+  context 'with escaped parentheses' do
+    let(:data) { 'background: url(../\)images/background.gif)' }
+    include_examples 'leave the url alone'
+  end
+end

data/sprockets_relative_url.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sprockets_relative_url/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'sprockets_relative_url'
+  spec.version       = SprocketsRelativeUrl::VERSION
+  spec.authors       = ['Shaun Mangelsdorf']
+  spec.email         = %w(s.mangelsdorf@gmail.com)
+  spec.summary       = 'Fixes relative URLs in CSS assets using Sprockets.'
+  spec.homepage      = 'https://github.com/smangelsdorf/sprockets_relative_url'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
+  spec.require_paths = %w(lib)
+
+  spec.add_development_dependency 'guard'
+  spec.add_development_dependency 'guard-rubocop'
+  spec.add_development_dependency 'guard-rspec'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'simplecov'
+
+  spec.add_runtime_dependency 'sprockets', '~> 2.12'
+end

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: sprockets_relative_url
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Shaun Mangelsdorf
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: guard
+  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: guard-rubocop
+  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: guard-rspec
+  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: rspec
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: simplecov
+  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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+description: 
+email:
+- s.mangelsdorf@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".simplecov"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sprockets_relative_url.rb
+- lib/sprockets_relative_url/processor.rb
+- lib/sprockets_relative_url/version.rb
+- spec/spec_helper.rb
+- spec/sprockets_relative_url/processor_spec.rb
+- sprockets_relative_url.gemspec
+homepage: https://github.com/smangelsdorf/sprockets_relative_url
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Fixes relative URLs in CSS assets using Sprockets.
+test_files:
+- spec/spec_helper.rb
+- spec/sprockets_relative_url/processor_spec.rb