Class Gem::Requirement
In: lib/rubygems/requirement.rb
Parent: Object

Requirement version includes a prefaced comparator in addition to a version number.

A Requirement object can actually contain multiple, er, requirements, as in (> 1.2, < 2.0).

Methods

as_list   create   default   new   normalize   parse   prerelease?   satisfied_by?   satisfy?  

Included Modules

Comparable

Constants

OPS = { "=" => lambda { |v, r| v == r }, "!=" => lambda { |v, r| v != r }, ">" => lambda { |v, r| v > r }, "<" => lambda { |v, r| v < r }, ">=" => lambda { |v, r| v >= r }, "<=" => lambda { |v, r| v <= r }, "~>" => lambda { |v, r| v = v.release;
OP_RE = OPS.keys.map{ |k| Regexp.quote k }.join '|'

Attributes

requirements  [R] 

Public Class methods

create(input)

Factory method to create a Gem::Requirement object. Input may be a Version, a String, or nil. Intended to simplify client code.

If the input is "weird", the default version requirement is returned.

[Source]

    # File lib/rubygems/requirement.rb, line 38
38:   def self.create(input)
39:     case input
40:     when Gem::Requirement then
41:       input
42:     when Gem::Version, Array then
43:       new input
44:     else
45:       if input.respond_to? :to_str then
46:         self.new [input.to_str]
47:       else
48:         self.default
49:       end
50:     end
51:   end
default()

A default "version requirement" can surely only be ’>= 0’.

[Source]

    # File lib/rubygems/requirement.rb, line 60
60:   def self.default
61:     self.new ['>= 0']
62:   end
new(requirements)

Constructs a Requirement from requirements which can be a String, a Gem::Version, or an Array of those. See parse for details on the formatting of requirement strings.

[Source]

    # File lib/rubygems/requirement.rb, line 69
69:   def initialize(requirements)
70:     @requirements = case requirements
71:                     when Array then
72:                       requirements.map do |requirement|
73:                         parse(requirement)
74:                       end
75:                     else
76:                       [parse(requirements)]
77:                     end
78:     @version = nil   # Avoid warnings.
79:   end

Public Instance methods

as_list()

[Source]

     # File lib/rubygems/requirement.rb, line 106
106:   def as_list
107:     normalize
108:     @requirements.map do |op, version| "#{op} #{version}" end
109:   end
normalize()

[Source]

     # File lib/rubygems/requirement.rb, line 111
111:   def normalize
112:     return if not defined? @version or @version.nil?
113:     @requirements = [parse(@version)]
114:     @nums = nil
115:     @version = nil
116:     @op = nil
117:   end
parse(obj)

Parse the version requirement obj returning the operator and version.

The requirement can be a String or a Gem::Version. A String can be an operator (<, <=, =, >=, >, !=, ~>), a version number, or both, operator first.

[Source]

     # File lib/rubygems/requirement.rb, line 146
146:   def parse(obj)
147:     case obj
148:     when /^\s*(#{OP_RE})\s*(#{Gem::Version::VERSION_PATTERN})\s*$/o then
149:       [$1, Gem::Version.new($2)]
150:     when /^\s*(#{Gem::Version::VERSION_PATTERN})\s*$/o then
151:       ['=', Gem::Version.new($1)]
152:     when /^\s*(#{OP_RE})\s*$/o then
153:       [$1, Gem::Version.new('0')]
154:     when Gem::Version then
155:       ['=', obj]
156:     else
157:       fail ArgumentError, "Illformed requirement [#{obj.inspect}]"
158:     end
159:   end
prerelease?()

[Source]

     # File lib/rubygems/requirement.rb, line 134
134:   def prerelease?
135:     # TODO: why is @requirements a nested array?
136:     @requirements.any?{ |r| r[1].prerelease? }
137:   end
satisfied_by?(version)

True if this requirement satisfied by the Gem::Version version.

[Source]

     # File lib/rubygems/requirement.rb, line 122
122:   def satisfied_by?(version)
123:     normalize
124:     @requirements.all? { |op, rv| satisfy?(op, version, rv) }
125:   end
satisfy?(op, version, required_version)

Is "version op required_version" satisfied?

[Source]

     # File lib/rubygems/requirement.rb, line 130
130:   def satisfy?(op, version, required_version)
131:     OPS[op].call(version, required_version)
132:   end

[Validate]