prismic_rails 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 91d0fd6019ba43ed0e35d1c2c0759e11faf11a2f
-  data.tar.gz: 7c4214e800edb0c788b8bf9d8948030682262db4
+  metadata.gz: b661aa54deff7c406f834ddd6da31318cbb75d4f
+  data.tar.gz: ba0aecffc2202919bea3da0a318a98b476401b3b
 SHA512:
-  metadata.gz: acf7f7dad35ad004caf7a2331d0d997229d1e0d0ead13ef02ab97345a0c095bc3587ddebb0c240551e5d7275acef9a76c61eca8d2689396e97ad090384c3167e
-  data.tar.gz: 04cfb7a4d598a7ca00d21e4c380a914576dcdf8e9622ed4d4a9d834a1f6ac4050cf21f2dfc1cdcfe083b923912871a7aa42f06b764f5b779ea8f4515ad0e4329
+  metadata.gz: bb3cb78090badadb3370356ec4b12030e17f4ad7b991d3efadcac1d6cf928a541c9426e39add6aa9be53e80d7a83c2aaa576a8f9650ba67df7cdc7b8c3061d20
+  data.tar.gz: 7b08ab8b08a078073a668e63d8db3e408580cb81933924fe12603bb38f41ec14be78a4bafdeda3cf196067549ce81810c10c942d4711515469f1c72abb9e991b

data/.travis.yml

@@ -3,3 +3,7 @@ language: ruby
 rvm:
   - 2.4.0
 before_install: gem install bundler -v 1.14.3
+
+notifications:
+  slack: fadendaten:tWoet2mtObvbwSZSyUAY93jl
+  email: false

data/Gemfile

@@ -1,4 +1,2 @@
 source 'https://rubygems.org'
-
-# Specify your gem's dependencies in prismicRails.gemspec
 gemspec

data/README.md

@@ -3,40 +3,88 @@
 [![Build Status](https://travis-ci.org/fadendaten/prismic_rails.svg?branch=master)](https://travis-ci.org/fadendaten/prismic_rails)
 [![Code Climate](https://codeclimate.com/github/fadendaten/prismic_rails.png)](https://codeclimate.com/github/fadendaten/prismic_rails)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/prismic-rails`. To experiment with that code, run `bin/console` for an interactive prompt.
+Library to consume API-based CMS prismic.io and to display fetched content into your Rails app.
 
-TODO: Delete this and the text above, and describe your gem
+This gem uses [prismicio/ruby-kit](https://github.com/prismicio/ruby-kit) gem to consume Prismic API.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'prismic-rails'
+gem 'prismic_rails', git: 'git@github.com:fadendaten/prismic_rails.git'
 ```
 
 And then execute:
 
     $ bundle
 
-Or install it yourself as:
+## Configuration
 
-    $ gem install prismic-rails
+Copy the initializer file by running
+
+    $ rails g prismic_rails:install
+
+And then set the ENV variables you got from prismic.io.
+
+#### I18n Support
+
+prismic.io supports finer graded set of locals. To work with that we need to map
+Rails locale to the locale prismic.io recognise.
+Define the language hash as following:
+
+```ruby
+config.languages = {
+  'en' => 'en-gb',
+  'de' => 'de-ch',
+  'fr' => 'fr-ch',
+  'it' => 'it-ch',
+  }
+```
+No need to configure language hash if you don't want I18n support. English will be used by default.
+
+
+#### Caching
+
+PrismicRails uses Rails caching to fasten the query process. You can choose to usse it or not to use it.
+
+    $ config.caching = true
 
 ## Usage
 
-TODO: Write usage instructions here
+From any view of your application we can do the followings:
 
-## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+  
+#### Query the prismic type 'blog-post' and render each document as html
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+```ruby
+<%= prismic_type 'blog-post' do |result| %>
+  <%- result.documents.each do |document| %>
+    <%= document.to_html %>
+  <% end %>
+<% end %>
+```
 
-## Contributing
+#### Query the prismic type 'blog-post' in english
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/fadendaten/prismic-rails.
+```ruby
+<%= prismic_type 'blog-post', lang: 'en' do |result| %>
+  <%- result.documents.each do |document| %>
+    <%= document.to_html %>
+  <% end %>
+<% end %>
+```
+
+#### Query only the title of the type 'blog-post
+
+```ruby
+<%= prismic_type 'tea' do |result| %>
+  <%= result.find_fragment('title').to_html %>
+<% end %>
+```
 
+You can use `to_text` is case you want only the text. 
 
 ## License
 

data/lib/generators/templates/prismic_rails.rb

@@ -6,14 +6,14 @@ PrismicRails.configure do |config|
   # Set the access token of prismic if you have one
   config.token = ENV["PRISMIC_ACCESS_TOKEN"]
 
-  # Language machting of your app locale to prismic local:
+  # Language machting of your app locale to prismic locale:
   #  Example
-  # config.languages do |l|
-  #   l.en = 'en-gb'
-  #   l.de = 'de-ch'
-  #   l.fr = 'fr-ch'
-  #   l.it = 'it-ch'
-  # end
+  # config.languages = {
+  #   'en' => 'en-gb',
+  #   'de' => 'de-ch',
+  #   'fr' => 'fr-ch',
+  #   'it' => 'it-ch'
+  # }
   #
   # Set if PrismicRails should use rails caching
   # config.caching = true

data/lib/prismic_rails.rb

@@ -33,7 +33,7 @@ module PrismicRails
     yield self.config
   end
 
-  # Returns the Prismic::API Object or nif if prismic.io is down
+  # Returns the Prismic::API Object or nil if prismic.io is down
   def self.api
     begin
       @api = Prismic.api(self.config.url, self.config.token)
@@ -46,8 +46,8 @@ module PrismicRails
     end
   end
 
-  # Get the master ref of prismic account. This is primary used to establis a
-  # got caching mechanism.
+  # Get the master ref of prismic account. This is primarily used to establish a
+  # caching mechanism.
   def self.ref
     if caching_enabled?
       get_cached_ref
@@ -61,8 +61,6 @@ module PrismicRails
     PrismicRails.config.caching
   end
 
-  private
-
   # Get the master ref out of the rails cache if prismic is not available
   def self.get_cached_ref
     if api.nil?
@@ -79,4 +77,12 @@ module PrismicRails
     api.master_ref.ref
   end
 
+  def self.find(document_type, fragment_id, options = {})
+    if options[:lang]
+      PrismicRails::QueryService.type(document_type, lang: options[:lang]).find_fragment(fragment_id)
+    else
+      PrismicRails::QueryService.type(document_type).find_fragment(fragment_id)
+    end
+  end
+
 end

data/lib/prismic_rails/content/document.rb

@@ -1,17 +1,17 @@
 # :nodoc:
 module PrismicRails
   # The PrismicRails::Document is a wrapper class around Prismic::Document to
-  # support custom features like to_html and to handle nil documents.
+  # support custom features like to_html, to_text and to handle nil documents.
   class Document
 
-    # Creats a new PrismicRails::Document
+    # Creates a new PrismicRails::Document
     # ====
     #   +document+ A Prismic::Document
     def initialize(document)
       @document = document || PrismicRails::NilDocument.new
     end
 
-    # Returns the document as save html
+    # Returns the document as safe html
     def to_html
       @document.as_html(nil).html_safe
     end
@@ -21,13 +21,17 @@ module PrismicRails
       @document.as_text
     end
 
-    # Find a fragment of a specific type in a document
+    # Finds a fragment of a specific type in a document
+    # ====
+    #    +type+ 'text', 'image' etc
     def find_fragment(type)
       fragment = @document.fragments[type]
       return PrismicRails::Fragment.new(fragment) || NilDocument.new
     end
 
     # Tests if the document has the type type.
+    # ====
+    #    +type+ 'text', 'image' etc
     def is_type? type
       type == @document.type
     end

data/lib/prismic_rails/content/fragment.rb

@@ -9,7 +9,7 @@ module PrismicRails
       @fragment = fragment
     end
 
-    # Returns the document as save html
+    # Returns the document as safe html
     def to_html
       @fragment.as_html(nil).html_safe
     end

data/lib/prismic_rails/content/nil_document.rb

@@ -9,7 +9,7 @@ module PrismicRails
       @document = ''
     end
 
-    # Returns the document as save html, in this case simply an empty string
+    # Returns the document as safe html, in this case simply an empty string
     def to_html
       @document
     end

data/lib/prismic_rails/content/result.rb

@@ -22,12 +22,12 @@ module PrismicRails
       end
     end
 
-    # Find a specific fragment in the list of all documents.
+    # Find a specific fragment in the list of all document.
     #
     # ==== Examples
     #
     #   PrismicRails::Result.find_fragment('image')
-    # This call walks through all the documents and looks for a fragment with
+    # This call walks through all the document and looks for a fragment with
     # the type 'image'.
     def find_fragment(type)
       @documents.each do |document|

data/lib/prismic_rails/helpers/view_helpers.rb

@@ -8,15 +8,15 @@ module PrismicRails
     # Query prismic for a specific type
     #
     # ==== Examples:
-    # Query the prismic type 'blog-post' and render each document a html
-    #   <%= prismic_type 'blog-post' do |result| %>
+    # Query the prismic type 'blog-post' and render each document as html
+    #   <% prismic_type 'blog-post' do |result| %>
     #     <%- result.documents.each do |document| %>
     #       <%= document.to_html %>
     #     <% end %>
     #   <% end %>
     #
     # Query the prismic type 'blog-post' in english
-    #   <%= prismic_type 'blog-post', lang: 'en' do |result| %>
+    #   <% prismic_type 'blog-post', lang: 'en' do |result| %>
     #     <%- result.documents.each do |document| %>
     #       <%= document.to_html %>
     #     <% end %>
@@ -24,7 +24,7 @@ module PrismicRails
     #
     # Query only the title of the type 'blog-post
     #
-    #   <%= prismic_type 'tea' do |result| %>
+    #   <% prismic_type 'tea' do |result| %>
     #     <%= result.find_fragment('title').to_html %>
     #   <% end %>
     #
@@ -33,8 +33,7 @@ module PrismicRails
     def prismic_type(type, options = {}, &block)
 
       query = Proc.new do
-        response = PrismicRails::QueryService.type(type, options)
-        result = PrismicRails::Result.new(response)
+        result = PrismicRails::QueryService.type(type, options)
         capture(result, &block)
       end
 

data/lib/prismic_rails/services/language_service.rb

@@ -6,10 +6,10 @@ module PrismicRails
   # E.g. If your rails app support the locales :en, :de and :fr and you want to
   # support this locales with your prismic content you have to match this
   # locals.
-  # In Prismic you have the posibility to define a finer graded set of locals,
+  # In Prismic you have the possibility to define a finer graded set of locals,
   # e.g. 'en-gb', 'en-us', 'de-de', 'de-ch' and so on.
-  # Unfortunatly Prismic does not support a wildecard query on the locals, so we
-  # solve this problem by setting up a matching logic.
+  # Unfortunately Prismic does not support a wildcard query on the locals, so we
+  # have solved this problem by setting up a matching logic.
   #
   # You can define the matching logic in your PrismicRails configureation.
   class LanguageService
@@ -17,8 +17,8 @@ module PrismicRails
     # Stores the given locale
     attr_accessor :locale
 
-    # Call the PrismicRails::LanguageService with a i18n locale form rails. The
-    # PrismicRails::LanguageService tries to match it into a prismic local.
+    # Calls the PrismicRails::LanguageService with a i18n locale form rails. The
+    # PrismicRails::LanguageService tries to match it into a prismic locale.
     def self.call(locale)
       new(locale).match()
     end

data/lib/prismic_rails/services/query_service.rb

@@ -12,19 +12,20 @@ module PrismicRails
 
       # Query the Prismic API with a type
       # ==== Examples
-      #   PrismicRails::QueryService('blog-post')
+      #   PrismicRails::QueryService.type('blog-post')
       #
       # This returns a Prismic::Response with all the (published) documents of
       # the type 'blog-post'
       #
-      #   PrismicRails::QueryService('block-post', {lang: 'en'}
+      #   PrismicRails::QueryService.type('blog-post', {lang: 'en'}
       #
-      # This returns a Prismic::Response with all the (published) documents of
-      # the type 'blog-post' in english.
+      # This gets all the (published) documents of
+      # the type 'blog-post' in english as a Prismic::Response and wraps it around with a PrismicRails::Result
       #
       def type(type, options = {})
         match_language options if options[:lang]
-        query(predicates(type), options)
+        response = query(predicates(type), options)
+        PrismicRails::Result.new(response)
       end
 
       private

data/lib/prismic_rails/version.rb

@@ -1,5 +1,5 @@
 # :nodoc:
 module PrismicRails
   # :nodoc:
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/prismic_rails.gemspec

@@ -21,16 +21,17 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "prismic.io", "~> 1.4", ">= 4.1"
-  spec.add_runtime_dependency 'rails', '>= 4.2', '~> 5.1'
+  spec.add_runtime_dependency "prismic.io", "~> 1.5", ">= 1.5"
+  spec.add_runtime_dependency "rails", ">= 4.2"
 
   spec.add_development_dependency "bundler", "~> 1.14"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
 
   spec.add_development_dependency "rdoc", "~> 5.1", ">= 5.1"
-  spec.add_development_dependency "vcr", "~> 3.0.3", ">= 5.1.0"
+  spec.add_development_dependency "vcr", "~> 3.0.3", ">= 3.0.3"
   spec.add_development_dependency "dotenv", "~> 2.2", ">= 2.2.1"
   spec.add_development_dependency "webmock", "~> 3.0", ">= 3.0.1"
   spec.add_development_dependency 'simplecov', "~> 0.14", ">= 0.14.1"
+  spec.add_development_dependency 'pry', '~> 0.10.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prismic_rails
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Felix Langenegger
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-07 00:00:00.000000000 Z
+date: 2017-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prismic.io
@@ -16,20 +16,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1.5'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '1.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1.5'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -37,9 +37,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.2'
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -47,9 +44,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.2'
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -121,7 +115,7 @@ dependencies:
         version: 3.0.3
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.1.0
+        version: 3.0.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -131,7 +125,7 @@ dependencies:
         version: 3.0.3
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.1.0
+        version: 3.0.3
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
@@ -192,6 +186,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.14.1
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
 description: With PrismicRails it is simple to query the prismic.io API for a defined
   custom type. By providing rails helpers the integration in your rails view is much
   easier as before.
@@ -223,7 +231,6 @@ files:
 - lib/prismic_rails/services/language_service.rb
 - lib/prismic_rails/services/query_service.rb
 - lib/prismic_rails/version.rb
-- prismic_rails-0.1.21.gem
 - prismic_rails.gemspec
 homepage: https://github.com/fadendaten/prismic_rails
 licenses: