markawesome 0.13.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dde7893cda313985c975f86e5521db8a3f56268ebf8d0df5b304719e8db5b73b
-  data.tar.gz: 73e885ac60dfbe2b8734d44aa135fb345440c977390d8d3d7a22cc577328eadf
+  metadata.gz: afd9d40552aa4f47c46ce12a72e4340075e9049a0d374dabbd894d6b4e9c0771
+  data.tar.gz: bf63ff67375e59593d352c35b9e6852fd4f436a4005eba52bdf695b54d734f11
 SHA512:
-  metadata.gz: 1e4cab6567c4ef43c87472be12ec93d506fc7b4d47a9a7588aa4c99e28d58761e6705bbf56b0ed5efac032dff0960fa6af9d661042950aba516f76d8ee4881ac
-  data.tar.gz: 49df9a0d39e97272b3acd05b52980b86ace61eb00dd6be7e92d91dc90ec0c688b550e5b21e7999303c8f3dc6dd8188cac8d791c1fe5ad07baaac0ce10b23fd5c
+  metadata.gz: eeb2dffdb406f0eeb414cedfe834a616540956dddf5854c972b9743088e62b9d92054a4a1db2be1dc68817b5b81bec1ef7f0b30a0055a5508c6641710b8dc5f1
+  data.tar.gz: c76afeb5d61c70cab00f10e8a3a0d9b2f825bf04b5c4e5f46915506092fb826c9f1e4cb49061da3c29437404c2c0d2188eaf38d634704a56f6398a3410438770

data/CHANGELOG.md

@@ -4,6 +4,16 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.14.0] - 2026-06-24
+
+### Added
+
+- New `AccordionTransformer` producing Web Awesome `<wa-accordion>` / `<wa-accordion-item>` — a multi-section collapsible container for FAQs, docs sections, and "show more" content (the grouped, mutually-exclusive-capable sibling of `details`). The `/` delimiter is the container/item marker: container fence `//////` (6×), item fence `///` (3×) with an explicit `///` close, mirroring tabs (`++++++`/`+++`). An alternative `:::wa-accordion … :::` form is also accepted.
+  - **Container line** (bare tokens, order-independent, rightmost-wins): `appearance` (`outlined` default, `filled`, `filled-outlined`, `plain`), `mode` (`multiple`, `single`, `single-collapsible`), `icon-placement` (`start`, `end`), and a value-form `heading:N` → `heading-level="N"` where `N` is `1`–`6` or `none` (out-of-range values fall back to omitting the attribute). `appearance` is always emitted (defaulting to `outlined`); `mode`, `icon-placement`, and `heading-level` are emitted only when specified.
+  - **Item header** (`/// [expanded] [disabled] [icon:name] Label`): leading `expanded`/`disabled` flags become the matching boolean attributes; `icon:name` becomes a `<wa-icon slot="icon" name="…">` first child; the remaining text becomes the HTML-escaped `label`. Item bodies are full markdown and may contain other components.
+  - **Plain-markdown degradation** (`render_as_markdown`, used for `.md` endpoints / llms.txt): each item degrades to a `### Label` heading followed by its body, mirroring tabs.
+- `wa-accordion` is **experimental** in Web Awesome (added in 3.7), but `expanded`, `disabled`, and the `mode`/`appearance`/`icon-placement`/`heading-level` attributes are all declarative and static-site-safe — no JavaScript required. The interactive `expandAll()`/`collapseAll()` controls and rich/HTML `label` slot are out of scope for v1; item labels are plain text. The `--wa-accordion-divider-color` custom property removed in WA 3.9.0 is intentionally not exposed.
+
 ## [0.13.0] - 2026-06-20
 
 ### Added

data/lib/markawesome/plain_markdown_renderer.rb

@@ -24,8 +24,8 @@ module Markawesome
       # plugin during boot to override the default rendering for a single
       # component without forking the gem.
       #
