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

Methods

===   =~   create   default   new   none?   parse   prerelease?   satisfied_by?   specific?  

Included Modules

Comparable

Constants

OPS = { #:nodoc: "=" => 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 >= r && v.release < r.bump }
PATTERN = /\A\s*(#{quoted})?\s*(#{Gem::Version::VERSION_PATTERN})\s*\z/

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 39
39:   def self.create input
40:     case input
41:     when Gem::Requirement then
42:       input
43:     when Gem::Version, Array then
44:       new input
45:     else
46:       if input.respond_to? :to_str then
47:         new [input.to_str]
48:       else
49:         default
50:       end
51:     end
52:   end
default()

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

[Source]

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

Constructs a requirement from requirements. Requirements can be Strings, Gem::Versions, or Arrays of those. nil and duplicate requirements are ignored. An empty set of requirements is the same as ">= 0".

[Source]

     # File lib/rubygems/requirement.rb, line 99
 99:   def initialize *requirements
100:     requirements = requirements.flatten
101:     requirements.compact!
102:     requirements.uniq!
103: 
104:     requirements << ">= 0" if requirements.empty?
105:     @none = (requirements == ">= 0")
106:     @requirements = requirements.map! { |r| self.class.parse r }
107:   end
parse(obj)

Parse obj, returning an [op, version] pair. obj can be a String or a Gem::Version.

If obj is a String, it can be either a full requirement specification, like ">= 1.2", or a simple version number, like "1.2". 

    parse("> 1.0")                 # => [">", "1.0"]
    parse("1.0")                   # => ["=", "1.0"]
    parse(Gem::Version.new("1.0")) # => ["=,  "1.0"]

[Source]

    # File lib/rubygems/requirement.rb, line 77
77:   def self.parse obj
78:     return ["=", obj] if Gem::Version === obj
79: 
80:     unless PATTERN =~ obj.to_s
81:       raise ArgumentError, "Illformed requirement [#{obj.inspect}]"
82:     end
83: 
84:     [$1 || "=", Gem::Version.new($2)]
85:   end

Public Instance methods

===(version)

Alias for satisfied_by?

=~(version)

Alias for satisfied_by?

none?()

[Source]

     # File lib/rubygems/requirement.rb, line 109
109:   def none?
110:     @none ||= (to_s == ">= 0")
111:   end
prerelease?()

[Source]

     # File lib/rubygems/requirement.rb, line 145
145:   def prerelease?
146:     requirements.any? { |r| r.last.prerelease? }
147:   end
satisfied_by?(version)

True if version satisfies this Requirement.

[Source]

     # File lib/rubygems/requirement.rb, line 158
158:   def satisfied_by? version
159:     # #28965: syck has a bug with unquoted '=' YAML.loading as YAML::DefaultKey
160:     requirements.all? { |op, rv| (OPS[op] || OPS["="]).call version, rv }
161:   end
specific?()

True if the requirement will not always match the latest version.

[Source]

     # File lib/rubygems/requirement.rb, line 169
169:   def specific?
170:     return true if @requirements.length > 1 # GIGO, > 1, > 2 is silly
171: 
172:     not %w[> >=].include? @requirements.first.first # grab the operator
173:   end

[Validate]