wytch 0.2.0 → 0.4.0

data/lib/wytch/version.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
 module Wytch
-  VERSION = "0.2.0"
+  # The current version of Wytch.
+  VERSION = "0.4.0"
 end

data/lib/wytch.rb

@@ -7,19 +7,48 @@ loader = Zeitwerk::Loader.for_gem
 loader.inflector.inflect("cli" => "CLI")
 loader.setup
 
+# Wytch is a minimal static site generator that uses Ruby for content
+# and Phlex for views.
+#
+# @example Basic configuration in config.rb
+#   Wytch.configure do |site|
+#     site.page_class = "MySite::Page"
+#     site.base_url = "https://example.com"
+#   end
+#
+# @see Wytch::Site
+# @see Wytch::Page
 module Wytch
+  # Base error class for all Wytch errors.
   class Error < StandardError; end
 
   class << self
+    # Returns the global site instance.
+    #
+    # @return [Wytch::Site] the current site configuration
     def site
       @site ||= Site.new
     end
 
+    # Configures the global site instance.
+    #
+    # @yield [site] Configuration block
+    # @yieldparam site [Wytch::Site] the site instance to configure
+    # @return [Wytch::Site] the configured site
+    #
+    # @example
+    #   Wytch.configure do |site|
+    #     site.page_class = "MySite::Page"
+    #     site.content_dir = "pages"
+    #   end
     def configure
       yield(site) if block_given?
       site
     end
 
+    # Resets the global site instance. Primarily used for testing.
+    #
+    # @return [void]
     def reset_site!
       @site = nil
     end

data/website/.gitignore

@@ -0,0 +1,4 @@
+build/
+node_modules/
+lib/
+.vite/

data/website/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gem "wytch", path: ".."
+
+gem "builder", "~> 3.3"
+gem "yard", "~> 0.9"

data/website/Gemfile.lock

@@ -0,0 +1,63 @@
+PATH
+  remote: ..
+  specs:
+    wytch (0.2.0)
+      concurrent-ruby (~> 1.3)
+      listen (~> 3.9)
+      phlex (~> 1.11)
+      puma (~> 6.4)
+      rack (~> 3.1)
+      thor (~> 1.4)
+      zeitwerk (~> 2.6)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    builder (3.3.0)
+    concurrent-ruby (1.3.5)
+    ffi (1.17.2)
+    ffi (1.17.2-aarch64-linux-gnu)
+    ffi (1.17.2-aarch64-linux-musl)
+    ffi (1.17.2-arm-linux-gnu)
+    ffi (1.17.2-arm-linux-musl)
+    ffi (1.17.2-arm64-darwin)
+    ffi (1.17.2-x86-linux-gnu)
+    ffi (1.17.2-x86-linux-musl)
+    ffi (1.17.2-x86_64-darwin)
+    ffi (1.17.2-x86_64-linux-gnu)
+    ffi (1.17.2-x86_64-linux-musl)
+    listen (3.9.0)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    nio4r (2.7.5)
+    phlex (1.11.0)
+    puma (6.6.1)
+      nio4r (~> 2.0)
+    rack (3.2.4)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.11.1)
+      ffi (~> 1.0)
+    thor (1.4.0)
+    yard (0.9.38)
+    zeitwerk (2.7.3)
+
+PLATFORMS
+  aarch64-linux-gnu
+  aarch64-linux-musl
+  arm-linux-gnu
+  arm-linux-musl
+  arm64-darwin
+  ruby
+  x86-linux-gnu
+  x86-linux-musl
+  x86_64-darwin
+  x86_64-linux-gnu
+  x86_64-linux-musl
+
+DEPENDENCIES
+  builder (~> 3.3)
+  wytch!
+  yard (~> 0.9)
+
+BUNDLED WITH
+   2.6.9

data/website/assets/Main.res

@@ -0,0 +1,2 @@
+// Main entry point for ReScript code
+Console.log("Hello from Wytch-site!")

data/website/assets/main.css

@@ -0,0 +1 @@
+@import "tailwindcss";

data/website/bin/generate_api_docs

@@ -0,0 +1,44 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'yard'
+require 'fileutils'
+
+# Path to the wytch gem lib directory
+WYTCH_LIB_PATH = File.expand_path('../../lib', __dir__)
+API_CONTENT_DIR = File.expand_path('../content/api', __dir__)
+
+puts "Cleaning existing API documentation..."
+FileUtils.rm_rf(API_CONTENT_DIR)
+FileUtils.mkdir_p(API_CONTENT_DIR)
+
+puts "Parsing YARD documentation from #{WYTCH_LIB_PATH}..."
+YARD.parse("#{WYTCH_LIB_PATH}/**/*.rb")
+
+puts "Generating API content files..."
+YARD::Registry.all(:class).each do |klass|
+  # Convert Wytch::Page to wytch/page
+  path_segments = klass.path.split('::').map(&:downcase)
+  
+  # Create directory structure
+  dir_path = File.join(API_CONTENT_DIR, *path_segments[0..-2])
+  FileUtils.mkdir_p(dir_path) if path_segments.length > 1
+  
+  # Create content file
+  file_path = File.join(API_CONTENT_DIR, *path_segments) + '.rb'
+  
+  File.write(file_path, <<~RUBY)
+    # frozen_string_literal: true
+    
+    view WytchSite::ApiClassView
+    
+    @metadata[:title] = "#{klass.path}"
+    @metadata[:yard_path] = "#{klass.path}"
+  RUBY
+  
+  puts "  Created #{file_path.sub(API_CONTENT_DIR + '/', '')}"
+end
+
+puts "\nGenerated #{YARD::Registry.all(:class).count} API documentation pages"
+puts "Run 'wytch build' to build the site"

