Class: Uniword::Assembly::AssemblyManifest

Inherits:
Object
  • Object
show all
Defined in:
lib/uniword/assembly/assembly_manifest.rb

Overview

Parses and validates assembly manifest YAML files.

Responsibility: Parse assembly.yml configuration files. Single Responsibility: Only handles manifest parsing and validation.

The AssemblyManifest:

  • Loads YAML assembly configuration

  • Validates manifest structure

  • Provides default values for optional settings

  • Exposes configuration through a clean interface

Examples:

Basic manifest loading

manifest = AssemblyManifest.new('assembly.yml')
puts manifest.output_path
puts manifest.template_name

Accessing variables

manifest = AssemblyManifest.new('assembly.yml')
vars = manifest.variables
puts vars['title']

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(manifest_path, override_variables: {}) ⇒ AssemblyManifest

Initialize manifest from YAML file.

Examples:

Load manifest

manifest = AssemblyManifest.new('assembly.yml')

With variable overrides

manifest = AssemblyManifest.new('assembly.yml',
  override_variables: { version: '2.0' }
)

Parameters:

  • manifest_path (String) —

    Path to assembly.yml file

  • override_variables (Hash) (defaults to: {}) —

    Variables to override manifest values



55
56
57
58
59
60
61
62
63
 
# File 'lib/uniword/assembly/assembly_manifest.rb', line 55

def initialize(manifest_path, override_variables: {})
  @manifest_path = manifest_path
  @raw_data = load_yaml(manifest_path)

  validate_structure!

  parse_manifest
  apply_variable_overrides(override_variables)
end

Instance Attribute Details

#options ⇒ Hash (readonly)

Returns Additional options.

Returns:

  • (Hash) —

    Additional options



41
42
43
 
# File 'lib/uniword/assembly/assembly_manifest.rb', line 41

def options
  @options
end

#output_path ⇒ String (readonly)

Returns Path to output file.

Returns:

  • (String) —

    Path to output file



29
30
31
 
# File 'lib/uniword/assembly/assembly_manifest.rb', line 29

def output_path
  @output_path
end

#sections ⇒ Array<Hash> (readonly)

Returns Section configurations.

Returns:

  • (Array<Hash>) —

    Section configurations



38
39
40
 
# File 'lib/uniword/assembly/assembly_manifest.rb', line 38

def sections
  @sections
end

#template_name ⇒ String? (readonly)

Returns Template name.

Returns:

  • (String, nil) —

    Template name



32
33
34
 
# File 'lib/uniword/assembly/assembly_manifest.rb', line 32

def template_name
  @template_name
end

#variables ⇒ Hash (readonly)

Returns Template variables.

Returns:

  • (Hash) —

    Template variables



35
36
37
 
# File 'lib/uniword/assembly/assembly_manifest.rb', line 35

def variables
  @variables
end

Instance Method Details

#section_list ⇒ Array<Hash>

Get section configurations.

Returns:

  • (Array<Hash>) —

    List of section definitions



75
76
77
 
# File 'lib/uniword/assembly/assembly_manifest.rb', line 75

def section_list
  @sections.dup
end

#template? ⇒ Boolean

Check if manifest has a template.

Returns:

  • (Boolean) —

    True if template is specified



68
69
70
 
# File 'lib/uniword/assembly/assembly_manifest.rb', line 68

def template?
  !@template_name.nil?
end

#variable(key) ⇒ Object?

Get variable value by key.

Parameters:

  • key (String, Symbol) —

    Variable key

Returns:

  • (Object, nil) —

    Variable value



83
84
85
 
# File 'lib/uniword/assembly/assembly_manifest.rb', line 83

def variable(key)
  @variables[key.to_s]
end

#variable?(key) ⇒ Boolean

Check if variable exists.

Parameters:

  • key (String, Symbol) —

    Variable key

Returns:

  • (Boolean) —

    True if variable is defined



91
92
93
 
# File 'lib/uniword/assembly/assembly_manifest.rb', line 91

def variable?(key)
  @variables.key?(key.to_s)
end