evnt 3.2.5 → 3.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 31e331c91b6b97338b9583587d74b8a3da99c861b9ee46b584f7029185cd25db
-  data.tar.gz: ce5fadcd4669d194b13a2840ff2e5c311da73f6149c0c7c628cb0bfe6872a641
+  metadata.gz: '0018c224758da691335945353b6168dfc983aa13d7bda8e1e1d08e0b7f23de51'
+  data.tar.gz: e8842f6d62ac1b78a1ca6db497702ba9c6bea6afed34e01f7e57ba57597246a7
 SHA512:
-  metadata.gz: 138fcfc99e148ac1665b0f317ab4f9efe53dae0ef220774defc067e7c7f8e2f79174d19ff81cf17509a4eb1a26169237751e9b8117335d98b094fbd7abcaa0a6
-  data.tar.gz: 944820d7276892bc245167d0340ed2098f0c5bb9d70cc3b3db3e231dfb0abb39288cfae3c96b7132c1cdbed59b9dec35d10ad61d3909b66508dcdb268abc6c36
+  metadata.gz: 96fa1e160c588b1840a30405b4963cc302a6c5a83f4912bd3c114eba909a4d8ca95164beaab2432661147c95aafc927dd0c117701285472b48d9382b2ddb8cf2
+  data.tar.gz: 7b614dba5252f70d8f3106bd55de60278b8e541d47dadece24359d90f94d03b39db82f781a97358ede91aa154d9ed6efe667fb20072c3091413685f6ee34157c

data/README.md

@@ -1,16 +1,17 @@
 # Evnt
 
+[![Gem Version](https://badge.fury.io/rb/evnt.svg)](https://badge.fury.io/rb/evnt)
+[![Inline docs](http://inch-ci.org/github/ideonetwork/evnt.svg?branch=master)](http://inch-ci.org/github/ideonetwork/evnt)
+
 CQRS and Event Driven Development architecture for Ruby projects.
 
-- [Installation](#installation)
-- [Structure](#structure)
-  - [Command](https://github.com/ideonetwork/evnt/blob/master/doc/Command.md)
-  - [Event](https://github.com/ideonetwork/evnt/blob/master/doc/Event.md)
-  - [Handler](https://github.com/ideonetwork/evnt/blob/master/doc/Handler.md)
-- [Rails integration](https://github.com/ideonetwork/evnt/blob/master/doc/RailsIntegration.md)
-- [Development](#development)
+Evnt is a Ruby gem used to design software following the CQRS and Event driven development pattern. The idea behind Evnt is to develop the business logic of the system using three different classes:
+
+- **Commands**: actions executed by actors that can be completed or stopped by the system.
+- **Events**: something that it's already happen and should be logged somewhere.
+- **Handlers**:  event listeners that perform specific tasks.
 
-Full class documentation here: https://ideonetwork.github.io/evnt/
+The full documentation of these classes can be found here: https://ideonetwork.github.io/evnt
 
 ## Installation
 
@@ -26,22 +27,12 @@ Legacy version
 gem 'evnt'
 ```
 
-## Structure
-
-Evnt is developed to be used over all kinds of projects and frameworks (like Ruby on Rails or Sinatra), so it contains only three types of entities:
-
-- [Command](https://github.com/ideonetwork/evnt/blob/master/doc/Command.md)
-- [Event](https://github.com/ideonetwork/evnt/blob/master/doc/Event.md)
-- [Handler](https://github.com/ideonetwork/evnt/blob/master/doc/Handler.md)
-
-Every entity is a simple class that should be extended to structure your awesome project.
-
 ## Development
 
-To update the documentation run:
+To update the rdoc documentation run:
 
 ```console
 
-rdoc --op docs
+rdoc --op rdoc
 
 ```

data/lib/evnt/event.rb

@@ -86,6 +86,10 @@ module Evnt
       @options = initial_options.merge(default_options)
                                 .merge(params_options)
 
+      # set name and attributes
+      @name = _safe_name
+      @attributes = _safe_attributes
+
       # set payload
       payload = params.reject { |k, _v| k[0] == '_' }
       @payload = @state[:reloaded] ? payload : _generate_payload(payload)
@@ -94,10 +98,6 @@ module Evnt
       @extras = {}
       extras = params.select { |k, _v| k[0] == '_' }
       extras.each { |k, v| @extras[k[1..-1].to_sym] = v }
-
-      # set other datas
-      @name = _safe_name
-      @attributes = _safe_attributes
     end
 
     # This function generates the complete event payload.

data/lib/evnt/version.rb

@@ -3,6 +3,6 @@
 # Evnt.
 module Evnt
 
-  VERSION = '3.2.5'
+  VERSION = '3.2.6'
 
 end

data/lib/generators/evnt/event_generator.rb

@@ -15,7 +15,7 @@ module Evnt
       path = informations.first.split('::')
       @event_class = path.last.camelize
       @event_modules = path - [path.last]
-      @event_name = path.map(&:underscore).join('_')
+      @event_name = path.map(&:underscore).join('_') # TODO: Remove "event" at the end of name if it's present.
       @event_attributes = (informations - [informations.first]).map { |a| ":#{a}" }.join(', ')
 
       template(

data/lib/generators/evnt/initializer_generator.rb

@@ -9,9 +9,14 @@ module Evnt
 
     source_root File.expand_path('../templates', __FILE__)
 
+    class_option :migrated, type: :boolean, default: false,
+                            desription: 'Include migration for a model used to save events.'
+
     def create_initializer
       directory './initializer', './'
       update_config_application
+
+      manage_migrated_option
     end
 
     def update_config_application
@@ -20,6 +25,12 @@ module Evnt
       application "config.autoload_paths += %W[\#{Rails.root}/app/handlers]"
     end
 
+    def manage_migrated_option
+      return unless options[:migrated]
+
+      invoke 'model', ['EvntEvent', 'name:string', 'payload:text']
+    end
+
   end
 
 end

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

@@ -2,4 +2,8 @@
 
 # ApplicationCommand.
 class ApplicationCommand < Evnt::Command
+
+  default_options exceptions: false,
+                  nullify_empty_params: false
+
 end

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

@@ -2,4 +2,15 @@
 
 # ApplicationEvent.
 class ApplicationEvent < Evnt::Event
+
+  default_options silent: false
+
+  # Change this block with what you want to do to save event!
+  to_write_event do
+    EvntEvent.create(
+      name: name,
+      payload: payload
+    )
+  end
+
 end

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

@@ -8,7 +8,6 @@ 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

@@ -8,8 +8,6 @@ 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: evnt
 version: !ruby/object:Gem::Version
-  version: 3.2.5
+  version: 3.2.6
 platform: ruby
 authors:
 - Ideonetwork
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-01 00:00:00.000000000 Z
+date: 2018-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler