css-rewrite 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fc776cbf9f90435b4988cf29c875cbb2ce2e691c
+  data.tar.gz: afdc21aa137284b0242ade4d4355641b29f1718c
+SHA512:
+  metadata.gz: f5218b6f5ddd5be6bbc8fd333c91833d9847c35c61ea2207a72b63cd2bee5537975cde43b8efe845e14910d0054b40a3ba113f674673b8103a3626bf71a50bdb
+  data.tar.gz: db6eb3a7cc43d1853b1d8f58663a74b935adc45bd4bc4f1981853efb3db2852eaec81f88926a45bdeac2c09a079f42929a395c816397959c58481d5aece2070e

data/Gemfile

@@ -0,0 +1,2 @@
+ENV['BUNDLE_GEMFILE'] = File.expand_path('../Gemfile-rails-4.2.x', __FILE__)
+Bundler.load

data/Rakefile

@@ -0,0 +1,23 @@
+# encoding: UTF-8
+
+$:.unshift File.join(File.dirname(__FILE__), 'lib')
+
+require 'rubygems' unless ENV['NO_RUBYGEMS']
+
+require 'bundler'
+require 'pry-byebug'
+require 'rspec/core/rake_task'
+require 'rubygems/package_task'
+
+require 'rails'
+require 'sprockets/railtie'
+require 'css-rewrite'
+
+Bundler::GemHelper.install_tasks
+
+task default: :spec
+
+desc 'Run specs'
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = './spec/**/*_spec.rb'
+end

data/css-rewrite.gemspec

@@ -0,0 +1,22 @@
+$:.unshift File.join(File.dirname(__FILE__), 'lib')
+require 'css-rewrite/version'
+
+Gem::Specification.new do |s|
+  s.name     = 'css-rewrite'
+  s.version  = ::CssRewrite::VERSION
+  s.authors  = ['Cameron Dutro']
+  s.email    = ['camertron@gmail.com']
+  s.homepage = 'http://github.com/camertron/css-rewrite'
+
+  s.description = s.summary = 'Rewrite URLs in your 3rd-party CSS files using the asset pipeline.'
+
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+
+  s.add_dependency 'sprockets', '~> 3.0'
+  s.add_dependency 'railties', '>= 4.0'
+  s.add_dependency 'crass'
+
+  s.require_path = 'lib'
+  s.files = Dir['{lib,spec}/**/*', 'Gemfile', 'README.md', 'Rakefile', 'css-rewrite.gemspec']
+end

data/lib/css-rewrite/call_rewriter.rb

@@ -0,0 +1,21 @@
+module CssRewrite
+  class CallRewriter
+    def self.applies_to?(*args, &block)
+      args.size == 0 && block.present?
+    end
+
+    attr_reader :replacement_block
+
+    def initialize(&block)
+      @replacement_block = block
+    end
+
+    def matches?(url)
+      true
+    end
+
+    def rewrite(url, filename)
+      replacement_block.call(url, filename)
+    end
+  end
+end

data/lib/css-rewrite/config.rb

@@ -0,0 +1,23 @@
+module CssRewrite
+  class Config
+    def self.instance
+      @instance ||= new
+    end
+
+    def self.reset
+      @instance = nil
+    end
+
+    attr_reader :rewriters
+
+    def rewrite(*args, &block)
+      rewriters << Rewriter.create(*args, &block)
+    end
+
+    private
+
+    def initialize
+      @rewriters = []
+    end
+  end
+end

data/lib/css-rewrite/postprocessor.rb

