operatic 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d23afc6809c6d2b335d1db3747eeaa96e931f6a8e3dd51c8cd52261512b78bd4
-  data.tar.gz: f21c35d239aca9518215252494bc1aeb8572750b56e30a4c94ee6aa0e2215aa0
+  metadata.gz: aeb2128119d4f471de6cd2ef4bc70e7d2a5ad73bf3a21867cbd8ead4d6e2a387
+  data.tar.gz: 53ba7951114c31a60a360f95c801b4900603daf010e9f8d4f8aeded22ea657db
 SHA512:
-  metadata.gz: 010f2b26e6129b0fd7b6ac5c0c1499f1fadb9a0b31027b3ed4334cb54e2a5ecdbf4710e092c64457f6f10f7d97de016887bf7c356b2ffe8711be534e67214eee
-  data.tar.gz: 5e32262f6568ff446897a86840cb1f8bb1a3b19ca0a89fa05ffd7c32ef9f388c8e81862a6b07ea070488d44f3550893d316833e416ec0e1d3509448edf4faec2
+  metadata.gz: 2f50a0a06fc96f281822f2ccc5696e2608d387b7720c49bf861f735a566e6d717fe90c3d57aed36ffcd09ddfebe9501c27d8e8cc7abfb7c1fb28c9e349a25972
+  data.tar.gz: f47a4fb2db7a8facc43235ae6bbd9d8c0f86e3a55c998a73666e360caee833227c1385a64b4c6b47212c41ecd640832f3248fc16f68db09745a75cf1ecce5c1f

data/.github/workflows/ruby.yml

@@ -12,6 +12,7 @@ jobs:
           - '2.6'
           - '2.7'
           - '3.0'
+          - '3.1'
     name: Ruby ${{ matrix.ruby }} RSpec
     steps:
     - uses: actions/checkout@v2

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## Version 0.4.0 - 2022-05-25
+
+- Switch to keyword arguments. <https://github.com/benpickles/operatic/pull/8>
+
 ## Version 0.3.1 - 2020-01-05
 
 - Less specific Rake dependency. <https://github.com/benpickles/operatic/pull/6>

data/lib/operatic/result.rb

@@ -4,7 +4,7 @@ module Operatic
     # wouldn't normally be called directly, see {ClassMethods#result} for
     # example usage.
     #
-    # @param attrs [Array<Symbol>] a list of accessors to the result's data.
+    # @param attrs [Array<Symbol>] a list of convenience data accessors.
     def self.generate(*attrs)
       Class.new(self) do
         attrs.each do |name|
@@ -24,16 +24,13 @@ module Operatic
       @success = true
     end
 
-    # Mark the result as a failure, optionally attach data, and freeze the
-    # object so it cannot be modified further.
+    # Mark the result as a failure, optionally attach +data+ via kwargs, and
+    # freeze the object so it cannot be modified further.
     #
-    # *Note*: After calling this method calling {#success!} or {#failure!}
-    # again will raise a +FrozenError+.
-    #
-    # @param data [Hash<Symbol, anything>] an optional hash of data to attach
-    #   to the result.
-    def failure!(data = nil)
-      set_data(data) if data
+    # *Note*: Calling {#success!} or {#failure!} more than once will raise a
+    # +FrozenError+.
+    def failure!(**data)
+      set_data(**data)
       @success = false
       freeze
     end
@@ -47,20 +44,17 @@ module Operatic
       super
     end
 
-    # Mark the result as a success, optionally attach data, and freeze the
-    # object so it cannot be modified further.
+    # Mark the result as a success, optionally attach +data+ via kwargs, and
+    # freeze the object so it cannot be modified further.
     #
-    # Calling this is not strictly necessary as a result defaults to being a
+    # Calling this is not strictly necessary as a +Result+ defaults to being a
     # success, but it's a convenient means of attaching data and of indicating
     # intent in the consuming code.
     #
-    # *Note*: After calling this method calling {#success!} or {#failure!}
-    # again will raise a +FrozenError+.
-    #
-    # @param data [Hash<Symbol, anything>] an optional hash of data to attach
-    #   to the result.
-    def success!(data = nil)
-      set_data(data) if data
+    # *Note*: Calling {#success!} or {#failure!} more than once will raise a
+    # +FrozenError+.
+    def success!(**data)
+      set_data(**data)
       @success = true
       freeze
     end
@@ -72,13 +66,13 @@ module Operatic
     # Returns the full (frozen) hash of data attached to the result via
     # {#success!}, {#failure!}, or convenience accessors added with {.generate}.
     #
-    # @return [Hash]
+    # @return [Hash<Symbol, anything>]
     def to_h
       @data
     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.3.1'
+  VERSION = '0.4.0'
 end

data/lib/operatic.rb

@@ -11,15 +11,12 @@ module Operatic
   module ClassMethods
     # The main way of calling an operation.
     #
-    # The class is instantiated with supplied +attrs+ and calls {Operatic#call}
-    # returning a frozen {Result} instance.
+    # The class is instantiated with the supplied +attrs+ keyword arguments and
+    # calls {Operatic#call} returning a frozen {Result} instance.
     #
-    # @param attrs [Hash<Symbol, anything>] an optional hash of key/values to
-    #   to the result. The class must have corresponding +attr_reader+s
-    #
-    # @return a [Result]
-    def call(attrs = nil)
-      new(attrs)
+    # @return [Result]
+    def call(**attrs)
+      new(**attrs)
         .tap(&:call)
         .result
         .freeze
@@ -30,8 +27,8 @@ module Operatic
     # test setups, etc.
     #
     # @return [Result]
-    def call!(attrs = nil)
-      call(attrs).tap { |result|
+    def call!(**attrs)
+      call(**attrs).tap { |result|
         raise FailureError if result.failure?
       }
     end
@@ -55,8 +52,11 @@ module Operatic
     #   result = SayHello.call(name: 'Dave')
     #   result.success? # => true
     #   result.message  # => "Hello Dave"
-    def result(*args)
-      @result_class = Result.generate(*args)
+    #
+    # @param attrs [Array<Symbol>] a list of convenience data accessors to
+    #   define on the {Result}.
+    def result(*attrs)
+      @result_class = Result.generate(*attrs)
     end
 
     def result_class
@@ -69,17 +69,17 @@ module Operatic
   # @return [Result]
   attr_reader :result
 
-  def initialize(attrs = nil)
+  def initialize(**attrs)
     @result = self.class.result_class.new
 
     attrs.each do |key, value|
       instance_variable_set("@#{key}", value)
-    end if attrs
+    end
   end
 
   # Override this method with your implementation. Use {#success!} or
   # {#failure!} methods to communicate the {#result}'s status and to attach
-  # data it. Define convenience result accessors with {ClassMethods#result}.
+  # data to it. Define convenience result accessors with {ClassMethods#result}.
   #
   # @example
   #   class SayHello
@@ -87,6 +87,8 @@ module Operatic
   #
   #     attr_reader :name
   #
+  #     result :message
+  #
   #     def call
   #       return failure! unless name
   #       success!(message: "Hello #{name}")
@@ -94,23 +96,26 @@ module Operatic
   #   end
   #
   #   result = SayHello.call(name: 'Dave')
+  #   result.failure? # => false
   #   result.success? # => true
+  #   result.message  # => "Hello Dave"
   #   result.to_h     # => {:message=>"Hello Dave"}
   #
   #   result = SayHello.call
   #   result.failure? # => true
   #   result.success? # => false
+  #   result.message  # => nil
   #   result.to_h     # => {}
   def call
   end
 
   # Convenience shortcut to the operation's {Result#failure!}.
-  def failure!(data = nil)
-    result.failure!(data)
+  def failure!(**data)
+    result.failure!(**data)
   end
 
   # Convenience shortcut to the operation's {Result#success!}.
-  def success!(data = nil)
-    result.success!(data)
+  def success!(**data)
+    result.success!(**data)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: operatic
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Ben Pickles
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-01-05 00:00:00.000000000 Z
+date: 2022-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -97,7 +97,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: A minimal standard interface for your operations