f_service 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2a994a8e96a8aa3f6db41ba6f9dcb358a716b2c1cdce8e82c8b92f70458e941c
+  data.tar.gz: 99906aece6b382536fcda4ccb21e3874ccc755d6dfc2418fe98dd2019504513d
+SHA512:
+  metadata.gz: 0430b236523a17dae5c2afeb3db37d8354fbdce15f96789121ec184a41004242ccce40bd2a73d742f49a5312efa8dda9e6da207ceff41ef9eafabd03794e88d9
+  data.tar.gz: 3d7c7439d7283f69d494c8e402b2c08f906073c4089d7e031e6b7a00e40b66577ce7aac860b8ed49378335d4be9f867dfeb5a982a2fd6cd9bcb1b34a1094e839

data/.github/workflows/tests-and-linter.yml

@@ -0,0 +1,28 @@
+name: Ruby
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [2.4, 2.5, 2.6, 2.7]
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby ${{ matrix.ruby }}
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Build and test with Rake
+        run: |
+          gem install bundler
+          bundle install --jobs 4 --retry 3
+          bundle exec rake
+      - name: Rubocop Linter Action
+        run: bundle exec rubocop --parallel

data/.gitignore

@@ -0,0 +1,58 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*
+
+.rspec_status

data/.rubocop.yml

@@ -0,0 +1,15 @@
+require:
+  - rubocop-rspec
+
+AllCops:
+  NewCops: enable
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*"
+
+Style/DocumentationMethod:
+  Enabled: true

data/CHANGELOG.md

@@ -0,0 +1,19 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## Unreleased
+_Nothing here_
+
+## 0.1.1
+### Added
+First usable version with:
+- Result based services;
+- Type check on results;
+- Pattern matching with `#call`ables;
+- Safe chaining calls with `#then`;
+
+## 0.1.0
+- **Yanked**

data/Gemfile

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in f_service.gemspec
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13.0.0'
+  gem 'rubocop', '~> 0.82.0', require: false
+  gem 'rubocop-rspec', require: false
+end
+
+group :docs do
+  gem 'yard'
+end
+
+group :optional do
+  gem 'solargraph'
+end
+
+group :test do
+  gem 'rspec', '~> 3.0'
+  gem 'simplecov', require: false
+end

data/Gemfile.lock

@@ -0,0 +1,90 @@
+PATH
+  remote: .
+  specs:
+    f_service (0.1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    backport (1.1.2)
+    benchmark (0.1.0)
+    diff-lcs (1.3)
+    docile (1.3.2)
+    e2mmap (0.1.0)
+    jaro_winkler (1.5.4)
+    maruku (0.7.3)
+    mini_portile2 (2.4.0)
+    nokogiri (1.10.9)
+      mini_portile2 (~> 2.4.0)
+    parallel (1.19.1)
+    parser (2.7.1.1)
+      ast (~> 2.4.0)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    reverse_markdown (1.4.0)
+      nokogiri
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    rubocop (0.82.0)
+      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, < 2.0)
+    rubocop-rspec (1.38.1)
+      rubocop (>= 0.68.1)
+    ruby-progressbar (1.10.1)
+    simplecov (0.18.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+    simplecov-html (0.12.0)
+    solargraph (0.38.6)
+      backport (~> 1.1)
+      benchmark
+      bundler (>= 1.17.2)
+      e2mmap
+      jaro_winkler (~> 1.5)
+      maruku (~> 0.7, >= 0.7.3)
+      nokogiri (~> 1.9, >= 1.9.1)
+      parser (~> 2.3)
+      reverse_markdown (~> 1.0, >= 1.0.5)
+      rubocop (~> 0.52)
+      thor (~> 1.0)
+      tilt (~> 2.0)
+      yard (~> 0.9)
+    thor (1.0.1)
+    tilt (2.0.10)
+    unicode-display_width (1.7.0)
+    yard (0.9.24)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  f_service!
+  rake (~> 13.0.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.82.0)
+  rubocop-rspec
+  simplecov
+  solargraph
+  yard
+
+BUNDLED WITH
+   2.0.2

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Matheus Richard
+
+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,147 @@
+![CI](https://github.com/Fretadao/f_service/workflows/Ruby/badge.svg)
+
+# FService
+
+FService is a small gem that provides a base class for your services (aka operations).
+The goal is to make services simpler, safer, and more composable.
+It uses the Result monad for handling operations.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'f_service'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install f_service
+
+## Usage
+### Creating your service
+To start using it, you have to create your service class inheriting from FService::Base.
+
+```ruby
+class User::Create < FService::Base
+end
+```
+
+Now, define your initializer to setup data.
+```ruby
+class User::Create < FService::Base
+  def initialize(name:)
+    @name = name
+  end
+end
+```
+
+The next step is writing the `#run` method, which is where the work should be done.
+Use the methods `#success` and `#failure` to handle your return values. The return can be any value.
+
+```ruby
+class User::Create < FService::Base
+  # ...
+  def run
+    return failure("No name given") if @name.nil?
+
+    user = UserRepository.create(name: @name)
+    if user.valid?
+      success(status: "User successfully created!", data: user)
+    else
+      failure(status: "User could not be created!", data: user.errors)
+    end
+  end
+end
+```
+> Remember, you **have** to return an `FService::Result` at the end of your services.
+
+### Using your service
+
+To run your service, use the method `#call` provided by `FService::Base`. We like to use the [implicit call](https://stackoverflow.com/a/19108981/8650655), but you can use it in the form you like most.
+
+```ruby
+User::Create.(name: name)
+# or
+User::Create.call(name: name)
+```
+
+> We do **not** recommend manually initializing your service because it **will not** type check your result (and you could lose nice features like [pattern matching](#pattern-matching) and [service chaining](#chaining-services))!
+
+### Using the result
+
+Use the methods `#successful?` and `#failed?` to check the status of your result. If it is successful, you can access the value with `#value`, and if your service fails, you can access the error with `#error`.
+
+A hypothetical controller action using the example service could look like this:
+
+```ruby
+class UsersController < BaseController
+  def create
+    result = User::Create.(user_params)
+
+    if result.successful?
+      json_success(result.value)
+    else
+      json_error(result.error)
+    end
+  end
+end
+```
+> Note that you're not limited to using services inside controllers. They're just PORO's (Play Old Ruby Objects), so you can use in controllers, models, etc. (even other services!).
+
+### Pattern matching
+The code above could be rewritten using the `#on` matcher too. It works similar to pattern matching:
+
+```ruby
+class UsersController < BaseController
+  def create
+    User::Create.(user_params).on(
+      success: ->(value) { return json_success(value) },
+      failure: ->(error) { return json_error(error) }
+    )
+  end
+end
+```
+> You can use any object that responds to #call, not only Lambdas.
+
+### Chaining services
+Since all services return Results, you can chain service calls making a data pipeline.
+If some step fails, it will short circuit the call chain.
+
+```ruby
+class UsersController < BaseController
+  def create
+    result = User::Create.(user_params)
+                         .then { |user| User::Login.(user) }
+                         .then { |user| User::SendWelcomeEmail.(user) }
+
+    if result.successful?
+      json_success(result.value)
+    else
+      json_error(result.error)
+    end
+  end
+end
+```
+
+## API Docs
+
+You can access the API docs [here](https://www.rubydoc.info/gems/f_service/).
+
+## 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 allows 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 tags, 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/Fretadao/f_service.
+
+## License
+
+The gem is available as open-source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'yard'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+
+YARD::Rake::YardocTask.new

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'f_service'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/f_service.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'f_service/version'
+
+Gem::Specification.new do |spec|
+  spec.name    = 'f_service'
+  spec.version = FService::VERSION
+  spec.authors = ['Matheus Richard']
+  spec.email   = ['matheusrichardt@gmail.com']
+
+  spec.summary     = 'A small, monad-based service class'
+  spec.description = <<-DESCRIPTION
+    FService is a small gem that provides a base class for your services (aka operations).
+    The goal is to make services simpler, safer and more composable.
+    It uses the Result monad for handling operations.
+  DESCRIPTION
+
+  spec.homepage = 'https://github.com/Fretadao/f_service'
+  spec.license  = 'MIT'
+
+  spec.metadata['homepage_uri']    = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/Fretadao/f_service'
+  spec.metadata['documentation_uri'] = 'https://www.rubydoc.info/gems/f_service'
+  # spec.metadata['changelog_uri'] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+end

data/lib/f_service.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative 'f_service/base'
+
+# A small, monad-based service class
+#
+# @api public
+module FService
+end

data/lib/f_service/base.rb

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+require_relative 'result/base'
+require_relative 'result/failure'
+require_relative 'result/success'
+
+module FService
+  # Abstract base class for services.
+  # It provides the basic interface to return and handle results.
+  #
+  # @abstract
+  class Base
+    # Initializes and runs a new service.
+    #
+    # @example
+    #   User::UpdateName.(user: user, new_name: new_name)
+    #   # or
+    #   User::UpdateName.call(user: user, new_name: new_name)
+    #
+    # @note this method shouldn't be overridden in the subclasses
+    # @return [FService::Result::Success, FService::Result::Failure]
+    def self.call(*params)
+      result = new(*params).run
+      raise(FService::Error, 'Services must return a Result') unless result.is_a? Result::Base
+
+      result
+    end
+
+    # This method is where the main work of your service must be.
+    # It is called after initilizing the service and should return
+    # an FService::Result.
+    #
+    # @example
+    #   class User::UpdateName < FService::Base
+    #     def initialize(user:, new_name:)
+    #       @user = user
+    #       @new_name = new_name
+    #     end
+    #
+    #     def run
+    #       return failure('Missing user') if user.nil?
+    #
+    #       if @user.update(name: @new_name)
+    #         success(status: 'User successfully updated!', data: user)
+    #       else
+    #         failure(status: 'User could not be updated.', data: user.errors)
+    #       end
+    #     end
+    #   end
+    #
+    # @note this method SHOULD be overridden in the subclasses
+    # @return [FService::Result::Success, FService::Result::Failure]
+    def run
+      raise NotImplementedError, 'Services must implement #run'
+    end
+
+    # Returns a successful operation.
+    # You'll probably want to return this inside {#run}.
+    #
+    #
+    # @example
+    #   class User::ValidateAge < FService::Base
+    #     def initialize(age:)
+    #       @age = age
+    #     end
+    #
+    #     def run
+    #       return failure(status: 'No age given!', data: @age) if age.blank?
+    #       return failure(status: 'Too young!', data: @age) if age < 18
+    #
+    #       success(status: 'Valid age.', data: @age)
+    #     end
+    #   end
+    #
+    # @return [FService::Result::Success] - a successful operation
+    def success(data = nil)
+      FService::Result::Success.new(data)
+    end
+
+    # Returns a failed operation.
+    # You'll probably want to return this inside {#run}.
+    # @example
+    #   class User::ValidateAge < FService::Base
+    #     def initialize(age:)
+    #       @age = age
+    #     end
+    #
+    #     def run
+    #       return failure(status: 'No age given!', data: @age) if age.blank?
+    #       return failure(status: 'Too young!', data: @age) if age < 18
+    #
+    #       success(status: 'Valid age.', data: @age)
+    #     end
+    #   end
+    #
+    # @return [FService::Result::Failure] - a failed operation
+    def failure(data = nil)
+      FService::Result::Failure.new(data)
+    end
+
+    # Return either {FService::Result::Failure Success} or {FService::Result::Failure Failure}
+    # given the condition.
+    #
+    # @example
+    #   class YearIsLeap < FService::Base
+    #     def initialize(year:)
+    #       @year = year
+    #     end
+    #
+    #     def run
+    #       return failure(status: 'No year given!', data: @year) if @year.nil?
+    #
+    #       result(leap?, @year)
+    #     end
+    #
+    #     private
+    #
+    #     def leap?
+    #       ((@year % 4).zero? && @year % 100 != 0) || (@year % 400).zero?
+    #     end
+    #   end
+    #
+    # @return [FService::Result::Success, FService::Result::Failure]
+    def result(condition, data = nil)
+      condition ? success(data) : failure(data)
+    end
+  end
+end

data/lib/f_service/errors.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module FService
+  # General FService error
+  class Error < StandardError; end
+
+  module Result
+    # Fservice::Result related error
+    class Error < Error; end
+  end
+end

data/lib/f_service/result/base.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module FService
+  # Includes representations of operations that can be successful or failed.
+  module Result
+    # Abstract base class for Result::Success and Result::Failure.
+    #
+    # @abstract
+    class Base
+      %i[initialize then successful? failed? value value! error].each do |method_name|
+        define_method(method_name) do |*_args|
+          raise NotImplementedError, "called #{method_name} on class Result::Base"
+        end
+      end
+
+      # "Pattern matching"-like method for results.
+      # It will run the success path if Result is a Success.
+      # Otherwise, it will run the failure path.
+      #
+      #
+      # @example
+      #   class UsersController < BaseController
+      #     def update
+      #       User::Update.(user: user).on(
+      #         success: ->(value) { return json_success(value) },
+      #         failure: ->(error) { return json_error(error) }
+      #       )
+      #     end
+      #
+      #     private
+      #
+      #     def user
+      #       @user ||= User.find_by!(slug: params[:slug])
+      #     end
+      #   end
+      #
+      # @param success [#call] a lambda (or anything that responds to #call) to run on success
+      # @param failure [#call] a lambda (or anything that responds to #call) to run on failure
+      # @api public
+      def on(success:, failure:)
+        if successful?
+          success.call(value)
+        else
+          failure.call(error)
+        end
+      end
+    end
+  end
+end

data/lib/f_service/result/failure.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+require_relative '../errors'
+
+module FService
+  module Result
+    # Represents a value of a failed operation.
+    # The error field can contain any information you want.
+    #
+    # @api public
+    class Failure < Result::Base
+      # Returns the provided error
+      attr_reader :error
+
+      # Creates a failed operation.
+      # You usually shouldn't call this directly. See {FService::Base#failure}.
+      #
+      # @param error [Object] failure value.
+      def initialize(error)
+        @error = error
+        freeze
+      end
+
+      # Returns false.
+      #
+      #
+      # @example
+      #   # Suppose that User::Update returns an FService::Result
+      #
+      #   log_errors(user) unless User::Update.(user: user).successful?
+      def successful?
+        false
+      end
+
+      # Returns true.
+      #
+      #
+      # @example
+      #   # Suppose that User::Update returns an FService::Result
+      #
+      #   log_errors(user) if User::Update.(user: user).failed?
+      def failed?
+        true
+      end
+
+      # Failed operations do not have value.
+      def value
+        nil
+      end
+
+      # Raises an exception if called.
+      # (see #value)
+      def value!
+        raise Result::Error, 'Failure objects do not have value'
+      end
+
+      # Returns itself to the given block.
+      # Use this to chain multiple service calls (since all services return Results).
+      # It will short circuit your service call chain.
+      #
+      #
+      # @example
+      #   class UsersController < BaseController
+      #     def create
+      #       result = User::Create.(user_params) # if this fails the following calls won't run
+      #                 .then { |user| User::SendWelcomeEmail.(user: user) }
+      #                 .then { |user| User::Login.(user: user) }
+      #
+      #       if result.successful?
+      #         json_success(result.value)
+      #       else
+      #         json_error(result.error)
+      #       end
+      #     end
+      #   end
+      #
+      # @return [self]
+      def then
+        self
+      end
+
+      # Outputs a string representation of the object
+      #
+      #
+      # @example
+      #   puts FService::Result::Failure.new("Oh no!")
+      #   # => Failure("Oh no!")
+      #
+      # @return [String] the object's string representation
+      def to_s
+        error.nil? ? 'Failure()' : "Failure(#{error.inspect})"
+      end
+    end
+  end
+end

data/lib/f_service/result/success.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module FService
+  module Result
+    # Represents a value of a successful operation.
+    # The value field can contain any information you want.
+    #
+    # @api public
+    class Success < Result::Base
+      # Returns the provided value.
+      attr_reader :value
+
+      # Creates a successful operation.
+      # You usually shouldn't call this directly. See {FService::Base#success}.
+      #
+      # @param value [Object] success value.
+      def initialize(value)
+        @value = value
+        freeze
+      end
+
+      # Returns true.
+      #
+      #
+      # @example
+      #   # Suppose that User::Update returns an FService::Result
+      #
+      #   log_errors(user) unless User::Update.(user: user).successful?
+      def successful?
+        true
+      end
+
+      # Returns false.
+      #
+      #
+      # @example
+      #   # Suppose that User::Update returns an FService::Result
+      #
+      #   log_errors(user) if User::Update.(user: user).failed?
+      def failed?
+        false
+      end
+
+      # (see #value)
+      def value!
+        value
+      end
+
+      # Successful operations do not have error.
+      #
+      # @return [nil]
+      def error
+        nil
+      end
+
+      # Returns its value to the given block.
+      # Use this to chain multiple service calls (since all services return Results).
+      #
+      #
+      # @example
+      #   class UsersController < BaseController
+      #     def create
+      #       result = User::Create.(user_params)
+      #                 .then { |user| User::SendWelcomeEmail.(user: user) }
+      #                 .then { |user| User::Login.(user: user) }
+      #
+      #       if result.successful?
+      #         json_success(result.value)
+      #       else
+      #         json_error(result.error)
+      #       end
+      #     end
+      #   end
+      #
+      # @yieldparam [result] value pass {#value} to a block
+      def then
+        yield value
+      end
+
+      # Outputs a string representation of the object
+      #
+      #
+      # @example
+      #   puts FService::Result::Success.new("Yay!")
+      #   # => Success("Yay!")
+      #
+      # @return [String] the object's string representation
+      def to_s
+        value.nil? ? 'Success()' : "Success(#{value.inspect})"
+      end
+    end
+  end
+end

data/lib/f_service/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module FService
+  # Current version of the gem
+  VERSION = '0.1.1'
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: f_service
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Matheus Richard
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-05-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: |2
+      FService is a small gem that provides a base class for your services (aka operations).
+      The goal is to make services simpler, safer and more composable.
+      It uses the Result monad for handling operations.
+email:
+- matheusrichardt@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/tests-and-linter.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- f_service.gemspec
+- lib/f_service.rb
+- lib/f_service/base.rb
+- lib/f_service/errors.rb
+- lib/f_service/result/base.rb
+- lib/f_service/result/failure.rb
+- lib/f_service/result/success.rb
+- lib/f_service/version.rb
+homepage: https://github.com/Fretadao/f_service
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Fretadao/f_service
+  source_code_uri: https://github.com/Fretadao/f_service
+  documentation_uri: https://www.rubydoc.info/gems/f_service
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A small, monad-based service class
+test_files: []