jekyll-remote_csv 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9234ec368484e146c47ee5828f272db7df871c7d
+  data.tar.gz: 50ca21b149f61cb21c0b20c6ea2a5b8259982fbb
+SHA512:
+  metadata.gz: c2f12c7dfeb7188c622633ec279d1a61b03b8e5fe20b90db855a9fd20911a82b49e61b277908915f2681ac6fc9a57b6141400df1b781aa58ab27ea44433222b7
+  data.tar.gz: 045b67562d168dbe526e225eba581105ec5b705d2496b33af670ffb84ad229080b7e2d5faf8f55333bf430b2d941a9852d0e99a69426506389a457cc69000d24

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+cache: bundler
+rvm:
+  - 2.0.0
+  - 2.1.7
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Chris Mytton
+
+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,158 @@
+# Jekyll::RemoteCsv [![Build Status](https://travis-ci.org/everypolitician/jekyll-remote_csv.svg?branch=master)](https://travis-ci.org/everypolitician/jekyll-remote_csv)
+
+This plugin allows you to specify remote CSVs to be turned into collections. It also provides a way for you to associate these collections with other collections.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jekyll-remote_csv'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jekyll-remote_csv
+
+## Usage
+
+In `_config.yml` add a section which points to a CSV of Education information:
+
+```yaml
+remote_csv:
+  education:
+    source: https://docs.google.com/spreadsheets/u/1/d/1rFnkM9rrhwmo5eTwhEPordgucf-iNACnzc6E78elkaM/export?format=csv
+```
+
+In this default configuration it will fetch the CSV at the url specified in the source attribute. It will the use the key as the name for the collection. In the example above `site.education` would be populated with the remote CSV:
+
+```liquid
+{% for item in site.education %}
+  <p>{{ item.role }}</p>
+{% endfor %}
+```
+
+### Associating with other collections
+
+Sometimes you might want this collection to be associated with another collection, you can configure this in `_config.yml`:
+
+```yaml
+remote_csv:
+  education:
+    source: https://docs.google.com/spreadsheets/u/1/d/1rFnkM9rrhwmo5eTwhEPordgucf-iNACnzc6E78elkaM/export?format=csv
+    collections:
+      - assembly_people
+      - senate_people
+```
+
+This will associate the collection in the source CSV with the `assembly_people` and `senate_people` collections. For this to work correctly each document in the collections will need to specify an `id` in its frontmatter which matches the `id` column in the CSV. If you need to override this then you can specify that:
+
+```yaml
+remote_csv:
+  education:
+    source: https://docs.google.com/spreadsheets/u/1/d/1rFnkM9rrhwmo5eTwhEPordgucf-iNACnzc6E78elkaM/export?format=csv
+    csv_id_field: person_id
+    collections:
+      assembly_people: pombola_id
+      senate_people: kuvakazim_id
+```
+
+This will use the `person_id` column in the CSV and match it to `assembly_people` using the `pombola_id` property in the frontmatter and the `senate_people` using the `kuvakazim_id` property. This means that each person in the collection will have an `education` property.
+
+Assuming that the CSV file has `person_id`, `organization_name` and `qualification` columns you could then use this in a template listing people as follows:
+
+```liquid
+{% for person in site.assembly_people %}
+  <h2>{{ person.name }} Education</h2>
+  <ul>
+  {% for education in person.education %}
+    <li>Organisation: {{ education.organization_name }} | Qualification: {{ education.qualification }}</li>
+  {% endfor %}
+  </ul>
+{% endfor %}
+```
+
+### Outputting a collection
+
+If you want to output the collection then you will need to provide a key to use for the output item's slug.
+
+```yaml
+remote_csv:
+  education:
+    source: https://docs.google.com/spreadsheets/u/1/d/1rFnkM9rrhwmo5eTwhEPordgucf-iNACnzc6E78elkaM/export?format=csv
+    collection_slug_field: organisation_name
+
+collections:
+  education:
+    output: true
+```
+
+With the above configuration the education source CSV will be turned into a collection and then each item in the collection will be output at `/education/organisation-name-slugified`.
+
+### Grouping records
+
+Sometimes you might want to group the records by a certain field, perhaps you want to display all the people who went to Harvard University for example. To make this work you can specify a `group_by` option:
+
+```yaml
+remote_csv:
+  education:
+    source: https://docs.google.com/spreadsheets/u/1/d/1rFnkM9rrhwmo5eTwhEPordgucf-iNACnzc6E78elkaM/export?format=csv
+    group_by: university
+
+collections:
+  education_by_university:
+    output: true
+```
+
+Then in your `_layouts/education_by_university.html` file:
+
+```liquid
+<h1>{{ page.title }}</h1>
+{% for education in page.education %}
+  <p>{{ education.name }}</p>
+  <p>{{ education.degree }}</p>
+{% endfor %}
+```
+
+If you want to connect back to another collection you can also specify a `reverse_relation_name` option:
+
+```yaml
+remote_csv:
+  education:
+    source: https://docs.google.com/spreadsheets/u/1/d/1rFnkM9rrhwmo5eTwhEPordgucf-iNACnzc6E78elkaM/export?format=csv
+    group_by: university
+    reverse_relation_name: person
+    collections:
+      people: person_id
+
+collections:
+  education_by_university:
+    output: true
+```
+
+```liquid
+<h1>{{ page.title }}</h1>
+{% for education in page.education %}
+  <p><a href="{{ education.person.url }}">{{ education.person.name }}</a></p>
+  <p>{{ education.degree }}</p>
+{% endfor %}
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also 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`, 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/everypolitician/jekyll-remote_csv.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'jekyll/remote_csv'
+
+# 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.
+
+require 'pry'
+Pry.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/jekyll-remote_csv.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jekyll/remote_csv/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'jekyll-remote_csv'
+  spec.version       = Jekyll::RemoteCsv::VERSION
+  spec.authors       = ['Chris Mytton']
+  spec.email         = ['chrismytton@gmail.com']
+
+  spec.summary       = 'Specify remote CSVs to be included in site.data'
+  spec.homepage      = 'https://github.com/everypolitician/jekyll-remote_csv'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'jekyll', '>= 3'
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'pry'
+end

