Permalink
Browse files

Some reformatting of comments.

git-svn-id: svn+ssh://rubyforge.org/var/svn/rubygems/trunk@900 3d4018f9-ac1a-0410-99e9-8a154d859a19
  • Loading branch information...
1 parent e43dfd3 commit 2a0828782fef10581f947413cc121ef599b52407 @jimweirich jimweirich committed Jul 8, 2005
Showing with 30 additions and 21 deletions.
  1. +30 −21 rubygems/lib/rubygems/custom_require.rb
@@ -4,15 +4,18 @@ module Kernel
alias require__ require
#
- # We replace Ruby's require with our own, which is capable of loading gems on demand.
+ # We replace Ruby's require with our own, which is capable of
+ # loading gems on demand.
#
# When you call <tt>require 'x'</tt>, this is what happens:
- # * If the file can be loaded from the existing Ruby loadpath, it is.
- # * Otherwise, installed gems are searched for a file that matches. If it's found in gem
- # 'y', that gem is activated (added to the loadpath).
+ # * If the file can be loaded from the existing Ruby loadpath, it
+ # is.
+ # * Otherwise, installed gems are searched for a file that matches.
+ # If it's found in gem 'y', that gem is activated (added to the
+ # loadpath).
#
- # The normal <tt>require</tt> functionality of returning false if that file has already been
- # loaded is preserved.
+ # The normal <tt>require</tt> functionality of returning false if
+ # that file has already been loaded is preserved.
#
def require(path)
require__ path
@@ -33,30 +36,33 @@ def require(path)
module Gem
#
- # GemPathSearcher has the capability to find loadable files inside gems. It generates data
- # up front to speed up searches later.
+ # GemPathSearcher has the capability to find loadable files inside
+ # gems. It generates data up front to speed up searches later.
#
class 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.
+ # 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.
+ # 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(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.
+ # 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.
+ # The gems are searched in alphabetical order, and in reverse
+ # version order.
#
# For example:
#
@@ -65,9 +71,10 @@ def initialize
# 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.
+ # 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|
@@ -81,17 +88,19 @@ def find(path)
SUFFIX_PATTERN = "{,.rb,.so,.bundle,.dll,.sl}"
#
- # Attempts to find a matching path using the require_paths of the given _spec_.
+ # 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.
+ # Some of the intermediate results are cached in @lib_dirs for
+ # speed.
#
def matching_file(spec, path) # :doc:
glob = "#{@lib_dirs[spec.object_id]}/#{path}#{SUFFIX_PATTERN}"
return true unless Dir[glob].select { |f| File.file?(f) }.empty?
end
- # Return a list of all installed gemspecs, sorted by alphabetical order and in reverse
- # version order.
+ # 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)

0 comments on commit 2a08287

Please sign in to comment.