evnt 3.0.1 → 3.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 63694dd6640e60116fa220f26d2c5c534434f488
-  data.tar.gz: b8a2784a560444babd7ac31a9d43d4cf73b4be91
+SHA256:
+  metadata.gz: 0d2cecb4f90544de842098f1f89110548ef2a2231504ac0cf47f821bf0abfbb3
+  data.tar.gz: 731c1460b90c981043850df9a5a5b6cc6b9a4d1d0b780859e2070cd0d94c8047
 SHA512:
-  metadata.gz: 4c1381e123afa1b6dfac53d92086102a5d57167d90dbfbaa5e72c59af1aff1bf71ccd48766d33841e265c8875db73812a582600eb192e2d35ea0cb324559c795
-  data.tar.gz: e1baebd245175ff2034607294c4e4836579d6f03148de64cbbc36b60211da29066dec7623263408799c5afbe1296d468f78c24628d614cf139a79ce2fb802252
+  metadata.gz: e93adc9ffeead5ee8632b41d1bee8a030376d1876f61bf6d8e5c4f077fb5efda56c7a3a92a62493a3e3f118a153be0436dc9c5eb6ee87cd335530efc7f9300c9
+  data.tar.gz: 69e531d6aa91fd78f31c75bd3eb4cc30e9848f917bde1e81e191959633736f85e4b3ae7638104df84ecaf5bdaf32f301f8ec6e1348deb44c02ffeffb7895b82d

data/README.md

