operatic 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aeb2128119d4f471de6cd2ef4bc70e7d2a5ad73bf3a21867cbd8ead4d6e2a387
-  data.tar.gz: 53ba7951114c31a60a360f95c801b4900603daf010e9f8d4f8aeded22ea657db
+  metadata.gz: 79842e69c42fad058cef240224911da273e0b801b51762bb4edc062590b1db1c
+  data.tar.gz: d3262c93d6332c3833b3688425f09d1168bc961fc084b67bcaa148f2700ff60c
 SHA512:
-  metadata.gz: 2f50a0a06fc96f281822f2ccc5696e2608d387b7720c49bf861f735a566e6d717fe90c3d57aed36ffcd09ddfebe9501c27d8e8cc7abfb7c1fb28c9e349a25972
-  data.tar.gz: f47a4fb2db7a8facc43235ae6bbd9d8c0f86e3a55c998a73666e360caee833227c1385a64b4c6b47212c41ecd640832f3248fc16f68db09745a75cf1ecce5c1f
+  metadata.gz: 212c3d737d571164069bacb305fe196008cbf27d1b81e440c230025715032a84c5df6e1dd2d2d6dc3a9073a5a9ebf010dff712e2f1577b68564f0d0d9594ca33
+  data.tar.gz: 42d76bcf9a9e5ecef9ebb9e22d5eaa1378ed93bbbc164ac589acf134803b250c2ba8c6b461ef74e6927c6794d78c791d58811316c76ad6bc66fc0f44692326a2

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # CHANGELOG
 
+## Version 0.5.0 - 2022-06-23
+
+- Support custom initialize method to aid compatibility with other libraries. <https://github.com/benpickles/operatic/pull/11>
+- Rename to `Operatic.result_attr` to be more specific about its functionality. <https://github.com/benpickles/operatic/pull/10>
+- Get and set Result data with `#[]` / `#[]=`. <https://github.com/benpickles/operatic/pull/9>
+
 ## Version 0.4.0 - 2022-05-25
 
 - Switch to keyword arguments. <https://github.com/benpickles/operatic/pull/8>

data/README.md

@@ -24,7 +24,7 @@ class SayHello
   attr_reader :name
 
   # Declare convenience accessors on the result.
-  result :message
+  result_attr :message
 
   def call
     # Exit the method and mark the result as a failure.
@@ -36,15 +36,17 @@ class SayHello
 end
 
 result = SayHello.call(name: 'Dave')
-result.success? # => true
-result.message  # => "Hello Dave"
-result.to_h     # => {:message=>"Hello Dave"}
+result.success?  # => true
+result.message   # => "Hello Dave"
+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     # => {}
+result.failure?  # => true
+result.success?  # => false
+result.message   # => nil
+result[:message] # => nil
+result.to_h      # => {}
 ```
 
 A Rails controller might use Operatic like this:

data/lib/operatic/result.rb

@@ -1,7 +1,7 @@
 module Operatic
   class Result
     # Generate a subclass of {Result} with named +attrs+ accessors. This
-    # wouldn't normally be called directly, see {ClassMethods#result} for
+    # wouldn't normally be called directly, see {ClassMethods#result_attr} for
     # example usage.
     #
     # @param attrs [Array<Symbol>] a list of convenience data accessors.
@@ -24,6 +24,16 @@ module Operatic
       @success = true
     end
 
+    # Read data that's attached to the result.
+    def [](key)
+      @data[key]
+    end
+
+    # Set data on the result.
+    def []=(key, value)
+      @data[key] = value
+    end
+
     # Mark the result as a failure, optionally attach +data+ via kwargs, and
     # freeze the object so it cannot be modified further.
     #

data/lib/operatic/version.rb

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

data/lib/operatic.rb

@@ -42,7 +42,7 @@ module Operatic
     #
     #     attr_reader :name
     #
-    #     result :message
+    #     result_attr :message
     #
     #     def call
     #       success!(message: "Hello #{name}")
@@ -55,7 +55,7 @@ module Operatic
     #
     # @param attrs [Array<Symbol>] a list of convenience data accessors to
     #   define on the {Result}.
-    def result(*attrs)
+    def result_attr(*attrs)
       @result_class = Result.generate(*attrs)
     end
 
@@ -64,14 +64,7 @@ module Operatic
     end
   end
 
-  # An instance of {Result} or a subclass generated by {ClassMethods#result}.
-  #
-  # @return [Result]
-  attr_reader :result
-
   def initialize(**attrs)
-    @result = self.class.result_class.new
-
     attrs.each do |key, value|
       instance_variable_set("@#{key}", value)
     end
@@ -79,7 +72,8 @@ module Operatic
 
   # Override this method with your implementation. Use {#success!} or
   # {#failure!} methods to communicate the {#result}'s status and to attach
-  # data to it. Define convenience result accessors with {ClassMethods#result}.
+  # data to it. Define convenience result accessors with
+  # {ClassMethods#result_attr}.
   #
   # @example
   #   class SayHello
@@ -87,7 +81,7 @@ module Operatic
   #
   #     attr_reader :name
   #
-  #     result :message
+  #     result_attr :message
   #
   #     def call
   #       return failure! unless name
@@ -114,6 +108,14 @@ module Operatic
     result.failure!(**data)
   end
 
+  # An instance of {Result} or a subclass generated by
+  # {ClassMethods#result_attr}.
+  #
+  # @return [Result]
+  def result
+    @result ||= self.class.result_class.new
+  end
+
   # Convenience shortcut to the operation's {Result#success!}.
   def success!(**data)
     result.success!(**data)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: operatic
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Ben Pickles
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-25 00:00:00.000000000 Z
+date: 2022-06-23 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.1.6
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: A minimal standard interface for your operations