css_splitter 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 YOURNAME
+
+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,76 @@
+# CssSplitter
+
+## Status
+
+Work in progress of turning this https://gist.github.com/2398394 into a gem.  Not released yet.
+
+## What it does?
+
+Older versions of Internet Explorer (basically version 9 and below) have a hard limit for the number of CSS selectors they can process, which is 4095.  If one of your stylesheets exceeds this limit, all the rule sets beyond the 4095th selector will not be processed by IE and your app will miss some styling information.
+
+CssSplitter integrates with the Rails 3.1+ Asset Pipeline to generate additional split stylesheets with all the CSS rules beyond the 4095th that can be served to IE browsers in order to get all the styling information.
+
+
+## Dependencies
+
+* Rails 3.1+
+* Asset Pipeline
+
+## Documentation
+
+### 1. Splitting your stylesheets
+
+The first step is indentifying the stylesheets that have more than 4095 selectors and therefore need to be split for IE.
+
+Once you know which stylesheets need to be split, you need to create a second "container file" for those stylesheets with the file extension `.split2`, that will contain the styles beyond the 4095 selector limit.
+
+For example, if you want to split `too_big_stylesheet.css`, you need to create a new file `too_big_stylesheet_split2.css.split2` in the same directory.  The only content of that container, will be an include of the original file, e.g.:
+
+    # app/assets/stylesheets/too_big_stylesheet_split2.css.split2
+
+    //= include 'too_big_stylesheet'
+
+You also need to remember to add those new files to the asset pipeline, so they will be compiled. For example:
+
+    # config/application.rb
+
+    module MyApp
+      class Application < Rails::Application
+        config.assets.precompile += %w( too_big_stylesheet_split2.css )
+
+### 2. Including your split stylesheets
+
+Now that you have split up your big stylesheets at the 4095 limit you need to change your HTML layout, so the split stylesheets are used for older IE versions (IE9 and older).
+
+You can just use our `split_stylesheet_link_tag` helper, which would look something like this:
+
+    # app/views/layout/application.html.erb
+    <%= split_stylesheet_link_tag "too_big_stylesheet", :media => "all" %>
+
+    # output
+    <link href="/stylesheets/too_big_stylesheet.css" media="screen" rel="stylesheet" type="text/css" />
+    <!--[if lte IE 9]>
+      <link href="/stylesheets/too_big_stylesheet_split2.css" media="screen" rel="stylesheet" type="text/css" />
+    <![endif]-->
+
+Or you can just create similar HTML as in the above example yourself.
+
+## How it works
+
+Basically, CssSplitter is registering a new `Sprockets::Engine` for the `.split2` file extension, that will fill those files with all the selectors beyond the 4095th.  Unfortunately, those `.split2` files need to be created manually, because we haven't figured out a way for a `Sprockets::Engine` to output multiple files.  They need to present before the compile step.
+
+If you have more questions about how it works, look at the code or contact us.
+
+
+## Limitations
+
+Currently the gem only supports stylesheets that need to be split into 2 files.  It could theoretically create more splits (e.g. if you should have more than 8190 selectors), but in that case you should probably refactor the stylesheets anyway.  Contact us, if you have this requirement.
+
+
+## Credits & License
+
+This is a joint project by the two German Rails shops [Zweitag](http://zweitag.de) und [Railslove](http://railslove.com), therefore the GitHub name "Zweilove".
+
+The original code was written by [Christian Peters](mailto:christian.peters@zweitag.de) (see this [Gist](https://gist.github.com/2398394)) and turned into a gem by [Jakob Hilden](mailto:jakobhilden@gmail.com)
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,40 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'CssSplitter'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/app/assets/javascripts/css_splitter/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

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

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/app/controllers/css_splitter/application_controller.rb

@@ -0,0 +1,4 @@
+module CssSplitter
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/helpers/css_splitter/application_helper.rb

@@ -0,0 +1,18 @@
+module CssSplitter
+  module ApplicationHelper
+    def split_stylesheet_link_tag(*sources)
+      original_sources = sources.dup
+
+      options = sources.extract_options!
+      sources.collect!{ |source| "#{source}_split2" }
+      sources << options
+
+      [
+        stylesheet_link_tag(*original_sources),
+        "<!--[if lte IE 9]>",
+        stylesheet_link_tag(*sources),
+        "<![endif]-->"
+      ].join("\n").html_safe
+    end
+  end
+end

data/app/views/layouts/css_splitter/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>CssSplitter</title>
+  <%= stylesheet_link_tag    "css_splitter/application", :media => "all" %>
+  <%= javascript_include_tag "css_splitter/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,2 @@
+CssSplitter::Engine.routes.draw do
+end

data/lib/css_splitter/engine.rb

@@ -0,0 +1,11 @@
+module CssSplitter
+  class Engine < ::Rails::Engine
+    isolate_namespace CssSplitter
+
+    initializer 'css_splitter.action_controller' do |app|
+      ActiveSupport.on_load :action_controller do
+        helper CssSplitter::ApplicationHelper
+      end
+    end
+  end
+end

data/lib/css_splitter/railtie.rb

@@ -0,0 +1,7 @@
+module CssSplitter
+  class Railtie < Rails::Railtie
+    initializer "css_splitter.initializer" do |app|
+      app.assets.register_engine '.split2', CssSplitter::SprocketsEngine
+    end
+  end
+end

data/lib/css_splitter/splitter.rb

@@ -0,0 +1,103 @@
+module CssSplitter
+
+  class Splitter
+
+    MAX_SELECTORS_DEFAULT = 4095
+
+    def self.split(infile, outdir = File.dirname(infile), max_selectors = MAX_SELECTORS_DEFAULT)
+
+      raise "infile could not be found" unless File.exists? infile
+
+      rules = IO.readlines(infile, "}")
+      return if rules.first.nil?
+
+      charset_statement, rules[0] = rules.first.partition(/^\@charset[^;]+;/)[1,2]
+      return if rules.nil?
+
+      file_id = 1 # The infile remains the first file
+      selectors_count = 0
+      output = nil
+
+      rules.each do |rule|
+        rule_selectors_count = count_selectors_of_rule rule
+        selectors_count += rule_selectors_count
+
+        # Nothing happens until the selectors limit is reached for the first time
+        if selectors_count > max_selectors
+          # Close current file if there is already one
+          output.close if output
+
+          # Prepare next file
+          file_id += 1
+          filename = File.join(outdir, File.basename(infile, File.extname(infile)) + "_#{file_id.to_s}" + File.extname(infile))
+          output = File.new(filename, "w")
+          output.write charset_statement
+
+          # Reset count with current rule count
+          selectors_count = rule_selectors_count
+        end
+
+        output.write rule if output
+      end
+    end
+
+    def self.split_string(css_string, part = 1, max_selectors = MAX_SELECTORS_DEFAULT)
+      rules = split_string_into_rules(css_string)
+      extract_part rules, part, max_selectors
+    end
+
+    def self.split_string_into_rules(css_string)
+      strip_comments(css_string).chomp.scan /[^}]*}/
+    end
+
+    def self.extract_part(rules, part = 1, max_selectors = MAX_SELECTORS_DEFAULT)
+      return if rules.first.nil?
+
+      charset_statement, rules[0] = rules.first.partition(/^\@charset[^;]+;/)[1,2]
+      return if rules.nil?
+
+      output = charset_statement
+      selectors_count = 0
+      selector_range = max_selectors * (part - 1) + 1 .. max_selectors * part
+
+      rules.each do |rule|
+        rule_selectors_count = count_selectors_of_rule rule
+        selectors_count += rule_selectors_count
+
+        if selector_range.cover? selectors_count
+          output << rule
+        elsif selectors_count > selector_range.end
+          break
+        end
+      end
+
+      output
+    end
+
+    def self.count_selectors(css_file)
+      raise "file could not be found" unless File.exists? css_file
+
+      rules = IO.readlines(css_file, '}')
+      return if rules.first.nil?
+
+      charset_statement, rules[0] = rules.first.partition(/^\@charset[^;]+;/)[1,2]
+      return if rules.first.nil?
+
+      rules.sum {|rule| count_selectors_of_rule(rule)}.tap do |result|
+        puts File.basename(css_file) + " contains #{result} selectors."
+      end
+    end
+
+    def self.count_selectors_of_rule(rule)
+      strip_comments(rule).partition(/\{/).first.scan(/,/).count.to_i + 1
+    end
+
+    private
+
+      def self.strip_comments(s)
+        s.gsub(/\/\/.*$/, "").gsub(/\/\*.*?\*\//, "")
+      end
+
+  end
+
+end

data/lib/css_splitter/sprockets_engine.rb

@@ -0,0 +1,19 @@
+require 'tilt'
+
+module CssSplitter
+
+  class SprocketsEngine < Tilt::Template
+    def self.engine_initialized?
+      true
+    end
+
+    def prepare
+    end
+
+    def evaluate(scope, locals, &block)
+      part = scope.pathname.extname =~ /(\d+)$/ && $1 || 0
+      CssSplitter::Splitter.split_string data, part.to_i
+    end
+  end
+
+end

data/lib/css_splitter/version.rb

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

data/lib/css_splitter.rb

@@ -0,0 +1,7 @@
+require "css_splitter/engine"
+require "css_splitter/sprockets_engine"
+require "css_splitter/splitter"
+require "css_splitter/railtie"
+
+module CssSplitter
+end

data/lib/tasks/css_splitter_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :css_splitter do
+#   # Task goes here
+# end

data/test/css_splitter_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class CssSplitterTest < ActiveSupport::TestCase
+  test "truth" do
+    assert_kind_of Module, CssSplitter
+  end
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.

data/test/dummy/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

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

@@ -0,0 +1,16 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ */
+
+ .foo {
+    color: black;
+ }