evnt 3.6.2 → 3.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 534a7e52f3d1e1e0639241b4576f13ddf3d84f5d27661653a7f54b8ab6282b87
-  data.tar.gz: 269c77c39c3475b5514f6bb72b6d0177bb6d0e7707de349ad40613feb2bae9ec
+  metadata.gz: d6914876f490b7f506f0bd135ac831e8acffb9e5fb43415f58058caabd247b89
+  data.tar.gz: bccddfbc82d68e6b0a4799dd1db223cb8eb29c53b74b2ce59cfbcbd208d15ad5
 SHA512:
-  metadata.gz: c5ba0c448849c4d6b6288b7158c8ce32ac2a532829257207f371567fc39e070495ad25e69d2ad2c9d1d5e222d3b6d5ce9b2cd9a430c0a87680675b692ab9913e
-  data.tar.gz: 000fb5ac286e63df864ddbad79759e12829b02f627bb2fab61b8631a75db1f43dc127b9637dc3183988b961a6d100345303c1fd4b66cee0cea3c45768029a462
+  metadata.gz: c66d8707ed27a203347788861f27f7acdb6220bae5fe6288ce63b4b162dafc19ace35fe0e4e077274e743f908f1c0ca2acd379cdc02441cf1aeb2956ba502ddf
+  data.tar.gz: 7e01984cd1ae84b961ff41fad33e0fd518c5543c172eb821a5315936767637615e81efb3d215e408fa824e79c087d11e4daeceba8d76c8f57f17c97fc76aff08

data/README.md

@@ -42,7 +42,7 @@ rdoc --op rdoc
 Install docsify as global node dependency
 
 ```shell
-npm install -g docsify
+npm install -g docsify-cli
 ```
 
 See documentation on local machine

data/lib/evnt/command.rb

@@ -213,11 +213,10 @@ module Evnt
 
       # This function sets the single validation request for a command parameter.
       def validates(param, options)
-        @validations ||= []
-        @validations.push(param: param, options: options)
-        command_validations = @validations
+        @@validations ||= []
+        @@validations.push(param: param, options: options)
 
-        define_method('_validations', -> { return command_validations })
+        define_method('_validations', -> { @@validations })
       end
 
       # This function sets the normalize params function for the command.

data/lib/evnt/event.rb

@@ -16,7 +16,17 @@ module Evnt
     attr_reader :name
 
     ##
-    # Attribute containings the list of attributes of the event.
+    # Attribute containings the list of payload attributes of the event.
+    ##
+    attr_reader :payload_attributes
+
+    ##
+    # Attribute containings the list of extras attributes of the event.
+    ##
+    attr_reader :extras_attributes
+
+    ##
+    # DEPRECATED: Attribute containings the list of attributes of the event.
     ##
     attr_reader :attributes
 
@@ -49,6 +59,7 @@ module Evnt
     def initialize(params = {})
       _init_event_data(params)
       _validate_payload
+      _validate_extras
       _run_event_steps
       _notify_handlers if @state[:saved]
     end
@@ -111,7 +122,9 @@ module Evnt
 
       # set name and attributes
       @name = _safe_name
-      @attributes = _safe_attributes
+      @payload_attributes = _safe_payload_attributes
+      @extras_attributes = _safe_extras_attributes
+      @attributes = _safe_payload_attributes # DEPRECATED
 
       # set payload
       payload = params.reject { |k, _v| k[0] == '_' }
@@ -137,10 +150,17 @@ module Evnt
     # This function validates all payload and check they are completed.
     def _validate_payload
       # check all attributes are present
-      check_attr = (@payload.keys - [:evnt]) == @attributes
+      check_attr = (@payload.keys - [:evnt]).sort == @payload_attributes.sort
       raise 'Event parameters are not correct' unless check_attr
     end
 
+    # This function validates all extras and check they are completed.
+    def _validate_extras
+      # check all attributes are present
+      check_attr = @extras.keys.sort == @extras_attributes.sort
+      puts 'Event extras are not correct; in future releases they will be required' unless check_attr
+    end
+
     # This function calls requested steps for the event.
     def _run_event_steps
       _safe_write_event
@@ -169,8 +189,13 @@ module Evnt
       ''
     end
 
-    def _safe_attributes
-      return _attributes if defined?(_attributes)
+    def _safe_payload_attributes
+      return _payload_attributes if defined?(_payload_attributes)
+      []
+    end
+
+    def _safe_extras_attributes
+      return _extras_attributes if defined?(_extras_attributes)
       []
     end
 
@@ -192,11 +217,10 @@ module Evnt
 
       # This function sets the default options that should be used by the event.
       def default_options(options)
-        @options ||= {}
-        @options.merge!(options)
-        event_options = @options
+        @@options ||= {}
+        @@options.merge!(options)
 
-        define_method('_default_options', -> { return event_options })
+        define_method('_default_options', -> { @@options })
       end
 
       # This function sets the name for the event.
@@ -204,22 +228,36 @@ module Evnt
         define_method('_name', -> { return name })
       end
 
-      # This function sets the list of attributes for the event.
+      # This function sets the list of payload attributes for the event.
+      def payload_attributes_are(*attributes)
+        @@payload_attributes ||= []
+        @@payload_attributes.concat(attributes).uniq!
+
+        define_method('_payload_attributes', -> { @@payload_attributes })
+      end
+
+      # This function sets the list of extras attributes for the event.
+      def extras_attributes_are(*attributes)
+        @@extras_attributes ||= []
+        @@extras_attributes.concat(attributes).uniq!
+
+        define_method('_extras_attributes', -> { @@extras_attributes })
+      end
+
+      # DEPRECATED: This function sets the list of attributes for the event.
       def attributes_are(*attributes)
-        @attributes ||= []
-        @attributes.concat(attributes).uniq!
-        event_attributes = @attributes
+        @@payload_attributes ||= []
+        @@payload_attributes.concat(attributes).uniq!
 
-        define_method('_attributes', -> { return event_attributes })
+        define_method('_payload_attributes', -> { @@payload_attributes })
       end
 
       # This function sets the list of handlers for the event.
       def handlers_are(handlers)
-        @handlers ||= []
-        @handlers.concat(handlers)
-        event_handlers = @handlers
+        @@handlers ||= []
+        @@handlers.concat(handlers)
 
-        define_method('_handlers', -> { return event_handlers })
+        define_method('_handlers', -> { @@handlers })
       end
 
       # This function sets the write event function for the event.
@@ -229,11 +267,10 @@ module Evnt
 
       # This function is used to add a new handler to the event from the external.
       def add_handler(handler)
-        @handlers ||= []
-        @handlers.push(handler)
-        event_handlers = @handlers
+        @@handlers ||= []
+        @@handlers.push(handler)
 
-        define_method('_handlers', -> { return event_handlers })
+        define_method('_handlers', -> { @@handlers })
       end
 
     end

data/lib/evnt/version.rb

@@ -3,6 +3,6 @@
 # Evnt.
 module Evnt
 
-  VERSION = '3.6.2'
+  VERSION = '3.6.3'
 
 end

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

@@ -7,7 +7,7 @@
 
 <%= '  ' * (@event_modules.length + 1) %>name_is :<%= @event_name %>
 <% unless @event_attributes.blank? %>
-<%= '  ' * (@event_modules.length + 1) %>attributes_are <%= @event_attributes %>
+<%= '  ' * (@event_modules.length + 1) %>payload_attributes_are <%= @event_attributes %>
 <% end %>
 <%= '  ' * @event_modules.length %>end
 <% @event_modules.each_with_index do |_module_name, index| %>

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

@@ -3,7 +3,8 @@
 # ApplicationEvent.
 class ApplicationEvent < Evnt::Event
 
-  default_options silent: false
+  default_options silent: false,
+                  exceptions: false
 
   # Change this block with what you want to do to save event!
   to_write_event do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: evnt
 version: !ruby/object:Gem::Version
-  version: 3.6.2
+  version: 3.6.3
 platform: ruby
 authors:
 - Ideonetwork
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-24 00:00:00.000000000 Z
+date: 2019-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -100,8 +100,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: CQRS and Event Driven Development architecture for Ruby