sea_food 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 229c5e0090e1f77fe0603d6dd101c2a95a4b8b2ac6df8e3e6a4bfb2a33fe1dba
-  data.tar.gz: a214594cb13e3f68a19780e89379396cc3555fe704d6aa5bd560c5d961b8592f
+  metadata.gz: '09caa9ace45be8850e8639249d6838094845be06718b0c70e384873a35612020'
+  data.tar.gz: 4b77831dc3d9decd91d67f735baea6bd3cfb27c0519d581d1e6988f6d8ff0194
 SHA512:
-  metadata.gz: eccdcd9327f73be12b69603edf85868c24004a60e8e772682369fab85bc19404a6d7d59bf541b8481504577570ace291b4e816778bebed229bd71a66e71a328b
-  data.tar.gz: 0d03a7f7a0ced6aa30bc611239863c2f4a38bad6a4869c641a3be80d49338ebf367098e14a1260b06c0ed75117a26b4071f22fcac5f382c4f1c8124ddd0b40fd
+  metadata.gz: 710db87b3d97c5cf54c3ad05599efd80a499a6d3610212a8c7289fa67d678eaf6213cf02f49801bf3fe86fb8713d2fed2d73d3a9b4b9eb6c8baa6d39b521c6b4
+  data.tar.gz: 49c68b7d88ef0526fa7f9762e0b5f264dd135a174287993b73e31e412dfc8ee225623c1c11bd4c966f50bb446459f83a604f31c46839c76368df51bff7b7ff83

data/.rubocop.yml

@@ -42,7 +42,7 @@ Metrics/BlockLength:
     - 'sea_food.gemspec'
     - config/**/*
     - spec/**/*
-  ExcludedMethods:
+  AllowedMethods:
     - class_methods
 
 Metrics/BlockNesting:
@@ -97,9 +97,14 @@ Style/MissingRespondToMissing:
   Exclude:
     - 'lib/sea_food/service.rb'
 
-Style/MethodMissingSuper:
+Lint/MissingSuper:
   Exclude:
     - 'lib/sea_food/service.rb'
+    - spec/**/*
 
 Naming/PredicateName:
-  Enabled: false
+  Enabled: false
+
+Lint/ConstantDefinitionInBlock:
+  Exclude:
+    - 'spec/**/*'

data/README.md

@@ -53,6 +53,197 @@ end
 ```
 It will raise an `ArgumentError`.
 
+
+### Handling Success and Failure
+#### Using success and fail
+`success(data):` Marks the service result as successful and optionally provides data.
+`fail(data):` Marks the service result as a failure but continues executing the call method.
+`fail!(data):` Marks the service result as a failure and immediately exits the call method.
+#### Example: Using fail followed by success
+```ruby
+  class TestFailService < SeaFood::Service
+    def initialize(email:)
+      @email = email
+    end
+
+    def call
+      fail(email: 'hi@example.com')
+      success(email: @email)
+    end
+  end
+
+  result = TestFailService.call(email: 'service@example.com')
+
+  puts result.success? # => true
+  puts result.email    # => 'service@example.com'
+```
+In this example:
+
+The fail method sets the result to failure but allows the method to continue.
+The subsequent success call overrides the failure, resulting in a successful outcome.
+
+#### Example: Using fail! to Exit Early
+```ruby
+class TestFailBangService < SeaFood::Service
+  def initialize(email:)
+    @email = email
+  end
+
+  def call
+    fail!(email: 'hi@example.com')
+    success(email: @email) # This line is not executed
+  end
+end
+
+result = TestFailBangService.call(email: 'service@example.com')
+
+puts result.success? # => false
+puts result.email    # => 'hi@example.com'
+```
+
+The `fail!` method immediately exits the call method.
+The service result is a failure, and subsequent code in call is not executed.
+Nested Services
+You can call other services within a service. The behavior depends on whether you use `call` or `call!`.
+#### Summary of call vs. call!
+`call`: Executes the service and returns the result. Does not raise an exception if the service fails.
+
+`call!`: Executes the service and raises an exception if the service fails. Useful for propagating failures in nested services.
+
+#### Using call (Non-Bang Method)
+Failures in nested services do not automatically propagate to the parent service.
+
+
+```ruby
+  class InnerService < SeaFood::Service
+    def initialize(email:)
+      @email = email
+    end
+
+    def call
+      fail!(email: @email)
+    end
+  end
+
+  class OuterService < SeaFood::Service
+    def initialize(email:)
+      @email = email
+    end
+
+    def call
+      InnerService.call(email: 'inner@example.com')
+      success(email: @email)
+    end
+  end
+
+  result = OuterService.call(email: 'outer@example.com')
+
+  puts result.success? # => true
+  puts result.email    # => 'outer@example.com'
+```
+*Explanation:*
+
+`InnerService` fails using `fail!`.
+`OuterService` calls `InnerService` using `call`.
+Since `call` does not raise an exception on failure, `OuterService` continues and succeeds.
+
+#### Using `call!` (Bang Method)
+Failures in nested services propagate to the parent service when using `call!`.
+
+```ruby
+  class InnerService < SeaFood::Service
+    def initialize(email:)
+      @email = email
+    end
+
+    def call
+      fail!(email: @email)
+    end
+  end
+
+  class OuterService < SeaFood::Service
+    def initialize(email:)
+      @email = email
+    end
+
+    def call
+      InnerService.call!(email: 'inner@example.com')
+      success(email: @email) # This line is not executed
+    end
+  end
+
+  result = OuterService.call(email: 'outer@example.com')
+
+  puts result.success? # => false
+  puts result.email    # => 'inner@example.com'
+```
+*Explanation:*
+
+`InnerService` fails using `fail!`.
+`OuterService` calls `InnerService` using call!.
+The failure from `InnerService` propagates, causing `OuterService` to fail.
+#### Handling Failures in Nested Services
+You can handle failures from nested services by checking their result.
+
+```ruby
+class InnerService < SeaFood::Service
+  def initialize(value:)
+    @value = value
+  end
+
+  def call
+    if @value < 0
+      fail!(error: 'Negative value')
+    else
+      success(value: @value)
+    end
+  end
+end
+
+class OuterService < SeaFood::Service
+  def initialize(value:)
+    @value = value
+  end
+
+  def call
+    result = InnerService.call(value: @value)
+
+    if result.fail?
+      fail!(error: result.error)
+    else
+      success(value: result.value * 2)
+    end
+  end
+end
+
+result = OuterService.call(value: -1)
+
+puts result.success?   # => false
+puts result.error      # => 'Negative value'
+```
+*Explanation:*
+
+`OuterService` checks the result of `InnerService`.
+If `InnerService` fails, `OuterService` handles it accordingly.
+
+#### Accessing Result Data
+The result object allows you to access data provided in success or fail calls using method syntax.
+
+```ruby
+class ExampleService < SeaFood::Service
+  def call
+    success(message: 'Operation successful', value: 42)
+  end
+end
+
+result = ExampleService.call
+
+puts result.success?   # => true
+puts result.message    # => 'Operation successful'
+puts result.value      # => 42
+```
+
+
 ## 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.

data/lib/sea_food/service.rb

@@ -21,12 +21,18 @@ module SeaFood
       # @param args [Hash] Arguments to pass to the service.
       # @return [ServiceResult] The result of the service call.
       def call(params = {})
-        # debugger
         service = new(**params)
         service.call
         service.result || ServiceResult.new
       rescue ServiceError => e
-        service.result
+        service.result || e.try(:result)
+      end
+
+      def call!(params = {})
+        result = call(params)
+        return result || ServiceResult.new unless result.fail?
+
+        raise ServiceError, result
       end
     end
 
@@ -113,7 +119,13 @@ module SeaFood
       end
     end
 
-    class ServiceError < StandardError; end
+    class ServiceError < StandardError
+      attr_reader :result
+
+      def initialize(result)
+        @result = result
+      end
+    end
 
     private
 

data/lib/sea_food/version.rb

@@ -1,3 +1,3 @@
 module SeaFood
-  VERSION = '0.1.1'.freeze
+  VERSION = '0.2.0'.freeze
 end

data/sea_food.gemspec

@@ -12,6 +12,7 @@ Gem::Specification.new do |spec|
   spec.summary       = 'A Ruby gem for seamlessly integrating form and service object patterns.'
   spec.homepage      = 'https://github.com/eagerworks/sea_food'
   spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.7.0')
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.
@@ -43,6 +44,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'debug'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rubocop', '~> 0.80.0'
+  spec.add_development_dependency 'rubocop', '~> 1.0'
   spec.add_development_dependency 'sqlite3', '~> 1.5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sea_food
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Federico Aldunate
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-10-01 00:00:00.000000000 Z
+date: 2024-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -128,14 +128,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.80.0
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.80.0
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -192,7 +192,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="