faster_require 0.7.4 → 0.8.0

data/ChangeLog

@@ -1,3 +1,5 @@
+0.7.5: unique hash now, for the cache file [hopefuly]
+
 0.7.4: allow double loading, for rails apps and gems to load it.
 
 0.7.3: work with 1.9 require_relative

data/README

@@ -1,105 +1,134 @@
-A little utility to make
-
-require 'xxx'
-
-take much less time.  As in much less.  Well, on windows at least. And to speedup how long it takes things to load in windows, like rails apps.
-
-Well, mostly on windows--on linux it's a speedup of only 0.41 to 0.45s, or so. [1]
-
-If you've ever wondered why ruby feels slow on doze...sometimes it's just the startup time.  This really helps.
-
-Benchmarks:
-
-loading a (blank) rspec file:
-
-  1.9.1   
-    without 3.20s
-    with 0.34s (10x improvement)
-
-  1.8.6
-    without 3.6s
-    with 1.25s
-    
-    
-rails app, running a unit test file
-
- 1.8.6
-   without:
-      23s
-   with:
-      14s
-
-rails app, running $ script/console "puts 333"
-
- 1.9.1
-   without:
-      20s
-    with:
-      10s
- 
- 1.8.6 
-   without:
-       9s
-   with:
-       6s
-       
-running "rake -T"
-
- 1.9.1
-   without: 3.75s
-   with: 1.5s       
-
- 1.8.6
-   without: 1.37s
-   with:    1.25s
-   
-Note: in reality what we should do is fix core so that it doesn't have such awful I/O time in windows.  There may be some gross inefficiency in there.  For now, this is a work-around.
-   
-== How to use in Rails ==
-
-You can either install the gem, then add a
-
-require 'rubygems'
-require 'faster_require'
-
-in your config/environment.rb, or (the best way is as follows):
-
-Unpack it somewhere, like lib
-$ cd my_rails_app/lib
-$ gem unpack faster_require
-
-Now add this line to your config/environment.rb:
-
-require File.dirname(__FILE__) + "/../lib/faster_require-0.7.0/lib/faster_require" # faster speeds all around...make sure to update it to whatever version number you fetched.
-
-add it *before* this other (existing) line:
-
-require File.join(File.dirname(__FILE__), 'boot')
-
-Now it will speedup loading rubygems and everything. Happiness.  (NB that setting it this will also run in production mode code, so be careful here, though it does work for me in production).
-
-== clearing cache ==
-
-If you use bundler to change bundled gems, you'll want to run the command $ faster_require --clear-cache
-so that it will pick up the new load paths.  Also if you moves files around to new paths, you may want to do the same.
-As you install any new gems, it should clear the paths automatically for you.
-
-== How to use generally ==
-
-You can install it to be used "always" (well, for anything that loads rubygems, at least, via something like the following):
-
-$ gem which rubygems
-d:/Ruby192/lib/ruby/site_ruby/1.9.1/rubygems.rb
-
-$ gem which faster_require
-d:/Ruby192/lib/ruby/gems/1.9.1/gems/faster_require-0.6.0/lib/faster_require.rb
-
-Now edit that rubygems.rb file, and add a require line to the top of it like this:
-
-require 'd:/Ruby192/lib/ruby/gems/1.9.1/gems/faster_require-0.6.0/lib/faster_require.rb' 
-
-update the path for your own, obviously. You'll also have to change that added line if
-you ever install a newer version of faster_require gem, or if you update your version of rubygems, 
-as the rubygems.rb file will be wiped clean at that point.
-
+A little utility to make
+
+require 'xxx'
+
+take much less time.  As in much less.  Well, on windows at least. And to speedup how long it takes things to load in windows, like rails apps.
+
+Well, mostly on windows--on linux it's a speedup of only 0.41 to 0.45s, or so. [1]
+
+If you've ever wondered why ruby feels slow on doze...sometimes it's just the startup time.  This really helps.
+
+Benchmarks:
+
+loading a (blank) rspec file:
+
+  1.9.1   
+    without 3.20s
+    with 0.34s (10x improvement)
+
+  1.8.6
+    without 3.6s
+    with 1.25s
+    
+    
+rails app, running a unit test
+
+ 1.8.6
+   without:
+      23s
+   with:
+      14s
+
+rails app, running $ script/console "puts 333"
+
+ 1.9.1
+   without:
+      20s
+    with:
+      10s
+ 
+ 1.8.6 
+   without:
+       9s
+   with:
+       6s
+       
+running "rake -T" somewhere
+
+ 1.9.1
+   without: 3.75s
+   with: 1.5s       
+
+ 1.8.6
+   without: 1.37s
+   with:    1.25s
+   
+Note: in reality what we should do is fix core so that it doesn't have such awful load time in windows.  There may be some inefficiency in there.  For now, this is a work-around that helps.
+
+Also it helps with SSD's even, on windows, as it avoids some cpu used at require time.
+
+== How to use ==
+
+In general, you can either use it by installing the gem, then adding
+require 'rubygems'
+require 'faster_require'
+to the top of your script.
+
+However this doesn't speedup the loading of rubygems, so you can do this to get best performance:
+
+G:>gem which faster_require
+C:/installs/Ruby187/lib/ruby/gems/1.8/gems/faster_require-0.7.4/lib/faster_require.rb
+
+now before doing require rubygems in your script, do this:
+
+require 'C:/installs/Ruby187/lib/ruby/gems/1.8/gems/faster_require-0.7.4/lib/faster_require.rb'
+
+Then rubygems load will be cached too. Faster.
+
+== How to use in Rails ==
+
+One way is to install the gem, then add a
+
+require 'rubygems'
+require 'faster_require'
+
+in your config/environment.rb, or (the better way is as follows):
+
+Unpack it somewhere, like lib
+
+$ cd my_rails_app/lib
+$ gem unpack faster_require
+
+Now add this line to your config/environment.rb:
+
+require File.dirname(__FILE__) + "/../lib/faster_require-0.7.0/lib/faster_require" # faster speeds all around...make sure to update it to whatever version number you fetched though.
+
+add that *before* this other (pre-existing) line:
+
+require File.join(File.dirname(__FILE__), 'boot')
+
+Now faster_require will speedup loading rubygems and everything railsy. Happiness.  (NB that setting it this will also run in production mode code, so be careful here, though it does work for me fine for production).
+
+Ping me if it's still too slow.
+
+== Clearing the cache ==
+
+If you use bundler to change bundled gems, you'll want to run the command $ faster_require --clear-cache
+so that it will pick up any new load paths.  Also if you moves files around to new directories, you may want to do the same.
+As you install any new gems, it should clear the paths automatically for you.
+
+
+== How to use generally/globally ==
+
+You can install it to be used "always" (well, for anything that loads rubygems, at least, which is most things, via something like the following):
+
+$ gem which rubygems
+d:/Ruby192/lib/ruby/site_ruby/1.9.1/rubygems.rb
+
+$ gem which faster_require
+d:/Ruby192/lib/ruby/gems/1.9.1/gems/faster_require-0.6.0/lib/faster_require.rb
+
+Now edit that rubygems.rb file, and add a require line to the top of it like this:
+
+require 'd:/Ruby192/lib/ruby/gems/1.9.1/gems/faster_require-0.6.0/lib/faster_require.rb' 
+
+update the path for your own, obviously. You'll also have to change that added line if
+you ever install a newer version of faster_require gem, or if you update your version of rubygems, 
+as the rubygems.rb file will be wiped clean at that point.
+
+== See also ==
+
+Spork can help speedup rails tests.  I "should" work well when used in conjunction with faster_require, as well.
+
+
 Enjoy.

