Class: Inspec::Plugins::Fetcher

Inherits:
PluginRegistry::Plugin show all
Defined in:
lib/inspec/plugins/fetcher.rb

Direct Known Subclasses

RelFetcher

Instance Attribute Summary

Attributes inherited from PluginRegistry::Plugin

#parent, #target

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from PluginRegistry::Plugin

name, priority, resolve, resolve_next

Class Method Details

.plugin_registry ⇒ Object 



10
11
12
 
# File 'lib/inspec/plugins/fetcher.rb', line 10

def self.plugin_registry
  Inspec::Fetcher
end

Instance Method Details

#files ⇒ Array[String]

Provide a list of files that are available to this fetcher.

Returns:

  • (Array[String]) —

    A list of filenames



17
18
19
 
# File 'lib/inspec/plugins/fetcher.rb', line 17

def files
  fail "Fetcher #{self} does not implement `files()`. This is required."
end

#read(_file) ⇒ String

Read a file using this fetcher. The name must correspond to a file available to this fetcher. Use #files to retrieve the list of files.

Parameters:

  • _file (String) —

    The filename you are interested in

Returns:

  • (String) —

    The file’s contents



27
28
29
 
# File 'lib/inspec/plugins/fetcher.rb', line 27

def read(_file)
  fail "Fetcher #{self} does not implement `read(...)`. This is required."
end

#relative_target ⇒ Object 



31
32
33
 
# File 'lib/inspec/plugins/fetcher.rb', line 31

def relative_target
  RelFetcher.new(self)
end