Class: Inspec::DependencySet

Inherits:
Object
  • Object
show all
Defined in:
lib/inspec/dependencies/dependency_set.rb

Overview

A DependencySet manages a list of dependencies for a profile.

Currently this class is a thin wrapper interface to coordinate the VendorIndex and the Resolver.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(cwd, vendor_path, dep_list, backend) ⇒ dependencies

initialize

Parameters:

  • cwd (String) —

    current working directory for relative path includes

  • vendor_path (String) —

    path which contains vendored dependencies



61
62
63
64
65
66
 
# File 'lib/inspec/dependencies/dependency_set.rb', line 61

def initialize(cwd, vendor_path, dep_list, backend)
  @cwd = cwd
  @vendor_path = vendor_path
  @dep_list = dep_list
  @backend = backend
end

Instance Attribute Details

#dep_list=(value) ⇒ Object (writeonly)

Sets the attribute dep_list

Parameters:

  • value —

    the value to set the attribute dep_list to.



55
56
57
 
# File 'lib/inspec/dependencies/dependency_set.rb', line 55

def dep_list=(value)
  @dep_list = value
end

#vendor_path ⇒ Object (readonly)

Returns the value of attribute vendor_path.



54
55
56
 
# File 'lib/inspec/dependencies/dependency_set.rb', line 54

def vendor_path
  @vendor_path
end

Class Method Details

.flatten_dep_tree(dep_tree) ⇒ Object

This is experimental code to test the working of the dependency loader - perform a proper dependency related search in the future.

Flatten tree because that is all we know how to deal with for right now. Last dep seen for a given name wins right now.



45
46
47
48
49
50
51
52
 
# File 'lib/inspec/dependencies/dependency_set.rb', line 45

def self.flatten_dep_tree(dep_tree)
  dep_list = {}
  dep_tree.each do |d|
    dep_list[d.name] = d
    dep_list.merge!(flatten_dep_tree(d.dependencies))
  end
  dep_list
end

.from_array(dependencies, cwd, vendor_path, backend) ⇒ Object 



31
32
33
34
35
36
37
 
# File 'lib/inspec/dependencies/dependency_set.rb', line 31

def self.from_array(dependencies, cwd, vendor_path, backend)
  dep_list = {}
  dependencies.each do |d|
    dep_list[d.name] = d
  end
  new(cwd, vendor_path, dep_list, backend)
end

.from_lockfile(lockfile, cwd, vendor_path, backend) ⇒ Object

Return a dependency set given a lockfile.

Parameters:

  • lockfile (Inspec::Lockfile) —

    A lockfile to generate the dependency set from

  • cwd (String) —

    Current working directory for relative path includes

  • vendor_path (String) —

    Path to the vendor directory



21
22
23
24
25
26
27
28
29
 
# File 'lib/inspec/dependencies/dependency_set.rb', line 21

def self.from_lockfile(lockfile, cwd, vendor_path, backend)
  vendor_index = VendorIndex.new(vendor_path)
  dep_tree = lockfile.deps.map do |dep|
    Inspec::Requirement.from_lock_entry(dep, cwd, vendor_index, backend)
  end

  dep_list = flatten_dep_tree(dep_tree)
  new(cwd, vendor_path, dep_list, backend)
end

Instance Method Details

#each ⇒ Object 



68
69
70
71
72
 
# File 'lib/inspec/dependencies/dependency_set.rb', line 68

def each
  @dep_list.each do |_k, v|
    yield v.profile
  end
end

#list ⇒ Object 



74
75
76
 
# File 'lib/inspec/dependencies/dependency_set.rb', line 74

def list
  @dep_list || {}
end

#to_array ⇒ Object 



78
79
80
81
82
83
 
# File 'lib/inspec/dependencies/dependency_set.rb', line 78

def to_array
  return [] if @dep_list.nil?
  @dep_list.map do |_k, v|
    v.to_hash
  end.compact
end

#vendor(dependencies) ⇒ nil

  1. Get dependencies, pull things to a local cache if necessary

  2. Resolve dependencies

Parameters:

  • dependencies (Gem::Dependency) —

    list of dependencies

Returns:

  • (nil) 


92
93
94
95
96
 
# File 'lib/inspec/dependencies/dependency_set.rb', line 92

def vendor(dependencies)
  return nil if dependencies.nil? || dependencies.empty?
  @vendor_index ||= VendorIndex.new(@vendor_path)
  @dep_list = Resolver.resolve(dependencies, @vendor_index, @cwd, @backend)
end