jekyll-tidy-json 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a100fe883b4f484897f0ea5d76dcdbfad084a12bd7c8576f950b1fbc80b4aa66
+  data.tar.gz: c311f572cacd7564f213558696f42b440d1c4e37b3e6f648c8ada464f8516a20
+SHA512:
+  metadata.gz: b95e847956a0994a986e20df431a47b6a2c1e88610352af202dcc3ab3d934828f28793039520bb244044f54e6a451efdc6be4659c8e851a5538d8891ffd2183b
+  data.tar.gz: 3466c5bbaab955fd2dd4e75b413aefac431d44a3ffcb7cd54fc963788636f315fd405ee1b133d6cb127d98744f76cd65aacf86b4b3aa2f641a8f84c2ef4fea6f

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in jekyll-tidy_json.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Ribose Inc.
+
+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.adoc

@@ -0,0 +1,87 @@
+= Jekyll-Tidy-JSON
+
+ifdef::env-github[]
+image:https://img.shields.io/gem/v/jekyll-tidy-json[
+    "Gem Version",
+    link="https://rubygems.org/gems/jekyll-tidy-json"]
+image:https://img.shields.io/github/workflow/status/geolexica/jekyll-tidy-json/Tests[
+    "Build Status",
+    link="https://github.com/geolexica/jekyll-tidy-json/actions"]
+endif::[]
+
+A Jekyll plugin that cleans JSONs up.
+
+It takes a JSON page and applies consistent formatting rules to it.  If that
+input is malformed, then raises an exception at site building time to prevent
+you from deploying a buggy site.
+
+If you use Liquid templates to build JSONs for your site, then you probably
+really want it.
+
+== Installation
+
+Include this gem in your site's Gemfile under the `:jekyll_plugins group`:
+
+[source,lang=sh]
+----
+group :jekyll_plugins do
+  gem "jekyll-tidy-json"
+end
+----
+
+Visit https://jekyllrb.com/docs/plugins/installation/[Jekyll documentation]
+for a detailed description or more installation options.
+
+== Configuration
+
+This plugin's behaviour is steered by "tidy_json" entry in site's `_config.yml`.
+For example, following enables JSON prettifying:
+
+[source,lang=yaml]
+----
+tidy_json:
+  pretty: true
+----
+
+Available configuration options:
+
+[cols=3*,options="header"]
+|===
+| Option name
+| Description
+| Default setting
+
+| `enabled`
+| Can be used to disable the plugin entirely by setting it to `false`.
+| `true`
+
+| `pretty`
+| If set to `true`, then JSONs will be prettified for readability sake.  If
+set to `false`, then all unnecessary spaces and new lines will be removed.
+| `false`
+|===
+
+== TODO
+
+This plugin is fairly complete.  However, some enhancements would be welcome:
+
+- more options for pretty formatting
+- options for including/excluding JSON files
+- JSON sanitizing features, perhaps by integrating
+  https://github.com/OWASP/json-sanitizer[json-sanitizer] by OWASP
+- support for some improved JSON syntax like https://json5.org/[JSON5]
+  or http://www.relaxedjson.org/[Relaxed JSON] if any of them gets popular
+  enough
+
+== Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/geolexica/jekyll-tidy-json.
+
+== Credits
+
+This gem is developed, maintained and funded by
+https://www.ribose.com[Ribose Inc.]
+
+== License
+
+This gem is licensed under MIT license.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "jekyll/tidy_json"
+
+# 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(__FILE__)

data/bin/setup

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

data/jekyll-tidy-json.gemspec

@@ -0,0 +1,37 @@
+require_relative 'lib/jekyll/tidy_json/version'
+
+ALL_FILES_IN_GIT = Dir.chdir(__dir__) { `git ls-files -z`.split("\x0") }
+
+Gem::Specification.new do |spec|
+  spec.name          = "jekyll-tidy-json"
+  spec.version       = Jekyll::TidyJSON::VERSION
+  spec.authors       = ["Ribose Inc."]
+  spec.email         = ["open.source@ribose.com"]
+
+  spec.summary       = "A Jekyll plugin that cleans JSONs up."
+  spec.description   = spec.summary + " If you use Liquid templates to build " +
+                       "JSONs for your site, then you probably really want it."
+  spec.homepage      = "https://github.com/geolexica/jekyll-tidy-json"
+  spec.license       = "MIT"
+
+  spec.metadata = {
+    "bug_tracker_uri"   => (spec.homepage + "/issues"),
+    "homepage_uri"      => spec.homepage,
+    "source_code_uri"   => spec.homepage,
+  }
+
+  spec.files         = ALL_FILES_IN_GIT.reject do |f|
+    f.match(%r{^(test|spec|features|.github)/}) ||
+    %w[.editorconfig .gitignore .rspec].include?(f)
+  end
+
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.add_runtime_dependency "jekyll", ">= 3.8", "< 5"
+
+  spec.add_development_dependency "rspec", "~> 3.9"
+end

data/lib/jekyll-tidy-json.rb

@@ -0,0 +1,5 @@
+# There is Jekyll convention to use kebab-case only in gem names, even though
+# it conflicts with Ruby conventions.  This file is meant to bridge
+# one convention to another.
+
+require_relative "jekyll/tidy_json"

data/lib/jekyll/tidy_json.rb

@@ -0,0 +1,58 @@
+require "jekyll"
+require "json"
+
+require_relative "tidy_json/version"
+
+module Jekyll
+  module TidyJSON
+    class Processor
+      def initialize(config)
+        parse_plugin_config config.fetch("tidy_json", {})
+      end
+
+      def should_tidy?(path)
+        File.extname(path).downcase == ".json"
+      end
+
+      def tidy_page_or_document(page_or_document)
+        path = page_or_document.relative_path
+
+        if should_tidy?(path)
+          Jekyll.logger.debug("Tidy up JSON:", path)
+          page_or_document.output = tidy_string(page_or_document.output)
+        end
+      end
+
+      def tidy_string(string)
+        return string if !enabled? || string.empty?
+        json = JSON.parse(string)
+        meth = self.pretty? ? :pretty_generate : :fast_generate
+
+        JSON.public_send meth, json
+      end
+
+      def pretty?
+        !!@pretty
+      end
+
+      def enabled?
+        !!@enabled
+      end
+
+      private
+
+      def parse_plugin_config(pc)
+        @enabled = pc.fetch("enabled", true)
+        @pretty = pc.fetch("pretty", false)
+      end
+    end
+  end
+end
+
+Jekyll::Hooks.register :documents, :post_render do |doc|
+  Jekyll::TidyJSON::Processor.new(doc.site.config).tidy_page_or_document(doc)
+end
+
+Jekyll::Hooks.register :pages, :post_render do |page|
+  Jekyll::TidyJSON::Processor.new(page.site.config).tidy_page_or_document(page)
+end

data/lib/jekyll/tidy_json/version.rb

@@ -0,0 +1,5 @@
+module Jekyll
+  module TidyJSON
+    VERSION = "1.0.0"
+  end
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-tidy-json
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ribose Inc.
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-05-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+description: A Jekyll plugin that cleans JSONs up. If you use Liquid templates to
+  build JSONs for your site, then you probably really want it.
+email:
+- open.source@ribose.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.txt
+- README.adoc
+- Rakefile
+- bin/console
+- bin/setup
+- jekyll-tidy-json.gemspec
+- lib/jekyll-tidy-json.rb
+- lib/jekyll/tidy_json.rb
+- lib/jekyll/tidy_json/version.rb
+homepage: https://github.com/geolexica/jekyll-tidy-json
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/geolexica/jekyll-tidy-json/issues
+  homepage_uri: https://github.com/geolexica/jekyll-tidy-json
+  source_code_uri: https://github.com/geolexica/jekyll-tidy-json
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A Jekyll plugin that cleans JSONs up.
+test_files: []