easy_talk 3.1.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b091eaff6c33ddcc23f0c5d0147bf28f94a7421c95a0ca47ad917af8e42fad20
-  data.tar.gz: 9a6c0de5afff453a566940b7b1684e2075e70b53379b2bf3b7583a46ca370c58
+  metadata.gz: 3f11b7be6e0fa32087d5be57be3d3e37d5bd5b96cc61ae8626b33d41a420e401
+  data.tar.gz: 82ba98f220e8e75e3bb3e208a595a168f188c226a130e88f13991da9a386cfc6
 SHA512:
-  metadata.gz: 32a49bfa38a5279340b6699ff26d8ac415c1574f83da1488d403d422d4b49cd4aea94d5424d858c5ae2326e914c4e83995a97eb67fe4b005543e6f8984d6a60c
-  data.tar.gz: 02ad31d7b34aac67a4777a709ffb286487675f28e6a2c18757dd87e7a006743ab6cd0f75b817fdb6abb23d3f9ef63384fcbd5f063e1eb2d0dc8a06c7107ae0e0
+  metadata.gz: 90fb93ef486adb8151e883e6929437be2f52bdbe4a51bb45485006884a983b80ce9f10de1d14b313031be4b8126d6fe21c3bd54a998863543a1be1d752c124d9
+  data.tar.gz: 2ff9102ba57ae6738cb79511fdd095b5f798a760c009b10d2b5577c30575f04d94dfb11e410036e566971d92e27e2c4bc2d17336e44c64f9d35b966bbe1b4960

data/.rubocop.yml

@@ -1,7 +1,3 @@
-plugins:
-  - rubocop-rspec
-  - rubocop-rake
-
 AllCops:
   NewCops: enable
   TargetRubyVersion: 3.2
@@ -33,6 +29,8 @@ Style/StringLiterals:
 
 Metrics/ClassLength:
   Max: 240
+  Exclude:
+    - lib/easy_talk/validation_adapters/active_model_adapter.rb
 
 Metrics/MethodLength:
   Max: 60
@@ -55,6 +53,7 @@ Metrics/BlockNesting:
 Metrics/BlockLength:
   Exclude:
     - spec/**/*
+    - easy_talk.gemspec
 
 Layout/EndAlignment:
   Enabled: false
@@ -70,47 +69,24 @@ Lint/EmptyBlock:
   Exclude:
     - spec/**/*
 
-RSpec/DescribeClass:
-  Enabled: false
-
-RSpec/LeakyConstantDeclaration:
-  Enabled: false
-
-RSpec/RemoveConst:
-  Enabled: false
-
-RSpec/BeforeAfterAll:
-  Enabled: false
-
-RSpec/NestedGroups:
-  Max: 4
-
-RSpec/RepeatedDescription:
-  Enabled: false
-
-RSpec/PendingWithoutReason:
-  Enabled: false
-
-RSpec/MultipleDescribes:
+Lint/DuplicateBranch:
   Enabled: false
 
-RSpec/ContextWording:
+Gemspec/DevelopmentDependencies:
   Enabled: false
 
-RSpec/MultipleMemoizedHelpers:
-  Max: 10
-
-RSpec/ExampleLength:
-  Max: 40
-
-RSpec/MultipleExpectations:
-  Max: 10
+Naming/PredicateMethod:
+  Exclude:
+    - spec/support/schema_validation_matcher.rb
 
-RSpec/SpecFilePathFormat:
+Naming/BlockForwarding:
   Enabled: false
 
-Lint/DuplicateBranch:
-  Enabled: false
+Lint/UnusedMethodArgument:
+  AllowUnusedKeywordArguments: true
+  Exclude:
+    - lib/easy_talk/configuration.rb
+    - lib/easy_talk/schema_definition.rb
 
-Gemspec/DevelopmentDependencies:
+Style/DefWithParentheses:
   Enabled: false

data/.yardopts

@@ -0,0 +1,13 @@
+--readme README.md
+--title "EasyTalk API Documentation"
+--markup markdown
+--output-dir docs/api
+--protected
+--no-private
+--hide-void-return
+--embed-mixins
+lib/**/*.rb
+-
+README.md
+CHANGELOG.md
+CONSTRAINTS.md

data/CHANGELOG.md

@@ -1,3 +1,167 @@
+## [3.3.0] - 2026-01-12
+
+### Added
+
+- **Schema Objects in additionalProperties**: Extended `additionalProperties` to support type constraints and schema objects (#160)
+  - New syntax: `additional_properties Integer, minimum: 0, maximum: 100`
+  - Three supported forms: boolean, type class, or type with constraints
+  - Generates full JSON Schema for additional properties validation
+  - New methods: `ObjectBuilder#process_additional_properties`, `ObjectBuilder#build_additional_properties_schema`
+  - Fully backwards compatible with existing boolean usage
+
+- **External $ref Support via $id**: Enhanced schema referencing with external URI support (#158)
+  - New configuration options:
+    - `base_schema_uri` - Base URI for auto-generating $id values
+    - `auto_generate_ids` - Enable automatic $id generation (default: false)
+    - `prefer_external_refs` - Use external URI in $ref when model has $id (default: false)
+  - Three-level schema ID resolution: explicit per-model → auto-generated → global
+  - Dynamic $ref templates conditionally use external URIs or local `#/$defs/ModelName` format
+  - Supports composition types (T::OneOf, T::AnyOf, T::AllOf) with external refs
+
+- **T::Tuple Type for Positional Array Validation**: New tuple type for JSON Schema tuple support (#154, #155)
+  - New syntax: `property :coords, T::Tuple[Float, Float]`
+  - Generates JSON Schema with `items` as array of schemas
+  - Supports `additional_items: false`, `true`, or a type constraint
+  - Combines with array constraints: `min_items`, `max_items`, `unique_items`
+  - ActiveModel validation for runtime type checking at each position
+  - New files: `lib/easy_talk/types/tuple.rb`, `lib/easy_talk/builders/tuple_builder.rb`
+
+- **Object-Level JSON Schema Keywords**: Support for schema-wide object constraints (#148, #151)
+  - New keywords: `patternProperties`, `minProperties`, `maxProperties`, `dependencies`, `dependentRequired`
+  - ActiveModel validators for object-level constraints via `ActiveModelSchemaValidation` module
+  - Auto-defined `count_present_properties` private method on model classes
+  - Thread-safe validator application with double-checked locking
+
+### Changed
+
+- **Format Validation Enhancements**: Improved format validation accuracy and security (#157, #156, #144)
+  - **Scope Fix**: Format and pattern validations now only apply to string values (per JSON Schema spec)
+  - **URI/URL Validation**: Uses `URI.parse()` with `.absolute?` check instead of regex
+  - **Parsing-Based Validators**: Date, DateTime, and Time formats now use parsing instead of regex
+  - **Email Validation**: Replaced ReDoS-vulnerable regex with simple linear-time pattern
+  - New validation methods: `apply_uri_format_validation`, `apply_date_format_validation`, `apply_datetime_format_validation`, `apply_time_format_validation`
+
+- **JSON Schema Equality for uniqueItems**: Implements correct JSON Schema equality semantics for array uniqueness (#152)
+  - Objects with same keys/values in different order are equal
+  - Numbers are mathematically equal (1 == 1.0)
+  - Type matters for non-numbers (true != 1, false != 0)
+  - New module: `EasyTalk::JsonSchemaEquality` with `normalize()` and `duplicates?()` methods
+  - MAX_DEPTH = 100 limit to prevent SystemStackError on deeply nested structures
+
+- **Array Presence Validation**: Required array properties now properly reject nil values (#140)
+  - New method: `apply_array_presence_validation()` for array-specific nil checks
+  - Rejects nil but allows empty arrays `[]`
+  - Aligns with JSON Schema spec: 'optional' means property can be omitted, not that nil is accepted
+
+### Fixed
+
+- **Default Additional Properties Configuration**: Fixed `default_additional_properties` config option being ignored (#142)
+  - Both `ObjectBuilder` and `SchemaDefinition` now use configured default
+  - Added schema hash duplication to prevent mutation side effects
+
+- **Property Name Validation**: Fixed validation incorrectly applying to JSON output name (`:as` constraint) instead of Ruby property name (#143)
+  - `validate_property_name()` now validates Ruby name only
+  - Allows using `:as` for JSON-LD (@type, @id), JSON Schema ($id, $ref), and other special JSON keys
+
+- **Method Redefinition Warning**: Fixed "method redefined" warning for `:property` keyword (#153)
+  - Removed `:property` from `KEYWORDS` constant since it has dedicated implementation
+
+### Internal
+
+- **Type Introspection Improvements**: Enhanced type checking capabilities (#156)
+  - New helper methods: `array_type?()`, `boolean_union_type?()`, extracted `boolean_type?()`
+  - Improved encapsulation and testability
+
+- **ValidationContext Decoupling**: Refactored validation adapter internals (#150)
+  - New plain data class `ValidationContext` for pre-computed validation values
+  - Replaces `__send__` usage with direct value passing
+  - Improved encapsulation and testability
+
+- **Code Coverage Integration**: Added SimpleCov and Codecov for test coverage tracking
+  - Local HTML reports via SimpleCov
+  - CI badge reporting via Codecov
+  - Coverage uploads on Ruby 3.4.7 builds only
+
+- **Test Infrastructure**: Comprehensive test expansion (~1800 lines of new tests)
+  - New test files: `external_ref_spec.rb`, `additional_properties_schema_spec.rb`, `tuple_validation_spec.rb`, `json_schema_equality_spec.rb`
+  - Enhanced builder test coverage
+  - Improved JSON Schema compliance testing
+
+## [3.2.0] - 2025-12-28
+
+### Added
+
+- **Pluggable Validation Adapter System**: Complete overhaul of the validation layer to make it a distinct, pluggable component (#89)
+  - New `EasyTalk::ValidationAdapters::Base` abstract class defining the adapter interface
+  - New `EasyTalk::ValidationAdapters::Registry` for adapter registration and lookup
+  - New `EasyTalk::ValidationAdapters::ActiveModelAdapter` as the default adapter
+  - New `EasyTalk::ValidationAdapters::NoneAdapter` for schema-only use cases
+  - Per-model validation configuration: `define_schema(validations: false)`, `define_schema(validations: :none)`, or `define_schema(validations: CustomAdapter)`
+  - Per-property validation control with `validate: false` constraint
+  - Global configuration via `config.validation_adapter = :active_model`
+
+- **Schema-Only Module**: New `EasyTalk::Schema` module for schema generation without ActiveModel (#89)
+  - Does not include `ActiveModel::API` or `ActiveModel::Validations`
+  - Ideal for API documentation, OpenAPI specs, and schema-first design
+
+- **Pluggable Type Registry**: Runtime registration of custom types with their corresponding schema builders (#80)
+  - New `EasyTalk::Builders::Registry` class with `register`, `resolve`, `registered?`, `unregister`, `registered_types`, and `reset!` methods
+  - Added `EasyTalk.register_type` convenience method at module level
+  - Added `config.register_type` for configuration block registration
+  - Allows extending EasyTalk with custom types (e.g., Money, GeoPoint) without modifying gem source
+
+- **Robust Type Introspection**: New `TypeIntrospection` module replacing brittle string-based type detection (#83)
+  - Predicate methods: `boolean_type?`, `typed_array?`, `nilable_type?`, `primitive_type?`
+  - Helper methods: `json_schema_type`, `get_type_class`, `extract_inner_type`
+  - Uses Sorbet's type system properly instead of string pattern matching
+
+- **Standardized Validation Error Output**: Helper methods for API-friendly error formats (#88)
+  - **Flat format**: Simple array of field/message/code objects
+  - **JSON Pointer (RFC 6901)**: Paths like `/properties/name`
+  - **RFC 7807**: Problem Details for HTTP APIs
+  - **JSON:API**: Standard JSON:API error format
+  - Instance methods: `validation_errors(format:)`, `validation_errors_flat`, `validation_errors_json_pointer`, `validation_errors_rfc7807`, `validation_errors_jsonapi`
+  - Configuration options: `default_error_format`, `error_type_base_uri`, `include_error_codes`
+
+- **Naming Strategies**: Support for automatic property name transformation (#61)
+  - Built-in strategies: `CAMEL_CASE`, `SNAKE_CASE`
+  - Optional `as:` property constraint for per-property name override
+  - Per-schema configuration: `define_schema { naming_strategy :camel_case }`
+  - Global configuration: `config.naming_strategy = :camel_case`
+
+- **Array Composition Support**: `T::AnyOf`, `T::OneOf`, and `T::AllOf` now work with `T::Array` (#63)
+  - Example: `property :items, T::Array[T::OneOf[ProductA, ProductB]]`
+
+- **Nested Model Validation in Arrays**: Arrays of EasyTalk::Model objects are now recursively validated (#112)
+  - Hash items in arrays are auto-instantiated to model instances
+  - Errors from nested models are merged with indexed paths (e.g., `addresses[0].street`)
+
+### Changed
+
+- **Deprecated `EasyTalk::ValidationBuilder`**: Use `EasyTalk::ValidationAdapters::ActiveModelAdapter` instead (deprecation warning shown on first use)
+
+### Fixed
+
+- **Default Value Assignment**: Default values are now properly assigned during initialization (#72)
+- **Explicit Nil Preservation**: Explicitly passed `nil` values are preserved instead of being replaced with defaults (#79)
+- **Optional Enum Validation**: Allow `nil` for optional properties with enum constraints (#64)
+- **Optional Pattern Validation**: Allow `nil` for optional properties with pattern validation (#65)
+- **Optional Format Validation**: Allow `nil` for optional properties with format validation (email, uri, uuid, etc.) (#75)
+- **Optional Length Validation**: Allow `nil` for optional properties with length constraints (#76)
+- **Schema Definition Mutation**: Avoid mutating schema definition during property building (#95)
+- **Unknown Property Types**: Fail fast with `UnknownPropertyTypeError` instead of silently returning 'object' (#97)
+- **respond_to_missing?**: Fixed `respond_to_missing?` implementation for additional properties (#98)
+- **VALID_OPTIONS Mutation**: Avoid mutating `VALID_OPTIONS` constant in TypedArrayBuilder (#99)
+- **Registry Reset**: `ValidationAdapters::Registry.reset!` now repopulates defaults (#100)
+- **FunctionBuilder Error**: Replace deprecated Instructor error with `EasyTalk::UnsupportedTypeError` (#96)
+- **Missing snake_case Strategy**: Added `SNAKE_CASE` constant to NamingStrategies module (#77)
+
+### Internal
+
+- Extracted shared schema methods into `SchemaMethods` mixin for code reuse between `Model` and `Schema` modules (#103)
+- Centralized built-in type registration in `Builders::Registry` (#102)
+- Added json_schemer for systematic validation testing with custom RSpec matchers
+
 ## [3.1.0] - 2025-12-18
 
 ### Added