Added :update method to set multiple values within a single call.

Author: CodeMeister

CHANGELOG.md

@@ -1,5 +1,11 @@
 # CHANGELOG
 
+## 1.4.0
+- New method `:update` added.
+  - The :update method accepts data to be added in the format `key: value`.
+  - New data is created and existing data is updated.
+  - E.g. `result.update( success: true, name: 'Tester', time: Time.now )`
+
 ## 1.3.0
 - When recording an exception: 
   - Unless perviously defined, the :error_message attribute is automatically set with the exception's error message.

Gemfile.lock

@@ -1,78 +1,80 @@
 PATH
   remote: .
   specs:
-    result_vault (1.3.0)
+    result_vault (1.4.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    amazing_print (1.5.0)
+    amazing_print (1.6.0)
     ast (2.4.2)
-    debug (1.9.1)
+    debug (1.9.2)
       irb (~> 1.10)
       reline (>= 0.3.8)
-    diff-lcs (1.5.0)
-    docile (1.4.0)
+    diff-lcs (1.5.1)
+    docile (1.4.1)
     io-console (0.7.2)
-    irb (1.11.1)
-      rdoc
+    irb (1.14.0)
+      rdoc (>= 4.0.0)
       reline (>= 0.4.2)
-    json (2.7.1)
+    json (2.7.2)
     language_server-protocol (3.17.0.3)
-    parallel (1.24.0)
-    parser (3.3.0.5)
+    parallel (1.26.2)
+    parser (3.3.4.2)
       ast (~> 2.4.1)
       racc
     psych (5.1.2)
       stringio
-    racc (1.7.3)
+    racc (1.8.1)
     rainbow (3.1.1)
-    rake (13.1.0)
-    rdoc (6.6.2)
+    rake (13.2.1)
+    rdoc (6.7.0)
       psych (>= 4.0.0)
-    regexp_parser (2.9.0)
-    reline (0.4.2)
+    regexp_parser (2.9.2)
+    reline (0.5.9)
       io-console (~> 0.5)
-    rexml (3.2.6)
-    rspec (3.12.0)
-      rspec-core (~> 3.12.0)
-      rspec-expectations (~> 3.12.0)
-      rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.2)
-      rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.3)
+    rexml (3.3.5)
+      strscan
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.6)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-support (3.12.1)
-    rubocop (1.60.1)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    rubocop (1.65.1)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
+      regexp_parser (>= 2.4, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.30.0, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.30.0)
-      parser (>= 3.2.1.0)
+    rubocop-ast (1.32.0)
+      parser (>= 3.3.1.0)
     ruby-progressbar (1.13.0)
     simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
-    stringio (3.1.0)
+    stringio (3.1.1)
+    strscan (3.1.0)
     unicode-display_width (2.5.0)
-    yard (0.9.34)
+    yard (0.9.36)
 
 PLATFORMS
-  arm64-darwin-22
+  arm64-darwin-23
   ruby
   x86_64-linux
 
@@ -87,4 +89,4 @@ DEPENDENCIES
   yard
 
 BUNDLED WITH
-   2.5.5
+   2.5.17

README.md

@@ -44,6 +44,7 @@
     - [:exception](#exception)
     - [:error_message](#error_message)
     - [:data](#data)
+    - [:update](#update)
 - [freezing results](#freezing)
 - [change log](CHANGELOG.md)
 - [code of conduct](#code-of-conduct)
@@ -195,6 +196,7 @@ result.user_name  #=> 'Test User'
 - [:exception](#exception)
 - [:error_message](#error_message)
 - [:data](#data)
+- [:update](#update)
 
 
 There are five methods pre-defined to help developers easily determine
@@ -309,7 +311,32 @@ result    = average(num_array)
 result.data #=> {:total=>15, :size=>5, :average=>3, :success=>true, :status=>nil, :error_message=>""}
 ```
 
-> **Note:** <br/>`:data` cannot be set directly.
+> **Note:** <br/>Use `:update` to add or update data.
+
+
+
+<a name='update'></a>
+### :update
+
+`:update` sets new or updates existing data values:
+
+```ruby
+result = ResultVault.new(age: 9.75)
+result.success? #=> false
+result.age      #=> 9.75
+result.name     #=> Undefined method `name'
+
+result.update(success: true, age: 23, name: 'Tester')
+
+result.success? #=> true
+result.age      #=> 23
+result.name     #=> 'Tester'
+end
+
+num_array = [1,2,3,4,5]
+result    = average(num_array)
+result.data #=> {:total=>15, :size=>5, :average=>3, :success=>true, :status=>nil, :error_message=>""}
+```
 
 ---
 

lib/result_vault.rb

@@ -110,11 +110,29 @@ def error_message=(err_msg)
   end
 
 
+  ##
+  # Set multiple data in a single call
+  #
+  # @param [Hash] args
+  #
+  def update(**args)
+    args.each do |k, v|
+      if k.is_a?(Symbol)
+        send("#{k.downcase}=", v)
+      else
+        fail ArgumentError, ":update argument key not a Symbol: '#{k}'."
+      end
+    end
+
+    return self
+  end
+
+
   ##
   # Raise an exception if the user is setting data directly
   #
   def data=(*)
-    fail ArgumentError, ":data is a reserved keyword and may not be set directly."
+    fail ArgumentError, "use :update to set or update results."
   end
 
 

lib/result_vault/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class ResultVault
-  VERSION = '1.3.0'
+  VERSION = '1.4.0'
 end

spec/getter_methods_spec.rb

@@ -0,0 +1,52 @@
+RSpec.describe ResultVault, type: :model do
+
+  describe 'getter methods' do
+    let(:result) { ResultVault.new(test_1: 'One', test_2: 'Two') }
+
+    %i[success ok good pass passed succeeded].each do |name|
+      context ":#{name}" do
+        it 'returns the value of :success?' do
+          res = ResultVault.new(success: true)
+          expect(res.send("#{name}?")).to be_truthy
+        end
+      end
+    end # each name
+
+    describe ':data' do
+      it 'returns a hash of the result data' do
+        expect(result.data).to be_a Hash
+        expect(result.data.keys).to include :test_1
+        expect(result.data.keys).to include :test_2
+        expect(result.data[:test_1]).to eq 'One'
+        expect(result.data[:test_2]).to eq 'Two'
+      end
+
+      it 'freezes the returned hash' do
+        expect(result.data).to be_frozen
+      end
+    end # ":data"
+
+    describe ':status' do
+      it 'returns the status' do
+        expect(result.status).to be_nil
+        result.status = :test_status
+        expect(result.status).to eq :test_status
+      end
+    end # :status
+
+    describe ':exception' do
+      it 'returns the exception value' do
+        result.exception = ArgumentError.new
+        expect(result.exception).to be_a Exception
+      end
+    end # :exception
+
+    describe ':error_message' do
+      it 'returns the error message' do
+        expect(result.error_message).to be_empty
+        result.error_message = 'Test Message'
+        expect(result.error_message).to eq 'Test Message'
+      end
+    end # :error_message
+  end
+end