Class: Metanorma::Generic::Converter

Inherits:
Standoc::Converter
  • Object
show all
Defined in:
lib/metanorma/generic/log.rb,
lib/metanorma/generic/front.rb,
lib/metanorma/generic/converter.rb

Constant Summary collapse

GENERIC_LOG_MESSAGES = 
{
  # rubocop:disable Naming/VariableNumber
  "GENERIC_1": { category: "Document Attributes",
                 error: "%s is not a legal document type: reverting to '%s'",
                 severity: 2 },
  "GENERIC_2": { category: "Document Attributes",
                 error: "%s is not a recognised status",
                 severity: 2 },
  "GENERIC_3": { category: "Document Attributes",
                 error: "%s is not a recognised committee",
                 severity: 2 },
}.freeze
EXT_STRUCT = 
%w(_output _attribute _list).freeze

Instance Method Summary collapse

Instance Method Details

#baselocation(loc) ⇒ Object 



14
15
16
17
 
# File 'lib/metanorma/generic/converter.rb', line 14

def baselocation(loc)
  loc.nil? and return nil
  loc
end

#bibdata_hash(xmldoc) ⇒ Object 



171
172
173
174
175
 
# File 'lib/metanorma/generic/converter.rb', line 171

def bibdata_hash(xmldoc)
  b = xmldoc.at("//bibdata") || xmldoc.at("//xmlns:bibdata")
  BibdataConfig.from_xml("<metanorma>#{b.to_xml}</metanorma>")
    .bibdata.to_hash
end

#bibdata_validate(doc) ⇒ Object 



106
107
108
109
 
# File 'lib/metanorma/generic/converter.rb', line 106

def bibdata_validate(doc)
  stage_validate(doc)
  committee_validate(doc)
end

#blank_method(*args) ⇒ Object Also known as: style, title_validate 



136
 
# File 'lib/metanorma/generic/converter.rb', line 136

def blank_method(*args); end

#boilerplate_file(xmldoc) ⇒ Object 



177
178
179
180
181
182
183
 
# File 'lib/metanorma/generic/converter.rb', line 177

def boilerplate_file(xmldoc)
  f = configuration.boilerplate
  f.nil? and return super
  f.is_a? String and return baselocation(f)
  f.is_a? Hash and f[@lang] and return baselocation(f[@lang])
  super
end

#boilerplate_isodoc(xmldoc) ⇒ Object 



161
162
163
164
165
166
167
168
169
 
# File 'lib/metanorma/generic/converter.rb', line 161

def boilerplate_isodoc(xmldoc)
  conv = super or return nil
  Metanorma::Generic::Configuration::CONFIG_ATTRS.each do |a|
    conv.meta.set(a, configuration.send(a))
  end
  # conv.meta.set(:bibdata, bibdata_hash(xmldoc))
  @isodoc = conv
  @isodoc
end

#committee_validate(xmldoc) ⇒ Object 



119
120
121
122
123
124
125
126
127
 
# File 'lib/metanorma/generic/converter.rb', line 119

def committee_validate(xmldoc)
  committees = Array(configuration&.committees) || return
  committees.empty? and return
  xmldoc.xpath("//bibdata/contributor[role/description = 'committee']/" \
      "organization/subdivision/name").each do |c|
    committees.include? c.text or
      @log.add("GENERIC_3", nil, params: [c.text])
  end
end

#configuration ⇒ Object 



157
158
159
 
# File 'lib/metanorma/generic/converter.rb', line 157

def configuration
  Metanorma::Generic.configuration
end

#content_validate(doc) ⇒ Object 



101
102
103
104
 
# File 'lib/metanorma/generic/converter.rb', line 101

def content_validate(doc)
  super
  bibdata_validate(doc.root)
end

#default_publisher ⇒ Object 



4
5
6
 
# File 'lib/metanorma/generic/front.rb', line 4

def default_publisher
  configuration.organization_name_long
end

#doc_converter(node) ⇒ Object 



153
154
155
 
# File 'lib/metanorma/generic/converter.rb', line 153

def doc_converter(node)
  IsoDoc::Generic::WordConvert.new(doc_extract_attributes(node))
end

#docidentifier_cleanup(xmldoc) ⇒ Object 



19
20
21
22
23
24
 
# File 'lib/metanorma/generic/converter.rb', line 19

def docidentifier_cleanup(xmldoc)
  docid = xmldoc.at("//bibdata/docidentifier") or return
  docid.text.empty? or return
  id = docidentifier_from_template(xmldoc) or return
  (id.empty? and docid.remove) or docid.children = id
end

#docidentifier_from_template(xmldoc) ⇒ Object 



26
27
28
29
30
31
 
# File 'lib/metanorma/generic/converter.rb', line 26

def docidentifier_from_template(xmldoc)
  b = boilerplate_isodoc(xmldoc) or return
  template = configuration.docid_template ||
    "{{ agency }} {{ docnumeric }}"
  b.populate_template(template, nil)
end

#doctype(node) ⇒ Object 



33
34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/metanorma/generic/converter.rb', line 33