@@ -0,0 +1,58 @@
+require 'crass'
+
+module CssRewrite
+  class Postprocessor
+    class << self
+      def run(filename, source, context)
+        tree = Crass.parse(source, preserve_comments: true)
+
+        replace_urls(tree) do |url|
+          rewriter = Config.instance.rewriters.find { |re| re.matches?(url) }
+          rewriter ? rewriter.rewrite(url, filename) : url
+        end
+
+        Crass::Parser.stringify(tree)
+      end
+
+      def call(input)
+        filename = input[:filename]
+        source   = input[:data]
+        context  = input[:environment].context_class.new(input)
+
+        result = run(filename, source, context)
+        context.metadata.merge(data: result)
+      end
+
+      private
+
+      def replace_urls(root, &block)
+        return unless root
+
+        root.each do |node|
+          if node[:node] == :url
+            new_value = yield node[:value]
+            node[:raw].sub!(node[:value], new_value)
+            node[:value] = new_value
+          elsif node[:node] == :function && node[:name] == 'url'
+            old_value = node[:value].first[:value]
+            new_value = yield old_value
+            node[:value].first[:value] = new_value
+            node[:value].first[:raw].sub!(old_value, new_value)
+          end
+
+          replace_urls(node[:children], &block)
+          replace_urls(node[:block], &block)
+        end
+      end
+    end
+
+    def initialize(filename, &block)
+      @filename = filename
+      @source = block.call
+    end
+
+    def render(context, empty_hash_wtf)
+      self.class.run(@filename, @source, context)
+    end
+  end
+end

data/lib/css-rewrite/railtie.rb

@@ -0,0 +1,21 @@
+# encoding: UTF-8
+
+module CssRewrite
+  class Railtie < ::Rails::Railtie
+    config.assets.configure do |env|
+      if env.respond_to?(:register_transformer)
+        env.register_postprocessor 'text/css', 'text/css', CssRewrite::Postprocessor
+      end
+
+      if env.respond_to?(:register_engine)
+        args = ['.css', CssRewrite::Postprocessor]
+
+        if Sprockets::VERSION.start_with?('3')
+          args << { mime_type: 'text/css', silence_deprecation: true }
+        end
+
+        env.register_engine(*args)
+      end
+    end
+  end
+end

data/lib/css-rewrite/regex_rewriter.rb

@@ -0,0 +1,22 @@
+module CssRewrite
+  class RegexRewriter
+    def self.applies_to?(*args, &block)
+      args.size == 1 && args.first.is_a?(Regexp) && block_given?
+    end
+
+    attr_reader :regex, :replacement_block
+
+    def initialize(regex, &block)
+      @regex = regex
+      @replacement_block = block
+    end
+
+    def matches?(url)
+      !!(regex =~ url)
+    end
+
+    def rewrite(url, filename)
+      replacement_block.call(url, filename)
+    end
+  end
+end

data/lib/css-rewrite/rewriter.rb

@@ -0,0 +1,13 @@
+module CssRewrite
+  class Rewriter
+    REWRITERS = [CssRewrite::RegexRewriter, CssRewrite::CallRewriter]
+
+    def self.create(*args, &block)
+      rewriter = REWRITERS.find do |rewriter|
+        rewriter.applies_to?(*args, &block)
+      end
+
+      rewriter.new(*args, &block)
+    end
+  end
+end

data/lib/css-rewrite/version.rb

@@ -0,0 +1,3 @@
+module CssRewrite
+  VERSION = '1.0.0'
+end

data/lib/css-rewrite.rb

@@ -0,0 +1,13 @@
+module CssRewrite
+  autoload :CallRewriter,  'css-rewrite/call_rewriter'
+  autoload :Config,        'css-rewrite/config'
+  autoload :Postprocessor, 'css-rewrite/postprocessor'
+  autoload :RegexRewriter, 'css-rewrite/regex_rewriter'
+  autoload :Rewriter,      'css-rewrite/rewriter'
+
+  def self.configure
+    yield Config.instance
+  end
+end
+
+require 'css-rewrite/railtie' if defined?(Rails)

data/spec/app/assets/stylesheets/application.css

@@ -0,0 +1,3 @@
+.my-class {
+  background-image: url('foo/bar.png');
+}