data/Rakefile

@@ -1,5 +1,7 @@
-  require 'rubygems' if RUBY_VERSION < "1.9'"
-  
+require 'rubygems' if RUBY_VERSION < "1.9'"
+
+ENV['PATH'] = 'C:\Program Files\Git\bin;' + ENV['PATH']
+
 begin
   require 'psych' # sigh
 rescue ::LoadError

data/TODO

@@ -1,6 +1,7 @@
-advertise if quiet for a week after 3/10/11
+advertise more everywhere if quiet for a week after 3/10/11
 stringio
 if ruby < 1.9 for autoload stuff
 benchmarks jruby et al
 running rails seems to still have some redundancies in there [?]
-"does it slow us down"
+"does it slow us down"
+issues

data/VERSION

@@ -1 +1 @@
-0.7.4
+0.8.0

data/lib/faster_require.rb

@@ -1,47 +1,87 @@
 
+# check for double load...because we're afraid to load twice, since we override require et al
+
 if(defined?($already_using_faster_require))
-  p 'warning: faster_require double load expected?' if $FAST_REQUIRE_DEBUG
+  p 'warning: faster_require double load--expected?' if $FAST_REQUIRE_DEBUG
   local_version = File.read(File.dirname(__FILE__) + "/../VERSION")
-  raise 'mismatched faster_require version' unless local_version == FastRequire::VERSION
+  raise "mismatched faster_require versions! #{local_version} != #{FastRequire::VERSION}" unless local_version == FastRequire::VERSION
 else
 $already_using_faster_require = true
 
