mu-result 1.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 66c2f073332bdb1c48fdb2f64230c8f4d6f00b4f7131ae12b2d88fede4409aa8
-  data.tar.gz: 90f6420883ca8d40ed5cc8f0b1d006d27f8b88e441e927dce4c2261923448a3c
+  metadata.gz: fac87f8bfeb00091ef1bf1e340c905d57e8c1153ea860e4b59e609fe1a3b39fa
+  data.tar.gz: 7a92f8b7a12a0894e1ee3a50f712fdab236c36d119f8f9686b5fc2e79ed00586
 SHA512:
-  metadata.gz: 9d56cc528a0e37f3c96487e679b6276649738069005b2495b78740257116d2ecef1720417c2b0dc8b324e6dd3ddf88121d4a3fe7940507ffceb0e81497ed957d
-  data.tar.gz: b74a9e5440305dc532cb0b265d3a9d93c8ff79fcac940e1c52c9b40c1fa16ba445312da9306e41c8aca6ff5e97f040e7e9e740095d253525d59a29b2ab7b8039
+  metadata.gz: ddc000eda0bdface21287f5e8bb3e32849898a2b270cdf698db350a00adfaf69d9e65fc1be090233022045ba75040b82d60f2c09fb11fa4b8c784c904f62c161
+  data.tar.gz: 447eb2d9cc8bb51456b576f026894cb0e3cc900fbcce7e414772037ff89ad4e3512e0ab32eb7819fdb5349752703ffad90e132e538a26d18f99940dde02363b7

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,35 +1,35 @@
 PATH
   remote: .
   specs:
-    mu-result (1.0.0)
+    mu-result (2.1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    diff-lcs (1.3)
-    rake (10.5.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.2)
+    diff-lcs (1.4.4)
+    rake (13.0.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.16)
+  bundler (~> 2.2)
   mu-result!
-  rake (~> 10.0)
+  rake (~> 13.0)
   rspec (~> 3.0)
 
 BUNDLED WITH
-   1.16.6
+   2.2.15

data/README.md

@@ -1,5 +1,7 @@
 # Mu::Result
 
+[![Gem Version](https://badge.fury.io/rb/mu-result.svg)](https://badge.fury.io/rb/mu-result)
+
 This is a really tiny implementation of the Result object.
 
 ## Installation
@@ -22,6 +24,7 @@ Or install it yourself as:
 
 ```ruby
 include 'mu'
+
 result = Result.success
 result.success? # => true
 result = Result.error
@@ -32,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.
@@ -40,8 +62,8 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/mu-result. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome at https://source.olisti.co/olistik/mu-result. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## Code of Conduct
 
-Everyone interacting in the Mu::Result project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/mu-result/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Mu::Result project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://source.olisti.co/olistik/mu-result/blob/master/CODE_OF_CONDUCT.md).

data/lib/mu/result.rb

@@ -1,41 +1,16 @@
 require 'mu/result/version'
+require 'mu/result/base_result'
 
 module Mu
   module Result
-    class BaseResult
-      def initialize(code: :ok, data: nil)
-        @code = code
-        @data = data
-      end
-
-      def code!(value)
-        @code = value
-        self
-      end
-
-      def code
-        @code
-      end
-
-      def data
-        @data
-      end
-
-      def success?
-        @code == :ok
-      end
-
-      def error?
-        !success?
-      end
-    end
 
     def self.success(data = nil)
-      BaseResult.new(code: :ok, data: data)
+      BaseResult.new(is_success: true, code: :ok, data: data)
     end
 
     def self.error(data = nil)
-      BaseResult.new(code: :ko,  data: data)
+      BaseResult.new(is_success: false, code: :ko,  data: data)
     end
+
   end
 end

data/lib/mu/result/base_result.rb

@@ -0,0 +1,51 @@
+module Mu
+  module Result
+
+    class BaseResult
+      def initialize(is_success: true, code: :ok, data: nil)
+        @is_success = is_success
+        @code = code
+        @data = data
+      end
+
+      def code!(value)
+        @code = value
+        self
+      end
+
+      def code
+        @code
+      end
+
+      def data
+        @data
+      end
+
+      def success?
+        @is_success == true
+      end
+
+      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
+
+      def to_hash
+        {
+          code: code,
+          data: data,
+        }
+      end
+    end
+
+  end
+end

data/lib/mu/result/version.rb

@@ -1,5 +1,5 @@
 module Mu
   module Result
-    VERSION = '1.0.0'
+    VERSION = '2.1.0'
   end
 end

data/mu-result.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
 
   spec.summary       = %q{μResult is a small Result object}
   spec.description   = %q{μ as in micro}
-  spec.homepage      = 'https://source.olisti.co/olistik/mu-result'
+  spec.homepage      = 'https://github.com/olistik/mu-result'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.16'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'bundler', '~> 2.2'
+  spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mu-result
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - olistik
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-09 00:00:00.000000000 Z
+date: 2021-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -62,6 +62,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -70,9 +71,10 @@ files:
 - bin/console
 - bin/setup
 - lib/mu/result.rb
+- lib/mu/result/base_result.rb
 - lib/mu/result/version.rb
 - mu-result.gemspec
-homepage: https://source.olisti.co/olistik/mu-result
+homepage: https://github.com/olistik/mu-result
 licenses:
 - AGPL-3.0
 metadata: {}
@@ -91,8 +93,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.8
+rubygems_version: 3.2.15
 signing_key: 
 specification_version: 4
 summary: μResult is a small Result object