resol 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f71f97e92852c4b25525cf1388c8cc671bc5587d7535fa844e3a681c686c14d1
+  data.tar.gz: 996140397a4d0c0bd04a426c30f0da88a423495e9e80715e2722a1089fd3656e
+SHA512:
+  metadata.gz: 638959dfb203d736a85c79c3c271b716d08be263e88b8509210ff712715f12fddcfd27d2600dfbee1e0cf39fd84b89def3a0ee1323bb27451d90cbb407cc8edb
+  data.tar.gz: 1b89eb69a71e3d43da7520e4f90789b7e6b2a33716dabc9b163a8d6fc1ce70a424c40430b5e982ee3adec3e7fd0fed1c17921adf1f1e1706199febaa7f8fbcfd

data/.github/workflows/main.yml

@@ -0,0 +1,25 @@
+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

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rubocop.yml

@@ -0,0 +1,23 @@
+AllCops:
+  TargetRubyVersion: 2.6
+  NewCops: enable
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/RaiseArgs:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 100
+
+Layout/FirstArrayElementIndentation:
+  EnforcedStyle: consistent

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,97 @@
+PATH
+  remote: .
+  specs:
+    resol (0.1.0)
+      smart_initializer
+      uber
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    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)
+    diff-lcs (1.4.4)
+    docile (1.3.5)
+    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)
+    parallel (1.20.1)
+    parser (3.0.1.0)
+      ast (~> 2.4.1)
+    pry (0.14.0)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    qonfig (0.25.0)
+    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)
+      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)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (0.93.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8)
+      rexml
+      rubocop-ast (>= 0.6.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.4.1)
+      parser (>= 2.7.1.5)
+    ruby-progressbar (1.11.0)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.2)
+    smart_engine (0.11.0)
+    smart_initializer (0.5.0)
+      qonfig (~> 0.24)
+      smart_engine (~> 0.11)
+      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)
+    uber (0.1.0)
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  x86_64-darwin-19
+
+DEPENDENCIES
+  coveralls
+  pry
+  rake
+  resol!
+  rspec
+  rubocop
+  simplecov
+
+BUNDLED WITH
+   2.2.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 appuser
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,94 @@
+# Resol
+
+![https://github.com/umbrellio/resol](https://github.com/umbrellio/resol/actions/workflows/main.yml/badge.svg)
+
+Ruby Gem for creating simple service objects and other any object ruby patterns.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'resol'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install resol
+
+## Usage
+
+### Sample usage
+
+```ruby
+class FindUser < Resol::Service
+  param :id
+
+  def call
+    user = User.find(id)
+    if user
+      success!(user)
+    else
+      fail!(:not_found)
+    end
+  end
+end
+
+# when user exists
+FindUser.call(1) # => Resol::Success(<user object>)
+FindUser.call!(1) # => <user object>
+
+# when user doesn't exist
+FindUser.call(100) # => Resol::Failure(:not_found)
+FindUser.call!(100) # => raised FindUser::Failure: :not_found
+```
+
+So method `.call` always returns the [result object](#result-objects)
+and method `.call!` returns a value or throws an error (in case of `fail!` has been called).
+
+#### Params defining
+
+All incoming params and options can be defined using a [smart_initializer](https://github.com/smart-rb/smart_initializer) gem interface.
+
+#### Return a result
+
+**Note** – calling `success!`/`fail!` methods interrupts `call` method execution.
+
+- `success!(value)` – finish with a success value
+- `fail!(code, data = nil)` – fail with any error code and optional data
+
+### Result objects
+
+Methods:
+
+- `success?` – returns `true` for success result and `false` for failure result
+- `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)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/rspec` to run the tests.
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/umbrellio/resol.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Authors
+
+Created by [Aleksei Bespalov](https://github.com/nulldef).
+
+<a href="https://github.com/umbrellio/">
+<img style="float: left;" src="https://umbrellio.github.io/Umbrellio/supported_by_umbrellio.svg" alt="Supported by Umbrellio" width="439" height="72">
+</a>

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "resol"
+require "pry"
+
+Pry.start

data/bin/rubocop

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle exec rubocop

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/lib/resol.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "uber/builder"
+require "smart_core/initializer"
+
+require_relative "resol/version"
+require_relative "resol/service"
+
+module Resol
+end

data/lib/resol/builder.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Resol
+  module Builder
+    def self.included(base)
+      base.include(Uber::Builder)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def build_klass(*args, **kwargs)
+        klass = self
+
+        loop do
+          new_klass = klass.build!(klass, *args, **kwargs)
+          break if new_klass == klass
+
+          klass = new_klass
+        end
+
+        klass
+      end
+
+      def build(*args)
+        build_klass(*args).new(*args)
+      end
+    end
+  end
+end

data/lib/resol/result.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module Resol
+  class UnwrapError < StandardError; end
+
+  class Result
+    # @!method success?
+    # @!method failure?
+    # @!method value_or
+    # @!method value!
+
+    def initialize(*); end
+  end
+
+  class Success < Result
+    def initialize(value)
+      super
+      @value = value
+    end
+
+    def success?
+      true
+    end
+
+    def failure?
+      false
+    end
+
+    def value_or(*)
+      @value
+    end
+
+    def value!
+      @value
+    end
+  end
+
+  class Failure < Result
+    def initialize(error)
+      super
+      @value = error
+    end
+
+    def success?
+      false
+    end
+
+    def failure?
+      true
+    end
+
+    def value_or(other_value = nil)
+      if block_given?
+        yield(@value)
+      else
+        other_value
+      end
+    end
+
+    def value!
+      raise UnwrapError, "Failure result #{@value.inspect}"
+    end
+  end
+
+  def self.Success(*args)
+    Success.new(*args)
+  end
+
+  def self.Failure(*args)
+    Failure.new(*args)
+  end
+end

data/lib/resol/service.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require_relative "builder"
+require_relative "result"
+
+module Resol
+  class Service
+    class InvalidCommandImplementation < StandardError; end
+
+    class Interruption < StandardError
+      attr_accessor :data
+
+      def initialize(data)
+        self.data = data
+        super
+      end
+
+      def inspect
+        "#{self.class.name}: #{message}"
+      end
+
+      def message
+        data.inspect
+      end
+    end
+
+    class Failure < Interruption
+      attr_accessor :code
+
+      def initialize(code, data)
+        self.code = code
+        super(data)
+      end
+
+      def message
+        data ? "#{code.inspect} => #{data.inspect}" : code.inspect
+      end
+    end
+
+    class Success < Interruption; end
+
+    include SmartCore::Initializer
+    include Resol::Builder
+
+    class << self
+      def inherited(klass)
+        klass.const_set(:Failure, Class.new(klass::Failure))
+        klass.const_set(:Success, Class.new(klass::Success))
+        super
+      end
+
+      def call(*args, **options, &block)
+        command = build(*args, **options)
+        command.call(&block)
+
+        error_message = "No success! or fail! called in the #call method in #{command.class}"
+        raise InvalidCommandImplementation, error_message
+      rescue self::Success => e
+        Resol::Success(e.data)
+      rescue self::Failure => e
+        Resol::Failure(e)
+      end
+
+      def call!(*args)
+        call(*args).value_or { |error| raise error }
+      end
+    end
+
+    # @!method call
+
+    private
+
+    def fail!(code, data = nil)
+      raise self.class::Failure.new(code, data)
+    end
+
+    def success!(data = nil)
+      raise self.class::Success.new(data)
+    end
+  end
+end

data/lib/resol/version.rb

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

metadata

@@ -0,0 +1,172 @@
+--- !ruby/object:Gem::Specification
+name: resol
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Aleksei Bespalov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-04-08 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: uber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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
+- oss@umbrellio.biz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/rubocop
+- bin/setup
+- lib/resol.rb
+- lib/resol/builder.rb
+- lib/resol/result.rb
+- lib/resol/service.rb
+- lib/resol/version.rb
+homepage: https://github.com/umbrellio/resol
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Gem for creating (any) object patterns
+test_files: []