jekyll-data 0.2.1 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7c383a01aa3bb9fe5690b81d7cd54125be7ac8b3
-  data.tar.gz: 0f98f59af2bee263e7af7e10304e23318b632cd0
+SHA256:
+  metadata.gz: bfc00c25a2b9ae9878a4c854955f88698b114a1a0b7ed4733ec56ee691bdf507
+  data.tar.gz: 972a9a1d061585cadf5ceb5c10e057967ccfa6abb37b647682f942ef02bb94a2
 SHA512:
-  metadata.gz: 3bc5a33b09beb3c7cb19c474c723928eb0e8f79f93beac5568f0714440a196ae5e8bfbba58bd54e550082688576c3d696b6cbdd8b3112078006aff8081a8cbc4
-  data.tar.gz: 72e1317d7b637897ac35a0ccecc711772145bc45baf1b6a016b5e4a879d32136816e5f6bac9f0d9e6395e24f0950d8d72b1aa8fb677da4adc1f454c26183a51e
+  metadata.gz: 18c73a13bef6df9cf945301e8cb1ae8ed62882a0b9b39de1da8e4b4d4124b93ccb07f86ee1bafd363c6ad8591ffe891ec8498a9aa01d9949e24a00a9f309181b
+  data.tar.gz: b97f8328beb1003c23f4d0f96f05177f762dfceeffcbb7c577c9db1304076235d866da32cda1cfc952e4a59b93fa994572477d1a846cea3a60cf4e48c26088d1

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 Ashwin Maroli
+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

data/README.md

@@ -1,118 +1,118 @@
 # 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.
 
-Introducing a plugin that reads data files within **jekyll theme gems** and adds the resulting hash to the site's internal data hash.
 
 ## Installation
 
-Simply add the plugin to your site's Gemfile and config file like every other jekyll plugin gems..
+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
-``` 
-```yaml
-# _config.yml
+```
+..and run
 
-gems:
-  - jekyll-data
+    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.**
 
-```
-..and run 
-```
-bundle install
-```
 
 ## Usage
 
-As long as the gem has been installed properly, and is included in the Gemfile & the config file, 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.
+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 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 way to have the said data-files read and be used by the site. This plugin expects to find all data-files within the `_data` directory at the root of the theme gem.
+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.
 
-Theme specific directives *should* be defined in a file named the same as `theme.name`.  
-e.g. if *minima* were to ship a YAML file with such directives, then it would've a **_data/minima.yml** and variables within it would be referenced in the template files using a `theme` namespace like so: `{{ theme.myvariable }}` (which is functionally identical to `{{ site.data.minima.myvariable }}`)
+This plugin provides a solution to that hurdle:
 
-### Regular Data-files
+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`:
 
-Regular data files that may be used to supplement theme templates (e.g. demo placeholders) can be named as desired. Either use a sub-directory to house related data-files or declare all of them as a mapped data block within a single file.
-```yaml
-# <theme-gem>/_data/apparel.yml
-
-shirts:
-  - color: white
-    size: large
-    image: s_w_lg.jpg
-  - color: black
-    size: large
-    image: s_b_lg.jpg
-
-jeans:
-  - color: khaki
-    waist: 34
-    image: j_kh_34.jpg
-  - color: blue
-    waist: 32
-    image: j_bu_32.jpg
-```
-is the same as:
-```yaml
-# <theme-gem>/_data/apparel/shirts.yml
-
-- color: white
-  size: large
-  image: s_w_lg.jpg
-- color: black
-  size: large
-  image: s_b_lg.jpg
-```
 ```yaml
