Module: Middleman::Util::Data

Extended by:
Memoist
Includes:
Contracts
Defined in:
middleman-core/lib/middleman-core/util/data.rb

Constant Summary

Constants included from Contracts

Contracts::PATH_MATCHER, Contracts::ResourceList, Contracts::VectorOf

Class Method Summary collapse

Methods included from Contracts

#Contract

Class Method Details

.build_regex(frontmatter_delims) ⇒ Object



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
# File 'middleman-core/lib/middleman-core/util/data.rb', line 89

def build_regex(frontmatter_delims)
  start_delims, stop_delims = frontmatter_delims
                              .values
                              .flatten(1)
                              .transpose
                              .map(&::Regexp.method(:union))

  /
    \A(?:[^\r\n]*coding:[^\r\n]*\r?\n)?
    (?<start>#{start_delims})[ ]*\r?\n
    (?<frontmatter>.*?)[ ]*\r?\n?
    ^(?<stop>#{stop_delims})[ ]*\r?\n?
    \r?\n?
    (?<additional_content>.*)
  /mx
end

.parse(file, frontmatter_delims, known_type = nil) ⇒ Object



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
78
79
80
81
82
83
84
85
86
87
# File 'middleman-core/lib/middleman-core/util/data.rb', line 48

def parse(file, frontmatter_delims, known_type=nil)
  full_path = file[:full_path]
  return [{}, nil] if ::Middleman::Util.binary?(full_path) || file[:types].include?(:binary)

  # Avoid weird race condition when a file is renamed
  begin
    content = file.read
  rescue EOFError, IOError, ::Errno::ENOENT
    return [{}, nil]
  end

  match = build_regex(frontmatter_delims).match(content) || {}

  unless match[:frontmatter]
    case known_type
    when :yaml
      return [parse_yaml(content, full_path), nil]
    when :json
      return [parse_json(content, full_path), nil]
    end
  end

  case [match[:start], match[:stop]]
  when *frontmatter_delims[:yaml]
    [
      parse_yaml(match[:frontmatter], full_path),
      match[:additional_content]
    ]
  when *frontmatter_delims[:json]
    [
      parse_json("{#{match[:frontmatter]}}", full_path),
      match[:additional_content]
    ]
  else
    [
      {},
      content
    ]
  end
end

.parse_json(content, full_path) ⇒ Object



126
127
128
129
130
131
132
133
134
# File 'middleman-core/lib/middleman-core/util/data.rb', line 126

def parse_json(content, full_path)
  c = ::Middleman::Util.instrument 'parse.json' do
    ::JSON.parse(content)
  end
  c ? symbolize_recursive(c) : {}
rescue StandardError => error
  warn "JSON Exception parsing #{full_path}: #{error.message}"
  {}
end

.parse_yaml(content, full_path) ⇒ Object



111
112
113
114
115
116
117
118
119
# File 'middleman-core/lib/middleman-core/util/data.rb', line 111

def parse_yaml(content, full_path)
  c = ::Middleman::Util.instrument 'parse.yaml' do
    ::YAML.load(content)
  end
  c ? symbolize_recursive(c) : {}
rescue StandardError, ::Psych::SyntaxError => error
  warn "YAML Exception parsing #{full_path}: #{error.message}"
  {}
end

.StringHash

Parse JSON frontmatter out of a string

Parameters:

Returns:

  • (Hash)


110
# File 'middleman-core/lib/middleman-core/util/data.rb', line 110

Contract String, Pathname => Hash

.symbolize_recursive(value) ⇒ Object



137
138
139
140
141
142
143
144
145
146
# File 'middleman-core/lib/middleman-core/util/data.rb', line 137

def symbolize_recursive(value)
  case value
  when Hash
    value.map { |k, v| [k.to_sym, symbolize_recursive(v)] }.to_h
  when Array
    value.map { |v| symbolize_recursive(v) }
  else
    value
  end
end