simpler_command 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 667240bb9109486b654cb65b71cec68f795d260883567c696e8fef2051dfe8f0
+  data.tar.gz: 58899bb01b7775769a386432010de4044120a8b2ee2e6c84f5cff55783c2083a
+SHA512:
+  metadata.gz: a6561d0f75b6dbcde6a8246c32d5943f29fcd988eb81760c29d00f6f190b5ba121a371af2f75d2d3b6ff3b2d86d721aa9e2152694f105ab76a690d8b19251153
+  data.tar.gz: 566d35c4e9c1bea2ace1f2f9f1cf9d47693013005ea4956143da4d424498a99e6a9a51d31fadf9976dc48b5cdff848e73e206285e03080bf93a11f31cea52b0c

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,18 @@
+AllCops:
+  NewCops: enable
+
+Layout/LineLength:
+  Max: 100 # Set line width to more sensible default
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes # prefer double quotes
+
+Style/FormatStringToken:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: always_true # immutable code where possible

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.0
+before_install: gem install bundler -v 2.1.4

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Changelog
+
+## [Unreleased]
+
+### Added
+
+- Initial commit
+
+### Changed
+
+### Removed

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in simpler_command.gemspec
+gemspec
+
+gem "activemodel", "~> 6.0.3"
+gem "activesupport", "~> 6.0.3"
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+gem "rubocop", "~> 0.90.0"
+gem "simplecov", "~> 0.19.0"

data/Gemfile.lock

@@ -0,0 +1,79 @@
+PATH
+  remote: .
+  specs:
+    simpler_command (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (6.0.3.3)
+      activesupport (= 6.0.3.3)
+    activesupport (6.0.3.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    ast (2.4.1)
+    concurrent-ruby (1.1.7)
+    diff-lcs (1.4.4)
+    docile (1.3.2)
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.2)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    regexp_parser (1.7.1)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    rubocop (0.90.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.3.0, < 1.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.3.0)
+      parser (>= 2.7.1.4)
+    ruby-progressbar (1.10.1)
+    simplecov (0.19.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+    simplecov-html (0.12.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.7.0)
+    zeitwerk (2.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activemodel (~> 6.0.3)
+  activesupport (~> 6.0.3)
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.90.0)
+  simpler_command!
+  simplecov (~> 0.19.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Ben Morrall
+
+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,192 @@
+# SimplerCommand
+
+Yet another simple and standardized way to build and use Commands (aka Service Objects).
+
+Strongly inspired by [simple_command](https://github.com/nebulab/simple_command).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'simpler_command'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install simpler_command
+
+## Usage
+
+Here's a basic example of a Command that updates an Album's description, from data collected from an external API.
+
+```ruby
+class UpdateAlbumDescription
+  prepend SimplerCommand
+
+  def initialize(album, lastfm_client)
+    @album = album
+    @lastfm_client = @lastfm_client
+  end
+
+  def call
+    album_info = @lastfm_client.album.get_info(album: album.name, artist: album.artist_name)
+    description = album_info.dig("wiki", "contents")
+    if description.blank?
+      errors.add(:description, "was not found on Last.fm")
+      return
+    end
+
+    @album.update(description: description)
+    nil
+  end
+end
+```
+
+The Command can be invoked by calling `.call` on the class.
+
+```ruby
+class Albums::UpdateDescriptionController < ApplicationController
+  def create
+    album = Album.find(params[:album_id])
+    lastfm_client = Lastfm.new(ENV.fetch("LASTFM_API_KEY"), ENV.fetch("LASTFM_API_SECRET"))
+
+    command = UpdateAlbumDescription.call(album, lastfm_client)
+    if command.success?
+      flash[:notice] = "Description updated successfully"
+      redirect_to album
+    else
+      flash[:alert] = alert.errors.full_messages.to_sentence
+      redirect_to edit_album_path(album)
+    end
+  end
+end
+```
+
+### The result object
+
+Commands are Service Objects, built with the intent of following the principles of Command-query separation: every method should either be a command that performs an action, or a query that returns data to the caller, but not both.
+
+Occassionally, there are instances where some data would assist with control flow or for logging. In those cases, the returned object from your call is availale from the `result` method in the returned object.
+
+```ruby
+PublishPost = Struct.new(:post) do
+  prepend SimplerCommand
+
+  def call
+    published_date = Time.zone.now
+    unless post.update(published_date: published_date)
+      errors.add(:base, "Unable to update the Post")
+      errors.add_all(post.errors)
+    end
+    published_date
+  end
+end
+
+# ...
+
+post = Post.find(123)
+command = PublishPost.call(post)
+if command.success?
+  logger.info("Post published on: " + command.result.strftime("%Y-%m-%d"))
+end
+```
+
+Attempting to call the `result` method for a failed command will result in a `SimplerCommand::Failure` being raised.
+
+Additionally, you can invoke the `call` method by passing a block, which will yeild the result for a successful operation, or raise `SimplerCommand::Failure` in the advent of an error.
+
+```ruby
+class PublishPostJob < ApplicationJob
+  retry_on SimplerCommand::Failure
+
+  def perform(post)
+    PublishPost.call(post) do |published_date|
+      Rollbar.info("Post published on: " + published_date.strftime("%Y-%m-%d"))
+    end
+  end
+end
+```
+
+You can also use the `.call!` method instead of `.call`. If there aren't any errors, it will return the result, otherwise it will raise an exception.
+
+```ruby
+published_date = PublishPost.call!
+puts "Post published on: " + published_date.strftime("%Y-%m-%d")
+```
+
+### Using ActiveModel::Validations with I18n
+
+String translations for errors can be provided by using ActiveModel::Validations within your Command.
+
+```ruby
+class ExampleCommand
+  prepend SimplerCommand
+  include ActiveModel::Validations
+
+  def call
+    errors.add(:base, :failure)
+    nil
+  end
+end
+```
+
+in your locale file
+
+```yaml
+# config/locales/en.yml
+en:
+  activemodel:
+    errors:
+      models:
+        example_command:
+          failure: Everything is wrong!
+```
+
+### Testing with RSpec
+
+Make the spec file `spec/commands/authenticate_user_spec.rb` like:
+
+```ruby
+describe AuthenticateUser do
+  subject(:context) { described_class.call(username, password) }
+
+  describe '.call' do
+    context 'when the call is successful' do
+      let(:username) { 'correct_user' }
+      let(:password) { 'correct_password' }
+
+      it 'succeeds' do
+        expect(context).to be_success
+      end
+    end
+
+    context 'when the call is not successful' do
+      let(:username) { 'wrong_user' }
+      let(:password) { 'wrong_password' }
+
+      it 'fails' do
+        expect(context).to be_failure
+      end
+    end
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/bmorrall/simpler_command.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "simpler_command"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/simpler_command.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require "simpler_command/version"
+require "simpler_command/string_utils"
+require "simpler_command/errors"
+
+# Provides a simple structure for Commands (Services).
+#
+# Prepend SimplerCommand to your Command (Service) objects and implemente a call methods.
+#
+# In the advent of a failure, Log any errors to an errors object.
+module SimplerCommand
+  # Indicates the implementing class has not defined a #call method
+  class NotImplementedError < StandardError; end
+
+  # Indicates the #call function did not succeed
+  class Failure < StandardError; end
+
+  # Provided class methods to each implementing class
+  module ClassMethods
+    def call(*args, &block)
+      new(*args).call(&block)
+    end
+
+    def call!(*args)
+      call(*args).result
+    end
+  end
+
+  def self.prepended(base)
+    base.extend ClassMethods
+  end
+
+  def call(&block)
+    raise NotImplementedError unless defined?(super)
+
+    unless called?
+      @called = true
+      @result = super
+    end
+
+    yield result if block_given?
+
+    self
+  end
+
+  def success?
+    called? && !failure?
+  end
+  alias successful? success?
+
+  def result
+    raise Failure, StringUtils.to_sentence(errors.full_messages) if failure?
+
+    @result
+  end
+
+  def failure?
+    called? && errors.any?
+  end
+
+  def errors
+    return super if defined?(super)
+
+    @errors ||= Errors.new
+  end
+
+  private
+
+  def called?
+    @called ||= false
+  end
+end

data/lib/simpler_command/errors.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module SimplerCommand
+  # Provides an Errors implementation similar to ActiveModel::Errors
+  class Errors < Hash
+    def add(key, value, _opts = {})
+      self[key] ||= []
+      self[key] << value
+      self[key].uniq!
+    end
+
+    def add_all(errors_hash)
+      errors_hash.each do |key, values|
+        Array(values).each do |value|
+          add key, value
+        end
+      end
+    end
+
+    def each
+      each_key do |field|
+        self[field].each { |message| yield field, message }
+      end
+    end
+
+    def full_messages
+      map { |attribute, message| full_message(attribute, message) }
+    end
+
+    # Allow ActiveSupport to render errors similar to ActiveModel::Errors
+    def as_json(options = nil)
+      {}.tap do |output|
+        each do |field, value|
+          output[field] ||= []
+          output[field] << value
+        end
+      end.as_json(options)
+    end
+
+    private
+
+    def full_message(attribute, message)
+      return message if attribute == :base
+
+      attr_name = StringUtils.humanize(attribute.to_s)
+      [attr_name, message].join(" ")
+    end
+  end
+end

data/lib/simpler_command/string_utils.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module SimplerCommand
+  # Simple Utilities for either using ActiveSupport methods, or falling back to equivalents.
+  #
+  # Used only for generating Human-readable Strings, which should not be used for logic
+  module StringUtils
+    module_function
+
+    # Converts a string to a human-readable string
+    def humanize(string)
+      attribute = string.tr(".", "_")
+      if attribute.respond_to?(:humanize)
+        attribute.humanize
+      else
+        attribute.tr("_", " ").capitalize
+      end
+    end
+
+    # Attempt Array#to_sentence provided by ActiveSupport, or fall back to join
+    def to_sentence(array)
+      if array.respond_to?(:to_sentence)
+        array.to_sentence
+      else
+        array.join(", ")
+      end
+    end
+  end
+end

data/lib/simpler_command/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SimplerCommand
+  VERSION = "0.1.0"
+end

data/simpler_command.gemspec

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative "lib/simpler_command/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "simpler_command"
+  spec.version       = SimplerCommand::VERSION
+  spec.authors       = ["Ben Morrall"]
+  spec.email         = ["bemo56@hotmail.com"]
+
+  spec.summary       = "Yet another simple and standardized way to build and use Commands (aka Service Objects)"
+  spec.homepage      = "https://github.com/bmorrall/simpler_command"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/bmorrall/simpler_command"
+  spec.metadata["changelog_uri"] = "https://github.com/bmorrall/simpler_command/blob/master/CHANGELOG.md"
+
+  # 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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: simpler_command
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ben Morrall
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-09-11 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- bemo56@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/simpler_command.rb
+- lib/simpler_command/errors.rb
+- lib/simpler_command/string_utils.rb
+- lib/simpler_command/version.rb
+- simpler_command.gemspec
+homepage: https://github.com/bmorrall/simpler_command
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/bmorrall/simpler_command
+  source_code_uri: https://github.com/bmorrall/simpler_command
+  changelog_uri: https://github.com/bmorrall/simpler_command/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: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Yet another simple and standardized way to build and use Commands (aka Service
+  Objects)
+test_files: []