jekyll-frontmatter-jsonify 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: de6168b0fe3028bc633b15dafe93e57f76c44693
+  data.tar.gz: c403d1ec5e845f926b32af6fc91000f587ab1666
+SHA512:
+  metadata.gz: f5638d7dafa89e17e4554146eac8630f4e9e63e5ec7e4f0e11a96cdcb4a9d3b83d9ef324b200bb54bbc14706f77721adc7d6cc4ebbe6c1a79f5725b244812613
+  data.tar.gz: 9df557b37805ecb743c7dcc810e9d52e237a6766019dcd22ece65492b7d0834b44c7e7dadb20892104cb791ddfaa90d62d04dc0cb6a94f81b44ad61d74a1ae02

data/.gitignore

@@ -0,0 +1,51 @@
+### Linux ###
+*~
+
+# temporary files which can be created if a process still has a handle open of a deleted file
+.fuse_hidden*
+
+# KDE directory preferences
+.directory
+
+# Linux trash folder which might appear on any partition or disk
+.Trash-*
+
+
+### Ruby ###
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+

data/README.md

@@ -0,0 +1,72 @@
+# 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.
+
+For example, we have a collection with two items:
+
+**_sample_collection/item1.md**
+
+```
+---
+food: bacon
+---
+
+Sample Content from 'item1.md'
+```
+
+**_sample_collection/item2.md**
+
+```
+---
+food: toast
+---
+
+Awesome content from 'item2.md'
+```
+
+## The `jsonify` filter
+
+```
+{{ site.sample_collection | jsonify }}
+```
+
+**Returns**
+
+```
+[ "Sample Content from 'item1.md'", "Awesome content from 'item2.md'" ]
+```
+
+## The `collection_jsonify` filter
+
+This plug-in introduces the `collection_jsonify` Liquid filter which will convert each collection item's frontmatter into a JSON array.
+
+```
+{{ site.sample_collection | collection_jsonify }}
+```
+
+**Returns**
+
+```
+[
+  {
+      "food": "bacon",
+      // Jekyll default keys
+      "draft": false,
+      "categories": [],
+      "ext": ".md"
+  },
+  {
+      "food": "toast",
+      // Jekyll default keys
+      "draft": false,
+      "categories": [],
+      "ext": ".md"
+  }
+]
+```
+
+This filter takes a single boolean as a parameter (defaults to `false`) that will ignore Jekyll's default keys in the frontmatter and only return the custom data a collection item has in its frontmatter. In the above example, only the "food" key would be outputted if the parameter was set to true (i.e. ` | collection_jsonify: true`)
+
+## License
+
+MIT

data/jekyll-frontmatter-jsonify.gemspec

@@ -0,0 +1,19 @@
+Gem::Specification.new do |s|
+  s.name        = 'jekyll-frontmatter-jsonify'
+  s.version     = '0.0.1'
+  s.date        = '2016-05-18'
+  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'
+
+  s.files         = `git ls-files -z`.split("\x0")
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency "jekyll", '>= 2.4'
+end

data/lib/jekyll-frontmatter-jsonify.rb

@@ -0,0 +1,24 @@
+module Jekyll
+  module FrontMatterJsonify
+    # These are keys defined by Jekyll that don't mean anything to analytics-reporter
+    JekyllKeys = [
+      'next', 'previous', '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 = []
+
+      collection.each do |item|
+        JekyllKeys.each{ |k| item.data.delete(k) } if ignore_jekyll_keys
+
+        results << item.data
+      end
+
+      results.to_json
+    end
+  end
+end
+
+Liquid::Template.register_filter(Jekyll::FrontMatterJsonify)

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-frontmatter-jsonify
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- City of Santa Monica
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.4'
+description: A liquid filter plugin for Jekyll which outputs the frontmatter of each
+  item in a collection as a JSON array
+email: data@smgov.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- README.md
+- jekyll-frontmatter-jsonify.gemspec
+- lib/jekyll-frontmatter-jsonify.rb
+homepage: https://github.com/CityofSantaMonica/jekyll-frontmatter-jsonify
+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.1
+signing_key: 
+specification_version: 4
+summary: Output frontmatter of collections as JSON
+test_files: []