Skip to Content Skip to Search

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

See Gem::Version for a description on how versions and requirements work together in RubyGems.

Namespace
Methods
#
C
D
E
N
P
S

Constants

DefaultPrereleaseRequirement = [">=", Gem::Version.new("0.a")].freeze
 

The default requirement matches any version
DefaultRequirement = [">=", Gem::Version.new(0)].freeze
 

The default requirement matches any non-prerelease version
PATTERN = /\A#{PATTERN_RAW}\z/
 

A regular expression that matches a requirement

Class Public methods

create(*inputs)

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: show | on GitHub 

# File ruby/lib/rubygems/requirement.rb, line 55
def self.create(*inputs)
  return new inputs if inputs.length > 1

  input = inputs.shift

  case input
  when Gem::Requirement then
    input
  when Gem::Version, Array then
    new input
  when "!" then
    source_set
  else
    if input.respond_to? :to_str
      new [input.to_str]
    else
      default
    end
  end
end

default()

Source: show | on GitHub 

# File ruby/lib/rubygems/requirement.rb, line 76
def self.default
  new ">= 0"
end

default_prerelease()

Source: show | on GitHub 

# File ruby/lib/rubygems/requirement.rb, line 80
def self.default_prerelease
  new ">= 0.a"
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: show | on GitHub 

# File ruby/lib/rubygems/requirement.rb, line 131
def initialize(*requirements)
  requirements = requirements.flatten
  requirements.compact!
  requirements.uniq!

  if requirements.empty?
    @requirements = [DefaultRequirement]
  else
    @requirements = requirements.map! {|r| self.class.parse r }
  end
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")                 # => [">", Gem::Version.new("1.0")]
parse("1.0")                   # => ["=", Gem::Version.new("1.0")]
parse(Gem::Version.new("1.0")) # => ["=,  Gem::Version.new("1.0")]

Source: show | on GitHub 

# File ruby/lib/rubygems/requirement.rb, line 103
def self.parse(obj)
  return ["=", obj] if Gem::Version === obj

  unless PATTERN =~ obj.to_s
    raise BadRequirementError, "Illformed requirement [#{obj.inspect}]"
  end

  if $1 == ">=" && $2 == "0"
    DefaultRequirement
  elsif $1 == ">=" && $2 == "0.a"
    DefaultPrereleaseRequirement
  else
    [-($1 || "="), Gem::Version.new($2)]
  end
end

Instance Public methods

===(version)

Alias for: satisfied_by?

=~(version)

Alias for: satisfied_by?

concat(new)

Concatenates the new requirements onto this requirement.

Source: show | on GitHub 

# File ruby/lib/rubygems/requirement.rb, line 146
def concat(new)
  new = new.flatten
  new.compact!
  new.uniq!
  new = new.map {|r| self.class.parse r }

  @requirements.concat new
end

exact?()

true if the requirement is for only an exact version

Source: show | on GitHub 

# File ruby/lib/rubygems/requirement.rb, line 184
def exact?
  return false unless @requirements.size == 1
  @requirements[0][0] == "="
end

none?()

true if this gem has no requirements.

Source: show | on GitHub 

# File ruby/lib/rubygems/requirement.rb, line 173
def none?
  if @requirements.size == 1
    @requirements[0] == DefaultRequirement
  else
    false
  end
end

prerelease?()

A requirement is a prerelease if any of the versions inside of it are prereleases

Source: show | on GitHub 

# File ruby/lib/rubygems/requirement.rb, line 229
def prerelease?
  requirements.any? {|r| r.last.prerelease? }
end

satisfied_by?(version)

True if version satisfies this Requirement.

Also aliased as: ===, =~

Source: show | on GitHub 

# File ruby/lib/rubygems/requirement.rb, line 242
def satisfied_by?(version)
  raise ArgumentError, "Need a Gem::Version: #{version.inspect}" unless
    Gem::Version === version
  requirements.all? {|op, rv| OPS[op].call version, rv }
end

specific?()

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

Source: show | on GitHub 

# File ruby/lib/rubygems/requirement.rb, line 254
def specific?
  return true if @requirements.length > 1 # GIGO, > 1, > 2 is silly

  !%w[> >=].include? @requirements.first.first # grab the operator
end

Instance Protected methods

_sorted_requirements()

Source: show | on GitHub 

# File ruby/lib/rubygems/requirement.rb, line 280
def _sorted_requirements
  @_sorted_requirements ||= requirements.sort_by(&:to_s)
end

_tilde_requirements()

Source: show | on GitHub 

# File ruby/lib/rubygems/requirement.rb, line 284
def _tilde_requirements
  @_tilde_requirements ||= _sorted_requirements.select {|r| r.first == "~>" }
end