syntropy 0.10.1 → 0.12

data/test/test_routing_tree.rb

@@ -0,0 +1,427 @@
+# frozen_string_literal: true
+
+require_relative 'helper'
+require 'syntropy/routing_tree'
+
+class RoutingTreeTest < Minitest::Test
+  FILE_TREE = {
+    'site': {
+
+      '[org]': {
+        'index.rb': '',
+        '[repo]': {
+          '_error.rb': '',
+          'index.rb': '',
+          'commits': {
+            'index.rb': ''
+          },
+          'issues': {
+            '_hook.rb': '',
+            '[id]': {
+              'index.rb': ''
+            },
+            'index.rb': ''
+          },
+          '_layout.rb': ''
+        }
+      },
+      '_error.rb': '',
+      '_hook.rb': '',
+      'about.md': '',
+      'index.rb': '',
+      'api+.rb': '',
+      'assets': {
+        'img': {
+          'foo.jpg': ''
+        },
+        'css': {
+          'style.css': ''
+        }
+      },
+      'posts': {
+        '[id].rb': '',
+        'index.rb': ''
+      },
+
+      'old': {
+        'index.html': '',
+        'baz.html': ''
+      }
+    }
+  }
+
+  def setup
+    @root_dir = "/tmp/#{__FILE__.gsub('/', '-')}-#{SecureRandom.hex}"
+    make_tmp_file_tree(@root_dir, FILE_TREE)
+    @rt = Syntropy::RoutingTree.new(root_dir: File.join(@root_dir, 'site'), mount_path: '/docs')
+  end
+
+  def test_compute_clean_url_path
+    c = ->(fn) { @rt.send(:compute_clean_url_path, fn) }
+    assert_equal '/', c.(File.join(@rt.root_dir, '/index.rb'))
+    assert_equal '/about', c.(File.join(@rt.root_dir, '/about.md'))
+    assert_equal '/[org]', c.(File.join(@rt.root_dir, '/[org]'))
+    assert_equal '/favicon.ico', c.(File.join(@rt.root_dir, '/favicon.ico'))
+    assert_equal '/assets/style.css', c.(File.join(@rt.root_dir, '/assets/style.css'))
+    assert_equal '/foo.js', c.(File.join(@rt.root_dir, '/foo.js'))
+  end
+
+  def test_routing_tree_generation
+    root = @rt.root
+    assert_equal '/docs', root[:path]
+    assert_nil root[:parent]
+    assert_nil root[:param]
+    assert_nil root[:target]
+    assert_equal ['[]', 'about', 'api', 'assets', 'old', 'posts'], root[:children].keys.sort_by(&:to_s)
+
+    entry = @rt.static_map['/docs']
+    assert_equal File.join(@rt.root_dir, 'index.rb'), entry[:target][:fn]
+
+    about = root[:children]['about']
+    assert_equal '/docs/about', about[:path]
+    assert_equal root, about[:parent]
+    assert_equal File.join(@rt.root_dir, 'about.md'), about[:target][:fn]
+    assert_nil about[:children]
+
+    org = root[:children]['[]']
+    assert_equal '/docs/[org]', org[:path]
+    assert_equal 'org', org[:param]
+    refute_nil org[:target]
+    assert_equal File.join(@rt.root_dir, '[org]/index.rb'), org[:target][:fn]
+    assert_equal ['[]'], org[:children].keys.sort_by(&:to_s)
+
+    repo = org[:children]['[]']
+    assert_equal org, repo[:parent]
+    assert_equal '/docs/[org]/[repo]', repo[:path]
+    assert_equal 'repo', repo[:param]
+    assert_equal File.join(@rt.root_dir, '[org]/[repo]/index.rb'), repo[:target][:fn]
+    assert_equal ['commits', 'issues'], repo[:children].keys.sort_by(&:to_s)
+
+    issues = repo[:children]['issues']
+    assert_equal repo, issues[:parent]
+    assert_equal '/docs/[org]/[repo]/issues', issues[:path]
+    assert_nil issues[:param]
+    assert_equal File.join(@rt.root_dir, '[org]/[repo]/issues/index.rb'), issues[:target][:fn]
+    assert_equal ['[]'], issues[:children].keys.sort_by(&:to_s)
+
+    id = issues[:children]['[]']
+    assert_equal issues, id[:parent]
+    assert_equal '/docs/[org]/[repo]/issues/[id]', id[:path]
+    assert_equal 'id', id[:param]
+    assert_equal File.join(@rt.root_dir, '[org]/[repo]/issues/[id]/index.rb'), id[:target][:fn]
+    assert_equal [], id[:children].keys.sort_by(&:to_s)
+
+    posts = root[:children]['posts']
+    assert_equal root, posts[:parent]
+    assert_equal '/docs/posts', posts[:path]
+    assert_nil posts[:target]
+    assert_equal ['[]'], posts[:children].keys.sort_by(&:to_s)
+
+    id = posts[:children]['[]']
+    assert_equal posts, id[:parent]
+    assert_equal '/docs/posts/[id]', id[:path]
+    assert_equal 'id', id[:param]
+    assert_equal File.join(@rt.root_dir, 'posts/[id].rb'), id[:target][:fn]
+    assert_nil id[:children]
+
+    old = root[:children]['old']
+    refute_nil old
+    assert_nil old[:target]
+
+    # static files are not added to the routing tree, so the assets entry has no children
+    assets = root[:children]['assets']
+    refute_nil assets
+    assert_nil assets[:target]
+  end
+
+  def test_static_map
+    map = @rt.static_map
+    assert_equal 7, map.size
+
+    keys = map.keys.sort
+    assert_equal [
+      '/docs', '/docs/about', '/docs/assets/css/style.css',
+      '/docs/assets/img/foo.jpg', '/docs/old', '/docs/old/baz', '/docs/posts'
+    ], keys
+
+    o = map['/docs/assets/css/style.css']
+    assert_equal File.join(@rt.root_dir, 'assets/css/style.css'), o[:target][:fn]
+
+    o = map['/docs/assets/img/foo.jpg']
+    assert_equal File.join(@rt.root_dir, 'assets/img/foo.jpg'), o[:target][:fn]
+
+    o = map['/docs/old/baz']
+    assert_equal File.join(@rt.root_dir, 'old/baz.html'), o[:target][:fn]
+
+    o = map['/docs/posts']
+    assert_equal File.join(@rt.root_dir, 'posts/index.rb'), o[:target][:fn]
+    refute_nil o[:parent]
+    assert_equal '/docs', o[:parent][:path]
+
+    o = map['/docs/old/baz']
+    assert_equal File.join(@rt.root_dir, 'old/baz.html'), o[:target][:fn]
+
+    o = map['/docs/old']
+    assert_equal File.join(@rt.root_dir, 'old/index.html'), o[:target][:fn]
+    refute_nil o[:parent]
+    assert_equal '/docs', o[:parent][:path]
+
+    o = map['/docs']
+    assert_equal File.join(@rt.root_dir, 'index.rb'), o[:target][:fn]
+
+    o = map['/docs/about']
+    assert_equal File.join(@rt.root_dir, 'about.md'), o[:target][:fn]
+  end
+
+  def test_dynamic_map
+    map = @rt.dynamic_map
+    assert_equal 7, map.size
+
+    keys = map.keys.sort
+    assert_equal [
+      '/docs/[org]', '/docs/[org]/[repo]', '/docs/[org]/[repo]/commits',
+      '/docs/[org]/[repo]/issues', '/docs/[org]/[repo]/issues/[id]',
+      '/docs/api+', '/docs/posts/[id]'
+    ], keys
+
+    # all entries in dynamic map should have targets
+    assert_equal [], map.values.select { !it[:target] }
+
+    # all entries should a path equal to the key
+    assert_equal ({}), map.select { |k, v| k != v[:path] }
+
+    assert_equal [
+      '[org]/index.rb',
+      '[org]/[repo]/index.rb',
+      '[org]/[repo]/commits/index.rb',
+      '[org]/[repo]/issues/index.rb',
+      '[org]/[repo]/issues/[id]/index.rb',
+      'api+.rb',
+      'posts/[id].rb'
+    ].map { File.join(@rt.root_dir, it) }, keys.map { map[it][:target][:fn] }
+  end
+
+  def test_router_proc
+    router = @rt.router_proc
+
+    params = {}
+    route = router.('/docs/df/p2/issues/14', params)
+    assert_equal ({ 'org' => 'df', 'repo' => 'p2', 'id' => '14'}), params
+    refute_nil route
+    assert_equal '/docs/[org]/[repo]/issues/[id]', route[:path]
+
+    route = router.('/foo', {})
+    assert_nil route
+
+    route = router.('/abc/../def', {})
+    assert_nil route
+
+    route = router.('/assets', {})
+    assert_nil route
+
+    route = router.('/docs/assets', {})
+    assert_nil route
+
+    route = router.('/docs/assets/foo', {})
+    assert_nil route
+
+    route = router.('/docs/assets/img', {})
+    assert_nil route
+
+    route = router.('/docs/assets/foo/bar.jpg', {})
+    assert_nil route
+
+    route = router.('/docs/assets/img/foo.jpg', {})
+    assert_equal File.join(@rt.root_dir, 'assets/img/foo.jpg'), route[:target][:fn]
+
+    route = router.('/docs/assets/img/bar.jpg', {})
+    assert_nil route
+
+    route = router.('/docs/about', {})
+    assert_equal File.join(@rt.root_dir, 'about.md'), route[:target][:fn]
+
+    route = router.('/docs/foo', params = {})
+    assert_equal File.join(@rt.root_dir, '[org]/index.rb'), route[:target][:fn]
+    assert_equal 'foo', params['org']
+
+    route = router.('/docs/foo/bar', params = {})
+    assert_equal File.join(@rt.root_dir, '[org]/[repo]/index.rb'), route[:target][:fn]
+    assert_equal 'foo', params['org']
+    assert_equal 'bar', params['repo']
+
+    route = router.('/docs/bar/baz/commits', params = {})
+    assert_equal File.join(@rt.root_dir, '[org]/[repo]/commits/index.rb'), route[:target][:fn]
+    assert_equal 'bar', params['org']
+    assert_equal 'baz', params['repo']
+
+    route = router.('/docs/foo/bar/issues', params = {})
+    assert_equal File.join(@rt.root_dir, '[org]/[repo]/issues/index.rb'), route[:target][:fn]
+    assert_equal 'foo', params['org']
+    assert_equal 'bar', params['repo']
+
+    route = router.('/docs/bar/baz/issues/14', params = {})
+    assert_equal File.join(@rt.root_dir, '[org]/[repo]/issues/[id]/index.rb'), route[:target][:fn]
+    assert_equal 'bar', params['org']
+    assert_equal 'baz', params['repo']
+    assert_equal '14', params['id']
+
+    route = router.('/docs/foo/bar/issues/14/blah', {})
+    assert_nil route
+
+    route = router.('/docs/foo/bar/baz', {})
+    assert_nil route
+
+    route = router.('/docs/api', {})
+    assert_equal File.join(@rt.root_dir, 'api+.rb'), route[:target][:fn]
+
+    route = router.('/docs/api/foo/bar', {})
+    assert_equal File.join(@rt.root_dir, 'api+.rb'), route[:target][:fn]
+
+    route = router.('/docs/api/foo/bar', {})
+    assert_equal File.join(@rt.root_dir, 'api+.rb'), route[:target][:fn]
+
+    route = router.('/docs/posts', {})
+    assert_equal File.join(@rt.root_dir, 'posts/index.rb'), route[:target][:fn]
+
+    route = router.('/docs/posts/foo', params = {})
+    assert_equal File.join(@rt.root_dir, 'posts/[id].rb'), route[:target][:fn]
+    assert_equal 'foo', params['id']
+  end
+
+  def test_route_error_handler
+    e = @rt.dynamic_map['/docs/[org]']
+    target = @rt.route_error_handler(e)
+    assert_kind_of Hash, target
+    assert_equal :module, target[:kind]
+    assert_equal File.join(@rt.root_dir, '_error.rb'), target[:fn]
+
+    e = @rt.dynamic_map['/docs/api+']
+    target = @rt.route_error_handler(e)
+    assert_equal :module, target[:kind]
+    assert_equal File.join(@rt.root_dir, '_error.rb'), target[:fn]
+
+    e = @rt.dynamic_map['/docs/[org]/[repo]']
+    target = @rt.route_error_handler(e)
+    assert_equal :module, target[:kind]
+    assert_equal File.join(@rt.root_dir, '[org]/[repo]/_error.rb'), target[:fn]
+  end
+
+  def test_route_hooks
+    e = @rt.dynamic_map['/docs/[org]']
+    hooks = @rt.route_hooks(e)
+    assert_equal [
+      { kind: :module, fn: File.join(@rt.root_dir, '_hook.rb') }
+    ], hooks
+
+    e = @rt.dynamic_map['/docs/api+']
+    hooks = @rt.route_hooks(e)
+    assert_equal [
+      { kind: :module, fn: File.join(@rt.root_dir, '_hook.rb') }
+    ], hooks
+
+    e = @rt.dynamic_map['/docs/[org]/[repo]']
+    hooks = @rt.route_hooks(e)
+    assert_equal [
+      { kind: :module, fn: File.join(@rt.root_dir, '_hook.rb') }
+    ], hooks
+
+    e = @rt.dynamic_map['/docs/[org]/[repo]/issues']
+    hooks = @rt.route_hooks(e)
+    assert_equal [
+      { kind: :module, fn: File.join(@rt.root_dir, '_hook.rb') },
+      { kind: :module, fn: File.join(@rt.root_dir, '[org]/[repo]/issues/_hook.rb') }
+    ], hooks
+
+    e = @rt.dynamic_map['/docs/[org]/[repo]/issues/[id]']
+    hooks = @rt.route_hooks(e)
+    assert_equal [
+      { kind: :module, fn: File.join(@rt.root_dir, '_hook.rb') },
+      { kind: :module, fn: File.join(@rt.root_dir, '[org]/[repo]/issues/_hook.rb') }
+    ], hooks
+  end
+
+  def test_routing_root_mounted
+    rt = Syntropy::RoutingTree.new(root_dir: File.join(@root_dir, 'site'), mount_path: '/')
+    router = rt.router_proc
+
+    # pp rt.root
+    # puts
+
+    route = router.('/docs/df/p2/issues/14', {})
+    assert_nil route
+
+    params = {}
+    route = router.('/df/p2/issues/14', params)
+    refute_nil route
+    assert_equal ({ 'org' => 'df', 'repo' => 'p2', 'id' => '14'}), params
+    assert_equal '/[org]/[repo]/issues/[id]', route[:path]
+
+    route = router.('/assets', {})
+    assert_nil route
+
+    route = router.('/assets/foo', {})
+    assert_nil route
+
+    route = router.('/assets/img', {})
+    assert_nil route
+
+    route = router.('/assets/foo/bar.jpg', {})
+    assert_nil route
+
+    route = router.('/assets/img/foo.jpg', {})
+    assert_equal File.join(@rt.root_dir, 'assets/img/foo.jpg'), route[:target][:fn]
+
+    route = router.('/assets/img/bar.jpg', {})
+    assert_nil route
+
+    route = router.('/about', {})
+    assert_equal File.join(@rt.root_dir, 'about.md'), route[:target][:fn]
+
+    route = router.('/foo', params = {})
+    assert_equal File.join(@rt.root_dir, '[org]/index.rb'), route[:target][:fn]
+    assert_equal 'foo', params['org']
+
+    route = router.('/foo/bar', params = {})
+    assert_equal File.join(@rt.root_dir, '[org]/[repo]/index.rb'), route[:target][:fn]
+    assert_equal 'foo', params['org']
+    assert_equal 'bar', params['repo']
+
+    route = router.('/bar/baz/commits', params = {})
+    assert_equal File.join(@rt.root_dir, '[org]/[repo]/commits/index.rb'), route[:target][:fn]
+    assert_equal 'bar', params['org']
+    assert_equal 'baz', params['repo']
+
+    route = router.('/foo/bar/issues', params = {})
+    assert_equal File.join(@rt.root_dir, '[org]/[repo]/issues/index.rb'), route[:target][:fn]
+    assert_equal 'foo', params['org']
+    assert_equal 'bar', params['repo']
+
+    route = router.('/bar/baz/issues/14', params = {})
+    assert_equal File.join(@rt.root_dir, '[org]/[repo]/issues/[id]/index.rb'), route[:target][:fn]
+    assert_equal 'bar', params['org']
+    assert_equal 'baz', params['repo']
+    assert_equal '14', params['id']
+
+    route = router.('/foo/bar/issues/14/blah', {})
+    assert_nil route
+
+    route = router.('/foo/bar/baz', {})
+    assert_nil route
+
+    route = router.('/api', {})
+    assert_equal File.join(@rt.root_dir, 'api+.rb'), route[:target][:fn]
+
+    route = router.('/api/foo/bar', {})
+    assert_equal File.join(@rt.root_dir, 'api+.rb'), route[:target][:fn]
+
+    route = router.('/api/foo/bar', {})
+    assert_equal File.join(@rt.root_dir, 'api+.rb'), route[:target][:fn]
+
+    route = router.('/posts', {})
+    assert_equal File.join(@rt.root_dir, 'posts/index.rb'), route[:target][:fn]
+
+    route = router.('/posts/foo', params = {})
+    assert_equal File.join(@rt.root_dir, 'posts/[id].rb'), route[:target][:fn]
+    assert_equal 'foo', params['id']
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: syntropy
 version: !ruby/object:Gem::Version
