sea_food 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e1fadef17caded8e4d217abcf4cacb11a668661557b90945daec7c6248c3016d
-  data.tar.gz: 07ba588fb09dd2488095aff9149840decba53751351929195ce21fc490257756
+  metadata.gz: '09caa9ace45be8850e8639249d6838094845be06718b0c70e384873a35612020'
+  data.tar.gz: 4b77831dc3d9decd91d67f735baea6bd3cfb27c0519d581d1e6988f6d8ff0194
 SHA512:
-  metadata.gz: 43027c029c2c6b39625303d3ec828b5327c9231864902aef30cbde651229bb03b897b6bec31912c06e97234b3e8a8b9a944d80d75a3f15df185245322dcd72d9
-  data.tar.gz: 4a4a56b87d4c8944da926dc59c26ed634ca398fd1127af54cb9df7141def7520f456b577c50f3e78268722fd82ba4c92ddd47ef5840bcfcd0ba946c16f5f0491
+  metadata.gz: 710db87b3d97c5cf54c3ad05599efd80a499a6d3610212a8c7289fa67d678eaf6213cf02f49801bf3fe86fb8713d2fed2d73d3a9b4b9eb6c8baa6d39b521c6b4
+  data.tar.gz: 49c68b7d88ef0526fa7f9762e0b5f264dd135a174287993b73e31e412dfc8ee225623c1c11bd4c966f50bb446459f83a604f31c46839c76368df51bff7b7ff83

data/.github/workflows/ci.yml

@@ -0,0 +1,49 @@
+name: Test Matrix
+
+on: 
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        gemfile: [5_2.gemfile, 6_1.gemfile, 7_0.gemfile, 7_1.gemfile, 7_2.gemfile]
+        ruby-version: [ '2.7', '3.0', '3.1', '3.3']
+        exclude:
+          - ruby-version: '2.7'
+            gemfile: '7_0.gemfile'
+          - ruby-version: '2.7'
+            gemfile: '7_1.gemfile'
+          - ruby-version: '2.7'
+            gemfile: '7_2.gemfile'
+          - ruby-version: '3.0'
+            gemfile: '5_2.gemfile'
+          - ruby-version: '3.0'
+            gemfile: '7_2.gemfile'
+          - ruby-version: '3.1'
+            gemfile: '5_2.gemfile'
+          - ruby-version: '3.3'
+            gemfile: '5_2.gemfile'
+
+    env:
+      BUNDLE_GEMFILE: spec/gemfiles/${{ matrix.gemfile }}
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+
+      - name: Run tests
+        run: |
+          bundle exec rspec

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

@@ -21,7 +21,228 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Service usage
+```ruby
+class Invoices::ApproveService < SeaFood::Service
+  def initialize(invoice:, user:)
+    @invoice = invoice
+    @user = user
+  end
+
+  def call
+    fail!("You are not authorized to approve invoices") unless authorized?
+
+    @invoice.update!(status: :approved)
+    success(invoice: @invoice)
+  end
+end
+
+result = Invoices::ApproveService.call(invoice: invoice, user: user)
+result.success?
+#=> true
+result.invoice
+#=> <Invoice(...>
+```
+If you want to enforce the interface and not allow users to use `call`
+without arguments defined in the `initialize` you can add an initializer.
+```ruby
+# initializers/sea_food.rb
+SeaFood.configure do |config|
+  config.enforce_interface = true
+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
 

data/lib/sea_food/form.rb

@@ -7,11 +7,11 @@ module SeaFood
     end
 
     def save(options = {})
-      model.save(options) if valid?
+      model.save(**options) if valid?
     end
 
     def save!(options = {})
-      model.save!(options) if valid?
+      model.save!(**options) if valid?
     end
 
     private

data/lib/sea_food/service.rb

@@ -21,11 +21,18 @@ module SeaFood
       # @param args [Hash] Arguments to pass to the service.
       # @return [ServiceResult] The result of the service call.
       def call(params = {})
-        service = new(params)
+        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
 
@@ -112,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.0'.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.
@@ -38,11 +39,11 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'activesupport', '>= 5.2'
 
   spec.add_development_dependency 'activerecord', '>= 5.2'
-  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'database_cleaner-active_record', '~> 2.2.0'
   spec.add_development_dependency 'debug'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  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.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Federico Aldunate
-autorequire: 
+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
@@ -56,16 +56,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: database_cleaner-active_record
   requirement: !ruby/object:Gem::Requirement
@@ -98,16 +98,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -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
@@ -150,21 +150,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.5.0
-description: 
+description:
 email:
 - federico.aldunatec@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".ruby-version"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -185,7 +184,7 @@ metadata:
   source_code_uri: https://github.com/eagerworks/sea_food/
   changelog_uri: https://github.com/eagerworks/sea_food/releases
   bug_tracker_uri: https://github.com/eagerworks/sea_food/issues
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -193,15 +192,15 @@ 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:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.3.26
+signing_key:
 specification_version: 4
 summary: A Ruby gem for seamlessly integrating form and service object patterns.
 test_files: []

data/.ruby-version

@@ -1 +0,0 @@
-2.7.2

data/Gemfile.lock

@@ -1,96 +0,0 @@
-PATH
-  remote: .
-  specs:
-    sea_food (0.1.0)
-      activemodel (>= 5.2)
-      activesupport (>= 5.2)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activemodel (6.1.7.8)
-      activesupport (= 6.1.7.8)
-    activerecord (6.1.7.8)
-      activemodel (= 6.1.7.8)
-      activesupport (= 6.1.7.8)
-    activesupport (6.1.7.8)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 1.6, < 2)
-      minitest (>= 5.1)
-      tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
-    ast (2.4.2)
-    concurrent-ruby (1.3.4)
-    database_cleaner-active_record (2.2.0)
-      activerecord (>= 5.a)
-      database_cleaner-core (~> 2.0.0)
-    database_cleaner-core (2.0.1)
-    debug (1.8.0)
-      irb (>= 1.5.0)
-      reline (>= 0.3.1)
-    diff-lcs (1.5.1)
-    i18n (1.14.5)
-      concurrent-ruby (~> 1.0)
-    io-console (0.7.2)
-    irb (1.6.3)
-      reline (>= 0.3.0)
-    jaro_winkler (1.5.6)
-    mini_portile2 (2.8.7)
-    minitest (5.24.1)
-    parallel (1.24.0)
-    parser (3.3.4.2)
-      ast (~> 2.4.1)
-      racc
-    racc (1.8.1)
-    rainbow (3.1.1)
-    rake (10.5.0)
-    reline (0.5.9)
-      io-console (~> 0.5)
-    rexml (3.3.5)
-      strscan
-    rspec (3.13.0)
-      rspec-core (~> 3.13.0)
-      rspec-expectations (~> 3.13.0)
-      rspec-mocks (~> 3.13.0)
-    rspec-core (3.13.0)
-      rspec-support (~> 3.13.0)
-    rspec-expectations (3.13.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.13.0)
-    rspec-support (3.13.1)
-    rubocop (0.80.1)
-      jaro_winkler (~> 1.5.1)
-      parallel (~> 1.10)
-      parser (>= 2.7.0.1)
-      rainbow (>= 2.2.2, < 4.0)
-      rexml
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
-    ruby-progressbar (1.13.0)
-    sqlite3 (1.5.4)
-      mini_portile2 (~> 2.8.0)
-    strscan (3.1.0)
-    tzinfo (2.0.6)
-      concurrent-ruby (~> 1.0)
-    unicode-display_width (1.6.1)
-    zeitwerk (2.6.17)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  activerecord (>= 5.2)
-  bundler (~> 2.0)
-  database_cleaner-active_record (~> 2.2.0)
-  debug
-  rake (~> 10.0)
-  rspec (~> 3.0)
-  rubocop (~> 0.80.0)
-  sea_food!
-  sqlite3 (~> 1.5.0)
-
-BUNDLED WITH
-   2.1.4