nexus_cqrs 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c62728d657d12e0238fa6d56e85de427f66d9f3521941b320aa087193e53eaa4
+  data.tar.gz: 432a2ebc8bdf0fda72f954704738620d30c0a2c756e174b5982e90576c7b5cb2
+SHA512:
+  metadata.gz: b2d3f76090eab365459d245f34fda9229dfdb4ecc2e749ef0e38eb7c27e12b2ee3a72b88b52aa7ffe63ca3f0b10bc4ee9f7ff3a4acbc966f8d6b0ddd180c55c0
+  data.tar.gz: c96f30c32b942efebd1eeded9a4816c4fcb2616f82a7a47c16ff392448967f0f709d447b08e2192faa689a6383e1e9037b881f1e26f222c475bfe2e7e3f7a8d4

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

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 dean.lovett@nexusmods.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,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in cqrs-core.gemspec
+gemspec
+
+gem "rake", "~> 12.0"

data/README.md

@@ -0,0 +1,40 @@
+# Cqrs::Core
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/cqrs/core`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cqrs-core'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install cqrs-core
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/[USERNAME]/cqrs-core. 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]/cqrs-core/blob/master/CODE_OF_CONDUCT.md).
+
+
+## Code of Conduct
+
+Everyone interacting in the Cqrs::Core project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/cqrs-core/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "cqrs/core"
+
+# 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/generators/nexus_cqrs/USAGE

@@ -0,0 +1,9 @@
+Description:
+    Generates a new Query object, along with the QueryHandler
+
+Example:
+    rails generate cqrs:query GetUserById
+
+    This will create:
+        app/domain/queries/get_user_by_id.rb
+        app/domain/queries/get_user_by_id_handler.rb

data/lib/generators/nexus_cqrs/command_generator.rb

@@ -0,0 +1,12 @@
+require 'rails/generators/base'
+
+module NexusCqrs
+  class CommandGenerator < Rails::Generators::NamedBase
+    source_root File.expand_path('templates', __dir__)
+
+    def copy_command_file
+      template "command.rb", "app/domain/commands/#{file_name}.rb"
+      template "command_handler.rb", "app/domain/commands/#{file_name}_handler.rb"
+    end
+  end
+end

data/lib/generators/nexus_cqrs/query_generator.rb

@@ -0,0 +1,12 @@
+require 'rails/generators/base'
+
+module NexusCqrs
+  class QueryGenerator < Rails::Generators::NamedBase
+    source_root File.expand_path('templates', __dir__)
+
+    def copy_query_file
+      template "query.rb", "app/domain/queries/#{file_name}.rb"
+      template "query_handler.rb", "app/domain/queries/#{file_name}_handler.rb"
+    end
+  end
+end

data/lib/generators/nexus_cqrs/templates/command.rb

@@ -0,0 +1,12 @@
+module Commands
+  class <%= class_name %> < BaseCommand
+
+    # Define attributes for this command
+    attr_accessor :id
+
+    # Define the constructor
+    def initialize(id)
+      @id = id
+    end
+  end
+end

data/lib/generators/nexus_cqrs/templates/command_handler.rb

@@ -0,0 +1,9 @@
+module Commands
+  class <%= class_name %>Handler < BaseCommandHandler
+
+    # call is where the Command is executed
+    def call(command)
+
+    end
+  end
+end

data/lib/generators/nexus_cqrs/templates/query.rb

@@ -0,0 +1,12 @@
+module Queries
+  class <%= class_name %> < BaseQuery
+
+    # Define attributes for this query
+    attr_accessor :id
+
+    # Define the constructor
+    def initialize(id)
+      @id = id
+    end
+  end
+end

data/lib/generators/nexus_cqrs/templates/query_handler.rb

@@ -0,0 +1,9 @@
+module Queries
+  class <%= class_name %>Handler < BaseQueryHandler
+
+    # call is where the Query is executed
+    def call(command)
+
+    end
+  end
+end

data/lib/nexus_cqrs/base_command.rb

@@ -0,0 +1,5 @@
+module NexusCqrs
+  class BaseCommand
+
+  end
+end

data/lib/nexus_cqrs/base_command_handler.rb

@@ -0,0 +1,4 @@
+module NexusCqrs
+  class BaseCommandHandler
+  end
+end

data/lib/nexus_cqrs/base_query.rb

@@ -0,0 +1,4 @@
+module NexusCqrs
+  class BaseQuery
+  end
+end

data/lib/nexus_cqrs/base_query_handler.rb

@@ -0,0 +1,4 @@
+module NexusCqrs
+  class BaseQueryHandler
+  end
+end

data/lib/nexus_cqrs/command_bus.rb

@@ -0,0 +1,27 @@
+require 'thread_safe'
+
+module NexusCqrs
+  class CommandBus
+    UnregisteredHandler = Class.new(StandardError)
+    MultipleHandlers    = Class.new(StandardError)
+
+    def initialize
+      @handlers =
+          ThreadSafe::Cache.new
+    end
+
+    def register(klass, handler)
+      raise MultipleHandlers.new("Multiple handlers not allowed for #{klass}") if handlers[klass]
+      handlers[klass] = handler
+    end
+
+    def call(command)
+      handlers
+          .fetch(command.class) { raise UnregisteredHandler.new("Missing handler for #{command.class}")  }
+      .(command)
+    end
+
+    private
+    attr_reader :handlers
+  end
+end

data/lib/nexus_cqrs/command_executor.rb

@@ -0,0 +1,18 @@
+module NexusCqrs
+  class CommandExecutor
+    def initialize
+      @bus = CommandBus.new
+
+      register_commands
+    end
+
+    def execute(command)
+      @bus.(command)
+    end
+
+    private
+      def register_commands
+        # TODO, Register Commands/Queries
+      end
+  end
+end

data/lib/nexus_cqrs/helpers.rb

@@ -0,0 +1,18 @@
+module NexusCqrs
+  module Helpers
+    # Executes a CQRS Command
+    def execute(command)
+      command_executor.execute(command)
+    end
+
+    # Executes a CQRS Query
+    def query(query)
+      command_executor.execute(query)
+    end
+
+    # Provide access to the CQRS executor
+    def command_executor
+      @command_executor ||= NexusCqrs::CommandExecutor.new
+    end
+  end
+end

data/lib/nexus_cqrs/version.rb

@@ -0,0 +1,3 @@
+module NexusCqrs
+  VERSION = "0.0.1"
+end

data/nexus_cqrs.gemspec

@@ -0,0 +1,23 @@
+require_relative 'lib/nexus_cqrs/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "nexus_cqrs"
+  spec.version       = NexusCqrs::VERSION
+  spec.authors       = ["Dean Lovett"]
+  spec.email         = ["dean.lovett@nexusmods.com"]
+
+  spec.summary       = %q{Core package for the nexus cqrs gem}
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  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"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rails", "~> 5"
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: nexus_cqrs
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Dean Lovett
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-08-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+description: 
+email:
+- dean.lovett@nexusmods.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/generators/nexus_cqrs/USAGE
+- lib/generators/nexus_cqrs/command_generator.rb
+- lib/generators/nexus_cqrs/query_generator.rb
+- lib/generators/nexus_cqrs/templates/command.rb
+- lib/generators/nexus_cqrs/templates/command_handler.rb
+- lib/generators/nexus_cqrs/templates/query.rb
+- lib/generators/nexus_cqrs/templates/query_handler.rb
+- lib/nexus_cqrs/base_command.rb
+- lib/nexus_cqrs/base_command_handler.rb
+- lib/nexus_cqrs/base_query.rb
+- lib/nexus_cqrs/base_query_handler.rb
+- lib/nexus_cqrs/command_bus.rb
+- lib/nexus_cqrs/command_executor.rb
+- lib/nexus_cqrs/helpers.rb
+- lib/nexus_cqrs/version.rb
+- nexus_cqrs.gemspec
+homepage: 
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.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: Core package for the nexus cqrs gem
+test_files: []