evnt 3.3.0 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8ef1b5762fd449d75c4ae69dc161adcbb551d447c660e818e99b99a017fa31df
-  data.tar.gz: 54abf9e98b18f38fa5c11b3dd04413f0acad251840b48d234452f1575128e504
+  metadata.gz: 2e6642f8281f70c2e1fa58135df7275bff548259ae713d451495e31d48ef2d06
+  data.tar.gz: 68ac7a94843664a0b6d7ad88136afb45bbea32530b8b2dce58908edd2ca93607
 SHA512:
-  metadata.gz: d95dcf19b416dc055707153fae3ef77abd188e8291417f39966677677523084665db75842b4dc2ee592e583acb2d63955176027aa87e1ca7135b8658aef82437
-  data.tar.gz: 3fd2d0dfc03ed1b5431358bfc52bf6eb125b6dfc067c8808f8e7ed2aa8bece0cb7f96ea58780cc916955ec306c7b42cea7e8d7b51fe426c5423f3713627c048e
+  metadata.gz: 90e84269ee4dce4cb75ab51253e4bd5e5e865484e2eb0d701561a18abeb26c73607eae13f9dd2043cdfc4e3dda186123ebb6c14edd6f7b3c5bae8db011c56135
+  data.tar.gz: 15d50a32bbea10cad774c418cbcdf96aaa84044ccdb4daaa41cdb11e58d2c47c68660d9b5d964183214bc65645ff6ac5a6afa0fd08e4d2b064311fe9654c9927

data/README.md

@@ -5,11 +5,12 @@
 
 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 three 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 four 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.
+- **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,6 +6,9 @@ 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/query.rb

@@ -0,0 +1,40 @@
+# 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, except: [], only: [])
+      raise NotImplementedError, 'As json 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

@@ -0,0 +1,33 @@
+# 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.
+    # * +except+ - The list of attributes that should be removed from the json.
+    # * +only+ - The list of parameters that shoud be accepted for the json.
+    ##
+    def self.as_json(query, parameters, except: [], 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
+
+  end
+
+end

data/lib/evnt/version.rb

@@ -3,6 +3,6 @@
 # Evnt.
 module Evnt
 
-  VERSION = '3.3.0'
+  VERSION = '3.4.0'
 
 end

data/lib/generators/evnt/initializer_generator.rb

@@ -23,6 +23,7 @@ module Evnt
       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]"
+      application "config.autoload_paths += %W[\#{Rails.root}/app/queries]"
     end
 
     def manage_migrated_option

data/lib/generators/evnt/query_generator.rb

@@ -0,0 +1,35 @@
+# 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

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

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

@@ -0,0 +1,13 @@
+# 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 %>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: evnt
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 3.4.0
 platform: ruby
 authors:
 - Ideonetwork
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-13 00:00:00.000000000 Z
+date: 2018-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -65,21 +65,26 @@ 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/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