domainic-type 0.1.0.alpha.3.0.2 → 0.1.0.alpha.3.1.0

data/sig/domainic/type/types/network/uri_type.rbs

@@ -0,0 +1,159 @@
+module Domainic
+  module Type
+    # A type for validating URIs according to RFC 3986 standards
+    #
+    # This type provides comprehensive URI validation, ensuring that values conform to
+    # standard URI syntax. It supports constraints on components like the scheme, hostname,
+    # path, and query string.
+    #
+    # Key features:
+    # - RFC-compliant URI validation
+    # - Scheme, hostname, path, and query validation
+    # - Maximum length enforcement
+    # - ASCII character set requirement
+    #
+    # @example Basic usage
+    #   type = UriType.new
+    #   type.validate("https://example.com/path?query=1") # => true
+    #   type.validate("not-a-uri") # => false
+    #
+    # @example With scheme constraints
+    #   type = UriType.new
+    #     .having_scheme("http", "https")
+    #
+    # @example With hostname and path constraints
+    #   type = UriType.new
+    #     .having_hostname("example.com")
+    #     .matching_path(/^\/[a-z]+$/)
+    #
+    # @example With maximum length
+    #   type = UriType.new
+    #     .having_maximum_size(2000)
+    #
+    # @author {https://aaronmallen.me Aaron Allen}
+    # @since 0.1.0
+    class URIType
+      extend Behavior::ClassMethods
+
+      include Behavior
+
+      include Behavior::StringBehavior::MatchingBehavior
+
+      include Behavior::SizableBehavior
+
+      include Behavior::URIBehavior
+
+      URI_REGEXP: Regexp
+
+      # Constrain URI hostname to allowed values
+      #
+      # Uses `HostnameType` to validate the hostname part of the URI.
+      #
+      # @example
+      #   type.having_hostname("example.com")
+      #   type.validate("https://example.com")  # => true
+      #   type.validate("https://other.com")    # => false
+      #
+      # @param hostnames [Array<String>] List of allowed hostnames
+      # @return [self] self for method chaining
+      def having_hostname: (*String hostnames) -> self
+
+      alias allowing_hostname having_hostname
+
+      alias host having_hostname
+
+      alias hostname having_hostname
+
+      alias with_hostname having_hostname
+
+      # Constrain URI path to match any of the specified patterns
+      #
+      # Ensures that the path part of the URI matches at least one of the given patterns.
+      #
+      # @example
+      #   type.having_path(/^\/[a-z]+$/, /^\/api\/v\d+/)
+      #   type.validate("https://example.com/path") # => true
+      #   type.validate("https://example.com/api/v1") # => true
+      #   type.validate("https://example.com/123")  # => false
+      #
+      # @param patterns [Array<Regexp>] Patterns the path must match
+      # @return [self] self for method chaining
+      def having_path: (*String | Regexp patterns) -> self
+
+      alias allowing_path having_path
+
+      alias with_path having_path
+
+      # Constrain URI scheme to specific values
+      #
+      # Ensures that the scheme part of the URI matches one of the specified schemes.
+      #
+      # @example
+      #   type.having_scheme("http", "https")
+      #   type.validate("https://example.com") # => true
+      #   type.validate("ftp://example.com")   # => false
+      #
+      # @param schemes [Array<String>] List of allowed schemes
+      # @return [self] self for method chaining
+      def having_scheme: (*String schemes) -> self
+
+      alias allowing_scheme having_scheme
+
+      alias scheme having_scheme
+
+      # Constrain URI hostname to exclude specific values
+      #
+      # Uses `HostnameType` to blacklist hostnames.
+      #
+      # @example
+      #   type.not_having_hostname("forbidden.com")
+      #   type.validate("https://allowed.com")   # => true
+      #   type.validate("https://forbidden.com") # => false
+      #
+      # @param hostnames [Array<String>] List of forbidden hostnames
+      # @return [self] self for method chaining
+      def not_having_hostname: (*String hostnames) -> self
+
+      alias forbidding_hostname not_having_hostname
+
+      alias not_host not_having_hostname
+
+      alias not_hostname not_having_hostname
+
+      # Constrain URI path to exclude any of the specified patterns
+      #
+      # Ensures that the path part of the URI does not match any of the given patterns.
+      #
+      # @example
+      #   type.not_having_path(/^\/admin/, /^\/private/)
+      #   type.validate("https://example.com/user") # => true
+      #   type.validate("https://example.com/admin") # => false
+      #   type.validate("https://example.com/private") # => false
+      #
+      # @param patterns [Array<Regexp>] Patterns the path must not match
+      # @return [self] self for method chaining
+      def not_having_path: (*String | Regexp patterns) -> self
+
+      alias forbidding_path not_having_path
+
+      alias not_allowing_path not_having_path
+
+      # Constrain URI scheme to exclude specific values
+      #
+      # Ensures that the scheme part of the URI does not match the specified schemes.
+      #
+      # @example
+      #   type.not_having_scheme("ftp")
+      #   type.validate("https://example.com") # => true
+      #   type.validate("ftp://example.com")   # => false
+      #
+      # @param schemes [Array<String>] List of forbidden schemes
+      # @return [self] self for method chaining
+      def not_having_scheme: (*String schemes) -> self
+
+      alias forbidding_scheme not_having_scheme
+
+      alias not_allowing_scheme not_having_scheme
+    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.0.2
+  version: 0.1.0.alpha.3.1.0
 platform: ruby
 authors:
 - Aaron Allen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-25 00:00:00.000000000 Z
