al_comments 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8582e0b0a66b49c71cafbf872b834a2154e5221f8dc1520aac1b34b0e3fbbf8
-  data.tar.gz: 0fb8762fba4a9e91594be452e2584ff47726d9c41b5aeea8b91ccce4bf9f52a5
+  metadata.gz: b21be4d1edaba6ece5ead7b8a4a367d44f8931ba71e789923d5420a3edc88958
+  data.tar.gz: 378e2a1016b2e1775665ab3ff6ade1bf21fd4cc9c37ba24d31efcba5f7b56ae1
 SHA512:
-  metadata.gz: 8cd9477e85aecc152ac1ef75dd40d6663de2ff54835d41b435128893752f1d45586481a443ed07898adc66813207747b365ee0e73021b591a5067c916097ad0f
-  data.tar.gz: 9d66f7bfd9f311fa5dfe9811a65329b3817f4ab7d6c6184352bae96e5fe5c05db95b4b5c06e775e90fe92b5d4aa92fb3b682b241fa4a2f03374317daa84ca956
+  metadata.gz: 458b7d6f979287163ccdc1ee7a59be3d8989aace5cf526bb6826809e4a0fbacba2e9255f8796d4045eb703dc9a7982e4454109b30f377171b93da38b2def58d1
+  data.tar.gz: 3eb9b4fc9c64fc6414d5411635503a37ee8fff72edcc8d9e26498f4eb5959874f5d435fc450fcbabb9b7503cda215e772f579aef559af6a678d94c959a8948a8

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## 0.1.2 - 2026-02-07
+- Aligned giscus activation behavior with al-folio main branch expectations:
+  - Removed fallback from `site.repository` / `site.github.repository_nwo` to avoid partially configured giscus injection.
+  - Requires `repo`, `repo_id`, `category`, and `category_id` before loading giscus client script.
+  - Shows theme-side warning with missing required keys when configuration is incomplete.
+- Expanded tests for incomplete giscus config handling.
+
+## 0.1.1 - 2026-02-07
+- Improved config compatibility for comment rendering:
+  - Supports both string and symbol keys for nested config values.
+  - Supports `disqus.shortname` in addition to `disqus_shortname`.
+  - Supports `giscus.repo` aliases and fallback from `repository` / `github.repository_nwo`.
+  - Accepts common truthy flag values (`1`, `yes`, `on`) for `*_comments`.
+- Added automated tests for Giscus/Disqus rendering paths and config fallbacks.
+
 ## 0.1.0 - 2026-02-07
 - Initial gem release.
 - Added standalone Giscus/Disqus comment rendering tag for Jekyll/al-folio sites.

data/lib/al_comments.rb

@@ -9,12 +9,13 @@ module AlComments
 
       page = context.registers[:page] || context['page'] || {}
       output = []
+      disqus_shortname = resolve_disqus_shortname(site)
 
-      if site.config['disqus_shortname'] && truthy?(page['disqus_comments'])
-        output << disqus_html(site, page)
+      if disqus_shortname && truthy?(fetch_key(page, 'disqus_comments'))
+        output << disqus_html(site, page, disqus_shortname)
       end
 
-      if truthy?(page['giscus_comments'])
+      if truthy?(fetch_key(page, 'giscus_comments'))
         output << giscus_html(site, page)
       end
 
@@ -24,20 +25,108 @@ module AlComments
     private
 
     def truthy?(value)
-      value == true || value.to_s == 'true'
+      return false if value.nil? || value == false
+      return true if value == true
+      return true if value.is_a?(Numeric) && value != 0
+
+      normalized = value.to_s.strip.downcase
+      %w[true 1 yes y on].include?(normalized)
     end
 
     def post_layout?(page)
-      page['layout'].to_s == 'post'
+      fetch_key(page, 'layout').to_s == 'post'
+    end
+
+    def fetch_key(hash, *keys)
+      return nil unless hash.respond_to?(:key?)
+
+      keys.each do |key|
+        return hash[key] if hash.key?(key)
+
+        string_key = key.to_s
+        return hash[string_key] if hash.key?(string_key)
+
+        symbol_key = key.respond_to?(:to_sym) ? key.to_sym : nil
+        return hash[symbol_key] if symbol_key && hash.key?(symbol_key)
+      end
+
+      nil
     end
 
-    def disqus_html(site, page)
+    def value_blank?(value)
+      value.nil? || value.to_s.strip.empty?
+    end
+
+    def resolve_disqus_shortname(site)
+      direct = fetch_key(site.config, 'disqus_shortname')
+      return direct.to_s unless value_blank?(direct)
+
+      disqus = fetch_key(site.config, 'disqus')
+      return nil unless disqus.is_a?(Hash)
+
+      nested = fetch_key(disqus, 'shortname')
+      return nil if value_blank?(nested)
+
+      nested.to_s
+    end
+
+    def resolve_giscus_config(site)
+      giscus = fetch_key(site.config, 'giscus')
+      return giscus if giscus.is_a?(Hash)
+
+      comments = fetch_key(site.config, 'comments')
+      return {} unless comments.is_a?(Hash)
+
+      nested = fetch_key(comments, 'giscus')
+      nested.is_a?(Hash) ? nested : {}
+    end
+
+    def resolve_giscus_repo(_site, giscus)
+      repo = fetch_key(giscus, 'repo', 'repository', 'repo_name')
+      return '' if value_blank?(repo)
+
+      repo.to_s
+    end
+
+    def missing_giscus_fields(giscus, repo)
+      required = {
+        'repo' => repo,
+        'repo_id' => fetch_key(giscus, 'repo_id'),
+        'category' => fetch_key(giscus, 'category'),
+        'category_id' => fetch_key(giscus, 'category_id')
+      }
+
+      required.each_with_object([]) do |(name, value), missing|
+        missing << name if value_blank?(value)
+      end
+    end
+
+    def giscus_warning_html(style, spacer, missing_fields)
+      details = if missing_fields.empty?
+                  ''
+                else
+                  "<p>Missing required keys: <code>#{missing_fields.join(', ')}</code>.</p>"
+                end
+
+      warning = <<~HTML
+        <blockquote class="block-danger">
+          <h5>giscus comments misconfigured</h5>
+          <p>Please follow instructions at <a href="http://giscus.app">http://giscus.app</a> and update your giscus configuration.</p>
+          #{details}
+        </blockquote>
+      HTML
+
+      %(<div id="giscus_thread"#{style}>#{spacer}\n#{warning}</div>)
+    end
+
+    def disqus_html(site, page, disqus_shortname)
+      max_width = fetch_key(site.config, 'max_width')
       <<~HTML
-        <div id="disqus_thread" style="max-width: #{site.config['max_width']}; margin: 0 auto;">
+        <div id="disqus_thread" style="max-width: #{max_width}; margin: 0 auto;">
           <script type="text/javascript">
-            var disqus_shortname  = #{site.config['disqus_shortname'].to_json};
-            var disqus_identifier = #{page['id'].to_s.to_json};
-            var disqus_title      = #{page['title'].to_s.to_json};
+            var disqus_shortname  = #{disqus_shortname.to_json};
+            var disqus_identifier = #{fetch_key(page, 'id').to_s.to_json};
+            var disqus_title      = #{fetch_key(page, 'title').to_s.to_json};
             (function() {
               var dsq = document.createElement('script');
               dsq.type = 'text/javascript';
@@ -55,17 +144,15 @@ module AlComments
     end
 
     def giscus_html(site, page)
-      giscus = site.config['giscus'] || {}
-      style = post_layout?(page) ? " style=\"max-width: #{site.config['max_width']}; margin: 0 auto;\"" : ''
+      giscus = resolve_giscus_config(site)
+      repo = resolve_giscus_repo(site, giscus)
+      max_width = fetch_key(site.config, 'max_width')
+      style = post_layout?(page) ? " style=\"max-width: #{max_width}; margin: 0 auto;\"" : ''
       spacer = post_layout?(page) ? "\n  <br>" : ''
+      missing_fields = missing_giscus_fields(giscus, repo)
 
-      if giscus['repo'].to_s.strip.empty?
-        warning = <<~MARKDOWN
-          > ##### giscus comments misconfigured
-          > Please follow instructions at [http://giscus.app](http://giscus.app) and update your giscus configuration.
-          {: .block-danger }
-        MARKDOWN
-        return %(<div id="giscus_thread"#{style}>#{spacer}\n#{Jekyll::Converters::Markdown.new(site.config).convert(warning)}</div>)
+      unless missing_fields.empty?
+        return giscus_warning_html(style, spacer, missing_fields)
       end
 
       <<~HTML
@@ -79,17 +166,17 @@ module AlComments
               var giscusTheme = determineGiscusTheme();
               var attrs = {
                 src: "https://giscus.app/client.js",
-                "data-repo": #{giscus['repo'].to_s.to_json},
-                "data-repo-id": #{giscus['repo_id'].to_s.to_json},
-                "data-category": #{giscus['category'].to_s.to_json},
-                "data-category-id": #{giscus['category_id'].to_s.to_json},
-                "data-mapping": #{giscus['mapping'].to_s.to_json},
-                "data-strict": #{giscus['strict'].to_s.to_json},
-                "data-reactions-enabled": #{giscus['reactions_enabled'].to_s.to_json},
-                "data-emit-metadata": #{giscus['emit_metadata'].to_s.to_json},
-                "data-input-position": #{giscus['input_position'].to_s.to_json},
+                "data-repo": #{repo.to_s.to_json},
+                "data-repo-id": #{fetch_key(giscus, 'repo_id').to_s.to_json},
+                "data-category": #{fetch_key(giscus, 'category').to_s.to_json},
+                "data-category-id": #{fetch_key(giscus, 'category_id').to_s.to_json},
+                "data-mapping": #{fetch_key(giscus, 'mapping').to_s.to_json},
+                "data-strict": #{fetch_key(giscus, 'strict').to_s.to_json},
+                "data-reactions-enabled": #{fetch_key(giscus, 'reactions_enabled').to_s.to_json},
+                "data-emit-metadata": #{fetch_key(giscus, 'emit_metadata').to_s.to_json},
+                "data-input-position": #{fetch_key(giscus, 'input_position').to_s.to_json},
                 "data-theme": giscusTheme,
-                "data-lang": #{giscus['lang'].to_s.to_json},
+                "data-lang": #{fetch_key(giscus, 'lang').to_s.to_json},
                 crossorigin: "anonymous",
                 async: true
               };
@@ -109,16 +196,22 @@ module AlComments
     end
 
     def theme_detection(site)
-      if site.config['enable_darkmode']
+      giscus = resolve_giscus_config(site)
+      dark_theme = fetch_key(giscus, 'dark_theme').to_s
+      light_theme = fetch_key(giscus, 'light_theme').to_s
+      dark_theme = 'dark' if value_blank?(dark_theme)
+      light_theme = 'light' if value_blank?(light_theme)
+
+      if fetch_key(site.config, 'enable_darkmode')
         <<~JS
           var theme = localStorage.getItem("theme") || document.documentElement.getAttribute("data-theme") || "system";
-          if (theme === "dark") return #{site.config.dig('giscus', 'dark_theme').to_s.to_json};
-          if (theme === "light") return #{site.config.dig('giscus', 'light_theme').to_s.to_json};
+          if (theme === "dark") return #{dark_theme.to_json};
+          if (theme === "light") return #{light_theme.to_json};
           var prefersDark = window.matchMedia("(prefers-color-scheme: dark)").matches;
-          return prefersDark ? #{site.config.dig('giscus', 'dark_theme').to_s.to_json} : #{site.config.dig('giscus', 'light_theme').to_s.to_json};
+          return prefersDark ? #{dark_theme.to_json} : #{light_theme.to_json};
         JS
       else
-        %(return #{site.config.dig('giscus', 'light_theme').to_s.to_json};)
+        %(return #{light_theme.to_json};)
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: al_comments
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - al-org