wytch 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7aa017b3a2d6ed1b64cde7b4a73f312222d64a630a365ad71db68f4babc28ce5
-  data.tar.gz: fba837a626f3c4dfcc3525d03127ada6b62b30b367e31da4c5eef3721c7b264a
+  metadata.gz: 3adc6455846cef32252a24576fd40aafe237d26a688e131ee73a9c222827d0c6
+  data.tar.gz: 1409ff6165c88b35941cef1679c7fcd8f77d7e07950d7ec9601a504c89309a91
 SHA512:
-  metadata.gz: b70258ec6436a644dee4ecb637dc0bcad929428c7803d4272b7eef34b8bb0620b024c683a2a77f41e1235c05f5c1713b188a374bc7d050bb77a571bd924db7f0
-  data.tar.gz: 98a84928a3cf7bd5aff50e99225d6b944da43ca69a44c2bb94a10ee8bc5ba424365ca228378f2f2472757b25632f86b7b5bea0aaa458e075100e2b96f1f87985
+  metadata.gz: bfe7e1897b05b7017624a03b8659919383dde9f0aabc86f4e8afe86ea4835a092bc0c719be29a0f1b641de133702229aa9a07fa1b766f99bda2e091b5f20d699
+  data.tar.gz: 3c04f324a254bf565d47ac2039141ee596c3dc1f98f39c3c7001fa51bdbf90f968520a3e9ed9ee4a2274301ffcc9a07d732e44c1593f0eccf2af36aee082890c

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Unreleased]
 
+## [0.5.0] - 2025-12-7
+
+- Documentation cleanup
+
+## [0.4.0] - 2025-12-7
+
+- Move sitemap generation to Wytch core (`Wytch::SitemapView` and `Wytch::SitemapHelper`)
+
 ## [0.3.0] - 2025-12-7
 
 - Add YARD documentation to all classes and methods

data/lib/wytch/builder.rb

@@ -3,28 +3,15 @@
 require "fileutils"
 
 module Wytch
-  # Builds the static site by rendering all pages to the output directory.
-  #
-  # The Builder is responsible for the production build process:
-  # 1. Loading site configuration and content
-  # 2. Rendering each page to HTML
-  # 3. Copying static files from public/
-  # 4. Integrating Vite-built assets
+  # Builds the static site.
   #
   # @example Building via CLI
   #   $ wytch build
-  #
-  # @example Building programmatically
-  #   Wytch::Builder.new.build
   class Builder
-    # @return [String] the output directory for built files
     OUTPUT_DIR = "build"
 
     # Builds the entire site.
     #
-    # Sets RACK_ENV to "production", loads the site configuration,
-    # renders all pages to HTML files, and copies static assets.
-    #
     # @return [void]
     def build
       ENV["RACK_ENV"] = "production"
@@ -51,19 +38,12 @@ module Wytch
 
     private
 
-    # Copies files from public/ to the output directory.
-    #
-    # @return [void]
     def copy_public_files
       return unless Dir.exist?("public")
 
       FileUtils.cp_r "public/.", OUTPUT_DIR, verbose: true
     end
 
-    # Reports on Vite assets in the output directory.
-    # Vite builds directly to build/assets, so no copying is needed.
-    #
-    # @return [void]
     def copy_vite_assets
       vite_output = File.join(OUTPUT_DIR, "assets")
       return unless Dir.exist?(vite_output)

data/lib/wytch/cli.rb

@@ -71,8 +71,6 @@ module Wytch
       template("src/site/home_view.rb.tt", "#{name}/src/#{@site_name}/home_view.rb")
       template("src/site/post_view.rb.tt", "#{name}/src/#{@site_name}/post_view.rb")
       template("src/site/post_helpers.rb.tt", "#{name}/src/#{@site_name}/post_helpers.rb")
-      template("src/site/sitemap_view.rb.tt", "#{name}/src/#{@site_name}/sitemap_view.rb")
-      template("src/site/sitemap_helper.rb.tt", "#{name}/src/#{@site_name}/sitemap_helper.rb")
       template("src/site/feed_view.rb.tt", "#{name}/src/#{@site_name}/feed_view.rb")
       template("src/site/feed_helper.rb.tt", "#{name}/src/#{@site_name}/feed_helper.rb")
 
@@ -116,10 +114,6 @@ module Wytch
 
     private
 
-    # Converts a snake_case name to PascalCase.
-    #
-    # @param name [String] the name to classify
-    # @return [String] the PascalCase version
     def classify(name)
       name.split("_").map(&:capitalize).join
     end

data/lib/wytch/content_loader.rb

@@ -29,24 +29,14 @@ module Wytch
 
     private
 
-    # Creates a Page instance from a content file.
-    #
-    # @param file_path [String] path to the content file, relative to content_dir
-    # @return [Page] the loaded page
     def load_page(file_path)
       page_class.new(file_path:)
     end
 
-    # Returns the configured page class.
-    #
-    # @return [Class] the page class to instantiate
     def page_class
       Object.const_get(Wytch.site.page_class)
     end
 
-    # Returns the content directory path.
-    #
-    # @return [String] the content directory
     def content_dir
       Wytch.site.content_dir
     end

data/lib/wytch/server.rb

@@ -55,9 +55,6 @@ module Wytch
 
     private
 
-    # Builds the Rack application stack.
-    #
-    # @return [Rack::Builder] the configured Rack app
     def app
       base_app = lambda { |env|
         path = env["PATH_INFO"]

data/lib/wytch/sitemap_helper.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Wytch
+  # Helper module for sitemap pages.
+  #
+  # This module provides methods to configure a page as a sitemap.
+  # It sets the correct path, build path, and excludes the sitemap
+  # itself from appearing in the sitemap.
+  #
+  # @example Using in a content file (content/sitemap.rb)
+  #   view Wytch::SitemapView
+  #   add Wytch::SitemapHelper
+  module SitemapHelper
+    # Returns the URL path for the sitemap.
+    #
+    # @return [String] "/sitemap.xml"
+    def path
+      "/sitemap.xml"
+    end
+
+    # Returns the build path for the sitemap.
+    #
+    # @return [String] "sitemap.xml"
+    def build_path
+      "sitemap.xml"
+    end
+
+    # Excludes the sitemap from appearing in the sitemap.
+    #
+    # @return [Boolean] false
+    def include_in_sitemap?
+      false
+    end
+  end
+end

data/lib/wytch/{templates/src/site/sitemap_view.rb.tt → sitemap_view.rb}

@@ -1,15 +1,29 @@
 # frozen_string_literal: true
 
-module <%= @site_module %>
+module Wytch
+  # Generates an XML sitemap for the site.
+  #
+  # This view renders a sitemap.xml file listing all pages that have
+  # `include_in_sitemap?` returning true.
+  #
+  # @example Using in a content file (content/sitemap.rb)
+  #   view Wytch::SitemapView
+  #   add Wytch::SitemapHelper
   class SitemapView
+    # Creates a new sitemap view.
+    #
+    # @param page [Page] the page object (not used but required for interface)
     def initialize(page)
       @page = page
     end
 
+    # Renders the sitemap XML.
+    #
+    # @return [String] XML sitemap content
     def call
       require "builder"
 
-      xml = Builder::XmlMarkup.new(indent: 2)
+      xml = ::Builder::XmlMarkup.new(indent: 2)
       xml.instruct! :xml, version: "1.0", encoding: "UTF-8"
       xml.urlset xmlns: "http://www.sitemaps.org/schemas/sitemap/0.9" do
         Wytch.site.pages.values.each do |page|

data/lib/wytch/templates/content/sitemap.rb.tt

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 
-add <%= @site_module %>::SitemapHelper
-view <%= @site_module %>::SitemapView
+add Wytch::SitemapHelper
+view Wytch::SitemapView

data/lib/wytch/version.rb

@@ -2,5 +2,5 @@
 
 module Wytch
   # The current version of Wytch.
-  VERSION = "0.3.0"
+  VERSION = "0.5.0"
 end

data/website/content/api/wytch/sitemapview.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+view WytchSite::ApiClassView
+
+@metadata[:title] = "Wytch::SitemapView"
+@metadata[:yard_path] = "Wytch::SitemapView"