Class: Metanorma::Mirror::Rewriter

Inherits:
Object
  • Object
show all
Defined in:
lib/metanorma/mirror/rewriter.rb

Overview

Rewrites a mirror Model graph with configurable type-skipping and per-type customization. Despite living in the reverse-conversion namespace, this class produces a Model graph (not Metanorma XML) — the output is a fully model-driven representation that can be serialized via Model#to_h or embedded into HTML output by Output::Formats::InlineFormat (which renders the source document through the classic Metanorma::Html renderer).

Instance API:

Rewriter.new(skip: Set.new(%w[review footnotes]))
rewriter.skip("my_type")
rewriter.register("my_type") { |n, r| ... }

Class API (seeds defaults copied into each new instance):

Rewriter.skip("review")        # adds to defaults
Rewriter.register("my_type") { |n, r| ... }

Two Rewriter instances do not share state. Class-level mutation only affects instances created afterwards (the default snapshot is copied at new time).

Constant Summary collapse

DEFAULT_SKIPPED_TYPES = 
%w[review footnotes].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(skip: nil, builders: nil) ⇒ Rewriter

Returns a new instance of Rewriter.



54
55
56
57
 
# File 'lib/metanorma/mirror/rewriter.rb', line 54

def initialize(skip: nil, builders: nil)
  @skipped_types = skip || self.class.default_skipped_types.dup
  @builders = builders || self.class.default_builders.dup
end

Instance Attribute Details

#builders ⇒ Object (readonly)

Returns the value of attribute builders.



59
60
61
 
# File 'lib/metanorma/mirror/rewriter.rb', line 59

def builders
  @builders
end

#skipped_types ⇒ Object (readonly)

Returns the value of attribute skipped_types.



59
60
61
 
# File 'lib/metanorma/mirror/rewriter.rb', line 59

def skipped_types
  @skipped_types
end

Class Method Details

.default_builders ⇒ Object

Default builder map, copied into each new instance.



35
36
37
 
# File 'lib/metanorma/mirror/rewriter.rb', line 35

def default_builders
  @default_builders ||= {}
end

.default_skipped_types ⇒ Object

Default skip set, copied into each new instance.



30
31
32
 
# File 'lib/metanorma/mirror/rewriter.rb', line 30

def default_skipped_types
  @default_skipped_types ||= Set.new(DEFAULT_SKIPPED_TYPES)
end

.register(type, &block) ⇒ Object

Register a builder for a type at the default level. Affects instances created afterwards; existing instances are unchanged.



48
49
50
51
 
# File 'lib/metanorma/mirror/rewriter.rb', line 48

def register(type, &block)
  default_builders[type] = block
  self
end

.skip(type) ⇒ Object

Add a type to the default skip set. Affects instances created afterwards; existing instances are unchanged.



41
42
43
44
 
# File 'lib/metanorma/mirror/rewriter.rb', line 41

def skip(type)
  default_skipped_types << type
  self
end

Instance Method Details

#build(node) ⇒ Object 



79
80
81
82
83
84
85
 
# File 'lib/metanorma/mirror/rewriter.rb', line 79

def build(node)
  return nil unless node

  return rewrite_string(node) if node.is_a?(String)

  node.accept_rewriter(self)
end

#build_children(content) ⇒ Object 



118
119
120
 
# File 'lib/metanorma/mirror/rewriter.rb', line 118

def build_children(content)
  Array(content).filter_map { |child| build(child) }
end

#call(mirror_node) ⇒ Object 



75
76
77
 
# File 'lib/metanorma/mirror/rewriter.rb', line 75

def call(mirror_node)
  build(mirror_node)
end

#register(type, &block) ⇒ Object 



70
71
72
73
 
# File 'lib/metanorma/mirror/rewriter.rb', line 70

def register(type, &block)
  builders[type] = block
  self
end

#rewrite_container(node) ⇒ Object 



87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/metanorma/mirror/rewriter.rb', line 87

def rewrite_container(node)
  return nil if skipped?(node.type)

  builder = builders[node.type]
  return builder.call(node, self) if builder

  Model::Container.new(
    type: node.type,
    attrs: node.attrs,
    content: build_children(node.content),
  )
end

#rewrite_leaf(node) ⇒ Object 



100
101
102
103
104
 
# File 'lib/metanorma/mirror/rewriter.rb', line 100

def rewrite_leaf(node)
  return nil if skipped?(node.type)

  Model::Leaf.new(type: node.type, attrs: node.attrs)
end

#rewrite_soft_break(_node) ⇒ Object 



110
111
112
 
# File 'lib/metanorma/mirror/rewriter.rb', line 110

def rewrite_soft_break(_node)
  Model::SoftBreak.new
end

#rewrite_string(string) ⇒ Object 



114
115
116
 
# File 'lib/metanorma/mirror/rewriter.rb', line 114

def rewrite_string(string)
  Model::Text.new(text: string)
end

#rewrite_text(node) ⇒ Object 



106
107
108
 
# File 'lib/metanorma/mirror/rewriter.rb', line 106

def rewrite_text(node)
  Model::Text.new(text: node.text, marks: node.marks)
end

#skip(type) ⇒ Object 



61
62
63
64
 
# File 'lib/metanorma/mirror/rewriter.rb', line 61

def skip(type)
  skipped_types << type
  self
end

#skipped?(type) ⇒ Boolean

Returns:

  • (Boolean) 


66
67
68
 
# File 'lib/metanorma/mirror/rewriter.rb', line 66

def skipped?(type)
  skipped_types.include?(type)
end