willamette 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f5138017ccfb6d65c8e535ce1ecb734496e2c83c2d1d7aa1e7d93396914099e1
-  data.tar.gz: 3dc71a8e21f0b54e24bbfeb49b87b26ac787e79ed40209b45e225bab1e4dab46
+  metadata.gz: a4b853f52bf79b6b1653d57cafb45bbc7dc904f8de77e885fddf57de1724649a
+  data.tar.gz: 4b6f1bd188e86211babaa5f3ef67ada6f533e3465089e6d3ef42c5cf39a3088d
 SHA512:
-  metadata.gz: cd681c6cbb7e00ef36b0a78671d457440df5878638aef4e6045ec962b131b9744eff98f1381bea3b68b70fd460ffbd5e79fe2ed5c881f1e94af85d489821242a
-  data.tar.gz: 4541f0994fc2c3c51a7adc4534e6c76a284c00e58388304085720fa7402c7b8cc01a64c5342c8712a5ec7d640d3d90de6237515ec0e8160211f807cc1bc9964c
+  metadata.gz: 88291ce695014b0647393b6c00119beab4b30b9ddd9b3afe5798b34d64d27fb04ccce61671fcd36de863213bc252d719dfd587409c486b6ff919cc516a72102e
+  data.tar.gz: a549b26f00fc725f59b507d73bba533ee1b791b1242b4709249b6f7d402baa71f19e2890ecd7e36db60c514f84a79146633eb070426159641e1e0ab4918b3bd8

data/Gemfile

@@ -9,6 +9,7 @@ group :test do
   gem "minitest"
   gem "minitest-profile"
   gem "minitest-reporters"
+  gem "nokolexbor"
 end
 
 gem "rubocop-bridgetown", "~> 0.7"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    willamette (0.8.0)
+    willamette (0.9.0)
       bridgetown (>= 2.1, < 3.0)
       nokolexbor (>= 0.6)
 
@@ -241,6 +241,7 @@ DEPENDENCIES
   minitest
   minitest-profile
   minitest-reporters
+  nokolexbor
   rake (>= 13.0)
   rubocop-bridgetown (~> 0.7)
   solargraph (~> 0.58.2)

data/automations/components.automation.rb

@@ -5,9 +5,25 @@ remove_file "src/_components/shared/navbar.rb"
 create_file "src/_components/shared.rb" do <<~RUBY
 module Shared
   class Navbar < Bridgetown::Component
-    attr_reader :metadata, :resource
+    attr_reader :metadata, :resource, :strategy
 
-    def initialize(metadata:, resource:) = (@metadata, @resource = metadata, resource)
+    # @param metadata [HashWithDotAccess::Hash]
+    # @param resource [Bridgetown::Resource::Base]
+    def initialize(metadata:, resource:)
+      @metadata, @resource = metadata, resource
+
+      @strategy = Willamette.navbar(
+        self,
+        logo: "/willamette/bridgetown-avatar.svg",
+        logo_alt: "Website Logo",
+        site_title: metadata.title,
+        nav_links: [
+          Willamette.link(title: t("nav.blog"), url: "/blog"),
+          Willamette.link(title: t("nav.about"), url: "/about"),
+          Willamette.link(icon: "mastodon", icon_family: "brands", icon_label: "Mastodon", title: nil, url: "https://mastodon.social"),
+        ]
+      )
+    end
   end
 
   class Sidebar < Bridgetown::Component
@@ -50,18 +66,19 @@ create_file "src/_components/shared/navbar.erb" do <<~HTML
     <% end %>
 
     <a slot="logo" href="/">
-      <img src="<%= '/willamette/bridgetown-avatar.svg' %>" alt="Website Logo" />
-      <span><%= metadata.title %></span>
+      <% if strategy.logo? %>
+        <img src="<%= strategy.logo %>" alt="<%= strategy.logo_alt %>" />
+      <% end %>
+      <% if strategy.site_title? %>
+        <span><%= strategy.site_title %></span>
+      <% end %>
     </a>
 
-    <a href="<%= relative_url '/search' %>" slot="search"><wa-icon label="<%= t "labels.search" %>" name="search"></wa-icon> <span class="hide-for-mobile"><%= t "labels.search" %> <kbd style="vertical-align: 10%">⌘K</kbd></span></a>
+    <% if strategy.search? %>
+      <a href="<%= relative_url '/search' %>" slot="search"><wa-icon label="<%= t "labels.search" %>" name="search"></wa-icon> <span class="hide-for-mobile"><%= t "labels.search" %> <kbd style="vertical-align: 10%">⌘K</kbd></span></a>
+    <% end %>
 
-    <ul slot="nav">
-      <!-- customize this list! -->
-      <li><a href="<%= relative_url '/blog' %>">Blog</a></li>
-      <li><a href="<%= relative_url '/about' %>">About</a></li>
-      <li><a href="#"><wa-icon label="Mastodon" family="brands" name="mastodon"></wa-icon></a></li>
-    </ul>
+    <%= strategy.nav_links %>
   </header>
 HTML
 end

data/layouts/willamette/default.erb

@@ -37,8 +37,6 @@
 
       <%= slotted :toc %>
 
-      <hr />
-
       <!-- TOC insertion -->
     </aside>
 

data/lib/willamette/locales/en.yml

@@ -20,3 +20,6 @@ en:
     follow: Follow Us
     subscribe: Subscribe
     see_also: See Also
+  nav:
+    blog: Blog
+    about: About

data/lib/willamette/strategies/base.rb

@@ -0,0 +1,41 @@
+module Willamette
+  module Strategies
+    class Base
+      private
+
+      def links_html(links, slot: nil)
+        doc = Nokolexbor::HTML("<ul></ul>")
+        list = doc.at_css("ul")
+        list[:slot] = slot if slot
+        links.each_with_index do |link, index|
+          list << link_node(doc:, link:, folder: (links[index + 1]&.depth || 1) > link.depth)
+        end
+        list.to_html.html_safe
+      end
+
+      def link_node(doc:, link:, folder: false) # rubocop:disable Metrics
+        item = doc.create_element("li")
+        item[:"item-depth"] = link.depth
+        anchor = doc.create_element("a")
+        anchor[:href] = @component.relative_url(link.url)
+        anchor[:"aria-current"] = "page" if link.current
+
+        if link.icon || respond_to?(:default_link_icon)
+          icon = doc.create_element("wa-icon")
+          icon[:name] = link.icon || default_link_icon(folder:)
+          icon[:family] = link.icon_family if link.icon_family
+          icon[:label] = link.icon_label if link.icon_label
+          anchor << icon
+        end
+
+        if link.title
+          anchor << doc.create_text_node(" ")
+          anchor << doc.create_text_node(link.title)
+        end
+
+        item << anchor
+        item
+      end
+    end
+  end
+end

data/lib/willamette/strategies/link.rb

@@ -1,9 +1,11 @@
 module Willamette
   # Contain logic for rendering
-  Strategies::Link = Data.define(:depth, :current, :icon, :icon_family, :title, :url)
+  Strategies::Link = Data.define(
+    :depth, :current, :icon, :icon_family, :icon_label, :title, :url
+  )
 
-  def self.link(depth: 1, current: false, icon: nil, icon_family: nil, **) # rubocop:disable Metrics/ParameterLists
-    Strategies::Link.new(depth:, current:, icon:, icon_family:, **)
+  def self.link(depth: 1, current: false, icon: nil, icon_family: nil, icon_label: nil, **) # rubocop:disable Metrics/ParameterLists
+    Strategies::Link.new(depth:, current:, icon:, icon_family:, icon_label:, **)
   end
 
   def self.links_for(base_resource)

data/lib/willamette/strategies/navbar.rb

@@ -0,0 +1,43 @@
+module Willamette
+  # rubocop:disable Metrics/ParameterLists
+  module Strategies
+    # Contain logic for navbar rendering
+    class Navbar < Base
+      attr_reader :logo, :logo_alt, :site_title
+
+      # Use the `navbar` module method on `Willamette`
+      def initialize(
+        component, logo:, logo_alt:, site_title:, nav_links:, search:
+      )
+        @component = component
+        @logo = logo
+        @logo_alt = logo_alt
+        @site_title = site_title
+        @nav_links  = nav_links
+        @search = search
+      end
+
+      def logo? = @logo
+
+      def site_title? = @site_title
+
+      def search? = @search
+
+      def nav_links = links_html(@nav_links, slot: :nav)
+    end
+  end
+
+  def self.navbar(
+    component,
+    logo:,
+    site_title:,
+    nav_links:,
+    logo_alt: "logo",
+    search: true
+  )
+    Willamette::Strategies::Navbar.new(
+      component, logo:, logo_alt:, site_title:, nav_links:, search:
+    )
+  end
+  # rubocop:enable Metrics/ParameterLists
+end

data/lib/willamette/strategies/sidebar.rb

@@ -1,75 +1,47 @@
 module Willamette
-  # Contain logic for rendering
   # rubocop:disable Metrics/ParameterLists
-  class Strategies::Sidebar
-    attr_reader :description
-
-    # Use the `sidebar` module method on `Willamette`
-    def initialize(
-      component, description:, explore_links:, follow_links:, subscribe:, see_also_links:
-    )
-      @component = component
-      @description = description
-      @explore_links = explore_links || []
-      @follow_links = follow_links || []
-      @subscribe = subscribe
-      @see_also_links = see_also_links || []
-    end
-
-    def explore? = !@explore_links.empty?
+  module Strategies
+    # Contain logic for sidebar rendering
+    class Sidebar < Base
+      attr_reader :description
+
+      # Use the `sidebar` module method on `Willamette`
+      def initialize(
+        component, description:, explore_links:, follow_links:, subscribe:, see_also_links:
+      )
+        @component = component
+        @description = description
+        @explore_links = explore_links || []
+        @follow_links = follow_links || []
+        @subscribe = subscribe
+        @see_also_links = see_also_links || []
+      end
 
-    def explore_links = links_html(@explore_links)
+      def explore? = !@explore_links.empty?
 
-    def description? = @description && !explore?
+      def explore_links = links_html(@explore_links)
 
-    def follow? = !@follow_links.empty?
+      def description? = @description && !explore?
 
-    def follow_links = links_html(@follow_links)
+      def follow? = !@follow_links.empty?
 
-    def subscribe? = @subscribe
+      def follow_links = links_html(@follow_links)
 
-    def see_also? = !@see_also_links.empty?
+      def subscribe? = @subscribe
 
-    def see_also_links = links_html(@see_also_links)
+      def see_also? = !@see_also_links.empty?
 
-    def default_link_icon(folder: false)
-      folder ? "folder-open" : "file-lines"
-    end
+      def see_also_links = links_html(@see_also_links)
 
-    private
-
-    def links_html(links)
-      doc = Nokolexbor::HTML("<ul></ul>")
-      list = doc.at_css("ul")
-      links.each_with_index do |link, index|
-        list << link_node(doc:, link:, folder: (links[index + 1]&.depth || 1) > link.depth)
+      def default_link_icon(folder: false)
+        folder ? "folder-open" : "file-lines"
       end
-      list.to_html.html_safe
-    end
-
-    def link_node(doc:, link:, folder: false) # rubocop:disable Metrics/AbcSize
-      item = doc.create_element("li")
-      item[:"item-depth"] = link.depth
-      anchor = doc.create_element("a")
-      anchor[:href] = @component.relative_url(link.url)
-      anchor[:"aria-current"] = "page" if link.current
-
-      icon = doc.create_element("wa-icon")
-      icon[:name] = link.icon || default_link_icon(folder:)
-      icon[:family] = link.icon_family if link.icon_family
-      anchor << icon
-
-      anchor << doc.create_text_node(" ")
-      anchor << doc.create_text_node(link.title)
-
-      item << anchor
-      item
     end
   end
 
   def self.sidebar(
     component,
-    description:,
+    description: nil,
     explore_links: nil,
     follow_links: nil,
     subscribe: false,

data/lib/willamette/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Willamette
-  VERSION = "0.8.0"
+  VERSION = "0.9.0"
 end

data/lib/willamette.rb

@@ -13,7 +13,9 @@ end
 require "willamette/builders/author_extension"
 require "willamette/builders/inspectors"
 require "willamette/builders/toc"
+require "willamette/strategies/base"
 require "willamette/strategies/link"
+require "willamette/strategies/navbar"
 require "willamette/strategies/sidebar"
 
 # use `<wll-code>` element instead of `<div>`

data/package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "willamette",
-  "version": "0.7.1",
+  "version": "0.9.0",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "willamette",
-      "version": "0.7.1",
+      "version": "0.9.0",
       "license": "MIT",
       "dependencies": {
         "@awesome.me/webawesome": ">=3.6.0",

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "willamette",
-  "version": "0.8.0",
+  "version": "0.9.0",
   "main": "frontend/javascript/index.js",
   "repository": {
     "type": "git",

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: willamette
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Bridgetown Team
 bindir: bin
 cert_chain: []
-date: 2026-05-01 00:00:00.000000000 Z
+date: 2026-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bridgetown
@@ -116,7 +116,9 @@ files:
 - lib/willamette/builders/inspectors.rb
 - lib/willamette/builders/toc.rb
 - lib/willamette/locales/en.yml
+- lib/willamette/strategies/base.rb
 - lib/willamette/strategies/link.rb
+- lib/willamette/strategies/navbar.rb
 - lib/willamette/strategies/sidebar.rb
 - lib/willamette/version.rb
 - package-lock.json