zx-result 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0256c3f98b2f2fa7a72ae9a3ab3e0db5700583c6275fa38b38b1111fb9c4f5f1
+  data.tar.gz: 13a29cde376b2d95d3c75500b917c3caaede5a7dac1b9e9d56111e73b2706711
+SHA512:
+  metadata.gz: efd4d61b29da7587bd6bc408ccf113d2f61ba5d30c5708ac7957dc8da78e0b022bab2a61f5938d307efb77bbd25806f74dfa516b508762b2741a75167a082e3f
+  data.tar.gz: 5630e13604ab28ad36cede46b812795b47994e35fdf34c350d407eca6981a77216a6fb3909afef13885ac58539f9986e95186b0de5bbfe73a68c9c553d88264e

data/.editorconfig

@@ -0,0 +1,12 @@
+# EditorConfig is awesome: https://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = false
+insert_final_newline = false

data/.github/workflows/ci.yml

@@ -0,0 +1,28 @@
+name: ci
+
+on: [push]
+
+permissions:
+  contents: read
+
+jobs:
+  rspec:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.7', '3.0', '3.1']
+
+    steps:
+    - uses: actions/checkout@v3
+      
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@2b019609e2b0f1ea1a2bc8ca11cb82ab46ada124
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+        
+    - name: Run RSpec
+      run: bundle exec rspec --color

data/.gitignore

@@ -0,0 +1,17 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+/.idea/
+.byebug_history
+.DS_store
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--format progress
+--no-profile

data/.rubocop.yml

@@ -0,0 +1,67 @@
+Style/Documentation:
+  Enabled: false
+
+Style/DocumentationMethod:
+  Enabled: false
+
+Style/ModuleFunction:
+  Enabled: false
+
+Style/Lambda:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 15
+
+Layout/LineLength:
+  Max: 150
+
+Layout/FirstArrayElementIndentation:
+  Enabled: false
+
+Layout/MultilineMethodCallIndentation:
+  Enabled: false
+
+Style/MutableConstant:
+  Enabled: true
+
+Layout/FirstHashElementIndentation:
+  Enabled: false
+
+Naming/MethodName:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: true
+  SafeAutoCorrect: true
+  Exclude:
+    - bin/**/*
+    - config.ru
+    - Gemfile
+    - Rakefile
+
+AllCops:
+  DisabledByDefault: false
+  NewCops: enable
+  TargetRubyVersion: 2.7.6
+  # Exclude:
+  #   - 'spec/factories/*.rb'
+  #   - *.gemspec
+
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%i': '()'
+
+Lint/DeprecatedConstants:
+  Enabled: true

data/.ruby-version

@@ -0,0 +1 @@
+2.7.6

data/.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+  "vscode-run-rspec-file.custom-command": "bundle exec rspec --color"
+}

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at tadeuu@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+gemspec
+
+ruby '>= 2.5.8'
+
+group :test do
+  gem 'byebug'
+  gem 'rspec'
+  gem 'simplecov', require: false
+end
+
+gem 'rubocop', github: 'rubocop/rubocop', require: false

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright 2023 Thadeu Esteves Jr
+
+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,242 @@
+<p align="center">
+  <h1 align="center">🔃 Zx::Result</h1>
+  <p align="center"><i>Functional result object for Ruby</i></p>
+</p>
+
+<p align="center">
+  <a href="https://rubygems.org/gems/zx-result">
+    <img alt="Gem" src="https://img.shields.io/gem/v/zx-result.svg">    
+  </a>
+
+  <a href="https://github.com/thadeu/zx-result/actions/workflows/ci.yml">
+    <img alt="Build Status" src="https://github.com/thadeu/zx-result/actions/workflows/ci.yml/badge.svg">
+  </a>
+</p>
+
+
+## Motivation
+
+Because in sometimes, we need to create a safe return for our objects. This gem simplify this work.
+
+## Documentation <!-- omit in toc -->
+
+Version    | Documentation
+---------- | -------------
+unreleased | https://github.com/thadeu/zx-result/blob/main/README.md
+
+## Table of Contents <!-- omit in toc -->
+  - [Installation](#installation)
+  - [Usage](#usage)
+
+## Compatibility
+
+| kind           | branch  | ruby               |
+| -------------- | ------- | ------------------ |
+| unreleased     | main    | >= 2.5.8, <= 3.1.x |
+
+## Installation
+
+Use bundle
+
+```ruby
+bundle add zx-result
+```
+
+or add this line to your application's Gemfile.
+
+```ruby
+gem 'zx-result'
+```
+
+and then, require module
+
+```ruby
+require 'zx'
+```
+
+## Configuration
+
+Without configuration, because we use only Ruby. ❤️
+
+## Usage
+
+
+### Success Type
+
+```ruby
+result = Zx.Success(5)
+result.success? #=> true
+result.failure? #=> false
+result.value #=> 5
+result.value! #=> 5 or raise
+result.error #=> nil or raises an exception
+```
+
+```ruby
+result = Zx.Success(5, type: :integer)
+result.success? #=> true
+result.failure? #=> false
+result.value #=> 5
+result.value! #=> 5 or raise
+result.error #=> nil or raises an exception
+result.type #=> :integer
+```
+
+### Failure Type
+
+```ruby
+result = Zx.Failure(:fizz)
+result.success? #=> false
+result.failure? #=> true
+result.value #=> raises an exception
+result.error #=> :fizz
+result.type #=> :error
+```
+
+```ruby
+result = Zx.Failure(:fizz, type: :not_found)
+result.success? #=> false
+result.failure? #=> true
+result.value #=> raises an exception
+result.error #=> :fizz
+result.type #=> :not_found
+```
+
+### Map or Then
+
+```ruby
+result = Zx.Success(5, type: :integer)
+  .fmap{ |number| number + 5 }
+  .fmap{ |number| number + 5 }
+  .fmap{ |number| number + 5 }
+  .on_success(:integer) {|number| puts number } #=> 20
+  .on(:success, :integer) {|number| puts number } #=> 20
+  .on_success {|number| puts number } #=> 20
+
+result.success? #=> true
+result.failure? #=> false
+result.value #=> 20
+result.value! #=> 20 or raise
+result.error #=> nil or raises a  n exception
+result.type #=> :integer
+```
+
+```ruby
+result = Zx.Success(5, type: :integer)
+  .then{ |number| number + 5 }
+  .then{ |number| number + 5 }
+  .then{ |number| number + 5 }
+  .on_success{|number| puts number } #=> 20
+
+result.success? #=> true
+result.failure? #=> false
+result.value #=> 20
+result.value! #=> 20 or raise
+result.error #=> nil or raises an exception
+result.type #=> :integer
+```
+
+You can use one or multiples listeners in your result. We see some use cases.
+
+**Simple composition**
+
+```ruby
+class AsIncluded
+  include Zx
+
+  def pass(...)
+    Success(...)
+  end
+
+  def passthrough(value)
+    Success[value]
+  end
+
+  def failed(error)
+    Failure[error, type: :error]
+  end
+end
+
+result = AsIncluded.new.pass('save record!')
+
+result
+  .on(:success, :success) { expect(_1).to eq(a: 1) }
+  .on(:success, :mailer) { expect(_1).to eq(a: 1) }
+  .on(:success, :persisted) { expect(_1).to eq('save record!') }
+  .on(:success) { |value, (type)| expect([value, type]).to eq(['save record!', :persisted]) }
+  .on(:failure, :error) { expect(_1).to eq('on error') }
+  .on(:failure, :record_not_found) { expect(_1).to eq('not found user') }
+```
+
+**Simple Inherit**
+
+```ruby
+class AsInherited < Zx::Result
+  def pass(...)
+    Success(...)
+  end
+
+  def passthrough(value)
+    Success[value]
+  end
+
+  def failed(error)
+    Failure(error, type: :error)
+  end
+end
+
+result = AsInherited.new.pass('save record!')
+
+result
+  .on(:success, :success) { expect(_1).to eq(a: 1) }
+  .on(:success, :mailer) { expect(_1).to eq(a: 1) }
+  .on(:success, :persisted) { expect(_1).to eq('save record!') }
+  .on(:success) { |value, (type)| expect([value, type]).to eq(['save record!', :persisted]) }
+  .on(:failure, :error) { expect(_1).to eq('on error') }
+  .on(:failure, :record_not_found) { expect(_1).to eq('not found user') }
+```
+
+You can use directly methods, for example:
+
+```ruby
+Zx::Result.Success(relation)
+
+# or
+
+Zx::Result::Success[relation]
+
+# or
+
+
+Zx::Success[relation]
+```
+
+```ruby
+Zx::Result.Failure('error', type: :invalid)
+
+# or
+
+Zx::Result::Failure[:invalid_user, 'user was not found']
+
+# or
+
+Zx::Failure[:invalid_user, 'user was not found']
+```
+
+
+[⬆️ &nbsp;Back to Top](#table-of-contents-)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec 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 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/thadeu/zx-result. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/thadeu/zx-result/blob/master/CODE_OF_CONDUCT.md).
+
+
+## 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,13 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+RuboCop::RakeTask.new(:rubocop) do |t|
+  t.options = ['--display-cop-names']
+end
+
+task default: %i(spec rubocop)

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'zx'
+
+# 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,9 @@
+#!/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/lib/zx/result.rb

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+
+module Zx
+  class Result
+    class FailureError < StandardError; end
+
+    def initialize
+      @value = nil
+      @success = true
+      @exception = false
+      @type = nil
+    end
+
+    attr_reader :value, :type
+
+    def error
+      @value unless type == :ok
+    end
+
+    def success?
+      !!@success
+    end
+
+    def failure?
+      !success?
+    end
+
+    def value!
+      @value || raise(FailureError)
+    end
+
+    def deconstruct
+      [type, value]
+    end
+
+    def deconstruct_keys(_)
+      { type: type, value: value, error: error }
+    end
+
+    def on_unknown(&block)
+      __execute__(nil, &block)
+    end
+
+    def on_success(tag = nil, &block)
+      return self if failure?
+
+      __execute__(tag, &block)
+
+      self
+    end
+
+    def on_failure(tag = nil, &block)
+      return self if success?
+
+      __execute__(tag, &block)
+
+      self
+    end
+
+    def on(ontype, tag = nil, &block)
+      case ontype.to_sym
+      when :success then on_success(tag, &block)
+      when :failure then on_failure(tag, &block)
+      end
+    end
+    alias >> on
+    alias | on
+    alias pipe on
+
+    def then(&block)
+      fmap(&block)
+    end
+
+    def fmap(&block)
+      return self if failure?
+
+      new_value = block.call @value
+      @value = new_value
+
+      self
+    end
+
+    def failure!(value = nil, type: :error)
+      @type = type.to_sym
+      @success = false
+      @value = value
+
+      self
+    end
+
+    def success!(value = nil, type: :ok)
+      @type = type.to_sym
+      @success = true
+      @value = value
+
+      self
+    end
+
+    def __execute__(tag = nil, &block)
+      return block.call(@value, [@type, @success]) if tag.nil?
+
+      block.call(@value, [@type, @success]) if @type == tag.to_sym
+    end
+    private :__execute__
+
+    def Success(value = nil, options = {})
+      success!(value, type: options.fetch(:type, :ok))
+    end
+    
+    def Success!(value = nil, options = {})
+      success!(value, type: options.fetch(:type, :ok))
+    end
+
+    def Failure(value = nil, options = {})
+      failure!(value, type: options.fetch(:type, :error))
+    end
+    
+    def Failure!(value = nil, options = {})
+      failure!(value, type: options.fetch(:type, :error))
+    end
+
+    def self.Success(value = nil, options = {})
+      new.success!(value, type: options.fetch(:type, :ok))
+    end
+
+    def self.Success!(...)
+      Success(...)
+    end
+
+    def self.Failure(value = nil, options = {})
+      new.failure!(value, type: options.fetch(:type, :error))
+    end
+
+    def self.Failure!(...)
+      Failure(...)
+    end
+
+    Success = ->(*kwargs) { Success(*kwargs) }
+    Failure = ->(*kwargs) { Failure(*kwargs) }
+  end
+end

data/lib/zx/version.rb

@@ -0,0 +1,3 @@
+module Zx
+  VERSION = '0.0.1'.freeze
+end

data/lib/zx.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'zx/result'
+
+module Zx
+  module Extendable
+    Success = ->(*kwargs) { Result.Success(*kwargs) }
+    Failure = ->(*kwargs) { Result.Failure(*kwargs) }
+
+    def Success(...)
+      Result.Success(...)
+    end
+
+    def Failure(...)
+      Result.Failure(...)
+    end
+  end
+
+  include Extendable
+  extend Extendable
+end

data/zx-result.gemspec

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'zx/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'zx-result'
+  spec.version       = Zx::VERSION
+  spec.authors       = ['Thadeu Esteves']
+  spec.email         = ['tadeuu@gmail.com']
+  spec.summary       = 'Functional result object for Ruby'
+  spec.description   = 'Expose an methods to create result object flow'
+  spec.homepage      = 'https://github.com/thadeu/zx-result'
+  spec.license       = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.required_ruby_version = '>= 2.7.6'
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '>= 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.70'
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: zx-result
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Thadeu Esteves
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-09-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.70'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.70'
+description: Expose an methods to create result object flow
+email:
+- tadeuu@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".vscode/settings.json"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/zx.rb
+- lib/zx/result.rb
+- lib/zx/version.rb
+- zx-result.gemspec
+homepage: https://github.com/thadeu/zx-result
+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.7.6
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: Functional result object for Ruby
+test_files: []