stannum 0.3.0 → 0.4.0

data/lib/stannum/schema.rb

@@ -2,159 +2,159 @@
 
 require 'forwardable'
 
-require 'stannum/attribute'
-
 module Stannum
-  # Abstract class for defining attribute methods for a struct.
+  # Abstract class for defining property methods for an entity.
   #
   # @see Stannum::Attribute.
   class Schema < Module
     extend  Forwardable
     include Enumerable
 
-    def initialize
-      super
+    # @param property_class [Class] the class representing the elements of the
+    #   schema.
+    # @param property_name [String, Symbol] the name of the schema elements.
+    def initialize(property_class:, property_name:)
+      super()
+
+      tools.assertions.validate_class(property_class, as: 'property class')
+      tools.assertions.validate_name(property_name, as: 'property name')
 
-      @attributes = {}
+      @properties     = {}
+      @property_class = property_class
+      @property_name  = property_name.to_s
     end
 
-    # Retrieves the named attribute object.
+    # @return [Class] the class representing the elements of the schema.
+    attr_reader :property_class
+
+    # @return [String] the name of the schema elements.
+    attr_reader :property_name
+
+    # Retrieves the named property object.
     #
-    # @param key [String, Symbol] The name of the requested attribute.
+    # @param key [String, Symbol] The name of the requested property.
     #
-    # @return [Stannum::Attribute] The attribute object.
+    # @return [Stannum::Attribute] The property object.
     #
     # @raise ArgumentError if the key is invalid.
-    # @raise KeyError if the attribute is not defined.
+    # @raise KeyError if the property is not defined.
     def [](key)
       tools.assertions.assert_name(key, as: 'key', error_class: ArgumentError)
 
       str = -key.to_s
 
       each_ancestor do |ancestor|
-        next unless ancestor.own_attributes.key?(str)
+        next unless ancestor.own_properties.key?(str)
 
-        return ancestor.own_attributes[str]
+        return ancestor.own_properties[str]
       end
 
       {}.fetch(str)
     end
 
-    # rubocop:disable Metrics/MethodLength
-
     # @api private
     #
-    # Defines an attribute and adds the attribute to the contract.
+    # Defines an property and adds the property to the contract.
     #
-    # This method should not be called directly. Instead, define attributes via
-    # the Struct.attribute class method.
+    # This method should not be called directly. Instead, define properties via
+    # the Struct.property class method.
     #
     # @see Stannum::Struct
-    def define_attribute(name:, options:, type:)
-      attribute = Stannum::Attribute.new(
-        name:    name,
-        options: options,
-        type:    type
-      )
-
-      if @attributes.key?(attribute.name)
-        raise ArgumentError, "attribute #{name.inspect} already exists"
+    def define(name:, options:, type:, definition_class: nil)
+      definition_class ||= property_class
+
+      property = definition_class.new(name:, options:, type:)
+
+      if @properties.key?(property.name)
+        message =
+          "#{tools.str.singularize(property_name)} #{name.inspect} " \
+          'already exists'
+
+        raise ArgumentError, message
       end
 
-      define_reader(attribute.name, attribute.reader_name)
-      define_writer(attribute.name, attribute.writer_name, attribute.default)
+      definition_class::Builder.new(self).call(property)
 
-      @attributes[attribute.name] = attribute
+      @properties[property.name] = property
     end
-    # rubocop:enable Metrics/MethodLength
 
-    # Iterates through the the attributes by name and attribute object.
+    # Iterates through the the properties by name and property object.
     #
-    # @yieldparam name [String] The name of the attribute.
-    # @yieldparam attribute [Stannum::Attribute] The attribute object.
+    # @yieldparam name [String] The name of the property.
+    # @yieldparam property [Stannum::Attribute] The property object.
     def each(&block)
       return enum_for(:each) { size } unless block_given?
 
       each_ancestor do |ancestor|
-        ancestor.own_attributes.each(&block)
+        ancestor.own_properties.each(&block)
       end
     end
 
-    # Iterates through the the attributes by name.
+    # Iterates through the the properties by name.
     #
-    # @yieldparam name [String] The name of the attribute.
+    # @yieldparam name [String] The name of the property.
     def each_key(&block)
       return enum_for(:each_key) { size } unless block_given?
 
       each_ancestor do |ancestor|
-        ancestor.own_attributes.each_key(&block)
+        ancestor.own_properties.each_key(&block)
       end
     end
 
-    # Iterates through the the attributes by attribute object.
+    # Iterates through the the properties by property object.
     #
-    # @yieldparam attribute [Stannum::Attribute] The attribute object.
+    # @yieldparam property [Stannum::Attribute] The property object.
     def each_value(&block)
       return enum_for(:each_value) { size } unless block_given?
 
       each_ancestor do |ancestor|
-        ancestor.own_attributes.each_value(&block)
+        ancestor.own_properties.each_value(&block)
       end
     end
 
-    # Checks if the given attribute is defined.
+    # Checks if the given property is defined.
     #
-    # @param key [String, Symbol] the name of the attribute to check.
+    # @param key [String, Symbol] the name of the property to check.
     #
-    # @return [Boolean] true if the attribute is defined; otherwise false.
+    # @return [Boolean] true if the property is defined; otherwise false.
     def key?(key)
       tools.assertions.assert_name(key, as: 'key', error_class: ArgumentError)
 
       each_ancestor.any? do |ancestor|
-        ancestor.own_attributes.key?(key.to_s)
+        ancestor.own_properties.key?(key.to_s)
       end
     end
     alias has_key? key?
 
-    # Returns the defined attribute keys.
+    # Returns the defined property keys.
     #
-    # @return [Array<String>] the attribute keys.
+    # @return [Array<String>] the property keys.
     def keys
       each_key.to_a
     end
 
     # @private
-    def own_attributes
-      @attributes
+    def own_properties
+      @properties
     end
 
-    # @return [Integer] the number of defined attributes.
+    # @return [Integer] the number of defined properties.
     def size
       each_ancestor.reduce(0) do |memo, ancestor|
-        memo + ancestor.own_attributes.size
+        memo + ancestor.own_properties.size
       end
     end
     alias count size
 
-    # Returns the defined attribute value.
+    # Returns the defined property value.
     #
-    # @return [Array<Stannum::Attribute>] the attribute values.
+    # @return [Array<Stannum::Attribute>] the property values.
     def values
       each_value.to_a
     end
 
     private
 
-    def define_reader(attr_name, reader_name)
-      define_method(reader_name) { @attributes[attr_name] }
-    end
-
-    def define_writer(attr_name, writer_name, default_value)
-      define_method(writer_name) do |value|
-        @attributes[attr_name] = value.nil? ? default_value : value
-      end
-    end
-
     def each_ancestor
       return enum_for(:each_ancestor) unless block_given?
 

data/lib/stannum/support/optional.rb

@@ -20,7 +20,7 @@ module Stannum::Support
 
         options.merge(
           required: required?(
-            default:  default,
+            default:,
             optional: validate_option(optional, as: :optional),
             required: validate_option(required, as: :required)
           )

data/lib/stannum/version.rb

@@ -10,7 +10,7 @@ module Stannum
     # Major version.
     MAJOR = 0
     # Minor version.
-    MINOR = 3
+    MINOR = 4
     # Patch version.
     PATCH = 0
     # Prerelease version.
@@ -27,13 +27,13 @@ module Stannum
       #
       # @see SleepingKingStudios::Tools::SemanticVersion#to_gem_version
       def to_gem_version
-        str = +"#{MAJOR}.#{MINOR}.#{PATCH}"
+        str = "#{MAJOR}.#{MINOR}.#{PATCH}"
 
         prerelease = value_of(:PRERELEASE)
-        str << ".#{prerelease}" if prerelease
+        str = "#{str}.#{prerelease}" if prerelease
 
         build = value_of(:BUILD)
-        str << ".#{build}" if build
+        str = "#{str}.#{build}" if build
 
         str
       end

data/lib/stannum.rb

@@ -4,6 +4,9 @@ require 'stannum/version'
 
 # A library for specifying and validating data structures.
 module Stannum
+  autoload :Association,         'stannum/association'
+  autoload :Associations,        'stannum/associations'
+  autoload :Attribute,           'stannum/attribute'
   autoload :Constraint,          'stannum/constraint'
   autoload :Constraints,         'stannum/constraints'
   autoload :Contract,            'stannum/contract'

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: stannum
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Rob "Merlin" Smith
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-25 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sleeping_king_studios-tools
@@ -16,84 +15,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.10'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.10'
-- !ruby/object:Gem::Dependency
-  name: rspec-sleeping_king_studios
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.6'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.48'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.48'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.19'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.19'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.21'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.21'
+        version: '1.1'
 description: |-
   A focused library for specifying and validating data structures. Stannum
   provides tools to define data schemas for domain objects, method arguments,
@@ -112,6 +41,10 @@ files:
 - README.md
 - config/locales/en.rb
 - lib/stannum.rb
+- lib/stannum/association.rb
+- lib/stannum/associations.rb
+- lib/stannum/associations/many.rb
+- lib/stannum/associations/one.rb
 - lib/stannum/attribute.rb
 - lib/stannum/constraint.rb
 - lib/stannum/constraints.rb
@@ -122,6 +55,7 @@ files:
 - lib/stannum/constraints/delegator.rb
 - lib/stannum/constraints/enum.rb
 - lib/stannum/constraints/equality.rb
+- lib/stannum/constraints/format.rb
 - lib/stannum/constraints/hashes.rb
 - lib/stannum/constraints/hashes/extra_keys.rb
 - lib/stannum/constraints/hashes/indifferent_extra_keys.rb
@@ -161,6 +95,7 @@ files:
 - lib/stannum/constraints/types/symbol_type.rb
 - lib/stannum/constraints/types/time_type.rb
 - lib/stannum/constraints/union.rb
+- lib/stannum/constraints/uuid.rb
 - lib/stannum/contract.rb
 - lib/stannum/contracts.rb
 - lib/stannum/contracts/array_contract.rb
@@ -177,8 +112,10 @@ files:
 - lib/stannum/contracts/parameters_contract.rb
 - lib/stannum/contracts/tuple_contract.rb
 - lib/stannum/entities.rb
+- lib/stannum/entities/associations.rb
 - lib/stannum/entities/attributes.rb
 - lib/stannum/entities/constraints.rb
+- lib/stannum/entities/primary_key.rb
 - lib/stannum/entities/properties.rb
 - lib/stannum/entity.rb
 - lib/stannum/errors.rb
@@ -204,7 +141,6 @@ metadata:
   bug_tracker_uri: https://github.com/sleepingkingstudios/stannum/issues
   source_code_uri: https://github.com/sleepingkingstudios/stannum
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -212,15 +148,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: A library for specifying and validating data structures.
 test_files: []