simple_ruby_service 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1931553dbf6a835d17206efc865d38d6ea03a627936e5985e851a8c0a26cb79e
-  data.tar.gz: 64ce8e7423db632c6fabc68452428cef5b20c62396ffefa86d8e28b318da267f
+  metadata.gz: 43714cc68b788ec9560c521bea6b1f990c53df4355c1ea1926181a085d9995f5
+  data.tar.gz: 663f185df7329f6c11af20451accc328d00a62ca5fef47f484fc2075ceaf1b88
 SHA512:
-  metadata.gz: e388e6b6889c295f9aff7452692704833aeb85d9b8a1c9c3710e01e27c1ec87caaed477e17c12ef51a7cc8b80e2ed0ccb74680be771030303d4056d4c3c98f9d
-  data.tar.gz: e48303d314abe2837a02b862860f1b09cdc1cd63de85d0331f5143e946d179c7942e5aa31286a2c20e9a25c8df162aa2984a96f410b4bb7897ba61571a807077
+  metadata.gz: 9090c2b6e0cd08731df1094e0e9e1c73327b47c9c74ab853647fe0c48b898630a6800655e62a450d3a6ca932e14aeb807163129865b4bb9c2dcebf60c4f603ad
+  data.tar.gz: 49ba2e1b78455023bbeb560da3a89d2ee30375fab1beda505f525c03e789fa9a71949b698f0c8d534cc1120fd34dd25a583163a28d2cb526861943e7b0b760d5

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
-## 0.3.0 (01-Jul-21)
+## 1.0.1 (01-Jul-21)
+
+* Renamed SimpleRubyservice to SimpleRubyService
+* Minor updates for README
+
+## 1.0.0 (01-Jul-21)
 
 * Initial public release

data/README.md

@@ -1,18 +1,18 @@
-# Simple Ruby service
+# Simple Ruby Service
 
-Simple Ruby service is a lightweight framework for Ruby that makes it easy to create Services and Service Objects (SOs).
+Simple Ruby Service is a lightweight framework for Ruby that makes it easy to create Services and Service Objects (SOs).
 
 The framework provides a simple DSL that:
 
 1. Adds ActiveModel validations and error handling 
 2. Encourages a succinct, idiomatic coding style 
-3. Standardizes the SO interface 
+3. Allows Service Objects to ducktype as Procs
 
 ## Requirements
 
 * Ruby 1.9.2+
 
-_Simple Ruby service includes helpers for Rails 3.0+, but does not require Rails._
+_Simple Ruby Service includes helpers for Rails 3.0+, but does not require Rails._
 
 ## Download and installation
 
