staticky 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 41fa452e7c74ade67ffd58486af13cb4b121eda6cd51ffd5dc25105981cea0c2
-  data.tar.gz: c8c2a3a15bc2cf0225d7763a825e8c1a34af2a0762777091e0c6c581723d485f
+  metadata.gz: 601e3b52395f847f7f7f57909a0063f83063dc0cf5bd02ef21e865d972f3322f
+  data.tar.gz: 7d8ecdd8e166359930743d01e2c955dc521a4f9d1b231d239d35aa45858cc003
 SHA512:
-  metadata.gz: ff6e8e759028df62d4ce1a9304c2b8caa7fd38c5684e9a653445d14a46ffd4b880fd3c05bb393890d055262db28d37384c47af02ff72c1ce37dafaed33842d33
-  data.tar.gz: 3aa63ca27344d93d99a92463e85f4cd75a547360da6682f6727cbd022b258c540df7dd39b4631f15f08f8f19bcb08bc21aedfe07736aab3267092d4d1db5ec9d
+  metadata.gz: c1b21ab89e9d6429b3cd3407ae84802c1739e68aa39c969f10c0d82e28ad3cdf187cd1bedcf98a22805fbe9de64c3be96d711f4f554c5addf55c744bcd11b9a6
+  data.tar.gz: 3695cab76d925bec1ba6e02852ac63a088c88cd2d2fb9e3942c5e33f0ef8aefb19d6c643c6e2ade7d63b438dba6d954a351efaba86939ac4ac5e56be73652343

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## [Unreleased]
 
-## [0.1.0] - 2024-07-08
+## [0.1.1] - 2024-08-18
+
+- Fixes nginx and Dockerfile configs for default dokku deployments
+- Improvements to site template files
+- Adds ability for `link_to` helpers to take absolute paths
+
+## [0.1.0] - 2024-08-18
 
 - Initial release

data/README.md

@@ -70,6 +70,8 @@ module Posts
     end
 
     def view_template
+      link_to "Home", "/"
+
       render Posts::Header.new(@post)
       render Posts::Outline.new(@post, class: css[:outline])
       render Posts::Markdown.new(@post, class: css[:post])
@@ -96,6 +98,9 @@ module Posts
 end
 ```
 
+We get `link_to` from the `Staticky::Phlex::ViewHelpers` which resolves either
+a URL or a phlex class from your router.
+
 When you are developing your site you run `bin/dev` to start your development
 server on http://localhost:9292. This will automatically reload after a short
 period when you make changes.
@@ -127,6 +132,14 @@ end
 
 This will output your site to `./build` by default.
 
+During building, each definition in the router is compiled and handed a special
+view context which holds information about the resource being rendered such as
+the `current_path`.
+
+These are available in your Phlex components under `helpers` (if you are using
+the site template). This matches what you might expect when using Phlex in
+Rails with `phlex-rails`.
+
 ## Configuration
 
 We can override the configuration according to the settings defined on the main

data/lib/staticky/phlex/view_helpers.rb

@@ -5,7 +5,8 @@ module Staticky
     module ViewHelpers
       def link_to(text, href, **, &block) # rubocop:disable Metrics/ParameterLists
         block ||= proc { text }
-        href = Staticky.router.resolve(href).url
+        href = Staticky.router.resolve(href)
+        href = href.url unless href.is_a?(String)
 
         a(href:, **, &block)
       end

data/lib/staticky/router.rb

@@ -29,6 +29,9 @@ module Staticky
     end
 
     def resolve(path)
+      # Return absolute paths as is
+      return path if path.is_a?(String) && path.start_with?("http")
+
       @definition.resolve(path)
     end
   end

data/lib/staticky/server.rb

@@ -14,6 +14,7 @@ module Staticky
 
     plugin :common_logger, Staticky.server_logger, method: :debug
     plugin :render, engine: "html"
+    plugin :public
 
     plugin :not_found do
       raise NotFound if Staticky.env.test?
@@ -41,8 +42,7 @@ module Staticky
         end
       end
 
-      # Need to return nil or Roda is unhappy
-      nil
+      r.public
     end
   end
 end

data/lib/staticky/version.rb

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

data/site_template/Dockerfile

@@ -40,8 +40,8 @@ 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
+# Expose port to the Docker host (default is 5000 for dokku)
+EXPOSE 5000
 
 # Start Nginx when the container launches
-CMD ["nginx", "-g", "daemon off;"]
+CMD ["nginx", "-c", "/etc/nginx/nginx.conf"]

data/site_template/README.md

@@ -96,3 +96,7 @@ The router is your definition for how to build your static site.
 
 Deployment is done through a simple Dockerfile. This setup is optimized for
 deploying onto Dokku servers.
+
+By default Dokku expects the app to be exposed on port 5000 which we do through
+our Dockerfile. Dokku will scan the Dockerfile for an `EXPOSE` directive and
+automatically setup the port routing for you.

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

@@ -5,7 +5,8 @@ module Layouts
     include Phlex::DeferredRender
 
     def view_template
-      html lang: "en_US", data: { theme: "onedark" } do
+      doctype
+      html lang: "en", data: { theme: "onedark" } do
         render Layouts::Head.new(&head)
 
         body do

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

@@ -4,7 +4,7 @@ module UI
   class Navbar < Component
     def view_template
       header(**attrs) do
-        a(href: "/", class: "btn btn-ghost") { "MyApp" }
+        a(href: "/", class: "btn btn-ghost") { Site.title }
       end
     end
 

data/site_template/config/boot.rb

@@ -5,6 +5,8 @@ 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")

data/site_template/config/staticky.rb

@@ -0,0 +1,4 @@
+Staticky.configure do |config|
+  config.build_path = Pathname.new("build")
+  config.root_path = Pathname(__dir__).join("..")
+end

data/site_template/nginx.conf

@@ -1,6 +1,7 @@
 worker_processes 1;
 error_log stderr;
 pid nginx.pid;
+daemon off;
 
 events {
   worker_connections 768;
@@ -17,17 +18,18 @@ http {
   gzip_proxied any;
   gzip_vary on;
 
+  error_page 404 /404.html;
+
   server {
-    listen 80 default_server;
-    listen [::]:80 default_server;
+    listen 5000;
     server_name  _;
     root /usr/share/nginx/html;
-    index index.html index.htm;
+    index index.html;
     port_in_redirect off;
     add_header X-Content-Type-Options "nosniff";
 
     location / {
-      try_files $uri $uri.html =404;
+      try_files $uri $uri/ =404;
       expires 1h;
     }
 

data/site_template/public/site.webmanifest.erb

@@ -1,6 +1,6 @@
 {
-  "name": <%= title %>,
-  "short_name": <%= title %>,
+  "name": "<%= title %>",
+  "short_name": "<%= title %>",
   "icons": [
     {
       "src":"/android-chrome-192x192.png",

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: staticky
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Nolan J Tait
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-18 00:00:00.000000000 Z
+date: 2024-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-cli
@@ -209,6 +209,7 @@ files:
 - site_template/config/boot.rb
 - site_template/config/routes.rb
 - site_template/config/site.erb
+- site_template/config/staticky.rb
 - site_template/config/vite.json
 - site_template/content/.keep
 - site_template/content/demo.md