operatic 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79842e69c42fad058cef240224911da273e0b801b51762bb4edc062590b1db1c
-  data.tar.gz: d3262c93d6332c3833b3688425f09d1168bc961fc084b67bcaa148f2700ff60c
+  metadata.gz: 05be6b41b0969a2f2ae37af1a149095939d78b8724591d7598c46543f15d9070
+  data.tar.gz: 071dc0a5a5d652476a33498206e5e7a34e1c911cd6276018d9022b0558628815
 SHA512:
-  metadata.gz: 212c3d737d571164069bacb305fe196008cbf27d1b81e440c230025715032a84c5df6e1dd2d2d6dc3a9073a5a9ebf010dff712e2f1577b68564f0d0d9594ca33
-  data.tar.gz: 42d76bcf9a9e5ecef9ebb9e22d5eaa1378ed93bbbc164ac589acf134803b250c2ba8c6b461ef74e6927c6794d78c791d58811316c76ad6bc66fc0f44692326a2
+  metadata.gz: e76718b015b9f69c0d7fb8b9b600baacd95abfac4656b1c3d926f1c59b66e2d55e092f0c1cf2382978396fb03d65ce8a0f114f78eb9ee27879d28040e62426ad
+  data.tar.gz: f8adfcf7e3852cf6031ad407b1ea9f0cbdd82d9cd7983bf71fe5fab46c769997406ca58bccfcaddd2bc18ed8e828f29420b937ba15db3ffbdf8b2a5bbfba50aa

data/.github/workflows/ruby.yml

@@ -20,4 +20,8 @@ jobs:
       with:
         bundler-cache: true
         ruby-version: ${{ matrix.ruby }}
-    - run: bundle exec rspec
+    - name: 'Set RSpec exclude pattern for Ruby < 2.7'
+      run: echo "::set-output name=value::**/*_gte_ruby_2_7_spec.rb"
+      if: matrix.ruby == '2.5' || matrix.ruby == '2.6'
+      id: rspec_exclude_pattern
+    - run: bundle exec rspec --exclude-pattern=${{ steps.rspec_exclude_pattern.outputs.value }}

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## Version 0.6.0 - 2022-08-22
+
+- Support pattern matching a Result (in Ruby 2.7+). <https://github.com/benpickles/operatic/pull/12>
+
 ## Version 0.5.0 - 2022-06-23
 
 - Support custom initialize method to aid compatibility with other libraries. <https://github.com/benpickles/operatic/pull/11>

data/README.md

@@ -49,6 +49,17 @@ result[:message] # => nil
 result.to_h      # => {}
 ```
 
+An `Operatic::Result` also supports pattern matching in Ruby 2.7+ returning an array of `[success, data]`:
+
+```ruby
+case SayHello.call(name: 'Dave')
+in [true, { message: }]
+  # Result is a success, do something with the `message` variable.
+in [false, _]
+  # Result is a failure, do something else.
+end
+```
+
 A Rails controller might use Operatic like this:
 
 ```ruby
@@ -65,6 +76,35 @@ class HellosController < ApplicationController
 end
 ```
 
+Or a pattern matching alternative:
+
+```ruby
+class HellosController < ApplicationController
+  def create
+    case SayHello.call(name: params[:name])
+    in [true, { message: }]
+      render plain: message
+    in [false, _]
+      render :new
+    end
+  end
+end
+```
+
+## Development
+
+Run the tests with:
+
+```
+bundle exec rspec
+```
+
+Generate Yard documentation with:
+
+```
+bundle exec yardoc
+```
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/operatic/result.rb

@@ -34,14 +34,31 @@ module Operatic
       @data[key] = value
     end
 
+    # Returns an array of success and data.
+    #
+    # @example
+    #   result = Result.new.success!(message: 'Hello world')
+    #
+    #   case result
+    #   in [true, { message: }]
+    #     # Result is a success, do something with the `message` variable.
+    #   in [false, _]
+    #     # Result is a failure, do something else.
+    #   end
+    #
+    # @return [Array(Boolean, Hash<Symbol, anything>)]
+    def deconstruct
+      [@success, @data]
+    end
+
     # Mark the result as a failure, optionally attach +data+ via kwargs, and
     # freeze the object so it cannot be modified further.
     #
     # *Note*: Calling {#success!} or {#failure!} more than once will raise a
     # +FrozenError+.
     def failure!(**data)
-      set_data(**data)
       @success = false
+      set_data(data)
       freeze
     end
 
@@ -64,8 +81,8 @@ module Operatic
     # *Note*: Calling {#success!} or {#failure!} more than once will raise a
     # +FrozenError+.
     def success!(**data)
-      set_data(**data)
       @success = true
+      set_data(data)
       freeze
     end
 
@@ -82,7 +99,7 @@ module Operatic
     end
 
     private
-      def set_data(**data)
+      def set_data(data)
         data.each do |key, value|
           @data[key] = value
         end

data/lib/operatic/version.rb

@@ -1,3 +1,3 @@
 module Operatic
-  VERSION = '0.5.0'
+  VERSION = '0.6.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: operatic
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Ben Pickles
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-23 00:00:00.000000000 Z
+date: 2022-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler