datalog-theme 0.8.0 → 0.9.1

data/lib/datalog/plugins/comments.rb

@@ -19,16 +19,23 @@ module Datalog
       REQUIRED_FIELDS = {
         "giscus" => %w[repo repo_id category category_id],
         "utterances" => %w[repo],
-        "disqus" => %w[shortname]
+        "disqus" => %w[shortname],
+        "api" => []
       }.freeze
 
+      # The api provider's thread (components/comments-thread.html) is a Liquid
+      # include, so it shares the service forms' labels and states.
+      API_INCLUDE = "{% include components/comments-thread.html %}"
+
       def initialize(site, config = {})
         super
         @defaults = {
           "provider" => "giscus",
           "mapping" => "pathname",
           "theme" => "light",
-          "enabled_by_default" => false
+          "enabled_by_default" => false,
+          "replies" => true,
+          "moderation" => true
         }.merge(@config)
         @memo = {}
       end
@@ -67,9 +74,12 @@ module Datalog
         settings = @memo[key]
         return "" unless settings
 
+        embed = settings["embed"]
+        embed = render_api(context) if settings["provider"] == "api" && embed.to_s.empty?
+
         <<~HTML
           <div class="datalog-comments" aria-label="Comments">
-            #{settings['embed']}
+            #{embed}
           </div>
         HTML
       end
@@ -109,6 +119,8 @@ module Datalog
           render_utterances(settings)
         when "disqus"
           render_disqus(document, settings)
+        when "api"
+          "" # the thread is rendered by the tag, in its own context
         else
           %(<p class="datalog-comments-unsupported">Comments provider "#{settings['provider']}" is not supported.</p>)
         end
@@ -140,6 +152,12 @@ module Datalog
           async></script>)
       end
 
+      # The thread of the site's own backend (#253), rendered in the tag's own
+      # context so the include sees the page and the site.
+      def render_api(context)
+        Liquid::Template.parse(API_INCLUDE).render(context)
+      end
+
       def render_disqus(document, settings)
         shortname = settings["shortname"] || ""
         nonce = nonce_attribute(document)
@@ -171,10 +189,22 @@ module Datalog
       end
 
       def missing_required_fields(provider, settings)
+        return api_missing(settings) if provider.to_s == "api"
+
         required = REQUIRED_FIELDS.fetch(provider.to_s, [])
         required.select { |key| settings[key].to_s.strip.empty? }
       end
 
+      # The api provider needs a backend: its own endpoint, or the site's
+      # dynamic services (docs/dynamic-services.md).
+      def api_missing(settings)
+        services = site.config["dynamic_services"]
+        base = services.is_a?(Hash) ? services["base_url"].to_s.strip : ""
+        return [] unless settings["endpoint"].to_s.strip.empty? && base.empty?
+
+        ["endpoint (or dynamic_services.base_url)"]
+      end
+
       def logger
         Jekyll.logger
       end

