rails_application_service 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f2660a3497bae6216e343a1b8a930f75bbd0dd470ed3229060cc8881438d56b1
-  data.tar.gz: b97c1a7919d2ca70aef177a1701e14416caf3f0a170970bbecfcf10c0e745a49
+  metadata.gz: 1ce7c95dcdb2c3e8a3155219906c39a736ec5a5cb820e819d9f82291f09465fd
+  data.tar.gz: 4a6f8d3dbd8af987d39922c8b9fcd3d55363c8037576349ec35c909ed56d7b87
 SHA512:
-  metadata.gz: 5ab05ae5a159d838c65ff1b41badb518df968734462c9d52eaeeed705643de2ca6cf1aec0bc529d0f4d045efc98d4c612ebec5a7f351a953f8205fa9571cce2f
-  data.tar.gz: ef48067c66734b18053e04c6bc87934b9841fc4adcd19e39fe7e526d032d4f64506553c7020d7ffff5b416664e2a517b1d964f4e8dc9bc4fd3360abab5e43e1e
+  metadata.gz: 6396cdf5260b37a651d9d09a06e9e37f8f4fb5a54d16f8de44ed055550910abfcbb369c3fdd97901e25c7b55154744715ed47721f9ab73d3534f5fa7c170e7ee
+  data.tar.gz: 37118f9adfcc779cbd17f50af24505921a0098ce2c5a95e2361694eb497f0fc125fabe4869b8d7892bfa6246126b9043a0c82fcac04a788471a768c7597ddbb3

data/CHANGELOG.md

@@ -1,5 +1,89 @@
-## [Unreleased]
+# Change Log
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](http://semver.org/).
+
+## [Unreleased] - yyyy-mm-dd
+
+Here we write upgrading notes for brands. It's a team effort to make them as
+straightforward as possible.
+
+### Added
+- [PROJECTNAME-XXXX](http://tickets.projectname.com/browse/PROJECTNAME-XXXX)
+  MINOR Ticket title goes here.
+- [PROJECTNAME-YYYY](http://tickets.projectname.com/browse/PROJECTNAME-YYYY)
+  PATCH Ticket title goes here.
+
+### Changed
+
+### Removed
+
+### Breaking Changes
+
+## [0.5.0] - 2025-06-16
+
+### Added
+
+### Changed
+- Code documentation and Readme were enhanced
+- Test specs were refactored and simplified
+- Rubocop offenses were fixed
+- Dependencies were updated
+
+### Removed
+
+### Breaking Changes
+
+## [0.4.0] - 2025-06-16
+
+### Added
+- Support for `ActiveModel::API` and `ActiveModel::Attributes` was added
+- Type casting through `ActiveModel::Attributes` was added
+- Validation through `ActiveModel::Validations` was added
+
+### Changed
+- Service initialization now uses keyword arguments exclusively
+- Improved error messages and documentation
+- Enhanced example code in docstrings
+
+### Removed
+- Support for positional arguments in the `call` method
+
+### Breaking Changes
+- Services must now use keyword arguments instead of positional arguments
+- All existing services using positional arguments need to be updated
+
+## [0.3.0] - 2025-02-05
+
+### Added
+
+### Changed
+- Source code and tests were refactored
+
+### Removed
+
+### Breaking Changes
+
+## [0.2.0] - 2025-02-04
+
+### Added
+
+### Changed
+- Source code and tests were refactored
+
+### Removed
+
+### Breaking Changes
 
 ## [0.1.0] - 2025-02-04
 
+### Added
 - Initial release
+
+### Changed
+
+### Removed
+
+### Breaking Changes

data/README.md

@@ -1,4 +1,4 @@
-# ApplicationService
+# Rails Application Service
 
 Service objects for Rails - the Rails way. This Ruby gem adds service objects to Rails applications.
 
@@ -7,7 +7,7 @@ Service objects for Rails - the Rails way. This Ruby gem adds service objects to
 **1 - Add the gem to the Rails application's Gemfile by entering:**
 
 ```bash
-gem add application_service
+bundle add rails_application_service
 ```
 
 **2 - Install the gem into the Rails application's directory by running:**
@@ -16,17 +16,19 @@ gem add application_service
 bundle install
 ```
 
-**3 - Create a `app/services` subdirectory into the Rails application's directory by running:**
+**3 - Create an `app/services` subdirectory in the Rails application's directory by running:**
 ```bash
 mkdir -p app/services
 ```
 
 ## Usage
 
-The `ApplicationService::Base` class provides a standard interface for calling service objects. It defines a class method `call` that initializes a new instance of the service object and invokes its `call` instance method. The `call` method can accept any number of arguments, which are passed to the initializer of the service object. You can define attributes and validations just like in Active Record, using the same syntax and conventions.
+The `ApplicationService::Base` class provides a standard interface for calling service objects with robust type handling and validations. It leverages `ActiveModel::API` for initialization with keyword arguments, `ActiveModel::Attributes` for type casting, and `ActiveModel::Validations` for input validation.
 
 ### Example of a basic service:
 ```ruby
+require "application_service"
+
 class MyService < ApplicationService::Base
   def call
     # Perform the service action
@@ -36,28 +38,37 @@ end
 my_service = MyService.call # nil
 ```
 
-### Example of a more complete service:
+### Example of a service:
 ```ruby
-class Sum < ApplicationService::Base
-  attr_accessor :number_a, :number_b
+require "application_service"
 
-  validates :number_a, :number_b, presence: true, numericality: { only_integer: true, greater_than: 0 }
-
-  def initialize(number_a, number_b)
-    super
+class Sum < ApplicationService::Base
+  attribute :number_a, :integer
+  attribute :number_b, :integer
 
-    self.number_a = number_a
-    self.number_b = number_b
-  end
+  validates :number_a, :number_b, presence: true, numericality: { greater_than: 0 }
 
   def call
-    (number_a + number_b)
+    number_a + number_b
   end
 end
 
-sum = Sum.call(1, 2) # 2
+sum = Sum.call(number_a: 1, number_b: 2) # => 3
 ```
 
+### Available attribute types
+
+This gem supports the following attribute types through `ActiveModel::Attributes` and other custom types defined in `ActiveModel::Type`:
+
+- `:boolean`
+- `:date`
+- `:datetime`
+- `:decimal`
+- `:float`
+- `:integer`
+- `:string`
+- `:time`
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -74,7 +85,7 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the ApplicationService project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/mariomarroquim/rails_application_service/blob/main/CODE_OF_CONDUCT.md).
+Everyone interacting in the ApplicationService project's codebases, issue trackers, chat rooms, and mailing lists is expected to follow the [code of conduct](https://github.com/mariomarroquim/rails_application_service/blob/main/CODE_OF_CONDUCT.md).
 
 ## Support
 

data/lib/application_service/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ApplicationService
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/lib/application_service.rb

@@ -8,51 +8,61 @@ require "active_model"
 # perform a single action or a series of related actions.
 module ApplicationService
   # The Base class within the ApplicationService module provides a standard
-  # interface for calling service objects. It defines a class method `call`
-  # that initializes a new instance of the service object and invokes its
-  # `call` instance method.
+  # interface for calling service objects with robust type handling and validations.
+  # It leverages ActiveModel::API for initialization with keyword arguments,
+  # ActiveModel::Attributes for type casting, and ActiveModel::Validations for
+  # input validation.
   #
   # Example usage:
-  #   class Sum < ApplicationService::Base
-  #     attr_accessor :number_a, :number_b
-  #
-  #     validates :number_a, :number_b, presence: true, numericality: { only_integer: true, greater_than: 0 }
   #
-  #     def initialize(number_a, number_b)
-  #       super
+  #   class Sum < ApplicationService::Base
+  #     attribute :number_a, :integer
+  #     attribute :number_b, :integer
   #
-  #       self.number_a = number_a
-  #       self.number_b = number_b
-  #     end
+  #     validates :number_a, :number_b, presence: true, numericality: { greater_than: 0 }
   #
   #     def call
-  #       (number_a + number_b)
+  #       number_a + number_b
   #     end
   #   end
   #
-  #   sum = Sum.call(1, 2) # 2
+  #   sum = Sum.call(number_a: 1, number_b: 2) # => 3
   #
-  # The `call` method can accept any number of arguments, which are
-  # passed to the initializer of the service object. You can define
-  # attributes and validations just like in Active Record, using
-  # the same syntax and conventions.
+  # This gem supports the following attribute types through ActiveModel::Attributes and
+  # other custom types defined in ActiveModel::Type:
+  #
+  # - :boolean
+  # - :date
+  # - :datetime
+  # - :decimal
+  # - :float
+  # - :integer
+  # - :string
+  # - :time
   class Base
+    include ::ActiveModel::API
+    include ::ActiveModel::Attributes
     include ::ActiveModel::Validations
 
     # Initializes a new instance of the service object.
     #
-    # @param args [Array] the arguments to be passed to the initializer of the service object
-    # @raise [NotImplementedError] if an attempt is made to instantiate the abstract class directly
-    def initialize(*_args)
-      raise NotImplementedError, "#{self.class} can not be instantiated" if instance_of?(Base)
+    # @param kwargs [Hash] the attributes to be passed to the service object
+    # @raise [NotImplementedError] if an attempt is made to instantiate the Base class directly
+    def initialize(**kwargs)
+      super
+
+      return unless instance_of?(Base)
+
+      raise ::NotImplementedError, "#{self.class.name} is an abstract class and cannot be instantiated directly"
     end
 
     # Initializes a new instance of the service object and invokes its `call` method.
     #
-    # @param args [Array] the arguments to be passed to the initializer of the service object
-    # @return [Object] the recently instantiated service object
-    def self.call(*args)
-      service = new(*args)
+    # @param kwargs [Hash] the attributes to be passed to the service object
+    # @return [Object] the result of the service object's call method
+    # @return [false] if the service object is invalid
+    def self.call(**kwargs)
+      service = new(**kwargs)
 
       return false unless service.valid?
 
@@ -63,7 +73,7 @@ module ApplicationService
     #
     # @raise [NotImplementedError] if the method is not implemented in a child class
     def call
-      raise NotImplementedError, "The `call` method must be implemented in #{self.class}"
+      raise ::NotImplementedError, "The `call` method must be implemented in #{self.class.name}"
     end
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: rails_application_service
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Mário Marroquim
 bindir: exe
 cert_chain: []
-date: 2025-02-05 00:00:00.000000000 Z
+date: 2025-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -62,7 +62,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.3
+rubygems_version: 3.6.6
 specification_version: 4
 summary: Service objects for Rails - the Rails way.
 test_files: []