command_service_object 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ad47cc35afbb96a172b7acf5c777259ae5470349d97ac7250a20635d5e7f093
-  data.tar.gz: 260996594ae69fb775ae51781673f690ad42b0933a8f6217715ca14e1cfc037d
+  metadata.gz: 26e3e53d35598d601bf546fc5046c751a0572dd6c936b8e2ded9acfa131699b9
+  data.tar.gz: 93bedb8abb7dd172b52190a51a0978ff963ff812afe5da51f8bb3422d79b8b8c
 SHA512:
-  metadata.gz: f0f4becc387a2436a7e9ed0f1f8c9c894c31d1224c26342539ec71440ee37124f492a89d2a7c784d4fbb28e6cc24f813cbeb7e5b45df652d3c7d9786b775dd21
-  data.tar.gz: ba231a12a36a194c614f19c5495adfdb17c7dad0150cd07f1edd021e745b8599e9e814d69d455150091f4bcabfc7c4187d06f36a590f93995fc4ee97dd3c20a6
+  metadata.gz: b5f85e59bd82b841981354719f59fb7e6062887e3dffe42946b18461cfaa5df8e8fcc4d7a223d0436f5a1164be8510dc065aac1c6785b434b4dc3884300a64c5
+  data.tar.gz: 2e368552a3f24ad456a5cbcf3f255a7b7f335765a5ca6c57f162188300cd1fada63aba45396ef648b958ce90eaf898f67ce95f97721ae8a27f41dfd31c6a92e3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    command_service_object (0.3.1)
+    command_service_object (0.4.0)
       virtus (~> 1.0.5)
 
 GEM

data/README.md

@@ -2,6 +2,22 @@
 
 Rails Generator for command service object.
 
+### Theory:
+[Command Design Pattern](https://en.wikipedia.org/wiki/Command_pattern) consists of `Command Object` and `Service Object` (Executor), Command object is responsible for containing `Client` requests and run input validations on it to ensure that the request is valid and set default values, then `Service Object` applies the business logic on that command.
+
+### Implementation:
+Service consists of several objects { `Command Object` ` Usecase Object`   And `Error Object` (business logic error) }.
+
+- **Command Object:** the object that responsible for containing `Client` requests and run input validations it's implemented using [Virtus](https://github.com/solnic/virtus) gem and can use `activerecord` for validations and it's existed under `commands` dir.
+- **Usecase Object:** this object responsible for executing the business logic, Every `usecase` should execute one command type only so that command name should be the same as usecase object name, usecase object existed under 'usecases` dir.
+- **Error Object:** business logic errors existed user `errors` dir inside the service dir.
+
+#### 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.
+
+> You can check if the result successful or not by using `ok?` method. 
+
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/command_service_object/version.rb

@@ -1,3 +1,3 @@
 module CommandServiceObject
-  VERSION = '0.3.2'.freeze
+  VERSION = '0.4.0'.freeze
 end

data/lib/generators/service/service_generator.rb

@@ -22,6 +22,22 @@ class ServiceGenerator < Rails::Generators::NamedBase
     directory 'base', 'app/services'
   end
 
+  def add_controller_helper_to_application_controller
+    application_controller_path = 'app/controllers/application_controller.rb'
+
+    line = File.readlines(application_controller_path).select do |li|
+      li =~ /class ApplicationController </
+    end.first
+
+    inject_into_file application_controller_path, after: line do
+      "  include ServiceControllerHelper\n"
+    end
+  end
+
+  def add_virtus_gem_to_gemfile
+    gem 'virtus'
+  end
+
   def create_service_dir
     return if File.exist?("app/services/#{service_name}")
 

data/lib/generators/service/templates/base/service_controller_helper.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module ServiceControllerHelper
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  def command(service: nil, usecase: action_name)
+    service_name = service || self.class.default_service || controller_name
+
+    "#{service_name}/commands/#{usecase}".camelize.constantize
+  end
+
+  def execute(cmd)
+    ApplicationService.call(cmd)
+  end
+
+  module ClassMethods
+    @default_service = nil
+
+    def default_service(service_name = nil)
+      @default_service ||= service_name
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: command_service_object
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Adham EL-Deeb
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-11 00:00:00.000000000 Z
+date: 2019-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -126,6 +126,7 @@ files:
 - lib/generators/service/service_generator.rb
 - lib/generators/service/templates/base/application_service.rb
 - lib/generators/service/templates/base/service_base.rb
+- lib/generators/service/templates/base/service_controller_helper.rb
 - lib/generators/service/templates/base/service_result.rb
 - lib/generators/service/templates/command.rb.erb
 - lib/generators/service/templates/error.rb.erb