Class: Scribo::Preamble

Inherits:
Object
  • Object
show all
Defined in:
lib/scribo/preamble.rb

Constant Summary collapse

DEFAULTS = 
{
  external_encoding: Encoding.default_external
}.freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(metadata, content) ⇒ Preamble

Returns a new instance of Preamble.



11
12
13
14
 
# File 'lib/scribo/preamble.rb', line 11

def initialize(metadata, content)
  @metadata = metadata
  @content  = content
end

Instance Attribute Details

#content ⇒ Object

Returns the value of attribute content.



9
10
11
 
# File 'lib/scribo/preamble.rb', line 9

def content
  @content
end

#metadata ⇒ Object

Returns the value of attribute metadata.



9
10
11
 
# File 'lib/scribo/preamble.rb', line 9

def metadata
  @metadata
end

Class Method Details

.load(path, options = {}) ⇒ Object 



79
80
81
82
 
# File 'lib/scribo/preamble.rb', line 79

def self.load(path, options = {})
  f = File.open(path, "r:#{options[:external_encoding]}")
  parse(f.read)
end

.load_multiple(*paths) ⇒ Object 



84
85
86
87
 
# File 'lib/scribo/preamble.rb', line 84

def self.load_multiple(*paths)
  options = paths.last.is_a?(Hash) ? paths.pop : {}
  paths.map { |path| Preamble.load(path, options) }
end

.parse(data) ⇒ Object 



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/scribo/preamble.rb', line 32

def self.parse(data)
  preamble_lines = +''
  content_lines  = +''

  state = :before_preamble

  f = StringIO.new(data)
  f.each do |line|
    stripped = line.strip

    case state
    when :before_preamble

      new_state = case stripped
                  when '---'
                    :preamble
                  when ''
                    :before_preamble
                  else
                    content_lines << line
                    :after_preamble
                  end

    when :preamble

      new_state = case stripped
                  when '---'
                    :after_preamble
                  else
                    preamble_lines << line
                    :preamble
                  end

    when :after_preamble
      new_state = :after_preamble
      content_lines << line

    else
      raise "Invalid State: #{state}"
    end

    state = new_state
  end

  new(Scribo::Utility.yaml_safe_parse(preamble_lines), content_lines)
end

Instance Method Details

#dump ⇒ Object 



20
21
22
 
# File 'lib/scribo/preamble.rb', line 20

def dump
  metadata_with_content
end

#metadata_with_content ⇒ Object 



16
17
18
 
# File 'lib/scribo/preamble.rb', line 16

def metadata_with_content
  @metadata.to_yaml + "---\n" + @content
end

#save(path, options = {}) ⇒ Object 



24
25
26
27
28
29
30
 
# File 'lib/scribo/preamble.rb', line 24

def save(path, options = {})
  options = DEFAULTS.merge(options)

  File.open(path, "w:#{options[:external_encoding]}") do |f|
    f.write metadata_with_content
  end
end