lamy_result 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9de251784cf83e80ac19a2f8d08bd00de25269ccae683b518570bcf710cf5918
-  data.tar.gz: 287d464139c3ae445e4cbdf477e9ea4109f08dde36db4394e79f5613fc5be00d
+  metadata.gz: 7f54a9321e1e265a16acd63a030358c51ae01b1d7772625eed4fbc096c93eece
+  data.tar.gz: f8fd3fd1017bd56d64f7f0a89d75fb8ea3f1144ed250a881b34385acb8b7aa43
 SHA512:
-  metadata.gz: 6845ef3a74016eebfdd7c34aa55cca0f4044cf0bdf89fff49f5c31d24393b7165b5e6a648dd08ae5ab17c079d1cbfff8d9a5be31c83693f934a3e6cfcc65141f
-  data.tar.gz: 7eb32ea5eb7c3d4da5ff15905fece148885fcdd352d3c06cf4a80e455fd90d88eeacf5212a23fe79c658c3ccd7d787488e609e6a0ab976ba632c134d669ce5a7
+  metadata.gz: 89b224ea4e39b5289c2afb5f77ae9c6cc057800e0f3c264834b700def4ce2d10a21f36b71f60e1bf6b213b176b30efe3a7ed31117a7ec692e5f74faecd571903
+  data.tar.gz: 8bd659a264d38e898ebc690ed9aa49f0304e1975bb0313bc1bed72c9e21937b6ecc9dc1215d160833d42d53b1a65d30b1b75ca9fed74e561a3f0a82bfdfeb241

data/CHANGELOG.md

@@ -1,13 +1,24 @@
 ## [Unreleased]
 
+## [0.3.0] - 2022-03-13
+
+### Added
+
+- `#any?` to compare the instance status against array of statuses.
+
+### Changed
+
+- Conditional "#<status>_then" now returns nil instead of self if there is no match.
+- Wrap checks with .format_status method to reliably format the status...
+
 ## [0.2.0] - 2022-03-07
 
-### Add
+### Added
 
 - Allow aliases of the status tags to be defined with the .define_status_tags
   method.
 
-### Remove
+### Removed
 
 - No longer define methods with the method_missing hook.
 

data/lamy_result.gemspec

@@ -11,50 +11,9 @@ Gem::Specification.new do |spec|
   spec.summary       = 'Wrap results with a status and a value.'
   spec.description   = <<~EOF
     The project is inspired by Elixir and Erlang's tagged tuple and Rust's Result/Option. Despite inspiration from other languages, Lamy Result aims to be idiomatic Ruby and runtime dependency-free.
-
-    Rather than change the way you're doing things. Returning a single result is great for most cases. You'll know if and when you need something more.
-
-    ```ruby
-    include LamyResult
-
-    result = Lamy.ok('Lamy is awesome')
-
-    if result.ok?
-      do_something_cool result.value
-    end
-
-    # or
-
-    # Will only evaluate if the status is :ok
-    result.ok_then do |v|
-      do_something_cool v
-    end
-
-    result.to_a
-    # Output: [:ok, 'Lamy is awesome']
-
-    result.to_h
-    # Output: { status: :ok, value: 'Lamy is awesome' }
-
-
-    # Aliases allow for natural expression.
-
-    def do_another_cool_thing
-      # Report success
-      Lamy.success('It worked')
-    end
-
-    another_result = do_another_cool_thing
-
-    # As in "Was the operation successful?"
-    another_result.successful?
-
-    # As in "Has the operation succeeded?"
-    another_result.succeeded?
-    ```
   EOF
 
-  spec.homepage      = 'https://evrnetwork.co.za'
+  spec.homepage      = 'https://github.com/JedBurke/LamyResult'
   spec.license       = 'Apache-2.0'
   spec.required_ruby_version = ">= 2.5.0"
 

data/lib/lamy_result/lamy.rb

@@ -15,11 +15,7 @@ module LamyResult
   #   See .define_status_tags for the method defined at runtime.
   class Lamy
     def initialize(status:, value: nil)
-      @status = status
-                .to_s
-                .downcase
-                .to_sym
-
+      @status = Lamy.format_status(status)
       @value = value
     end
 
@@ -31,11 +27,25 @@ module LamyResult
     # Compares the current instance's status to the input value. This is a
     # lov-level method meant to be used by the #ok? and #success? methods.
     def status_is?(value)
-      @status == value.to_sym
+      @status == Lamy.format_status(value)
+    end
+
+    # Compares the status with the input values and returns true if it matches
+    # any of them.
+    #
+    # Usage:
+    #   status = Lamy.ok('Yukihana Lamy is awesome')
+    #   status.any?(:ok, :success, :good)
+    #
+    def any?(*statuses)
+      statuses.any? {|status| status_is?(status) }
     end
 
+    # Consider: Add assert_any_then(*values, &block)
+    # either_then(*statuses,)
+
     # Calls #status_is? on the `status_to_check` and if true, yields the value.
-    # Otherwise, returns the instance. This is a low-level method meant to be
+    # Otherwise, returns nil. This is a low-level method meant to be
     # used by #ok_then and #success_then methods.
     def assert_status_then(status_to_check:)
       if status_is?(status_to_check)
@@ -44,7 +54,7 @@ module LamyResult
         return @value
       end
 
-      self
+      nil
     end
 
     # Returns the status attribute as a symbol or a TrueClass/FalseClass. This
@@ -53,9 +63,9 @@ module LamyResult
       # If the status is a boolean, return the status as a boolean.
       # Otherwise, return it as a symbol, which it should already be.
       if true? || false?
-        @status.to_s.to_sym == true.to_s.to_sym
+        Lamy.format_status(@status) == Lamy.format_status(true)
       else
-        @status.to_s.to_sym
+        Lamy.format_status(@status)
       end
     end
 
@@ -100,12 +110,19 @@ module LamyResult
       end
     end
 
+    def self.format_status(status)
+      status
+        .to_s
+        .downcase
+        .to_sym
+    end
+
     def self.format_status_check_method(status)
-      "#{status.to_s}?".to_sym
+      self.format_status("#{status}?")
     end
 
     def self.format_conditional_method(status)
-      "#{status.to_s}_then".to_sym
+      self.format_status("#{status}_then")
     end
 
     def self.define_status_method(status, *aliases)
@@ -139,6 +156,7 @@ module LamyResult
 
     def self.define_conditional_then_method(status, *aliases)
       method_symbol = format_conditional_method(status)
+
       status_conditional_aliases = aliases.map do |s|
         format_conditional_method(s)
       end
@@ -149,10 +167,7 @@ module LamyResult
 
       assert_new_instance_method! method_symbol
 
-      define_instance_aliases_for(
-        method_symbol,
-        *status_conditional_aliases
-      )
+      define_instance_aliases_for(method_symbol, *status_conditional_aliases)
     end
 
     # Checks if the method is an instance method, otherwise raises a
@@ -201,6 +216,7 @@ module LamyResult
     # the #status_is? method.
     alias == status_is?
     alias eql? status_is?
+    alias either? any?
 
     class << self
       # The singular form may be more comfortable for users wanting to define
@@ -215,8 +231,8 @@ module LamyResult
 
     # Add the basic tags to the class.
     Lamy.define_status_tags(
-      [:succeeded, :success, :successful],
-      [:failed, :fail, :error],
+      %i[succeeded success successful],
+      %i[failed fail error],
       :ok,
       :true,
       :false

data/lib/lamy_result/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LamyResult
-  VERSION = '0.2.1'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,58 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: lamy_result
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Jed Burke
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-04-10 00:00:00.000000000 Z
+date: 2022-04-13 00:00:00.000000000 Z
 dependencies: []
-description: |
-  The project is inspired by Elixir and Erlang's tagged tuple and Rust's Result/Option. Despite inspiration from other languages, Lamy Result aims to be idiomatic Ruby and runtime dependency-free.
+description: 'The project is inspired by Elixir and Erlang''s tagged tuple and Rust''s
+  Result/Option. Despite inspiration from other languages, Lamy Result aims to be
+  idiomatic Ruby and runtime dependency-free.
 
-  Rather than change the way you're doing things. Returning a single result is great for most cases. You'll know if and when you need something more.
-
-  ```ruby
-  include LamyResult
-
-  result = Lamy.ok('Lamy is awesome')
-
-  if result.ok?
-    do_something_cool result.value
-  end
-
-  # or
-
-  # Will only evaluate if the status is :ok
-  result.ok_then do |v|
-    do_something_cool v
-  end
-
-  result.to_a
-  # Output: [:ok, 'Lamy is awesome']
-
-  result.to_h
-  # Output: { status: :ok, value: 'Lamy is awesome' }
-
-
-  # Aliases allow for natural expression.
-
-  def do_another_cool_thing
-    # Report success
-    Lamy.success('It worked')
-  end
-
-  another_result = do_another_cool_thing
-
-  # As in "Was the operation successful?"
-  another_result.successful?
-
-  # As in "Has the operation succeeded?"
-  another_result.succeeded?
-  ```
+'
 email:
 - opensource@evrnetwork.co.za
 executables: []
@@ -73,11 +35,11 @@ files:
 - lib/lamy_result.rb
 - lib/lamy_result/lamy.rb
 - lib/lamy_result/version.rb
-homepage: https://evrnetwork.co.za
+homepage: https://github.com/JedBurke/LamyResult
 licenses:
 - Apache-2.0
 metadata:
-  homepage_uri: https://evrnetwork.co.za
+  homepage_uri: https://github.com/JedBurke/LamyResult
   source_code_uri: https://github.com/JedBurke/LamyResult
   changelog_uri: https://github.com/JedBurke/LamyResult/blob/master/CHANGELOG.md
 post_install_message: