jekyll-octopod 0.18.1 → 0.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9da6ebdac9915e6402bcda7c71a9c944ece4c004bd031220c733f49c3dfb47ec
-  data.tar.gz: b7052cf7e51011da39291849d35b14bedfa27caca156dd09a97c7957dee1ad3c
+  metadata.gz: af7f39feb92cfb4b4615bc3d7c4122cb463814e37bf8991c3c553784cfa06268
+  data.tar.gz: b0d6ebb6e48e8c476526dfb21934efc0ac773e528c48ce23464ee1afeade4e25
 SHA512:
-  metadata.gz: 2a054d404659a2434861da157840782ba71175259f8d5bd864da5f2369e599ad3fe69ae8aae7b6b547fa80d91d24de0682d9bf925b0329e19b3abdd849c5af78
-  data.tar.gz: 031da38de9086d544004abf870553125926d839186c6873cda4a00cab5e83161bdb973f95c3adcb1bc0798785d990bd79eb6bd1496db9bb5635ce7b371caaf2a
+  metadata.gz: 2ae85cc983a4661b5a6cf201cae6bd7c9708ee8c3a15d15134db3947b77ac3af65c0ca584523242f791706852bc3534a087f8eefc9b636543b9dede351a5baaf
+  data.tar.gz: 771baf577a1ed85e15db658bfa7c87e01890a5bffaf67708b2d4e5bbda029257cb9faa17421d7ef88627226b75328d329f844ade168b33c87839c3d6ad894dc6

data/assets/_config.yml

@@ -0,0 +1,47 @@
+# 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

data/assets/_config.yml.sample

@@ -9,9 +9,6 @@ subtitle: Static Site Podcast Publishing for Geeks
 description: My super duper cool podcast.
 author: Uncle Octopod
 
-### author_url: This is the URL of a site owned by the author (see https://jsonfeed.org/version/1)
-author_url: "http://your.fancy.hosting/"
-
 email: octopod@example.com
 keywords: [octopod, podcast, magic]
 itunes_categories: [Technology]
@@ -49,10 +46,6 @@ itunes_url: https://itunes.apple.com/at/podcast/myname/id232323
 #  torrent_m4a: http://bitlove.org/example_user/example_podcast_m4a/feed
 #  torrent_mp3: http://bitlove.org/example_user/example_podcast_mp3/feed
 
-### Disqus comments
-disqus_shortname: # Disqus will not be used unless this is set
-disqus_developer: 0 # 1 | 0
-
 ### Isso comments
 use_isso: "no" # "no" | "yes"
 

data/bin/octopod

@@ -120,7 +120,40 @@ def remove_theme_served_path(path)
     FileUtils.rmdir(path, verbose: true) if Dir.exist?(path) && Dir.empty?(path)
   elsif !path.end_with?('.md')
     FileUtils.rm(path, verbose: true)
+    # Clean up now-empty parent directories this file leaves behind (e.g. img/logo/ once every
+    # generic favicon file under it is gone), but never touch PWD itself and never remove a
+    # directory that still holds real, unrelated content (a site's own photos alongside the
+    # generic ones, say) - Dir.empty? guards that.
+    parent = File.dirname(path)
+    while parent != PWD && Dir.exist?(parent) && Dir.empty?(parent)
+      FileUtils.rmdir(parent, verbose: true)
+      parent = File.dirname(parent)
+    end
+  end
+end
+
+# 'now_theme_served' used to list '_layouts' and 'img' wholesale, on the assumption that a legacy
+# site's copies of those directories were 100% gem output. That's wrong whenever a site added its
+# own files alongside them - a custom '_layouts/presentation.html' with no gem equivalent, or real
+# content photos dropped into 'img/' - since a whole-directory delete has no way to tell those apart
+# from the generic files it's supposed to clean up. This instead lists the theme gem's *actual*
+# shipped filenames in those two directories, read from the installed jekyll-octopod-bulma gem
+# itself (same reasoning as the version-constraint lookup in update_gemfile_and_theme_config: read
+# from the gem so this can't drift out of sync as its shipped file list changes) - so 'update' only
+# ever removes a file that's actually theme content, and leaves anything else in place.
+def theme_shipped_generic_files
+  theme_gem_dir = begin
+    Gem::Specification.find_by_name('jekyll-octopod-bulma').gem_dir
+  rescue Gem::MissingSpecError
+    nil
   end
+  return [] unless theme_gem_dir
+
+  layouts = Dir.glob(File.join(theme_gem_dir, '_layouts', '*')).map { |f| "_layouts/#{File.basename(f)}" }
+  img = Dir.glob(File.join(theme_gem_dir, 'assets', 'img', '**', '*'), File::FNM_DOTMATCH)
+            .reject { |f| File.directory?(f) }
+            .map { |f| f.sub("#{theme_gem_dir}/assets/", '') }
+  layouts + img
 end
 
 # Points a site's Gemfile and _config.yml at jekyll-octopod-bulma instead of the old direct
@@ -371,8 +404,8 @@ if ARGV.size > 0 && (ARGV[0] == 'episode' || ARGV[0] == 'deploy' || ARGV[0] == '
     # point at it - so 'update' removes them outright, same "trust git diff, don't special-case"
     # philosophy as the rest of this command. Any '.md' file is kept no matter where it's found,
     # since that's real content, never theme boilerplate.
-    now_theme_served = %w[
-      _layouts podlove-player subscribe-button img favicon.ico apple-touch-icon-precomposed.png
+    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
     ]
@@ -387,6 +420,19 @@ 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) }
+      puts "===== ... done ===== ", ""
+    end
+
     puts "", "===== Pointing Gemfile/_config.yml at jekyll-octopod-bulma ... ====="
     update_gemfile_and_theme_config
     puts "===== ... done ===== ", ""

data/lib/jekyll/octopod_filters.rb

@@ -222,31 +222,6 @@ module Jekyll
       "@#{user}@#{uri.host}"
     end
 
-    # Generates the config for disqus integration
-    # If a page object is given, it generates the config variables only for this
-    # page. Otherwise it generate only the global config variables.
-    #
-    #   {{ site | disqus_config }}
-    #   {{ site | disqus_config:page }}
-    def disqus_config(site, page = nil)
-      if page
-        disqus_vars = {
-          'disqus_identifier'  => page['url'],
-          'disqus_url'         => "#{site['url']}#{page['url']}",
-          'disqus_category_id' => page['disqus_category_id'] || site['disqus_category_id'],
-          'disqus_title'       => j(page['title'] || site['site'])
-        }
-      else
-        disqus_vars = {
-          'disqus_developer'   => site['disqus_developer'],
-          'disqus_shortname'   => site['disqus_shortname']
-        }
-      end
-
-      disqus_vars.delete_if { |_, v| v.nil? }
-      disqus_vars.map { |k, v| "var #{k} = '#{v}';" }.compact.join("\n")
-    end
-
     # Returns the hex-encoded hash value of a given string. The optional
     # second argument defines the length of the returned string.
     #

data/lib/jekyll/update_config.rb

@@ -5,19 +5,14 @@ module Jekyll
       site.config.update(
         'episode_feed_formats' => feeds.map { |f| f.match(/episodes\.(\w{3,4})\.rss/)[1] }
       )
-      jsonfeeds = Dir["feed.{???,????}.json"]
-      site.config.update(
-        'json_feed_formats'    => jsonfeeds.map { |f| f.match(/feed\.(\w{3,4})\.json/)[1] }
-      )
 
-      # These marker files exist only so the scan above can detect which
-      # formats to generate; PagedFeedPageGenerator creates the actual pages
-      # at these exact paths. Excluding them here keeps Jekyll's normal
-      # reader from also turning them into pages, which would otherwise
+      # This marker file exists only so the scan above can detect which formats to generate;
+      # PagedFeedPageGenerator creates the actual pages at these exact paths. Excluding it here
+      # keeps Jekyll's normal reader from also turning it into a page, which would otherwise
       # collide with the generator's output at the same destination.
-      # site.exclude (not site.config['exclude']) is what Reader actually
-      # consults, and it's copied from config before this hook runs.
-      site.exclude += feeds + jsonfeeds
+      # site.exclude (not site.config['exclude']) is what Reader actually consults, and it's
+      # copied from config before this hook runs.
+      site.exclude += feeds
     end
   end
 end

data/lib/octopod/version.rb

@@ -2,8 +2,8 @@ module Jekyll
   class Octopod
     module VERSION #:nodoc:
       MAJOR = 0
-      MINOR = 18
-      TINY  = 1
+      MINOR = 20
+      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.18.1
+  version: 0.20.0
 platform: ruby
 authors:
 - Arne Eilermann
@@ -105,6 +105,7 @@ 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
@@ -114,9 +115,6 @@ files:
 - assets/episodes/episode0.m4a
 - assets/episodes/episode0.mp3
 - assets/episodes/episode0.ogg
-- assets/feed.m4a.json
-- assets/feed.mp3.json
-- assets/feed.ogg.json
 - assets/general_feed.xml
 - assets/imprint.md
 - assets/index.md

data/assets/feed.m4a.json

@@ -1,5 +0,0 @@
----
-layout: jsonfeed
-format: m4a
----
-{{ content }}

data/assets/feed.mp3.json

@@ -1,5 +0,0 @@
----
-layout: jsonfeed
-format: mp3
----
-{{ content }}

data/assets/feed.ogg.json

@@ -1,5 +0,0 @@
----
-layout: jsonfeed
-format: ogg
----
-{{ content }}