eztek-mediat_r 1.0.2 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a48e55844b50d4c411b90b137fe6d01e8ccfdf2ea6ed6c6cf6a4e6c1fa61858d
-  data.tar.gz: f4c2ff39479cd2c39c76948ca82f0adbd7cf033e3cbc80aebb3829870782661e
+  metadata.gz: 23232c3a36bb0ede0c8c8ae56e8b777575f34b962e98063781ad9b7dc8ff149b
+  data.tar.gz: 58dce58ad6aba69fe1bea815c6f8d3ff64cf8aaf0e487653aa3ba93013f4f589
 SHA512:
-  metadata.gz: efa2e26984fa7e44fa0460af1eb8e7a61f310090b4f433a117debf927cac25422a7e6a289ddf19f02acfe2efb34fa947b9f6521441ca7ae6f8535bf788e47c15
-  data.tar.gz: 611679a3f465a77f9bc5c2c464df2b3b691cd0b417fa97c0b61d80e401ddea683ad57d093d5a15c9baf40f998134b9dad4d001891b9fb2beac53f0b8ee820948
+  metadata.gz: 52b2d3824bb3a20f97195b8a9f327a03805c5ca20e3cfdaf14f2ee5f2e730991065e4480c42d4cd34a8b111576778d97e1415cb4f33fd443646eea9ddb62c9ef
+  data.tar.gz: 9967a9ccfd94e85648fa59f32b05d706c5985c0f7cff6328dd931f3fae7677e4a7ced4fda3fa24f4bf631bbc537b2929e002a90aef166f7dfc03b75b25f61ba9

data/README.md

@@ -1,8 +1,8 @@
-# Eztek::MediatR
+# Eztek MediatR
 
-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/eztek/mediat_r`. To experiment with that code, run `bin/console` for an interactive prompt.
+<a href="https://www.buymeacoffee.com/phunguyen" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png" alt="Buy Me A Coffee" style="height: 41px !important;width: 174px !important;box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;-webkit-box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;" ></a>
 
-TODO: Delete this and the text above, and describe your gem
+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/eztek/mediat_r`. To experiment with that code, run `bin/console` for an interactive prompt.
 
 ## Installation
 
@@ -21,8 +21,69 @@ Or install it yourself as:
     $ gem install eztek-mediat_r
 
 ## Usage
+### Initialize mediatR
+Add new file config/initializers/mediat_r.rb to initializer mediatR
+```ruby
+require 'ez/mediat_r'
+
+mediator = EZ::MediatR.new
+Rails.configuration.to_prepare do
+    Rails.configuration.bus = Bus.new
+    Rails.configuration.bus.tap do |bus|
+        # Register command - handler
+        bus.register(Auth::Commands::LoginCommand, Auth::Commands::Handlers::LoginCommandHandler.new)
+    end
+end
+
+```
+
+### Declare mediatR in controller
+```ruby
+def initialize
+    @mediator = Rails.configuration.bus
+end
+
+```
+
+or dependency with dry-container, dry-auto_inject:
+ 
+### Register mediaR in container
+Use file dependency.rb to register mediatR
+```ruby
+require 'ez/mediat_r'
+
+dependency_container = Dry::Container.new
+dependency_container.register('mediator', -> { EZ::MediatR.new })
+AutoInject = Dry::AutoInject(dependency_container)
+
+```
+
+### Define mediatR in controller
+```ruby
+include AutoInject['mediator']
+
+```
+
+### Run mediator
+```ruby
+command = Auth::Commands::LoginCommand.new(username, password)
+mediator.execute(command) 
+
+```
+
+## Generator structure with rails 
+```ruby
+    $ rails generate command feature command_name
+```
+Example: 
+```ruby
+    $ rails generate command auth login
+```
 
-TODO: Write usage instructions here
+This will create: 
+    app/cqrs/auth/commands/login_command.rb
+    app/cqrs/auth/commands/validators/login_command_validator.rb
+    app/cqrs/auth/commands/handlers/login_command_handler.rb
 
 ## Development
 
@@ -32,4 +93,4 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/eztek-mediat_r.
+Bug reports and pull requests are welcome on GitHub at https://github.com/yeucon02vn/eztek-mediat_r.

data/lib/ez/mediat_r/version.rb

@@ -2,6 +2,6 @@
 
 module EZ
   module MediatR
-    VERSION = "1.0.2"
+    VERSION = "1.1.1"
   end
 end

data/lib/generators/{commands → command}/USAGE

@@ -2,7 +2,7 @@ Description:
     Creates the command model structure for you.
 
 Example: 
