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

use nested array if multiple response is needed

@fetcher.data['http://gems.example.com/sequence'] = [['Success', 200, 'OK'], ['Failed', 401, 'Unauthorized']]

@fetcher.fetch_path('http://gems.example.com/sequence') # => ['Success', 200, 'OK']
@fetcher.fetch_path('http://gems.example.com/sequence') # => ['Failed', 401, 'Unauthorized']

# 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

#initializeFakeFetcher

Returns a new instance of FakeFetcher.


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

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

Instance Attribute Details

#dataObject (readonly)

Returns the value of attribute data


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

def data
  @data
end

#last_requestObject (readonly)

Returns the value of attribute last_request


33
34
35
# File 'lib/rubygems/test_utilities.rb', line 33

def last_request
  @last_request
end

#pathsObject

Returns the value of attribute paths


34
35
36
# File 'lib/rubygems/test_utilities.rb', line 34

def paths
  @paths
end

Instance Method Details

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


76
77
78
79
80
81
82
83
# File 'lib/rubygems/test_utilities.rb', line 76

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


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

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

  path = File.join path, name

  if source_uri =~ /^http/
    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


155
156
157
158
159
160
161
162
163
# File 'lib/rubygems/test_utilities.rb', line 155

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


63
64
65
66
67
68
69
70
71
72
73
74
# File 'lib/rubygems/test_utilities.rb', line 63

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

  if data.respond_to?(:call)
    data.call
  else
    if path.to_s.end_with?(".gz") and not data.nil? and not data.empty?
      data = Gem::Util.gunzip data
    end
    data
  end
end

#fetch_size(path) ⇒ Object

Raises:

  • (ArgumentError)

119
120
121
122
123
124
125
126
127
128
129
130
131
132
# File 'lib/rubygems/test_utilities.rb', line 119

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

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

  unless @data.key? path
    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, nargs = 3) ⇒ Object

Raises:

  • (ArgumentError)

41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
# File 'lib/rubygems/test_utilities.rb', line 41

def find_data(path, nargs = 3)
  return Gem.read_binary path.path if URI === path and 'file' == path.scheme

  if URI === path and "URI::#{path.scheme.upcase}" != path.class.name
    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.start_with?("https://", "http://")

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

  data = @data[path]

  data.flatten! and return data.shift(nargs) if data.respond_to?(:flatten!)
  data
end

#open_uri_or_path(path) ⇒ Object

Thanks, FakeWeb!


86
87
88
89
90
91
92
93
94
# File 'lib/rubygems/test_utilities.rb', line 86

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:


109
110
111
112
113
114
115
116
117
# File 'lib/rubygems/test_utilities.rb', line 109

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

    q.breakable
    q.pp @data.keys
  end
end

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

Yields:


96
97
98
99
100
101
102
103
104
105
106
107
# File 'lib/rubygems/test_utilities.rb', line 96

def request(uri, request_class, last_modified = nil)
  data = find_data(uri)
  body, code, msg = (data.respond_to?(:call) ? data.call : 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