syntropy 0.16 → 0.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b90967d51ee11dd83db1237db95b35fb1a2bd9cb36248086bfe62082ddd4c0a5
-  data.tar.gz: 187eb2adc5a21df0f8d0400ef54609300658df9e3ba371686c1007d4744c0667
+  metadata.gz: fccb5bf3768ed14e90b4bb5e67fd5cb87b2cf4290fd2b17474a9cb1e06678d34
+  data.tar.gz: bd23da91cb9ad10ab3bb2efcd7c7e48359809b4e21305303f8b1c02138745e7c
 SHA512:
-  metadata.gz: 1c0aff28315990526db9d48c1d4dba164d9944f93bdbcb671fdd6526a2f77eac28fa89cc2a99e68ce6bc5e55db85582270b3ea6032456c5e5d2fe9847150e3ae
-  data.tar.gz: 10d5ceb7568d22a07d89e13cca104aeeeea94e62a03c778a72c3da360b8a21ef466038d4d872b75ae00b1634c2dfffc8931e4a61695e95e99c78a51bfcd5c643
+  metadata.gz: e0ad7ab962b0dee33b3a3d4b8c67392f3230c274921e584192330743fec83abbdbfb03af86dacc4e4104348c854337838db209fa310e259d21a076b5c2e2bb9a
+  data.tar.gz: b3ecca8901ff9743ee26200ee713ed08fe9a5ed23dd299cfefa2f0f9f49210bd21ad3c9a389f42c4b34bc8c396325a7050e31f281d8392edec4621043b843433

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+# 0.18 2025-09-11
+
+- Rename P2 back to Papercraft
+
+# 0.17 2025-09-11
+
+- Move repo to [digital-fabric](https://github.com/digital-fabric/syntropy)
+
 # 0.16 2025-09-11
 
 - `syntropy` script:
@@ -12,8 +20,8 @@
   - home page with links to examples
 - Implement applet mounting and loading
 - Remove Papercraft dependency
-- Add support for P2 XML templates, using `#template_xml`
-- Update P2, TP2
+- Add support for Papercraft XML templates, using `#template_xml`
+- Update Papercraft, TPapercraft
 
 # 0.15 2025-08-31
 
@@ -42,16 +50,16 @@
 
 ## 0.11 2025-08-17
 
-- Upgrade to P2 2.8
+- Upgrade to Papercraft 2.8
 
 ## 0.10.1 2025-08-10
 
-- Fix ModuleLoader.wrap_module to work correctly with P2::Template
+- Fix ModuleLoader.wrap_module to work correctly with Papercraft::Template
 
 ## 0.10 2025-08-10
 
 - Add query, execute methods to ConnectionPool
-- Switch from Papercraft to P2
+- Switch from Papercraft to Papercraft
 
 ## 0.9.2 2025-07-24
 
@@ -59,17 +67,17 @@
 
 ## 0.9.1 2025-07-08
 
-- Update TP2
+- Update TPapercraft
 
 ## 0.9 2025-07-08
 
-- Update TP2
+- Update TPapercraft
 - Add `Module.app` method for loading arbitrary apps
 - Set `Module@machine`
 
 ## 0.8.4 2025-07-07
 
-- Update TP2
+- Update TPapercraft
 - Fix Router#path_parent to not break on double slash
 
 ## 0.8.3 2025-07-06

data/README.md

@@ -9,10 +9,10 @@
   <a href="http://rubygems.org/gems/syntropy">
     <img src="https://badge.fury.io/rb/syntropy.svg" alt="Ruby gem">
   </a>
-  <a href="https://github.com/noteflakes/syntropy/actions">
-    <img src="https://github.com/noteflakes/syntropy/actions/workflows/test.yml/badge.svg" alt="Tests">
+  <a href="https://github.com/digital-fabric/syntropy/actions">
+    <img src="https://github.com/digital-fabric/syntropy/actions/workflows/test.yml/badge.svg" alt="Tests">
   </a>
-  <a href="https://github.com/noteflakes/syntropy/blob/master/LICENSE">
+  <a href="https://github.com/digital-fabric/syntropy/blob/master/LICENSE">
     <img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="MIT License">
   </a>
 </p>
@@ -38,14 +38,24 @@ Syntropy is based on:
 
 - [UringMachine](https://github.com/digital-fabric/uringmachine) - a lean mean
   [io_uring](https://unixism.net/loti/what_is_io_uring.html) machine for Ruby.
-- [TP2](https://github.com/noteflakes/tp2) - an io_uring-based web server for
+- [TPapercraft](https://github.com/digital-fabric/tp2) - an io_uring-based web server for
   concurrent Ruby apps.
 - [Qeweney](https://github.com/digital-fabric/qeweney) a uniform interface for
   working with HTTP requests and responses.
-- [P2](https://github.com/digital-fabric/p2) HTML templating with plain Ruby.
+- [Papercraft](https://github.com/digital-fabric/papercraft) HTML templating with plain Ruby.
 - [Extralite](https://github.com/digital-fabric/extralite) a fast and innovative
   SQLite wrapper for Ruby.
 
+## Examples
+
+To get a taste of some of Syntropy's capabilities, you can run the included
+examples site inside the Syntropy repository:
+
+```bash
+$ cd syntropy
+$ bundle exec syntropy -d examples
+```
+
 ## Routing
 
 Syntropy routes request by following the tree structure of the Syntropy app. A
@@ -93,6 +103,28 @@ Some conventions employed in Syntropy-based web apps:
 - The Syntrpy router accepts clean URLs for Ruby modules and Markdown files. It
   also accepts clean URLs for `index.html` files.
 
+## Running Syntropy
+
+Note: Syntropy runs exclusively on Linux and requires kernel version >= 6.4.
+
+To start a web server on the working directory, use the `syntropy` command:
+
+```bash
+$ # install syntropy:
+$ gem install syntropy
+$ # run syntropy
+$ syntropy path/to/my_site
+```
+
+To get help for the different options available, run `syntropy -h`.
+
+## Development mode
+
+When developing and making changes to your site, you can run Syntropy in
+development mode, which automatically reloads changed modules and provides tools
+to automatically refresh open web pages and debug HTML templates. To start
+Syntropy in development mode, run `syntropy -d path/to/my_site`.
+
 ## What does a Syntropic Ruby module look like?
 
 Consider `site/archive.rb` in the file tree above. We want to get a list of
@@ -121,7 +153,7 @@ But a module can also be something completely different:
 
 ```ruby
 # api/v1.rb
-class APIV1 < Syntropy::RPCAPI
+class APIV1 < Syntropy::JSONAPI
   def initialize(db)
     @db = db
   end

data/TODO.md

@@ -23,7 +23,8 @@
   article.render_proc #=> (load layout, apply article)
   article.render #=> (render to HTML)
 
-  # there should also be methods for creating, updating and deleting of articles/items.
+  # there should also be methods for creating, updating and deleting of
+  # articles/items.
   ...
   ```
 
@@ -32,140 +33,15 @@
   - [ ] support for caching headers
   - [ ] add `Request#render_static_file(route, fn)
 
-- [ ] Serving of built-in assets (mostly JS)
-  - [ ] JS lib for RPC API
-
 ## Missing for a first public release
 
 - [ ] Logo
 - [ ] Website
-- [ ] Frontend part of RPC API
+- [v] Frontend part of JSON API
 - [v] Auto-refresh page when file changes
-- [ ] Examples
-  - [ ] Reactive app - counter or some other simple app showing interaction with server
-  - [ ] ?
-
-## Counter example
-
-Here's a react component (from https://fresh.deno.dev/):
-
-```jsx
-// islands/Counter.tsx
-import { useSignal } from "@preact/signals";
-
-export default function Counter(props) {
-  const count = useSignal(props.start);
-
-  return (
-    <div>
-      <h3>Interactive island</h3>
-      <p>The server supplied the initial value of {props.start}.</p>
-      <div>
-        <button onClick={() => count.value -= 1}>-</button>
-        <div>{count}</div>
-        <button onClick={() => count.value += 1}>+</button>
-      </div>
-    </div>
-  );
-}
-```
-
-How do we do this with Syntropy? Can we make a component that does the
-templating and the reactivity in a single file? Can we wrap reactivity in a
-component that has its own state? And where does the state live?
-
-```ruby
-class Counter < Syntropy::Component
-  def initialize(start:, **props)
-    @count = reactive()
-  end
-
-  def template
-    div {
-      h3 'Interactive island'
-      p "The server supplied the initial value of #props[:start]}"
-      div {
-        button '-', on_click: -> { @count.value -= 1 }
-        div @count.value
-        button '+', on_click: -> { @count.value += 1 }
-      }
-    }
-  end
-end
-```
-
-Hmm, don't know if the complexity is worth it. It's an abstraction that's very
-costly - both in terms of complexity of computation, and in terms of having a
-clear mental model of what's happening under the hood.
-
-I think a more logical approach is to stay with well-defined boundaries between
-computation on the frontend and computation on the backend, and a having a clear
-understanding of where things happen:
-
-```ruby
-class Counter < Syntropy::Component
-  def incr
-    update(value: @props[:value] + 1)
-  end
-
-  def decr
-    update(value: @props[:value] - 1)
-  end
-
-  def template
-    div {
-      h3 'Interactive island'
-      div {
-        button '-', syn_click: 'decr'
-        div @props[:value]
-        button '+', syn_click: 'incr'
-      }
-    }
-  end
-end
-```
-
-Now, we can do all kinds of wrapping with scripts and ids and stuff to make this
-work, but still, it would be preferable for the interactivity to be expressed in
-JS. Maybe we just need a way to include a script that acts on the local HTML
-code. How can we do this without writing a web component etc?
-
-One way is to assign a random id to the template, then have a script that works
-on it locally.
-
-```ruby
-export template { |**props|
-  id = SecureRandom.hex(4)
-  div(id: id) {
-    h3 'Interactive island'
-    div {
-      button '-', syn_action: "decr"
-      div props[:value], syn_value: "value"
-      button '+', syn_action: "incr"
-    }
-    script <<~JS
-      const state = { value: #{props[:value]} }
-      const root = document.querySelector('##{id}')
-      const decr = root.querySelector('[syn-action="decr"]')
-      const incr = root.querySelector('[syn-action="incr"]')
-      const value = root.querySelector('[syn-value="value"]')
-      const updateValue = (v) => { state.value = v; value.innerText = String(v) }
-
-      decr.addEventListener('click', (e) => { updateValue(state.value - 1) })
-      incr.addEventListener('click', (e) => { updateValue(state.value + 1) })
-    JS
-  }
-}
-```
-
-How can we make this less verbose, less painful, less error-prone?
-
-One way is to say - we don't worry about this on the backend, we just write
-normal JS for the frontend and forget about the whole thing. Another way is to
-provide a set of tools for making this less painful:
-
-- Add some fancier abstractions on top of the JS RPC lib
-- Add some template extensions that inject JS into the generated HTML
+- [v] Examples
+  - [v] Reactive app - counter or some other simple app showing interaction with
+    server
 
 ## Testing facilities
 
@@ -184,7 +60,8 @@ provide a set of tools for making this less painful:
   - session hook
   - session persistence
   - login page
-  - support for custom behaviour and custom workflows (2FA, signin using OTP etc.)
+  - support for custom behaviour and custom workflows (2FA, signin using OTP
+    etc.)
 
 Example usage:
 
@@ -211,7 +88,7 @@ end
 ## Response: cookies and headers
 
 We need a way to inject cookies into the response. This probably should be done
-in the TP2 code:
+in the TPapercraft code:
 
 ```ruby
 @@default_set_cookie_attr = 'HttpOnly'

data/bin/syntropy

@@ -75,11 +75,11 @@ env[:banner] = false
 
 # We set Syntropy.machine so we can reference it from anywhere
 env[:machine] = Syntropy.machine = UM.new
-env[:logger] = env[:logger] && TP2::Logger.new(env[:machine], **env)
+env[:logger] = env[:logger] && TPapercraft::Logger.new(env[:machine], **env)
 
 require 'syntropy/version'
 require 'syntropy/dev_mode' if env[:dev_mode]
 
 env[:logger]&.info(message: "Running Syntropy version #{Syntropy::VERSION}")
 app = Syntropy::App.load(env)
-TP2.run(env) { app.call(it) }
+TPapercraft.run(env) { app.call(it) }

data/lib/syntropy/app.rb

@@ -4,7 +4,7 @@ require 'json'
 require 'yaml'
 
 require 'qeweney'
-require 'p2'
+require 'papercraft'
 
 require 'syntropy/errors'
 require 'syntropy/file_watch'
@@ -183,7 +183,7 @@ module Syntropy
           }
           body {
             markdown md
-            auto_refresh_watch!
+            auto_refresh_watch! if @env[:dev_mode]
           }
         }
       }
@@ -197,14 +197,14 @@ module Syntropy
 
     def compute_module_proc(mod)
       case mod
-      when P2::Template
-        p2_template_proc(mod)
+      when Papercraft::Template
+        papercraft_template_proc(mod)
       else
         mod
       end
     end
 
-    def p2_template_proc(template)
+    def papercraft_template_proc(template)
       xml_mode = template.mode == :xml
       template = template.proc
       mime_type = xml_mode ? 'text/xml; charset=UTF-8' : 'text/html; charset=UTF-8'
@@ -302,7 +302,7 @@ module Syntropy
     # @return [void]
     def start
       @machine.spin do
-        # we do startup stuff asynchronously, in order to first let TP2 do its
+        # we do startup stuff asynchronously, in order to first let TPapercraft do its
         # setup tasks
         @machine.sleep 0.2
         route_count = @routing_tree.static_map.size + @routing_tree.dynamic_map.size

data/lib/syntropy/dev_mode.rb

@@ -8,4 +8,4 @@ TAG_DEBUG_PROC = ->(level, fn, line, col) {
   }
 }
 
-P2::Compiler.html_debug_attribute_injector = TAG_DEBUG_PROC
+Papercraft::Compiler.html_debug_attribute_injector = TAG_DEBUG_PROC

data/lib/syntropy/module.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'p2'
+require 'papercraft'
 
 module Syntropy
   # The ModuleLoader class implemenets a module loader. It handles loading of
@@ -204,28 +204,28 @@ module Syntropy
       }
     end
 
-    # Creates and returns a P2 template created with the given block.
+    # Creates and returns a Papercraft template created with the given block.
     #
     # @param proc [Proc, nil] template proc or nil
     # @param block [Proc] template block
-    # @return [P2::Template] template
+    # @return [Papercraft::Template] template
     def template(proc = nil, &block)
       proc ||= block
       raise "No template block/proc given" if !proc
 
-      P2::Template.new(proc)
+      Papercraft::Template.new(proc)
     end
 
-    # Creates and returns a P2 XML template created with the given block.
+    # Creates and returns a Papercraft XML template created with the given block.
     #
     # @param proc [Proc, nil] template proc or nil
     # @param block [Proc] template block
-    # @return [P2::Template] template
+    # @return [Papercraft::Template] template
     def template_xml(proc = nil, &block)
       proc ||= block
       raise "No template block/proc given" if !proc
 
-      P2::Template.new(proc, mode: :xml)
+      Papercraft::Template.new(proc, mode: :xml)
     rescue => e
       p e
       p e.backtrace

data/lib/syntropy/{p2_extensions.rb → papercraft_extensions.rb}

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'p2'
+require 'papercraft'
 
-P2.extension(
+Papercraft.extension(
   'auto_refresh_watch!': ->(loc = '/.syntropy') {
     script(src: File.join(loc, 'auto_refresh/watch.js'), type: 'module')
   },

data/lib/syntropy/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Syntropy
-  VERSION = '0.16'
+  VERSION = '0.18'
 end

data/lib/syntropy.rb

@@ -3,7 +3,7 @@
 require 'qeweney'
 require 'uringmachine'
 require 'tp2'
-require 'p2'
+require 'papercraft'
 
 require 'syntropy/app'
 require 'syntropy/connection_pool'
@@ -11,7 +11,7 @@ require 'syntropy/errors'
 require 'syntropy/markdown'
 require 'syntropy/module'
 require 'syntropy/request_extensions'
-require 'syntropy/p2_extensions'
+require 'syntropy/papercraft_extensions'
 require 'syntropy/routing_tree'
 require 'syntropy/json_api'
 require 'syntropy/side_run'
@@ -47,7 +47,7 @@ module Syntropy
     "  #{GREEN}ooooo\n"\
     "  #{GREEN} ooo vvv       #{CLEAR}Syntropy - a web framework for Ruby\n"\
     "  #{GREEN}  o vvvvv     #{CLEAR}--------------------------------------\n"\
-    "  #{GREEN}  #{YELLOW}|#{GREEN}  vvv o    #{CLEAR}https://github.com/noteflakes/syntropy\n"\
+    "  #{GREEN}  #{YELLOW}|#{GREEN}  vvv o    #{CLEAR}https://github.com/digital-fabric/syntropy\n"\
     "  #{GREEN} :#{YELLOW}|#{GREEN}:::#{YELLOW}|#{GREEN}::#{YELLOW}|#{GREEN}:\n"\
     "#{YELLOW}+++++++++++++++++++++++++++++++++++++++++++++++++++++++++\e[0m\n\n"
 end

data/syntropy.gemspec

@@ -9,11 +9,11 @@ Gem::Specification.new do |s|
   s.email         = 'sharon@noteflakes.com'
   s.files         = `git ls-files`.split
 
-  s.homepage      = 'https://github.com/noteflakes/syntropy'
+  s.homepage      = 'https://github.com/digital-fabric/syntropy'
   s.metadata      = {
-    'homepage_uri' => 'https://github.com/noteflakes/syntropy',
+    'homepage_uri' => 'https://github.com/digital-fabric/syntropy',
     'documentation_uri' => 'https://www.rubydoc.info/gems/syntropy',
-    'changelog_uri' => 'https://github.com/noteflakes/syntropy/blob/master/CHANGELOG.md'
+    'changelog_uri' => 'https://github.com/digital-fabric/syntropy/blob/master/CHANGELOG.md'
   }
   s.rdoc_options  = ['--title', 'Extralite', '--main', 'README.md']
   s.extra_rdoc_files = ['README.md']
@@ -23,7 +23,7 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'extralite',     '2.13'
   s.add_dependency 'json',          '2.13.2'
-  s.add_dependency 'p2',            '2.13'
+  s.add_dependency 'papercraft',            '2.13'
   s.add_dependency 'qeweney',       '0.22'
   s.add_dependency 'tp2',           '0.16'
   s.add_dependency 'uringmachine',  '0.18'

data/test/app/api+.rb

@@ -1,4 +1,4 @@
-class API < Syntropy::RPCAPI
+class API < Syntropy::JSONAPI
   def initialize(env)
     super(env)
     @count = 0

data/test/bm_server.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'httparty'
+
+def t(url)
+  HTTParty.get(url)
+end
+
+def m(x=1)
+  t0 = Time.now
+  x.times { yield }
+  e = Time.now - t0
+  p [x, e, e/x, x/e]
+end
+  
+m(10000) { t('http://localhost:1234/') }

data/test/test_app.rb

@@ -104,7 +104,7 @@ class AppTest < Minitest::Test
     assert_equal 'About', req.response_body.chomp
 
     req = make_request(':method' => 'GET', ':path' => '/test/about/foo')
-    assert_equal '<p>Hello from Markdown</p>', req.response_body.chomp
+    assert_equal '<!DOCTYPE html><html><head><title></title></head><body><p>Hello from Markdown</p></body></html>', req.response_body.gsub(/\n/, '')
 
     req = make_request(':method' => 'HEAD', ':path' => '/test/about/foo')
     assert_nil req.response_body

data/test/test_routing_tree.rb

@@ -205,8 +205,8 @@ class RoutingTreeTest < Minitest::Test
     router = @rt.router_proc
 
     params = {}
-    route = router.('/docs/df/p2/issues/14', params)
-    assert_equal ({ 'org' => 'df', 'repo' => 'p2', 'id' => '14'}), params
+    route = router.('/docs/df/papercraft/issues/14', params)
+    assert_equal ({ 'org' => 'df', 'repo' => 'papercraft', 'id' => '14'}), params
     refute_nil route
     assert_equal '/docs/[org]/[repo]/issues/[id]', route[:path]
 
@@ -292,13 +292,13 @@ class RoutingTreeTest < Minitest::Test
     rt = Syntropy::RoutingTree.new(root_dir: File.join(@root_dir, 'site'), mount_path: '/')
     router = rt.router_proc
 
-    route = router.('/docs/df/p2/issues/14', {})
+    route = router.('/docs/df/papercraft/issues/14', {})
     assert_nil route
 
     params = {}
-    route = router.('/df/p2/issues/14', params)
+    route = router.('/df/papercraft/issues/14', params)
     refute_nil route
-    assert_equal ({ 'org' => 'df', 'repo' => 'p2', 'id' => '14'}), params
+    assert_equal ({ 'org' => 'df', 'repo' => 'papercraft', 'id' => '14'}), params
     assert_equal '/[org]/[repo]/issues/[id]', route[:path]
 
     route = router.('/assets', {})

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: syntropy
 version: !ruby/object:Gem::Version
-  version: '0.16'
+  version: '0.18'
 platform: ruby
 authors:
 - Sharon Rosner
@@ -38,7 +38,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 2.13.2
 - !ruby/object:Gem::Dependency
-  name: p2
+  name: papercraft
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
@@ -212,7 +212,7 @@ files:
 - lib/syntropy/json_api.rb
 - lib/syntropy/markdown.rb
 - lib/syntropy/module.rb
-- lib/syntropy/p2_extensions.rb
+- lib/syntropy/papercraft_extensions.rb
 - lib/syntropy/request_extensions.rb
 - lib/syntropy/routing_tree.rb
 - lib/syntropy/side_run.rb
@@ -244,6 +244,7 @@ files:
 - test/app_multi_site/bar.baz/index.html
 - test/app_multi_site/foo.bar/index.html
 - test/bm_router_proc.rb
+- test/bm_server.rb
 - test/helper.rb
 - test/run.rb
 - test/test_app.rb
@@ -255,13 +256,13 @@ files:
 - test/test_request_extensions.rb
 - test/test_routing_tree.rb
 - test/test_side_run.rb
-homepage: https://github.com/noteflakes/syntropy
+homepage: https://github.com/digital-fabric/syntropy
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/noteflakes/syntropy
+  homepage_uri: https://github.com/digital-fabric/syntropy
   documentation_uri: https://www.rubydoc.info/gems/syntropy
-  changelog_uri: https://github.com/noteflakes/syntropy/blob/master/CHANGELOG.md
+  changelog_uri: https://github.com/digital-fabric/syntropy/blob/master/CHANGELOG.md
 rdoc_options:
 - "--title"
 - Extralite