syntropy 0.16 → 0.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b90967d51ee11dd83db1237db95b35fb1a2bd9cb36248086bfe62082ddd4c0a5
-  data.tar.gz: 187eb2adc5a21df0f8d0400ef54609300658df9e3ba371686c1007d4744c0667
+  metadata.gz: db440894351239f4fdc164cd3550d741919a8fed568f20620040cca54b7dbebd
+  data.tar.gz: 165d4a52b7d7ce7fb8377d7b0e96f108ef7c65cfc768cf59ec73b97a4f7c84e0
 SHA512:
-  metadata.gz: 1c0aff28315990526db9d48c1d4dba164d9944f93bdbcb671fdd6526a2f77eac28fa89cc2a99e68ce6bc5e55db85582270b3ea6032456c5e5d2fe9847150e3ae
-  data.tar.gz: 10d5ceb7568d22a07d89e13cca104aeeeea94e62a03c778a72c3da360b8a21ef466038d4d872b75ae00b1634c2dfffc8931e4a61695e95e99c78a51bfcd5c643
+  metadata.gz: d2bb77e92b44ca5e66a46c4427a4705cb2316b42372a71ce3c1e250bf1f93bccbe9201fe9602c174a6315880f33d47338133c121871561ab31e98c5a095bb385
+  data.tar.gz: c1069d92fbdb6a4a9eb792fa26c16e3d3494c882eb8a8d09e211a0f16b7b880bab8e0004a74cf4d1969398c2185091282bc3a4eebbf37b325c31ae06d52d3cd0

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 0.17 2025-09-11
+
+- Move repo to [digital-fabric](https://github.com/digital-fabric/syntropy)
+
 # 0.16 2025-09-11
 
 - `syntropy` script:

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,7 +38,7 @@ 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
+- [TP2](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.
@@ -46,6 +46,16 @@ Syntropy is based on:
 - [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/lib/syntropy/app.rb

@@ -183,7 +183,7 @@ module Syntropy
           }
           body {
             markdown md
-            auto_refresh_watch!
+            auto_refresh_watch! if @env[:dev_mode]
           }
         }
       }

data/lib/syntropy/version.rb

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

data/lib/syntropy.rb

@@ -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']

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/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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: syntropy
 version: !ruby/object:Gem::Version
-  version: '0.16'
+  version: '0.17'
 platform: ruby
 authors:
 - Sharon Rosner
@@ -255,13 +255,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