jekyll-overrides 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6fcc9d0b48d888c7e318fdabf6f2c2db14e582e9
+  data.tar.gz: 3cd897d47c1636dd1cca2ff695908608f1ef9401
+SHA512:
+  metadata.gz: c64a80deed914eed3f294c258ce2370a01849cba9e3c0e3e246d59a40a4c154142cc6f7fb453ebf9fadfd1358d8ed95607810d2c2bf0a8eaa5962d3204ad2332
+  data.tar.gz: 5d0e40d47a8820356682df332573c20157b94e5edd89792f781f394dc992e775e158a2f140afb2e3c7067de6f5e3234a6400ebbb662620ec1bf9ba63220fe16d

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {"https://github.com/researchsquare/jekyll-overrides"}
+
+# Specify your gem's dependencies in jekyll-translations.gemspec
+gemspec

data/README.md

@@ -0,0 +1,23 @@
+# Jekyll::Overrides
+
+This is a Jekyll plugin to manage overrides from a variety of sources, including AWS S3 and PO Editor.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jekyll-overrides'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jekyll-overrides
+
+## Usage
+
+If added correctly to the Gemfile, this plugin should work as a seamless replacement to local versions of the plugin that we have been using on our frontend Jekyll sites.

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "jekyll/overrides"
+
+# 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-overrides.gemspec

@@ -0,0 +1,11 @@
+Gem::Specification.new do |spec|
+    spec.name          = "jekyll-overrides"
+    spec.version       = "0.1.0"
+    spec.authors       = ["Jordan Dalton"]
+    spec.email         = ["jordan.dalton@researchsquare.com"]
+    spec.require_paths = ["lib"]
+    spec.summary       = %q{Overrides tool for Jekyll}
+    spec.homepage      = "https://github.com/researchsquare/jekyll-overrides"
+    spec.license       = "MIT"
+    spec.files         = `git ls-files -z`.split("\x0")
+end

data/lib/jekyll-overrides.rb

@@ -0,0 +1 @@
+require 'jekyll/overrides'

data/lib/jekyll/overrides.rb

@@ -0,0 +1,52 @@
+module Overrides
+    class OverridePage < Jekyll::Page
+        def initialize(site, base, dir, name)
+            @override_path = File.join(Dir.pwd, base, name)
+            super(site, base, dir, name)
+        end
+
+        def read_yaml(base, name, opts = {})
+            path = @path
+            # We temporarily replace the path here where super.read_yaml doesn't fail
+            @path = @override_path
+            super
+            @path = path
+        end
+    end
+
+    class Generator < Jekyll::Generator
+        def generate(site)
+            return if not override_directory = site.config['overrides']
+
+            # Let's gather pages that exist in our override directory, in case
+            # they aren't originally defined in our source directory`
+            Dir["#{override_directory}/**/*.{md,html}"].each do |path|
+                site.pages << OverridePage.new(
+                    site,
+                    override_directory.gsub(/\/$/, '') + '/',
+                    '',
+                    '/' + path.gsub(override_directory, '').gsub(/^\//, '')
+                )
+            end
+
+            site.pages.map { | page | configure_page(page, override_directory, site) }
+        end
+
+        def configure_page(page, override_directory, site)
+            override_file = File.join(override_directory, page.path)
+            if File.exists?(override_file)
+                override_content = File.read(override_file)
+
+                # Lets merge the old page data with any overrides
+                matches = Jekyll::Document::YAML_FRONT_MATTER_REGEXP.match(override_content)
+                if matches[0]
+                    page.data = page.data.merge(SafeYAML.load(matches[0]))
+                end
+
+                page.content = override_content.gsub(matches[0], '')
+            end
+
+            return page
+        end
+    end
+end

metadata

@@ -0,0 +1,52 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-overrides
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jordan Dalton
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-03-04 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- jordan.dalton@researchsquare.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- bin/console
+- bin/setup
+- jekyll-overrides.gemspec
+- lib/jekyll-overrides.rb
+- lib/jekyll/overrides.rb
+homepage: https://github.com/researchsquare/jekyll-overrides
+licenses:
+- MIT
+metadata: {}
+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.5.2.3
+signing_key: 
+specification_version: 4
+summary: Overrides tool for Jekyll
+test_files: []