jekyll-meta-files 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ea6a1301d0a3ecefa1a08eaa205ad9ed50889a3adb08e0f0d2574c6ccbf10a9a
+  data.tar.gz: bc2db9739a76ff80c56bd87048b5a4771d46ea919bec69be8dce72224186012b
+SHA512:
+  metadata.gz: 12d99553669c6b58fb20a49c5ccdef8bb1aede1c6abaffc74901f4c9d63fba02df4973a50d9c82055fef6d8fcd6805ff8024077d3f31d777955c687e5707c5f1
+  data.tar.gz: c3d3165ef6707b94e56042b4e013f55cf1b77d3b7c398a956ed42f075be3713d3dcc3a1f4e96a2ddbcf8881d33a5afc32829465dc9c6088f45ac8014c1aab679

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in jekyll-meta-files.gemspec
+gemspec
+
+gem "rake", "~> 13.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Pascal Reinhardt
+
+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,41 @@
+# jekyll-meta-files
+
+This plugin augments static files with YAML data / front matter in optional metafiles.
+
+DISCLAIMER: The plugin is very simple and relatively specific as it was created for a certain project. It's also not under active development but if you have feedback or even a pull request I am happy to incorprate it.
+
+The basic plugin code is based on the comment [here](https://github.com/jekyll/jekyll/issues/1082#issuecomment-177167222)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jekyll-meta-files'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install jekyll-meta-files
+
+## Usage
+
+The plugin will automatically augment all static files with additional YAML front matter from an assiciated metafile. The plugin looks for metafiles with the added extensions `\*.meta.yml` in `[documents_url]meta/`. The `documents_url` (with trailing /) should be specified in `config.yml`.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/irruputuncu/jekyll-meta-files.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "jekyll/meta/files"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/jekyll-meta-files.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative "lib/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "jekyll-meta-files"
+  spec.version       = JekyllMetaFiles::VERSION
+  spec.authors       = ["Pascal Reinhardt"]
+  spec.email         = ["pasrein@gmail.com"]
+
+  spec.summary       = "Jekyll plugin to augment static files with metadata"
+  spec.homepage      = "https://github.com/irruputuncu/jekyll-meta-files"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/irruputuncu/jekyll-meta-files"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Dependencies
+  spec.add_runtime_dependency 'jekyll', '~> 4.0'
+
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/jekyll-meta-files.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module JekyllMetaFiles
+  class Generator < Jekyll::Generator
+    def generate(site)
+
+      document_path = site.config['documents_url']
+
+      site.static_files.each do |doc|
+        meta_file = doc.path.gsub(/#{document_path}\w+\//, "#{document_path}meta/") + '.meta.yml'
+        if File.exist?(meta_file)
+            meta_data = SafeYAML.load_file(meta_file)
+            meta_data.each { |key, value| doc.data[key] = value}
+         end
+      end
+
+    end
+  end
+end

data/lib/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module JekyllMetaFiles
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-meta-files
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Pascal Reinhardt
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-03-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description:
+email:
+- pasrein@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- jekyll-meta-files.gemspec
+- lib/jekyll-meta-files.rb
+- lib/version.rb
+homepage: https://github.com/irruputuncu/jekyll-meta-files
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/irruputuncu/jekyll-meta-files
+  source_code_uri: https://github.com/irruputuncu/jekyll-meta-files
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.15
+signing_key:
+specification_version: 4
+summary: Jekyll plugin to augment static files with metadata
+test_files: []