-      # @param component [Symbol] one of :callout, :badge, :button, :card,
-      #   :carousel, :comparison, :copy_button, :details, :dialog, :icon,
+      # @param component [Symbol] one of :accordion, :callout, :badge, :button,
+      #   :card, :carousel, :comparison, :copy_button, :details, :dialog, :icon,
       #   :image_dialog, :layout, :popover, :tabs, :tag.
       # @yield [content, options] Proc that receives the full source content
       #   and the renderer options; returns the content with that component
@@ -58,6 +58,7 @@ module Markawesome
       icon
       tag
       tabs
+      accordion
     ].freeze
 
     TRANSFORMER_MAP = {
@@ -75,7 +76,8 @@ module Markawesome
       dialog: DialogTransformer,
       icon: IconTransformer,
       tag: TagTransformer,
-      tabs: TabsTransformer
+      tabs: TabsTransformer,
+      accordion: AccordionTransformer
     }.freeze
 
     def self.process(content, options = {})

data/lib/markawesome/transformer.rb

@@ -32,6 +32,10 @@ module Markawesome
       content = TagTransformer.transform(content)
       content = TabsTransformer.transform(content)
 
+      # Accordion runs last so item bodies may contain other already-transformed
+      # components (same reason tabs runs near the end).
+      content = AccordionTransformer.transform(content)
+
       CodeBlockProtector.restore(content, tokens)
     end
   end

data/lib/markawesome/transformers/accordion_transformer.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+require_relative 'base_transformer'
+require_relative '../attribute_parser'
+require_relative '../icon_slot_parser'
+
+module Markawesome
+  # Transforms accordion syntax into wa-accordion / wa-accordion-item elements
+  # Primary syntax:
+  #   //////appearance? mode? icon-placement? heading:N?
+  #   /// [expanded] [disabled] [icon:name] Label text
+  #   item body markdown
+  #   ///
+  #   //////
+  # Alternative syntax: :::wa-accordion ...same items... :::
+  #
+  # Container attributes (bare, order-independent, rightmost-wins):
+  #   - appearance: outlined (default), filled, filled-outlined, plain
+  #   - mode: multiple (default), single, single-collapsible
+  #   - icon-placement: start, end (default emitted only when given)
+  #   - heading:N -> heading-level="N" where N is 1-6 or "none"
+  # Item tokens (leading flags, then the rest of the line is the label):
+  #   - expanded -> expanded; disabled -> disabled
+  #   - icon:name -> <wa-icon slot="icon" name="name"></wa-icon> as first child
+  #
+  # wa-accordion is experimental in Web Awesome (added 3.7). expanded/disabled
+  # and the mode/appearance/icon-placement attributes are all static-safe.
+  class AccordionTransformer < BaseTransformer
+    CONTAINER_ATTRIBUTES = {
+      appearance: %w[outlined filled filled-outlined plain],
+      mode: %w[multiple single single-collapsible],
+      icon_placement: %w[start end]
+    }.freeze
+
+    ICON_SLOTS = {
+      default: 'icon',
+      slots: %w[icon],
+      slot_map: { 'icon' => 'icon' }
+    }.freeze
+
+    ITEM_FLAGS = %w[expanded disabled].freeze
+
+    PRIMARY_REGEX = %r{^/{6}([^\n]*)\n((?:/{3} [^\n]+\n.*?\n/{3}\n?)+)/{6}}m
+    ALTERNATIVE_REGEX = %r{^:::wa-accordion\s*([^\n]*)\n((?:/{3} [^\n]+\n.*?\n/{3}\n?)+):::}m
+    ITEM_REGEX = %r{^/{3} ([^\n]+)\n(.*?)\n/{3}}m
+
+    def self.transform(content)
+      transform_proc = proc do |params_string, items_block, _third|
+        attributes = AttributeParser.parse(params_string.to_s.strip, CONTAINER_ATTRIBUTES)
+        heading_level = extract_heading_level(params_string)
+
+        attr_parts = ["appearance=\"#{normalize_appearance(attributes[:appearance])}\""]
+        attr_parts << "mode=\"#{attributes[:mode]}\"" if attributes[:mode]
+        attr_parts << "icon-placement=\"#{attributes[:icon_placement]}\"" if attributes[:icon_placement]
+        attr_parts << "heading-level=\"#{heading_level}\"" if heading_level
+
+        "<wa-accordion #{attr_parts.join(' ')}>#{build_items(items_block)}</wa-accordion>"
+      end
+
+      patterns = dual_syntax_patterns(PRIMARY_REGEX, ALTERNATIVE_REGEX, transform_proc)
+      apply_multiple_patterns(content, patterns)
+    end
+
+    def self.render_as_markdown(content, _options = {})
+      transform_proc = proc do |_params_string, items_block, _third|
+        items_block.scan(ITEM_REGEX).map do |header, body|
+          _flags, label = parse_item_flags_and_label(IconSlotParser.parse(header, ICON_SLOTS)[:remaining])
+          "### #{label}\n\n#{body.strip}"
+        end.join("\n\n")
+      end
+
+      patterns = dual_syntax_patterns(PRIMARY_REGEX, ALTERNATIVE_REGEX, transform_proc)
+      apply_multiple_patterns(content, patterns)
+    end
+
+    class << self
+      private
+
+      def build_items(items_block)
+        items_block.scan(ITEM_REGEX).map do |header, body|
+          icon_result = IconSlotParser.parse(header, ICON_SLOTS)
+          flags, label = parse_item_flags_and_label(icon_result[:remaining])
+
+          item_attrs = ["label=\"#{escape_html(label)}\""]
+          item_attrs << 'expanded' if flags.include?('expanded')
+          item_attrs << 'disabled' if flags.include?('disabled')
+
+          icon_html = IconSlotParser.to_html(icon_result[:icons], ICON_SLOTS[:slot_map])
+          body_html = markdown_to_html(body.strip)
+
+          "<wa-accordion-item #{item_attrs.join(' ')}>#{icon_html}#{body_html}</wa-accordion-item>"
+        end.join
+      end
+
+      # Consume leading expanded/disabled tokens; the remainder is the label.
+      def parse_item_flags_and_label(remaining)
+        tokens = remaining.to_s.strip.split(/\s+/)
+        flags = []
+        flags << tokens.shift while tokens.any? && ITEM_FLAGS.include?(tokens.first)
+        [flags, tokens.join(' ')]
+      end
+
+      def extract_heading_level(params_string)
+        return nil if params_string.nil? || params_string.strip.empty?
+
+        token = params_string.strip.split(/\s+/).find { |t| t.start_with?('heading:') }
+        return nil unless token
+
+        value = token.sub(/^heading:/, '')
+        return value if value == 'none' || value.match?(/\A[1-6]\z/)
+
+        nil
+      end
+
+      def normalize_appearance(appearance_param)
+        case appearance_param
+        when 'filled'
+          'filled'
+        when 'filled-outlined'
+          'filled-outlined'
+        when 'plain'
+          'plain'
+        else
+          'outlined'
+        end
+      end
+
+      def escape_html(text)
+        text.to_s
+            .gsub('&', '&amp;')
+            .gsub('<', '&lt;')
+            .gsub('>', '&gt;')
+            .gsub('"', '&quot;')
+            .gsub("'", '&#39;')
+      end
+    end
+  end
+end

data/lib/markawesome/transformers.rb

@@ -4,6 +4,7 @@
 # This file makes it easy to require all transformers at once
 
 require_relative 'transformers/base_transformer'
+require_relative 'transformers/accordion_transformer'
 require_relative 'transformers/badge_transformer'
 require_relative 'transformers/button_transformer'
 require_relative 'transformers/callout_transformer'

data/lib/markawesome/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Markawesome
-  VERSION = '0.13.0'
+  VERSION = '0.14.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: markawesome
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.0
 platform: ruby
 authors:
 - Janne Waren
@@ -84,6 +84,7 @@ files:
 - lib/markawesome/plain_markdown_renderer.rb
 - lib/markawesome/transformer.rb
 - lib/markawesome/transformers.rb
+- lib/markawesome/transformers/accordion_transformer.rb
 - lib/markawesome/transformers/badge_transformer.rb
 - lib/markawesome/transformers/base_transformer.rb
 - lib/markawesome/transformers/button_transformer.rb