Module: Prismic::JsonParser

Defined in:
lib/prismic/json_parsers.rb

Constant Summary collapse

@@warned_unknown_type =
[]

Class Method Summary collapse

Class Method Details

.alternate_language_parser(alternate_language) ⇒ Object



248
249
250
# File 'lib/prismic/json_parsers.rb', line 248

def alternate_language_parser(alternate_language)
  Prismic::AlternateLanguage.new(alternate_language)
end

.boolean_field_parser(json) ⇒ Object



39
40
41
# File 'lib/prismic/json_parsers.rb', line 39

def boolean_field_parser(json) 
  Prismic::Fragments::BooleanField.new(json['value'])
end

.color_parser(json) ⇒ Object



132
133
134
# File 'lib/prismic/json_parsers.rb', line 132

def color_parser(json)
  Prismic::Fragments::Color.new(json['value'][1..6])
end

.date_parser(json) ⇒ Object



99
100
101
# File 'lib/prismic/json_parsers.rb', line 99

def date_parser(json)
  Prismic::Fragments::Date.new(Time.parse(json['value']))
end


43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
# File 'lib/prismic/json_parsers.rb', line 43

def document_link_parser(json)
  doc = json['value']['document']
  type = doc['type']
  fragments = {}
  if doc['data'] and doc['data'][type]
    fragments = Hash[doc['data'][type].map { |name, fragment|
      if fragment.is_a? Array
        [name, multiple_parser(fragment)]
      else
        [name, parsers[fragment['type']].call(fragment)]
      end
    }]
  end
  Prismic::Fragments::DocumentLink.new(
    doc['id'],
    doc['uid'],
    type,
    doc['tags'],
    CGI.unescape(doc['slug']),
    doc['lang'],
    fragments,
    json['value']['isBroken'],
    json['value']['target'] ? json['value']['target'] : nil)
end

.document_parser(json) ⇒ Object



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
# File 'lib/prismic/json_parsers.rb', line 252

def document_parser(json)
  data_json = json['data'].values.first  # {"doc_type": data}

  # Removing the unknown types + sending a warning, once
  data_json.select!{ |_, fragment|
    known_type = fragment.is_a?(Array) || parsers.include?(fragment['type'])
    if !known_type && !@@warned_unknown_type.include?(fragment['type'])
      warn "Type #{fragment['type']} is unknown, fragment was skipped; perhaps you should update your prismic.io gem?"
      @@warned_unknown_type << fragment['type']
    end
    known_type
  }

  alternate_languages = nil
  if json.key?('alternate_languages')
    alternate_languages = Hash[json['alternate_languages'].map { |doc|
      [doc['lang'], alternate_language_parser(doc)]
    }]
  end

  fragments = Hash[data_json.map { |name, fragment|
    [name, fragment_parser(fragment)]
  }]

  Prismic::Document.new(
      json['id'],
      json['uid'],
      json['type'],
      json['href'],
      json['tags'],
      json['slugs'].map { |slug| CGI.unescape(slug) },
      json['first_publication_date'] && Time.parse(json['first_publication_date']),
      json['last_publication_date'] && Time.parse(json['last_publication_date']),
      json['lang'],
      alternate_languages,
      fragments)
end

.embed_parser(json) ⇒ Object



111
112
113
# File 'lib/prismic/json_parsers.rb', line 111

def embed_parser(json)
  embed_object_parser(json['value']['oembed'])
end


74
75
76
77
78
79
80
81
# File 'lib/prismic/json_parsers.rb', line 74

def file_link_parser(json)
  Prismic::Fragments::FileLink.new(
    json['value']['file']['url'],
    json['value']['file']['name'],
    json['value']['file']['kind'],
    json['value']['file']['size'],
    json['value']['target'] ? json['value']['target'] : nil )
end

.fragment_parser(fragment) ⇒ Object



240
241
242
243
244
245
246
# File 'lib/prismic/json_parsers.rb', line 240

def fragment_parser(fragment)
  if fragment.is_a? Array
    multiple_parser(fragment)
  else
    parsers[fragment['type']].call(fragment)
  end
end

.geo_point_parser(json) ⇒ Object



115
116
117
118
119
120
# File 'lib/prismic/json_parsers.rb', line 115

def geo_point_parser(json)
  Prismic::Fragments::GeoPoint.new(
    json['value']['longitude'],
    json['value']['latitude']
  )
