jekyll-data 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b58db9039555a41b84b5c3d663b9bc689267f10a
-  data.tar.gz: 24db34fd2650c035b8a07a11ecf30cd47b152675
+SHA256:
+  metadata.gz: 95e3f9216da63cda9e38c9affb6abd7670f39a29918adc7c7e11ee8f2be2053f
+  data.tar.gz: 60732d8194aa06c2bf12ce37d05beeb097e49a537409c4324cd0bb2aeb945398
 SHA512:
-  metadata.gz: 7eaf71e652e9ed84805277cc8135c428f90c2239c3dd9563a4504b42db949ef2e8520cb637b26715380b8118203e39088d16b4690398cbb8437e64fac784d1d1
-  data.tar.gz: cf41dc8dfc5ae0e63176d862c59b6316232a224ce29fe29c7e14094ac0eb5f9fd4137ac98168cdcabb1ca793ae4b4bc1d68667af45b8f9aff7792ee3c6f0901b
+  metadata.gz: cc79ac198e020303b2a880f32baa681f61d838ccb241f359e1524eb9e5cd0e0ee0a0d5143359e063a87f9fb19b7d8c47fd1485c8ae9360570927f1aaebc9c672
+  data.tar.gz: 4011a6f4bf630320827a6545ccd472d9c593af8bf10ecdf856a8f3d07edab07dd6edc10aff7f00630a6307b77a91931b836caa5ad751397aadc2699d5daaed44

data/README.md

@@ -29,8 +29,6 @@ end
 
 ## 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:

data/lib/jekyll-data.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "jekyll"
 require "jekyll-data/version"
 
@@ -14,22 +16,19 @@ 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.
+# 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.*
 # ----------------------------------------------------------------------------
-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."
-    )
+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
 
@@ -39,11 +38,15 @@ end
 #
 # 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|
   if site.theme
-    file = site.in_theme_dir("_config.yml")
-    Jekyll.logger.info "Theme Config file:", file if File.exist?(file)
+    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

@@ -1,4 +1,5 @@
-# encoding: UTF-8
+# frozen_string_literal: true
+
 require "csv"
 
 module JekyllData
@@ -6,8 +7,7 @@ module JekyllData
     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}")]
+      @theme_data_files = Dir[File.join(site.theme.data_path, "**", "*.{yaml,yml,json,csv,tsv}")]
     end
 
     # Read data files within theme-gem.

data/lib/jekyll-data/theme_configuration.rb

@@ -1,4 +1,4 @@
-# encoding: UTF-8
+# frozen_string_literal: true
 
 module JekyllData
   class ThemeConfiguration < Jekyll::Configuration

data/lib/jekyll-data/theme_data_reader.rb

@@ -1,6 +1,9 @@
+# frozen_string_literal: true
+
 module JekyllData
   class ThemeDataReader < Jekyll::DataReader
     attr_reader :site, :content
+
     def initialize(site)
       @site = site
       @content = {}
@@ -9,6 +12,7 @@ module JekyllData
 
     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 JekyllData
       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

@@ -1,4 +1,4 @@
-# encoding: UTF-8
+# frozen_string_literal: true
 
 module JekyllData
   class ThemedSiteDrop < Jekyll::Drops::SiteDrop
@@ -9,7 +9,6 @@ module JekyllData
     def_delegator  :@obj, :site_data, :data
     def_delegators :@obj, :theme
 
-    private
-    def_delegator :@obj, :config, :fallback_data
+    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 = "1.0.0".freeze
+  VERSION = "1.1.0"
 end

data/lib/jekyll/build_options.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Jekyll
   class Command
     class << self
@@ -7,10 +9,10 @@ module Jekyll
       #
       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."
+      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

data/lib/jekyll/data_path.rb

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

data/lib/jekyll/theme_drop.rb

@@ -1,19 +1,18 @@
-# encoding: UTF-8
+# frozen_string_literal: true
 
 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]
+        @theme_drop ||= begin
+          config = site.send(:fallback_data)
+          config[config["theme"]]
+        end
       end
     end
   end

metadata

@@ -1,36 +1,39 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-data
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Ashwin Maroli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-15 00:00:00.000000000 Z
+date: 2019-09-09 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.14'
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.14.3
@@ -38,9 +41,6 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.14'
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.14.3
@@ -87,19 +87,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rubocop-jekyll
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.47.1
+        version: 0.10.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.47.1
+        version: 0.10.0
 description: 
 email:
 - ashmaroli@gmail.com
@@ -138,8 +138,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: A plugin to read '_config.yml' and data files within Jekyll theme-gems