jekyll-data-revised 1.0.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8235a1de5929de3afae76827b3d20547fd0ff9837b8aa7d4d3a553a007efc8dd
-  data.tar.gz: 5eae835b1f3023ce3e242a8d3e1cadac9a9e2a56d0b335aba3ed3b0587f627bd
+  metadata.gz: 707b112f76f32fc1f14554a99f27c6c3efdddc6c86fa4d144a1dfd502cf9545b
+  data.tar.gz: 2b338246b25bc273206dcccb74220078a81163dd21dd2c4da370aed5c0deca9d
 SHA512:
-  metadata.gz: 0d000fd359099279f80bf071947e8dab18d4d450109c3848fe76186b5f3f180ed4c39bda9d43103378cd8332b901a1b667b8a3bb71fedd9f8f7dbb0b6ac9182a
-  data.tar.gz: 5758af8fe853e8948ce9fb0a620c9dabcbe6b8c596199c8505ea0cd583dfa38adf8a18e89026e296de0a9f2034ed1f52865fdc4f861bf9e56f2dfc288c7c01f7
+  metadata.gz: 55e039056d3b85569f743de12de8e6f4f093dff9f96f6bce4006329834482e0bc052d0307e51d890e830cce39bdb94721f12010dc266b3fd136e372033f160d1
+  data.tar.gz: 4434fff2d13688928b3bee6ce25e4947b59fb2980e5b84c11072443718640dab99aaf102487444852ff03384995ce073c0a0b6364fbdc27c13d637cf3f404659

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-data-revised
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Ashwin Maroli
@@ -106,19 +106,8 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files:
-- LICENSE.txt
-- README.md
-- lib/jekyll-data.rb
-- lib/jekyll-data/reader.rb
-- lib/jekyll-data/theme_configuration.rb
-- lib/jekyll-data/theme_data_reader.rb
-- lib/jekyll-data/themed_site_drop.rb
-- lib/jekyll-data/version.rb
-- lib/jekyll/build_options.rb
-- lib/jekyll/data_path.rb
-- lib/jekyll/theme_drop.rb
-homepage: https://github.com/ashmaroli/jekyll-data
+files: []
+homepage: https://github.com/ashmaroli/jekyll-data-revised
 licenses:
 - MIT
 metadata:

data/LICENSE.txt

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2016-2017 Ashwin Maroli & Contributors
-
-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

@@ -1,125 +0,0 @@
-# JekyllData
-
-[![Gem Version](https://img.shields.io/gem/v/jekyll-data.svg)](https://rubygems.org/gems/jekyll-data)
-[![Build Status](https://img.shields.io/travis/ashmaroli/jekyll-data/master.svg?label=Build%20Status)][travis]
-
-[travis]: https://travis-ci.org/ashmaroli/jekyll-data
-
-Introducing a plugin that reads data files within **jekyll theme-gems** and adds the resulting hash to the site's internal data hash. If a **`_config.yml`** is present at the root of the theme-gem, it will be evaluated and the extracted hash data will be incorporated into the site's existing config hash.
-
-
-## Installation
-
-Simply add the plugin to your site's Gemfile and config file like every other jekyll plugin gem:
-
-```ruby
-# Gemfile
-
-group :jekyll_plugins do
-  gem "jekyll-data"
-end
-```
-..and run
-
-    bundle install
-
-
-> **Note: If the plugin has been marked as a `runtime_dependency` by the theme-gem's author it will be installed automatically with the theme-gem. Yet, it is recommended that the plugin be added to `:jekyll_plugins` group in the Gemfile rather than the `gems:` array in the config file while building or serving the site to avoid 'overriding' the `gems:` array data that may have been read-in from the theme-gem.**
-
-
-## Usage
-
-**Note:** *This plugin will only run in conjunction with a gem-based Jekyll-theme.*
-
-As long as the plugin-gem has been installed properly, and is included in the Gemfile's `:jekyll_plugins` group, data files supported by Jekyll and present in the `_data` directory at the root of your theme-gem will be read. Their contents will be added to the site's internal data hash, provided, an identical data hash doesn't already exist at the site-source.
-
-If the theme-gem also includes a `_config.yml` at its root, then it will be read as well. The resulting config hash will be mixed into the site's existing config hash, filling in where the *keys* are not already defined. In other words, the config file at `source` will override corresponding identical keys in a `_config.yml` within the theme-gem which would in turn override corresponding `DEFAULTS` from Jekyll:
-
-  **DEFAULTS** < **_config.yml in theme-gem** < **_config.yml at source** < **Override configs via command-line**.
-
-
-### Theme Configuration
-
-Jekyll themes (built prior to `Jekyll 3.2`) usually ship with configuration settings defined in the config file, which are then used within the theme's template files directly under the `site` namespace (e.g. `{{ site.myvariable }}`). This is not possible with theme-gems as a config file and data files within gems are not natively read (as of Jekyll 3.3), and hence require end-users to inspect a *demo* or *example* directory to source those files.
-
-This plugin provides a solution to that hurdle:
-
-JekyllData now reads the config file (at present only `_config.yml`) present within the theme-gem and uses the data to modify the site's config hash. This allows the theme-gem to continue using `{{ site.myvariable }}` within its templates and work out-of-the-box as intended, with minimal user intervention.
-
-**Note: the plugins required by the theme may be listed under the `gems:` array and will be automatically `required` by Jekyll while building/serving, provided that the user doesn't have a different `gems:` array in the config file at source. Hence it is recommended to add all other plugins ( including `jekyll-data` ) via the Gemfile's `:jekyll_plugins` group.**
-
-#### The `theme` namespace
-
-From `v1.0`, JekyllData no longer supports reading theme configuration provided as a `[theme-name].***` file within the `_data` directory and instead the `theme` namespace points to a certain key in the bundled `_config.yml`.
-
-For `{{ theme.variable }}` to work, the config file should nest all such key-value pairs under the `[theme-name]` key, as outlined in the example below for a theme-gem called `solitude`:
-
-```yaml
-# <solitude-0.1.0>/_config.yml
-
-# the settings below have been used in this theme's templates via the `theme`
-# namespace. e.g. `{{ theme.recent_posts.style }}` instead of using the more
-# verbose `{{ site.solitude.recent_posts.style }}` though both are functionally
-# the same.
-#
-solitude:
-  sidebar       : true      # enter 'false' to enable horizontal navbar instead.
-  theme_variant : Charcoal  # choose from 'Ocean', 'Grass', 'Charcoal'
-  recent_posts  :
-    style       : list      # choose from 'list' and 'grid'.
-    quantity    : '4'       # either '4' or '6'
-
-```
-
-
-### Data files
-
-Data files may be used to supplement theme templates (e.g. locales and translated UI text) and can be named as desired.
-  - Organize related small data files in sub-directories. (or)
-  - Declare all related data as mapped data blocks within a single file.
-
-To illustrate with an example, consider a `locales.yml` that has mappings for `en:`, `fr:`, `it:`.
-
-```yaml
-# <theme-gem>/_data/locales.yml
-
-en:
-  previous : previous
-  next     : next
-
-fr:
-  previous : précédent
-  next     : prochain
-
-it:
-  previous : precedente
-  next     : seguente
-```
-
-the Hash from above would be identical to one had the gem been shipped with a `_data/locales` directory containing individual files for each language data.
-
-
-### Overriding Data Files
-
-To override data shipped with a theme-gem, simply have an identical hash at the site-source.
-
-Irrespective of whether the theme-gem ships with consolidated data files of related entities, or sub-directories containing individual files, the data can be overridden with a single file or with multiple files.
-
-For example, if a theme-gem contains the above sample `locales.yml`, then to override the `fr:` key-data simply have either of the following:
-  - a **`_data/locales/fr.yml`** with identical subkey(s).
-  - a **`_data/locales.yml`** with **`fr:`** with identical subkey(s).
-
---
-> **Note**
-  - having an **empty** `_data/locales.yml` at `source` directory will override the **entire `["data"]["locales"]` payload** from the theme-gem as **`false`**.
-  - having an **empty** `_data/locales/fr.yml` at `source` directory will override the **enire `["data"]["locales"]["fr"]` payload** from the theme-gem as **`false`**
-
-
-## Contributing
-
-Bug reports and pull requests are welcome at the [GitHub Repo](https://github.com/ashmaroli/jekyll-data). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
-
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/jekyll-data.rb

@@ -1,49 +0,0 @@
-require "jekyll"
-require "jekyll-data/version"
-
-module JekyllData
-  autoload :Reader,             "jekyll-data/reader"
-  autoload :ThemedSiteDrop,     "jekyll-data/themed_site_drop"
-  autoload :ThemeDataReader,    "jekyll-data/theme_data_reader"
-  autoload :ThemeConfiguration, "jekyll-data/theme_configuration"
-end
-
-# Monkey-patches
-require_relative "jekyll/build_options"
-require_relative "jekyll/data_path"
-require_relative "jekyll/theme_drop"
-
-# ----------------------------------------------------------------------------
-# Modify the current site instance if it uses a gem-based theme else have this
-# plugin disabled.
-#
-# if a '_config.yml' is present at the root of theme-gem, it is evaluated and
-# the extracted hash data is incorprated into the site's config hash.
-# ----------------------------------------------------------------------------
-Jekyll::Hooks.register :site, :after_reset do |site|
-  if site.theme
-    file = site.in_theme_dir("_config.yml")
-    JekyllData::ThemeConfiguration.reconfigure(site) if File.exist?(file)
-  else
-    Jekyll.logger.abort_with(
-      "JekyllData:",
-      "Error! This plugin only works with gem-based jekyll-themes. " \
-      "Please disable this plugin to proceed."
-    )
-  end
-end
-
-# ---------------------------------------------------------------------------
-# Replace Jekyll::Reader with a subclass JekyllData::Reader only if the
-# site uses a gem-based theme.
-#
-# If a _config.yml exists at the root of the theme-gem, output its path.
-# Placed here inorder to avoid outputting the path after every regeneration.
-# ---------------------------------------------------------------------------
-Jekyll::Hooks.register :site, :after_init do |site|
-  if site.theme
-    file = site.in_theme_dir("_config.yml")
-    Jekyll.logger.info "Theme Config file:", file if File.exist?(file)
-    site.reader = JekyllData::Reader.new(site)
-  end
-end

data/lib/jekyll-data/reader.rb

@@ -1,223 +0,0 @@
-# encoding: UTF-8
-require "csv"
-
-module JekyllData
-  class Reader < Jekyll::Reader
-    def initialize(site)
-      @site = site
-      @theme = site.theme
-      @theme_data_files = Dir[File.join(site.theme.root,
-        site.config["data_dir"], "**", "*.{yaml,yml,json,csv}")]
-    end
-
-    # Read data files within theme-gem.
-    #
-    # Returns nothing.
-    def read
-      super
-      read_theme_data
-    end
-
-    # Read data files within a theme gem and add them to internal data
-    #
-    # Returns a hash appended with new data
-    def read_theme_data
-      if @theme.data_path
-        #
-        # show contents of "<theme>/_data/" dir being read while degugging.
-        inspect_theme_data
-        theme_data = ThemeDataReader.new(site).read(site.config["data_dir"])
-        @site.data = Jekyll::Utils.deep_merge_hashes(theme_data, @site.data)
-        #
-        # show contents of merged site.data hash while debugging with
-        # additional --show-data switch.
-        inspect_merged_hash if site.config["show-data"] && site.config["verbose"]
-      end
-    end
-
-    private
-
-    # Private:
-    # (only while debugging)
-    #
-    # Print a list of data file(s) within the theme-gem
-    def inspect_theme_data
-      print_clear_line
-      Jekyll.logger.debug "Reading:", "Theme Data Files..."
-      @theme_data_files.each { |file| Jekyll.logger.debug "", file }
-      print_clear_line
-      Jekyll.logger.debug "Merging:", "Theme Data Hash..."
-
-      unless site.config["show-data"] && site.config["verbose"]
-        Jekyll.logger.debug "", "use --show-data with --verbose to output " \
-                                "merged Data Hash.".cyan
-        print_clear_line
-      end
-    end
-
-    # Private:
-    # (only while debugging)
-    #
-    # Print contents of the merged data hash
-    def inspect_merged_hash
-      Jekyll.logger.debug "Inspecting:", "Site Data >>"
-
-      # the width of generated logger[message]
-      @width = 50
-      @dashes = "-" * @width
-
-      inspect_hash @site.data
-      print_clear_line
-    end
-
-    # --------------------------------------------------------------------
-    # Private helper methods to inspect data hash and output contents
-    # to logger at level debugging.
-    # --------------------------------------------------------------------
-
-    # Dissect the (merged) site.data hash and print its contents
-    #
-    # - Print the key string(s)
-    # - Individually analyse the hash[key] values and extract contents
-    #   to output.
-    def inspect_hash(hash)
-      hash.each do |key, value|
-        print_key key
-        if value.is_a? Hash
-          inspect_inner_hash value
-        elsif value.is_a? Array
-          extract_hashes_and_print value
-        else
-          print_string value.to_s
-        end
-      end
-    end
-
-    # Analyse deeper hashes and extract contents to output
-    def inspect_inner_hash(hash)
-      hash.each do |key, value|
-        if value.is_a? Array
-          print_label key
-          extract_hashes_and_print value
-        elsif value.is_a? Hash
-          print_subkey_and_value key, value
-        else
-          print_hash key, value
-        end
-      end
-    end
-
-    # If an array of strings, print. Otherwise assume as an
-    # array of hashes (sequences) that needs further analysis.
-    def extract_hashes_and_print(array)
-      array.each do |entry|
-        if entry.is_a? String
-          print_list entry
-        else
-          inspect_inner_hash entry
-        end
-      end
-    end
-
-    #
-
-    # --------------------------------------------------------------------
-    # Private methods for formatting log messages while debugging
-    # --------------------------------------------------------------------
-
-    # Splits a string longer than the value of '@width' into smaller
-    # strings and prints each line as a logger[message]
-    #
-    # string - the long string
-    #
-    # label - optional text to designate the printed lines.
-    def print_long_string(string, label = "")
-      strings = string.scan(%r!(.{1,#{@width}})(\s+|\W|\Z)!).map { |s| s.join.strip }
-      first_line = strings.first.cyan
-
-      label.empty? ? print_value(first_line) : print(label, first_line)
-      strings[1..-1].each { |s| print_value s.cyan }
-    end
-
-    # Prints key as logger[topic] and value as [message]
-    def print_hash(key, value)
-      if value.length > @width
-        print_long_string value, "#{key}:"
-      else
-        print "#{key}:", value.cyan
-      end
-    end
-
-    def print_list(item)
-      if item.length > @width
-        print_long_string item, "-"
-      else
-        print "-", item.cyan
-      end
-    end
-
-    def print_string(str)
-      if str.length > @width
-        print_long_string str
-      else
-        print_value str.inspect
-      end
-    end
-
-    # Prints the site.data[key] in color
-    def print_key(key)
-      print_clear_line
-      print "Data Key:", " #{key} ".center(@width, "=")
-      print_clear_line
-    end
-
-    # Prints label, keys and values of mappings
-    def print_subkey_and_value(key, value)
-      print_label key
-      value.each do |subkey, val|
-        if val.is_a? Hash
-          print_inner_subkey subkey
-          inspect_inner_hash val
-        elsif val.is_a? Array
-          print_inner_subkey subkey
-          extract_hashes_and_print val
-        elsif val.is_a? String
-          print_hash subkey, val
-        end
-      end
-    end
-
-    # Print only logger[message], [topic] = nil
-    def print_value(value)
-      if value.is_a? Array
-        extract_hashes_and_print value
-      else
-        print "", value
-      end
-    end
-
-    # Print only logger[topic] appended with a colon
-    def print_label(key)
-      print_value " #{key} ".center(@width, "-")
-    end
-
-    def print_inner_subkey(key)
-      print "#{key}:", @dashes
-    end
-
-    def print_dashes
-      print "", @dashes
-    end
-
-    def print_clear_line
-      print ""
-    end
-
-    # Redefine Jekyll Loggers to have the [topic] indented by 30.
-    # (rjust by just 29 to accomodate the additional whitespace added
-    # by Jekyll)
-    def print(topic, message = "")
-      Jekyll.logger.debug topic.rjust(29), message
-    end
-  end
-end

data/lib/jekyll-data/theme_configuration.rb

@@ -1,64 +0,0 @@
-# encoding: UTF-8
-
-module JekyllData
-  class ThemeConfiguration < Jekyll::Configuration
-    class << self
-      # Public: Establish a new site.config hash by reading an optional config
-      #         file within the theme-gem and appending the resulting hash to
-      #         existing site.config filling in keys not already defined.
-      #
-      # site: current Jekyll::Site instance.
-      #
-      # Returns a config Hash to be used by an 'after_reset' hook.
-      def reconfigure(site)
-        default_hash = Jekyll::Configuration::DEFAULTS
-        theme_config = ThemeConfiguration.new(site).read_theme_config
-
-        # Merge with existing site.config and strip any remaining defaults
-        config = Jekyll::Utils.deep_merge_hashes(
-          theme_config, site.config
-        ).reject { |key, value| value == default_hash[key] }
-
-        # Merge DEFAULTS < _config.yml in theme-gem < config file(s) from source
-        # and redefine site.config
-        site.config = Jekyll::Configuration.from(
-          Jekyll::Utils.deep_merge_hashes(theme_config, config)
-        )
-      end
-    end
-
-    #
-
-    def initialize(site)
-      @site = site
-    end
-
-    # Public: Read the '_config.yml' file within the theme-gem.
-    #         Additionally validates that the extracted config data and the
-    #         the 'value' of '<site.theme.name> key', when present, is a Hash.
-    #
-    # Returns a Configuration Hash
-    def read_theme_config
-      file = @site.in_theme_dir("_config.yml")
-      theme_name = @site.theme.name
-
-      config = safe_load_file(file)
-
-      check_config_is_hash!(config, file)
-      validate_config_hash config[theme_name] unless config[theme_name].nil?
-
-      config
-    end
-
-    private
-
-    # Validate the <site.theme.name> key's value to be accessed via the `theme`
-    # namespace.
-    def validate_config_hash(value)
-      unless value.is_a? Hash
-        Jekyll.logger.abort_with "JekyllData:", "Theme Configuration should be a " \
-            "Hash of key:value pairs or mappings. But got #{value.class} instead."
-      end
-    end
-  end
-end

data/lib/jekyll-data/theme_data_reader.rb

@@ -1,37 +0,0 @@
-module JekyllData
-  class ThemeDataReader < Jekyll::DataReader
-    attr_reader :site, :content
-    def initialize(site)
-      @site = site
-      @content = {}
-      @entry_filter = Jekyll::EntryFilter.new(site)
-    end
-
-    def read(dir)
-      return unless site.theme && site.theme.data_path
-      base = site.in_theme_dir(dir)
-      read_data_to(base, @content)
-      @content
-    end
-
-    def read_data_to(dir, data)
-      return unless File.directory?(dir) && !@entry_filter.symlink?(dir)
-
-      entries = Dir.chdir(dir) do
-        Dir["*.{yaml,yml,json,csv}"] + Dir["*"].select { |fn| File.directory?(fn) }
-      end
-
-      entries.each do |entry|
-        path = @site.in_theme_dir(dir, entry)
-        next if @entry_filter.symlink?(path)
-
-        if File.directory?(path)
-          read_data_to(path, data[sanitize_filename(entry)] = {})
-        else
-          key = sanitize_filename(File.basename(entry, ".*"))
-          data[key] = read_data_file(path)
-        end
-      end
-    end
-  end
-end

data/lib/jekyll-data/themed_site_drop.rb

@@ -1,15 +0,0 @@
-# encoding: UTF-8
-
-module JekyllData
-  class ThemedSiteDrop < Jekyll::Drops::SiteDrop
-    extend Forwardable
-
-    mutable false
-
-    def_delegator  :@obj, :site_data, :data
-    def_delegators :@obj, :theme
-
-    private
-    def_delegator :@obj, :config, :fallback_data
-  end
-end

data/lib/jekyll-data/version.rb

@@ -1,3 +0,0 @@
-module JekyllData
-  VERSION = "1.0.1".freeze
-end

data/lib/jekyll/build_options.rb

@@ -1,17 +0,0 @@
-module Jekyll
-  class Command
-    class << self
-      #
-      # patch original method to inject a '--show-data' switch to display
-      # merged data hash
-      #
-      alias_method :original_build_options, :add_build_options
-
-      def add_build_options(c)
-        original_build_options(c)
-        c.option "show-data", "--show-data",
-          "Print merged site-data hash when used with --verbose."
-      end
-    end
-  end
-end

data/lib/jekyll/data_path.rb

@@ -1,7 +0,0 @@
-module Jekyll
-  class Theme
-    def data_path
-      path_for "_data".freeze
-    end
-  end
-end

data/lib/jekyll/theme_drop.rb

@@ -1,20 +0,0 @@
-# encoding: UTF-8
-
-module Jekyll
-  module Drops
-    class UnifiedPayloadDrop < Drop
-      def site
-        @site_drop ||= JekyllData::ThemedSiteDrop.new(@obj)
-      end
-
-      # Register a namespace to easily call subkeys under <theme-name> key
-      # in the _config.yml within a theme-gem via its bundled templates.
-      #   e.g. with this drop, theme-specific variables usually called like
-      #        {{ site.minima.date_format }} can be shortened to simply
-      #        {{ theme.date_format }}.
-      def theme
-        @theme_drop ||= site[site.theme.name]
-      end
-    end
-  end
-end