Class: Metanorma::Mirror::Output::Formats::BaseFormat

Inherits:
Object
  • Object
show all
Defined in:
lib/metanorma/mirror/output/formats/base_format.rb

Direct Known Subclasses

InlineFormat

Class Attribute Summary collapse

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(dist_dir: nil) ⇒ BaseFormat

Returns a new instance of BaseFormat.



12
13
14
 
# File 'lib/metanorma/mirror/output/formats/base_format.rb', line 12

def initialize(dist_dir: nil)
  @dist_dir = dist_dir || self.class.default_dist_dir
end

Class Attribute Details

.configured_dist_dir ⇒ Object

Returns the value of attribute configured_dist_dir.



21
22
23
 
# File 'lib/metanorma/mirror/output/formats/base_format.rb', line 21

def configured_dist_dir
  @configured_dist_dir
end

Instance Attribute Details

#dist_dir ⇒ Object (readonly)

Returns the value of attribute dist_dir.



10
11
12
 
# File 'lib/metanorma/mirror/output/formats/base_format.rb', line 10

def dist_dir
  @dist_dir
end

Class Method Details

.default_dist_dir ⇒ Object 



23
24
25
26
27
 
# File 'lib/metanorma/mirror/output/formats/base_format.rb', line 23

def default_dist_dir
  @configured_dist_dir || File.expand_path(
    "../../../../../frontend/dist", __dir__
  )
end

Instance Method Details

#write(output_path, guide, title: "Metanorma") ⇒ Object

Raises:

  • (NotImplementedError) 


16
17
18
 
# File 'lib/metanorma/mirror/output/formats/base_format.rb', line 16

def write(output_path, guide, title: "Metanorma")
  raise NotImplementedError, "#{self.class}#write not implemented"
end