philiprehberger-env_validator 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb9d6d9b1aeee1b8eb35392807aec880212627edbcbb426c8108e1056824dc07
-  data.tar.gz: 0366aba96e46ec24ba6a769b4ba17271d29fa89ccf24bc99ca08a528e056d845
+  metadata.gz: a0780e54abe494b5db8736bc9d785d1cc9383b34e41c8f3029e0a33b15f213d9
+  data.tar.gz: 06e4e7b33320265595ca48fb0ca1d4d71ab5ba978b8b75abd52d622c97e074eb
 SHA512:
-  metadata.gz: 176cf272fcecb3fbb9e88acd9d11daaf509751265ef6eab0f4c7fddeb45c16550984525a48eb8f7e7711ba8b776bd7c34934da2c3c011c789d69970342aae6d1
-  data.tar.gz: 266c6471e7c5d11e0933edce3f639add0bf0a0252c8ab43253af0e5eae6652cc03018edcfd1b7540b7954a3a11b4c5626509741538cded0dcba97008253fd043
+  metadata.gz: e2d37adc96b99600d61bc346fb08439cb02a5288930f7241e8f5106fd1093d4c87dc620271fd1aa79991a938e8b78eac1b703bf0987c7b929fde313bbef8dfd1
+  data.tar.gz: e3df0449a752f36558aef1e80e5fdac3399129c697bee96e4d52c4214cf52147ffe5c7b54030bde138c0e6ff83b5a1189454dbf5fae63331215e8ec768eddb1f

data/CHANGELOG.md

@@ -7,6 +7,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.6.0] - 2026-06-14
+
+### Added
+- `Result#freeze!` — deeply freezes the underlying values hash and string values, then returns `self`. Lets callers safely treat a validated `Result` as an immutable global/shared config after boot.
+
+## [0.5.0] - 2026-04-26
+
+### Added
+- `Result#to_h(exclude:)` accepts a list of symbol or string keys to omit from the returned hash, useful for redacting sensitive values during serialization
+
 ## [0.4.0] - 2026-04-16
 
 ### Added

data/README.md

@@ -4,6 +4,8 @@
 [![Gem Version](https://badge.fury.io/rb/philiprehberger-env_validator.svg)](https://rubygems.org/gems/philiprehberger-env_validator)
 [![Last updated](https://img.shields.io/github/last-commit/philiprehberger/rb-env-validator)](https://github.com/philiprehberger/rb-env-validator/commits/main)
 
+![philiprehberger-env_validator](https://raw.githubusercontent.com/philiprehberger/rb-env-validator/main/package-card.webp)
+
 Schema-based environment variable validation with typed accessors
 
 ## Requirements
@@ -80,8 +82,15 @@ end
 config.keys            # => ["PORT", "HOST"]
 config.key?(:PORT)     # => true
 config.slice(:PORT)    # => { "PORT" => 3000 }
+config.to_h            # => { "PORT" => 3000, "HOST" => "localhost" }
+
+# Redact sensitive keys when serializing (e.g. for logs)
+config.to_h(exclude: %i[api_key])
+# => { "PORT" => 3000, "HOST" => "localhost" }
 ```
 
+The `exclude:` list accepts symbols or strings and is matched against keys regardless of how they are stored internally.
+
 ### Prefix
 
 Group related variables with a shared prefix:
@@ -147,6 +156,18 @@ Each element is stripped of surrounding whitespace and cast to `item_type`. An e
 | Boolean | `boolean` | `true/false/1/0/yes/no/on/off` (case-insensitive) |
 | Array | `array` | Delimited string cast to a list of typed elements |
 
+### Immutable Configs
+
+Once validated at boot time, prevent accidental mutation of the result:
+
+```ruby
+ENV_CONFIG = Philiprehberger::EnvValidator.define do
+  string :api_key
+end.freeze!
+
+ENV_CONFIG.fetch(:api_key) << 'tamper'  # => FrozenError
+```
+
 ## API
 
 | Method / Class | Description |
@@ -157,7 +178,8 @@ Each element is stripped of surrounding whitespace and cast to `item_type`. An e
 | `Result#keys` | List all defined variable names |
 | `Result#key?(name)` | Check if a variable was defined |
 | `Result#slice(*names)` | Get a subset hash of specific keys |
-| `Result#to_h` | Get all values as a hash |
+| `Result#to_h(exclude:)` | Get all values as a hash; pass `exclude:` to omit keys (symbols or strings) |
+| `Result#freeze!` | Deeply freeze the result; returns self for chaining |
 
 ## Development
 

data/lib/philiprehberger/env_validator/result.rb

@@ -45,9 +45,28 @@ module Philiprehberger
         @values.slice(*string_keys)
       end
 
-      # @return [Hash<String, Object>] all validated values
-      def to_h
-        @values.dup
+      # Return all validated values as a hash, optionally redacting keys.
+      #
+      # @param exclude [Array<Symbol, String>] keys to omit from the returned hash
+      # @return [Hash<String, Object>] all validated values, minus excluded keys
+      def to_h(exclude: [])
+        return @values.dup if exclude.nil? || exclude.empty?
+
+        excluded_keys = exclude.map(&:to_s)
+        @values.reject { |key, _| excluded_keys.include?(key.to_s) }
+      end
+
+      # Deeply freeze the result so it cannot be mutated after validation.
+      #
+      # Freezes the underlying values hash, all string keys, and any String
+      # values it holds. Useful for global/shared ENV configs that should be
+      # immutable after boot.
+      #
+      # @return [Result] self
+      def freeze!
+        @values.each_value { |v| v.freeze if v.is_a?(String) && !v.frozen? }
+        @values.freeze
+        self
       end
     end
   end

data/lib/philiprehberger/env_validator/version.rb

@@ -2,6 +2,6 @@
 
 module Philiprehberger
   module EnvValidator
-    VERSION = '0.4.0'
+    VERSION = '0.6.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: philiprehberger-env_validator
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Philip Rehberger
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-04-16 00:00:00.000000000 Z
+date: 2026-06-15 00:00:00.000000000 Z
 dependencies: []
 description: Define environment variable schemas with type casting, required/optional
   flags, and defaults. Validates at boot time and provides typed accessors.