data/spec/call_rewriter_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe CssRewrite::CallRewriter do
+  describe '.applies_to?' do
+    it 'applies if passed a block' do
+      expect(described_class.applies_to? {}).to eq(true)
+    end
+
+    it 'does not apply if passed any arguments' do
+      expect(described_class.applies_to?(1) {}).to eq(false)
+    end
+
+    it 'does not apply if not passed a block' do
+      expect(described_class.applies_to?).to eq(false)
+    end
+  end
+
+  context 'with a rewriter' do
+    subject { described_class.new(&block) }
+
+    let(:block) do
+      # replaces the extension with ".foo"
+      -> (url, filename) { url.chomp(File.extname(url)) + '.foo' }
+    end
+
+    describe '#matches?' do
+      it 'always matches' do
+        expect(subject.matches?('foo')).to eq(true)
+      end
+    end
+
+    describe '#rewrite' do
+      it 'invokes the replacement block' do
+        expect(subject.rewrite('foo.com/image.jpg', 'foo.css')).to eq(
+          'foo.com/image.foo'
+        )
+      end
+    end
+  end
+end

data/spec/config/application.rb

@@ -0,0 +1,12 @@
+module CssRewrite
+  class DummyApplication < ::Rails::Application
+    config.eager_load = false
+    config.active_support.deprecation = :stderr
+
+    config.assets.enabled = true
+    config.assets.compile = true
+    config.assets.allow_debugging = true
+    config.assets.digest = true
+    config.assets.manifest = 'spec/public/assets/.sprockets-manifest.json'
+  end
+end

data/spec/config_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe CssRewrite::Config do
+  describe '.instance' do
+    it 'returns the only instance' do
+      expect(described_class.instance).to be_a(described_class)
+      expect(described_class.instance.object_id).to(
+        eq(described_class.instance.object_id)
+      )
+    end
+  end
+
+  describe '.reset' do
+    it 'clears the existing instance' do
+      old_config = described_class.instance
+      described_class.reset
+      expect(old_config.object_id).to_not(
+        eq(described_class.instance.object_id)
+      )
+    end
+  end
+
+  context 'with a config instance' do
+    subject { described_class.instance }
+
+    describe '#rewrite' do
+      it 'adds a call rewriter to the list of rewriters' do
+        expect { subject.rewrite {} }.to change { subject.rewriters.size }.by(1)
+        expect(subject.rewriters.first).to be_a(CssRewrite::CallRewriter)
+      end
+
+      it 'adds a regex rewriter to the list of rewriters' do
+        expect { subject.rewrite(/re/) {} }.to change { subject.rewriters.size }.by(1)
+        expect(subject.rewriters.first).to be_a(CssRewrite::RegexRewriter)
+      end
+    end
+  end
+end

data/spec/precompile_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe 'Asset precompile' do
+  def precompile!
+    Rake::Task['assets:precompile'].reenable
+    Rake::Task['assets:precompile'].invoke
+  end
+
+  before do
+    CssRewrite.configure do |config|
+      config.rewrite do |url, filename|
+        url.chomp(File.extname(url)) + '.foo'
+      end
+    end
+  end
+
+  let(:manifest_file) { app.config.assets.manifest }
+
+  it 'replaces urls in precompiled css assets' do
+    precompile!
+
+    manifest = JSON.parse(File.read(manifest_file))
+    css_file = manifest['assets']['application.css']
+    css_path = File.join('spec', 'public', app.config.assets.prefix, css_file)
+    css = File.read(css_path)
+
+    expect(css).to eq(
+      ".my-class {\n  background-image: url('foo/bar.foo');\n}\n"
+    )
+  end
+end

