jekyll-octopod 0.20.1 → 0.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bab9d22951437197ea9b85735a898f4c6fe4582ee18eb942f63864cbe842c5b9
-  data.tar.gz: 9dee8614f7de17e484323d2ca79d84be23e798dc953a98abe9c2dfae592be4fb
+  metadata.gz: 24977665ce521eb079a357fb865df920bccd0fed95bddf6b33c28022305d58ce
+  data.tar.gz: 5b1626a963311fcdb716f95ad3251a6dd4901398988450ac87c266c9614e720c
 SHA512:
-  metadata.gz: 90483ebdbb7ba04b2dd8c0a5a196f75356224fb482488de2b030ae02ab975f513012ca718bbb52ee6c9404286b019c80a2fc3c509bc5ff7f37f042624be5d77b
-  data.tar.gz: 0fcaa3555178d41f5a30acf9c8fe1254bb59efc19213190e79a59c0b3a6921a61cfee5f29cc82a06287845dd448e0f276bd8aa2714a758e01c0de5a2c33ebb54
+  metadata.gz: 8318ee2181c3e65b494edb97f399c812b993ed8ccffe62c3b7ba58d016ff063d75725dcd25eb3174fce351943c35b983b77a46046715e6130e507efc34f34e6e
+  data.tar.gz: c85acaa2673dea3dedafdec6a84c8c3a19f2da26cb211fe7fbbd913efb93187f645ebad63aafedd442cd4be928276bfa93f67a07447d3ae75c1590827cbe350f

data/lib/jekyll/podlove_player_tag.rb

@@ -4,6 +4,11 @@ module Jekyll
   class PodlovePlayerTag < Liquid::Tag
     include Jekyll::OctopodFilters
 
+    # Every channel the player itself supports (per the config docs below) - sent unconditionally
+    # rather than exposed as a site/post setting, so the share tab always has something to offer
+    # instead of defaulting to the player's own empty channel list.
+    SHARE_CHANNELS = %w[twitter facebook whats-app linkedin pinterest xing mail link].freeze
+
     # From here: https://docs.podlove.org/podlove-web-player/v5/configuration
     def playerconfig(context)
       config = context.registers[:site].config
@@ -39,10 +44,79 @@ module Jekyll
         publicationDate: page["date"].respond_to?(:xmlschema) ? page["date"].xmlschema : page["date"].to_s,
         duration: page["duration"],
         audio: audio,
-        chapters: page["chapters"] ? page["chapters"].map { |chapter| split_chapter(chapter) }.compact : nil
+        chapters: page["chapters"] ? page["chapters"].map { |chapter| split_chapter(chapter) }.compact : nil,
+        transcripts: transcripts_for(page),
+        share: { channels: SHARE_CHANNELS }
       }.to_json
     end
 
+    # Finds a WebVTT transcript for this episode and parses it into the cue list Podlove Web
+    # Player's "transcripts" config field expects (see the same docs link above the config
+    # method: a plain list of { start, start_ms, end, end_ms, speaker, voice, text } cues - the
+    # player has no native understanding of WebVTT itself, so this is doing that conversion, not
+    # just passing the file through). Looks for an explicit page["transcript"] filename first,
+    # then falls back to the audio file's own basename with a .vtt extension (i.e.
+    # "episode1.mp3" -> "episode1.vtt"), resolved on disk the same way file_size() locates audio
+    # files: relative to the site root if the filename already contains a "/", otherwise under
+    # episodes/. Returns nil if there's no matching, parseable file, so the config field is
+    # simply omitted rather than sent empty.
+    def transcripts_for(page)
+      filename = page["transcript"] || vtt_sibling_of(page["audio"])
+      return nil unless filename
+
+      path = filename =~ /\// ? filename : File.join('episodes', filename)
+      return nil unless File.exist?(path)
+
+      cues = parse_vtt(File.read(path, encoding: 'UTF-8'))
+      cues.empty? ? nil : cues
+    end
+
+    def vtt_sibling_of(audio_hash)
+      return nil unless audio_hash
+      primary = audio(audio_hash)
+      return nil unless primary
+
+      primary.sub(/\.[^.\/]+\z/, '.vtt')
+    end
+
+    # Parses WebVTT cues, including Auphonic's "<v Speaker>text</v>" voice-tag convention. Not a
+    # full WebVTT implementation (no styling, regions, or nested tags) - just enough to turn
+    # timed, optionally speaker-tagged captions into Podlove's transcript-cue shape.
+    def parse_vtt(content)
+      content = content.sub(/\A\xEF\xBB\xBF/, '').gsub("\r\n", "\n")
+
+      content.split(/\n\n+/).filter_map do |block|
+        lines = block.strip.split("\n")
+        next nil if lines.empty?
+
+        # Discard the "WEBVTT" header, NOTE/STYLE/REGION blocks, and any cue identifier line -
+        # everything up to the "start --> end" timing line, which is left in place once found.
+        lines.shift while lines.first && !lines.first.include?('-->')
+        timing = lines.shift
+        next nil unless timing
+
+        match = timing.match(/((?:\d{2}:)?\d{2}:\d{2}\.\d{3})\s*-->\s*((?:\d{2}:)?\d{2}:\d{2}\.\d{3})/)
+        next nil unless match
+
+        text = lines.join(' ').strip
+        voice = text[/\A<v\s+([^>]+)>/, 1]
+        text = text.sub(/\A<v\s+[^>]+>/, '').sub(%r{</v>\z}, '').strip
+
+        { start: match[1], start_ms: ms_from_vtt_timestamp(match[1]),
+          end: match[2], end_ms: ms_from_vtt_timestamp(match[2]),
+          speaker: nil, voice: voice, text: text }
+      end
+    end
+
+    def ms_from_vtt_timestamp(timestamp)
+      parts = timestamp.split(':')
+      seconds, millis = parts.pop.split('.')
+      minutes = parts.pop.to_i
+      hours = parts.empty? ? 0 : parts.pop.to_i
+
+      (((hours * 60) + minutes) * 60 + seconds.to_i) * 1000 + millis.to_i
+    end
+
     def playerbaseconfig(context)
       config = context.registers[:site].config
       { version: 5, base: "#{config["url"]}/assets/podlove-player/" }.to_json

data/lib/octopod/version.rb

@@ -2,8 +2,8 @@ module Jekyll
   class Octopod
     module VERSION #:nodoc:
       MAJOR = 0
-      MINOR = 20
-      TINY  = 1
+      MINOR = 22
+      TINY  = 0
 
       STRING = [MAJOR, MINOR, TINY].join('.')
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-octopod
 version: !ruby/object:Gem::Version
-  version: 0.20.1
+  version: 0.22.0
 platform: ruby
 authors:
 - Arne Eilermann
@@ -105,7 +105,6 @@ extra_rdoc_files: []
 files:
 - README.md
 - Rakefile
-- assets/_config.yml
 - assets/_config.yml.sample
 - assets/_posts/2016-03-22-episode0.md
 - assets/_sass/_overrides.scss

data/assets/_config.yml

@@ -1,47 +0,0 @@
-# You have to configure this ###################################################
-title: Octopod
-# You should configure this ####################################################
-url: http://localhost:4000
-subtitle: Static Site Podcast Publishing for Geeks
-description: My super duper cool podcast.
-author: Uncle Octopod
-email: octopod@example.com
-keywords: [octopod, podcast, magic]
-itunes_categories: [Technology]
-# additional_feeds:
-#   itunes: http://itunes.apple.com/de/podcast/podcast_name/id42424242
-#   torrent_m4a: http://bitlove.org/example_user/example_podcast_m4a/feed
-#   torrent_mp3: http://bitlove.org/example_user/example_podcast_mp3/feed
-episodes_per_feed_page: 100
-## Rsync Deploy config #########################################################
-### Be sure your public key is listed in your server's ~/.ssh/authorized_keys
-### file.
-ssh_host: user@host.org
-ssh_port: 22
-document_root: /path/to/your/htdocs/
-rsync_delete: true
-# You can configure this #######################################################
-twitter_nick: my_twitter_handle
-language: en
-explicit: 'no'  # 'yes'/'no'/clean
-license: CC BY 4.0
-license_url: https://creativecommons.org/licenses/by/4.0/
-license_image_url: https://i.creativecommons.org/l/by/4.0/88x31.png
-## Flattr ######################################################################
-flattr_uid: # Flattr will not be used unless this is set
-flattr_button: compact # compact | default
-flattr_mode: auto # auto | manual(default)
-flattr_popout:  1 # 1 | 0 (show popout when hovering mouse over button)
-flattr_language: en_GB # available languages - https://api.flattr.com/rest/v2/languages.txt
-flattr_category: audio # available categories - https://api.flattr.com/rest/v2/categories.txt
-## Disqus comments #############################################################
-disqus_shortname: # Disqus will not be used unless this is set
-disqus_developer: 0 # 1 / 0
-## Feed links ###########################################################
-itunes_url: https://itunes.apple.com/at/podcast/myname/id#myid#
-bitlove_url: https://bitlove.org/myaccount
-fyyd_url: https://fyyd.de/podcast/myaccount/myid
-gpodder_url: https://gpodder.net/podcast/mypodcast
-
-gems: [jekyll-octopod]
-theme: jekyll-bootflat