Merge pull request #231 from hlascelles/switch-to-figjam-debug

Change debug lines to opt in with FIGJAM_DEBUG=true

Author: hlascelles

CHANGELOG.md

@@ -1,3 +1,8 @@
+## 3.0.0 (2025-09-01)
+
+⚠️ Breaking (debug) change
+- Change debug lines to opt in with FIGJAM_DEBUG=true [#231](https://github.com/hlascelles/figjam/pull/231)
+
 ## 2.2.1 (2025-07-17)
 
 - Add require in engine helper [#225](https://github.com/hlascelles/figjam/pull/225)

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    figjam (2.2.1)
+    figjam (3.0.0)
       thor (>= 0.14.0, < 2)
 
 GEM
@@ -94,6 +94,7 @@ GEM
     bigdecimal (3.2.2)
     builder (3.3.0)
     byebug (12.0.0)
+    climate_control (1.2.0)
     coderay (1.1.3)
     combustion (1.5.0)
       activesupport (>= 3.0.0)
@@ -357,6 +358,7 @@ DEPENDENCIES
   aruba
   base64
   bundler
+  climate_control
   combustion
   fasterer
   figjam!

README.md

@@ -131,7 +131,7 @@ Note, secrets are not to be provided by figjam, so do not add them to your `appl
 
 Deeply nested configuration structures are not possible.
 
-## Silencing type conversion warnings
+## Debugging Figjam
 
 Remember that `ENV` in ruby is a simple key/value store. All values will always be strings.
 This means that the following code will produce string values:
@@ -142,21 +142,18 @@ SOME_BOOLEAN: true
 ```
 
 ```ruby
-# WARNING: Use strings for Figjam configuration. 3 was converted to "3"
-# WARNING: Use strings for Figjam configuration. true was converted to "true"
-
 ENV["SOME_NUMBER"] == 3 # => false
 ENV["SOME_NUMBER"] == "3" # => true
 ENV["SOME_BOOLEAN"] == true # => false
 ENV["SOME_BOOLEAN"] == "true" # => true
 ```
 
-Because this is a possible cause of sleeper bugs, Figjam emits a warning when it does this
-conversion to a string. If you are confident in your abilities, you can silence it by adding this
-to the top of your `application.yml`:
+If you are unsure about how figjam is loading your configuration, you can enable warnings
+about type conversion and pre-existing ENV by setting the `FIGJAM_DEBUG` environment variable
+to `true`.
 
 ```yaml
-FIGJAM_SILENCE_STRING_WARNINGS: true
+FIGJAM_DEBUG: true
 ```
 
 ### Using `Figjam.env`

figjam.gemspec

@@ -29,6 +29,7 @@ Gem::Specification.new do |spec|
   # Ruby 3.4 needs this gem for specs, otherwise we see "cannot load such file -- base64"
   spec.add_development_dependency "base64"
   spec.add_development_dependency "bundler"
+  spec.add_development_dependency "climate_control"
   spec.add_development_dependency "combustion"
   spec.add_development_dependency "fasterer"
   # Ruby 3.4 needs this gem for specs, otherwise we see "cannot load such file -- mutex_m"