command_service_object 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aee49210439832ac6fdee2deec56da0f008a97421c7d47e91b2b41564e78df21
-  data.tar.gz: f1885b95dd77067e94d81f2e5b36c921fbbfb0c02b6ee5f95838f4c48c5f48ca
+  metadata.gz: e2217a3e17e64e6a5f301c65fa470347e767a4eefeb3d293558f46ef4c3979a2
+  data.tar.gz: 7d23e110c1d640ac4352e0c3b5a1d69ef97c8dbaf6b7ae46be3739ae33ce109e
 SHA512:
-  metadata.gz: 63cae3bcf9626c733aa494e3154c1b2e4800ff43fa26fa0f2b7d8a957e47d7cfe90161724010ccfcc735f6dc28975e49cde84d233d78b3886ba57e20f4db9a2b
-  data.tar.gz: 9c581f2cd67ae3128b9178e793164be2904fcc9cab624a8267738caebaa4b5e228565c0d817e562541be2f588ee618366de8968c9b0ee640d0f535dd9758c0f5
+  metadata.gz: 23d95efafcc1c6a36dc84b31d2593f81b1d10d1146a37b0f7d8c983b6a6a4f692491fbf1b395ba9aa8029964b7fd07dc44fe66e6f226dcbc1414a9531faa2761
+  data.tar.gz: 95e06753cce2f0360522bc2f3cb7cbba3eb21df3c83f1c1c279a5b2902fc5ea140ae66c935cf994da0ec854d61a2ff05629fed8c8e1b09c70a8a818de7c9b17e

data/README.md

@@ -1,8 +1,6 @@
 # CommandServiceObject
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/command_service_object`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Rails Generator for command service object.
 
 ## Installation
 
@@ -22,7 +20,80 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+    $ rails g service [service_name] [usecases usecases]
+### Example
+
+    $ rails g service user create update delete
+output
+
+```bash
+create  app/services/user_service
+create  app/services/user_service/usecases
+create  app/services/user_service/commands
+create  app/services/user_service/errors
+create  app/services/user_service/usecases/create.rb
+create  app/services/user_service/commands/create.rb
+create  app/services/user_service/usecases/update.rb
+create  app/services/user_service/commands/update.rb
+create  app/services/user_service/usecases/delete.rb
+create  app/services/user_service/commands/delete.rb
+```
+then you can edit command params
+> you can read [Virtus gem docs](https://github.com/solnic/virtus) for more info. 
+```ruby
+# app/services/user_service/commands/create.rb
+module UserService::Commands
+  class Create
+    include Virtus.model
+
+    attribute :name, String
+    attribute :phone, String
+    attribute :age, Integer
+  end
+end
+```
+and then add your business logic
+```ruby
+# app/services/user_service/usecases/create.rb
+module UserService::Usecases
+  class Create < ServiceBase
+    def call
+        # your business logic goes here
+        # keep call method clean by using private methods for Business logic
+        do_something
+        do_another_something
+    end
+
+    private
+
+    def do_something
+        # Business logic
+        # Don't catch errors ApplicationService will do that for you
+        raise Errors::CustomeError if ERROR
+    end
+
+    def do_another_something
+        # another business logic
+    end
+  end
+end
+```
+
+usage from controller
+```ruby
+class UsersController < ApplicationController
+  def create
+    cmd    = UserService::Commands::Create.new(user_params)
+    result = ApplicationService.call(cmd)
+
+    if result.ok?
+      render json: result.value!.as_json, status: 201
+    else
+      render json: { message: result.error }, status: 422
+    end
+  end
+end
+```
 
 ## Development
 
@@ -32,7 +103,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/command_service_object. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/adham90/command_service_object. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
@@ -40,4 +111,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the CommandServiceObject project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/command_service_object/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the CommandServiceObject project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/adham90/command_service_object/blob/master/CODE_OF_CONDUCT.md).

data/lib/command_service_object/version.rb

@@ -1,3 +1,3 @@
 module CommandServiceObject
-  VERSION = '0.1.1'.freeze
+  VERSION = '0.2.0'.freeze
 end

data/lib/generators/service/service_generator.rb

@@ -25,9 +25,11 @@ class ServiceGenerator < Rails::Generators::NamedBase
       @usecase = usecase
       u_path = "app/services/#{service_name}/usecases/#{usecase.underscore}.rb"
       c_path = "app/services/#{service_name}/commands/#{usecase.underscore}.rb"
+      e_path = "app/services/#{service_name}/errors/#{usecase.underscore}.rb"
 
       template 'usecase.rb.erb', u_path
       template 'command.rb.erb', c_path
+      template 'error.rb.erb',   e_path
     end
   end
 

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

@@ -2,6 +2,8 @@
 
 module <%= service_name.classify %>::Commands
   class <%= @usecase.classify %>
+    # You can read Virtus gem doc for more info.
+    # https://github.com/solnic/virtus
     include Virtus.model
 
     attribute :REPLACE_ME, String

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

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module <%= service_name.classify %>::Errors
+  class <%= @usecase.classify %> < StandardError
+    def initialize(msg = "custom message")
+      super(msg)
+    end
+  end
+end

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

@@ -2,7 +2,18 @@
 
 module <%= service_name.classify %>::Usecases
   class <%= @usecase.classify %> < ServiceBase
+    #
+    # Your business logic goes here, keep [call] method clean by using private
+    # methods for Business logic.
+    #
     def call
+      replace_me
     end
+
+    private
+
+      def replace_me
+        # [business logic]
+      end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: command_service_object
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Adham EL-Deeb
@@ -105,6 +105,7 @@ files:
 - lib/generators/service/USAGE
 - lib/generators/service/service_generator.rb
 - lib/generators/service/templates/command.rb.erb
+- lib/generators/service/templates/error.rb.erb
 - lib/generators/service/templates/usecase.rb.erb
 homepage: https://github.com/adham90/command_service_object
 licenses: