Merge pull request #184 from hlascelles/enforce-uppercase-env

Enforce uppercase ENV keys

Author: hlascelles

CHANGELOG.md

@@ -1,3 +1,8 @@
+## 2.0.0 (2025-04-12)
+
+BREAKING CHANGE:
+- Enforce uppercase ENV keys [#184](https://github.com/hlascelles/figjam/pull/184)
+
 ## 1.6.2 (2024-09-10)
 
 - Reduce override log level to info [#160](https://github.com/hlascelles/figjam/pull/160)

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    figjam (1.6.2)
+    figjam (2.0.0)
       thor (>= 0.14.0, < 2)
 
 GEM

README.md

@@ -7,7 +7,6 @@ figjam
 [![specs workflow](https://github.com/hlascelles/figjam/actions/workflows/specs.yml/badge.svg)](https://github.com/hlascelles/figjam/actions)
 [![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
 
-
 Figjam makes it easy to configure ruby and Rails apps `ENV` values by just using a single YAML file.
 
 PRs to applications often need to come with default configuration values, but hardcoding these into

lib/figjam/application.rb

@@ -3,6 +3,8 @@
 require "figjam/figaro_alias"
 
 module Figjam
+  class InvalidKeyNameError < StandardError; end
+
   # :reek:TooManyMethods
   class Application
     FIGARO_ENV_PREFIX = "_FIGARO_".freeze
@@ -40,7 +42,13 @@ def configuration
 
     def load
       each do |key, value|
-        skip?(key) ? key_skipped(key) : set(key, value)
+        if !valid_key_name?(key)
+          invalid_key_name(key)
+        elsif skip?(key)
+          key_skipped(key)
+        else
+          set(key, value)
+        end
       end
     end
 
@@ -110,5 +118,13 @@ def each(&block)
     private def key_skipped(key)
       puts "INFO: Skipping key #{key.inspect}. Already set in ENV."
     end
+
+    private def valid_key_name?(key)
+      key.to_s == key.to_s.upcase
+    end
+
+    private def invalid_key_name(key)
+      raise InvalidKeyNameError, "Environment variable names must be uppercase: #{key.inspect}"
+    end
   end
 end

lib/figjam/version.rb

@@ -1,3 +1,3 @@
 module Figjam
-  VERSION = "1.6.2".freeze
+  VERSION = "2.0.0".freeze
 end

spec/figjam/application_spec.rb

@@ -200,44 +200,66 @@ def yaml_to_path(yaml)
     let!(:application) { described_class.new }
 
     before do
-      allow(application).to receive(:configuration).and_return({ "foo" => "bar" })
+      # Update to use uppercase keys in the default configuration
+      allow(application).to receive(:configuration).and_return({ "FOO" => "bar" })
     end
 
     it "merges values into ENV" do
       expect {
         application.load
       }.to change {
-        ::ENV["foo"]
+        ::ENV["FOO"]
       }.from(nil).to("bar")
     end
 
     it "skips keys (and warns) that have already been set externally" do
-      ::ENV["foo"] = "baz"
+      ::ENV["FOO"] = "baz"
 
       expect(application)
-        .to receive(:puts).with('INFO: Skipping key "foo". Already set in ENV.')
+        .to receive(:puts).with('INFO: Skipping key "FOO". Already set in ENV.')
 
       expect {
         application.load
       }.not_to(
         change {
-          ::ENV["foo"]
+          ::ENV["FOO"]
         }
       )
     end
 
     it "sets keys that have already been set internally" do
       application.load
 
-      allow(application).to receive(:configuration).and_return({ "foo" => "baz" })
+      allow(application).to receive(:configuration).and_return({ "FOO" => "baz" })
 
       expect {
         application.load
       }.to change {
-        ::ENV["foo"]
+        ::ENV["FOO"]
       }.from("bar").to("baz")
     end
 
+    it "raises an error for keys that are not all uppercase" do
+      allow(application).to receive(:configuration).and_return({ "foo" => "bar",
+                                                                 "FOO_BAR" => "baz" })
+
+      expect {
+        application.load
+      }.to raise_error(Figjam::InvalidKeyNameError,
+                       'Environment variable names must be uppercase: "foo"')
+    end
+
+    it "accepts keys that are all uppercase" do
+      allow(application).to receive(:configuration).and_return({ "FOO" => "bar",
+                                                                 "BAR_BAZ" => "qux" })
+
+      expect {
+        application.load
+      }.to change {
+        [::ENV["FOO"], ::ENV["BAR_BAZ"]]
+      }.from([nil, nil]).to(%w[bar qux])
+    end
+
     shared_examples "correct warning with and without silence override" do
       [
         { FIGARO_SILENCE_STRING_WARNINGS: true },
@@ -286,19 +308,19 @@ def yaml_to_path(yaml)
     end
 
     context "when warning when a value isn't a string" do
-      let(:config) { { "string key" => :SYMBOL_VALUE } }
+      let(:config) { { "STRING_KEY" => :SYMBOL_VALUE } }
 
       include_examples "correct warning with and without silence override"
     end
 
     it "allows nil values" do
-      allow(application).to receive(:configuration).and_return({ "foo" => nil })
+      allow(application).to receive(:configuration).and_return({ "FOO" => nil })
 
       expect {
         application.load
       }.not_to(
         change {
-          ::ENV["foo"]
+          ::ENV["FOO"]
         }
       )
     end

spec/figjam/rails_spec.rb

@@ -44,11 +44,11 @@
 
   describe "initialization" do
     before do
-      write_file("config/application.yml", "foo: bar")
+      write_file("config/application.yml", "FOO: bar")
     end
 
     it "loads application.yml" do
-      run_command_and_stop("rails runner 'puts Figjam.env.foo'")
+      run_command_and_stop("rails runner 'puts Figjam.env.FOO'")
 
       expect(all_stdout).to include("bar")
     end
@@ -57,11 +57,11 @@
       write_file("config/database.yml", <<~STR)
         development:
           adapter: sqlite3
-          database: db/<%= ENV["foo"] %>.sqlite3
+          database: db/<%= ENV["FOO"] %>.sqlite3
 
         test:
           adapter: sqlite3
-          database: db/<%= ENV["foo"] %>.sqlite3
+          database: db/<%= ENV["FOO"] %>.sqlite3
       STR
 
       run_command_and_stop("rake db:migrate")
@@ -71,10 +71,10 @@
 
     it "happens before application configuration" do
       insert_into_file_after("config/application.rb", /< Rails::Application$/, <<-STR)
-    config.foo = ENV["foo"]
+    config.FOO = ENV["FOO"]
       STR
 
-      run_command_and_stop("rails runner 'puts Rails.application.config.foo'")
+      run_command_and_stop("rails runner 'puts Rails.application.config.FOO'")
 
       expect(all_stdout).to include("bar")
     end