data/lib/datalog/theme/installed_files.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+require "digest"
+require "fileutils"
+require "jekyll"
+require "json"
+require_relative "package"
+require_relative "repository_checkout"
+
+module Datalog
+  module Theme
+    # Stops a build that would serve a mix of theme versions. A site that uses
+    # the theme from a Git submodule or another checkout reads every theme file
+    # from it, but the script bundles are build output and have to be built
+    # again whenever the checkout moves. Any site can also hold copies of files
+    # the theme provides, left from copying the theme in by hand; a site's file
+    # takes the place of the theme's, and the copies fall behind on the next
+    # update.
+    module InstalledFiles
+      module_function
+
+      BUNDLE_SOURCES = "assets/js/dist/sources.json"
+      # Theme data a site has no reason to replace: the script manifest names
+      # the bundles this version of the theme ships, and the integrity hashes
+      # belong to the CDN files its layouts load. Translations are left out,
+      # since a site may change them.
+      DATA_FILES = %w[_data/js_manifest.json _data/cdn-integrity.yml].freeze
+
+      # Jekyll prints an error on one line, so the messages are written as
+      # sentences rather than laid out in lines.
+      def check_bundles(site)
+        return unless RepositoryCheckout.applies_to?(site)
+
+        root = site.theme.root
+        reasons = stale_bundle_reasons(root)
+        return if reasons.empty?
+
+        listed = reasons.first(5).join("; ")
+        listed += "; and #{reasons.size - 5} more" if reasons.size > 5
+        raise Jekyll::Errors::FatalException,
+              "The script bundles in #{File.join(root, 'assets', 'js', 'dist')} were not built from the theme " \
+              "files beside them (#{listed}). Pages would run scripts from another version of the theme. Build " \
+              "them again by running `npm ci && npm run build:js` in #{root}."
+      end
+
+      # scripts/build_js.mjs records a SHA-256 of each file it builds from.
+      def stale_bundle_reasons(root)
+        record = File.join(root, BUNDLE_SOURCES)
+        unless File.file?(record)
+          return ["#{BUNDLE_SOURCES} is missing: the bundles were never built, or built before it was recorded"]
+        end
+
+        JSON.parse(File.read(record)).fetch("sources").filter_map do |path, digest|
+          file = File.join(root, path)
+          if !File.file?(file)
+            "#{path} is gone"
+          elsif Digest::SHA256.file(file).hexdigest != digest
+            "#{path} has changed"
+          end
+        end
+      end
+
+      def check_site_copies(site)
+        theme = site.theme
+        return unless theme && theme.name == "datalog-theme"
+
+        copies = stale_asset_copies(site, theme.root) + stale_data_copies(site, theme.root)
+        return if copies.empty?
+
+        raise Jekyll::Errors::FatalException,
+              "Your site has its own copies of files datalog-theme provides, and they differ from the theme's: " \
+              "#{copies.join(', ')}. A site's file takes the place of the theme's, so pages would load scripts, " \
+              "or check their integrity, for another version of the theme. Delete these files: the theme " \
+              "provides them."
+      end
+
+      # The site's static files that stand in for theme files pages load. Jekyll
+      # leaves the theme's file out when the site has one at the same path.
+      def stale_asset_copies(site, root)
+        source = File.join(site.source, "")
+        site.static_files.filter_map do |file|
+          next unless file.path.start_with?(source)
+
+          relative = file.relative_path.delete_prefix("/")
+          next unless Package::SCRIPTS_PAGES_LOAD.any? { |entry| Package.inside?(relative, entry) }
+
+          theme_file = File.join(root, relative)
+          relative if File.file?(theme_file) && !FileUtils.identical?(file.path, theme_file)
+        end
+      end
+
+      def stale_data_copies(site, root)
+        reader = Jekyll::DataReader.new(site)
+        own = reader.read(site.config["data_dir"])
+        DATA_FILES.filter_map do |entry|
+          key = File.basename(entry, ".*")
+          theme_file = File.join(root, entry)
+          next unless own.key?(key) && File.file?(theme_file)
+          next if own[key] == reader.read_data_file(theme_file)
+
+          Dir.glob("#{key}.*", base: site.in_source_dir(site.config["data_dir"])).map do |name|
+            File.join(site.config["data_dir"], name)
+          end.first
+        end
+      end
+    end
+  end
+end
+
+Jekyll::Hooks.register :site, :post_read do |site|
+  Datalog::Theme::InstalledFiles.check_bundles(site)
+  Datalog::Theme::InstalledFiles.check_site_copies(site)
+end

data/lib/datalog/theme/repository_checkout.rb

@@ -54,9 +54,13 @@ module Datalog
         remove_demo_data(site)
       end
 
+      # A checkout also holds the script sources the bundles are built from,
+      # which no page loads. The site gets the theme assets the gem would give it.
       def remove_demo_assets(site)
-        demo_dirs = Package::DEMO_ASSETS.map { |entry| File.join(site.theme.root, entry, "") }
-        site.static_files.reject! { |file| demo_dirs.any? { |dir| file.path.start_with?(dir) } }
+        root = File.join(site.theme.root, "")
+        site.static_files.reject! do |file|
+          file.path.start_with?(root) && !Package.theme_file?(file.path.delete_prefix(root))
+        end
       end
 
       # site.data holds the theme's data with the site's merged over it. Each key

data/lib/datalog/theme/version.rb

@@ -2,6 +2,10 @@
 
 module Datalog
   module Theme
-    VERSION = "0.8.0" unless const_defined?(:VERSION)
+    VERSION = "0.9.1" unless const_defined?(:VERSION)
+    # The Ruby the gem installs on, for the gemspec and `datalog check`. The
+    # release workflow rewrites every quoted version assigned to a name ending
+    # in VERSION in this file, so this name must not end that way.
+    RUBY_REQUIREMENT = ">= 3.2" unless const_defined?(:RUBY_REQUIREMENT)
   end
 end

data/lib/datalog-theme.rb

@@ -36,3 +36,4 @@ end
 Datalog::Theme.load_plugins
 
 require_relative "datalog/theme/repository_checkout"
+require_relative "datalog/theme/installed_files"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: datalog-theme
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.1
 platform: ruby
 authors:
 - Diogo Ribeiro
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-09-15 00:00:00.000000000 Z
+date: 2026-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -206,26 +206,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.15'
-- !ruby/object:Gem::Dependency
-  name: mini_magick
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4.12'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4.12'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6'
 - !ruby/object:Gem::Dependency
   name: logger
   requirement: !ruby/object:Gem::Requirement
@@ -320,23 +300,43 @@ files:
 - _includes/components/academic-dashboard.html
 - _includes/components/api-function.html
 - _includes/components/author-bio.html
+- _includes/components/author-list.html
 - _includes/components/breadcrumbs.html
 - _includes/components/citation-tools.html
+- _includes/components/comments-thread.html
+- _includes/components/contact-form.html
 - _includes/components/content-provenance.html
+- _includes/components/correction-report.html
 - _includes/components/difficulty-badge.html
 - _includes/components/enhanced-code-block.html
 - _includes/components/enhanced-toc.html
 - _includes/components/hero.html
+- _includes/components/license-link.html
+- _includes/components/license-notice.html
 - _includes/components/math-fallback.html
+- _includes/components/moderation-inbox.html
 - _includes/components/open-science-badges.html
 - _includes/components/package-install.html
 - _includes/components/performance-monitor.html
 - _includes/components/post-hero.html
+- _includes/components/reactions.html
+- _includes/components/reading-list.html
+- _includes/components/reading-mode-toggle.html
+- _includes/components/reading-state-bookmark.html
+- _includes/components/reading-state-panel.html
+- _includes/components/reading-state-resume.html
+- _includes/components/reproducibility.html
 - _includes/components/responsive-image.html
+- _includes/components/revision-history.html
+- _includes/components/revision-notice.html
 - _includes/components/search-facets.html
+- _includes/components/series-nav.html
 - _includes/components/social-share.html
+- _includes/components/subscribe-form.html
+- _includes/components/subscription-manage.html
 - _includes/components/visualization-card.html
 - _includes/components/viz-table-fallback.html
+- _includes/components/webmentions.html
 - _includes/critical-css/default.html
 - _includes/critical-css/home.html
 - _includes/critical-css/post.html
@@ -350,10 +350,15 @@ files:
 - _includes/helpers/date-format.html
 - _includes/helpers/link-with-icon.html
 - _includes/layouts/default/article.html
+- _includes/meta/dynamic-services-config.html
 - _includes/meta/language-attributes.html
 - _includes/meta/math-config.html
+- _includes/meta/person-json.html
+- _includes/meta/publisher.html
 - _includes/meta/schema.html
+- _includes/meta/scholarly.html
 - _includes/meta/scripts-loader.html
+- _includes/meta/webmention-discovery.html
 - _includes/post/related-posts.html
 - _includes/scripts.html
 - _includes/search/index-data.json
@@ -371,7 +376,10 @@ files:
 - _layouts/project.html
 - _layouts/research.html
 - _plugins/analytics_dashboard.rb
+- _plugins/authors.rb
+- _plugins/citation_exports.rb
 - _plugins/config_validator.rb
+- _plugins/critical_css_check.rb
 - _plugins/csp_generator.rb
 - _plugins/datalog_bibliography.rb
 - _plugins/datalog_comments.rb
@@ -379,20 +387,29 @@ files:
 - _plugins/front_matter_compat.rb
 - _plugins/i18n.rb
 - _plugins/image_optimizer.rb
+- _plugins/licenses.rb
 - _plugins/math_preprocessor.rb
 - _plugins/notebook_converter.rb
 - _plugins/plugin_loader.rb
 - _plugins/publications_generator.rb
 - _plugins/reading_time.rb
