sprockets-derailleur 0.0.7 → 0.0.8

data/README.md

@@ -4,23 +4,21 @@ Speed up Manifest::Compile by forking processes
 
 ## Installation
 
-Add this line to your application's Gemfile:
+1. Add this line to your application's Gemfile: `gem 'sprockets-derailleur'`
+2. And then execute: `$ bundle`, or install it yourself as: `$ gem install sprockets-derailleur`
+3. Require `sprockets-derailleur` in environment file: `require 'sprockets-derailleur'`
 
-    gem 'sprockets-derailleur'
-
-And then execute:
+## Usage
 
-    $ bundle
+To override the number of processes you can use the
+`SPROCKETS_DERAILLEUR_WORKER_COUNT` environment variable. It defaults to the
+number of processors on your machine.
 
-Or install it yourself as:
+### Rails 4.0
 
-    $ gem install sprockets-derailleur
+Just drop in the Gemfile, nothing more.
 
-Require `sprockets-derailleur` in environment file:
-    
-    require 'sprockets-derailleur'
-
-## Usage
+### Rails 3.2
 
 To install to an existing rails 3.2 project, first create a new file, 'sprockets_derailleur.rb' in config/initializers.
 
@@ -32,15 +30,11 @@ module Sprockets
   
     alias_method :compile_without_manifest, :compile
     def compile
-    
-      # Determine how many workers you want to use first. Determine the number of physical CPUs this way
-      processes = SprocketsDerailleur::number_of_processors rescue 1
-      
-      puts "Multithreading on " + processes.to_s + " processors"
+      puts "Multithreading on " + SprocketsDerailleur.worker_count + " processors"
       puts "Starting Asset Compile: " + Time.now.getutc.to_s
       
       # Then initialize the manifest with the workers you just determined
-      manifest = Sprockets::Manifest.new(env, target, processes)
+      manifest = Sprockets::Manifest.new(env, target)
       manifest.compile paths
       
       puts "Finished Asset Compile: " + Time.now.getutc.to_s
@@ -95,6 +89,28 @@ rake assets:precompile:primary RAILS_ENV=production
 
 This skips the non-digest compile, hence doubling speed (especially useful if syncing assets with a remote server).
 
+## Troubleshooting
+
+In some situations (like if you are using compass sprites) you may see
+occasional exceptions such as:
+
+```
+lib/active_support/core_ext/marshal.rb:6:in `load': end of file reached (EOFError)
+
+AND/OR
+
+lib/sprockets-derailleur/manifest.rb:127:in `write': Broken pipe (Errno::EPIPE)
+```
+
+The default cache is not safe for parallel, you can override it by adding the
+following to `config/application.rb`:
+
+```ruby
+config.assets.configure do |env|
+  env.cache = SprocketsDerailleur::FileStore.new("tmp/cache/assets")
+end
+```
+
 ## Contributing
 
 1. Fork it

data/lib/sprockets-derailleur/file_store.rb

@@ -0,0 +1,32 @@
+require 'fileutils'
+require 'timeout'
+
+# The Sprockets::Cache::FileStore is not thread/parallel safe.
+# This one uses file locks to be safe.
+module SprocketsDerailleur
+  class FileStore < Sprockets::Cache::FileStore
+    def lock
+      @lock ||= begin
+        FileUtils.mkdir_p @root
+        File.open(@root.join("lock"), File::RDWR|File::CREAT)
+      end
+    end
+
+    # Lookup value in cache
+    def [](key)
+      with_lock(File::LOCK_SH) { super }
+    end
+
+    # Save value to cache
+    def []=(key, value)
+      with_lock(File::LOCK_EX) { super }
+    end
+
+    def with_lock(type)
+      Timeout::timeout(1) { lock.flock(type) }
+      yield
+    ensure
+      lock.flock(File::LOCK_UN)
+    end
+  end
+end

data/lib/sprockets-derailleur/manifest.rb

@@ -2,16 +2,9 @@ require "sprockets"
 
 module Sprockets
   class Manifest
-    attr_reader :workers
-    
-    alias_method :old_initialize, :initialize
-    def initialize(environment, path, workers=1)
-      @workers = workers
-      old_initialize(environment, path)
-    end
-
     alias_method :compile_with_workers, :compile
     def compile(*args)
+      worker_count = SprocketsDerailleur::worker_count
       paths_with_errors = {}
 
       time = Benchmark.measure do
@@ -30,10 +23,10 @@ module Sprockets
           end
         end
 
-        logger.warn "Initializing #{@workers} workers"
+        logger.warn "Initializing #{worker_count} workers"
 
         workers = []
-        @workers.times do
+        worker_count.times do
           workers << worker(paths)
         end
 
@@ -145,4 +138,4 @@ module Sprockets
       {:read => parent_read, :write => parent_write, :pid => pid}
     end
   end
-end
+end

data/lib/sprockets-derailleur/version.rb

@@ -1,5 +1,5 @@
 module Sprockets
   module Derailleur
-    VERSION = "0.0.7"
+    VERSION = "0.0.8"
   end
 end

data/lib/sprockets-derailleur.rb

@@ -1,5 +1,6 @@
 require "sprockets-derailleur/version"
 require "sprockets-derailleur/manifest"
+require "sprockets-derailleur/file_store"
 
 module SprocketsDerailleur
   def self.number_of_processors
@@ -11,7 +12,7 @@ module SprocketsDerailleur
       # this works for windows 2000 or greater
       require 'win32ole'
       wmi = WIN32OLE.connect("winmgmts://")
-      wmi.ExecQuery("select * from Win32_ComputerSystem").each do |system| 
+      wmi.ExecQuery("select * from Win32_ComputerSystem").each do |system|
         begin
           processors = system.NumberOfLogicalProcessors
         rescue
@@ -22,4 +23,12 @@ module SprocketsDerailleur
     end
     raise "can't determine 'number_of_processors' for '#{RUBY_PLATFORM}'"
   end
+
+  def self.worker_count
+    worker_count = ENV['SPROCKETS_DERAILLEUR_WORKER_COUNT'].to_i
+    return worker_count if worker_count > 0
+    number_of_processors
+  rescue
+    1
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sprockets-derailleur
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-04 00:00:00.000000000 Z
+date: 2014-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sprockets
@@ -40,6 +40,7 @@ files:
 - README.md
 - Rakefile
 - lib/sprockets-derailleur.rb
+- lib/sprockets-derailleur/file_store.rb
 - lib/sprockets-derailleur/manifest.rb
 - lib/sprockets-derailleur/version.rb
 - sprockets-derailleur.gemspec