command_service_object 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f7f0b0d9360f1cd9db2ce8bbab1f35f44f0d4d631f7ff356607509237807dbc
-  data.tar.gz: badfbd6e44876729b1dde74a4dabedd77e11a0b8e0decc333fbe4b43ab9a3e2f
+  metadata.gz: 378dc78b1fdeb1e415506b8edacb761ee0a0d78c90b5b1cf90c081a506cf6183
+  data.tar.gz: 26395c6559e2f8124583c5002a519f39f32b781dfee944218a894bd6570f1715
 SHA512:
-  metadata.gz: e65c2c56b4d32992a78753248012787b888aeaf099d5d8a4bf93e4a1b1efbb0a6c271ed83b79785a66748e0606175231c02ecef3bb1b267da9fee1d8f4cb4c69
-  data.tar.gz: 9c93b24c8f6831dab02c1a603474821ae37de77b5f3ede2ca3bdb8f91a48a2c68228285ca0fb1b8cae624658d7256827e31439b49e8d92a15501f221786491e8
+  metadata.gz: 446882a4a2a56924868783acffa56fdf54b0f61eedb48e1c58846f3de7795f32d7afde0b74fb02425530590324bc240eaf9befedc8b0cb306f52f1cb75e1cde4
+  data.tar.gz: 49e3cb994a9304e5b34d88d5abef25e4c79cbb751c1f466b8d232735534205e6092bb74219f4b05e4a46ec8e8cc295730c29b8b656e3ebcef612b98a9a0996f5

data/Gemfile.lock

@@ -64,7 +64,7 @@ GEM
     coercible (1.0.0)
       descendants_tracker (~> 0.0.1)
     concurrent-ruby (1.1.5)
-    crass (1.0.4)
+    crass (1.0.6)
     descendants_tracker (0.0.4)
       thread_safe (~> 0.3, >= 0.3.1)
     equalizer (0.0.11)
@@ -80,7 +80,7 @@ GEM
       concurrent-ruby (~> 1.0)
     ice_nine (0.11.2)
     json (2.3.1)
-    loofah (2.2.3)
+    loofah (2.7.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     mail (2.7.1)
@@ -94,9 +94,9 @@ GEM
     minitest (5.11.3)
     multi_json (1.15.0)
     nio4r (2.3.1)
-    nokogiri (1.10.4)
+    nokogiri (1.10.10)
       mini_portile2 (~> 2.4.0)
-    rack (2.0.7)
+    rack (2.2.3)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
     rails (5.2.3)
@@ -123,7 +123,7 @@ GEM
       method_source
       rake (>= 0.8.7)
       thor (>= 0.19.0, < 2.0)
-    rake (10.5.0)
+    rake (13.0.1)
     sprockets (3.7.2)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
@@ -142,7 +142,7 @@ GEM
       equalizer (~> 0.0, >= 0.0.9)
     websocket-driver (0.7.0)
       websocket-extensions (>= 0.1.0)
-    websocket-extensions (0.1.3)
+    websocket-extensions (0.1.5)
 
 PLATFORMS
   ruby
@@ -153,7 +153,7 @@ DEPENDENCIES
   command_service_object!
   minitest (~> 5.11, >= 5.11.3)
   rails (~> 5.0)
-  rake (~> 10.0)
+  rake (~> 13.0)
   thor (~> 0.20.3)
 
 BUNDLED WITH

data/README.md

@@ -18,13 +18,14 @@ Service consists of several objects { `Command Object` `Usecase Object` And `Err
 - **Listeners:** An event listener that waits for an event outside the service to occur.
 - **Entities:** Many objects are not fundamentally defined by their attributes, but rather by a thread of continuity and identity.
 
-#### Result Object
+### Result Object
 
 In case of successful or failure `ApplicationService` the responsible object for all services will return `service_result` object this object contain `value!` method containing successful call result, and `errors` method containing failure `errors` objects.
 
-#### Business Logic Failures
+### Helpers:
 
-To raise bussiness logic failures you can use `fail!` helper method with `message: String, extra_data: Hash` arguments.
+- Fail: You can use `fail!` helper to raise business logic failures, ex: `fail!('user should not have any active cards')`.
+- Check: To do business logic validations you can use `check!` helper ex: `check!('user should not have any active cards') { user.active_cards.empty? }`, if the given block returns false then it will raise fail! with the given message.
 
 > You can check if the result successful or not by using `ok?` method.
 

data/command_service_object.gemspec

@@ -36,7 +36,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'byebug', '~> 9.0.6'
   spec.add_development_dependency 'minitest', '~> 5.11', '>= 5.11.3'
   spec.add_development_dependency 'rails', '~> 5.0'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'thor', '~> 0.20.3'
 
   spec.add_dependency 'virtus', '~> 1.0', '>= 1.0.5'

data/lib/command_service_object.rb

@@ -4,6 +4,7 @@ require 'command_service_object/failure'
 require 'command_service_object/helpers/model_helper'
 require 'command_service_object/helpers/controller_helper'
 require 'command_service_object/helpers/failure_helper'
+require 'command_service_object/helpers/check_helper'
 require 'command_service_object/hooks'
 require 'virtus'
 

data/lib/command_service_object/helpers/check_helper.rb

@@ -0,0 +1,9 @@
+module CommandServiceObject
+  module CheckHelper
+    def check!(message, &block)
+      raise "No block given" unless block_given?
+
+      fail!(message) unless block.call
+    end
+  end
+end

data/lib/command_service_object/version.rb

@@ -1,3 +1,3 @@
 module CommandServiceObject
-  VERSION = '1.0.0'.freeze
+  VERSION = '1.1.0'.freeze
 end

data/lib/generators/service/install/templates/services/application_service.rb

@@ -17,12 +17,10 @@ class ApplicationService
         rollback if result.error.present?
       end
 
+      log_command
       result
     rescue StandardError => e
-      log_errors(e)
-      ServiceResult.new { raise e }
-    ensure
-      log_command
+      ServiceResult.new { raise e }      
     end
 
     def rollback
@@ -33,26 +31,38 @@ class ApplicationService
 
     private
 
-    def log_errors(err)
-      return if err.class.is_a?(CommandServiceObject::Failure)
-      # Add your logging logic
-      # ex:
-      #   Rollbar.error(err)
-    end
-
     def log_command
-      service_logger = ActiveSupport::TaggedLogging.new(ActiveSupport::Logger.new(Rails.root.join('log', 'services.log').to_s))
-      status = result.ok? ? 'success' : 'faild'
+      service_logger = ActiveSupport::Logger.new(Rails.root.join('log', 'services.log').to_s)
+      service_logger.formatter = proc do |severity, datetime, progname, msg|
+        "[#{msg['usecase']}] [#{msg['status']}] [#{datetime.to_s(:db)} ##{Process.pid}] -- #{msg['body']}\n"
+      end
+      log_body = result.ok? ? success_log : failure_log
 
-      service_logger.tagged(service_name, usecase_name, status) do
-        service_logger.info(
-          {
+      service_logger.info(log_body)
+    end
+
+    def success_log
+      {
+        usecase: "#{service_name}::#{usecase_name}",
+        status: 'success',
+        body: {
             cmd: cmd.as_json,
             result: result.value!.as_json,
             benchmark: bm.as_json
-          }.as_json
-        )
-      end
+          }
+      }.as_json
+    end
+
+    def failure_log
+      {
+        usecase: "#{service_name}::#{usecase_name}",
+        status: 'faild',
+        body: {
+          cmd: cmd.as_json,
+          error: result.error.to_s,
+          benchmark: bm.as_json
+        }
+      }.as_json
     end
 
     def usecase_class

data/lib/generators/service/install/templates/services/case_base.rb

@@ -5,6 +5,7 @@ require 'hutch'
 class CaseBase
   include CommandServiceObject::Hooks
   include CommandServiceObject::FailureHelper
+  include CommandServiceObject::CheckHelper
 
   attr_reader :cmd, :issuer, :right_name
   alias_attribute :payload, :cmd

data/lib/generators/service/usecase/templates/usecase.rb.erb

@@ -7,6 +7,10 @@ module <%= service_name.classify %>::Usecases
     # methods for Business logic.
     #
     def call
+      # Use check! for business logic validation,
+      # If the given block returns false then it will raise a business logic failure with the given message.
+      # Ex: check!("user should not have any active cards") { cmd.issuer.active_cards.empty? }
+
       replace_me
 
       output
@@ -31,7 +35,7 @@ module <%= service_name.classify %>::Usecases
     end
 
     def broadcast
-      Hutch.publish('<%= "#{service_name}_#{@usecase.underscore}" %>', subject: {}, action: '<%= "#{@usecase.underscore}" %>')
+      Hutch.publish('<%= service_name %>', action: '<%= "#{@usecase.underscore}" %>', subject: {})
     end
 
     private

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: command_service_object
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Adham EL-Deeb
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-09-23 00:00:00.000000000 Z
+date: 2020-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -79,14 +79,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -162,6 +162,7 @@ files:
 - lib/command_service_object.rb
 - lib/command_service_object/configuration.rb
 - lib/command_service_object/failure.rb
+- lib/command_service_object/helpers/check_helper.rb
 - lib/command_service_object/helpers/controller_helper.rb
 - lib/command_service_object/helpers/failure_helper.rb
 - lib/command_service_object/helpers/model_helper.rb