nexus_cqrs 0.0.3 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 67530620fea3787829b05b73fff8cf78b8414a6adcd79332f727e77d98ae07e2
-  data.tar.gz: cf1ee994dd29425087dec599192ad629b9a0e62910326c666dfa1b9671aa49ca
+  metadata.gz: 964f3e200ed51f402f7c00973065c34a05122b2f20837476b3f5a55a7e4fc46e
+  data.tar.gz: 9c4102fef193eda90fa60178ec05c1bafe49f89dff2157eb8e2a850ce773e18b
 SHA512:
-  metadata.gz: 8b9d852ecbe12b1158ff57823b97d614556ccca1e31d97cb7ee1ddfb9491881801bebc97818fb70f74ecabfe03932e0955ea1f50241079026c7c9af061de8de1
-  data.tar.gz: 72141ebc08db7e350973def5ff749bf0260bba02910c4d31decea711b392e291c28c0c1c13103364505137327f68e5fe9aa5e0899a97e0baef7731f0daec4c12
+  metadata.gz: 70862cb50dc57a43161aee2f346dc6d6e60061f620a6b194423bfdf4c8d75f766ca3b03d27ba036a213f2247a6d618ac55f13ea35bab1fad2c49a0fe0308835d
+  data.tar.gz: 5684b39d573edb2d81a1c3dc890ed2bb1de7d9d5d9b9f2e4f3054b34bb215bfc3dbfdf3b89d4a8434cfb48b2647350f1687259cd47a3b392e8b61df03ce756f8

data/.gitlab-ci.yml

@@ -0,0 +1,16 @@
+image: "ruby:2.7"
+
+before_script:
+  - sudo apt-get update -qq && sudo apt-get install -y -qq sqlite3 libsqlite3-dev nodejs
+  - ruby -v
+  - which ruby
+  - gem install bundler --no-document
+  - bundle install --jobs $(nproc)  "${FLAGS[@]}"
+
+rspec:
+  script:
+    - bundle exec rspec
+
+rubocop:
+  script:
+    - bundle exec rubocop

data/.rubocop.yml

@@ -0,0 +1,11 @@
+inherit_gem:
+  rubocop-shopify: rubocop.yml
+
+AllCops:
+  Exclude:
+    - 'lib/generators/nexus_cqrs/templates/**/*.rb'
+
+Style/GlobalVars:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: false

data/Gemfile

@@ -1,6 +1,11 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in cqrs-core.gemspec
 gemspec
 
-gem "rake", "~> 12.0"
+gem 'rubocop'
+gem 'rubocop-shopify', "~> 1.0.4", require: false
+
+gem 'rspec'
+gem "generator_spec"
+gem 'thread_safe'

data/Gemfile.lock

