static-site-builder 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cfa2d9ecc9c90e973fd3cecd6c04e2aad09a80fa29ba0bd78a95b524206986c4
-  data.tar.gz: 2394ef787382dec487390d4b05a1add37a27e3e9154f032f82d9972fae25924e
+  metadata.gz: 4ec7765f3cc618a791a6d655fed75fe39f43a09d9c697cc71135d17160dbd27f
+  data.tar.gz: 74ace48bd713ba712607509baf63a80095cd610395be622b59c3e552336f10df
 SHA512:
-  metadata.gz: 89d7320b08a5e90d12f7c155a8f2e2b0a7f907b9ff18c53c81632dcc5f49cd90e34d41b1533baf760bd4866a07aa06ad95a6f84ac4d34600ed8a86296a24b25e
-  data.tar.gz: 7db49008d74e0aa849e084edb8a8ccc515c1764c3d97e3fb820e952697d3187dd3723e4f4edb4dc284b1dff5ccf5549de7de282413c4616d619d7a8addb693da
+  metadata.gz: 358643b7c2cb4bd56693c18fa4f57114da85b519a1423e319a55d1b4d7ee0d3190768985225539e6c65f9eed044d96fced689d5464d39fb0db85238dbcb4e6d4
+  data.tar.gz: a8ab43edfdac947a34e0222c181037213120eb1f9dea91c924f218e974908c51491135ce475aadde6552bedd65698cf05a54e18af60b73669b6c6fe7134cb84a

data/CHANGELOG.md

@@ -5,6 +5,27 @@ 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.1.4] - 2025-11-22
+
+### Added
+- Generator now automatically creates `lib/page_helpers.rb` with `PageHelpers::PAGES` structure for page metadata
+- Generator now automatically creates `config/sitemap.rb` for sitemap generation
+- `sitemap_generator` gem is now automatically included in generated Gemfiles
+- `build:sitemap` task is automatically added to generated Rakefiles
+- Sitemap generation is integrated into `build:all` task
+
+### Changed
+- Page metadata is now managed via `PageHelpers::PAGES` hash instead of frontmatter
+- README updated to reflect `PageHelpers::PAGES` approach (frontmatter example removed)
+- ActionView requirement changed from `>= 8.0` to `~> 7.1` for Ruby 3.1 compatibility
+- Generated layouts now use `@title` and `@js_modules` instance variables instead of frontmatter
+
+### Fixed
+- Fixed `js_modules` variable reference in generated layouts (now uses `@js_modules`)
+- Fixed PageHelpers metadata loading to occur before page content rendering, allowing partials to access `@title`, `@description`, etc.
+- Removed all frontmatter parsing code and references
+- Updated all specs to use `PageHelpers::PAGES` instead of frontmatter
+
 ## [0.1.3] - 2025-11-22
 
 ### Added
@@ -17,7 +38,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Changed
 - Replaced raw ERB implementation with ActionView::Base for template rendering
 - Render method now uses ActionView's rendering system, matching Rails behaviour exactly
-- Partials automatically receive page variables (frontmatter, js_modules, importmap_json, current_page)
+- Partials automatically receive page variables (@js_modules, importmap_json, current_page)
 - Improved error messages for missing partials (converted from ActionView format for backwards compatibility)
 - Template annotations now preserve both page and layout annotations correctly
 
@@ -39,7 +60,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - `render` helper method for ERB templates to include partials
 - Support for rendering partials from `app/views/shared/` directory
 - Partial files should be named with `_` prefix (e.g., `_header.html.erb`)
-- Partials have access to page variables (frontmatter, js_modules, etc.)
+- Partials have access to page variables (@js_modules, etc.)
 
 ### Changed
 - Improved ERB compilation to support partial rendering
@@ -54,7 +75,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Support for multiple JavaScript bundlers (Importmap, ESBuild, Webpack, Vite, None)
 - Support for multiple CSS frameworks (TailwindCSS, shadcn/ui, Plain CSS)
 - Support for multiple JavaScript frameworks (Stimulus, React, Vue, Alpine.js, Vanilla)
