stannum 0.2.0 → 0.4.0

data/lib/stannum/entities/properties.rb

@@ -0,0 +1,208 @@
+# frozen_string_literal: true
+
+require 'stannum/entities'
+
+module Stannum::Entities
+  # Abstract module for handling heterogenous entity properties.
+  #
+  # This module provides a base for accessing and mutating entity properties
+  # such as attributes and associations.
+  module Properties
+    MEMORY_ADDRESS_PATTERN = /0x([0-9a-f]+)/
+    private_constant :MEMORY_ADDRESS_PATTERN
+
+    # @param properties [Hash] the properties used to initialize the entity.
+    def initialize(**properties)
+      set_properties(properties, force: true)
+    end
+
+    # Compares the entity with the other object.
+    #
+    # The other object must be an instance of the current class. In addition,
+    # the properties hashes of the two objects must be equal.
+    #
+    # @return true if the object is a matching entity.
+    def ==(other)
+      return false unless other.class == self.class
+
+      properties == other.properties
+    end
+
+    # Retrieves the property with the given key.
+    #
+    # @param property [String, Symbol] The property key.
+    #
+    # @return [Object] the value of the property.
+    #
+    # @raise ArgumentError if the key is not a valid property.
+    def [](property)
+      tools.assertions.validate_name(property, as: 'property')
+
+      get_property(property)
+    end
+
+    # Sets the given property to the given value.
+    #
+    # @param property [String, Symbol] The property key.
+    # @param value [Object] The value for the property.
+    #
+    # @raise ArgumentError if the key is not a valid property.
+    def []=(property, value)
+      tools.assertions.validate_name(property, as: 'property')
+
+      set_property(property, value)
+    end
+
+    # Updates the struct's properties with the given values.
+    #
+    # This method is used to update some (but not all) of the properties of the
+    # struct. For each key in the hash, it calls the corresponding writer method
+    # with the value for that property. If the value is nil, this will set the
+    # property value to the default for that property.
+    #
+    # Any properties that are not in the given hash are unchanged.
+    #
+    # If the properties hash includes any keys that do not correspond to an
+    # property, the struct will raise an error.
+    #
+    # @param properties [Hash] The initial properties for the struct.
+    #
+    # @raise ArgumentError if the key is not a valid property.
+    #
+    # @see #properties=
+    def assign_properties(properties)
+      unless properties.is_a?(Hash)
+        raise ArgumentError, 'properties must be a Hash'
+      end
+
+      set_properties(properties, force: false)
+    end
+    alias assign assign_properties
+
+    # @return [String] a string representation of the entity and its properties.
+    def inspect
+      inspect_with_options
+    end
+
+    # @param options [Hash] options for inspecting the entity.
+    #
+    # @option options memory_address [Boolean] if true, displays the memory
+    #   address of the object (as per Object#inspect). Defaults to false.
+    # @option options properties [Boolean] if true, displays the entity
+    #   properties. Defaults to true.
+    #
+    # @return [String] a string representation of the entity and its properties.
+    def inspect_with_options(**options)
+      address = options[:memory_address] ? ":#{memory_address}" : ''
+      mapped  = inspect_properties(**options)
+
+      "#<#{self.class.name}#{address}#{mapped}>"
+    end
+
+    # Collects the entity properties.
+    #
+    # @return [Hash<String, Object>] the entity properties.
+    def properties
+      {}
+    end
+
+    # Replaces the entity's properties with the given values.
+    #
+    # This method is used to update all of the properties of the entity. For
+    # each property, the writer method is called with the value from the hash,
+    # or nil if the corresponding key is not present in the hash. Any nil or
+    # missing values set the property value to that property's default value, if
+    # any.
+    #
+    # If the properties hash includes any keys that do not correspond to a valid
+    # property, the entity will raise an error.
+    #
+    # @param properties [Hash] the properties to assign to the entity.
+    #
+    # @raise ArgumentError if any key is not a valid property.
+    #
+    # @see #assign_properties
+    def properties=(properties)
+      unless properties.is_a?(Hash)
+        raise ArgumentError, 'properties must be a Hash'
+      end
+
+      set_properties(properties, force: true)
+    end
+
+    # Returns a Hash representation of the entity.
+    #
+    # @return [Hash<String, Object>] the entity properties.
+    #
+    # @see #properties
+    def to_h
+      properties
+    end
+
+    private
+
+    def bisect_properties(properties, expected)
+      matching     = {}
+      non_matching = {}
+
+      properties.each do |key, value|
+        if valid_property_key?(key) && expected.key?(key.to_s)
+          matching[key.to_s] = value
+        else
+          non_matching[key] = value
+        end
+      end
+
+      [matching, non_matching]
+    end
+
+    def get_property(key)
+      raise ArgumentError, "unknown property #{key.inspect}"
+    end
+
+    def handle_invalid_properties(properties, as: 'property')
+      properties.each_key do |key|
+        tools.assertions.assert_name(key, as:, error_class: ArgumentError)
+      end
+
+      raise ArgumentError, invalid_properties_message(properties, as:)
+    end
+
+    def inspect_properties(**)
+      ''
+    end
+
+    def invalid_properties_message(properties, as: 'property')
+      "unknown #{tools.int.pluralize(properties.size, as)} " +
+        properties.keys.map(&:inspect).join(', ')
+    end
+
+    def memory_address
+      Object
+        .instance_method(:inspect)
+        .bind(self)
+        .call
+        .match(MEMORY_ADDRESS_PATTERN)[1]
+    end
+
+    def set_property(key, _)
+      raise ArgumentError, "unknown property #{key.inspect}"
+    end
+
+    def set_properties(properties, **_)
+      return if properties.empty?
+
+      handle_invalid_properties(properties)
+    end
+
+    def tools
+      SleepingKingStudios::Tools::Toolbelt.instance
+    end
+
+    def valid_property_key?(key)
+      return false unless key.is_a?(String) || key.is_a?(Symbol)
+
+      !key.empty?
+    end
+  end
+end

