static-site-builder 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 34651b912c8819f93ee3dd7dda4209674306e91ff9040d8343671412ba4a9873
+  data.tar.gz: 32ac2a4ce16874db16d7990607dbc557ab18fa0235670681377aabb0baf78684
+SHA512:
+  metadata.gz: 96ace8067d05e208f9d26061962558fc9bfef30196e703be13249573612fb674ab496e6e052522e5c8ab6006b39b6825108d89a360323b5c4e6d2e9c02badc96
+  data.tar.gz: 2656f4592bf359cd186284ebbba773e83772fda781121e9515cee27d9f72b7fa7e6520c23858464842da95c9fab197782c7a4b510ef2b7cf3cbb0b2e7207be8d

data/ARCHITECTURE.md

@@ -0,0 +1,61 @@
+# Architecture
+
+This project is a **generator tool**, similar to `rails new`. It creates static site projects that use standard Ruby gems.
+
+## Structure
+
+```
+static-site-generator/
+├── lib/
+│   └── generator.rb          # Main generator logic
+├── bin/
+│   └── generate              # CLI entry point
+├── exe/
+│   └── static-site-generator # Gem executable
+└── templates/                # Template files (future)
+```
+
+## How It Works
+
+1. **Generator** (`static-site-generator` gem)
+   - Creates project structure
+   - Generates Gemfile with dependencies
+   - Creates config files
+   - Sets up build tasks
+
+2. **Builder Gem** (`static-site-builder` gem) - **Separate gem**
+   - Handles ERB/Phlex compilation
+   - Manages asset copying
+   - Generates importmap JSON
+   - Outputs static HTML
+
+3. **Standard Gems** - Used by generated sites
+   - `importmap-rails` - Importmap support
+   - `phlex-rails` - Phlex components
+   - `static-site-builder` - Core builder functionality
+
+## Generated Site Structure
+
+```
+my-site/
+├── Gemfile              # Dependencies
+├── package.json         # JS dependencies (if needed)
+├── Rakefile            # Build tasks
+├── config/
+│   └── importmap.rb    # Importmap config
+├── app/
+│   ├── views/
+│   ├── javascript/
+│   └── assets/
+└── lib/
+    └── site_builder.rb  # Thin wrapper using static-site-builder gem
+```
+
+## Separation of Concerns
+
+- **Generator** - Creates projects (this repo)
+- **Builder** - Compiles sites (`static-site-builder` gem)
+- **Standard Gems** - Provide functionality (importmap-rails, etc.)
+
+This keeps the generator lightweight and maintainable.
+

data/CHANGELOG.md

@@ -0,0 +1,36 @@
+# Changelog
+
+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.0.1] - 2025-11-21
+
+### Added
+- Initial release of static-site-builder gem
+- Generator for creating new static site projects
+- Builder for compiling ERB templates to static HTML
+- Support for multiple template engines (ERB, Phlex)
+- 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
+- Layout support with nested layouts
+- Importmap JSON generation
+- Asset copying (JavaScript, CSS, vendor files, static files)
+- Comprehensive test suite
+- YARD documentation
+- CI/CD setup (GitHub Actions)
+
+### Changed
+- Vendor JavaScript files are automatically copied directly from `node_modules` to `dist/assets/javascripts/` during build
+- Removed requirement for `vendor/javascript/` folder - vendor files are copied automatically based on importmap configuration
+- Generator no longer creates vendor files during project generation
+
+### Fixed
+- Added warning messages when vendor files cannot be found in `node_modules`
+- Updated base64 dependency comments to clarify requirement for Ruby 3.4+
+
+[0.0.1]: https://github.com/Ancez/static-site-builder/releases/tag/v0.0.1
+

data/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2025 Static Site Builder Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/README.md

@@ -0,0 +1,482 @@
+# Static Site Builder
+
+A Ruby-based generator and builder for creating static HTML sites with working JavaScript. **No backend required** - just compile your templates to static HTML and deploy anywhere.
+
+## Main Objective
+
+Generate static HTML pages with JavaScript files that work. Choose your own stack:
+
+- **Template Engine**: ERB or Phlex
+- **JavaScript Bundler**: Importmap, ESBuild, Webpack, Vite, or none
+- **CSS Framework**: TailwindCSS, shadcn/ui, or plain CSS
+- **JavaScript Framework**: Stimulus, React, Vue, Alpine.js, or vanilla JS
+
+## Installation
+
+```bash
+gem install static-site-builder
+# or
+git clone https://github.com/Ancez/static-site-builder
+cd static-site-builder
+bundle install
+```
+
+## Quick Start
+
+### Option 1: Install as a gem
+```bash
+gem install static-site-builder
+static-site-builder new my-site
+```
+
+### Option 2: Use directly from repo
+```bash
+git clone https://github.com/Ancez/static-site-builder
+cd static-site-builder
+bundle install
+ruby bin/generate my-site
+```
+
+You'll be prompted to choose your stack using an interactive menu with arrow key navigation. Generated sites use:
+- `static-site-builder` gem for compilation
+- Standard gems (importmap-rails, phlex-rails, etc.) for functionality
+- npm packages for JS bundlers and frameworks
+
+## What Gets Generated
+
+A clean project structure that depends on gems:
+
+```
+my-site/
+├── Gemfile              # Dependencies (static-site-builder, importmap-rails, etc.)
+├── package.json         # JS dependencies (if needed)
+├── Rakefile            # Build tasks
+├── config/
+│   └── importmap.rb    # Importmap config (if using importmap)
+├── app/
+│   ├── views/
+│   │   ├── layouts/
+│   │   ├── pages/
+│   │   └── components/     # Reusable components/partials
+│   ├── javascript/
+│   └── assets/
+└── lib/
+    └── site_builder.rb   # Compiles your site
+```
+
+## How It Works
+
+1. **Generator** (`static-site-generator`) - Creates the project structure
+2. **Builder Gem** (`static-site-builder`) - Handles ERB/Phlex compilation
+3. **Standard Gems** - importmap-rails, phlex-rails, etc. for functionality
+4. **Build Tools** - Rake tasks that use the builder gem
+
+## Features
+
+- 🎯 **Static HTML output** - No server-side rendering needed
+- 🔧 **Flexible stack** - Choose what works for you
+- 📦 **Gem-based** - Uses existing Ruby gems, not custom code
+- 🚀 **Fast builds** - Compile once, deploy everywhere
+- 🎨 **Component support** - ERB or Phlex components
+- 📱 **Modern JS** - ES modules, importmaps, or bundlers
+
+## Supported Stacks
+
+### Template Engines
+- **ERB** - Ruby's embedded Ruby templates
+- **Phlex** - Ruby component library (via phlex-rails gem)
+
+### JavaScript Bundlers
+- **Importmap** - No bundling, use ES modules directly (via importmap-rails gem)
+- **ESBuild** - Fast JavaScript bundler
+- **Webpack** - Powerful bundler with plugins
+- **Vite** - Next-generation frontend tooling
+- **None** - Vanilla JavaScript, no bundling
+
+### CSS Frameworks
+- **TailwindCSS** - Utility-first CSS framework
+- **shadcn/ui** - Re-usable components built with Tailwind
+- **Plain CSS** - Write your own styles
+
+### JavaScript Frameworks
+- **Stimulus** - Modest JavaScript framework
+- **React** - Popular UI library
+- **Vue** - Progressive JavaScript framework
+- **Alpine.js** - Minimal framework for HTML
+- **Vanilla JS** - No framework
+
+## Building Powerful Websites
+
+### Using ERB Templates
+
+Create pages in `app/views/pages/` with frontmatter:
+
+```erb
+---
+title: My Page
+description: A great page
+---
+
+<h1><%= @title %></h1>
+<p><%= @description %></p>
+```
+
+Use layouts in `app/views/layouts/application.html.erb`:
+
+```erb
+<!DOCTYPE html>
+<html>
+<head>
+  <title><%= @title || "My Site" %></title>
+</head>
+<body>
+  <%= yield %>
+</body>
+</html>
+```
+
+### Using Phlex Components
+
+Create reusable components in `app/views/components/`:
+
+```ruby
+class Button < Phlex::HTML
+  def initialize(text:, href:, variant: "primary")
+    @text = text
+    @href = href
+    @variant = variant
+  end
+
+  def template
+    a(href: @href, class: "btn btn-#{@variant}") { @text }
+  end
+end
+```
+
+Use in pages:
+
+```ruby
+class HomePage < Phlex::HTML
+  def template
+    div do
+      h1 { "Welcome" }
+      render Button.new(text: "Get Started", href: "/about")
+    end
+  end
+end
+```
+
+### JavaScript with Importmap
+
+No bundling needed - use ES modules directly:
+
+```javascript
+// app/javascript/application.js
+import { Application } from "@hotwired/stimulus"
+import HelloController from "./controllers/hello_controller"
+
+window.Stimulus = Application.start()
+Stimulus.register("hello", HelloController)
+```
+
+### JavaScript with Bundlers
+
+Use ESBuild, Webpack, or Vite for modern tooling:
+
+```javascript
+// app/javascript/index.js
+import React from 'react'
+import { createRoot } from 'react-dom/client'
+
+function App() {
+  return <h1>Hello from React!</h1>
+}
+
+const root = createRoot(document.getElementById('app'))
+root.render(<App />)
+```
+
+### CSS with TailwindCSS
+
+Use utility classes directly in templates:
+
+```erb
+<div class="container mx-auto px-4">
+  <h1 class="text-4xl font-bold text-gray-900">Hello World</h1>
+</div>
+```
+
+### CSS with shadcn/ui
+
+Install components and use them in your templates:
+
+```bash
+npx shadcn-ui@latest add button
+```
+
+## Examples
+
+### ERB + Importmap + Stimulus + TailwindCSS
+```bash
+static-site-builder new my-site
+# Choose: ERB, Importmap, TailwindCSS, Stimulus
+```
+
+### Phlex + ESBuild + React + shadcn
+```bash
+static-site-builder new my-site
+# Choose: Phlex, ESBuild, shadcn/ui, React
+```
+
+## Requirements
+
+### For Importmap Projects
+
+When using **Importmap** as your JavaScript bundler:
+
+1. **Install npm dependencies**:
+   ```bash
+   npm install
+   ```
+
+2. **Build your site** - vendor files are automatically copied from `node_modules` to `dist/assets/javascripts/` during the build:
+   ```bash
+   rake build:all
+   ```
+
+The build process automatically copies required vendor JavaScript files directly from `node_modules` to `dist/assets/javascripts/` based on your importmap configuration. No intermediate `vendor/javascript/` folder is needed.
+
+## Development
+
+### Running Your Site Locally
+
+After generating a site, you can run it locally with auto-rebuild and live reload:
+
+```bash
+cd my-site
+bundle install
+npm install  # Required for importmap projects and JS frameworks
+
+# Start development server (auto-rebuilds on file changes)
+rake dev:server
+```
+
+This will:
+- Build your site to `dist/`
+- Start a web server at `http://localhost:3000`
+- Watch for file changes and rebuild automatically
+- Auto-refresh your browser when files change
+
+You can change the port with:
+```bash
+PORT=8080 rake dev:server
+```
+
+### Building for Production
+
+```bash
+# Build everything (assets + HTML)
+rake build:all
+
+# Or just HTML
+rake build:html
+
+# Output is in dist/ directory
+```
+
+## Deployment
+
+The `dist/` directory contains your complete static site and can be deployed to any static hosting provider.
+
+### Cloudflare Pages
+
+1. **Connect your repository** to Cloudflare Pages in the Cloudflare dashboard
+
+2. **Build settings**:
+   - **Build command**: `bundle install && npm install && bundle exec rake build:all`
+   - **Build output directory**: `dist`
+   - **Root directory**: (leave empty or set to repository root)
+
+3. **Environment variables** (if needed):
+   - `RUBY_VERSION`: Set to your Ruby version (e.g., `3.4`)
+   - `NODE_VERSION`: Set to your Node.js version (e.g., `24`)
+
+4. **Deploy**: Cloudflare Pages will automatically build and deploy on every push to your main branch
+
+**Note**: Cloudflare Pages supports Ruby and Node.js builds. Ensure your `Gemfile` and `package.json` are properly configured.
+
+### Vercel
+
+1. **Install Vercel CLI** (optional):
+   ```bash
+   npm i -g vercel
+   ```
+
+2. **Deploy**:
+   ```bash
+   # Build locally first
+   bundle install && npm install && bundle exec rake build:all
+   
+   # Deploy
+   vercel --prod
+   ```
+
+   Or connect your repository in the Vercel dashboard with these settings:
+   - **Build Command**: `bundle install && npm install && bundle exec rake build:all`
+   - **Output Directory**: `dist`
+   - **Install Command**: `bundle install && npm install`
+
+3. **Configuration file** (optional `vercel.json`):
+   ```json
+   {
+     "buildCommand": "bundle install && npm install && bundle exec rake build:all",
+     "outputDirectory": "dist",
+     "installCommand": "bundle install && npm install"
+   }
+   ```
+
+### Netlify
+
+1. **Create `netlify.toml`** in your project root:
+   ```toml
+   [build]
+     command = "bundle install && npm install && bundle exec rake build:all"
+     publish = "dist"
+   
+   [build.environment]
+     RUBY_VERSION = "3.4"
+     NODE_VERSION = "24"
+   ```
+
+2. **Deploy**:
+   - Connect your repository in Netlify dashboard
+   - Netlify will automatically detect `netlify.toml` and use those settings
+   - Or use Netlify CLI: `netlify deploy --prod`
+
+### GitHub Pages
+
+1. **Using GitHub Actions** (recommended):
+
+   Create `.github/workflows/deploy.yml`:
+   ```yaml
+   name: Deploy to GitHub Pages
+   
+   on:
+     push:
+       branches: [ main ]
+   
+   jobs:
+     deploy:
+       runs-on: ubuntu-latest
+       steps:
+         - uses: actions/checkout@v4
+         
+         - name: Set up Ruby
+           uses: ruby/setup-ruby@v1
+           with:
+             ruby-version: 3.4
+             bundler-cache: true
+         
+         - name: Set up Node.js
+           uses: actions/setup-node@v4
+           with:
+             node-version: '24'
+             cache: 'npm'
+         
+         - name: Install dependencies
+           run: |
+             bundle install
+             npm install
+         
+        - name: Build site
+          run: bundle exec rake build:all
+          # Note: Vendor files will be automatically copied from node_modules during build
+         
+         - name: Deploy to GitHub Pages
+           uses: peaceiris/actions-gh-pages@v4
+           with:
+             github_token: ${{ secrets.GITHUB_TOKEN }}
+             publish_dir: ./dist
+   ```
+
+2. **Enable GitHub Pages** in your repository settings:
+   - Go to Settings → Pages
+   - Source: GitHub Actions
+
+### Other Static Hosts
+
+For any static hosting provider (AWS S3, Azure Static Web Apps, etc.):
+
+1. **Build locally**:
+   ```bash
+   bundle install
+   npm install
+   bundle exec rake build:all
+   ```
+
+2. **Upload `dist/` directory** to your hosting provider
+
+3. **Configure** your host to serve from the `dist` directory
+
+### CI/CD Considerations
+
+- **Vendor files**: Vendor files are automatically copied from `node_modules` to `dist/` during build - no vendor folder needed
+- **Dependencies**: Both Ruby (`Gemfile`) and Node.js (`package.json`) dependencies are needed for the build
+- **Build order**: Install dependencies → Build assets → Build HTML
+- **Ruby/Node versions**: Specify versions in your CI/CD configuration to ensure consistent builds
+
+### Generator Development
+
+```bash
+# Clone the repo
+git clone https://github.com/Ancez/static-site-builder
+cd static-site-builder
+
+# Install dependencies
+bundle install
+
+# Run tests
+bundle exec rspec
+
+# Build the gem
+gem build static-site-builder.gemspec
+```
+
+## Testing
+
+The project includes comprehensive test coverage:
+
+- Unit tests for Generator and Builder classes
+- Integration tests for full build workflows
+- End-to-end tests for complete workflows
+- Tests for all stack combinations
+
+Run tests with:
+```bash
+bundle exec rspec
+```
+
+View coverage report:
+```bash
+open coverage/index.html
+```
+
+## Architecture
+
+This generator follows the Rails pattern:
+- **Generator gem** - Creates project structure
+- **Builder gem** - Handles compilation (separate gem: `static-site-builder`)
+- **Standard gems** - Reuse existing Ruby gems
+- **Generated code** - Minimal, uses gem dependencies
+
+## Contributing
+
+Contributions welcome! Especially:
+- New template engine support
+- New bundler integrations
+- New CSS framework setups
+- Documentation improvements
+
+## License
+
+MIT