data/lib/jekyll/remote_csv.rb

@@ -0,0 +1,78 @@
+require 'jekyll/remote_csv/version'
+
+require 'open-uri'
+require 'csv'
+
+require 'jekyll'
+
+module Jekyll
+  module RemoteCsv
+    class Generator < ::Jekyll::Generator
+      priority :low
+
+      def generate(site)
+        return unless site.config['remote_csv']
+        site.config['remote_csv'].each do |source_name, conf|
+          csv_string = open(conf['source']).read
+          csv_data = CSV.parse(csv_string, headers: true).map(&:to_hash)
+          site.collections[source_name] = make_collection(site, source_name, conf, csv_data)
+          if conf['group_by']
+            group_name = "#{source_name}_by_#{conf['group_by']}"
+            site.collections[group_name] = make_group_collection(site, source_name, group_name, conf, site.collections[source_name].docs)
+            site.collections[source_name].docs.each do |doc|
+              doc.data[group_name] = site.collections[group_name].docs.find do |group|
+                group['title'] == doc[conf['group_by']]
+              end
+            end
+          end
+          next unless conf['collections']
+          conf['collections'].each do |collection_name, key|
+            next unless site.collections.key?(collection_name)
+            key ||= 'id'
+            csv_id_field = conf.fetch('csv_id_field', 'id')
+            site.collections[collection_name].docs.each do |doc|
+              doc.data[source_name] = site.collections[source_name].docs.find_all do |item|
+                item[csv_id_field] == doc[key]
+              end
+              doc.data[source_name].each do |source_doc|
+                reverse_relation_name = conf.fetch('reverse_relation_name', collection_name)
+                source_doc.data[reverse_relation_name] = doc
+              end
+            end
+          end
+        end
+      end
+
+      def make_collection(site, source_name, conf, csv_data)
+        collection = Collection.new(site, source_name)
+        csv_data.each do |item|
+          item_id_field = conf.fetch('collection_slug_field', item.keys.first)
+          path = File.join(site.source, "_#{source_name}", "#{Jekyll::Utils.slugify(item[item_id_field])}.md")
+          doc = Document.new(path, collection: collection, site: site)
+          doc.merge_data!(item)
+          if site.layouts.key?(source_name)
+            doc.merge_data!('layout' => source_name)
+          end
+          collection.docs << doc
+        end
+        collection
+      end
+
+      def make_group_collection(site, source_name, group_name, conf, data)
+        collection = Collection.new(site, group_name)
+        data.group_by { |d| d[conf['group_by']] }.each do |name, items|
+          path = File.join(site.source, "_#{group_name}", "#{Jekyll::Utils.slugify(name)}.md")
+          doc = Document.new(path, collection: collection, site: site)
+          doc.merge_data!('title' => name, source_name => items)
+          if site.layouts.key?(group_name)
+            doc.merge_data!('layout' => group_name)
+          elsif site.layouts.key?(source_name)
+            doc.merge_data!('layout' => source_name)
+          end
+          collection.docs << doc
+        end
+        collection
+      end
+    end
+  end
+end

data/lib/jekyll/remote_csv/version.rb

@@ -0,0 +1,5 @@
+module Jekyll
+  module RemoteCsv
+    VERSION = '0.1.0'
+  end
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-remote_csv
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris Mytton
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-01-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- chrismytton@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- jekyll-remote_csv.gemspec
+- lib/jekyll/remote_csv.rb
+- lib/jekyll/remote_csv/version.rb
+homepage: https://github.com/everypolitician/jekyll-remote_csv
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Specify remote CSVs to be included in site.data
+test_files: []