command_service_object 0.6.5 → 1.3.0

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

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module <%= service_name.classify %>::Entities
+  class <%= @entity %>
+    include Virtus.model(nullify_blank: true)
+
+    # attribute :name, String
+  end
+end

data/lib/generators/service/external/external_generator.rb

@@ -0,0 +1,46 @@
+require_relative '../setup/setup_generator.rb'
+require_relative '../helper'
+
+module Service
+  module Generators
+    class ExternalGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path('templates', __dir__)
+
+      argument :externals, type: :array, default: [], banner: 'external external'
+
+      def create_externals
+        invoke Service::Generators::SetupGenerator, [name]
+
+        externals.each do |m|
+          @external = m.classify
+          create_main(m)
+          create_test(m)
+        end
+      end
+
+      private
+
+      def create_main(m)
+        path = "#{service_path}/externals/#{m.underscore}.rb"
+        template 'external.rb.erb', path
+      end
+
+      def create_test(m)
+        path = "#{spec_path}/externals/#{m.underscore}_spec.rb"
+        template 'external_spec.rb.erb', path
+      end
+
+      def service_name
+        Service::Helper.service_name(name)
+      end
+
+      def service_path
+        Service::Helper.service_path(name)
+      end
+
+      def spec_path
+        Service::Helper.spec_path(name)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module <%= service_name.classify %>::Externals
+  module <%= @external %>
+    extend self
+
+    # Example
+    # def balance(id)
+    #   res = http.get("user/:id")
+    #   res_as_json = JSON.parse(res.body)
+    #
+    #   The return value should only be OpenStruct or Hash Object
+    #   OpenStruct.new(user_id: res_as_json[:id], balance: res_as_json[:balance])
+    # end
+  end
+end

data/lib/generators/service/external/templates/external_spec.rb.erb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe <%= service_name.classify %>::Externals::<%= @external %> do
+  # Example
+  # context "when success" do
+  #   it 'should be okay?' do
+  #     expect(subject.[method_name]).to eql([result])
+  #   end
+  # end
+end

data/lib/generators/service/helper.rb

@@ -0,0 +1,23 @@
+module Service
+  module Helper
+    extend self
+
+    def service_name(arg)
+      if arg.include? "/"
+        root = arg.split("/").first
+        sub_domain = arg.split("/").last
+        "#{root.underscore}_service/#{sub_domain}"
+      else
+        "#{arg.underscore}_service"
+      end
+    end
+
+    def service_path(arg)
+      "app/services/#{service_name(arg)}"
+    end
+
+    def spec_path(arg)
+      "spec/services/#{service_name(arg)}"
+    end
+  end
+end

data/lib/generators/service/install/templates/initializer.rb

@@ -1,3 +1,8 @@
+require 'hutch'
+
+Hutch::Logging.logger = Rails.logger
+Hutch.connect
+
 CommandServiceObject.configure do |config|
   # By setting the append_controller_helper to false you will need to
   # manually include the CommandServiceObject::ServiceControllerHelper

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

@@ -2,38 +2,79 @@
 
 class ApplicationService
   class << self
+    attr_reader :cmd, :usecase, :bm, :result
+
     def call(cmd)
-      raise Errors::InvalidCommand, cmd.class if cmd.invalid?
+      @cmd = cmd
+      @bm = Benchmark.measure do
+        raise Errors::InvalidCommand, cmd.class if cmd.invalid?
+
+        @usecase = usecase_class.new(cmd)
+        raise Errors::NotAuthorizedError, cmd.class unless usecase.allowed?
 
-      usecase = usecase_for(cmd).new(cmd)
-      raise Errors::NotAuthorizedError, cmd.class unless usecase.allowed?
+        @result = ServiceResult.new { usecase.call }
 
-      result = ServiceResult.new { usecase.call }
+        rollback if result.error.present?
+      end
 
-      rollback(usecase, result, cmd) if result.error.present?
+      log_command
       result
     rescue StandardError => e
-      log_errors(e, cmd)
-      ServiceResult.new { raise e }
+      ServiceResult.new { raise e }      
     end
 
-    def rollback(usecase, result, cmd)
+    def rollback
       usecase.rollback_micros
       usecase.rollback
-      log_errors(result.error, cmd)
+      log_errors(result.error)
     end
 
-    def log_errors(err, _cmd)
-      return if err.class.is_a?(CommandServiceObject::Failure)
-      # Add your logging logic
-      # ex:
-      #   Rollbar.error(err)
+    private
+
+    def log_command
+      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.info(log_body)
     end
 
-    private
+    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
 
-    def usecase_for(cmd)
+    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
       cmd.class.name.gsub('Commands', 'Usecases').constantize
     end
+
+    def service_name
+      cmd.class.name.split('::').first
+    end
+
+    def usecase_name
+      cmd.class.name.split('::').last
+    end
   end
 end

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

@@ -1,8 +1,11 @@
 # frozen_string_literal: true
 
+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/install/templates/services/listener_base.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'hutch'
+
+class ListenerBase < SimpleDelegator
+  include Hutch::Consumer
+end

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

@@ -0,0 +1,55 @@
+require "active_record"
+
+class QueryBase
+  RelationRequired = Class.new(StandardError)
+
+  def initialize(*args)
+    @options = args.extract_options!
+    @relation = args.first || base_relation
+
+    if relation.nil?
+      raise(
+        RelationRequired,
+        "Queries require a base relation defined. Use .queries method to define relation."
+      )
+    elsif !relation.is_a?(ActiveRecord::Relation)
+      raise(
+        RelationRequired,
+        "Queries accept only ActiveRecord::Relation as input"
+      )
+    end
+  end
+
+  def self.call(*args)
+    new(*args).query
+  end
+
+  def self.queries(subject)
+    self.base_relation = subject
+  end
+
+  def base_relation
+    return nil if self.class.base_relation.nil?
+
+    if self.class.base_relation.is_a?(ActiveRecord::Relation)
+      self.class.base_relation
+    elsif self.class.base_relation < ActiveRecord::Base
+      self.class.base_relation.all
+    end
+  end
+
+  private
+
+  class << self
+    attr_accessor :base_relation
+  end
+
+  attr_reader :relation, :options
+
+  def query
+    raise(
+      NotImplementedError,
+      "You need to implement #query method which returns ActiveRecord::Relation object"
+    )
+  end
+end

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

@@ -0,0 +1,4 @@
+class ValueObjectBase
+  include ActiveModel::Validations
+  include Virtus.value_object
+end

data/lib/generators/service/listener/listener_generator.rb

@@ -0,0 +1,39 @@
+require_relative '../setup/setup_generator.rb'
+require_relative '../helper'
+
+module Service
+  module Generators
+    class ListenerGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path('templates', __dir__)
+
+      argument :listeners, type: :array, default: [], banner: 'Listener Listener'
+
+      def setup
+        invoke Service::Generators::SetupGenerator, [name]
+      end
+
+      def create_micros
+        listeners.each do |m|
+          @listener = m.classify
+
+          path = "#{service_path}/listeners/#{m.underscore}.rb"
+          template 'listener.rb.erb', path
+        end
+      end
+
+      private
+
+      def service_name
+        Service::Helper.service_name(name)
+      end
+
+      def service_path
+        Service::Helper.service_path(name)
+      end
+
+      def spec_path
+        Service::Helper.spec_path(name)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module <%= service_name.classify %>::Listeners
+  class <%= @listener %> < ListenerBase
+    consume 'channel name'
+
+    def process(message)
+      # Logic
+    end
+  end
+end

data/lib/generators/service/micro/micro_generator.rb

@@ -1,4 +1,5 @@
 require_relative '../setup/setup_generator.rb'
+require_relative '../helper'
 
 module Service
   module Generators
@@ -15,7 +16,7 @@ module Service
         micros.each do |m|
           @micro = m.classify
 
-          path = "app/services/#{service_name}/usecases/micros/#{m.underscore}.rb"
+          path = "#{service_path}/usecases/micros/#{m.underscore}.rb"
           template 'micro.rb.erb', path
         end
       end
@@ -23,7 +24,15 @@ module Service
       private
 
       def service_name
-        "#{name.underscore}_service"
+        Service::Helper.service_name(name)
+      end
+
+      def service_path
+        Service::Helper.service_path(name)
+      end
+
+      def spec_path
+        Service::Helper.spec_path(name)
       end
     end
   end

data/lib/generators/service/query/USAGE

@@ -0,0 +1,8 @@
+Description:
+    This will generatet query_object under [service_name]/queries
+
+Example:
+    rails generate service:query [service name] [query name]
+
+    This will create:
+        services/[service_name]/queries/[query_name].rb

data/lib/generators/service/query/query_generator.rb

@@ -0,0 +1,39 @@
+require_relative '../setup/setup_generator.rb'
+require_relative '../helper'
+
+module Service
+  module Generators
+    class QueryGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path('templates', __dir__)
+
+      argument :queries, type: :array, default: [], banner: 'query query'
+
+      def setup
+        invoke Service::Generators::SetupGenerator, [name]
+      end
+
+      def create_queries
+        queries.each do |m|
+          @query = m.classify
+
+          path = "#{service_path}/queries/#{m.underscore}.rb"
+          template 'query.rb.erb', path
+        end
+      end
+
+      private
+
+      def service_name
+        Service::Helper.service_name(name)
+      end
+
+      def service_path
+        Service::Helper.service_path(name)
+      end
+
+      def spec_path
+        Service::Helper.spec_path(name)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module <%= service_name.classify %>::Queries
+  class <%= @query %> < QueryBase
+    # queries UserService::Models::User
+
+    # Example
+    # def query
+    #   map_rows(relation.where(phone: options.fetch(:phone)))
+    # end
+
+    private
+
+    # def map_rows(rows)
+    #   rows.map { |r| UserService::Views::User.new(r.as_json).to_hash }
+    # end
+
+    # def map_row(r)
+    #   UserService::Views::User.new(r.as_json).to_hash
+    # end
+  end
+end