syntropy 0.11 → 0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f33d7721410d70a9d5b86977c73b36f6a410a6534c253269df5f2d47123a54f
-  data.tar.gz: 6f961a74dd9fa299296d6699244076dfc09fa3697faad7c28cc6c2db81f5fb46
+  metadata.gz: 18d6c37aa12dcf2315d95bc656d1cbf196ada1dd0e2309b0f1bf1ca8b65a1cbb
+  data.tar.gz: 04f12a324d704814f45d9218e6e02d0d38469dbed753dc8202009568f447d400
 SHA512:
-  metadata.gz: 158e46fd1e09da1af72a5ffd50a1ccde7699ce52f9a9d7a317903e3aa29234a5f924371712571b4d0188bcc5e7484b7bced4be7ee7440140ba5cfb07b492bccf
-  data.tar.gz: 6a45ef64e1ef65cf5c86c15dd5858a3f028343c55f68be253d07626800c4f534782898e4e7d83697fb324b4169050ce913a911575d31936c5a852e12f0eb4be0
+  metadata.gz: c62d9b26c9754c23bfc53dd25c1d698733e1d01b703d580db17cfeed1505c36f3f382fcd762ef0e91e641505cda26af03a328e549a840f9f7af4b2ab7c582bc0
+  data.tar.gz: 0577b8d2fda40cb40c81419c31c7f515230f7948ab49158a7ca2d647fe71a323d51b176003d976b1e5428fe4ead6415064321340c0e20b5c84806d1e52266ce0

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+# 0.12 2025-08-28
+
+- Add routing info to request: `#route`, `#route_params`
+- Improve validations
+- Improve errors
+- Reimplement `App`
+- Add support for parametric routes
+- Reimplement `RoutingTree` (was `Router`)
+
 ## 0.11 2025-08-17
 
 - Upgrade to P2 2.8

data/Rakefile

@@ -10,7 +10,7 @@ end
 task :release do
   require_relative './lib/syntropy/version'
   version = Syntropy::VERSION
-  
+
   puts 'Building syntropy...'
   `gem build syntropy.gemspec`
 

data/TODO.md

@@ -1,137 +1,182 @@
-- a way to inject cookies into the response
-
-- add support for applets
-
-  - can be implemented as separate gems
-  - can route requests to a different directory (i.e. inside the gem directory)
-  - simple way to instantiate and setup the applet
-  - as a first example, implement an auth/signin applet:
-    - session hook
-    - session persistence
-    - login page
-    - support for custom behaviour and custom workflows (2FA, signin using OTP etc.)
-
-- Some standard middleware:
-
-  - request rewriter
-  - logger
-  - auth
-  - selector + terminator
-
-  ```Ruby
-  # For the chainable DSL shown below, we need to create a custom class:
-  class Syntropy::Middleware::Selector
-    def initialize(select_proc, terminator_proc = nil)
-      @select_proc = select_proc
-      @terminator_proc = terminator_proc
-    end
-
-    def to_proc
-      ->(req, proc) {
-        @select_proc.(req) ? @terminator_proc.(req) : proc(req)
-      }
-    end
-
-    def terminate(&proc)
-      @terminator_proc = proc
-    end
+## Support for applets
+
+- can be implemented as separate gems
+- can route requests to a different directory (i.e. inside the gem directory)
+- simple way to instantiate and setup the applet
+- as a first example, implement an auth/signin applet:
+  - session hook
+  - session persistence
+  - login page
+  - support for custom behaviour and custom workflows (2FA, signin using OTP etc.)
+
+Example usage:
+
+```ruby
+# /admin+.rb
+require 'syntropy/admin'
+
+export Syntropy::Admin.new(@ref, @env)
+```
+
+Implementation:
+
+```ruby
+# syntropy-admin/lib/syntropy/admin.rb
+APP_ROOT = File.expand_path(File.join(__dir__, '../../app'))
+
+class Syntropy::Admin < Syntropy::App
+  def new(mount_path, env)
+    super(env[:machine], APP_ROOT, mount_path, env)
+  end
+end
+```
+
+## Response: cookies and headers
+
+We need a way to inject cookies into the response. This probably should be done
+in the TP2 code:
+
+```ruby
+@@default_set_cookie_attr = 'HttpOnly'
+def self.default_set_cookie_attr=(v)
+  @@default_set_cookie_attr = v
+end
+
+def set_cookie(key, value, attr = @@default_set_cookie_attr)
+  @buffered_headers ||= +''
+  @buffered_headers << format(
+    "Set-Cookie: %<key>s=%<value>s; %<attr>s\n",
+    key:, value:, attr:
+  )
+end
+
+def set_headers(headers)
+  @buffered_headers ||= +''
+  @buffered_headers << format_headers(headers)
+end
+
+...
+
+req.set_cookie('at', 'foobar', 'SameSite=none; Secure; HttpOnly')
+```
+
+## Middleware
+
+Some standard middleware:
+
+- request rewriter
+- logger
+- auth
+- selector + terminator
+
+```Ruby
+# For the chainable DSL shown below, we need to create a custom class:
+class Syntropy::Middleware::Selector
+  def initialize(select_proc, terminator_proc = nil)
+    @select_proc = select_proc
+    @terminator_proc = terminator_proc
   end
 
