hash_validator 1.2.0 → 2.0.0

data/spec/validators/user_defined_spec.rb

@@ -11,7 +11,7 @@ describe 'User-defined validator' do
 
         def validate(key, value, validations, errors)
           unless value.is_a?(Integer) && value.odd?
-            errors[key] = presence_error_message
+            errors[key] = error_message
           end
         end
       end
@@ -72,7 +72,7 @@ describe 'User-defined validator' do
   end
 
   describe 'Integrating with the entire validation system' do
-    before { HashValidator.append_validator(validator) rescue nil }  # rescue to prevent: validators need to have unique names
+    before { HashValidator.add_validator(validator) rescue nil }  # rescue to prevent: validators need to have unique names
 
     it 'can be looked up using #validator_for' do
       expect(HashValidator.validator_for('odd')).to be_a_kind_of(HashValidator::Validator::OddValidator)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hash_validator
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 2.0.0
 platform: ruby
 authors:
 - James Brooks
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-08-20 00:00:00.000000000 Z
+date: 2025-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -65,12 +65,12 @@ files:
 - ".ruby-version"
 - Gemfile
 - LICENSE.txt
-- Plan.md
 - README.md
 - Rakefile
 - hash_validator.gemspec
 - lib/hash_validator.rb
 - lib/hash_validator/base.rb
+- lib/hash_validator/configuration.rb
 - lib/hash_validator/validations.rb
 - lib/hash_validator/validations/many.rb
 - lib/hash_validator/validations/multiple.rb
@@ -83,10 +83,15 @@ files:
 - lib/hash_validator/validators/boolean_validator.rb
 - lib/hash_validator/validators/class_validator.rb
 - lib/hash_validator/validators/digits_validator.rb
+- lib/hash_validator/validators/dynamic_func_validator.rb
+- lib/hash_validator/validators/dynamic_pattern_validator.rb
 - lib/hash_validator/validators/email_validator.rb
 - lib/hash_validator/validators/enumerable_validator.rb
 - lib/hash_validator/validators/hash_validator.rb
 - lib/hash_validator/validators/hex_color_validator.rb
+- lib/hash_validator/validators/ip_validator.rb
+- lib/hash_validator/validators/ipv4_validator.rb
+- lib/hash_validator/validators/ipv6_validator.rb
 - lib/hash_validator/validators/json_validator.rb
 - lib/hash_validator/validators/lambda_validator.rb
 - lib/hash_validator/validators/many_validator.rb
@@ -98,6 +103,7 @@ files:
 - lib/hash_validator/validators/simple_validator.rb
 - lib/hash_validator/validators/url_validator.rb
 - lib/hash_validator/version.rb
+- spec/configuration_spec.rb
 - spec/hash_validator_spec.rb
 - spec/hash_validator_spec_helper.rb
 - spec/spec_helper.rb
@@ -108,10 +114,15 @@ files:
 - spec/validators/boolean_spec.rb
 - spec/validators/class_spec.rb
 - spec/validators/digits_validator_spec.rb
+- spec/validators/dynamic_func_validator_spec.rb
+- spec/validators/dynamic_pattern_validator_spec.rb
 - spec/validators/email_spec.rb
 - spec/validators/hash_validator_spec.rb
 - spec/validators/hex_color_validator_spec.rb
 - spec/validators/in_enumerable_spec.rb
+- spec/validators/ip_validator_spec.rb
+- spec/validators/ipv4_validator_spec.rb
+- spec/validators/ipv6_validator_spec.rb
 - spec/validators/json_validator_spec.rb
 - spec/validators/lambda_spec.rb
 - spec/validators/many_spec.rb
@@ -147,6 +158,7 @@ signing_key:
 specification_version: 4
 summary: Ruby library to validate hashes (Hash) against user-defined requirements
 test_files:
+- spec/configuration_spec.rb
 - spec/hash_validator_spec.rb
 - spec/hash_validator_spec_helper.rb
 - spec/spec_helper.rb
@@ -157,10 +169,15 @@ test_files:
 - spec/validators/boolean_spec.rb
 - spec/validators/class_spec.rb
 - spec/validators/digits_validator_spec.rb
+- spec/validators/dynamic_func_validator_spec.rb
+- spec/validators/dynamic_pattern_validator_spec.rb
 - spec/validators/email_spec.rb
 - spec/validators/hash_validator_spec.rb
 - spec/validators/hex_color_validator_spec.rb
 - spec/validators/in_enumerable_spec.rb
+- spec/validators/ip_validator_spec.rb
+- spec/validators/ipv4_validator_spec.rb
+- spec/validators/ipv6_validator_spec.rb
 - spec/validators/json_validator_spec.rb
 - spec/validators/lambda_spec.rb
 - spec/validators/many_spec.rb

data/Plan.md

@@ -1,309 +0,0 @@
-# Hash Validator Enhancement Plan - Living Document
-
-## Document Instructions
-**This is a living plan document.** It should be updated throughout the implementation process to track:
-- Current progress and completion status
-- Any deviations or improvements discovered during implementation
-- Lessons learned that may benefit subsequent phases
-- Test results and quality check outcomes
-
-**Update Protocol:**
-1. Mark tasks as `[x]` when completed
-2. Add notes in **Implementation Notes** sections for important discoveries
-3. Update status indicators for each phase
-4. Document any blockers or changes in approach
-
-## Overall Objective
-Add 11 new validators to the hash_validator gem to expand its validation capabilities for common use cases.
-
-## Phase Structure
-Between each major phase:
-1. Run full test suite: `rake spec`
-2. Verify no breaking changes to existing functionality
-3. Provide summary to user
-4. Request approval before proceeding to next phase
-
----
-
-## Phase 1: Simple String Pattern Validators
-**Status:** [ ] Not Started | [ ] In Progress | [x] Completed
-**Validators:** URL, JSON, Hex Color, Alphanumeric, Alpha, Digits
-
-### Tasks:
-- [x] Create URL validator (`lib/hash_validator/validators/url_validator.rb`)
-  - Validation: Use `URI.parse` and check for valid scheme
-  - Error message: "is not a valid URL"
-  - Accept: http, https, ftp schemes
-  
-- [x] Create JSON validator (`lib/hash_validator/validators/json_validator.rb`)
-  - Validation: `JSON.parse(value)` with rescue
-  - Error message: "is not valid JSON"
-  - Must be string type first
-  
-- [x] Create Hex Color validator (`lib/hash_validator/validators/hex_color_validator.rb`)
-  - Validation: Regex `/\A#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})\z/`
-  - Error message: "is not a valid hex color"
-  - Accept: #RGB and #RRGGBB formats
-  
-- [x] Create Alphanumeric validator (`lib/hash_validator/validators/alphanumeric_validator.rb`)
-  - Validation: Regex `/\A[a-zA-Z0-9]+\z/`
-  - Error message: "must contain only letters and numbers"
-  
-- [x] Create Alpha validator (`lib/hash_validator/validators/alpha_validator.rb`)
-  - Validation: Regex `/\A[a-zA-Z]+\z/`
-  - Error message: "must contain only letters"
-  
-- [x] Create Digits validator (`lib/hash_validator/validators/digits_validator.rb`)
-  - Validation: Regex `/\A\d+\z/`
-  - Error message: "must contain only digits"
-
-### Tests:
-- [x] Write specs for each validator in `spec/validators/[validator_name]_spec.rb`
-- [x] Test valid inputs, invalid inputs, nil values, wrong types
-- [x] Run test suite and ensure all pass
-
-### Registration:
-- [x] Add requires to `lib/hash_validator/validators.rb`
-- [x] Ensure validators auto-register via `HashValidator.append_validator`
-
-**Implementation Notes:**
-- **Ruby Version Updated:** Changed minimum Ruby requirement from 2.0.0 to 3.0.0 in gemspec
-- **URI Library:** Confirmed URI standard library is available in Ruby 3.0+ and works perfectly for URL validation
-- **JSON Library:** Confirmed JSON standard library is available in Ruby 3.0+ and works perfectly for JSON validation
-- **All Tests Pass:** 74 new tests added (70 validator tests + 4 Rails integration tests), all passing (451 total)
-- **Regex Patterns:** All regex patterns use `\A` and `\z` anchors for exact string matching
-- **Error Messages:** Follow established pattern ("is not a valid [type]" vs "must contain only [constraint]")
-- **Performance:** All validators use simple regex patterns for optimal performance
-- **Rails Integration:** Added ActionController::Parameters support - no more need for `.to_unsafe_h`
-- **README Updated:** Comprehensive table format with validation configs and example payloads, Rails controller example
-- **Documentation:** Added Requirements section, Quick Start, better Examples section structure
-
----
-
-## Additional Improvements (Beyond Original Plan)
-**Status:** [x] Completed
-**Description:** Enhancements made during Phase 1 implementation
-
-### Rails Integration Enhancement:
-- [x] **ActionController::Parameters Support**: Modified hash validator to automatically detect and handle Rails params
-- [x] **Seamless Conversion**: Internally calls `.to_unsafe_h` when `ActionController::Parameters` detected
-- [x] **Backward Compatibility**: Regular Hash validation continues to work unchanged
-- [x] **Integration Tests**: Added 4 comprehensive tests for Rails params support
-
-### Documentation Improvements:
-- [x] **README Restructuring**: Better flow from Installation → Quick Start → Examples → Usage Table → Advanced Features
-- [x] **Usage Table Enhancement**: Three-column table with Validator, Configuration, and Example Payload
-- [x] **Rails Controller Example**: Practical example showing API parameter validation
-- [x] **Requirements Section**: Added Ruby 3.0+ requirement documentation
-- [x] **Quick Start Guide**: Simple 4-line example to get users started immediately
-
-### Quality Improvements:
-- [x] **Test Coverage**: Increased from 447 to 451 total tests
-- [x] **Error Handling**: Verified all new validators provide clear, consistent error messages
-- [x] **Performance**: All new validators use efficient regex patterns
-- [x] **Integration**: Full compatibility testing with existing codebase
-
-**Implementation Notes:**
-- **Rails Support**: Uses `defined?(ActionController::Parameters)` for safe detection without requiring Rails
-- **User Experience**: Rails developers can now use `HashValidator.validate(params, validations)` directly
-- **Maintenance**: No breaking changes introduced, all existing APIs remain unchanged
-
----
-
-## Phase 2: IP Address Validators
-**Status:** [ ] Not Started | [ ] In Progress | [ ] Completed
-**Validators:** IP (generic), IPv4, IPv6
-
-### Tasks:
-- [ ] Create IPv4 validator (`lib/hash_validator/validators/ipv4_validator.rb`)
-  - Validation: Check 4 octets, each 0-255
-  - Regex: `/\A(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\z/`
-  - Error message: "is not a valid IPv4 address"
-  
-- [ ] Create IPv6 validator (`lib/hash_validator/validators/ipv6_validator.rb`)
-  - Validation: Standard IPv6 format including compressed notation
-  - Consider using `IPAddr` class for validation
-  - Error message: "is not a valid IPv6 address"
-  
-- [ ] Create IP validator (`lib/hash_validator/validators/ip_validator.rb`)
-  - Validation: Accept either IPv4 or IPv6
-  - Can leverage IPv4 and IPv6 validators
-  - Error message: "is not a valid IP address"
-
-### Tests:
-- [ ] Test standard IPv4 addresses (192.168.1.1)
-- [ ] Test IPv6 addresses (standard and compressed)
-- [ ] Test edge cases (0.0.0.0, 255.255.255.255, ::1)
-- [ ] Test invalid formats
-
-### Registration:
-- [ ] Add requires to `lib/hash_validator/validators.rb`
-
-**Implementation Notes:**
-<!-- Add discoveries and changes here during implementation -->
-
----
-
-## Phase 3: Parameterized Validators - Length
-**Status:** [ ] Not Started | [ ] In Progress | [ ] Completed
-**Validators:** Length with min/max/exactly options
-
-### Tasks:
-- [ ] Create Length validation class (`lib/hash_validator/validations/length.rb`)
-  - Similar structure to `Optional`, `Many`, `Multiple` classes
-  - Store min, max, exactly options
-  
-- [ ] Create Length validator (`lib/hash_validator/validators/length_validator.rb`)
-  - Handle strings, arrays, hashes
-  - Support options: `min`, `max`, `exactly`
-  - Dynamic error messages based on constraints
-  
-- [ ] Add factory method to `lib/hash_validator.rb`:
-  ```ruby
-  def self.length(options)
-    Validations::Length.new(options)
-  end
-  ```
-
-### Usage Examples:
-```ruby
-HashValidator.length(min: 5, max: 10)
-HashValidator.length(exactly: 8)
-HashValidator.length(min: 5)
-```
-
-### Tests:
-- [ ] Test all option combinations
-- [ ] Test with strings, arrays, hashes
-- [ ] Test boundary conditions
-- [ ] Test invalid option combinations
-
-**Implementation Notes:**
-<!-- Add discoveries and changes here during implementation -->
-
----
-
-## Phase 4: Parameterized Validators - Numeric Ranges
-**Status:** [ ] Not Started | [ ] In Progress | [ ] Completed
-**Validators:** Between, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual
-
-### Tasks:
-- [ ] Create Range validation classes in `lib/hash_validator/validations/`:
-  - `between.rb` - Between two values (inclusive)
-  - `greater_than.rb` - Greater than value
-  - `less_than.rb` - Less than value
-  - `greater_than_or_equal.rb` - Greater than or equal
-  - `less_than_or_equal.rb` - Less than or equal
-  
-- [ ] Create corresponding validators in `lib/hash_validator/validators/`
-  
-- [ ] Add factory methods to `lib/hash_validator.rb`:
-  ```ruby
-  def self.between(min, max)
-    Validations::Between.new(min, max)
-  end
-  
-  def self.greater_than(value)
-    Validations::GreaterThan.new(value)
-  end
-  # ... etc
-  ```
-
-### Usage Examples:
-```ruby
-HashValidator.between(1, 100)
-HashValidator.greater_than(0)
-HashValidator.less_than_or_equal(100)
-```
-
-### Tests:
-- [ ] Test numeric types (Integer, Float, Rational)
-- [ ] Test boundary values
-- [ ] Test with non-numeric types
-- [ ] Test with nil
-
-**Implementation Notes:**
-<!-- Add discoveries and changes here during implementation -->
-
----
-
-## Phase 5: Documentation and Final Testing
-**Status:** [ ] Not Started | [ ] In Progress | [ ] Completed
-
-### Tasks:
-- [ ] Update README.md with all new validators
-  - Add to simple types list
-  - Add to "Additional validations" section
-  - Provide usage examples for each
-  
-- [ ] Update CLAUDE.md if needed
-  
-- [ ] Run full test suite
-  
-- [ ] Check for any performance impacts
-  
-- [ ] Verify backward compatibility
-
-### Documentation Sections to Update:
-- [ ] Usage section - add new simple validators
-- [ ] Additional validations - add parameterized validators
-- [ ] Examples section - comprehensive examples
-
-**Implementation Notes:**
-<!-- Add discoveries and changes here during implementation -->
-
----
-
-## Quality Checklist (Run after each phase)
-- [ ] All new tests pass
-- [ ] All existing tests still pass
-- [ ] No rubocop/style violations (if configured)
-- [ ] Documentation is updated
-- [ ] Code follows existing patterns
-
-## Technical Decisions & Rationale
-
-### Pattern Consistency
-All validators follow the existing pattern:
-1. Inherit from `HashValidator::Validator::Base`
-2. Initialize with validator name
-3. Implement `validate` method
-4. Auto-register using `HashValidator.append_validator`
-
-### Error Message Style
-Consistent with existing validators:
-- Simple validators: "is not a valid [type]"
-- Constraint validators: "must be [constraint]"
-- Type validators: "[type] required"
-
-### Validation Approach
-- **URL**: Use Ruby's built-in `URI.parse` for robustness
-- **IP Addresses**: Regex for IPv4, consider `IPAddr` for IPv6
-- **JSON**: Use `JSON.parse` with exception handling
-- **Patterns**: Simple regex patterns for performance
-
-### File Organization
-- Simple validators: `lib/hash_validator/validators/[name]_validator.rb`
-- Parameterized validations: `lib/hash_validator/validations/[name].rb`
-- Tests mirror structure: `spec/validators/[name]_spec.rb`
-
-## Notes for Future Sessions
-When resuming work on this plan:
-1. Check this document's status indicators
-2. Review Implementation Notes for each completed phase
-3. Run test suite to verify current state
-4. Continue from the next uncompleted task
-
-## Completion Criteria
-- [x] Phase 1: All 6 string pattern validators implemented and tested
-- [ ] Phase 2: All 3 IP address validators implemented and tested  
-- [ ] Phase 3: Length validator implemented and tested
-- [ ] Phase 4: All 5 numeric range validators implemented and tested
-- [x] README fully updated with new validators and Rails integration
-- [x] All tests passing (451/451)
-- [x] Rails ActionController::Parameters support added
-- [x] Ruby 3.0+ minimum version requirement updated
-- [ ] Gem builds successfully
-- [ ] Version bump considered
-
-**Progress: Phase 1 Complete (6/11 validators) + Major Rails Integration Enhancement**