prismic.io 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2ee3bfcd4ea5ad701435ae58de5bc1ef89fef1ee
-  data.tar.gz: 0d10d02860bc3353331d0994be4cf606cad248dd
+  metadata.gz: 7ddebf7e0c8efd6eb548e0c2311e5021611320ef
+  data.tar.gz: 396c64eadc4b74c2355a70cc60723c9a1a7252af
 SHA512:
-  metadata.gz: 2846d41756d623ef7d12ed48643c06f3c9181d9057198e2a7a2814afeca4220ccdd57e0030fa4ab43d6120028eda3bac917a38130f2a15642ce5878b1e41cbfb
-  data.tar.gz: fef0bdb5040e2a46b0705d4557bf85ea4e9871902716c753b722f0573f4d8fa102f81cfc7baea26592d50235532fdf67eec7c6a01207850b5ae8a5cc7aee07dc
+  metadata.gz: 9781e89122d946b0ee9d4c1a11869ec6887e00e8b5c9921e996c537607ce483d9723c27cf789e258ce99cf7f5c837b46956d5a3309883d11b2eefaadad472787
+  data.tar.gz: 97402b3c5ffad257575f73f2583d615028646dcf7d106093e4ecdeb38c2897b7d27022c0d815432c0177370077d189e99d6c41a1115d495c5f45a3269ab48e40

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    prismic.io (1.2.1)
+    prismic.io (1.3.0)
       hashery (~> 2.1.1)
 
 GEM

data/lib/prismic/fragments.rb

@@ -13,3 +13,4 @@ require 'prismic/fragments/select'
 require 'prismic/fragments/structured_text'
 require 'prismic/fragments/text'
 require 'prismic/fragments/timestamp'
+require 'prismic/fragments/slices'

data/lib/prismic/fragments/image.rb

@@ -13,6 +13,10 @@ module Prismic
         main.as_html(link_resolver)
       end
 
+      def as_text
+        ""
+      end
+
       def get_view(key)
         if key == 'main'
           main

data/lib/prismic/fragments/slices.rb

@@ -0,0 +1,59 @@
+# encoding: utf-8
+module Prismic
+  module Fragments
+
+    # A fragment of type Slice, an item in a SliceZone
+    class Slice < Fragment
+      attr_accessor :slice_type
+      attr_accessor :value
+
+      def initialize(slice_type, value)
+        @slice_type = slice_type
+        @value = value
+      end
+
+      # Generate an text representation of the group
+      #
+      # @return [String] the text representation
+      def as_text
+        @value.as_text
+      end
+
+      # Generate an HTML representation of the group
+      #
+      # @param link_resolver [LinkResolver] The LinkResolver used to build
+      #     application's specific URL
+      #
+      # @return [String] the HTML representation
+      def as_html(link_resolver=nil)
+        @value.as_html(link_resolver)
+      end
+    end
+
+    class SliceZone < Fragment
+      attr_accessor :slices
+
+      def initialize(slices)
+        @slices = slices
+      end
+
+      # Generate an text representation of the group
+      #
+      # @return [String] the text representation
+      def as_text
+        @slices.map { |slice| slice.as_text }.join("\n")
+      end
+
+      # Generate an HTML representation of the group
+      #
+      # @param link_resolver [LinkResolver] The LinkResolver used to build
+      #     application's specific URL
+      #
+      # @return [String] the HTML representation
+      def as_html(link_resolver=nil)
+        @slices.map { |slice| slice.as_html(link_resolver) }.join("\n")
+      end
+    end
+
+  end
+end

data/lib/prismic/json_parsers.rb

@@ -23,7 +23,8 @@ module Prismic
           'StructuredText' => method(:structured_text_parser),
           'Select'         => method(:select_parser),
           'Multiple'       => method(:multiple_parser),
-          'Group'          => method(:group_parser)
+          'Group'          => method(:group_parser),
+          'SliceZone'      => method(:slices_parser)
         }
       end
 