@@ -0,0 +1,134 @@
+PATH
+  remote: .
+  specs:
+    nexus_cqrs (0.0.8)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (6.0.3.2)
+      actionview (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
+      rack (~> 2.0, >= 2.0.8)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actionview (6.0.3.2)
+      activesupport (= 6.0.3.2)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activesupport (6.0.3.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    ast (2.4.1)
+    builder (3.2.4)
+    concurrent-ruby (1.1.7)
+    crass (1.0.6)
+    diff-lcs (1.4.4)
+    erubi (1.9.0)
+    generator_spec (0.9.4)
+      activesupport (>= 3.0.0)
+      railties (>= 3.0.0)
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    loofah (2.6.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    method_source (1.0.0)
+    mini_portile2 (2.4.0)
+    minitest (5.14.1)
+    multi_json (1.15.0)
+    net-scp (3.0.0)
+      net-ssh (>= 2.6.5, < 7.0.0)
+    net-ssh (6.1.0)
+    net-telnet (0.1.1)
+    nokogiri (1.10.10)
+      mini_portile2 (~> 2.4.0)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (6.0.3.2)
+      actionpack (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.20.3, < 2.0)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    regexp_parser (1.7.1)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-its (1.3.0)
+      rspec-core (>= 3.0.0)
+      rspec-expectations (>= 3.0.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    rubocop (0.86.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.0.3, < 1.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.3.0)
+      parser (>= 2.7.1.4)
+    rubocop-shopify (1.0.4)
+      rubocop (>= 0.85, < 0.87)
+    ruby-progressbar (1.10.1)
+    serverspec (2.41.5)
+      multi_json
+      rspec (~> 3.0)
+      rspec-its
+      specinfra (~> 2.72)
+    sfl (2.3)
+    specinfra (2.82.19)
+      net-scp
+      net-ssh (>= 2.7)
+      net-telnet (= 0.1.1)
+      sfl
+    thor (1.0.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.7.0)
+    zeitwerk (2.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  generator_spec
+  nexus_cqrs!
+  rspec
+  rubocop
+  rubocop-shopify (~> 1.0.4)
+  serverspec
+  thread_safe
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -22,19 +22,18 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Generators can be used to aide in the creation of Commands and Queries:
 
-## 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).
+    rails g nexus_cqrs:command CommandName
+    rails g nexus_cqrs:query QueryName
 
-## 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).
+Once installed, a CommandBus is required to control the flow of Commands and/or Queries:
 
+## Development
 
-## Code of Conduct
+To contribute to this gem, simple pull the repository, run `bundle install` and run tests:
 
-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).
+```shell script
+    bundle exec rspec
+    bundle exec rubocop
+```

data/Rakefile

@@ -1,2 +1,3 @@
 require "bundler/gem_tasks"
-task :default => :spec
+require 'bundler/gem_tasks'
+task(default: :spec)

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "cqrs/core"
+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.
@@ -10,5 +10,5 @@ require "cqrs/core"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/lib/generators/nexus_cqrs/command_generator.rb

@@ -5,8 +5,26 @@ module NexusCqrs
     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"
+      file_path = class_name.underscore
+
+      template('command.rb', "app/domain/commands/#{file_path}.rb")
+      template('command_handler.rb', "app/domain/commands/#{file_path}_handler.rb")
+
+      register_command(class_name)
+    end
+
+    private
+
+    def register_command(full_name)
+      handler_config = 'config/initializers/register_cqrs_handlers.rb'
+
+      unless File.exist?('config/initializers/register_cqrs_handlers.rb')
+        template('register_cqrs_handlers.rb', handler_config)
+      end
+
+      code_to_inject = "$COMMAND_EXECUTOR.register_command(#{full_name}, #{full_name}Handler)"
+
+      inject_into_file(handler_config, code_to_inject, after: "# Register Commands\n")
     end
   end
 end

data/lib/generators/nexus_cqrs/query_generator.rb

@@ -5,8 +5,26 @@ module NexusCqrs
     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"
+      file_path = class_name.underscore
+
+      template('query.rb', "app/domain/queries/#{file_path}.rb")
+      template('query_handler.rb', "app/domain/queries/#{file_path}_handler.rb")
+
+      register_query(class_name)
+    end
+
+    private
+
+    def register_query(full_name)
+      handler_config = 'config/initializers/register_cqrs_handlers.rb'
+
+      unless File.exist?('config/initializers/register_cqrs_handlers.rb')
+        template('register_cqrs_handlers.rb', handler_config)
+      end
+
+      code_to_inject = "$QUERY_EXECUTOR.register_command(#{full_name}, #{full_name}Handler)"
+
+      inject_into_file(handler_config, code_to_inject, after: "# Register Queries\n")
     end
   end
 end

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

@@ -1,5 +1,5 @@
 module Commands
-  class <%= class_name %> < BaseCommand
+  class <%= class_name %> < NexusCqrs::BaseCommand
 
     # Define attributes for this command
     attr_accessor :id

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

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

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

@@ -1,5 +1,5 @@
 module Queries
-  class <%= class_name %> < BaseQuery
+  class <%= class_name %> < NexusCqrs::BaseQuery
 
     # Define attributes for this query
     attr_accessor :id

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

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

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

@@ -0,0 +1,9 @@
+command_bus = NexusCqrs::CommandBus.new
+query_bus = NexusCqrs::CommandBus.new
+
+$COMMAND_EXECUTOR = NexusCqrs::CommandExecutor.new command_bus
+$QUERY_EXECUTOR = NexusCqrs::CommandExecutor.new query_bus
+
+# Register Queries
+
+# Register Commands

data/lib/nexus_cqrs.rb

@@ -8,4 +8,4 @@ require 'nexus_cqrs/helpers'
 
 module NexusCqrs
   class Error < StandardError; end
-end
+end

data/lib/nexus_cqrs/base_command.rb

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

data/lib/nexus_cqrs/base_command_handler.rb

@@ -1,4 +1,6 @@
 module NexusCqrs
   class BaseCommandHandler
+    def call(command)
+    end
   end
-end
+end

data/lib/nexus_cqrs/base_query.rb

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

data/lib/nexus_cqrs/base_query_handler.rb

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

data/lib/nexus_cqrs/command_bus.rb

@@ -7,21 +7,29 @@ module NexusCqrs
 
     def initialize
       @handlers =
-          ThreadSafe::Cache.new
+        ThreadSafe::Cache.new
     end
 
     def register(klass, handler)
-      raise MultipleHandlers.new("Multiple handlers not allowed for #{klass}") if handlers[klass]
+      raise MultipleHandlers, "Multiple handlers not allowed for #{klass}" if handlers[klass]
+
       handlers[klass] = handler
     end
 
     def call(command)
+      unregistered_handler = proc { raise UnregisteredHandler, "Missing handler for #{command.class}" }
+
+      handlers
+        .fetch(command.class, &unregistered_handler)
+        .call(command)
+    end
+
+    def registered_handlers
       handlers
-          .fetch(command.class) { raise UnregisteredHandler.new("Missing handler for #{command.class}")  }
-      .(command)
     end
 
     private
+
     attr_reader :handlers
   end
-end
+end

data/lib/nexus_cqrs/command_executor.rb

@@ -1,18 +1,24 @@
 module NexusCqrs
   class CommandExecutor
-    def initialize
-      @bus = CommandBus.new
+    def initialize(command_bus)
+      @bus = command_bus
 
       register_commands
     end
 
     def execute(command)
-      @bus.(command)
+      @bus.call(command)
+    end
+
+    def register_command(klass, handler)
+      Rails.logger.debug("Registered #{klass} to #{handler}")
+      @bus.register(klass.class, handler)
     end
 
     private
-      def register_commands
-        # TODO, Register Commands/Queries
-      end
+
+    def register_commands
+      # TODO, Register Commands/Queries
+    end
   end
-end
+end

data/lib/nexus_cqrs/helpers.rb

@@ -12,7 +12,7 @@ module NexusCqrs
 
     # Provide access to the CQRS executor
     def command_executor
-      @command_executor ||= NexusCqrs::CommandExecutor.new
+      @command_executor ||= $COMMAND_EXECUTOR
     end
   end
-end
+end

data/lib/nexus_cqrs/version.rb

@@ -1,3 +1,3 @@
 module NexusCqrs
-  VERSION = "0.0.3"
+  VERSION = '0.0.8'
 end

data/nexus_cqrs.gemspec

@@ -1,23 +1,20 @@
 require_relative 'lib/nexus_cqrs/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "nexus_cqrs"
+  spec.name          = 'nexus_cqrs'
   spec.version       = NexusCqrs::VERSION
-  spec.authors       = ["Dean Lovett"]
-  spec.email         = ["dean.lovett@nexusmods.com"]
+  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")
+  spec.summary       = '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)/}) }
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    %x(git ls-files -z).split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
+  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"
+  spec.require_paths = ['lib']
 end

metadata

@@ -1,43 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: nexus_cqrs
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.8
 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'
+date: 2020-08-25 00:00:00.000000000 Z
+dependencies: []
 description: 
 email:
 - dean.lovett@nexusmods.com
@@ -46,8 +18,11 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".gitlab-ci.yml"
+- ".rubocop.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - README.md
 - Rakefile
 - bin/console
@@ -59,6 +34,7 @@ files:
 - lib/generators/nexus_cqrs/templates/command_handler.rb
 - lib/generators/nexus_cqrs/templates/query.rb
 - lib/generators/nexus_cqrs/templates/query_handler.rb
+- lib/generators/nexus_cqrs/templates/register_cqrs_handlers.rb
 - lib/nexus_cqrs.rb
 - lib/nexus_cqrs/base_command.rb
 - lib/nexus_cqrs/base_command_handler.rb