Create base service and base custom object (#26)

Author: nejdetkadir

Gemfile

@@ -95,15 +95,24 @@ gem 'kaminari', '~> 1.2', '>= 1.2.2'
 # Useful, common monads in idiomatic Ruby [https://github.com/dry-rb/dry-monads]
 gem 'dry-monads', '~> 1.4'
 
+# A simple validation library [https://github.com/dry-rb/dry-validation]
+gem 'dry-validation', '~> 1.6'
+
+# Typed structs and value objects [https://github.com/dry-rb/dry-struct]
+gem 'dry-struct', '~> 1.4'
+
+# Type system for Ruby supporting coercions, constraints and complex types like structs, value objects, enums etc [https://github.com/dry-rb/dry-types]
+gem 'dry-types', '~> 1.5', '>= 1.5.1'
+
+# DSL for declaring params and options of the initializer [https://github.com/dry-rb/dry-initializer]
+gem 'dry-initializer', '~> 3.1', '>= 3.1.1'
+
 # Form object decoupled from models with validation, population and presentation [https://github.com/trailblazer/reform]
 gem 'reform', '~> 2.6'
 
 # Automatically load and include all common Rails form features. [https://github.com/trailblazer/reform-rails]
 gem 'reform-rails', '~> 0.2.2'
 
-# A simple validation library [https://github.com/dry-rb/dry-validation]
-gem 'dry-validation', '~> 1.6'
-
 # Flexible authentication solution for Rails with Warden [https://github.com/heartcombo/devise]
 gem 'devise', '~> 4.8', '>= 4.8.1'
 

Gemfile.lock

@@ -133,6 +133,10 @@ GEM
       dry-initializer (~> 3.0)
       dry-logic (~> 1.0)
       dry-types (~> 1.5)
+    dry-struct (1.4.0)
+      dry-core (~> 0.5, >= 0.5)
+      dry-types (~> 1.5)
+      ice_nine (~> 0.11)
     dry-types (1.5.1)
       concurrent-ruby (~> 1.0)
       dry-container (~> 0.3)
@@ -155,6 +159,7 @@ GEM
       activesupport (>= 5.0)
     i18n (1.9.1)
       concurrent-ruby (~> 1.0)
+    ice_nine (0.11.2)
     io-console (0.5.11)
     io-wait (0.2.1)
     irb (1.4.1)
@@ -326,7 +331,10 @@ DEPENDENCIES
   debug
   devise (~> 4.8, >= 4.8.1)
   doorkeeper (~> 5.5, >= 5.5.4)
+  dry-initializer (~> 3.1, >= 3.1.1)
   dry-monads (~> 1.4)
+  dry-struct (~> 1.4)
+  dry-types (~> 1.5, >= 1.5.1)
   dry-validation (~> 1.6)
   factory_bot_rails (~> 6.2)
   faker!

app/lib/custom_objects/base.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'dry-struct'
+
+module CustomObjects
+  class Base < Dry::Struct
+    transform_keys(&:to_sym)
+  end
+end

app/lib/types.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'dry-types'
+
+module Types
+  include Dry.Types()
+end

app/services/base.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'dry/monads/all'
+require 'dry-initializer'
+
+class Base
+  extend Dry::Initializer
+end

app/services/registration_service/register.rb

@@ -1,16 +1,10 @@
 # frozen_string_literal: true
 
-require 'dry/monads/do'
-
-class RegistrationService::Register
+class RegistrationService::Register < Base
   include Dry::Monads[:result]
   include Dry::Monads::Do.for(:call)
 
-  attr_reader :params
-
-  def initialize(params:)
-    @params = params
-  end
+  option :params, type: Types::Hash
 
   def call
     ActiveRecord::Base.transaction(requires_new: true) do

app/services/user_service/create.rb

@@ -1,16 +1,10 @@
 # frozen_string_literal: true
 
-require 'dry/monads/do'
-
-class UserService::Create
+class UserService::Create < Base
   include Dry::Monads[:result]
   include Dry::Monads::Do.for(:call)
 
-  attr_reader :params
-
-  def initialize(params:)
-    @params = params
-  end
+  option :params, type: Types::Hash
 
   def call
     user = User.new(params)

lib/generators/service/templates/create.html.erb

@@ -1,16 +1,10 @@
 # frozen_string_literal: true
 
-require "dry/monads/do"
-
-class <%= service_class_name %>::Create
+class <%= service_class_name %>::Create < Base
   include Dry::Monads[:result]
   include Dry::Monads::Do.for(:call)
 
-  attr_reader :params
-
-  def initialize(params:)
-    @params = params
-  end
+  option :params, type: Types::Hash
 
   def call
     ActiveRecord::Base.transaction(requires_new: true) do

lib/generators/service/templates/destroy.html.erb

@@ -1,16 +1,10 @@
 # frozen_string_literal: true
 
-require "dry/monads/do"
-
-class <%= service_class_name %>::Destroy
+class <%= service_class_name %>::Destroy < Base
   include Dry::Monads[:result]
   include Dry::Monads::Do.for(:call)
 
-  attr_reader :record
-
-  def initialize(record:)
-    @record = record
-  end
+  option :record, type: Types.Constructor(Record)
 
   def call
     ActiveRecord::Base.transaction(requires_new: true) do
@@ -28,3 +22,4 @@ class <%= service_class_name %>::Destroy
     end
   end
 end
+

lib/generators/service/templates/list.html.erb

@@ -1,12 +1,13 @@
 # frozen_string_literal: true
 
-require "dry/monads/do"
-
-class <%= service_class_name %>::List
+class <%= service_class_name %>::List < Base
   include Dry::Monads[:result]
   include Dry::Monads::Do.for(:call)
 
-  def call(pagination: nil, query: nil)
+  option :pagination, type: Types.Constructor(ParameterObject::Pagination)
+  option :query, type: Types.Constructor(ParameterObject::Query)
+
+  def call
     Success(records.ransack(query.query).result.page(pagination.page).per(pagination.per_page))
   end
 end

lib/generators/service/templates/update.html.erb

@@ -1,17 +1,11 @@
 # frozen_string_literal: true
 
-require "dry/monads/do"
-
-class <%= service_class_name %>::Update
+class <%= service_class_name %>::Update < Base
   include Dry::Monads[:result]
   include Dry::Monads::Do.for(:call)
 
-  attr_reader :params, :record
-
-  def initialize(params:, record:)
-    @params = params
-    @record = record
-  end
+  option :record, type: Types.Constructor(Record)
+  option :params, type: Types::Hash
 
   def call
     ActiveRecord::Base.transaction(requires_new: true) do