jekyll-data 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6fe7b8c111ab83b204be84b5f21de872ffd037ab
-  data.tar.gz: 5e954926b328bf2f1ba45dd0e48e154162786e1d
+  metadata.gz: fd5090a5a9fecc23edb990f2af43701cdf018fc2
+  data.tar.gz: 5d9c0af30ca3738e65114eb9ac29514b8c7c2fc9
 SHA512:
-  metadata.gz: c0a9382fb9a07bd5fb47278432fdc4e5bfe270a97b12d4af2b1e4191db93267c7766d1c82ad7bdf88270aea28e84ba6e0301416a74347c0fdca44fe8064815cc
-  data.tar.gz: 105d0a80ceb935055a7e15c7d282615e9eaa8dbc03c1fe186e1b0516bea82d29e896a3235f1a74e44ce67abc54654d7008bfade78bedab806e6cad8a8b048e28
+  metadata.gz: 89371b0891b485f65b138a30b13af973b4397a058eeaf3130eaaf7a75ac4db733864d79bcf12a1637813be2b4872fe6d74395956225f9a2d7e72bd7d80f931e9
+  data.tar.gz: 43d1d7e23a4ed9d40d6154f5100bf192865104259ebb52dc33ecd64c46151e83ad974df6837d5fce6066b72dfd252fd7efe2d7b8e2497e9507d37e084731859f

data/README.md

@@ -5,7 +5,7 @@
 
 [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.
+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 read as well.
 
 ## Installation
 
@@ -16,7 +16,7 @@ Simply add the plugin to your site's Gemfile and config file like every other je
 group :jekyll_plugins do
   gem "jekyll-data"
 end
-``` 
+```
 ```yaml
 # _config.yml
 
@@ -31,19 +31,32 @@ 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.
+**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 both 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.
+
+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 site's config hash without this plugin, will override the conflicting config hash generated by this plugin from reading the included `_config.yml`
 
 ### 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 couple of solutions to that hurdle:  
+
+  - settings via `_config.yml`  
+  ----------------------------  
+  This plugin reads the config file (at present only `_config.yml`) and uses the data to modify the site's config hash. This allows the gem to continue using `{{ site.myvariable }}` within its templates.
+  - settings via `_data/[theme-name].*`  
+  --------------------------------------  
+  An alternate route is to have theme-specific settings defined as a hash, in a valid data file named the same as the theme-gem.
+  The defined settings will be accessible via `{{ theme.myvariable }}`.  
+  e.g. if *minima* were to ship a YAML file with *minima*-specific settings (say, `post_excerpt: enabled`), then the gem would've a **_data/minima.yml** and this particular setting can be accessed in its templates via `{{ theme.post_excerpt }}` which is functionally equivalent to `{{ site.data.minima.post_excerpt }}`  
+  *Note: The `{{ theme.variable }}` is only available if the data-file is named the same as the theme-gem.*
 
 ### Regular Data-files
 
-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.
+Regular data files that may be used to supplement theme templates (e.g. locales and translated UI text) 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
 
@@ -124,4 +137,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

@@ -10,7 +10,22 @@ require_relative "jekyll/drops/themed_site_drop"
 require_relative "jekyll/theme"
 require_relative "jekyll/drops/unified_payload_drop"
 
-# replace Jekyll::Reader with a subclass Jekyll::ThemeReader
+# replace Jekyll::Reader with a subclass Jekyll::ThemeReader only if the site
+# uses a gem-based theme else have this plugin disabled.
+#
+# Additionally, append to site's config hash with optional config hash from the
+# theme gem by filling in keys not already defined.
 Jekyll::Hooks.register :site, :after_init do |site|
-  site.reader = Jekyll::ThemeReader.new(site)
+  if site.theme
+    site.config = Jekyll::Utils.deep_merge_hashes(
+      Jekyll::ThemeReader.new(site).read_theme_config, site.config
+    )
+    site.reader = Jekyll::ThemeReader.new(site)
+  else
+    Jekyll.logger.abort_with(
+      "JekyllData:",
+      "Error! This plugin only works with gem-based jekyll-themes. " \
+      "Please disable this plugin to proceed."
+    )
+  end
 end

data/lib/jekyll-data/version.rb

@@ -1,3 +1,3 @@
 module JekyllData
-  VERSION = "0.3.0".freeze
+  VERSION = "0.4.0".freeze
 end

data/lib/jekyll/theme_reader.rb

@@ -9,24 +9,19 @@ module Jekyll
         site.config["data_dir"], "**", "*.{yaml,yml,json,csv}")]
     end
 
-    # Read Site data from disk and load it into internal data structures.
+    # Read data files within theme-gem.
     #
     # Returns nothing.
     def read
-      @site.layouts = LayoutReader.new(site).read
-      read_directories
-      sort_files!
-      @site.data = DataReader.new(site).read(site.config["data_dir"])
+      super
       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
+      if site.theme.data_path
         #
         # show contents of "<theme>/_data/" dir being read while degugging.
         # Additionally validate if a data file with the same name as the
@@ -41,12 +36,25 @@ module Jekyll
       end
     end
 
+    # Read the '_config.yml' file if present within the theme gem and
+    # return a data hash otherwise return a hash of Jekyll Defaults.
+    #
+    # Returns a hash
+    def read_theme_config
+      config = @site.in_theme_dir("_config.yml")
+      if File.exist?(config)
+        Configuration.new.read_config_file(config)
+      else
+        Configuration::DEFAULTS
+      end
+    end
+
     private
 
     # Private:
     # Print messages only while debugging.
     #
-    # Inspect the theme configuration file (data-file with the same name
+    # Inspect the theme configuration file (data file with the same name
     # as the theme) and print a success message, if valid.
     def inspect_theme_data
       print_clear_line

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-data
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Ashwin Maroli
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-21 00:00:00.000000000 Z
+date: 2016-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -106,5 +106,5 @@ rubyforge_project:
 rubygems_version: 2.6.8
 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 in Jekyll Theme Gems
 test_files: []