lib/rubygems/version.rb

   1 #--
   2 # Copyright 2006 by Chad Fowler, Rich Kilmer, Jim Weirich and others.
   3 # All rights reserved.
   4 # See LICENSE.txt for permissions.
   5 #++
   6
   7 require 'rubygems'
   8
   9 ##
  10 # The Version class processes string versions into comparable values
  11
  12 class Gem::Version
  13
  14   include Comparable
  15
  16   attr_reader :ints
  17
  18   attr_reader :version
  19
  20   ##
  21   # Returns true if +version+ is a valid version string.
  22
  23   def self.correct?(version)
  24     case version
  25     when Integer, /\A\s*(\d+(\.\d+)*)*\s*\z/ then true
  26     else false
  27     end
  28   end
  29
  30   ##
  31   # Factory method to create a Version object.  Input may be a Version or a
  32   # String.  Intended to simplify client code.
  33   #
  34   #   ver1 = Version.create('1.3.17')   # -> (Version object)
  35   #   ver2 = Version.create(ver1)       # -> (ver1)
  36   #   ver3 = Version.create(nil)        # -> nil
  37
  38   def self.create(input)
  39     if input.respond_to? :version then
  40       input
  41     elsif input.nil? then
  42       nil
  43     else
  44       new input
  45     end
  46   end
  47
  48   ##
  49   # Constructs a Version from the +version+ string.  A version string is a
  50   # series of digits separated by dots.
  51
  52   def initialize(version)
  53     raise ArgumentError, "Malformed version number string #{version}" unless
  54       self.class.correct?(version)
  55
  56     self.version = version
  57   end
  58
  59   def inspect # :nodoc:
  60     "#<#{self.class} #{@version.inspect}>"
  61   end
  62
  63   # Dump only the raw version string, not the complete object
  64   def marshal_dump
  65     [@version]
  66   end
  67
  68   # Load custom marshal format
  69   def marshal_load(array)
  70     self.version = array[0]
  71   end
  72
  73   ##
  74   # Strip ignored trailing zeros.
  75
  76   def normalize
  77     @ints = build_array_from_version_string
  78
  79     return if @ints.length == 1
  80
  81     @ints.pop while @ints.last == 0
  82
  83     @ints = [0] if @ints.empty?
  84   end
  85
  86   ##
  87   # Returns the text representation of the version
  88   #
  89   # return:: [String] version as string
  90   #
  91   def to_s
  92     @version
  93   end
  94
  95   ##
  96   # Returns an integer array representation of this Version.
  97
  98   def to_ints
  99     normalize unless @ints
 100     @ints
 101   end
 102
 103   def to_yaml_properties
 104     ['@version']
 105   end
 106
 107   def version=(version)
 108     @version = version.to_s.strip
 109     normalize
 110   end
 111
 112   def yaml_initialize(tag, values)
 113     self.version = values['version']
 114   end
 115
 116   ##
 117   # Compares this version with +other+ returning -1, 0, or 1 if the other
 118   # version is larger, the same, or smaller than this one.
 119
 120   def <=>(other)
 121     return nil unless self.class === other
 122     return 1 unless other
 123     @ints <=> other.ints
 124   end
 125
 126   ##
 127   # A Version is only eql? to another version if it has the same version
 128   # string.  "1.0" is not the same version as "1".
 129
 130   def eql?(other)
 131     self.class === other and @version == other.version
 132   end
 133
 134   def hash # :nodoc:
 135     @version.hash
 136   end
 137
 138   # Return a new version object where the next to the last revision
 139   # number is one greater. (e.g.  5.3.1 => 5.4)
 140   def bump
 141     ints = build_array_from_version_string
 142     ints.pop if ints.size > 1
 143     ints[-1] += 1
 144     self.class.new(ints.join("."))
 145   end
 146
 147   def build_array_from_version_string
 148     @version.to_s.scan(/\d+/).map { |s| s.to_i }
 149   end
 150   private :build_array_from_version_string
 151
 152   #:stopdoc:
 153
 154   require 'rubygems/requirement'
 155
 156   # Gem::Requirement's original definition is nested in Version.
 157   # Although an inappropriate place, current gems specs reference the nested
 158   # class name explicitly.  To remain compatible with old software loading
 159   # gemspecs, we leave a copy of original definition in Version, but define an
 160   # alias Gem::Requirement for use everywhere else.
 161
 162   Requirement = ::Gem::Requirement
 163
 164   # :startdoc:
 165
 166 end
 167