Class: PuppetfileResolver::Puppetfile::Document

Inherits:
Object
  • Object
show all
Defined in:
lib/puppetfile-resolver/puppetfile/document.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(puppetfile_content) ⇒ Document

Returns a new instance of Document.



15
16
17
18
19
 
# File 'lib/puppetfile-resolver/puppetfile/document.rb', line 15

def initialize(puppetfile_content)
  @content = puppetfile_content
  @modules = []
  @validation_errors = nil
end

Instance Attribute Details

#content ⇒ Object

Returns the value of attribute content.



12
13
14
 
# File 'lib/puppetfile-resolver/puppetfile/document.rb', line 12

def content
  @content
end

#forge_uri ⇒ Object

Returns the value of attribute forge_uri.



12
13
14
 
# File 'lib/puppetfile-resolver/puppetfile/document.rb', line 12

def forge_uri
  @forge_uri
end

#modules ⇒ Object (readonly)

Returns the value of attribute modules.



13
14
15
 
# File 'lib/puppetfile-resolver/puppetfile/document.rb', line 13

def modules
  @modules
end

Instance Method Details

#add_module(puppet_module) ⇒ Object 



29
30
31
 
# File 'lib/puppetfile-resolver/puppetfile/document.rb', line 29

def add_module(puppet_module)
  @modules << puppet_module
end

#clear_modules ⇒ Object 



25
26
27
 
# File 'lib/puppetfile-resolver/puppetfile/document.rb', line 25

def clear_modules
  @modules = []
end

#resolution_validation_errors(resolution_result) ⇒ Object 



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/puppetfile-resolver/puppetfile/document.rb', line 65

def resolution_validation_errors(resolution_result)
  raise 'Validation can not be performed an an invalid document' unless valid?
  @validation_errors = []

  # Find modules which said latest but resolved to a specific version
  modules.each do |mod|
    next unless mod.version == :latest
    resolved_module = resolution_result.specifications[mod.name]
    next if resolved_module.nil? || resolved_module.is_a?(PuppetfileResolver::Models::MissingModuleSpecification)
    next if mod.resolver_flags.include?(PuppetfileResolver::Puppetfile::DISABLE_LATEST_VALIDATION_FLAG)
    @validation_errors << DocumentLatestVersionError.new(
      "Latest version of #{mod.name} is #{resolved_module.version}",
      mod,
      resolved_module
    )
  end

  # Find modules which could not be found (in the forge etc.)
  modules.each do |mod|
    resolved_module = resolution_result.specifications[mod.name]
    next unless resolved_module.is_a?(PuppetfileResolver::Models::MissingModuleSpecification)

    @validation_errors << DocumentMissingModuleError.new(
      "Could not find module #{mod.title}",
      mod,
      resolved_module
    )
  end

  # Find modules with missing dependencies
  puppetfile_module_names = modules.map(&:name)
  modules.each do |mod|
    resolved_module = resolution_result.specifications[mod.name]
    vertex = resolution_result.dependency_graph.vertex_named(mod.name)
    next if vertex.nil? || vertex.payload.nil?
    missing_successors = vertex.recursive_successors.select do |successor_vertex|
      next if successor_vertex.nil?
      next unless successor_vertex.payload.is_a?(PuppetfileResolver::Models::ModuleSpecification)
      !puppetfile_module_names.include?(successor_vertex.payload.name)
    end

    next if missing_successors.empty?
    missing_specs = missing_successors.map(&:payload)
    missing_names = missing_specs.map { |spec| "#{spec.name}-#{spec.version}" }.join(', ')
    plural = missing_successors.count == 1 ? '' : 's'
    @validation_errors << DocumentMissingDependenciesError.new(
      "Module #{mod.title} is missing dependent module#{plural}: #{missing_names}",
      mod,
      resolved_module,
      missing_specs
    )
  end

  @validation_errors
end

#to_s ⇒ Object 



21
22
23
 
# File 'lib/puppetfile-resolver/puppetfile/document.rb', line 21

def to_s
  "PuppetfileResolver::Puppetfile::Document\n#{@content}"
end

#valid? ⇒ Boolean

Returns:

  • (Boolean) 


33
34
35
 
# File 'lib/puppetfile-resolver/puppetfile/document.rb', line 33

def valid?
  validation_errors.empty?
end

#validation_errors ⇒ Object 



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/puppetfile-resolver/puppetfile/document.rb', line 37

def validation_errors
  return @validation_errors unless @validation_errors.nil?

  @validation_errors = []

  # Check for invalid modules
  modules.each do |mod|
    next unless mod.is_a?(PuppetfileResolver::Puppetfile::InvalidModule)
    @validation_errors << DocumentInvalidModuleError.new(mod.reason, mod)
  end

  # Check for duplicate module definitions
  dupes = modules
          .group_by { |mod| mod.name }
          .select { |_, v| v.size > 1 }
          .map(&:first)
  dupes.each do |dupe_module_name|
    duplicates = modules.select { |mod| mod.name == dupe_module_name }
    @validation_errors << DocumentDuplicateModuleError.new(
      "Duplicate module definition for '#{dupe_module_name}'",
      duplicates[0],
      duplicates.slice(1..-1)
    )
  end

  @validation_errors
end