evnt 3.5.0 → 3.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1147304064293c3dfa71574a83935a8328b98f91f9ece384d9bf32c8bc4195c2
-  data.tar.gz: 1b74795c01d50f1c00c3f45f6938a42493d5e9e5609c72b8df1a3bcce98e33d8
+  metadata.gz: 390c7cbf488240f3f1ba5caa1f1ca38d4b8f8aceb335a0c7e99ef52ddc2487b9
+  data.tar.gz: c46c2a712719b9640f25f1f3843f9470512b9b77b95a77caa1672e25dfb46a0d
 SHA512:
-  metadata.gz: f54bfe9c4b7ffeeea71df3a393e932ac2d51d9c0d96928f9ee35ec478c264dc3608f65bf16e10bc81e916290ef1a51cfcaade7481d2abe075a8791d43c7add7d
-  data.tar.gz: 8788243241cc12dc09edb4686d375bab113db99aa5bda599958f1c175153e1e72658757d8e1be1167781fb36e9a8c7a069ea333aa75d49d2c0704ea877690c13
+  metadata.gz: 66a63f9254bded1cfbd5211d0c54ebbe637911fd9b130145b968cbbc31f6e513794ba69871e7923b96ae388ede1a22c8f3be25849a70464aa3d6c678b29dfebc
+  data.tar.gz: 3e30a18058cde3b00148cf22826d554af206e2a19fd6812a4fa2b380ca85d399e0a748ff79d0efe820268f983c3428537daa8285933b5c0cd2c2352b6c6e736c

data/README.md

@@ -5,12 +5,11 @@
 
 CQRS and Event Driven Development architecture for Ruby projects.
 
-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 four different classes:
+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.
-- **Queries**: list of queries used to read data from database.
 
 The full documentation of these classes can be found here: https://ideonetwork.github.io/evnt
 

data/lib/evnt.rb

@@ -6,9 +6,6 @@ require 'evnt/event'
 require 'evnt/handler'
 require 'evnt/validator'
 
-require 'evnt/query'
-require 'evnt/query_activerecord'
-
 ##
 # Evnt is a gem developed to integrate a event driven development
 # and CQRS pattern inside a ruby project.

data/lib/evnt/event.rb

@@ -213,6 +213,15 @@ module Evnt
         define_method('_attributes', -> { return event_attributes })
       end
 
+      # This function sets the list of handlers for the event.
+      def handlers_are(handlers)
+        @handlers ||= []
+        @handlers.concat(handlers)
+        event_handlers = @handlers
+
+        define_method('_handlers', -> { return event_handlers })
+      end
+
       # This function sets the write event function for the event.
       def to_write_event(&block)
         define_method('_write_event', &block)
@@ -229,17 +238,6 @@ module Evnt
 
       # DEPRECATED
 
-      # This function sets the list of handlers for the event.
-      def handlers_are(handlers)
-        @handlers ||= []
-        @handlers.concat(handlers)
-        event_handlers = @handlers
-
-        define_method('_handlers', -> { return event_handlers })
-
-        warn '[DEPRECATION] `handlers_are` is deprecated.  Please use handler `listen` instead.' 
-      end
-
     end
 
   end

data/lib/evnt/version.rb

@@ -3,6 +3,6 @@
 # Evnt.
 module Evnt
 
-  VERSION = '3.5.0'
+  VERSION = '3.6.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: evnt
 version: !ruby/object:Gem::Version
-  version: 3.5.0
+  version: 3.6.0
 platform: ruby
 authors:
 - Ideonetwork
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-04 00:00:00.000000000 Z
+date: 2018-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -65,27 +65,22 @@ files:
 - lib/evnt/command.rb
 - lib/evnt/event.rb
 - lib/evnt/handler.rb
-- lib/evnt/query.rb
-- lib/evnt/query_activerecord.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/query_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/app/queries/application_query.rb
 - lib/generators/evnt/templates/initializer/config/initializers/evnt.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
-- lib/generators/evnt/templates/query/query.rb.erb
 homepage: http://ideonetwork.it/
 licenses:
 - MIT

data/lib/evnt/query.rb

@@ -1,48 +0,0 @@
-# frozen_string_literal: true
-
-module Evnt
-
-  ##
-  # Queries are used to read and prepare data from the database
-  # to the client.
-  # The Query class should contain only helpers used to develop custom queries.
-  ##
-  class Query
-
-    ##
-    # The constructor should not be used. Use class method insthead.
-    ##
-    def initialize
-      raise SystemCallError, 'Query can not be initialized'
-    end
-
-    def self.as_json(_query, _parameters = {})
-      raise NotImplementedError, 'As json method should be implemented on Query subclasses'
-    end
-
-    def self.as_string(_query, _parameters = {})
-      raise NotImplementedError, 'As string method should be implemented on Query subclasses'
-    end
-
-    def self.as_bytes(_query, _parameters = {})
-      raise NotImplementedError, 'As bytes method should be implemented on Query subclasses'
-    end
-
-    # Helpers:
-    ############################################################################
-
-    def self.clean_unpermitted_attributes_from_json(obj, unpermitted_attributes)
-      if obj.is_a?(Array)
-        obj.map { |o| unpermitted_attributes.each { |attribute| o.delete(attribute.to_s) } }
-      else
-        unpermitted_attributes.each { |attribute| obj.delete(attribute.to_s) }
-      end
-
-      obj
-    end
-
-    private_class_method :clean_unpermitted_attributes_from_json
-
-  end
-
-end

data/lib/evnt/query_activerecord.rb

@@ -1,58 +0,0 @@
-# frozen_string_literal: true
-
-module Evnt
-
-  ##
-  # Queries are used to read and prepare data from the database
-  # to the client.
-  # The QueryActivercord class shuld contain helpers used to develop custom
-  # queries based on activerecord.
-  ##
-  class QueryActiverecord < Evnt::Query
-
-    ##
-    # This function should run a query and return the result as a hash/json object.
-    #
-    # ==== Attributes
-    #
-    # * +query+ - The name of the query that should be executed.
-    # * +parameters+ - An object containing the parameters for the query.
-    ##
-    def self.as_json(query, parameters = {})
-      except = parameters[:_except] || []
-      only = parameters[:_only] || []
-
-      result = send(query, parameters).as_json
-      return result unless except.length.positive? || only.length.positive?
-
-      clean_unpermitted_attributes_from_json(result, except) if except.length.positive?
-      clean_unpermitted_attributes_from_json(result, result.keys - only) if only.length.positive?
-    end
-
-    ##
-    # This function should run a query and return the result as a string object.
-    #
-    # ==== Attributes
-    #
-    # * +query+ - The name of the query that should be executed.
-    # * +parameters+ - An object containing the parameters for the query.
-    ##
-    def self.as_string(query, parameters = {})
-      as_json(query, parameters).to_s
-    end
-
-    ##
-    # This function should run a query and return the result as a bytes array.
-    #
-    # ==== Attributes
-    #
-    # * +query+ - The name of the query that should be executed.
-    # * +parameters+ - An object containing the parameters for the query.
-    ##
-    def self.as_bytes(query, parameters = {})
-      as_string(query, parameters).bytes.to_a
-    end
-
-  end
-
-end

data/lib/generators/evnt/query_generator.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-require 'rails/generators/base'
-
-module Evnt
-
-  # QueryGenerator.
-  class QueryGenerator < Rails::Generators::Base
-
-    source_root File.expand_path('../templates', __FILE__)
-
-    argument :informations, type: :array, optional: false
-
-    def create_comand
-      path = informations.first.split('::')
-      @query_class = path.last.camelize
-      @query_modules = path - [path.last]
-      @query_params = informations - [informations.first]
-
-      template(
-        './query/query.rb.erb',
-        query_path
-      )
-    end
-
-    def query_path
-      path = './app/queries'
-      @query_modules.map { |m| path = "#{path}/#{m.underscore}" }
-      path = "#{path}/#{@query_class.underscore}.rb"
-      path
-    end
-
-  end
-
-end

data/lib/generators/evnt/templates/initializer/app/queries/application_query.rb

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-
-# ApplicationQuery.
-class ApplicationQuery < Evnt::QueryActiverecord
-
-end

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

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-<% @query_modules.each_with_index do |module_name, index| %>
-<%= '  ' * index %>module <%= module_name %>
-<% end %>
-<%= '  ' * @query_modules.length %># <%= @query_class %>
-<%= '  ' * @query_modules.length %>class <%= @query_class %> < ApplicationQuery
-<% @query_params.each do |param| %>
-<%= '  ' * (@query_modules.length + 1) %>def self.<%= param %>; end
-<% end %>
-<%= '  ' * @query_modules.length %>end
-<% @query_modules.each_with_index do |_module_name, index| %>
-<%= '  ' * (@query_modules.length - index - 1) %>end
-<% end %>