Class: Gem::SourceList (Ruby 2.2.4)
Description: Class : Gem::SourceList - 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/source_list.rb

### Parent

Object

### Methods

- ::from
- ::new
- #<<
- #clear
- #delete
- #each
- #each_source
- #empty?
- #first
- #include?
- #replace
- #to_a
- #to_ary

### Included Modules

- Enumerable

### 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::SourceList

The SourceList represents the sources rubygems has been configured to use. A source may be created from an array of sources:

    Gem::SourceList.from %w[https://rubygems.example https://internal.example]

Or by adding them:

    sources = Gem::SourceList.new
    sources.add 'https://rubygems.example'

The most common way to get a SourceList is Gem.sources.

### Attributes

sources[R]

The sources in this list

### Public Class Methods

from(ary) click to toggle source

Creates a new SourceList from an array of sources.

                   # File rubygems/source_list.rb, line 35
    def self.from(ary)
      list = new

      list.replace ary

      return list
    end

new() click to toggle source

Creates a new SourceList

                   # File rubygems/source_list.rb, line 23
    def initialize
      @sources = []
    end

### Public Instance Methods

<<(obj) click to toggle source

Appends `obj` to the source list which may be a Gem::Source, URI or URI String.

                   # File rubygems/source_list.rb, line 51
    def <<(obj)
      src = case obj
            when URI
              Gem::Source.new(obj)
            when Gem::Source
              obj
            else
              Gem::Source.new(URI.parse(obj))
            end

      @sources << src
      src
    end

clear() click to toggle source

Removes all sources from the SourceList.

                   # File rubygems/source_list.rb, line 82
    def clear
      @sources.clear
    end

delete(source) click to toggle source

Deletes `source` from the source list which may be a Gem::Source or a URI.

                   # File rubygems/source_list.rb, line 142
    def delete source
      if source.kind_of? Gem::Source
        @sources.delete source
      else
        @sources.delete_if { |x| x.uri.to_s == source.to_s }
      end
    end

each() click to toggle source

Yields each source URI in the list.

                   # File rubygems/source_list.rb, line 89
    def each
      @sources.each { |s| yield s.uri.to_s }
    end

each_source(&b) click to toggle source

Yields each source in the list.

                   # File rubygems/source_list.rb, line 96
    def each_source(&b)
      @sources.each(&b)
    end

empty?() click to toggle source

Returns true if there are no sources in this SourceList.

                   # File rubygems/source_list.rb, line 103
    def empty?
      @sources.empty?
    end

first() click to toggle source

Returns the first source in the list.

                   # File rubygems/source_list.rb, line 123
    def first
      @sources.first
    end

include?(other) click to toggle source

Returns true if this source list includes `other` which may be a Gem::Source or a source URI.

                   # File rubygems/source_list.rb, line 131
    def include?(other)
      if other.kind_of? Gem::Source
        @sources.include? other
      else
        @sources.find { |x| x.uri.to_s == other.to_s }
      end
    end

replace(other) click to toggle source

Replaces this SourceList with the sources in `other` See << for acceptable items in `other`.

                   # File rubygems/source_list.rb, line 69
    def replace(other)
      clear

      other.each do |x|
        self << x
      end

      self
    end

to_a() click to toggle source

Returns an Array of source URI Strings.

                   # File rubygems/source_list.rb, line 114
    def to_a
      @sources.map { |x| x.uri.to_s }
    end

Also aliased as: to_ary
to_ary() click to toggle source
Alias for: to_a