Skip to Content Skip to Search

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 << 'https://rubygems.example'

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

Methods
#
C
D
E
F
I
N
R
T
Included Modules

Attributes

[R] sources

The sources in this list

Class Public methods

from(ary)

Creates a new SourceList from an array of sources.

Source: show | on GitHub 

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

  list.replace ary

  list
end

new()

Creates a new SourceList

Source: show | on GitHub 

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

Instance Public methods

<<(obj)

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

Source: show | on GitHub 

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

  @sources << src unless @sources.include?(src)
  src
end

clear()

Removes all sources from the SourceList.

Source: show | on GitHub 

# File ruby/lib/rubygems/source_list.rb, line 79
def clear
  @sources.clear
end

delete(source)

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

Source: show | on GitHub 

# File ruby/lib/rubygems/source_list.rb, line 139
def delete(source)
  if source.is_a? Gem::Source
    @sources.delete source
  else
    @sources.delete_if {|x| x.uri.to_s == source.to_s }
  end
end

each()

Yields each source URI in the list.

Source: show | on GitHub 

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

each_source(&b)

Yields each source in the list.

Source: show | on GitHub 

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

empty?()

Returns true if there are no sources in this SourceList.

Source: show | on GitHub 

# File ruby/lib/rubygems/source_list.rb, line 100
def empty?
  @sources.empty?
end

first()

Returns the first source in the list.

Source: show | on GitHub 

# File ruby/lib/rubygems/source_list.rb, line 120
def first
  @sources.first
end

include?(other)

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

Source: show | on GitHub 

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

replace(other)

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

Source: show | on GitHub 

# File ruby/lib/rubygems/source_list.rb, line 66
def replace(other)
  clear

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

  self
end

to_a()

Returns an Array of source URI Strings.

Also aliased as: to_ary

Source: show | on GitHub 

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

to_ary()

Alias for: to_a