sleeping_king_studios-docs 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4efbec5418a43dab48ee3f399e9461fd64f17f1b31931d384f6bd5b3de0407cb
-  data.tar.gz: a609dd607d8b1c9a71495e09c0f01e70bac9d92ad91a29817f5abbfb1baefeb8
+  metadata.gz: 03ca814ce7d3b3f69036b8c1b0329efc653ee3e60a1171256796cb0b01f0b78e
+  data.tar.gz: a55bcfc03b9e3dcce0d1031f71f1a33eca621cdb8c51310b22b2ecbccac5e0ac
 SHA512:
-  metadata.gz: b2c4d06f1f2ff5cf128cee30e748a5255d99699f80a3e69054f54d544d1389aa045752b38be64b0c002e6b71e3fb654e77856293eb66d2297565e65315b2aba3
-  data.tar.gz: d01dd772621dbaac3c8261089ea997ad471edabd9f7b2a65d01467cd062415dae4a15a1b04f4198baa7c6bd117dd1852d2342bef2297c35befb75a03e9c7ca56
+  metadata.gz: 144d38bb823272073c5df7d11a97a1a1d9418e9bfda1e2fae6a3504f832b914871feb928b4df7922ba86fc61c6226a183c1e562c1245c4597f9fbd08ffaa3a9c
+  data.tar.gz: 9cddc82b060467f8021d14c1d0b3086007f6fdd5a464424900ddd1263c965e98f93e0cb7894dce7a213f6dd834639fb281c12a85f1efd883d9e3b4bbe6426ac1

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+# 0.2.0
+
+> **Upgrade Notes**
+>
+> Add the following to your `_config.yml` files:
+>
+> ```markdown
+> plugins:
+>   - sleeping_king_studios/docs/jekyll/plugins/required
+> ```
+
+- Improved handling of method names with characters that are not valid for HTML anchors, such as `[]`, `=`, and `?`.
+
 # 0.1.0
 
 Initial development release.

data/lib/sleeping_king_studios/docs/data/see_tags/class_method_tag.rb

@@ -70,7 +70,7 @@ module SleepingKingStudios::Docs::Data::SeeTags
       @normalized_path = @normalized_path.reverse.sub('::', '.').reverse
     end
 
-    def query_registry(name)
+    def registry_item_exists?(name)
       registry_query.class_method_exists?(name)
     end
 

data/lib/sleeping_king_studios/docs/data/see_tags/constant_tag.rb

@@ -40,7 +40,7 @@ module SleepingKingStudios::Docs::Data::SeeTags
 
     private
 
-    def query_registry(name)
+    def registry_item_exists?(name)
       registry_query.constant_exists?(name)
     end
 

data/lib/sleeping_king_studios/docs/data/see_tags/definition_tag.rb

@@ -39,7 +39,7 @@ module SleepingKingStudios::Docs::Data::SeeTags
 
     private
 
-    def query_registry(name)
+    def registry_item_exists?(name)
       registry_query.definition_exists?(name)
     end
 

data/lib/sleeping_king_studios/docs/data/see_tags/instance_method_tag.rb

@@ -55,7 +55,7 @@ module SleepingKingStudios::Docs::Data::SeeTags
 
     private
 
-    def query_registry(name)
+    def registry_item_exists?(name)
       registry_query.instance_method_exists?(name)
     end
 

data/lib/sleeping_king_studios/docs/data/see_tags/reference_tag.rb

@@ -51,10 +51,10 @@ module SleepingKingStudios::Docs::Data::SeeTags
     def absolute_path?
       return @absolute_path unless @absolute_path.nil?
 
-      @absolute_path = query_registry(reference)
+      @absolute_path = registry_item_exists?(reference)
     end
 
-    def query_registry(_)
+    def registry_item_exists?(_)
       false
     end
 
@@ -78,7 +78,7 @@ module SleepingKingStudios::Docs::Data::SeeTags
 
       return @relative_path = false if parent.root?
 
-      @relative_path = query_registry(qualified_path)
+      @relative_path = registry_item_exists?(qualified_path)
     end
 
     def slugify_path(path)

data/lib/sleeping_king_studios/docs/jekyll/plugins/liquid/filters/anchorize_slug.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'sleeping_king_studios/docs/jekyll/plugins/liquid/filters'
+
+module SleepingKingStudios::Docs::Jekyll::Plugins::Liquid::Filters
+  # Liquid filter for converting a reference slug to a safe HTML anchor.
+  module AnchorizeSlug
+    # Converts the slug to a string usable as an HTML anchor.
+    #
+    # Certain characters are valid Ruby identifiers but cause issues when used
+    # as HTML anchors, such as equals signs, hashes, question marks, and square
+    # brackets. This method replaces each with a placeholder value.
+    #
+    # @param slug [String] the slug to convert.
+    #
+    # @return [String] the converted slug.
+    def anchorize_slug(slug)
+      slug
+        .to_s
+        .gsub('=', '--equals')
+        .gsub('?', '--predicate')
+        .gsub('[]', '--brackets')
+    end
+
+    ::Liquid::Template.register_filter(self) if defined?(::Liquid::Template)
+  end
+end

data/lib/sleeping_king_studios/docs/jekyll/plugins/liquid/filters.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'sleeping_king_studios/docs/jekyll/plugins/liquid'
+
+module SleepingKingStudios::Docs::Jekyll::Plugins::Liquid
+  # Filters for extending Liquid template functionality.
+  module Filters
+    autoload :AnchorizeSlug,
+      'sleeping_king_studios/docs/jekyll/plugins/liquid/filters/anchorize_slug'
+  end
+end

data/lib/sleeping_king_studios/docs/jekyll/plugins/liquid.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'sleeping_king_studios/docs/jekyll/plugins'
+
+module SleepingKingStudios::Docs::Jekyll::Plugins
+  # Plugins for extending Liquid template functionality.
+  module Liquid
+    autoload :Filters,
+      'sleeping_king_studios/docs/jekyll/plugins/liquid/filters'
+  end
+end

data/lib/sleeping_king_studios/docs/jekyll/plugins/required.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'sleeping_king_studios/docs/jekyll/plugins'
+
+module SleepingKingStudios::Docs::Jekyll::Plugins
+  # Helper module for loading all required Jekyll plugins.
+  module Required
+    include Liquid::Filters::AnchorizeSlug
+  end
+end

data/lib/sleeping_king_studios/docs/jekyll/plugins.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'sleeping_king_studios/docs/jekyll'
+
+module SleepingKingStudios::Docs::Jekyll
+  # Plugins for extending Jekyll functionality.
+  module Plugins
+    autoload :Liquid,   'sleeping_king_studios/docs/jekyll/plugins/liquid'
+    autoload :Required, 'sleeping_king_studios/docs/jekyll/plugins/required'
+  end
+end

data/lib/sleeping_king_studios/docs/jekyll.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'sleeping_king_studios/docs'
+
+module SleepingKingStudios::Docs
+  # Namespace for working with Jekyll-specific functionality.
+  module Jekyll
+    autoload :Plugins, 'sleeping_king_studios/docs/jekyll/plugins'
+  end
+end

data/lib/sleeping_king_studios/docs/templates/config.yml.erb

@@ -1,4 +1,6 @@
 ---
+plugins:
+  - sleeping_king_studios/docs/jekyll/plugins/required
 collections:
   classes:
     output: false

data/lib/sleeping_king_studios/docs/templates/includes/reference/attribute.md

@@ -1,6 +1,6 @@
 {% assign method = site.methods | where: "data_path", include.attribute.path | where: "version", page.version | first %}
 {% capture prefix %}{{ include.type }}-attribute{% endcapture %}
-{% capture heading_id %}{{ prefix }}-{{ method.slug | replace: "=", "--equals" }}{% endcapture %}
+{% capture heading_id %}{{ prefix }}-{{ method.slug | anchorize_slug }}{% endcapture %}
 
 {% include reference/attributes/heading.md attribute=include.attribute heading_id=heading_id method=method type=include.type %}
 

data/lib/sleeping_king_studios/docs/templates/includes/reference/definitions/table-of-contents/class_attributes.md

@@ -3,7 +3,7 @@
   <a href="#class-attributes">Class Attributes</a>
   <ul style="margin-bottom: 0px;">
   {% for attribute in include.definition.class_attributes %}
-    <li><a href="#class-attribute-{{ attribute.slug | replace: "=", "--equals" }}">{{ attribute.name }}</a></li>
+    <li><a href="#class-attribute-{{ attribute.slug | anchorize_slug }}">{{ attribute.name }}</a></li>
   {% endfor %}
   </ul>
 </li>

data/lib/sleeping_king_studios/docs/templates/includes/reference/definitions/table-of-contents/class_methods.md

@@ -3,7 +3,7 @@
   <a href="#class-methods">Class Methods</a>
   <ul style="margin-bottom: 0px;">
   {% for method in include.definition.class_methods %}
-    <li><a href="#class-method-{{ method.slug | replace: "=", "--equals" | replace: "?", "--predicate" }}">{{ method.name }}</a></li>
+    <li><a href="#class-method-{{ method.slug | anchorize_slug }}">{{ method.name }}</a></li>
   {% endfor %}
   </ul>
 </li>

data/lib/sleeping_king_studios/docs/templates/includes/reference/definitions/table-of-contents/instance_attributes.md

@@ -3,7 +3,7 @@
   <a href="#instance-attributes">Instance Attributes</a>
   <ul style="margin-bottom: 0px;">
   {% for attribute in include.definition.instance_attributes %}
-    <li><a href="#instance-attribute-{{ attribute.slug | replace: "=", "--equals" }}">{{ attribute.name }}</a></li>
+    <li><a href="#instance-attribute-{{ attribute.slug | anchorize_slug }}">{{ attribute.name }}</a></li>
   {% endfor %}
   </ul>
 </li>

data/lib/sleeping_king_studios/docs/templates/includes/reference/definitions/table-of-contents/instance_methods.md

@@ -3,7 +3,7 @@
   <a href="#instance-methods">Instance Methods</a>
   <ul style="margin-bottom: 0px;">
   {% for method in include.definition.instance_methods %}
-    <li><a href="#instance-method-{{ method.slug | replace: "=", "--equals" | replace: "?", "--predicate" }}">{{ method.name }}</a></li>
+    <li><a href="#instance-method-{{ method.slug | anchorize_slug }}">{{ method.name }}</a></li>
   {% endfor %}
   </ul>
 </li>

data/lib/sleeping_king_studios/docs/templates/includes/reference/method.md

@@ -1,7 +1,7 @@
 {% assign method = site.methods | where: "data_path", include.path | where: "version", page.version | first %}
 {% if method %}
 {% capture prefix %}{{ include.type }}-method{% endcapture %}
-{% capture heading_id %}{{ prefix }}-{{ method.slug | replace: "=", "--equals" | replace: "?", "--predicate" }}{% endcapture %}
+{% capture heading_id %}{{ prefix }}-{{ method.slug | anchorize_slug }}{% endcapture %}
 
 {% include reference/methods/heading.md heading_id=heading_id method=method type=include.type %}
 

data/lib/sleeping_king_studios/docs/version.rb

@@ -11,7 +11,7 @@ module SleepingKingStudios
       # Major version.
       MAJOR = 0
       # Minor version.
-      MINOR = 1
+      MINOR = 2
       # Patch version.
       PATCH = 0
       # Prerelease version.

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: sleeping_king_studios-docs
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Rob "Merlin" Smith
 bindir: bin
 cert_chain: []
-date: 2025-03-31 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cuprum
@@ -151,6 +151,12 @@ files:
 - lib/sleeping_king_studios/docs/errors/file_not_found.rb
 - lib/sleeping_king_studios/docs/errors/invalid_directory.rb
 - lib/sleeping_king_studios/docs/errors/invalid_file.rb
+- lib/sleeping_king_studios/docs/jekyll.rb
+- lib/sleeping_king_studios/docs/jekyll/plugins.rb
+- lib/sleeping_king_studios/docs/jekyll/plugins/liquid.rb
+- lib/sleeping_king_studios/docs/jekyll/plugins/liquid/filters.rb
+- lib/sleeping_king_studios/docs/jekyll/plugins/liquid/filters/anchorize_slug.rb
+- lib/sleeping_king_studios/docs/jekyll/plugins/required.rb
 - lib/sleeping_king_studios/docs/registry.rb
 - lib/sleeping_king_studios/docs/registry_query.rb
 - lib/sleeping_king_studios/docs/tasks.rb
@@ -237,7 +243,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.5
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Tools for generating a versioned documentation site from YARD docs.
 test_files: []