navigable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: aca138d67f81a26946235aefdf41f6a884de776c8be86282ebab418cf6e56a01
+  data.tar.gz: f5f7333fd1a531cad78a07d989deaf57be2b0064dc8e9a3a6439c11aad9e8c55
+SHA512:
+  metadata.gz: e9560be4d3e344bd30e852a7b95dc0c3b2ae1e277fc1da86a6179148ddcf7888416816732afd6c48e38b9b37c79e32d633b0759b83d23340e6dcaf07260d1d10
+  data.tar.gz: bbfd09d0c17a7c45991c8fabe48055c3402f04b78efd723429b1d9d17a55b23de07ad68ed2bfeacedd80196314a6d3db363dde7e7fc594936884b3c54c474a1d

data/.gitignore

@@ -0,0 +1,17 @@
+/.bundle/
+/.vscode/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+.DS_Store
+
+# rspec failure tracking
+.rspec_status
+
+Gemfile.lock
+

data/.rspec

@@ -0,0 +1,3 @@
+--format progress
+--color
+--require spec_helper

data/.ruby-version

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

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.0
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at alan@ridlehoover.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in navigable.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Alan Ridlehoover
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,37 @@
+<img src="assets/navigable.png">
+
+# Navigable
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'navigable'
+```
+
+And then execute:
+
+    $ bundle install
+
+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.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Navigable 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/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "navigable"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/navigable.rb

@@ -0,0 +1,7 @@
+# frozen-string-literal: true
+
+require 'manufacturable'
+
+require 'navigable/version'
+require 'navigable/command'
+require 'navigable/dispatcher'

data/lib/navigable/command.rb

@@ -0,0 +1,35 @@
+# frozen-string-literal: true
+
+require 'navigable/observable'
+
+module Navigable
+  module Command
+    TYPE = :__command__
+    EXECUTE_NOT_IMPLEMENTED_MESSAGE = 'Class must implement `execute` method.'
+
+    def self.extended(base)
+      base.extend(Manufacturable::Item)
+      base.include(Observable)
+
+      base.instance_eval do
+        def corresponds_to(key)
+          super(key, TYPE)
+        end
+      end
+
+      base.class_eval do
+        attr_reader :params, :observers
+
+        def initialize(params: {}, observers: [])
+          @params = params
+          @observers = observers
+        end
+
+        def execute
+          raise NotImplementedError.new(EXECUTE_NOT_IMPLEMENTED_MESSAGE)
+        end
+      end
+    end
+  end
+end
+

data/lib/navigable/dispatcher.rb

@@ -0,0 +1,35 @@
+# frozen-string-literal: true
+
+require 'navigable/null_resolver'
+require 'navigable/observer'
+require 'navigable/command'
+
+module Navigable
+  class Dispatcher
+    def self.dispatch(key, params: {}, resolver: NullResolver.new)
+      self.new(key, params: params, resolver: resolver).dispatch
+    end
+
+    def dispatch
+      command.execute
+      resolver.resolve
+    end
+
+    attr_reader :key, :params, :resolver
+    private :key, :params, :resolver
+
+    private
+
+    def initialize(key, params:, resolver:)
+      @key, @params, @resolver = key, params, resolver
+    end
+
+    def observers
+      Manufacturable.build_all(Observer::TYPE, key).push(resolver)
+    end
+
+    def command
+      Manufacturable.build_one(Command::TYPE, key, params: params, observers: observers)
+    end
+  end
+end

data/lib/navigable/null_resolver.rb

@@ -0,0 +1,11 @@
+# frozen-string-literal: true
+
+require 'navigable/resolver'
+
+module Navigable
+  class NullResolver
+    extend Resolver
+
+    def resolve; end
+  end
+end

data/lib/navigable/observable.rb

@@ -0,0 +1,39 @@
+# frozen-string-literal: true
+
+module Navigable
+  module Observable
+    OBSERVERS_NOT_IMPLEMENTED_MESSAGE = 'Class must implement `observers` 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) }
+    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
+
+    def failed(*args)
+      observers.each { |observer| observer.on_failure(*args) }
+    end
+  end
+end

data/lib/navigable/observer.rb

@@ -0,0 +1,22 @@
+# frozen-string-literal: true
+
+require 'navigable/observer_interface'
+
+module Navigable
+  module Observer
+    TYPE = :__observer__
+
+    def self.extended(base)
+      base.extend(Manufacturable::Item)
+      base.include(ObserverInterface)
+    end
+
+    def observes_all_commands
+      corresponds_to_all(TYPE)
+    end
+
+    def observes(key)
+      corresponds_to(key, TYPE)
+    end
+  end
+end

data/lib/navigable/observer_interface.rb

@@ -0,0 +1,13 @@
+# frozen-string-literal: true
+
+module Navigable
+  module ObserverInterface
+    def on_success(*args); end
+    def on_failure_to_validate(*args); end
+    def on_failure_to_find(*args); end
+    def on_failure_to_create(*args); end
+    def on_failure_to_update(*args); end
+    def on_failure_to_delete(*args); end
+    def on_failure(*args); end
+  end
+end

data/lib/navigable/resolver.rb

@@ -0,0 +1,18 @@
+# frozen-string-literal: true
+
+require 'navigable/observer_interface'
+
+module Navigable
+  module Resolver
+    RESOLVE_NOT_IMPLEMENTED_MESSAGE = 'Class must implement `resolve` method.'
+
+    def self.extended(base)
+      base.include(ObserverInterface)
+      base.class_eval do
+        def resolve
+          raise NotImplementedError.new(RESOLVE_NOT_IMPLEMENTED_MESSAGE)
+        end
+      end
+    end
+  end
+end

data/lib/navigable/version.rb

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

data/navigable.gemspec

@@ -0,0 +1,34 @@
+require_relative "lib/navigable/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "navigable"
+  spec.version       = Navigable::VERSION
+  spec.platform      = Gem::Platform::RUBY
+  spec.authors       = ["Alan Ridlehoover", "Fito von Zastrow"]
+  spec.email         = ["alan@ridlehoover.com", "adolfovon@gmail.com"]
+
+  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.\n\nWe 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.homepage      = "https://github.com/first_try/navigable"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/first_try/navigable"
+  spec.metadata["bug_tracker_uri"] = "https://github.com/first_try/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)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib", "assets"]
+
+  spec.add_dependency "manufacturable", "~> 1.3"
+
+  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"
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: navigable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alan Ridlehoover
+- Fito von Zastrow
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-08-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: manufacturable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  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.\n\nWe 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.
+email:
+- alan@ridlehoover.com
+- adolfovon@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- assets/navigable.png
+- bin/console
+- bin/setup
+- lib/navigable.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
+- lib/navigable/resolver.rb
+- lib/navigable/version.rb
+- navigable.gemspec
+homepage: https://github.com/first_try/navigable
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/first_try/navigable
+  source_code_uri: https://github.com/first_try/navigable
+  bug_tracker_uri: https://github.com/first_try/navigable/issues
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- assets
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Ahoy! Navigable will get you there!
+test_files: []