Module: Ibex::GenerationManifest

Defined in:
lib/ibex/generation_manifest.rb,
sig/ibex/generation_manifest.rbs

Overview

Deterministic description of one published parser generation. rubocop:disable Metrics/ModuleLength -- manifest schema validation is kept in one auditable unit.

Constant Summary collapse

SCHEMA_VERSION =

RBS:

  • type json_value = String | Integer | Float | bool | nil | Array[json_value] | Hash[String, json_value]

Returns:

  • (Integer) 
1
IDENTIFIER =

Signature:

  • Integer

Returns:

  • (String) 
"generation"
ROOT_KEYS =

Signature:

  • String

Returns:

  • (Array[String]) 
%w[ibex_manifest schema_version input options artifacts].freeze
INPUT_KEYS =

Signature:

  • Array[String]

Returns:

  • (Array[String]) 
%w[root sha256 files].freeze
FILE_KEYS =

Signature:

  • Array[String]

Returns:

  • (Array[String]) 
%w[path sha256 bytesize].freeze
ARTIFACT_KEYS =

Signature:

  • Array[String]

Returns:

  • (Array[String]) 
%w[kind path sha256 bytesize].freeze

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.render(artifacts, source_records:, options:) ⇒ Object

RBS:

  • (ArtifactSet artifacts, source_records: Array[GenerationInput], options: Hash[String, Object?]) -> String



24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/ibex/generation_manifest.rb', line 24

def render(artifacts, source_records:, options:)
  files = source_records.map(&:to_h)
  document = {
    "ibex_manifest" => IDENTIFIER,
    "schema_version" => SCHEMA_VERSION,
    "input" => {
      "root" => files.fetch(0).fetch("path"),
      "sha256" => input_digest(files),
      "files" => files
    },
    "options" => sorted_hash(options),
    "artifacts" => artifacts.map { |artifact| artifact_entry(artifact) }
  }
  "#{JSON.pretty_generate(document)}\n"
end

.validate(source, verify_artifacts: true) ⇒ Object

Validate the manifest shape and, by default, every published artifact digest.

RBS:

  • (String source, ?verify_artifacts: bool) -> Hash[String, json_value]



42
43
44
45
46
47
48
49
50
51
 
# File 'lib/ibex/generation_manifest.rb', line 42

def validate(source, verify_artifacts: true)
  document = JSON.parse(source) #: Object?
  validate_document(document)
  document_hash = document #: Hash[String, json_value]
  artifacts = document_hash.fetch("artifacts") #: Array[Object?]
  verify_entries(artifacts) if verify_artifacts
  document_hash
rescue JSON::ParserError, KeyError, TypeError, ArgumentError => e
  raise Ibex::Error, "(manifest):1:1: invalid generation manifest: #{e.message}"
end

.validate_file(path, verify_artifacts: true) ⇒ Object

RBS:

  • (String path, ?verify_artifacts: bool) -> Hash[String, json_value]



54
55
56
57
58
 
# File 'lib/ibex/generation_manifest.rb', line 54

def validate_file(path, verify_artifacts: true)
  validate(File.binread(path), verify_artifacts: verify_artifacts)
rescue SystemCallError, ArgumentError => e
  raise Ibex::Error, "#{path}:1:1: cannot read generation manifest: #{e.message}"
end

Instance Method Details

#self?.artifact_entry ⇒ Hash[String, json_value]

RBS:

  • (Artifact artifact) -> Hash[String, json_value]

Parameters:

Returns:

  • (Hash[String, json_value]) 


32
 
# File 'sig/ibex/generation_manifest.rbs', line 32

def self?.artifact_entry: (Artifact artifact) -> Hash[String, json_value]

#self?.exact_keys! ⇒ void

This method returns an undefined value.

RBS:

  • (Hash[Object?, Object?] value, Array[String] expected, String label) -> void

Parameters:

  • value (Hash[Object?, Object?])
  • expected (Array[String])
  • label (String) 


65
 
# File 'sig/ibex/generation_manifest.rbs', line 65

def self?.exact_keys!: (Hash[Object?, Object?] value, Array[String] expected, String label) -> void

#self?.input_digest ⇒ String

RBS:

  • (Array[Hash[String, json_value]] files) -> String

Parameters:

  • files (Array[Hash[String, json_value]])

Returns:

  • (String) 


35
 
# File 'sig/ibex/generation_manifest.rbs', line 35

def self?.input_digest: (Array[Hash[String, json_value]] files) -> String

#self?.render ⇒ String

RBS:

  • (ArtifactSet artifacts, source_records: Array[GenerationInput], options: Hash[String, Object?]) -> String

