jekyll-author 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 733f79265b003f693bdd304b07da4a5193f33c45
+  data.tar.gz: 31b523a8adcef45d6438b05301af615e2cb584d8
+SHA512:
+  metadata.gz: 7520de79ff5251f802a82f7f8655766a4fe99cff391a6e57997edc0773e45c9fd164b9f68dd58c1390915ca72baa7d4e5562cf0f6280d18ca3ef515cacf82fbb
+  data.tar.gz: 1de9c076c10165b3d446d9678fb0467a41165bfeeede95377b46fe8d0fc7f7fa78a3e71362e2f3dac675bd9300be19467218c5a41b0b6f20fdca6390695bfcfb

data/.gitignore

@@ -0,0 +1,20 @@
+/vendor
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.gem
+Gemfile.lock
+spec/dest
+.bundle
+spec/fixtures/.jekyll-metadata

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,29 @@
+inherit_gem:
+  jekyll: .rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 1.9
+  Include:
+    - lib/*.rb
+
+  Exclude:
+    - .rubocop.yml
+    - .codeclimate.yml
+    - .travis.yml
+    - .gitignore
+    - .rspec
+
+    - Gemfile.lock
+    - CHANGELOG.md
+    - readme.md
+    - README.md
+    - Readme.md
+    - ReadMe.md
+    - COPYING
+    - LICENSE
+
+    - test/**/*
+    - vendor/**/*
+    - features/**/*
+    - script/**/*
+    - spec/**/*

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+rvm:
+  - 2.2
+env:
+  global:
+    - NOKOGIRI_USE_SYSTEM_LIBRARIES=true
+cache: bundler
+sudo: false
+before_script: bundle update
+script: ./script/cibuild
+notifications:
+  email: false

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Garth Braithwaite
+
+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,67 @@
+# Jekyll Authors Plugin
+
+A Jekyll plugin that manages all the author data from `_config.yml` and `_data/authors.*`
+
+[![Build Status](https://travis-ci.org/GarthDB/jekyll-author.svg)](https://travis-ci.org/GarthDB/jekyll-author)
+
+# Author information
+
+A list of authors can be declared in `_config.yml` as an array in `authors` and/or in a [Jekyll data file](https://jekyllrb.com/docs/datafiles/) (ie `_data/authors.yml` or `_data/authors.json`).
+
+*Note:* if an author slug is used in both lists (like `benbalter` in the examples below) it will keep the information from the `_config.yml` file and reject the `_data/authors.*` author data with the same slug.
+
+Example `_config.yml`:
+
+```yml
+timezone: UTC
+
+authors:
+  garthdb:
+    name: Garth Braithwaite
+    uri: http://garthdb.com/
+    email: garthdb@adobe.com
+    twitter: garthdb
+  benbalter:
+    name: Ben Balter
+    uri: http://ben.balter.com/
+    email: ben.balter@github.com
+    twitter: benbalter
+```
+
+Example `_data/authors.yml`:
+
+```yml
+pathawks:
+  name: Pat Hawks
+  uri: https://pathawks.com
+  email: pat@pathawks.com
+  twitter: pathawks
+benbalter:
+  name: The Ben Balter
+  uri: http://ben.balter.com/
+  email: ben.balter@github.com
+  twitter: benbalter
+```
+
+The author information can then be referenced in a post by using the author slug.
+
+For example if a post had the front matter:
+
+```yml
+---
+title: "Super Great Post Title"
+author: "benbalter"
+---
+```
+
+The layout could use the author information from list:
+
+```liquid
+{% if page.author.name and page.author.uri %}
+  <a href="{{ page.author.uri }}">{{ page.author.name }}</a>
+{% else %}
+  {{ page.author }}
+{% endif %}
+```
+
+It is recommended to check if properties needed are available and to fallback to the author if they are not.

data/Rakefile

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

data/jekyll-author.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+
+Gem::Specification.new do |spec|
+  spec.name          = "jekyll-author"
+  spec.version       = "0.1.0"
+  spec.authors       = ["Garth Braithwaite"]
+  spec.email         = ["garthdb@adobe.com"]
+  spec.summary       = "A Jekyll plugin to manage author data from multiple sources."
+  spec.homepage      = "https://github.com/garthdb/jekyll-author"
+  spec.license       = "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_development_dependency "jekyll", ">= 3.0.0", "< 3.2.0"
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "typhoeus", "~> 0.7"
+  spec.add_development_dependency "nokogiri", "~> 1.6"
+  spec.add_development_dependency "rubocop"
+end

data/lib/jekyll-author.rb

@@ -0,0 +1 @@
+require "jekyll/jekyll-author"

data/lib/jekyll/jekyll-author.rb

@@ -0,0 +1,40 @@
+module Jekyll
+  class Authors
+    class << self
+      def authors?(site)
+        (site.data.key?('authors') || site.config.key?('authors'))
+      end
+
+      def merge_authors(site)
+        site.config['authors'].merge!(site.data['authors']) { |_key, v1, _v2| v1 }
+      end
+
+      def default_author?(site)
+        site.config.key?('author')
+      end
+
+      def default_author(site)
+        site.config['author'] = site.config['authors'].values[0]
+      end
+
+      def post_author?(post)
+        (post.author.is_a?(String) && post.site.config['authors'].key?(post.author))
+      end
+
+      def attach_author(post)
+        post.data['author'] = post.site.config['authors'][post.author]
+      end
+    end
+  end
+end
+
+Jekyll::Hooks.register :site, :post_read do |site|
+  Jekyll::Authors.merge_authors(site) if Jekyll::Authors.authors?(site)
+  if !Jekyll::Authors.default_author?(site) && Jekyll::Authors.authors?(site)
+    Jekyll::Authors.default_author(site)
+  end
+end
+
+Jekyll::Hooks.register :posts, :pre_render do |post|
+  Jekyll::Authors.attach_author(post) if Jekyll::Authors.post_author?(post)
+end

data/script/bootstrap

@@ -0,0 +1,3 @@
+#! /bin/bash
+
+bundle install

data/script/cibuild

@@ -0,0 +1,7 @@
+#! /bin/bash
+
+set -e
+
+bundle exec rspec
+bundle exec rubocop -S -D
+bundle exec rake build

data/script/release

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

data/spec/fixtures/_config.yml

@@ -0,0 +1,13 @@
+timezone: UTC
+
+authors:
+  garthdb:
+    name: Garth Braithwaite
+    uri: http://garthdb.com/
+    email: garthdb@adobe.com
+    twitter: garthdb
+  benbalter:
+    name: Ben Balter
+    uri: http://ben.balter.com/
+    email: ben.balter@github.com
+    twitter: benbalter

data/spec/fixtures/_data/authors.yml

@@ -0,0 +1,10 @@
+pathawks:
+  name: Pat Hawks
+  uri: https://pathawks.com
+  email: pat@pathawks.com
+  twitter: pathawks
+benbalter:
+  name: The Ben Balter
+  uri: http://ben.balter.com/
+  email: ben.balter@github.com
+  twitter: benbalter

data/spec/fixtures/_layouts/post.html

@@ -0,0 +1,16 @@
+---
+---
+<html>
+  <head>
+  </head>
+  <body>
+    THIS IS MY LAYOUT
+    <h1>{{ page.title }}</h1>
+    {{ content }}
+    {% if page.author.name and page.author.uri %}
+      <a href="{{ page.author.uri }}">{{ page.author.name }}</a>
+    {% else %}
+      {{ page.author }}
+    {% endif %}
+  </body>
+</html>

data/spec/fixtures/_posts/2013-12-12-dec-the-second.md

@@ -0,0 +1,7 @@
+---
+excerpt: "Foo"
+image: "/image.png"
+layout: "post"
+author: garthdb
+---
+# December the twelfth, actually.

data/spec/fixtures/_posts/2014-08-13-non-author.md

@@ -0,0 +1,6 @@
+---
+image: "/image.png"
+layout: "post"
+author: Tester McTesterton
+---
+# This is a post

data/spec/fixtures/_site/2013/12/12/dec-the-second.html

@@ -0,0 +1,10 @@
+<html>
+  <head>
+  </head>
+  <body>
+    
+THIS IS MY LAYOUT
+<h1 id="december-the-twelfth-actually">December the twelfth, actually.</h1>
+
+  </body>
+</html>

data/spec/jekyll-author_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+describe(Jekyll::Authors) 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",
+      "collections" => {
+        "my_collection" => { "output" => true },
+        "other_things"  => { "output" => false }
+      }
+    }, overrides))
+  end
+  let(:site)     { Jekyll::Site.new(config) }
+  let(:generated_page) { File.read(dest_dir("2013/12/12/dec-the-second.html")) }
+  let(:context)  { make_context(site: site) }
+  before(:each) do
+    site.process
+  end
+
+  it "has authors from _config.yml" do
+    expect(site.config['authors']['garthdb']['name']).to match(/\AGarth Braithwaite/)
+  end
+
+  it "has authors from _data/authors.yml" do
+    expect(site.config['authors']['pathawks']['name']).to match(/\APat Hawks/)
+  end
+
+  it "prioritizes _config.yml data" do
+    expect(site.config['authors']['benbalter']['name']).to match('Ben Balter')
+  end
+
+  it "uses authors data for page author" do
+    expect(generated_page).to match(/Garth Braithwaite/)
+  end
+
+  it "leaves the string if it doesn't match author key" do
+    page = File.read(dest_dir("2014/08/13/non-author.html"))
+    expect(page).to match(/Tester McTesterton/)
+  end
+
+  it "sets default author from the first author in list if not set" do
+    expect(site.config['author']['name']).to match('Garth Braithwaite')
+  end
+
+  context "a default author set in config" do
+    let(:author) {"Dr. Jekyll"}
+    let(:overrides) do
+      {"author" => author}
+    end
+    it "does not override config author if set" do
+      expect(site.config['author']).to match(author)
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+require 'jekyll'
+require File.expand_path('../lib/jekyll-author', File.dirname(__FILE__))
+
+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", __FILE__)
+  DEST_DIR   = File.expand_path("../dest",     __FILE__)
+
+  def source_dir(*files)
+    File.join(SOURCE_DIR, *files)
+  end
+
+  def dest_dir(*files)
+    File.join(DEST_DIR, *files)
+  end
+
+  def make_context(registers = {})
+    Liquid::Context.new({}, {}, { site: site }.merge(registers))
+  end
+end

metadata

@@ -0,0 +1,179 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-author
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Garth Braithwaite
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: 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: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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'
+description: 
+email:
+- garthdb@adobe.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- History.markdown
+- LICENSE
+- README.md
+- Rakefile
+- jekyll-author.gemspec
+- lib/jekyll-author.rb
+- lib/jekyll/jekyll-author.rb
+- script/bootstrap
+- script/cibuild
+- script/release
+- spec/fixtures/_config.yml
+- spec/fixtures/_data/authors.yml
+- spec/fixtures/_layouts/post.html
+- spec/fixtures/_posts/2013-12-12-dec-the-second.md
+- spec/fixtures/_posts/2014-08-13-non-author.md
+- spec/fixtures/_site/2013/12/12/dec-the-second.html
+- spec/jekyll-author_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/garthdb/jekyll-author
+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.1
+signing_key: 
+specification_version: 4
+summary: A Jekyll plugin to manage author data from multiple sources.
+test_files:
+- spec/fixtures/_config.yml
+- spec/fixtures/_data/authors.yml
+- spec/fixtures/_layouts/post.html
+- spec/fixtures/_posts/2013-12-12-dec-the-second.md
+- spec/fixtures/_posts/2014-08-13-non-author.md
+- spec/fixtures/_site/2013/12/12/dec-the-second.html
+- spec/jekyll-author_spec.rb
+- spec/spec_helper.rb