operatic 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d2d761cb5faa5c2c3033b701c7a716390cdefba8ebf2c13bbd20086375c81ff
-  data.tar.gz: 854bfdfc81e9c54866dc70f1c8773d11a664648e20d3bb33bab2a5fd4ca093fd
+  metadata.gz: 79842e69c42fad058cef240224911da273e0b801b51762bb4edc062590b1db1c
+  data.tar.gz: d3262c93d6332c3833b3688425f09d1168bc961fc084b67bcaa148f2700ff60c
 SHA512:
-  metadata.gz: cd7219716eaf92d39c26a9bd7072a90eb45a3d95c86fc784c2c94de6645b4bd1c3b7dc8fb7d802fafd59db93532b96cb3ee4f5a93cd1e4a30973146244fd165e
-  data.tar.gz: 139a4f9bf2cddaec695fed7095b6460aa2b3cf5433980e327a05fa0ebeddedab7d53df934c07fe5c835eb57f935d2c5153fdc5e6c3cdd2bd5a22e630c86097a9
+  metadata.gz: 212c3d737d571164069bacb305fe196008cbf27d1b81e440c230025715032a84c5df6e1dd2d2d6dc3a9073a5a9ebf010dff712e2f1577b68564f0d0d9594ca33
+  data.tar.gz: 42d76bcf9a9e5ecef9ebb9e22d5eaa1378ed93bbbc164ac589acf134803b250c2ba8c6b461ef74e6927c6794d78c791d58811316c76ad6bc66fc0f44692326a2

data/.github/workflows/ruby.yml

@@ -1,6 +1,6 @@
 name: Ruby
 
-on: [push]
+on: push
 
 jobs:
   rspec:
@@ -8,24 +8,16 @@ jobs:
     strategy:
       matrix:
         ruby:
-          - '2.5.x'
-          - '2.6.x'
-
+          - '2.5'
+          - '2.6'
+          - '2.7'
+          - '3.0'
+          - '3.1'
     name: Ruby ${{ matrix.ruby }} RSpec
-
     steps:
-    - uses: actions/checkout@v1
-
-    - name: Set up Ruby
-      uses: actions/setup-ruby@v1
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
       with:
+        bundler-cache: true
         ruby-version: ${{ matrix.ruby }}
-
-    - name: Install latest bundler
-      run: gem install bundler
-
-    - name: Install operatic dependencies
-      run: bundle install --jobs 4
-
-    - name: Run RSpec
-      run: bundle exec rspec
+    - run: bundle exec rspec

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # 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>
+
+## Version 0.3.1 - 2020-01-05
+
+- Less specific Rake dependency. <https://github.com/benpickles/operatic/pull/6>
+
 ## Version 0.3.0 - 2019-11-27
 
 - Implement `#to_h` not `#to_hash`. <https://github.com/benpickles/operatic/pull/4>

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,10 +1,10 @@
 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 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,23 @@ module Operatic
       @success = true
     end
 
-    # Mark the result as a failure, optionally attach data, and freeze the
-    # object so it cannot be modified further.
-    #
-    # *Note*: After calling this method calling {#success!} or {#failure!}
-    # again will raise a +FrozenError+.
+    # 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.
     #
-    # @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 +54,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 +76,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.0'
+  VERSION = '0.5.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
@@ -45,7 +42,7 @@ module Operatic
     #
     #     attr_reader :name
     #
-    #     result :message
+    #     result_attr :message
     #
     #     def call
     #       success!(message: "Hello #{name}")
@@ -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_attr(*attrs)
+      @result_class = Result.generate(*attrs)
     end
 
     def result_class
@@ -64,22 +64,16 @@ module Operatic
     end
   end
 
-  # An instance of {Result} or a subclass generated by {ClassMethods#result}.
-  #
-  # @return [Result]
-  attr_reader :result
-
-  def initialize(attrs = nil)
-    @result = self.class.result_class.new
-
+  def initialize(**attrs)
     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_attr}.
   #
   # @example
   #   class SayHello
@@ -87,6 +81,8 @@ module Operatic
   #
   #     attr_reader :name
   #
+  #     result_attr :message
+  #
   #     def call
   #       return failure! unless name
   #       success!(message: "Hello #{name}")
@@ -94,23 +90,34 @@ 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
+
+  # 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 = nil)
-    result.success!(data)
+  def success!(**data)
+    result.success!(**data)
   end
 end

data/operatic.gemspec

@@ -31,6 +31,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec', '~> 3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: operatic
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Ben Pickles
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-11-27 00:00:00.000000000 Z
+date: 2022-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -28,16 +28,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -82,7 +82,7 @@ metadata:
   changelog_uri: https://github.com/benpickles/operatic/blob/master/CHANGELOG.md
   documentation_uri: https://rubydoc.info/gems/operatic
   source_code_uri: https://github.com/benpickles/operatic
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -97,8 +97,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: A minimal standard interface for your operations
 test_files: []