-# now load it...
 
-require 'rbconfig' # maybe could cache this one, too?
+
+require 'rbconfig' # maybe could cache this one's, too? probably not...
 
 module FastRequire
-  $FAST_REQUIRE_DEBUG ||= $DEBUG # can set via $DEBUG, or on its own.
+  
+  $FAST_REQUIRE_DEBUG ||= $DEBUG # can set this via $DEBUG, or on its own previously
+  
   VERSION = File.read(File.dirname(__FILE__) + "/../VERSION")
+
+  def self.sanitize filename
+    filename.gsub(/[\/:]/, '_')
+  end
+  
+  if RUBY_VERSION >= '1.9.0'
+    # appears 1.9.x has inconsistent string hashes...so roll our own...
+    def self.string_array_cruddy_hash strings
+      # we only call this method once, so overflowing to a bignum is ok
+      hash = 1;
+      for string in strings
+        hash = hash * 31
+        string.each_byte{|b|
+          hash += b
+        }
+      end
+      hash # probably a Bignum (sigh)
+    end
+    
+  else
+    
+    def self.string_array_cruddy_hash strings
+      strings.hash
+    end
+    
+  end
+
   def self.setup
     begin
      @@dir = File.expand_path('~/.ruby_faster_require_cache')
-    rescue ArgumentError => e # like  couldn't find HOME environment or the like
+    rescue ArgumentError => e # couldn't find HOME environment or the like
      whoami = `whoami`.strip
-     if File.directory?(home = "/home/#{whoami}") # assume writable :P
+     if File.directory?(home = "/home/#{whoami}")
       @@dir = home + '/.ruby_faster_require_cache'
      else
-       raise e
+       raise e.to_s + " and couldnt infer it from whoami"
      end
     end
 
-    Dir.mkdir @@dir unless File.directory?(@@dir)
+    unless File.directory?(@@dir)
+      Dir.mkdir @@dir 
+      raise 'unable to create user dir for faster_require ' + @@dir unless File.directory?(@@dir)
+    end
     
-    parts = [File.basename($0), RUBY_VERSION, RUBY_PLATFORM, File.basename(Dir.pwd), Dir.pwd, File.dirname($0), File.expand_path(File.dirname($0))].map{|part| sanitize(part)}
-    loc_name = (parts.map{|part| part[0..5]} + parts).join('-')[0..75] # try to be unique, but short...
-    @@loc = @@dir + '/' + loc_name
-  end
+    config = RbConfig::CONFIG
+    
+    # try to be a unique, but not too long, filename, for restrictions on filename length in doze
+    ruby_bin_name = config['bindir'] + config['ruby_install_name'] # needed if you have two rubies, same box, same ruby description [version, patch number]
+    parts = [File.basename($0), RUBY_DESCRIPTION, RUBY_VERSION, File.basename(Dir.pwd), Dir.pwd, File.dirname($0), File.expand_path(File.dirname($0)), ruby_bin_name]
+    sanitized_parts = parts.map{|part| sanitize(part)}
 
-  def self.sanitize filename
-    filename.gsub(/[\/:]/, '_')
+    full_parts_hash = string_array_cruddy_hash(parts).to_s
+    
+    loc_name = (sanitized_parts.map{|part| part[0..5] + (part[-5..-1] || '')}).join('-') + '-' + full_parts_hash + '.marsh'
+    
+    @@loc = @@dir + '/' + loc_name
+    @@loc
   end
 
-  FastRequire.setup
-
   def self.load filename
-    @@require_locs = Marshal.restore( File.open(filename, 'rb') {|f| f.read}) rescue {} 
+    @@require_locs = Marshal.restore( File.open(filename, 'rb') {|f| f.read} )
   end
-
+  
+  FastRequire.setup
+  
   if File.exist?(@@loc)
     FastRequire.load @@loc
   else
@@ -105,16 +145,10 @@ module FastRequire
   @@already_loaded[File.expand_path(__FILE__)] = true # this file itself isn't in loaded features, yet, but very soon will be..
   # a special case--I hope...
 
-  # also disallow re- $0
-  @@require_locs[$0] = File.expand_path($0) # so when we run into it on a require, we will skip it...
+  # also disallow re-loading $0
+  @@require_locs[$0] = File.expand_path($0) # so when we run into $0 on a freak require, we will skip it...
   @@already_loaded[File.expand_path($0)] = true
-
-  # XXXX within a very long depth to require fast_require,
-  # require 'a' => 'b' => 'c' => 'd' & fast_require
-  #             then
-  #             => 'b.rb'
-  # it works always
-
+  
   def self.already_loaded
     @@already_loaded
   end
@@ -126,6 +160,10 @@ module FastRequire
   def self.dir
     @@dir
   end
+  
+  def self.loc
+    @@loc
+  end
 
   at_exit {
     FastRequire.default_save
@@ -141,9 +179,14 @@ module FastRequire
 
   def self.clear_all!
     require 'fileutils'
-    FileUtils.rm_rf @@dir if File.exist? @@dir
+    success = false
+    if File.exist? @@dir
+      FileUtils.rm_rf @@dir 
+      success = true
+    end
     @@require_locs.clear
     setup
+    success
   end
   
   private
@@ -195,7 +238,7 @@ module FastRequire
             #    $LOADED_FEATURES << relative_full_path.gsub('.rb', '') # don't think you need this one
                   
                 # load(known_loc, false) # too slow
-                contents = File.open(known_loc, 'rb') {|f| f.read}
+                contents = File.open(known_loc, 'rb') {|f| f.read} # only costs 0.34/10 s...
                 if contents =~ /require_relative/ # =~ is faster than .include? it appears
                   load(known_loc, false) # slow, but dependent on a ruby core bug: http://redmine.ruby-lang.org/issues/4487
                 else
@@ -293,11 +336,6 @@ module Kernel
     
     end
     
-  #  unused?
-  #    def remove_method method
-  #     p 'in mine2'
-  #    end
-  
     # similarly overwrite this one...I guess...1.9.x...rubygems uses this as its default...I think...
     alias :original_non_cached_require :gem_original_require
     alias :gem_original_require :require_cached
@@ -307,5 +345,4 @@ module Kernel
   end
 end
 
-
 end

data/lib/rubygems_plugin.rb

@@ -1,5 +1,8 @@
 Gem.post_install { |gem_installer_instance|
   require 'faster_require'
-  FastRequire.clear_all!
-  puts 'cleared faster_require caches due to new gem install...'
+  if FastRequire.clear_all!
+    puts 'cleared faster_require caches due to new gem install...'
+  else
+    puts '(faster_require had no cache to clear/reset)'
+  end
 }

data/spec/files/fast.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + "/../../lib/faster_require.rb"
+require File.expand_path(File.dirname(__FILE__) + "/../../lib/faster_require.rb")
 require 'rubygems'
 require 'rspec'
 a = RSpec

data/spec/files/fast2.rb

@@ -1,6 +1,5 @@
-# different rubygems orders
+require File.expand_path(File.dirname(__FILE__) + "/../../lib/faster_require.rb")
 require 'rubygems'
-require File.dirname(__FILE__) + "/../../lib/faster_require.rb"
 require 'rspec'
 a = RSpec
 p 'success'

data/spec/spec.fast_require.rb

@@ -132,7 +132,7 @@ describe "requires faster!" do
   end  
   
  ['require_facets.rb', 'gem_after.rb', 'load_various_gems.rb', 'load_various_gems2.rb', 'active_support_no_double_load.rb', 'fast.rb'].each{|filename| 
-    it "should not double load gems #{filename}" do
+    it "should not double load gems #{@ruby} -v files/#{filename}" do
       3.times {
         a = `#{@ruby} -v files/#{filename} 2>&1`
         a.should_not match('already initialized')
@@ -146,7 +146,7 @@ describe "requires faster!" do
   it "should be ok if you require itself twice" do
     Dir.chdir('files') do
       3.times { assert system(@ruby + 'attempt_double_load.rb') }
-      assert `#{@ruby + 'attempt_double_load.rb'}` =~ /double load expected/
+      assert `#{@ruby + 'attempt_double_load.rb'}` =~ /double load--expected\?/
     end
   end
   
@@ -185,9 +185,10 @@ describe "requires faster!" do
     end
   end
   
-  it "should be able to infer .so files like socket.so" #do
-#    ruby "files/socket_load.rb" # LODO reproduce failure
+  # was there some failure like
+  # stringio or enumerator.so?
+  it "should be able to infer .so files" #do
+#    ruby "files/socket_load.rb" # LODO reproduce failure?
 #  end
 
-
 end

data/todo

@@ -1,6 +1,7 @@
-advertise if quiet for a week after 3/10/11
+advertise more everywhere if quiet for a week after 3/10/11
 stringio
 if ruby < 1.9 for autoload stuff
 benchmarks jruby et al
 running rails seems to still have some redundancies in there [?]
-"does it slow us down"
+"does it slow us down"
+issues

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: faster_require
 version: !ruby/object:Gem::Version 
-  hash: 11
-  prerelease: false
+  hash: 63
+  prerelease: 
   segments: 
   - 0
-  - 7
-  - 4
-  version: 0.7.4
+  - 8
+  - 0
+  version: 0.8.0
 platform: ruby
 authors: 
 - Roger Pack
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-10 00:00:00 -07:00
+date: 2011-04-15 00:00:00 -06:00
 default_executable: faster_require
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -183,18 +183,13 @@ files:
 - spec/spec.fast_require.rb
 - todo
 - TODO
-- spec/eval_me1.rb
-- spec/eval_me2.rb
-- spec/files/a.rb
-- spec/temp/slow.rb
-- spec/temp/yo.rb
 has_rdoc: true
 homepage: http://github.com/rdp/faster_require
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -218,18 +213,15 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.5.2
 signing_key: 
 specification_version: 3
 summary: Speed library loading in Ruby
 test_files: 
-- spec/eval_me1.rb
-- spec/eval_me2.rb
-- spec/files/a.rb
+- spec/files/a_requires_b.rb
 - spec/files/active_support_no_double_load.rb
 - spec/files/attempt_double_load.rb
 - spec/files/attempt_double_load_wrong_version.rb
-- spec/files/a_requires_b.rb
 - spec/files/b.rb
 - spec/files/c.rb
 - spec/files/d.rb
@@ -242,15 +234,13 @@ test_files:
 - spec/files/load_various_gems.rb
 - spec/files/load_various_gems2.rb
 - spec/files/non_dot_rb.rb
-- spec/files/requires_itself.rb
 - spec/files/require_facets.rb
 - spec/files/require_full_path.rb
 - spec/files/require_non_dot_rb_fails.rb
 - spec/files/require_twice_in_dir_pwd.rb
+- spec/files/requires_itself.rb
 - spec/files/should_put_modules_in_right_place.rb
 - spec/files/slow.rb
 - spec/files/socket_load.rb
 - spec/files/time_just_loading_rubygems.rb
 - spec/spec.fast_require.rb
-- spec/temp/slow.rb
-- spec/temp/yo.rb

data/spec/eval_me1.rb

@@ -1 +0,0 @@
-eval(File.read('eval_me2.rb'), binding, File.expand_path('./eval_me2.rb'))

data/spec/eval_me2.rb

@@ -1 +0,0 @@
-require_relative 'eval_me1.rb'

data/spec/temp/slow.rb

@@ -1,9 +0,0 @@
-slow = true
-file_name = File.expand_path('./yo.rb')
-File.open(file_name, 'w') do |f| f.write '33333'; end
-
-if !slow
-  1000.times { eval File.read(file_name) } # ascii mode
-else
-  1000.times { load file_name } # ascii mode
-end

data/spec/temp/yo.rb

@@ -1,10 +0,0 @@
-33333
-33333
-33333
-33333
-33333
-33333
-33333
-33333
-33333
-33333