rspec-stubbed_env 1.0.1 → 1.0.2

data/lib/rspec/stubbed_env/config.rb

@@ -15,7 +15,51 @@
 #   end
 # end
 #
+# Alternative usage:
+#
+# describe 'another stubbed test' do
+#   include_context 'with stubbed env', 'FOO' => 'is_bar'
+#   it 'also does a thing' do
+#     expect(ENV['FOO']).to eq('is bar')
+#   end
+# end
+RSpec.shared_context("with stubbed env") do |args|
+  include RSpec::StubbedEnv::StubHelpers
+
+  # TODO: Switch `length > 0` => `any?` after Ruby 1.8 support is dropped
+  if args.is_a?(Hash) && args.keys.length > 0
+    before { stub_env(args) }
+  end
+end
+
+#
+# ENV hiding is opt-in, via a shared context, rather than global
+#
+# Usage:
+#
+# describe 'my hidden test' do
+#   include_context 'with hidden env'
+#   before do
+#     hide_env('FOO', 'BAR')
+#   end
+#   it 'does a thing' do
+#     expect(ENV['FOO']).to be_nil
+#   end
+# end
+#
+# Alternative usage:
+#
+# describe 'another stubbed test' do
+#   include_context 'with stubbed env', 'FOO', 'BAR'
+#   it 'also does a thing' do
+#     expect(ENV['BAR']).to be_nil
+#   end
+# end
+RSpec.shared_context("with hidden env") do |*args|
+  include RSpec::StubbedEnv::HideHelpers
 
-RSpec.shared_context("with stubbed env") do
-  include RSpec::StubbedEnv::TestHelpers
+  # TODO: Switch `length > 0` => `any?` after Ruby 1.8 support is dropped
+  if args.is_a?(Array) && args.length > 0
+    before { hide_env(*args) }
+  end
 end

data/lib/rspec/stubbed_env/hide_helpers.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require "rspec/stubbed_env/stub_helpers"
+
+#
+# ENV hiding is opt-in, via a shared context, rather than global
+#
+# Usage:
+#
+# describe 'my hidden ENV test' do
+#   include_context 'with hidden env'
+#   before do
+#     ENV["FOO"] = "is bar"
+#     hide_env('FOO')
+#   end
+#   it 'is nil' do
+#     expect(ENV['FOO']).to be_nil
+#   end
+#   it 'raises KeyError on fetch' do
+#     expect { ENV.fetch('FOO') }.to raise_error(KeyError)
+#   end
+# end
+
+module RSpec
+  module StubbedEnv
+    # Helpers to unobtrusively stub ENV
+    module HideHelpers
+      include StubHelpers
+
+      # Can be called with an array of ENV keys to hide:
+      #
+      #     hide_env('FOO', 'BAR', 'BAZ') # Preferred
+      #
+      # Alternatively can be called once per ENV key to hide:
+      #
+      #     stub_env('A') # NOT
+      #     stub_env('C') # AS
+      #     stub_env('E') # GOOD (creates redundant stubs on values_at)
+      def hide_env(*keys)
+        init_stub unless env_stubbed?
+        keys.each do |key|
+          add_hidden_key(key)
+        end
+      end
+
+      private
+
+      def add_hidden_key(key)
+        key = key.to_s # Support symbols by forcing to string
+        hide_brackets(key)
+        hide_fetch(key)
+        hide_values_at
+      end
+
+      def hide_brackets(key)
+        allow(ENV).to(receive(:[]).with(key).and_return(nil))
+      end
+
+      def hide_fetch(key)
+        allow(ENV).to(receive(:fetch).with(key)) do |_|
+          raise KeyError, "key not found: \"#{key}\""
+        end
+        allow(ENV).to(receive(:fetch).with(key, anything)) do |_, default_val|
+          default_val
+        end
+      end
+
+      # Rides on the fetch hider!
+      def hide_values_at
+        allow(ENV).to(receive(:values_at)) do |*args|
+          args.map { |arg| ENV.fetch(arg, nil) }
+        end
+      end
+    end
+  end
+end

data/lib/rspec/stubbed_env/{test_helpers.rb → stub_helpers.rb}

@@ -27,16 +27,16 @@
 module RSpec
   module StubbedEnv
     # Helpers to unobtrusively stub ENV
-    module TestHelpers
+    module StubHelpers
       # Can be called with all key value pairs to be stubbed as a hash:
       #
-      #     stub_env('A' => 'B', 'C' => 'D', 'E' => 'F')
+      #     stub_env('A' => 'B', 'C' => 'D', 'E' => 'F') # Preferred
       #
       # Alternatively can be called one per ENV key-value pair to stub:
       #
-      #     stub_env('A', 'B')
-      #     stub_env('C', 'D')
-      #     stub_env('E', 'F')
+      #     stub_env('A', 'B') # NOT
+      #     stub_env('C', 'D') # AS
+      #     stub_env('E', 'F') # GOOD (Creates redundant stubs on values_at)
       def stub_env(key_or_hash, value = nil)
         init_stub unless env_stubbed?
         if key_or_hash.is_a?(Hash)

data/lib/rspec/stubbed_env/version.rb

@@ -2,6 +2,6 @@
 
 module RSpec
   module StubbedEnv
-    VERSION = "1.0.1"
+    VERSION = "1.0.2"
   end
 end

data/lib/rspec/stubbed_env.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require "rspec/stubbed_env/version"
-
 # This Gem
-require "rspec/stubbed_env/test_helpers"
+require "rspec/stubbed_env/version"
+require "rspec/stubbed_env/hide_helpers"
+require "rspec/stubbed_env/stub_helpers"
 require "rspec/stubbed_env/config"
 
 #
@@ -19,6 +19,15 @@ require "rspec/stubbed_env/config"
 #   end
 # end
 #
+# describe 'my hidden test' do
+#   include_context 'with hidden env'
+#   before do
+#     hide_env('FOO')
+#   end
+#   it 'does a thing' do
+#     expect(ENV['FOO']).to be_nil
+#   end
+# end
 module RSpec
   # Gem Namespace
   module StubbedEnv

metadata

@@ -1,50 +1,89 @@
 --- !ruby/object:Gem::Specification
 name: rspec-stubbed_env
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Liam Bennett
 - Peter Boling
-autorequire:
 bindir: exe
 cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
   MIIEgDCCAuigAwIBAgIBATANBgkqhkiG9w0BAQsFADBDMRUwEwYDVQQDDAxwZXRl
   ci5ib2xpbmcxFTATBgoJkiaJk/IsZAEZFgVnbWFpbDETMBEGCgmSJomT8ixkARkW
-  A2NvbTAeFw0yMjA5MTgyMzEyMzBaFw0yMzA5MTgyMzEyMzBaMEMxFTATBgNVBAMM
+  A2NvbTAeFw0yNTA1MDQxNTMzMDlaFw00NTA0MjkxNTMzMDlaMEMxFTATBgNVBAMM
   DHBldGVyLmJvbGluZzEVMBMGCgmSJomT8ixkARkWBWdtYWlsMRMwEQYKCZImiZPy
-  LGQBGRYDY29tMIIBojANBgkqhkiG9w0BAQEFAAOCAY8AMIIBigKCAYEA2Dn1GM3W
-  8K2/rvN1zz+06bQMcxD16ZKTihVwi7Pb1v3T98rM4Omnxohm3s+CwpDWGeiB9pj6
-  0I/CTce0e4e3s8GKJSOrg93veImPSoH2PfsMsRsuB8wtqyiOCjLbF5o6S29x87r0
-  LA5EawH+Lh4xqrkkPjdffsmLk7TaCig/vlmNvnzxXKBdey/X/aEJZXzzBiWRfVdh
-  O1fmMbVKyieGv9HK7+pLotIoT08bjDv8NP6V7zZslwQRqW27bQc6cqC2LGIbTYO3
-  3jt1kQxfMWmhOictS6SzG9VtKSrXf0L4Neq0Gh7CLBZBvJFWJYZPfb92YNITDbd8
-  emPOAQlXXNMN4mMXsEqtEhCPZRMnmwO+fOk/cC4AyglKi9lnQugCQoFV1XDMZST/
-  CYbzdQyadOdPDInTntG6V+Uw51d2QGXZ6PDDfrx9+toc/3sl5h68rCUGgE6Q3jPz
-  srinqmBsxv2vTpmd4FjmiAtEnwH5/ooLpQYL8UdAjEoeysxS3AwIh+5dAgMBAAGj
-  fzB9MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQWBBQWU6D156a2cle+
-  lb5RBfvVXlxTwjAhBgNVHREEGjAYgRZwZXRlci5ib2xpbmdAZ21haWwuY29tMCEG
+  LGQBGRYDY29tMIIBojANBgkqhkiG9w0BAQEFAAOCAY8AMIIBigKCAYEAruUoo0WA
+  uoNuq6puKWYeRYiZekz/nsDeK5x/0IEirzcCEvaHr3Bmz7rjo1I6On3gGKmiZs61
+  LRmQ3oxy77ydmkGTXBjruJB+pQEn7UfLSgQ0xa1/X3kdBZt6RmabFlBxnHkoaGY5
+  mZuZ5+Z7walmv6sFD9ajhzj+oIgwWfnEHkXYTR8I6VLN7MRRKGMPoZ/yvOmxb2DN
+  coEEHWKO9CvgYpW7asIihl/9GMpKiRkcYPm9dGQzZc6uTwom1COfW0+ZOFrDVBuV
+  FMQRPswZcY4Wlq0uEBLPU7hxnCL9nKK6Y9IhdDcz1mY6HZ91WImNslOSI0S8hRpj
+  yGOWxQIhBT3fqCBlRIqFQBudrnD9jSNpSGsFvbEijd5ns7Z9ZMehXkXDycpGAUj1
+  to/5cuTWWw1JqUWrKJYoifnVhtE1o1DZ+LkPtWxHtz5kjDG/zR3MG0Ula0UOavlD
+  qbnbcXPBnwXtTFeZ3C+yrWpE4pGnl3yGkZj9SMTlo9qnTMiPmuWKQDatAgMBAAGj
+  fzB9MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQWBBQE8uWvNbPVNRXZ
+  HlgPbc2PCzC4bjAhBgNVHREEGjAYgRZwZXRlci5ib2xpbmdAZ21haWwuY29tMCEG
   A1UdEgQaMBiBFnBldGVyLmJvbGluZ0BnbWFpbC5jb20wDQYJKoZIhvcNAQELBQAD
-  ggGBAJ4SqhPlgUiLYIrphGXIaxXScHyvx4kixuvdrwhI4VoQV2qXvO7R6ZjOXVwX
-  f/z84BWPiTZ8lzThPbt1UV/BGwkvLw9I4RjOdzvUz3J42j9Ly6q63isall07bo3F
-  QWe/OBvIMBF1IbjC3q5vKPg4rq8+TkNRJNoE86U2gfR+PkW3jYYs9uiy0GloHDCP
-  k5xgaj0vSL0Uy5mTOPdk3K6a/sUGZyYniWK05zdhIi956ynhfGaFO988FFdVw5Jq
-  LHtXfIpAU8F7ES04syZSslxOluw7VlcSKyRdVIr737J92ZTduppB4PRGSKRgBsWV
-  hXTahRE72Kyw53Q7FAuzF3v102WxAAQ7BuMjW+MyCUT75fwPm3W4ELPL8HYkNGE7
-  2oA5CPghFitRnvYS3GNrDG+9bNiRMEskeaBYwZ9UgReBQIwGYVj7LZk3UhiAsn44
-  gwGrEXGQGDZ0NIgBcmvMOqlXjkGQwQvugKycJ024z89+fz2332vdZIKTrSxJrXGk
-  4/bR9A==
+  ggGBAJbnUwfJQFPkBgH9cL7hoBfRtmWiCvdqdjeTmi04u8zVNCUox0A4gT982DE9
+  wmuN12LpdajxZONqbXuzZvc+nb0StFwmFYZG6iDwaf4BPywm2e/Vmq0YG45vZXGR
+  L8yMDSK1cQXjmA+ZBKOHKWavxP6Vp7lWvjAhz8RFwqF9GuNIdhv9NpnCAWcMZtpm
+  GUPyIWw/Cw/2wZp74QzZj6Npx+LdXoLTF1HMSJXZ7/pkxLCsB8m4EFVdb/IrW/0k
+  kNSfjtAfBHO8nLGuqQZVH9IBD1i9K6aSs7pT6TW8itXUIlkIUI2tg5YzW6OFfPzq
+  QekSkX3lZfY+HTSp/o+YvKkqWLUV7PQ7xh1ZYDtocpaHwgxe/j3bBqHE+CUPH2vA
+  0V/FwdTRWcwsjVoOJTrYcff8pBZ8r2MvtAc54xfnnhGFzeRHfcltobgFxkAXdE6p
+  DVjBtqT23eugOqQ73umLcYDZkc36vnqGxUBSsXrzY9pzV5gGr2I8YUxMqf6ATrZt
+  L9nRqA==
   -----END CERTIFICATE-----
-date: 2023-04-01 00:00:00.000000000 Z
-dependencies: []
-description: |-
-  Stub environment variables in a scoped context for testing
-  stub_env(
-    'AWS_REGION' => 'us-east-1',
-    'REDIS_URL' => 'redis://localhost:6379/'
-  )
+date: 2025-05-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+- !ruby/object:Gem::Dependency
+  name: rspec-block_is_expected
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+description: |
+  Stub or hide environment variables in a scoped context for testing
+  stub_env('REDIS_URL' => 'redis://localhost:6379/')
+  hide_env('SESSION_SECRET')
 email:
 - peter.boling@gmail.com
 executables: []
@@ -56,23 +95,24 @@ files:
 - CONTRIBUTING.md
 - LICENSE.txt
 - README.md
+- SECURITY.md
 - lib/rspec/stubbed_env.rb
 - lib/rspec/stubbed_env/config.rb
-- lib/rspec/stubbed_env/test_helpers.rb
+- lib/rspec/stubbed_env/hide_helpers.rb
+- lib/rspec/stubbed_env/stub_helpers.rb
 - lib/rspec/stubbed_env/version.rb
 homepage: https://github.com/pboling/rspec-stubbed_env
 licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/pboling/rspec-stubbed_env
-  source_code_uri: https://github.com/pboling/rspec-stubbed_env/tree/v1.0.1
-  changelog_uri: https://github.com/pboling/rspec-stubbed_env/blob/v1.0.1/CHANGELOG.md
+  source_code_uri: https://github.com/pboling/rspec-stubbed_env/tree/v1.0.2
+  changelog_uri: https://github.com/pboling/rspec-stubbed_env/blob/v1.0.2/CHANGELOG.md
   bug_tracker_uri: https://github.com/pboling/rspec-stubbed_env/issues
-  documentation_uri: https://www.rubydoc.info/gems/rspec-stubbed_env/1.0.1
+  documentation_uri: https://www.rubydoc.info/gems/rspec-stubbed_env/1.0.2
   funding_uri: https://liberapay.com/pboling
   wiki_uri: https://github.com/pboling/rspec-stubbed_env/wiki
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -87,8 +127,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
-signing_key:
+rubygems_version: 3.6.8
 specification_version: 4
 summary: Unobtrusively stub ENV keys and values during testing
 test_files: []