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

data/sig/domainic/type/types/core_extended/set_type.rbs

@@ -0,0 +1,27 @@
+module Domainic
+  module Type
+    # A type for validating and constraining `Set` objects.
+    #
+    # This type extends `EnumerableBehavior` to support validations and constraints
+    # such as being empty, containing specific elements, or having a minimum or maximum count.
+    #
+    # @example Validating a `Set` object
+    #   type = Domainic::Type::SetType.new
+    #   type.validate!(Set.new([1, 2, 3])) # => true
+    #
+    # @example Enforcing constraints
+    #   type = Domainic::Type::SetType.new
+    #   type.being_empty.validate!(Set.new) # => true
+    #   type.being_empty.validate!(Set.new([1])) # raises TypeError
+    #
+    # @author {https://aaronmallen.me Aaron Allen}
+    # @since 0.1.0
+    class SetType
+      extend Behavior::ClassMethods
+
+      include Behavior
+
+      include Behavior::EnumerableBehavior
+    end
+  end
+end

data/sig/domainic/type/types/datetime/date_time_string_type.rbs

@@ -0,0 +1,124 @@
+module Domainic
+  module Type
+    # A type for validating and constraining strings to match various datetime formats.
+    #
+    # This class includes behaviors for handling datetime constraints and ensures that
+    # a string matches one of the predefined datetime formats (e.g., ISO 8601, RFC2822).
+    #
+    # @example Validating American format
+    #   type = Domainic::Type::DateTimeStringType.new
+    #   type.having_american_format.validate!("01/31/2024")
+    #
+    # @example Validating ISO 8601 format
+    #   type = Domainic::Type::DateTimeStringType.new
+    #   type.having_iso8601_format.validate!("2024-01-01T12:00:00Z")
+    #
+    # @example Validating RFC2822 format
+    #   type = Domainic::Type::DateTimeStringType.new
+    #   type.having_rfc2822_format.validate!("Thu, 31 Jan 2024 13:30:00 +0000")
+    #
+    # @author {https://aaronmallen.me Aaron Allen}
+    # @since 0.1.0
+    class DateTimeStringType
+      extend Behavior::ClassMethods
+
+      include Behavior
+
+      include Behavior::DateTimeBehavior
+
+      # The `Format` module provides a set of regular expressions for validating
+      # various datetime formats, including ISO 8601, RFC2822, American, European,
+      # full month names, abbreviated month names, and 12-hour clock formats.
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since 0.1.0
+      module Format
+        # Matches ISO 8601 datetime formats, including:
+        # - `2024-01-01T12:00:00.000+00:00`
+        # - `2024-01-01T12:00:00+00:00`
+        # - `2024-01-01T12:00:00.000`
+        # - `2024-01-01T12:00:00`
+        # - `20240101T120000+0000` (basic format)
+        # @return [Regexp]
+        ISO8601: Regexp
+
+        # Matches RFC2822 datetime formats, including:
+        # - `Thu, 31 Jan 2024 13:30:00 +0000`
+        # - `31 Jan 2024 13:30:00 +0000`
+        # @return [Regexp]
+        RFC2822: Regexp
+
+        # Matches American-style dates with optional time in 12-hour or 24-hour formats, including:
+        # - `01/31/2024`
+        # - `01/31/2024 12:30:00`
+        # - `01/31/2024 12:30 PM`
+        # @return [Regexp]
+        AMERICAN: Regexp
+
+        # Matches European-style dates with optional time in 24-hour format, including:
+        # - `31.01.2024`
+        # - `31.01.2024 12:30:00`
+        # @return [Regexp]
+        EUROPEAN: Regexp
+
+        # Matches datetime formats with full month names, including:
+        # - `January 31, 2024 12:00:00`
+        # - `January 31, 2024 12:00`
+        # @return [Regexp]
+        FULL_MONTH_NAME: Regexp
+
+        # Matches datetime formats with abbreviated month names, including:
+        # - `Jan 31, 2024 12:00:00`
+        # - `Jan 31, 2024 12:00`
+        # @return [Regexp]
+        ABBREVIATED_MONTH_NAME: Regexp
+
+        # Matches datetime formats using a 12-hour clock with AM/PM, including:
+        # - `2024-01-01 01:30:00 PM`
+        # - `2024-01-01 01:30 PM`
+        # @return [Regexp]
+        TWELVE_HOUR_FORMAT: Regexp
+      end
+
+      # Constrain the type to match American-style datetime formats.
+      #
+      # @return [self] self for method chaining
+      def having_american_format: () -> self
+
+      alias american having_american_format
+
+      alias having_us_format having_american_format
+
+      alias us_format having_american_format
+
+      # Constrain the type to match European-style datetime formats.
+      #
+      # @return [self] self for method chaining
+      def having_european_format: () -> self
+
+      alias european having_european_format
+
+      alias having_eu_format having_european_format
+
+      alias eu_format having_european_format
+
+      # Constrain the type to match ISO 8601 datetime formats.
+      #
+      # @return [self] self for method chaining
+      def having_iso8601_format: () -> self
+
+      alias iso8601 having_iso8601_format
+
+      alias iso8601_format having_iso8601_format
+
+      # Constrain the type to match RFC2822 datetime formats.
+      #
+      # @return [self] self for method chaining
+      def having_rfc2822_format: () -> self
+
+      alias rfc2822 having_rfc2822_format
+
+      alias rfc2822_format having_rfc2822_format
+    end
+  end
+end

