resol 0.1.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f71f97e92852c4b25525cf1388c8cc671bc5587d7535fa844e3a681c686c14d1
-  data.tar.gz: 996140397a4d0c0bd04a426c30f0da88a423495e9e80715e2722a1089fd3656e
+  metadata.gz: 33dbd02433c7393f8d8f266c695d200183c89353a8b7a8c88ead39fe440e6adf
+  data.tar.gz: aba889493d6a145d47f34a9aebd85a86802b6e132383fbaf59a1e53e6c814609
 SHA512:
-  metadata.gz: 638959dfb203d736a85c79c3c271b716d08be263e88b8509210ff712715f12fddcfd27d2600dfbee1e0cf39fd84b89def3a0ee1323bb27451d90cbb407cc8edb
-  data.tar.gz: 1b89eb69a71e3d43da7520e4f90789b7e6b2a33716dabc9b163a8d6fc1ce70a424c40430b5e982ee3adec3e7fd0fed1c17921adf1f1e1706199febaa7f8fbcfd
+  metadata.gz: 34cc31c049d23bceb945518162b725fc919bd3aae6746d58a90038fe6d678d9ab5c8b4060d6e39a3ae248974973768c97f4ffe5abdcde49bad922081dc6dbf2f
+  data.tar.gz: aa8c2b3c450dc5b23314a53ed3c65fd662ce3e880b15ca6ab271b5f99a0e05229659c43fd6793ae47b0c7a99f53bcec2541ea025897075cc60ddedda970c1857

data/.github/workflows/test.yml

@@ -0,0 +1,60 @@
+name: Test
+
+on: [push, pull_request]
+
+env:
+  COVER: true
+
+jobs:
+  full-check:
+    runs-on: ubuntu-latest
+
+    # We want to run on external PRs, but not on our own internal PRs as they'll be run on push event
+    if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name != 'umbrellio/resol'
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3
+          bundler-cache: true
+      - name: Run Linter
+        run: bundle exec ci-helper RubocopLint
+      - name: Check missed spec suffixes
+        run: bundle exec ci-helper CheckSpecSuffixes --extra-paths spec/*.rb --ignored-paths spec/*_helper.rb
+      - name: Run specs
+        run: bundle exec ci-helper RunSpecs
+      - name: Audit
+        run: bundle exec ci-helper BundlerAudit
+      - name: Coveralls
+        uses: coverallsapp/github-action@master
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+  specs:
+    runs-on: ubuntu-latest
+    continue-on-error: ${{ matrix.experimental }}
+
+    env:
+      COVER: false
+
+    # We want to run on external PRs, but not on our own internal PRs as they'll be run on push event
+    if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name != 'umbrellio/resol'
+
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [2.7]
+        experimental: [false]
+        include:
+          - ruby: head
+            experimental: true
+
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Run specs
+        run: bundle exec ci-helper RunSpecs

data/.gitignore

@@ -9,3 +9,4 @@
 
 # rspec failure tracking
 .rspec_status
+*.gem

data/.rubocop.yml

@@ -1,23 +1,19 @@
-AllCops:
-  TargetRubyVersion: 2.6
-  NewCops: enable
+inherit_gem:
+  rubocop-config-umbrellio: lib/rubocop.yml
 
-Style/StringLiterals:
-  Enabled: true
-  EnforcedStyle: double_quotes
+AllCops:
+  DisplayCopNames: true
+  TargetRubyVersion: 2.7
 
-Style/StringLiteralsInInterpolation:
-  Enabled: true
-  EnforcedStyle: double_quotes
+Naming/MethodParameterName:
+  AllowedNames: ["x", "y", "z"]
 
-Style/RaiseArgs:
+RSpec/EmptyLineAfterHook:
   Enabled: false
 
-Style/Documentation:
+Naming/RescuedExceptionsVariableName:
   Enabled: false
 
-Layout/LineLength:
-  Max: 100
-
-Layout/FirstArrayElementIndentation:
-  EnforcedStyle: consistent
+Style/HashConversion:
+  Exclude:
+    - spec/**/*_spec.rb

data/Gemfile.lock

@@ -1,28 +1,37 @@
 PATH
   remote: .
   specs:
-    resol (0.1.0)
-      smart_initializer
-      uber
+    resol (0.4.1)
+      smart_initializer (~> 0.5)
+      uber (~> 0.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (6.1.3.1)
+      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.8.0)
+      bundler (>= 1.2.0, < 3)
+      thor (~> 1.0)
+    ci-helper (0.4.2)
+      colorize (~> 0.8)
+      dry-inflector (~> 0.2)
+      umbrellio-sequel-plugins (~> 0.4)
     coderay (1.1.3)
