jekyll-everypolitician 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: df7c92e1d38d1a4ba4e7675ec40f6b225966b5e1
-  data.tar.gz: d5ecc1fb4943a25e7d2694ec8145e6a60e0fa420
+  metadata.gz: 9387daa16bfcd547db3dcf3c7b7927d72af361ac
+  data.tar.gz: 7530ef6cd4232c9ed4f07bc723d6ccd142e67938
 SHA512:
-  metadata.gz: c61a1c1bac048520a7a1aa29e57b00b19df6d5ad273663bdf72f2f32e1d49c0bffbc1b66e93948e82baea53c8f58741ba4cd168b2d041df068972fbf63388cfb
-  data.tar.gz: 1cd95835ec1f3c1f68ed429036e158b9af00e2594e02d2d0f1d7ff31e448e37defbc8d76adb545b057c8e607afa633f8befae368b80bba9bf131e297bb4b959c
+  metadata.gz: de2310fa3695a3ab4b8a89e9a95018914cab6315d6b0ff06246fea9300196a5225a4a7e202a2b85c0f2a75ff82ae80373050af98ee5fce00560b0a948e0d99bf
+  data.tar.gz: 6bfd4923784f3ea99103a0213cd6bcb819ebc890231d1367607d44af761c7ad7a63ca2dbb4f64ec1dd19ce5a6609273809fe52361b975398924b105108456fee

data/.travis.yml

@@ -1,4 +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/CHANGELOG.md

@@ -2,9 +2,16 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
-## 0.1.0 - 2015-12-02
+## [0.3.0] - 2015-12-02
 
-- Initial release
+### Changed
+
+- `everypolitician_url` in `_config.yml` has been renamed to `everypolitician` and is now a hash. See the [Usage section in the README](https://github.com/everypolitician/jekyll-everypolitician/blob/2d9d9d562e99608b33038f712305c179e0196c8e/README.md#usage) for more details on how to use this. This means you can specify multiple sources for your data [#2](https://github.com/everypolitician/jekyll-everypolitician/issues/2)
+- `persons` collection is now called `people` [#3](https://github.com/everypolitician/jekyll-everypolitician/issues/3)
+
+### Fixed
+
+- We no longer raise an error if the config is missing.
 
 ## [0.2.0] - 2015-12-02
 
@@ -12,4 +19,10 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 - You can now set `everypolitician_url` in `_config.yml` to an everypolitician popolo url
 
+## 0.1.0 - 2015-12-02
+
+- Initial release
+
+
 [0.2.0]: https://github.com/everypolitician/jekyll-everypolitician/compare/v0.1.0...v0.2.0
+[0.3.0]: https://github.com/everypolitician/jekyll-everypolitician/compare/v0.2.0...v0.3.0

data/README.md

@@ -1,4 +1,4 @@
-# Jekyll::Everypolitician
+# Jekyll::Everypolitician [![Build Status](https://travis-ci.org/everypolitician/jekyll-everypolitician.svg?branch=master)](https://travis-ci.org/everypolitician/jekyll-everypolitician)
 
 Use [EveryPolitician](http://everypolitician.org) data in your Jekyll generated site.
 
@@ -29,7 +29,32 @@ gems:
 
 ## Usage
 
-TODO: Write usage instructions here
+You need to configure Jekyll so it knows which data to use. In your `_config.yml` add the following to tell jekyll-everypolitician where to get the data from:
+
+```yaml
+everypolitician:
+  sources:
+    - https://github.com/everypolitician/everypolitician-data/raw/master/data/Australia/Representatives/ep-popolo-v1.0.json
+```
+
+This tells it to use the data for the Australian Representatives, and specifies which version of the data to use, in this case `master`.
+
+When sources is an array, as in the example above, the collections that are created are `people`, `organizations`, `areas` and `events`.
+
+Sometimes you'll want more than one source, for example you might want the upper house as well. For this case you can specify sources as a hash:
+
+```yaml
+everypolitician:
+  sources:
+    assembly: https://github.com/everypolitician/everypolitician-data/raw/master/data/Australia/Representatives/ep-popolo-v1.0.json
+    senate: https://github.com/everypolitician/everypolitician-data/raw/master/data/Australia/Senate/ep-popolo-v1.0.json
+```
+
+When `sources` is a hash like this the collections that are created are prefixed with the key of the hash, e.g. `assembly_people`, `senate_people`, `assembly_areas` etc.
+
+### Layouts
+
+This plugin will try and use layouts that are named after the generated collections. So in the examples above if you'd specified `sources` as an array then it would try to use `_layouts/people.html` as the layout for the `people` collection. Similarly if you specify `sources` as a hash then it would try to use something like `_layouts/assembly_people.html` for the `assembly_people` collection.
 
 ## Development
 

data/bin/console

@@ -6,9 +6,8 @@ require 'jekyll/everypolitician'
 # 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
+SITE = Jekyll::Site.new(Jekyll.configuration)
+SITE.config['everypolitician_url'] = 'test/fixtures/vatican-ep-popolo-v1.0.json'
 
-require 'irb'
-IRB.start
+require 'pry'
+Pry.start

data/jekyll-everypolitician.gemspec

@@ -24,4 +24,5 @@ Gem::Specification.new do |spec|
   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/everypolitician/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module Everypolitician
-    VERSION = '0.2.0'
+    VERSION = '0.3.0'
   end
 end

data/lib/jekyll/everypolitician.rb

@@ -10,44 +10,72 @@ require 'active_support/core_ext/string'
 module Jekyll
   module Everypolitician
     class Generator < Jekyll::Generator
+      COLLECTION_MAPPING = {
+        'persons' => 'people'
+      }
+
       def generate(site)
-        popolo = JSON.parse(open(site.config['everypolitician_url']).read)
+        return unless site.config.key?('everypolitician')
+        sources = site.config['everypolitician']['sources']
+        if sources.is_a?(Array)
+          generate_collections(site, sources.first)
+        elsif sources.is_a?(Hash)
+          sources.each do |prefix, source|
+            generate_collections(site, source, prefix)
+          end
+        end
+      end
+
+      def generate_collections(site, source, prefix = nil)
+        popolo = JSON.parse(open(source).read)
         memberships = popolo['memberships']
-        popolo.keys.each do |collection_name|
-          next unless popolo[collection_name].is_a?(Array)
+        popolo.keys.each do |type|
+          next unless popolo[type].is_a?(Array)
+          collection_name = collection_name_for(type, prefix)
           collection = Collection.new(site, collection_name)
-          popolo[collection_name].each do |item|
+          popolo[type].each do |item|
             next unless item['id']
             path = File.join(site.source, "_#{collection_name}", "#{item['id'].parameterize}.md")
             doc = Document.new(path, collection: collection, site: site)
             doc.merge_data!(item)
             doc.merge_data!(
               'title' => item['name'],
-              'layout' => collection_name,
-              'memberships' => memberships_for(item, collection_name, memberships)
+              'memberships' => memberships_for(item, type, memberships)
             )
+            if site.layouts.key?(collection_name)
+              doc.merge_data!('layout' => collection_name)
+            end
             collection.docs << doc
           end
           site.collections[collection_name] = collection
         end
 
         memberships.each do |membership|
-          membership['person'] = site.collections['persons'].docs.find { |p| p.data['id'] == membership['person_id'] }
-          membership['area'] = site.collections['areas'].docs.find { |a| a.data['id'] == membership['area_id'] }
-          membership['legislative_period'] = site.collections['events'].docs.find { |e| e.data['id'] == membership['legislative_period_id'] }
-          membership['organization'] = site.collections['organizations'].docs.find { |o| o.data['id'] == membership['organization_id'] }
-          membership['party'] = site.collections['organizations'].docs.find { |o| o.data['id'] == membership['on_behalf_of_id'] }
+          membership['person'] = site.collections[collection_name_for('persons', prefix)].docs.find { |p| p.data['id'] == membership['person_id'] }
+          membership['area'] = site.collections[collection_name_for('areas', prefix)].docs.find { |a| a.data['id'] == membership['area_id'] }
+          membership['legislative_period'] = site.collections[collection_name_for('events', prefix)].docs.find { |e| e.data['id'] == membership['legislative_period_id'] }
+          membership['organization'] = site.collections[collection_name_for('organizations', prefix)].docs.find { |o| o.data['id'] == membership['organization_id'] }
+          membership['party'] = site.collections[collection_name_for('organizations', prefix)].docs.find { |o| o.data['id'] == membership['on_behalf_of_id'] }
+        end
+      end
+
+      def collection_name_for(type, prefix = nil)
+        name = COLLECTION_MAPPING[type] || type
+        if prefix
+          [prefix, name].join('_')
+        else
+          name
         end
       end
 
-      def memberships_for(item, collection_name, memberships)
+      def memberships_for(item, type, memberships)
         map = {
           'areas' => 'area_id',
           'persons' => 'person_id',
           'events' => 'legislative_period_id',
           'organizations' => 'on_behalf_of_id'
         }
-        memberships.find_all { |m| m[map[collection_name]] == item['id'] }
+        memberships.find_all { |m| m[map[type]] == item['id'] }
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-everypolitician
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Chris Mytton
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !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