jekyll-cloudcannon-schedule 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6d8d800c1a586c057aca826bd0510aaabeb737b5f23037b1fd5c126c0a626f17
+  data.tar.gz: 7c671f080557ceaca914f91a893d5ca71eb69179aae81c75ea6e9b82fdeba47a
+SHA512:
+  metadata.gz: 6ab145cb25bab86d16ee82ff0a9405a0377e8dc48f11da04989a243ec6a69cf22d715965e57840876870b7903df840753f915ab1df031b2dc4002973147e001b
+  data.tar.gz: 65445530f326763d44f99b11c1a97bda560f316135efceee06d5a4d72bcdadea66e1f366fe516bc66a4d32f712200ea032423177cae00cf1a6f490e9d55a4444

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+Gemfile.lock
+spec/dest
+.bundle

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.rubocop.yml

@@ -0,0 +1,11 @@
+inherit_gem:
+  jekyll: .rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 2.1
+  Include:
+    - lib/*.rb
+
+  Exclude:
+    - script/**/*
+    - spec/**/*

data/.ruby-version

@@ -0,0 +1 @@
+2.5.0

data/.travis.yml

@@ -0,0 +1,38 @@
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+- 2.2
+- 2.3
+- 2.4
+- 2.5
+matrix:
+  include:
+  # GitHub Pages
+  - rvm: 2.4.0
+    env:
+    - JEKYLL_VERSION=3.6.2
+    - GITHUB_PAGES=1 # Only set on one build in matrix
+env:
+  matrix:
+  - JEKYLL_VERSION=3.6
+branches:
+  only:
+  - master
+  - /^v\d+\.\d+\.\d+/
+git:
+  depth: 1000
+before_install:
+- gem update --system
+install:
+- travis_retry script/bootstrap
+script: script/cibuild
+deploy:
+  provider: rubygems
+  api_key:
+    secure: O8fGRnM6OJCqC2BlVE1BqYfq5aR19ulpiHhQwRiHbtSCh8H4rYt7FLsuOwSTtRQjhWYRRSpdRt2ilfQ6PY6Jx1UkxZq5zo9QAPQ9tKxiFTm7gBpZAiAgb06eyaMBSzyQ8qe2qccaFI6CiZhsiaGMsdKsWuYpuoPmdLPd7aDyYJs=
+  gem: jekyll-cloudcannon-schedule
+  on:
+    tags: true
+    repo: CloudCannon/jekyll-cloudcannon-schedule
+    condition: "$GITHUB_PAGES == 1"

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+gemspec
+
+if ENV["JEKYLL_VERSION"]
+  gem "jekyll", "~> #{ENV["JEKYLL_VERSION"]}"
+end

data/History.markdown

@@ -0,0 +1,3 @@
+## 0.1.0 / 2018-02-05
+
+  * Birthday!

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014-present, GitHub, inc. and the jekyll-cloudcannon-schedule contributors
+
+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,40 @@
+# Jekyll Schedule Generator Plugin
+
+*Jekyll plugin to generate _schedule.txt for all future posts in your Jekyll site.*
+
+[![Build Status](https://travis-ci.org/CloudCannon/jekyll-cloudcannon-schedule.svg?branch=master)](https://travis-ci.org/CloudCannon/jekyll-cloudcannon-schedule)
+[![Gem Version](https://badge.fury.io/rb/jekyll-cloudcannon-schedule.svg)](https://badge.fury.io/rb/jekyll-cloudcannon-schedule)
+
+## Usage
+
+1. Add `gem 'jekyll-cloudcannon-schedule'` to your site's Gemfile and run `bundle`
+2. Add the following to your site's `_config.yml`:
+
+```yml
+url: "http://example.com" # the base hostname & protocol for your site
+plugins:
+  - jekyll-cloudcannon-schedule
+```
+
+💡 If you are using a Jekyll version less than 3.5.0, use the `gems` key instead of `plugins`.
+
+## Override default development settings
+
+[Follow these instructions on Jekyll's documentation](https://jekyllrb.com/docs/usage/#override-default-development-settings).
+
+## Developing locally
+
+* Use `script/bootstrap` to bootstrap your local development environment.
+* Use `script/console` to load a local IRB console with the Gem.
+
+## Testing
+
+1. `script/bootstrap`
+2. `script/cibuild`
+
+## Contributing
+
+1. Fork the project
+2. Create a descriptively named feature branch
+3. Add your feature
+4. Submit a pull request

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/jekyll-cloudcannon-schedule.gemspec

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "jekyll-cloudcannon-schedule/version"
+
+Gem::Specification.new do |spec|
+  spec.name        = "jekyll-cloudcannon-schedule"
+  spec.summary     = "Automatically generates _schedule.txt for builds on CloudCannon."
+  spec.version     = Jekyll::CloudCannonSchedule::VERSION
+  spec.authors     = ["CloudCannon Inc."]
+  spec.email       = "support@cloudcannon.com"
+  spec.homepage    = "https://github.com/CloudCannon/jekyll-cloudcannon-schedule"
+  spec.licenses    = ["MIT"]
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r!^bin/!) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r!^(test|spec|features)/!)
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "jekyll", "~> 3.3"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop", "0.51"
+end

data/lib/_schedule.txt

@@ -0,0 +1,2 @@
+{% for post in page.future_posts %}{{ post.date | date_to_xmlschema }},Build '{{ post.title }}',{{ post.path }}
+{% endfor %}

data/lib/jekyll-cloudcannon-schedule.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "jekyll/page_without_a_file"
+require "jekyll/jekyll-cloudcannon-schedule"

data/lib/jekyll-cloudcannon-schedule/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module CloudCannonSchedule
+    VERSION = "0.1.2".freeze
+  end
+end

data/lib/jekyll/jekyll-cloudcannon-schedule.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require "fileutils"
+
+module Jekyll
+  class FuturePostReader < Jekyll::PostReader
+    def read_publishable(dir, magic_dir, matcher)
+      future_posts = []
+      read_content(dir, magic_dir, matcher).tap { |docs| docs.each(&:read) }
+        .each do |doc|
+          next unless doc.content.valid_encoding?
+          site.publisher.publish?(doc).tap do |will_publish|
+            if !will_publish && site.publisher.hidden_in_the_future?(doc)
+              future_posts << doc
+            end
+          end
+        end
+
+      future_posts
+    end
+  end
+
+  class JekyllCloudCannonSchedule < Jekyll::Generator
+    safe true
+    priority :lowest
+
+    # Main plugin action, called by Jekyll-core
+    def generate(site)
+      @site = site
+      @site.pages << schedule unless file_exists?("_schedule.txt")
+    end
+
+    private
+
+    def source_path(file = "_schedule.txt")
+      File.expand_path "../#{file}", __dir__
+    end
+
+    def future_posts
+      FuturePostReader.new(@site).read_posts("")
+    end
+
+    def schedule
+      schedule = PageWithoutAFile.new(@site, __dir__, "", "_schedule.txt")
+      schedule.content = File.read(source_path)
+      schedule.data["layout"] = nil
+      schedule.data["future_posts"] = future_posts.map(&:to_liquid)
+      schedule
+    end
+
+    # Checks if a file already exists in the site source
+    def file_exists?(file_path)
+      if @site.respond_to?(:in_source_dir)
+        File.exist? @site.in_source_dir(file_path)
+      else
+        File.exist? Jekyll.sanitized_path(@site.source, file_path)
+      end
+    end
+  end
+end

data/lib/jekyll/page_without_a_file.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Jekyll
+  class PageWithoutAFile < Page
+    def read_yaml(*)
+      @data ||= {}
+    end
+  end
+end

data/script/bootstrap

@@ -0,0 +1,4 @@
+#!/bin/sh
+set -ex
+
+bundle install

data/script/cibuild

@@ -0,0 +1,5 @@
+#!/bin/sh
+set -e
+
+time script/fmt
+time script/test

data/script/console

@@ -0,0 +1,34 @@
+#! /usr/bin/env ruby
+
+def relative_to_root(path)
+  File.expand_path(path, File.dirname(__dir__))
+end
+
+require "jekyll"
+require relative_to_root("lib/jekyll-sitemap.rb")
+require "pry-debugger"
+
+SOURCE_DIR = relative_to_root("spec/fixtures")
+DEST_DIR   = relative_to_root("spec/dest")
+
+def source_dir(*files)
+  File.join(SOURCE_DIR, *files)
+end
+
+def dest_dir(*files)
+  File.join(DEST_DIR, *files)
+end
+
+def config(overrides = {})
+  Jekyll.configuration({
+    "source"      => source_dir,
+    "destination" => dest_dir,
+    "url"         => "http://example.org",
+  }).merge(overrides)
+end
+
+def site(configuration = config)
+  Jekyll::Site.new(configuration)
+end
+
+binding.pry

data/script/fmt

@@ -0,0 +1,10 @@
+#!/bin/bash
+set -e
+
+echo "Rubocop $(bundle exec rubocop --version)"
+bundle exec rubocop -D -E $@
+success=$?
+if ((success != 0)); then
+   echo -e "\nTry running \`script/fmt -a\` to automatically fix errors"
+fi
+exit $success

data/script/release

@@ -0,0 +1,7 @@
+#!/bin/sh
+# Tag and push a release.
+
+set -e
+
+script/cibuild
+bundle exec rake release

data/script/test

@@ -0,0 +1,4 @@
+#!/bin/bash
+set -ex
+
+bundle exec rspec "$@"

data/spec/fixtures/_config.yml

@@ -0,0 +1,9 @@
+timezone: UTC
+
+defaults:
+  -
+    scope:
+      path: ""
+      type: page
+    values:
+      layout: some_default

data/spec/fixtures/_data/authors.yml

@@ -0,0 +1,5 @@
+garthdb:
+  name: Garth
+  twitter: garthdb
+  uri: "http://garthdb.com"
+  email: example@mail.com

data/spec/fixtures/_drafts/2015-01-12-a-draft.md

@@ -0,0 +1,4 @@
+---
+---
+
+This is a draft.

data/spec/fixtures/_layouts/some_default.html

@@ -0,0 +1,11 @@
+---
+---
+<html>
+  <head>
+    {% feed_meta %}
+  </head>
+  <body>
+THIS IS MY LAYOUT
+{{ content }}
+  </body>
+</html>

data/spec/fixtures/_posts/2015-08-08-stuck-in-the-middle.html

@@ -0,0 +1,2 @@
+---
+---

data/spec/fixtures/_posts/3005-10-22-because-of-the-internet.md

@@ -0,0 +1,6 @@
+---
+excerpt: ""
+author: childish
+---
+
+# No matter what you say or what you do

data/spec/jekyll-cloudcanon-schedule_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+describe(Jekyll::JekyllCloudCannonSchedule) do
+  let(:overrides) { Hash.new }
+  let(:config) do
+    Jekyll.configuration(Jekyll::Utils.deep_merge_hashes({
+      "full_rebuild" => true,
+      "source"      => source_dir,
+      "destination" => dest_dir,
+      "show_drafts" => true,
+      "url"         => "http://example.org",
+      "name"       => "My awesome site",
+      "author"      => {
+        "name"        => "Dr. Jekyll"
+      },
+      "collections" => {
+        "my_collection" => { "output" => true },
+        "other_things"  => { "output" => false }
+      }
+    }, overrides))
+  end
+  let(:site)     { Jekyll::Site.new(config) }
+  let(:contents) { File.read(dest_dir("_schedule.txt")) }
+  let(:context)  { make_context(site: site) }
+  before(:each) do
+    site.process
+  end
+
+  it "has no layout" do
+    expect(contents).not_to match(/\ATHIS IS MY LAYOUT/)
+  end
+
+  it "creates a _schedule.txt file" do
+    expect(Pathname.new(dest_dir("_schedule.txt"))).to exist
+  end
+
+  it "has empty lines or formatted lines" do
+    lines = contents.split("\n")
+
+    lines.each do |line|
+      parts = line.split ","
+      if parts.length < 2
+        expect(line).to match(/^\s+$/)
+      else
+        expect(parts[0].to_s).to match /\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d([+-][0-2]\d:[0-5]\d|Z)/
+        expect(parts[1].to_s).to match /Build \'.*\'/
+        expect(parts[2].to_s).to match /_posts\/\d{4}-[01]\d-[0-3]\d-(.*)\.(md|html)$/
+      end
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "jekyll"
+require File.expand_path("../lib/jekyll-cloudcannon-schedule", __dir__)
+
+Jekyll.logger.log_level = :error
+
+RSpec.configure do |config|
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.order = "random"
+
+  SOURCE_DIR = File.expand_path("fixtures", __dir__)
+  DEST_DIR   = File.expand_path("dest", __dir__)
+
+  def source_dir(*files)
+    File.join(SOURCE_DIR, *files)
+  end
+
+  def dest_dir(*files)
+    File.join(DEST_DIR, *files)
+  end
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-cloudcannon-schedule
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- CloudCannon Inc.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-02-05 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.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '0.51'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '0.51'
+description: 
+email: support@cloudcannon.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- History.markdown
+- LICENSE.md
+- README.md
+- Rakefile
+- jekyll-cloudcannon-schedule.gemspec
+- lib/_schedule.txt
+- lib/jekyll-cloudcannon-schedule.rb
+- lib/jekyll-cloudcannon-schedule/version.rb
+- lib/jekyll/jekyll-cloudcannon-schedule.rb
+- lib/jekyll/page_without_a_file.rb
+- script/bootstrap
+- script/cibuild
+- script/console
+- script/fmt
+- script/release
+- script/test
+- spec/fixtures/_config.yml
+- spec/fixtures/_data/authors.yml
+- spec/fixtures/_drafts/2015-01-12-a-draft.md
+- spec/fixtures/_layouts/some_default.html
+- spec/fixtures/_posts/2015-08-08-stuck-in-the-middle.html
+- spec/fixtures/_posts/3005-10-22-because-of-the-internet.md
+- spec/jekyll-cloudcanon-schedule_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/CloudCannon/jekyll-cloudcannon-schedule
+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.7.3
+signing_key: 
+specification_version: 4
+summary: Automatically generates _schedule.txt for builds on CloudCannon.
+test_files:
+- spec/fixtures/_config.yml
+- spec/fixtures/_data/authors.yml
+- spec/fixtures/_drafts/2015-01-12-a-draft.md
+- spec/fixtures/_layouts/some_default.html
+- spec/fixtures/_posts/2015-08-08-stuck-in-the-middle.html
+- spec/fixtures/_posts/3005-10-22-because-of-the-internet.md
+- spec/jekyll-cloudcanon-schedule_spec.rb
+- spec/spec_helper.rb