rs-result 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 85d0bd21d2e9cdae59b4b8824bbacbfef2780792b8b3398d3a5e962efab3078d
+  data.tar.gz: dff2d34b2a2877d1ce5360a2ab979bb4dfde8b595c0459d67926c3f29238bd58
+SHA512:
+  metadata.gz: 761f77d7b69bbfceccfdd5a8ebb3a1b5e79ed72e405bc4325326230c3f94ccd9dc66486d25cfc44eb7ecd389325c318f167fa4ca8a0e91a0008f3b62f250bfe2
+  data.tar.gz: d5af5f8d085a919590858d332b974ed1e79daa46e5b1e0ad41fad448209c6668aa4b66c34cbbcb23e18da91a04664eaf70a8500ad11e49e2f51ebd91e76eabbf

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,8 @@
+inherit_gem:
+  rubocop-config-crystal: .rubocop.yml
+
+Metrics/BlockLength:
+  Enabled: false
+
+Style/MethodCallWithArgsParentheses:
+  Enabled: true

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-11-06
+
+- Initial release

data/README.md

@@ -0,0 +1,34 @@
+# Rs::Result
+
+Bring the Rust [Result Option] type to Ruby
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add rs-result
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install rs-result
+
+## Usage
+
+```ruby
+require "rs/result"
+
+x = Some.new(2)
+x = None.new
+
+x = Ok.new(-3)
+x = Err.new("Some error message")
+```
+## 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 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/[USERNAME]/rs-result.

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: [:spec, :rubocop]

data/lib/rs/option.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require_relative "result/version"
+module Rs
+  # https://doc.rust-lang.org/std/option/index.html
+  # https://doc.rust-lang.org/std/option/enum.Option.html
+  # https://doc.rust-lang.org/src/core/option.rs.html
+  module Option
+    class ArgumentError < StandardError; end
+    class UnwrapNone < StandardError; end
+
+    def some?
+      @some
+    end
+
+    def some_and
+      if !@some
+        false
+      elsif block_given?
+        yield(@value)
+      else
+        @some
+      end
+    end
+
+    def none?
+      !@some
+    end
+
+    def none_or
+      if !@some
+        true
+      elsif block_given?
+        yield(@value)
+      else
+        !@some
+      end
+    end
+
+    def expect(msg)
+      @some ? @value : raise(UnwrapNone, msg)
+    end
+
+    def unwrap
+      @some ? @value : raise(UnwrapNone)
+    end
+
+    def unwrap_or(default = nil)
+      if @some
+        @value
+      elsif block_given?
+        yield
+      else
+        default
+      end
+    end
+
+    def unwrap_or_else(&block)
+      @some ? @value : block.call
+    end
+  end
+end
+
+class Some
+  include Rs::Option
+
+  def initialize(value)
+    if value == nil
+      raise(Rs::Option::ArgumentError, "Some value cannot be nil")
+    end
+
+    @value = value
+    @some = true
+  end
+end
+
+class None
+  include Rs::Option
+
+  def initialize
+    @some = false
+  end
+end

data/lib/rs/result/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Rs
+  module Result
+    VERSION = "0.1.0"
+  end
+end

data/lib/rs/result.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+require_relative "option"
+require_relative "result/version"
+
+module Rs
+  # https://doc.rust-lang.org/std/result/index.html
+  # https://doc.rust-lang.org/std/result/enum.Result.html
+  # https://doc.rust-lang.org/src/core/result.rs.html
+  module Result
+    class ArgumentError < StandardError; end
+    class UnwrapOnErr < StandardError; end
+    class UnwrapErrOnOk < StandardError; end
+
+    def ok?
+      @ok
+    end
+
+    def ok_and
+      if !@ok
+        false
+      elsif block_given?
+        yield(@value)
+      else
+        @ok
+      end
+    end
+
+    def err?
+      !@ok
+    end
+
+    def err_and
+      if @ok
+        false
+      elsif block_given?
+        yield(@value)
+      else
+        !@ok
+      end
+    end
+
+    def ok
+      if @ok
+        Some.new(@value)
+      else
+        None.new
+      end
+    end
+
+    def err
+      if !@ok
+        Some.new(@value)
+      else
+        None.new
+      end
+    end
+
+    def expect(msg)
+      @ok ? @value : raise(UnwrapOnErr, "#{msg}: #{@value}")
+    end
+
+    def unwrap
+      @ok ? @value : raise(UnwrapOnErr, "called `Result::unwrap()` on an `Err` value: #{@value}")
+    end
+
+    def unwrap_or(default = nil)
+      if @ok
+        @value
+      elsif block_given?
+        yield
+      else
+        default
+      end
+    end
+
+    def unwrap_or_else(&block)
+      @ok ? @value : block.call(@value)
+    end
+
+    def expect_err(msg)
+      @ok ? raise(UnwrapErrOnOk, "#{msg}: #{@value}") : @value
+    end
+
+    def unwrap_err
+      @ok ? raise(UnwrapErrOnOk, "called `Result::unwrap_err()` on an `Ok` value: #{@value}") : @value
+    end
+  end
+end
+
+class Ok
+  include Rs::Result
+  def initialize(value)
+    if value == nil
+      raise(Rs::Result::ArgumentError, "Ok value cannot be nil")
+    end
+
+    @value = value
+    @ok = true
+  end
+end
+
+class Err
+  include Rs::Result
+  def initialize(error)
+    @value = error
+    @ok = false
+  end
+end

data/sig/rs/result.rbs

@@ -0,0 +1,6 @@
+module Rs
+  module Result
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -0,0 +1,52 @@
+--- !ruby/object:Gem::Specification
+name: rs-result
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- initdc
+bindir: exe
+cert_chain: []
+date: 2025-11-06 00:00:00.000000000 Z
+dependencies: []
+description: Bring the Rust [Result Option] type to Ruby
+email:
+- initd@outlook.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- README.md
+- Rakefile
+- lib/rs/option.rb
+- lib/rs/result.rb
+- lib/rs/result/version.rb
+- sig/rs/result.rbs
+homepage: https://rubygems.org/gems/rs-result
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://rubygems.org/gems/rs-result
+  source_code_uri: https://github.com/initdc/rs-result
+  changelog_uri: https://github.com/initdc/rs-result/blob/master/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: Bring the Rust [Result Option] type to Ruby
+test_files: []