datalog-theme 0.10.1 → 0.11.0

data/lib/datalog/theme/updater.rb

@@ -0,0 +1,307 @@
+# frozen_string_literal: true
+
+require "bundler"
+require "fileutils"
+require "json"
+require "open3"
+require "pathname"
+require "shellwords"
+require "tmpdir"
+require "yaml"
+require_relative "../site_config"
+
+module Datalog
+  module Theme
+    # Runs an upgrade from either a published gem or a path-installed checkout.
+    # A checkout is moved only after its worktree and target tag are checked.
+    class Updater
+      class Error < StandardError; end
+
+      COPY_FILES = %w[assets/js/loader.js _data/js_manifest.json _data/cdn-integrity.yml].freeze
+      CONFIG_DIRS = %w[layouts_dir includes_dir plugins_dir].freeze
+
+      def initialize(root:, options:, report:, execute:, available:)
+        @root = File.expand_path(root)
+        @options = options
+        @report = report
+        @execute = execute
+        @available = available
+      end
+
+      def run
+        theme = checkout_path
+        return update_gem unless theme
+
+        update_checkout(theme)
+      end
+
+      private
+
+      def report(message)
+        @report.call(message)
+      end
+
+      def checkout_path
+        gemfile = File.join(@root, "Gemfile")
+        return unless File.file?(gemfile)
+
+        definition = Bundler::Dsl.evaluate(gemfile, File.join(@root, "Gemfile.lock"), {})
+        dependency = definition.dependencies.find { |item| item.name == "datalog-theme" }
+        source = dependency&.source
+        return unless source.is_a?(Bundler::Source::Path)
+
+        path = File.expand_path(source.path.to_s, @root)
+        return path if File.exist?(File.join(path, ".git")) && git("rev-parse", "--show-toplevel", dir: path) == path
+
+        nil
+      rescue Bundler::BundlerError => e
+        raise Error, "Cannot read the site's Gemfile: #{e.message}"
+      end
+
+      def update_checkout(theme)
+        current = current_tag(theme)
+        raise Error, "Theme checkout is not at a release tag; check out one before updating" unless current
+        unless git("status", "--porcelain", dir: theme).empty?
+          raise Error, "Theme checkout has local changes; commit or discard them first"
+        end
+
+        tags = available_tags(theme)
+        target = choose_tag(tags, current)
+        newer = tags.select { |tag| version(tag) > version(current) }.sort_by { |tag| version(tag) }
+        report("Releases after #{current}: #{newer.join(', ')}") unless newer.empty?
+        if target == current && !submodule_needs_stage?(theme)
+          report("DataLog theme is already at #{current}.")
+          return check_current(theme)
+        end
+
+        report("Update #{theme} from #{current} to #{target}.")
+        if @options[:dry_run]
+          report("Dry run: fetch tags, check out #{target}, build bundles, install gems, " \
+                 "check the site and stage the submodule.")
+          return 0
+        end
+
+        raise Error, "npm is required to build a path-installed theme" unless @available.call("npm")
+
+        git("fetch", "--tags", "origin", dir: theme) if remote?(theme)
+        git("checkout", "--detach", target, dir: theme)
+        run!("npm ci", theme)
+        run!("npm run build:js", theme)
+        run!("bundle install", @root)
+        changelog(File.join(theme, "CHANGELOG.md"), current, target)
+        check_site!(theme)
+        build_site if @options[:build]
+        stage_submodule(theme, target)
+        report("Theme updated to #{target}. Review the changes before committing; nothing was committed or pushed.")
+        2
+      end
+
+      # Already at the release asked for, the checkout still has to be one a
+      # site can build from: its bundles are rebuilt when they were never built
+      # or were built from other sources, the site gets the same checks as after
+      # an update, and --build builds it. Nothing changes the release, so the
+      # answer stays 0, "already current".
+      def check_current(theme)
+        require_relative "installed_files"
+        stale = InstalledFiles.stale_bundle_reasons(theme)
+        if @options[:dry_run]
+          report("Dry run: rebuild the theme bundles (#{stale.first}).") unless stale.empty?
+          report("Dry run: check the site#{' and build it' if @options[:build]}.")
+          return 0
+        end
+
+        unless stale.empty?
+          raise Error, "npm is required to build a path-installed theme" unless @available.call("npm")
+
+          report("The theme's bundles need building: #{stale.first}.")
+          run!("npm ci", theme)
+          run!("npm run build:js", theme)
+        end
+        check_site!(theme)
+        build_site if @options[:build]
+        0
+      end
+
+      def check_site!(theme)
+        issues = preflight(theme)
+        return if issues.empty?
+
+        issues.each { |issue| report("Check: #{issue}") }
+        raise Error, "Resolve the #{issues.size} site check(s) above before building"
+      end
+
+      def update_gem
+        if @options[:to] && @options[:to] != "latest"
+          raise Error, "--to with a version requires a path-installed Git checkout"
+        end
+
+        gemfile = File.join(@root, "Gemfile")
+        before = locked_version
+        if File.file?(gemfile)
+          run!("bundle update datalog-theme", @root, "Bundler could not update datalog-theme.")
+        else
+          report("No Gemfile detected—skipping Bundler update")
+        end
+        update_site_npm
+        return 0 if @options[:dry_run]
+
+        after = locked_version
+        changelog(gem_changelog, "v#{before}", "v#{after}") if before && after && before != after
+        build_site if @options[:build]
+        report("Theme dependencies are up to date!")
+        before && after && before != after ? 2 : 0
+      end
+
+      def update_site_npm
+        return unless File.file?(File.join(@root, "package.json"))
+
+        if @available.call("npm")
+          run!("npm install", @root, "npm could not install the site's packages.")
+        else
+          report("Node.js tooling not available—skipping npm install")
+        end
+      end
+
+      def run!(command, dir, error = "#{command} failed")
+        report(@options[:dry_run] ? "Would run #{command} in #{dir}" : "Running #{command} in #{dir}")
+        return if @options[:dry_run]
+
+        env = command.start_with?("bundle ") ? { "BUNDLE_GEMFILE" => File.join(@root, "Gemfile") } : {}
+        return if @execute.call(env, command, dir)
+
+        raise Error, error
+      end
+
+      def build_site
+        Dir.mktmpdir("datalog-update-build") do |destination|
+          command = "bundle exec jekyll build --disable-disk-cache --destination #{Shellwords.escape(destination)}"
+          run!(command, @root, "The site build failed after updating the theme")
+        end
+      end
+
+      def available_tags(theme)
+        local = git("tag", "--list", dir: theme).lines.map(&:strip)
+        remote = if remote?(theme)
+                   git("ls-remote", "--refs", "--tags", "origin", dir: theme).lines.map do |line|
+                     line.split("refs/tags/").last&.strip
+                   end
+                 else
+                   []
+                 end
+        (local + remote).compact.uniq.select { |tag| version(tag) }
+      end
+
+      def choose_tag(tags, current)
+        requested = @options[:to] || "latest"
+        stable = tags.reject { |tag| version(tag).prerelease? }
+        target = requested == "latest" ? stable.max_by { |tag| version(tag) } : requested
+        raise Error, "Release tag #{requested.inspect} was not found" unless target && tags.include?(target)
+        if version(target) < version(current)
+          raise Error, "#{target} is older than #{current}; an update cannot downgrade the theme"
+        end
+
+        target
+      end
+
+      def current_tag(theme)
+        tags = git("tag", "--points-at", "HEAD", dir: theme).lines.map(&:strip)
+        tags.select { |tag| version(tag) }.max_by { |tag| version(tag) }
+      end
+
+      def version(tag)
+        value = tag.to_s.delete_prefix("v")
+        Gem::Version.new(value) if tag.to_s.start_with?("v") && Gem::Version.correct?(value)
+      end
+
+      def remote?(theme)
+        !git("remote", "get-url", "origin", dir: theme, optional: true).nil?
+      end
+
+      def git(*args, dir:, optional: false)
+        output, error, status = Open3.capture3("git", "-C", dir, *args)
+        return output.strip if status.success?
+        return if optional
+
+        raise Error, "git #{args.join(' ')} failed in #{dir}: #{error.strip}"
+      end
+
+      def stage_submodule(theme, target)
+        relative = Pathname.new(theme).relative_path_from(Pathname.new(@root)).to_s
+        tracked = git("ls-files", "--stage", "--", relative, dir: @root, optional: true).to_s
+        if tracked.start_with?("160000 ")
+          git("add", "--", relative, dir: @root)
+          report("Staged submodule #{relative}. Commit it when ready: " \
+                 "git commit -m \"Update the DataLog theme to #{target}\"")
+        else
+          report("Theme checkout is not a tracked submodule; stage its pointer in your site repository yourself.")
+        end
+      end
+
+      def submodule_needs_stage?(theme)
+        relative = Pathname.new(theme).relative_path_from(Pathname.new(@root)).to_s
+        tracked = git("ls-files", "--stage", "--", relative, dir: @root, optional: true).to_s
+        tracked.start_with?("160000 ") && tracked.split[1] != git("rev-parse", "HEAD", dir: theme)
+      end
+
+      def locked_version
+        file = File.join(@root, "Gemfile.lock")
+        return unless File.file?(file)
+
+        Bundler::LockfileParser.new(Bundler.read_file(file)).specs.find { |spec| spec.name == "datalog-theme" }&.version
+      end
+
+      def gem_changelog
+        output, = Open3.capture2({ "BUNDLE_GEMFILE" => File.join(@root, "Gemfile") },
+                                 "bundle", "info", "--path", "datalog-theme", chdir: @root)
+        File.join(output.strip, "CHANGELOG.md")
+      rescue Errno::ENOENT
+        nil
+      end
+
+      def changelog(file, from, to)
+        return unless file && File.file?(file)
+
+        File.read(file).scan(/^## \[([^\]]+)\][^\n]*\n(.*?)(?=^## \[|\z)/m).reverse_each do |name, body|
+          next unless version("v#{name}") && version("v#{name}") > version(from) && version("v#{name}") <= version(to)
+
+          body.scan(/^### (Removed|Changed|Deprecated)\s*\n(.*?)(?=^### |\z)/m) do |heading, contents|
+            report("#{name} — #{heading}\n#{contents.strip}")
+          end
+        end
+      end
+
+      def preflight(theme)
+        require_relative "installed_files"
+        config = SiteConfig.load(File.join(@root, "_config.yml"))
+        issues = InstalledFiles.stale_bundle_reasons(theme)
+        issues.concat(stale_copies(theme))
+        CONFIG_DIRS.each do |key|
+          issues << "#{key} points into the theme checkout" if points_into_theme?(config[key], theme)
+        end
+        sass = config["sass"].is_a?(Hash) ? config["sass"]["sass_dir"] : nil
+        issues << "sass.sass_dir points into the theme checkout" if points_into_theme?(sass, theme)
+        issues
+      end
+
+      def points_into_theme?(value, theme)
+        return false unless value.is_a?(String) && !value.empty?
+
+        path = File.expand_path(value, @root)
+        path == theme || path.start_with?("#{theme}#{File::SEPARATOR}")
+      end
+
+      def stale_copies(theme)
+        files = COPY_FILES + Dir.glob("assets/js/dist/**/*", base: theme).select do |path|
+          File.file?(File.join(theme, path))
+        end
+        files.filter_map do |relative|
+          own = File.join(@root, relative)
+          source = File.join(theme, relative)
+          next unless File.file?(source) && File.file?(own)
+
+          "#{relative} differs from the theme's file" unless FileUtils.compare_file(own, source)
+        end
+      end
+    end
+  end
+end

data/lib/datalog/theme/version.rb

@@ -2,7 +2,7 @@
 
 module Datalog
   module Theme
-    VERSION = "0.10.1" unless const_defined?(:VERSION)
+    VERSION = "0.11.0" 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.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: datalog-theme
 version: !ruby/object:Gem::Version
-  version: 0.10.1
+  version: 0.11.0
 platform: ruby
 authors:
 - Diogo Ribeiro
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-09-22 00:00:00.000000000 Z
+date: 2026-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -308,7 +308,6 @@ files:
 - _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
@@ -316,9 +315,10 @@ files:
 - _includes/components/math-fallback.html
 - _includes/components/moderation-inbox.html
 - _includes/components/open-science-badges.html
+- _includes/components/package-index.html
 - _includes/components/package-install.html
-- _includes/components/performance-monitor.html
 - _includes/components/post-hero.html
+- _includes/components/post-list.html
 - _includes/components/reactions.html
 - _includes/components/reading-list.html
 - _includes/components/reading-mode-toggle.html
@@ -334,7 +334,6 @@ files:
 - _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
@@ -349,9 +348,11 @@ files:
 - _includes/helpers/date-format.html
 - _includes/helpers/link-with-icon.html
 - _includes/layouts/default/article.html
+- _includes/meta/dataset-json.html
 - _includes/meta/dynamic-services-config.html
 - _includes/meta/language-attributes.html
 - _includes/meta/math-config.html
+- _includes/meta/package-json.html
 - _includes/meta/person-json.html
 - _includes/meta/publisher.html
 - _includes/meta/schema.html
@@ -364,8 +365,10 @@ files:
 - _includes/search/page.html
 - _includes/skip-link.html
 - _includes/toc.html
+- _layouts/archive.html
 - _layouts/dataset.html
 - _layouts/default.html
+- _layouts/docs.html
 - _layouts/home.html
 - _layouts/notebook.html
 - _layouts/package.html
@@ -375,12 +378,13 @@ files:
 - _layouts/project.html
 - _layouts/research.html
 - _plugins/analytics_dashboard.rb
+- _plugins/archive.rb
 - _plugins/authors.rb
 - _plugins/citation_exports.rb
 - _plugins/config_validator.rb
+- _plugins/correction_fallback.rb
 - _plugins/critical_css_check.rb
 - _plugins/csp_generator.rb
-- _plugins/datalog_bibliography.rb
 - _plugins/datalog_comments.rb
 - _plugins/datalog_slides.rb
 - _plugins/front_matter_compat.rb
@@ -390,10 +394,13 @@ files:
 - _plugins/licenses.rb
 - _plugins/math_preprocessor.rb
 - _plugins/notebook_converter.rb
+- _plugins/packages.rb
+- _plugins/page_dates.rb
 - _plugins/plugin_loader.rb
 - _plugins/publications_generator.rb
 - _plugins/reading_time.rb
 - _plugins/references.rb
+- _plugins/related_posts.rb
 - _plugins/reproducibility.rb
 - _plugins/responsive_content.rb
 - _plugins/revisions.rb
@@ -402,7 +409,10 @@ files:
 - _plugins/search_code_blocks.rb
 - _plugins/search_normalizer.rb
 - _plugins/search_pages.rb
+- _plugins/search_sections.rb
 - _plugins/series.rb
+- _plugins/site_identity.rb
+- _plugins/social_cards.rb
 - _plugins/sri_filter.rb
 - _plugins/statements.rb
 - _plugins/toc_filter.rb
@@ -411,6 +421,7 @@ files:
 - _sass/_base.scss
 - _sass/_comments-thread.scss
 - _sass/_components.scss
+- _sass/_docs.scss
 - _sass/_features.scss
 - _sass/_font-fallbacks.scss
 - _sass/_header.scss
@@ -452,8 +463,8 @@ files:
 - assets/js/dist/academic.js
 - assets/js/dist/analytics-dashboard.js
 - assets/js/dist/chunks/chunk-PATLC23F.js
+- assets/js/dist/chunks/chunk-TNVD6UAM.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
@@ -473,18 +484,44 @@ files:
 - bin/datalog
 - datalog-theme.gemspec
 - lib/datalog-theme.rb
+- lib/datalog/audit.rb
+- lib/datalog/audit/checks.rb
+- lib/datalog/audit/known_keys.rb
+- lib/datalog/audit/site_reader.rb
+- lib/datalog/audit/source_file.rb
+- lib/datalog/citations/bibtex.rb
+- lib/datalog/citations/entry.rb
+- lib/datalog/citations/markup.rb
 - lib/datalog/cli.rb
 - lib/datalog/critical_css.rb
+- lib/datalog/latex_speech.rb
+- lib/datalog/latex_speech/words.json
+- lib/datalog/packages.rb
+- lib/datalog/packages/command.rb
+- lib/datalog/packages/refresh.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/site_config.rb
 - lib/datalog/slug.rb
+- lib/datalog/social_cards.rb
+- lib/datalog/social_cards/font.rb
+- lib/datalog/social_cards/fonts/IBMPlexSans-Regular.ttf
+- lib/datalog/social_cards/fonts/IBMPlexSerif-SemiBold.ttf
+- lib/datalog/social_cards/fonts/OFL.txt
+- lib/datalog/social_cards/geometry.rb
+- lib/datalog/social_cards/outline.rb
+- lib/datalog/social_cards/plain_text.rb
+- lib/datalog/social_cards/template.rb
+- lib/datalog/social_cards/template.svg
+- lib/datalog/social_cards/typesetter.rb
 - lib/datalog/theme/installed_files.rb
 - lib/datalog/theme/package.rb
 - lib/datalog/theme/repository_checkout.rb
+- lib/datalog/theme/updater.rb
 - lib/datalog/theme/version.rb
 - lib/datalog/warning_filter.rb
 homepage: https://github.com/DiogoRibeiro7/analytics-blog-jekyll