optiomist 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 92591eacce063dae48757d001e0e17accc035e2b68e39225861f79d806841b61
+  data.tar.gz: 4eabdd213206dcc2d50dc91a283bef7ecc86d4e670905b6a9604d4a1e8a46864
+SHA512:
+  metadata.gz: af6e43b6ef52f8dad6605956a822cb34be88c4c44c6038e920581dffafb2790df2386589095d2a417f40c5bf68caba23a50d24e0f151429f613a86c016df1859
+  data.tar.gz: 1d5f7298797532d8dacf35d80786f90abb43e47f6deffdda6765a09a66523ca08c7d5e1f57ebd1a8cbde3e49d6915f7669e339fb5f33103b148d89e8af5ac4f5

data/README.md

@@ -0,0 +1,27 @@
+# optiomist
+A simple implementation of an optional value pattern.
+
+Let's be optimistic. The glass will never be half nil.
+# Usage
+
+```
+require 'optiomist'
+
+result = Optiomist.some('value')
+result.some? # => true
+result.none? # => false
+result.value # => 'value'
+
+result = Optiomist.some(nil)
+result.some? # => true
+result.value # => nil
+
+result = Optiomist.none
+result.none? # => true
+result.some? # => false
+```
+
+# Running tests
+```
+./run_tests
+```

data/lib/optiomist.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require 'singleton'
+
+# Defines optional values.
+module Optiomist
+  # There is some value.
+  # Warning: +nil+ is also treated as a correct value.
+  #
+  # Example:
+  #   >> result = Optiomist.some('x')
+  #   >> result.some?
+  #   => true
+  #   >> result.value
+  #   => 'x'
+  class Some
+    # This is the value.
+    attr_reader :value
+
+    def initialize(value)
+      @value = value
+    end
+
+    # It's +true+.
+    def some?
+      true
+    end
+
+    # It's +false+.
+    def none?
+      false
+    end
+  end
+
+  # There is no value.
+  #
+  # Example:
+  #   >> result = Optiomist.none
+  #   >> result.none?
+  #   => true
+  class None
+    include Singleton
+
+    # Should it really respond to +nil?+
+    def nil?
+      true
+    end
+
+    # It's +false+.
+    def some?
+      false
+    end
+
+    # It's +true+.
+    def none?
+      true
+    end
+  end
+
+  # A shortcut to create +Option::Some+ for given +value+.
+  def self.some(value)
+    Some.new(value)
+  end
+
+  # A shortcut to get +Option::None+.
+  def self.none
+    None.instance
+  end
+end

metadata

@@ -0,0 +1,47 @@
+--- !ruby/object:Gem::Specification
+name: optiomist
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Michał Radmacher
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-09-08 00:00:00.000000000 Z
+dependencies: []
+description: Optiomist represents an optional value. Be an optimist. The glass will
+  never be half nil.
+email: michal@radmacher.pl
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- README.md
+- lib/optiomist.rb
+homepage: https://github.com/mradmacher/optiomist
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message: 
+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.1.2
+signing_key: 
+specification_version: 4
+summary: A simple implementation of an optional value pattern
+test_files: []