aglushkov/serega

View on GitHub
lib/serega/plugins/metadata/validations/check_block.rb

Summary

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

class Serega
  module SeregaPlugins
    module Metadata
      class MetaAttribute
        #
        # Validator for meta_attribute block parameter
        #
        class CheckBlock
          class << self
            #
            # Checks block provided with attribute
            # Block must have up to two arguments - object(s) and context.
            #
            # @example without arguments
            #   metadata(:version) { CONSTANT_VERSION }
            #
            # @example with one argument
            #   metadata(:paging) { |scope| { { page: scope.page, per_page: scope.per_page, total_count: scope.total_count } }
            #
            # @example with two arguments
            #   metadata(:paging) { |scope, context| { { ... } if context[:pagy] }
            #
            # @param block [Proc] Block that returns serialized meta attribute value
            #
            # @raise [SeregaError] SeregaError that block has invalid arguments
            #
            # @return [void]
            #
            def call(block)
              SeregaValidations::Utils::CheckExtraKeywordArg.call(block, "block")
              params_count = SeregaUtils::ParamsCount.call(block, max_count: 2)

              raise SeregaError, block_error if params_count > 2
            end

            private

            def block_error
              "Block can have maximum two parameters (object(s), context)"
            end
          end
        end
      end
    end
  end
end