datalog-theme 0.7.0 → 0.9.0

data/lib/datalog/theme/repository_checkout.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require "jekyll"
+require_relative "package"
+
+module Datalog
+  module Theme
+    # A site that installs the theme from a Git checkout or a local path
+    # (`gem "datalog-theme", github: ...` or `path: ...`) gets the whole
+    # repository as its theme, and the repository is also the demo site. Jekyll
+    # merges the demo's _config.yml into the site's configuration, reads the
+    # demo's _data as theme data and copies the demo's downloads from assets/.
+    # The site then inherits the maintainer's name, contact addresses and social
+    # profiles, and jekyll-feed stops the build on a datasets feed for a
+    # collection the site does not have. The packaged gem contains none of those
+    # files; these hooks give a checkout the same contents.
+    module RepositoryCheckout
+      module_function
+
+      # The packaged gem ships no _config.yml, so one at the theme root means
+      # the theme is a copy of the repository.
+      def applies_to?(site)
+        theme = site.theme
+        !theme.nil? && theme.name == "datalog-theme" && File.file?(File.join(theme.root, "_config.yml"))
+      end
+
+      # Jekyll merges the theme configuration before any theme code runs, so it
+      # cannot be taken back out here: Jekyll's own `ignore_theme_config` switch
+      # is the only way to keep it out. A site that sets the switch to false has
+      # chosen to inherit the demo configuration.
+      def check_configuration(site)
+        return unless applies_to?(site)
+        return if site.config.key?("ignore_theme_config")
+
+        raise Jekyll::Errors::FatalException, <<~MESSAGE
+          datalog-theme is installed from a copy of its repository (#{site.theme.root}),
+          which is also the theme's demo site. Jekyll merges the demo's _config.yml into
+          your configuration, so your site would carry the demo's author, contact
+          addresses, social profiles and feeds.
+
+          Add this line to your _config.yml:
+
+            ignore_theme_config: true
+
+          The theme then also leaves out the demo's _data files and downloads. Set it to
+          false instead only if you mean to inherit the demo configuration.
+        MESSAGE
+      end
+
+      def remove_demo_content(site)
+        return unless applies_to?(site) && site.config["ignore_theme_config"] == true
+
+        remove_demo_assets(site)
+        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)
+        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
+      # the demo contributed goes back to the site's own value, or away.
+      def remove_demo_data(site)
+        theme_data_dir = File.join(site.theme.root, "_data")
+        return unless File.directory?(theme_data_dir)
+
+        demo_keys = Dir.children(theme_data_dir).map { |name| File.basename(name, ".*") } - Package.data_keys
+        return if demo_keys.empty?
+
+        own = Jekyll::DataReader.new(site).read(site.config["data_dir"])
+        demo_keys.each do |key|
+          if own.key?(key)
+            site.data[key] = own[key]
+          else
+            site.data.delete(key)
+          end
+        end
+      end
+    end
+  end
+end
+
+Jekyll::Hooks.register :site, :after_init do |site|
+  Datalog::Theme::RepositoryCheckout.check_configuration(site)
+end
+
+Jekyll::Hooks.register :site, :post_read do |site|
+  Datalog::Theme::RepositoryCheckout.remove_demo_content(site)
+end

data/lib/datalog/theme/version.rb

@@ -2,6 +2,10 @@
 
 module Datalog
   module Theme
-    VERSION = "0.7.0" unless const_defined?(:VERSION)
+    VERSION = "0.9.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.
+    RUBY_REQUIREMENT = ">= 3.2" unless const_defined?(:RUBY_REQUIREMENT)
   end
 end

data/lib/datalog/warning_filter.rb

@@ -1,13 +1,17 @@
 # frozen_string_literal: true
 
 module Datalog
+  # Silences two warnings that every build repeats. Kernel#warn reports through
+  # Warning.warn, so prepending here covers both. A Kernel#warn override used to
+  # sit alongside it, and it printed keyword arguments such as `uplevel:` and
+  # `category:` as a hash after the message instead of honouring them.
   module WarningFilter
     FILTERS = [
       /literal string will be frozen/,
       /already initialized constant Datalog::Theme::VERSION/
     ].freeze
 
-    def warn(message)
+    def warn(message, **options)
       return if FILTERS.any? { |pattern| pattern.match?(message) }
 
       super
@@ -16,13 +20,3 @@ module Datalog
 end
 
 Warning.singleton_class.prepend(Datalog::WarningFilter) if defined?(Warning)
-
-module Kernel
-  alias __datalog_warn warn
-
-  def warn(message = nil, *args)
-    return if message && Datalog::WarningFilter::FILTERS.any? { |pattern| pattern.match?(message) }
-
-    __datalog_warn(message, *args)
-  end
-end

data/lib/datalog-theme.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
 require_relative "datalog/theme/version"
+# The layouts render their page-independent includes with {% include_cached %},
+# which comes from jekyll-include-cache rather than Jekyll itself.
+require "jekyll-include-cache"
 
 module Datalog
   module Theme
@@ -31,3 +34,6 @@ module Datalog
 end
 
 Datalog::Theme.load_plugins
+
+require_relative "datalog/theme/repository_checkout"
+require_relative "datalog/theme/installed_files"