Class: Asciidoctor::Standoc::PlantUMLBlockMacroBackend

Inherits:
Object
  • Object
show all
Defined in:
lib/asciidoctor/standoc/macros_plantuml.rb

Class Method Summary collapse

Class Method Details

.generate_attrs(attrs) ⇒ Object 



65
66
67
68
69
70
71
 
# File 'lib/asciidoctor/standoc/macros_plantuml.rb', line 65

def self.generate_attrs(attrs)
  %w(id align float title role width height alt)
    .inject({}) do |memo, key|
    memo[key] = attrs[key] if attrs.has_key? key
    memo
  end
end

.generate_file(parent, reader) ⇒ Object

if no :imagesdir: leave image file in plantuml sleep need for windows because dot works in separate process and plantuml process may finish earlier then dot, as result png file maybe not created yet after plantuml finish



31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/asciidoctor/standoc/macros_plantuml.rb', line 31

def self.generate_file(parent, reader)
  localdir = Metanorma::Utils::localdir(parent.document)
  imagesdir = parent.document.attr("imagesdir")
  umlfile, outfile = save_plantuml parent, reader, localdir
  run(umlfile, outfile) or raise "No image output from PlantUML (#{umlfile}, #{outfile})!"
  umlfile.unlink

  path = Pathname.new(localdir) + (imagesdir || "plantuml")
  File.writable?(localdir) or raise "Destination path #{path} not writable for PlantUML!"
  path.mkpath
  File.writable?(path) or raise "Destination path #{path} not writable for PlantUML!"
  # File.exist?(path) or raise "Destination path #{path} already exists for PlantUML!"

  # Warning: metanorma/metanorma-standoc#187
  # Windows Ruby 2.4 will crash if a Tempfile is "mv"ed.
  # This is why we need to copy and then unlink.
  filename = File.basename(outfile.to_s)
  FileUtils.cp(outfile, path) && outfile.unlink

  imagesdir ? filename : File.join(path, filename)
end

.plantuml_installed? ⇒ Boolean

stackoverflow.com/questions/2108727/which-in-ruby-checking-if-program-exists-in-path-from-ruby

Returns:

  • (Boolean) 


5
6
7
8
9
10
11
12
13
14
15
 
# File 'lib/asciidoctor/standoc/macros_plantuml.rb', line 5

def self.plantuml_installed?
  cmd = "plantuml"
  exts = ENV["PATHEXT"] ? ENV["PATHEXT"].split(";") : [""]
  ENV["PATH"].split(File::PATH_SEPARATOR).each do |path|
    exts.each do |ext|
      exe = File.join(path, "#{cmd}#{ext}")
      return exe if File.executable?(exe) && !File.directory?(exe)
    end
  end
  raise "PlantUML not installed"
end

.run(umlfile, outfile) ⇒ Object 



17
18
19
20
21
22
23
24
25
 
# File 'lib/asciidoctor/standoc/macros_plantuml.rb', line 17

def self.run(umlfile, outfile)
  system "plantuml #{umlfile.path}" or (warn $? and return false)
  i = 0
  until !Gem.win_platform? || File.exist?(outfile) || i == 15
    sleep(1)
    i += 1
  end
  File.exist?(outfile)
end

.save_plantuml(_parent, reader, _localdir) ⇒ Object 



53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/asciidoctor/standoc/macros_plantuml.rb', line 53

def self.save_plantuml(_parent, reader, _localdir)
  src = reader.source
  reader.lines.first.sub(/\s+$/, "").match /^@startuml($| )/ or
    src = "@startuml\n#{src}\n@enduml\n"
  /^@startuml (?<fn>[^\n]+)\n/ =~ src
  Tempfile.open(["plantuml", ".pml"], encoding: "utf-8") do |f|
    f.write(src)
    [f, File.join(File.dirname(f.path),
                  "#{fn || File.basename(f.path, '.pml')}.png")]
  end
end