-    coveralls (0.7.2)
-      multi_json (~> 1.3)
-      rest-client (= 1.6.7)
-      simplecov (>= 0.7)
-      term-ansicolor (= 1.2.2)
-      thor (= 0.18.1)
+    colorize (0.8.1)
+    concurrent-ruby (1.1.8)
     diff-lcs (1.4.4)
     docile (1.3.5)
+    dry-inflector (0.2.0)
+    i18n (1.8.10)
+      concurrent-ruby (~> 1.0)
     method_source (1.0.0)
-    mime-types (3.3.1)
-      mime-types-data (~> 3.2015)
-    mime-types-data (3.2021.0225)
-    multi_json (1.15.0)
+    minitest (5.14.4)
     parallel (1.20.1)
     parser (3.0.1.0)
       ast (~> 2.4.1)
@@ -30,11 +39,10 @@ GEM
       coderay (~> 1.1)
       method_source (~> 1.0)
     qonfig (0.25.0)
+    rack (2.2.3)
     rainbow (3.0.0)
     rake (13.0.3)
     regexp_parser (2.1.1)
-    rest-client (1.6.7)
-      mime-types (>= 1.16)
     rexml (3.2.5)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
@@ -49,23 +57,46 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.2)
-    rubocop (0.93.1)
+    rubocop (1.11.0)
       parallel (~> 1.10)
-      parser (>= 2.7.1.5)
+      parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8)
+      regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 0.6.0)
+      rubocop-ast (>= 1.2.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
+      unicode-display_width (>= 1.4.0, < 3.0)
     rubocop-ast (1.4.1)
       parser (>= 2.7.1.5)
+    rubocop-config-umbrellio (1.11.0.40)
+      rubocop (= 1.11.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 (>= 0.4.0)
+    rubocop-rails (2.9.1)
+      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.0)
+      rubocop-ast (>= 1.1.0)
+    rubocop-sequel (0.2.0)
+      rubocop (~> 1.0)
     ruby-progressbar (1.11.0)
+    sequel (5.43.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.2)
     smart_engine (0.11.0)
     smart_initializer (0.5.0)
@@ -74,24 +105,32 @@ GEM
       smart_types (~> 0.4)
     smart_types (0.4.0)
       smart_engine (~> 0.11)
-    term-ansicolor (1.2.2)
-      tins (~> 0.8)
-    thor (0.18.1)
-    tins (0.13.2)
+    symbiont-ruby (0.6.0)
+    thor (1.1.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
     uber (0.1.0)
-    unicode-display_width (1.7.0)
+    umbrellio-sequel-plugins (0.4.0.164)
+      sequel
+      symbiont-ruby (>= 0.6)
+    unicode-display_width (2.0.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   x86_64-darwin-19
+  x86_64-darwin-20
+  x86_64-linux
 
 DEPENDENCIES
-  coveralls
+  bundler-audit
+  ci-helper
   pry
   rake
   resol!
   rspec
-  rubocop
+  rubocop-config-umbrellio
   simplecov
+  simplecov-lcov
 
 BUNDLED WITH
-   2.2.3
+   2.2.19

data/README.md

@@ -1,6 +1,8 @@
 # Resol
 
-![https://github.com/umbrellio/resol](https://github.com/umbrellio/resol/actions/workflows/main.yml/badge.svg)
+![https://github.com/umbrellio/resol](https://github.com/umbrellio/resol/actions/workflows/test.yml/badge.svg)
+[![Coverage Status](https://coveralls.io/repos/github/umbrellio/resol/badge.svg?branch=master)](https://coveralls.io/github/umbrellio/resol?branch=master)
+[![Gem Version](https://badge.fury.io/rb/resol.svg)](https://badge.fury.io/rb/resol)
 
 Ruby Gem for creating simple service objects and other any object ruby patterns.
 
@@ -61,6 +63,34 @@ All incoming params and options can be defined using a [smart_initializer](https
 - `success!(value)` – finish with a success value
 - `fail!(code, data = nil)` – fail with any error code and optional data
 
+#### Define callbacks
+
+You can define callbacks to be executed before calling the `#call` method.
+
+```ruby
+class FindUser < Resol::Service
+  param :id
+
+  before_call :set_user
+
+  def call
+    if user
+      success!(user)
+    else
+      fail!(:not_found)
+    end
+  end
+
+  private
+
+  attr_accessor :user
+
+  def set_user
+    self.user = User.find(id)
+  end
+end
+```
+
 ### Result objects
 
 Methods:
@@ -69,10 +99,20 @@ 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.
+
+
+### Configuration
+
+Configuration constant references to `SmartCore::Initializer::Configuration`. You can read
+about available configuration options [here](https://github.com/smart-rb/smart_initializer#configuration).
 
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/rspec` to run the tests.
+If you want to check coverage, then set env variable `COVER` to `true` before running `bin/rspec`:
+`COVER=true bin/rspec`.
 You can also run `bin/console` for an interactive prompt that will allow you 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).

data/bin/rubocop

@@ -3,4 +3,4 @@ set -euo pipefail
 IFS=$'\n\t'
 set -vx
 
-bundle exec rubocop
+bundle exec rubocop $@

data/lib/resol.rb

@@ -7,4 +7,5 @@ require_relative "resol/version"
 require_relative "resol/service"
 
 module Resol
+  Configuration = SmartCore::Initializer::Configuration
 end

data/lib/resol/builder.rb

@@ -8,11 +8,11 @@ module Resol
     end
 
     module ClassMethods
-      def build_klass(*args, **kwargs)
+      def build_klass(...)
         klass = self
 
         loop do
-          new_klass = klass.build!(klass, *args, **kwargs)
+          new_klass = klass.build!(klass, ...)
           break if new_klass == klass
 
           klass = new_klass
@@ -21,8 +21,8 @@ module Resol
         klass
       end
 
-      def build(*args)
-        build_klass(*args).new(*args)
+      def build(...)
+        build_klass(...).new(...)
       end
     end
   end

data/lib/resol/callbacks.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Resol
+  module Callbacks
+    def self.included(base)
+      base.extend(ClassMethods)
+      base.instance_variable_set(:@__callback_methods__, [])
+    end
+
+    module ClassMethods
+      def inherited(subclass)
+        super
+        subclass.instance_variable_set(:@__callback_methods__, @__callback_methods__.dup)
+      end
+
+      def before_call(method_name)
+        @__callback_methods__ << method_name
+      end
+
+      private
+
+      def __run_callbacks__(instance)
+        @__callback_methods__.each { |method_name| instance.__send__(method_name) }
+      end
+    end
+  end
+end

data/lib/resol/result.rb

@@ -10,6 +10,14 @@ module Resol
     # @!method value!
 
     def initialize(*); end
+
+    def or
+      yield(@value) if failure?
+    end
+
+    def either(success_proc, failure_proc)
+      success? ? success_proc.call(@value) : failure_proc.call(@value)
+    end
   end
 
   class Success < Result
@@ -62,11 +70,11 @@ module Resol
     end
   end
 
-  def self.Success(*args)
-    Success.new(*args)
+  def self.Success(...)
+    Success.new(...)
   end
 
-  def self.Failure(*args)
-    Failure.new(*args)
+  def self.Failure(...)
+    Failure.new(...)
   end
 end

data/lib/resol/service.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "builder"
+require_relative "callbacks"
 require_relative "result"
 
 module Resol
@@ -41,6 +42,7 @@ module Resol
 
     include SmartCore::Initializer
     include Resol::Builder
+    include Resol::Callbacks
 
     class << self
       def inherited(klass)
@@ -49,8 +51,9 @@ module Resol
         super
       end
 
-      def call(*args, **options, &block)
-        command = build(*args, **options)
+      def call(*args, **kwargs, &block)
+        command = build(*args, **kwargs)
+        __run_callbacks__(command)
         command.call(&block)
 
         error_message = "No success! or fail! called in the #call method in #{command.class}"
@@ -61,8 +64,8 @@ module Resol
         Resol::Failure(e)
       end
 
-      def call!(*args)
-        call(*args).value_or { |error| raise error }
+      def call!(...)
+        call(...).value_or { |error| raise error }
       end
     end
 

data/lib/resol/version.rb

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

metadata

@@ -1,37 +1,51 @@
 --- !ruby/object:Gem::Specification
 name: resol
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Aleksei Bespalov
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-08 00:00:00.000000000 Z
+date: 2021-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: smart_initializer
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: uber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: bundler-audit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -39,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: ci-helper
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,7 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rubocop-config-umbrellio
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -122,6 +136,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov-lcov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Gem for creating (any) object patterns
 email:
 - nulldefiner@gmail.com
@@ -130,7 +158,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/main.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - Gemfile
@@ -143,6 +171,7 @@ files:
 - bin/setup
 - lib/resol.rb
 - lib/resol/builder.rb
+- lib/resol/callbacks.rb
 - lib/resol/result.rb
 - lib/resol/service.rb
 - lib/resol/version.rb
@@ -150,7 +179,7 @@ homepage: https://github.com/umbrellio/resol
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -158,15 +187,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.15
+signing_key:
 specification_version: 4
 summary: Gem for creating (any) object patterns
 test_files: []

data/.github/workflows/main.yml

@@ -1,25 +0,0 @@
-name: Ruby
-
-on: [push,pull_request]
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v2
-
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: 2.7.0
-
-    - name: Bundling
-      run: |
-        gem install bundler -v 2.2.3
-        bundle install
-
-    - name: Linting
-      run: bin/rubocop
-
-    - name: Testing
-      run: COVER=1 bin/rspec