better_service 2.0.0 → 2.1.0

data/lib/generators/serviceable/templates/show_service.rb.tt

@@ -1,14 +1,9 @@
 # frozen_string_literal: true
 
 <% module_namespacing do -%>
-class <%= class_name %>::ShowService < BetterService::Services::ShowService
-  # Optional: Use a presenter to format response data
-  # Generate with: rails generate better_service:presenter <%= class_name %>
-  #
-  # presenter <%= class_name %>Presenter
-  # presenter_options do
-  #   { current_user: user }
-  # end
+class <%= class_name %>::ShowService < <%= parent_class %>
+  # Action name for metadata
+  performed_action :showed
 
   # Schema for validating params
   schema do
@@ -17,39 +12,16 @@ class <%= class_name %>::ShowService < BetterService::Services::ShowService
 
   # Phase 1: Search - Load the resource
   search_with do
-    { resource: user.<%= plural_table_name %>.find(params[:id]) }
+<% if using_base_service? -%>
+    { object: <%= singular_table_name %>_repository.find(params[:id]) }
+<% else -%>
+    { object: user.<%= plural_table_name %>.find(params[:id]) }
+<% end -%>
   end
 
-  # Phase 2: Process - Transform data (optional)
-  # process_with do |data|
-  #   data
-  # end
-
-  # Phase 4: Respond - Format response (optional override)
-  # Uses I18n message helper with fallback to default messages
-  #
-  # To customize messages, create config/locales/<%= plural_table_name %>_services.en.yml:
-  #   en:
-  #     <%= plural_table_name %>:
-  #       services:
-  #         show:
-  #           success: "<%= human_name %> loaded successfully!"
-  #
-  # Then configure namespace: messages_namespace :<%= plural_table_name %>
+  # Phase 4: Respond - Format response
   respond_with do |data|
-    success_result(message("show.success"), data)
+    success_for(data[:object], message("show.success"))
   end
-
-  # Phase 5: Viewer - UI configuration (optional)
-  # viewer do |processed, transformed, result|
-  #   {
-  #     page_title: "<%= human_name %> ##{result[:resource].id}",
-  #     breadcrumbs: [
-  #       { label: "Home", url: "/" },
-  #       { label: "<%= plural_table_name.titleize %>", url: "/<%= plural_table_name %>" },
-  #       { label: "Show", url: "#" }
-  #     ]
-  #   }
-  # end
 end
 <% end -%>

data/lib/generators/serviceable/templates/update_service.rb.tt

@@ -1,10 +1,12 @@
 # frozen_string_literal: true
 
 <% module_namespacing do -%>
-class <%= class_name %>::UpdateService < BetterService::Services::UpdateService
-  # Database transactions are ENABLED by default for update operations
-  # The process block will automatically run inside a transaction
-  # To disable: with_transaction false
+class <%= class_name %>::UpdateService < <%= parent_class %>
+  # Action name for metadata
+  performed_action :updated
+
+  # Enable transaction wrapping
+  with_transaction true
 
   # Schema for validating params
   schema do
@@ -12,49 +14,33 @@ class <%= class_name %>::UpdateService < BetterService::Services::UpdateService
     # Add your optional attributes here
   end
 
-  # Authorization (optional) - Runs BEFORE search phase
-  # Uncomment and customize for your needs:
-  #
-  # authorize_with do
-  #   # Example 1: Simple role check
-  #   user.admin?
-  #
-  #   # Example 2: Resource ownership check
-  #   <%= file_name %> = <%= class_name %>.find(params[:id])
-  #   <%= file_name %>.user_id == user.id
-  #
-  #   # Example 3: Pundit integration
-  #   <%= class_name %>Policy.new(user, <%= class_name %>.find(params[:id])).update?
-  #
-  #   # Example 4: CanCanCan integration
-  #   Ability.new(user).can?(:update, :<%= file_name %>)
-  # end
-
   # Phase 1: Search - Load the resource
   search_with do
-    { resource: user.<%= plural_table_name %>.find(params[:id]) }
+<% if using_base_service? -%>
+    { object: <%= singular_table_name %>_repository.find(params[:id]) }
+<% else -%>
+    { object: user.<%= plural_table_name %>.find(params[:id]) }
+<% end -%>
   end
 
   # Phase 2: Process - Update the resource (runs in transaction)
+  # Uses update (not update!) to allow graceful validation handling
   process_with do |data|
-    <%= file_name %> = data[:resource]
-    <%= file_name %>.update!(params.except(:id))
-    { resource: <%= file_name %> }
+    record = data[:object]
+
+    if record.update(params.except(:id))
+      { object: record }
+    else
+      failure_for(record)
+    end
   end
 
