middleman-prismic 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9f736c2a97835b9aad9c6bd91fa2cdbd78c719c1
+  data.tar.gz: e9129af75a42538d8ab264f1a34c7ae17c68c743
+SHA512:
+  metadata.gz: 5a76611dba3fbbdc751b40222fd4cb88dd8b185b853ddcd86051dcb99891bb70b2c635148a745277fbd0482de505094acf9b99def96c2e90c3b4414f2cd79277
+  data.tar.gz: 52268bf6060956baf8ffb1013a3e7f2fe50bad2a1a0c583db10c94487cf84e2ed865760ab5e6eff4971c53efb971d81a5bc4da1c0a180a71b2e48a7db4bdbbe2

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Kollegorna
+
+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,69 @@
+# Middleman Prismic
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'middleman-prismic'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install middleman-prismic
+i
+## Configuration
+
+To configure the extension, add the following configuration block to Middleman's config.rb:
+
+
+Parameter     |i Description
+----------    |------------
+api_url       | the single endpoint of your content repository
+access_token  | Prismic API OAuth2 based access token (optional)
+release       | The content release (optional, defaults to `master`)
+link_resolver | A link resolver. Expects a proc with one param, which is an object of type [Prismic::Fragments::DocumentLink](http://www.rubydoc.info/github/prismicio/ruby-kit/master/Prismic/Fragments/DocumentLink) (optional)
+
+For instance:
+
+```ruby
+activate :prismic do |f|
+  f.api_url = 'https://testrepositorymiddleman.prismic.io/api'
+  f.release = 'master'
+  f.link_resolver = ->(link) { binding.pry; "#{link.type.pluralize}/#{link.slug}"}
+  f.custom_queries = { test: [Prismic::Predicates::at('document.type', 'product')] }
+end
+```
+
+## Usage
+Run `bundle exec middleman prismic` in your terminal. This will fetch entries for the configured
+spaces and content types and put the resulting data in the [local data folder](https://middlemanapp.com/advanced/local-data/) as yaml files.
+
+For each document mask you have, you will get a file named `prismic_{document-name}` under `/data`.
+So for instance if you have article and product document masks, you will get 2 files: `prismic_articles`, `prismic_products`.
+Each file will contain all your documents of the specified document mask in an array.
+
+
+In your templates, you get for free helper methods named after your document mask that return the Prismic equivelant object.
+For instance for articles, if you run `<%= articles %>` you get back a `Prismic::Document`.
+
+If at any time need access to `Prismic::Ref` you can do it using the `reference` helper.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment. 
+
+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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/middleman-prismic/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "middleman-prismic"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/middleman-prismic.rb

@@ -0,0 +1,47 @@
+require 'prismic'
+require 'middleman-prismic/version'
+require 'middleman-prismic/commands/prismic'
+
+module MiddlemanPrismic
+  class << self
+    attr_reader :options
+  end
+
+  class Core < Middleman::Extension
+
+    option :api_url, nil, 'The prismic api url'
+    option :release, 'master', 'Content release'
+    option(
+      :link_resolver,
+      ->(link) {"http://www.example.com/#{link.type.pluralize}/#{link.slug}"},
+      'The link resolver'
+    )
+    option :custom_queries, {}, 'Custom queries'
+
+    def initialize(app, options_hash={}, &block)
+      super
+
+      MiddlemanPrismic.instance_variable_set('@options', options)
+    end
+
+    helpers do
+      Dir["data/prismic_*"].each do |file|
+        define_method(file.gsub('data/prismic_','')) do
+          YAML::load(File.read(file)).values
+        end
+      end
+
+      def reference
+        ref = YAML::load(File.read('data/prismic_reference'))
+        ref.class.send(
+          :define_method, :link_to, MiddlemanPrismic.options.link_resolver
+        )
+
+        return ref
+      end
+    end
+  end
+
+end
+
+::Middleman::Extensions.register(:prismic, MiddlemanPrismic::Core)

data/lib/middleman-prismic/commands/prismic.rb

@@ -0,0 +1,68 @@
+require 'yaml'
+require 'fileutils'
+
+module Middleman
+  module Cli
+
+    class Prismic < Thor
+      # Path where Middleman expects the local data to be stored
+      MIDDLEMAN_LOCAL_DATA_FOLDER = 'data'
+
+      check_unknown_options!
+
+      namespace :prismic
+      desc 'prismic', 'Import data from Prismic'
+
+=begin
+      method_option "refetch",
+        aliases: "-r",
+        desc: "Refetches the data from Prismic"
+=end
+
+      def self.source_root
+        ENV['MM_ROOT']
+      end
+
+      # Tell Thor to exit with a nonzero exit code on failure
+      def self.exit_on_failure?
+        true
+      end
+
+      def prismic
+        ::Middleman::Application.server.inst
+        reference = MiddlemanPrismic.options.release
+
+        Dir.mkdir('data') unless File.exists?('data')
+
+        FileUtils.rm_rf(Dir.glob('data/prismic_*'))
+
+        api = ::Prismic.api(MiddlemanPrismic.options.api_url)
+        response = api.form('everything').submit(api.ref(reference))
+
+        available_documents = []
+        response.each {|d| available_documents << d.type}
+
+        available_documents.uniq!
+
+        available_documents.each do |document_type|
+          documents = response.select{|d| d.type == document_type}
+          File.open("data/prismic_#{document_type.pluralize}", 'w') do |f|
+            f.write(Hash[[*documents.map.with_index]].invert.to_yaml)
+          end
+        end
+
+        File.open('data/prismic_reference', 'w') do |f|
+          f.write(api.master_ref.to_yaml)
+        end
+
+        MiddlemanPrismic.options.custom_queries.each do |k, v|
+          response = api.form('everything').query(*v).submit(api.master_ref)
+          File.open("data/prismic_custom_#{k}", 'w') do |f|
+            f.write(Hash[[*response.map.with_index]].invert.to_yaml)
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/middleman-prismic/version.rb

@@ -0,0 +1,3 @@
+module MiddlemanPrismic
+  VERSION = "0.1.0"
+end

data/middleman-prismic.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'middleman-prismic/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "middleman-prismic"
+  spec.version       = MiddlemanPrismic::VERSION
+  spec.authors       = ["Filippos Vasilakis"]
+  spec.email         = ["vasilakisfil@gmail.com"]
+
+  spec.summary       = %q{Middleman extension for Prismic}
+  spec.description   = %q{Middleman extension for Prismic}
+  spec.homepage      = "https://github.com/kollegorna/middleman-prismic"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "middleman", "~> 3.3"
+  spec.add_dependency "middleman-core", "~> 3.3"
+  spec.add_dependency "prismic.io", "~> 1.1"
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: middleman-prismic
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Filippos Vasilakis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: middleman
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: middleman-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: prismic.io
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Middleman extension for Prismic
+email:
+- vasilakisfil@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/middleman-prismic.rb
+- lib/middleman-prismic/commands/prismic.rb
+- lib/middleman-prismic/version.rb
+- middleman-prismic.gemspec
+homepage: https://github.com/kollegorna/middleman-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: Middleman extension for Prismic
+test_files: []