rubygems-update 2.1.0.rc.1 → 2.1.0.rc.2

data/lib/rubygems/source/local.rb

@@ -1,8 +1,8 @@
-require 'rubygems/source'
-
 class Gem::Source::Local < Gem::Source
   def initialize
-    @uri = nil
+    @specs   = nil
+    @api_uri = nil
+    @uri     = nil
   end
 
   ##
@@ -22,7 +22,8 @@ class Gem::Source::Local < Gem::Source
   end
 
   def inspect # :nodoc:
-    "#<%s specs: %p>" % [self.class, @specs.keys]
+    keys = @specs ? @specs.keys.sort : 'NOT LOADED'
+    "#<%s specs: %p>" % [self.class, keys]
   end
 
   def load_specs(type)

data/lib/rubygems/source/specific_file.rb

@@ -25,4 +25,32 @@ class Gem::Source::SpecificFile < Gem::Source
     raise Gem::Exception, "Unable to download '#{spec.full_name}'"
   end
 
+  def pretty_print q # :nodoc:
+    q.group 2, '[Local:', ']' do
+      q.breakable
+      q.text @path
+    end
+  end
+
+  ##
+  # Orders this source against +other+.
+  #
+  # If +other+ is a SpecificFile from a different gem name +nil+ is returned.
+  #
+  # If +other+ is a SpecificFile from the same gem name the versions are
+  # compared using Gem::Version#<=>
+  #
+  # Otherwise Gem::Source#<=> is used.
+
+  def <=> other
+    case other
+    when Gem::Source::SpecificFile then
+      return nil if @spec.name != other.spec.name
+
+      @spec.version <=> other.spec.version
+    else
+      super
+    end
+  end
+
 end

data/lib/rubygems/specification.rb

@@ -206,15 +206,19 @@ class Gem::Specification < Gem::BasicSpecification
   attr_reader :version
 
   ##
-  # Paths in the gem to add to <tt>$LOAD_PATH</tt> when this gem is activated.
+  # Paths in the gem to add to <code>$LOAD_PATH</code> when this gem is
+  # activated.
+  #
+  # If you have an extension you do not need to add <code>"ext"</code> to the
+  # require path, the extension build process will copy the extension files
+  # into "lib" for you.
+  #
+  # The default value is <code>"lib"</code>
   #
   # Usage:
   #
   #   # If all library files are in the root directory...
   #   spec.require_path = '.'
-  #
-  #   # If you have 'lib' and 'ext' directories...
-  #   spec.require_paths << 'ext'
 
   attr_accessor :require_paths
 
@@ -228,7 +232,7 @@ class Gem::Specification < Gem::BasicSpecification
   ##
   # A short summary of this gem's description.  Displayed in `gem list -d`.
   #
-  # The description should be more detailed than the summary.
+  # The #description should be more detailed than the summary.
   #
   # Usage:
   #
@@ -241,21 +245,23 @@ class Gem::Specification < Gem::BasicSpecification
   #
   # This is usually Gem::Platform::RUBY or Gem::Platform::CURRENT.
   #
-  # Most gems contain pure Ruby code; they should simply leave the default value
-  # in place. Some gems contain C (or other) code to be compiled into a Ruby
-  # “extension”. The should leave the default value in place unless their code
-  # will only compile on a certain type of system. Some gems consist of
-  # pre-compiled code (“binary gems”). It’s especially important that they set
-  # the platform attribute appropriately. A shortcut is to set the platform to
-  # Gem::Platform::CURRENT, which will cause the gem builder to set the platform
-  # to the appropriate value for the system on which the build is being performed.
+  # Most gems contain pure Ruby code; they should simply leave the default
+  # value in place.  Some gems contain C (or other) code to be compiled into a
+  # Ruby "extension".  The should leave the default value in place unless
+  # their code will only compile on a certain type of system.  Some gems
+  # consist of pre-compiled code ("binary gems").  It's especially important
+  # that they set the platform attribute appropriately.  A shortcut is to set
+  # the platform to Gem::Platform::CURRENT, which will cause the gem builder
+  # to set the platform to the appropriate value for the system on which the
+  # build is being performed.
   #
-  # If this attribute is set to a non-default value, it will be included in the
-  # filename of the gem when it is built, e.g. fxruby-1.2.0-win32.gem.
+  # If this attribute is set to a non-default value, it will be included in
+  # the filename of the gem when it is built such as:
+  # nokogiri-1.6.0-x86-mingw32.gem
   #
   # Usage:
   #
-  #   spec.platform = Gem::Platform::Win32
+  #   spec.platform = Gem::Platform.local
 
   def platform= platform
     if @original_platform.nil? or
@@ -357,7 +363,7 @@ class Gem::Specification < Gem::BasicSpecification
   attr_reader :description
 
   ##
-  # A contact email for this gem
+  # A contact email address (or addresses) for this gem
   #
   # Usage:
   #
@@ -473,6 +479,8 @@ class Gem::Specification < Gem::BasicSpecification
   # Usage:
   #
   #  spec.extensions << 'ext/rmagic/extconf.rb'
+  #
+  # See Gem::Ext::Builder for information about writing extensions for gems.
 
   def extensions
     @extensions ||= []
@@ -502,6 +510,8 @@ class Gem::Specification < Gem::BasicSpecification
   # This should just be the name of your license. The full
   # text of the license should be inside of the gem when you build it.
   #
+  # You can set multiple licenses with #licenses=
+  #
   # Usage:
   #   spec.license = 'MIT'
 
@@ -538,15 +548,20 @@ class Gem::Specification < Gem::BasicSpecification
   end
 
   ##
-  # The version of Ruby required by this gem
+  # The version of Ruby required by this gem.  The ruby version can be
+  # specified to the patch-level:
+  #
+  #   $ ruby -v -e 'p Gem.ruby_version'
+  #   ruby 2.0.0p247 (2013-06-27 revision 41674) [x86_64-darwin12.4.0]
+  #   #<Gem::Version "2.0.0.247">
   #
   # Usage:
   #
-  #  # If it will work with 1.8.6 or greater...
+  #  # This gem will work with 1.8.6 or greater...
   #  spec.required_ruby_version = '>= 1.8.6'
   #
-  #  # Hopefully by now:
-  #  spec.required_ruby_version = '>= 1.9.2'
+  #  # Only with ruby 2.0.x
+  #  spec.required_ruby_version = '~> 2.0'
 
   def required_ruby_version= req
     @required_ruby_version = Gem::Requirement.create req
@@ -554,7 +569,7 @@ class Gem::Specification < Gem::BasicSpecification
 
   ##
   # Lists the external (to RubyGems) requirements that must be met for this gem
-  # to work. It’s simply information for the user.
+  # to work.  It's simply information for the user.
   #
   # Usage:
   #
@@ -566,7 +581,7 @@ class Gem::Specification < Gem::BasicSpecification
   end
 
   ##
-  # A collection of unit test files. They will be loaded as unit tests when
+  # A collection of unit test files.  They will be loaded as unit tests when
   # the user requests a gem to be unit tested.
   #
   # Usage:
@@ -592,7 +607,7 @@ class Gem::Specification < Gem::BasicSpecification
   #
   # Deprecated: It is neither supported nor functional.
 
-  attr_accessor :autorequire
+  attr_accessor :autorequire # :nodoc:
 
   ##
   # Sets the default executable for this gem.
@@ -615,9 +630,12 @@ class Gem::Specification < Gem::BasicSpecification
   # The RubyGems version required by this gem
 
   attr_reader :required_rubygems_version
+
   ##
   # The rubyforge project this gem lives under.  i.e. RubyGems'
   # rubyforge_project is "rubygems".
+  #
+  # This option is deprecated.
 
   attr_accessor :rubyforge_project
 
@@ -768,7 +786,7 @@ class Gem::Specification < Gem::BasicSpecification
   # -- wilsonb
 
   def self.all= specs
-    @@all = specs
+    @@all = @@stubs = specs
   end
 
   ##