data/sig/domainic/type/types/datetime/timestamp_type.rbs

@@ -0,0 +1,44 @@
+module Domainic
+  module Type
+    # A type for validating Unix timestamps (seconds since the Unix epoch).
+    #
+    # This type ensures the value is an `Integer` representing a valid Unix
+    # timestamp. It integrates with `DateTimeBehavior` to provide a rich set of
+    # validation capabilities, including chronological constraints and range checks.
+    #
+    # Key features:
+    # - Ensures the value is an `Integer` representing a Unix timestamp.
+    # - Supports chronological relationship constraints (e.g., before, after).
+    # - Provides range, equality, and nilable checks.
+    #
+    # @example Basic usage
+    #   type = TimestampType.new
+    #   type.validate(Time.now.to_i)             # => true
+    #   type.validate(Date.today.to_time.to_i)   # => true
+    #   type.validate('invalid')                 # => false
+    #
+    # @example Range validation
+    #   type = TimestampType.new
+    #     .being_between(Time.now.to_i, (Time.now + 3600).to_i)
+    #   type.validate((Time.now + 1800).to_i)    # => true
+    #   type.validate((Time.now + 7200).to_i)    # => false
+    #
+    # @example Historical timestamps
+    #   type = TimestampType.new
+    #   type.validate(-1234567890)               # => true (date before 1970-01-01)
+    #
+    # @example Nilable timestamp
+    #   nilable_type = _Nilable(TimestampType.new)
+    #   nilable_type.validate(nil)               # => true
+    #
+    # @author {https://aaronmallen.me Aaron Allen}
+    # @since 0.1.0
+    class TimestampType
+      extend Behavior::ClassMethods
+
+      include Behavior
+
+      include Behavior::DateTimeBehavior
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: domainic-type
 version: !ruby/object:Gem::Version
-  version: 0.1.0.alpha.3.2.0
+  version: 0.1.0.alpha.3.4.0
 platform: ruby
 authors:
 - Aaron Allen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-26 00:00:00.000000000 Z
+date: 2024-12-30 00:00:00.000000000 Z
 dependencies: []
 description: Stop wrestling with complex type validations and unclear error messages.
   Domainic::Type brings type validation to Ruby that is both powerful and delightful
@@ -21,9 +21,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".yardopts"
 - CHANGELOG.md
 - LICENSE
 - README.md
+- docs/USAGE.md
 - lib/domainic-type.rb
 - lib/domainic/type.rb
 - lib/domainic/type/accessors.rb
@@ -58,6 +60,7 @@ files:
 - lib/domainic/type/constraint/constraints/ordering_constraint.rb
 - lib/domainic/type/constraint/constraints/parity_constraint.rb
 - lib/domainic/type/constraint/constraints/polarity_constraint.rb
+- lib/domainic/type/constraint/constraints/predicate_constraint.rb
 - lib/domainic/type/constraint/constraints/range_constraint.rb
 - lib/domainic/type/constraint/constraints/type_constraint.rb
 - lib/domainic/type/constraint/constraints/uniqueness_constraint.rb
@@ -65,14 +68,21 @@ files:
 - lib/domainic/type/constraint/set.rb
 - lib/domainic/type/definitions.rb
 - lib/domainic/type/types/core/array_type.rb
+- lib/domainic/type/types/core/complex_type.rb
 - lib/domainic/type/types/core/float_type.rb
 - lib/domainic/type/types/core/hash_type.rb
 - lib/domainic/type/types/core/integer_type.rb
+- lib/domainic/type/types/core/range_type.rb
+- lib/domainic/type/types/core/rational_type.rb
 - lib/domainic/type/types/core/string_type.rb
 - lib/domainic/type/types/core/symbol_type.rb
+- lib/domainic/type/types/core_extended/big_decimal_type.rb
+- lib/domainic/type/types/core_extended/set_type.rb
+- lib/domainic/type/types/datetime/date_time_string_type.rb
 - lib/domainic/type/types/datetime/date_time_type.rb
 - lib/domainic/type/types/datetime/date_type.rb
 - lib/domainic/type/types/datetime/time_type.rb
+- lib/domainic/type/types/datetime/timestamp_type.rb
 - lib/domainic/type/types/identifier/cuid_type.rb
 - lib/domainic/type/types/identifier/uuid_type.rb
 - lib/domainic/type/types/network/email_address_type.rb
@@ -117,6 +127,7 @@ files:
 - sig/domainic/type/constraint/constraints/ordering_constraint.rbs
 - sig/domainic/type/constraint/constraints/parity_constraint.rbs
 - sig/domainic/type/constraint/constraints/polarity_constraint.rbs
+- sig/domainic/type/constraint/constraints/predicate_constraint.rbs
 - sig/domainic/type/constraint/constraints/range_constraint.rbs
 - sig/domainic/type/constraint/constraints/type_constraint.rbs
 - sig/domainic/type/constraint/constraints/uniqueness_constraint.rbs
@@ -124,14 +135,21 @@ files:
 - sig/domainic/type/constraint/set.rbs
 - sig/domainic/type/definitions.rbs
 - sig/domainic/type/types/core/array_type.rbs
+- sig/domainic/type/types/core/complex_type.rbs
 - sig/domainic/type/types/core/float_type.rbs
 - sig/domainic/type/types/core/hash_type.rbs
 - sig/domainic/type/types/core/integer_type.rbs
+- sig/domainic/type/types/core/range_type.rbs
+- sig/domainic/type/types/core/rational_type.rbs
 - sig/domainic/type/types/core/string_type.rbs
 - sig/domainic/type/types/core/symbol_type.rbs
+- sig/domainic/type/types/core_extended/big_decimal_type.rbs
+- sig/domainic/type/types/core_extended/set_type.rbs
+- sig/domainic/type/types/datetime/date_time_string_type.rbs
 - sig/domainic/type/types/datetime/date_time_type.rbs
 - sig/domainic/type/types/datetime/date_type.rbs
 - sig/domainic/type/types/datetime/time_type.rbs
+- sig/domainic/type/types/datetime/timestamp_type.rbs
 - sig/domainic/type/types/identifier/cuid_type.rbs
 - sig/domainic/type/types/identifier/uuid_type.rbs
 - sig/domainic/type/types/network/email_address_type.rbs
@@ -144,15 +162,16 @@ files:
 - sig/domainic/type/types/specification/union_type.rbs
 - sig/domainic/type/types/specification/void_type.rbs
 - sig/manifest.yaml
-homepage: https://github.com/domainic/domainic/tree/domainic-type-v0.1.0-alpha.3.2.0/domainic-type
+homepage: https://github.com/domainic/domainic/tree/domainic-type-v0.1.0-alpha.3.4.0/domainic-type
 licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/domainic/domainic/issues
-  changelog_uri: https://github.com/domainic/domainic/releases/tag/domainic-type-v0.1.0-alpha.3.2.0
-  homepage_uri: https://github.com/domainic/domainic/tree/domainic-type-v0.1.0-alpha.3.2.0/domainic-type
+  changelog_uri: https://github.com/domainic/domainic/releases/tag/domainic-type-v0.1.0-alpha.3.4.0
+  documentation_uri: https://rubydoc.info/gems/domainic-type/0.1.0.alpha.3.4.0
+  homepage_uri: https://github.com/domainic/domainic/tree/domainic-type-v0.1.0-alpha.3.4.0/domainic-type
   rubygems_mfa_required: 'true'
-  source_code_uri: https://github.com/domainic/domainic/tree/domainic-type-v0.1.0-alpha.3.2.0/domainic-type
+  source_code_uri: https://github.com/domainic/domainic/tree/domainic-type-v0.1.0-alpha.3.4.0/domainic-type
 post_install_message:
 rdoc_options: []
 require_paths: