jekyll-frontmatter-jsonify 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: de6168b0fe3028bc633b15dafe93e57f76c44693
-  data.tar.gz: c403d1ec5e845f926b32af6fc91000f587ab1666
+  metadata.gz: 722914f5b9e52542944d93bb8137dbbceb414429
+  data.tar.gz: b60daa84c86f9c4eb23247d68442bf307c3e478a
 SHA512:
-  metadata.gz: f5638d7dafa89e17e4554146eac8630f4e9e63e5ec7e4f0e11a96cdcb4a9d3b83d9ef324b200bb54bbc14706f77721adc7d6cc4ebbe6c1a79f5725b244812613
-  data.tar.gz: 9df557b37805ecb743c7dcc810e9d52e237a6766019dcd22ece65492b7d0834b44c7e7dadb20892104cb791ddfaa90d62d04dc0cb6a94f81b44ad61d74a1ae02
+  metadata.gz: 17264ee36f75aed88c5d39f275035157112c60e6663ecda1588c00577d70688126f3011efa55c68fae833fc8caf1df6afd3e626cf2449118088e5640fed1fa93
+  data.tar.gz: f5e3687842dfd0ac075d741cc7336342ec3c8315d3847dc397e4a8ef865e288e76ea984375c9f09f4d14cd721d8fd71c8a321db9fa32085d483894eb3823f12f

data/README.md

@@ -1,6 +1,16 @@
 # Jekyll Frontmatter Jsonify
 
-The problem with the `jsonify` filter on a collection is that it will convert only the body of the collection item into a JSON array but not the frontmatter.
+## Use it
+
+Take a look at [Jekyll's instructions for loading plugins](https://jekyllrb.com/docs/plugins/#installing-a-plugin).
+
+```
+gem install jekyll-frontmatter-jsonify
+```
+
+## The problem
+
+The `jsonify` filter when applied to a collection will convert only the body of the collection item into a JSON array, and not the frontmatter.
 
 For example, we have a collection with two items:
 
@@ -24,7 +34,7 @@ food: toast
 Awesome content from 'item2.md'
 ```
 
-## The `jsonify` filter
+### The `jsonify` filter
 
 ```
 {{ site.sample_collection | jsonify }}
@@ -36,7 +46,7 @@ Awesome content from 'item2.md'
 [ "Sample Content from 'item1.md'", "Awesome content from 'item2.md'" ]
 ```
 
-## The `collection_jsonify` filter
+## The solution
 
 This plug-in introduces the `collection_jsonify` Liquid filter which will convert each collection item's frontmatter into a JSON array.
 
@@ -69,4 +79,4 @@ This filter takes a single boolean as a parameter (defaults to `false`) that wil
 
 ## License
 
-MIT
+MIT

data/jekyll-frontmatter-jsonify.gemspec

@@ -1,12 +1,13 @@
+require File.expand_path '../lib/jekyll-frontmatter-jsonify/version', __FILE__
+
 Gem::Specification.new do |s|
   s.name        = 'jekyll-frontmatter-jsonify'
-  s.version     = '0.0.1'
-  s.date        = '2016-05-18'
+  s.version     = Jekyll::FrontMatterJsonify::VERSION
+  s.date        = Date.today.to_s
   s.summary     = "Output frontmatter of collections as JSON"
   s.description = "A liquid filter plugin for Jekyll which outputs the frontmatter of each item in a collection as a JSON array"
   s.authors     = ["City of Santa Monica"]
   s.email       = 'data@smgov.net'
-  s.files       = ["lib/jekyll-frontmatter-jsonify.rb"]
   s.homepage    =
     'https://github.com/CityofSantaMonica/jekyll-frontmatter-jsonify'
   s.license     = 'MIT'

data/lib/jekyll-frontmatter-jsonify.rb

@@ -1,22 +1,35 @@
 module Jekyll
   module FrontMatterJsonify
-    # These are keys defined by Jekyll that don't mean anything to analytics-reporter
+    # Jekyll keys to always ignore
+    KeysBlacklist = [
+      'next', 'previous'
+    ]
+
+    # These are keys defined and created by Jekyll. They will be ignored if the user chooses to exclude them from the
+    # JSON array
     JekyllKeys = [
-      'next', 'previous', 'path', 'id', 'output', 'content', 'to_s',
-      'relative_path', 'url', 'collection', 'excerpt', 'draft', 'categories',
+      'path', 'id', 'output', 'content', 'to_s', 'relative_path',
+      'url', 'collection', 'excerpt', 'draft', 'categories',
       'title', 'slug', 'ext', 'tags', 'date'
     ]
 
     def collection_jsonify(collection, ignore_jekyll_keys = false)
-      results = []
+      collectionArray = []
 
       collection.each do |item|
-        JekyllKeys.each{ |k| item.data.delete(k) } if ignore_jekyll_keys
+        docDrop = Drops::DocumentDrop.new(item)
+        results = {}
+
+        docDrop.keys.each do |key|
+          next if (ignore_jekyll_keys and JekyllKeys.include? key) or (KeysBlacklist.include? key)
+
+          results[key] = docDrop[key]
+        end
 
-        results << item.data
+        collectionArray << results
       end
 
-      results.to_json
+      collectionArray.to_json
     end
   end
 end

data/lib/jekyll-frontmatter-jsonify/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-frontmatter-jsonify
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - City of Santa Monica
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-18 00:00:00.000000000 Z
+date: 2016-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -35,6 +35,7 @@ files:
 - README.md
 - jekyll-frontmatter-jsonify.gemspec
 - lib/jekyll-frontmatter-jsonify.rb
+- lib/jekyll-frontmatter-jsonify/version.rb
 homepage: https://github.com/CityofSantaMonica/jekyll-frontmatter-jsonify
 licenses:
 - MIT