rspec-stubbed_env 1.0.0 → 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/stub_helpers.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+#
+# ENV stubbing is opt-in, via a shared context, rather than global
+#
+# Usage:
+#
+# describe 'my stubbed test' do
+#   include_context 'with stubbed env'
+#   before do
+#     stub_env('FOO' => 'is bar')
+#     # or, equivalently:
+#     stub_env(FOO: 'is bar')
+#     # or, equivalently:
+#     stub_env('FOO', 'is bar')
+#     # or, equivalently:
+#     stub_env(FOO: 'is bar')
+#   end
+#   it 'does a thing' do
+#     expect(ENV['FOO']).to eq('is bar')
+#   end
+# end
+#
+# NOTE: This file was originally written by Liam Bennet (https://github.com/ljkbennett)
+#       as part of the stub_env library (https://github.com/ljkbennett/stub_env).
+#       It has evolved since then.
+module RSpec
+  module StubbedEnv
+    # Helpers to unobtrusively stub ENV
+    module StubHelpers
+      # Can be called with all key value pairs to be stubbed as a hash:
+      #
+      #     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') # 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)
+          key_or_hash.each { |k, v| add_stubbed_value(k, v) }
+        else
+          add_stubbed_value(key_or_hash, value)
+        end
+      end
+
+      private
+
+      STUBBED_KEY = "__STUBBED__"
+
+      def add_stubbed_value(key, value)
+        key = key.to_s # Support symbols by forcing to string
+        allow_brackets(key, value)
+        allow_fetch(key, value)
+        allow_values_at
+      end
+
+      def allow_brackets(key, value)
+        allow(ENV).to(receive(:[]).with(key).and_return(value))
+      end
+
+      def allow_fetch(key, value)
+        allow(ENV).to(receive(:fetch).with(key).and_return(value))
+        allow(ENV).to(receive(:fetch).with(key, anything)) do |_, default_val|
+          value || default_val
+        end
+      end
+
+      # Rides on the fetch stub!
+      def allow_values_at
+        allow(ENV).to(receive(:values_at)) do |*args|
+          args.map { |arg| ENV.fetch(arg, nil) }
+        end
+      end
+
+      def env_stubbed?
+        ENV.fetch(STUBBED_KEY, nil)
+      end
+
+      def init_stub
+        allow(ENV).to(receive(:[]).and_call_original)
+        allow(ENV).to(receive(:fetch).and_call_original)
+        allow(ENV).to(receive(:values_at).and_call_original)
+        add_stubbed_value(STUBBED_KEY, true)
+      end
+    end
+  end
+end

data/lib/rspec/stubbed_env/version.rb

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

data/lib/rspec/stubbed_env.rb

@@ -1,13 +1,10 @@
 # frozen_string_literal: true
 
-require 'rspec/stubbed_env/version'
-
-# External Gems
-require 'rspec'
-
 # This Gem
-require 'rspec/stubbed_env/test_helpers'
-require 'rspec/stubbed_env/config'
+require "rspec/stubbed_env/version"
+require "rspec/stubbed_env/hide_helpers"
+require "rspec/stubbed_env/stub_helpers"
+require "rspec/stubbed_env/config"
 
 #
 # ENV stubbing is opt-in, via a shared context, rather than global
@@ -22,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,105 +1,118 @@
 --- !ruby/object:Gem::Specification
 name: rspec-stubbed_env
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.2
 platform: ruby
 authors:
+- Liam Bennett
 - Peter Boling
-autorequire: 
 bindir: exe
-cert_chain: []
-date: 2018-10-06 00:00:00.000000000 Z
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIEgDCCAuigAwIBAgIBATANBgkqhkiG9w0BAQsFADBDMRUwEwYDVQQDDAxwZXRl
+  ci5ib2xpbmcxFTATBgoJkiaJk/IsZAEZFgVnbWFpbDETMBEGCgmSJomT8ixkARkW
+  A2NvbTAeFw0yNTA1MDQxNTMzMDlaFw00NTA0MjkxNTMzMDlaMEMxFTATBgNVBAMM
+  DHBldGVyLmJvbGluZzEVMBMGCgmSJomT8ixkARkWBWdtYWlsMRMwEQYKCZImiZPy
+  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
+  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: 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.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '3.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '3.13'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec-block_is_expected
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.16'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.16'
-description: |-
-  Stub environment variables in a scoped context for testing
-  stub_env(
-    'AWS_REGION' => 'us-east-1',
-    'REDIS_URL' => 'redis://localhost:6379/'
-  )
+        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: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".pryrc"
-- ".rspec"
-- ".ruby-version"
-- ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
-- Gemfile
-- LICENSE
+- CONTRIBUTING.md
+- LICENSE.txt
 - README.md
-- Rakefile
-- bin/console
-- bin/setup
+- 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
-- rspec-stubbed_env.gemspec
 homepage: https://github.com/pboling/rspec-stubbed_env
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  homepage_uri: https://github.com/pboling/rspec-stubbed_env
+  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.2
+  funding_uri: https://liberapay.com/pboling
+  wiki_uri: https://github.com/pboling/rspec-stubbed_env/wiki
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -107,16 +120,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.8.7
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
-signing_key: 
+rubygems_version: 3.6.8
 specification_version: 4
 summary: Unobtrusively stub ENV keys and values during testing
 test_files: []

data/.gitignore

@@ -1,19 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-# rspec failure tracking
-.rspec_status
-
-.byebug_history
-
-# iCloud Drive
-.nosync
-
-*.gem
-/Gemfile.lock

data/.pryrc

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-if defined?(PryByebug)
-  Pry.commands.alias_command 'c', 'continue'
-  Pry.commands.alias_command 's', 'step'
-  Pry.commands.alias_command 'n', 'next'
-  Pry.commands.alias_command 'trace', 'backtrace'
-end
-
-# Hit Enter to repeat last command
-Pry::Commands.command /^$/, 'repeat last command' do
-  _pry_.run_command Pry.history.to_a.last
-end

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/.ruby-version

@@ -1 +0,0 @@
-ruby-2.5.1

data/.travis.yml

@@ -1,32 +0,0 @@
----
-env:
-  global:
-  - JRUBY_OPTS="-Xcli.debug=true --debug"
-  - CC_TEST_REPORTER_ID=3ed1c79841ccc5d053b995c63c0ead562427a77dba728601b8d19f02b16ac0f2
-
-before_script:
-- curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
-- chmod +x ./cc-test-reporter
-- ./cc-test-reporter before-build
-
-script:
-- bundle exec rake
-
-after_script:
-- ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
-
-before_install:
-- gem update --system
-- gem install bundler -v 1.16.5
-
-install:
-- bundle install
-
-bundler_args: --no-deployment --jobs 3 --retry 3
-
-language: ruby
-cache: bundler
-rvm:
-- 2.3.7
-- 2.4.4
-- 2.5.1

data/Gemfile

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
-
-# Specify your gem's dependencies in rspec-stubbed_env.gemspec
-gemspec

data/Rakefile

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new(:spec)
-
-task default: :spec

data/bin/console

@@ -1,15 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require 'bundler/setup'
-require 'rspec/stubbed_env'
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require 'irb'
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/lib/rspec/stubbed_env/test_helpers.rb

@@ -1,63 +0,0 @@
-# frozen_string_literal: true
-
-#
-# ENV stubbing is opt-in, via a shared context, rather than global
-#
-# Usage:
-#
-# describe 'my stubbed test' do
-#   include_context 'with stubbed env'
-#   before do
-#     stub_env('FOO' => 'is bar')
-#   end
-#   it 'does a thing' do
-#     expect(ENV['FOO']).to eq('is bar')
-#   end
-# end
-#
-module RSpec
-  module StubbedEnv
-    # Helpers to unobtrusively stub ENV
-    module TestHelpers
-      # Can be called with all key value pairs to be stubbed as a hash:
-      #
-      #     stub_env('A' => 'B', 'C' => 'D', 'E' => 'F')
-      #
-      # Alternatively can be called one per ENV key-value pair to stub:
-      #
-      #     stub_env('A', 'B')
-      #     stub_env('C', 'D')
-      #     stub_env('E', 'F')
-      def stub_env(key_or_hash, value = nil)
-        init_stub unless env_stubbed?
-        if key_or_hash.is_a? Hash
-          key_or_hash.each { |k, v| add_stubbed_value(k, v) }
-        else
-          add_stubbed_value key_or_hash, value
-        end
-      end
-
-      private
-
-      STUBBED_KEY = '__STUBBED__'
-
-      def add_stubbed_value(key, value)
-        allow(ENV).to receive(:[]).with(key).and_return(value)
-        allow(ENV).to receive(:fetch).with(key).and_return(value)
-        allow(ENV).to receive(:fetch).with(key, anything) do |_, default_val|
-          value || default_val
-        end
-      end
-
-      def env_stubbed?
-        ENV[STUBBED_KEY]
-      end
-
-      def init_stub
-        allow(ENV).to receive(:[]).and_call_original
-        allow(ENV).to receive(:fetch).and_call_original
-        add_stubbed_value(STUBBED_KEY, true)
-      end
-    end
-  end
-end

data/rspec-stubbed_env.gemspec

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-lib = File.expand_path('lib', __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'rspec/stubbed_env/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = 'rspec-stubbed_env'
-  spec.version       = RSpec::StubbedEnv::VERSION
-  spec.authors       = ['Peter Boling']
-  spec.email         = ['peter.boling@gmail.com']
-
-  spec.summary       = 'Unobtrusively stub ENV keys and values during testing'
-  spec.description   = %[Stub environment variables in a scoped context for testing
-stub_env(
-  'AWS_REGION' => 'us-east-1',
-  'REDIS_URL' => 'redis://localhost:6379/'
-)]
-  spec.homepage      = 'https://github.com/pboling/rspec-stubbed_env'
-  spec.license       = 'MIT'
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  end
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
-
-  spec.add_runtime_dependency 'rspec', '>= 3.0'
-
-  spec.add_development_dependency 'bundler', '~> 1.16'
-  spec.add_development_dependency 'rake', '~> 12.3'
-  spec.add_development_dependency 'simplecov', '~> 0.16'
-end