-# <theme-gem>/_data/apparel/jeans.yml
-
-- color: khaki
-  waist: 34
-  image: j_kh_34.jpg
-- color: blue
-  waist: 32
-  image: j_bu_32.jpg
+# <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'
+
 ```
 
-### User-overrides
 
-To override directives shipped with a theme gem, simply have an identical hash at the site-source.  
-e.g.
+### 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
-# <site_source_dir>/_data/navigation.yml
-
-mainmenu:
-  - title: Home
-    url: /
-  - title: Kitchen Diaries
-    url: /kitchen-diaries/
-  - title: Tips & Tricks
-    url: /tips-n-tricks/
-  - title: Health Facts
-    url: /health/
-  - title: About Me
-    url: /about/ 
- ```
- would have overridden the following:
- ```yaml
-# <theme-gem>/_data/navigation/mainmenu.yml
-
-- title: Link Item 1
-  url: /link-one/
-- title: Link Item 2
-  url: /link-two/
-- title: Link Item 3
-  url: /link-three/
+# <theme-gem>/_data/locales.yml
+
+en:
+  previous : previous
+  next     : next
+
+fr:
+  previous : précédent
+  next     : prochain
+
+it:
+  previous : precedente
+  next     : successivo
 ```
 
+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.
@@ -121,4 +121,3 @@ Bug reports and pull requests are welcome at the [GitHub Repo](https://github.co
 ## 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,16 +1,52 @@
+# frozen_string_literal: true
+
 require "jekyll"
 require "jekyll-data/version"
 
-# Plugin inclusions
-require_relative "jekyll/theme_reader"
-require_relative "jekyll/readers/theme_data_reader"
-require_relative "jekyll/drops/themed_site_drop"
+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/theme"
-require_relative "jekyll/drops/unified_payload_drop"
+require_relative "jekyll/build_options"
+require_relative "jekyll/data_path"
+require_relative "jekyll/theme_drop"
+
+# ----------------------------------------------------------------------------
+# Modify the current site instance only if it uses a gem-based theme.
+#
+# 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 4.0 has this feature incorporated in its core.*
+# ----------------------------------------------------------------------------
+unless Jekyll::VERSION.start_with?("4")
+  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)
+    end
+  end
+end
 
-# replace Jekyll::Reader with a subclass Jekyll::ThemeReader
+# ---------------------------------------------------------------------------
+# 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 4.0 detects a theme-configuration natively.*
+# ---------------------------------------------------------------------------
 Jekyll::Hooks.register :site, :after_init do |site|
-  site.reader = Jekyll::ThemeReader.new(site)
+  if site.theme
+    unless Jekyll::VERSION.start_with?("4")
+      file = site.in_theme_dir("_config.yml")
+      Jekyll.logger.info "Theme Config file:", file if File.exist?(file)
+    end
+    site.reader = JekyllData::Reader.new(site)
+  end
 end

data/lib/jekyll-data/reader.rb

@@ -0,0 +1,226 @@
+# frozen_string_literal: true
+
+require "csv"
+
+module JekyllData
+  class Reader < Jekyll::Reader
+    def initialize(site)
+      @site = site
+      @theme = site.theme
+
+      if @theme.data_path
+        @theme_data_files = Dir[File.join(@theme.data_path, "**", "*.{yaml,yml,json,csv,tsv}")]
+      end
+    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

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+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/readers → jekyll-data}/theme_data_reader.rb

@@ -1,14 +1,18 @@
-module Jekyll
-  class ThemeDataReader < DataReader
+# frozen_string_literal: true
+
+module JekyllData
+  class ThemeDataReader < Jekyll::DataReader
     attr_reader :site, :content
+
     def initialize(site)
-      @site = site
-      @content = {}
-      @entry_filter = EntryFilter.new(site)
+      super
+
+      @source_dir = site.in_theme_dir("/")
     end
 
     def read(dir)
       return unless site.theme && site.theme.data_path
+
       base = site.in_theme_dir(dir)
       read_data_to(base, @content)
       @content
@@ -18,7 +22,7 @@ module Jekyll
       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) }
+        Dir["*.{yaml,yml,json,csv,tsv}"] + Dir["*"].select { |fn| File.directory?(fn) }
       end
 
       entries.each do |entry|

data/lib/jekyll-data/themed_site_drop.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+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 +1,5 @@
+# frozen_string_literal: true
+
 module JekyllData
-  VERSION = "0.2.1".freeze
+  VERSION = "1.1.1"
 end

data/lib/jekyll/build_options.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+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(cmd)
+        original_build_options(cmd)
+        cmd.option "show-data", "--show-data",
+                   "Print merged site-data hash when used with --verbose."
+      end
+    end
+  end
+end

data/lib/jekyll/data_path.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Jekyll
+  class Theme
+    def data_path
+      @data_path ||= path_for "_data"
+    end
+  end
+end

data/lib/jekyll/theme_drop.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Drops
+    class UnifiedPayloadDrop < Drop
+      # 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 ||= begin
+          config = site.send(:fallback_data)
+          config[config["theme"]]
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,57 +1,63 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-data
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 1.1.1
 platform: ruby
 authors:
 - Ashwin Maroli
-autorequire: 
-bindir: exe
+autorequire:
+bindir: bin
 cert_chain: []
-date: 2016-10-21 00:00:00.000000000 Z
+date: 2021-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: 1.14.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: 1.14.3
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: cucumber
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 5.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 5.1.0
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -66,7 +72,35 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
-description: 
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+description:
 email:
 - ashmaroli@gmail.com
 executables: []
@@ -76,18 +110,20 @@ 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/drops/themed_site_drop.rb
-- lib/jekyll/drops/unified_payload_drop.rb
-- lib/jekyll/readers/theme_data_reader.rb
-- lib/jekyll/theme.rb
-- lib/jekyll/theme_reader.rb
+- lib/jekyll/build_options.rb
+- lib/jekyll/data_path.rb
+- lib/jekyll/theme_drop.rb
 homepage: https://github.com/ashmaroli/jekyll-data
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -102,9 +138,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.7
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.7.6.2
+signing_key:
 specification_version: 4
-summary: A plugin to read data files in Jekyll Theme Gems
+summary: A plugin to read '_config.yml' and data files within Jekyll theme-gems
 test_files: []

data/lib/jekyll/drops/themed_site_drop.rb

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

data/lib/jekyll/drops/unified_payload_drop.rb

@@ -1,30 +0,0 @@
-# encoding: UTF-8
-
-module Jekyll
-  module Drops
-    class UnifiedPayloadDrop < Drop
-      mutable true
-
-      attr_accessor :page, :layout, :content, :paginator
-      attr_accessor :highlighter_prefix, :highlighter_suffix
-
-      def jekyll
-        JekyllDrop.global
-      end
-
-      def site
-        @site_drop ||= ThemedSiteDrop.new(@obj)
-      end
-
-      def theme
-        theme_name = site.theme.name
-        site.data[theme_name]
-      end
-
-      private
-      def fallback_data
-        @fallback_data ||= {}
-      end
-    end
-  end
-end

data/lib/jekyll/theme.rb

@@ -1,66 +0,0 @@
-module Jekyll
-  class Theme
-    extend Forwardable
-    attr_reader :name
-    def_delegator :gemspec, :version, :version
-
-    def initialize(name)
-      @name = name.downcase.strip
-      configure_sass
-    end
-
-    def root
-      # Must use File.realpath to resolve symlinks created by rbenv
-      # Otherwise, Jekyll.sanitized path with prepend the unresolved root
-      @root ||= File.realpath(gemspec.full_gem_path)
-    rescue Errno::ENOENT, Errno::EACCES, Errno::ELOOP
-      nil
-    end
-
-    def includes_path
-      path_for "_includes".freeze
-    end
-
-    def layouts_path
-      path_for "_layouts".freeze
-    end
-
-    def sass_path
-      path_for "_sass".freeze
-    end
-
-    def data_path
-      path_for "_data".freeze
-    end
-
-    def assets_path
-      path_for "assets".freeze
-    end
-
-    def configure_sass
-      return unless sass_path
-      require "sass"
-      Sass.load_paths << sass_path
-    end
-
-    private
-
-    def path_for(folder)
-      path = realpath_for(folder)
-      path if path && File.directory?(path)
-    end
-
-    def realpath_for(folder)
-      File.realpath(Jekyll.sanitized_path(root, folder.to_s))
-    rescue Errno::ENOENT, Errno::EACCES, Errno::ELOOP
-      nil
-    end
-
-    def gemspec
-      @gemspec ||= Gem::Specification.find_by_name(name)
-    rescue Gem::LoadError
-      raise Jekyll::Errors::MissingDependencyException,
-        "The #{name} theme could not be found."
-    end
-  end
-end

