eztek-mediat_r 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c66221e78adb55cce7b38b481a32ae12a8f4f22e5c4b25b8d12a1435fa3b98d
-  data.tar.gz: 381eb46fbd9daedee47f246368214b5805a9433c59b8b20c27de6010a2876bb4
+  metadata.gz: 81fe49ca3fee1be65127f9c763d31fd0da477737b0a2d016c5e8efb1a9712f7d
+  data.tar.gz: a71cb6498c253234c65e32f5a5df4eeadc313e89c5f81ee461369f7039783eeb
 SHA512:
-  metadata.gz: 9475134a35c04b01e42b7ae2b47d031821c3e8bc51056f679abbaf7ed5fe09bf5650134fc3d3fce6f402f30f3742fd9d29bcf78ccfa0dcd036d8452cb111082f
-  data.tar.gz: 3f8a32363b4df0da42eba84d7598dc0eda50aeb283fc5e7375da48886ea0997490edd75fe340135bae76bcbdbd782ed162b1839170c799c9c2e879ab23bdbf6d
+  metadata.gz: a9be31068ed497359eaf3278955420ed1231d35c5dde06fdb0dd7c325257dff1795a28912bf07b8b69e882d382584508909d4ab224961b446516be98de8f7cc9
+  data.tar.gz: e0b8646e6be3ea108701125521f1ed4c7f485211ce8d5c4e42bbb23961d727dddc7b0a04bffcb936b70463a74a3724235cbf1db6df6316d23f7b5accae914313

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,55 @@ 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']
 
