prismic.io 1.4.2 → 1.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 397ea2cd56addd7eb0044a8fc9fef772df40f174
-  data.tar.gz: fe7638bd984fb3162ecb9c9e3b6383f23d0458a7
+  metadata.gz: fe3fbf71a36faca94508e34025888f01161bde97
+  data.tar.gz: af1281ebfc68219a92b15e4ca0092f16ade38dcd
 SHA512:
-  metadata.gz: a075bc85ebda03d3c35c6afd0136f6b8c4d82b86aae1a3a1371a200069bdbecaf0baf5a67b4f5e33fc50dd31937d030697122d5c083c99f1e937636b3252fca6
-  data.tar.gz: b74c4f82f34faf7e3186ad518840135a04a7a4254564c10b4813edcb5dfd045348a3ba8bdb2f05eff1d040edf3a2af7d5798d569901a56c183dda171f3f90e2a
+  metadata.gz: 885abba55dbd68875a34e736a63c81e077dca50507264978b66535e595661bedfc25a7ade19e96412ed29b5177a202284d5b93aacec128c2b9efd180dac95eb8
+  data.tar.gz: 0134fc549d395befc527dc8f6ba5b73cd792d2a907329b61bb0b2a6b003753417d911846a6585305e7cf232d1bec6275fd20bfef07d9bb70b978ba9b583b254d

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    prismic.io (1.4.2)
+    prismic.io (1.4.3)
       hashery (~> 2.1.1)
 
 GEM
@@ -44,3 +44,6 @@ DEPENDENCIES
   rspec (~> 2.14)
   simplecov (~> 0.7)
   yajl-ruby
+
+BUNDLED WITH
+   1.13.5

data/README.md

@@ -38,45 +38,23 @@ gem 'prismic.io', require: 'prismic'
 
 The quickstart is not available for Ruby yet, but if you understand Javascript you can easily adapt the code.
 
-#### Specific Ruby kit syntax
-
-Thanks to Ruby's syntax, this kit contains some mild differences and syntastic sugar over [the "Kits and helpers" section of our API documentation](https://developers.prismic.io/documentation/UjBe8bGIJ3EKtgBZ/api-documentation#kits-and-helpers) in general (which you should read first). They are listed here:
-
- * When calling the API, a faster way to pass the `ref`: directly as a parameter of the `submit` method (no need to use the `ref` method then): `api.form("everything").submit(@ref)`.
- * Accessing type-dependent fields from a `document` is done through the `[]` operator (rather than a `get()` method). Printing the HTML version of a field therefore looks like `document["title_user_friendly"].as_html(link_resolver(@ref))`.
- * Two of the fields in the `DocumentLink` object (the one used to write your `link_resolver` method, for instance) were renamed to fit Ruby's best practice: `doc.type` is in fact `doc.link_type`, and `doc.isBroken` is in fact `doc.broken?`.
- * You don't need to pass a `ctx` object in `as_html()`, you can use the `Prismic.link_resolver` static method to build a link resolver object that takes the `ref` into account, like this: `@link_resolver = Prismic.link_resolver(@ref) { |doc| ...  }`. Then you can simply go: `fragment.as_html(@link_resolver)`. Note: the Rails starter kit provides you with a helper allowing you to pass the ref each time you call the link resolver, like this: `fragment.as_html(link_resolver(@ref))`.
- * the `Response` class is fit to work with the [Kaminari](https://github.com/amatsuda/kaminari) gem. So if you have a `@response` object in your controller, you can display a whole pagination for it in your view like this: `<%= paginate @response %>` (this works with any Rails 3 or 4 app with the Kaminari gem installed).
-
-Knowing all that, here is typical code written with the Ruby kit:
-
- * A typical API object instantiation looks like this: `Prismic.api(url, opts)`
- * A typical querying looks like this: `api.query('[[:d = at(document.type, "product")]]')`
- * A typical fragment manipulation looks like this: `doc['article.image'].get_view('icon').url`
- * A typical fragment serialization to HTML looks like this: `doc['article.body'].as_html(@link_resolver)`
-
 #### Configuring Alternative API Caches
 
-The default cache stores data in-memory, in the server. You may want to use a different cache, for example to share it between several servers (with memcached or similar). A null cache (does no caching) is also available if you need a predictible behavior for testing or VCR. To use it (or any other compliant cache), simply add `api_cache => Prismic::BasicNullCache.new`
-to the options passed to `Prismic.api`.
+The default cache stores data in-memory, in the server. You may want to use a different cache, for example to share it between several servers (with memcached or similar). A null cache (does no caching) is also available if you need a predictible behavior for testing or VCR. To use it (or any other compliant cache), simply add `api_cache: Prismic::BasicNullCache.new` to the options passed to `Prismic.api`.
 
 ### Changelog
 
 Need to see what changed, or to upgrade your kit? We keep our changelog on [this repository's "Releases" tab](https://github.com/prismicio/ruby-kit/releases).
 
-### Contribute to the kit
-
-Contribution is open to all developer levels, read our "[Contribute to the official kits](https://developers.prismic.io/documentation/UszOeAEAANUlwFpp/contribute-to-the-official-kits)" documentation to learn more.
-
 #### Install the kit locally
 
 Of course, you're going to need [Ruby installed](https://www.ruby-lang.org/en/downloads/) on your computer, as well as [RubyGems](http://rubygems.org/pages/download) and [Bundler](http://bundler.io/).
 
-Clone the kit, then run ```bundle install```.
+Clone the kit, then run `bundle install`.
 
 #### Test
 
-Please write tests for any bugfix or new feature, by placing your tests in the [spec/](spec/) folder, following the [RSpec](http://rspec.info/) syntax. Launch the tests by running ```bundle exec rspec```
+Please write tests for any bugfix or new feature, by placing your tests in the [spec/](spec/) folder, following the [RSpec](http://rspec.info/) syntax. Launch the tests by running `rspec`
 
 If you find existing code that is not optimally tested and wish to make it better, we really appreciate it; but you should document it on its own branch and its own pull request.
 

data/lib/prismic/api.rb

@@ -108,6 +108,7 @@ module Prismic
     alias :getByID :get_by_id
 
     # Retrieve one document by its uid
+    # @param typ [String] the document type's name
     # @param uid [String] the uid to search
     # @param opts [Hash] query options (ref, etc.)
     # @return the document, or nil if not found
@@ -126,7 +127,7 @@ module Prismic
     alias :getByIDs :get_by_ids
 
     # Retrieve one single typed document by its type
-    # @param q [String] the query to perform
+    # @param typ [String] the document type's name
     # @param opts [Hash] query options (ref, etc.)
     # @return the document, or nil if not found
     def get_single(typ, opts={})

data/lib/prismic/predicates.rb

@@ -5,6 +5,10 @@ module Prismic
       ['at', fragment, value]
     end
 
+    def self.not(fragment, value)
+      ['not', fragment, value]
+    end
+
     def self.in(fragment, value)
       ['in', fragment, value]
     end

data/lib/prismic/version.rb

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

data/spec/fragments_spec.rb

@@ -143,6 +143,17 @@ describe 'Span' do
           'Our vanilla Macarons are made with our very own (in-house) <em>pure extract of Madagascar vanilla</em>, and subtly dusted with <strong>our own vanilla sugar</strong> (which we make from real vanilla beans).</p>'
     end
   end
+  describe 'in structured texts when image with link' do
+    before do
+      @raw_json_structured_text = File.read("#{File.dirname(__FILE__)}/responses_mocks/structured_text_image_with_link.json")
+      @json_structured_text = JSON.load(@raw_json_structured_text)
+      @structured_text = Prismic::JsonParser.structured_text_parser(@json_structured_text)
+    end
+    it 'serializes well into HTML' do
+      @structured_text.as_html(nil).should ==
+          '<p class="block-img"><a href="http://prismic.io"><img src="https://wroomdev.s3.amazonaws.com/tutoblanktemplate%2F97109f41-140e-4dc9-a2c8-96fb10f14051_star.gif" alt="" width="960" height="800" /></a></p>'
+    end
+  end
 end
 
 describe 'Text' do

data/spec/predicates_spec.rb

@@ -21,6 +21,17 @@ describe 'predicates' do
     end
   end
 
+  describe 'not predicate' do
+    it 'as an array serializes well' do
+      form = @api.form('everything').query(['not', 'document.id', 'UrjI1gEAALOCeO5i'])
+      form.data['q'].should == ['[[:d = not(document.id, "UrjI1gEAALOCeO5i")]]']
+    end
+    it 'with helper serializes well' do
+      form = @api.form('everything').query(Predicates.not('document.id', 'UrjI1gEAALOCeO5i'))
+      form.data['q'].should == ['[[:d = not(document.id, "UrjI1gEAALOCeO5i")]]']
+    end
+  end
+
   describe 'any predicate' do
     it 'with helper serializes well' do
       form = @api.form('everything').query(Predicates.any('document.type', ['article', 'blog-post']))

data/spec/responses_mocks/structured_text_image_with_link.json

@@ -0,0 +1,21 @@
+{
+    "type": "StructuredText",
+    "value": [
+        {
+            "type": "image",
+            "url": "https://wroomdev.s3.amazonaws.com/tutoblanktemplate%2F97109f41-140e-4dc9-a2c8-96fb10f14051_star.gif",
+            "alt": null,
+            "copyright": null,
+            "dimensions": {
+              "width": 960,
+              "height": 800
+            },
+            "linkTo": {
+                "type": "Link.web",
+                "value": {
+                    "url": "http://prismic.io"
+                }
+            }
+        }
+    ]
+}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: prismic.io
 version: !ruby/object:Gem::Version
-  version: 1.4.2
+  version: 1.4.3
 platform: ruby
 authors:
 - Étienne Vallette d'Osia
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-21 00:00:00.000000000 Z
+date: 2017-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -224,6 +224,7 @@ files:
 - spec/responses_mocks/fragments.json
 - spec/responses_mocks/slices.json
 - spec/responses_mocks/structured_text_heading.json
+- spec/responses_mocks/structured_text_image_with_link.json
 - spec/responses_mocks/structured_text_linkfile.json
 - spec/responses_mocks/structured_text_paragraph.json
 - spec/responses_mocks/structured_text_with_labels.json
@@ -270,6 +271,7 @@ test_files:
 - spec/responses_mocks/fragments.json
 - spec/responses_mocks/slices.json
 - spec/responses_mocks/structured_text_heading.json
+- spec/responses_mocks/structured_text_image_with_link.json
 - spec/responses_mocks/structured_text_linkfile.json
 - spec/responses_mocks/structured_text_paragraph.json
 - spec/responses_mocks/structured_text_with_labels.json