jekyll-prismic 0.1.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NGZhMmE5MjVhNWZiYjU0YWI3MzIyMDJkMzg5MjQ4ZTRkNjQyZjBmYQ==
+  data.tar.gz: !binary |-
+    MGFiYmZiZWVhNmRkNWZjMTU1ZDY2NDQ2ZGJkZWYzNjFiODMyZWUxZg==
+SHA512:
+  metadata.gz: !binary |-
+    Zjg1ZjFiMDhkN2RlNDE4ODZkM2NjZDE2ZDNkZWRkMjNkM2U5NTJlYTY2YTFm
+    NDY3MjI2NDk2ZDQxY2FhYmZkYTM0YWVjYTc0M2VmZGI3MDRkZGFkNTEzNWQy
+    ZjEwMDU1OTAzZmE0MTE2NjhhZmEwNWVmMDAxOWRiZTIzNTgwMDM=
+  data.tar.gz: !binary |-
+    NDUyYmFmOWU1M2Y3Yzc1MmI2NzIzNzBhYTBlOGUxOWIzNDk1ZjhlNzZjZmRj
+    MmE1N2JhZDcxZTAzOGNiNDVmZGEyNzRjYTMzNDNjMDRlOGE5OGJkNDNlYjc3
+    MDQ0M2I4ZTE3MjVmYjg4YWQ0Nzc5MmUzYmQyNWM4MWJiNTAzNjE=

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+Copyright © 2015 Christoph Hochstrasser <me@christophh.net>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the “Software”), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,67 @@
+# jekyll-prismic
+
+## Install
+
+Add the "jekyll-prismic" gem to your Gemfile:
+
+```
+gem "jekyll-prismic"
+```
+
+Then add "jekyll-prismic" to your gems in `_config.yml`:
+
+```
+gems:
+    - jekyll-prismic
+```
+
+## Configuration
+
+```
+prismic:
+    # Your repository endpoint
+    endpoint: https://lesbonneschoses.prismic.io/api
+    access_token: 'Your access token if the repo is private'
+    # Link resolving, key should match a document type in your repo
+    links:
+        post:
+            permalink: /posts/:slug-:id/
+    # Collections, key is used to access in the site.prismic.collections
+    # template variable
+    collections:
+        # Example for a "posts" collection
+        posts:
+            # Query the documents by type (optional)
+            type: post
+            # Collection name (optional)
+            form: posts
+            # Layout file for this collection
+            layout: prismic_post.html
+            # Additional queries
+            query:
+                - ["missing", "my.post.allow_comments"]
+            output: true # Generate output files or not (default: false)
+```
+
+## Usage
+
+This plugin provides the `site.prismic` template variable. This template provides access to tags, bookmarks, and the collections defined in the configuration.
+
+### Using Collections
+
+Collections are accessed by their name in `site.prismic.collections`. The `posts` collections is available at `site.prismic.collections.posts`.
+
+To list all documents of the collection:
+
+```
+{% for post in site.prismic.collection.posts %}
+<article>
+    <header>
+        {{ post.fragments.title.html }}
+    </header>
+    <div class="body"
+        {{ post.fragments.body.html }}
+    </div>
+</article>
+{% endfor %}
+```

data/lib/jekyll-prismic.rb

@@ -0,0 +1,9 @@
+require 'prismic'
+require 'jekyll/prismic/version'
+require 'jekyll/prismic/helper'
+require 'jekyll/prismic/collection'
+require 'jekyll/prismic/drops'
+require 'jekyll/prismic/generator'
+require 'jekyll/prismic/filters'
+require 'jekyll/prismic/hooks'
+require 'jekyll/prismic/site'

data/lib/jekyll/prismic/collection.rb

@@ -0,0 +1,53 @@
+module Jekyll
+  module Prismic
+    class PrismicCollection
+      attr_accessor :collection_name, :config
+
+      def initialize(site, collection_name, config)
+        @cache = []
+        @site = site
+        @collection_name = collection_name
+        @config = config
+        @config['output_dir'] = collection_name unless config.key? 'output_dir'
+      end
+
+      def generate?
+        @config['output'] || false
+      end
+
+      def each
+        if @cache.length > 0
+          @cache.each { |v| yield v }
+          return
+        end
+
+        queries = []
+        queries << ::Prismic::Predicates::at('document.type', @config['type']) if @config['type']
+
+        form = PrismicHelper.api.form(@config['form'] || "everything").ref(PrismicHelper.ref)
+
+        if @config['query'] != nil and @config['query'].length > 0
+          @config['query'].each do |query|
+            queries << query
+          end
+        end
+
+        form.query(*queries)
+
+        begin
+          response = form.submit()
+
+          begin
+            response.results.each do |result|
+              @cache << result
+              yield result
+            end
+            response = form.page(response.next_page).submit() if response.next_page != nil
+          end while response.next_page != nil
+        rescue ::Prismic::SearchForm::FormSearchException => error
+          Jekyll.logger.warn "prismic:collection:#{@collection_name}", "Not found"
+        end
+      end
+    end
+  end
+end

data/lib/jekyll/prismic/drops.rb

@@ -0,0 +1,228 @@
+module Jekyll
+  module Prismic
+    # Prismic Document access in Liquid
+    class PrismicDocumentDrop < Liquid::Drop
+        attr_accessor :document
+
+        def initialize(document, link_resolver)
+            @document = document
+            @link_resolver = link_resolver
+        end
+
+        def id
+            @document.id
+        end
+
+        def type
+            @document.type
+        end
+
+        def uid
+            @document.uid
+        end
+
+        def slug
+            @document.slug
+        end
+
+        def slugs
+            @document.slugs
+        end
+
+        def tags
+            @document.tags
+        end
+
+        def href
+            @document.href
+        end
+
+        def fragments
+            PrismicFragmentsDrop.new(@document.fragments, @link_resolver)
+        end
+    end
+
+    class PrismicFragmentsDrop < Liquid::Drop
+        def initialize(fragments, link_resolver)
+            @fragments = fragments
+            @link_resolver = link_resolver
+        end
+
+        def [](fragment_id)
+            fragment = @fragments[fragment_id]
+
+            case fragment
+            when ::Prismic::Fragments::DocumentLink then
+                PrismicDocumentLinkFragmentDrop.new(fragment, @link_resolver)
+            when ::Prismic::Fragments::Link then
+                PrismicLinkFragmentDrop.new(fragment, @link_resolver)
+            when ::Prismic::Fragments::Group then
+                PrismicGroupFragmentDrop.new(fragment, @link_resolver)
+            when ::Prismic::Fragments::GroupDocument then
+                PrismicGroupDocumentFragmentDrop.new(fragment, @link_resolver)
+            when ::Prismic::Fragments::Multiple then
+                PrismicMultipleFragmentDrop.new(fragment, @link_resolver)
+            when ::Prismic::Fragments::Color then
+                PrismicColorFragmentDrop.new(fragment, @link_resolver)
+            when ::Prismic::Fragments::StructuredText then
+                PrismicStructuredTextFragmentDrop.new(fragment, @link_resolver)
+            else
+                PrismicFragmentDrop.new(fragment, @link_resolver)
+            end
+        end
+    end
+
+    class PrismicFragmentDrop < Liquid::Drop
+        def initialize(fragment, link_resolver)
+            @fragment = fragment
+            @link_resolver = link_resolver
+        end
+
+        def [](attribute)
+            case attribute
+            when "html" then
+                @fragment.as_html(@link_resolver)
+            when "text" then
+                @fragment.as_text
+            else
+                @fragment.send(attribute.to_sym)
+            end
+        end
+    end
+
+    class PrismicGroupFragmentDrop < PrismicFragmentDrop
+        def [](attribute)
+            case attribute
+            when "group_documents" then
+                docs = []
+                @fragment.each do |group_document|
+                    docs << PrismicGroupDocumentFragmentDrop.new(group_document, @link_resolver)
+                end
+                docs
+            else
+                super
+            end
+        end
+    end
+
+    class PrismicGroupDocumentFragmentDrop < PrismicFragmentDrop
+        def to_liquid
+            {
+                "fragments" => PrismicFragmentsDrop.new(@fragment.fragments, @link_resolver)
+            }
+        end
+    end
+
+    class PrismicMultipleFragmentDrop < PrismicFragmentDrop
+        def to_liquid
+            {
+                "fragments" => PrismicFragmentsDrop.new(@fragment.fragments, @link_resolver)
+            }
+        end
+    end
+
+    class PrismicLinkFragmentDrop < PrismicFragmentDrop
+        def [](attribute)
+            case attribute
+            when "start_html" then
+                @fragment.start_html(@link_resolver)
+            when "url" then
+                @fragment.url(@link_resolver)
+            else
+                super
+            end
+        end
+
+        def url
+            @fragment.url(@link_resolver)
+        end
+    end
+
+    class PrismicDocumentLinkFragmentDrop < PrismicLinkFragmentDrop
+        def [](attribute)
+            case attribute
+            when "fragments" then
+                PrismicFragmentsDrop.new(@fragment.fragments, @link_resolver)
+            else
+                super
+            end
+        end
+    end
+
+    class PrismicColorFragmentDrop < PrismicFragmentDrop
+        def [](attribute)
+            case attribute
+            when "rgb" then
+                @fragment.asRGB
+            else
+                super
+            end
+        end
+    end
+
+    class PrismicStructuredTextFragmentDrop < PrismicFragmentDrop
+    end
+
+    # Handles a single Prismic collection in Liquid
+    class PrismicCollectionDrop < Liquid::Drop
+        def initialize(collection, link_resolver)
+            @collection = collection
+            @link_resolver = link_resolver
+        end
+
+        def to_liquid
+            results = []
+            @collection.each { |result| results << PrismicDocumentDrop.new(result, @link_resolver) }
+            results
+        end
+    end
+
+    # Handles Prismic collections in Liquid, and creates the collection on demand
+    class PrismicCollectionsDrop < Liquid::Drop
+        def initialize(collections, link_resolver)
+            @collections = collections
+            @link_resolver = link_resolver
+        end
+
+        def [](collection_name)
+            PrismicCollectionDrop.new(@collections[collection_name], @link_resolver)
+        end
+    end
+
+    # Main Liquid Drop, handles lazy loading of collections, tags, and bookmarks
+    # and conversion to drops
+    class PrismicDrop < Liquid::Drop
+        def initialize(site)
+            @site = site
+        end
+
+        def collections
+            @collections ||= PrismicCollectionsDrop.new(@site.prismic_collections, @site.prismic_link_resolver)
+        end
+
+        def tags
+            @tags ||= @site.prismic.tags
+        end
+
+        def bookmarks
+            @bookmarks ||= PrismicBookmarksDrop.new(@site, @site.prismic.bookmarks)
+        end
+    end
+
+    # Handles Prismic bookmarks in Liquid, and fetches the documents on demand
+    class PrismicBookmarksDrop < Liquid::Drop
+        def initialize(site, bookmarks)
+            @cache = {}
+            @site = site
+            @bookmarks = bookmarks
+        end
+
+        def [](bookmark)
+            unless @cache.key? bookmark
+                @cache[bookmark] = PrismicDocumentDrop.new(PrismicHelper.find_document(@bookmarks[bookmark]), @site.prismic_link_resolver)
+            end
+            @cache[bookmark]
+        end
+    end
+  end
+end

data/lib/jekyll/prismic/filters.rb

@@ -0,0 +1,23 @@
+module Jekyll
+  module Prismic
+    module PrismicFilter
+      def prismic_document(input)
+        document = PrismicHelper.find_document(input)
+        PrismicDocumentDrop.new(document, @context.registers[:site].prismic_link_resolver)
+      end
+
+      # Uses the link resolver to link to a document
+      def prismic_link_to(input)
+        site = @context.registers[:site]
+
+        if input.is_a? PrismicDocumentDrop
+            return site.prismic_link_resolver.link_to(input.document)
+        end
+
+        input.url if input.respond_to? :url
+      end
+    end
+  end
+end
+
+Liquid::Template.register_filter(Jekyll::Prismic::PrismicFilter)

data/lib/jekyll/prismic/generator.rb

@@ -0,0 +1,53 @@
+module Jekyll
+  module Prismic
+    # Generates pages for all collections with have the "generate" option set to True
+    class PrismicGenerator < Generator
+      safe true
+
+      def generate(site)
+        site.prismic_collections.each do |collection_name, collection|
+          if collection.generate?
+            collection.each do |document|
+              site.pages << PrismicPage.new(site, site.source, document, collection.config)
+            end
+          end
+        end
+      end
+    end
+
+    class PrismicPage < Page
+      def initialize(site, base, document, config)
+        @site = site
+        @base = base
+        @dir = config['output_dir']
+        # Default file name, can be overwritten by permalink frontmatter setting
+        @name = "#{document.slug}-#{document.id}.html"
+        @document = document
+
+        self.process(@name)
+        self.read_yaml(File.join(base, "_layouts"), config['layout'])
+        # Use the permalink collection setting if it is set
+        self.data['permalink'] = config['permalink'] if config.key? 'permalink'
+        self.data['document'] = document
+      end
+
+      def url_placeholders
+        Utils.deep_merge_hashes({
+          :slug => @document.slug,
+          :id => @document.id,
+          :uid => @document.uid,
+          :type => @document.type
+        }, super)
+      end
+
+      def render(layouts, site_payload)
+        payload = Utils.deep_merge_hashes({
+          "document" => PrismicDocumentDrop.new(@document, @site.prismic_link_resolver),
+          "page" => self.to_liquid
+        }, site_payload)
+
+        do_layout(payload, layouts)
+      end
+    end
+  end
+end

