rails-pixrem 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f9f0e0b6f6b318f15d49412d0e7d7e1c04cc03e6
+  data.tar.gz: 5870e83c3a2e6b56e6ee453b3d7d315933a63a50
+SHA512:
+  metadata.gz: 6a75437b5fc76bb09590a0580fd8726c3b02c6e8b0c829b84f70cdb0cf37997c32d068f03dcf73898446f37481187e68898377bfe4a0e7f83fcce83e387d4b63
+  data.tar.gz: 36b58ec227f11e0cd4aadf800d108b0599fcca9817ef6b34283401edd6612be6ec109e75dd1bd6888c18bc25d2113ebb997de06da2b4ff0994fb37a08e17a15b

data/.fs.yml

@@ -0,0 +1 @@
+ci: "https://semaphoreapp.com/vast/rails-pixrem/branches/%{branch}"

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rails-pixrem.gemspec
+gemspec
+
+gem 'rails'
+gem 'sass-rails'
+gem 'rspec-rails'

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Vasily Polovnyov
+
+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,69 @@
+Rails-pixrem
+===================================================================
+
+[![Build Status](https://semaphoreapp.com/api/v1/projects/db183d30-2136-4ba5-99e4-d0d8dac5f09d/230344/badge.png)](https://semaphoreapp.com/vast/rails-pixrem)
+
+CSS post-processor which generates pixel fallbacks for rem units
+in your Rails (Sinatra) application.
+
+
+Usage
+===================================================================
+
+### Ruby on Rails
+
+Add `rails-pixrem` to your `Gemfile`:
+
+```ruby
+gem 'rails-pixrem', github: 'vast/rails-pixrem'
+```
+
+Write your CSS (SASS, Stylus, LESS) using `rem`s:
+
+```scss
+#header {
+  font-size: 2rem;
+}
+```
+
+Rails-pixrem will automatically add fallback rules with pixel values:
+
+```scss
+#header {
+  font-size: 32px; // IE8, Opera Mini
+  font-size: 2rem; // modern browsers
+}
+```
+
+
+### Sprockets
+
+If you use a non-Rails framework with Sprockets, connect Sprockets environment
+with `RailsPixrem`:
+
+
+```ruby
+assets = Sprockets::Environment.new do |env|
+  # ...
+end
+
+require 'rails-pixrem'
+RailsPixrem.install(assets)
+```
+
+## Configuration
+
+You can specify root element font size (default: '16px') in px, em or percents:
+
+### Ruby On Rails
+
+```yaml
+# config/pixrem.yml
+root_value: 24px
+```
+
+### Sprockets
+
+```ruby
+RailsPixrem.install(assets, root_value: '85%')
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/rails-pixrem.rb

@@ -0,0 +1,17 @@
+require_relative 'rails-pixrem/version'
+require_relative 'rails-pixrem/processor'
+require_relative 'rails-pixrem/railtie' if defined?(Rails)
+
+module RailsPixrem
+  autoload :Sprockets, 'rails-pixrem/sprockets'
+
+  def self.install(assets, options = {})
+    Sprockets.new(processor(options)).install(assets)
+  end
+
+  def self.processor(options = {})
+    @cache ||= {}
+    cache_key = options.to_s
+    @cache[cache_key] ||= Processor.new(options)
+  end
+end

data/lib/rails-pixrem/processor.rb

@@ -0,0 +1,32 @@
+require 'pathname'
+require 'execjs'
+
+module RailsPixrem
+  class Processor
+    def initialize(options = {})
+      @options = { root_value: '16px' }.merge(options)
+    end
+
+    def process(css)
+      processor.call('process', css, @options[:root_value])
+    end
+
+    private
+
+    def processor
+      @processor ||= ExecJS.compile(processor_js)
+    end
+
+    def processor_js
+      [pixrem_js, process_proxy].join(';')
+    end
+
+    def pixrem_js
+      @@pixrem_js ||= Pathname(__FILE__).join('../../../vendor/pixrem.js').read
+    end
+
+    def process_proxy
+      "var process = require('pixrem');"
+    end
+  end
+end

data/lib/rails-pixrem/railtie.rb

@@ -0,0 +1,17 @@
+begin
+  require 'sprockets/railtie'
+
+  module RailsPixrem
+    class Railtie < ::Rails::Railtie
+      initializer :setup_pixrem, group: :all do |app|
+        RailsPixrem.install(app.assets, configuration(app))
+      end
+
+      def configuration(app)
+        file = app.root.join('config/pixrem.yml')
+        file.exist? ? YAML.load_file(file).symbolize_keys : {}
+      end
+    end
+  end
+rescue LoadError
+end

data/lib/rails-pixrem/sprockets.rb

@@ -0,0 +1,45 @@
+module RailsPixrem
+  class Sprockets
+    def initialize(processor)
+      @processor = processor
+    end
+
+    def process(context, css)
+      @processor.process(css)
+    end
+
+    def process_only_css(context, content)
+      process(context, content)
+    rescue ExecJS::ProgramError => e
+      if e.message =~ /Can't parse CSS/
+        content
+      else
+        raise e
+      end
+    end
+
+    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
+
+    def register(assets, &block)
+      assets.register_postprocessor('text/css', :pixrem, &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/rails-pixrem/version.rb

@@ -0,0 +1,3 @@
+module RailsPixrem
+  VERSION = "0.0.1"
+end

data/rails-pixrem.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rails-pixrem/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rails-pixrem"
+  spec.version       = RailsPixrem::VERSION
+  spec.authors       = ["Vasily Polovnyov"]
+  spec.email         = ["vasily@polovnyov.ru"]
+  spec.summary       = %q{Generate pixel fallbacks for rem units in Rails application}
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/vast/rails-pixrem"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "execjs"
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-its"
+end

data/spec/dummy/Rakefile

@@ -0,0 +1,2 @@
+require File.expand_path('../config/application', __FILE__)
+Dummy::Application.load_tasks

data/spec/dummy/app/assets/stylesheets/rails.css.scss

@@ -0,0 +1,3 @@
+a {
+  margin: 3rem;
+}

data/spec/dummy/app/assets/stylesheets/test.css

@@ -0,0 +1,3 @@
+i {
+  padding: 1rem
+}

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,2 @@
+class ApplicationController < ActionController::Base
+end

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

@@ -0,0 +1,5 @@
+class CssController < ApplicationController
+  def test
+    render text: Rails.application.assets['rails.css']
+  end
+end

data/spec/dummy/config.ru

@@ -0,0 +1,2 @@
+require ::File.expand_path('../config/environment',  __FILE__)
+run Dummy::Application

data/spec/dummy/config/application.rb

@@ -0,0 +1,14 @@
+require File.expand_path('../boot', __FILE__)
+
+require "action_controller/railtie"
+require "sprockets/railtie"
+
+if defined?(Bundler)
+  Bundler.require(*Rails.groups(assets: %w(development test)))
+end
+
+module Dummy
+  class Application < Rails::Application
+    config.sass.line_comments = false
+  end
+end

data/spec/dummy/config/boot.rb

@@ -0,0 +1,2 @@
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])

data/spec/dummy/config/environment.rb

@@ -0,0 +1,2 @@
+require File.expand_path('../application', __FILE__)
+Dummy::Application.initialize!

data/spec/dummy/config/environments/test.rb

@@ -0,0 +1,11 @@
+Dummy::Application.configure do
+  config.cache_classes = true
+  config.serve_static_assets = true
+  config.static_cache_control = "public, max-age=3600"
+  config.eager_load = false
+  config.consider_all_requests_local = true
+  config.action_controller.perform_caching = false
+  config.action_dispatch.show_exceptions = false
+  config.action_controller.allow_forgery_protection = false
+  config.active_support.deprecation = :stderr
+end

data/spec/dummy/config/initializers/compress.rb

@@ -0,0 +1 @@
+Rails.application.config.assets.css_compressor = nil

data/spec/dummy/config/initializers/secret_token.rb

@@ -0,0 +1 @@
+Dummy::Application.config.secret_key_base = 'test'

data/spec/dummy/config/pixrem.yml

@@ -0,0 +1 @@
+root_value: 20px

data/spec/dummy/config/routes.rb

@@ -0,0 +1,3 @@
+Dummy::Application.routes.draw do
+  root to: 'css#test'
+end

data/spec/rails-pixrem/processor_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe RailsPixrem::Processor do
+  describe '#process' do
+    let(:sample_css) { '#foo { padding: 2rem }' }
+    let(:processor) { described_class.new }
+    subject { processor.process(sample_css) }
+
+    it { should include('padding: 32px;') }
+    it { should include('padding: 2rem') }
+
+    context 'when root value is passed' do
+      let(:processor) { described_class.new(root_value: '20px') }
+
+      it { should include('padding: 40px;') }
+    end
+  end
+end

data/spec/rails-pixrem/rails_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe CssController, type: :controller do
+  subject { response }
+
+  before do
+    cache = Rails.root.join('tmp/cache')
+    cache.rmtree if cache.exist?
+
+    get :test
+  end
+
+  it { should be_success }
+  its(:body) { should include('margin: 3rem;') }
+  its(:body) { should include('margin: 60px;') }
+end

data/spec/rails-pixrem/sprockets_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe 'Sprockets integration' do
+  let(:assets) { Sprockets::Environment.new }
+
+  before do
+    assets.append_path(Pathname(__FILE__).dirname.join('../dummy/app/assets/stylesheets'))
+  end
+
+  context 'with default configuration' do
+    before { RailsPixrem.install(assets) }
+
+    it 'works with Sprockets' do
+      assets['test.css'].to_s.should == "i {\n" +
+                                        "  padding: 16px;\n" +
+                                        "  padding: 1rem\n" +
+                                        "}\n"
+    end
+  end
+
+  context 'when additional configuration passed' do
+    before { RailsPixrem.install(assets, root_value: '40px') }
+
+    it 'honors root value' do
+      assets['test.css'].to_s.should == "i {\n" +
+                                        "  padding: 40px;\n" +
+                                        "  padding: 1rem\n" +
+                                        "}\n"
+    end
+  end
+end