navigable 1.0.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 60c6f7c8bbd71f2616a448c4a43ff4647b4ac0ffd8ff1c3e75d833be6d943c7f
-  data.tar.gz: 52af4a03f43abcb62e228edace4e1acf5ca3ba7321ea50eaa63a5c8dd94b0432
+  metadata.gz: 3a004a4e2480872ee2a0130049ad9ef937a051ce833e531ac7630e959619d810
+  data.tar.gz: e8da43504809998f63d4814e6e811210bed57e08da0fbeb129ed0cf6771d152b
 SHA512:
-  metadata.gz: e8485af6e386a84e7bf913af36744abf27ab9549b4961919066de53fb7d0e50d136bdd785d73fa13bdf747788aff305ad85434ecf40288288d0eeaf0f7412e85
-  data.tar.gz: b89a7583e5c59e4ebea72c10127eda0c79a79531f39f07098aad468dfedbd6d4b650da0baf734b9b37126f943ea4a2411aa1872e95d6717e7da0f103e2f435ee
+  metadata.gz: d59a86ed9f40d4d1def574099592f46b4434f78deb0aa1b6e89d41fd6cc13d8c89db2393885bff1449113741c9e566cecd6d30848962c2afd6da6f23dbf29abf
+  data.tar.gz: c159acdb8be562e419540b01cccf1efb9df1b8dfa37f9fd85b7e6ac7a455fb54dd080c29d062b96460fb8f393688d15061ac10466b68dd83f0e025309a34aec3

data/.gitignore

@@ -13,5 +13,6 @@
 # rspec failure tracking
 .rspec_status
 
+.DS_Store
 Gemfile.lock
 

data/README.md

@@ -11,8 +11,17 @@ Navigable is a family of gems that together provide all the tools you need to bu
 <td width="130"><img alt="Clipper Ship" src="https://raw.githubusercontent.com/first-try-software/navigable/main/assets/clipper.png"></td>
 <td>
 