data/lib/jekyll/theme_reader.rb

@@ -1,158 +0,0 @@
-# encoding: UTF-8
-require "csv"
-
-module Jekyll
-  class ThemeReader < Reader
-    def initialize(site)
-      @site = site
-      @theme_data_files = Dir[File.join(@site.theme.root,
-        site.config["data_dir"], "**", "*.{yaml,yml,json,csv}")]
-    end
-
-    # Read Site data from disk and load it into internal data structures.
-    #
-    # Returns nothing.
-    def read
-      @site.layouts = LayoutReader.new(site).read
-      read_directories
-      sort_files!
-      @site.data = DataReader.new(site).read(site.config["data_dir"])
-      read_theme_data
-      CollectionReader.new(site).read
-      ThemeAssetsReader.new(site).read
-    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 site.theme && site.theme.data_path
-        #
-        # show contents of "<theme>/_data/" dir being read
-        debug_theme_reader
-        theme_data = ThemeDataReader.new(site).read(site.config["data_dir"])
-        @site.data = Utils.deep_merge_hashes(theme_data, @site.data)
-        #
-        # show site.data hash contents
-        debug_theme_data_reader
-      end
-    end
-
-    private
-
-    def debug_theme_reader
-      print_clear_line
-      print "Reading:", "Theme Data Files..."
-      @theme_data_files.each do |file|
-        print_value file
-      end
-      print_clear_line
-      print "Merging:", "Theme Data Hash..."
-    end
-
-    def debug_theme_data_reader
-      print "Inspecting:", "Site Data >>"
-      inspect_hash @site.data
-      print_clear_line
-    end
-
-    def inspect_hash(hash)
-      hash.each do |key, value|
-        print_key key
-        if key == @site.theme.name
-          inspect_theme_override value
-        end
-        if value.class == Hash
-          inspect_inner_hash value
-        elsif value.class == Array
-          print_label key
-          extract_hashes_and_print value
-        else
-          print_value "'#{value}'"
-        end
-      end
-    end
-
-    def inspect_theme_override(value)
-      if value == false
-        abort_with_msg "Cannot define or override Theme Configuration " \
-                       "with an empty file!"
-      end
-      unless value.class == Hash
-        abort_with_msg "Theme Config or its override should be a Hash of " \
-            "key:value pairs or mappings. But got #{value.class} instead."
-      end
-    end
-
-    def inspect_inner_hash(hash)
-      hash.each do |key, value|
-        if value.class == Array
-          print_label key
-          extract_hashes_and_print value
-          print_clear_line
-        elsif value.class == Hash
-          print_subkey_and_value key, value
-        else
-          print_hash key, value
-        end
-      end
-    end
-
-    def extract_hashes_and_print(array)
-      array.each do |entry|
-        if entry.class == String
-          print "-", entry
-        else
-          inspect_inner_hash entry
-        end
-      end
-    end
-
-    def print_hash(key, value)
-      print "#{key}:", value
-    end
-
-    def print_key(key)
-      @dashes = "------------------------"
-      print_value @dashes.to_s.cyan
-      print "Data Key:", key.to_s.cyan
-      print_value @dashes.to_s.cyan
-    end
-
-    def print_subkey_and_value(key, value)
-      print_label key
-      value.each do |subkey, val|
-        print_hash subkey, val
-      end
-      print_dashes
-    end
-
-    def print_value(value)
-      if value.class == Array
-        extract_hashes_and_print value
-      else
-        print "", value
-      end
-    end
-
-    def print_label(key)
-      print "#{key}:"
-    end
-
-    def print_dashes
-      print "", @dashes
-    end
-
-    def print_clear_line
-      print ""
-    end
-
-    def print(arg1, arg2 = "")
-      Jekyll.logger.debug arg1, arg2
-    end
-
-    def abort_with_msg(msg)
-      Jekyll.logger.abort_with "JekyllData:", msg
-    end
-  end
-end