evnt 3.2.6 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0018c224758da691335945353b6168dfc983aa13d7bda8e1e1d08e0b7f23de51'
-  data.tar.gz: e8842f6d62ac1b78a1ca6db497702ba9c6bea6afed34e01f7e57ba57597246a7
+  metadata.gz: 8ef1b5762fd449d75c4ae69dc161adcbb551d447c660e818e99b99a017fa31df
+  data.tar.gz: 54abf9e98b18f38fa5c11b3dd04413f0acad251840b48d234452f1575128e504
 SHA512:
-  metadata.gz: 96fa1e160c588b1840a30405b4963cc302a6c5a83f4912bd3c114eba909a4d8ca95164beaab2432661147c95aafc927dd0c117701285472b48d9382b2ddb8cf2
-  data.tar.gz: 7b614dba5252f70d8f3106bd55de60278b8e541d47dadece24359d90f94d03b39db82f781a97358ede91aa154d9ed6efe667fb20072c3091413685f6ee34157c
+  metadata.gz: d95dcf19b416dc055707153fae3ef77abd188e8291417f39966677677523084665db75842b4dc2ee592e583acb2d63955176027aa87e1ca7135b8658aef82437
+  data.tar.gz: 3fd2d0dfc03ed1b5431358bfc52bf6eb125b6dfc067c8808f8e7ed2aa8bece0cb7f96ea58780cc916955ec306c7b42cea7e8d7b51fe426c5423f3713627c048e

data/README.md

@@ -29,10 +29,24 @@ gem 'evnt'
 
 ## Development
 
+### RDoc documentation
+
 To update the rdoc documentation run:
 
 ```console
-
 rdoc --op rdoc
+```
+
+### Docsify documentation
+
+Install docsify as global node dependency
+
+```shell
+npm install -g docsify
+```
+
+See documentation on local machine
 
+```shell
+docsify serve ./docs
 ```

data/lib/evnt/event.rb

@@ -50,7 +50,7 @@ module Evnt
       _init_event_data(params)
       _validate_payload
       _run_event_steps
-      _notify_handlers
+      _notify_handlers if @state[:saved]
     end
 
     # Public functions:
@@ -65,6 +65,27 @@ module Evnt
       @state[:reloaded]
     end
 
+    ##
+    # This function tells if the event is saved or not.
+    # As default an event is considered saved. It should be updated to
+    # not saved when the to_write_event has some problems.
+    ##
+    def saved?
+      @state[:saved]
+    end
+
+    ##
+    # This function can be used to set the event as not saved.
+    # A not saved event should not notify handlers.
+    # If the exceptions option is active, it should raise a new error.
+    ##
+    def set_not_saved
+      @state[:saved] = false
+
+      # raise error if event needs exceptions
+      raise 'Event can not be saved' if @options[:exceptions]
+    end
+
     # Private functions:
     ############################################################################
 
@@ -74,11 +95,13 @@ module Evnt
     def _init_event_data(params)
       # set state
       @state = {
-        reloaded: !params[:evnt].nil?
+        reloaded: !params[:evnt].nil?,
+        saved: true
       }
 
       # set options
       initial_options = {
+        exceptions: false,
         silent: false
       }
       default_options = _safe_default_options || {}

data/lib/evnt/version.rb

@@ -3,6 +3,6 @@
 # Evnt.
 module Evnt
 
-  VERSION = '3.2.6'
+  VERSION = '3.3.0'
 
 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('_') # TODO: Remove "event" at the end of name if it's present.
+      @event_name = event_name_clean(path.map(&:underscore).join('_'))
       @event_attributes = (informations - [informations.first]).map { |a| ":#{a}" }.join(', ')
 
       template(
@@ -31,6 +31,12 @@ module Evnt
       path
     end
 
+    def event_name_clean(event_name)
+      return event_name unless event_name.end_with?('_event')
+
+      event_name.gsub('_event', '')
+    end
+
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: evnt
 version: !ruby/object:Gem::Version
-  version: 3.2.6
+  version: 3.3.0
 platform: ruby
 authors:
 - Ideonetwork