Parameters:

Returns:

  • (String) 


22
 
# File 'sig/ibex/generation_manifest.rbs', line 22

def self?.render: (ArtifactSet artifacts, source_records: Array[GenerationInput], options: Hash[String, Object?]) -> String

#self?.sorted_hash ⇒ Hash[String, Object?]

RBS:

  • (Hash[String, Object?] value) -> Hash[String, Object?]

Parameters:

  • value (Hash[String, Object?])

Returns:

  • (Hash[String, Object?]) 


38
 
# File 'sig/ibex/generation_manifest.rbs', line 38

def self?.sorted_hash: (Hash[String, Object?] value) -> Hash[String, Object?]

#self?.validate ⇒ Hash[String, json_value]

Validate the manifest shape and, by default, every published artifact digest.

RBS:

  • (String source, ?verify_artifacts: bool) -> Hash[String, json_value]

Parameters:

  • source (String)
  • verify_artifacts: (Boolean)

Returns:

  • (Hash[String, json_value]) 


26
 
# File 'sig/ibex/generation_manifest.rbs', line 26

def self?.validate: (String source, ?verify_artifacts: bool) -> Hash[String, json_value]

#self?.validate_digest ⇒ void

This method returns an undefined value.

RBS:

  • (Object? digest, String label) -> void

Parameters:

  • digest (Object, nil)
  • label (String) 


62
 
# File 'sig/ibex/generation_manifest.rbs', line 62

def self?.validate_digest: (Object? digest, String label) -> void

#self?.validate_document ⇒ void

This method returns an undefined value.

RBS:

  • (Object? document) -> void

Parameters:

  • document (Object, nil) 


41
 
# File 'sig/ibex/generation_manifest.rbs', line 41

def self?.validate_document: (Object? document) -> void

#self?.validate_entries ⇒ void

This method returns an undefined value.

RBS:

  • (Array[Object?] entries, String label, ?require_kind: bool) -> void

Parameters:

  • entries (Array[Object?])
  • label (String)
  • require_kind: (Boolean) 


50
 
# File 'sig/ibex/generation_manifest.rbs', line 50

def self?.validate_entries: (Array[Object?] entries, String label, ?require_kind: bool) -> void

#self?.validate_entry ⇒ void

This method returns an undefined value.

RBS:

  • (Object? entry, String label, bool require_kind) -> void

Parameters:

  • entry (Object, nil)
  • label (String)
  • require_kind (Boolean) 


53
 
# File 'sig/ibex/generation_manifest.rbs', line 53

def self?.validate_entry: (Object? entry, String label, bool require_kind) -> void

#self?.validate_file ⇒ Hash[String, json_value]

RBS:

  • (String path, ?verify_artifacts: bool) -> Hash[String, json_value]

Parameters:

  • path (String)
  • verify_artifacts: (Boolean)

Returns:

  • (Hash[String, json_value]) 


29
 
# File 'sig/ibex/generation_manifest.rbs', line 29

def self?.validate_file: (String path, ?verify_artifacts: bool) -> Hash[String, json_value]

#self?.validate_identity ⇒ void

This method returns an undefined value.

RBS:

  • (Hash[Object?, Object?] document) -> void

Parameters:

  • document (Hash[Object?, Object?]) 


44
 
# File 'sig/ibex/generation_manifest.rbs', line 44

def self?.validate_identity: (Hash[Object?, Object?] document) -> void

#self?.validate_input ⇒ void

This method returns an undefined value.

RBS:

  • (Object? input) -> void

Parameters:

  • input (Object, nil) 


47
 
# File 'sig/ibex/generation_manifest.rbs', line 47

def self?.validate_input: (Object? input) -> void

#self?.validate_kind ⇒ void

This method returns an undefined value.

RBS:

  • (Object? kind, String label) -> void

Parameters:

  • kind (Object, nil)
  • label (String) 


59
 
# File 'sig/ibex/generation_manifest.rbs', line 59

def self?.validate_kind: (Object? kind, String label) -> void

#self?.validate_path ⇒ void

This method returns an undefined value.

RBS:

  • (Object? path, String label) -> void

Parameters:

  • path (Object, nil)
  • label (String) 


56
 
# File 'sig/ibex/generation_manifest.rbs', line 56

def self?.validate_path: (Object? path, String label) -> void

#self?.verify_entries ⇒ void

This method returns an undefined value.

RBS:

  • (Array[Object?] entries) -> void

Parameters:

  • entries (Array[Object?]) 


68
 
# File 'sig/ibex/generation_manifest.rbs', line 68

def self?.verify_entries: (Array[Object?] entries) -> void