jekyll-data 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ef504f55a2b8067637d9c39a015d1931bc46cf49
+  data.tar.gz: cc1515e3a63bfc0722308ffb08fa9594f2435279
+SHA512:
+  metadata.gz: 0eb3122d58976537b4e4a50ce4b51e96b413a148d95d0e3dfa2f5cf210a0f155affe92d44d312615522fbe432e823211de28f69dff740dff1f2a8dea444b98bf
+  data.tar.gz: '05840a5d7b27acb2fffb63b93cf8067a3855e8d947f01c2f7b034e03f3fa3eb5d3d63edd5df97627f2dc4399db31cf312389ba9ca060ee2c9fc21b88d4a37883'

data/LICENSE.txt

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

@@ -0,0 +1,124 @@
+# JekyllData
+
+[![Gem Version](https://img.shields.io/gem/v/jekyll-data.svg)](https://rubygems.org/gems/jekyll-data)
+
+Introducing a plugin that reads data files within **jekyll theme gems** and adds it 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..
+```ruby
+# Gemfile
+
+group :jekyll_plugins do
+  gem "jekyll-data"
+end
+``` 
+```yaml
+# _config.yml
+
+gems:
+  - jekyll-data
+
+```
+..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.
+
+### 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.
+
+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 }}`)
+
+### 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.
+```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
+```
+
+### User-overrides
+
+To override directives shipped with a theme gem, simply have an identical hash at the site-source.  
+e.g.
+```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/
+```
+
+## 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

@@ -0,0 +1,16 @@
+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"
+
+# Monkey-patches
+require_relative "jekyll/theme"
+require_relative "jekyll/drops/unified_payload_drop"
+
+# replace Jekyll::Reader with a subclass Jekyll::ThemeReader
+Jekyll::Hooks.register :site, :after_init do |site|
+  site.reader = Jekyll::ThemeReader.new(site)
+end

data/lib/jekyll-data/version.rb

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

data/lib/jekyll/drops/themed_site_drop.rb

@@ -0,0 +1,17 @@
+# 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

@@ -0,0 +1,30 @@
+# 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/readers/theme_data_reader.rb

@@ -0,0 +1,37 @@
+module Jekyll
+  class ThemeDataReader < DataReader
+    attr_reader :site, :content
+    def initialize(site)
+      @site = site
+      @content = {}
+      @entry_filter = 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/theme.rb

@@ -0,0 +1,66 @@
+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

@@ -0,0 +1,137 @@
+# 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_clear_line
+      print "Site Data:"
+      process_hash @site.data
+      print_clear_line
+    end
+
+    def process_hash(hash)
+      hash.each do |key, value|
+        print_key key
+        if value.class == Hash
+          process_inner_hash value
+        else
+          print_value "'#{value}'"
+        end
+      end
+    end
+
+    def process_inner_hash(hash)
+      hash.each do |key, value|
+        if value.class == Array
+          print_label key
+          extract_hashes_and_print value
+          print_dashes
+        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 |h|
+        process_inner_hash h
+      end
+    end
+
+    def print_hash(key, value)
+      key = key.to_s + ":"
+      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
+      print_dashes
+      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.to_s}:"
+    end
+
+    def print_dashes
+      print "", @dashes
+    end
+
+    def print_clear_line
+      print ""
+    end
+
+    def print(arg1, arg2 = "")
+      Jekyll.logger.debug arg1, arg2
+    end
+  end
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-data
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Ashwin Maroli
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-10-18 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 
+email:
+- ashmaroli@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/jekyll-data.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
+homepage: https://github.com/ashmaroli/jekyll-data
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.7
+signing_key: 
+specification_version: 4
+summary: A plugin to read data files in Jekyll Theme Gems
+test_files: []