-  version: 0.10.1
+  version: '0.12'
 platform: ruby
 authors:
 - Sharon Rosner
@@ -43,28 +43,42 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: '2.4'
+        version: '2.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: '2.4'
+        version: '2.8'
+- !ruby/object:Gem::Dependency
+  name: papercraft
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: qeweney
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: '0.21'
+        version: '0.22'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: '0.21'
+        version: '0.22'
 - !ruby/object:Gem::Dependency
   name: tp2
   requirement: !ruby/object:Gem::Requirement
@@ -198,7 +212,7 @@ files:
 - lib/syntropy/markdown.rb
 - lib/syntropy/module.rb
 - lib/syntropy/request_extensions.rb
-- lib/syntropy/router.rb
+- lib/syntropy/routing_tree.rb
 - lib/syntropy/rpc_api.rb
 - lib/syntropy/side_run.rb
 - lib/syntropy/version.rb
@@ -218,6 +232,7 @@ files:
 - test/app/bar.rb
 - test/app/baz.rb
 - test/app/index.html
+- test/app/params/[foo].rb
 - test/app/tmp.rb
 - test/app_custom/_site.rb
 - test/app_multi_site/_site.rb
@@ -227,12 +242,13 @@ files:
 - test/run.rb
 - test/test_app.rb
 - test/test_connection_pool.rb
+- test/test_errors.rb
 - test/test_file_watch.rb
 - test/test_module.rb
-- test/test_router.rb
+- test/test_request_extensions.rb
+- test/test_routing_tree.rb
 - test/test_rpc_api.rb
 - test/test_side_run.rb
-- test/test_validation.rb
 homepage: https://github.com/noteflakes/syntropy
 licenses:
 - MIT