Class: Gem::SourceList (Ruby 2.3.4)

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

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 << '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)

Creates a new SourceList from an array of sources.

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

  list.replace ary

  return list
end

new()

Creates a new SourceList

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

Public Instance Methods

<<(obj)

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

 
               # File rubygems/source_list.rb, line 52
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()

Removes all sources from the SourceList.

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

delete(source)

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

 
               # File rubygems/source_list.rb, line 143
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()

Yields each source URI in the list.

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

each_source(&b)

Yields each source in the list.

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

empty?()

Returns true if there are no sources in this SourceList.

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

first()

Returns the first source in the list.

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

 
               # File rubygems/source_list.rb, line 132
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)

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

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

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

  self
end

to_a()

Returns an Array of source URI Strings.

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

Also aliased as: to_ary

to_ary()

Alias for: to_a