prismic.io 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8622f78a1a654d406af4edf4471810ab14e0a4a2
-  data.tar.gz: 3861bfec9717d19b0e047d86f4e28375b6f801d6
+  metadata.gz: 0efa24b3f98e9f3dc05f26b50f7125e45409afa2
+  data.tar.gz: fb6164ea1e1fa198951e92353429fc985e4432b1
 SHA512:
-  metadata.gz: 962b52cb0b6fa39f30058653bbbc99e44d33be0516a30afd6a8ba3c7cae6ff1ef1643da2818e8eaa1cde8e751f532b4c881f83e75f0e929a6846a36da2e0c2f2
-  data.tar.gz: 004429336746943544191ae573d28fddd03dc8147292020ca4a7836fddc6d47f2748384f86004070463f8ab15b331bae88561792f8577a279121120395532da0
+  metadata.gz: 7af5bae716dcdf93e5672a8639b71ce1974c903a352739c2cf27d8dbf600b16b396bd5c4f273787f723c612aff16f1e6f4750f68cb3f40f8288d6a115e8e2501
+  data.tar.gz: 14d0b5d69449eeb4e3ec27a8524a0eb69358ad45545b46cc75d5cea1ee061a59cee26e6c672392a4ea555c7561b73fe41132f3eb72b696027eec99919a1cd091

data/.gitignore

@@ -2,4 +2,7 @@ coverage/
 pkg/*.gem
 .bundle/
 .idea/
+.yardoc/
+doc/
+
 

data/.travis.yml

@@ -17,4 +17,5 @@ deploy:
   gemspec: prismic.gemspec
   on:
     tags: true
+    all_branches: true
     repo: prismicio/ruby-kit

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    prismic.io (1.0.1)
+    prismic.io (1.0.2)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -95,3 +95,4 @@ Copyright 2013 Zengularity (http://www.zengularity.com).
 Licensed under the Apache License, Version 2.0 (the "License"); you may not use this project except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0.
 
 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+

data/deploy-doc.sh

@@ -0,0 +1,9 @@
+yard && \
+cd doc && \
+rm -rf doc/phpdoc-cache-* && \
+git init . && \
+git add . && \
+git commit -m "Update documentation."; \
+git push "git@github.com:prismicio/ruby-kit.git" master:gh-pages --force && \
+rm -rf .git
+

data/lib/prismic.rb

@@ -142,10 +142,33 @@ module Prismic
       @ref = ref
     end
 
-    # @!method query(query)
-    #   Specify a query for this form.
+    # Specify a query for this form.
     #   @param  query [String] The query
     #   @return [SearchForm] self
+    def query(*query)
+      q(*query)
+    end
+
+    def q(*query)
+      def serialize(field)
+        if field.kind_of?(String) and not (field.start_with?('my.') or field.start_with?('document.'))
+          %("#{field}")
+        elsif field.kind_of?(Array)
+          %([#{field.map{ |arg| serialize(arg) }.join(', ')}])
+        else
+          %(#{field})
+        end
+      end
+      if query[0].kind_of?(String)
+        set('q', query[0])
+      else
+        predicates = query.map { |q|
+          op = q.shift
+          "[:d = #{op}(#{q.map { |arg| serialize(arg) }.join(', ')})]"
+        }
+        set('q', "[#{predicates * ''}]")
+      end
+    end
 
     # @!method orderings(orderings)
     #   Specify a orderings for this form.
@@ -169,11 +192,6 @@ module Prismic
       meth_name = name.gsub(/([A-Z])/, '_\1').downcase
       return if respond_to?(meth_name)
       define_singleton_method(meth_name){|value| set(name, value) }
-      if name == 'q'
-        class << self
-          alias :query :q
-        end
-      end
     end
     private :create_field_helper_method
 
@@ -605,6 +623,7 @@ end
 require 'prismic/api'
 require 'prismic/form'
 require 'prismic/fragments'
+require 'prismic/predicates'
 require 'prismic/json_parsers'
 require 'prismic/cache/lru'
 require 'prismic/cache/basic'

data/lib/prismic/fragments/group.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 module Prismic
   module Fragments
 

data/lib/prismic/fragments/structured_text.rb

@@ -190,16 +190,27 @@ module Prismic
               if pos < text.length
                 if stack.empty?
                   # Top level text
-                  html += CGI::escapeHTML(text[pos])
+                  html += cgi_escape_html(text[pos])
                 else
                   # Inner text of a span
-                  stack[-1][:html] += CGI::escapeHTML(text[pos])
+                  stack[-1][:html] += cgi_escape_html(text[pos])
                 end
               end
             end
             html
           end
 
+          def cgi_escape_html(string)
+            # We don't use CGI::escapeHTML because the implementation changed from 1.9 to 2.0 and that break tests
+            string.gsub(/['&\"<>]/, {
+                "'" => '&#39;',
+                '&' => '&amp;',
+                '"' => '&quot;',
+                '<' => '&lt;',
+                '>' => '&gt;',
+            })
+          end
+
           # Building two span Hashes:
           #  * start_spans, with the starting positions as keys, and spans as values
           #  * end_spans, with the ending positions as keys, and spans as values
@@ -234,7 +245,7 @@ module Prismic
             end
           end
 
-          private :class_code
+          private :class_code, :cgi_escape_html
         end
 
         class Heading < Text

data/lib/prismic/predicates.rb

@@ -0,0 +1,101 @@
+module Prismic
+  module Predicates
+
+    def self.at(fragment, value)
+      ['at', fragment, value]
+    end
+
+    def self.any(fragment, values)
+      ['any', fragment, values]
+    end
+
+    def self.fulltext(fragment, values)
+      ['fulltext', fragment, values]
+    end
+
+    def self.similar(fragment, value)
+      ['similar', fragment, value]
+    end
+
+    def self.gt(fragment, value)
+      ['number.gt', fragment, value]
+    end
+
+    def self.lt(fragment, value)
+      ['number.lt', fragment, value]
+    end
+
+    def self.in_range(fragment, before, after)
+      ['number.inRange', fragment, before, after]
+    end
+
+    def self.date_before(fragment, before)
+      ['date.before', fragment, before]
+    end
+
+    def self.date_after(fragment, after)
+      ['date.after', fragment, after]
+    end
+
+    def self.date_between(fragment, before, after)
+      ['date.between', fragment, before, after]
+    end
+
+    def self.day_of_month(fragment, day)
+      ['date.day-of-month', fragment, day]
+    end
+
+    def self.day_of_month_after(fragment, day)
+      ['date.day-of-month-after', fragment, day]
+    end
+
+    def self.day_of_month_before(fragment, day)
+      ['date.day-of-month-before', fragment, day]
+    end
+
+    def self.day_of_week(fragment, day)
+      ['date.day-of-week', fragment, day]
+    end
+
+    def self.day_of_week_after(fragment, day)
+      ['date.day-of-week-after', fragment, day]
+    end
+
+    def self.day_of_week_before(fragment, day)
+      ['date.day-of-week-before', fragment, day]
+    end
+
+    def self.month(fragment, month)
+      ['date.month', fragment, month]
+    end
+
+    def self.month_before(fragment, month)
+      ['date.month-before', fragment, month]
+    end
+
+    def self.month_after(fragment, month)
+      ['date.month-after', fragment, month]
+    end
+
+    def self.year(fragment, year)
+      ['date.year', fragment, year]
+    end
+
+    def self.hour(fragment, hour)
+      ['date.hour', fragment, hour]
+    end
+
+    def self.hour_before(fragment, hour)
+      ['date.hour-before', fragment, hour]
+    end
+
+    def self.hour_after(fragment, hour)
+      ['date.hour-after', fragment, hour]
+    end
+
+    def self.near(fragment, latitude, longitude, radius)
+      ['geopoint.near', fragment, latitude, longitude, radius]
+    end
+
+  end
+end

data/lib/prismic/version.rb

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

data/spec/fragments_spec.rb

@@ -663,10 +663,10 @@ end
 
 describe 'Group' do
   before do
-    @micro_api = Prismic.api("https://micro.prismic.io/api", nil)
+    @micro_api = Prismic.api('https://micro.prismic.io/api', nil)
     @master_ref = @micro_api.master_ref
-    @docchapter = @micro_api.form("everything").query(%([[:d = at(document.type, "docchapter")]])).orderings('[my.docchapter.priority]').submit(@master_ref)[0]
-    @link_resolver = Prismic.link_resolver("master"){|doc_link| "http://localhost/#{doc_link.link_type}/#{doc_link.id}" }
+    @docchapter = @micro_api.form('everything').query('[[:d = at(document.type, "docchapter")]]').orderings('[my.docchapter.priority]').submit(@master_ref)[0]
+    @link_resolver = Prismic.link_resolver('master'){|doc_link| "http://localhost/#{doc_link.link_type}/#{doc_link.id}" }
   end
 
   it 'accesses fields the proper way' do

data/spec/micro_spec.rb

@@ -10,7 +10,7 @@ describe 'micro' do
 
   describe 'embed block in structured text fragments' do
     it 'is of the right Embed object, and serializes well' do
-      fragment = @api.form("everything").query(%([[:d = at(document.id, "UrjI1gEAALOCeO5i")]])).submit(@master_ref)[0]['article.body']
+      fragment = @api.form("everything").query(%w(at document.id UrjI1gEAALOCeO5i)).submit(@master_ref)[0]['article.body']
       fragment.blocks[4].is_a?(Prismic::Fragments::Embed).should == true
       fragment.as_html(@link_resolver).gsub(/[\n\r]+/, '').gsub(/ +/, ' ').gsub(/&#39;/, "'").should == %(<h2>The meta-micro mailing-list</h2><p>This is where you go to give feedback, and discuss the future of micro. <a href="https://groups.google.com/forum/?hl=en#!forum/micro-meta-framework">Subscribe to the list now</a>!</p><h2>The micro GitHub repository</h2><p>This is where you get truly active, by forking the project's source code, and making it better. Please always feel free to send us pull requests.</p> <div data-oembed="" data-oembed-type="link" data-oembed-provider="object"><div data-type="object"><a href="https://github.com/rudyrigot/meta-micro"><h1>rudyrigot/meta-micro</h1><img src="https://avatars2.githubusercontent.com/u/552279?s=400"><p>The meta-micro-framework you simply need</p></a></div></div><h2>Report bugs on micro</h2><p>If you think micro isn't working properly in one of its features, <a href="https://github.com/rudyrigot/meta-micro/issues">open a new issue in the micro GitHub repository</a>.</p><h2>Ask for help</h2><p>Feel free to ask a new question <a href="http://stackoverflow.com/questions/tagged/meta-micro">on StackOverflow</a>.</p>)
     end

data/spec/predicates_spec.rb

@@ -0,0 +1,86 @@
+# encoding: utf-8
+require 'spec_helper'
+
+Predicates = Prismic::Predicates
+
+describe 'predicates' do
+  before do
+    @api = Prismic.api('https://micro.prismic.io/api', nil)
+    @master_ref = @api.master_ref
+    @link_resolver = Prismic.link_resolver('master'){|doc_link| "http://localhost/#{doc_link.id}" }
+  end
+
+  describe 'at predicate' do
+    it 'as an array serializes well' do
+      form = @api.form('everything').query(['at', 'document.id', 'UrjI1gEAALOCeO5i'])
+      form.data['q'].should == ['[[:d = at(document.id, "UrjI1gEAALOCeO5i")]]']
+    end
+    it 'with helper serializes well' do
+      form = @api.form('everything').query(Predicates.at('document.id', 'UrjI1gEAALOCeO5i'))
+      form.data['q'].should == ['[[:d = at(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']))
+      form.data['q'].should == ['[[:d = any(document.type, ["article", "blog-post"])]]']
+    end
+  end
+
+  describe 'similar predicate' do
+    it 'as an array serializes well' do
+      form = @api.form('everything').query(['similar', 'idOfSomeDocument', 10])
+      form.data['q'].should == ['[[:d = similar("idOfSomeDocument", 10)]]']
+    end
+    it 'with helpers serializes well' do
+      form = @api.form('everything').query(Predicates.similar('idOfSomeDocument', 10))
+      form.data['q'].should == ['[[:d = similar("idOfSomeDocument", 10)]]']
+    end
+  end
+
+  describe 'multiple predicates' do
+    it 'as an array serializes well' do
+      form = @api.form('everything').query(
+          ['date.month-after', 'my.blog-post.publication-date', 4],
+          ['date.month-before', 'my.blog-post.publication-date', 'December']
+      )
+      form.data['q'].should == ['[[:d = date.month-after(my.blog-post.publication-date, 4)][:d = date.month-before(my.blog-post.publication-date, "December")]]']
+    end
+    it 'with helpers serializes well' do
+      form = @api.form('everything').query(
+          Predicates.month_after('my.blog-post.publication-date', 4),
+          Predicates.month_before('my.blog-post.publication-date', 'December')
+      )
+      form.data['q'].should == ['[[:d = date.month-after(my.blog-post.publication-date, 4)][:d = date.month-before(my.blog-post.publication-date, "December")]]']
+    end
+  end
+
+  describe 'number LT' do
+    it 'with helpers serializes well' do
+      form = @api.form('everything').query(
+          Predicates.lt('my.blog-post.publication-date', 4)
+      )
+      form.data['q'].should == ['[[:d = number.lt(my.blog-post.publication-date, 4)]]']
+    end
+  end
+
+  describe 'number in range' do
+    it 'with helpers serializes well' do
+      form = @api.form('everything').query(
+          Predicates.in_range('my.product.price', 2, 4.5)
+      )
+      form.data['q'].should == ['[[:d = number.inRange(my.product.price, 2, 4.5)]]']
+    end
+  end
+
+  describe 'geopoint near' do
+    it 'with helpers serializes well' do
+      form = @api.form('everything').query(
+          Predicates.near('my.store.coordinates', 40.689757, -74.0451453, 15)
+      )
+      form.data['q'].should == ['[[:d = geopoint.near(my.store.coordinates, 40.689757, -74.0451453, 15)]]']
+    end
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: prismic.io
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Étienne Vallette d'Osia
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-23 00:00:00.000000000 Z
+date: 2014-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -79,11 +79,11 @@ files:
 - .gitignore
 - .travis.yml
 - .yardopts
-- Changelog.md
 - Gemfile
 - Gemfile.lock
 - README.md
 - Rakefile
+- deploy-doc.sh
 - lib/prismic.rb
 - lib/prismic/api.rb
 - lib/prismic/cache/basic.rb
@@ -105,6 +105,7 @@ files:
 - lib/prismic/fragments/text.rb
 - lib/prismic/fragments/timestamp.rb
 - lib/prismic/json_parsers.rb
+- lib/prismic/predicates.rb
 - lib/prismic/version.rb
 - prismic.gemspec
 - spec/cache_spec.rb
@@ -113,6 +114,7 @@ files:
 - spec/lesbonneschoses_spec.rb
 - spec/micro_spec.rb
 - spec/oauth_spec.rb
+- spec/predicates_spec.rb
 - spec/prismic_spec.rb
 - spec/responses_mocks/api.json
 - spec/responses_mocks/document.json
@@ -155,6 +157,7 @@ test_files:
 - spec/lesbonneschoses_spec.rb
 - spec/micro_spec.rb
 - spec/oauth_spec.rb
+- spec/predicates_spec.rb
 - spec/prismic_spec.rb
 - spec/responses_mocks/api.json
 - spec/responses_mocks/document.json
@@ -166,3 +169,4 @@ test_files:
 - spec/responses_mocks/structured_text_with_labels.json
 - spec/responses_mocks/structured_text_with_tricky_spans.json
 - spec/spec_helper.rb
+has_rdoc: 

data/Changelog.md

@@ -1,7 +0,0 @@
-### 1.0.0.rc10 (2014-09-10)
-
-Features:
-
-  - Support for links in images
-  - Support for Timestamp fragments
-  - Support for Geopoint fragments