def doctype(node)
  d = super
  node.attr("doctype") == "article" and d = "article"
  a = configuration.default_doctype and @default_doctype = a
  configuration.doctypes or
    return d == "article" ? @default_doctype : d
  type = @default_doctype || configuration.doctypes.keys[0]
  if !configuration.doctypes.key?(d)
    node.attr("doctype") && node.attr("doctype") != "article" and # factory default
      @log.add("GENERIC_1", nil, params: [d, type])
    d = type
  end
  d
end

#document(node) ⇒ Object 



71
72
73
74
75
76
77
78
79
 
# File 'lib/metanorma/generic/converter.rb', line 71

def document(node)
  if node.attr("customize")
    p = node.attr("customize")
    (Pathname.new p).absolute? or
      p = File.expand_path(File.join(Metanorma::Utils::localdir(node), p))
    read_config_file(p)
  end
  super
end

#empty_metadata_cleanup(ext) ⇒ Object

Keep cleaning until no more elements are removed (recursive depth-first) Process elements in reverse doc order to handle nested removals properly



63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/metanorma/generic/front.rb', line 63

def empty_metadata_cleanup(ext)
  loop do
    removed_count = 0
    ext.xpath(".//*").reverse_each do |element|
      element.children.empty? && element.attributes.empty? or next
      element.remove
      removed_count += 1
    end
    removed_count.zero? and break # Stop when no elems removed this pass
  end
end

#html_converter(node) ⇒ Object Also known as: pdf_converter 



138
139
140
 
# File 'lib/metanorma/generic/converter.rb', line 138

def html_converter(node)
  IsoDoc::Generic::HtmlConvert.new(html_extract_attributes(node))
end

#log_messages ⇒ Object

rubocop:enable Naming/VariableNumber



18
19
20
 
# File 'lib/metanorma/generic/log.rb', line 18

def log_messages
  super.merge(GENERIC_LOG_MESSAGES)
end

#metadata_committee_types(_node) ⇒ Object 



24
25
26
 
# File 'lib/metanorma/generic/front.rb', line 24

def metadata_committee_types(_node)
  Array(configuration.committee_types || "committee")
end

#metadata_doctype(node, xml) ⇒ Object 



75
76
77
78
79
80
 
# File 'lib/metanorma/generic/front.rb', line 75

def metadata_doctype(node, xml)
  d = doctype(node)
  add_noko_elem(xml, "doctype", d,
                abbreviation: configuration&.doctypes&.dig(d))
  # xml.doctype d, attr_code(abbreviation: configuration&.doctypes&.dig(d))
end

#metadata_ext(node, ext) ⇒ Object 



49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/metanorma/generic/front.rb', line 49

def metadata_ext(node, ext)
  super
  if configuration.metadata_extensions.is_a? Hash
    metadata_ext_hash(node, ext, configuration.metadata_extensions)
  else
    Array(configuration.metadata_extensions).each do |e|
      a = node.attr(e) and ext.send e, a
    end
  end
  empty_metadata_cleanup(ext.parent)
end

#metadata_ext_attrs(hash, node) ⇒ Object 



108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/metanorma/generic/front.rb', line 108

def metadata_ext_attrs(hash, node)
  return {} unless hash.is_a?(Hash)

  ret = {}
  hash.each do |k, v|
    next unless v.is_a?(Hash) && v["_attribute"]

    ret[(v["_output"] || k).to_sym] = node.attr(k)
  end
  ret
end

#metadata_ext_hash(node, ext, hash) ⇒ Object 



84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/metanorma/generic/front.rb', line 84

def metadata_ext_hash(node, ext, hash)
  hash.each do |k, v|
    EXT_STRUCT.include?(k) || (!v.is_a?(Hash) && !node.attr(k)) and next
    if v.is_a?(Hash) && v["_list"]
      csv_split(node.attr(k), ",").each do |val|
        metadata_ext_hash1(k, val, ext, v, node)
      end
    else
      metadata_ext_hash1(k, node.attr(k), ext, v, node)
    end
  end
end

#metadata_ext_hash1(key, value, ext, hash, node) ⇒ Object 



97
98
99
100
101
102
103
104
105
106
 
# File 'lib/metanorma/generic/front.rb', line 97

def metadata_ext_hash1(key, value, ext, hash, node)
  h = hash.is_a?(Hash)
  h && hash["_attribute"] and return
  is_hash = h && !hash.keys.reject { |n| EXT_STRUCT.include?(n) }.empty?
  !is_hash && (value.nil? || value.empty?) and return
  name = h ? (hash["_output"] || key) : key
  ext.send name, **attr_code(metadata_ext_attrs(hash, node)) do |e|
    is_hash ? metadata_ext_hash(node, e, hash) : (e << value)
  end
end

#metadata_id(node, xml) ⇒ Object 



41
42
43
44
45
46
47
 
# File 'lib/metanorma/generic/front.rb', line 41

def metadata_id(node, xml)
  id_type = node.attr("publisher_abbr") || node.attr("publisher") ||
    configuration.organization_name_short
  xml.docidentifier primary: "true", type: id_type do |i|
    i << (node.attr("docidentifier") || "")
  end
end

#metadata_status(node, xml) ⇒ Object 



28
29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/metanorma/generic/front.rb', line 28

def metadata_status(node, xml)
  xml.status do |s|
    add_noko_elem(s, "stage", node.attr("status") || node.attr("docstage") ||
             configuration.default_stage || "published")
    # s.stage ( node.attr("status") || node.attr("docstage") ||
    # configuration.default_stage || "published")
    add_noko_elem(s, "substage", node.attr("substage"))
    # x = node.attr("substage") and s.substage x
    add_noko_elem(s, "iteration", node.attr("iteration"))
    # x = node.attr("iteration") and s.iteration x
  end
end

#org_abbrev ⇒ Object 



8
9
10
11
12
13
14
15
16
17
18
 
# File 'lib/metanorma/generic/front.rb', line 8

def org_abbrev
  if !configuration.organization_name_long.empty? &&
      !configuration.organization_name_short.empty? &&
      configuration.organization_name_long !=
          configuration.organization_name_short
    { configuration.organization_name_long =>
      configuration.organization_name_short }
  else
    super
  end
end

#outputs(node, ret) ⇒ Object 



81
82
83
84
85
86
87
88
89
90
 
# File 'lib/metanorma/generic/converter.rb', line 81

def outputs(node, ret)
  File.open("#{@filename}.xml", "w:UTF-8") { |f| f.write(ret) }
  presentation_xml_converter(node)&.convert("#{@filename}.xml")
  html_converter(node)&.convert("#{@filename}.presentation.xml",
                                nil, false, "#{@filename}.html")
  doc_converter(node)&.convert("#{@filename}.presentation.xml",
                               nil, false, "#{@filename}.doc")
  pdf_converter(node)&.convert("#{@filename}.presentation.xml",
                               nil, false, "#{@filename}.pdf")
end

#presentation_xml_converter(node) ⇒ Object 



142
143
144
145
146
147
 
# File 'lib/metanorma/generic/converter.rb', line 142

def presentation_xml_converter(node)
  IsoDoc::Generic::PresentationXMLConvert
    .new(html_extract_attributes(node)
    .merge(output_formats: ::Metanorma::Generic::Processor.new
    .output_formats))
end

#published?(status, _xmldoc) ⇒ Boolean

Returns:

  • (Boolean) 


185
186
187
188
 
# File 'lib/metanorma/generic/converter.rb', line 185

def published?(status, _xmldoc)
  stages = configuration&.published_stages || ["published"]
  (Array(stages).map(&:downcase).include? status.downcase)
end

#read_config_file(path_to_config_file) ⇒ Object 



48
49
50
51
52
53
54
55
 
# File 'lib/metanorma/generic/converter.rb', line 48

def read_config_file(path_to_config_file)
  Metanorma::Generic.configuration
    .set_default_values_from_yaml_file(path_to_config_file)
  # reregister Processor to Metanorma with updated values
  if defined? Metanorma::Registry
    Metanorma::Registry.instance.register(Metanorma::Generic::Processor)
  end
end

#relaton_relations ⇒ Object 



20
21
22
 
# File 'lib/metanorma/generic/front.rb', line 20

def relaton_relations
  Array(configuration.relations) || []
end

#schema_file ⇒ Object 



97
98
99
 
# File 'lib/metanorma/generic/converter.rb', line 97

def schema_file
  configuration.validate_rng_file || "generic.rng"
end

#schema_location ⇒ Object 



92
93
94
95
 
# File 'lib/metanorma/generic/converter.rb', line 92

def schema_location
  baselocation(configuration.validate_rng_file) ||
    File.join(File.dirname(__FILE__), "generic.rng")
end

#sections_cleanup(xml) ⇒ Object 



129
130
131
132
133
134
 
# File 'lib/metanorma/generic/converter.rb', line 129

def sections_cleanup(xml)
  super
  xml.xpath("//*[@inline-header]").each do |h|
    h.delete("inline-header")
  end
end

#sectiontype_streamline(ret) ⇒ Object 



57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/metanorma/generic/converter.rb', line 57

def sectiontype_streamline(ret)
  if configuration.termsdefs_titles&.map(&:downcase)&.include? ret
    "terms and definitions"
  elsif configuration.symbols_titles&.map(&:downcase)&.include? ret
    "symbols and abbreviated terms"
  elsif configuration.normref_titles&.map(&:downcase)&.include? ret
    "normative references"
  elsif configuration.bibliography_titles&.map(&:downcase)&.include? ret
    "bibliography"
  else
    super
  end
end

#stage_validate(xmldoc) ⇒ Object 



111
112
113
114
115
116
117
 
# File 'lib/metanorma/generic/converter.rb', line 111

def stage_validate(xmldoc)
  stages = configuration.stage_abbreviations&.keys || return
  stages.empty? and return
  stage = xmldoc.at("//bibdata/status/stage")&.text
  stages.include? stage or
    @log.add("GENERIC_2", nil, params: [stage])
end