sprockets-derailleur 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 44edd61c8b242defbd08b9e80a68cef7b2f15ebc
-  data.tar.gz: bbe80f95343fc291abb6138a543769411f51a0fd
+  metadata.gz: ccc65b211fb466e3602a25feedd7d969648e2b9e
+  data.tar.gz: a9be9ff647af9cba0fdd5167be5c462e58719127
 SHA512:
-  metadata.gz: 6ab698ea4f8ae75a34e724c000a07fa7605a0bf8db4f71bb08144440886e9aafa84a622c467754859b26f809b9e6187161b625450b09b13412615cb7ef9a2b54
-  data.tar.gz: 6e40312aabc329f8d56340105720d3394c5ca0c0d7cf888a6b8cdc013a7695370ea3c2bfe1525c3516f7c7bae490ee25210018cd3efa24129de1992f400a9ad7
+  metadata.gz: efa4573354b0e808e81e4346e802f21d47e686b85baa67c451965c6ada3a8fe2c7ab2295d0a8f5f5569a390a0ffc6657edd8f43ffe509a4162183d5154e662df
+  data.tar.gz: 3ea74c387c00279abdfb77ff04bcd38680c1d0098718897453ec8db89c392a60aa947a75e17dc7092044bbf53f34923dac416a8de0aa72d28463f111f91e2f56

data/README.md

@@ -1,6 +1,8 @@
 # Sprockets::Derailleur
 
-Speed up Manifest::Compile by forking processes 
+Speed up Manifest::Compile by forking processes
+
+**Warning: Do not use with Sprockets 3+!** (See [#25](https://github.com/steel/sprockets-derailleur/issues/25) for details.)
 
 ## Installation
 
@@ -10,9 +12,38 @@ Speed up Manifest::Compile by forking processes
 
 ## Usage
 
-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.
+To override the number of processes you can use the `worker_count` configuration
+setting or the `SPROCKETS_DERAILLEUR_WORKER_COUNT` environment variable.
+It defaults to the number of processors on your machine.
+
+### Configuration
+
+You are able to configure Sprockets::Derailleur by creating a configure block (an example can be seen below).
+This is entirely optional and will by default use the settings commented out in the example below.
+If you would like to configure Sprockets::Derailleur, putting this configuration in an initializer is a good idea.
+
+```ruby
+# file: config/initializers/sprockets-derailleur.rb
+
+SprocketsDerailleur.configure do |config|
+  # Override how long the file lock timeout lasts
+  # config.file_lock_timeout = 10
+
+  # Set to true to log the compiled time lines to the info level
+  # (usually they are logged to the debug level)
+  #config.compile_times_to_info_log = false
+
+  # Override the number of workers to use
+  # If not set will use SPROCKETS_DERAILLEUR_WORKER_COUNT environment variable
+  # and if that's also not set, then will use the number of processors
+  # config.worker_count = 8
+
+  # Has the same effect as setting the rails cache file store to be the new
+  # thread safe sprockets derailleur one, but monkey patches methods instead of
+  # instantiating new object.
+  # config.use_sprockets_derailleur_file_store = false
+end
+```
 
 ### Rails 4.0
 
@@ -27,24 +58,24 @@ Here we need to override some core parts of the sprockets module.
 ```ruby
 module Sprockets
   class StaticCompiler
-  
+
     alias_method :compile_without_manifest, :compile
     def compile
       puts "Multithreading on " + SprocketsDerailleur.worker_count.to_s + " 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)
       manifest.compile paths
-      
+
       puts "Finished Asset Compile: " + Time.now.getutc.to_s
-      
+
     end
   end
-  
+
   class Railtie < ::Rails::Railtie
     config.after_initialize do |app|
-      
+
       config = app.config
       next unless config.assets.enabled
 
@@ -58,10 +89,10 @@ module Sprockets
         manifest = Sprockets::Manifest.new(app, path)
         config.assets.digests = manifest.assets
       end
-      
+
     end
   end
-  
+
 end
 ```
 

data/lib/sprockets-derailleur.rb

@@ -1,8 +1,22 @@
 require "sprockets-derailleur/version"
 require "sprockets-derailleur/manifest"
+require "sprockets-derailleur/file_store_extension"
 require "sprockets-derailleur/file_store"
+require "sprockets-derailleur/configuration"
 
 module SprocketsDerailleur
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
   def self.number_of_processors
     if RUBY_PLATFORM =~ /linux/
       return `cat /proc/cpuinfo | grep processor | wc -l`.to_i
@@ -25,10 +39,18 @@ module SprocketsDerailleur
   end
 
   def self.worker_count
-    worker_count = ENV['SPROCKETS_DERAILLEUR_WORKER_COUNT'].to_i
+    worker_count = SprocketsDerailleur.configuration.worker_count || ENV['SPROCKETS_DERAILLEUR_WORKER_COUNT'].to_i
     return worker_count if worker_count > 0
     number_of_processors
   rescue
     1
   end
-end
+
+  def self.prepend_file_store_if_required
+    if SprocketsDerailleur.configuration.use_sprockets_derailleur_file_store
+      Sprockets::Cache::FileStore.class_eval do
+        prepend SprocketsDerailleur::FileStoreExtension
+      end
+    end
+  end
+end

data/lib/sprockets-derailleur/configuration.rb

@@ -0,0 +1,12 @@
+module SprocketsDerailleur
+  class Configuration
+    attr_accessor :file_lock_timeout, :compile_times_to_info_log, :worker_count, :use_sprockets_derailleur_file_store
+
+    def initialize
+      @file_lock_timeout = 10
+      @compile_times_to_info_log = false
+      @worker_count = nil
+      @use_sprockets_derailleur_file_store = false
+    end
+  end
+end

data/lib/sprockets-derailleur/file_store.rb

@@ -1,32 +1,7 @@
-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(10) { lock.flock(type) }
-      yield
-    ensure
-      lock.flock(File::LOCK_UN)
-    end
+    prepend SprocketsDerailleur::FileStoreExtension
   end
 end

data/lib/sprockets-derailleur/file_store_extension.rb

@@ -0,0 +1,30 @@
+require 'fileutils'
+require 'timeout'
+
+module SprocketsDerailleur
+  module FileStoreExtension
+    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(SprocketsDerailleur.configuration.file_lock_timeout) { lock.flock(type) }
+      yield
+    ensure
+      lock.flock(File::LOCK_UN)
+    end
+  end
+end

data/lib/sprockets-derailleur/manifest.rb

@@ -4,6 +4,8 @@ module Sprockets
   class Manifest
     alias_method :compile_with_workers, :compile
     def compile(*args)
+      SprocketsDerailleur::prepend_file_store_if_required
+
       worker_count = SprocketsDerailleur::worker_count
       paths_with_errors = {}
 
@@ -121,7 +123,11 @@ module Sprockets
               end
             end
 
-            logger.debug "Compiled #{path} (#{(time.real * 1000).round}ms, pid #{Process.pid})"
+            if SprocketsDerailleur.configuration.compile_times_to_info_log
+              logger.info "Compiled #{path} (#{(time.real * 1000).round}ms, pid #{Process.pid})"
+            else
+              logger.debug "Compiled #{path} (#{(time.real * 1000).round}ms, pid #{Process.pid})"
+            end
           end
         ensure
           child_read.close

data/lib/sprockets-derailleur/version.rb

@@ -1,5 +1,5 @@
 module Sprockets
   module Derailleur
-    VERSION = "1.0.0"
+    VERSION = "1.1.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sprockets-derailleur
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Steel Fu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-12 00:00:00.000000000 Z
+date: 2017-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sprockets
@@ -37,7 +37,9 @@ files:
 - README.md
 - Rakefile
 - lib/sprockets-derailleur.rb
+- lib/sprockets-derailleur/configuration.rb
 - lib/sprockets-derailleur/file_store.rb
+- lib/sprockets-derailleur/file_store_extension.rb
 - lib/sprockets-derailleur/manifest.rb
 - lib/sprockets-derailleur/version.rb
 - sprockets-derailleur.gemspec
@@ -60,7 +62,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.3
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Multi process sprockets compiling