-**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 and Hanami.
+**[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>
@@ -20,8 +29,8 @@ A stand-alone tool for isolating business logic from external interfaces and cro
 <td width="130"><img alt="Compass" src="https://raw.githubusercontent.com/first-try-software/navigable/main/assets/compass.png"></td>
 <td>
 
-**Navigable Server** *(coming soon)*<br>
-A Rack-based web server for building Navigable-backed applications.
+**[Navigable Server][server]** *(coming soon)*<br>
+A Rack-based server for building Ruby and Navigable web applications.
 
 </td>
 </tr>
@@ -49,8 +58,6 @@ An extension of Navigable Server for building GraphQL APIs.
 
 <img style="width: 600px; display: block; margin: 0 auto;" alt="Lighthouse" src="https://raw.githubusercontent.com/first-try-software/navigable/main/assets/lighthouse.png">
 
-<br>
-
 # The Navigable Charter
 
 We hold these truths to be self-evident, that not all objects are created equal, that poorly structured code leads to poorly tested code, and that poorly tested code leads to rigid software and fearful engineers.
@@ -164,11 +171,13 @@ Here are a few things to look for in the code above:
 
 * Use the `observes_all_commands` statement (as shown in the `Monitor` class) for cross-cutting concerns. It tells Navigable to send messages to the observer no matter which command was executed.
 
+For a deeper look at the core concepts introduced by Navigable, please have a look at our [wiki][wiki].
+
 ## Feedback
 
 We are really excited about Navigable! We think it solves the problem of seperating business logic from the web interface, persistence layer, and even cross-cutting concerns in an elegant and simple way.
 
-We sincerely hope you'll download Navigable and play with it! If you do, please send us a note to [navigable@firsttry.software][mail] to give us your thoughts!
+We're thrilled you're checking out Navigable! If you have any questions or comments, please feel free to reach out to [navigable@firsttry.software][mail].
 
 ## Installation
 
@@ -210,3 +219,7 @@ Everyone interacting in the Navigable project's codebases, issue trackers, chat
 [ocp]: https://en.wikipedia.org/wiki/Open–closed_principle
 [ddd]: https://en.wikipedia.org/wiki/Domain-driven_design
 [mail]: mailto:navigable@firsttry.software
+[wiki]: https://github.com/first-try-software/navigable/wiki
+[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/command.rb

@@ -4,6 +4,8 @@ require 'navigable/observable'
 
 module Navigable
   module Command
+    class NotFoundError < StandardError; end
+
     TYPE = :__command__
     EXECUTE_NOT_IMPLEMENTED_MESSAGE = 'Class must implement `execute` method.'
 
@@ -20,7 +22,7 @@ module Navigable
       base.class_eval do
         attr_reader :params, :observers
 
-        def initialize(params: {}, observers: [])
+        def inject(params: {}, observers: [])
           @params = params
           @observers = observers
         end

data/lib/navigable/dispatcher.rb

@@ -1,12 +1,12 @@
 # frozen-string-literal: true
 
-require 'navigable/basic_resolver'
+require 'navigable/null_resolver'
 require 'navigable/observer'
 require 'navigable/command'
 
 module Navigable
   class Dispatcher
-    def self.dispatch(key, params: {}, resolver: BasicResolver.new)
+    def self.dispatch(key, params: {}, resolver: NullResolver.new)
       self.new(key, params: params, resolver: resolver).dispatch
     end
 
@@ -25,11 +25,15 @@ module Navigable
     end
 
     def observers
-      Manufacturable.build_all(Observer::TYPE, key, params: params).push(resolver)
+      Manufacturable.build_all(Observer::TYPE, key) { |observer| observer.inject(params: params) }.push(resolver)
     end
 
     def command
-      Manufacturable.build_one(Command::TYPE, key, params: params, observers: observers)
+      build_command.tap { |command| raise Navigable::Command::NotFoundError unless command }
+    end
+
+    def build_command
+      Manufacturable.build_one(Command::TYPE, key) { |command| command.inject(params: params, observers: observers) }
     end
   end
 end

data/lib/navigable/{basic_resolver.rb → null_resolver.rb}

@@ -3,7 +3,7 @@
 require 'navigable/resolver'
 
 module Navigable
-  class BasicResolver
+  class NullResolver
     extend Navigable::Resolver
 
     def resolve

data/lib/navigable/observer.rb

@@ -23,7 +23,7 @@ module Navigable
       base.class_eval do
         attr_reader :params
 
-        def initialize(params: {})
+        def inject(params: {})
           @params = params
         end
 

data/lib/navigable/resolver.rb

@@ -4,10 +4,23 @@ require 'navigable/observer_interface'
 
 module Navigable
   module Resolver
-    RESOLVE_NOT_IMPLEMENTED_MESSAGE = 'Class must implement `resolve` method.'
+    TYPE = :__resolver__
+    RESOLVE_NOT_IMPLEMENTED_MESSAGE = 'Resolver classes must implement a `resolve` method.'
 
     def self.extended(base)
+      base.extend(Manufacturable::Item)
       base.include(ObserverInterface)
+
+      base.instance_eval do
+        def default_resolver
+          default_manufacturable(TYPE)
+        end
+
+        def resolves(key)
+          corresponds_to(key, TYPE)
+        end
+      end
+
       base.class_eval do
         def resolve
           raise NotImplementedError.new(RESOLVE_NOT_IMPLEMENTED_MESSAGE)

data/lib/navigable/version.rb

@@ -1,5 +1,5 @@
 # frozen-string-literal: true
 
 module Navigable
-  VERSION = "1.0.0"
+  VERSION = "1.3.0"
 end

data/navigable.gemspec

@@ -7,8 +7,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Alan Ridlehoover", "Fito von Zastrow"]
   spec.email         = ["navigable@firsttry.software"]
 
-  spec.summary       = %q{Ahoy! Navigable will get you there!}
-  spec.description   = %q{We hold these truths to be self-evident, that not all objects are created equal, that poorly structured code leads to poorly tested code, and that poorly tested code leads to rigid software and fearful engineers. We believe a framework should break free of this tyranny. It should be simple, testable, and fast. It can be opinionated. But, it should leverage SOLID principles to guide us toward well structured, well tested, maleable code that is truly navigable.}
+  spec.summary       = %q{Ahoy! Welcome aboard Navigable!}
+  spec.description   = %q{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.}
   spec.homepage      = "https://firsttry.software"
   spec.license       = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
@@ -18,17 +18,17 @@ Gem::Specification.new do |spec|
   spec.metadata["bug_tracker_uri"] = "https://github.com/first-try-software/navigable/issues"
 
   spec.files         = Dir.chdir(File.expand_path("..", __FILE__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|assets)/}) }
   end
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "manufacturable", "~> 1.4"
+  spec.add_dependency "manufacturable", "~> 1.5"
 
   spec.add_development_dependency "bundler", "~> 2.0"
   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.16"
+  spec.add_development_dependency "simplecov", "~>0.17.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: navigable
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Alan Ridlehoover
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-17 00:00:00.000000000 Z
+date: 2020-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: manufacturable
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -87,20 +87,19 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.16'
+        version: 0.17.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.16'
-description: We hold these truths to be self-evident, that not all objects are created
-  equal, that poorly structured code leads to poorly tested code, and that poorly
-  tested code leads to rigid software and fearful engineers. We believe a framework
-  should break free of this tyranny. It should be simple, testable, and fast. It can
-  be opinionated. But, it should leverage SOLID principles to guide us toward well
-  structured, well tested, maleable code that is truly navigable.
+        version: 0.17.0
+description: 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.
 email:
 - navigable@firsttry.software
 executables: []
@@ -116,19 +115,12 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- assets/clipper.png
-- assets/compass.png
-- assets/header.png
-- assets/lighthouse.png
-- assets/map.png
-- assets/navigable.png
-- assets/telescope.png
 - bin/console
 - bin/setup
 - lib/navigable.rb
-- lib/navigable/basic_resolver.rb
 - lib/navigable/command.rb
 - lib/navigable/dispatcher.rb
+- lib/navigable/null_resolver.rb
 - lib/navigable/observable.rb
 - lib/navigable/observer.rb
 - lib/navigable/observer_interface.rb
@@ -160,5 +152,5 @@ requirements: []
 rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: Ahoy! Navigable will get you there!
+summary: Ahoy! Welcome aboard Navigable!
 test_files: []