jekyll-podcast 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 69e80669ca56561da9578401d9afbd342b681eb5648dfcca7b395a03b502579a
+  data.tar.gz: f0884813435aa6d532fe45bf99b889c82fcf13d8601ab3b579eb12161448e134
+SHA512:
+  metadata.gz: 78c530532b4b91b0fc0e17c7ce31f170a51a9582cf07e638ef25d7239cb674b8ccdeb45e0cc72581b5a491a63f7afcf1813a7406325a9a8cc6ebacaf822b3441
+  data.tar.gz: 1f7dfaa39fc4fa7a0e1e20db83061c3d811a8272a24338f0f55eca4c3199f1d7051ecc5f5935463457bd1897031a3ae2577f39b7f3c2b8de8d5c34e3d58529f6

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.vscode/
+/spec/dest/
+.jekyll-cache
+.nova
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,8 @@
+require: rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 3.0
+  NewCops: enable
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-09-28
+
+- Initial release

data/Gemfile

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in jekyll-podcast.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'
+
+gem 'rspec', '~> 3.0'
+
+gem 'rubocop', '~> 1.7'
+gem 'rubocop-rspec', '~> 2.12'
+
+gem 'jekyll', '~> 4.2'
+
+gem 'nokogiri', '~> 1.13'
+
+gem 'rubocop-rake', '~> 0.6.0'

data/Gemfile.lock

@@ -0,0 +1,130 @@
+PATH
+  remote: .
+  specs:
+    jekyll-podcast (0.9.0)
+      jekyll (~> 4.2)
+      json-schema (~> 2.6)
+      mp3info (~> 0.8.5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.2)
+    colorator (1.1.0)
+    concurrent-ruby (1.1.10)
+    diff-lcs (1.5.0)
+    em-websocket (0.5.3)
+      eventmachine (>= 0.12.9)
+      http_parser.rb (~> 0)
+    eventmachine (1.2.7)
+    ffi (1.15.5)
+    forwardable-extended (2.6.0)
+    http_parser.rb (0.8.0)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    jekyll (4.2.2)
+      addressable (~> 2.4)
+      colorator (~> 1.0)
+      em-websocket (~> 0.5)
+      i18n (~> 1.0)
+      jekyll-sass-converter (~> 2.0)
+      jekyll-watch (~> 2.0)
+      kramdown (~> 2.3)
+      kramdown-parser-gfm (~> 1.0)
+      liquid (~> 4.0)
+      mercenary (~> 0.4.0)
+      pathutil (~> 0.9)
+      rouge (~> 3.0)
+      safe_yaml (~> 1.0)
+      terminal-table (~> 2.0)
+    jekyll-sass-converter (2.2.0)
+      sassc (> 2.0.1, < 3.0)
+    jekyll-watch (2.2.1)
+      listen (~> 3.0)
+    json (2.6.2)
+    json-schema (2.8.1)
+      addressable (>= 2.4)
+    kramdown (2.4.0)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    liquid (4.0.3)
+    listen (3.7.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    mercenary (0.4.0)
+    mp3info (0.8.5)
+      ruby-mp3info (>= 0.8.5)
+    nokogiri (1.13.8-arm64-darwin)
+      racc (~> 1.4)
+    parallel (1.22.1)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    pathutil (0.16.2)
+      forwardable-extended (~> 2.6)
+    public_suffix (4.0.7)
+    racc (1.6.0)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    rb-fsevent (0.11.1)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    regexp_parser (2.5.0)
+    rexml (3.2.5)
+    rouge (3.30.0)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.32.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.19.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.19.1)
+      parser (>= 3.1.1.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.12.1)
+      rubocop (~> 1.31)
+    ruby-mp3info (0.8.10)
+    ruby-progressbar (1.11.0)
+    safe_yaml (1.0.5)
+    sassc (2.4.0)
+      ffi (~> 1.9)
+    terminal-table (2.0.0)
+      unicode-display_width (~> 1.1, >= 1.1.1)
+    unicode-display_width (1.8.0)
+
+PLATFORMS
+  arm64-darwin-20
+  arm64-darwin-21
+
+DEPENDENCIES
+  jekyll (~> 4.2)
+  jekyll-podcast!
+  nokogiri (~> 1.13)
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.7)
+  rubocop-rake (~> 0.6.0)
+  rubocop-rspec (~> 2.12)
+
+BUNDLED WITH
+   2.3.9

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Nathan Bottomley
+
+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,335 @@
+# Jekyll::Podcast
+
+`jekyll-podcast` converts a Jekyll blog into a podcast webpage. It provides you with all the functionality you need to make your podcast fully accessible from your webpage, and it creates a podcast feed which you can submit to Apple Podcasts, Google Podcasts, Spotify or any other podcast directory.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jekyll-podcast'
+```
+
+And then execute:
+
+```shell
+bundle install
+```
+
+Or install it yourself as:
+
+```shell
+gem install jekyll-podcast
+```
+
+## Usage
+
+### Providing information about your podcast
+
+Most of the important information about your podcast — the title, the owner, the category, the subcategory and so on should appear in a `podcast` block in `_config.yml`.
+
+```yaml
+# _config.yml
+
+podcast:
+  title: "Flight Through Entirety: A Doctor Who Podcast"
+  subtitle: &subtitle >-
+    Flying through the entirety of Doctor Who. Originally with cake,but now with guests.
+  # I've made the description and the summary
+  # the same as the subtitle, but you can do
+  # whatever you like here.
+  description: *subtitle
+  summary: *subtitle
+  email: flightthroughentirety@gmail.com
+  language: en-AU
+  author: Flight Through Entirety
+  owner: Nathan Bottomley
+  explicit: false
+  category: TV & Film
+  subcategory: TV Reviews
+  complete: no
+```
+
+>Explanations of all of the fields here can be found on [Apple's page about podcast feed tags](https://help.apple.com/itc/podcasts_connect/#/itcb54353390). A list of podcast categories and subcategories [can be found here](https://podcasters.apple.com/support/1691-apple-podcasts-categories).
+
+You will also need to provide your podcast artwork, which should be a JPEG file 3000 × 3000 pixels in size. `jekyll-podcast` will expect to find this file at `/assets/images/podcast-logo.jpeg`.
+
+### Providing information about your podcast episodes
+
+Each post in the `_posts` directory will correspond to an episode of your podcast. So, for example, the publication date of the post will be the publication date of the episode, and the content of the post will be the episode's description or shownotes, which will (normally) be displayed in your listeners' podcast player.
+
+Other information about your podcast episodes should be provided in each post's front matter. Here's an example.
+
+```yaml
+tags: #optional
+- Series 6
+- The Eleventh Doctor
+contributors: #also optional
+- Nathan Bottomley
+podcast:
+  # the episode number
+  episode: 217
+  # the episode filename, including the extension
+  file: >-
+    FTE 217, Gaslight Girlboss Ginger (Day of the Moon).mp3
+  # optional
+  recording_date: 2021-08-01
+```
+
+### The episode files
+
+By default, you will store your episodes in `/assets/episodes`, and they will be served directly from your website.
+
+If you use an analytics service that requires a URL prefix to track your episodes' data, you will need to provide that prefix as part of the `podcast` block in `_config.yml`.
+
+```yaml
+# _config.yml
+
+podcast:
+  tracking_prefix: https://dts.podtrac.com/redirect.mp3
+```
+
+If you use a CDN or an S3-compatible storage solution to host your podcast episodes, you will need to provide the URL for that sevice. You must also store your episodes in a folder called `/_episodes`, so that Jekyll doesn't include the episode files in the website it builds.
+
+```yaml
+# _config.yml
+
+podcast:
+  remote_episode_host: https://flight-through-entirety.us-east-1.linodeobjects.com
+```
+
+> If you store your episodes on some other service, you will have to take care of uploading the episodes to that service yourself. I generally write a build script using `rsync` or `s3cmd sync` to do this.
+
+### Creating your podcast feed
+
+If you set up your `_config.yml` file and the front matter of your posts as specified above, `jekyll-podcast` will have enough information to create your podcast feed.
+
+Your podcast feed will appear in your `_site` directory at `feed/podcast`.
+
+### Your shownotes
+
+The contents of each episode's post will appear on the website, as usual, but it will also be used as the description or shownotes for your episode and displayed in your listeners' podcast players.
+
+It's easy to make a podcast player show a different description from the post displayed on your site. Just create an include called `post-feed-content.html` in the `_includes` folder and use it to define the content that you want to appear in a podcast player. Here's an example.
+
+```html
+<!-- post-feed-content.html -->
+
+<p>
+  <em>
+    {{ post.star_trek.series }}, 
+    {{ post.star_trek.episode }}.
+    First broadcast on {{ post.star_trek.broadcast | date: "%A, %e %B %Y" }}
+  </em>
+</p>
+
+{{ post.content }}
+```
+
+### Podcast episode permalinks
+
+Unlike a blog, a podcast website should have simple permalinks. Best practice tends to be just the episode number.
+
+```url
+https://flightthroughentirety.com/217
+```
+
+To make this possible, `jekyll-podcast` provides a `:podcast_episode` placeholder, which you can use in your default permalink definitions in `_config.yml`.
+
+```yaml
+# _config.yml
+
+- scope:
+    path: ""
+    type: posts
+  values:
+    permalink: /:podcast_episode/
+```
+
+> You can combine this placeholder with other placeholders if you like. One possibility might be combining the episode number with the slug, like this:
+>
+> ```yaml
+> # _config.yml
+> 
+> values:
+>   permalink: /:podcast_episode-:slug/
+> ```
+>
+>
+> Remember to put the `/` at the end of the permalink pattern, so that you don't end up with the `.html` suffix at the end of your URLs.
+
+### Podcast episode data
+
+When `jekyll-podcast` builds your site, it analyses the podcast episodes in your `assets/episodes` folder (or your `_episodes` folder). As a result, the following information becomes available to your Liquid templates.
+
+```liquid
+{{ post.podcast.duration }} 
+→ 0:57:22
+
+{{ post.podcast.size_in_megabytes }}
+→ 40.1 MB
+```
+
+You might want to consider adding the recording date to the podcast blog in the front matter of your posts, so that you can display it in your posts as well.
+
+```yaml
+podcast:
+  recording_date: 2022-07-13
+```
+
+```liquid
+{{ post.podcast.recording_date | date: "%A, %e %B %Y" }} 
+→ Wednesday, 13 July 2022
+```
+
+### Including an `<audio>` tag
+
+You should also create an include for your post so that your listeners can listen to the episodes on your website. The easiest way to do this is using an `<audio>` tag. `jekyll-podcast` provides a liquid filter called `episode_url`, which will add the correct URL to the filename you provide in your front matter.
+
+Here's an example.
+
+```html
+<!-- _includes/audio-player.html -->
+
+<audio controls preload="metadata" src="{{ post.podcast.file | episode_url }}"></audio>
+```
+
+### Podcast data
+
+While `jekyll-podcast` is analysing your podcast files, it collects some interesting information about your podcast, and logs it to screen as part of the build process. This information includes the number of episodes, their total size in megabytes and their total duration (to the nearest millisecond).
+
+```shell
+236 episodes; 15786.9 MB; 9 d 16 h 6 min 25.577 s 
+```
+
+### Contributor pages
+
+`jekyll-podcasts` has a feature which allows you to create bio pages for each of your contributors. These pages can include whatever information you like, including a chronological list of all of the episodes that a contributor has appeared in.
+
+To get this to work, you need to create a Jekyll collection for your contributor pages. To do this, add a block like this to `_config.yml`.
+
+```yaml
+# _config.yml
+
+collections:
+  contributors:
+    output: true
+    permalink: /contributors/:slug/
+```
+
+Then create a layout for your contributor pages, and specify it as a default in `_config.yml`.
+
+```yaml
+# _config.yml
+
+defaults:
+  - scope:
+      path: ""
+      type: contributors
+    values:
+      layout: contributors-page
+```
+
+This layout should include the page content, and then iterate through the contributor's posts, which are all accessible to the layout and the page as `{{ page.posts }}`. Here's a simple example.
+
+```html
+<!-- contributors-page.html -->
+
+<h1>page.title</h1>
+
+{{ content }}
+
+{% for post in page.posts %}
+  <article>
+    <h1>{{ post.title }}</h1>
+    {{ post.content }}
+  </article>
+{% endfor %}
+```
+
+Now you can create the contributor's pages. Each page can contain a picture, a bio and anything else you want. So long as you set the layout in the front matter to `contributors-page`, the pages will display all of the episodes that the contributor is involved in.
+
+To indicate which contributors are involved in a particular episode, just add a list of contributors to the front matter of the corresponding post.
+
+```yaml
+contributors:
+- Jonathan Archer
+- Gabriel Lorca
+- Christopher Pike
+- James T Kirk
+```
+
+> Originally this feature was called _Guest pages_, and it's still possible to call this feature whatever you want. Just provide an replacement name in plural form to the `podcast` block in `_config.yml` as the `contributors_alias`, like this:
+>
+>```yaml
+> # _config.yml
+>
+> podcast:
+>  contributors_alias: guests
+> ```
+>
+> If you do this, you should also change the name of the collection and the default type in `_config.yml` as shown above.
+
+### Tag pages
+
+There are plenty of other implementations of tag pages for Jekyll blogs, and so this one just aims to be as simple as possible.
+
+To specify an episode's tags, just list them in the post's front matter.
+
+```yaml
+tags:
+- The Tenth Doctor
+- Specials
+- Christmas
+```
+
+That's it really. By default, the permalink of a tag page will be the slugified version of the tag's text.
+
+If you want to specify permalinks for a tag, you can do that by creating a file in the data directory called `tag_permalinks.yaml` or `tag_permalinks.json`. It should be a hash, with the tag as the key and the permalink as the value.
+
+```yaml
+# tag_permalinks.yaml
+
+"Star Trek: The Next Generation": /tng/
+"Star Trek: Deep Space Nine": /ds9/
+"Star Trek: Voyager": /voy/
+```
+
+To create a list of tag links attached to a post, you can use `jekyll-podcast`'s `tag_link` filter, like this.
+
+```html
+{% for tag in post.tags %}
+  {{ tag | tag_link }}
+{% endfor %}
+```
+
+### The `pagetitle` tag
+
+The `{% pagetitle %}` Liquid tag can be placed in the `<head>` of your HTML layouts, and it will render a `<title>` tag for your page. This tag will consist of the title of your page (as specified in the front matter), followed by an em-dash, followed by the title of your site (as specified in `_config.yml`). If your page has no title or if its title is the same as your site's title, the tag will just contain your site's title.
+
+### `jekyll-podcast` in action
+
+I've been using `jekyll-podcast` to create podcast websites since the middle of 2021, after hosting podcasts with WordPress for a number of years. It has allowed me to take more control of my podcast sites, and to spend my time writing HTML and Sass (and Ruby, I guess) instead of wrestling with WordPress plugins and PHP.
+
+If you would like to see some podcasts powered by `jekyll-podcast`, here's a list of the podcasts I'm currently running.
+
+- [Flight Through Entirety](https://flightthroughentirety.com), a _Doctor Who_ podcast flying through the entirety of the show's 60-year history.
+- [Bondfinger](https://bondfinger.com), a James Bond commentary podcast that has run out of James Bond films and now spends its time drinking and watching terrible TV shows from the 1960s mostly.
+- [Jodie into Terror](https://jodieintoterror.com), a _Doctor Who_ flashcast in which we give our (intermittently) enthusiastic hot takes on the most recent era of _Doctor Who_ mere days after each episode's first broadcast in the UK.
+- [Untitled Star Trek Project](https://untitledstartrekproject.com), a _Star Trek_ commentary podcast in which two friends watch _Star Trek_ episodes from any series, chosen (nearly) at random by [a page on the podcast website](https://untitledstartrekproject.com/randomiser).
+
+<!--
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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/furius95/jekyll-podcast>.
+
+-->
+## 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,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/jekyll-podcast.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative 'lib/jekyll/podcast/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'jekyll-podcast'
+  spec.version       = Jekyll::Podcast::VERSION
+  spec.authors       = ['Nathan Bottomley']
+  spec.email         = ['nathan.bottomley@gmail.com']
+
+  spec.summary       = 'A Jekyll plugin that provides some useful features for podcasting websites.'
+  spec.homepage      = 'https://github.com/furius95/jekyll-podcast'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = '>= 3.0.0'
+
+  # spec.metadata['allowed_push_host'] = 'http://mygemserver.com'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  # spec.metadata['changelog_uri'] = 'TODO: Put your gem's CHANGELOG.md URL here.'
+
+  # 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']
+
+  spec.add_runtime_dependency 'jekyll', '~> 4.2'
+  spec.add_runtime_dependency 'json-schema', '~> 2.6'
+  spec.add_runtime_dependency 'mp3info', '~> 0.8.5'
+
+  spec.add_development_dependency 'nokogiri', '~> 1.13'
+  spec.metadata['rubygems_mfa_required'] = 'true'
+end

data/lib/jekyll/podcast/contributor_page_generator.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Podcast
+    module ContributorPageGenerator
+      # Adds posts to each contributor page on the site
+      class Generator < Jekyll::Generator
+        def generate(site)
+          @site = site
+          collect_contributor_posts
+          @site.documents.each do |doc|
+            next unless doc.type == contributors_alias.to_sym
+
+            doc.data['posts'] = @contributor_posts[doc.data['title']]
+          end
+        end
+
+        private
+
+        def collect_contributor_posts
+          @contributor_posts = {}
+          @site.posts.docs.each do |post|
+            next unless post.data[contributors_alias]
+
+            post.data[contributors_alias].each do |contributor|
+              @contributor_posts[contributor] ||= []
+              @contributor_posts[contributor].push(post)
+            end
+          end
+        end
+
+        def contributors_alias
+          @site.config['podcast']['contributors_alias'] || 'contributors'
+        end
+      end
+    end
+  end
+end

data/lib/jekyll/podcast/episode_data.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Jekyll
+  # Define duration method in Jekyll::Podcast to convert from seconds to string for feed
+  module Podcast
+    # Class responsible for setting episode data on a post's page
+    class EpisodeData
+      def initialize(page, payload)
+        @site = page.site
+        @page = payload['page']
+        @file_path = File.join(Jekyll::Podcast::Utils.episodes_dir(@site), @page['podcast']['file'])
+      end
+
+      def add_episode_data
+        @page['podcast'].merge!({ 'size' => size,
+                                  'size_in_megabytes' => size_in_megabytes,
+                                  'duration' => duration(seconds),
+                                  'guid' => guid })
+      end
+
+      def size
+        if File.exist? @file_path
+          File.size(@file_path)
+        else
+          0
+        end
+      end
+
+      def size_in_megabytes
+        "#{(size / 1_000_000.0).round(1)} MB"
+      end
+
+      def seconds
+        if File.exist? @file_path
+          Mp3Info.open(@file_path, &:length)
+        else
+          0
+        end
+      end
+
+      def duration(seconds)
+        format('%<hours>d:%<minutes>02d:%<seconds>02d',
+               Jekyll::Podcast::Utils.duration(seconds))
+      end
+
+      def guid
+        @page['podcast']['guid'] || "#{@site.config['url']}#{@page['url']}"
+      end
+    end
+  end
+end
+
+Jekyll::Hooks.register :posts, :pre_render, priority: 'high' do |page, payload|
+  Jekyll::Podcast::EpisodeData.new(page, payload).add_episode_data
+end

data/lib/jekyll/podcast/feed_generator.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+Jekyll::Hooks.register :site, :after_init do |site|
+  required_keys = %w[title subtitle author description language summary owner email explicit category]
+  missing_keys = required_keys.reject { |x| site.config['podcast'].key?(x) }
+  Jekyll.logger.warn "Podcast config is missing keys #{missing_keys}" unless missing_keys.empty?
+end
+
+module Jekyll
+  module Podcast
+    # Class representing feed page
+    class FeedPage < Jekyll::Page
+      def read_yaml(*)
+        @data ||= {} # rubocop:disable Naming/MemoizedInstanceVariableName
+      end
+    end
+
+    # Generator for podcast feed
+    class FeedGenerator < Jekyll::Generator
+      def generate(site)
+        @site = site
+        site.pages << new_feed_page
+      end
+
+      def new_feed_page
+        feed_page = FeedPage.new(@site, __dir__, '', 'feed/podcast')
+        template_path = File.expand_path('podcast.xml', __dir__)
+        feed_page.content = File.read(template_path)
+        feed_page.data['layout'] = nil
+        feed_page
+      end
+    end
+  end
+end

data/lib/jekyll/podcast/file_exists.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Podcast
+    # Liquid tag to determine the existence of a file
+    # Path name should be the root of the directory, without an initial slash
+    class FileExistsTag < Liquid::Tag
+      def initialize(tag_name, path, tokens)
+        super
+        @path = path
+      end
+
+      def render(context)
+        # Pipe parameter through Liquid to make additional replacements possible
+        url = Liquid::Template.parse(@path).render context
+
+        # Add the site source, so that it also works with a custom one
+        site_source = context.registers[:site].config['source']
+        file_path = "#{site_source}/#{url}"
+
+        # Check if file exists (returns true or false)
+        File.exist?(file_path.strip!).to_s
+      end
+    end
+  end
+end
+
+Liquid::Template.register_tag('file_exists', Jekyll::Podcast::FileExistsTag)

data/lib/jekyll/podcast/liquid_tag_filters.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'erb'
+
+module Jekyll
+  module Podcast
+    # Define tag filters for podcasting
+    module TagFilters
+      def without_index_html(input)
+        input.delete_suffix('index.html')
+      end
+
+      def tag_permalink(input)
+        site.data['tag_permalinks'][input]
+      end
+
+      def episode_url(input)
+        input = ERB::Util.url_encode(input)
+        File.join(url_prefix, input)
+      end
+
+      private
+
+      def url_prefix
+        if tracking_prefix && remote_episode_host
+          url_prefix_with_tracking_prefix_and_remote_episode_host
+        elsif tracking_prefix
+          url_prefix_with_tracking_prefix_and_no_remote_episode_host
+        elsif remote_episode_host
+          url_prefix_with_no_tracking_prefix_and_remote_episode_host
+        else
+          File.join(site.config['url'], 'assets', 'episodes')
+        end
+      end
+
+      def url_prefix_with_tracking_prefix_and_remote_episode_host
+        File.join(tracking_prefix, remote_episode_host.sub(%r{^https?://}, ''))
+      end
+
+      def url_prefix_with_tracking_prefix_and_no_remote_episode_host
+        File.join(tracking_prefix, 'assets', 'episodes')
+      end
+
+      def url_prefix_with_no_tracking_prefix_and_remote_episode_host
+        remote_episode_host
+      end
+
+      def tracking_prefix
+        @context.registers[:site].config['podcast']['tracking_prefix']
+      end
+
+      def remote_episode_host
+        @context.registers[:site].config['podcast']['remote_episode_host']
+      end
+
+      def site
+        @context.registers[:site]
+      end
+    end
+  end
+end
+
+Liquid::Template.register_filter(Jekyll::Podcast::TagFilters)

data/lib/jekyll/podcast/page_title_liquid_tag.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Podcast
+    # Liquid tag for generating a page title
+    class PageTitleTag < Liquid::Tag
+      def render(context)
+        site_title = context.registers[:site].config['title']
+        page_title = context.registers[:page]['title']
+
+        if page_title.nil? || page_title.empty? || page_title == site_title
+          "<title>#{site_title}</title>"
+        else
+          "<title>#{page_title} — #{site_title}</title>"
+        end
+      end
+    end
+  end
+end
+
+Liquid::Template.register_tag('pagetitle', Jekyll::Podcast::PageTitleTag)

data/lib/jekyll/podcast/podcast.xml

@@ -0,0 +1,71 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<rss version="2.0"
+  xmlns:itunes="http://www.itunes.com/dtds/podcast-1.0.dtd"
+  xmlns:atom="http://www.w3.org/2005/Atom"
+  xmlns:dc="http://purl.org/dc/elements/1.1/"
+  xmlns:content="http://purl.org/rss/1.0/modules/content/">
+  <channel>
+		<title>{{ site.podcast.title }}</title>
+		<itunes:subtitle>{{ site.podcast.subtitle }}</itunes:subtitle>
+		<link>{{ site.url }}</link>
+    <atom:link href="{{ site.url }}{{ page.url }}" rel="self" type="application/rss+xml" />
+  	<dc:creator><![CDATA[{{ site.podcast.author }}]]></dc:creator>
+		<description>{{ site.podcast.description }}</description>
+		<lastBuildDate>{{ site.time | date_to_rfc822 }}</lastBuildDate>
+		<language>{{ site.podcast.language }}</language>
+		<copyright>© {{ site.time | date: "%Y" }} {{ site.podcast.author }}</copyright>
+		<itunes:author>{{ site.podcast.author }}</itunes:author>
+    <itunes:type>episodic</itunes:type>
+    <itunes:summary>{{ site.podcast.summary }}</itunes:summary>
+		<itunes:owner>
+			<itunes:name>{{ site.podcast.owner }}</itunes:name>
+			<itunes:email>{{ site.podcast.email }}</itunes:email>
+		</itunes:owner>
+		<itunes:explicit>{{ site.podcast.explicit }}</itunes:explicit>
+    {% if site.podcast.subcategory -%}
+    <itunes:category text="{{ site.podcast.category }}">
+      <itunes:category text="{{ site.podcast.subcategory }}"/>
+    </itunes:category>
+    {%- else -%}
+    <itunes:category text="{{ site.podcast.category }}" />
+    {%- endif %}
+    <itunes:image href="{{ site.url }}/assets/images/podcast-logo.jpeg" />
+    {% if site.podcast.complete -%}
+    <itunes:complete>Yes</itunes:complete>
+    {%- endif %}
+    {% if site.podcast.new-feed-url -%}
+    <generator>Jekyll v{{ jekyll.version }}</generator>
+    {% for post in site.posts -%}
+    <item>
+      <title>{{ post.title }}</title>
+      <link>{{ site.url }}{{ post.url }}</link>
+      <pubDate>{{ post.date | date_to_rfc822 }}</pubDate>
+      <guid isPermaLink="false">{{ post.podcast.guid }}</guid>
+	    <dc:creator><![CDATA[{{ site.podcast.author }}]]></dc:creator>
+      {%- capture post_feed_content_exists -%}
+        {%- file_exists _includes/post-feed-content.html -%}
+      {%- endcapture %}
+      {%- capture content %}
+        {%- if post_feed_content_exists == "true" -%}
+          {%- include post-feed-content.html post=post -%}
+        {%- else -%}
+          {{ post.content }}
+        {%- endif -%}
+      {%- endcapture -%}
+      <description><![CDATA[{{ content }}]]></description>
+      <content:encoded><![CDATA[{{ content }}]]></content:encoded>
+      <itunes:subtitle><![CDATA[{{ post.excerpt | strip_html | truncate: 250 }}]]></itunes:subtitle>
+      <itunes:keywords>{{ post.tags | join: ","}}</itunes:keywords>
+      <itunes:episodeType>full</itunes:episodeType>
+      <itunes:title>{{ post.title }}</itunes:title>
+      <itunes:episode>{{ post.podcast.episode }}</itunes:episode>
+      <enclosure url="{{ post.podcast.file | episode_url }}" length="{{ post.podcast.size }}"
+        type="audio/mpeg" />
+      <itunes:summary><![CDATA[{{ post.excerpt | strip_html }}]]></itunes:summary>
+      <itunes:block>no</itunes:block>
+      <itunes:duration>{{ post.podcast.duration }}</itunes:duration>
+      <itunes:author>{{ site.podcast.author }}</itunes:author>
+    </item>
+    {% endfor %}
+  </channel>
+</rss>

data/lib/jekyll/podcast/podcast_data.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Podcast
+    # Calculate the total count and duration of all podcast episodes
+    module PodcastData
+      class << self
+        def episodes_dir
+          Jekyll::Podcast::Utils.episodes_dir(@site)
+        end
+
+        def episodes
+          Dir.children(episodes_dir).select { |x| x.end_with?('.mp3') }
+        end
+
+        def total_duration_in_seconds
+          episodes.sum do |mp3|
+            Mp3Info.open(File.join(episodes_dir, mp3), &:length)
+          end
+        end
+
+        def total_size_in_megabytes
+          size_in_bytes = episodes.sum do |mp3|
+            File.size(File.join(episodes_dir, mp3))
+          end
+          "#{(size_in_bytes / 1_000_000.0).round(1)} MB"
+        end
+
+        def podcast_data
+          result = Jekyll::Podcast::Utils.duration(total_duration_in_seconds)
+          result[:count] = episodes.length
+          result[:size] = total_size_in_megabytes
+          result
+        end
+
+        def podcast_data_log_entry(site)
+          @site = site
+          if Dir.exist?(episodes_dir)
+            format(
+              '%<count>d episodes; %<size>s;' \
+              '%<days>d d %<hours>d h %<minutes>d min %<seconds>0.3f s',
+              podcast_data
+            )
+          else
+            "No episodes directory found at #{episodes_dir}"
+          end
+        end
+      end
+    end
+  end
+end
+
+Jekyll::Hooks.register :site, :post_write do |site|
+  Jekyll.logger.info Jekyll::Podcast::PodcastData.podcast_data_log_entry(site).yellow
+end

data/lib/jekyll/podcast/podcast_episode_drop.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Drops
+    # A new :podcast_element component for the site's permalink structure
+    class UrlDrop < Drop
+      def podcast_episode
+        @obj.data.dig('podcast', 'episode').to_s
+      end
+    end
+  end
+end

data/lib/jekyll/podcast/tag_link_filter.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Podcast
+    # creates a filter to turn tag names into links
+    module TagLinkFilter
+      def tag_link(input)
+        tag_href = Jekyll::Podcast::TagPageGenerator.permalink(input, @context.registers[:site])
+        "<a class='tag' href='#{tag_href}'>#{input}</a>"
+      end
+    end
+  end
+end
+
+Liquid::Template.register_filter(Jekyll::Podcast::TagLinkFilter)

data/lib/jekyll/podcast/tag_page_generator.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Podcast
+    # Generator to create tag pages for each tag on the site
+    module TagPageGenerator
+      # The generator itself
+      class Generator < Jekyll::Generator
+        def generate(site)
+          site.tags.each do |tag, _|
+            site.pages << TagPage.new(site, tag)
+          end
+        end
+      end
+
+      # Represents a tag page; includes pagination information
+      class TagPage < Jekyll::Page
+        def initialize(site, tag)
+          super(site, site.baseurl, '/', 'index.html')
+          @tag = tag
+          @data ||= {}
+          @data['permalink'] = Jekyll::Podcast::TagPageGenerator.permalink(@tag, site)
+          @data['layout'] = 'tag-page'
+          @data['title'] = tag
+          @data['pagination'] = pagination(site)
+        end
+
+        def pagination(site)
+          pagination_config = site.config.dig('tag_pages', 'pagination') || {}
+          {
+            'enabled' => true,
+            'tag' => @tag,
+            'sort_reverse' => false
+          }.merge(pagination_config)
+        end
+      end
+
+      def self.permalink(tag, site)
+        if site.data['tag_permalinks'] && site.data['tag_permalinks'][tag]
+          site.data['tag_permalinks'][tag]
+        else
+          "/#{Jekyll::Utils.slugify(tag)}/"
+        end
+      end
+    end
+  end
+end

data/lib/jekyll/podcast/utils.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Podcast
+    # Utility functions used in jekyll-podcast
+    module Utils
+      class << self
+        def duration(seconds)
+          mm, ss = seconds.divmod(60)
+          hh, mm = mm.divmod(60)
+          dd, hh = hh.divmod(24)
+          {
+            days: dd,
+            hours: hh,
+            minutes: mm,
+            seconds: ss
+          }
+        end
+
+        def episodes_dir(site)
+          if site.config['podcast']['remote_episode_host']
+            File.join(site.source, '_episodes')
+          else
+            File.join(site.source, 'assets/episodes')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/jekyll/podcast/validate_yaml_frontmatter.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require 'date'
+require 'yaml'
+require 'json'
+require 'json-schema'
+
+module Jekyll
+  module Podcast
+    # Validate the frontmatter of each document using schemas in the _schemas directory
+    module ValidateYAMLFrontmatter
+      class << self
+        date_proc = lambda { |value|
+          begin
+            Date.iso8601(value)
+          rescue ArgumentError
+            raise JSON::Schema::CustomFormatError, 'must be in ISO-8601 format: CCYY-MM-DD'
+          end
+        }
+        JSON::Validator.register_format_validator('full-date', date_proc)
+
+        def print_validation_complete_message(error_count)
+          if error_count.zero?
+            Jekyll.logger.info 'YAML frontmatter validated successfully'.yellow
+          else
+            Jekyll.logger.info "YAML frontmatter validation failed with #{error_count} errors".yellow
+          end
+        end
+
+        def print_document_validation_failed_message(document, errors)
+          Jekyll.logger.info "Validation failed for #{document.path}:".yellow
+          Jekyll.logger.info(errors.map { |x| "- #{x}" }.join("\n").yellow)
+        end
+
+        def validate_document(document)
+          return [] unless File.exist? "_schemas/#{document.collection.label}.json"
+
+          document_frontmatter = YAML.safe_load_file(document.path, permitted_classes: [Date]).to_json
+          JSON::Validator.fully_validate("_schemas/#{document.collection.label}.json", document_frontmatter)
+        end
+
+        def validate_site(site)
+          Jekyll.logger.info 'Validating YAML frontmatter'.yellow
+          error_count = 0
+          site.documents.each do |document|
+            result = validate_document(document)
+            next if result.empty?
+
+            error_count += result.length
+            print_document_validation_failed_message(document, result)
+          end
+          print_validation_complete_message(error_count)
+        end
+      end
+    end
+  end
+end
+
+Jekyll::Hooks.register :site, :pre_render do |site, _payload|
+  Jekyll::Podcast::ValidateYAMLFrontmatter.validate_site(site)
+end

data/lib/jekyll/podcast/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Podcast
+    VERSION = '0.9.0'
+  end
+end

data/lib/jekyll/podcast.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'jekyll'
+require 'mp3info'
+require 'json-schema'
+
+require 'jekyll/podcast/version'
+
+module Jekyll
+  module Podcast
+    class Error < StandardError; end
+  end
+end
+
+require 'jekyll/podcast/utils'
+require 'jekyll/podcast/episode_data'
+require 'jekyll/podcast/podcast_episode_drop'
+require 'jekyll/podcast/liquid_tag_filters'
+require 'jekyll/podcast/file_exists'
+require 'jekyll/podcast/feed_generator'
+require 'jekyll/podcast/tag_page_generator'
+require 'jekyll/podcast/tag_link_filter'
+require 'jekyll/podcast/contributor_page_generator'
+require 'jekyll/podcast/podcast_data'
+require 'jekyll/podcast/validate_yaml_frontmatter'
+require 'jekyll/podcast/page_title_liquid_tag'

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-podcast
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- Nathan Bottomley
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-09-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: json-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: mp3info
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.5
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+description:
+email:
+- nathan.bottomley@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- jekyll-podcast.gemspec
+- lib/jekyll/podcast.rb
+- lib/jekyll/podcast/contributor_page_generator.rb
+- lib/jekyll/podcast/episode_data.rb
+- lib/jekyll/podcast/feed_generator.rb
+- lib/jekyll/podcast/file_exists.rb
+- lib/jekyll/podcast/liquid_tag_filters.rb
+- lib/jekyll/podcast/page_title_liquid_tag.rb
+- lib/jekyll/podcast/podcast.xml
+- lib/jekyll/podcast/podcast_data.rb
+- lib/jekyll/podcast/podcast_episode_drop.rb
+- lib/jekyll/podcast/tag_link_filter.rb
+- lib/jekyll/podcast/tag_page_generator.rb
+- lib/jekyll/podcast/utils.rb
+- lib/jekyll/podcast/validate_yaml_frontmatter.rb
+- lib/jekyll/podcast/version.rb
+homepage: https://github.com/furius95/jekyll-podcast
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/furius95/jekyll-podcast
+  source_code_uri: https://github.com/furius95/jekyll-podcast
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: A Jekyll plugin that provides some useful features for podcasting websites.
+test_files: []