-  # Phase 4: Respond - Format response (optional override)
-  # Uses I18n message helper with fallback to default messages
-  #
-  # To customize messages, create config/locales/<%= plural_table_name %>_services.en.yml:
-  #   en:
-  #     <%= plural_table_name %>:
-  #       services:
-  #         update:
-  #           success: "<%= human_name %> updated successfully!"
-  #
-  # Then configure namespace: messages_namespace :<%= plural_table_name %>
+  # Phase 4: Respond - Format response
   respond_with do |data|
-    success_result(message("update.success"), data)
+    # Pass through failure responses
+    return data if data[:success] == false
+
+    success_for(data[:object], message("update.success"))
   end
 end
 <% end -%>

data/lib/generators/serviceable/update_generator.rb

@@ -9,6 +9,9 @@ module Serviceable
 
       desc "Generate an Update service for modifying resources"
 
+      class_option :base_class, type: :string, default: nil,
+                   desc: "Custom base class to inherit from (e.g., Articles::BaseService)"
+
       def create_service_file
         template "update_service.rb.tt", File.join("app/services", class_path, "#{file_name}/update_service.rb")
       end
@@ -22,6 +25,14 @@ module Serviceable
       def service_class_name
         "#{class_name}::UpdateService"
       end
+
+      def parent_class
+        options[:base_class] || "BetterService::Services::Base"
+      end
+
+      def using_base_service?
+        options[:base_class].present?
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: better_service
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - alessiobussolari
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-11-28 00:00:00.000000000 Z
+date: 2025-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -75,7 +75,7 @@ dependencies:
 description: A powerful DSL-based framework for building Service Objects in Rails
   with built-in support for validation, caching, presenters, and more.
 email:
-- alessio@cosmic.tech
+- alessio.bussolari@pandev.it
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -95,7 +95,6 @@ files:
 - lib/better_service/concerns/serviceable/repository_aware.rb
 - lib/better_service/concerns/serviceable/transactional.rb
 - lib/better_service/concerns/serviceable/validatable.rb
-- lib/better_service/concerns/serviceable/viewable.rb
 - lib/better_service/concerns/workflowable.rb
 - lib/better_service/concerns/workflowable/callbacks.rb
 - lib/better_service/concerns/workflowable/context.rb
@@ -110,6 +109,7 @@ files:
 - lib/better_service/errors/runtime/authorization_error.rb
 - lib/better_service/errors/runtime/database_error.rb
 - lib/better_service/errors/runtime/execution_error.rb
+- lib/better_service/errors/runtime/invalid_result_error.rb
 - lib/better_service/errors/runtime/resource_not_found_error.rb
 - lib/better_service/errors/runtime/runtime_error.rb
 - lib/better_service/errors/runtime/transaction_error.rb
@@ -125,13 +125,8 @@ files:
 - lib/better_service/presenter.rb
 - lib/better_service/railtie.rb
 - lib/better_service/repository/base_repository.rb
-- lib/better_service/services/action_service.rb
+- lib/better_service/result.rb
 - lib/better_service/services/base.rb
-- lib/better_service/services/create_service.rb
-- lib/better_service/services/destroy_service.rb
-- lib/better_service/services/index_service.rb
-- lib/better_service/services/show_service.rb
-- lib/better_service/services/update_service.rb
 - lib/better_service/subscribers/log_subscriber.rb
 - lib/better_service/subscribers/stats_subscriber.rb
 - lib/better_service/version.rb
@@ -152,15 +147,21 @@ files:
 - lib/generators/better_service/templates/presenter.rb.tt
 - lib/generators/better_service/templates/presenter_test.rb.tt
 - lib/generators/serviceable/action_generator.rb
+- lib/generators/serviceable/base_generator.rb
 - lib/generators/serviceable/create_generator.rb
 - lib/generators/serviceable/destroy_generator.rb
 - lib/generators/serviceable/index_generator.rb
 - lib/generators/serviceable/scaffold_generator.rb
 - lib/generators/serviceable/show_generator.rb
 - lib/generators/serviceable/templates/action_service.rb.tt
+- lib/generators/serviceable/templates/base_locale.en.yml.tt
+- lib/generators/serviceable/templates/base_service.rb.tt
+- lib/generators/serviceable/templates/base_service_test.rb.tt
 - lib/generators/serviceable/templates/create_service.rb.tt
 - lib/generators/serviceable/templates/destroy_service.rb.tt
 - lib/generators/serviceable/templates/index_service.rb.tt
+- lib/generators/serviceable/templates/repository.rb.tt
+- lib/generators/serviceable/templates/repository_test.rb.tt
 - lib/generators/serviceable/templates/service_test.rb.tt
 - lib/generators/serviceable/templates/show_service.rb.tt
 - lib/generators/serviceable/templates/update_service.rb.tt
@@ -185,14 +186,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: DSL-based Service Objects framework for Rails

data/lib/better_service/concerns/serviceable/viewable.rb

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-module BetterService
-  module Concerns
-    module Serviceable
-    module Viewable
-      extend ActiveSupport::Concern
-
-      included do
-        class_attribute :_viewer_enabled, default: false
-        class_attribute :_viewer_block, default: nil
-      end
-
-      class_methods do
-        def viewer(enabled = true, &block)
-          self._viewer_enabled = enabled
-          self._viewer_block = block if block_given?
-        end
-      end
-
-      private
-
-      def viewer_enabled?
-        self.class._viewer_enabled && self.class._viewer_block.present?
-      end
-
-      def execute_viewer(processed, transformed, result)
-        instance_exec(processed, transformed, result, &self.class._viewer_block)
-      end
-    end
-    end
-  end
-end

data/lib/better_service/services/action_service.rb

@@ -1,60 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "base"
-
-module BetterService
-  module Services
-  # ActionService - Specialized service for custom actions/transitions
-  #
-  # Returns: { resource: {}, metadata: { action: :custom_action_name } }
-  #
-  # Example:
-  #   class Orders::ConfirmService < BetterService::Services::ActionService
-  #     action_name :confirmed  # Sets metadata action
-  #
-  #     schema do
-  #       required(:id).filled(:integer)
-  #     end
-  #
-  #     search_with do
-  #       { resource: user.orders.find(params[:id]) }
-  #     end
-  #
-  #     process_with do |data|
-  #       order = data[:resource]
-  #       order.update!(status: 'confirmed', confirmed_at: Time.current)
-  #       { resource: order }
-  #     end
-  #   end
-  class ActionService < Services::Base
-    # Default action_name to nil - subclasses MUST set it
-    self._action_name = nil
-
-    def self.action_name(name)
-      self._action_name = name.to_sym
-    end
-
-    # Default schema - requires id parameter for actions
-    schema do
-      required(:id).filled
-    end
-
-    private
-
-    # Override respond to ensure resource key is present
-    def respond(data)
-      # Get base result (from custom respond_with block or default)
-      if self.class._respond_block
-        result = instance_exec(data, &self.class._respond_block)
-      else
-        result = success_result("Action completed successfully", data)
-      end
-
-      # Ensure resource key exists (default to nil if not provided)
-      result[:resource] ||= nil
-
-      result
-    end
-  end
-  end
-end

data/lib/better_service/services/create_service.rb

@@ -1,63 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "base"
-
-module BetterService
-  module Services
-  # CreateService - Specialized service for creating new resources
-  #
-  # Returns: { resource: {}, metadata: { action: :created } }
-  #
-  # Example:
-  #   class Orders::CreateService < BetterService::Services::CreateService
-  #     schema do
-  #       required(:title).filled(:string)
-  #       required(:total).filled(:decimal)
-  #     end
-  #
-  #     search_with do
-  #       {}
-  #     end
-  #
-  #     process_with do |data|
-  #       order = user.orders.create!(
-  #         title: params[:title],
-  #         total: params[:total]
-  #       )
-  #       { resource: order }
-  #     end
-  #   end
-  class CreateService < Services::Base
-    # Set action_name for metadata
-    self._action_name = :created
-
-    # Enable database transactions by default for create operations
-    with_transaction true
-
-    # Enable automatic cache invalidation for create operations
-    self._auto_invalidate_cache = true
-
-    # Default empty schema - subclasses MUST override with specific validations
-    schema do
-      # Override in subclass with required fields
-    end
-
-    private
-
-    # Override respond to ensure resource key is present
-    def respond(data)
-      # Get base result (from custom respond_with block or default)
-      if self.class._respond_block
-        result = instance_exec(data, &self.class._respond_block)
-      else
-        result = success_result("Resource created successfully", data)
-      end
-
-      # Ensure resource key exists (default to nil if not provided)
-      result[:resource] ||= nil
-
-      result
-    end
-  end
-  end
-end

data/lib/better_service/services/destroy_service.rb

@@ -1,60 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "base"
-
-module BetterService
-  module Services
-  # DestroyService - Specialized service for deleting resources
-  #
-  # Returns: { resource: {}, metadata: { action: :deleted } }
-  #
-  # Example:
-  #   class Orders::DestroyService < BetterService::Services::DestroyService
-  #     schema do
-  #       required(:id).filled(:integer)
-  #     end
-  #
-  #     search_with do
-  #       { resource: user.orders.find(params[:id]) }
-  #     end
-  #
-  #     process_with do |data|
-  #       order = data[:resource]
-  #       order.destroy!
-  #       { resource: order }
-  #     end
-  #   end
-  class DestroyService < Services::Base
-    # Set action_name for metadata
-    self._action_name = :deleted
-
-    # Enable database transactions by default for destroy operations
-    with_transaction true
-
-    # Enable automatic cache invalidation for destroy operations
-    self._auto_invalidate_cache = true
-
-    # Default schema - requires id parameter
-    schema do
-      required(:id).filled
-    end
-
-    private
-
-    # Override respond to ensure resource key is present
-    def respond(data)
-      # Get base result (from custom respond_with block or default)
-      if self.class._respond_block
-        result = instance_exec(data, &self.class._respond_block)
-      else
-        result = success_result("Resource deleted successfully", data)
-      end
-
-      # Ensure resource key exists (default to nil if not provided)
-      result[:resource] ||= nil
-
-      result
-    end
-  end
-  end
-end

data/lib/better_service/services/index_service.rb

@@ -1,56 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "base"
-
-module BetterService
-  module Services
-  # IndexService - Specialized service for list/collection endpoints
-  #
-  # Returns: { items: [], metadata: { action: :index, stats: {}, pagination: {} } }
-  #
-  # Example:
-  #   class Orders::IndexService < BetterService::Services::IndexService
-  #     search_with do
-  #       { items: user.orders.to_a }
-  #     end
-  #
-  #     process_with do |data|
-  #       {
-  #         items: data[:items],
-  #         metadata: {
-  #           stats: { total: data[:items].count },
-  #           pagination: { page: params[:page] || 1 }
-  #         }
-  #       }
-  #     end
-  #   end
-  class IndexService < Services::Base
-    # Set action_name for metadata
-    self._action_name = :index
-
-    # Default schema - can be overridden in subclasses
-    schema do
-      optional(:page).filled(:integer, gteq?: 1)
-      optional(:per_page).filled(:integer, gteq?: 1, lteq?: 100)
-      optional(:search).maybe(:string)
-    end
-
-    private
-
-    # Override respond to ensure items key is present
-    def respond(data)
-      # Get base result (from custom respond_with block or default)
-      if self.class._respond_block
-        result = instance_exec(data, &self.class._respond_block)
-      else
-        result = success_result("Operation completed successfully", data)
-      end
-
-      # Ensure items key exists (default to empty array if not provided)
-      result[:items] ||= []
-
-      result
-    end
-  end
-  end
-end

data/lib/better_service/services/show_service.rb

@@ -1,44 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "base"
-
-module BetterService
-  module Services
-  # ShowService - Specialized service for single resource detail endpoints
-  #
-  # Returns: { resource: {}, metadata: { action: :show } }
-  #
-  # Example:
-  #   class Orders::ShowService < BetterService::Services::ShowService
-  #     search_with do
-  #       { resource: user.orders.find(params[:id]) }
-  #     end
-  #   end
-  class ShowService < Services::Base
-    # Set action_name for metadata
-    self._action_name = :show
-
-    # Default schema - requires id parameter
-    schema do
-      required(:id).filled
-    end
-
-    private
-
-    # Override respond to ensure resource key is present
-    def respond(data)
-      # Get base result (from custom respond_with block or default)
-      if self.class._respond_block
-        result = instance_exec(data, &self.class._respond_block)
-      else
-        result = success_result("Operation completed successfully", data)
-      end
-
-      # Ensure resource key exists (default to nil if not provided)
-      result[:resource] ||= nil
-
-      result
-    end
-  end
-  end
-end

data/lib/better_service/services/update_service.rb

@@ -1,61 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "base"
-
-module BetterService
-  module Services
-  # UpdateService - Specialized service for updating existing resources
-  #
-  # Returns: { resource: {}, metadata: { action: :updated } }
-  #
-  # Example:
-  #   class Orders::UpdateService < BetterService::Services::UpdateService
-  #     schema do
-  #       required(:id).filled(:integer)
-  #       optional(:title).filled(:string)
-  #     end
-  #
-  #     search_with do
-  #       { resource: user.orders.find(params[:id]) }
-  #     end
-  #
-  #     process_with do |data|
-  #       order = data[:resource]
-  #       order.update!(params.except(:id))
-  #       { resource: order }
-  #     end
-  #   end
-  class UpdateService < Services::Base
-    # Set action_name for metadata
-    self._action_name = :updated
-
-    # Enable database transactions by default for update operations
-    with_transaction true
-
-    # Enable automatic cache invalidation for update operations
-    self._auto_invalidate_cache = true
-
-    # Default schema - requires id parameter
-    schema do
-      required(:id).filled
-    end
-
-    private
-
-    # Override respond to ensure resource key is present
-    def respond(data)
-      # Get base result (from custom respond_with block or default)
-      if self.class._respond_block
-        result = instance_exec(data, &self.class._respond_block)
-      else
-        result = success_result("Resource updated successfully", data)
-      end
-
-      # Ensure resource key exists (default to nil if not provided)
-      result[:resource] ||= nil
-
-      result
-    end
-  end
-  end
-end