class SumsUp::Core::Matcher

Matching DSL for sum type variants. Methods in this class are prefixed with an _ so as not to conflict with the names of user-defined variant names. Use .build_matcher_class to generate a new subclass for a variant given the other variant names.

Public Class Methods

build_matcher_class(variant, other_variants) click to toggle source
# File lib/sums_up/core/matcher.rb, line 10
def self.build_matcher_class(variant, other_variants)
  Class.new(self) do
    const_set(:VARIANT, variant)
    const_set(:ALL_VARIANTS, [variant, *other_variants].freeze)
    const_set(:IncorrectMatcher, incorrect_matcher_module(other_variants))

    include(const_get(:IncorrectMatcher))

    alias_method(variant, :_correct_variant_matcher)
  end
end
incorrect_matcher_module(variants) click to toggle source
# File lib/sums_up/core/matcher.rb, line 22
def self.incorrect_matcher_module(variants)
  Module.new do
    variants.each do |variant|
      define_method(variant) do |_value = nil|
        _ensure_wildcard_not_matched!(variant)
        _ensure_no_duplicate_match!(variant)

        @matched_variants << variant

        self
      end
    end
  end
end
new(variant_instance) click to toggle source
# File lib/sums_up/core/matcher.rb, line 37
def initialize(variant_instance)
  @variant_instance = variant_instance

  @matched = false
  @matched_variants = []
  @wildcard_matched = false
  @result = nil
end

Public Instance Methods

_(value = nil) { |variant_instance| ... } click to toggle source
# File lib/sums_up/core/matcher.rb, line 46
def _(value = nil)
  _ensure_wildcard_not_matched!(:_)

  @wildcard_matched = true

  return self if @matched

  @result = block_given? ? yield(@variant_instance) : value

  self
end
_correct_variant_matcher(value = nil) { |*members(dup: false)| ... } click to toggle source

Defining #_correct_variant_matcher “statically” allows us to use yield instead of block.call, which is much faster in most ruby versions. github.com/JuanitoFatas/fast-ruby/blob/256fa4916b577befb40ba5ffaa22af08dc16565c/README.md#proc–block

# File lib/sums_up/core/matcher.rb, line 96
def _correct_variant_matcher(value = nil)
  variant = self.class::VARIANT

  _ensure_wildcard_not_matched!(variant)
  _ensure_no_duplicate_match!(variant)

  @matched_variants << variant
  @matched = true

  @result =
    if block_given?
      yield(*@variant_instance.members(dup: false))
    else
      value
    end

  self
end
_fetch_result() click to toggle source
# File lib/sums_up/core/matcher.rb, line 79
def _fetch_result
  variants = self.class::ALL_VARIANTS

  return @result if @wildcard_matched
  return @result if @matched_variants.length == variants.length

  unmatched_variants = (variants - @matched_variants).join(', ')

  raise(
    UnmatchedVariantError,
    "Did not match the following variants: #{unmatched_variants}"
  )
end
_match_hash(hash) click to toggle source
# File lib/sums_up/core/matcher.rb, line 58
def _match_hash(hash)
  variants = self.class::ALL_VARIANTS
  unknown_variants = hash
    .each_key
    .reject { |key| (key == :_) || variants.include?(key) }

  if unknown_variants.any?
    raise(
      UnknownVariantError,
      "Unknown variant(s): #{unknown_variants.join(', ')}; " \
      "valid variant(s) are: #{variants.join(', ')}"
    )
  end

  hash.each do |variant, value|
    public_send(variant, value)
  end

  self
end

Private Instance Methods

_ensure_no_duplicate_match!(variant) click to toggle source
# File lib/sums_up/core/matcher.rb, line 126
def _ensure_no_duplicate_match!(variant)
  return unless @matched_variants.include?(variant)

  raise(DuplicateMatchError, "Duplicated match for variant: #{variant}")
end
_ensure_wildcard_not_matched!(variant) click to toggle source
# File lib/sums_up/core/matcher.rb, line 117
def _ensure_wildcard_not_matched!(variant)
  return unless @wildcard_matched

  raise(
    MatchAfterWildcardError,
    "Attempted to match variant after wildcard (_): #{variant}"
  )
end