+- _plugins/references.rb
+- _plugins/reproducibility.rb
+- _plugins/responsive_content.rb
+- _plugins/revisions.rb
 - _plugins/rouge_highlight_filter.rb
+- _plugins/scholarly.rb
 - _plugins/search_code_blocks.rb
 - _plugins/search_normalizer.rb
 - _plugins/search_pages.rb
+- _plugins/series.rb
 - _plugins/sri_filter.rb
+- _plugins/statements.rb
 - _plugins/toc_filter.rb
 - _plugins/warning_filter.rb
 - _sass/_academic-dashboard.scss
 - _sass/_base.scss
+- _sass/_comments-thread.scss
 - _sass/_components.scss
 - _sass/_features.scss
 - _sass/_font-fallbacks.scss
@@ -401,18 +418,25 @@ files:
 - _sass/_layout.scss
 - _sass/_mathematical.scss
 - _sass/_mixins.scss
+- _sass/_moderation.scss
 - _sass/_notebooks.scss
 - _sass/_open-science-badges.scss
 - _sass/_package-docs.scss
 - _sass/_post-components.scss
+- _sass/_print.scss
+- _sass/_reactions.scss
+- _sass/_reading-state.scss
 - _sass/_search-page.scss
 - _sass/_search.scss
+- _sass/_service-forms.scss
+- _sass/_subscriptions.scss
 - _sass/_syntax-highlighting.scss
 - _sass/_theme.scss
 - _sass/_typography.scss
 - _sass/_utilities.scss
 - _sass/_variables.scss
 - _sass/_visualizations.scss
+- _sass/_webmentions.scss
 - assets/css/main.scss
 - assets/img/favicons/android-chrome-192x192.png
 - assets/img/favicons/android-chrome-512x512.png
@@ -427,24 +451,37 @@ files:
 - assets/img/social-card.png
 - assets/js/dist/academic.js
 - assets/js/dist/analytics-dashboard.js
-- assets/js/dist/chunks/chunk-225H5YXE.js
+- assets/js/dist/chunks/chunk-PATLC23F.js
+- assets/js/dist/chunks/chunk-VZ5WKQVA.js
+- assets/js/dist/chunks/chunk-WIRUK3OZ.js
+- assets/js/dist/comments.js
+- assets/js/dist/contact.js
 - assets/js/dist/core.js
+- assets/js/dist/corrections.js
 - assets/js/dist/loader.js
 - assets/js/dist/math.js
+- assets/js/dist/moderation.js
 - assets/js/dist/notebook.js
+- assets/js/dist/reactions.js
+- assets/js/dist/reading-state.js
 - assets/js/dist/search.js
+- assets/js/dist/sources.json
+- assets/js/dist/subscriptions.js
 - assets/js/dist/visualizations.js
+- assets/js/dist/webmentions.js
 - assets/js/loader.js
 - bin/datalog
 - datalog-theme.gemspec
 - lib/datalog-theme.rb
 - lib/datalog/cli.rb
+- lib/datalog/critical_css.rb
 - lib/datalog/plugin_system.rb
 - lib/datalog/plugin_system/dependency_resolver.rb
 - lib/datalog/plugins/citations.rb
 - lib/datalog/plugins/comments.rb
 - lib/datalog/plugins/search.rb
 - lib/datalog/plugins/slides.rb
+- lib/datalog/theme/installed_files.rb
 - lib/datalog/theme/package.rb
 - lib/datalog/theme/repository_checkout.rb
 - lib/datalog/theme/version.rb

data/assets/js/dist/chunks/chunk-225H5YXE.js

@@ -1 +0,0 @@
-var f=Object.defineProperty;var d=Object.getOwnPropertySymbols;var g=Object.prototype.hasOwnProperty,h=Object.prototype.propertyIsEnumerable;var e=(c,a,b)=>a in c?f(c,a,{enumerable:!0,configurable:!0,writable:!0,value:b}):c[a]=b,i=(c,a)=>{for(var b in a||(a={}))g.call(a,b)&&e(c,b,a[b]);if(d)for(var b of d(a))h.call(a,b)&&e(c,b,a[b]);return c};export{i as a};