michaelherold/interactor-contracts

View on GitHub
lib/interactor/contracts/breach_set.rb

Summary

Maintainability
A
0 mins
Test Coverage
A
100%
# frozen_string_literal: true

require 'delegate'

module Interactor
  module Contracts
    # A simple wrapper around set of breaches of contract constraints
    class BreachSet < SimpleDelegator
      # Converts the breach set into a Hash for use with context failing
      #
      # @example
      #   class AuthenticateUser
      #     include Interactor
      #     include Interactor::Contracts
      #
      #     expects do
      #       required(:email).filled
      #       required(:password).filled
      #     end
      #
      #     promises do
      #       required(:user).filled
      #       required(:token).filled
      #     end
      #
      #     on_breach do |breaches|
      #       context.fail!(breaches)
      #     end
      #   end
      #
      #   result = AuthenticateUser.call({})
      #   #=> #<Interactor::Context email=["email is missing"],
      #                             password=["password is missing"]>
      #
      #   result.failure?  #=> true
      #
      # @api public
      # @return [Hash] a hash with property keys and message values
      def to_hash
        each_with_object({}) do |(property, messages), result|
          result[property] =
            if messages.is_a?(Hash)
              Hash(result[property]).merge(messages)
            else
              Array(result[property]) | messages
            end
          result
        end
      end
      alias to_h to_hash
    end
  end
end