jekyll-data 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7c383a01aa3bb9fe5690b81d7cd54125be7ac8b3
-  data.tar.gz: 0f98f59af2bee263e7af7e10304e23318b632cd0
+  metadata.gz: 6fe7b8c111ab83b204be84b5f21de872ffd037ab
+  data.tar.gz: 5e954926b328bf2f1ba45dd0e48e154162786e1d
 SHA512:
-  metadata.gz: 3bc5a33b09beb3c7cb19c474c723928eb0e8f79f93beac5568f0714440a196ae5e8bfbba58bd54e550082688576c3d696b6cbdd8b3112078006aff8081a8cbc4
-  data.tar.gz: 72e1317d7b637897ac35a0ccecc711772145bc45baf1b6a016b5e4a879d32136816e5f6bac9f0d9e6395e24f0950d8d72b1aa8fb677da4adc1f454c26183a51e
+  metadata.gz: c0a9382fb9a07bd5fb47278432fdc4e5bfe270a97b12d4af2b1e4191db93267c7766d1c82ad7bdf88270aea28e84ba6e0301416a74347c0fdca44fe8064815cc
+  data.tar.gz: 105d0a80ceb935055a7e15c7d282615e9eaa8dbc03c1fe186e1b0516bea82d29e896a3235f1a74e44ce67abc54654d7008bfade78bedab806e6cad8a8b048e28

data/README.md

@@ -1,6 +1,9 @@
 # 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.
 

data/lib/jekyll-data/version.rb

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

data/lib/jekyll/theme_reader.rb

@@ -28,43 +28,68 @@ module Jekyll
     def read_theme_data
       if site.theme && site.theme.data_path
         #
-        # show contents of "<theme>/_data/" dir being read
-        debug_theme_reader
+        # show contents of "<theme>/_data/" dir being read while degugging.
+        # Additionally validate if a data file with the same name as the
+        # theme (= theme config or theme config-override) is a Hash.
+        inspect_theme_data
         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
+        # check if the merged hash is suitable for generating the site.
+        # Also show contents of merged site.data hash while debugging.
+        inspect_merged_hash
       end
     end
 
     private
 
-    def debug_theme_reader
+    # Private:
+    # Print messages only while debugging.
+    #
+    # 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
       print "Reading:", "Theme Data Files..."
       @theme_data_files.each do |file|
-        print_value file
+        if File.basename(file, ".*") == @site.theme.name
+          inspect_theme_config file
+          print_value file.green
+        else
+          print_value file
+        end
       end
       print_clear_line
       print "Merging:", "Theme Data Hash..."
     end
 
-    def debug_theme_data_reader
+    # Private:
+    # Print contents of the merged data hash while debugging
+    def inspect_merged_hash
       print "Inspecting:", "Site Data >>"
       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) and if matches theme name, validate its
+    #   value as well.
+    # - Individually analyse the hash[key] values and extract contents
+    #   to output.
     def inspect_hash(hash)
       hash.each do |key, value|
         print_key key
         if key == @site.theme.name
-          inspect_theme_override value
+          validate_config_hash value
         end
-        if value.class == Hash
+
+        if value.is_a? Hash
           inspect_inner_hash value
-        elsif value.class == Array
+        elsif value.is_a? Array
           print_label key
           extract_hashes_and_print value
         else
@@ -73,24 +98,14 @@ module Jekyll
       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
-
+    # Analyse deeper hashes and extract contents to output
     def inspect_inner_hash(hash)
       hash.each do |key, value|
-        if value.class == Array
+        if value.is_a? Array
           print_label key
           extract_hashes_and_print value
           print_clear_line
-        elsif value.class == Hash
+        elsif value.is_a? Hash
           print_subkey_and_value key, value
         else
           print_hash key, value
@@ -98,9 +113,11 @@ module Jekyll
       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.class == String
+        if entry.is_a? String
           print "-", entry
         else
           inspect_inner_hash entry
@@ -108,10 +125,32 @@ module Jekyll
       end
     end
 
+    # analyse the theme config file and validate it as Hash
+    def inspect_theme_config(path)
+      config = ThemeDataReader.new(site).read_data_file(path)
+      validate_config_hash config
+    end
+
+    def validate_config_hash(value)
+      if value == false
+        abort_with_msg "Cannot define or override Theme Configuration " \
+                       "with an empty file!"
+      end
+      unless value.is_a? 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
+
+    # Private methods for formatting log messages while debugging and a
+    # method to issue conflict alert and abort site.process
+
+    # Prints key as logger[topic] and value as [message]
     def print_hash(key, value)
       print "#{key}:", value
     end
 
+    # Prints the site.data[key] in color
     def print_key(key)
       @dashes = "------------------------"
       print_value @dashes.to_s.cyan
@@ -119,6 +158,7 @@ module Jekyll
       print_value @dashes.to_s.cyan
     end
 
+    # Prints label, keys and values of mappings
     def print_subkey_and_value(key, value)
       print_label key
       value.each do |subkey, val|
@@ -127,14 +167,16 @@ module Jekyll
       print_dashes
     end
 
+    # Print only logger[message], [topic] = nil
     def print_value(value)
-      if value.class == Array
+      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 "#{key}:"
     end
@@ -147,6 +189,7 @@ module Jekyll
       print ""
     end
 
+    # Redefine Jekyll Loggers
     def print(arg1, arg2 = "")
       Jekyll.logger.debug arg1, arg2
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-data
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Ashwin Maroli
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-21 00:00:00.000000000 Z
+date: 2016-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -103,7 +103,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.7
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: A plugin to read data files in Jekyll Theme Gems