command_service_object 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb7c2967cb51ce592d31d4b34f08175449af0784d09a5a99d8d5ebd34cc94dd5
-  data.tar.gz: f8ea42c732274054c729ded305f92f38de7b162cc959d96efa1d9b8c054cf982
+  metadata.gz: 4039a3dbbda00504a1bcecf192eeadbc2d713421a1a3abcbea48b42776a1c556
+  data.tar.gz: eb5e934d9f3ec8ef0d292d7f82b8330c334e6f595da77eee4519e9295b320786
 SHA512:
-  metadata.gz: e3cfa831018cb98fe78a4118266a8059c336c771571b891d07cbac6f7015b6d6857cbb2c2afd22543a9f4b41dd86bcbd1e5eb368ca6b7103d3e5aac4434b6361
-  data.tar.gz: 60e06975870a9557b169e2ad29e86b964f8d7e4a2ecf0a5d2886e4a462d4461280e50f010468e70045ca882e7b6fa81f1dae4f12e15d3b3f3101d0c5e2fcb3e4
+  metadata.gz: 946455406a4ce0008936b985daa3d7c586bf5aa34d80ff3d5a19cba568bd2ace83fb2fb3036e3a670491ce4d1a9e345fa262c497f49df4a2109c832fd5b8e1dd
+  data.tar.gz: 891e869e8f625a7d865462d388b4b86fd7d14bac5e6184710bf179dfdfe78234aaa8e39c92e46ab7ceb16584092f97b636f03b2d0120a73c1c7dd67defdc3023

data/lib/command_service_object/version.rb

@@ -1,3 +1,3 @@
 module CommandServiceObject
-  VERSION = '0.3.0'.freeze
+  VERSION = '0.3.1'.freeze
 end

data/lib/generators/service/service_generator.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'rubygems'
 require 'rails/generators/model_helpers'
 
 class ServiceGenerator < Rails::Generators::NamedBase
@@ -8,15 +9,17 @@ class ServiceGenerator < Rails::Generators::NamedBase
   source_root File.expand_path('templates', __dir__)
 
   argument :usecases, type: :array, default: [], banner: 'usecase usecase'
-  class_option :skip_command, type: :boolean, default: false,
+  class_option :skip_command, type: :boolean, default: false, aliases: '-C',
                               desc: 'skip command file generation'
-  class_option :skip_error, type: :boolean, default: false,
+  class_option :skip_error, type: :boolean, default: false, aliases: '-E',
                             desc: 'skip error file generation'
+  class_option :skip_test, type: :boolean, default: false, aliases: '-T',
+                           desc: 'skip test file generation'
 
   def create_base_dir
     return if File.exist?('app/services')
 
-    directory 'services', 'app/services'
+    directory 'base', 'app/services'
   end
 
   def create_service_dir
@@ -28,21 +31,67 @@ class ServiceGenerator < Rails::Generators::NamedBase
     empty_directory("app/services/#{service_name}/errors")
   end
 
-  def create_usecases
+  def generate_usecases
     usecases.each do |usecase|
-      @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 unless options.skip_command?
-      template 'error.rb.erb',   e_path unless options.skip_error?
+      generate_usecase(usecase)
+      generate_command(usecase)
+      generate_error(usecase)
+      generate_test(usecase)
     end
   end
 
   private
 
+  def generate_usecase(usecase)
+    @usecase = usecase.classify
+    path = "app/services/#{service_name}/usecases/#{usecase.underscore}.rb"
+    template 'usecase.rb.erb', path
+  end
+
+  def generate_command(command)
+    @command = command.classify
+    path = "app/services/#{service_name}/commands/#{command.underscore}.rb"
+    template 'command.rb.erb', path unless options.skip_command?
+  end
+
+  def generate_error(error)
+    @error = error.classify
+    path = "app/services/#{service_name}/errors/#{error.underscore}.rb"
+    template 'error.rb.erb', path unless options.skip_error?
+  end
+
+  def generate_test(test)
+    return if options.skip_test?
+
+    if defined?(Minitest)
+      empty_directory('test/services')
+      generate_minitest_test_files(test)
+    elsif defined?(RSpec)
+      empty_directory('spec/services')
+      generate_rspec_test_files(test)
+    end
+  end
+
+  def generate_minitest_test_files(test)
+    dir = "test/services/#{service_name}"
+    empty_directory(dir)
+
+    @test = test.classify
+    path  = "#{dir}/#{test.underscore}_test.rb"
+
+    template 'minitest.rb.erb', path
+  end
+
+  def generate_rspec_test_files(test)
+    dir = "spec/services/#{service_name}"
+    empty_directory(dir)
+
+    @test = test.classify
+    path  = "#{dir}/#{test.underscore}_spec.rb"
+
+    template 'rspec.rb.erb', path
+  end
+
   def service_name
     "#{name.underscore}_service"
   end

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

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class ApplicationService < ServiceBase
+  def call
+    ServiceResult.new do
+      cmd.class.name.gsub('Commands', 'Usecases').constantize.call(cmd)
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+class ServiceBase
+  attr_reader :cmd
+
+  def initialize(command)
+    @cmd = command
+  end
+
+  def self.call(command)
+    raise Errors::InvalidCommand, command.class if command.invalid?
+
+    new(command).call
+  end
+end

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

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+class ServiceResult
+  attr_reader :error
+
+  def initialize
+    @value = yield
+    @error = nil
+  rescue StandardError => e
+    @error = e
+  end
+
+  def to_s
+    if ok?
+      format('#<Result:0x%x value: %s>', object_id, @value.inspect)
+    else
+      format('#<Result:0x%x error: %s>', object_id, @error.inspect)
+    end
+  end
+
+  alias inspect to_s
+
+  def then
+    return self unless ok?
+
+    result = yield(@value)
+    raise TypeError, 'block invoked in Result#then did not return Result' unless result.is_a?(Result)
+
+    result
+  end
+
+  def rescue
+    return self if ok?
+
+    result = yield(@error)
+    raise TypeError, 'block invoked in Result#rescue did not return Result' unless result.is_a?(Result)
+
+    result
+  end
+
+  def value
+    raise ArgumentError, 'must provide a block to Result#value to be invoked in case of error' unless block_given?
+
+    return @value if ok?
+
+    yield(@error)
+  end
+
+  def value!
+    raise @error unless ok?
+
+    @value
+  end
+
+  def ok?
+    !@error
+  end
+
+  def self.error(err)
+    result = allocate
+    result.instance_variable_set(:@error, err)
+    result
+  end
+end

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module <%= service_name.classify %>::Commands
-  class <%= @usecase.classify %>
+  class <%= @command %>
     # You can read Virtus gem doc for more info.
     # https://github.com/solnic/virtus
     include Virtus.model

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

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

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

@@ -0,0 +1 @@
+# frozen_string_literal: true

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

@@ -0,0 +1 @@
+# frozen_string_literal: true

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

@@ -1,17 +1,24 @@
 # frozen_string_literal: true
 
 module <%= service_name.classify %>::Usecases
-  class <%= @usecase.classify %> < ServiceBase
+  class <%= @usecase %> < ServiceBase
     #
     # Your business logic goes here, keep [call] method clean by using private
     # methods for Business logic.
     #
     def call
-      replace_me
+      begin
+        replace_me
+      rescue => e
+        rollback
+        raise e
+      end
     end
 
     private
 
+      def rollback;end
+
       def replace_me
         # [business logic]
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: command_service_object
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Adham EL-Deeb
@@ -104,8 +104,13 @@ files:
 - lib/command_service_object/version.rb
 - lib/generators/service/USAGE
 - 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_result.rb
 - lib/generators/service/templates/command.rb.erb
 - lib/generators/service/templates/error.rb.erb
+- lib/generators/service/templates/minitest.rb.erb
+- lib/generators/service/templates/rspec.rb.erb
 - lib/generators/service/templates/usecase.rb.erb
 homepage: https://github.com/adham90/command_service_object
 licenses: