navigable 1.0.2 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b96bb3ac3fd1a2e93eaaa1517c7bf890065f9ee803f4e20269bf96fcaea7f78f
-  data.tar.gz: 3e08676aef87c9340af3b58e0b8124221e17a7ced004813dddd8f9377d9da9e0
+  metadata.gz: 966eb5d995d2e8f36c4450d4e2519457da26c2a0002710c12f77a612826d1807
+  data.tar.gz: 103449a1ac072269ea8b1286b47b07d6be5d6964adc04ca4b183ba40232d4ea8
 SHA512:
-  metadata.gz: 689df880596033ed27ef92716554f2534a12a43b5d6c54a100eb363d8b3a57eed6ed356d77fbbcfddcf2ffc6509c6e866b0d6365ba27b9ecd908216b4d6b9322
-  data.tar.gz: 298e1239bfd0cf6e7050766173dfee8cbae94af0cf2994e2d4bb0b7a318f3303da09878c55c45dcffff1356a8a3d69072154bb9bd8d81b17219bae42090224f0
+  metadata.gz: 97a549b8a71e31b29c3c99773a4ad24f1ce653b5223c5e526de33130196c025ffe502b296ae5719b67bee26d9d206a9c738f8ac5b8a4eed025295392c7b2396c
+  data.tar.gz: 62cd0c2c211d3e4056c6cb6cb3801a165842af287a09f95451fe78b265f6b04111acee9ae4b0cbadee246b3c80748a4ba38afd17e00ac8032ef32f4d224159fb

data/.gitignore

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

data/README.md

@@ -11,26 +11,26 @@ 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>
+**[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/compass.png"></td>
+<td width="130"><img alt="Compass" src="https://raw.githubusercontent.com/first-try-software/navigable/main/assets/sextant.png"></td>
 <td>
 
-**Navigable Server** *(coming soon)*<br>
-A Rack-based web server for building Navigable-backed applications.
+**[Navigable Router][router]** *(coming soon)*<br>
+A simple, highly-performant, Rack-based router.
 
 </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 width="130"><img alt="Compass" src="https://raw.githubusercontent.com/first-try-software/navigable/main/assets/compass.png"></td>
 <td>
 
-**Navigable API** *(coming soon)*<br>
-An extension of Navigable Server for building restful JSON APIs.
+**[Navigable Server][server]** *(coming soon)*<br>
+A Rack-based server for building Ruby and Navigable web applications.
 
 </td>
 </tr>
@@ -38,7 +38,7 @@ An extension of Navigable Server for building restful JSON APIs.
 <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>
+**[Navigable GraphQL][graphql]** *(coming soon)*<br>
 An extension of Navigable Server for building GraphQL APIs.
 
 </td>
@@ -49,8 +49,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 +162,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
 
@@ -186,12 +186,6 @@ Or install it yourself as:
 
     $ gem install navigable
 
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/first-try-software/navigable.
@@ -210,3 +204,8 @@ 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
+[graphql]: https://github.com/first-try-software/navigable-graphql

data/lib/navigable.rb

@@ -1,5 +1,6 @@
 # frozen-string-literal: true
 
+require 'concurrent'
 require 'manufacturable'
 
 require 'navigable/version'

data/lib/navigable/command.rb

@@ -4,30 +4,35 @@ require 'navigable/observable'
 
 module Navigable
   module Command
+    class NotFoundError < StandardError; end
+
     TYPE = :__command__
     EXECUTE_NOT_IMPLEMENTED_MESSAGE = 'Class must implement `execute` method.'
 
     def self.extended(base)
       base.extend(Manufacturable::Item)
+      base.extend(ClassMethods)
       base.include(Observable)
+      base.include(InstanceMethods)
+    end
 
-      base.instance_eval do
-        def corresponds_to(key)
-          super(key, TYPE)
-        end
+    module ClassMethods
+      def corresponds_to(key)
+        super(key, TYPE)
       end
+    end
 
-      base.class_eval do
-        attr_reader :params, :observers
+    module InstanceMethods
+      attr_reader :params, :observers, :resolver
 
-        def initialize(params: {}, observers: [])
-          @params = params
-          @observers = observers
-        end
+      def inject(params: {}, observers: [], resolver: NullResolver.new)
+        @params = params
+        @observers = observers
+        @resolver = resolver
+      end
 
-        def execute
-          raise NotImplementedError.new(EXECUTE_NOT_IMPLEMENTED_MESSAGE)
-        end
+      def execute
+        raise NotImplementedError.new(EXECUTE_NOT_IMPLEMENTED_MESSAGE)
       end
     end
   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) }
     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, resolver: resolver) }
     end
   end
 end

