autoprefixer-rails 0.8.20131213 → 1.0.20131222

data/README.md

@@ -31,17 +31,18 @@ support to add vendor prefixes automatically using the Asset Pipeline:
 
 ```css
 :-webkit-full-screen a {
-  -webkit-transition: -webkit-transform 1s;
-  transition: transform 1s;
+    -webkit-transition: -webkit-transform 1s;
+    transition: transform 1s
 }
-
 :-moz-full-screen a {
-  transition: transform 1s;
+    transition: transform 1s
+}
+:-ms-fullscreen a {
+    transition: transform 1s
 }
-
 :fullscreen a {
-  -webkit-transition: -webkit-transform 1s;
-  transition: transform 1s;
+    -webkit-transition: -webkit-transform 1s;
+    transition: transform 1s
 }
 ```
 
@@ -52,17 +53,17 @@ to `config/autoprefixer.yml`. See [browser section] in Autoprefixer docs.
 browsers:
   - "last 1 version"
   - "> 1%"
-  - "ie 8"
+  - "explorer 10"
 ```
 
-You can inspect what properties will be changed using a Rake task:
+You can get what properties will be changed using a Rake task:
 
 ```sh
-rake autoprefixer:inspect
+rake autoprefixer:info
 ```
 
-By default, Autoprefixer uses `> 1%, last 2 versions, ff 17, opera 12.1`:
-* Firefox 17 is a latest [ESR].
+By default, Autoprefixer uses `> 1%, last 2 versions, firefox 24, opera 12.1`:
+* Firefox 24 is a latest [ESR].
 * Opera 12.1 will be in list until Opera supports non-Blink 12.x branch.
 
 [browser section]: https://github.com/ai/autoprefixer#browsers
@@ -89,5 +90,41 @@ If you need to call Autoprefixer from plain Ruby code, it’s very easy:
 
 ```ruby
 require "autoprefixer-rails"
-prefixed = AutoprefixerRails.compile(css)
+prefixed = AutoprefixerRails.process(css, from: 'main.css').css
+```
+
+You can specify browsers by `browsers` option:
+
+```ruby
+AutoprefixerRails.process(css, from: 'a.css', browsers: ['> 1%', 'ie 10']).css
+```
+
+### Source Map
+
+Autoprefixer will generate source map, if you set `map` option to `true` in
+`process` method.
+
+You must set input and output CSS files paths (by `from` and `to` options)
+to generate correct map.
+
+```ruby
+result = AutoprefixerRails.process(css,
+    map:   true,
+    from: 'main.css',
+    to:   'main.out.css')
+
+result.css #=> Prefixed CSS
+result.map #=> Source map content
+```
+
+Autoprefixer can also modify previous source map (for example, from Sass
+compilation). Just set original source map content (as string) to `map` option:
+
+```ruby
+result = AutoprefixerRails.process(css, {
+    map:   File.read('main.sass.css.map'),
+    from: 'main.sass.css',
+    to:   'main.min.css')
+
+result.map #=> Source map from main.sass to main.min.css
 ```

data/autoprefixer-rails.gemspec

@@ -10,13 +10,13 @@ Gem::Specification.new do |s|
 
   s.files            = `git ls-files`.split("\n")
   s.test_files       = `git ls-files -- {spec}/*`.split("\n")
-  s.extra_rdoc_files = ['README.md', 'LICENSE', 'ChangeLog']
+  s.extra_rdoc_files = ['README.md', 'LICENSE', 'ChangeLog.md']
   s.require_path     = 'lib'
 
   s.author   = 'Andrey "A.I." Sitnik'
   s.email    = 'andrey@sitnik.ru'
   s.homepage = 'https://github.com/ai/autoprefixer-rails'
-  s.license  = 'LGPL-3'
+  s.license  = 'MIT'
 
   s.add_dependency "execjs", [">= 0"]
 end

data/lib/autoprefixer-rails.rb

@@ -1,62 +1,38 @@
-=begin
-Copyright 2013 Andrey “A.I.” Sitnik <andrey@sitnik.ru>,
-sponsored by Evil Martians.
-
-This program is free software: you can redistribute it and/or modify
-it under the terms of the GNU Lesser General Public License as published by
-the Free Software Foundation, either version 3 of the License, or
-(at your option) any later version.
-
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU Lesser General Public License for more details.
-
-You should have received a copy of the GNU Lesser General Public License
-along with this program.  If not, see <http://www.gnu.org/licenses/>.
-=end
-
 require 'pathname'
 
 # Ruby integration with Autoprefixer JS library, which parse CSS and adds
 # only actual prefixed
 module AutoprefixerRails
-  # Parse `css` and add vendor prefixes for `browsers`
-  def self.compile(css, browsers = nil)
-    compiler(browsers).compile(css)
+  autoload :Sprockets, 'autoprefixer-rails/sprockets'
+
+  # Add prefixes to `css`. See `Processor#process` for options.
+  def self.process(css, opts = { })
+    browsers = opts.delete(:browsers)
+    processor(browsers).process(css, opts)
   end
 
   # Add Autoprefixer for Sprockets environment in `assets`.
   # You can specify `browsers` actual in your project.
   def self.install(assets, browsers = nil)
-    instance = compiler(browsers)
-    assets.register_postprocessor 'text/css', :autoprefixer do |context, css|
-      if defined?(Sass::Rails) or defined?(Sprockets::Sass)
-        begin
-          instance.compile(css)
-        rescue ExecJS::ProgramError => e
-          if e.message =~ /Can't parse CSS/
-            css
-          else
-            raise e
-          end
-        end
-      else
-        instance.compile(css)
-      end
-    end
+    Sprockets.new( processor(browsers) ).install(assets)
   end
 
-  # Cache compiler instances
-  def self.compiler(browsers)
+  # Cache processor instances
+  def self.processor(browsers=nil)
     @cache ||= { }
-    @cache[browsers] ||= Compiler.new(browsers)
+    @cache[browsers] ||= Processor.new(browsers)
+  end
+
+  # Deprecated method. Use `process` instead.
+  def self.compile(css, browsers = nil)
+    processor(browsers).compile(css)
   end
 end
 
 dir = Pathname(__FILE__).dirname.join('autoprefixer-rails')
 
+require dir.join('result').to_s
 require dir.join('version').to_s
-require dir.join('compiler').to_s
+require dir.join('processor').to_s
 
 require dir.join('railtie').to_s if defined?(Rails)

data/lib/autoprefixer-rails/processor.rb

@@ -0,0 +1,90 @@
+require 'execjs'
+
+module AutoprefixerRails
+  # Ruby to JS wrapper for Autoprefixer processor instance
+  class Processor
+    def initialize(browsers=nil)
+      @browsers = browsers || []
+    end
+
+    # Process `css` and return result.
+    #
+    # Options can be:
+    # * `from` with input CSS file name. Will be used in error messages.
+    # * `to` with output CSS file name.
+    # * `map` with true to generate new source map or with previous map.
+    def process(css, opts = { })
+      result = processor.call('process', css, opts)
+      Result.new(result['css'], result['map'])
+    end
+
+    # Return, which browsers and prefixes will be used
+    def info
+      processor.call('info')
+    end
+
+    # Lazy load for JS instance
+    def processor
+      @processor ||= ExecJS.compile(build_js)
+    end
+
+    # Deprecated method. Use `process` instead.
+    def compile(css)
+      warn 'autoprefixer-rails: Replace compile() to process(). ' +
+           'Method compile() is deprecated and will be removed in 1.1.'
+      processor.call('process', css)['css']
+    end
+
+    private
+
+    # Print warning to logger or STDERR
+    def warn(message)
+      $stderr.puts(message)
+    end
+
+    # Cache autoprefixer.js content
+    def read_js
+      @@js ||= Pathname(__FILE__).join("../../../vendor/autoprefixer.js").read
+    end
+
+    # Return processor JS with some extra methods
+    def build_js
+      create_global + read_js + create_instance +
+      process_proxy + info_proxy
+    end
+
+    # Return JS code to create `global` namespace
+    def create_global
+      'var global = this;'
+    end
+
+    # Return JS code to create Autoprefixer instance
+    def create_instance
+      if @browsers.empty?
+        "var processor = autoprefixer;"
+      else
+        browsers = @browsers.map(&:to_s).join("', '")
+        "var processor = autoprefixer('#{browsers}');"
+      end
+    end
+
+    # Return JS code for process method proxy
+    def process_proxy
+      <<-JS
+        var process = function() {
+          var result = processor.process.apply(processor, arguments);
+          return { css: result.css, map: result.map };
+        };
+      JS
+    end
+
+    # Return JS code for info method proxy
+    def info_proxy
+      <<-JS
+        var info = function() {
+          return processor.info.apply(processor);
+        };
+      JS
+    end
+  end
+end

data/lib/autoprefixer-rails/railtie.rb

@@ -1,21 +1,3 @@
-=begin
-Copyright 2013 Andrey “A.I.” Sitnik <andrey@sitnik.ru>,
-sponsored by Evil Martians.
-
-This program is free software: you can redistribute it and/or modify
-it under the terms of the GNU Lesser General Public License as published by
-the Free Software Foundation, either version 3 of the License, or
-(at your option) any later version.
-
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU Lesser General Public License for more details.
-
-You should have received a copy of the GNU Lesser General Public License
-along with this program.  If not, see <http://www.gnu.org/licenses/>.
-=end
-
 begin
   require 'sprockets/railtie'
 

data/lib/autoprefixer-rails/result.rb

@@ -0,0 +1,20 @@
+module AutoprefixerRails
+  # Container of prefixed CSS and source map with changes
+  class Result
+    # Prefixed CSS after Autoprefixer
+    attr_reader :css
+
+    # Source map of changes
+    attr_reader :map
+
+    def initialize(css, map)
+      @css = css
+      @map = map
+    end
+
+    # Stringify prefixed CSS
+    def to_s
+      @css
+    end
+  end
+end

data/lib/autoprefixer-rails/sprockets.rb

@@ -0,0 +1,56 @@
+module AutoprefixerRails
+  # Register autoprefixer postprocessor in Sprockets and fix common issues
+  class Sprockets
+    def initialize(processor)
+      @processor = processor
+    end
+
+    # Add prefixes for `css`
+    def process(context, css)
+      root   = Pathname.new(context.root_path)
+      input  = context.pathname.relative_path_from(root).to_s
+      output = input.chomp(File.extname(input)) + '.css'
+
+      @processor.process(css, from: input, to: output).css
+    end
+
+    # Add prefixes only if in `content` will be CSS.
+    def process_only_css(context, content)
+      begin
+        process(context, content)
+      rescue ExecJS::ProgramError => e
+        if e.message =~ /Can't parse CSS/
+          content
+        else
+          raise e
+        end
+      end
+    end
+
+    # Register postprocessor in Sprockets depend on issues with other gems
+    def install(assets)
+      if ignore_syntax_error?
+        register(assets) { |context, css| process_only_css(context, css) }
+      else
+        register(assets) { |context, css| process(context, css) }
+      end
+    end
+
+    private
+
+    # Add `block` as `assets` postprocessor
+    def register(assets, &block)
+      assets.register_postprocessor('text/css', :autoprefixer, &block)
+    end
+
+    # Return true if broken sass-rails is loaded
+    def ignore_syntax_error?
+      return false unless defined? Sass::Rails
+
+      fixed   = Gem::Version.new('4.0.1')
+      current = Gem::Version.new(Sass::Rails::VERSION)
+
+      current < fixed
+    end
+  end
+end

data/lib/autoprefixer-rails/version.rb

@@ -1,3 +1,3 @@
 module AutoprefixerRails
-  VERSION = '0.8.20131213'.freeze unless defined? AutoprefixerRails::VERSION
+  VERSION = '1.0.20131222'.freeze unless defined? AutoprefixerRails::VERSION
 end

data/lib/rake/autoprefixer_tasks.rb

@@ -1,21 +1,3 @@
-=begin
-Copyright 2013 Andrey “A.I.” Sitnik <andrey@sitnik.ru>,
-sponsored by Evil Martians.
-
-This program is free software: you can redistribute it and/or modify
-it under the terms of the GNU Lesser General Public License as published by
-the Free Software Foundation, either version 3 of the License, or
-(at your option) any later version.
-
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU Lesser General Public License for more details.
-
-You should have received a copy of the GNU Lesser General Public License
-along with this program.  If not, see <http://www.gnu.org/licenses/>.
-=end
-
 require 'rake'
 require 'rake/tasklib'
 require 'autoprefixer-rails'
@@ -30,15 +12,15 @@ module Rake
 
     def initialize(browsers = [])
       @browsers = browsers
-      @compiler = AutoprefixerRails.compiler(@browsers)
+      @processor = AutoprefixerRails.processor(@browsers)
       define
     end
 
     def define
       namespace :autoprefixer do
         desc 'Show selected browsers and prefixed CSS properties and values'
-        task :inspect do
-          puts @compiler.inspect
+        task :info do
+          puts @processor.info
         end
       end
     end

data/spec/app/app/assets/stylesheets/loaded.sass

@@ -0,0 +1,2 @@
+a
+  transition: all 1s

data/spec/app/app/assets/stylesheets/sass.sass

@@ -0,0 +1 @@
+@import "loaded"

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

@@ -0,0 +1 @@
+a {

data/spec/app/app/controllers/css_controller.rb

@@ -1,6 +1,6 @@
 class CssController < ApplicationController
   def test
     file = params[:file] + '.css'
-    render :text => Rails.application.assets[file]
+    render text: Rails.application.assets[file]
   end
 end

data/spec/app/config/application.rb

@@ -4,7 +4,7 @@ require "action_controller/railtie"
 require "sprockets/railtie"
 
 if defined?(Bundler)
-  Bundler.require(*Rails.groups(:assets => %w(development test)))
+  Bundler.require(*Rails.groups(assets: %w(development test)))
 end
 
 module App