staticky 0.1.1 → 0.3.0

data/lib/staticky.rb

@@ -1,17 +1,27 @@
 # frozen_string_literal: true
 
+require "uri"
+require "delegate"
+
 require "phlex"
+require "dry/container"
 require "dry/system"
 require "dry/configurable"
 require "dry/logger"
-require "uri"
 require "tilt"
+require "staticky-files"
 
 module Staticky
   GEM_ROOT = Pathname.new(__dir__).join("..").expand_path
 end
 
-require_relative "staticky/container"
+require_relative "staticky/pluggable"
+require_relative "staticky/resources/plugins"
+require_relative "staticky/resources/plugins/prelude"
+require_relative "staticky/resources/plugins/phlex"
+require_relative "staticky/routing/plugins"
+require_relative "staticky/routing/plugins/prelude"
+require_relative "staticky/application"
 
 module Staticky
   # DOCS: Module for static site infrastructure such as:
@@ -24,28 +34,30 @@ module Staticky
 
   extend Dry::Configurable
 
-  setting :env, default: :development
-  setting :build_path, default: Pathname.new("build")
+  setting :env, default: ENV.fetch("RACK_ENV", "development").to_sym
+  setting :build_path, default: Pathname(__dir__).join("..", "build")
   setting :root_path, default: Pathname(__dir__)
   setting :logger, default: Dry.Logger(:staticky, template: :details)
+  setting :live_reloading, default: true
   setting :server_logger, default: Dry.Logger(
     :staticky_server,
     template: :details,
     formatter: :rack
   )
 
-  def monitor(...) = container.monitor(...)
-  def server_logger =config.server_logger
+  def monitor(...) = application.monitor(...)
+  def server_logger = config.server_logger
   def logger = config.logger
   def build_path = config.build_path
   def root_path = config.root_path
   def resources = router.resources
-  def router = container[:router]
-  def builder = container[:builder]
-  def generator = container[:generator]
-  def container = Container
+  def router = application[:router]
+  def builder = application[:builder]
+  def generator = application[:generator]
+  def files = application[:files]
+  def application = Application
 
   def env
-    @env ||= Environment.new container.env
+    Environment.new config.env.to_sym
   end
 end

data/site_template/.gitignore

@@ -9,3 +9,17 @@ node_modules
 
 .bundle
 /tmp/
+
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/sdks
+!.yarn/versions
+
+# Swap the comments on the following lines if you wish to use zero-installs
+# In that case, don't forget to run `yarn config set enableGlobalCache false`!
+# Documentation here: https://yarnpkg.com/features/caching#zero-installs
+
+#!.yarn/cache
+.pnp.*

data/site_template/.ruby-version

@@ -1 +1 @@
-3.3.4
+3.3.5

data/site_template/Gemfile

@@ -3,8 +3,7 @@
 source "https://rubygems.org"
 git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
-ruby_version = Pathname.new(__dir__).join(".ruby-version")
-ruby ruby_version.read.strip
+ruby file: ".ruby-version"
 
 gem "protos"
 gem "protos-icon"
@@ -13,7 +12,6 @@ gem "protos-markdown"
 gem "dry-inflector"
 gem "front_matter_parser"
 gem "rack"
-gem "rackup"
 gem "rake"
 gem "rouge"
 gem "staticky", github: "nolantait/staticky", branch: "master"
@@ -28,6 +26,8 @@ group :test do
 end
 
 group :development do
-  gem "rerun"
-  gem "rubocop-inhouse", require: false
+  gem "filewatcher", require: false
+  gem "puma"
+  gem "rubocop"
+  gem "rubocop-inhouse"
 end

data/site_template/Procfile.dev

@@ -1,3 +1,3 @@
-server: bin/bundle exec rackup
-builder: rerun --dir app,lib,content --exit --verbose -- bin/rake site:build
+server: bin/bundle exec puma -C config/puma.rb
+builder: bin/rake site:watch
 vite: bin/vite dev

data/site_template/README.md

@@ -9,7 +9,7 @@ assets by default and hooks into the build command defined in your `Rakefile`
 Your development server runs with `bin/dev`
 
 Everything is ruby, there is no html or erb. It outputs a static site to the
-`build/` folder by default, but that can be configured.
+`./build` folder by default, but that can be configured.
 
 ## Usage
 
@@ -36,7 +36,7 @@ Your site should not be accessible at http://localhost:9292
 
 ## Building
 
-During development `rerun` watches your files and rebuilds the site when they
+During development `filewatcher` watches your files and rebuilds the site when they
 change by running `bin/rake site:build`. These files are served by a Roda app.
 
 In production you simply output the files to a folder and serve them statically
@@ -46,6 +46,26 @@ can be tweaked however you like.
 Building takes all the definitions inside your `config/routes` and outputs
 static files to `./build` or wherever you have configured it.
 
+## Development and hot reloading
+
+By default your site will use `puma` to run a `roda` server that serves the
+files inside your `Staticky.build_path` (`./build` by default).
+
+You can access your site at:
+
+```
+http://localhost:3000
+```
+
+You can change these settings inside your `Procfile.dev` which starts the
+processes required for development.
+
+When your site triggers a rebuild and you are connected to the page. The vite
+server will trigger a page reload after 500ms.
+
+If this is too fast and you find yourself having to refresh the page yourself
+you can tweak this inside your `vite.config.ts`.
+
 ## Views
 
 Views are defined in `app/views`. They should be phlex components and you can
@@ -80,12 +100,12 @@ Staticky.router.define do
   # Write your own custom logic for parsing your markdown
   Dir["content/**/*.md"].each do |file|
     parsed = FrontMatterParser::Parser.parse_file(file, loader:)
+    basenames = file.gsub("content/", "").gsub(".md", "")
+    front_matter = parsed.front_matter.transform_keys(&:to_sym)
 
-    match file.gsub("content/", "").gsub(".md", ""),
-          to: Pages::Post.new(
-            parsed.content,
-            front_matter: parsed.front_matter.transform_keys(&:to_sym)
-          )
+    basename.each do |path|
+      match path, to: Pages::Post.new(parsed.content, front_matter:)
+    end
   end
 end
 ```

data/site_template/Rakefile

@@ -7,12 +7,43 @@ ViteRuby.install_tasks
 desc "Precompile assets"
 task :environment do
   require "./config/boot"
+
+  Staticky.application.monitor(:builder, methods: %i[call]) do |event|
+    Staticky.logger.info "Built site in #{event[:time]}ms"
+  end
 end
 
 namespace :site do
-  desc "Precompile assets"
+  desc "Build the site and its assets into the Staticky.build_path (./build)"
   task build: :environment do
-    Rake::Task["vite:build"].invoke
+    Staticky.logger.info "Building site in #{Staticky.env.name} environment..."
     Staticky.builder.call
   end
+
+  desc "Watch the site and its assets for changes"
+  task watch: :environment do
+    require "filewatcher"
+
+    unless Staticky.build_path.join("500.html").exist?
+      Rake::Task["site:build"].execute
+    end
+
+    Staticky.logger.info "Watching site in #{Staticky.env.name} environment..."
+
+    Filewatcher.new(
+      [
+        "app/**/*.rb",
+        "lib/**/*.rb",
+        "content/**/*"
+      ]
+    ).watch do
+      Staticky.logger.info "Change detected, rebuilding site..."
+      sh("bin/rake site:build") do |ok, res|
+        unless ok
+          Staticky.logger.error "Error rebuilding site:"
+          puts res
+        end
+      end
+    end
+  end
 end

data/site_template/{lib/component.rb → app/views/application_component.rb}

@@ -2,7 +2,7 @@
 
 require "staticky/phlex/view_helpers"
 
-class Component < Protos::Component
+class ApplicationComponent < Protos::Component
   include ViteHelpers
 
   class NullViewContext

data/site_template/app/views/application_layout.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class ApplicationLayout < ApplicationComponent
+end

data/site_template/app/views/application_page.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class ApplicationPage < ApplicationComponent
+  def around_template(&block) = render Layouts::Page.new(&block)
+end

data/site_template/app/views/errors/not_found.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Errors
-  class NotFound < Page
+  class NotFound < ApplicationPage
     include Protos::Typography
 
     def self.layout = Layouts::Error

data/site_template/app/views/errors/service_error.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Errors
-  class ServiceError < Page
+  class ServiceError < ApplicationPage
     include Protos::Typography
 
     def self.layout = Layouts::Error

data/site_template/app/views/layouts/error.rb

@@ -1,12 +1,10 @@
 # frozen_string_literal: true
 
 module Layouts
-  class Error < Layout
-    def view_template(&block)
-      render Layouts::Site.new do
-        div(class: "grid place-items-center h-[--main-scene]") do
-          section(class: "flex flex-col place-items-center gap-sm", &block)
-        end
+  class Error < Site
+    def view_template(&)
+      div(class: "grid place-items-center h-[--main-scene]") do
+        section(class: "flex flex-col place-items-center gap-sm", &)
       end
     end
   end

data/site_template/app/views/layouts/head.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Layouts
-  class Head < Component
+  class Head < ApplicationComponent
     option :title, default: -> { ::Site.title }, reader: false
     option :description, default: -> { ::Site.description }, reader: false
 
@@ -44,10 +44,12 @@ module Layouts
         meta name: "twitter:site", content: ::Site.twitter
         meta name: "twitter:creator", content: ::Site.twitter
 
-        vite_client_tag unless ENV["RACK_ENV"] == "production"
         javascript_tag "application"
 
-        yield if block_given?
+        if Staticky.env.development?
+          vite_client_tag
+          staticky_live_reload_js if Staticky.config.live_reloading
+        end
       end
     end
 

data/site_template/app/views/layouts/site.rb

@@ -1,38 +1,25 @@
 # frozen_string_literal: true
 
 module Layouts
-  class Site < Layout
-    include Phlex::DeferredRender
-
-    def view_template
+  class Site < ApplicationLayout
+    def around_template(&)
       doctype
       html lang: "en", data: { theme: "onedark" } do
-        render Layouts::Head.new(&head)
-
-        body do
-          render UI::Navbar.new(class: css[:navbar])
-          main(class: css[:main], &content)
-          render UI::Footer.new(class: css[:footer])
-        end
+        head
+        body(&)
       end
     end
 
-    def with_head(&block)
-      @head = block
-    end
-
-    def with_content(&block)
-      @content = block
+    def view_template(&block)
+      render UI::Navbar.new(class: css[:navbar])
+      main(**attrs, &block)
+      render UI::Footer.new(class: css[:footer])
     end
 
     private
 
-    def content
-      @content || proc {}
-    end
-
-    def head
-      @head || proc {}
+    def head(&block)
+      render Head.new(&block)
     end
   end
 end

data/site_template/app/views/pages/home.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Pages
-  class Home < Page
+  class Home < ApplicationPage
     include Protos::Typography
 
     def view_template

data/site_template/app/views/ui/footer.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module UI
-  class Footer < Component
+  class Footer < ApplicationComponent
     def view_template
       footer(**attrs) do
         p(class: "opacity-80 text-sm") do

data/site_template/app/views/ui/navbar.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module UI
-  class Navbar < Component
+  class Navbar < ApplicationComponent
     def view_template
       header(**attrs) do
         a(href: "/", class: "btn btn-ghost") { Site.title }

data/site_template/bin/{lint → setup}

@@ -13,6 +13,12 @@ FileUtils.chdir APP_ROOT do
   # This script is idempotent, so that you can run it at any time and get an expectable outcome.
   # Add necessary setup steps to this file.
 
-  puts "== Running rubocop =="
-  system! "bundle exec rubocop --autocorrect-all --fail-level error"
+  puts "== Installing dependencies =="
+  system! "gem install bundler --conservative"
+  system("bundle check") || system!("bundle install")
+
+  system! "bundle binstubs --force bundler rubocop rspec-core vite_ruby rake"
+
+  puts "\n== Installing javascript dependencies =="
+  system! "yarn install"
 end

data/site_template/config/boot.rb

@@ -5,13 +5,12 @@ ENV["RACK_ENV"] ||= "development"
 require "bundler"
 Bundler.require(:default, ENV.fetch("RACK_ENV", nil))
 
-require_relative "staticky"
-
 loader = Zeitwerk::Loader.new
 loader.inflector.inflect("ui" => "UI")
 loader.push_dir("lib")
 loader.push_dir("app/views")
 loader.setup
 
+require_relative "staticky"
 require_relative "site"
 require_relative "routes"

data/site_template/config/puma.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+# Run in single threaded mode
+threads 0, 1
+
+# Specifies the `port` that Puma will listen on to receive requests; default is
+# 3000.
+port 3000
+
+# Only use a pidfile when requested
+pidfile ENV["PIDFILE"] if ENV["PIDFILE"]

data/site_template/config/staticky.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 Staticky.configure do |config|
   config.build_path = Pathname.new("build")
   config.root_path = Pathname(__dir__).join("..")
+  config.live_reloading = true
 end

data/site_template/config/vite.json

@@ -2,7 +2,9 @@
   "all": {
     "publicDir": "build",
     "sourceCodeDir": "frontend",
-    "watchAdditionalPaths": []
+    "watchAdditionalPaths": [
+      "app/**/*.rb"
+    ]
   },
   "development": {
     "autoBuild": true,

data/site_template/frontend/entrypoints/application.js

@@ -5,4 +5,3 @@ import "~/stylesheets/application.css"
 import "~/stylesheets/syntax.css"
 
 import "~/controllers"
-import "~/turbo_transitions.js"

data/site_template/frontend/tailwindcss/variable_font_plugin.js

@@ -1,7 +1,7 @@
 // This is a custom plugin for Tailwind CSS to enable font-variation-settings
 import plugin from "tailwindcss/plugin";
 
-const fontVariationSettings = plugin(function ({ addUtilities }) {
+const fontVariationSettings = plugin(function({ addUtilities }) {
   addUtilities({
     ".font-thin": {
       fontWeight: 100,

data/site_template/lib/icon.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-class Icon < Component
+class Icon < ApplicationComponent
   param :name, reader: false
-  option :variant, reader: false, default: -> {}
+  option :variant, reader: false, default: -> { }
   option :size, default: -> { :md }, reader: false
 
   def template

data/site_template/nginx.conf

@@ -28,9 +28,16 @@ http {
     port_in_redirect off;
     add_header X-Content-Type-Options "nosniff";
 
+    location = / {
+      try_files /index.html =404;
+    }
+
     location / {
-      try_files $uri $uri/ =404;
+      rewrite ^/(.*)/$ /$1 permanent;
+
+      try_files $uri $uri.html =404;
       expires 1h;
+      error_page 404 /404.html;
     }
 
     location ~* \.(?:ico|gif|jpe?g|png|svg|webp)$ {

data/site_template/package.json

@@ -11,21 +11,16 @@
   "author": "",
   "license": "ISC",
   "dependencies": {
-    "@fontsource-variable/inter": "^5.0.20",
+    "@fontsource-variable/inter": "^5.1.0",
     "@hotwired/stimulus": "^3.2.2",
-    "@hotwired/turbo": "^8.0.5",
-    "@tailwindcss/typography": "^0.5.14",
+    "@hotwired/turbo": "^8.0.12",
+    "@tailwindcss/typography": "^0.5.15",
     "autoprefixer": "^10.4.20",
-    "daisyui": "^4.12.10",
-    "protos-stimulus": "^0.0.3",
-    "postcss": "^8.4.41",
-    "tailwindcss": "^3.4.10",
-    "vite": "^5.4.0",
-    "vite-plugin-ruby": "^5.0.0",
-    "vite-plugin-full-reload": "^1.2.0"
-  },
-  "optionalDependencies": {
-    "@rollup/rollup-linux-arm64-musl": "4.20.0"
-  },
-  "packageManager": "yarn@1.22.22+sha1.ac34549e6aa8e7ead463a7407e1c7390f61a6610"
+    "daisyui": "^4.12.20",
+    "postcss": "^8.4.49",
+    "protos-stimulus": "^0.0.4",
+    "tailwindcss": "^3.4.16",
+    "vite": "^6.0.3",
+    "vite-plugin-ruby": "^5.1.1"
+  }
 }

data/site_template/tailwind.config.js

@@ -1,12 +1,15 @@
 import defaultTheme from "tailwindcss/defaultTheme"
+import daisyui from "daisyui"
+import typography from "@tailwindcss/typography"
+import variableFonts from "./frontend/tailwindcss/variable_font_plugin"
 
 // For importing tailwind styles from protos gem
-const execSync = require('child_process').execSync;
-const output = execSync('bundle show protos', { encoding: 'utf-8' });
-const protos_path = output.trim() + '/**/*.rb';
+import { execSync } from "child_process"
+const output = execSync("bundle show protos", { encoding: "utf-8" });
+const protos_path = output.trim() + "/**/*.rb";
 
-/** @type {import('tailwindcss').Config} */
-module.exports = {
+/** @type {import("tailwindcss").Config} */
+const config = {
   content: [
     "./app/**/*.rb",
     "./lib/**/*.rb",
@@ -75,9 +78,10 @@ module.exports = {
     ]
   },
   plugins: [
-    require("daisyui"),
-    require('@tailwindcss/typography'),
-    require("./frontend/tailwindcss/variable_font_plugin"),
+    daisyui,
+    typography,
+    variableFonts
   ],
 }
 
+export default config

data/site_template/vite.config.ts

@@ -1,14 +1,9 @@
 import { defineConfig } from "vite"
 import RubyPlugin from "vite-plugin-ruby"
-import FullReload from "vite-plugin-full-reload"
 
 export default defineConfig({
   server: { hmr: false },
   plugins: [
     RubyPlugin(),
-    FullReload(
-      "build/index.html",
-      { delay: 0 }
-    ),
   ],
 })