Class: Gem::FakeFetcher

Inherits:
Object
  • Object
show all
Defined in:
lib/rubygems/test_utilities.rb

Overview

A fake Gem::RemoteFetcher for use in tests or to avoid real live HTTP requests when testing code that uses RubyGems.

Example:

@fetcher = Gem::FakeFetcher.new
@fetcher.data['http://gems.example.com/yaml'] = source_index.to_yaml
Gem::RemoteFetcher.fetcher = @fetcher

# invoke RubyGems code

paths = @fetcher.paths
assert_equal 'http://gems.example.com/yaml', paths.shift
assert paths.empty?, paths.join(', ')

See RubyGems’ tests for more examples of FakeFetcher.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ FakeFetcher

Returns a new instance of FakeFetcher.



30
31
32
33
34
 
# File 'lib/rubygems/test_utilities.rb', line 30

def initialize
  @data = {}
  @paths = []
  @api_endpoints = {}
end

Instance Attribute Details

#api_endpoints ⇒ Object (readonly)

Returns the value of attribute api_endpoints



27
28
29
 
# File 'lib/rubygems/test_utilities.rb', line 27

def api_endpoints
  @api_endpoints
end

#data ⇒ Object (readonly)

Returns the value of attribute data



25
26
27
 
# File 'lib/rubygems/test_utilities.rb', line 25

def data
  @data
end

#last_request ⇒ Object (readonly)

Returns the value of attribute last_request



26
27
28
 
# File 'lib/rubygems/test_utilities.rb', line 26

def last_request
  @last_request
end

#paths ⇒ Object

Returns the value of attribute paths



28
29
30
 
# File 'lib/rubygems/test_utilities.rb', line 28

def paths
  @paths
end

Instance Method Details

#api_endpoint(uri) ⇒ Object 



36
37
38
 
# File 'lib/rubygems/test_utilities.rb', line 36

def api_endpoint(uri)
  @api_endpoints[uri] || uri
end

#cache_update_path(uri, path = nil, update = true) ⇒ Object 



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

def cache_update_path uri, path = nil, update = true
  if data = fetch_path(uri)
    open(path, 'wb') { |io| io.write data } if path and update
    data
  else
    Gem.read_binary(path) if path
  end
end

#download(spec, source_uri, install_dir = Gem.dir) ⇒ Object 



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/rubygems/test_utilities.rb', line 137

def download spec, source_uri, install_dir = Gem.dir
  name = File.basename spec.cache_file
  path = if Dir.pwd == install_dir then # see fetch_command
           install_dir
         else
           File.join install_dir, "cache"
         end

  path = File.join path, name

  if source_uri =~ /^http/ then
    File.open(path, "wb") do |f|
      f.write fetch_path(File.join(source_uri, "gems", name))
    end
  else
    FileUtils.cp source_uri, path
  end

  path
end

#download_to_cache(dependency) ⇒ Object 



158
159
160
161
162
163
164
165
166
 
# File 'lib/rubygems/test_utilities.rb', line 158

def download_to_cache dependency
  found, _ = Gem::SpecFetcher.fetcher.spec_for_dependency dependency

  return if found.empty?

  spec, source = found.first

  download spec, source.uri.to_s
end

#fetch_path(path, mtime = nil, head = false) ⇒ Object 



57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/rubygems/test_utilities.rb', line 57

def fetch_path path, mtime = nil, head = false
  data = find_data(path)

  if data.respond_to?(:call) then
    data.call
  else
    if path.to_s =~ /gz$/ and not data.nil? and not data.empty? then
      data = Gem.gunzip data
    end

    data
  end
end

#fetch_size(path) ⇒ Object

Raises:

  • (ArgumentError) 


122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/rubygems/test_utilities.rb', line 122

def fetch_size(path)
  path = path.to_s
  @paths << path

  raise ArgumentError, 'need full URI' unless path =~ %r'^http://'

  unless @data.key? path then
    raise Gem::RemoteFetcher::FetchError.new("no data for #{path}", path)
  end

  data = @data[path]

  data.respond_to?(:call) ? data.call : data.length
end

#find_data(path) ⇒ Object

Raises:

  • (ArgumentError) 


40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/rubygems/test_utilities.rb', line 40

def find_data(path)
  if URI === path and "URI::#{path.scheme.upcase}" != path.class.name then
    raise ArgumentError,
      "mismatch for scheme #{path.scheme} and class #{path.class}"
  end

  path = path.to_s
  @paths << path
  raise ArgumentError, 'need full URI' unless path =~ %r'^https?://'

  unless @data.key? path then
    raise Gem::RemoteFetcher::FetchError.new("no data for #{path}", path)
  end

  @data[path]
end

#open_uri_or_path(path) ⇒ Object

Thanks, FakeWeb!



81
82
83
84
85
86
87
88
89
 
# File 'lib/rubygems/test_utilities.rb', line 81

def open_uri_or_path(path)
  data = find_data(path)
  body, code, msg = data

  response = Net::HTTPResponse.send(:response_class, code.to_s).new("1.0", code.to_s, msg)
  response.instance_variable_set(:@body, body)
  response.instance_variable_set(:@read, true)
  response
end

#pretty_print(q) ⇒ Object

:nodoc:



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/rubygems/test_utilities.rb', line 104

def pretty_print q # :nodoc:
  q.group 2, '[FakeFetcher', ']' do
    q.breakable
    q.text 'URIs:'

    q.breakable
    q.pp @data.keys

    unless @api_endpoints.empty? then
      q.breakable
      q.text 'API endpoints:'

      q.breakable
      q.pp @api_endpoints.keys
    end
  end
end

#request(uri, request_class, last_modified = nil) {|@last_request| ... } ⇒ Object

Yields:



91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/rubygems/test_utilities.rb', line 91

def request(uri, request_class, last_modified = nil)
  data = find_data(uri)
  body, code, msg = data

  @last_request = request_class.new uri.request_uri
  yield @last_request if block_given?

  response = Net::HTTPResponse.send(:response_class, code.to_s).new("1.0", code.to_s, msg)
  response.instance_variable_set(:@body, body)
  response.instance_variable_set(:@read, true)
  response
end