data/spec/regex_rewriter_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe CssRewrite::RegexRewriter do
+  describe '.applies_to?' do
+    it 'applies if passed a regex and a block' do
+      expect(described_class.applies_to?(/re/) {}).to eq(true)
+    end
+
+    it 'does not apply if passed no arguments' do
+      expect(described_class.applies_to? {}).to eq(false)
+    end
+
+    it 'does not apply if not passed a block' do
+      expect(described_class.applies_to?(/re/)).to eq(false)
+    end
+  end
+
+  context 'with a rewriter' do
+    subject { described_class.new(/.jpg\z/, &block) }
+
+    let(:block) do
+      # replaces the extension with ".foo"
+      -> (url, filename) { url.chomp(File.extname(url)) + '.foo' }
+    end
+
+    describe '#matches?' do
+      it 'matches if the regex matches' do
+        expect(subject.matches?('foo.jpg')).to eq(true)
+      end
+
+      it 'does not match if the regex fails to match' do
+        expect(subject.matches?('foo.png')).to eq(false)
+      end
+    end
+
+    describe '#rewrite' do
+      it 'invokes the replacement block' do
+        expect(subject.rewrite('foo.com/image.jpg', 'foo.css')).to eq(
+          'foo.com/image.foo'
+        )
+      end
+    end
+  end
+end

data/spec/rewriter_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe CssRewrite::Rewriter do
+  describe '.create' do
+    it 'creates a call rewriter from the given args' do
+      block = -> {}
+      rewriter = described_class.create(&block)
+      expect(rewriter).to be_a(CssRewrite::CallRewriter)
+      expect(rewriter.replacement_block).to eq(block)
+    end
+
+    it 'creates a regex rewriter' do
+      block = -> {}
+      regex = /re/
+      rewriter = described_class.create(regex, &block)
+      expect(rewriter).to be_a(CssRewrite::RegexRewriter)
+      expect(rewriter.replacement_block).to eq(block)
+      expect(rewriter.regex).to eq(regex)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,49 @@
+# encoding: UTF-8
+
+$:.push(File.dirname(__FILE__))
+
+require 'rspec'
+require 'pry-byebug'
+
+require 'rails'
+require 'rake'
+require 'sprockets/railtie'
+
+ENV['RAILS_ENV'] ||= 'test'
+
+require 'css-rewrite'
+
+Dir.chdir('spec') do
+  require File.expand_path('../config/application', __FILE__)
+  CssRewrite::DummyApplication.initialize!
+  CssRewrite::DummyApplication.load_tasks  # used by precompilation specs
+end
+
+module LetDeclarations
+  extend RSpec::SharedContext
+
+  let(:app) { Rails.application }
+  let(:assets) { app.assets }
+
+  let(:assets_dir) do
+    CssRewrite::DummyApplication.root.join('public/assets')
+  end
+
+  let(:tmp_dir) do
+    CssRewrite::DummyApplication.root.join('tmp')
+  end
+end
+
+RSpec.configure do |config|
+  config.include(LetDeclarations)
+
+  config.before do
+    FileUtils.rm_rf(tmp_dir)
+    FileUtils.rm_rf(assets_dir)
+    FileUtils.mkdir_p(assets_dir)
+  end
+
+  config.after(:each) do
+    CssRewrite::Config.reset
+  end
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: css-rewrite
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Cameron Dutro
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-09-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sprockets
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: crass
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Rewrite URLs in your 3rd-party CSS files using the asset pipeline.
+email:
+- camertron@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Rakefile
+- css-rewrite.gemspec
+- lib/css-rewrite.rb
+- lib/css-rewrite/call_rewriter.rb
+- lib/css-rewrite/config.rb
+- lib/css-rewrite/postprocessor.rb
+- lib/css-rewrite/railtie.rb
+- lib/css-rewrite/regex_rewriter.rb
+- lib/css-rewrite/rewriter.rb
+- lib/css-rewrite/version.rb
+- spec/app/assets/stylesheets/application.css
+- spec/call_rewriter_spec.rb
+- spec/config/application.rb
+- spec/config_spec.rb
+- spec/log/test.log
+- spec/precompile_spec.rb
+- spec/regex_rewriter_spec.rb
+- spec/rewriter_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/camertron/css-rewrite
+licenses: []
+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.6.11
+signing_key: 
+specification_version: 4
+summary: Rewrite URLs in your 3rd-party CSS files using the asset pipeline.
+test_files: []