end

.group_parser(json) ⇒ Object



208
209
210
211
212
213
214
215
# File 'lib/prismic/json_parsers.rb', line 208

def group_parser(json)
  fragment_list_array = []
  json['value'].each do |group|
    fragments = Hash[ group.map {|name, fragment| [name, parsers[fragment['type']].call(fragment)] }]
    fragment_list_array << Prismic::Fragments::GroupDocument.new(fragments)
  end
  Prismic::Fragments::Group.new(fragment_list_array)
end


68
69
70
71
72
# File 'lib/prismic/json_parsers.rb', line 68

def image_link_parser(json)
  Prismic::Fragments::ImageLink.new(
    json['value']['image']['url'],
    json['value']['target'] ? json['value']['target'] : nil)
end

.image_parser(json) ⇒ Object



122
123
124
125
126
127
128
129
130
# File 'lib/prismic/json_parsers.rb', line 122

def image_parser(json)
  main  = view_parser(json['value']['main'])
  views = {}
  json['value']['views'].each do |name, view|
    views[name] = view_parser(view)
  end

  Prismic::Fragments::Image.new(main, views)
end

.integration_fields_parser(json) ⇒ Object



35
36
37
# File 'lib/prismic/json_parsers.rb', line 35

def integration_fields_parser(json)
  Prismic::Fragments::IntegrationField.new(json['value'])
end

.multiple_parser(json) ⇒ Object



201
202
203
204
205
206
# File 'lib/prismic/json_parsers.rb', line 201

def multiple_parser(json)
  fragments = json.map do |fragment|
    parsers[fragment['type']].call(fragment)
  end
  Prismic::Fragments::Multiple.new(fragments)
end

.number_parser(json) ⇒ Object



107
108
109
# File 'lib/prismic/json_parsers.rb', line 107

def number_parser(json)
  Prismic::Fragments::Number.new(json['value'])
end

.parsersObject



10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
# File 'lib/prismic/json_parsers.rb', line 10

def parsers
  @parsers ||= {
    'Link.document'  => method(:document_link_parser),
    'Text'           => method(:text_parser),
    'Link.web'       => method(:web_link_parser),
    'Link.image'     => method(:image_link_parser),
    'Link.file'      => method(:file_link_parser),
    'Date'           => method(:date_parser),
    'Timestamp'      => method(:timestamp_parser),
    'Number'         => method(:number_parser),
    'Embed'          => method(:embed_parser),
    'GeoPoint'       => method(:geo_point_parser),
    'Image'          => method(:image_parser),
    'Color'          => method(:color_parser),
    'StructuredText' => method(:structured_text_parser),
    'Select'         => method(:select_parser),
    'Multiple'       => method(:multiple_parser),
    'Group'          => method(:group_parser),
    'SliceZone'      => method(:slices_parser),
    'Separator'      => method(:separator_parser),
    'IntegrationFields' => method(:integration_fields_parser),
    'Boolean' => method(:boolean_field_parser)
  }
end

.response_parser(documents) ⇒ Object

Raises:

  • (FormSearchException)


296
297
298
299
300
301
302
303
304
305
306
307
308
# File 'lib/prismic/json_parsers.rb', line 296

def response_parser(documents)
  raise FormSearchException, "Error : #{documents['error']}" if documents['error']
  Prismic::Response.new(
    documents['page'],
    documents['results_per_page'],
    documents['results_size'],
    documents['total_results_size'],
    documents['total_pages'],
    documents['next_page'],
    documents['prev_page'],
    results_parser(documents['results'])
  )
end

.results_parser(results) ⇒ Object



290
291
292
293
294
# File 'lib/prismic/json_parsers.rb', line 290

def results_parser(results)
  results.map do |doc|
    document_parser(doc)
  end
end

.select_parser(json) ⇒ Object



91
92
93
# File 'lib/prismic/json_parsers.rb', line 91

def select_parser(json)
  Prismic::Fragments::Text.new(json['value'])
end

.separator_parser(json) ⇒ Object



87
88
89
# File 'lib/prismic/json_parsers.rb', line 87

def separator_parser(json)
  Prismic::Fragments::Separator.new('')
end

.slices_parser(json) ⇒ Object



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
# File 'lib/prismic/json_parsers.rb', line 217

def slices_parser(json)
  slices = []

  json['value'].each do |data|
    slice_type = data['slice_type']
    slice_label = data['slice_label']

    if data.key?('value')
      slices << Prismic::Fragments::SimpleSlice.new(slice_type, slice_label, fragment_parser(data['value']))
    else
      non_repeat = {}
      data['non-repeat'].each do |fragment_key, fragment_value|
        non_repeat[fragment_key] = fragment_parser(fragment_value)
      end

      repeat = group_parser({ 'type' => 'Group', 'value' => data['repeat']})

      slices << Prismic::Fragments::CompositeSlice.new(slice_type, slice_label, non_repeat, repeat)
    end
  end
  Prismic::Fragments::SliceZone.new(slices)
end

.span_parser(span) ⇒ Object



137
138
139
140
141
142
143
144
145
146
147
148
149
# File 'lib/prismic/json_parsers.rb', line 137

def self.span_parser(span)
  case span['type']
  when 'em'
    Prismic::Fragments::StructuredText::Span::Em.new(span['start'], span['end'])
  when 'strong'
    Prismic::Fragments::StructuredText::Span::Strong.new(span['start'], span['end'])
  when 'hyperlink'
    Prismic::Fragments::StructuredText::Span::Hyperlink.new(span['start'], span['end'], link_parser(span['data']))
  else
    label = span['data'] && span['data']['label']
    Prismic::Fragments::StructuredText::Span::Label.new(span['start'], span['end'], label)
  end
end

.structured_text_parser(json) ⇒ Object



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
# File 'lib/prismic/json_parsers.rb', line 136

def structured_text_parser(json)
  def self.span_parser(span)
    case span['type']
    when 'em'
      Prismic::Fragments::StructuredText::Span::Em.new(span['start'], span['end'])
    when 'strong'
      Prismic::Fragments::StructuredText::Span::Strong.new(span['start'], span['end'])
    when 'hyperlink'
      Prismic::Fragments::StructuredText::Span::Hyperlink.new(span['start'], span['end'], link_parser(span['data']))
    else
      label = span['data'] && span['data']['label']
      Prismic::Fragments::StructuredText::Span::Label.new(span['start'], span['end'], label)
    end
  end

  blocks = json['value'].map do |block|
    case block['type']
    when 'paragraph'
      spans = block['spans'].map {|span| span_parser(span) }
      Prismic::Fragments::StructuredText::Block::Paragraph.new(block['text'], spans, block['label'])
    when 'preformatted'
      spans = block['spans'].map {|span| span_parser(span) }
      Prismic::Fragments::StructuredText::Block::Preformatted.new(block['text'], spans, block['label'])
    when /^heading(\d+)$/
      heading = $1
      spans = block['spans'].map {|span| span_parser(span) }
      Prismic::Fragments::StructuredText::Block::Heading.new(
        block['text'],
        spans,
        heading.to_i,
        block['label']
      )
    when 'o-list-item'
      spans = block['spans'].map {|span| span_parser(span) }
      Prismic::Fragments::StructuredText::Block::ListItem.new(
        block['text'],
        spans,
        true,  # ordered
        block['label']
      )
    when 'list-item'
      spans = block['spans'].map {|span| span_parser(span) }
      Prismic::Fragments::StructuredText::Block::ListItem.new(
        block['text'],
        spans,
        false,  # unordered
        block['label']
      )
    when 'image'
      Prismic::Fragments::StructuredText::Block::Image.new(
        view_parser(block),
        block['label']
      )
    when 'embed'
      Prismic::Fragments::StructuredText::Block::Embed.new(
        embed_object_parser(block['oembed']),
        block['label']
      )
    else
      puts "Unknown bloc type: #{block['type']}"
    end
  end
  Prismic::Fragments::StructuredText.new(blocks)
end

.text_parser(json) ⇒ Object



83
84
85
# File 'lib/prismic/json_parsers.rb', line 83

def text_parser(json)
  Prismic::Fragments::Text.new(json['value'])
end

.timestamp_parser(json) ⇒ Object



103
104
105
# File 'lib/prismic/json_parsers.rb', line 103

def timestamp_parser(json)
  Prismic::Fragments::Timestamp.new(Time.parse(json['value']))
end


95
96
97
# File 'lib/prismic/json_parsers.rb', line 95

def web_link_parser(json)
  Prismic::Fragments::WebLink.new(json['value']['url'], json['value']['target'])
end