@@ -8,14 +8,25 @@ CQRS and Event Driven Development architecture for Ruby projects.
   - [Event](#event)
   - [Handler](#handler)
 - [Rails integration](#rails-integration)
+  - [Generators integration](#generators-integration)
+    - [Command generators](#command-generators)
+    - [Event generators](#event-generators)
+    - [Handler generators](#handler-generators)
+  - [Manual integration](#manual-integration)
 - [Development](#development)
 
-Full documentation here: https://ideonetwork.github.io/ruby-evnt/
+Full documentation here: https://ideonetwork.github.io/evnt/
 
 ## Installation
 
 To use the gem you need to add it on your Gemfile
 
+Latest version
+```ruby
+gem 'evnt', git: 'https://github.com/ideonetwork/evnt'
+```
+
+Legacy version
 ```ruby
 gem 'evnt'
 ```
@@ -30,7 +41,7 @@ Evnt is developed to be used over all kinds of projects and frameworks (like Rub
 
 ### Command
 
-Commands are used to run single tasks on the system. It's like a controller on an MVC architecture without the communication with the client.
+Commands are used to run single tasks on the system. It's like a controller on an MVC architecture.
 
 Every command has three steps to execute:
 
@@ -44,15 +55,16 @@ An example of command should be:
 ```ruby
 class CreateOrderCommand < Evnt::Command
 
+  validates :user_id, type: :integer, presence: true
+  validates :product_id, type: :integer, presence: true
+  validates :quantity, type: :integer, presence: true
+
   to_normalize_params do
     params[:quantity] = params[:quantity].to_i
   end
 
   to_validate_params do
-    # check params presence
-    err 'User should be present' if params[:user_id].blank?
-    err 'Product should be present' if params[:product_id].blank?
-    err 'Quantity should be present' if params[:quantity].blank?
+    err 'Quantity should be positive' unless params[:quantity].positive?
   end
 
   to_validate_logic do
@@ -136,22 +148,6 @@ rescue => e
 end
 ```
 
-Some validations are similar for every command (like presence or paramter type), so you can also use general validations instead of **to_validate_params** block. An example of general validations should be:
-
-```ruby
-
-class CreateOrderCommand < Evnt::Command
-
-  validates :user_id, type: :integer, presence: true
-  validates :product_id, type: :integer, presence: true
-  validates :quantity, type: :integer, presence: true
-
-  # ...
-
-end
-
-```
-
 ### Event
 
 Events are used to save on a persistent data structure what happends on the system.
@@ -180,7 +176,10 @@ class CreateOrderEvent < Evnt::Event
 
   to_write_event do
     # save event on database
-    Event.create(name: name, payload: payload)
+    Event.create(
+      name: name,
+      payload: payload
+    )
   end
 
 end
@@ -201,7 +200,7 @@ puts event.attributes # -> [:order_id, :user_id, :product_id, :quantity]
 puts event.payload # -> { order_id: 1, user_id: 128, product_id: 534, quantity: 10, evnt: { timestamp: 2017010101, name: 'create_order' } }
 ```
 
-The event payload should contain all event attributes and a reserver attributes "evnt" used to store the event timestamp and the event name.
+The event payload should contain all event attributes and a reserved attributes "evnt" used to store the event timestamp and the event name.
 
 It's also possible to give datas to the event without save them on the event payload, to do this you shuld only use a key with "_" as first character. An example should be:
 
@@ -283,6 +282,101 @@ end
 
 Evnt can be used with Ruby on Rails to extends the MVC pattern.
 
+### Generators integration
+
+There's a simple generator that can be used to inizialize a Rails application with Evnt.
+
+```shell
+
+rails generate evnt:initializer
+
+```
+
+This command should:
+
+- Create an **application_command.rb** on app/commands directory.
+- Create an **application_event.rb** on app/events directory.
+- Create an **application_handler.rb** on app/handlers directory.
+- Create tests for the three new classes added on the project.
+- Added app/commands, app/events and app/handlers on config.autoload_paths setting of the application.
+
+#### Command generators
+
+Usage:
+
+```shell
+
+rails generate evnt:command Authentication::LoginCommand email:string password:string ip_address:string
+
+```
+
+Output:
+
+```ruby
+# ./app/commands/authentication/login_command.rb
+module Authentication
+  class LoginCommand < ApplicationCommand
+
+    validates :email, type: :string
+
+    validates :password, type: :string
+
+    validates :ip_address, type: :string
+
+  end
+end
+```
+
+#### Event generators
+
+Usage:
+
+```shell
+
+rails generate evnt:event Authentication::LoginEvent user_uuid ip_address
+
+```
+
+Output:
+
+```ruby
+# ./app/events/authentication/login_event.rb
+module Authentication
+  class LoginEvent < ApplicationEvent
+
+    name_is :authentication_login_event
+
+    attributes_are :user_uuid, :ip_address
+
+  end
+end
+```
+
+#### Handler generators
+
+Usage:
+
+```shell
+
+rails generate evnt:handler AuthenticationHandler authentication_login_event authentication_signup_event
+
+```
+
+Output:
+
+```ruby
+# ./app/handlers/authentication_handler.rb
+class AuthenticationHandler < ApplicationHandler
+
+  on :authentication_login_event do; end
+
+  on :authentication_signup_event do; end
+
+end
+```
+
+### Manual integration
+
 To use the gem with Rails you need to create three folders inside the ./app project's path:
 
 - **./app/commands**

data/lib/evnt/command.rb

@@ -26,7 +26,7 @@ module Evnt
     #
     # * +exceptions+ - Boolean value used to activate the throw of excetions.
     ##
-    def initialize(params)
+    def initialize(params = {})
       _init_command_data(params)
       _run_command_steps
     end
@@ -96,7 +96,7 @@ module Evnt
       )
 
       # raise error if command needs exceptions
-      raise error if @options[:exceptions]
+      raise message if @options[:exceptions]
     end
 
     # Private functions:
@@ -111,7 +111,7 @@ module Evnt
         result: true,
         errors: []
       }
-      
+
       # set options
       options = params[:_options] || {}
       @options = {

data/lib/evnt/event.rb

@@ -46,7 +46,7 @@ module Evnt
     # * +silent+ - Boolean value used to avoid the call of the notify method of
     # handlers.
     ##
-    def initialize(params)
+    def initialize(params = {})
       _init_event_data(params)
       _validate_payload
       _run_event_steps

data/lib/evnt/version.rb

@@ -1,10 +1,8 @@
 # frozen_string_literal: true
 
+# Evnt.
 module Evnt
 
-  ##
-  # Constant containing the current gem version.
-  ##
-  VERSION = '3.0.1'
+  VERSION = '3.0.2'
 
 end

data/lib/generators/evnt/command_generator.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'rails/generators/base'
+
+module Evnt
+
+  # CommandGenerator.
+  class CommandGenerator < Rails::Generators::Base
+
+    source_root File.expand_path('../templates', __FILE__)
+
+    argument :informations, type: :array, optional: false
+
+    def create_comand
+      path = informations.first.split('::')
+      @command_class = path.last.camelize
+      @command_modules = path - [path.last]
+      @command_params = (informations - [informations.first]).map do |data|
+        data = data.split(':')
+        data.length > 1 ? ":#{data.first}, type: :#{data.last}" : ":#{data.first}"
+      end
+
+      template(
+        './command/command.rb.erb',
+        command_path
+      )
+    end
+
+    def command_path
+      path = './app/commands'
+      @command_modules.map { |m| path = "#{path}/#{m.underscore}" }
+      path = "#{path}/#{@command_class.underscore}.rb"
+      path
+    end
+
+  end
+
+end

data/lib/generators/evnt/event_generator.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'rails/generators/base'
+
+module Evnt
+
+  # EventGenerator.
+  class EventGenerator < Rails::Generators::Base
+
+    source_root File.expand_path('../templates', __FILE__)
+
+    argument :informations, type: :array, optional: false
+
+    def create_event
+      path = informations.first.split('::')
+      @event_class = path.last.camelize
+      @event_modules = path - [path.last]
+      @event_name = path.map(&:underscore).join('_')
+      @event_attributes = (informations - [informations.first]).map { |a| ":#{a}" }.join(', ')
+
+      template(
+        './event/event.rb.erb',
+        event_path
+      )
+    end
+
+    def event_path
+      path = './app/events'
+      @event_modules.map { |m| path = "#{path}/#{m.underscore}" }
+      path = "#{path}/#{@event_class.underscore}.rb"
+      path
+    end
+
+  end
+
+end

data/lib/generators/evnt/handler_generator.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'rails/generators/base'
+
+module Evnt
+
+  # HandlerGenerator.
+  class HandlerGenerator < Rails::Generators::Base
+
+    source_root File.expand_path('../templates', __FILE__)
+
+    argument :informations, type: :array, optional: false
+
+    def create_handler
+      path = informations.first.split('::')
+      @handler_class = path.last.camelize
+      @handler_modules = path - [path.last]
+      @handler_events = (informations - [informations.first])
+
+      template(
+        './handler/handler.rb.erb',
+        handler_path
+      )
+    end
+
+    def handler_path
+      path = './app/handlers'
+      @handler_modules.map { |m| path = "#{path}/#{m.underscore}" }
+      path = "#{path}/#{@handler_class.underscore}.rb"
+      path
+    end
+
+  end
+
+end

data/lib/generators/evnt/initializer_generator.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'rails/generators/base'
+
+module Evnt
+
+  # InitializerGenerator.
+  class InitializerGenerator < Rails::Generators::Base
+
+    source_root File.expand_path('../templates', __FILE__)
+
+    def create_initializer
+      directory './initializer', './'
+      update_config_application
+    end
+
+    def update_config_application
+      application "config.autoload_paths += %W[\#{Rails.root}/app/commands]"
+      application "config.autoload_paths += %W[\#{Rails.root}/app/events]"
+      application "config.autoload_paths += %W[\#{Rails.root}/app/handlers]"
+    end
+
+  end
+
+end

data/lib/generators/evnt/templates/command/command.rb.erb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+<% @command_modules.each_with_index do |module_name, index| %>
+<%= '  ' * index %>module <%= module_name %>
+<% end %>
+<%= '  ' * @command_modules.length %># <%= @command_class %>
+<%= '  ' * @command_modules.length %>class <%= @command_class %> < ApplicationCommand
+<% @command_params.each do |param| %>
+<%= '  ' * (@command_modules.length + 1) %>validates <%= param %>
+<% end %>
+<%= '  ' * @command_modules.length %>end
+<% @command_modules.each_with_index do |_module_name, index| %>
+<%= '  ' * (@command_modules.length - index - 1) %>end
+<% end %>

data/lib/generators/evnt/templates/event/event.rb.erb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+<% @event_modules.each_with_index do |module_name, index| %>
+<%= '  ' * index %>module <%= module_name %>
+<% end %>
+<%= '  ' * @event_modules.length %># <%= @event_class %>
+<%= '  ' * @event_modules.length %>class <%= @event_class %> < ApplicationEvent
+
+<%= '  ' * (@event_modules.length + 1) %>name_is :<%= @event_name %>
+<% unless @event_attributes.blank? %>
+<%= '  ' * (@event_modules.length + 1) %>attributes_are <%= @event_attributes %>
+<% end %>
+<%= '  ' * @event_modules.length %>end
+<% @event_modules.each_with_index do |_module_name, index| %>
+<%= '  ' * (@event_modules.length - index - 1) %>end
+<% end %>

data/lib/generators/evnt/templates/handler/handler.rb.erb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+<% @handler_modules.each_with_index do |module_name, index| %>
+<%= '  ' * index %>module <%= module_name %>
+<% end %>
+<%= '  ' * @handler_modules.length %># <%= @handler_class %>
+<%= '  ' * @handler_modules.length %>class <%= @handler_class %> < ApplicationHandler
+<% @handler_events.each do |event| %>
+<%= '  ' * (@handler_modules.length + 1) %>on :<%= event %> do; end
+<% end %>
+<%= '  ' * @handler_modules.length %>end
+<% @handler_modules.each_with_index do |_module_name, index| %>
+<%= '  ' * (@handler_modules.length - index - 1) %>end
+<% end %>

data/lib/generators/evnt/templates/initializer/app/commands/application_command.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+# ApplicationCommand.
+class ApplicationCommand < Evnt::Command
+end

data/lib/generators/evnt/templates/initializer/app/events/application_event.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+# ApplicationEvent.
+class ApplicationEvent < Evnt::Event
+end

data/lib/generators/evnt/templates/initializer/app/handlers/application_handler.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+# ApplicationHandler.
+class ApplicationHandler < Evnt::Handler
+end

data/lib/generators/evnt/templates/initializer/test/commands/application_command_test.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+# ApplicationCommandTest.
+class ApplicationCommandTest < ActiveSupport::TestCase
+
+  test 'it should be initialized' do
+    command = ApplicationCommand.new
+    assert_not_nil command
+    assert command.completed?
+  end
+
+end

data/lib/generators/evnt/templates/initializer/test/events/application_event_test.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+# ApplicationEventTest.
+class ApplicationEventTest < ActiveSupport::TestCase
+
+  test 'it should be initialized' do
+    event = ApplicationEvent.new
+    assert_not_nil event
+    assert_not_nil event.payload
+    assert_not_nil event.payload[:evnt]
+  end
+
+end

data/lib/generators/evnt/templates/initializer/test/handlers/application_handler_test.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+# ApplicationHandlerTest.
+class ApplicationHandlerTest < ActiveSupport::TestCase
+
+  test 'it should be initialized' do
+    handler = ApplicationHandler.new
+    assert_not_nil handler
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: evnt
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.0.2
 platform: ruby
 authors:
 - Ideonetwork
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-14 00:00:00.000000000 Z
+date: 2018-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -67,6 +67,19 @@ files:
 - lib/evnt/handler.rb
 - lib/evnt/validator.rb
 - lib/evnt/version.rb
+- lib/generators/evnt/command_generator.rb
+- lib/generators/evnt/event_generator.rb
+- lib/generators/evnt/handler_generator.rb
+- lib/generators/evnt/initializer_generator.rb
+- lib/generators/evnt/templates/command/command.rb.erb
+- lib/generators/evnt/templates/event/event.rb.erb
+- lib/generators/evnt/templates/handler/handler.rb.erb
+- lib/generators/evnt/templates/initializer/app/commands/application_command.rb
+- lib/generators/evnt/templates/initializer/app/events/application_event.rb
+- lib/generators/evnt/templates/initializer/app/handlers/application_handler.rb
+- lib/generators/evnt/templates/initializer/test/commands/application_command_test.rb
+- lib/generators/evnt/templates/initializer/test/events/application_event_test.rb
+- lib/generators/evnt/templates/initializer/test/handlers/application_handler_test.rb
 homepage: http://ideonetwork.it/
 licenses:
 - MIT
@@ -87,7 +100,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: CQRS and Event Driven Development architecture for Ruby