@@ -34,9 +34,9 @@ Source code can be downloaded on GitHub
   [github.com/amazing-jay/simple_ruby_service/tree/master](https://github.com/amazing-jay/simple_ruby_service/tree/master)
 
 
-### The following examples illustrate how Simple Ruby service can help you refactor complex business logic
+### The following examples illustrate how Simple Ruby Service can help you refactor complex business logic
 
-See [Usage](https://github.com/amazing-jay/simple_ruby_service#usage) & [Creating Simple Ruby services](https://github.com/amazing-jay/simple_ruby_service#creating-simple-ruby-services) for more information.
+See [Usage](https://github.com/amazing-jay/simple_ruby_service#usage) & [Creating Simple Ruby Services](https://github.com/amazing-jay/simple_ruby_service#creating-simple-ruby-services) for more information.
 
 #### ::Before:: Vanilla Rails with a fat controller (a contrived example)
 ```ruby
@@ -56,13 +56,13 @@ end
 ```ruby
 class SomeController < ApplicationController
   def show
-    # NOTE: Simple Ruby service Objects ducktype as Procs and do not need to be instantiated
+    # NOTE: Simple Ruby Service Objects ducktype as Procs and do not need to be instantiated
     render DoSomething.call(params).value
   end
 end
 
 class DoSomething
-  extend SimpleRubyservice::ServiceObject
+  include SimpleRubyService::ServiceObject
   
   attribute :id
   attr_accessor :resource
@@ -85,7 +85,7 @@ end
 ```ruby
 class SomeController < ApplicationController
   def show
-    # NOTE: Simple Ruby service methods can be chained together
+    # NOTE: Simple Ruby Service methods can be chained together
     render SomeService.new(params)
       .do_something
       .do_something_related
@@ -94,7 +94,7 @@ class SomeController < ApplicationController
 end
 
 class SomeService
-  extend SimpleRubyservice::Service
+  include SimpleRubyService::Service
   
   attribute :id
   attr_accessor :resource
@@ -110,7 +110,7 @@ class SomeService
       resource.do_something_related
     end
 
-    # NOTE: Unlike SOs, `value` must be explicitely set
+    # NOTE: Unlike SOs, `value` must be explicitely set for Service methods
     def do_something_related
       self.value ||= resource.tap &:do_something_related
     end
@@ -128,6 +128,8 @@ Service Object names should begin with a verb and should not include the words `
 
 Also, only one operation should be made public, it should always be named `call`, and it should not accept arguments (except for an optional block).
 
+_See [To bang!, or not to bang](https://github.com/amazing-jay/simple_ruby_service/tree/master#to-bang-or-not-to-bang) to learn about `.call!` vs. `.call`._
+
 #### Short form (_recommended_)
 
 ```ruby
@@ -143,17 +145,15 @@ result = DoSomething.new(foo: 'bar').call!
 ```ruby
 result = begin
   DoSomething.call!(foo: 'bar')
-rescue SimpleRubyservice::Invalid => e
+rescue SimpleRubyService::Invalid => e
   # do something with e.target.attributes
-rescue SimpleRubyservice::Failure
+rescue SimpleRubyService::Failure
   # do something with e.target.value
 end
 ```
 
 #### Conditional form 
 
-_See [To bang!, or not to bang](https://github.com/amazing-jay/simple_ruby_service/tree/master#to-bang-or-not-to-bang) to learn about `.call!` vs. `.call`._
-
 ```ruby
 result = DoSomething.call(foo: 'bar')
 if result.invalid?
@@ -188,6 +188,9 @@ Unlike Service Objects, Service class names should begin with a noun (and may in
 
 Also, any number of operations may be made public, any of these operations may be named `call`, and any of these operations may accept arguments.
 
+_See [To bang!, or not to bang](https://github.com/amazing-jay/simple_ruby_service/tree/master#to-bang-or-not-to-bang) to learn about `.service_method_name!` vs. `.service_method_name`._
+
+
 #### Short form
 
 _not available for Services_
@@ -199,8 +202,6 @@ result = SomeService.new(foo: 'bar').do_something!
 
 #### Chained form 
 
-_See [To bang!, or not to bang](https://github.com/amazing-jay/simple_ruby_service/tree/master#to-bang-or-not-to-bang) to learn about `.do_something!` vs. `.do_something`._
-
 ```ruby
 result = SomeService.new(foo: 'bar')
   .do_something
@@ -212,9 +213,9 @@ result = SomeService.new(foo: 'bar')
 ```ruby
 result = begin
   SomeService.new(foo: 'bar').do_something!
-rescue SimpleRubyservice::Invalid => e
+rescue SimpleRubyService::Invalid => e
   # do something with e.target.attributes
-rescue SimpleRubyservice::Failure
+rescue SimpleRubyService::Failure
   # do something with e.target.value
 end
 ```
@@ -241,12 +242,12 @@ result = SomeService.new(foo: 'bar').do_something! do |obj|
 end
 ```
 
-## Creating Simple Ruby services
+## Creating Simple Ruby Services
 
 ### Service Objects
-To implement an Simple Ruby service Object:
+To implement an Simple Ruby Service Object:
 
-  1. extend `SimpleRubyservice::ServiceObject`
+  1. include `SimpleRubyService::ServiceObject`
   2. declare attributes with the `attribute` keyword (class level DSL)
   3. declare validations see [Active Record Validations](https://guides.rubyonrails.org/active_record_validations.html)
   4. implement the special `perform` method (automatically invoked by `call` wrapper method)
@@ -257,12 +258,12 @@ _note: `perform` may optionally accept a block param, but no other args._
 Example::
 ```ruby
 class DoSomething
-  extend SimpleRubyservice::ServiceObject
+  include SimpleRubyService::ServiceObject
   
   attribute :attr1, :attr2             # should include all params required to execute, similar to ActiveRecord
   validates_presence_of :attr1         # validate params
 
-  def perform(&block)
+  def perform
     errors.add(:some critical service, message: 'down') and return unless some_critical_service.up?
     yield if block_given?
 
@@ -272,9 +273,9 @@ end
 ```
 
 ### Services
-To implement an Simple Ruby service:
+To implement an Simple Ruby Service:
 
-  1. extend `SimpleRubyservice::Service`
+  1. include `SimpleRubyService::Service`
   2. declare attributes with the `attribute` keyword (class level DSL)
   3. declare validations see [Active Record Validations](https://guides.rubyonrails.org/active_record_validations.html)
   4. define operations within a `service_methods` block (each method defined will be wrapped)
@@ -287,7 +288,7 @@ Example::
 
 ```ruby
 class SomeService 
-  extend SimpleRubyservice::Service
+  include SimpleRubyService::Service
   
   attribute :attr1, :attr2               # should include all params required to execute, similar to ActiveRecord
   validates_presence_of :attr1           # validate params
@@ -338,11 +339,11 @@ The framework does not include transaction support by default. You are responsib
 ### Control Flow
 Rescue exceptions that represent internal control flow and propogate the rest.
 
-For example, if an internal call to User.create! is expected to always succeed, allow `ActiveRecord::RecordInvalid` to propogate to the caller. If, on the otherhand, an internal call to User.create! is anticipated to conditionally fail on a uniqueness constraint, rescue `ActiveRecord::RecordInvalid` and rely on the framework to raise `SimpleRubyservice::Failure`.
+For example, if an internal call to User.create! is expected to always succeed, allow `ActiveRecord::RecordInvalid` to propogate to the caller. If, on the otherhand, an internal call to User.create! is anticipated to conditionally fail on a uniqueness constraint, rescue `ActiveRecord::RecordInvalid` and rely on the framework to raise `SimpleRubyService::Failure`.
 
 Example::
 ```ruby
-class DoSomethingDangerous < SimpleRubyservice::ObjectBase
+class DoSomethingDangerous < SimpleRubyService::ObjectBase
   attribute :attr1, :attr2             # should include all params required to execute
   validates_presence_of :attr1         # validate params to call
 
@@ -361,12 +362,12 @@ end
 ## Workflows
 SOs often need to call other SOs in order to implement various workflows:
 ```ruby
-class PerformSomeWorkflow < SimpleRubyservice::ObjectBase
+class PerformSomeWorkflow < SimpleRubyService::ObjectBase
   def perform
-    dependency = SimpleRubyservice1.call!
-    result = SimpleRubyservice2.call(dependency)
+    dependency = SimpleRubyService1.call!
+    result = SimpleRubyService2.call(dependency)
     raise unless result.success?                 
-    SimpleRubyservice3(dependency, result.value).call!
+    SimpleRubyService3(dependency, result.value).call!
   end
 end
 ```
@@ -381,8 +382,8 @@ The `attribute` and `attributes` keywords behaves similar to [ActiveRecord::Base
 Use the bang! version of an operation whenever you expect the operation to succeed more often than fail, and you don't need to chain operations together.
 
 Similar in pattern to `ActiveRecord#save!`, the bang version of each operation:
-* raises `SimpleRubyservice::Invalid` if `valid?` is falsey
-* raises `SimpleRubyservice::Failure` if the block provided returns a falsey value
+* raises `SimpleRubyService::Invalid` if `valid?` is falsey
+* raises `SimpleRubyService::Failure` if the block provided returns a falsey value
 * returns `@value`
 
 Whereas, similar in pattern to `ActiveRecord#save`, the regular version of each operation:
@@ -406,5 +407,6 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## DEVELOPMENT ROADMAP
 
-1. Isolate validation errors from execution errors (so that invalid? is not always true when failed? is true)
+1. Create a helper to dynamically generate default SOs for ActiveRecord models (`create`, `update`, and `destroy`) _(when used in a project that includes [ActiveRecord](https://github.com/rails/rails/tree/main/activerecord))_.
+2. Consider isolating validation errors from execution errors (so that invalid? is not always true when failed? is true)
 

data/lib/simple_ruby_service.rb

@@ -4,7 +4,7 @@
 require 'active_model'
 
 # namespace
-module SimpleRubyservice; end
+module SimpleRubyService; end
 
 require 'simple_ruby_service/version'
 require 'simple_ruby_service/error'

data/lib/simple_ruby_service/error.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module SimpleRubyservice
+module SimpleRubyService
   # simple exception class with target and message
   class Error < StandardError
     attr_accessor :target

data/lib/simple_ruby_service/errors.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module SimpleRubyservice
+module SimpleRubyService
   # Extnding ActiveModel::Errors with additional features:
   # 1. Adds ability to return array of errors
   # 2. Adds ability to decorate errors

data/lib/simple_ruby_service/failure.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
-module SimpleRubyservice
+module SimpleRubyService
   class Failure < Error; end
 end

data/lib/simple_ruby_service/invalid.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
-module SimpleRubyservice
+module SimpleRubyService
   class Invalid < Error; end
 end

data/lib/simple_ruby_service/service.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # See /README.md
-module SimpleRubyservice
+module SimpleRubyService
   module Service
     extend ActiveSupport::Concern
     include ActiveModel::AttributeAssignment

data/lib/simple_ruby_service/service_object.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # See /README.md
-module SimpleRubyservice
+module SimpleRubyService
   module ServiceObject
     extend ActiveSupport::Concern
     include Service

data/lib/simple_ruby_service/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
-module SimpleRubyservice
-  VERSION = '1.0.0'
+module SimpleRubyService
+  VERSION = '1.0.1'
 end

data/simple_ruby_service.gemspec

@@ -6,12 +6,12 @@ require "simple_ruby_service/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "simple_ruby_service"
-  spec.version       = SimpleRubyservice::VERSION
+  spec.version       = SimpleRubyService::VERSION
   spec.authors       = ["Jay Crouch"]
   spec.email         = ["i.jaycrouch@gmail.com"]
 
   spec.summary       = 'Simple Ruby Service is a lightweight framework for Ruby that makes it easy to create Services and Service Objects (SOs).'
-  spec.description   = 'Simple Ruby Service is a lightweight framework for Ruby that makes it easy to create Services and Service Objects (SOs). The framework provides a simple DSL that: adds ActiveModel validations and error handling; encourages a succinct, idiomatic coding style; and standardizes the SO interface.'
+  spec.description   = 'Simple Ruby Service is a lightweight framework for Ruby that makes it easy to create Services and Service Objects (SOs). The framework provides a simple DSL that: adds ActiveModel validations and error handling; encourages a succinct, idiomatic coding style; and allows Service Objects to ducktype as Procs.'
   spec.homepage      = 'https://github.com/amazing-jay/simple_ruby_service'
   spec.license       = "MIT"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple_ruby_service
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Jay Crouch
@@ -293,7 +293,7 @@ dependencies:
 description: 'Simple Ruby Service is a lightweight framework for Ruby that makes it
   easy to create Services and Service Objects (SOs). The framework provides a simple
   DSL that: adds ActiveModel validations and error handling; encourages a succinct,
-  idiomatic coding style; and standardizes the SO interface.'
+  idiomatic coding style; and allows Service Objects to ducktype as Procs.'
 email:
 - i.jaycrouch@gmail.com
 executables: []