bootscale 0.5.2 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8f9aae3eeb86052322d2ae6b745e8c0f0385e2d4
-  data.tar.gz: 0bbe7af30e7de21a6641771d8571d3f63efb9e1a
+  metadata.gz: 18d8250aaa3d20edb7c2d8279f04eb1ec4f87493
+  data.tar.gz: f93a4fd4d1369f68b06b616b113f47bbd88f3444
 SHA512:
-  metadata.gz: 7a54144b441ef4dd3a233a8d22ce838ff6a3a13d8204a5304bd614bbd2f88b3c415b0ab62f62281e48df3a396ad2470a594387f9312997d5d6748b2d2dce5388
-  data.tar.gz: 72699fc3cf785bfa26ba3b25917978ec4f109a3b71260f92320d9b6db6f419f378e0550592f3473a5d901c7231cebfa868f0cb259285db87df892852b68336b0
+  metadata.gz: c32e0137cd9c339c9e2a4e9eb3bc31f0aff386a924631cf561e28df58d103c38d079719d11e89e2cdc61124d181f34851c874c479b508efa6912fc3310544ce6
+  data.tar.gz: 266605dcdcd8bb793ac7cd2719e4a8c3680a611dad42a9d524a6d66737596e7a2233bc70e28e0818ead8b034114e6e02cfdfc1997558362838d87c566e184c2c

data/README.md

@@ -14,16 +14,6 @@ but for bigger applications it can save 1 to 3 seconds of boot time per 100 used
 # Gemfile
 gem 'bootscale', require: false
 ```
-
-Then you need to add right after `require 'bundler/setup'`:
-
-```ruby
-require 'bundler/setup'
-require 'bootscale/setup'
-```
-
-If your application is a Rails application, you will find this in `config/boot.rb`.
-
 ### Important
 
 For correctness cache should be updated everytime `$LOAD_PATH` is modified by calling `Bootscale.regenerate`.
@@ -38,6 +28,22 @@ module MyApp
     end
   end
 end
+
+### Rails applications
+
+Locate `require 'bundler/setup'` in `config/boot.rb` and add `require 'bootscale/rails'` after it:
+```ruby
+require 'bundler/setup'
+require 'bootscale/rails'
+```
+
+### Other Bundler enabled applications
+
+Locate `require 'bundler/setup'`, and add `require 'bootscale/setup'` after it:
+
+```ruby
+require 'bundler/setup'
+require 'bootscale/setup'
 ```
 
 ## Faster cache loading
@@ -51,10 +57,10 @@ gem 'bootscale', require: false
 ```
 
 ```ruby
-# config/application.rb (or wherever you have the require of bundler/setup)
+# config/boot.rb (or wherever you have the require of bundler/setup)
 require 'bundler/setup'
 require 'msgpack'
-require 'bootscale/setup'
+require 'bootscale/setup' # or require 'bootscale/rails'
 ```
 
 ## Under the hood
@@ -66,7 +72,7 @@ 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.
+If you're experiencing problems with loading your application, especially after moving files around, try deleting the `tmp/bootscale` folder.
 
 ## Contributing
 

data/lib/bootscale/active_support/core_ext.rb

@@ -0,0 +1,16 @@
+require 'active_support/dependencies'
+
+module ActiveSupport
+  module Dependencies
+    undef_method :search_for_file
+
+    # ActiveSupport::Dependencies.search_for_file works pretty much like Kernel#require.
+    # It has a load path (AS::Dependencies.autoload_paths) and when it's looking for a file to load
+    # it search the load path entries one by one for a match.
+    # So just like for Kernel#require, this process is increasingly slow the more load path entries you have,
+    # and it can be optimized with exactly the same caching strategy.
+    def search_for_file(path)
+      ::Bootscale::ActiveSupport.cache[path]
+    end
+  end
+end

data/lib/bootscale/active_support.rb

@@ -0,0 +1,40 @@
+module Bootscale
+  module ActiveSupport
+    class Cache < ::Bootscale::Cache
+      def load_path
+        ::ActiveSupport::Dependencies.autoload_paths
+      end
+
+      # Ideally we'd use a more accurate comparison like `#hash`, unfortunately it's
+      # not efficient enough given how much of a hot spot this is.
+      # So we assume entries are not mutated or replaced, only added or removed.
+      # It is obviously wrong sometimes, and you'll have to manually call Bootscale.regenerate
+      def reload(force = true)
+        @load_path_size ||= nil
+
+        if force
+          @cache = fetch(load_path)
+          @load_path_size = load_path.size
+        elsif (size = load_path.size) != @load_path_size
+          @cache = fetch(load_path)
+          @load_path_size = size
+        end
+      end
+    end
+
+    class << self
+      attr_reader :cache, :cache_directory
+
+      def cache_builder
+        @cache_builder ||= CacheBuilder.new
+      end
+
+      def setup(options = {})
+        @cache_directory = options.fetch(:cache_directory, Bootscale.cache_directory)
+        require 'active_support/dependencies'
+        @cache = Cache.new(cache_directory)
+        require_relative 'active_support/core_ext'
+      end
+    end
+  end
+end

