turbo-sprockets-rails4 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1854ff556095ce844de7a1c0a0220bc604343cff
+  data.tar.gz: 0f526c593fc25dee2804ec227fa4da3924262015
+SHA512:
+  metadata.gz: 9d634af0655938051494b90372b40a497248c443c548f232cab6c813603b0cad5e3f3c16edd810a4fa32dd17df168e90ce0292e070953c79f46f55a00ee19591
+  data.tar.gz: 94c3356a12c24d286825a77f8d2ff2bc985cac3552019a5040f84875648ae50ea7e77e990c6cd847400be3b60f21be6f5da22f113bb7a73d56fce7d24a9f6771

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'pry-byebug'
+  gem 'rails'
+  gem 'rake'
+  gem 'rspec', '~> 3.0'
+end

data/README.md

@@ -0,0 +1,50 @@
+## turbo-sprockets-rails4
+Speed up asset precompliation by compiling assets in parallel.
+
+## Installation
+
+`gem install turbo-sprockets-rails4`
+
+or put it in your Gemfile:
+
+```ruby
+gem 'turbo-sprockets-rails4'
+```
+
+### Rationale
+
+In a large Rails application, assets can take a very long time to precompile. It can be a real drag on productivity and deployments to have to wait until your assets are done precompiling. Although the slowness can be attributed to a number of factors, one of the most significant has to do with Ruby's single-threaded execution model. Most servers and laptops these days come with multiple processors or cores, but Rails doesn't take advantage of them. Wouldn't it be nice if we could put all our CPU cores to work precompiling assets?
+
+That's where this gem comes in. turbo-sprockets is capable of precompiling assets in parallel, using all the CPU cores available on your laptop or server. Generally this translates into a substantial speed increase. In one of the large codebases I've worked on, turbo-sprockets decreased the total precompile time from ~12 minutes to ~2 minutes using the four cores on my laptop.
+
+### Getting Started
+
+turbo-sprockets is designed to work as a drop-in addition to your Rails app. Adding it to your Gemfile and running `bundle install` should be all that's necessary to enable your application to precompile assets in parallel.
+
+### Configuration
+
+Rather than guess how many CPU cores your computer has (which can be error prone), turbo-sprockets asks that you set the `SPROCKETS_WORKER_COUNT` environment variable (2 cores are used by default). For example, to precompile using 4 workers, you might run:
+
+```bash
+SPROCKETS_WORKER_COUNT=4 bundle exec rake assets:precompile
+```
+
+### How Does it Work?
+
+Under the hood, turbo-sprockets uses the [parallel](https://github.com/grosser/parallel) gem to divide your assets up amongst the available CPUs. It works by [forking](https://en.wikipedia.org/wiki/Fork_(system_call)) into multiple system processes which are executed in parallel by your operating system.
+
+### Supported Platforms
+
+turbo-sprockets works with any Ruby that supports `Process#fork` such as the Rubies that run on most flavors of Unix, Linux, BSD, and MacOS. It won't work on Windows. Specifically, if `Process#fork` isn't available, turbo-sprockets won't raise an error, but it also won't provide any sort of speed improvement.
+
+### Disclaimer
+
+Everybody's setup is a little different, so please remember that, with respect to turbo-sprockets, your mileage may vary. You may see an increase in precompliation speed or none at all depending on the mix of assets in your application.
+
+## License
+
+Licensed under the MIT license. See LICENSE for details.
+
+## Authors
+
+* Cameron C. Dutro: http://github.com/camertron

data/Rakefile

@@ -0,0 +1,23 @@
+# encoding: UTF-8
+
+$:.unshift File.join(File.dirname(__FILE__), 'lib')
+
+require 'rubygems' unless ENV['NO_RUBYGEMS']
+
+require 'bundler'
+require 'pry-byebug'
+require 'rspec/core/rake_task'
+require 'rubygems/package_task'
+
+require 'rails'
+require 'sprockets/railtie'
+require 'turbo-sprockets-rails4'
+
+Bundler::GemHelper.install_tasks
+
+task default: :spec
+
+desc 'Run specs'
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = './spec/**/*_spec.rb'
+end

data/lib/turbo-sprockets-rails4.rb

@@ -0,0 +1,9 @@
+require 'turbo-sprockets/railtie'
+
+module TurboSprockets
+  autoload :ParallelCompiler, 'turbo-sprockets/parallel_compiler'
+
+  def self.logger
+    Rails.application.assets_manifest.send(:logger)
+  end
+end

data/lib/turbo-sprockets/parallel_compiler.rb

@@ -0,0 +1,100 @@
+require 'benchmark'
+require 'parallel'
+require 'json'
+
+module TurboSprockets
+  class ParallelCompiler
+    DEFAULT_WORKER_COUNT = 2
+
+    attr_reader :manifest
+
+    def initialize(manifest)
+      @manifest = manifest
+    end
+
+    def compile(*args)
+      logger.warn "Precompiling with #{worker_count} workers"
+
+      time = Benchmark.measure do
+        results = compile_in_parallel(find_precompile_paths(*args))
+        write_manifest(results)
+      end
+
+      logger.info "Completed precompiling assets (#{time.real.round(2)}s)"
+    end
+
+    private
+
+    def write_manifest(results)
+      File.write(manifest.filename, results.to_json)
+    end
+
+    def compile_in_parallel(paths)
+      flatten_precomp_results(
+        Parallel.map(paths, in_processes: worker_count) do |path|
+          manifest.compile_without_parallelism([path])
+
+          { 'files' => {}, 'assets' => {} }.tap do |data|
+            manifest.find([path]) do |asset|
+              logger.info("Writing #{asset.digest_path}")
+
+              data['files'][asset.digest_path] = properties_for(asset)
+              data['assets'][asset.logical_path] = asset.digest_path
+
+              if alias_logical_path = manifest.class.compute_alias_logical_path(asset.logical_path)
+                data['assets'][alias_logical_path] = asset.digest_path
+              end
+            end
+          end
+        end
+      )
+    end
+
+    def flatten_precomp_results(results)
+      results.each_with_object({}) do |result, ret|
+        result.each_pair do |key, data|
+          (ret[key] ||= {}).merge!(data)
+        end
+      end
+    end
+
+    def find_precompile_paths(*args)
+      paths, filters = args.flatten.partition do |pre|
+        manifest.class.simple_logical_path?(pre)
+      end
+
+      filters = filters.map do |filter|
+        manifest.class.compile_match_filter(filter)
+      end
+
+      environment.logical_paths.each do |logical_path, filename|
+        if filters.any? { |f| f.call(logical_path, filename) }
+          paths << filename
+        end
+      end
+
+      paths
+    end
+
+    def properties_for(asset)
+      {
+        'logical_path' => asset.logical_path,
+        'mtime'        => asset.mtime.iso8601,
+        'size'         => asset.bytesize,
+        'digest'       => asset.hexdigest,
+      }
+    end
+
+    def worker_count
+      @worker_count ||= ENV.fetch('SPROCKETS_WORKER_COUNT', DEFAULT_WORKER_COUNT).to_i
+    end
+
+    def environment
+      manifest.environment
+    end
+
+    def logger
+      ::TurboSprockets.logger
+    end
+  end
+end

data/lib/turbo-sprockets/railtie.rb

@@ -0,0 +1,15 @@
+module TurboSprockets
+  class Railtie < ::Rails::Railtie
+    initializer 'turbo-sprockets' do
+      unless Sprockets::Manifest.method_defined?(:compile_with_parallelism)
+        Sprockets::Manifest.class_eval do
+          def compile_with_parallelism(*args)
+            ::TurboSprockets::ParallelCompiler.new(self).compile(*args)
+          end
+
+          alias_method_chain :compile, :parallelism
+        end
+      end
+    end
+  end
+end

data/lib/turbo-sprockets/version.rb

@@ -0,0 +1,3 @@
+module TurboSprockets
+  VERSION = '1.0.0'
+end

data/spec/app/assets/javascripts/file1.js

@@ -0,0 +1,3 @@
+function() {
+  var foo = 'bar';
+}

data/spec/app/assets/javascripts/file2.js

@@ -0,0 +1,3 @@
+function() {
+  var foo = 'baz';
+}

data/spec/config/application.rb

@@ -0,0 +1,13 @@
+module TurboSprockets
+  class DummyApplication < ::Rails::Application
+    config.eager_load = false
+    config.active_support.deprecation = :stderr
+
+    config.assets.enabled = true
+    config.assets.compile = true
+    config.assets.allow_debugging = true
+    config.assets.digest = true
+    config.assets.manifest = 'spec/public/assets/.sprockets-manifest.json'
+    config.assets.precompile += %w(file1.js file2.js)
+  end
+end

data/spec/parallel_compiler_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+describe TurboSprockets::ParallelCompiler do
+  def precompile!
+    Rake::Task['assets:precompile'].reenable
+    Rake::Task['assets:precompile'].invoke
+  end
+
+  def with_env(env)
+    # ENV can't be duped, so use select instead to make a copy
+    old_env = ENV.select { true }
+    env.each_pair { |k, v| ENV[k] = v }
+    yield
+  ensure
+    # reset back to old vars
+    env.each_pair { |k, _| ENV[k] = old_env[k] }
+  end
+
+  let(:files) do
+    {
+      'file1.js' => 'file1-9461265d541718e5776632b202c4ccdd21f13d9cd7d0b4d92c1b43131292749a.js',
+      'file2.js' => 'file2-e2a24754a5ca8cb2f9c645a80ad4d4ca375c4d9914f1d962b4fb3e779dc4ad34.js'
+    }
+  end
+
+  it 'precompiles all assets' do
+    # make sure we have _some_ way of knowing parallel compliation is happening
+    expect(Parallel).to receive(:map).and_call_original
+
+    precompile!
+
+    files.each do |logical_path, digest_path|
+      expect(assets_dir.join(digest_path)).to exist
+      expect(assets_dir.join("#{digest_path}.gz")).to exist
+    end
+  end
+
+  it 'writes a manifest' do
+    precompile!
+    expect(Pathname(app.config.assets.manifest)).to exist
+    manifest = JSON.parse(File.read(app.config.assets.manifest))
+    expect(manifest['assets']).to eq(files)
+  end
+
+  it 'uses the specified number of workers' do
+    logger = CapturingLogger.new
+    allow(TurboSprockets).to receive(:logger).and_return(logger)
+
+    with_env('SPROCKETS_WORKER_COUNT' => '4') do
+      precompile!
+    end
+
+    expect(logger.messages).to include([:warn, 'Precompiling with 4 workers'])
+  end
+end

data/spec/public/assets/file1-9461265d541718e5776632b202c4ccdd21f13d9cd7d0b4d92c1b43131292749a.js

@@ -0,0 +1,4 @@
+function() {
+  var foo = 'bar';
+}
+;

data/spec/public/assets/file2-e2a24754a5ca8cb2f9c645a80ad4d4ca375c4d9914f1d962b4fb3e779dc4ad34.js

@@ -0,0 +1,4 @@
+function() {
+  var foo = 'baz';
+}
+;

data/spec/spec_helper.rb

@@ -0,0 +1,66 @@
+# encoding: UTF-8
+
+$:.push(File.dirname(__FILE__))
+
+require 'rspec'
+require 'pry-byebug'
+
+require 'rails'
+require 'rake'
+require 'sprockets/railtie'
+
+ENV['RAILS_ENV'] ||= 'test'
+
+require 'turbo-sprockets-rails4'
+
+Dir.chdir('spec') do
+  require File.expand_path('../config/application', __FILE__)
+  TurboSprockets::DummyApplication.initialize!
+  TurboSprockets::DummyApplication.load_tasks  # used by precompilation specs
+end
+
+module LetDeclarations
+  extend RSpec::SharedContext
+
+  let(:app) do
+    Rails.application
+  end
+
+  let(:assets_dir) do
+    TurboSprockets::DummyApplication.root.join('public/assets')
+  end
+
+  let(:tmp_dir) do
+    TurboSprockets::DummyApplication.root.join('tmp')
+  end
+end
+
+class CapturingLogger
+  attr_reader :messages
+
+  def initialize
+    @messages = []
+  end
+
+  def info(msg)
+    messages << [:info, msg]
+  end
+
+  def warn(msg)
+    messages << [:warn, msg]
+  end
+
+  def error(msg)
+    messages << [:error, msg]
+  end
+end
+
+RSpec.configure do |config|
+  config.include(LetDeclarations)
+
+  config.before(:each) do
+    FileUtils.rm_rf(tmp_dir)
+    FileUtils.rm_rf(assets_dir)
+    FileUtils.mkdir_p(assets_dir)
+  end
+end

data/spec/tmp/cache/assets/sprockets/v3.0/0g/0geAvurz1AX0xI67Ou6WBG0HEnHLFZG5Rbvog7JuFh8.cache

@@ -0,0 +1 @@
+"%h,t�[�J�!�R����S$I�9Q�F2��^g�

data/spec/tmp/cache/assets/sprockets/v3.0/Ny/Ny4Hng5x4A-TVYWIKr0AjzqV9U32nMfeROjIYX3t1zc.cache

@@ -0,0 +1 @@
+I"
app/assets/javascripts/file1.js?type=application/javascript&id=fd26267e172201fa2d3b128fce4cb1a53c227f28aa0b693ac2708a9ab0b44ea2:ET

data/spec/tmp/cache/assets/sprockets/v3.0/Oo/OoRDv9ysw5g18-975bcUUGTFBnb0-ShhbDgUqo-VuOU.cache

@@ -0,0 +1,2 @@
+[o:Set:
+@hash}I"environment-version:ETTI"environment-paths;TTI"rails-env;TTI"Lprocessors:type=application/javascript&file_type=application/javascript;TTI"2file-digest://app/assets/javascripts/file1.js;TTI"Zprocessors:type=application/javascript&file_type=application/javascript&pipeline=self;TTF

data/spec/tmp/cache/assets/sprockets/v3.0/Py/PyP_Z86btB-ByMXeasgN-buL98MfdATp8WPzc8AWy6c.cache

@@ -0,0 +1 @@
+I"
app/assets/javascripts/file2.js?type=application/javascript&id=8e7ad17b3e9d5262767b265f3b265c1f5fc9742a2782ce3232b8087632963d4d:ET

data/spec/tmp/cache/assets/sprockets/v3.0/Yi/Yi_k91msAv7kbymP50BwVfhkKwo_XMEZIJmMf6LgTAA.cache

@@ -0,0 +1 @@
+"%N�a�t�%�چ�e�o/���H.����t⠝

data/spec/tmp/cache/assets/sprockets/v3.0/_4/_4pm9XADf-SWLKsx4Qea0XRAZetvbGWa8MQf_aMqcm0.cache

@@ -0,0 +1,3 @@
+[o:Set:
+@hash}
+I"environment-version:ETTI"environment-paths;TTI"rails-env;TTI"Zprocessors:type=application/javascript&file_type=application/javascript&pipeline=self;TTI"2file-digest://app/assets/javascripts/file2.js;TTF

data/spec/tmp/cache/assets/sprockets/v3.0/b8/b8XCYwFHJAQi_UQnYIe_rPgE6W5gMlmY69smkT7lUUg.cache

@@ -0,0 +1 @@
+I"
�app/assets/javascripts/file2.js?type=application/javascript&pipeline=self&id=93fac2a2152bd5b89fdb8f97fd3fac83e8b82a3621681c1f077981a977775fcf:ET

data/spec/tmp/cache/assets/sprockets/v3.0/c5/c5fWyhSDQYpk5wBXxoIj4L8d8VRI5fx8BA-Vusc-Tm8.cache

@@ -0,0 +1,3 @@
+[o:Set:
+@hash}
+I"environment-version:ETTI"environment-paths;TTI"rails-env;TTI"Zprocessors:type=application/javascript&file_type=application/javascript&pipeline=self;TTI"2file-digest://app/assets/javascripts/file1.js;TTF

data/spec/tmp/cache/assets/sprockets/v3.0/fi/fide8IvH1RAoWxoK8yipcMFLPqQym3YmbZs93J5nyGM.cache

@@ -0,0 +1,2 @@
+[o:Set:
+@hash}I"environment-version:ETTI"environment-paths;TTI"rails-env;TTI"Lprocessors:type=application/javascript&file_type=application/javascript;TTI"2file-digest://app/assets/javascripts/file2.js;TTI"Zprocessors:type=application/javascript&file_type=application/javascript&pipeline=self;TTF

data/spec/tmp/cache/assets/sprockets/v3.0/sk/skLSgxSN-gAyttjzKsGZfvS6147mrFxxK3ztXCqNNP8.cache

@@ -0,0 +1 @@
+I"
�app/assets/javascripts/file1.js?type=application/javascript&pipeline=self&id=18ce48382a6f42ab81da8c115f1e4c686ad07b2fec30a431a20e627dd718ae7f:ET

data/turbo-sprockets-rails4.gemspec

@@ -0,0 +1,22 @@
+$:.unshift File.join(File.dirname(__FILE__), 'lib')
+require 'turbo-sprockets/version'
+
+Gem::Specification.new do |s|
+  s.name     = 'turbo-sprockets-rails4'
+  s.version  = ::TurboSprockets::VERSION
+  s.authors  = ['Cameron Dutro']
+  s.email    = ['camertron@gmail.com']
+  s.homepage = 'http://github.com/camertron'
+
+  s.description = s.summary = 'Speed up asset precompliation by compiling assets in parallel.'
+
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+
+  s.add_dependency 'parallel', '~> 1.0'
+  s.add_dependency 'railties', '>= 4', '< 5'
+  s.add_dependency 'sprockets', '~> 3.0'
+
+  s.require_path = 'lib'
+  s.files = Dir['{lib,spec}/**/*', 'Gemfile', 'README.md', 'Rakefile', 'turbo-sprockets-rails4.gemspec']
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: turbo-sprockets-rails4
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Cameron Dutro
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-05-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: parallel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: sprockets
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Speed up asset precompliation by compiling assets in parallel.
+email:
+- camertron@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- Rakefile
+- lib/turbo-sprockets-rails4.rb
+- lib/turbo-sprockets/parallel_compiler.rb
+- lib/turbo-sprockets/railtie.rb
+- lib/turbo-sprockets/version.rb
+- spec/app/assets/javascripts/file1.js
+- spec/app/assets/javascripts/file2.js
+- spec/config/application.rb
+- spec/log/test.log
+- spec/parallel_compiler_spec.rb
+- spec/public/assets/file1-9461265d541718e5776632b202c4ccdd21f13d9cd7d0b4d92c1b43131292749a.js
+- spec/public/assets/file1-9461265d541718e5776632b202c4ccdd21f13d9cd7d0b4d92c1b43131292749a.js.gz
+- spec/public/assets/file2-e2a24754a5ca8cb2f9c645a80ad4d4ca375c4d9914f1d962b4fb3e779dc4ad34.js
+- spec/public/assets/file2-e2a24754a5ca8cb2f9c645a80ad4d4ca375c4d9914f1d962b4fb3e779dc4ad34.js.gz
+- spec/spec_helper.rb
+- spec/tmp/cache/assets/sprockets/v3.0/-m/-mYOrHQQw4eQz_Ht_LzLRCkKUaiPsHUZnmBchCOMAQU.cache
+- spec/tmp/cache/assets/sprockets/v3.0/0g/0geAvurz1AX0xI67Ou6WBG0HEnHLFZG5Rbvog7JuFh8.cache
+- spec/tmp/cache/assets/sprockets/v3.0/F9/F9uLDkuCpwXDtwzIob92yhwmsuBy0NUF2GnJGRiyWF4.cache
+- spec/tmp/cache/assets/sprockets/v3.0/FA/FA7o1GffPYj_2A2EsHqBM8vMKfdSdGYJzMYpjhkXAxE.cache
+- spec/tmp/cache/assets/sprockets/v3.0/Ny/Ny4Hng5x4A-TVYWIKr0AjzqV9U32nMfeROjIYX3t1zc.cache
+- spec/tmp/cache/assets/sprockets/v3.0/Oo/OoRDv9ysw5g18-975bcUUGTFBnb0-ShhbDgUqo-VuOU.cache
+- spec/tmp/cache/assets/sprockets/v3.0/Py/PyP_Z86btB-ByMXeasgN-buL98MfdATp8WPzc8AWy6c.cache
+- spec/tmp/cache/assets/sprockets/v3.0/Yi/Yi_k91msAv7kbymP50BwVfhkKwo_XMEZIJmMf6LgTAA.cache
+- spec/tmp/cache/assets/sprockets/v3.0/_4/_4pm9XADf-SWLKsx4Qea0XRAZetvbGWa8MQf_aMqcm0.cache
+- spec/tmp/cache/assets/sprockets/v3.0/b8/b8XCYwFHJAQi_UQnYIe_rPgE6W5gMlmY69smkT7lUUg.cache
+- spec/tmp/cache/assets/sprockets/v3.0/c5/c5fWyhSDQYpk5wBXxoIj4L8d8VRI5fx8BA-Vusc-Tm8.cache
+- spec/tmp/cache/assets/sprockets/v3.0/fi/fide8IvH1RAoWxoK8yipcMFLPqQym3YmbZs93J5nyGM.cache
+- spec/tmp/cache/assets/sprockets/v3.0/rs/rsmYKfF63AJstBxp9BfJQ_Alz93hJXeRW6AlZasgAg8.cache
+- spec/tmp/cache/assets/sprockets/v3.0/sk/skLSgxSN-gAyttjzKsGZfvS6147mrFxxK3ztXCqNNP8.cache
+- turbo-sprockets-rails4.gemspec
+homepage: http://github.com/camertron
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Speed up asset precompliation by compiling assets in parallel.
+test_files: []