@@ -1320,7 +1338,7 @@ class Gem::Specification < Gem::BasicSpecification
   end
 
   ##
-  # Singular reader for #authors
+  # Singular reader for #authors.  Returns the first author in the list
 
   def author
     val = authors and val.first
@@ -1328,6 +1346,8 @@ class Gem::Specification < Gem::BasicSpecification
 
   ##
   # The list of author names who wrote this gem.
+  #
+  #   spec.authors = ['Chad Fowler', 'Jim Weirich', 'Rich Kilmer']
 
   def authors
     @authors ||= []
@@ -1407,7 +1427,9 @@ class Gem::Specification < Gem::BasicSpecification
   end
 
   ##
-  # The date this gem was created. Lazily defaults to TODAY.
+  # The date this gem was created.  Lazily defaults to the current UTC date.
+  #
+  # There is no need to set this in your gem specification.
 
   def date
     @date ||= TODAY
@@ -1454,7 +1476,7 @@ class Gem::Specification < Gem::BasicSpecification
   # Deprecated: The name of the gem is assumed to be the name of the
   # executable now.  See Gem.bin_path.
 
-  def default_executable
+  def default_executable # :nodoc:
     if defined?(@default_executable) and @default_executable
       result = @default_executable
     elsif @executables and @executables.size == 1
@@ -1513,7 +1535,7 @@ class Gem::Specification < Gem::BasicSpecification
   end
 
   ##
-  # A long description of this gem
+  # A detailed description of this gem.  See also #summary
 
   def description= str
     @description = str.to_s
@@ -1672,7 +1694,7 @@ class Gem::Specification < Gem::BasicSpecification
   #
   # Formerly used to indicate this gem was RDoc-capable.
 
-  def has_rdoc
+  def has_rdoc # :nodoc:
     true
   end
 
@@ -1681,11 +1703,11 @@ class Gem::Specification < Gem::BasicSpecification
   #
   # Formerly used to indicate this gem was RDoc-capable.
 
-  def has_rdoc= ignored
+  def has_rdoc= ignored # :nodoc:
     @has_rdoc = true
   end
 
-  alias :has_rdoc? :has_rdoc
+  alias :has_rdoc? :has_rdoc # :nodoc:
 
   ##
   # True if this gem has files in test_files
@@ -1818,7 +1840,7 @@ class Gem::Specification < Gem::BasicSpecification
     @licenses ||= []
   end
 
-  def filename= path
+  def loaded_from= path # :nodoc:
     super
 
     @bin_dir       = nil
@@ -1831,17 +1853,6 @@ class Gem::Specification < Gem::BasicSpecification
     @spec_file     = nil
   end
 
-  ##
-  # Path this gemspec was loaded from.  This attribute is not persisted.
-
-  alias loaded_from filename
-
-  ##
-  # Set the location a Specification was loaded from. +obj+ is converted
-  # to a String.
-
-  alias loaded_from= filename=
-
   ##
   # Sets the rubygems_version to the current RubyGems version.
 

data/lib/rubygems/stub_specification.rb

@@ -1,119 +1,120 @@
-module Gem
-  # Gem::StubSpecification reads the stub: line from the gemspec
-  # This prevents us having to eval the entire gemspec in order to
-  # find out certain information.
-  class StubSpecification < BasicSpecification
-    # :nodoc:
-    PREFIX = "# stub: "
-
-    OPEN_MODE = # :nodoc:
-      if Object.const_defined? :Encoding then
-        'r:UTF-8:-'
-      else
-        'r'
-      end
-
-    # :nodoc:
-    class StubLine
-      attr_reader :parts
+##
+# Gem::StubSpecification reads the stub: line from the gemspec.  This prevents
+# us having to eval the entire gemspec in order to find out certain
+# information.
+
+class Gem::StubSpecification < Gem::BasicSpecification
+  # :nodoc:
+  PREFIX = "# stub: "
+
+  OPEN_MODE = # :nodoc:
+    if Object.const_defined? :Encoding then
+      'r:UTF-8:-'
+    else
+      'r'
+    end
 
-      def initialize(data)
-        @parts = data[PREFIX.length..-1].split(" ")
-      end
+  class StubLine # :nodoc: all
+    attr_reader :parts
 
-      def name
-        @parts[0]
-      end
+    def initialize(data)
+      @parts = data[PREFIX.length..-1].split(" ")
+    end
 
-      def version
-        Gem::Version.new @parts[1]
-      end
+    def name
+      @parts[0]
+    end
 
-      def platform
-        Gem::Platform.new @parts[2]
-      end
+    def version
+      Gem::Version.new @parts[1]
+    end
 
-      def require_paths
-        @parts[3..-1].join(" ").split("\0")
-      end
+    def platform
+      Gem::Platform.new @parts[2]
     end
 
-    def initialize(filename)
-      self.filename = filename
-      @data         = nil
-      @spec         = nil
+    def require_paths
+      @parts[3..-1].join(" ").split("\0")
     end
+  end
 
-    ##
-    # Name of the gem
+  def initialize(filename)
+    self.loaded_from = filename
+    @data            = nil
+    @spec            = nil
+  end
 
-    def name
-      @name ||= data.name
-    end
+  ##
+  # True when this gem has been activated
 
-    ##
-    # Version of the gem
+  def activated?
+    loaded = Gem.loaded_specs[name]
+    loaded && loaded.version == version
+  end
 
-    def version
-      @version ||= data.version
+  ##
+  # If the gemspec contains a stubline, returns a StubLine instance. Otherwise
+  # returns the full Gem::Specification.
+
+  def data
+    unless @data
+      open loaded_from, OPEN_MODE do |file|
+        begin
+          file.readline # discard encoding line
+          stubline = file.readline.chomp
+          @data = StubLine.new(stubline) if stubline.start_with?(PREFIX)
+        rescue EOFError
+        end
+      end
     end
 
-    ##
-    # Platform of the gem
+    @data ||= to_spec
+  end
 
-    def platform
-      @platform ||= data.platform
-    end
+  private :data
 
-    ##
-    # Require paths of the gem
+  ##
+  # Name of the gem
 
-    def require_paths
-      @require_paths ||= data.require_paths
-    end
+  def name
+    @name ||= data.name
+  end
 
-    ##
-    # The full Gem::Specification for this gem, loaded from evalling its gemspec
+  ##
+  # Platform of the gem
 
-    def to_spec
-      @spec ||= Gem::Specification.load(filename)
-    end
+  def platform
+    @platform ||= data.platform
+  end
 
-    ##
-    # True when this gem has been activated
+  ##
+  # Require paths of the gem
 
-    def activated?
-      loaded = Gem.loaded_specs[name]
-      loaded && loaded.version == version
-    end
+  def require_paths
+    @require_paths ||= data.require_paths
+  end
 
-    ##
-    # Is this StubSpecification valid? i.e. have we found a stub line, OR does
-    # the filename contain a valid gemspec?
+  ##
+  # The full Gem::Specification for this gem, loaded from evalling its gemspec
 
-    def valid?
-      data
-    end
+  def to_spec
+    @spec ||= Gem::Specification.load(loaded_from)
+  end
 
-    private
-
-    ##
-    # If the gemspec contains a stubline, returns a StubLine instance. Otherwise
-    # returns the full Gem::Specification.
-
-    def data
-      unless @data
-        open filename, OPEN_MODE do |file|
-          begin
-            file.readline # discard encoding line
-            stubline = file.readline.chomp
-            @data = StubLine.new(stubline) if stubline.start_with?(PREFIX)
-          rescue EOFError
-          end
-        end
-      end
+  ##
+  # Is this StubSpecification valid? i.e. have we found a stub line, OR does
+  # the filename contain a valid gemspec?
 
-      @data ||= to_spec
-    end
+  def valid?
+    data
   end
+
+  ##
+  # Version of the gem
+
+  def version
+    @version ||= data.version
+  end
+
 end
+