operatic 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f5f46398654b0cda4099550dc86d85e82833fa9671722f901dfeb09a0c9ef6e5
-  data.tar.gz: c5098edb779caedbefc2ddf39861ffd6e005315f5928da73b5eaaa04046c68fc
+  metadata.gz: aeb2128119d4f471de6cd2ef4bc70e7d2a5ad73bf3a21867cbd8ead4d6e2a387
+  data.tar.gz: 53ba7951114c31a60a360f95c801b4900603daf010e9f8d4f8aeded22ea657db
 SHA512:
-  metadata.gz: 93c89546ab8bc0a51fd1e58e059a5ec5da145443fdffadc4072e8af304fad195d1034f31b37a446870fe7e230292d7a40bf0168cfc1cc536ceab4e7b251907fb
-  data.tar.gz: 8a14b3e513e2416c55fc768612f0445697da7dabd331594d651c88f8da42c866db3bef42933d22ba44b3ef29b37dc5a6aa77b00af93360b7738c1563d32280c3
+  metadata.gz: 2f50a0a06fc96f281822f2ccc5696e2608d387b7720c49bf861f735a566e6d717fe90c3d57aed36ffcd09ddfebe9501c27d8e8cc7abfb7c1fb28c9e349a25972
+  data.tar.gz: f47a4fb2db7a8facc43235ae6bbd9d8c0f86e3a55c998a73666e360caee833227c1385a64b4c6b47212c41ecd640832f3248fc16f68db09745a75cf1ecce5c1f

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

@@ -0,0 +1,17 @@
+# 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>
+
+## Version 0.3.0 - 2019-11-27
+
+- Implement `#to_h` not `#to_hash`. <https://github.com/benpickles/operatic/pull/4>
+
+## Version 0.2.0 - 2019-11-23
+
+First official version hosted on [RubyGems.org](https://rubygems.org/gems/operatic).

data/README.md

@@ -2,6 +2,8 @@
 
 [![GitHub Actions status](https://github.com/benpickles/operatic/workflows/Ruby/badge.svg)](https://github.com/benpickles/operatic)
 
+A minimal standard interface for your operations.
+
 ## Installation
 
 Add Operatic to your application's Gemfile and run `bundle install`.
@@ -36,13 +38,13 @@ end
 result = SayHello.call(name: 'Dave')
 result.success? # => true
 result.message  # => "Hello Dave"
-result.to_hash  # => {:message=>"Hello Dave"}
+result.to_h     # => {:message=>"Hello Dave"}
 
 result = SayHello.call
 result.failure? # => true
 result.success? # => false
 result.message  # => nil
-result.to_hash  # => {}
+result.to_h     # => {}
 ```
 
 A Rails controller might use Operatic like this:

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
@@ -69,16 +63,16 @@ module Operatic
       @success
     end
 
-    # Returns the full hash of data attached to the result via {#success!},
-    # {#failure!}, or convenience accessors added with {.generate}.
+    # Returns the full (frozen) hash of data attached to the result via
+    # {#success!}, {#failure!}, or convenience accessors added with {.generate}.
     #
-    # @return [Hash]
-    def to_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.2.0'
+  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] which is fro
-    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.to_hash  # => {:message=>"Hello Dave"}
+  #   result.message  # => "Hello Dave"
+  #   result.to_h     # => {:message=>"Hello Dave"}
   #
   #   result = SayHello.call
   #   result.failure? # => true
   #   result.success? # => false
-  #   result.to_hash  # => {}
+  #   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

data/operatic.gemspec

@@ -8,22 +8,22 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Ben Pickles']
   spec.email         = ['spideryoung@gmail.com']
 
-  spec.summary       = 'Operations'
-  spec.description   = ''
+  spec.summary       = 'A minimal standard interface for your operations'
+  spec.description   = spec.summary
   spec.homepage      = 'https://github.com/benpickles/operatic'
   spec.license       = 'MIT'
 
-  # spec.metadata['allowed_push_host'] = 'TODO: Set to 'http://mygemserver.com''
-
-  spec.metadata['homepage_uri'] = spec.homepage
-  # spec.metadata['source_code_uri'] = 'TODO: Put your gem's public repo URL here.'
-  # spec.metadata['changelog_uri'] = 'TODO: Put your gem's CHANGELOG.md URL here.'
+  spec.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',
+  }
 
   spec.required_ruby_version = '>= 2.5.0'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files         = Dir.chdir(__dir__) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
   spec.bindir        = 'exe'
@@ -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.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Ben Pickles
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-11-23 00:00:00.000000000 Z
+date: 2022-05-25 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
@@ -52,7 +52,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: ''
+description: A minimal standard interface for your operations
 email:
 - spideryoung@gmail.com
 executables: []
@@ -62,6 +62,7 @@ files:
 - ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -78,8 +79,10 @@ homepage: https://github.com/benpickles/operatic
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/benpickles/operatic
-post_install_message: 
+  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:
 rdoc_options: []
 require_paths:
 - lib
@@ -94,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.1.6
+signing_key:
 specification_version: 4
-summary: Operations
+summary: A minimal standard interface for your operations
 test_files: []