data/lib/stannum/entities.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'sleeping_king_studios/tools/toolbox/mixin'
+
+require 'stannum/entities'
+
+module Stannum
+  # Namespace for modules implementing Entity functionality.
+  module Entities
+    autoload :Attributes,   'stannum/entities/attributes'
+    autoload :Associations, 'stannum/entities/associations'
+    autoload :Constraints,  'stannum/entities/constraints'
+    autoload :PrimaryKey,   'stannum/entities/primary_key'
+    autoload :Properties,   'stannum/entities/properties'
+  end
+end

data/lib/stannum/entity.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+require 'stannum'
+require 'stannum/entities/associations'
+require 'stannum/entities/attributes'
+require 'stannum/entities/constraints'
+require 'stannum/entities/primary_key'
+require 'stannum/entities/properties'
+
+module Stannum
+  # Abstract module for defining objects with structured attributes.
+  #
+  # @example Defining Attributes
+  #   class Widget
+  #     include Stannum::Entity
+  #
+  #     attribute :name,        String
+  #     attribute :description, String,  optional: true
+  #     attribute :quantity,    Integer, default:  0
+  #   end
+  #
+  #   widget = Widget.new(name: 'Self-sealing Stem Bolt')
+  #   widget.name        #=> 'Self-sealing Stem Bolt'
+  #   widget.description #=> nil
+  #   widget.quantity    #=> 0
+  #   widget.attributes  #=>
+  #   # {
+  #   #   name:        'Self-sealing Stem Bolt',
+  #   #   description: nil,
+  #   #   quantity:    0
+  #   # }
+  #
+  # @example Setting Attributes
+  #   widget.description = 'A stem bolt, but self sealing.'
+  #   widget.attributes #=>
+  #   # {
+  #   #   name:        'Self-sealing Stem Bolt',
+  #   #   description: 'A stem bolt, but self sealing.',
+  #   #   quantity:    0
+  #   # }
+  #
+  #   widget.assign_attributes(quantity: 50)
+  #   widget.attributes #=>
+  #   # {
+  #   #   name:        'Self-sealing Stem Bolt',
+  #   #   description: 'A stem bolt, but self sealing.',
+  #   #   quantity:    50
+  #   # }
+  #
+  #   widget.attributes = (name: 'Inverse Chronoton Emitter')
+  #   # {
+  #   #   name:        'Inverse Chronoton Emitter',
+  #   #   description: nil,
+  #   #   quantity:    0
+  #   # }
+  #
+  # @example Defining Attribute Constraints
+  #   Widget::Contract.matches?(quantity: -5)                    #=> false
+  #   Widget::Contract.matches?(name: 'Capacitor', quantity: -5) #=> true
+  #
+  #   class Widget
+  #     constraint(:quantity) { |qty| qty >= 0 }
+  #   end
+  #
+  #   Widget::Contract.matches?(name: 'Capacitor', quantity: -5) #=> false
+  #   Widget::Contract.matches?(name: 'Capacitor', quantity: 10) #=> true
+  #
+  # @example Defining Struct Constraints
+  #   Widget::Contract.matches?(name: 'Diode') #=> true
+  #
+  #   class Widget
+  #     constraint { |struct| struct.description&.include?(struct.name) }
+  #   end
+  #
+  #   Widget::Contract.matches?(name: 'Diode') #=> false
+  #   Widget::Contract.matches?(
+  #     name:        'Diode',
+  #     description: 'A low budget Diode',
+  #   ) #=> true
+  module Entity
+    include Stannum::Entities::Properties
+    include Stannum::Entities::Attributes
+    include Stannum::Entities::Associations
+    include Stannum::Entities::PrimaryKey
+    include Stannum::Entities::Constraints
+  end
+end

data/lib/stannum/errors.rb

@@ -326,7 +326,7 @@ module Stannum
     #     .add(:not_integer, message: 'is outside the range')
     #     .add(:not_in_range)
     def add(type, message: nil, **data)
-      error  = build_error(data: data, message: message, type: type)
+      error  = build_error(data:, message:, type:)
       hashed = error.hash
 
       return self if @cache.include?(hashed)
@@ -436,7 +436,7 @@ module Stannum
     # @overload each
     #   Iterates through the errors, yielding each error to the provided block.
     #
-    #   @yieldparam error [Hash<Symbol=>Object>] The error object. Each error
+    #   @yieldparam error [Hash{Symbol=>Object}] The error object. Each error
     #     is a hash containing the keys :data, :message, :path and :type.
     def each
       return to_enum(:each) { size } unless block_given?
@@ -492,7 +492,7 @@ module Stannum
 
     # @return [String] a human-readable representation of the object.
     def inspect
-      oid = super[2...-1].split.first.split(':').last
+      oid = super[2...].split.first.split(':').last
 
       "#<#{self.class.name}:#{oid} @summary=%{#{summary}}>"
     end
@@ -592,14 +592,12 @@ module Stannum
 
     protected
 
-    def each_error(&block)
+    def each_error(&)
       return enum_for(:each_error) unless block_given?
 
-      @errors.each(&block)
+      @errors.each(&)
 
-      @children.each_value do |child|
-        child.each_error(&block)
-      end
+      @children.each_value { |child| child.each_error(&) }
     end
 
     def update_errors(other_errors)
@@ -621,10 +619,10 @@ module Stannum
       type = normalize_type(type)
       msg  = normalize_message(message)
 
-      { data: data, message: msg, type: type }
+      { data:, message: msg, type: }
     end
 
-    def compare_hashed_errors(other_errors)
+    def compare_hashed_errors(other_errors) # rubocop:disable Naming/PredicateMethod
       hashes       = Set.new(map(&:hash))
       other_hashes = Set.new(other_errors.map(&:hash))
 
@@ -644,7 +642,7 @@ module Stannum
 
       return path.first.to_s if path.size == 1
 
-      path[1..-1].reduce(path.first.to_s) do |str, item|
+      path[1..].reduce(path.first.to_s) do |str, item|
         item.is_a?(Integer) ? "#{str}[#{item}]" : "#{str}.#{item}"
       end
     end
@@ -669,7 +667,7 @@ module Stannum
       child = self.class.new
 
       ary.each do |item|
-        err  = normalize_array_item(item, allow_nil: allow_nil)
+        err  = normalize_array_item(item, allow_nil:)
         data = err.fetch(:data, {})
         path = err.fetch(:path, [])
 
@@ -708,9 +706,7 @@ module Stannum
 
       return value.dup if value.is_a?(self.class)
 
-      if value.is_a?(Array)
-        return normalize_array_value(value, allow_nil: allow_nil)
-      end
+      return normalize_array_value(value, allow_nil:) if value.is_a?(Array)
 
       raise ArgumentError, invalid_value_error(allow_nil)
     end
@@ -724,7 +720,7 @@ module Stannum
 
       raise ArgumentError,
         'key must be an Integer, a String or a Symbol',
-        caller(1..-1)
+        caller(1..)
     end
   end
 end

data/lib/stannum/messages/default_strategy.rb

@@ -18,7 +18,7 @@ module Stannum::Messages
       @load_paths ||= DEFAULT_LOAD_PATHS.dup
     end
 
-    # @param configuration [Hash{Symbol, Object}] The configured messages.
+    # @param configuration [Hash{Symbol=>Object}] The configured messages.
     # @param load_paths [Array<String>] The directories from which to load
     #   configured error messages.
     # @param locale [String] The locale used to load and scope configured
@@ -97,7 +97,7 @@ module Stannum::Messages
       Stannum::Messages::DefaultLoader
         .new(
           file_paths: load_paths,
-          locale:     locale
+          locale:
         )
         .call
     end

data/lib/stannum/parameter_validation.rb

@@ -126,11 +126,11 @@ module Stannum
         self::MethodValidations.define_method(method_name) \
         do |*arguments, **keywords, &block|
           result = match_parameters_to_contract(
-            arguments:   arguments,
-            block:       block,
-            contract:    contract,
-            keywords:    keywords,
-            method_name: method_name
+            arguments:,
+            block:,
+            contract:,
+            keywords:,
+            method_name:
           )
 
           return result unless result == VALIDATION_SUCCESS
@@ -199,17 +199,17 @@ module Stannum
     )
       match, errors = contract.match(
         {
-          arguments: arguments,
-          keywords:  keywords,
-          block:     block
+          arguments:,
+          keywords:,
+          block:
         }
       )
 
       return VALIDATION_SUCCESS if match
 
       handle_invalid_parameters(
-        errors:      errors,
-        method_name: method_name
+        errors:,
+        method_name:
       )
     end
   end

data/lib/stannum/rspec/match_errors_matcher.rb

@@ -4,8 +4,8 @@ begin
   require 'rspec/sleeping_king_studios/matchers/core/deep_matcher'
 rescue NameError
   # :nocov:
-  Kernel.warn 'WARNING: RSpec::SleepingKingStudios is a dependency for using' \
-              ' the MatchErrorsMatcher or the #match_errors method.'
+  Kernel.warn 'WARNING: RSpec::SleepingKingStudios is a dependency for using ' \
+              'the MatchErrorsMatcher or the #match_errors method.'
   # :nocov:
 end
 
@@ -27,7 +27,7 @@ module Stannum::RSpec
     end
 
     # Checks that the given errors do not match the expected errors.
-    def does_not_match?(actual)
+    def does_not_match?(actual) # rubocop:disable Naming/PredicatePrefix
       @actual = actual.is_a?(Stannum::Errors) ? actual.to_a : actual
 
       errors? && equality_matcher.does_not_match?(@actual)
@@ -40,8 +40,8 @@ module Stannum::RSpec
     # @return [String] a summary message describing a failed expectation.
     def failure_message
       unless errors?
-        return 'expected the errors to match the expected errors, but the' \
-               ' object is not an array or Errors object'
+        return 'expected the errors to match the expected errors, but the ' \
+               'object is not an array or Errors object'
       end
 
       equality_matcher.failure_message
@@ -51,8 +51,8 @@ module Stannum::RSpec
     #   expectation.
     def failure_message_when_negated
       unless errors?
-        return 'expected the errors not to match the expected errors, but the' \
-               ' object is not an array or Errors object'
+        return 'expected the errors not to match the expected errors, but ' \
+               'the object is not an array or Errors object'
       end
 
       equality_matcher.failure_message_when_negated

data/lib/stannum/rspec/validate_parameter.rb

@@ -15,8 +15,8 @@ module Stannum::RSpec
     # @return [Stannum::RSpec::ValidateParameterMatcher] the matcher.
     def validate_parameter(method_name, parameter_name)
       Stannum::RSpec::ValidateParameterMatcher.new(
-        method_name:    method_name,
-        parameter_name: parameter_name
+        method_name:,
+        parameter_name:
       )
     end
   end

data/lib/stannum/rspec/validate_parameter_matcher.rb

@@ -18,13 +18,21 @@ module Stannum::RSpec
     class InvalidParameterHandledError < StandardError; end
     private_constant :InvalidParameterHandledError
 
+    EXTRA_PARAMETER_ERROR_TYPES = Set.new(
+      [
+        Stannum::Constraints::Parameters::ExtraArguments::TYPE,
+        Stannum::Constraints::Parameters::ExtraKeywords::TYPE
+      ]
+    ).freeze
+    private_constant :EXTRA_PARAMETER_ERROR_TYPES
+
     class << self
       # @private
       def add_parameter_mapping(map:, match:)
         raise ArgumentError, 'map must be a Proc'   unless map.is_a?(Proc)
         raise ArgumentError, 'match must be a Proc' unless match.is_a?(Proc)
 
-        parameter_mappings << { match: match, map: map }
+        parameter_mappings << { match:, map: }
       end
 
       # @private
@@ -33,12 +41,12 @@ module Stannum::RSpec
           match = keywords.fetch(:match)
           map   = keywords.fetch(:map)
 
-          next unless match.call(actual: actual, method_name: method_name)
+          next unless match.call(actual:, method_name:)
 
-          return map.call(actual: actual, method_name: method_name)
+          return map.call(actual:, method_name:)
         end
 
-        unwrapped_method(actual: actual, method_name: method_name).parameters
+        unwrapped_method(actual:, method_name:).parameters
       end
 
       private
@@ -109,7 +117,7 @@ module Stannum::RSpec
     #
     # @return [true, false] false if the object validates the parameter,
     #   otherwise true.
-    def does_not_match?(actual)
+    def does_not_match?(actual) # rubocop:disable Naming/PredicatePrefix
       disallow_fluent_options!
 
       @actual         = actual
@@ -139,11 +147,11 @@ module Stannum::RSpec
         when :method_does_not_have_parameter
           "##{method_name} does not have a #{parameter_name.inspect} parameter"
         when :parameter_not_validated
-          "##{method_name} does not expect a #{parameter_name.inspect}" \
-          " #{parameter_type}"
+          "##{method_name} does not expect a #{parameter_name.inspect} " \
+          "#{parameter_type}"
         when :valid_parameter_value
-          "#{valid_value.inspect} is a valid value for the" \
-          " #{parameter_name.inspect} #{parameter_type}"
+          "#{valid_value.inspect} is a valid value for the " \
+          "#{parameter_name.inspect} #{parameter_type}"
         end
 
       [message, reason].compact.join(', but ')
@@ -281,20 +289,20 @@ module Stannum::RSpec
       unless @expected_constraint.nil?
         raise RuntimeError,
           '#does_not_match? with #using_constraint is not supported',
-          caller[1..-1]
+          caller[1..]
       end
 
       unless @parameters.nil?
         raise RuntimeError,
           '#does_not_match? with #with_parameters is not supported',
-          caller[1..-1]
+          caller[1..]
       end
 
       return if @parameter_value.nil?
 
       raise RuntimeError,
         '#does_not_match? with #with_value is not supported',
-        caller[1..-1]
+        caller[1..]
     end
 
     def equality_matcher
@@ -313,14 +321,8 @@ module Stannum::RSpec
     end
 
     def extra_parameter?
-      extra_arguments_type =
-        Stannum::Constraints::Parameters::ExtraArguments::TYPE
-      extra_keywords_type =
-        Stannum::Constraints::Parameters::ExtraKeywords::TYPE
-
       return false unless scoped_errors(indexed: true).any? do |error|
-        error[:type] == extra_arguments_type ||
-        error[:type] == extra_keywords_type
+        EXTRA_PARAMETER_ERROR_TYPES.include?(error[:type])
       end
 
       @failure_reason = :parameter_not_validated
@@ -372,7 +374,7 @@ module Stannum::RSpec
 
     def method_parameters
       @method_parameters ||=
-        self.class.map_parameters(actual: actual, method_name: method_name)
+        self.class.map_parameters(actual:, method_name:)
     end
 
     def mock_validation_handler