@@ -199,6 +200,24 @@ module Prismic
         Prismic::Fragments::Group.new(fragment_list_array)
       end
 
+      def slices_parser(json)
+        slices = []
+        json['value'].each do |data|
+          slice_type = data['slice_type']
+          fragment = data['value']
+          slices << Prismic::Fragments::Slice.new(slice_type, fragment_parser(fragment))
+        end
+        Prismic::Fragments::SliceZone.new(slices)
+      end
+
+      def fragment_parser(fragment)
+        if fragment.is_a? Array
+          multiple_parser(fragment)
+        else
+          parsers[fragment['type']].call(fragment)
+        end
+      end
+
       def document_parser(json)
         data_json = json['data'].values.first  # {"doc_type": data}
 
@@ -213,11 +232,7 @@ module Prismic
         }
 
         fragments = Hash[data_json.map { |name, fragment|
-          if fragment.is_a? Array
-            [name, multiple_parser(fragment)]
-          else
-            [name, parsers[fragment['type']].call(fragment)]
-          end
+          [name, fragment_parser(fragment)]
         }]
 
         Prismic::Document.new(

data/lib/prismic/version.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 module Prismic
 
-  VERSION = '1.2.1'
+  VERSION = '1.3.0'
 
 end

data/lib/prismic/with_fragments.rb

@@ -6,6 +6,13 @@ module Prismic
     # @return [Hash{String => Fragment}]
     attr_accessor :fragments
 
+    # Generate a Text representation of the entire document
+    #
+    # @return [String] the text representation
+    def as_text
+      fragments.map { |field, fragment| fragment.as_text }.join("\n")
+    end
+
     # Generate an HTML representation of the entire document
     #
     # @param link_resolver [LinkResolver] The LinkResolver used to build
@@ -143,6 +150,12 @@ module Prismic
       fragment
     end
 
+    def get_slice_zone(field)
+      fragment = self[field]
+      return nil unless fragment.is_a? Prismic::Fragments::SliceZone
+      fragment
+    end
+
     # @return [Array<LinkedDocument>]
     def linked_documents
       self.fragments.map { |name, fragment|

data/spec/fragments_spec.rb

@@ -485,8 +485,8 @@ describe 'Image' do
   end
 
   describe 'as_text' do
-    it 'raises an NotImplementedError' do
-      expect { @image.as_text }.to raise_error NotImplementedError
+    it 'is empty' do
+      @image.as_text.should == ""
     end
   end
 end
@@ -701,3 +701,19 @@ describe 'Group' do
   end
 
 end
+
+describe 'Slices' do
+  before do
+    @raw_json_slices = File.read("#{File.dirname(__FILE__)}/responses_mocks/slices.json")
+    @json_slices = JSON.load(@raw_json_slices)
+    @doc = Prismic::JsonParser.document_parser(@json_slices)
+    @slices = @doc.get_slice_zone("article.blocks")
+    @link_resolver = Prismic.link_resolver('master'){|doc_link| "http://localhost/#{doc_link.link_type}/#{doc_link.id}" }
+  end
+
+  it 'parses correctly' do
+    @slices.as_text.should == "\nc'est un bloc features\nC'est un bloc content"
+    @slices.as_html(@link_resolver).should == %[<section data-field="illustration"><img src="https://wroomdev.s3.amazonaws.com/toto/db3775edb44f9818c54baa72bbfc8d3d6394b6ef_hsf_evilsquall.jpg" alt="" width="4285" height="709" /></section>\n<section data-field="title"><span class="text">c&#39;est un bloc features</span></section>\n<p>C&#39;est un bloc content</p>]
+  end
+
+end

data/spec/responses_mocks/slices.json

@@ -0,0 +1,96 @@
+{
+    "id":"VQ_hV31Za5EAy02H",
+    "uid":null,
+    "type":"article",
+    "href":"http://toto.wroom.dev/api/documents/search?ref=VQ_uWX1Za0oCy46m&q=%5B%5B%3Ad+%3D+at%28document.id%2C+%22VQ_hV31Za5EAy02H%22%29+%5D%5D",
+    "tags":[],
+    "slugs":["une-activite"],
+    "linked_documents":[],
+    "data":{
+        "article":{
+            "activities":{
+                "type":"Group",
+                "value":[{
+                    "title":{
+                        "type":"StructuredText",
+                        "value":[{
+                            "type":"paragraph",
+                            "text":"Une activité",
+                            "spans":[]
+                        }]
+                    },
+                    "image":{
+                        "type":"Image",
+                        "value":{
+                            "main":{
+                                "url":"https://wroomdev.s3.amazonaws.com/toto/ce3f52b933c4934a13422e09ed0ff6ad03a29621_hsf_evilsquall.jpg",
+                                "alt":"",
+                                "copyright":"",
+                                "dimensions":{"width":860,"height":640}
+                            },
+                            "views":{
+                                "headline":{
+                                    "url":"https://wroomdev.s3.amazonaws.com/toto/5445d2dcd2b0c541b0406ca867ab3d07b309c944_hsf_evilsquall.jpg",
+                                    "alt":"",
+                                    "copyright":"",
+                                    "dimensions":{"width":570,"height":400}
+                                }
+                            }
+                        }
+                    },
+                    "body":{
+                        "type":"StructuredText",
+                        "value":[{
+                            "type":"paragraph",
+                            "text":"elle est bien",
+                            "spans":[]
+                        }]
+                    }
+                }]
+            },
+            "un_champ_texte":{
+                "type":"Text",
+                "value":"stuffgg"
+            },
+            "blocks":{
+                "type":"SliceZone",
+                "value":[{
+                    "type":"Slice",
+                    "slice_type": "features",
+                    "value":{
+                        "type":"Group",
+                        "value":[{
+                            "illustration":{
+                                "type":"Image",
+                                "value":{
+                                    "main":{
+                                        "url":"https://wroomdev.s3.amazonaws.com/toto/db3775edb44f9818c54baa72bbfc8d3d6394b6ef_hsf_evilsquall.jpg",
+                                        "alt":"",
+                                        "copyright":"",
+                                        "dimensions":{"width":4285,"height":709}
+                                    },
+                                    "views":{}
+                                }
+                            },
+                            "title":{
+                                "type":"Text",
+                                "value":"c'est un bloc features"
+                            }
+                        }]
+                    }
+                },{
+                    "type":"Slice",
+                    "slice_type":"text",
+                    "value":{
+                        "type":"StructuredText",
+                        "value":[{
+                            "type":"paragraph",
+                            "text":"C'est un bloc content",
+                            "spans":[]
+                        }]
+                    }
+                }]
+            }
+        }
+    }
+}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: prismic.io
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Étienne Vallette d'Osia
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-08 00:00:00.000000000 Z
+date: 2015-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -116,6 +116,7 @@ files:
 - lib/prismic/fragments/multiple.rb
 - lib/prismic/fragments/number.rb
 - lib/prismic/fragments/select.rb
+- lib/prismic/fragments/slices.rb
 - lib/prismic/fragments/structured_text.rb
 - lib/prismic/fragments/text.rb
 - lib/prismic/fragments/timestamp.rb
@@ -140,6 +141,7 @@ files:
 - spec/responses_mocks/document_with_unknown_fragment.json
 - spec/responses_mocks/experiments.json
 - spec/responses_mocks/fragments.json
+- spec/responses_mocks/slices.json
 - spec/responses_mocks/structured_text_heading.json
 - spec/responses_mocks/structured_text_linkfile.json
 - spec/responses_mocks/structured_text_paragraph.json
@@ -186,6 +188,7 @@ test_files:
 - spec/responses_mocks/document_with_unknown_fragment.json
 - spec/responses_mocks/experiments.json
 - spec/responses_mocks/fragments.json
+- spec/responses_mocks/slices.json
 - spec/responses_mocks/structured_text_heading.json
 - spec/responses_mocks/structured_text_linkfile.json
 - spec/responses_mocks/structured_text_paragraph.json