-    rails generate commands user create_user
+    rails generate command user create_user
 
     This will create: 
         app/cqrs/user/commands/create_user_command.rb

data/lib/generators/{commands/commands_generator.rb → command/command_generator.rb}

@@ -1,4 +1,4 @@
-class CommandsGenerator < Rails::Generators::Base
+class CommandGenerator < Rails::Generators::Base
     source_root File.expand_path('../templates', __FILE__)
     argument :model, type: :string
     argument :name, type: :string
@@ -14,18 +14,17 @@ class CommandsGenerator < Rails::Generators::Base
         generate_command_validator if options.validator?
     end
 
-
     private
 
     def generate_command
-        template 'commands_template.template', "app/cqrs/#{model.underscore}/commands/#{name.underscore}_command.rb"
+        template 'command_template.template', "app/cqrs/#{model.underscore}/commands/#{name.underscore}_command.rb"
     end
 
     def generate_command_validator
-        template 'commands_validator_template.template', "app/cqrs/#{model.underscore}/commands/validators/#{name.underscore}_command_validator.rb"
+        template 'command_validator_template.template', "app/cqrs/#{model.underscore}/commands/validators/#{name.underscore}_command_validator.rb"
     end
 
     def generate_command_handler
-        template 'commands_handler_template.template', "app/cqrs/#{model.underscore}/commands/handlers/#{name.underscore}_command_handler.rb"
+        template 'command_handler_template.template', "app/cqrs/#{model.underscore}/commands/handlers/#{name.underscore}_command_handler.rb"
     end
 end

data/lib/generators/{queries → query}/USAGE

@@ -2,7 +2,7 @@ Description:
     Creates the query model structure for you.
 
 Example: 
-    rails generate queries user get_all_user
+    rails generate query user get_all_user
 
     This will create: 
         app/cqrs/user/queries/get_all_user_query.rb

data/lib/generators/{queries/queries_generator.rb → query/query_generator.rb}

@@ -1,4 +1,4 @@
-class QueriesGenerator < Rails::Generators::Base
+class QueryGenerator < Rails::Generators::Base
     source_root File.expand_path('../templates', __FILE__)
     argument :model, type: :string
     argument :name, type: :string
@@ -17,14 +17,14 @@ class QueriesGenerator < Rails::Generators::Base
     private
 
     def generate_query
-        template 'queries_template.template', "app/cqrs/#{model.underscore}/queries/#{name.underscore}_query.rb"
+        template 'query_template.template', "app/cqrs/#{model.underscore}/queries/#{name.underscore}_query.rb"
     end
 
     def generate_query_validator
-        template 'queries_validator_template.template', "app/cqrs/#{model.underscore}/queries/validators/#{name.underscore}_query_validator.rb"
+        template 'query_validator_template.template', "app/cqrs/#{model.underscore}/queries/validators/#{name.underscore}_query_validator.rb"
     end
 
     def generate_query_handler
-        template 'queries_handler_template.template', "app/cqrs/#{model.underscore}/queries/handlers/#{name.underscore}_query_handler.rb"
+        template 'query_handler_template.template', "app/cqrs/#{model.underscore}/queries/handlers/#{name.underscore}_query_handler.rb"
     end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eztek-mediat_r
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.1
 platform: ruby
 authors:
 - yeucon02vn
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-09-08 00:00:00.000000000 Z
+date: 2022-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -79,16 +79,16 @@ files:
 - lib/ez/mediat_r.rb
 - lib/ez/mediat_r/alias.rb
 - lib/ez/mediat_r/version.rb
-- lib/generators/commands/USAGE
-- lib/generators/commands/commands_generator.rb
-- lib/generators/commands/templates/command_handler_template.template
-- lib/generators/commands/templates/command_template.template
-- lib/generators/commands/templates/command_validator_template.template
-- lib/generators/queries/USAGE
-- lib/generators/queries/queries_generator.rb
-- lib/generators/queries/templates/queries_handler_template.template
-- lib/generators/queries/templates/queries_template.template
-- lib/generators/queries/templates/queries_validator_template.template
+- lib/generators/command/USAGE
+- lib/generators/command/command_generator.rb
+- lib/generators/command/templates/command_handler_template.template
+- lib/generators/command/templates/command_template.template
+- lib/generators/command/templates/command_validator_template.template
+- lib/generators/query/USAGE
+- lib/generators/query/query_generator.rb
+- lib/generators/query/templates/query_handler_template.template
+- lib/generators/query/templates/query_template.template
+- lib/generators/query/templates/query_validator_template.template
 - sig/ez/mediat_r.rbs
 homepage: https://github.com/yeucon02vn/eztek-mediat_r
 licenses: