navigable-router 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2fcd2c783613974e0cfc498e7fed135d9c24faaac631c5492f1d80d7b800cfb4
-  data.tar.gz: 7e5959b84ec2c0508dab57e67c2a869cb92fb85230b2e7933a9ec698f849a1fe
+  metadata.gz: c748cefb4d44f7c08276fc8184e1c7409cba3527805e10723bcd6717e61f5673
+  data.tar.gz: 7517903e1cb426baaf2abb0998e58a65c68ac7b039b85db3c9a9a74b5fea5d68
 SHA512:
-  metadata.gz: ba294b063321dcb00cdf45d6130ba16debbd827381c74b7d51c48b4227e9a59526ae60642dcbdb6cf410f4983a801fbe1627ed82ad8b040bf5e28845e9306c05
-  data.tar.gz: e2b2b309c9b212c68bfb8b5544c9b837d8487b8ef94f00627ac7dd1d78e3034cb49fabaefd7dc6847017400949e103d380a643454eb48ffa9734f44a5fb71518
+  metadata.gz: 341079c0f664ddd3bfd0bc49784387e682b7c7e3885cb2f9669665624fb0f6e64ba544109e9fcc7d5cf9af33c575937ffd21f74ee15cfcf15b66810720e25236
+  data.tar.gz: d740816ccda07355f5d393bbb4179162f4f57ce3735af576026f6bb232872f99dad92c0f400441eadd8c3774dcf3d053f9b9b8e6136b2822091851f33e5a4ccc

data/.travis.yml

@@ -4,3 +4,11 @@ cache: bundler
 rvm:
   - 2.7.1
 before_install: gem install bundler -v 2.1.4
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+script:
+  - bundle exec rspec
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/README.md

@@ -1,5 +1,57 @@
 # Navigable::Router
 
+[![Gem Version](https://badge.fury.io/rb/navigable-router.svg)](https://badge.fury.io/rb/navigable-router) [![Build Status](https://travis-ci.org/first-try-software/navigable-router.svg?branch=main)](https://travis-ci.org/first-try-software/navigable-router) [![Maintainability](https://api.codeclimate.com/v1/badges/514b9791fb670b7a3abb/maintainability)](https://codeclimate.com/github/first-try-software/navigable-router/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/514b9791fb670b7a3abb/test_coverage)](https://codeclimate.com/github/first-try-software/navigable-router/test_coverage)
+
+Navigable is a family of gems that together provide all the tools you need to build fast, testable, and reliable JSON and/or GraphQL based APIs with isolated, composable business logic. The gems include:
+
+<table style="margin: 20px 0">
+<tr height="140">
+<td width="130"><img alt="Clipper Ship" src="https://raw.githubusercontent.com/first-try-software/navigable/main/assets/clipper.png"></td>
+<td>
+
+**[Navigable][navigable]**<br>
+A stand-alone tool for isolating business logic from external interfaces and cross-cutting concerns. Navigable composes self-configured command and observer objects to allow you to extend your business logic without modifying it. Navigable is compatible with any Ruby-based application development framework, including Rails, Hanami, and Sinatra.
+
+</td>
+</tr>
+<tr height="140">
+<td width="130"><img alt="Compass" src="https://raw.githubusercontent.com/first-try-software/navigable/main/assets/sextant.png"></td>
+<td>
+
+**[Navigable Router][router]** *(coming soon)*<br>
+A simple, highly-performant, Rack-based router.
+
+</td>
+</tr>
+<tr height="140">
+<td width="130"><img alt="Compass" src="https://raw.githubusercontent.com/first-try-software/navigable/main/assets/compass.png"></td>
+<td>
+
+**[Navigable Server][server]** *(coming soon)*<br>
+A Rack-based server for building Ruby and Navigable web applications.
+
+</td>
+</tr>
+<tr height="140">
+<td width="130"><img alt="Telescope" src="https://raw.githubusercontent.com/first-try-software/navigable/main/assets/telescope.png"></td>
+<td>
+
+**Navigable API** *(coming soon)*<br>
+An extension of Navigable Server for building restful JSON APIs.
+
+</td>
+</tr>
+<tr height="140">
+<td width="130"><img alt="Map" src="https://raw.githubusercontent.com/first-try-software/navigable/main/assets/map.png"></td>
+<td>
+
+**Navigable GraphQL** *(coming soon)*<br>
+An extension of Navigable Server for building GraphQL APIs.
+
+</td>
+</tr>
+</table>
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -18,7 +70,25 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+To use `Navigable::Router` simply instantiate a router and add your routes:
+
+```ruby
+router = Navigable::Router.new
+router.get('/ahoy', to: -> (env) { [200, { 'Content-Type' => 'text/html' }, [ 'Ahoy!' ]] })
+```
+The destination of the route needs to respond to `#call`, like the lambda above, or these classes:
+
+```ruby
+router.get('/swabbies', to: ShowSwabbies)
+router.get('/swabbies/:id', to: ShowSwabbie)
+router.post('/swabbies', to: CreateSwabbie)
+router.put('/swabbies/:id', to: UpdateSwabbie)
+router.delete('/swabbies/:id', to: DeleteSwabbie)
+```
+To run the app, add this to your config.ru:
+```ruby
+run router
+```
 
 ## Development
 
@@ -28,7 +98,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/navigable-router. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/navigable-router/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/first-try-softare/navigable-router. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/first-try-softare/navigable-router/blob/master/CODE_OF_CONDUCT.md).
 
 
 ## License
@@ -37,4 +107,8 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Navigable::Router project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/navigable-router/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Navigable::Router project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/first-try-software/navigable-router/blob/master/CODE_OF_CONDUCT.md).
+
+[navigable]: https://github.com/first-try-software/navigable
+[router]: https://github.com/first-try-software/navigable-router
+[server]: https://github.com/first-try-software/navigable-server

data/lib/navigable/router.rb

@@ -4,6 +4,7 @@ require 'mustermann'
 
 require 'navigable/router/version'
 require 'navigable/router/trie'
+require 'navigable/router/printer'
 
 module Navigable
   class Router
@@ -50,6 +51,10 @@ module Navigable
       endpoint ? endpoint.call(env) : NOT_FOUND_RESPONSE
     end
 
+    def print(stdout = STDOUT)
+      Printer.new(@static, @dynamic, stdout).print
+    end
+
     private
 
     def register_route(verb, path, to)
@@ -85,4 +90,4 @@ module Navigable
       @static[verb][path] = to
     end
   end
-end
+end

data/lib/navigable/router/node.rb

@@ -19,13 +19,18 @@ module Navigable
       end
 
       def find(segment)
-        find_node(segment) { |params| yield(symbolize_keys(params)) if params && block_given? } unless empty?
+        find_node(segment) { |params| yield(symbolize_keys(params)) if params && block_given? }
       end
 
       def attach(endpoint)
         @endpoint = endpoint
       end
 
+      def print(verb, routes, prefix = '')
+        print_segments(@static, routes, verb, prefix)
+        print_segments(@dynamic, routes, verb, prefix)
+      end
+
       private
 
       def add_static(segment)
@@ -39,6 +44,8 @@ module Navigable
       end
 
       def find_node(segment, &block)
+        return if empty?
+
         find_static(segment, &block) || find_dynamic(segment, &block)
       end
 
@@ -68,6 +75,13 @@ module Navigable
       def symbolize_keys(hash)
         hash.each_with_object({}) { |(key, value), obj| obj[key.to_sym] = value }
       end
+
+      def print_segments(segments, routes, verb, prefix)
+        segments&.each do |segment, node|
+          routes << { verb: verb, path: "#{prefix}/#{segment}", endpoint: node.endpoint } if node.endpoint
+          node.print(verb, routes, "#{prefix}/#{segment}")
+        end
+      end
     end
   end
 end

data/lib/navigable/router/printer.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Navigable
+  class Router
+    class Printer
+      VERBS = %w(GET HEAD POST PUT PATCH DELETE).freeze
+
+      attr_reader :static, :dynamic, :memo, :stdout
+
+      def initialize(static, dynamic, stdout = STDOUT)
+        @static, @dynamic = static, dynamic
+        @stdout = stdout
+        @memo = []
+      end
+
+      def print
+        gather_static_routes
+        gather_dynamic_routes
+        print_routes
+      end
+
+      private
+
+      def gather_static_routes
+        static.each do |verb, routes|
+          routes.each do |path, endpoint|
+            memo << { verb: verb, path: path, endpoint: endpoint }
+          end
+        end
+      end
+
+      def gather_dynamic_routes
+        dynamic.each do |verb, trie|
+          trie.print(verb, memo)
+        end
+      end
+
+      def print_routes
+        sorted_routes.each { |route| print_route(route) }
+      end
+
+      def sorted_routes
+        memo.sort_by { |route| "#{route[:path]}-#{VERBS.find_index(route[:verb])}" }
+      end
+
+      def print_route(route)
+        stdout.puts "#{pad(route[:verb], 8)} #{pad(route[:path], -50)} => #{route[:endpoint]}"
+      end
+
+      def pad(str, length)
+        "%#{length}s" % str
+      end
+    end
+  end
+end

data/lib/navigable/router/trie.rb

@@ -26,6 +26,10 @@ module Navigable
         node&.endpoint
       end
 
+      def print(verb, routes)
+        @root.print(verb, routes)
+      end
+
       private
 
       def traverse(path)

data/lib/navigable/router/version.rb

@@ -1,5 +1,5 @@
 module Navigable
   class Router
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/navigable-router.gemspec

@@ -31,5 +31,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 12.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "rspec_junit_formatter", "~>0.4"
-  spec.add_development_dependency "simplecov", "~>0.17"
+  spec.add_development_dependency "simplecov", "~>0.17.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: navigable-router
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Alan Ridlehoover
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-21 00:00:00.000000000 Z
+date: 2020-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mustermann
@@ -115,14 +115,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.17'
+        version: 0.17.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.17'
+        version: 0.17.0
 description: A simple, highly-performant, Rack-based router.
 email:
 - navigable@firsttry.software
@@ -142,6 +142,7 @@ files:
 - bin/setup
 - lib/navigable/router.rb
 - lib/navigable/router/node.rb
+- lib/navigable/router/printer.rb
 - lib/navigable/router/trie.rb
 - lib/navigable/router/version.rb
 - navigable-router.gemspec