-TODO: Write usage instructions here
+```
+
+### Run mediator
+```ruby
+command = Auth::Commands::LoginCommand.new(username, password)
+mediator.execute(command) 
+
+```
 
 ## Development
 
@@ -32,4 +79,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

@@ -1,7 +1,7 @@
-# frozen_string_literal: true
-
-module EZ
-  module MediatR
-    VERSION = "1.0.1"
-  end
-end
+# frozen_string_literal: true
+
+module EZ
+  module MediatR
+    VERSION = "1.1.0"
+  end
+end

data/lib/generators/command/USAGE

@@ -0,0 +1,10 @@
+Description:
+    Creates the command model structure for you.
+
+Example: 
+    rails generate command user create_user
+
+    This will create: 
+        app/cqrs/user/commands/create_user_command.rb
+        app/cqrs/user/commands/validators/create_user_command_validator.rb
+        app/cqrs/user/commands/handlers/create_user_command_handler.rb

data/lib/generators/command/command_generator.rb

@@ -0,0 +1,30 @@
+class CommandGenerator < Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+    argument :model, type: :string
+    argument :name, type: :string
+    class_option :validator, type: :boolean, default: true, desc: "Generate validator."
+    class_option :doc, type: :boolean, default: true, desc: "Include documentation."
+
+    def generate_init
+        generate_command
+        generate_command_handler
+    end
+
+    def generate_validator
+        generate_command_validator if options.validator?
+    end
+
+    private
+
+    def generate_command
+        template 'command_template.template', "app/cqrs/#{model.underscore}/commands/#{name.underscore}_command.rb"
+    end
+
+    def generate_command_validator
+        template 'command_validator_template.template', "app/cqrs/#{model.underscore}/commands/validators/#{name.underscore}_command_validator.rb"
+    end
+
+    def generate_command_handler
+        template 'command_handler_template.template', "app/cqrs/#{model.underscore}/commands/handlers/#{name.underscore}_command_handler.rb"
+    end
+end

data/lib/generators/{commands → command}/templates/command_template.template

@@ -1,7 +1,7 @@
 module <%= model.camelcase %>::Commands
     class <%= name.camelcase %>Command
         include ActiveModel::Validations
-        <%- options.validator -%>
+        <%- if options.validator? -%>
         validates_with Validators::<%= name.camelcase %>CommandValidator 
         <%- end -%>
 

data/lib/generators/query/USAGE

@@ -0,0 +1,10 @@
+Description:
+    Creates the query model structure for you.
+
+Example: 
+    rails generate query user get_all_user
+
+    This will create: 
+        app/cqrs/user/queries/get_all_user_query.rb
+        app/cqrs/user/queries/validators/get_all_user_query_validator.rb
+        app/cqrs/user/queries/handlers/get_all_user_query_handler.rb

data/lib/generators/query/query_generator.rb

@@ -0,0 +1,30 @@
+class QueryGenerator < Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+    argument :model, type: :string
+    argument :name, type: :string
+    class_option :validator, type: :boolean, default: true, desc: "Generate validator."
+    class_option :doc, type: :boolean, default: true, desc: "Include documentation."
+
+    def generate_init
+        generate_query
+        generate_query_handler
+    end
+
+    def generate_validator
+        generate_query_validator if options.validator?
+    end
+
+    private
+
+    def generate_query
+        template 'query_template.template', "app/cqrs/#{model.underscore}/queries/#{name.underscore}_query.rb"
+    end
+
+    def generate_query_validator
+        template 'query_validator_template.template', "app/cqrs/#{model.underscore}/queries/validators/#{name.underscore}_query_validator.rb"
+    end
+
+    def generate_query_handler
+        template 'query_handler_template.template', "app/cqrs/#{model.underscore}/queries/handlers/#{name.underscore}_query_handler.rb"
+    end
+end

data/lib/generators/{queries/templates/queries_template.template → query/templates/query_template.template}

@@ -1,7 +1,7 @@
 module <%= model.camelcase %>::Queries
     class <%= name.camelcase %>Query
         include ActiveModel::Validations
-        <%- options.validator -%>
+        <%- if options.validator? -%>
         validates_with Validators::<%= name.camelcase %>QueryValidator 
         <%- end -%>
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eztek-mediat_r
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 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:

data/lib/generators/commands/commands_generator.rb

@@ -1,33 +0,0 @@
-class CommandsGenerator < Rails::Generators::Base
-    source_root File.expand_path('../templates', __FILE__)
-    argument :model, type: :string
-    argument :name, type: :string
-    class_option :validator, type: :boolean, default: false, desc: "Generate validator."
-    class_option :doc, type: :boolean, default: true, desc: "Include documentation."
-
-    def generate_init
-        generate_command
-    end
-
-    def generate_validator
-        generate_validator if validator
-    end
-
-    def generate_handler
-        generate_handler unless model == 'init'
-    end
-
-    private
-
-    def generate_command
-        template 'commands_template.template', "app/cqrs/#{model.underscore}/commands/#{{name.underscore}_command.rb}"
-    end
-
-    def generate_validator
-        template 'commands_validator_template.template', "app/cqrs/#{model.underscore}/commands/validators/#{{name.underscore}_command_validator.rb}"
-    end
-
-    def generate_handler
-        template 'commands_handler_template.template', "app/cqrs/#{model.underscore}/commands/handlers/#{{name.underscore}_command_handler.rb}"
-    end
-end

data/lib/generators/queries/queries_generator.rb

@@ -1,33 +0,0 @@
-class QueriesGenerator < Rails::Generators::Base
-    source_root File.expand_path('../templates', __FILE__)
-    argument :model, type: :string
-    argument :name, type: :string
-    class_option :validator, type: :boolean, default: false, desc: "Generate validator."
-    class_option :doc, type: :boolean, default: true, desc: "Include documentation."
-
-    def generate_init
-        generate_query
-    end
-
-    def generate_validator
-        generate_validator if validator
-    end
-
-    def generate_handler
-        generate_handler unless model == 'init'
-    end
-
-    private
-
-    def generate_query
-        template 'queries_template.template', "app/cqrs/#{model.underscore}/queries/#{{name.underscore}_query.rb}"
-    end
-
-    def generate_validator
-        template 'queries_validator_template.template', "app/cqrs/#{model.underscore}/queries/validators/#{{name.underscore}_query_validator.rb}"
-    end
-
-    def generate_handler
-        template 'queries_handler_template.template', "app/cqrs/#{model.underscore}/queries/handlers/#{{name.underscore}_query_handler.rb}"
-    end
-end