prismic.io 1.0.0.preview.6 → 1.0.0.preview.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 48b555e3c575061f3461b396c1739459780a690d
-  data.tar.gz: ec67ac158b329572e7a65e76be77bf5464139c4f
+  metadata.gz: 9978093a5e4f4f3529a05df62cbead5aa3bbb31c
+  data.tar.gz: 9f89d25cd5a8affedcc997e4fefe1d62908df492
 SHA512:
-  metadata.gz: b1f78ed016ec55f62dd5538f688f9ad887cfcb6cf7351840ba1ef2f7f85ab040ace75cd2caebb1546c4d43f1b856acea88d7f33b418a440a31e4910a1f299ba9
-  data.tar.gz: b523de93f12d9c831ce127cad7629682d4cd4d481ef785c9eaac098e7e95c4b3f038e1392f6d28b021b7c1e47ab5c91a088f14d3c2c935eb88a45bdd93392499
+  metadata.gz: 078f0e8b7fa42fd89fbaa6e8af7a16639a5e707194d1815004f540b39efec152e9c7bba3507065f5991a2cfff1e9cf1127a11b56461a2304ae1eda4f54a73a5b
+  data.tar.gz: b34a4a54f34c285ee46ca0bd570dd4c7e8f66b6712372eda66b760a02cf484c3156bdf21724ba61873fc0ab8d6c1a5804199b336586edb3567a503e1b892f2c9

data/.travis.yml

@@ -4,7 +4,6 @@ rvm:
   - 1.9.3
   - 1.9.2
   - jruby-19mode
-  - rbx-19mode
 script: bundle exec rspec spec
 notifications:
   email:

data/Gemfile.lock

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

data/README.md

@@ -4,7 +4,7 @@
 [![Build Status](https://api.travis-ci.org/prismicio/ruby-kit.png)](https://travis-ci.org/prismicio/ruby-kit)
 [![Code Climate](https://codeclimate.com/github/prismicio/ruby-kit.png)](https://codeclimate.com/github/prismicio/ruby-kit)
 
-### Getting Started
+### Getting Started with the gem
 
 #### Install using bundler
 
@@ -28,15 +28,26 @@ then add in your code:
 require 'prismic'
 ```
 
-#### Kit Documentation
+#### Getting started with prismic.io
 
-You should check out [the "Kits and helpers" section of our API documentation](https://developers.prismic.io/documentation/UjBe8bGIJ3EKtgBZ/api-documentation#kits-and-helpers), which sets general information about how our kits work. The Ruby kit is mostly compliant with it, but contains some mild differences:
+On our [prismic.io developer's portal](https://developers.prismic.io/), on top of the complete documentation, you will:
+ * get a better understanding of [what prismic.io is and how to get started with it](https://developers.prismic.io/documentation/UjBaQsuvzdIHvE4D/getting-started).
+ * get a thorough understanding of [how prismic.io kits work](https://developers.prismic.io/documentation/UjBe8bGIJ3EKtgBZ/api-documentation#kits-and-helpers), including this one. There's a couple of specificities for Ruby's case, described below.
+ * see [what else is available for Ruby](https://developers.prismic.io/technologies/UjBh6MuvzeMJvE4m/ruby).
 
- * The api object's type is Prismic::API, and the name of the method to retrieve the master ref is gotten by `api.master_ref`.
- * There's no `ctx` object to pass around; the context is passed in different ways.
- * From the api object, getting a form is done through the `create_search_form` method; a basic querying therefore looks like this: `api.create_search_form("everything").query("[[:d = at(document.type, \"product\")]]").submit(ref)`
- * Advice: the `%()` Ruby notation for strings is great for queries, as they may include quotes and/or double-quotes. The above querying is therefore even better this way: `api.create_search_form("everything").query(%([[:d = at(document.type, "product")]])).submit(ref)`
- * Accessing type-dependent fields from a `document` is done through a `fragments` hash. Printing the HTML version of a field therefore looks like `document.fragments["title_user_friendly"].as_html(link_resolver(ref)).html_safe`.
+#### Kit documentation
+
+To get a detailed documentation of the Ruby kit's variables and methods, please check out the [prismic.io Ruby kit's documentation](http://prismicio.github.io/ruby-kit/) (click on the "Class list" tab at the top-right)
+
+Need to see what changed, or to upgrade your kit? Check out [this kit's changelog](changelog.md).
+
+##### Ruby kit's specificities
+
+This Ruby 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) (which you should read first). They are listed here:
+ * From the api object, getting a form is done through the `create_search_form` method; a basic querying therefore looks like this: `api.create_search_form("everything").ref(@ref).submit()`.
+ * 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.create_search_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)).html_safe`.
+ * 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?`.
 
 #### Use it
 

data/changelog.md

@@ -0,0 +1,19 @@
+## Changelog for prismic.io Ruby development kit
+
+
+### prismic.io.1.0.0.preview.7
+
+#### Potentially breaking changes
+ * Boldness in `Prismic::Fragments::StructuredText#as_html` was represented as `<b>` tags, now as `<strong>` tags (262b5da9219cb990773a5b307f270f899b067ee5)
+
+#### New features
+ * You had to call `Prismic::Link_resolver#link_to` on a `Prismic::Fragments::DocumentLink` object, but sometimes, you actually have the full `Prismic::Document`; you can now call it on both types of objects (b1a53141e1a962762e00bd904a68d6fcd5c3a6bc).
+ * You had to call `api.master_ref` to get the master ref; now you can call it `api.master`, just like in the other dev kits; both methods do the same thing (a9e11bbb735601734512a8cefca72ed29a6bdc81).
+ * New method: `Prismic::Fragments::StructuredText#as_text`, renders zero formatting, and ignores images and embeds (d4c8c751a28afef4ef2c2e0d943cf8066ef3c039).
+ * `Prismic::SearchForm` only had the `query` method to set the `q` parameter of the API call. Now those methods are dynamically created from the RESTful form found in the `/api` document, so it's now possible to use those methods too: `orderings`, `page`, `pageSize`, as well as all the future non-yet-existing ones (fcb4e3a92dbda1b6901a1065dcf0ef4144871fdd)
+
+
+### prismic.io.1.0.0.preview.6
+
+#### Potentially breaking changes
+ * From an image, you had to call the view with its index, like this `image_object[0]`; now they're stored in a Hash, you have to call them with their proper name: `image_object['large']` (e6312b8d4486c8eacb1de7214563d45c61b5653c).

data/lib/prismic.rb

@@ -13,7 +13,7 @@ module Prismic
     end
 
     # Return the full trace of the error (including nested errors)
-    # @param  e=self Parent error (don't use)
+    # @param [Exception] e Parent error (for internal use)
     #
     # @return [String] The trace
     def full_trace(e=self)
@@ -34,16 +34,19 @@ module Prismic
   #
   # The HTTP Client must responds to same method than {DefaultHTTPClient}.
   #
-  # @param url [String] The URL of the prismic.io repository
-  # @param [String] access_token The access token
-  # @param [Hash] opts The options
-  # @option opts [String] :access_token (nil) The access_token
-  # @option opts :http_client (DefaultHTTPClient) The HTTP client to use
-  #
-  # @overload api(url, opts=nil)
+  # @overload api(url)
+  #   Simpler syntax (no configuration)
+  #   @param [String] url The URL of the prismic.io repository
+  # @overload api(url, opts)
   #   Standard use
+  #   @param [String] url The URL of the prismic.io repository
+  #   @param [Hash] opts The options
+  #   @option opts [String] :access_token (nil) The access_token
+  #   @option opts :http_client (DefaultHTTPClient) The HTTP client to use
   # @overload api(url, access_token)
   #   Provide the access_token (only)
+  #   @param [String] url The URL of the prismic.io repository
+  #   @param [String] access_token The access token
   #
   # @return [API] The API instance related to this repository
   def self.api(url, opts=nil)
@@ -63,6 +66,18 @@ module Prismic
   # in the same way than regular HTML forms.
   #
   # Get SearchForm instance through the {API#create_search_form} method.
+  #
+  # The SearchForm instance contains helper methods for each predefined form's fields.
+  # Note that these methods are not be created if they risk to add confusion:
+  # - only letters, underscore and digits are authorized in the name
+  # - name starting with a digit or an underscore are forbidden
+  # - generated method can't override existing methods
+  #
+  # @example
+  #   search_form = api.create_search_form('everything')
+  #   search_form.page(3)  # specify the field 'page'
+  #   search_form.page_size("20")  # specify the 'page_size' field
+  #   results = search_form.submit(master_ref)  # submit the search form
   class SearchForm
     attr_accessor :api, :form, :data, :ref
 
@@ -70,12 +85,49 @@ module Prismic
       @api = api
       @form = form
       @data = {}
+      form.fields.each { |name, _| create_field_helper_method(name) }
       form.default_data.each { |key, value| set(key, value) }
       data.each { |key, value| set(key, value) }
       @ref = ref
     end
 
-    def name
+    # @!method query(query)
+    #   Specify a query for this form.
+    #   @param  query [String] The query
+    #   @return [SearchForm] self
+
+    # @!method orderings(orderings)
+    #   Specify a orderings for this form.
+    #   @param  orderings [String] The orderings
+    #   @return [SearchForm] self
+
+    # @!method page(page)
+    #   Specify a page for this form.
+    #   @param  page [String,Fixum] The page
+    #   @return [SearchForm] self
+
+    # @!method page_size(page_size)
+    #   @generated
+    #   Specify a page size for this form.
+    #   @param  page_size [String,Fixum] The page size
+    #   @return [SearchForm] self
+
+    # Create the fields'helper methods
+    def create_field_helper_method(name)
+      return if name == 'ref'
+      return unless name =~ /\A[a-zA-Z][a-zA-Z0-9_]*\z/
+      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
+
+    def form_name
       form.name
     end
 
@@ -83,19 +135,19 @@ module Prismic
       form.form_method
     end
 
-    def rel
+    def form_rel
       form.rel
     end
 
-    def enctype
+    def form_enctype
       form.enctype
     end
 
-    def action
+    def form_action
       form.action
     end
 
-    def fields
+    def form_fields
       form.fields
     end
 
@@ -108,17 +160,17 @@ module Prismic
     #
     # @param  ref [Ref, String] The {Ref reference} to use (if not already defined)
     #
-    # @return [type] [description]
+    # @return [Array<Document>] The results
     def submit(ref = nil)
       self.ref(ref) if ref
       raise NoRefSetException unless @ref
 
-      if form_method == "GET" && enctype == "application/x-www-form-urlencoded"
+      if form_method == "GET" && form_enctype == "application/x-www-form-urlencoded"
         data['ref'] = @ref
         data['access_token'] = api.access_token if api.access_token
         data.delete_if { |k, v| v.nil? }
 
-        response = api.http_client.get(action, data, 'Accept' => 'application/json')
+        response = api.http_client.get(form_action, data, 'Accept' => 'application/json')
 
         if response.code.to_s == "200"
           Prismic::JsonParser.results_parser(JSON.parse(response.body))
@@ -135,15 +187,6 @@ module Prismic
       end
     end
 
-    # Specify a query for this form
-    # @api
-    # @param  query [String] The query
-    #
-    # @return [SearchForm] self
-    def query(query)
-      set('q', query)
-    end
-
     # Specify a parameter for this form
     # @param  field_name [String] The parameter's name
     # @param  value [String] The parameter's value
@@ -233,6 +276,13 @@ module Prismic
       title
     end
 
+    def [](field)
+      array = field.split('.')
+      raise ArgumentError, "Argument should contain one dot. Example: product.price" if array.length != 2
+      return nil if array[0] != self.type
+      fragments[array[1]]
+    end
+
     private
 
     def parse_fragments(fragments)
@@ -265,12 +315,17 @@ module Prismic
       @ref = ref
       @blk = blk
     end
-    def link_to(doc_link)
-      @blk.call(doc_link)
+    def link_to(doc)
+      if doc.is_a? Prismic::Fragments::DocumentLink
+        @blk.call(doc)
+      elsif doc.is_a? Prismic::Document
+        doc_link = Prismic::Fragments::DocumentLink.new(doc.id, doc.type, doc.tags, doc.slug, false)
+        @blk.call(doc_link)
+      end
     end
   end
 
-  # Default HTTP client implementation, using the standard {Net::HTTP} library.
+  # Default HTTP client implementation, using the standard Net::HTTP library.
   module DefaultHTTPClient
     class << self
       # Performs a GET call and returns the result

data/lib/prismic/api.rb

@@ -2,7 +2,14 @@
 module Prismic
   class API
     attr_reader :json, :access_token, :http_client
-    attr_accessor :refs, :bookmarks, :forms, :master, :tags, :types, :oauth
+    attr_accessor :refs, :bookmarks, :forms, :tags, :types, :oauth
+
+    # Returns the master {Ref reference}
+    # @api
+    #
+    # @return [Ref] The master {Ref reference}
+    attr_accessor :master
+    alias :master_ref :master
 
     def initialize(json, access_token, http_client)
       @json = json
@@ -31,15 +38,6 @@ module Prismic
       refs[name.downcase]
     end
 
-    # Returns the master {Ref reference}
-    # @api
-    #
-    # @return [type] [description]
-    def master_ref
-      ref('master')
-    end
-
-
     def form(name)
       forms[name]
     end

data/lib/prismic/fragments.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+require 'prismic/fragments/fragment'
 require 'prismic/fragments/block'
 require 'prismic/fragments/color'
 require 'prismic/fragments/date'

data/lib/prismic/fragments/color.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 module Prismic
   module Fragments
-    class Color
+    class Color < Fragment
       attr_accessor :value
 
       def initialize(value)

data/lib/prismic/fragments/date.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 module Prismic
   module Fragments
-    class Date
+    class Date < Fragment
       attr_accessor :value
 
       def initialize(value)

data/lib/prismic/fragments/embed.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 module Prismic
   module Fragments
-    class Embed
+    class Embed < Fragment
       attr_accessor :embed_type, :provider, :url, :html, :o_embed_json
 
       def initialize(embed_type, provider, url, html, o_embed_json)

data/lib/prismic/fragments/fragment.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+module Prismic
+	module Fragments
+		# Generic fragment, this class is to be extended by all fragment classes.
+		class Fragment
+			# Generic as_html method for fragments, meant to be overriden by
+			# specific fragment classes.
+			#
+			# @return [String] an empty string
+			def as_html(link_resolver = nil)
+				raise NotImplementedError, "Method #{__method__} is not implemented for #{inspect}", caller
+			end
+			# Generic as_text method for fragments, meant to be overriden by
+			# specific fragment classes.
+			#
+			# @return [String] an empty string
+			def as_text()
+				raise NotImplementedError, "Method #{__method__} is not implemented for #{inspect}", caller
+			end
+    	end
+	end
+end

data/lib/prismic/fragments/image.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 module Prismic
   module Fragments
-    class Image
+    class Image < Fragment
       attr_accessor :main, :views
 
       def initialize(main, views)
@@ -25,7 +25,7 @@ module Prismic
 
       class ViewDoesNotExistException < Error ; end
 
-      class View
+      class View < Fragment
         attr_accessor :url, :width, :height, :alt, :copyright
 
         def initialize(url, width, height, alt, copyright)

data/lib/prismic/fragments/link.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 module Prismic
   module Fragments
-    class Link
+    class Link < Fragment
       def as_html(link_resolver=nil)
         %(<a href="#@url">#@url</a>)
       end

data/lib/prismic/fragments/multiple.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 module Prismic
   module Fragments
-    class Multiple
+    class Multiple < Fragment
       attr_reader :fragments
 
       def initialize(fragments=[])

data/lib/prismic/fragments/number.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 module Prismic
   module Fragments
-    class Number
+    class Number < Fragment
       attr_accessor :value
 
       def initialize(value)

data/lib/prismic/fragments/select.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 module Prismic
   module Fragments
-    class Select
+    class Select < Fragment
       attr_accessor :value
 
       def initialize(value)

data/lib/prismic/fragments/structured_text.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 module Prismic
   module Fragments
-    class StructuredText
+    class StructuredText < Fragment
       class Group
         attr_reader :kind, :blocks
         def initialize(kind)
@@ -47,6 +47,15 @@ module Prismic
         }.join("\n\n")
       end
 
+      # Returns the StructuredText as plain text, with zero formatting.
+      # Non-textual blocks (like images and embeds) are simply ignored.
+      #
+      # @param separator [String] The string separator inserted between the blocks (a blank space by default)
+      # @return [String] The complete string representing the textual value of the StructuredText field.
+      def as_text(separator=' ')
+        blocks.map{|block| block.as_text }.compact.join(separator)
+      end
+
       # Finds the first highest title in a structured text
       def first_title
         max_level = 6 # any title with a higher level kicks the current one out
@@ -81,10 +90,10 @@ module Prismic
 
         class Strong < Span
           def start_html(link_resolver=nil)
-            "<b>"
+            "<strong>"
           end
           def end_html(link_resolver=nil)
-            "</b>"
+            "</strong>"
           end
         end
 
@@ -105,6 +114,15 @@ module Prismic
       end
 
       class Block
+
+        # Returns nil, as a block is not textual by default.
+        # This is meant to be overriden by textual blocks (see Prismic::Fragments::StructuredText::Block::Text.as_text, for instance)
+        #
+        # @return nil, always.
+        def as_text
+          nil
+        end
+
         class Text
           attr_accessor :text, :spans
 
@@ -139,6 +157,13 @@ module Prismic
             end
             [@start_spans, @end_spans]
           end
+
+          # Zero-formatted textual value of the block.
+          #
+          # @return The textual value.
+          def as_text
+            @text
+          end
         end
 
         class Heading < Text

data/lib/prismic/fragments/text.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 module Prismic
   module Fragments
-    class Text
+    class Text < Fragment
       attr_accessor :value
 
       def initialize(value)
@@ -11,6 +11,10 @@ module Prismic
       def as_html(link_resolver=nil)
         %(<span class="text">#{CGI::escapeHTML(@value)}</span>)
       end
+
+      def as_text
+        @value
+      end
     end
   end
 end

data/lib/prismic/version.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 module Prismic
 
-  VERSION = "1.0.0.preview.6"
+  VERSION = "1.0.0.preview.7"
 
 end

data/spec/fragments_spec.rb

@@ -23,13 +23,23 @@ describe 'WebLink' do
       Nokogiri::XML(@web_link.as_html).child.content.should == 'my_url'
     end
   end
+
+  describe 'as_text' do
+    before do
+      @web_link = Prismic::Fragments::WebLink.new('my_url')
+    end
+    it 'raises an NotImplementedError' do
+      expect { @web_link.as_text }.to raise_error NotImplementedError
+    end
+  end
 end
 
 describe 'MediaLink' do
+  before do
+    @media_link = Prismic::Fragments::MediaLink.new('my_url')
+  end
+
   describe 'as_html' do
-    before do
-      @media_link = Prismic::Fragments::MediaLink.new('my_url')
-    end
 
     it "returns an <a> HTML element" do
       Nokogiri::XML(@media_link.as_html).child.name.should == 'a'
@@ -47,13 +57,20 @@ describe 'MediaLink' do
       Nokogiri::XML(@media_link.as_html).child.content.should == 'my_url'
     end
   end
+
+  describe 'as_text' do
+    it 'raises an NotImplementedError' do
+      expect { @media_link.as_text }.to raise_error NotImplementedError
+    end
+  end
 end
 
 describe 'Text' do
+  before do
+    @text = Prismic::Fragments::Text.new('my_value')
+  end
+
   describe 'as_html' do
-    before do
-      @text = Prismic::Fragments::Text.new('my_value')
-    end
 
     it "returns a <span> HTML element" do
       Nokogiri::XML(@text.as_html).child.name.should == 'span'
@@ -72,13 +89,20 @@ describe 'Text' do
       @text.as_html.should =~ /^<[^>]+>&amp;my &lt;value&gt; #abcde<[^>]+>$/
     end
   end
+
+  describe 'as_text' do
+    it 'return the value' do
+      @text.as_text.should == 'my_value'
+    end
+  end
 end
 
 describe 'Select' do
+  before do
+    @select = Prismic::Fragments::Select.new('my_value')
+  end
+
   describe 'as_html' do
-    before do
-      @select = Prismic::Fragments::Select.new('my_value')
-    end
 
     it "returns a <span> HTML element" do
       Nokogiri::XML(@select.as_html).child.name.should == 'span'
@@ -97,6 +121,12 @@ describe 'Select' do
       @select.as_html(nil).should =~ %r{^<[^>]+>&amp;my &lt;value&gt; #abcde<[^>]+>$}
     end
   end
+
+  describe 'as_text' do
+    it 'raises an NotImplementedError' do
+      expect { @select.as_text }.to raise_error NotImplementedError
+    end
+  end
 end
 
 describe 'Date' do
@@ -113,6 +143,12 @@ describe 'Date' do
       Nokogiri::XML(@date.as_html).child.content.should == '2013-08-07T11:13:07.000+02:00'
     end
   end
+
+  describe 'as_text' do
+    it 'raises an NotImplementedError' do
+      expect { @date.as_text }.to raise_error NotImplementedError
+    end
+  end
 end
 
 describe 'Number' do
@@ -143,6 +179,12 @@ describe 'Number' do
       Nokogiri::XML(@number.as_html).child.content.should == 10.2.to_s
     end
   end
+
+  describe 'as_text' do
+    it 'raises an NotImplementedError' do
+      expect { @number.as_text }.to raise_error NotImplementedError
+    end
+  end
 end
 
 describe 'Color' do
@@ -213,6 +255,12 @@ describe 'Color' do
     end
   end
 
+  describe 'as_text' do
+    it 'raises an NotImplementedError' do
+      expect { @color.as_text }.to raise_error NotImplementedError
+    end
+  end
+
   describe 'self.valid?' do
     it "returns true if the color is valid" do
       Prismic::Fragments::Color.valid?(@hex_value).should be_true
@@ -268,6 +316,12 @@ describe 'Embed' do
       Nokogiri::XML(@embed.as_html).child.content.should == 'my_html'
     end
   end
+
+  describe 'as_text' do
+    it 'raises an NotImplementedError' do
+      expect { @embed.as_text }.to raise_error NotImplementedError
+    end
+  end
 end
 
 describe 'Image::View' do
@@ -311,6 +365,12 @@ describe 'Image::View' do
     #   Nokogiri::XML(@view.as_html).child.attribute('alt').should == nil
     # end
   end
+
+  describe 'as_text' do
+    it 'raises an NotImplementedError' do
+      expect { @view.as_text }.to raise_error NotImplementedError
+    end
+  end
 end
 
 describe 'Image' do
@@ -343,6 +403,12 @@ describe 'Image' do
       Nokogiri::XML(@image.as_html).child.attribute('alt').value.should == Nokogiri::XML(@main_view.as_html).child.attribute('alt').value
     end
   end
+
+  describe 'as_text' do
+    it 'raises an NotImplementedError' do
+      expect { @image.as_text }.to raise_error NotImplementedError
+    end
+  end
 end
 
 describe 'StructuredText' do
@@ -378,12 +444,12 @@ describe 'StructuredText::Heading' do
   it 'generates valid h1 html' do
     @heading = 1
     @block = Prismic::Fragments::StructuredText::Block::Heading.new(@text, @spans, @heading)
-    @block.as_html(nil).should == "<h1>This <em>is</em> <b>a</b> simple test.</h1>"
+    @block.as_html(nil).should == "<h1>This <em>is</em> <strong>a</strong> simple test.</h1>"
   end
   it 'generates valid h2 html' do
     @heading = 2
     @block = Prismic::Fragments::StructuredText::Block::Heading.new(@text, @spans, @heading)
-    @block.as_html(nil).should == "<h2>This <em>is</em> <b>a</b> simple test.</h2>"
+    @block.as_html(nil).should == "<h2>This <em>is</em> <strong>a</strong> simple test.</h2>"
   end
 end
 
@@ -397,7 +463,7 @@ describe 'StructuredText::Paragraph' do
     @block = Prismic::Fragments::StructuredText::Block::Paragraph.new(@text, @spans)
   end
   it 'generates valid html' do
-    @block.as_html(nil).should == "<p>This <em>is</em> <b>a</b> simple test.</p>"
+    @block.as_html(nil).should == "<p>This <em>is</em> <strong>a</strong> simple test.</p>"
   end
   it "espaces HTML content" do
     @text = '&my <value> #abcde'
@@ -406,7 +472,7 @@ describe 'StructuredText::Paragraph' do
       Prismic::Fragments::StructuredText::Span::Strong.new(0, 1),
     ]
     @block = Prismic::Fragments::StructuredText::Block::Paragraph.new(@text, @spans)
-    @block.as_html(nil).should =~ %r{^<[^>]+><b>&amp;</b>my <em>&lt;value&gt;</em> #abcde<[^>]+>$}
+    @block.as_html(nil).should =~ %r{^<[^>]+><strong>&amp;</strong>my <em>&lt;value&gt;</em> #abcde<[^>]+>$}
   end
 end
 
@@ -420,7 +486,7 @@ describe 'StructuredText::Preformatted' do
     @block = Prismic::Fragments::StructuredText::Block::Preformatted.new(@text, @spans)
   end
   it 'generates valid html' do
-    @block.as_html(nil).should == "<pre>This <em>is</em> <b>a</b> simple test.</pre>"
+    @block.as_html(nil).should == "<pre>This <em>is</em> <strong>a</strong> simple test.</pre>"
   end
 end
 
@@ -485,10 +551,6 @@ describe 'StructuredText::Hyperlink' do
   end
 end
 
-describe 'DocumentLink' do
-  describe 'as_html'
-end
-
 describe 'Multiple' do
   before do
     @multiple = Prismic::Fragments::Multiple.new

data/spec/lesbonneschoses_spec.rb

@@ -34,4 +34,38 @@ describe 'LesBonnesChoses' do
 				.submit(@master_ref).size.should == 11
 		end		
 	end
+
+	describe 'API::Document' do
+		before do
+			@document = @api.create_search_form('everything').query(%([[:d = at(document.id, "UkL0gMuvzYUANCpf")]])).submit(@master_ref)[0]
+		end
+
+		it 'Operator [] works on document' do
+			@document['job-offer.name'].as_html(nil).should == '<h1>Pastry Dresser</h1>'
+		end
+
+		it 'Operator [] returns nil if wrong type' do
+			@document['product.name'].should == nil
+		end
+
+		it 'Operator [] raises error if field is nonsense' do
+			expect {
+				@document['blablabla']
+			}.to raise_error(ArgumentError, "Argument should contain one dot. Example: product.price")
+		end
+	end
+
+	describe 'fragments' do
+		it "returns a correct as_text on a StructuredText" do
+			@api.create_search_form("everything")
+				.query(%([[:d = at(document.id, "UkL0gMuvzYUANCps")]]))
+				.submit(@master_ref)[0].fragments['body'].as_text.should == "The end of a chapter the beginning of a new one Jean-Michel Pastranova, the founder of Les Bonnes Choses, and creator of the whole concept of modern fine pastry, has decided to step down as the CEO and the Director of Workshops of Les Bonnes Choses, to focus on other projects, among which his now best-selling pastry cook books, but also to take on a primary role in a culinary television show to be announced later this year. \"I believe I've taken the Les Bonnes Choses concept as far as it can go. Les Bonnes Choses is already an entity that is driven by its people, thanks to a strong internal culture, so I don't feel like they need me as much as they used to. I'm sure they are greater ways to come, to innovate in pastry, and I'm sure Les Bonnes Choses's coming innovation will be even more mind-blowing than if I had stayed longer.\" He will remain as a senior advisor to the board, and to the workshop artists, as his daughter Selena, who has been working with him for several years, will fulfill the CEO role from now on. \"My father was able not only to create a revolutionary concept, but also a company culture that puts everyone in charge of driving the company's innovation and quality. That gives us years, maybe decades of revolutionary ideas to come, and there's still a long, wonderful path to walk in the fine pastry world.\""
+		end
+
+		it "returns a correct as_text on a StructuredText with a separator" do
+			@api.create_search_form("everything")
+				.query(%([[:d = at(document.id, "UkL0gMuvzYUANCps")]]))
+				.submit(@master_ref)[0].fragments['body'].as_text(' #### ').should == "The end of a chapter the beginning of a new one #### Jean-Michel Pastranova, the founder of Les Bonnes Choses, and creator of the whole concept of modern fine pastry, has decided to step down as the CEO and the Director of Workshops of Les Bonnes Choses, to focus on other projects, among which his now best-selling pastry cook books, but also to take on a primary role in a culinary television show to be announced later this year. #### \"I believe I've taken the Les Bonnes Choses concept as far as it can go. Les Bonnes Choses is already an entity that is driven by its people, thanks to a strong internal culture, so I don't feel like they need me as much as they used to. I'm sure they are greater ways to come, to innovate in pastry, and I'm sure Les Bonnes Choses's coming innovation will be even more mind-blowing than if I had stayed longer.\" #### He will remain as a senior advisor to the board, and to the workshop artists, as his daughter Selena, who has been working with him for several years, will fulfill the CEO role from now on. #### \"My father was able not only to create a revolutionary concept, but also a company culture that puts everyone in charge of driving the company's innovation and quality. That gives us years, maybe decades of revolutionary ideas to come, and there's still a long, wonderful path to walk in the fine pastry world.\""
+		end
+	end
 end

data/spec/prismic_spec.rb

@@ -46,6 +46,18 @@ describe 'Api' do
     end
   end
 
+  describe 'master_ref' do
+    it "returns the right Ref" do
+      @api.master_ref.label.should == 'label3'
+    end
+  end
+
+  describe 'master' do
+    it "returns the right Ref" do
+      @api.master.label.should == 'label3'
+    end
+  end
+
   describe 'form' do
     it "return the right Form" do
       @api.form('form2').name.should == 'form2'
@@ -222,6 +234,25 @@ describe 'Api' do
 
 end
 
+describe 'LinkResolver' do
+  before do
+    @doc_link = Prismic::Fragments::DocumentLink.new('id', 'blog-post', ['tag1', 'tag2'], 'my-slug', false)
+    @document = Prismic::Document.new('id', 'blog-post', nil, ['tag1', 'tag2'], ['my-slug', 'my-other-slug'], nil)
+
+    @link_resolver = Prismic::LinkResolver.new(nil) do |doc|
+      '/'+doc.link_type+'/'+doc.id+'/'+doc.slug
+    end
+  end
+  
+  it "builds the right URL from a DocumentLink" do
+    @link_resolver.link_to(@doc_link).should == '/blog-post/id/my-slug'
+  end
+  
+  it "builds the right URL from a Document" do
+    @link_resolver.link_to(@document).should == '/blog-post/id/my-slug'
+  end
+end
+
 describe 'Document' do
   before do
     fragments = {
@@ -299,6 +330,46 @@ describe 'SearchForm' do
     form.create_search_form
   end
 
+  describe 'fields methods' do
+
+    it "should be created for each valid field names" do
+      @form = create_form('a_param' => @field)
+      @form.should respond_to(:a_param)
+    end
+
+    it "should be created for each valid field names with number" do
+      @form = create_form('a_param2' => @field)
+      @form.should respond_to(:a_param2)
+    end
+
+    it "should be created for each camelCase field names" do
+      @form = create_form('anExampleParam0A0B' => @field)
+      @form.should respond_to(:an_example_param0_a0_b)
+    end
+
+    it "should not be created for field names begining with a number" do
+      @form = create_form('2param' => @field)
+      @form.should_not respond_to(:'2param')
+    end
+
+    it "should not be created for field names begining with an underscore" do
+      @form = create_form('_param' => @field)
+      @form.should_not respond_to(:'_param')
+    end
+
+    it "should not be created for field names containing invalid characters" do
+      @form = create_form('a-param' => @field)
+      @form.should_not respond_to(:'a-param')
+    end
+
+    it "should not be created if a method with same name already exists" do
+      Prismic::SearchForm.module_exec { def param_example_for_tests() "ok" end }
+      @form = create_form('param_example_for_tests' => @field)
+      @form.param_example_for_tests.should == "ok"
+    end
+
+  end
+
   describe 'set() for queries' do
 
     it "append value for repeatable fields" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: prismic.io
 version: !ruby/object:Gem::Version
-  version: 1.0.0.preview.6
+  version: 1.0.0.preview.7
 platform: ruby
 authors:
 - Étienne Vallette d'Osia
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-27 00:00:00.000000000 Z
+date: 2013-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,6 +80,7 @@ files:
 - Gemfile.lock
 - README.md
 - Rakefile
+- changelog.md
 - lib/prismic.rb
 - lib/prismic/api.rb
 - lib/prismic/form.rb
@@ -88,6 +89,7 @@ files:
 - lib/prismic/fragments/color.rb
 - lib/prismic/fragments/date.rb
 - lib/prismic/fragments/embed.rb
+- lib/prismic/fragments/fragment.rb
 - lib/prismic/fragments/image.rb
 - lib/prismic/fragments/link.rb
 - lib/prismic/fragments/multiple.rb
@@ -128,7 +130,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.6
+rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
 summary: Prismic.io development kit
@@ -143,4 +145,3 @@ test_files:
 - spec/responses_mocks/structured_text_heading.json
 - spec/responses_mocks/structured_text_paragraph.json
 - spec/spec_helper.rb
-has_rdoc: