domainic-type 0.1.0.alpha.3.2.0 → 0.1.0.alpha.3.4.0

data/lib/domainic/type/accessors.rb

@@ -4,12 +4,12 @@ module Domainic
   module Type
     # @rbs!
     #   type accessor = :abs | :begin | :chars | :class | :count | :end | :entries | :first | :keys | :last | :length |
-    #                   :self | :size | :values
+    #                   :real | :self | :size | :values
 
     # A list of valid access methods that can be used to retrieve values for constraint validation.
     # These methods represent common Ruby interfaces for accessing collection sizes, ranges, and values.
     #
-    # - :abs                       - For absolute values
+    # - :abs, :real                - For absolute values
     # - :begin, :end               - For Range-like objects
     # - :class                     - For type checking
     # - :count, :length, :size     - For measuring collections
@@ -27,6 +27,7 @@ module Domainic
       entries
       chars
       abs
+      real
       count
       size
       length

data/lib/domainic/type/behavior/date_time_behavior.rb

@@ -28,13 +28,93 @@ module Domainic
       # @author {https://aaronmallen.me Aaron Allen}
       # @since 0.1.0
       module DateTimeBehavior
+        # The supported date/time patterns for parsing date/time strings
+        #
+        # @note This list is ordered from most specific to least specific to ensure that the most specific patterns are
+        #  tried first. This is important because some patterns are more lenient than others and may match a wider range
+        #  of input strings.
+        #
+        # @return [Array<String>] the supported date/time patterns
+        DATETIME_PATTERNS = [
+          # ISO 8601 variants (most specific first)
+          '%Y-%m-%dT%H:%M:%S.%N%:z',    # 2024-01-01T12:00:00.000+00:00
+          '%Y-%m-%dT%H:%M:%S%:z',       # 2024-01-01T12:00:00+00:00
+          '%Y-%m-%dT%H:%M:%S.%N',       # 2024-01-01T12:00:00.000
+          '%Y-%m-%dT%H:%M:%S',          # 2024-01-01T12:00:00
+          '%Y%m%dT%H%M%S%z',            # 20240101T120000+0000 (basic format)
+
+          # RFC formats
+          '%a, %d %b %Y %H:%M:%S %z',   # Thu, 31 Jan 2024 13:30:00 +0000
+          '%d %b %Y %H:%M:%S %z',       # 31 Jan 2024 13:30:00 +0000
+
+          # Common datetime formats with timezone
+          '%Y-%m-%d %H:%M:%S %z',       # 2024-01-01 12:00:00 +0000
+          '%d/%m/%Y %H:%M:%S %z',       # 31/01/2024 12:00:00 +0000
+
+          # Full date + time formats (24h)
+          '%Y-%m-%d %H:%M:%S',          # 2024-01-01 12:00:00
+          '%Y-%m-%d %H:%M',             # 2024-01-01 12:00
+          '%d/%m/%Y %H:%M:%S',          # 31/01/2024 12:00:00
+          '%d/%m/%Y %H:%M',             # 31/01/2024 12:00
+          '%d-%m-%Y %H:%M:%S',          # 31-01-2024 12:00:00
+          '%d-%m-%Y %H:%M',             # 31-01-2024 12:00
+          '%Y/%m/%d %H:%M:%S',          # 2024/01/31 12:00:00
+          '%Y/%m/%d %H:%M',             # 2024/01/31 12:00
+
+          # Full date + time formats (12h)
+          '%Y-%m-%d %I:%M:%S %p',       # 2024-01-01 01:30:00 PM
+          '%Y-%m-%d %I:%M %p',          # 2024-01-01 01:30 PM
+          '%d/%m/%Y %I:%M:%S %p',       # 31/01/2024 01:30:00 PM
+          '%d/%m/%Y %I:%M %p',          # 31/01/2024 01:30 PM
+
+          # Full month name formats
+          '%B %d, %Y %H:%M:%S',         # January 31, 2024 12:00:00
+          '%B %d, %Y %H:%M',            # January 31, 2024 12:00
+          '%d %B %Y %H:%M:%S',          # 31 January 2024 12:00:00
+          '%d %B %Y %H:%M',             # 31 January 2024 12:00
+
+          # Abbreviated month name formats
+          '%b %d, %Y %H:%M:%S',         # Jan 31, 2024 12:00:00
+          '%b %d, %Y %H:%M',            # Jan 31, 2024 12:00
+          '%d %b %Y %H:%M:%S',          # 31 Jan 2024 12:00:00
+          '%d %b %Y %H:%M',             # 31 Jan 2024 12:00
+
+          # Date-only formats (in order of specificity)
+          '%Y-%m-%d',                   # 2024-01-31
+          '%Y%m%d',                     # 20240131
+          '%B %d, %Y',                  # January 31, 2024
+          '%d %B %Y',                   # 31 January 2024
+          '%b %d, %Y',                  # Jan 31, 2024
+          '%d %b %Y',                   # 31 Jan 2024
+          '%d/%m/%Y',                   # 31/01/2024
+          '%d-%m-%Y',                   # 31-01-2024
+          '%Y/%m/%d',                   # 2024/01/31
+          '%m/%d/%Y'                    # 01/31/2024 (US format - last to avoid ambiguity)
+        ].freeze #: Array[String]
+
+        # Coerce a value to a Date, DateTime, or Time object
+        #
+        # @return [Proc] a lambda that coerces a value to a Date, DateTime, or Time object
         TO_DATETIME_COERCER = lambda { |value|
-          if [Date, DateTime, Time].any? { |type| value.is_a?(type) }
+          case value
+          when Date, DateTime, Time
             value
+          when Integer
+            Time.at(value).to_datetime
+          when String
+            DATETIME_PATTERNS.each do |pattern|
+              result = DateTime.strptime(value, pattern)
+              # Validate the parsing preserved the original values by reformatting
+              # the result with the same pattern and comparing
+              return result if value == result.strftime(pattern)
+            rescue ArgumentError
+              next
+            end
+            DateTime.parse(value) # Fallback to Ruby's built-in parser and allow it to raise.
           else
-            DateTime.parse(value.to_s)
+            DateTime.parse(value) # Fallback to Ruby's built-in parser and allow it to raise.
           end
-        } #: Proc
+        } #: ^(Date | DateTime | Integer | String | Time value) -> (Date | DateTime | Time)
 
         class << self
           private
@@ -44,39 +124,39 @@ module Domainic
           # @note this in my opinion is better than polluting the namespace of the including class even with a private
           #   method. This way, the method is only available within the module itself. See {#being_between}.
           #
-          # @param after [Date, DateTime, String, Time, nil] minimum size value from positional args
-          # @param before [Date, DateTime, String, Time, nil] maximum size value from positional args
+          # @param after [Date, DateTime, Integer, String, Time, nil] minimum size value from positional args
+          # @param before [Date, DateTime, Integer, String, Time, nil] maximum size value from positional args
           # @param options [Hash] keyword arguments containing after/before values
           #
           # @raise [ArgumentError] if minimum or maximum value can't be determined
-          # @return [Array<Date, DateTime, String, Time, nil>] parsed [after, before] values
+          # @return [Array<Date, DateTime, Integer, String, Time, nil>] parsed [after, before] values
           # @rbs (
-          #   (Date | DateTime | String | Time)? after,
-          #   (Date | DateTime | String | Time)? before,
-          #   Hash[Symbol, (Date | DateTime | String | Time)?] options
-          #   ) -> Array[(Date | DateTime | String | Time)?]
+          #   (Date | DateTime | Integer | String | Time)? after,
+          #   (Date | DateTime | Integer | String | Time)? before,
+          #   Hash[Symbol, (Date | DateTime | Integer | String | Time)?] options
+          #   ) -> Array[(Date | DateTime | Integer | String | Time)?]
           def parse_being_between_arguments!(after, before, options)
             after ||= options[:after]
             before ||= options[:before]
             raise_being_between_argument_error!(caller, after, before, options) if after.nil? || before.nil?
 
-            [after, before] #: Array[(Date | DateTime | String | Time)?]
+            [after, before] #: Array[(Date | DateTime | Integer | String | Time)?]
           end
 
           # Raise appropriate ArgumentError for being_between
           #
           # @param original_caller [Array<String>] caller stack for error
-          # @param after [Date, DateTime, String, Time, nil] after value from positional args
-          # @param before [Date, DateTime, String, Time, nil] before value from positional args
+          # @param after [Date, DateTime, Integer, String, Time, nil] after value from positional args
+          # @param before [Date, DateTime, Integer, String, Time, nil] before value from positional args
           # @param options [Hash] keyword arguments containing after/before values
           #
           # @raise [ArgumentError] with appropriate message
           # @return [void]
           # @rbs (
           #   Array[String] original_caller,
-          #   (Date | DateTime | String | Time)? after,
-          #   (Date | DateTime | String | Time)? before,
-          #   Hash[Symbol, (Date | DateTime | String | Time)?] options
+          #   (Date | DateTime | Integer | String | Time)? after,
+          #   (Date | DateTime | Integer | String | Time)? before,
+          #   Hash[Symbol, (Date | DateTime | Integer | String | Time)?] options
           #   ) -> void
           def raise_being_between_argument_error!(original_caller, after, before, options)
             message = if options.empty?
@@ -93,66 +173,70 @@ module Domainic
 
         # Constrain the value to be chronologically after a given date/time
         #
-        # @param other [Date, DateTime, String, Time] the date/time to compare against
+        # @param other [Date, DateTime, Integer, String, Time] the date/time to compare against
         # @return [self] self for method chaining
-        # @rbs (Date | DateTime | String | Time other) -> Behavior
+        # @rbs (Date | DateTime | Integer | String | Time other) -> Behavior
         def being_after(other)
           # @type self: Object & Behavior
-          constrain :self, :range, { minimum: other },
+          constrain :self, :range, { minimum: TO_DATETIME_COERCER.call(other) },
                     coerce_with: TO_DATETIME_COERCER, description: 'being', inclusive: false
         end
         alias after being_after
 
         # Constrain the value to be chronologically before a given date/time
         #
-        # @param other [Date, DateTime, String, Time] the date/time to compare against
+        # @param other [Date, DateTime, Integer, String, Time] the date/time to compare against
         # @return [self] self for method chaining
-        # @rbs (Date | DateTime | String | Time other) -> Behavior
+        # @rbs (Date | DateTime | Integer | String | Time other) -> Behavior
         def being_before(other)
           # @type self: Object & Behavior
-          constrain :self, :range, { maximum: other },
+          constrain :self, :range, { maximum: TO_DATETIME_COERCER.call(other) },
                     coerce_with: TO_DATETIME_COERCER, description: 'being', inclusive: false
         end
         alias before being_before
 
         # Constrain the value to be chronologically between two date/times
         #
-        # @param after [Date, DateTime, String, Time] the earliest allowed date/time
-        # @param before [Date, DateTime, String, Time] the latest allowed date/time
+        # @param after [Date, DateTime, Integer, String, Time] the earliest allowed date/time
+        # @param before [Date, DateTime, Integer, String, Time] the latest allowed date/time
         # @param options [Hash] alternative way to specify after/before via keywords
-        # @option options [Date, DateTime, String, Time] :after earliest allowed date/time
-        # @option options [Date, DateTime, String, Time] :before latest allowed date/time
+        # @option options [Date, DateTime, Integer, String, Time] :after earliest allowed date/time
+        # @option options [Date, DateTime, Integer, String, Time] :before latest allowed date/time
         # @return [self] self for method chaining
-        # @rbs (Date | DateTime | String | Time after, Date | DateTime | String | Time before) -> Behavior
+        # @rbs (
+        #   Date | DateTime | Integer | String | Time after,
+        #   Date | DateTime | Integer | String | Time before
+        #   ) -> Behavior
         def being_between(after = nil, before = nil, **options)
           # @type self: Object & Behavior
           after, before =
             DateTimeBehavior.send(:parse_being_between_arguments!, after, before, options.transform_keys(&:to_sym))
-          constrain :self, :range, { minimum: after, maximum: before },
+          constrain :self, :range,
+                    { minimum: TO_DATETIME_COERCER.call(after), maximum: TO_DATETIME_COERCER.call(before) },
                     coerce_with: TO_DATETIME_COERCER, description: 'being', inclusive: false
         end
         alias between being_between
 
         # Constrain the value to be exactly equal to a given date/time
         #
-        # @param other [Date, DateTime, String, Time] the date/time to compare against
+        # @param other [Date, DateTime, Integer, String, Time] the date/time to compare against
         # @return [self] self for method chaining
-        # @rbs (Date | DateTime | String | Time other) -> Behavior
+        # @rbs (Date | DateTime | Integer | String | Time other) -> Behavior
         def being_equal_to(other)
           # @type self: Object & Behavior
-          constrain :self, :equality, other,
+          constrain :self, :equality, TO_DATETIME_COERCER.call(other),
                     coerce_with: TO_DATETIME_COERCER, description: 'being'
         end
         alias at being_equal_to
 
         # Constrain the value to be chronologically on or after a given date/time
         #
-        # @param other [Date, DateTime, String, Time] the date/time to compare against
+        # @param other [Date, DateTime, Integer, String, Time] the date/time to compare against
         # @return [self] self for method chaining
-        # @rbs (Date | DateTime | String | Time other) -> Behavior
+        # @rbs (Date | DateTime | Integer | String | Time other) -> Behavior
         def being_on_or_after(other)
           # @type self: Object & Behavior
-          constrain :self, :range, { minimum: other },
+          constrain :self, :range, { minimum: TO_DATETIME_COERCER.call(other) },
                     coerce_with: TO_DATETIME_COERCER, description: 'being'
         end
         alias at_or_after being_on_or_after
@@ -161,12 +245,12 @@ module Domainic
 
         # Constrain the value to be chronologically on or before a given date/time
         #
-        # @param other [Date, DateTime, String, Time] the date/time to compare against
+        # @param other [Date, DateTime, Integer, String, Time] the date/time to compare against
         # @return [self] self for method chaining
-        # @rbs (Date | DateTime | String | Time other) -> Behavior
+        # @rbs (Date | DateTime | Integer | String | Time other) -> Behavior
         def being_on_or_before(other)
           # @type self: Object & Behavior
-          constrain :self, :range, { maximum: other },
+          constrain :self, :range, { maximum: TO_DATETIME_COERCER.call(other) },
                     coerce_with: TO_DATETIME_COERCER, description: 'being'
         end
         alias at_or_before being_on_or_before

data/lib/domainic/type/behavior.rb

@@ -186,6 +186,22 @@ module Domainic
         end
       end
 
+      # Add a custom constraint to this type.
+      #
+      # @param proc [Proc] the constraint to add
+      # @param accessor [Type::Accessor] the accessor to constrain
+      # @param options [Hash{Symbol => Object}] additional constraint options
+      #
+      # @return [self] for chaining constraints
+      # @rbs (
+      #   Proc proc,
+      #   ?accessor: Type::accessor,
+      #   **untyped options
+      #   ) -> Behavior
+      def satisfies(proc, accessor: :self, **options)
+        constrain accessor, :predicate, proc, **options
+      end
+
       # Convert the type to a String representation.
       #
       # @return [String] The type as a String

data/lib/domainic/type/config/registry.yml

@@ -62,6 +62,9 @@ constraints:
   polarity:
     constant: Domainic::Type::Constraint::PolarityConstraint
     require_path: domainic/type/constraint/constraints/polarity_constraint
+  predicate:
+    constant: Domainic::Type::Constraint::PredicateConstraint
+    require_path: domainic/type/constraint/constraints/predicate_constraint
   range:
     constant: Domainic::Type::Constraint::RangeConstraint
     require_path: domainic/type/constraint/constraints/range_constraint
@@ -78,6 +81,12 @@ types:
   anything:
     constant: Domainic::Type::AnythingType
     require_path: domainic/type/types/specification/anything_type
+  big_decimal:
+    constant: Domainic::Type::BigDecimalType
+    require_path: domainic/type/types/core_extended/big_decimal_type
+  complex:
+    constant: Domainic::Type::ComplexType
+    require_path: domainic/type/types/core/complex_type
   cuid:
     constant: Domainic::Type::CUIDType
     require_path: domainic/type/types/identifier/cuid_type
@@ -87,6 +96,9 @@ types:
   date_time:
     constant: Domainic::Type::DateTimeType
     require_path: domainic/type/types/datetime/date_time_type
+  date_time_string:
+    constant: Domainic::Type::DateTimeStringType
+    require_path: domainic/type/types/datetime/date_time_string_type
   duck:
     constant: Domainic::Type::DuckType
     require_path: domainic/type/types/specification/duck_type
@@ -111,6 +123,15 @@ types:
   integer:
     constant: Domainic::Type::IntegerType
     require_path: domainic/type/types/core/integer_type
+  range:
+    constant: Domainic::Type::RangeType
+    require_path: domainic/type/types/core/range_type
+  rational:
+    constant: Domainic::Type::RationalType
+    require_path: domainic/type/types/core/rational_type
+  set:
+    constant: Domainic::Type::SetType
+    require_path: domainic/type/types/core_extended/set_type
   string:
     constant: Domainic::Type::StringType
     require_path: domainic/type/types/core/string_type
@@ -120,6 +141,9 @@ types:
   time:
     constant: Domainic::Type::TimeType
     require_path: domainic/type/types/datetime/time_type
+  timestamp:
+    constant: Domainic::Type::TimestampType
+    require_path: domainic/type/types/datetime/timestamp_type
   union:
     constant: Domainic::Type::UnionType
     require_path: domainic/type/types/specification/union_type

data/lib/domainic/type/constraint/constraints/nor_constraint.rb

@@ -39,7 +39,7 @@ module Domainic
         # @rbs override
         def short_description
           descriptions = @expected.map(&:short_description)
-          return descriptions.first if descriptions.size == 1
+          return "not #{descriptions.first}" if descriptions.size == 1
 
           *first, last = descriptions
           "#{first.join(', ')} nor #{last}"

data/lib/domainic/type/constraint/constraints/predicate_constraint.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require 'domainic/type/constraint/behavior'
+
+module Domainic
+  module Type
+    module Constraint
+      # A constraint for validating values using a custom predicate function.
+      #
+      # This constraint allows for custom validation logic through a Proc that returns
+      # a boolean value. It enables users to create arbitrary validation rules when
+      # the built-in constraints don't cover their specific needs.
+      #
+      # @example Basic usage
+      #   constraint = PredicateConstraint.new(:self, ->(x) { x > 0 })
+      #   constraint.satisfied?(1)   # => true
+      #   constraint.satisfied?(-1)  # => false
+      #
+      # @example With custom violation description
+      #   constraint = PredicateConstraint.new(:self, ->(x) { x > 0 }, violation_description: 'not greater than zero')
+      #   constraint.satisfied?(-1)  # => false
+      #   constraint.short_violation_description  # => "not greater than zero"
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since 0.1.0
+      class PredicateConstraint
+        # @rbs!
+        #   type expected = ^(untyped value) -> bool
+        #
+        #   type options = { ?violation_description: String}
+
+        include Behavior #[expected, untyped, options]
+
+        # Get a description of what the constraint expects.
+        #
+        # @note This constraint type does not provide a description as predicates are arbitrary.
+        #
+        # @return [String] an empty string
+        # @rbs override
+        def short_description = ''
+
+        # Get a description of why the predicate validation failed.
+        #
+        # @return [String] the custom violation description if provided
+        # @rbs override
+        def short_violation_description
+          # @type ivar @options: { ?violation_description: String }
+          @options.fetch(:violation_description, '')
+        end
+
+        protected
+
+        # Check if the value satisfies the predicate function.
+        #
+        # @return [Boolean] true if the predicate returns true
+        # @rbs override
+        def satisfies_constraint?
+          @expected.call(@actual)
+        end
+
+        # Validate that the expectation is a Proc.
+        #
+        # @param expectation [Object] the expectation to validate
+        #
+        # @raise [ArgumentError] if the expectation is not a Proc
+        # @return [void]
+        # @rbs override
+        def validate_expectation!(expectation)
+          return if expectation.is_a?(Proc)
+
+          raise ArgumentError, 'Expectation must be a Proc'
+        end
+      end
+    end
+  end
+end