-- Frontmatter parsing for ERB pages
+- Page metadata via `PageHelpers::PAGES` hash
 - Layout support with nested layouts
 - Importmap JSON generation
 - Asset copying (JavaScript, CSS, vendor files, static files)

data/README.md

@@ -48,11 +48,12 @@ A clean project structure that depends on gems:
 
 ```
 my-site/
-├── Gemfile              # Dependencies (static-site-builder, importmap-rails, etc.)
+├── Gemfile              # Dependencies (static-site-builder, sitemap_generator, etc.)
 ├── package.json         # JS dependencies (if needed)
-├── Rakefile            # Build tasks
+├── Rakefile            # Build tasks (includes sitemap generation)
 ├── config/
-│   └── importmap.rb    # Importmap config (if using importmap)
+│   ├── importmap.rb    # Importmap config (if using importmap)
+│   └── sitemap.rb      # Sitemap generation config
 ├── app/
 │   ├── views/
 │   │   ├── layouts/
@@ -61,7 +62,8 @@ my-site/
 │   ├── javascript/
 │   └── assets/
 └── lib/
-    └── site_builder.rb   # Compiles your site
+    ├── site_builder.rb   # Compiles your site
+    └── page_helpers.rb   # Page metadata (title, description, etc.)
 ```
 
 ## How It Works
@@ -109,18 +111,32 @@ my-site/
 
 ### Using ERB Templates
 
-Create pages in `app/views/pages/` with frontmatter:
+Create pages in `app/views/pages/`:
 
 ```erb
----
-title: My Page
-description: A great page
----
-
 <h1><%= @title %></h1>
 <p><%= @description %></p>
 ```
 
+Page metadata is automatically configured in `lib/page_helpers.rb` (generated automatically):
+
+```ruby
+module PageHelpers
+  PAGES = {
+    '/' => {
+      title: 'My Page',
+      description: 'A great page',
+      url: 'https://example.com',
+      image: 'https://example.com/image.jpg',
+      priority: 1.0,
+      changefreq: 'weekly'
+    }
+  }.freeze
+end
+```
+
+The builder automatically loads metadata from `PageHelpers::PAGES` and sets `@title`, `@description`, `@url`, and `@image` instance variables for use in your templates. This metadata is also used by the `sitemap_generator` gem for generating sitemaps.
+
 Use layouts in `app/views/layouts/application.html.erb`:
 
 ```erb
@@ -214,6 +230,18 @@ Install components and use them in your templates:
 npx shadcn-ui@latest add button
 ```
 
+### Generating Sitemaps
+
+Sitemap generation is automatically configured when you generate a new site. The `sitemap_generator` gem is included in the Gemfile, and `config/sitemap.rb` is automatically created.
+
+The sitemap is generated from your `PageHelpers::PAGES` metadata during `rake build:all`. Update `config/sitemap.rb` to set your domain:
+
+```ruby
+SitemapGenerator::Sitemap.default_host = 'https://yourdomain.com'
+```
+
+The sitemap will be generated in `dist/sitemaps/sitemap.xml.gz` during the build process.
+
 ## Examples
 
 ### ERB + Importmap + Stimulus + TailwindCSS

data/lib/generator.rb

@@ -68,6 +68,8 @@ module StaticSiteBuilder
       create_config_files
       create_app_structure
       create_build_files
+      create_page_helpers
+      create_sitemap_config
       create_example_pages
       create_readme
       create_gitignore
@@ -104,7 +106,8 @@ module StaticSiteBuilder
       gems = [
         "rake",
         "static-site-builder",
-        "webrick"  # Required for dev server (removed from stdlib in Ruby 3.0+)
+        "webrick",  # Required for dev server (removed from stdlib in Ruby 3.0+)
+        "sitemap_generator"  # For generating sitemaps from PageHelpers::PAGES
       ]
       gems << "importmap-rails" if @options[:js_bundler] == "importmap"
       gems << "phlex-rails" if @options[:template_engine] == "phlex"
@@ -186,6 +189,78 @@ module StaticSiteBuilder
       create_rails_config if @options[:edit_rails]
     end
 
+    def create_page_helpers
+      content = <<~RUBY
+        # frozen_string_literal: true
+
+        module PageHelpers
+          # Page metadata configuration
+          # The builder automatically loads this and sets @title, @description, @url, and @image
+          # instance variables for use in your templates.
+          # This metadata is also used by sitemap_generator for generating sitemaps.
+          PAGES = {
+            '/' => {
+              title: 'Home',
+              description: 'Welcome to my site',
+              url: 'https://example.com',
+              image: 'https://example.com/image.jpg',
+              priority: 1.0,
+              changefreq: 'weekly'
+            }
+          }.freeze
+
+          def page_title(path = nil)
+            path ||= @current_page
+            PAGES[path]&.fetch(:title) || 'Site'
+          end
+
+          def page_description(path = nil)
+            path ||= @current_page
+            PAGES[path]&.fetch(:description) || 'A static site'
+          end
+
+          def page_url(path = nil)
+            path ||= @current_page
+            PAGES[path]&.fetch(:url) || 'https://example.com'
+          end
+
+          def page_image(path = nil)
+            path ||= @current_page
+            PAGES[path]&.fetch(:image) || 'https://example.com/image.jpg'
+          end
+        end
+      RUBY
+
+      write_file("lib/page_helpers.rb", content)
+    end
+
+    def create_sitemap_config
+      content = <<~RUBY
+        # frozen_string_literal: true
+
+        require 'sitemap_generator'
+        require_relative '../lib/page_helpers'
+
+        # Configure sitemap generator
+        # Update default_host to your actual domain
+        SitemapGenerator::Sitemap.default_host = 'https://example.com'
+        SitemapGenerator::Sitemap.sitemaps_path = 'sitemaps'
+        SitemapGenerator::Sitemap.public_path = 'dist'
+
+        # Generate sitemap from PageHelpers::PAGES
+        SitemapGenerator::Sitemap.create do
+          PageHelpers::PAGES.each do |path, metadata|
+            add path,
+                lastmod: Time.now,
+                priority: metadata[:priority] || 0.5,
+                changefreq: metadata[:changefreq] || 'weekly'
+          end
+        end
+      RUBY
+
+      write_file("config/sitemap.rb", content)
+    end
+
     def create_importmap_config
       content = <<~RUBY
         # frozen_string_literal: true
@@ -410,7 +485,7 @@ module StaticSiteBuilder
         <head>
           <meta charset="UTF-8">
           <meta name="viewport" content="width=device-width, initial-scale=1.0">
-          <title><%= frontmatter['title'] || 'Site' %></title>
+          <title><%= @title || 'Site' %></title>
           <link rel="stylesheet" href="/assets/stylesheets/application.css">
         </head>
         <body>
@@ -470,8 +545,8 @@ module StaticSiteBuilder
       case @options[:js_bundler]
       when "importmap"
         <<~ERB
-          <% if js_modules && !js_modules.empty? %>
-            <% js_modules.each do |module_name| %>
+          <% if @js_modules.present? %>
+            <% @js_modules.each do |module_name| %>
               <script type="module">import "<%= module_name %>";</script>
             <% end %>
           <% else %>
@@ -728,8 +803,8 @@ module StaticSiteBuilder
           require "pathname"
 
           namespace :build do
-            desc "Build everything (HTML + CSS)"
-            task :all => [:html, :css] do
+            desc "Build everything (HTML + CSS + Sitemap)"
+            task :all => [:html, :css, :sitemap] do
               puts "\\n✓ Build complete!"
             end
 
@@ -778,6 +853,11 @@ module StaticSiteBuilder
               ENV["PRODUCTION"] = "true"
               Rake::Task["build:all"].invoke
             end
+
+            desc "Generate sitemap from PageHelpers::PAGES"
+            task :sitemap do
+              require './config/sitemap'
+            end
           end
 
           namespace :dev do
@@ -798,8 +878,8 @@ module StaticSiteBuilder
           require "pathname"
 
           namespace :build do
-            desc "Build everything (HTML)"
-            task :all => [:html] do
+            desc "Build everything (HTML + Sitemap)"
+            task :all => [:html, :sitemap] do
               puts "\\n✓ Build complete!"
             end
 
@@ -820,6 +900,11 @@ module StaticSiteBuilder
               ENV["PRODUCTION"] = "true"
               Rake::Task["build:all"].invoke
             end
+
+            desc "Generate sitemap from PageHelpers::PAGES"
+            task :sitemap do
+              require './config/sitemap'
+            end
           end
 
           namespace :dev do

data/lib/static_site_builder/builder.rb

@@ -337,6 +337,24 @@ module StaticSiteBuilder
       view.instance_variable_set(:@current_page, current_page_path)
       view.instance_variable_set(:@page_content, nil)
       
+      # Set title and metadata from PageHelpers BEFORE rendering page content
+      # This ensures partials rendered within the page have access to metadata
+      page_helpers_path = @root.join('lib', 'page_helpers.rb')
+      begin
+        if page_helpers_path.exist?
+          require page_helpers_path.to_s
+          pages = ::PageHelpers::PAGES rescue nil
+          if pages && pages.is_a?(Hash) && pages.key?(current_page_path)
+            metadata = pages[current_page_path]
+            view.instance_variable_set(:@title, metadata[:title])
+            view.instance_variable_set(:@description, metadata[:description])
+            view.instance_variable_set(:@url, metadata[:url])
+            view.instance_variable_set(:@image, metadata[:image])
+          end
+        end
+      rescue => e
+        # Silently continue if PageHelpers can't be loaded
+      end
       
       # Override render to handle 'footer' -> 'shared/footer' conversion
       # and ensure locals are passed to partials
@@ -413,31 +431,6 @@ module StaticSiteBuilder
         page_content = annotate_template(page_content, relative_template_path.to_s)
       end
 
-      # Set title and metadata from PageHelpers before rendering layout
-      puts "  DEBUG: About to set metadata for #{current_page_path}"
-      page_helpers_path = @root.join('lib', 'page_helpers.rb')
-      puts "  DEBUG: Checking PageHelpers at: #{page_helpers_path} (exists: #{page_helpers_path.exist?})"
-      begin
-        if page_helpers_path.exist?
-          require page_helpers_path.to_s
-          pages = ::PageHelpers::PAGES rescue nil
-          puts "  Pages loaded: #{pages ? 'yes' : 'no'}, keys: #{pages&.keys&.inspect}"
-          if pages && pages.is_a?(Hash) && pages.key?(current_page_path)
-            metadata = pages[current_page_path]
-            view.instance_variable_set(:@title, metadata[:title])
-            view.instance_variable_set(:@description, metadata[:description])
-            view.instance_variable_set(:@url, metadata[:url])
-            view.instance_variable_set(:@image, metadata[:image])
-            puts "  ✓ Set metadata for #{current_page_path}: #{metadata[:title]}"
-          else
-            puts "  ⚠ No metadata found for #{current_page_path}"
-          end
-        end
-      rescue => e
-        puts "  ⚠ Error loading PageHelpers: #{e.class} - #{e.message}"
-        puts e.backtrace.first(3)
-      end
-
       # Render layout using ActionView
       # Instance variables set in the page template are available in the layout
       layout_template = ActionView::Template.new(

data/lib/static_site_builder/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module StaticSiteBuilder
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: static-site-builder
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Lukasz Czapiewski
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '8.0'
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '8.0'
+        version: '7.1'
 - !ruby/object:Gem::Dependency
   name: base64
   requirement: !ruby/object:Gem::Requirement
@@ -128,7 +128,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="