rails_application_service 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1ce7c95dcdb2c3e8a3155219906c39a736ec5a5cb820e819d9f82291f09465fd
-  data.tar.gz: 4a6f8d3dbd8af987d39922c8b9fcd3d55363c8037576349ec35c909ed56d7b87
+  metadata.gz: b7e3b78a33f41ea84a56ce29d482a739d1c4431122ec8eb766d76fd4d4598552
+  data.tar.gz: 5cf617de77f52dad4444d4cdfefbfd84b62e1bf2d54a3e0140dd64d890ab5661
 SHA512:
-  metadata.gz: 6396cdf5260b37a651d9d09a06e9e37f8f4fb5a54d16f8de44ed055550910abfcbb369c3fdd97901e25c7b55154744715ed47721f9ab73d3534f5fa7c170e7ee
-  data.tar.gz: 37118f9adfcc779cbd17f50af24505921a0098ce2c5a95e2361694eb497f0fc125fabe4869b8d7892bfa6246126b9043a0c82fcac04a788471a768c7597ddbb3
+  metadata.gz: 6116887b8a93ab25f5efcea6ab0e03c3f9cffd75aa7be4df4437956979db258b9d9ac671fa43323ebf26b2e78a5b3787c36ea888c41d07063d46e2c0d99e8948
+  data.tar.gz: cf929d8a4dad1d3f330a35b65cf1506aa67d0c0ab18c3113b9bab6a1451593c1862f74c321bf0a6fac15dd24fdee79073dfbb7f2b9400971c581a13743f7d561

data/CHANGELOG.md

@@ -1,22 +1,16 @@
-# Change Log
+# Changelog
 
-All notable changes to this project will be documented in this file.
+All notable changes to this project are 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/).
+The format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased] - yyyy-mm-dd
-
-Here we write upgrading notes for brands. It's a team effort to make them as
-straightforward as possible.
+## [0.6.0] - 2025-06-16
 
 ### 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
+- Enhanced the changelog
 
 ### Removed
 
@@ -27,10 +21,10 @@ straightforward as possible.
 ### Added
 
 ### Changed
-- Code documentation and Readme were enhanced
-- Test specs were refactored and simplified
-- Rubocop offenses were fixed
-- Dependencies were updated
+- Improved code documentation and README
+- Refactored and simplified test specs
+- Fixed Rubocop offenses
+- Updated dependencies
 
 ### Removed
 
@@ -39,17 +33,17 @@ straightforward as possible.
 ## [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
+- Added support for `ActiveModel::API` and `ActiveModel::Attributes`
+- Enabled type casting through `ActiveModel::Attributes`
+- Added validation via `ActiveModel::Validations`
 
 ### Changed
-- Service initialization now uses keyword arguments exclusively
+- Service initialization now exclusively uses keyword arguments
 - Improved error messages and documentation
 - Enhanced example code in docstrings
 
 ### Removed
-- Support for positional arguments in the `call` method
+- Removed support for positional arguments in the `call` method
 
 ### Breaking Changes
 - Services must now use keyword arguments instead of positional arguments
@@ -60,7 +54,7 @@ straightforward as possible.
 ### Added
 
 ### Changed
-- Source code and tests were refactored
+- Refactored source code and tests
 
 ### Removed
 
@@ -71,7 +65,7 @@ straightforward as possible.
 ### Added
 
 ### Changed
-- Source code and tests were refactored
+- Refactored source code and tests
 
 ### Removed
 

data/README.md

@@ -1,22 +1,23 @@
 # Rails Application Service
 
-Service objects for Rails - the Rails way. This Ruby gem adds service objects to Rails applications.
+Service objects for Rails, the Rails way. This Ruby gem adds service objects to your Rails applications.
 
 ## Installation
 
-**1 - Add the gem to the Rails application's Gemfile by entering:**
+**1 - Add the gem to your Rails application's Gemfile:**
 
 ```bash
 bundle add rails_application_service
 ```
 
-**2 - Install the gem into the Rails application's directory by running:**
+**2 - Install the gem by running:**
 
 ```bash
 bundle install
 ```
 
-**3 - Create an `app/services` subdirectory in the Rails application's directory by running:**
+**3 - Create an `app/services` directory in your Rails application:**
+
 ```bash
 mkdir -p app/services
 ```
@@ -25,7 +26,8 @@ mkdir -p app/services
 
 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:
+### Basic service example
+
 ```ruby
 require "application_service"
 
@@ -38,7 +40,8 @@ end
 my_service = MyService.call # nil
 ```
 
-### Example of a service:
+### Example with attributes and validations
+
 ```ruby
 require "application_service"
 
@@ -56,9 +59,9 @@ end
 sum = Sum.call(number_a: 1, number_b: 2) # => 3
 ```
 
-### Available attribute types
+### Supported attribute types
 
-This gem supports the following attribute types through `ActiveModel::Attributes` and other custom types defined in `ActiveModel::Type`:
+This gem supports the following attribute types through `ActiveModel::Attributes` and custom types defined in `ActiveModel::Type`:
 
 - `:boolean`
 - `:date`
@@ -71,9 +74,9 @@ This gem supports the following attribute types through `ActiveModel::Attributes
 
 ## 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.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to execute the tests. You can also run `bin/console` for an interactive prompt to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, then run `bundle exec rake release`. This will create a git tag for the version, push git commits and the tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 

data/lib/application_service/version.rb

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

data/lib/application_service.rb

@@ -46,24 +46,23 @@ module ApplicationService
 
     # Initializes a new instance of the service object.
     #
-    # @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
+    # @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"
+      if instance_of?(Base)
+        raise ::NotImplementedError, "#{self.class.name} is an abstract class and cannot be instantiated directly"
+      end
     end
 
-    # Initializes a new instance of the service object and invokes its `call` method.
+    # Instantiates a new service object and invokes its `call` method.
     #
-    # @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
+    # @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?
 
       service.call
@@ -71,7 +70,7 @@ module ApplicationService
 
     # Encapsulates the implementation to be executed by the service object.
     #
-    # @raise [NotImplementedError] if the method is not implemented in a child class
+    # @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.name}"
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_application_service
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Mário Marroquim