data/lib/navigable/executor.rb

@@ -0,0 +1,9 @@
+# frozen-string-literal: true
+
+module Navigable
+  class Executor
+    def self.execute(&block)
+      ENV['CONCURRENT_OBSERVERS'] ? Concurrent.global_io_executor.post(&block) : block.call
+    end
+  end
+end

data/lib/navigable/null_resolver.rb

@@ -0,0 +1,19 @@
+# frozen-string-literal: true
+
+require 'navigable/resolver'
+
+module Navigable
+  class NullResolver
+    extend Navigable::Resolver
+
+    def resolve
+      @result
+    end
+
+    ObserverMap::METHODS.values.each do |observer_method|
+      define_method(observer_method) do |result|
+        @result = result
+      end
+    end
+  end
+end

data/lib/navigable/observable.rb

@@ -1,39 +1,29 @@
 # frozen-string-literal: true
 
+require 'navigable/observer_map'
+require 'navigable/executor'
+
 module Navigable
   module Observable
     OBSERVERS_NOT_IMPLEMENTED_MESSAGE = 'Class must implement `observers` method.'
+    RESOLVER_NOT_IMPLEMENTED_MESSAGE = 'Class must implement `resolver` method.'
 
     def observers
       raise NotImplementedError.new(OBSERVERS_NOT_IMPLEMENTED_MESSAGE)
     end
 
-    def successfully(*args)
-      observers.each { |observer| observer.on_success(*args) }
-    end
-
-    def failed_to_validate(*args)
-      observers.each { |observer| observer.on_failure_to_validate(*args) }
-    end
-
-    def failed_to_find(*args)
-      observers.each { |observer| observer.on_failure_to_find(*args) }
+    def resolver
+      raise NotImplementedError.new(RESOLVER_NOT_IMPLEMENTED_MESSAGE)
     end
 
-    def failed_to_create(*args)
-      observers.each { |observer| observer.on_failure_to_create(*args) }
-    end
-
-    def failed_to_update(*args)
-      observers.each { |observer| observer.on_failure_to_update(*args) }
-    end
-
-    def failed_to_delete(*args)
-      observers.each { |observer| observer.on_failure_to_delete(*args) }
-    end
+    ObserverMap::METHODS.each_pair do |observable_method, observer_method|
+      define_method(observable_method) do |*args, **kwargs|
+        observers.each do |observer|
+          Navigable::Executor.execute { observer.send(observer_method, *args, **kwargs) }
+        end
 
-    def failed(*args)
-      observers.each { |observer| observer.on_failure(*args) }
+        resolver.send(observer_method, *args, **kwargs)
+      end
     end
   end
 end

data/lib/navigable/observer.rb

@@ -8,28 +8,30 @@ module Navigable
 
     def self.extended(base)
       base.extend(Manufacturable::Item)
+      base.extend(ClassMethods)
       base.include(ObserverInterface)
+      base.include(InstanceMethods)
+    end
 
-      base.instance_eval do
-        def observes_all_commands
-          corresponds_to_all(TYPE)
-        end
+    module ClassMethods
+      def observes_all_commands
+        corresponds_to_all(TYPE)
+      end
 
-        def observes(key)
-          corresponds_to(key, TYPE)
-        end
+      def observes(key)
+        corresponds_to(key, TYPE)
       end
+    end
 
-      base.class_eval do
-        attr_reader :params
+    module InstanceMethods
+      attr_reader :params
 
-        def initialize(params: {})
-          @params = params
-        end
+      def inject(params: {})
+        @params = params
+      end
 
-        def observed_command_key
-          manufacturable_item_key
-        end
+      def observed_command_key
+        manufacturable_item_key
       end
     end
   end

data/lib/navigable/observer_interface.rb

@@ -1,13 +1,11 @@
 # frozen-string-literal: true
 
+require 'navigable/observer_map'
+
 module Navigable
   module ObserverInterface
-    def on_success(*args, **kwargs); end
-    def on_failure_to_validate(*args, **kwargs); end
-    def on_failure_to_find(*args, **kwargs); end
-    def on_failure_to_create(*args, **kwargs); end
-    def on_failure_to_update(*args, **kwargs); end
-    def on_failure_to_delete(*args, **kwargs); end
-    def on_failure(*args, **kwargs); end
+    ObserverMap::METHODS.values.each do |observer_method|
+      define_method(observer_method) { |*args, **kwargs| }
+    end
   end
 end

data/lib/navigable/observer_map.rb

@@ -0,0 +1,16 @@
+# frozen-string-literal: true
+
+module Navigable
+  class ObserverMap
+    METHODS = {
+      successfully: :on_success,
+      successfully_created: :on_creation,
+      failed_to_validate: :on_failure_to_validate,
+      failed_to_find: :on_failure_to_find,
+      failed_to_create: :on_failure_to_create,
+      failed_to_update: :on_failure_to_update,
+      failed_to_delete: :on_failure_to_delete,
+      failed: :on_failure
+    }.freeze
+  end
+end

data/lib/navigable/resolver.rb

@@ -4,14 +4,29 @@ 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.extend(ClassMethods)
       base.include(ObserverInterface)
-      base.class_eval do
-        def resolve
-          raise NotImplementedError.new(RESOLVE_NOT_IMPLEMENTED_MESSAGE)
-        end
+      base.include(InstanceMethods)
+    end
+
+    module ClassMethods
+      def default_resolver
+        default_manufacturable(TYPE)
+      end
+
+      def resolves(key)
+        corresponds_to(key, TYPE)
+      end
+    end
+
+    module InstanceMethods
+      def resolve
+        raise NotImplementedError.new(RESOLVE_NOT_IMPLEMENTED_MESSAGE)
       end
     end
   end

data/lib/navigable/version.rb

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

data/navigable.gemspec

@@ -24,7 +24,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "manufacturable", "~> 1.4"
+  spec.add_dependency "concurrent-ruby", "~> 1.1.7"
+  spec.add_dependency "manufacturable", "~> 1.5"
 
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake", "~> 12.0"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: navigable
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.5.0
 platform: ruby
 authors:
 - Alan Ridlehoover
@@ -9,22 +9,36 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-17 00:00:00.000000000 Z
+date: 2020-12-06 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.7
 - !ruby/object:Gem::Dependency
   name: manufacturable
   requirement: !ruby/object:Gem::Requirement
     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
@@ -108,7 +122,6 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
-- ".ruby-version"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -118,12 +131,14 @@ files:
 - bin/console
 - bin/setup
 - lib/navigable.rb
-- lib/navigable/basic_resolver.rb
 - lib/navigable/command.rb
 - lib/navigable/dispatcher.rb
+- lib/navigable/executor.rb
+- lib/navigable/null_resolver.rb
 - lib/navigable/observable.rb
 - lib/navigable/observer.rb
 - lib/navigable/observer_interface.rb
+- lib/navigable/observer_map.rb
 - lib/navigable/resolver.rb
 - lib/navigable/version.rb
 - navigable.gemspec

data/.ruby-version

@@ -1 +0,0 @@
-2.7.1

data/lib/navigable/basic_resolver.rb

@@ -1,24 +0,0 @@
-# frozen-string-literal: true
-
-require 'navigable/resolver'
-
-module Navigable
-  class BasicResolver
-    extend Navigable::Resolver
-
-    def resolve
-      @result
-    end
-
-    def on_success(result)
-      @result = result
-    end
-
-    alias_method :on_failure_to_validate, :on_success
-    alias_method :on_failure_to_find, :on_success
-    alias_method :on_failure_to_create, :on_success
-    alias_method :on_failure_to_update, :on_success
-    alias_method :on_failure_to_delete, :on_success
-    alias_method :on_failure, :on_success
-  end
-end