-  def Syntropy
-  ```
-
-  ```Ruby
-  # a _site.rb file can be used to wrap a whole app
-  # site/_site.rb
-
-  # this means we route according to the host header, with each
-  export Syntropy.route_by_host
-
-  # we can also rewrite requests:
-  rewriter = Syntropy
-    .select { it.host =~ /^tolkora\.(org|com)$/ }
-    .terminate { it.redirect_permanent('https://tolkora.net') }
-
-  # This is actuall a pretty interesting DSL design:
-  # a chain of operations that compose functions. So, we can select a
-  export rewriter.wrap(default_app)
-
-  # composing
-  export rewriter.wrap(Syntropy.some_custom_app.wrap(app))
-
-  # or maybe
-  export rewriter << some_other_middleware << app
-  ```
-
-
-
-
-- CLI tool for setting up a site repo:
-
-  ```bash
-  # clone a newly created repo
-  ~/repo$ git clone https://github.com/foo/bar
-  ...
-  ~/repo$ syntropy setup bar
-
-  (syntropy banner)
-
-  Setting up Syntropy project in /home/sharon/repo/bar:
-
-  bar/
-    bin/
-      start
-      stop
-      restart
-      console
-      server
-    docker-compose.yml
-    Dockerfile
-    Gemfile
-    proxy/
-
-    README.md
-    site/
-      _layout/
-        default.rb
-      _lib/
-      about.md
-      articles/
-        long-form.md
-      assets/
-        js/
-        css/
-          style.css
-        img/
-          syntropy.png
-      index.rb
-  ```
-
-  - Some of the files might need templating, but we can maybe do without, or at
-  least make it as generic as possible.
-
-- `syntropy setup` steps:
-
-  1. Verify existence of target directory
-  2. Copy files from Syntropy template to target directory
-  3. Do chmod +x for bin/*
-  4. Do bundle install in the target directory
-  5. Show some information with regard to how to get started working with the
-     repo
-
-- `syntropy provision` steps:
-
-  1. Verify Ubuntu 22.x or higher
-  2. Install git, docker, docker-compose
-
-- `syntropy deploy` steps:
-
-  1. Verify no uncommitted changes.
-  2. SSH to remote machine.
-    2.1. If not exists, clone repo
-    2.2. Otherwise, verify remote machine repo is on same branch as local repo
-    2.3. Do a git pull (what about credentials?)
-    2.4. If gem bundle has changed, do a docker compose build
-    2.5. If docker compose services are running, restart
-    2.6. Otherwise, start services
-    2.7. Verify service is running correctly
+  def to_proc
+    ->(req, proc) {
+      @select_proc.(req) ? @terminator_proc.(req) : proc(req)
+    }
+  end
+
+  def terminate(&proc)
+    @terminator_proc = proc
+  end
+end
+```
+
+```Ruby
+# a _site.rb file can be used to wrap a whole app
+# site/_site.rb
+
+# this means we route according to the host header, with each
+export Syntropy.route_by_host
+
+# we can also rewrite requests:
+rewriter = Syntropy
+  .select { it.host =~ /^tolkora\.(org|com)$/ }
+  .terminate { it.redirect_permanent('https://tolkora.net') }
+
+# This is actuall a pretty interesting DSL design:
+# a chain of operations that compose functions. So, we can select a
+export rewriter.wrap(default_app)
+
+# composing
+export rewriter.wrap(Syntropy.some_custom_app.wrap(app))
+
+# or maybe
+export rewriter << some_other_middleware << app
+```
+
+## CLI tool for setting up a site repo:
+
+```bash
+# clone a newly created repo
+~/repo$ git clone https://github.com/foo/bar
+...
+~/repo$ syntropy setup bar
+
+(syntropy banner)
+
+Setting up Syntropy project in /home/sharon/repo/bar:
+
+bar/
+  bin/
+    start
+    stop
+    restart
+    console
+    server
+  docker-compose.yml
+  Dockerfile
+  Gemfile
+  proxy/
+  README.md
+  site/
+    _layout/
+      default.rb
+    _lib/
+    about.md
+    articles/
+      long-form.md
+    assets/
+      js/
+      css/
+        style.css
+      img/
+        syntropy.png
+    index.rb
+```
+
+Some of the files might need templating, but we can maybe do without, or at
+least make it as generic as possible.
+
+`syntropy setup` steps:
+
+1. Verify existence of target directory
+2. Copy files from Syntropy template to target directory
+3. Do chmod +x for bin/*
+4. Do bundle install in the target directory
+5. Show some information with regard to how to get started working with the
+   repo
+
+`syntropy provision` steps:
+
+1. Verify Ubuntu 22.x or higher
+2. Install git, docker, docker-compose
+
+`syntropy deploy` steps:
+
+1. Verify no uncommitted changes.
+2. SSH to remote machine.
+  2.1. If not exists, clone repo
+  2.2. Otherwise, verify remote machine repo is on same branch as local repo
+  2.3. Do a git pull (what about credentials?)
+  2.4. If gem bundle has changed, do a docker compose build
+  2.5. If docker compose services are running, restart
+  2.6. Otherwise, start services
+  2.7. Verify service is running correctly

data/bin/syntropy

@@ -5,6 +5,7 @@ require 'syntropy'
 require 'optparse'
 
 opts = {
+  mount_path: '/',
   banner: Syntropy::BANNER,
   logger: true
 }
@@ -32,6 +33,10 @@ parser = OptionParser.new do |o|
     exit
   end
 
+  o.on('-m', '--mount', 'Set mount path (default: /)') do
+    opts[:mount_path] = it
+  end
+
   o.on('-v', '--version', 'Show version') do
     require 'syntropy/version'
     puts "Syntropy version #{Syntropy::VERSION}"
@@ -49,10 +54,10 @@ rescue StandardError => e
   exit
 end
 
-opts[:location] = ARGV.shift || '.'
+opts[:root_dir] = ARGV.shift || '.'
 
-if !File.directory?(opts[:location])
-  puts "#{File.expand_path(opts[:location])} Not a directory"
+if !File.directory?(opts[:root_dir])
+  puts "#{File.expand_path(opts[:root_dir])} Not a directory"
   exit
 end