Class: Gem::Requirement (Ruby 2.2.4)
Description: Class : Gem::Requirement - Ruby 2.2.4

- Home
- Core 2.2.4
- Std-lib 2.2.4
- Downloads

Support for the Ruby 2.2 series has ended. See here for reference.

### Home Classes Methods

### In Files

- rubygems/requirement.rb

### Parent

Object

### Namespace

- CLASS Gem::Requirement::BadRequirementError

### Methods

- ::create
- ::default
- ::new
- ::parse
- #===
- #=~
- #concat
- #exact?
- #none?
- #prerelease?
- #satisfied_by?
- #specific?

### Class/Module Index

Quicksearch

- Gem::AvailableSet
- Gem::BasicSpecification
- Gem::Command
- Gem::CommandLineError
- Gem::CommandManager
- Gem::Commands
- Gem::Commands::BuildCommand
- Gem::Commands::CertCommand
- Gem::Commands::CheckCommand
- Gem::Commands::CleanupCommand
- Gem::Commands::ContentsCommand
- Gem::Commands::DependencyCommand
- Gem::Commands::EnvironmentCommand
- Gem::Commands::FetchCommand
- Gem::Commands::GenerateIndexCommand
- Gem::Commands::HelpCommand
- Gem::Commands::InstallCommand
- Gem::Commands::ListCommand
- Gem::Commands::LockCommand
- Gem::Commands::MirrorCommand
- Gem::Commands::OpenCommand
- Gem::Commands::OutdatedCommand
- Gem::Commands::OwnerCommand
- Gem::Commands::PristineCommand
- Gem::Commands::PushCommand
- Gem::Commands::QueryCommand
- Gem::Commands::RdocCommand
- Gem::Commands::SearchCommand
- Gem::Commands::ServerCommand
- Gem::Commands::SetupCommand
- Gem::Commands::SourcesCommand
- Gem::Commands::SpecificationCommand
- Gem::Commands::StaleCommand
- Gem::Commands::UninstallCommand
- Gem::Commands::UnpackCommand
- Gem::Commands::UpdateCommand
- Gem::Commands::WhichCommand
- Gem::Commands::YankCommand
- Gem::ConfigFile
- Gem::ConfigFile::Psych
- Gem::ConflictError
- Gem::ConsoleUI
- Gem::DefaultUserInteraction
- Gem::Dependency
- Gem::DependencyError
- Gem::DependencyInstaller
- Gem::DependencyList
- Gem::DependencyRemovalException
- Gem::DependencyResolutionError
- Gem::Deprecate
- Gem::Doctor
- Gem::DocumentError
- Gem::EndOfYAMLException
- Gem::ErrorReason
- Gem::Exception
- Gem::Ext
- Gem::Ext::BuildError
- Gem::Ext::Builder
- Gem::Ext::CmakeBuilder
- Gem::Ext::ConfigureBuilder
- Gem::Ext::ExtConfBuilder
- Gem::Ext::RakeBuilder
- Gem::FakeFetcher
- Gem::FilePermissionError
- Gem::FormatException
- Gem::GemNotFoundException
- Gem::GemNotInHomeException
- Gem::GemRunner
- Gem::GemcutterUtilities
- Gem::ImpossibleDependenciesError
- Gem::Indexer
- Gem::InstallError
- Gem::InstallUpdateOptions
- Gem::Installer
- Gem::InstallerTestCase
- Gem::InvalidSpecificationException
- Gem::List
- Gem::LoadError
- Gem::LocalRemoteOptions
- Gem::MockGemUi
- Gem::MockGemUi::InputEOFError
- Gem::MockGemUi::SystemExitException
- Gem::MockGemUi::TTY
- Gem::MockGemUi::TermError
- Gem::NameTuple
- Gem::NoAliasYAMLTree
- Gem::OperationNotSupportedError
- Gem::Package::DigestIO
- Gem::Package::Error
- Gem::Package::FormatError
- Gem::Package::NonSeekableIO
- Gem::Package::Old
- Gem::Package::PathError
- Gem::Package::TarHeader
- Gem::Package::TarInvalidError
- Gem::Package::TarReader
- Gem::Package::TarReader::Entry
- Gem::Package::TarReader::UnexpectedEOF
- Gem::Package::TarTestCase
- Gem::Package::TarWriter
- Gem::Package::TarWriter::BoundedStream
- Gem::Package::TarWriter::FileOverflow
- Gem::Package::TarWriter::RestrictedStream
- Gem::Package::TooLongFileName
- Gem::PackageTask
- Gem::PathSupport
- Gem::Platform
- Gem::PlatformMismatch
- Gem::RemoteError
- Gem::RemoteFetcher
- Gem::RemoteFetcher::FetchError
- Gem::RemoteFetcher::UnknownHostError
- Gem::RemoteInstallationCancelled
- Gem::RemoteInstallationSkipped
- Gem::RemoteSourceException
- Gem::Request::ConnectionPools
- Gem::Request::ConnectionPools::Net
- Gem::RequestSet
- Gem::RequestSet::GemDependencyAPI
- Gem::RequestSet::Lockfile
- Gem::RequestSet::Lockfile::ParseError
- Gem::Requirement
- Gem::Requirement::BadRequirementError
- Gem::Resolver
- Gem::Resolver::APISet
- Gem::Resolver::APISpecification
- Gem::Resolver::ActivationRequest
- Gem::Resolver::BestSet
- Gem::Resolver::ComposedSet
- Gem::Resolver::Conflict
- Gem::Resolver::CurrentSet
- Gem::Resolver::DependencyRequest
- Gem::Resolver::GitSet
- Gem::Resolver::GitSpecification
- Gem::Resolver::IndexSet
- Gem::Resolver::IndexSpecification
- Gem::Resolver::InstalledSpecification
- Gem::Resolver::InstallerSet
- Gem::Resolver::LocalSpecification
- Gem::Resolver::LockSet
- Gem::Resolver::LockSpecification
- Gem::Resolver::RequirementList
- Gem::Resolver::Set
- Gem::Resolver::SpecSpecification
- Gem::Resolver::Specification
- Gem::Resolver::Stats
- Gem::Resolver::VendorSet
- Gem::Resolver::VendorSpecification
- Gem::RubyVersionMismatch
- Gem::Security
- Gem::Security::Exception
- Gem::Security::Policy
- Gem::Security::Signer
- Gem::Security::TrustDir
- Gem::Server
- Gem::SilentUI
- Gem::Source
- Gem::Source::Git
- Gem::Source::Installed
- Gem::Source::Local
- Gem::Source::Lock
- Gem::Source::SpecificFile
- Gem::Source::Vendor
- Gem::SourceFetchProblem
- Gem::SourceList
- Gem::SpecFetcher
- Gem::SpecificGemNotFoundException
- Gem::Specification
- Gem::StreamUI
- Gem::StreamUI::SilentDownloadReporter
- Gem::StreamUI::SilentProgressReporter
- Gem::StreamUI::SimpleProgressReporter
- Gem::StreamUI::VerboseDownloadReporter
- Gem::StreamUI::VerboseProgressReporter
- Gem::StringSink
- Gem::StringSource
- Gem::StubSpecification
- Gem::SystemExitException
- Gem::TestCase
- Gem::TestCase::SpecFetcherSetup
- Gem::TestCase::StaticSet
- Gem::Text
- Gem::Uninstaller
- Gem::UnsatisfiableDependencyError
- Gem::UriFormatter
- Gem::UserInteraction
- Gem::Util
- Gem::Validator
- Gem::VerificationError
- Gem::Version
- Gem::VersionOption
- Kernel
- Object
- OpenSSL
- TempIO
- YAML::Syck
- YAML::Syck

No matching classes.

# 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) click to toggle source

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 51
    def self.create input
      case input
      when Gem::Requirement then
        input
      when Gem::Version, Array then
        new input
      else
        if input.respond_to? :to_str then
          new [input.to_str]
        else
          default
        end
      end
    end

default() click to toggle source

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

                   # File rubygems/requirement.rb, line 69
    def self.default
      new '>= 0'
    end

new(*requirements) click to toggle source

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 111
    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) click to toggle source

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"]

                   # File rubygems/requirement.rb, line 85
    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) click to toggle source
Alias for: satisfied_by?
=~(version) click to toggle source
Alias for: satisfied_by?
concat(new) click to toggle source

Concatenates the `new` requirements onto this requirement.

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

      @requirements.concat new
    end

exact?() click to toggle source

true if the requirement is for only an exact version

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

none?() click to toggle source

true if this gem has no requirements.

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

prerelease?() click to toggle source

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

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

satisfied_by?(version) click to toggle source

True if `version` satisfies this Requirement.

                   # File rubygems/requirement.rb, line 227
    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?() click to toggle source

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

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

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