Class: Gem::Requirement (Ruby 2.3.4)

Home Classes Methods

In Files

rubygems/requirement.rb

Class/Module Index

Gem::Requirement

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.

Constants

DefaultRequirement: The default requirement matches any version
PATTERN: A regular expression that matches a requirement

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.

 
               # File rubygems/requirement.rb, line 54
def self.create input
  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 then
      new [input.to_str]
    else
      default
    end
  end
end

default()

A default “version requirement” can surely only be ‘>= 0’.

 
               # File rubygems/requirement.rb, line 74
def self.default
  new '>= 0'
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".

 
               # File rubygems/requirement.rb, line 123
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")]

 
               # File rubygems/requirement.rb, line 97
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
  else
    [$1 || "=", Gem::Version.new($2)]
  end
end

Public Instance Methods

===(version)

Alias for: satisfied_by?

=~(version)

Alias for: satisfied_by?

concat(new)

Concatenates the new requirements onto this requirement.

 
               # File rubygems/requirement.rb, line 138
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

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

none?()

true if this gem has no requirements.

 
               # File rubygems/requirement.rb, line 165
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

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

satisfied_by?(version)

True if version satisfies this Requirement.

 
               # File rubygems/requirement.rb, line 239
def satisfied_by? version
  raise ArgumentError, "Need a Gem::Version: #{version.inspect}" unless
    Gem::Version === version
  # #28965: syck has a bug with unquoted '=' YAML.loading as YAML::DefaultKey
  requirements.all? { |op, rv| (OPS[op] || OPS["="]).call version, rv }
end

Also aliased as: ===, =~

specific?()

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

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

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