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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e864e12054b6928f12f7465eace3657aaa736e264a1655e7838ec4f2e658ebed
-  data.tar.gz: ac7c71c1bd2c2f992bb6aca1306291838a4b7eabc77326130db553de8a9dc18f
+  metadata.gz: 550b1308cecd5947776940a2dcc989cdd36887d95eb465ecfc38536917ee37f8
+  data.tar.gz: 81b6b0cd20abc571c139b513ab1e04a85a05d986c5b382afa39335e254098cc8
 SHA512:
-  metadata.gz: 6029d7d12cb562dd7f2688472f0da97bcb548c544f163cf5215736d82ee0927e6f2c4ff87cc0d1818eefe722d10ac0ee2dd4ebccabff45412793340928e63cb8
-  data.tar.gz: 7ba6d7e41e431f2dd401bffecd60701a9dfeab35eeea3bef9085e97941d1b8327ddfd7cbe5febc577a0e1b3cce49147f6b686b56f1f6251257836d58327d198d
+  metadata.gz: 11ffccc4e5d51bba2c827c6546e619a4ea0adacdf082e9fa400b7392acf5e5a17165c288793d0ccaa20143623e69023ca409e6138d516f5d3d14618a1ccec7f2
+  data.tar.gz: 5390e21417c13932df1f32da949fcf3af23ac31a56423b20cc6ec7752616a47765c867fb03d92f218d19d956a649c63027c17bdd9d98724d46a7c267b8cb1c06

data/README.md

@@ -7,7 +7,7 @@
 
 > [!IMPORTANT]  
 > We're running an experiment with Domainic::Type! Help us explore flexible type validation in Ruby by trying our
-> [alpha release](https://github.com/domainic/domainic/wiki/experiments-domainic-type-alpha-3). Your feedback is
+> [alpha release](https://github.com/domainic/domainic/wiki/experiments-domainic-type-v0.1.0-alpha). Your feedback is
 > invaluable for shaping the future of domain-driven design in Ruby.
 
 A flexible type validation system for Ruby that brings the power of composable constraints and crystal-clear error

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

@@ -53,6 +53,9 @@ module Domainic
         # @rbs!
         #   type options = { ?abort_on_failure: bool, ?coerce_with: Array[Proc] | Proc }
 
+        # @rbs skip
+        extend Gem::Deprecate
+
         # @rbs @accessor: Type::accessor
         # @rbs @actual: Actual
         # @rbs @expected: Expected
@@ -120,19 +123,25 @@ module Domainic
 
         # The full description of the constraint.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @return [String, nil] The full description of the constraint.
         # @rbs () -> String?
         def full_description
           full_description_for(short_description)
         end
+        deprecate :full_description, :none, 2025, 3 # steep:ignore
 
         # The full description of the violations that caused the constraint to be unsatisfied.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @return [String, nil] The full description of the constraint when it fails.
         # @rbs () -> String?
         def full_violation_description
           full_description_for(short_violation_description)
         end
+        deprecate :full_violation_description, :none, 2025, 3 # steep:ignore
 
         # Whether the constraint is satisfied.
         #
@@ -161,22 +170,28 @@ module Domainic
         # Implementing classes should override this to provide meaningful descriptions of their
         # constraint behavior.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @return [String] The description of the constraint.
         # @rbs () -> String
         def short_description
           @expected.to_s
         end
+        deprecate :short_description, :none, 2025, 3 # steep:ignore
 
         # The short description of the violations that caused the constraint to be unsatisfied.
         #
         # This is used to help compose a error message when the constraint is not satisfied.
         # Implementing classes can override this to provide more specific failure messages.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @return [String] The description of the constraint when it fails.
         # @rbs () -> String
         def short_violation_description
           @actual.to_s
         end
+        deprecate :short_violation_description, :none, 2025, 3 # steep:ignore
 
         # Whether the constraint is a success.
         #
@@ -310,6 +325,8 @@ module Domainic
 
         # Generate the full description for the corresponding short description.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @param description [String] The short description to expand.
         #
         # @return [String] The full description.

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

@@ -30,6 +30,8 @@ module Domainic
 
         # Get a description of what the constraint expects.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @return [String] the constraint description
         # @rbs override
         def short_description
@@ -41,6 +43,8 @@ module Domainic
         # This is used to help compose a error message when the constraint is not satisfied.
         # Implementing classes can override this to provide more specific failure messages.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @return [String] The description of the constraint when it fails.
         # @rbs override
         def short_violation_description

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

@@ -33,6 +33,8 @@ module Domainic
 
         # Get a description of what the constraint expects.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @return [String] a description combining all constraint descriptions with 'and'
         # @rbs override
         def short_description
@@ -51,6 +53,8 @@ module Domainic
         # This method provides detailed feedback about which constraints failed,
         # listing all violations that prevented validation from succeeding.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @return [String] The combined violation descriptions from all constraints
         # @rbs override
         def short_violation_description

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

@@ -32,6 +32,8 @@ module Domainic
 
         # Get a description of what the constraint expects.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @return [String] a description combining all constraint descriptions
         # @rbs override
         def short_description
@@ -43,6 +45,8 @@ module Domainic
         # This method provides detailed feedback when no constraints are satisfied,
         # listing all the ways in which the value failed validation.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @return [String] The combined violation descriptions from all constraints
         # @rbs override
         def short_violation_description

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

@@ -50,6 +50,8 @@ module Domainic
 
         # Get a description of what the constraint expects
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @return [String] the constraint description
         # @rbs override
         def short_description
@@ -58,6 +60,8 @@ module Domainic
 
         # Get a description of why the constraint was violated
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @return [String] the violation description
         # @rbs override
         def short_violation_description

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

@@ -43,6 +43,8 @@ module Domainic
 
         # Get a human-readable description of the case requirement.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @example
         #   constraint = CaseConstraint.new(:self, :upper)
         #   constraint.short_description # => "upper case"
@@ -55,6 +57,8 @@ module Domainic
 
         # Get a human-readable description of why case validation failed.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @example
         #   constraint = CaseConstraint.new(:self, :upper)
         #   constraint.satisfied?("Hello")

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

@@ -51,6 +51,8 @@ module Domainic
 
         # Get a human-readable description of the character set requirement.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @example
         #   constraint = CharacterSetConstraint.new(:self, :numeric)
         #   constraint.short_description # => "only numeric characters"
@@ -63,6 +65,8 @@ module Domainic
 
         # Get a human-readable description of why character validation failed.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @example
         #   constraint = CharacterSetConstraint.new(:self, :numeric)
         #   constraint.satisfied?("abc123")

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

@@ -44,6 +44,8 @@ module Domainic
 
         # Get a human-readable description of the divisibility requirement.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @example
         #   constraint = DivisibilityConstraint.new(:self, 5)
         #   constraint.short_description # => "divisible by 5"
@@ -56,6 +58,8 @@ module Domainic
 
         # Get a human-readable description of why divisibility validation failed.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @example With non-numeric value
         #   constraint = DivisibilityConstraint.new(:self, 5)
         #   constraint.satisfied?("not a number")

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

@@ -28,6 +28,8 @@ module Domainic
 
         # Get a human-readable description of the emptiness requirement.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @example
         #   constraint = EmptinessConstraint.new(:self)
         #   constraint.description # => "empty"
@@ -40,6 +42,8 @@ module Domainic
 
         # Get a human-readable description of why emptiness validation failed.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @example
         #   constraint = EmptinessConstraint.new(:self)
         #   constraint.satisfied?([1, 2, 3])

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

@@ -34,6 +34,8 @@ module Domainic
 
         # Get a human-readable description of the equality requirement.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @example
         #   constraint = EqualityConstraint.new(:self, 42)
         #   constraint.description # => "equal to 42"
@@ -46,6 +48,8 @@ module Domainic
 
         # Get a human-readable description of why equality validation failed.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @example
         #   constraint = EqualityConstraint.new(:self, 42)
         #   constraint.satisfied?(41)

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

@@ -31,6 +31,8 @@ module Domainic
 
         # Get a human-readable description of the finiteness requirement.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @return [String] Description of the finiteness requirement
         # @rbs override
         def short_description
@@ -39,6 +41,8 @@ module Domainic
 
         # Get a human-readable description of why finiteness validation failed.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @return [String] Description of the validation failure
         # @rbs override
         def short_violation_description

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

@@ -33,6 +33,8 @@ module Domainic
 
         # Get a human-readable description of the inclusion requirement.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @example
         #   constraint = InclusionConstraint.new(:self, 42)
         #   constraint.short_description # => "including 42"
@@ -45,6 +47,8 @@ module Domainic
 
         # Get a human-readable description of why inclusion validation failed.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @example
         #   constraint = InclusionConstraint.new(:self, 42)
         #   constraint.satisfied?([1, 2, 3])

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

@@ -28,6 +28,8 @@ module Domainic
 
         # Get a human-readable description of the instance requirement.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @example
         #   constraint = InstanceOfConstraint.new(:self, String)
         #   constraint.description # => "instance of String"
@@ -40,6 +42,8 @@ module Domainic
 
         # Get a human-readable description of why instance validation failed.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @example
         #   constraint = InstanceOfConstraint.new(:self, String)
         #   constraint.satisfied?(:symbol)

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

@@ -28,6 +28,8 @@ module Domainic
 
         # Get a human-readable description of the pattern requirement.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @example
         #   constraint = MatchPatternConstraint.new(:self, /\d+/)
         #   constraint.short_description # => "matches /\\d+/"
@@ -40,6 +42,8 @@ module Domainic
 
         # Get a human-readable description of why pattern validation failed.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @example
         #   constraint = MatchPatternConstraint.new(:self, /\d+/)
         #   constraint.satisfied?("abc")

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

@@ -22,6 +22,8 @@ module Domainic
 
         # Get a short description of what this constraint expects
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @return [String] description of the expected method
         # @rbs override
         def short_description
@@ -30,6 +32,8 @@ module Domainic
 
         # Get a short description of why the constraint was violated
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @return [String] description of the missing method
         # @rbs override
         def short_violation_description

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

@@ -32,6 +32,8 @@ module Domainic
 
         # Get a description of what the constraint expects.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @return [String] a description negating the expected constraint description
         # @rbs override
         def short_description
@@ -43,6 +45,8 @@ module Domainic
         # This method provides detailed feedback when any constraints are satisfied,
         # listing all the ways in which the value failed validation.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @return [String] The combined violation descriptions from all violating elements
         # @rbs override
         def short_violation_description

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

@@ -35,6 +35,8 @@ module Domainic
 
         # Get a description of what the constraint expects.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @return [String] a description combining all constraint descriptions with 'nor'
         # @rbs override
         def short_description
@@ -50,6 +52,8 @@ module Domainic
         # This method provides detailed feedback about which constraints were satisfied,
         # listing all violations that caused the validation to fail.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @return [String] The combined violation descriptions from all satisfied constraints
         # @rbs override
         def short_violation_description

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

@@ -31,6 +31,8 @@ module Domainic
 
         # Get a description of what the constraint expects.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @return [String] the negated constraint description
         # @rbs override
         def short_description
@@ -42,6 +44,8 @@ module Domainic
         # This is used to help compose a error message when the constraint is not satisfied.
         # Implementing classes can override this to provide more specific failure messages.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @return [String] The description of the constraint when it fails.
         # @rbs override
         def short_violation_description

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

@@ -33,6 +33,8 @@ module Domainic
 
         # Get a description of what the constraint expects.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @return [String] a description combining all constraint descriptions with 'or'
         # @rbs override
         def short_description
@@ -47,6 +49,8 @@ module Domainic
 
         # The description of the violations that caused the constraint to be unsatisfied.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # This method provides detailed feedback when no constraints are satisfied,
         # listing all the ways in which the value failed validation. Uses 'and' in the
         # message because all constraints failed (e.g., "was not a string AND was not a

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

@@ -34,6 +34,8 @@ module Domainic
 
         # Get a human-readable description of the ordering requirement.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @example
         #   constraint = OrderingConstraint.new(:self)
         #   constraint.description # => "ordered"
@@ -46,6 +48,8 @@ module Domainic
 
         # Get a human-readable description of why ordering validation failed.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @example
         #   constraint = OrderingConstraint.new(:self)
         #   constraint.satisfied?([3, 1, 2])

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

@@ -27,6 +27,8 @@ module Domainic
 
         # Get a human-readable description of the parity requirement.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @example
         #   constraint = ParityConstraint.new(:self).expecting(:even)
         #   constraint.short_description  # => "even"
@@ -39,6 +41,8 @@ module Domainic
 
         # Get a human-readable description of why parity validation failed.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @example
         #   constraint = ParityConstraint.new(:self).expecting(:positive)
         #   constraint.satisfied?(0)

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

@@ -37,6 +37,8 @@ module Domainic
 
         # Get a human-readable description of the polarity requirement.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @example
         #   constraint = PolarityConstraint.new(:self).expecting(:positive)
         #   constraint.short_description  # => "positive"
@@ -49,6 +51,8 @@ module Domainic
 
         # Get a human-readable description of why polarity validation failed.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @example
         #   constraint = PolarityConstraint.new(:self).expecting(:positive)
         #   constraint.satisfied?(0)

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

@@ -33,6 +33,8 @@ module Domainic
 
         # Get a description of what the constraint expects.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @note This constraint type does not provide a description as predicates are arbitrary.
         #
         # @return [String] an empty string
@@ -41,6 +43,8 @@ module Domainic
 
         # Get a description of why the predicate validation failed.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @return [String] the custom violation description if provided
         # @rbs override
         def short_violation_description

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

@@ -58,6 +58,8 @@ module Domainic
 
         # Get a human-readable description of the range constraint.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @example With both bounds
         #   constraint = RangeConstraint.new(:self, { minimum: 1, maximum: 10 })
         #   constraint.description
@@ -86,6 +88,8 @@ module Domainic
 
         # The description of the violations that caused the constraint to be unsatisfied.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # This is used to help compose a error message when the constraint is not satisfied.
         # Implementing classes can override this to provide more specific failure messages.
         #

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

@@ -45,6 +45,8 @@ module Domainic
 
         # Get a human-readable description of the expected type.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @example
         #   constraint = TypeConstraint.new(:self, Float)
         #   constraint.description # => "Float"
@@ -63,6 +65,8 @@ module Domainic
         # This is used to help compose a error message when the constraint is not satisfied.
         # Implementing classes can override this to provide more specific failure messages.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @return [String] The description of the constraint when it fails.
         # @rbs override
         def short_violation_description

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

@@ -29,6 +29,8 @@ module Domainic
 
         # Get a human-readable description of the uniqueness requirement.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @example
         #   constraint = UniquenessConstraint.new(:self)
         #   constraint.description # => "unique"
@@ -44,6 +46,8 @@ module Domainic
         # This is used to help compose a error message when the constraint is not satisfied.
         # Implementing classes can override this to provide more specific failure messages.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @return [String] The description of the constraint when it fails.
         # @rbs override
         def short_violation_description

data/lib/domainic/type/constraint/set.rb

@@ -34,6 +34,9 @@ module Domainic
       class Set
         extend Forwardable
 
+        # @rbs skip
+        extend Gem::Deprecate
+
         # @rbs @lookup: Hash[Type::accessor, Hash[Symbol, Behavior]]
 
         # Initialize a new empty constraint set.
@@ -121,6 +124,8 @@ module Domainic
 
         # The aggregate description of all constraints in the set.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @return [String] The description of all constraints
         # @rbs () -> String
         def description
@@ -128,6 +133,7 @@ module Domainic
             @lookup[accessor].values.filter_map(&:full_description)
           end.join(', ').strip
         end
+        deprecate :description, :none, 2025, 3 # steep:ignore
 
         # @!method each
         #   Iterate over each constraint in the set.
@@ -221,6 +227,8 @@ module Domainic
 
         # The aggregate violation description of all constraints in the set.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @return [String] The description of all constraints
         # @rbs () -> String
         def violation_description
@@ -228,6 +236,7 @@ module Domainic
             @lookup[accessor].values.reject(&:successful?).filter_map(&:full_violation_description)
           end.join(', ').strip
         end
+        deprecate :violation_description, :none, 2025, 3 # steep:ignore
 
         private
 

data/sig/domainic/type/constraint/behavior.rbs

@@ -97,11 +97,15 @@ module Domainic
 
         # The full description of the constraint.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @return [String, nil] The full description of the constraint.
         def full_description: () -> String?
 
         # The full description of the violations that caused the constraint to be unsatisfied.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @return [String, nil] The full description of the constraint when it fails.
         def full_violation_description: () -> String?
 
@@ -124,6 +128,8 @@ module Domainic
         # Implementing classes should override this to provide meaningful descriptions of their
         # constraint behavior.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @return [String] The description of the constraint.
         def short_description: () -> String
 
@@ -132,6 +138,8 @@ module Domainic
         # This is used to help compose a error message when the constraint is not satisfied.
         # Implementing classes can override this to provide more specific failure messages.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @return [String] The description of the constraint when it fails.
         def short_violation_description: () -> String
 
@@ -240,6 +248,8 @@ module Domainic
 
         # Generate the full description for the corresponding short description.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @param description [String] The short description to expand.
         #
         # @return [String] The full description.

data/sig/domainic/type/constraint/constraints/all_constraint.rbs

@@ -26,6 +26,8 @@ module Domainic
 
         # Get a description of what the constraint expects.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @return [String] the constraint description
         def short_description: ...
 
@@ -34,6 +36,8 @@ module Domainic
         # This is used to help compose a error message when the constraint is not satisfied.
         # Implementing classes can override this to provide more specific failure messages.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @return [String] The description of the constraint when it fails.
         def short_violation_description: ...
 

data/sig/domainic/type/constraint/constraints/and_constraint.rbs

@@ -29,6 +29,8 @@ module Domainic
 
         # Get a description of what the constraint expects.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @return [String] a description combining all constraint descriptions with 'and'
         def short_description: ...
 
@@ -39,6 +41,8 @@ module Domainic
         # This method provides detailed feedback about which constraints failed,
         # listing all violations that prevented validation from succeeding.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @return [String] The combined violation descriptions from all constraints
         def short_violation_description: ...
 

data/sig/domainic/type/constraint/constraints/any_constraint.rbs

@@ -28,6 +28,8 @@ module Domainic
 
         # Get a description of what the constraint expects.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @return [String] a description combining all constraint descriptions
         def short_description: ...
 
@@ -36,6 +38,8 @@ module Domainic
         # This method provides detailed feedback when no constraints are satisfied,
         # listing all the ways in which the value failed validation.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @return [String] The combined violation descriptions from all constraints
         def short_violation_description: ...
 

data/sig/domainic/type/constraint/constraints/attribute_presence_constraint.rbs

@@ -45,11 +45,15 @@ module Domainic
 
         # Get a description of what the constraint expects
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @return [String] the constraint description
         def short_description: ...
 
         # Get a description of why the constraint was violated
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @return [String] the violation description
         def short_violation_description: ...
 

data/sig/domainic/type/constraint/constraints/case_constraint.rbs

@@ -38,6 +38,8 @@ module Domainic
 
         # Get a human-readable description of the case requirement.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @example
         #   constraint = CaseConstraint.new(:self, :upper)
         #   constraint.short_description # => "upper case"
@@ -47,6 +49,8 @@ module Domainic
 
         # Get a human-readable description of why case validation failed.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @example
         #   constraint = CaseConstraint.new(:self, :upper)
         #   constraint.satisfied?("Hello")

data/sig/domainic/type/constraint/constraints/character_set_constraint.rbs

@@ -40,6 +40,8 @@ module Domainic
 
         # Get a human-readable description of the character set requirement.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @example
         #   constraint = CharacterSetConstraint.new(:self, :numeric)
         #   constraint.short_description # => "only numeric characters"
@@ -49,6 +51,8 @@ module Domainic
 
         # Get a human-readable description of why character validation failed.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @example
         #   constraint = CharacterSetConstraint.new(:self, :numeric)
         #   constraint.satisfied?("abc123")

data/sig/domainic/type/constraint/constraints/divisibility_constraint.rbs

@@ -39,6 +39,8 @@ module Domainic
 
         # Get a human-readable description of the divisibility requirement.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @example
         #   constraint = DivisibilityConstraint.new(:self, 5)
         #   constraint.short_description # => "divisible by 5"
@@ -48,6 +50,8 @@ module Domainic
 
         # Get a human-readable description of why divisibility validation failed.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @example With non-numeric value
         #   constraint = DivisibilityConstraint.new(:self, 5)
         #   constraint.satisfied?("not a number")

data/sig/domainic/type/constraint/constraints/emptiness_constraint.rbs

@@ -24,6 +24,8 @@ module Domainic
 
         # Get a human-readable description of the emptiness requirement.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @example
         #   constraint = EmptinessConstraint.new(:self)
         #   constraint.description # => "empty"
@@ -33,6 +35,8 @@ module Domainic
 
         # Get a human-readable description of why emptiness validation failed.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @example
         #   constraint = EmptinessConstraint.new(:self)
         #   constraint.satisfied?([1, 2, 3])

data/sig/domainic/type/constraint/constraints/equality_constraint.rbs

@@ -30,6 +30,8 @@ module Domainic
 
         # Get a human-readable description of the equality requirement.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @example
         #   constraint = EqualityConstraint.new(:self, 42)
         #   constraint.description # => "equal to 42"
@@ -39,6 +41,8 @@ module Domainic
 
         # Get a human-readable description of why equality validation failed.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @example
         #   constraint = EqualityConstraint.new(:self, 42)
         #   constraint.satisfied?(41)

data/sig/domainic/type/constraint/constraints/finiteness_constraint.rbs

@@ -26,11 +26,15 @@ module Domainic
 
         # Get a human-readable description of the finiteness requirement.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @return [String] Description of the finiteness requirement
         def short_description: ...
 
         # Get a human-readable description of why finiteness validation failed.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @return [String] Description of the validation failure
         def short_violation_description: ...
 

data/sig/domainic/type/constraint/constraints/inclusion_constraint.rbs

@@ -29,6 +29,8 @@ module Domainic
 
         # Get a human-readable description of the inclusion requirement.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @example
         #   constraint = InclusionConstraint.new(:self, 42)
         #   constraint.short_description # => "including 42"
@@ -38,6 +40,8 @@ module Domainic
 
         # Get a human-readable description of why inclusion validation failed.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @example
         #   constraint = InclusionConstraint.new(:self, 42)
         #   constraint.satisfied?([1, 2, 3])

data/sig/domainic/type/constraint/constraints/instance_of_constraint.rbs

@@ -24,6 +24,8 @@ module Domainic
 
         # Get a human-readable description of the instance requirement.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @example
         #   constraint = InstanceOfConstraint.new(:self, String)
         #   constraint.description # => "instance of String"
@@ -33,6 +35,8 @@ module Domainic
 
         # Get a human-readable description of why instance validation failed.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @example
         #   constraint = InstanceOfConstraint.new(:self, String)
         #   constraint.satisfied?(:symbol)

data/sig/domainic/type/constraint/constraints/match_pattern_constraint.rbs

@@ -24,6 +24,8 @@ module Domainic
 
         # Get a human-readable description of the pattern requirement.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @example
         #   constraint = MatchPatternConstraint.new(:self, /\d+/)
         #   constraint.short_description # => "matches /\\d+/"
@@ -33,6 +35,8 @@ module Domainic
 
         # Get a human-readable description of why pattern validation failed.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @example
         #   constraint = MatchPatternConstraint.new(:self, /\d+/)
         #   constraint.satisfied?("abc")

data/sig/domainic/type/constraint/constraints/method_presence_constraint.rbs

@@ -18,11 +18,15 @@ module Domainic
 
         # Get a short description of what this constraint expects
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @return [String] description of the expected method
         def short_description: ...
 
         # Get a short description of why the constraint was violated
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @return [String] description of the missing method
         def short_violation_description: ...
 

data/sig/domainic/type/constraint/constraints/none_constraint.rbs

@@ -28,6 +28,8 @@ module Domainic
 
         # Get a description of what the constraint expects.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @return [String] a description negating the expected constraint description
         def short_description: ...
 
@@ -36,6 +38,8 @@ module Domainic
         # This method provides detailed feedback when any constraints are satisfied,
         # listing all the ways in which the value failed validation.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @return [String] The combined violation descriptions from all violating elements
         def short_violation_description: ...
 

data/sig/domainic/type/constraint/constraints/nor_constraint.rbs

@@ -31,6 +31,8 @@ module Domainic
 
         # Get a description of what the constraint expects.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @return [String] a description combining all constraint descriptions with 'nor'
         def short_description: ...
 
@@ -39,6 +41,8 @@ module Domainic
         # This method provides detailed feedback about which constraints were satisfied,
         # listing all violations that caused the validation to fail.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @return [String] The combined violation descriptions from all satisfied constraints
         def short_violation_description: ...
 

data/sig/domainic/type/constraint/constraints/not_constraint.rbs

@@ -27,6 +27,8 @@ module Domainic
 
         # Get a description of what the constraint expects.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @return [String] the negated constraint description
         def short_description: ...
 
@@ -35,6 +37,8 @@ module Domainic
         # This is used to help compose a error message when the constraint is not satisfied.
         # Implementing classes can override this to provide more specific failure messages.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @return [String] The description of the constraint when it fails.
         def short_violation_description: ...
 

data/sig/domainic/type/constraint/constraints/or_constraint.rbs

@@ -29,6 +29,8 @@ module Domainic
 
         # Get a description of what the constraint expects.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @return [String] a description combining all constraint descriptions with 'or'
         def short_description: ...
 
@@ -36,6 +38,8 @@ module Domainic
 
         # The description of the violations that caused the constraint to be unsatisfied.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # This method provides detailed feedback when no constraints are satisfied,
         # listing all the ways in which the value failed validation. Uses 'and' in the
         # message because all constraints failed (e.g., "was not a string AND was not a

data/sig/domainic/type/constraint/constraints/ordering_constraint.rbs

@@ -30,6 +30,8 @@ module Domainic
 
         # Get a human-readable description of the ordering requirement.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @example
         #   constraint = OrderingConstraint.new(:self)
         #   constraint.description # => "ordered"
@@ -39,6 +41,8 @@ module Domainic
 
         # Get a human-readable description of why ordering validation failed.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @example
         #   constraint = OrderingConstraint.new(:self)
         #   constraint.satisfied?([3, 1, 2])

data/sig/domainic/type/constraint/constraints/parity_constraint.rbs

@@ -22,6 +22,8 @@ module Domainic
 
         # Get a human-readable description of the parity requirement.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @example
         #   constraint = ParityConstraint.new(:self).expecting(:even)
         #   constraint.short_description  # => "even"
@@ -31,6 +33,8 @@ module Domainic
 
         # Get a human-readable description of why parity validation failed.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @example
         #   constraint = ParityConstraint.new(:self).expecting(:positive)
         #   constraint.satisfied?(0)

data/sig/domainic/type/constraint/constraints/polarity_constraint.rbs

@@ -32,6 +32,8 @@ module Domainic
 
         # Get a human-readable description of the polarity requirement.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @example
         #   constraint = PolarityConstraint.new(:self).expecting(:positive)
         #   constraint.short_description  # => "positive"
@@ -41,6 +43,8 @@ module Domainic
 
         # Get a human-readable description of why polarity validation failed.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @example
         #   constraint = PolarityConstraint.new(:self).expecting(:positive)
         #   constraint.satisfied?(0)

data/sig/domainic/type/constraint/constraints/predicate_constraint.rbs

@@ -28,6 +28,8 @@ module Domainic
 
         # Get a description of what the constraint expects.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @note This constraint type does not provide a description as predicates are arbitrary.
         #
         # @return [String] an empty string
@@ -35,6 +37,8 @@ module Domainic
 
         # Get a description of why the predicate validation failed.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @return [String] the custom violation description if provided
         def short_violation_description: ...
 

data/sig/domainic/type/constraint/constraints/range_constraint.rbs

@@ -53,6 +53,8 @@ module Domainic
 
         # Get a human-readable description of the range constraint.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @example With both bounds
         #   constraint = RangeConstraint.new(:self, { minimum: 1, maximum: 10 })
         #   constraint.description
@@ -71,6 +73,8 @@ module Domainic
 
         # The description of the violations that caused the constraint to be unsatisfied.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # This is used to help compose a error message when the constraint is not satisfied.
         # Implementing classes can override this to provide more specific failure messages.
         #

data/sig/domainic/type/constraint/constraints/type_constraint.rbs

@@ -40,6 +40,8 @@ module Domainic
 
         # Get a human-readable description of the expected type.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @example
         #   constraint = TypeConstraint.new(:self, Float)
         #   constraint.description # => "Float"
@@ -55,6 +57,8 @@ module Domainic
         # This is used to help compose a error message when the constraint is not satisfied.
         # Implementing classes can override this to provide more specific failure messages.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @return [String] The description of the constraint when it fails.
         def short_violation_description: ...
 

data/sig/domainic/type/constraint/constraints/uniqueness_constraint.rbs

@@ -25,6 +25,8 @@ module Domainic
 
         # Get a human-readable description of the uniqueness requirement.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @example
         #   constraint = UniquenessConstraint.new(:self)
         #   constraint.description # => "unique"
@@ -37,6 +39,8 @@ module Domainic
         # This is used to help compose a error message when the constraint is not satisfied.
         # Implementing classes can override this to provide more specific failure messages.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @return [String] The description of the constraint when it fails.
         def short_violation_description: ...
 

data/sig/domainic/type/constraint/set.rbs

@@ -79,6 +79,8 @@ module Domainic
 
         # The aggregate description of all constraints in the set.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @return [String] The description of all constraints
         def description: () -> String
 
@@ -133,6 +135,8 @@ module Domainic
 
         # The aggregate violation description of all constraints in the set.
         #
+        # @deprecated this method will be removed in version 0.1.0
+        #
         # @return [String] The description of all constraints
         def violation_description: () -> String
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: domainic-type
 version: !ruby/object:Gem::Version
-  version: 0.1.0.alpha.3.4.0
+  version: 0.1.0.alpha.3.4.1
 platform: ruby
 authors:
 - Aaron Allen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-30 00:00:00.000000000 Z
+date: 2024-12-31 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
@@ -162,16 +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.4.0/domainic-type
+homepage: https://github.com/domainic/domainic/tree/domainic-type-v0.1.0-alpha.3.4.1/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.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
+  changelog_uri: https://github.com/domainic/domainic/releases/tag/domainic-type-v0.1.0-alpha.3.4.1
+  documentation_uri: https://rubydoc.info/gems/domainic-type/0.1.0.alpha.3.4.1
+  homepage_uri: https://github.com/domainic/domainic/tree/domainic-type-v0.1.0-alpha.3.4.1/domainic-type
   rubygems_mfa_required: 'true'
-  source_code_uri: https://github.com/domainic/domainic/tree/domainic-type-v0.1.0-alpha.3.4.0/domainic-type
+  source_code_uri: https://github.com/domainic/domainic/tree/domainic-type-v0.1.0-alpha.3.4.1/domainic-type
 post_install_message:
 rdoc_options: []
 require_paths: