staticky 0.1.0

data/lib/staticky/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Staticky
+  VERSION = "0.1.0"
+end

data/lib/staticky/view_context.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Staticky
+  class ViewContext
+    def initialize(resource)
+      @resource = resource
+    end
+
+    def root?
+      @resource.root?
+    end
+
+    def current_path
+      @resource.url
+    end
+  end
+end

data/lib/staticky.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require "phlex"
+require "dry/system"
+require "dry/configurable"
+require "dry/logger"
+require "uri"
+require "tilt"
+
+module Staticky
+  GEM_ROOT = Pathname.new(__dir__).join("..").expand_path
+end
+
+require_relative "staticky/container"
+
+module Staticky
+  # DOCS: Module for static site infrastructure such as:
+  # - Defining routes
+  # - Compiling templates
+  # - Development server
+  # - Managing filesystem
+
+  module_function
+
+  extend Dry::Configurable
+
+  setting :env, default: :development
+  setting :build_path, default: Pathname.new("build")
+  setting :root_path, default: Pathname(__dir__)
+  setting :logger, default: Dry.Logger(:staticky, template: :details)
+  setting :server_logger, default: Dry.Logger(
+    :staticky_server,
+    template: :details,
+    formatter: :rack
+  )
+
+  def monitor(...) = container.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 env
+    @env ||= Environment.new container.env
+  end
+end

data/site_template/.dockerignore

@@ -0,0 +1,4 @@
+spec/
+Procfile.dev
+README.md
+node_modules/

data/site_template/.gitignore

@@ -0,0 +1,11 @@
+/build/
+
+# Vite Ruby
+/public/vite*
+node_modules
+# Vite uses dotenv and suggests to ignore local-only env files. See
+# https://vitejs.dev/guide/env-and-mode.html#env-files
+*.local
+
+.bundle
+/tmp/

data/site_template/.prettierrc

@@ -0,0 +1,6 @@
+{
+  "trailingComma": "es5",
+  "tabWidth": 2,
+  "semi": false,
+  "singleQuote": false
+}

data/site_template/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/site_template/.rubocop.yml

@@ -0,0 +1,8 @@
+require:
+  - rubocop-inhouse
+  - rubocop-capybara
+
+inherit_gem:
+  rubocop-inhouse:
+    - config/default.yml
+    - config/capybara.yml

data/site_template/.ruby-version

@@ -0,0 +1 @@
+3.3.4

data/site_template/Dockerfile

@@ -0,0 +1,47 @@
+# Use an official Ruby runtime based on Alpine as a parent image
+FROM ruby:3.3-alpine AS builder
+
+ENV RACK_ENV="production" \
+    NODE_ENV="production" \
+    BUNDLE_DEPLOYMENT="1" \
+    BUNDLE_WITHOUT="development:test"
+
+# Update gems and bundler
+RUN gem update --system --no-document && \
+    gem install -N bundler
+
+# Install necessary packages including Node.js and Yarn
+RUN apk add --no-cache build-base nodejs npm git && \
+    npm install -g yarn
+
+# Set the working directory
+WORKDIR /app
+
+# Copy Gemfile and other necessary files
+COPY --link Gemfile Gemfile.lock .ruby-version package.json yarn.lock ./
+
+# Install dependencies
+RUN bundle install && \
+    yarn install --frozen-lockfile && \
+    rm -rf /root/.bundle/cache /usr/local/bundle/cache /var/cache/apk/*
+
+# Copy the rest of the application code
+COPY --link . .
+
+# Build the static site (e.g., using Jekyll)
+RUN bin/rake site:build
+
+# Use an official Nginx image based on Alpine to serve the static site
+FROM nginx:stable-alpine
+
+# Copy the Nginx configuration file
+COPY nginx.conf /etc/nginx/nginx.conf
+
+# Copy the static site files to the Nginx HTML directory
+COPY --from=builder /app/build /usr/share/nginx/html/
+
+# Expose port 80 to the Docker host
+EXPOSE 80
+
+# Start Nginx when the container launches
+CMD ["nginx", "-g", "daemon off;"]

data/site_template/Gemfile

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+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
+
+gem "protos"
+gem "protos-icon"
+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"
+gem "vite_ruby"
+gem "zeitwerk"
+
+group :test do
+  gem "capybara", require: false
+  gem "debug"
+  gem "phlex-testing-capybara"
+  gem "rspec"
+end
+
+group :development do
+  gem "rerun"
+  gem "rubocop-inhouse", require: false
+end

data/site_template/Procfile.dev

@@ -0,0 +1,3 @@
+server: bin/bundle exec rackup
+builder: rerun --dir app,lib,content --exit --verbose -- bin/rake site:build
+vite: bin/vite dev

data/site_template/README.md

@@ -0,0 +1,98 @@
+# Static starter
+
+This is a minimal static site builder with [phlex](https://phlex.fun) and
+[protos](https://github.com/inhouse-work/protos) component library.
+
+[Vite](https://vite-ruby.netlify.app/) handles your javascript and your
+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.
+
+## Usage
+
+First we need to install `staticky` if you have not already:
+
+```
+gem install staticky
+```
+
+Then we can use the CLI to generate a new template:
+
+```
+staticky new my_blog
+```
+
+Finally cd into your new site and run the development server:
+
+```
+cd my_blog
+bin/dev
+```
+
+Your site should not be accessible at http://localhost:9292
+
+## Building
+
+During development `rerun` 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
+on your website. We have included a `Dockerfile` with a working nginx setup that
+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.
+
+## Views
+
+Views are defined in `app/views`. They should be phlex components and you can
+choose how to render them inside your router.
+
+## Javascript
+
+All javascript and images are handled via [Vite](https://vite-ruby.netlify.app/)
+
+## Router
+
+Your routes are defined in `config/routes.rb` and determine the output for your
+site. Everything gets built into the `./build` folder by default.
+
+Here is an example of loading content for a blog:
+
+```ruby
+# frozen_string_literal: true
+
+require "date"
+require "front_matter_parser"
+
+loader = FrontMatterParser::Loader::Yaml.new(allowlist_classes: [Date])
+
+Staticky.router.define do
+  root to: Pages::Home.new
+
+  # Link directly to components or their classes in your routes
+  match "404", to: Errors::NotFound.new
+  match "500", to: Errors::ServiceError.new(class: "bg-red-500")
+
+  # Write your own custom logic for parsing your markdown
+  Dir["content/**/*.md"].each do |file|
+    parsed = FrontMatterParser::Parser.parse_file(file, loader:)
+
+    match file.gsub("content/", "").gsub(".md", ""),
+          to: Pages::Post.new(
+            parsed.content,
+            front_matter: parsed.front_matter.transform_keys(&:to_sym)
+          )
+  end
+end
+```
+
+The router is your definition for how to build your static site.
+
+## Deployment
+
+Deployment is done through a simple Dockerfile. This setup is optimized for
+deploying onto Dokku servers.

data/site_template/Rakefile

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "vite_ruby"
+
+ViteRuby.install_tasks
+
+desc "Precompile assets"
+task :environment do
+  require "./config/boot"
+end
+
+namespace :site do
+  desc "Precompile assets"
+  task build: :environment do
+    Rake::Task["vite:build"].invoke
+    Staticky.builder.call
+  end
+end

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Errors
+  class NotFound < Page
+    include Protos::Typography
+
+    def self.layout = Layouts::Error
+
+    def view_template
+      h1 { "Page not found." }
+      link_to("Back to home", Pages::Home, class: "link")
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Errors
+  class ServiceError < Page
+    include Protos::Typography
+
+    def self.layout = Layouts::Error
+
+    def view_template
+      h1 { "Something went wrong." }
+      link_to("Back to home", Pages::Home, class: "link")
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# 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
+      end
+    end
+  end
+end

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

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Layouts
+  class Head < Component
+    option :title, default: -> { ::Site.title }, reader: false
+    option :description, default: -> { ::Site.description }, reader: false
+
+    def view_template
+      head do
+        title { @title }
+        meta name: "description", content: @description
+        meta charset: "utf-8"
+        meta name: "viewport",
+             content: "width=device-width,initial-scale=1,viewport-fit=cover"
+        meta name: "turbo-cache-control", content: "no-preview"
+        meta name: "turbo-refresh-method", content: "morph"
+        meta name: "turbo-refresh-scroll", content: "preserve"
+        meta name: "theme-color", content: "#61afef"
+        meta name: "mobile-web-app-capable", content: "yes"
+        meta name: "apple-touch-fullscreen", content: "yes"
+        meta name: "apple-mobile-web-app-capable", content: "yes"
+        meta name: "apple-mobile-web-app-status-bar-style", content: "default"
+        meta name: "apple-mobile-web-app-title", content: @title
+
+        link rel: "canonical", href: ::Site.url_for(helpers.current_path)
+        link rel: "apple-touch-icon", href: "/apple-touch-icon.png"
+        link rel: "icon",
+             type: "image/png",
+             sizes: "32x32",
+             href: "/favicon-32x32.png"
+        link rel: "icon",
+             type: "image/png",
+             sizes: "16x16",
+             href: "/favicon-16x16.png"
+        link rel: "manifest", href: "/site.webmanifest"
+
+        meta property: "og:title", content: @title
+        meta property: "og:type", content: "website"
+        meta property: "og:locale", content: "en_US"
+        meta property: "og:url", content: ::Site.url
+        meta property: "og:site_name", content: ::Site.title
+        meta property: "twitter:title", content: ::Site.title
+        meta name: "twitter:card", content: "summary"
+        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?
+      end
+    end
+
+    private
+
+    def javascript_tag(...)
+      vite_javascript_tag(...)
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Layouts
+  class Site < Layout
+    include Phlex::DeferredRender
+
+    def view_template
+      html lang: "en_US", 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
+      end
+    end
+
+    def with_head(&block)
+      @head = block
+    end
+
+    def with_content(&block)
+      @content = block
+    end
+
+    private
+
+    def content
+      @content || proc {}
+    end
+
+    def head
+      @head || proc {}
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Pages
+  class Home < Page
+    include Protos::Typography
+
+    def view_template
+      render Protos::Hero.new(
+        class: "h-96",
+        style: "background-image: url(#{asset_path("images/hero.jpg")})"
+      ) do |hero|
+        hero.overlay(class: "opacity-90")
+        hero.content(class: "flex-col text-white") do
+          h1 { "Ruby maximalism" }
+          p(margin: false) { "Zen vibes only" }
+
+          link_to("Learn more", Errors::NotFound)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module UI
+  class Footer < Component
+    def view_template
+      footer(**attrs) do
+        p(class: "opacity-80 text-sm") do
+          "All rights reserved. © #{Time.now.year}"
+        end
+      end
+    end
+
+    private
+
+    def theme
+      {
+        container: "flex justify-center w-full py-lg text-center"
+      }
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module UI
+  class Navbar < Component
+    def view_template
+      header(**attrs) do
+        a(href: "/", class: "btn btn-ghost") { "MyApp" }
+      end
+    end
+
+    private
+
+    def theme
+      {
+        container: "p-xs"
+      }
+    end
+  end
+end

data/site_template/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "./config/boot"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require "irb"
+IRB.start(__FILE__)

data/site_template/bin/dev

@@ -0,0 +1,12 @@
+#!/usr/bin/env sh
+
+if command -v overmind &> /dev/null; then
+  overmind start -f Procfile.dev
+else
+  if ! gem list foreman -i --silent; then
+    echo "Installing foreman..."
+    gem install foreman
+  fi
+
+  exec foreman start -f Procfile.dev "$@"
+fi

data/site_template/bin/lint

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+require "fileutils"
+
+# path to your application root.
+APP_ROOT = File.expand_path("..", __dir__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+FileUtils.chdir APP_ROOT do
+  # This script is a way to set up or update your development environment automatically.
+  # 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"
+end

data/site_template/bin/staticky

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'staticky' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+bundle_binstub = File.expand_path("bundle", __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300).include?("This file was generated by Bundler")
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+require "./config/boot"
+
+load Gem.bin_path("staticky", "staticky")

data/site_template/config/boot.rb

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

data/site_template/config/routes.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "date"
+
+Staticky.router.define do
+  root to: Pages::Home
+  match "404", to: Errors::NotFound
+  match "500", to: Errors::ServiceError
+end

data/site_template/config/site.erb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Site
+  module_function
+
+  def title = "<%= title %>"
+  def description = "<%= description %>"
+  def twitter = "<%= twitter %>"
+  def url = "<%= url %>"
+
+  def url_for(path) = URI.join(url, path)
+end

data/site_template/config/vite.json

@@ -0,0 +1,17 @@
+{
+  "all": {
+    "publicDir": "build",
+    "sourceCodeDir": "frontend",
+    "watchAdditionalPaths": []
+  },
+  "development": {
+    "autoBuild": true,
+    "publicOutputDir": "vite-dev",
+    "port": 3036
+  },
+  "test": {
+    "autoBuild": true,
+    "publicOutputDir": "vite-test",
+    "port": 3037
+  }
+}

data/site_template/config.ru

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "logger"
+require "./config/boot"
+require "staticky/server"
+
+use(ViteRuby::DevServerProxy, ssl_verify_none: true) if ViteRuby.run_proxy?
+run Staticky::Server.app.freeze