Class: Metanorma::Compile

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

Constant Summary collapse

REQUIREMENT_XPATH = 
"//requirement | //xmlns:requirement | "\
"//recommendation | //xmlns:recommendation | //permission | "\
"//xmlns:permission".freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Compile

Returns a new instance of Compile.



10
11
12
13
 
# File 'lib/metanorma/compile.rb', line 10

def initialize
  @registry = Metanorma::Registry.instance
  @errors = []
end

Instance Attribute Details

#errors ⇒ Array<String> (readonly)

Returns:

  • (Array<String>) 


8
9
10
 
# File 'lib/metanorma/compile.rb', line 8

def errors
  @errors
end

#processor ⇒ Array<String> (readonly)

Returns:

  • (Array<String>) 


8
9
10
 
# File 'lib/metanorma/compile.rb', line 8

def processor
  @processor
end

Instance Method Details

#clean_sourcecode(xml) ⇒ Object 



147
148
149
150
151
152
153
 
# File 'lib/metanorma/compile.rb', line 147

def clean_sourcecode(xml)
  xml.xpath(".//callout | .//annotation | .//xmlns:callout | .//xmlns:annotation").each do |x|
    x.remove
  end
  xml.xpath(".//br | .//xmlns:br").each { |x| x.replace("\n") }
  HTMLEntities.new.decode(xml.children.to_xml)
end

#compile(filename, options = {}) ⇒ Object 



15
16
17
18
19
20
21
22
23
24
25
 
# File 'lib/metanorma/compile.rb', line 15

def compile(filename, options = {})
  require_libraries(options)
  options = options_extract(filename, options)
  validate_type(options) && validate_format(options) || (return nil)
  @processor = @registry.find_processor(options[:type].to_sym)
  extensions = get_extensions(options) or return nil
  (file, isodoc = process_input(filename, options)) or return nil
  relaton_export(isodoc, options)
  extract(isodoc, options[:extract], options[:extract_type])
  process_extensions(extensions, file, isodoc, options)
end

#extract(isodoc, dirname, extract_types) ⇒ Object 



155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/metanorma/compile.rb', line 155

def extract(isodoc, dirname, extract_types)
  return unless dirname
  if extract_types.nil? || extract_types.empty?
    extract_types = [:sourcecode, :image, :requirement]
  end
  FileUtils.rm_rf dirname
  FileUtils.mkdir_p dirname
  xml = Nokogiri::XML(isodoc)
  sourcecode_export(xml, dirname) if extract_types.include? :sourcecode
  image_export(xml, dirname) if extract_types.include? :image
  requirement_export(xml, dirname) if extract_types.include? :requirement
end

#get_extensions(options) ⇒ Object 



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/metanorma/compile.rb', line 92

def get_extensions(options)
  options[:extension_keys] ||= @processor.output_formats.reduce([]) do |memo, (k, _)|
    memo << k
  end
  extensions = options[:extension_keys].reduce([]) do |memo, e|
    if @processor.output_formats[e]
      memo << e
    else
      message = "[metanorma] Error: #{e} format is not supported for this standard."
      @errors << message
      Util.log(message, :error)
      memo
    end
  end
  if !extensions.include?(:presentation) and extensions.any? { |e| @processor.use_presentation_xml(e) }
    extensions << :presentation
    end
  extensions
end

#image_export(xml, dirname) ⇒ Object 



179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/metanorma/compile.rb', line 179

def image_export(xml, dirname)
  xml.at("//image | //xmlns:image") or return
  FileUtils.mkdir_p "#{dirname}/image"
  xml.xpath("//image | //xmlns:image").each_with_index do |s, i|
    next unless /^data:image/.match s["src"]
    %r{^data:image/(?<imgtype>[^;]+);base64,(?<imgdata>.+)$} =~ s["src"]
    filename = s["filename"] || sprintf("image-%04d.%s", i, imgtype)
    File.open("#{dirname}/image/#{filename}", "wb") do |f|
      f.write(Base64.strict_decode64(imgdata))
    end
  end
end

#options_extract(filename, options) ⇒ Object 



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/metanorma/compile.rb', line 45

def options_extract(filename, options)
  content = read_file(filename)
  o = Metanorma::Input::Asciidoc.new.extract_metanorma_options(content)
  o = o.merge(xml_options_extract(content))
  options[:type] ||= o[:type]&.to_sym
  t = @registry.alias(options[:type]) and options[:type] = t
  dir = filename.sub(%r(/[^/]+$), "/")
  options[:relaton] ||= "#{dir}/#{o[:relaton]}" if o[:relaton]
  options[:sourcecode] ||= "#{dir}/#{o[:sourcecode]}" if o[:sourcecode]
  options[:extension_keys] ||= o[:extensions]&.split(/,[ ]*/)&.map(&:to_sym)
  options[:extension_keys] = nil if options[:extension_keys] == [:all]
  options[:format] ||= :asciidoc
  options[:filename] = filename
  options
end

#process_extensions(extensions, file, isodoc, options) ⇒ Object

isodoc is Raw Metanorma XML



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/metanorma/compile.rb', line 228

def process_extensions(extensions, file, isodoc, options)
  f = change_output_dir options
  xml_name = f.sub(/\.[^.]+$/, ".xml")
  presentationxml_name = f.sub(/\.[^.]+$/, ".presentation.xml")
  extensions.sort do |a, b|
    sort_extensions_execution(a) <=> sort_extensions_execution(b)
  end.each do |ext|
    isodoc_options = @processor.extract_options(file)
    isodoc_options[:datauriimage] = true if options[:datauriimage]
    file_extension = @processor.output_formats[ext]
    outfilename = f.sub(/\.[^.]+$/, ".#{file_extension}")
    if ext == :rxl
      options[:relaton] = outfilename
      relaton_export(isodoc, options)
    else
      begin
        @processor.use_presentation_xml(ext) ?
          @processor.output(nil, presentationxml_name, outfilename, ext, isodoc_options) :
          @processor.output(isodoc, xml_name, outfilename, ext, isodoc_options)
      rescue StandardError => e
        puts e.message
      end
    end
    wrap_html(options, file_extension, outfilename)
  end
end

#process_input(filename, options) ⇒ Object 



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/metanorma/compile.rb', line 112

def process_input(filename, options)
  case extname = File.extname(filename)
  when ".adoc"
    Util.log("[metanorma] Processing: AsciiDoc input.", :info)
    file = read_file(filename)
    options[:asciimath] and
      file.sub!(/^(=[^\n]+\n)/, "\\1:mn-keep-asciimath:\n")
    dir = File.dirname(filename)
    dir != '.' and
      file.gsub!(/^include::/, "include::#{dir}/")
    [file, @processor.input_to_isodoc(file, filename, options)]
  when ".xml"
    Util.log("[metanorma] Processing: Metanorma XML input.", :info)
    # TODO NN: this is a hack -- we should provide/bridge the
    # document attributes in Metanorma XML
    ["", read_file(filename)]
  else
    Util.log("[metanorma] Error: file extension #{extname} is not supported.", :error)
    nil
  end
end

#read_file(filename) ⇒ Object 



134
135
136
 
# File 'lib/metanorma/compile.rb', line 134

def read_file(filename)
  File.read(filename, encoding: "utf-8").gsub("\r\n", "\n")
end

#relaton_export(isodoc, options) ⇒ Object 



138
139
140
141
142
143
144
145
 
# File 'lib/metanorma/compile.rb', line 138

def relaton_export(isodoc, options)
  return unless options[:relaton]
  xml = Nokogiri::XML(isodoc)
  bibdata = xml.at("//bibdata") || xml.at("//xmlns:bibdata")
  #docid = bibdata&.at("./xmlns:docidentifier")&.text || options[:filename]
  #outname = docid.sub(/^\s+/, "").sub(/\s+$/, "").gsub(/\s+/, "-") + ".xml"
  File.open(options[:relaton], "w:UTF-8") { |f| f.write bibdata.to_xml }
end

#require_libraries(options) ⇒ Object 



27
28
29
30
31
32
33
 
# File 'lib/metanorma/compile.rb', line 27

def require_libraries(options)
  if options[:require]
    options[:require].each do |r|
      require r
    end
  end
end

#requirement_export(xml, dirname) ⇒ Object 



196
197
198
199
200
201
202
203
204
205
 
# File 'lib/metanorma/compile.rb', line 196

def requirement_export(xml, dirname)
  xml.at(REQUIREMENT_XPATH) or return
  FileUtils.mkdir_p "#{dirname}/requirement"
  xml.xpath(REQUIREMENT_XPATH).each_with_index do |s, i|
    filename = s["filename"] || sprintf("%s-%04d.xml", s.name, i)
    File.open("#{dirname}/requirement/#{filename}", "w:UTF-8") do |f|
      f.write s
    end
  end
end

#sort_extensions_execution(ext) ⇒ Object

dependency ordering



208
209
210
211
212
213
214
215
216
 
# File 'lib/metanorma/compile.rb', line 208

def sort_extensions_execution(ext)
   case ext
   when :xml then 0
   when :rxl then 1
   when :presentation then 2
   else
     99
   end
end

#sourcecode_export(xml, dirname) ⇒ Object 



168
169
170
171
172
173
174
175
176
177
 
# File 'lib/metanorma/compile.rb', line 168

def sourcecode_export(xml, dirname)
  xml.at("//sourcecode | //xmlns:sourcecode") or return
  FileUtils.mkdir_p "#{dirname}/sourcecode"
  xml.xpath("//sourcecode | //xmlns:sourcecode").each_with_index do |s, i|
    filename = s["filename"] || sprintf("sourcecode-%04d.txt", i)
    File.open("#{dirname}/sourcecode/#{filename}", "w:UTF-8") do |f|
      f.write clean_sourcecode(s.dup) 
    end
  end
end

#validate_format(options) ⇒ Object 



84
85
86
87
88
89
90
 
# File 'lib/metanorma/compile.rb', line 84

def validate_format(options)
  unless options[:format] == :asciidoc
    Util.log("[metanorma] Error: Only source file format currently supported is 'asciidoc'.", :error)
    return false
  end
  true
end

#validate_type(options) ⇒ Object 



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/metanorma/compile.rb', line 61

def validate_type(options)
  unless options[:type]
    Util.log("[metanorma] Error: Please specify a standard type: #{@registry.supported_backends}.", :error)
    return nil
  end
  stdtype = options[:type].to_sym
  unless @registry.supported_backends.include? stdtype
    Util.log("[metanorma] Info: Loading `metanorma-#{stdtype}` gem for standard type `#{stdtype}`.", :info)
  end
  begin
    require "metanorma-#{stdtype}"
    Util.log("[metanorma] Info: gem `metanorma-#{stdtype}` loaded.", :info)
  rescue LoadError
    Util.log("[metanorma] Error: loading gem `metanorma-#{stdtype}` failed. Exiting.", :error)
    return false
  end
  unless @registry.supported_backends.include? stdtype
    Util.log("[metanorma] Error: The `metanorma-#{stdtype}` gem still doesn't support `#{stdtype}`. Exiting.", :error)
    return false
  end
  true
end

#wrap_html(options, file_extension, outfilename) ⇒ Object 



218
219
220
221
222
223
224
225
 
# File 'lib/metanorma/compile.rb', line 218

def wrap_html(options, file_extension, outfilename)
  if options[:wrapper] and /html$/.match file_extension
      outfilename = outfilename.sub(/\.html$/, "")
      FileUtils.mkdir_p outfilename
      FileUtils.mv "#{outfilename}.html", outfilename
      FileUtils.mv "#{outfilename}_images", outfilename, force: true
    end
end

#xml_options_extract(file) ⇒ Object 



35
36
37
38
39
40
41
42
43
 
# File 'lib/metanorma/compile.rb', line 35

def xml_options_extract(file)
  xml = Nokogiri::XML(file)
  if xml.root
    @registry.root_tags.each do |k, v|
      return { type: k }  if v == xml.root.name
    end
  end
  {}
end