data/lib/bootscale/cache.rb

@@ -0,0 +1,48 @@
+require_relative 'file_storage'
+
+module Bootscale
+  class Cache
+    def initialize(cache_directory = nil)
+      @storage = FileStorage.new(cache_directory) if cache_directory
+      reload
+    end
+
+    def load_path
+      $LOAD_PATH
+    end
+
+    def reload(force = true)
+      @cache = fetch(load_path) if force
+    end
+
+    def [](path)
+      path = path.to_s
+      return if path.start_with?(LEADING_SLASH)
+      reload(false)
+      if path.end_with?(DOT_RB, DOT_SO)
+        @cache[path]
+      else
+        @cache["#{path}#{DOT_RB}"] || @cache["#{path}#{DOT_SO}"]
+      end
+    end
+
+    private
+
+    attr_reader :storage
+
+    def fetch(load_path)
+      load || save(Bootscale.cache_builder.generate(load_path))
+    end
+
+    def load
+      return unless storage
+      storage.load(load_path)
+    end
+
+    def save(cache)
+      return cache unless storage
+      storage.dump(load_path, cache)
+      cache
+    end
+  end
+end

data/lib/bootscale/core_ext.rb

@@ -1,20 +1,20 @@
 module Kernel
   alias_method :require_without_cache, :require
   def require(path)
-    require_without_cache(Bootscale[path] || path)
+    require_without_cache(Bootscale.cache[path] || path)
   end
 end
 
 class << Kernel
   alias_method :require_without_cache, :require
   def require(path)
-    require_without_cache(Bootscale[path] || path)
+    require_without_cache(Bootscale.cache[path] || path)
   end
 end
 
 class Module
   alias_method :autoload_without_cache, :autoload
   def autoload(const, path)
-    autoload_without_cache(const, Bootscale[path] || path)
+    autoload_without_cache(const, Bootscale.cache[path] || path)
   end
 end

data/lib/bootscale/rails.rb

@@ -0,0 +1,3 @@
+require_relative 'setup'
+require_relative 'active_support'
+Bootscale::ActiveSupport.setup

data/lib/bootscale/version.rb

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

data/lib/bootscale.rb

@@ -6,55 +6,24 @@ module Bootscale
   LEADING_SLASH = '/'.freeze
 
   class << self
-    def [](path)
-      path = path.to_s
-      return if path.start_with?(LEADING_SLASH)
-      if path.end_with?(DOT_RB, DOT_SO)
-        @cache[path]
-      else
-        @cache["#{path}#{DOT_RB}"] || @cache["#{path}#{DOT_SO}"]
-      end
-    end
-
-    def setup(options = {})
-      self.cache_directory = options[:cache_directory]
-      require_relative 'bootscale/core_ext'
-      regenerate
-    end
-
-    def regenerate
-      @cache = load_cache || save_cache(cache_builder.generate($LOAD_PATH))
-    end
-
-    private
+    attr_reader :cache, :cache_directory
 
     def cache_builder
       @cache_builder ||= CacheBuilder.new
     end
 
-    def load_cache
-      return unless storage
-      storage.load($LOAD_PATH)
-    end
-
-    def save_cache(cache)
-      return cache unless storage
-      storage.dump($LOAD_PATH, cache)
-      cache
+    def regenerate
+      cache.reload
     end
 
-    attr_accessor :storage
-
-    def cache_directory=(directory)
-      if directory
-        require_relative 'bootscale/file_storage'
-        self.storage = FileStorage.new(directory)
-      else
-        self.storage = nil
-      end
+    def setup(options = {})
+      @cache_directory = options[:cache_directory]
+      @cache = Cache.new(cache_directory)
+      require_relative 'bootscale/core_ext'
     end
   end
 end
 
 require_relative 'bootscale/entry'
 require_relative 'bootscale/cache_builder'
+require_relative 'bootscale/cache'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bootscale
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.6.0
 platform: ruby
 authors:
 - Jean Boussier
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-27 00:00:00.000000000 Z
+date: 2016-12-09 00:00:00.000000000 Z
 dependencies: []
 description: Inspired by Aaron Patterson's talk on the subject
 email:
@@ -20,10 +20,14 @@ files:
 - LICENSE.txt
 - README.md
 - lib/bootscale.rb
+- lib/bootscale/active_support.rb
+- lib/bootscale/active_support/core_ext.rb
+- lib/bootscale/cache.rb
 - lib/bootscale/cache_builder.rb
 - lib/bootscale/core_ext.rb
 - lib/bootscale/entry.rb
 - lib/bootscale/file_storage.rb
+- lib/bootscale/rails.rb
 - lib/bootscale/setup.rb
 - lib/bootscale/utils.rb
 - lib/bootscale/version.rb