+date: 2024-12-26 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
@@ -32,6 +32,8 @@ files:
 - lib/domainic/type/behavior/numeric_behavior.rb
 - lib/domainic/type/behavior/sizable_behavior.rb
 - lib/domainic/type/behavior/string_behavior.rb
+- lib/domainic/type/behavior/string_behavior/matching_behavior.rb
+- lib/domainic/type/behavior/uri_behavior.rb
 - lib/domainic/type/config/registry.yml
 - lib/domainic/type/constraint/behavior.rb
 - lib/domainic/type/constraint/constraints/all_constraint.rb
@@ -67,6 +69,11 @@ files:
 - lib/domainic/type/types/core/integer_type.rb
 - lib/domainic/type/types/core/string_type.rb
 - lib/domainic/type/types/core/symbol_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
+- lib/domainic/type/types/network/hostname_type.rb
+- lib/domainic/type/types/network/uri_type.rb
 - lib/domainic/type/types/specialized/instance_type.rb
 - lib/domainic/type/types/specification/anything_type.rb
 - lib/domainic/type/types/specification/duck_type.rb
@@ -81,6 +88,8 @@ files:
 - sig/domainic/type/behavior/numeric_behavior.rbs
 - sig/domainic/type/behavior/sizable_behavior.rbs
 - sig/domainic/type/behavior/string_behavior.rbs
+- sig/domainic/type/behavior/string_behavior/matching_behavior.rbs
+- sig/domainic/type/behavior/uri_behavior.rbs
 - sig/domainic/type/constraint/behavior.rbs
 - sig/domainic/type/constraint/constraints/all_constraint.rbs
 - sig/domainic/type/constraint/constraints/and_constraint.rbs
@@ -115,6 +124,11 @@ files:
 - sig/domainic/type/types/core/integer_type.rbs
 - sig/domainic/type/types/core/string_type.rbs
 - sig/domainic/type/types/core/symbol_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
+- sig/domainic/type/types/network/hostname_type.rbs
+- sig/domainic/type/types/network/uri_type.rbs
 - sig/domainic/type/types/specialized/instance_type.rbs
 - sig/domainic/type/types/specification/anything_type.rbs
 - sig/domainic/type/types/specification/duck_type.rbs
@@ -122,15 +136,15 @@ 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.0.2/domainic-type
+homepage: https://github.com/domainic/domainic/tree/domainic-type-v0.1.0-alpha.3.1.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.0.2
-  homepage_uri: https://github.com/domainic/domainic/tree/domainic-type-v0.1.0-alpha.3.0.2/domainic-type
+  changelog_uri: https://github.com/domainic/domainic/releases/tag/domainic-type-v0.1.0-alpha.3.1.0
+  homepage_uri: https://github.com/domainic/domainic/tree/domainic-type-v0.1.0-alpha.3.1.0/domainic-type
   rubygems_mfa_required: 'true'
-  source_code_uri: https://github.com/domainic/domainic/tree/domainic-type-v0.1.0-alpha.3.0.2/domainic-type
+  source_code_uri: https://github.com/domainic/domainic/tree/domainic-type-v0.1.0-alpha.3.1.0/domainic-type
 post_install_message:
 rdoc_options: []
 require_paths: