prismic.io 1.0.0.preview.8 → 1.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 22c9fa81f67d2c7120d3d0aeaa476257392d324b
-  data.tar.gz: ec3215425959d51198428fa75827b3b69ca14d5b
+  metadata.gz: dfc8f36ad84978908dd0e3de61caaf36a354c572
+  data.tar.gz: 9faacc27422f43a5e668136082398036a95a3034
 SHA512:
-  metadata.gz: 608f58c15fab9a73a487f01b69301679e8ffcc54e4dcbae98bdda8c57d6b69191216d48c63ed5b1e208e5a53b13a0ff498101136d0f3db5ce30011bde8f6573e
-  data.tar.gz: c41729c800aeac6d103569cbbee76d4679854e9bc55d0f8956645815f5e5f3e81a58b03da82a5406cc2fcaf0311d2aa17a9179f54397350a6e3090c02bd91419
+  metadata.gz: b70799f5a36b767f8635017c7b6451b2162285f38027d578fe7d31844dad2332d23e9afe19685be06af1293773debf7366dbb5a31301c61c42db0bdee4e4c156
+  data.tar.gz: f3b17450288b894a4f5e37943608630c14ae9a990483e5cb6691ac7ca81a984cc7b4602cd3e0d108527a9cee857b0454213e8f15a0eb2bf813d8def439d25594

data/.gitignore

@@ -1,2 +1,3 @@
 coverage/
 pkg/*.gem
+.bundle/

data/Gemfile.lock

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

data/README.md

@@ -4,53 +4,73 @@
 [![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 with the gem
+### Getting Started
 
-#### Install using bundler
+#### Install the kit for your project
 
-You can this line in your Gemfile:
+*(Assuming that [Ruby is installed](https://www.ruby-lang.org/en/downloads/) on your computer, as well as [RubyGems](http://rubygems.org/pages/download))*
 
-```ruby
-gem 'prismic.io', require: 'prismic'
-```
 
-#### Install manually
-
-Run in shell:
+To install the gem on your computer, run in shell:
 
 ```sh
 gem install prismic.io --pre
 ```
-
 then add in your code:
-
 ```ruby
 require 'prismic'
 ```
 
-#### Getting started with prismic.io
+To add the gem as a dependency to your project with [Bundler](http://bundler.io/), you can add this line in your Gemfile:
 
-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).
+```ruby
+gem 'prismic.io', require: 'prismic'
+```
 
-#### Kit documentation
+#### Get started with prismic.io
 
-To get a detailed documentation of the Ruby kit's variables and methods, please check out the [prismic.io Ruby kit's documentation](http://rubydoc.info/github/prismicio/ruby-kit/master/frames)
+You can find out [how to get started with prismic.io](https://developers.prismic.io/documentation/UjBaQsuvzdIHvE4D/getting-started) on our [prismic.io developer's portal](https://developers.prismic.io/).
 
-Need to see what changed, or to upgrade your kit? Check out [this kit's changelog](changelog.md).
+#### Get started using the kit
+
+Also on our [prismic.io developer's portal](https://developers.prismic.io/), on top of our full documentation, you will:
+ * get a thorough introduction of [how to use prismic.io kits](https://developers.prismic.io/documentation/UjBe8bGIJ3EKtgBZ/api-documentation#kits-and-helpers), including this one.
+ * see [what else is available for Ruby](https://developers.prismic.io/technologies/UjBh6MuvzeMJvE4m/ruby): starter projects, examples, ...
+
+#### Kit's detailed documentation
 
-##### Ruby kit's specificities
+To get a detailed documentation of the Ruby kit's variables and methods, please check out the [prismic.io Ruby kit's documentation](http://rubydoc.info/github/prismicio/ruby-kit/master/frames).
 
-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:
+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?`.
 
-#### Use it
+### Changelog
+
+Need to see what changed, or to upgrade your kit? Check out [this kit's changelog](changelog.md).
+
+### 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```.
+
+#### 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```
+
+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.
+
+#### Documentation
+
+Please document any bugfix or new feature, using the [Yard](http://yardoc.org/) syntax. Don't worry about generating the doc, we'll take care of that.
 
-You can look at the [rails starter](https://github.com/prismicio/ruby-rails-starter) project to see how to use it :-)
+If you find existing code that is not optimally documented and wish to make it better, we really appreciate it; but you should document it on its own branch and its own pull request.
 
 ### Licence
 

data/changelog.md

@@ -1,5 +1,20 @@
 ## Changelog for prismic.io Ruby development kit
 
+### prismic.io.1.0.0.rc1
+
+#### Potentially breaking changes for advanced users
+
+ * **If you've been monkey-patching or overriding the `Prismic::Fragments::MediaLink`** class: it doesn't exist anymore, and is now replaced by `Prismic::Fragments::FileLink` or `Prismic::Fragments::ImageLink`, depending on the kind of link.
+
+#### New features
+ * Support for `Link.image` and `Link.file` kinds of links, with new `Prismic::Fragments::FileLink` and `Prismic::Fragments::ImageLink` classes.
+ * `Prismic::Fragments::Group` class now includes `Enumerable`, which means you can use `each`, `map`, `select`, etc. on `Group` objects. Same with `Prismic::Fragments::Group::FragmentMapping` objects (used internally by the `Group` class).
+ * `Prismic::Fragments::Group` class now have a `length` method, aliased as `size`. Same with `Prismic::Fragments::Group::FragmentMapping` objects (used internally by the `Group` class).
+ * The `url` method only existed for the `Prismic::Fragments::WebLink` class, now it is directly in the `Prismic::Fragments::Link` class, extended by all links classes: `Prismic::Fragments::WebLink`, `Prismic::Fragments::DocumentLink`, etc...
+
+#### Syntactic sugar
+ *  Since you can now call `url` on any kind of link (see right above), this allows to do this in Rails, regardless of the kind of link the `link` object is: `<%= link_to "Click here", link.url, :whatever_attribute => "whatever value" %>`.
+
 ### prismic.io.1.0.0.preview.8
 
 #### New features
@@ -11,7 +26,7 @@
 
 ### prismic.io.1.0.0.preview.7
 
-#### Potentially breaking changes
+#### Potentially breaking changes for basic users
  * Boldness in `Prismic::Fragments::StructuredText#as_html` was represented as `<b>` tags, now as `<strong>` tags.
 
 #### New features
@@ -23,5 +38,5 @@
 
 ### prismic.io.1.0.0.preview.6
 
-#### Potentially breaking changes
+#### Potentially breaking changes for basic users
  * 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']`.

data/lib/prismic/fragments/group.rb

@@ -20,6 +20,16 @@ module Prismic
 				@fragment_list_array[i]
 			end
 
+			def each(&blk)
+				@fragment_list_array.each(&blk)
+			end
+			include Enumerable  # adds map, select, etc
+
+			def length
+				@fragment_list_array.length
+			end
+			alias :size :length
+
 			def as_html(link_resolver = nil)
 				@fragment_list_array.map { |fl| fl.as_html(link_resolver) }.join("\n")
 			end
@@ -28,6 +38,7 @@ module Prismic
 				@fragment_list_array.map { |fl| fl.as_text }.join("\n")
 			end
 
+
 			class FragmentMapping
 
 				# a hash containing all the fragments in the fragment list
@@ -42,6 +53,16 @@ module Prismic
 					@fragments[name]
 				end
 
+				def each(&blk)
+					@fragments.each(&blk)
+				end
+				include Enumerable  # adds map, select, etc
+
+				def length
+					@fragments.length
+				end
+				alias :size :length
+
 				def as_html(link_resolver = nil)
 					@fragments.map { |name, fragment|
 						%(<section data-field="#{name}">#{fragment.as_html(link_resolver)}</section>)

data/lib/prismic/fragments/link.rb

@@ -14,6 +14,11 @@ module Prismic
       def as_html(link_resolver=nil)
         %(#{start_html(link_resolver)}#@url#{end_html(link_resolver)})
       end
+
+      def url(link_resolver=nil)
+        @url
+      end
+
     end
 
     class WebLink < Link
@@ -24,7 +29,23 @@ module Prismic
       end
     end
 
-    class MediaLink < Link
+    class FileLink < Link
+      attr_accessor :url, :name, :kind, :size
+
+      def initialize(url, name, kind, size)
+        @url = url
+        @name = name
+        @kind = kind
+        @size = size
+      end
+
+      def as_html(link_resolver=nil)
+        %(#{start_html(link_resolver)}#@name#{end_html(link_resolver)})
+      end
+
+    end
+
+    class ImageLink < Link
       attr_accessor :url
 
       def initialize(url)
@@ -44,8 +65,7 @@ module Prismic
       end
 
       def start_html(link_resolver)
-        raise "A link_resolver method is needed to serialize document links into a correct URL on your website. If you're using a starter kit, a trivial one is provided out-of-the-box, that you can update later." if link_resolver == nil
-        broken? ? %(<span>) : %(<a href="#{link_resolver.link_to(self)}">)
+        broken? ? %(<span>) : %(<a href="#{self.url(link_resolver)}">)
       end
 
       def end_html(link_resolver = nil)
@@ -56,6 +76,11 @@ module Prismic
         %(#{start_html(link_resolver)}#{slug}#{end_html(link_resolver)})
       end
 
+      def url(link_resolver)
+        raise "A link_resolver method is needed to serialize document links into a correct URL on your website. If you're using a starter kit, a trivial one is provided out-of-the-box, that you can update later." if link_resolver == nil
+        link_resolver.link_to(self)
+      end
+
       alias :broken? :broken
     end
   end

data/lib/prismic/json_parsers.rb

@@ -8,6 +8,8 @@ module Prismic
           '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),
           'Number'         => method(:number_parser),
           'Embed'          => method(:embed_parser),
@@ -30,6 +32,14 @@ module Prismic
           json['value']['isBroken'])
       end
 
+      def image_link_parser(json)
+        Prismic::Fragments::ImageLink.new(json['value']['image']['url'])
+      end
+
+      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'])
+      end
+
       def text_parser(json)
         Prismic::Fragments::Text.new(json['value'])
       end
@@ -209,6 +219,10 @@ module Prismic
           document_link_parser(json)
         elsif json['type'] == 'Link.web'
           web_link_parser(json)
+        elsif json['type'] == 'Link.image'
+          image_link_parser(json)
+        elsif json['type'] == 'Link.file'
+          file_link_parser(json)
         end
       end
     end

data/lib/prismic/version.rb

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

data/spec/fragments_spec.rb

@@ -34,37 +34,50 @@ describe 'WebLink' do
   end
 end
 
-describe 'MediaLink' do
+describe 'ImageLink' do
   before do
-    @media_link = Prismic::Fragments::MediaLink.new('my_url')
+    @image_link = Prismic::Fragments::ImageLink.new('my_url')
   end
 
   describe 'as_html' do
 
     it "returns an <a> HTML element" do
-      Nokogiri::XML(@media_link.as_html).child.name.should == 'a'
+      Nokogiri::XML(@image_link.as_html).child.name.should == 'a'
     end
 
     it "returns a HTML element with an href attribute" do
-      Nokogiri::XML(@media_link.as_html).child.has_attribute?('href').should be_true
+      Nokogiri::XML(@image_link.as_html).child.has_attribute?('href').should be_true
     end
 
     it "returns a HTML element with an href attribute pointing to the url" do
-      Nokogiri::XML(@media_link.as_html).child.attribute('href').value.should == 'my_url'
+      Nokogiri::XML(@image_link.as_html).child.attribute('href').value.should == 'my_url'
     end
 
     it "returns a HTML element whose content is the link" do
-      Nokogiri::XML(@media_link.as_html).child.content.should == 'my_url'
+      Nokogiri::XML(@image_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
+      expect { @image_link.as_text }.to raise_error NotImplementedError
     end
   end
 end
 
+describe 'FileLink' do
+	describe 'in structured texts' do
+		before do
+			@raw_json_structured_text = File.read("#{File.dirname(__FILE__)}/responses_mocks/structured_text_linkfile.json")
+			@json_structured_text = JSON.parse(@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><a href=\"https://prismic-io.s3.amazonaws.com/annual.report.pdf\">2012 Annual Report</p>\n\n<p><a href=\"https://prismic-io.s3.amazonaws.com/annual.budget.pdf\">2012 Annual Budget</p>\n\n<p><a href=\"https://prismic-io.s3.amazonaws.com/vision.strategic.plan_.sm_.pdf\">2015 Vision &amp; Strategic Plan</p>"
+		end
+	end
+end
+
 describe 'Text' do
   before do
     @text = Prismic::Fragments::Text.new('my_value')
@@ -585,4 +598,25 @@ describe 'Group' do
     @docchapter['docchapter.docs'].as_html(@link_resolver).should == "<section data-field=\"linktodoc\"><a href=\"http://localhost/doc/UrDofwEAALAdpbNH\">with-jquery</a></section>\n<section data-field=\"linktodoc\"><a href=\"http://localhost/doc/UrDp8AEAAPUdpbNL\">with-bootstrap</a></section>"
   end
 
+  it 'loops through the group fragment properly' do
+    @docchapter['docchapter.docs']
+      .map{ |fragments| fragments['linktodoc'].slug }
+      .join(' ').should == "with-jquery with-bootstrap"
+  end
+
+  it 'returns the proper length of a group fragment' do
+    @docchapter['docchapter.docs'].length.should == 2
+    @docchapter['docchapter.docs'].size.should == 2
+  end
+
+  it 'loops through the subfragment list properly' do
+    @docchapter['docchapter.docs'][0].count.should == 1
+    @docchapter['docchapter.docs'][0].first[0].should == "linktodoc"
+  end
+
+  it 'returns the proper length of the sunfragment list' do
+    @docchapter['docchapter.docs'][0].length.should == 1
+    @docchapter['docchapter.docs'][0].size.should == 1
+  end
+
 end

data/spec/json_parsers_spec.rb

@@ -199,6 +199,34 @@ json
   end
 end
 
+describe 'file_link_parser' do
+  before do
+    raw_json = <<json
+    {
+      "type": "Link.file",
+      "value": {
+        "file": {
+          "name": "2012_annual.report.pdf",
+          "kind": "document",
+          "url": "https://prismic-io.s3.amazonaws.com/annual.report.pdf",
+          "size": "1282484"
+        }
+      }
+    }
+json
+    @json = JSON.parse(raw_json)
+    @link_file = Prismic::JsonParser.file_link_parser(@json)
+  end
+
+  it 'correctly parses file links' do
+    @link_file.url.should == "https://prismic-io.s3.amazonaws.com/annual.report.pdf"
+    @link_file.kind.should == "document"
+    @link_file.name.should == "2012_annual.report.pdf"
+    @link_file.size.should == "1282484"
+    @link_file.as_html.should == "<a href=\"https://prismic-io.s3.amazonaws.com/annual.report.pdf\">2012_annual.report.pdf</a>"
+  end
+end
+
 describe 'structured_text_parser' do
   before do
     raw_json_paragraph = File.read("#{File.dirname(__FILE__)}/responses_mocks/structured_text_paragraph.json")

data/spec/responses_mocks/structured_text_linkfile.json

@@ -0,0 +1,71 @@
+{
+  "type": "StructuredText",
+  "value": [
+    {
+      "type": "paragraph",
+      "text": "2012 Annual Report",
+      "spans": [
+        {
+          "start": 0,
+          "end": 18,
+          "type": "hyperlink",
+          "data": {
+            "type": "Link.file",
+            "value": {
+              "file": {
+                "name": "2012_annual.report.pdf",
+                "kind": "document",
+                "url": "https://prismic-io.s3.amazonaws.com/annual.report.pdf",
+                "size": "1282484"
+              }
+            }
+          }
+        }
+      ]
+    },
+    {
+      "type": "paragraph",
+      "text": "2012 Annual Budget",
+      "spans": [
+        {
+          "start": 0,
+          "end": 18,
+          "type": "hyperlink",
+          "data": {
+            "type": "Link.file",
+            "value": {
+              "file": {
+                "name": "2012_smec.annual.budget.pdf",
+                "kind": "document",
+                "url": "https://prismic-io.s3.amazonaws.com/annual.budget.pdf",
+                "size": "59229"
+              }
+            }
+          }
+        }
+      ]
+    },
+    {
+      "type": "paragraph",
+      "text": "2015 Vision & Strategic Plan",
+      "spans": [
+        {
+          "start": 0,
+          "end": 28,
+          "type": "hyperlink",
+          "data": {
+            "type": "Link.file",
+            "value": {
+              "file": {
+                "name": "2015_vision.strategic.plan_.sm_.pdf",
+                "kind": "document",
+                "url": "https://prismic-io.s3.amazonaws.com/vision.strategic.plan_.sm_.pdf",
+                "size": "1969956"
+              }
+            }
+          }
+        }
+      ]
+    }
+  ]
+}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: prismic.io
 version: !ruby/object:Gem::Version
-  version: 1.0.0.preview.8
+  version: 1.0.0.rc1
 platform: ruby
 authors:
 - Étienne Vallette d'Osia
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-20 00:00:00.000000000 Z
+date: 2014-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -109,6 +109,7 @@ files:
 - spec/responses_mocks/document_with_unknown_fragment.json
 - spec/responses_mocks/fragments.json
 - spec/responses_mocks/structured_text_heading.json
+- spec/responses_mocks/structured_text_linkfile.json
 - spec/responses_mocks/structured_text_paragraph.json
 - spec/spec_helper.rb
 homepage: http://prismic.io
@@ -131,7 +132,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: Prismic.io development kit
@@ -145,6 +146,6 @@ test_files:
 - spec/responses_mocks/document_with_unknown_fragment.json
 - spec/responses_mocks/fragments.json
 - spec/responses_mocks/structured_text_heading.json
+- spec/responses_mocks/structured_text_linkfile.json
 - spec/responses_mocks/structured_text_paragraph.json
 - spec/spec_helper.rb
-has_rdoc: