resol 0.6.1 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f8b237f2430ac32748c491d62bdd0bc2b968731f2611e131b02e8570ede129d
-  data.tar.gz: e31bdb54460ce66b15ae4dd334687f1364400ddae6742e0d7981f84185fd1c39
+  metadata.gz: 4eb71da351b1379daa165b6223a0bb9fd2ff2ae5fd3436642b7cfdc782413917
+  data.tar.gz: 62712882caa637dfcfbf9a8f25e1026afeed72cea67c677acdf93c6802ac5cb4
 SHA512:
-  metadata.gz: 44bc7acefa0c91e8c98c008441e1c071eff83b6a14249945d08874cf173c9e843ed4ffd6d9f9c62b76a85b386e7251cb4e1bd58599492b0b813d896df335e69b
-  data.tar.gz: 5126dedc456428d860e2293f2617098f63a6275d168b09050b31e8047d033805e94d55fb25358bcb67a00202f6644d579c09d0a75b9b94cab1c2cd9b65587df8
+  metadata.gz: 4ae925f82e9deda9fa0c180976a446aff26822eb39e20371065d5e1c185e0473e0ae4e7811dd5f9c07cb09205bec9a3eec5b0458d0a807a81daaf1313133d09d
+  data.tar.gz: 5942e294f2a6e99386802e1d2848b6f754a6d8700268aa57079099058e161dd481d4aaec1000eb835dd80ab699f9e5ec2670a54038481dff4c42d324b1d803c5

data/.github/workflows/test.yml

@@ -16,7 +16,7 @@ jobs:
       - uses: actions/checkout@v2
       - uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 3
+          ruby-version: "3.1"
           bundler-cache: true
       - name: Run Linter
         run: bundle exec ci-helper RubocopLint
@@ -43,7 +43,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [2.7]
+        ruby: ["2.7", "3.0"]
         experimental: [false]
         include:
           - ruby: head

data/Gemfile.lock

@@ -1,18 +1,17 @@
 PATH
   remote: .
   specs:
-    resol (0.6.1)
+    resol (0.8.0)
       smart_initializer (~> 0.7)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.4.1)
+    activesupport (7.0.2.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
     ast (2.4.2)
     bundler-audit (0.9.0.1)
       bundler (>= 1.2.0, < 3)
@@ -24,99 +23,99 @@ GEM
     coderay (1.1.3)
     colorize (0.8.1)
     concurrent-ruby (1.1.9)
-    diff-lcs (1.4.4)
+    diff-lcs (1.5.0)
     docile (1.4.0)
     dry-inflector (0.2.1)
-    i18n (1.8.10)
+    i18n (1.10.0)
       concurrent-ruby (~> 1.0)
     method_source (1.0.0)
-    minitest (5.14.4)
+    minitest (5.15.0)
     parallel (1.21.0)
-    parser (3.0.2.0)
+    parser (3.1.1.0)
       ast (~> 2.4.1)
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    qonfig (0.26.0)
+    qonfig (0.27.0)
     rack (2.2.3)
-    rainbow (3.0.0)
+    rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.1.1)
+    regexp_parser (2.2.1)
     rexml (3.2.5)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
-    rubocop (1.17.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.25.1)
       parallel (~> 1.10)
-      parser (>= 3.0.0.0)
+      parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 1.15.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.11.0)
-      parser (>= 3.0.1.1)
-    rubocop-config-umbrellio (1.17.0.53)
-      rubocop (= 1.17.0)
-      rubocop-performance (= 1.10.0)
-      rubocop-rails (= 2.9.1)
-      rubocop-rake (= 0.5.1)
-      rubocop-rspec (= 2.2.0)
-      rubocop-sequel (= 0.2.0)
-    rubocop-performance (1.10.0)
-      rubocop (>= 0.90.0, < 2.0)
+    rubocop-ast (1.16.0)
+      parser (>= 3.1.1.0)
+    rubocop-config-umbrellio (1.25.0.61)
+      rubocop (~> 1.25.0)
+      rubocop-performance (~> 1.13.0)
+      rubocop-rails (~> 2.13.0)
+      rubocop-rake (~> 0.6.0)
+      rubocop-rspec (~> 2.7.0)
+      rubocop-sequel (~> 0.3.3)
+    rubocop-performance (1.13.2)
+      rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
-    rubocop-rails (2.9.1)
+    rubocop-rails (2.13.2)
       activesupport (>= 4.2.0)
       rack (>= 1.1)
-      rubocop (>= 0.90.0, < 2.0)
-    rubocop-rake (0.5.1)
-      rubocop
-    rubocop-rspec (2.2.0)
+      rubocop (>= 1.7.0, < 2.0)
+    rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-      rubocop-ast (>= 1.1.0)
-    rubocop-sequel (0.2.0)
+    rubocop-rspec (2.7.0)
+      rubocop (~> 1.19)
+    rubocop-sequel (0.3.3)
       rubocop (~> 1.0)
     ruby-progressbar (1.11.0)
-    sequel (5.48.0)
+    sequel (5.54.0)
     simplecov (0.21.2)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov-lcov (0.8.0)
-    simplecov_json_formatter (0.1.3)
-    smart_engine (0.11.0)
-    smart_initializer (0.7.0)
+    simplecov_json_formatter (0.1.4)
+    smart_engine (0.12.0)
+    smart_initializer (0.9.0)
       qonfig (~> 0.24)
       smart_engine (~> 0.11)
       smart_types (~> 0.4)
-    smart_types (0.6.0)
+    smart_types (0.7.0)
       smart_engine (~> 0.11)
     symbiont-ruby (0.7.0)
-    thor (1.1.0)
+    thor (1.2.1)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
     umbrellio-sequel-plugins (0.5.1.27)
       sequel
       symbiont-ruby
     unicode-display_width (2.1.0)
-    zeitwerk (2.4.2)
 
 PLATFORMS
+  arm64-darwin-21
   x86_64-darwin-19
   x86_64-darwin-20
+  x86_64-darwin-21
   x86_64-linux
 
 DEPENDENCIES
@@ -131,4 +130,4 @@ DEPENDENCIES
   simplecov-lcov
 
 BUNDLED WITH
-   2.2.21
+   2.3.8

data/README.md

@@ -99,9 +99,16 @@ Methods:
 - `failure?` – returns `true` for failure result and `false` for success result
 - `value!` – unwraps a result object, returns the value for success result, and throws an error for failure result
 - `value_or(other_value, &block)` – returns a value for success result or `other_value` for failure result (either calls `block` in case it given)
-- `or(&block)` - calls block for failure result, for success result does nothing
-- `either(success_proc, failure_proc)` - for success result calls success_proc with result value in args, for failure result calls failure_proc with error in args.
+- `error` – returns `nil` for success result and error object (with code and data) for failure result
+- `or(&block)` – calls block for failure result, for success result does nothing
+- `either(success_proc, failure_proc)` – for success result calls success_proc with result value in args, for failure result calls failure_proc with error in args.
 
+### Error object
+
+In case of failure you can get an error object with error code
+and data from `fail!` arguments. This can be done by method `error` on
+the result object and the returned object will have corresponding
+methods `code` and `data`.
 
 ### Configuration
 

data/lib/resol/result.rb

@@ -41,6 +41,10 @@ module Resol
     def value!
       @value
     end
+
+    def error
+      nil
+    end
   end
 
   class Failure < Result
@@ -68,6 +72,10 @@ module Resol
     def value!
       raise UnwrapError, "Failure result #{@value.inspect}"
     end
+
+    def error
+      @value
+    end
   end
 
   def self.Success(...)

data/lib/resol/service.rb

@@ -7,6 +7,7 @@ require_relative "result"
 module Resol
   class Service
     class InvalidCommandImplementation < StandardError; end
+    class InvalidCommandCall < StandardError; end
 
     class Failure < StandardError
       attr_accessor :data, :code
@@ -39,16 +40,21 @@ module Resol
       end
 
       def call(*args, **kwargs, &block)
-        command = build(*args, **kwargs)
-        result = catch(command) do
-          __run_callbacks__(command)
-          command.call(&block)
-          nil
+        service = build(*args, **kwargs)
+
+        result = catch(service) do
+          service.instance_variable_set(:@__performing__, true)
+          __run_callbacks__(service)
+          service.call(&block)
+          :uncaught
         end
-        return Resol::Success(result.data) unless result.nil?
 
-        error_message = "No success! or fail! called in the #call method in #{command.class}"
-        raise InvalidCommandImplementation, error_message
+        if result == :uncaught
+          error_message = "No `#success!` or `#fail!` called in `#call` method in #{service.class}."
+          raise InvalidCommandImplementation, error_message
+        else
+          Resol::Success(result.data)
+        end
       rescue self::Failure => e
         Resol::Failure(e)
       end
@@ -62,12 +68,30 @@ module Resol
 
     private
 
+    attr_reader :__performing__
+
     def fail!(code, data = nil)
-      raise self.class::Failure.new(code, data)
+      check_performing do
+        raise self.class::Failure.new(code, data)
+      end
     end
 
     def success!(data = nil)
-      throw(self, Result.new(data))
+      check_performing do
+        throw(self, Result.new(data))
+      end
+    end
+
+    def check_performing
+      if __performing__
+        yield
+      else
+        error_message =
+          "It looks like #call instance method was called directly in #{self.class}. " \
+          "You must always use class-level `.call` or `.call!` method."
+
+        raise InvalidCommandCall, error_message
+      end
     end
   end
 end

data/lib/resol/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Resol
-  VERSION = "0.6.1"
+  VERSION = "0.8.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: resol
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.8.0
 platform: ruby
 authors:
 - Aleksei Bespalov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-23 00:00:00.000000000 Z
+date: 2022-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: smart_initializer
@@ -180,7 +180,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.3.5
 signing_key:
 specification_version: 4
 summary: Gem for creating (any) object patterns