data/website/config.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+Wytch.configure do |site|
+  site.page_class = "WytchSite::Page"
+  # site.base_url = "https://example.com"
+end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

data/website/content/index.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+view WytchSite::HomeView
+
+@metadata[:title] = "Wytch"
+@metadata[:description] = "A minimal static site generator"

data/website/content/sitemap.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+add WytchSite::SitemapHelper
+view WytchSite::SitemapView

data/website/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "wytch-site",
+  "version": "0.1.0",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "dev": "vite",
+    "build": "vite build"
+  },
+  "devDependencies": {
+    "@jihchi/vite-plugin-rescript": "^7.1.0",
+    "rescript": "^11.1.4",
+    "tailwindcss": "^4.1.0",
+    "vite": "^7.2.2"
+  },
+  "dependencies": {
+    "@rescript/core": "^1.6.1"
+  }
+}

data/website/public/robots.txt

@@ -0,0 +1,2 @@
+User-agent: *
+Allow: /

data/website/rescript.json

@@ -0,0 +1,18 @@
+{
+  "name": "wytch-site",
+  "sources": [
+    {
+      "dir": "assets",
+      "subdirs": true
+    }
+  ],
+  "package-specs": [
+    {
+      "module": "esmodule",
+      "in-source": false
+    }
+  ],
+  "suffix": ".res.js",
+  "bs-dependencies": ["@rescript/core"],
+  "bsc-flags": ["-open RescriptCore"]
+}

data/website/src/wytch_site/api_class_view.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module WytchSite
+  class ApiClassView < Phlex::HTML
+    def initialize(page)
+      @page = page
+      @klass = @page.yard_object
+    end
+
+    def view_template
+      render Layout.new(@page) do
+        article do
+          header do
+            h1 { @klass.path }
+            p(class: "summary") { @klass.docstring.summary } unless @klass.docstring.summary.empty?
+          end
+
+          unless @klass.docstring.to_s.empty?
+            section(class: "description") do
+              h2 { "Description" }
+              div { unsafe_raw markdown_to_html(@klass.docstring.to_s) }
+            end
+          end
+
+          # Public methods
+          public_methods = @klass.meths(visibility: :public).reject { |m| m.name == :initialize }
+          if public_methods.any?
+            section(class: "methods") do
+              h2 { "Methods" }
+              public_methods.each do |method|
+                render_method(method)
+              end
+            end
+          end
+        end
+      end
+    end
+
+    private
+
+    def render_method(method)
+      article(class: "method", id: method.name) do
+        h3 { code { method.signature } }
+        
+        unless method.docstring.to_s.empty?
+          div(class: "method-description") do
+            unsafe_raw markdown_to_html(method.docstring.to_s)
+          end
+        end
+
+        # Parameters
+        param_tags = method.tags.select { |t| t.tag_name == "param" }
+        if param_tags.any?
+          dl(class: "parameters") do
+            dt { "Parameters:" }
+            param_tags.each do |tag|
+              dd do
+                code { tag.name }
+                span { " (#{tag.types.join(', ')})" } if tag.types
+                plain " — #{tag.text}" if tag.text
+              end
+            end
+          end
+        end
+
+        # Returns
+        return_tags = method.tags.select { |t| t.tag_name == "return" }
+        if return_tags.any?
+          dl(class: "returns") do
+            dt { "Returns:" }
+            return_tags.each do |tag|
+              dd do
+                span { "(#{tag.types.join(', ')})" } if tag.types
+                plain " — #{tag.text}" if tag.text
+              end
+            end
+          end
+        end
+      end
+    end
+
+    def markdown_to_html(text)
+      # Simple markdown rendering - just handle basic formatting
+      text.gsub(/`([^`]+)`/, '<code>\1</code>')
+          .gsub(/\*\*([^*]+)\*\*/, '<strong>\1</strong>')
+          .gsub(/\n\n/, '</p><p>')
+          .then { |s| "<p>#{s}</p>" }
+    end
+  end
+end

data/website/src/wytch_site/home_view.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module WytchSite
+  class HomeView < Phlex::HTML
+    def initialize(page)
+      @page = page
+    end
+
+    def view_template
+      render Layout.new(@page) do
+        h1 { @page.metadata[:title] }
+        p { @page.metadata[:description] }
+        
+        section do
+          h2 { "API Documentation" }
+          ul do
+            api_pages.each do |page|
+              li { a(href: page.path) { page.metadata[:title] } }
+            end
+          end
+        end
+      end
+    end
+    
+    private
+    
+    def api_pages
+      Wytch.site.pages.values
+        .select { |p| p.path.start_with?('/api/') }
+        .sort_by { |p| p.metadata[:title] }
+    end
+  end
+end

data/website/src/wytch_site/layout.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module WytchSite
+  class Layout < Phlex::HTML
+    def initialize(page)
+      @page = page
+    end
+
+    def view_template(&block)
+      doctype
+
+      html do
+        head do
+          meta charset: "utf-8"
+          title { @page.metadata[:title] }
+          meta name: "description", content: @page.metadata[:description] if @page.metadata[:description]
+          meta name: "viewport", content: "width=device-width, initial-scale=1.0"
+
+          # Vite assets
+          if ENV["RACK_ENV"] == "development"
+            script src: "http://localhost:6970/@vite/client", type: "module"
+            link rel: "stylesheet", href: "http://localhost:6970/assets/main.css"
+            script src: "http://localhost:6970/assets/Main.res", type: "module"
+          else
+            link rel: "stylesheet", href: "/assets/main.css"
+            script src: "/assets/app.js", type: "module"
+          end
+        end
+
+        body(&block)
+      end
+    end
+  end
+end

data/website/src/wytch_site/page.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'yard'
+
+module WytchSite
+  class Page < Wytch::Page
+    def yard_object
+      return nil unless @metadata[:yard_path]
+      
+      # Parse YARD if registry is empty
+      if YARD::Registry.all.empty?
+        YARD.parse(File.expand_path('../../../lib/**/*.rb', __dir__))
+      end
+      
+      YARD::Registry.at(@metadata[:yard_path])
+    end
+  end
+end

data/{lib/wytch/templates/src/site/sitemap_helper.rb.tt → website/src/wytch_site/sitemap_helper.rb}

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module <%= @site_module %>
+module WytchSite
   module SitemapHelper
     def path
       "/sitemap.xml"

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module <%= @site_module %>
+module WytchSite
   class SitemapView
     def initialize(page)
       @page = page

data/website/vite.config.js

@@ -0,0 +1,26 @@
+import { defineConfig } from "vite";
+import createReScriptPlugin from "@jihchi/vite-plugin-rescript";
+
+export default defineConfig({
+  plugins: [
+    createReScriptPlugin({
+      loader: {
+        suffix: ".res.js",
+      },
+    }),
+  ],
+  build: {
+    outDir: "build/assets",
+    manifest: true,
+    rollupOptions: {
+      input: {
+        main: "./assets/main.css",
+        app: "./assets/Main.res",
+      },
+    },
+  },
+  server: {
+    port: 6970,
+    strictPort: false,
+  },
+});

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wytch
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Jared Norman
@@ -131,6 +131,8 @@ files:
 - lib/wytch/server.rb
 - lib/wytch/site.rb
 - lib/wytch/site_code_loader_middleware.rb
+- lib/wytch/sitemap_helper.rb
+- lib/wytch/sitemap_view.rb
 - lib/wytch/templates/Gemfile.tt
 - lib/wytch/templates/config.rb.tt
 - lib/wytch/templates/content/feed.rb.tt
@@ -150,11 +152,38 @@ files:
 - lib/wytch/templates/src/site/page.rb.tt
 - lib/wytch/templates/src/site/post_helpers.rb.tt
 - lib/wytch/templates/src/site/post_view.rb.tt
-- lib/wytch/templates/src/site/sitemap_helper.rb.tt
-- lib/wytch/templates/src/site/sitemap_view.rb.tt
 - lib/wytch/templates/vite.config.js.tt
 - lib/wytch/version.rb
 - sig/wytch.rbs
+- website/.gitignore
+- website/Gemfile
+- website/Gemfile.lock
+- website/assets/Main.res
+- website/assets/main.css
+- website/bin/generate_api_docs
+- website/config.rb
+- website/content/api/wytch/builder.rb
+- website/content/api/wytch/cli.rb
+- website/content/api/wytch/contentloader.rb
+- website/content/api/wytch/error.rb
+- website/content/api/wytch/once.rb
+- website/content/api/wytch/page.rb
+- website/content/api/wytch/reloadcoordinator.rb
+- website/content/api/wytch/server.rb
+- website/content/api/wytch/site.rb
+- website/content/api/wytch/sitecodeloadermiddleware.rb
+- website/content/index.rb
+- website/content/sitemap.rb
+- website/package.json
+- website/public/robots.txt
+- website/rescript.json
+- website/src/wytch_site/api_class_view.rb
+- website/src/wytch_site/home_view.rb
+- website/src/wytch_site/layout.rb
+- website/src/wytch_site/page.rb
+- website/src/wytch_site/sitemap_helper.rb
+- website/src/wytch_site/sitemap_view.rb
+- website/vite.config.js
 homepage: https://github.com/SuperGoodSoft/wytch
 licenses:
 - MIT