simple_service 2.1.4 → 2.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2220ad6ff738c552c1aec94c1ca60e03e57373407c1358c59771aacc36d1b8ee
-  data.tar.gz: e33b89e540ecbc047b4d30c3926475c000603d58a7a3cfe02c1205319c28ec37
+  metadata.gz: 407aa35e8ec13960f5cc0509d5e1152b5f94fed9bf7d035aa20e759b27e4de80
+  data.tar.gz: 9fbaaf4c5afbf37dd68814032312e3a1d8b98e0a1f5d511c111c2679f881296e
 SHA512:
-  metadata.gz: cc84c17c115e32d93fb7038d2a74ae5e6e784a1bf35130ced4ce047ddfb0efc5379d16c42a9bacb283b323af768f41b5e41ba7450fd9fb96d5a4db5adbc1b461
-  data.tar.gz: 5547aa32dfddea4ea7ec12d7a8906309dbf781f1d74416675d8c7ed3ffe0d619b644572136e0eb144a880fb0f0943cf173907116f1aeb2e687eb0bd7f297239b
+  metadata.gz: f4f17ce95877a995c8b0b48a12b57c1147360115bd1b94b365c30a8a618bfa591197d66f107594923cf71cd81ec80e38b6101be28a93967bf6b3b96adfe69927
+  data.tar.gz: 61e3058fe33d2294255fa1933901146f417199c45b83fdb428d6d7c835df78d2e222b25cce2862025b1dcd1b5ececf698abb885adb2c70ca4e0411c76b89c0f8

data/.github/workflows/build_master.yml

@@ -0,0 +1,41 @@
+name: Build Master
+
+env:
+  CC_TEST_REPORTER_URL: https://codeclimate.com/downloads/test-reporter/test-reporter-0.7.0-linux-amd64
+  CC_TEST_REPORTER_ID: ${{ secrets.SIMPLE_SERVICE_CODECLIMATE_ID }}
+
+on:
+  pull_request:
+
+  push:
+    branches:
+      - master
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest]
+        # Due to https://github.com/actions/runner/issues/849, we have to use quotes for '3.0'
+        ruby: ["2.7.0", "3.2.2"]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+
+      - name: Install dependencies
+        run: |
+          gem install bundler -v 2.4.14
+          bundle install --jobs 3 --retry 3
+
+      - name: Run tests
+        run: RUBYOPT="-E UTF-8" bundle exec rake
+
+      - name: Code Climate Test Reporter
+        uses: aktions/codeclimate-test-reporter@v1
+        with:
+          codeclimate-test-reporter-id: ${{ secrets.SIMPLE_SERVICE_CODECLIMATE_ID }}
+          command: after-build

data/README.md

@@ -1,28 +1,26 @@
 # SimpleService
 
 [![Gem Version](https://badge.fury.io/rb/simple_service.svg)](http://badge.fury.io/rb/simple_service)
-[![Code Climate](https://codeclimate.com/github/jspillers/simple_service/badges/gpa.svg)](https://codeclimate.com/github/jspillers/simple_service)
-[![Test Coverage](https://codeclimate.com/github/jspillers/simple_service/badges/coverage.svg)](https://codeclimate.com/github/jspillers/simple_service)
-[![Build Status](https://travis-ci.org/jspillers/simple_service.svg?branch=master)](https://travis-ci.org/jspillers/simple_service)
-<!--![](http://ruby-gem-downloads-badge.herokuapp.com/jspillers/simple_service)-->
+[![Maintainability](https://api.codeclimate.com/v1/badges/4b75735e83e2bc944285/maintainability)](https://codeclimate.com/github/jspillers/simple_service/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/4b75735e83e2bc944285/test_coverage)](https://codeclimate.com/github/jspillers/simple_service/test_coverage)
 
 SimpleService facilitates the creation of Ruby service objects into highly discreet, reusable,
-and composable units of business logic. The core concept of SimpleService is the definition of 
-"Command" objects/methods. Commands are very small classes or methods that perform exactly one task. 
+and composable units of business logic. The core concept of SimpleService is the definition of
+"Command" objects/methods. Commands are very small classes or methods that perform exactly one task.
 When properly designed, these command objects can be composited together or even nested to create
 complex flows.
 
 # 2.0.0 update notes
 
-This update is a major refactor from previous 1.x.x versions. After revisiting this codebase I decided that 
+This update is a major refactor from previous 1.x.x versions. After revisiting this codebase I decided that
 I needed to make SimpleService actually simple in both use and implementation. The gem has now been paired down
 to about 150 lines of code.
 
-* All functionality is added to your service class via module inclusion instead of inheritance
-* The concept of an Organizer has been removed
-* The DSL for defining interfaces has been removed in favor of simple keyword arguments
-* `#success` or `#failure` must be called within each command or call method
-* Services are always invoked via the class method `.call`. Previously you could use either `#call` or `.call`.
+- All functionality is added to your service class via module inclusion instead of inheritance
+- The concept of an Organizer has been removed
+- The DSL for defining interfaces has been removed in favor of simple keyword arguments
+- `#success` or `#failure` must be called within each command or call method
+- Services are always invoked via the class method `.call`. Previously you could use either `#call` or `.call`.
 
 ## Installation
 
@@ -40,10 +38,10 @@ Or install it yourself as:
 
 # Setup and Basic Usage:
 
-* load the gem
-* include the SimpleService module into your service object class
-* define one or more comamnds that it will perform, must accept either keyword arguments or a hash argument
-* call `#success` or `#failure` with any values you wish to pass along to the next command (or wish to return if it is the last command)
+- load the gem
+- include the SimpleService module into your service object class
+- define one or more comamnds that it will perform, must accept either keyword arguments or a hash argument
+- call `#success` or `#failure` with any values you wish to pass along to the next command (or wish to return if it is the last command)
 
 ```ruby
 require 'rubygems'
@@ -100,7 +98,7 @@ You can also use ClassNames as commands and to organize them into other files. I
 defined and no other commands are defined via `command` or `commands` then SimpleService will
 automatically use `#call` as the default command
 
-```ruby 
+```ruby
 require 'rubygems'
 require 'simple_service'
 
@@ -144,7 +142,7 @@ result.value #=> {something: 'went wrong'}
 ```
 
 If you would like your service to process an enumerable you can override `.call`
-on your service object. Invoking `#super` in your definition and passing along 
+on your service object. Invoking `#super` in your definition and passing along
 the appropriate arguments will allow your command chain to proceed as normal, but
 called multiple times via a loop. The Result object returned from each call to `#super`
 can be passed in as an argument to the next iteration or you can collect the result objects
@@ -162,11 +160,11 @@ class LoopingService
   def self.call(count:)
     count = kwargs
 
-    # In this example the result object from super overwrites 
-    # the previous result/initial args. You could also capture 
+    # In this example the result object from super overwrites
+    # the previous result/initial args. You could also capture
     # results in an array or hash for further manipulation.
     # If you do not need to do anything with the result object
-    # then there is no need to assign it back to anything. 
+    # then there is no need to assign it back to anything.
     3.times do
       count = super(count)
     end
@@ -179,13 +177,13 @@ class LoopingService
   end
 end
 
-result = LoopingService.call(count: 0) 
+result = LoopingService.call(count: 0)
 result.is_a?(SimpleService::Result) #=> true
 result.value #=> {count: 3}
 ```
 
-If you are using this with a Rails app, placing top level services in 
-`app/services/` and all nested commands in `app/services/commands/` is 
+If you are using this with a Rails app, placing top level services in
+`app/services/` and all nested commands in `app/services/commands/` is
 recommended. Even if not using rails, a similar structure also works well.
 
 ## Contributing

data/checksums/simple_service-2.1.4.gem.sha512

@@ -0,0 +1 @@
+cb567a382f07efd13ccbb083e1f8b876aaae4d752b188fd8d7fc42cc0fdba86d5c6d051187e4422aa3d9e5a7d9ad2db4789142fced9cd6cd3d6b08a99f3d40d3

data/lib/simple_service/result.rb

@@ -3,7 +3,7 @@ module SimpleService
     attr_accessor :value, :recorded_commands
 
     def initialize()
-      @recorded_commands = []
+      @recorded_commands = Set.new
       @verbose_tracking = SimpleService.configuration.verbose_tracking
     end
 

data/lib/simple_service/version.rb

@@ -1,3 +1,3 @@
 module SimpleService
-  VERSION = '2.1.4'
+  VERSION = '2.1.6'
 end

data/simple_service.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.version       = SimpleService::VERSION
   spec.authors       = ['Jarrod Spillers']
   spec.email         = ['jarrod@stacktact.com']
-  spec.description   = %q{A minimal service object composer with support for individual commands and top level organizer objects}
+  spec.description   = %q{A minimal service object composer and orchestrator}
   spec.summary       = spec.description
   spec.homepage      = 'https://github.com/jspillers/simple_service'
   spec.license       = 'MIT'
@@ -18,10 +18,17 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
+  spec.metadata = {
+    "bug_tracker_uri" => "#{spec.homepage}/issues",
+    "changelog_uri" => "#{spec.homepage}/blob/main/CHANGELOG.md",
+    "documentation_uri" => spec.homepage.to_s,
+    "homepage_uri" => spec.homepage.to_s,
+    "source_code_uri" => spec.homepage.to_s,
+  }
+
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake', '~> 12.3.3'
   spec.add_development_dependency 'rspec', '~> 3.12.0'
   spec.add_development_dependency 'pry', '~> 0.14.2'
   spec.add_development_dependency 'simplecov'
-  spec.add_development_dependency 'codeclimate-test-reporter'
 end

data/spec/simple_service_spec.rb

@@ -2,6 +2,7 @@ require 'spec_helper'
 require_relative 'support/basic_service'
 require_relative 'support/looping_service'
 require_relative 'support/empty_service'
+require_relative 'support/multiple_outcome_calls'
 
 RSpec.describe SimpleService do
 
@@ -87,31 +88,50 @@ RSpec.describe SimpleService do
   end
 
   context 'record commands' do
+    it 'value refects only one outcome call per command' do
+      result = MultipleOutcomeCalls.call(params.merge(foo: 'foo', bar: 'bar'))
+      expect(result.value).to eq(foo: 'FOO', bar: 'BAR')
+    end
+
+    it 'recorded commands has only one outcome call per command' do
+      result = MultipleOutcomeCalls.call(params.merge(foo: 'foo', bar: 'bar'))
+      expect(result.recorded_commands).to eq(Set.new([
+        {
+          class_name: 'MultipleOutcomeCalls',
+          command_name: :command_one,
+          success: true,
+        },
+        {
+          class_name: 'MultipleOutcomeCalls',
+          command_name: :command_two,
+          success: true,
+        },
+      ]))
+    end
+
     it 'records normal command execution' do
-      expect(result.recorded_commands).to eq(
-        [
-          {
-            class_name: 'BasicService',
-            command_name: :upcase_foo,
-            success: true,
-          },
-          {
-            class_name: 'BasicService',
-            command_name: :upcase_bar,
-            success: true,
-          },
-          {
-            class_name: 'ModifyFooBar',
-            command_name: :call,
-            success: true,
-          },
-          {
-            class_name: 'CombineFooBar',
-            command_name: :call,
-            success: true,
-          },
-        ]
-      )
+      expect(result.recorded_commands).to eq(Set.new([
+        {
+          class_name: 'BasicService',
+          command_name: :upcase_foo,
+          success: true,
+        },
+        {
+          class_name: 'BasicService',
+          command_name: :upcase_bar,
+          success: true,
+        },
+        {
+          class_name: 'ModifyFooBar',
+          command_name: :call,
+          success: true,
+        },
+        {
+          class_name: 'CombineFooBar',
+          command_name: :call,
+          success: true,
+        },
+      ]))
     end
 
     it 'records verbose command execution' do
@@ -119,7 +139,7 @@ RSpec.describe SimpleService do
         config.verbose_tracking = true
       end
 
-      expect(result.recorded_commands).to eq(
+      expect(result.recorded_commands).to eq(Set.new(
         [
           {
             class_name: 'BasicService',
@@ -181,7 +201,7 @@ RSpec.describe SimpleService do
             },
           },
         ]
-      )
+      ))
     end
   end
 end

data/spec/support/multiple_outcome_calls.rb

@@ -0,0 +1,16 @@
+class MultipleOutcomeCalls
+  include SimpleService
+
+  commands :command_one,
+           :command_two,
+
+  def command_one(**kwargs)
+    success(kwargs.merge(foo: kwargs[:foo].capitalize))
+    success(kwargs.merge(foo: kwargs[:foo].upcase))
+  end
+
+  def command_two(**kwargs)
+    success(bar: kwargs[:bar].capitalize)
+    success(foo: kwargs[:foo].upcase, bar: kwargs[:bar].upcase)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_service
 version: !ruby/object:Gem::Version
-  version: 2.1.4
+  version: 2.1.6
 platform: ruby
 authors:
 - Jarrod Spillers
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-27 00:00:00.000000000 Z
+date: 2023-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,36 +80,22 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: codeclimate-test-reporter
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-description: A minimal service object composer with support for individual commands
-  and top level organizer objects
+description: A minimal service object composer and orchestrator
 email:
 - jarrod@stacktact.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/build_master.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - Gemfile
 - LICENSE
 - LICENSE.txt
 - README.md
 - Rakefile
+- checksums/simple_service-2.1.4.gem.sha512
 - lib/simple_service.rb
 - lib/simple_service/configuration.rb
 - lib/simple_service/result.rb
@@ -122,10 +108,16 @@ files:
 - spec/support/empty_service.rb
 - spec/support/looping_service.rb
 - spec/support/modify_foo_bar.rb
+- spec/support/multiple_outcome_calls.rb
 homepage: https://github.com/jspillers/simple_service
 licenses:
 - MIT
-metadata: {}
+metadata:
+  bug_tracker_uri: https://github.com/jspillers/simple_service/issues
+  changelog_uri: https://github.com/jspillers/simple_service/blob/main/CHANGELOG.md
+  documentation_uri: https://github.com/jspillers/simple_service
+  homepage_uri: https://github.com/jspillers/simple_service
+  source_code_uri: https://github.com/jspillers/simple_service
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -144,8 +136,7 @@ requirements: []
 rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
-summary: A minimal service object composer with support for individual commands and
-  top level organizer objects
+summary: A minimal service object composer and orchestrator
 test_files:
 - spec/simple_service_spec.rb
 - spec/spec_helper.rb
@@ -154,3 +145,4 @@ test_files:
 - spec/support/empty_service.rb
 - spec/support/looping_service.rb
 - spec/support/modify_foo_bar.rb
+- spec/support/multiple_outcome_calls.rb

data/.travis.yml

@@ -1,6 +0,0 @@
-language: ruby
-rvm:
-  - jruby-19mode
-  - 2.3.0
-  - 2.3.3
-  - 2.4.2