faster_gem_script 0.1.2 → 0.1.4

data/README

@@ -1,41 +1,49 @@
-Example:
-
-# install it
-C:\> gem install faster_gem_script
-
-# install something to optimize
-
-C:\> gem install whichr
-
-C:\>whichr whichr
-higher in the list is executed first
-C:\installs\ruby19_mingw\bin\whichr.bat
-
-C:\>faster_gem_script C:\installs\ruby19_mingw\bin\whichr
-
-# now run it twice
-
-
-
-C:\> timer whichr whichr
-higher in the list is executed first
-C:\installs\ruby19_mingw\bin\whichr.bat
-
-2.484375
-
-C:\dev\ruby\faster_gem_script>timer whichr whichr
-higher in the list is executed first
-C:\installs\ruby19_mingw\bin\whichr.bat
-
-0.40625
-
-Yea much faster now.
-
-You can revert back to the original performance, too.
-
-C:\> gem install whichr
-C:\> timer whichr whichr
-higher in the list is executed first
-C:\installs\ruby19_mingw\bin\whichr.bat
-
-2.5625
+<<<<<<< HEAD
+This is a utility to speedup gem scripts quite a bit (especially for windows users), by avoiding expensive rubygems calls.
+
+Background:
+
+By default rubygems runs a
+
+require rubygems
+...
+load Gem.bin_path(...)
+
+in every gem's auto-generated startup script (ex: the ruby-prof gem has a ruby-prof command--it runs the above before running that command).
+
+This is great if you have a complex gem that requires specific version of its dependencies, etc.
+
+However, these calls result in an extra slowdown--especially in windows it can take up to an extra 2s, EVERY TIME, at startup.
+
+This can be alleviated, however, with this gem.
+
+In my box 2s went down to 0.37s (1.9.1 mingw).  In linux it can speedup a tidge, too (from 0.3 to 0.16s). 
+
+How it does it:
+
+This gem provides a utility to replace the auto-generated startup script with one that caches the bin_path location so that the second/third/fourth times it starts up almost instantly.
+
+This works in 1.9 because of gem_prelude (which makes loading rubygems at times unnecessary), and of the "faster_rubygems" gem for 1.8.x, which is essentially gem_prelude for 1.8.
+
+How to use it:
+
+# install a gem that has a command line executable, like ruby-prof
+
+# install a gem pre-req--necessary because of a bug in rubygems
+C:> gem install os 
+# install the optimizer
+C:> gem install faster_gem_scripts
+# this next line will change based on your ruby location
+C:> faster_gem_script c:\ruby18\bin\whichr
+
+If you want an easier way to discover the path for your commands (and are on windows), you can checkout the whichr gem (http://github.com/rdp/whichr).
+
+Caveat:  If you update a gem after using this, you'll need to run it again so that it will be sure to cache the location of the latest version of the gem.
+
+Other caveat: if your gem has any "complex dependencies" (like it uses the gem command like 
+
+gem 'some_other_dependency', '= 1.1.9'
+
+then this system won't work for you.  Try it out to see.
+
+You can find out by running it once.  If it fails then reinstall the gem to get back to its original functionality.

data/Rakefile

@@ -0,0 +1,13 @@
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "faster_gem_script"
+    gemspec.summary = "A utility to make ruby \"command line scripts\" run much faster by using gem prelude instead of full rubygems"
+    gemspec.email = "rogerdpack@gmail.com"
+    gemspec.homepage = "http://github.com/rdp/faster_gem_scripts"
+    gemspec.authors = ["Roger Pack"]
+    gemspec.add_dependency('sane', '>= 0.17.0')
+    gemspec.add_dependency('fast_require')
+    gemspec.add_development_dependency('rspec')
+    # don't need faster_rubygems here, as we auto install it
+    gemspec.extensions = 'ext/mkrf_conf.rb'
+  end

data/VERSION

@@ -0,0 +1 @@
+0.1.4

data/bin/faster_gem_script

@@ -1,8 +1,8 @@
-require 'sane'
-require_relative '../lib/faster_gem_scripts'
-if ARGV.length == 0 || ARGV[0] == '-h' || ARGV[0] == '--help'
-  puts "syntax: gem binary, like bin/abc (no .rb)"
-  exit
-end
-
-FasterGemScripts.overwrite ARGV[0]
+#!/usr/bin/env ruby
+require 'faster_gem_scripts'
+if ARGV.length == 0
+  puts 'syntax: script_name_to_optimize'
+else
+  FasterGemScripts.overwrite ARGV[0]
+end
+

data/ext/mkrf_conf.rb

@@ -0,0 +1,19 @@
+require 'rubygems'
+  require 'rubygems/command.rb'
+  require 'rubygems/dependency_installer.rb' 
+  begin
+    Gem::Command.build_args = ARGV
+    rescue NoMethodError
+  end 
+  inst = Gem::DependencyInstaller.new
+  begin
+    if RUBY_VERSION < "1.9" # need the helper
+      inst.install "faster_rubygems"
+    end
+    rescue
+      exit(1)
+  end 
+
+  f = File.open(File.join(File.dirname(__FILE__), "Rakefile"), "w")   # create dummy rakefile to indicate success
+  f.write("task :default\n")
+  f.close

data/lib/faster_gem_scripts.rb

@@ -3,9 +3,24 @@ require 'sane'
 class FasterGemScripts
   def self.overwrite full_path
    contents_should_be = File.read __dir__ + '/template'
-   File.write(full_path, contents_should_be)
-   bin_loc = full_path + '_bin_location'
-   File.delete(bin_loc) if File.exist?(bin_loc)
+   if File.file?(full_path)
+     puts 'faster_gem_scripts: optimizing ' + full_path + '...'
+     File.write(full_path, contents_should_be)
+     bin_loc = full_path + '_bin_location'
+     File.delete(bin_loc) if File.exist?(bin_loc)
+   else
+    puts "unable to find the binary:" + full_path + " you may want to find it and overwrite it yourself using C:\>faster_gem_script file_name (no .bat)"
+   end
+  end
+  
+  def self.clear_caches!
+    # I only know about one type...
+   bin_dir = OS.ruby_bin.split('/')[0..-2].join('/') # strip off ruby.exe
+   Dir[bin_dir = '/*_bin_location'].each{|file|
+     puts 'deleting'
+     File.delete file   
+   }
+    
   end
 
 end

data/lib/rubygems_plugin.rb

@@ -0,0 +1,18 @@
+Gem.post_install { |gem_installer_instance|
+  require 'os'
+  require 'faster_gem_scripts'
+  all = gem_installer_instance.spec.files.select{|file| file.start_with? "bin" }
+  bin_dir =  OS.ruby_bin.split('/')[0..-3].join('/')
+  if all.length > 0
+   FasterGemScripts.clear_caches!
+   all.each{|script_name|
+     name = bin_dir + '/' + script_name     
+     FasterGemScripts.overwrite name
+   }
+  end
+}
+
+Gem.post_uninstall {
+  require 'faster_gem_scripts'
+  FasterGemScripts.clear_caches! if (gem_installer_instance.spec.files.select{|file| file.start_with? "bin" }.length > 0)
+}

data/lib/template

@@ -1,7 +1,7 @@
 gem_name = File.basename(__FILE__)
 
 if ARGV.first =~ /^_(.*)_$/
-  # special version of the gem--we'll need full rubygems for this
+  # special version of the gem--we'll need full rubygems for this...
   require 'rubygems'
   if Gem::Version.correct? $1 then
     version = $1
@@ -14,14 +14,16 @@ end
 
 cached = File.dirname(__FILE__) + "/#{gem_name}_bin_location"
 
- # if we haven't cached its location yet...
+# if we haven't cached its location yet...
 unless File.exist? cached
  File.open(cached, 'w') do |f|
+   # then setup the cache
+   puts 'faster_gem_script cacheing bin location (1st time only) ' + __FILE__
    require 'rubygems'
    f.write Gem.bin_path(gem_name, gem_name, ">= 0")
  end
 end
 
 require 'faster_rubygems' if RUBY_VERSION < '1.9' # gem prelude equivalent
-
-load File.read(cached)
+require 'fast_require' # happiness
+load File.read(cached)

data/spec/{spec.rb → spec.faster_gem_scripts.rb}

@@ -1,11 +1,14 @@
+require 'faster_rubygems' if RUBY_VERSION < '1.9'
 require 'sane'
-require_rel '../lib/faster_gem_scripts'
+require_relative '../lib/faster_gem_scripts'
 require 'spec/autorun'
+require 'fileutils'
 
-describe "rewriter" do
+describe "faster rubygems" do
 
   def setup
     File.delete 'abc' if File.exist?('abc')
+    FileUtils.touch 'abc'
     FasterGemScripts.overwrite 'abc'
   end
 
@@ -15,11 +18,15 @@ describe "rewriter" do
     assert new_contents.contain?("faster_rubygems")
   end
 
-  it "should nuke the cache on write" do
+  it "should nuke the old cache on re-write" do
     require 'fileutils'
     FileUtils.touch 'abc_bin_location'
     setup
     assert !File.exist?('abc_bin_location')
   end
+  
+  it "should overwrite on gem install"
+  
+  
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: faster_gem_script
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors: 
 - Roger Pack
@@ -9,13 +9,23 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-27 00:00:00 -07:00
+date: 2010-01-29 00:00:00 -07:00
 default_executable: faster_gem_script
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: sane
   type: :runtime
   version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.17.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: fast_require
+  type: :runtime
+  version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
@@ -36,14 +46,20 @@ description:
 email: rogerdpack@gmail.com
 executables: 
 - faster_gem_script
-extensions: []
-
+extensions: 
+- ext/mkrf_conf.rb
 extra_rdoc_files: 
 - README
 files: 
+- README
+- Rakefile
+- VERSION
+- bin/faster_gem_script
+- ext/mkrf_conf.rb
 - lib/faster_gem_scripts.rb
+- lib/rubygems_plugin.rb
 - lib/template
-- README
+- spec/spec.faster_gem_scripts.rb
 has_rdoc: true
 homepage: http://github.com/rdp/faster_gem_scripts
 licenses: []
@@ -73,4 +89,4 @@ signing_key:
 specification_version: 3
 summary: A utility to make ruby "command line scripts" run much faster by using gem prelude instead of full rubygems
 test_files: 
-- spec/spec.rb
+- spec/spec.faster_gem_scripts.rb