data/bin/generate

@@ -0,0 +1,64 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative "../lib/static_site_builder"
+require "tty-prompt"
+
+def main
+  if ARGV.empty?
+    puts "Usage: ruby bin/generate <app-name>"
+    puts "   or: static-site-builder new <app-name>"
+    exit 1
+  end
+
+  app_name = ARGV[0]
+
+  if Dir.exist?(app_name)
+    puts "Error: Directory '#{app_name}' already exists"
+    exit 1
+  end
+
+  puts "Generating static site: #{app_name}"
+  puts "=" * 50
+
+  prompt = TTY::Prompt.new
+
+  template_engine = prompt.select(
+    "Template engine?",
+    StaticSiteBuilder::Generator::TEMPLATE_ENGINES.map(&:capitalize),
+    default: 1
+  ).downcase
+
+  js_bundler = prompt.select(
+    "JavaScript bundler?",
+    StaticSiteBuilder::Generator::JS_BUNDLERS.map(&:capitalize),
+    default: 1
+  ).downcase
+
+  css_framework = prompt.select(
+    "CSS framework?",
+    StaticSiteBuilder::Generator::CSS_FRAMEWORKS.map(&:capitalize),
+    default: 1
+  ).downcase
+
+  js_framework = prompt.select(
+    "JavaScript framework?",
+    StaticSiteBuilder::Generator::JS_FRAMEWORKS.map(&:capitalize),
+    default: 1
+  ).downcase
+
+  options = {
+    template_engine: template_engine,
+    js_bundler: js_bundler,
+    css_framework: css_framework,
+    js_framework: js_framework
+  }
+
+  generator = StaticSiteBuilder::Generator.new(app_name, options)
+  generator.generate
+rescue Interrupt
+  puts "\n\nGeneration cancelled."
+  exit 1
+end
+
+main if __FILE__ == $PROGRAM_NAME