Class: Gem::SourceList

Inherits:
Object
  • Object
show all
Includes:
Enumerable
Defined in:
lib/rubygems/source_list.rb

Overview

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.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeSourceList

Creates a new SourceList


24
25
26
# File 'lib/rubygems/source_list.rb', line 24

def initialize
  @sources = []
end

Instance Attribute Details

#sourcesObject (readonly)

The sources in this list


31
32
33
# File 'lib/rubygems/source_list.rb', line 31

def sources
  @sources
end

Class Method Details

.from(ary) ⇒ Object

Creates a new SourceList from an array of sources.


36
37
38
39
40
41
42
# File 'lib/rubygems/source_list.rb', line 36

def self.from(ary)
  list = new

  list.replace ary

  return list
end

Instance Method Details

#<<(obj) ⇒ Object

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


52
53
54
55
56
57
58
59
60
61
62
63
64
# File 'lib/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 unless @sources.include?(src)
  src
end

#==(other) ⇒ Object

:nodoc:


108
109
110
# File 'lib/rubygems/source_list.rb', line 108

def == other # :nodoc:
  to_a == other
end

#clearObject

Removes all sources from the SourceList.


83
84
85
# File 'lib/rubygems/source_list.rb', line 83

def clear
  @sources.clear
end

#delete(source) ⇒ Object

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


143
144
145
146
147
148
149
# File 'lib/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

#eachObject

Yields each source URI in the list.


90
91
92
# File 'lib/rubygems/source_list.rb', line 90

def each
  @sources.each { |s| yield s.uri.to_s }
end

#each_source(&b) ⇒ Object

Yields each source in the list.


97
98
99
# File 'lib/rubygems/source_list.rb', line 97

def each_source(&b)
  @sources.each(&b)
end

#empty?Boolean

Returns true if there are no sources in this SourceList.


104
105
106
# File 'lib/rubygems/source_list.rb', line 104

def empty?
  @sources.empty?
end

#firstObject

Returns the first source in the list.


124
125
126
# File 'lib/rubygems/source_list.rb', line 124

def first
  @sources.first
end

#include?(other) ⇒ Boolean

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


132
133
134
135
136
137
138
# File 'lib/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

#initialize_copy(other) ⇒ Object

:nodoc:


44
45
46
# File 'lib/rubygems/source_list.rb', line 44

def initialize_copy(other) # :nodoc:
  @sources = @sources.dup
end

#replace(other) ⇒ Object

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


70
71
72
73
74
75
76
77
78
# File 'lib/rubygems/source_list.rb', line 70

def replace(other)
  clear

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

  self
end

#to_aObject Also known as: to_ary

Returns an Array of source URI Strings.


115
116
117
# File 'lib/rubygems/source_list.rb', line 115

def to_a
  @sources.map { |x| x.uri.to_s }
end