simple_ruby_service 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1931553dbf6a835d17206efc865d38d6ea03a627936e5985e851a8c0a26cb79e
+  data.tar.gz: 64ce8e7423db632c6fabc68452428cef5b20c62396ffefa86d8e28b318da267f
+SHA512:
+  metadata.gz: e388e6b6889c295f9aff7452692704833aeb85d9b8a1c9c3710e01e27c1ec87caaed477e17c12ef51a7cc8b80e2ed0ccb74680be771030303d4056d4c3c98f9d
+  data.tar.gz: e48303d314abe2837a02b862860f1b09cdc1cd63de85d0331f5143e946d179c7942e5aa31286a2c20e9a25c8df162aa2984a96f410b4bb7897ba61571a807077

data/.gitignore

@@ -0,0 +1,63 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+*~
+log/*
+measurement/*
+
+# Used by dotenv library to load environment variables.
+.env
+
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+.ruby-version
+.ruby-gemset
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,4 @@
+--format progress
+--color
+--require spec_helper
+--order rand

data/.rubocop.yml

@@ -0,0 +1,86 @@
+# I can't get the requires to work with sublime:
+# SEE: https://github.com/pderichs/sublime_rubocop/issues/66
+# -- https://gist.github.com/topher6345/4f921ca3e7938132563e
+# -- https://forum.sublimetext.com/t/run-command-after-saving-file/44016
+# -- https://medium.com/devnetwork/running-rubocop-only-on-modified-files-a21aed86e06d
+# -- https://code.tutsplus.com/tutorials/how-to-create-a-sublime-text-2-plugin--net-22685
+
+# -- https://github.com/SublimeLinter/SublimeLinter-rubocop/issues/19
+#    -- https://github.com/fnando/sublime-codefmt
+#    -- https://github.com/fnando/sublime-switch-case
+#    -- https://github.com/fnando/sublime-rubocop-completion/issues/1
+# required these fixes:
+#    -- install PackageDev https://forum.sublimetext.com/t/pathlib-not-found-in-purchased-version/49978
+#    -- download all 3 packages via git clone rather than package manager
+#    -- renamed several files and directories to match
+#    -- brew update
+#    -- brew doctor
+#    -- brew install prettier yapf
+
+require:
+  - rubocop-performance
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.5
+  NewCops: enable
+
+Style/Documentation:
+  Enabled: false
+
+Naming/VariableNumber:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - "**/*.rake"
+    - "config/**/*"
+    - "Rakefile"
+    - "spec/**/*.rb"
+    - "*.gemspec"
+
+Layout/LineLength:
+  Max: 120
+
+Style/BlockComments:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/RedundantBegin:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+
+Style/WordArray:
+  EnforcedStyle: brackets
+
+Metrics/MethodLength:
+  Max: 15
+
+Style/HashSyntax:
+  Enabled: false
+
+Style/StringHashKeys:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Layout/DotPosition:
+  Enabled: false
+
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - "spec/**/*"
+
+RSpec/NamedSubject:
+  Enabled: false
+# Rails:
+#   Enabled: true
+

data/.simplecov

@@ -0,0 +1,4 @@
+SimpleCov.start do
+  add_filter "/spec/"
+  add_filter "/tmp/"
+end

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## 0.3.0 (01-Jul-21)
+
+* Initial public release

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in simple_ruby_service.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Jay Crouch
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,410 @@
+# Simple Ruby service
+
+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 
+
+## Requirements
+
+* Ruby 1.9.2+
+
+_Simple Ruby service includes helpers for Rails 3.0+, but does not require Rails._
+
+## Download and installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'simple_ruby_service'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simple_ruby_service
+
+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
+
+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
+class SomeController < ApplicationController
+  def show
+    raise unless params[:id].present?
+    resource = SomeModel.find(id)
+    authorize! resource
+    resource.do_something
+    value = resource.do_something_related
+    render value
+  end
+end
+```
+
+#### ::After:: Refactored using an SO
+```ruby
+class SomeController < ApplicationController
+  def show
+    # 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
+  
+  attribute :id
+  attr_accessor :resource
+
+  # NOTE: Validations are executed prior to the business logic encapsulated in `perform`
+  validate do                                 
+    @resource ||= SomeModel.find(id)
+    authorize! resource
+  end
+  
+  # NOTE: The return value of `perform` is automatically stored as the SO's `value`
+  def perform
+    resource.do_something
+    resource.do_something_related
+  end
+end
+```
+
+#### ::Alternate Form:: Refactored using a Service
+```ruby
+class SomeController < ApplicationController
+  def show
+    # NOTE: Simple Ruby service methods can be chained together
+    render SomeService.new(params)
+      .do_something
+      .do_something_related
+      .value
+  end
+end
+
+class SomeService
+  extend SimpleRubyservice::Service
+  
+  attribute :id
+  attr_accessor :resource
+
+  # NOTE: Validations are executed prior to the first service method called
+  validate do
+    @resource ||= SomeModel.find(id)
+    authorize! @resource
+  end
+  
+  service_methods do
+    def do_something
+      resource.do_something_related
+    end
+
+    # NOTE: Unlike SOs, `value` must be explicitely set
+    def do_something_related
+      self.value ||= resource.tap &:do_something_related
+    end
+  end
+end
+```
+
+## Usage
+
+### Service Objects
+
+Service Object names should begin with a verb and should not include the words `service` or `object`:
+- GOOD = `CreateUser`
+- BAD = `UserCreator`, `CreateUserServiceObject`, etc.
+
+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).
+
+#### Short form (_recommended_)
+
+```ruby
+result = DoSomething.call!(foo: 'bar')
+```
+
+#### Instance form
+```ruby
+result = DoSomething.new(foo: 'bar').call!
+```
+
+#### Rescue form
+```ruby
+result = begin
+  DoSomething.call!(foo: 'bar')
+rescue SimpleRubyservice::Invalid => e
+  # do something with e.target.attributes
+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?
+  # do something with result.attributes
+elsif result.failure?
+  # do something with result.value
+else
+  # do something with result.errors
+end
+```
+
+#### Block form 
+_note: blocks, if present, are envoked prior to failure check._
+
+```ruby
+result = DoSomething.call!(foo: 'bar') do |obj|
+  obj.errors.clear # clear errors
+  'new value'      # set result = 'new value'
+end
+```
+
+#### Dependency injection form
+```ruby
+DoSomething.call!(with: DoSomethingFirst.call!)
+```
+
+### Services
+
+Unlike Service Objects, Service class names should begin with a noun (and may include the words `service` or `object`):
+- GOOD = `UserCreator`
+- BAD = `CreateUser`, `UserCreatorService`, etc.
+
+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.
+
+#### Short form
+
+_not available for Services_
+
+#### Instance form
+```ruby
+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
+  .do_something_else
+  .value
+```
+
+#### Rescue form
+```ruby
+result = begin
+  SomeService.new(foo: 'bar').do_something!
+rescue SimpleRubyservice::Invalid => e
+  # do something with e.target.attributes
+rescue SimpleRubyservice::Failure
+  # do something with e.target.value
+end
+```
+
+#### Conditional form
+```ruby
+result = SomeService.new(foo: 'bar').do_something
+if result.invalid?
+  # do something with result.attributes
+elsif result.failure?
+  # do something with result.value
+else
+  # do something with result.errors
+end
+```
+
+#### Block form
+_note: blocks, if present, are envoked prior to failure check._
+
+```ruby
+result = SomeService.new(foo: 'bar').do_something! do |obj|
+  obj.errors.clear # clear errors
+  'new value'      # set result = 'new value'
+end
+```
+
+## Creating Simple Ruby services
+
+### Service Objects
+To implement an Simple Ruby service Object:
+
+  1. extend `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)
+  5. add errors to indicate the operation failed
+
+_note: `perform` may optionally accept a block param, but no other args._
+ 
+Example::
+```ruby
+class DoSomething
+  extend SimpleRubyservice::ServiceObject
+  
+  attribute :attr1, :attr2             # should include all params required to execute, similar to ActiveRecord
+  validates_presence_of :attr1         # validate params
+
+  def perform(&block)
+    errors.add(:some critical service, message: 'down') and return unless some_critical_service.up?
+    yield if block_given?
+
+    'hello world'                      # set `value` to the returned value of the operation
+  end
+end
+```
+
+### Services
+To implement an Simple Ruby service:
+
+  1. extend `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)
+  5. set (or modify) `self.value` (if your service method creates artifacts
+  6. add errors to indicate the operation failed
+
+_note: service methods may accept any arguments, required or otherwise._
+
+Example::
+
+```ruby
+class SomeService 
+  extend SimpleRubyservice::Service
+  
+  attribute :attr1, :attr2               # should include all params required to execute, similar to ActiveRecord
+  validates_presence_of :attr1           # validate params
+
+  service_methods do
+    def hello
+      self.value = 'hello world'         # set value
+    end
+    
+    def oops
+      errors.add(:foo, :bar)             # indicate failure
+    end
+
+    
+    def goodbye(arg1, arg2 = nil, arg3: arg4: nil, &block)
+      self.value += '...goodnight sweet world'                # modify value
+    end
+  end
+end
+```
+
+## FAQ
+
+### Why should I use Services & SOs?
+
+[Click here](https://www.google.com/search?q=service+object+pattern+rails&rlz=1C5CHFA_enUS893US893&oq=service+object+pattern+rails) to learn more about the Services & SO design pattern.
+
+**TLDR; fat models and fat controllers are bad! Services and Service Objects help you DRY things up.**
+
+### How is a Service different from an SO?
+
+An SO is just a Service that encapsulates a single operation (i.e. **one, and only one, responsibility**).
+
+### When should I choose a Service over an SO, and vice-versa?
+
+Use a `Service` when encapsulating related operations that share dependencies & validations.
+
+i.e.:
+
+* Create a Service with two service methods when operation `A` and operation `B` both act on a `User` (and are related in some way).
+* Create two Service Objects when operation `A` and operation `B` are related, but `A` acts on a `User` while `B` acts on a `Company`.
+
+_note: Things get fuzzy when operations share some, but not all, dependencies & validations. Use your best judgement when operation `A` and operation `B` are related but `A` acts on a `User` while `B` acts on both a `User` & a `Company`._
+
+### Atomicity
+The framework does not include transaction support by default. You are responsible for wrapping with a transaction if atomicity is desired.
+
+### 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`.
+
+Example::
+```ruby
+class DoSomethingDangerous < SimpleRubyservice::ObjectBase
+  attribute :attr1, :attr2             # should include all params required to execute
+  validates_presence_of :attr1         # validate params to call
+
+  def perform
+    ActiveRecord::Base.transaction do  # optional
+      self.value = # ... do work ...   # save results for the caller
+    end
+  rescue SomeDependency::Failed
+    errors[:base] << e.message         # notify the caller of error
+  rescue ActiveRecord::RecordInvalid
+    # ... fix things and retry ...
+  end
+end
+```
+
+## Workflows
+SOs often need to call other SOs in order to implement various workflows:
+```ruby
+class PerformSomeWorkflow < SimpleRubyservice::ObjectBase
+  def perform
+    dependency = SimpleRubyservice1.call!
+    result = SimpleRubyservice2.call(dependency)
+    raise unless result.success?                 
+    SimpleRubyservice3(dependency, result.value).call!
+  end
+end
+```
+
+## MISC
+
+### Attributes
+The `attribute` and `attributes` keywords behaves similar to [ActiveRecord::Base.attribute](https://api.rubyonrails.org/v6.1.3.1/classes/ActiveRecord/Attributes/ClassMethods.html), but they are not typed or bound to persistant storage.
+
+### To bang!, or not to bang
+
+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
+* returns `@value`
+
+Whereas, similar in pattern to `ActiveRecord#save`, the regular version of each operation:
+* doesn't raise any exceptions
+* passes the return value of the block provided to `#success?` 
+* returns self << _note: this is unlike `ActiveRecord#save`_
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/amazing-jay/simple_ruby_service. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## DEVELOPMENT ROADMAP
+
+1. Isolate validation errors from execution errors (so that invalid? is not always true when failed? is true)
+

data/Rakefile

@@ -0,0 +1,23 @@
+#!/usr/bin/env rake
+
+def initialize_rake_environment
+  return unless require_relative "config/environment"
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+Bundler::GemHelper.install_tasks
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+task default: :spec
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+RuboCop::RakeTask.new do |task|
+  task.requires << "rubocop-performance"
+  task.requires << "rubocop-rspec"
+end

data/lib/simple_ruby_service.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+# requre the runtime dependencies that aren't automatically loaded by bundler
+require 'active_model'
+
+# namespace
+module SimpleRubyservice; end
+
+require 'simple_ruby_service/version'
+require 'simple_ruby_service/error'
+require 'simple_ruby_service/errors'
+require 'simple_ruby_service/failure'
+require 'simple_ruby_service/invalid'
+require 'simple_ruby_service/service'
+require 'simple_ruby_service/service_object'

data/lib/simple_ruby_service/error.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module SimpleRubyservice
+  # simple exception class with target and message
+  class Error < StandardError
+    attr_accessor :target
+
+    def initialize(target, msg)
+      @target = target
+      super msg
+    end
+  end
+end

data/lib/simple_ruby_service/errors.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module SimpleRubyservice
+  # Extnding ActiveModel::Errors with additional features:
+  # 1. Adds ability to return array of errors
+  # 2. Adds ability to decorate errors
+  # 2. Adds ability to internationalize errors
+  class Errors
+    delegate_missing_to :@active_model_errors
+
+    attr_reader :original_errors
+    attr_reader :active_model_errors
+
+    def initialize(base)
+      @base = base
+      @original_errors = []
+      @active_model_errors = ActiveModel::Errors.new(base)
+    end
+
+    def add(attribute, message = :invalid, options = {})
+      # store original arguments, since Rails 5 errors don't store `message`, only it's translation.
+      # can be avoided with Rails 6.
+      original_errors << OpenStruct.new(
+        attribute: attribute,
+        message: message,
+        options: options
+      )
+      active_model_errors.add(attribute, message, options)
+    end
+
+    def api_errors(&decorate_error)
+      original_errors.map do |e|
+        type = e.message.is_a?(Symbol) ? e.message : nil
+        message = type ? active_model_errors.generate_message(e.attribute, e.message, e.options) : e.message
+        full_message = full_message(e.attribute, message)
+
+        error = {
+          full_message: full_message,
+          message: message,
+          type: type,
+          attribute: e.attribute,
+          options: e.options
+        }
+
+        error = decorate_error.call(error) if decorate_error
+        error
+      end
+    end
+
+    # Support ovveriding format for each error (not avaliable in rails 5)
+    def full_message(attribute, message)
+      return message if attribute == :base
+
+      attr_name = attribute.to_s.tr('.', '_').humanize
+      attr_name = @base.class.human_attribute_name(attribute, default: attr_name)
+
+      defaults = i18n_keys(attribute, '_format')
+      defaults << :"errors.format"
+      defaults << '%{attribute} %{message}'
+
+      I18n.t(defaults.shift,
+             default: defaults,
+             attribute: attr_name,
+             message: message)
+    end
+
+    def i18n_keys(attribute, key)
+      if @base.class.respond_to?(:i18n_scope)
+        i18n_scope = @base.class.i18n_scope.to_s
+        @base.class.lookup_ancestors.flat_map do |klass|
+          [:"#{i18n_scope}.errors.models.#{klass.model_name.i18n_key}.attributes.#{attribute}.#{key}"]
+        end
+      else
+        []
+      end
+    end
+
+    def clear
+      original_errors.clear
+      active_model_errors.clear
+    end
+  end
+end

data/lib/simple_ruby_service/failure.rb

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

data/lib/simple_ruby_service/invalid.rb

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

data/lib/simple_ruby_service/service.rb

@@ -0,0 +1,134 @@
+# frozen_string_literal: true
+
+# See /README.md
+module SimpleRubyservice
+  module Service
+    extend ActiveSupport::Concern
+    include ActiveModel::AttributeAssignment
+    include ActiveModel::Validations
+
+    included do
+      attr_accessor :value
+    end
+
+    class_methods do
+      def attributes
+        @attributes ||= []
+      end
+
+      # Class level DSL that registers attributes to inform #attributes getter.
+      def attribute(*attrs)
+        Module.new.tap do |m| # Using anonymous modules so that super can be used to extend accessor methods
+          include m
+
+          attrs = attrs.map(&:to_sym)
+          (attrs - attributes).each do |attr_name|
+            attributes << attr_name.to_sym
+            m.attr_accessor attr_name
+          end
+        end
+      end
+
+      # Class level DSL that wraps the methods defined in inherited classes.
+      def service_methods(&blk)
+        Module.new.tap do |m| # Using anonymous modules so that super can be used to extend service methods
+          m.module_eval &blk
+          include m
+
+          m.instance_methods.each do |service_method|
+            m.alias_method "perform_#{service_method}", service_method
+
+            # Returns self (for chainability).
+            # Evaluates validity prior to executing the block provided.
+            define_method service_method do |*args, **kwargs, &callback|
+              perform(service_method, *args, **kwargs, &callback) if valid?
+
+              self
+            end
+
+            # Returns #value (i.e. the result of block provided).
+            # Raises Invalid if validation reports any errors.
+            # Raises Failure if the blk provided reports any errors.
+            define_method "#{service_method}!" do |*args, **kwargs, &callback|
+              send(service_method, *args, **kwargs, &callback)
+              raise Invalid.new self, errors.full_messages unless valid?
+              raise Failure.new self, errors.full_messages unless success?
+
+              value
+            end
+          end
+        end
+      end
+    end
+
+    # Always returns self (for chainability).
+    def reset!
+      errors.clear
+      @valid = nil
+      self.value = nil
+
+      self
+    end
+
+    # Returns true unless validations or any actions added errors [even if no action(s) has been executed]
+    def success?
+      valid? && errors.empty? # valid? ensures validations have run, errors.empty? catchs errors added during execution
+    end
+
+    def failure?
+      !success?
+    end
+
+    # Ensures all validations have run, then returns true if no errors were found, false otherwise.
+    # NOTE: Overriding ActiveModel::Validations#valid?, so as to not re-validate (unless reset! is called).
+    # SEE: https://www.rubydoc.info/gems/activemodel/ActiveModel/Validations#valid%3F-instance_method
+    def valid?(context = nil)
+      return @valid unless @valid.nil?
+
+      @valid = super # memoize result to indicate validations have run
+    end
+
+    def attributes
+      self.class.attributes.each_with_object({}) do |attr_name, h|
+        h[attr_name] = send(attr_name)
+      end
+    end
+
+    # Hook override to enable validation of non-attributes and error messages for random keys
+    #   e.g. validates :random, presence: true
+    #   e.g. errors.add :random, :message => 'evil is near'
+    # SEE: https://www.rubydoc.info/docs/rails/ActiveModel%2FValidations:read_attribute_for_validation
+    def read_attribute_for_validation(attribute)
+      send(attribute) if respond_to?(attribute)
+    end
+
+    protected
+
+    def initialize(attributes = {})
+      assign_attributes attributes
+    end
+
+    def perform(service_method, *args, **kwargs, &callback)
+      if kwargs.empty?
+        send("perform_#{service_method}", *args, &callback)
+      else
+        send("perform_#{service_method}", *args, **kwargs, &callback)
+      end
+    end
+
+    def add_errors_from_object(obj, key: nil, full_messages: false)
+      if full_messages
+        key ||= obj.class.name.underscore.to_sym
+        obj.errors.full_messages.each do |msg|
+          errors.add(key, msg)
+        end
+      else
+        obj.errors.messages.each do |obj_key, msgs|
+          msgs.each { |msg| errors.add(key || obj_key, msg) }
+        end
+      end
+    end
+  end
+end
+
+

data/lib/simple_ruby_service/service_object.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+# See /README.md
+module SimpleRubyservice
+  module ServiceObject
+    extend ActiveSupport::Concern
+    include Service
+
+    included do
+      class << self
+        undef_method :service_methods
+      end
+    end
+
+    # Class level DSL for convenience.
+    class_methods do
+      def call(attributes = {}, &callback)
+        new(attributes).call(&callback)
+      end
+
+      def call!(attributes = {}, &callback)
+        new(attributes).call!(&callback)
+      end
+    end
+
+    # Returns self (for chainability).
+    # Memoizes to `value` the result of the blk provided.
+    # Evaluates validity prior to executing the block provided.
+    def call(&callback)
+      self.value = perform(&callback) if valid?
+
+      self
+    end
+
+    # Returns #value (i.e. the result of block provided).
+    # Raises Invalid if validation reports any errors.
+    # Raises Failure if the blk provided reports any errors.
+    def call!(&callback)
+      call(&callback)
+      raise Invalid.new self, errors.full_messages unless valid?
+      raise Failure.new self, errors.full_messages unless success?
+
+      value
+    end
+
+    protected
+    # Abstract method
+    def perform
+      raise NoMethodError, "#perform must be implemented."
+    end
+  end
+end

data/lib/simple_ruby_service/version.rb

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

data/simple_ruby_service.gemspec

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "simple_ruby_service/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "simple_ruby_service"
+  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.homepage      = 'https://github.com/amazing-jay/simple_ruby_service'
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = 'https://github.com/amazing-jay/simple_ruby_service'
+    spec.metadata["changelog_uri"] = "https://github.com/amazing-jay/simple_ruby_service/blob/master/CHANGELOG.md"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  # 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
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|bin|config)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'activemodel'
+  spec.add_dependency 'activesupport'
+
+  # spec.add_development_dependency 'actionpack'
+  spec.add_development_dependency "awesome_print", "~> 1.9.2"
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "database_cleaner", "~> 2.0.1"
+  spec.add_development_dependency "dotenv", "~> 2.5"
+  spec.add_development_dependency "factory_bot", "~> 6.2.0"
+  spec.add_development_dependency "faker", "~> 2.18"
+  spec.add_development_dependency "listen", "~> 3.5.1"
+  spec.add_development_dependency "pry-byebug", "~> 3.9"
+  spec.add_development_dependency "rails", "~> 6.1.3.2"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec-rails", "~> 5.0.1"
+  spec.add_development_dependency "rubocop", "~> 0.60"
+  spec.add_development_dependency "rubocop-performance", "~> 1.5"
+  spec.add_development_dependency "rubocop-rspec", "~> 1.37"
+  spec.add_development_dependency "simplecov", "~> 0.16"
+  spec.add_development_dependency "sqlite3", "~> 1.4.2"
+  spec.add_development_dependency "webmock", "~> 3.13"
+end

metadata

@@ -0,0 +1,348 @@
+--- !ruby/object:Gem::Specification
+name: simple_ruby_service
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jay Crouch
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-07-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.9.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.2.0
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.18'
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.1
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.3.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.3.2
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.1
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.60'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.60'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.37'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.37'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.2
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+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.'
+email:
+- i.jaycrouch@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".simplecov"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/simple_ruby_service.rb
+- lib/simple_ruby_service/error.rb
+- lib/simple_ruby_service/errors.rb
+- lib/simple_ruby_service/failure.rb
+- lib/simple_ruby_service/invalid.rb
+- lib/simple_ruby_service/service.rb
+- lib/simple_ruby_service/service_object.rb
+- lib/simple_ruby_service/version.rb
+- simple_ruby_service.gemspec
+homepage: https://github.com/amazing-jay/simple_ruby_service
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/amazing-jay/simple_ruby_service
+  source_code_uri: https://github.com/amazing-jay/simple_ruby_service
+  changelog_uri: https://github.com/amazing-jay/simple_ruby_service/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.9
+signing_key:
+specification_version: 4
+summary: Simple Ruby Service is a lightweight framework for Ruby that makes it easy
+  to create Services and Service Objects (SOs).
+test_files: []