rubygems-update 0.9.4 → 0.9.5

data/lib/rubygems/gem_path_searcher.rb

@@ -0,0 +1,84 @@
+#--
+# Copyright 2006 by Chad Fowler, Rich Kilmer, Jim Weirich and others.
+# All rights reserved.
+# See LICENSE.txt for permissions.
+#++
+
+require 'rubygems'
+
+#
+# GemPathSearcher has the capability to find loadable files inside
+# gems.  It generates data up front to speed up searches later.
+#
+class Gem::GemPathSearcher
+
+  #
+  # Initialise the data we need to make searches later.
+  #
+  def initialize
+    # We want a record of all the installed gemspecs, in the order
+    # we wish to examine them.
+    @gemspecs = init_gemspecs
+    # Map gem spec to glob of full require_path directories.
+    # Preparing this information may speed up searches later.
+    @lib_dirs = {}
+    @gemspecs.each do |spec|
+      @lib_dirs[spec.object_id] = lib_dirs_for(spec)
+    end
+  end
+
+  # 
+  # Look in all the installed gems until a matching _path_ is found.
+  # Return the _gemspec_ of the gem where it was found.  If no match
+  # is found, return nil.
+  #
+  # The gems are searched in alphabetical order, and in reverse
+  # version order.
+  #
+  # For example:
+  #
+  #   find('log4r')              # -> (log4r-1.1 spec)
+  #   find('log4r.rb')           # -> (log4r-1.1 spec)
+  #   find('rake/rdoctask')      # -> (rake-0.4.12 spec)
+  #   find('foobarbaz')          # -> nil
+  #
+  # Matching paths can have various suffixes ('.rb', '.so', and
+  # others), which may or may not already be attached to _file_.
+  # This method doesn't care about the full filename that matches;
+  # only that there is a match.
+  # 
+  def find(path)
+    @gemspecs.each do |spec|
+      return spec if matching_file(spec, path)
+    end
+    nil
+  end
+
+  private
+
+  # Attempts to find a matching path using the require_paths of the
+  # given _spec_.
+  #
+  # Some of the intermediate results are cached in @lib_dirs for
+  # speed.
+  def matching_file(spec, path)  # :doc:
+    glob = File.join @lib_dirs[spec.object_id], "#{path}#{Gem.suffix_pattern}"
+    return true unless Dir[glob].select { |f| File.file?(f.untaint) }.empty?
+  end
+
+  # Return a list of all installed gemspecs, sorted by alphabetical
+  # order and in reverse version order.
+  def init_gemspecs
+    Gem.source_index.map { |_, spec| spec }.sort { |a,b|
+      (a.name <=> b.name).nonzero? || (b.version <=> a.version)
+    }
+  end
+
+  # Returns library directories glob for a gemspec.  For example,
+  #   '/usr/local/lib/ruby/gems/1.8/gems/foobar-1.0/{lib,ext}'
+  def lib_dirs_for(spec)
+    "#{spec.full_gem_path}/{#{spec.require_paths.join(',')}}"
+  end
+
+end
+

data/lib/rubygems/gem_runner.rb

@@ -1,11 +1,12 @@
-#!/usr/bin/env ruby
 #--
 # Copyright 2006 by Chad Fowler, Rich Kilmer, Jim Weirich and others.
 # All rights reserved.
 # See LICENSE.txt for permissions.
 #++
 
-require 'rubygems/gem_commands'
+require 'rubygems/command_manager'
+require 'rubygems/config_file'
+require 'rubygems/doc_manager'
 
 module Gem
 
@@ -22,12 +23,26 @@ module Gem
 
     # Run the gem command with the following arguments.
     def run(args)
+      start_time = Time.now
       do_configuration(args)
       cmd = @command_manager_class.instance
-      cmd.command_names.each do |c|
-        Command.add_specific_extra_args c, Array(Gem.configuration[c])
+      cmd.command_names.each do |command_name|
+        config_args = Gem.configuration[command_name]
+        config_args = case config_args
+                      when String
+                        config_args.split ' '
+                      else
+                        Array(config_args)
+                      end
+        Command.add_specific_extra_args command_name, config_args
       end
       cmd.run(Gem.configuration.args)
+      end_time = Time.now
+      if Gem.configuration.benchmark 
+        printf "\nExecution time: %0.2f seconds.\n", end_time-start_time
+        puts "Press Enter to finish"
+        STDIN.gets
+      end
     end
 
     private
@@ -35,7 +50,7 @@ module Gem
     def do_configuration(args)
       Gem.configuration = @config_file_class.new(args)
       Gem.use_paths(Gem.configuration[:gemhome], Gem.configuration[:gempath])
-      Command.extra_args = Gem.configuration[:gem]
+      Gem::Command.extra_args = Gem.configuration[:gem]
       @doc_manager_class.configured_args = Gem.configuration[:rdoc]
     end
 

data/lib/rubygems/indexer.rb

@@ -0,0 +1,163 @@
+require 'fileutils'
+require 'tmpdir'
+
+require 'rubygems'
+require 'rubygems/format'
+
+begin
+  require 'builder/xchar'
+rescue LoadError
+end
+
+##
+# Top level class for building the gem repository index.
+class Gem::Indexer
+
+  include Gem::UserInteraction
+
+  ##
+  # Index install location
+
+  attr_reader :dest_directory
+
+  ##
+  # Index build directory
+
+  attr_reader :directory
+
+  # Create an indexer that will index the gems in +directory+.
+  def initialize(directory)
+    unless ''.respond_to? :to_xs then
+      fail "Gem::Indexer requires that the XML Builder library be installed:" \
+           "\n\tgem install builder"
+    end
+
+    @dest_directory = directory
+    @directory = File.join Dir.tmpdir, "gem_generate_index_#{$$}"
+
+    marshal_name = "Marshal.#{Gem.marshal_version}"
+
+    @master_index = Gem::Indexer::MasterIndexBuilder.new "yaml", @directory
+    @marshal_index = Gem::Indexer::MarshalIndexBuilder.new marshal_name, @directory
+    @quick_index = Gem::Indexer::QuickIndexBuilder.new "index", @directory
+  end
+
+  # Build the index.
+  def build_index
+    @master_index.build do
+      @quick_index.build do
+        @marshal_index.build do
+          progress = ui.progress_reporter gem_file_list.size,
+                                          "Generating index for #{gem_file_list.size} gems in #{@dest_directory}",
+                                          "Loaded all gems"
+
+          gem_file_list.each do |gemfile|
+            if File.size(gemfile.to_s) == 0 then
+              alert_warning "Skipping zero-length gem: #{gemfile}"
+              next
+            end
+
+            begin
+              spec = Gem::Format.from_file_by_path(gemfile).spec
+
+              unless gemfile =~ /\/#{Regexp.escape spec.original_name}.*\.gem\z/i then
+                alert_warning "Skipping misnamed gem: #{gemfile} => #{spec.full_name} (#{spec.original_name})"
+                next
+              end
+
+              abbreviate spec
+              sanitize spec
+
+              @master_index.add spec
+              @quick_index.add spec
+              @marshal_index.add spec
+
+              progress.updated spec.original_name
+
+            rescue SignalException => e
+              alert_error "Recieved signal, exiting"
+              raise
+            rescue Exception => e
+              alert_error "Unable to process #{gemfile}\n#{e.message} (#{e.class})\n\t#{e.backtrace.join "\n\t"}"
+            end
+          end
+
+          progress.done
+
+          say "Generating master indexes (this may take a while)"
+        end
+      end
+    end
+  end
+
+  def install_index
+    verbose = Gem.configuration.really_verbose
+
+    say "Moving index into production dir #{@dest_directory}" if verbose
+
+    files = @master_index.files + @quick_index.files + @marshal_index.files
+
+    files.each do |file|
+      relative_name = file[/\A#{@directory}.(.*)/, 1]
+      dest_name = File.join @dest_directory, relative_name
+
+      FileUtils.rm_rf dest_name, :verbose => verbose
+      FileUtils.mv file, @dest_directory, :verbose => verbose
+    end
+  end
+
+  def generate_index
+    FileUtils.rm_rf @directory
+    FileUtils.mkdir_p @directory, :mode => 0700
+
+    build_index
+    install_index
+  rescue SignalException
+  ensure
+    FileUtils.rm_rf @directory
+  end
+
+  # List of gem file names to index.
+  def gem_file_list
+    Dir.glob(File.join(@dest_directory, "gems", "*.gem"))
+  end
+
+  # Abbreviate the spec for downloading.  Abbreviated specs are only
+  # used for searching, downloading and related activities and do not
+  # need deployment specific information (e.g. list of files).  So we
+  # abbreviate the spec, making it much smaller for quicker downloads.
+  def abbreviate(spec)
+    spec.files = []
+    spec.test_files = []
+    spec.rdoc_options = []
+    spec.extra_rdoc_files = []
+    spec.cert_chain = []
+    spec
+  end
+
+  # Sanitize the descriptive fields in the spec.  Sometimes non-ASCII
+  # characters will garble the site index.  Non-ASCII characters will
+  # be replaced by their XML entity equivalent.
+  def sanitize(spec)
+    spec.summary = sanitize_string(spec.summary)
+    spec.description = sanitize_string(spec.description)
+    spec.post_install_message = sanitize_string(spec.post_install_message)
+    spec.authors = spec.authors.collect { |a| sanitize_string(a) }
+    spec
+  end
+
+  # Sanitize a single string.
+  def sanitize_string(string)
+    # HACK the #to_s is in here because RSpec has an Array of Arrays of
+    # Strings for authors.  Need a way to disallow bad values on gempsec
+    # generation.  (Probably won't happen.)
+    string ? string.to_s.to_xs : string
+  end
+
+end
+
+require 'rubygems/indexer/abstract_index_builder'
+require 'rubygems/indexer/master_index_builder'
+require 'rubygems/indexer/quick_index_builder'
+require 'rubygems/indexer/marshal_index_builder'
+

data/lib/rubygems/indexer/abstract_index_builder.rb

@@ -0,0 +1,80 @@
+require 'zlib'
+
+require 'rubygems/indexer'
+
+# Abstract base class for building gem indicies.  Uses the template pattern
+# with subclass specialization in the +begin_index+, +end_index+ and +cleanup+
+# methods.
+class Gem::Indexer::AbstractIndexBuilder
+
+  # Directory to put index files in
+  attr_reader :directory
+
+  # File name of the generated index
+  attr_reader :filename
+
+  # List of written files/directories to move into production
+  attr_reader :files
+
+  def initialize(filename, directory)
+    @filename = filename
+    @directory = directory
+    @files = []
+  end
+
+  # Build a Gem index.  Yields to block to handle the details of the
+  # actual building.  Calls +begin_index+, +end_index+ and +cleanup+ at
+  # appropriate times to customize basic operations.
+  def build
+    FileUtils.mkdir_p @directory unless File.exist? @directory
+    raise "not a directory: #{@directory}" unless File.directory? @directory
+
+    file_path = File.join @directory, @filename
+
+    @files << file_path
+
+    File.open file_path, "wb" do |file|
+      @file = file
+      start_index
+      yield
+      end_index
+    end
+    cleanup
+  ensure
+    @file = nil
+  end
+
+  # Compress the given file.
+  def compress(filename, ext="rz")
+    zipped = zip(File.open(filename, 'rb'){ |fp| fp.read })
+    File.open "#{filename}.#{ext}", "wb" do |file|
+      file.write zipped
+    end
+  end
+
+  # Called immediately before the yield in build.  The index file is open and
+  # available as @file.
+  def start_index
+  end
+
+  # Called immediately after the yield in build.  The index file is still open
+  # and available as @file.
+  def end_index
+  end
+
+  # Called from within builder after the index file has been closed.
+  def cleanup
+  end
+
+  # Return an uncompressed version of a compressed string.
+  def unzip(string)
+    Zlib::Inflate.inflate(string)
+  end
+
+  # Return a compressed version of the given string.
+  def zip(string)
+    Zlib::Deflate.deflate(string)
+  end
+
+end
+

data/lib/rubygems/indexer/marshal_index_builder.rb

@@ -0,0 +1,17 @@
+require 'rubygems/indexer'
+
+# Construct the master Gem index file.
+class Gem::Indexer::MarshalIndexBuilder < Gem::Indexer::MasterIndexBuilder
+  def end_index
+    gems = {}
+    index = Gem::SourceIndex.new
+
+    @index.each do |name, gemspec|
+      gems[gemspec.original_name] = gemspec
+    end
+
+    index.instance_variable_get(:@gems).replace gems
+
+    @file.write index.dump
+  end
+end

data/lib/rubygems/indexer/master_index_builder.rb

@@ -0,0 +1,53 @@
+require 'rubygems/indexer'
+
+# Construct the master Gem index file.
+class Gem::Indexer::MasterIndexBuilder < Gem::Indexer::AbstractIndexBuilder
+
+  def start_index
+    super
+    @index = Gem::SourceIndex.new
+  end
+
+  def end_index
+    super
+    @file.puts "--- !ruby/object:#{@index.class}"
+    @file.puts "gems:"
+
+    gems = @index.sort_by { |name, gemspec| gemspec.sort_obj }
+    gems.each do |name, gemspec|
+      yaml = gemspec.to_yaml.gsub(/^/, '    ')
+      yaml = yaml.sub(/\A    ---/, '') # there's a needed extra ' ' here
+      @file.print "  #{gemspec.original_name}:"
+      @file.puts yaml
+    end
+  end
+
+  def cleanup
+    super
+
+    index_file_name = File.join @directory, @filename
+
+    compress index_file_name, "Z"
+    compressed_file_name = "#{index_file_name}.Z"
+
+    paranoid index_file_name, compressed_file_name
+
+    @files << compressed_file_name
+  end
+
+  def add(spec)
+    @index.add_spec(spec)
+  end
+
+  private
+
+  def paranoid(fn, compressed_fn)
+    data = File.open(fn, 'rb') do |fp| fp.read end
+    compressed_data = File.open(compressed_fn, 'rb') do |fp| fp.read end
+
+    if data != unzip(compressed_data) then
+      fail "Compressed file #{compressed_fn} does not match uncompressed file #{fn}"
+    end
+  end
+
+end