bootscale 0.5.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8a7aaf845e800f1f64c2c2ef8441ad54aff38c2c
-  data.tar.gz: 6b0a73fe2db054d04ba54d487182ce17f42709a1
+  metadata.gz: 8f9aae3eeb86052322d2ae6b745e8c0f0385e2d4
+  data.tar.gz: 0bbe7af30e7de21a6641771d8571d3f63efb9e1a
 SHA512:
-  metadata.gz: fc644b8650d023e093830e9f3c940bf50a13cb1f5e8fe642bedade1e4dd28b1bb533dcd0f12368a9a1bf0bf5486ed2513e940fa0228701b9c9ef768b637dc845
-  data.tar.gz: 34aada56e016d3eee070415109268a1afac1a16ef00833c3df7f7d76d8c46db37be3f7dbf3a8ea8c5e2751e861faa85234acb217f86bb121a2e9547333f56404
+  metadata.gz: 7a54144b441ef4dd3a233a8d22ce838ff6a3a13d8204a5304bd614bbd2f88b3c415b0ab62f62281e48df3a396ad2470a594387f9312997d5d6748b2d2dce5388
+  data.tar.gz: 72699fc3cf785bfa26ba3b25917978ec4f109a3b71260f92320d9b6db6f419f378e0550592f3473a5d901c7231cebfa868f0cb259285db87df892852b68336b0

data/README.md

@@ -1,5 +1,8 @@
 # Bootscale
 
+[![Build Status](https://travis-ci.org/byroot/bootscale.svg)](http://travis-ci.org/byroot/bootscale)
+[![Gem Version](https://badge.fury.io/rb/bootscale.png)](http://badge.fury.io/rb/byroot/bootscale)
+
 Speedup applications boot by caching file locations during require calls.
 
 Speed gain depends on your number of gems. Under 100 gems you likely won't see the difference,
@@ -39,7 +42,20 @@ end
 
 ## Faster cache loading
 
-Add the `msgpack` gem and `require 'msgpack'` to gain ~10-30ms of extra load speed by using msgpack.
+In order to gain ~10-30ms of extra load speed, you can use the msgpack gem:
+
+```ruby
+# Gemfile
+gem 'msgpack',   require: false
+gem 'bootscale', require: false
+```
+
+```ruby
+# config/application.rb (or wherever you have the require of bundler/setup)
+require 'bundler/setup'
+require 'msgpack'
+require 'bootscale/setup'
+```
 
 ## Under the hood
 
@@ -48,6 +64,10 @@ patches `require` + `autoload` to use these absolute paths, thereby avoiding hav
 
 Problem outlined in this [talk](https://www.youtube.com/watch?v=kwkbrOwLsZY)
 
+## Troubleshooting
+
+If you're experiencing problems with loading your application and are unable to successfully run `Bootscale.regenerate`, try deleting the `tmp/bootscale` folder.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/byroot/bootscale.

data/lib/bootscale/file_storage.rb

@@ -1,4 +1,5 @@
 require 'digest/md5'
+require_relative 'utils'
 
 module Bootscale
   class FileStorage
@@ -14,7 +15,7 @@ module Bootscale
     def dump(load_path, cache)
       path = cache_path(load_path)
       FileUtils.mkdir_p(File.dirname(path))
-      File.write(path, Serializer.dump(cache), mode: 'wb+')
+      Utils.atomic_write(path) { |f| f.write(Serializer.dump(cache)) }
     end
 
     private

data/lib/bootscale/utils.rb

@@ -0,0 +1,30 @@
+module Bootscale
+  module Utils
+    # Write to a file atomically. Useful for situations where you
+    # don't want other processes or threads to see half-written files.
+    #
+    #   Utils.atomic_write('important.file') do |file|
+    #     file.write('hello')
+    #   end
+    #
+    # Returns nothing.
+    def self.atomic_write(filename)
+      dirname, basename = File.split(filename)
+      basename = [
+          basename,
+          Thread.current.object_id,
+          Process.pid,
+          rand(1000000)
+      ].join('.'.freeze)
+      tmpname = File.join(dirname, basename)
+
+      File.open(tmpname, 'wb+') do |f|
+        yield f
+      end
+
+      File.rename(tmpname, filename)
+    ensure
+      File.delete(tmpname) if File.exist?(tmpname)
+    end
+  end
+end

data/lib/bootscale/version.rb

@@ -1,3 +1,3 @@
 module Bootscale
-  VERSION = '0.5.1'
+  VERSION = '0.5.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bootscale
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors:
 - Jean Boussier
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-02 00:00:00.000000000 Z
+date: 2016-06-27 00:00:00.000000000 Z
 dependencies: []
 description: Inspired by Aaron Patterson's talk on the subject
 email:
@@ -25,6 +25,7 @@ files:
 - lib/bootscale/entry.rb
 - lib/bootscale/file_storage.rb
 - lib/bootscale/setup.rb
+- lib/bootscale/utils.rb
 - lib/bootscale/version.rb
 homepage: https://github.com/byroot/bootscale
 licenses: []
@@ -45,7 +46,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Speedup applications boot by caching require calls