data/lib/jekyll/prismic/helper.rb

@@ -0,0 +1,37 @@
+module Jekyll
+  module Prismic
+    class PrismicHelper
+      def self.config
+        @@config ||= Jekyll.configuration()['prismic']
+      end
+
+      def self.api
+        return if config == nil
+
+        @@api ||= ::Prismic.api(config['endpoint'], config['access_token'])
+      end
+
+      def self.ref
+        @@ref ||= api.refs[config['ref']] || api.master_ref
+      end
+
+      def self.find_document(id)
+        @@document_cache ||= {}
+
+        if @@document_cache.key? id
+          return @@document_cache[id]
+        end
+
+        begin
+          response = api.form('everything')
+              .query(::Prismic::Predicates::at('document.id', id))
+              .submit(ref)
+
+          @@document_cache[id] = response.results.first
+        rescue ::Prismic::SearchForm::FormSearchException
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/jekyll/prismic/hooks.rb

@@ -0,0 +1,8 @@
+module Jekyll
+  module Prismic
+    # Add Prismic Liquid variables to all templates
+    Jekyll::Hooks.register :site, :pre_render do |site, payload|
+      payload['site']['prismic'] = PrismicDrop.new(site)
+    end
+  end
+end

data/lib/jekyll/prismic/site.rb

@@ -0,0 +1,45 @@
+module Jekyll
+  # Add helper methods for dealing with Prismic to the Site class
+  class Site
+    def prismic
+      Jekyll::Prismic::PrismicHelper.api
+    end
+
+    def prismic_collections
+      if @config['prismic'] != nil and @config['prismic']['collections'] != nil
+        @prismic_collections ||= Hash[@config['prismic']['collections'].map { |name, config| [name, Prismic::PrismicCollection.new(self, name, config)] }]
+      else
+        []
+      end
+    end
+
+    def prismic_ref
+      Jekyll::Prismic::PrismicHelper.ref
+    end
+
+    def prismic_link_resolver
+      @prismic_link_resolver ||= ::Prismic.link_resolver prismic_ref do |link|
+        if @config['prismic'] != nil and @config['prismic']['links'] != nil
+          url = nil
+
+          @config['prismic']['links'].each do |type, link_config|
+            if (link.is_a? ::Prismic::Fragments::DocumentLink or link.is_a? ::Prismic::Document) and type == link.type
+              url = Jekyll::URL.new(:template => link_config['permalink'], :placeholders => {
+                :id => link.id,
+                :uid => link.uid,
+                :slug => link.slug,
+                :type => link.type
+              })
+            end
+          end
+
+          url.to_s
+        end
+      end
+    end
+
+    def prismic_collection(collection_name)
+      prismic_collections[collection_name]
+    end
+  end
+end

data/lib/jekyll/prismic/version.rb

@@ -0,0 +1,5 @@
+module Jekyll
+  module Prismic
+    VERSION = "0.1.1"
+  end
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-prismic
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Christoph Hochstrasser
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: prismic.io
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: ! '    A Jekyll plugin for retrieving content from the Prismic.io API
+
+'
+email:
+- me@christophh.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/jekyll-prismic.rb
+- lib/jekyll/prismic/collection.rb
+- lib/jekyll/prismic/drops.rb
+- lib/jekyll/prismic/filters.rb
+- lib/jekyll/prismic/generator.rb
+- lib/jekyll/prismic/helper.rb
+- lib/jekyll/prismic/hooks.rb
+- lib/jekyll/prismic/site.rb
+- lib/jekyll/prismic/version.rb
+homepage: http://github.com/CHH/jekyll-prismic/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Prismic.io integration for Jekyll
+test_files: []