jekyll-octopod 0.20.0 → 0.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af7f39feb92cfb4b4615bc3d7c4122cb463814e37bf8991c3c553784cfa06268
-  data.tar.gz: b0d6ebb6e48e8c476526dfb21934efc0ac773e528c48ce23464ee1afeade4e25
+  metadata.gz: '08b3d44f4b48f6f493121d5d6bcd4708d4d82f54a386be9a79e8f4cf9df5aceb'
+  data.tar.gz: 518582535ee414dcc81f41ad540bf3242bd2fe339067d292733c7c3abe995ca9
 SHA512:
-  metadata.gz: 2ae85cc983a4661b5a6cf201cae6bd7c9708ee8c3a15d15134db3947b77ac3af65c0ca584523242f791706852bc3534a087f8eefc9b636543b9dede351a5baaf
-  data.tar.gz: 771baf577a1ed85e15db658bfa7c87e01890a5bffaf67708b2d4e5bbda029257cb9faa17421d7ef88627226b75328d329f844ade168b33c87839c3d6ad894dc6
+  metadata.gz: df52f5ac952f8ce2f4ae7089696183f519f93d0f43133e02011e1f66114c8b9b2e57b32d6da857b69439330af566b53693495f5c7ab733eee8a8e1e7e0d2c256
+  data.tar.gz: 61da23c9b801a3f33e011e97723c0dcb2a4d5de86cd15b0e3bdeb8f4cb3f5527eb93c1fc600aaabb6b7e24181b96a223b277c05cc06bc48422a07dc4551b4c47

data/bin/octopod

@@ -407,7 +407,7 @@ if ARGV.size > 0 && (ARGV[0] == 'episode' || ARGV[0] == 'deploy' || ARGV[0] == '
     now_theme_served = theme_shipped_generic_files + %w[
       podlove-player subscribe-button favicon.ico apple-touch-icon-precomposed.png
       _includes/sidebar.html _includes/post_header.html _includes/post.html _includes/post_line.html
-      _includes/disqus_thread.html _includes/disqus_count.html _includes/isso_thread.html
+      _includes/isso_thread.html
     ]
     found_theme_served = now_theme_served.select { |path| File.exist?(File.join(PWD, path)) }
 
@@ -420,16 +420,20 @@ if ARGV.size > 0 && (ARGV[0] == 'episode' || ARGV[0] == 'deploy' || ARGV[0] == '
       puts "===== ... done ===== ", ""
     end
 
-    # As of jekyll-octopod 0.19.0, JSON Feed support is gone outright - not moved to the theme
-    # gem, just removed (no real podcast client ever consumed it, and a since-fixed bug in this
-    # gem's own :after_init hook meant it silently never even built). Any 'feed.*.json' marker
-    # file left over from an older site is now genuinely dead: nothing generates its content, and
-    # jekyll-octopod-bulma's sidebar no longer links to it. Removed the same way theme-served
-    # files are removed above.
-    found_json_feeds = Dir.glob(File.join(PWD, 'feed.*.json'))
-    unless found_json_feeds.empty?
-      puts "", "===== Removing feed.*.json marker files (JSON Feed support was removed) ====="
-      found_json_feeds.each { |path| remove_theme_served_path(path) }
+    # As of jekyll-octopod 0.19.0/0.20.0, JSON Feed and Disqus support are gone outright - not
+    # moved to the theme gem the way the paths above were, just removed. JSON Feed: no real
+    # podcast client ever consumed it, and a since-fixed bug in this gem's own :after_init hook
+    # meant it silently never even built. Disqus: unused across every site in this gem's own
+    # family (none had disqus_shortname set) and superseded by Isso for self-hosted comments. Any
+    # leftover 'feed.*.json' marker file or local copy of the old disqus includes is now genuinely
+    # dead - nothing generates or serves it any more. Removed the same way theme-served files are
+    # removed above.
+    removed_feature_paths = Dir.glob(File.join(PWD, 'feed.*.json')) +
+      %w[_includes/disqus_thread.html _includes/disqus_count.html]
+        .map { |path| File.join(PWD, path) }.select { |path| File.exist?(path) }
+    unless removed_feature_paths.empty?
+      puts "", "===== Removing files for features that were removed entirely (JSON Feed, Disqus) ====="
+      removed_feature_paths.each { |path| remove_theme_served_path(path) }
       puts "===== ... done ===== ", ""
     end
 

data/lib/jekyll/podlove_player_tag.rb

@@ -39,10 +39,78 @@ 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)
       }.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,7 +2,7 @@ module Jekyll
   class Octopod
     module VERSION #:nodoc:
       MAJOR = 0
-      MINOR = 20
+      MINOR = 21
       TINY  = 0
 
       STRING = [MAJOR, MINOR, TINY].join('.')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-octopod
 version: !ruby/object:Gem::Version
-  version: 0.20.0
+  version: 0.21.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