lamy_result 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f54a9321e1e265a16acd63a030358c51ae01b1d7772625eed4fbc096c93eece
-  data.tar.gz: f8fd3fd1017bd56d64f7f0a89d75fb8ea3f1144ed250a881b34385acb8b7aa43
+  metadata.gz: c804f6269e93e5c6f4741bf8d4de4c0d1f67a3cad29022620f6c4b394aaf8460
+  data.tar.gz: 5128295c967871adec2d7d3251bf2a7b39fcc9a82c56c3ade5f04922f43fc3c9
 SHA512:
-  metadata.gz: 89b224ea4e39b5289c2afb5f77ae9c6cc057800e0f3c264834b700def4ce2d10a21f36b71f60e1bf6b213b176b30efe3a7ed31117a7ec692e5f74faecd571903
-  data.tar.gz: 8bd659a264d38e898ebc690ed9aa49f0304e1975bb0313bc1bed72c9e21937b6ecc9dc1215d160833d42d53b1a65d30b1b75ca9fed74e561a3f0a82bfdfeb241
+  metadata.gz: eb41fa69656252be504bc8096072b221a2ce033e9dd39a915b430153d2862bd6bd92391a8418cd2e6e2c9d0fb479de04bab29d3b30abbf7d74a3e431c7aa3dd0
+  data.tar.gz: 35aad442edd5f6343db7d17f372582760077dc56f36f58ef13559ad89693aba50f55c8ffd61ceaececd3f465ca565b4225e021f7451bfbe5efbf8cad97aa1132

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## [Unreleased]
 
+### [0.4.0] - 2022-05-02
+
+### Added
+
+- `any_then` and alias `either_then` yields value to a block if the instance status matches the input statuses.
+
 ## [0.3.0] - 2022-03-13
 
 ### Added

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    lamy_result (0.2.1)
+    lamy_result (0.4.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -6,7 +6,37 @@ The project is inspired by Elixir and Erlang's tagged tuple and Rust's Result/Op
 
 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.
 
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'lamy_result'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install lamy_result
+
+[LamyResult](https://rubygems.org/gems/lamy_result) on RubyGems.org
+
+## Usage
+
+A few pre-designed status labels are included: `succeeded` `ok` `failed` `error` `true` `false`
+
+Providing a short-hand way to create a result, each statuc corresponds to a static method (or class method) on the Lamy class.
+
+For example, `Lamy.failed('You did not think this through.')` will return a Lamy instance with the status set to `:failed` and the value to `You did not think this through.`
+
+Here are some basic examples.
+
 ```ruby
+require 'lamy_result'
+
 include LamyResult
 
 result = Lamy.ok('Lamy is awesome')
@@ -22,6 +52,12 @@ result.ok_then do |v|
   do_something_cool v
 end
 
+# When either of the input statuses match the instance's status, the
+# instance value will be yielded to the block.
+result.any_then(:ok, :success) do |value|
+  value.upcase
+end
+
 result.to_a
 # Output: [:ok, 'Lamy is awesome']
 
@@ -45,31 +81,6 @@ another_result.successful?
 another_result.succeeded?
 ```
 
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'lamy_result'
-```
-
-And then execute:
-
-    $ bundle install
-
-Or install it yourself as:
-
-    $ gem install lamy_result
-
-## Usage
-
-A few pre-designed status labels are included: `success` `ok` `failed` `error` `true` `false`
-
-As a short-hand way to create a result, each one corresponds to a static method (or class method) on the Lamy class.
-
-For example, `Lamy.failed('You did not think this through.')` will instantize a Lamy instance with the status set to `:failed` and the value to `You did not think this through.`
-
-
 ## Motivation
 
 The idea came from a function which would check if a file exists with either dashes or underscores. If I was looking for `./ecchi/ecchi-pic-7.jpg`, it should also check for `./ecchi/ecchi_pic_7.jpg`. Without going on a tangent, the function is meant to reconcile file name inconsistencies.

data/Rakefile

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-require "rubocop/rake_task"
+require 'rubocop/rake_task'
 
 RuboCop::RakeTask.new
 

data/lib/lamy_result/lamy.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 module LamyResult
-
   # Creates and checks result instances.
   #
   # A quick reference for class and instance methods.
@@ -41,8 +40,24 @@ module LamyResult
       statuses.any? {|status| status_is?(status) }
     end
 
-    # Consider: Add assert_any_then(*values, &block)
-    # either_then(*statuses,)
+    # Yields the instance value if its status matches either of the instance
+    # statuses. If no block is given, the value will be returned. If there is
+    # no match, false will be returned.
+    #
+    # Usage:
+    #   status = Lamy.ok('Yukihana Lamy is awesome')
+    #   status.any_then(:ok, :success, :good) {|v| v.upcase }
+    #
+    def any_then(*statuses)
+      if any?(*statuses)
+        return yield if block_given?
+
+        # Just return the value.
+        return @value
+      end
+
+      false
+    end
 
     # Calls #status_is? on the `status_to_check` and if true, yields the value.
     # Otherwise, returns nil. This is a low-level method meant to be
@@ -51,6 +66,7 @@ module LamyResult
       if status_is?(status_to_check)
         return yield @value if block_given?
 
+        # Just return the value.
         return @value
       end
 
@@ -100,13 +116,13 @@ module LamyResult
         new_status, *new_status_aliases = Array(status)
 
         # Defines the short-hand class method like .ok(input)
-        self.define_status_method(new_status, *new_status_aliases)
+        define_status_method(new_status, *new_status_aliases)
 
         # Define status check instance methods like #ok?
-        self.define_status_check_method(new_status, *new_status_aliases)
+        define_status_check_method(new_status, *new_status_aliases)
 
         # Define conditional instance methods like #ok_then
-        self.define_conditional_then_method(new_status, *new_status_aliases)
+        define_conditional_then_method(new_status, *new_status_aliases)
       end
     end
 
@@ -118,19 +134,19 @@ module LamyResult
     end
 
     def self.format_status_check_method(status)
-      self.format_status("#{status}?")
+      format_status("#{status}?")
     end
 
     def self.format_conditional_method(status)
-      self.format_status("#{status}_then")
+      format_status("#{status}_then")
     end
 
     def self.define_status_method(status, *aliases)
       self
-      .class
-      .send(:define_method, status) do |value|
-        Lamy.new(status: status, value: value)
-      end
+        .class
+        .send(:define_method, status) do |value|
+          Lamy.new(status: status, value: value)
+        end
 
       # Define aliases for the new status if we got any.
       define_class_aliases_for(status, *aliases)
@@ -151,7 +167,7 @@ module LamyResult
 
       assert_new_instance_method! method_symbol
 
-      self.define_instance_aliases_for(method_symbol, *status_check_aliases)
+      define_instance_aliases_for(method_symbol, *status_check_aliases)
     end
 
     def self.define_conditional_then_method(status, *aliases)
@@ -173,8 +189,8 @@ module LamyResult
     # Checks if the method is an instance method, otherwise raises a
     # StandardError.
     def self.assert_new_instance_method!(method_symbol)
-      unless self.instance_methods.include?(method_symbol)
-        raise StandardError.new "##{method_symbol} is not an instance method."
+      unless instance_methods.include?(method_symbol)
+        raise StandardError, "##{method_symbol} is not an instance method."
       end
 
       true
@@ -217,6 +233,7 @@ module LamyResult
     alias == status_is?
     alias eql? status_is?
     alias either? any?
+    alias either_then any_then
 
     class << self
       # The singular form may be more comfortable for users wanting to define

data/lib/lamy_result/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lamy_result
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Jed Burke
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-04-13 00:00:00.000000000 Z
+date: 2022-05-02 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