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

A Requirement is a set of one or more version restrictions. It supports a few (=, !=, >, <, >=, <=, ~>) different restriction operators.

Methods

create   default   new   none?   parse   prerelease?   satisfied_by?  

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 = v.release;
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 30
30:   def self.create input
31:     case input
32:     when Gem::Requirement then
33:       input
34:     when Gem::Version, Array then
35:       new input
36:     else
37:       if input.respond_to? :to_str then
38:         new [input.to_str]
39:       else
40:         default
41:       end
42:     end
43:   end
default()

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

[Source]

    # File lib/rubygems/requirement.rb, line 52
52:   def self.default
53:     new '>= 0'
54:   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 90
90:   def initialize *requirements
91:     requirements = requirements.flatten
92:     requirements.compact!
93:     requirements.uniq!
94: 
95:     requirements << ">= 0" if requirements.empty?
96:     @none = (requirements == ">= 0")
97:     @requirements = requirements.map! { |r| self.class.parse r }
98:   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 68
68:   def self.parse obj
69:     return ["=", obj] if Gem::Version === obj
70: 
71:     unless PATTERN =~ obj.to_s
72:       raise ArgumentError, "Illformed requirement [#{obj.inspect}]"
73:     end
74: 
75:     [$1 || "=", Gem::Version.new($2)]
76:   end

Public Instance methods

none?()

[Source]

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

[Source]

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

True if version satisfies this Requirement.

[Source]

     # File lib/rubygems/requirement.rb, line 133
133:   def satisfied_by? version
134:     requirements.all? { |op, rv| OPS[op].call version, rv }
135:   end

[Validate]