mu-result 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec6059760dd74a847a598f17b84dee0ad3028a2c5c6e7afd5b8bf5a8815c0922
-  data.tar.gz: fde0c2077ce8690b98bba79c9b8a9654c11f3db221a7220807c8840e9b9a9140
+  metadata.gz: 7035a2ec94da66780f5ad89cc4cc1975a16633e2021b7bbc0366007ae5100773
+  data.tar.gz: 10c5f2b8f40fdfebe315663551f954b16049ad84a6327fa78e3e29ac44f84fe0
 SHA512:
-  metadata.gz: e7976d5f7fa13447ce500aa913327a02440cf3590e2e01543e6c7362d096cf91beeca8693cfc9bad11bd6dc892c35279865d8ebf25fd06b808202b2bdd9f058c
-  data.tar.gz: eeb98d41c5add154fe3abe0878f0ea0417f842498e1d9904c1582e31e168f81baeec4b6e745466fd9d1e7f9d424268ec08ab5c5f98661982b844bc3c9a8d3ee3
+  metadata.gz: 8d4fbb1d0c9d670d2ae6073d293780de9ec232035732720779b205771f43239a0a3394673aa9f4317155ff6ec5eee8dc0f8fb142a8399363213b00da1b7ed4ee
+  data.tar.gz: 1ecc708bdd34a381a034613ae6d85def2a846e2542e136b5de1542205fa55538dee83387ca4796400e6819eaf512875ba734079c50c3b70c42d0968888a8373b

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+# Changelog
+
+## 1.2.0
+
+- Adds `BaseResult#unwrap`.
+

data/Gemfile

@@ -1,6 +1,4 @@
 source 'https://rubygems.org'
 
-git_source(:github) {|repo_name| 'https://github.com/#{repo_name}' }
-
 # Specify your gem's dependencies in mu-result.gemspec
 gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mu-result (1.1.0)
+    mu-result (1.2.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -24,6 +24,7 @@ Or install it yourself as:
 
 ```ruby
 include 'mu'
+
 result = Result.success
 result.success? # => true
 result = Result.error
@@ -34,6 +35,25 @@ result = Result.success(name: 'Arthur Dent', answer: 42)
 result.data # => { name: 'Arthur Dent', answer: 42 }
 ```
 
+### Unwrap
+
+When you want to access to a specific field of the result, you can _unwrap_ it:
+
+```ruby
+result = Result.success(user: 'olistik', role: :developer)
+result.unwrap(:user) # => 'olistik'
+result.unwrap(:role) # => :developer
+result.unwrap(:name) # => raises `StandardError (The symbol 'name' is not included in the result data object.)`
+```
+
+This is a way to avoid getting unwanted nil values out of the result when passing the wrong field:
+
+```ruby
+result = Result.success(user: 'olistik', role: :developer)
+value = result.data[:users] # => nil, this could lead to an annoying bug later on because we're not aware there's a typo in `:users`, yet.
+value = result.unwrap(:users) # This raises an exception instead, making it evident that we're using the wrong name for the field.
+```
+
 ## 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.

data/lib/mu/result/base_result.rb

@@ -27,6 +27,16 @@ module Mu
       def error?
         !success?
       end
+
+      def unwrap(symbol = nil)
+        return data if symbol.nil?
+
+        if !data.respond_to?(:include?) || !data.include?(symbol)
+          raise StandardError.new("The symbol '#{symbol}' is not included in the result data object.")
+        end
+
+        return data[symbol]
+      end
     end
 
   end

data/lib/mu/result/version.rb

@@ -1,5 +1,5 @@
 module Mu
   module Result
-    VERSION = '1.1.0'
+    VERSION = '1.2.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mu-result
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - olistik
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-03 00:00:00.000000000 Z
+date: 2020-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -62,6 +62,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock