rspec_in_context 1.1.0.3 → 1.2.1

data/examples/usage/interactor_spec.rb

@@ -0,0 +1,23 @@
+# Example: Using :interactor_expect for contract validation
+#
+# Tests that the interactor fails when any required field is nil,
+# then tests the happy path separately.
+
+require "rails_helper"
+
+RSpec.describe CreateInvoice do
+  subject do
+    described_class.call(amount: amount, client: client, due_date: due_date)
+  end
+
+  let(:amount) { 100 }
+  let(:client) { create(:client) }
+  let(:due_date) { Date.tomorrow }
+
+  in_context :interactor_expect, %i[amount client due_date]
+
+  it "creates the invoice" do
+    expect(subject).to be_success
+    expect(subject.invoice).to be_persisted
+  end
+end

data/examples/usage/nested_contexts_spec.rb

@@ -0,0 +1,30 @@
+# Example: Nesting multiple contexts together
+#
+# Combines :with_frozen_time and :with_inline_mailer
+# to test time-sensitive email delivery.
+
+require "rails_helper"
+
+RSpec.describe PasswordReset do
+  in_context :with_frozen_time do
+    in_context :with_inline_mailer do
+      it "sends the reset email" do
+        user = create(:user)
+
+        PasswordReset.call(user)
+
+        expect(ActionMailer::Base.deliveries.size).to eq(1)
+      end
+
+      it "includes the current timestamp" do
+        user = create(:user)
+
+        PasswordReset.call(user)
+
+        expect(ActionMailer::Base.deliveries.last.body.to_s).to include(
+          Time.current.iso8601,
+        )
+      end
+    end
+  end
+end

data/examples/usage/request_spec.rb

@@ -0,0 +1,29 @@
+# Example: Using :authenticated_request in a request spec
+#
+# The context handles authentication setup and tests the unauthenticated case.
+# Your tests inside the block run in an authenticated state.
+
+require "rails_helper"
+
+RSpec.describe "Projects", type: :request do
+  let(:http_method) { :get }
+  let(:endpoint_path) { projects_path }
+
+  in_context :authenticated_request do
+    describe "GET /projects" do
+      it "returns 200" do
+        get projects_path
+
+        expect(response).to have_http_status(:ok)
+      end
+
+      it "lists the user's projects" do
+        project = create(:project, account: account)
+
+        get projects_path
+
+        expect(response.body).to include(project.name)
+      end
+    end
+  end
+end

data/lib/rspec_in_context/context_management.rb

@@ -1,12 +1,10 @@
-# frozen_string_literal: true
-
 module RspecInContext
   # Allow context to be scoped inside a block
   module ContextManagement
     # @api private
     # prepending a RSpec method so we can know when a describe/context block finish
     # its reading
-    def subclass(parent, description, args, registration_collection, &example_group_block)
+    def subclass(parent, description, args, registration_collection, &)
       subclass = super
       RspecInContext::InContext.remove_context(subclass)
       subclass

data/lib/rspec_in_context/in_context.rb

@@ -1,14 +1,29 @@
-# frozen_string_literal: true
-
 # Base module
 module RspecInContext
-  # Error type when no context is find from its name (and eventualy namespace)
-  class NoContextFound < StandardError; end
+  # Base error class for all gem errors
+  class Error < StandardError
+  end
+
+  # Error type when no context is found from its name (and eventually namespace)
+  class NoContextFound < Error
+  end
+
+  # Error type when define_context is called without a block
+  class MissingDefinitionBlock < ArgumentError
+  end
+
+  # Error type when context_name is nil or empty
+  class InvalidContextName < ArgumentError
+  end
+
+  # Error type when multiple namespaces contain a context with the same name
+  class AmbiguousContextName < Error
+  end
 
   # Context struct
   # @attr [Proc] block what will be executed in the test context
   # @attr [Class] owner current rspec context class. This will be used to know where a define_context has been defined
-  # @attr [String | Symbol] name represent the name by which the context can be find.
+  # @attr [String | Symbol] name represent the name by which the context can be found.
   # @attr [String | Symbol] namespace namespace for context names to avoid collisions
   # @attr [Boolean] silent does the in_context wrap itself into a context with its name or an anonymous context
   Context = Struct.new(:block, :owner, :name, :namespace, :silent)
@@ -17,6 +32,9 @@ module RspecInContext
   module InContext
     # Name of the Global context
     GLOBAL_CONTEXT = :global_context
+    # Mutex protecting @contexts for thread-safety (e.g. parallel_tests in thread mode)
+    @contexts_mutex = Mutex.new
+
     class << self
       # Hook for easier inclusion of the gem in RSpec
       # @api private
@@ -25,50 +43,105 @@ module RspecInContext
       end
 
       # Contexts container + creation
+      # Keys are normalized to strings so symbols and strings are interchangeable.
       # @api private
       def contexts
-        @contexts ||= HashWithIndifferentAccess.new { |hash, key| hash[key] = HashWithIndifferentAccess.new }
+        @contexts_mutex.synchronize do
+          @contexts ||= Hash.new { |hash, key| hash[key.to_s] = {} }
+        end
+      end
+
+      # Remove all stored contexts (both scoped and global).
+      # Useful for memory cleanup in long-running test suites with
+      # dynamically generated contexts.
+      def clear_all_contexts!
+        @contexts_mutex.synchronize { @contexts = nil }
       end
 
       # Meta method to add a new context
       # @api private
       #
-      # @note Will warn if a context is overriden
-      def add_context(context_name, owner = nil, namespace = nil, silent = true, &block)
+      # @note Will warn if a context is overridden
+      # @raise [InvalidContextName] if context_name is nil or empty
+      # @raise [MissingDefinitionBlock] if no block is provided
+      def add_context(
+        context_name,
+        owner = nil,
+        namespace = nil,
+        silent = true,
+        &block
+      )
+        if context_name.nil? ||
+             (context_name.respond_to?(:empty?) && context_name.empty?)
+          raise InvalidContextName, "context_name cannot be nil or empty"
+        end
+        unless block
+          raise MissingDefinitionBlock, "define_context requires a block"
+        end
+
         namespace ||= GLOBAL_CONTEXT
-        warn("Overriding an existing context: #{context_name}@#{namespace}") if contexts[namespace][context_name]
-        contexts[namespace][context_name] = Context.new(block, owner, context_name, namespace, silent)
+        ns_key = namespace.to_s
+        name_key = context_name.to_s
+        if contexts.dig(ns_key, name_key)
+          warn("Overriding an existing context: #{context_name}@#{namespace}")
+        end
+        contexts[ns_key][name_key] = Context.new(
+          block,
+          owner,
+          context_name,
+          namespace,
+          silent,
+        )
       end
 
       # Find a context.
       # @api private
+      # @raise [NoContextFound] if no context is found
+      # @raise [AmbiguousContextName] if multiple namespaces contain the same context name
       def find_context(context_name, namespace = nil)
-        if namespace&.present?
-          contexts[namespace][context_name]
-        else
-          contexts[GLOBAL_CONTEXT][context_name] || find_context_in_any_namespace(context_name)
-        end || (raise NoContextFound, "No context found with name #{context_name}")
+        name_key = context_name.to_s
+        result =
+          if namespace && !namespace.to_s.empty?
+            contexts.dig(namespace.to_s, name_key)
+          else
+            find_context_across_all_namespaces(name_key)
+          end
+        result ||
+          (raise NoContextFound, "No context found with name #{context_name}")
       end
 
       # Look into every namespace to find the context
+      # Uses dig to avoid auto-vivifying empty namespace entries
       # @api private
-      def find_context_in_any_namespace(context_name)
-        valid_namespace = contexts.find { |_, namespaced_contexts| namespaced_contexts[context_name] }&.last
-        valid_namespace[context_name] if valid_namespace
+      # @raise [AmbiguousContextName] if multiple namespaces contain the same context name
+      def find_context_across_all_namespaces(name_key)
+        matching_namespaces =
+          contexts.select do |_, namespaced_contexts|
+            namespaced_contexts[name_key]
+          end
+        if matching_namespaces.size > 1
+          namespace_names = matching_namespaces.keys.join(", ")
+          raise AmbiguousContextName,
+                "Context '#{name_key}' exists in multiple namespaces (#{namespace_names}). " \
+                  "Please specify a namespace."
+        end
+        matching_namespaces.values.first&.[](name_key)
       end
 
       # @api private
       # Delete a context
       def remove_context(current_class)
         contexts.each_value do |namespaced_contexts|
-          namespaced_contexts.delete_if { |_, context| context.owner == current_class }
+          namespaced_contexts.delete_if do |_, context|
+            context.owner == current_class
+          end
         end
       end
 
       # @api private
       # Define a context from outside a RSpec.describe block
-      def outside_define_context(context_name, namespace, silent, &block)
-        InContext.add_context(context_name, nil, namespace, silent, &block)
+      def outside_define_context(context_name, namespace, silent, &)
+        InContext.add_context(context_name, nil, namespace, silent, &)
       end
     end
 
@@ -83,40 +156,69 @@ module RspecInContext
       # @param block Content that will be re-injected (see #execute_tests)
       def in_context(context_name, *args, namespace: nil, ns: nil, &block)
         namespace ||= ns
-        Thread.current[:test_block] = block
         context_to_exec = InContext.find_context(context_name, namespace)
-        return context { instance_exec(*args, &context_to_exec.block) } if context_to_exec.silent
-
-        context(context_name.to_s) { instance_exec(*args, &context_to_exec.block) }
+        Thread.current[:test_block_stack] ||= []
+        Thread.current[:test_block_stack].push(block)
+        begin
+          if context_to_exec.silent
+            context { instance_exec(*args, &context_to_exec.block) }
+          else
+            context(
+              context_name.to_s,
+            ) { instance_exec(*args, &context_to_exec.block) }
+          end
+        ensure
+          Thread.current[:test_block_stack].pop
+        end
       end
 
       # Used in context definition
       # Place where you want to re-inject code passed in argument of in_context
-      #
-      # For convenience and readability, a `instanciate_context` alias have been defined
       # (for more examples look at tests)
       def execute_tests
-        instance_exec(&Thread.current[:test_block]) if Thread.current[:test_block]
+        current_block = Thread.current[:test_block_stack]&.last
+        instance_exec(&current_block) if current_block
+      end
+      alias instantiate_context execute_tests
+
+      # @deprecated Use {#instantiate_context} or {#execute_tests} instead
+      def instanciate_context
+        warn(
+          "DEPRECATION: `instanciate_context` is deprecated due to a typo. " \
+            "Use `instantiate_context` or `execute_tests` instead.",
+          uplevel: 1,
+        )
+        execute_tests
       end
-      alias instanciate_context execute_tests
 
       # Let you define a context that can be reused later
       #
       # @param context_name [String, Symbol] The name of the context that will be re-used later
       # @param namespace [String, Symbol] namespace name where the context will be stored.
-      #   It helps reducing colisions when you define "global" contexts
+      #   It helps reducing collisions when you define "global" contexts
       # @param ns [String, Symbol] Alias of namespace
       # @param block [Proc] Contain the code that will be injected with #in_context later
       # @param silent [Boolean] Does the in_context wrap itself into a context with its name or an anonymous context
       # @param print_context [Boolean] Reverse alias of silent
       #
       # @note contexts are scoped to the block they are defined in.
-      def define_context(context_name, namespace: nil, ns: nil, silent: true, print_context: nil, &block)
+      def define_context(
+        context_name,
+        namespace: nil,
+        ns: nil,
+        silent: true,
+        print_context: nil,
+        &
+      )
         namespace ||= ns
-        silent = print_context.nil? ? silent : !print_context
-        instance_exec do
-          InContext.add_context(context_name, hooks.instance_variable_get(:@owner), namespace, silent, &block)
-        end
+        silent = !print_context unless print_context.nil?
+        InContext.add_context(
+          context_name,
+          hooks.instance_variable_get(:@owner),
+          namespace,
+          silent,
+          &
+        )
       end
     end
   end

data/lib/rspec_in_context/version.rb

@@ -1,6 +1,4 @@
-# frozen_string_literal: true
-
 module RspecInContext
   # Version of the gem
-  VERSION = '1.1.0.3'
+  VERSION = "1.2.1".freeze
 end

data/lib/rspec_in_context.rb

@@ -1,9 +1,6 @@
-# frozen_string_literal: true
-
-require 'active_support/all'
-require 'rspec_in_context/version'
-require 'rspec_in_context/in_context'
-require 'rspec_in_context/context_management'
+require "rspec_in_context/version"
+require "rspec_in_context/in_context"
+require "rspec_in_context/context_management"
 
 # Main wrapping module
 module RspecInContext
@@ -24,9 +21,16 @@ module RSpec
   # @param silent [Boolean] Does the in_context should wrap itself into a context block with its name
   # @param print_context [Boolean] Reverse alias of silent
   # @param block [Proc] code that will be injected later
-  def self.define_context(name, namespace: nil, ns: nil, silent: true, print_context: nil, &block)
+  def self.define_context(
+    name,
+    namespace: nil,
+    ns: nil,
+    silent: true,
+    print_context: nil,
+    &
+  )
     namespace ||= ns
-    silent = print_context.nil? ? silent : !print_context
-    RspecInContext::InContext.outside_define_context(name, namespace, silent, &block)
+    silent = !print_context unless print_context.nil?
+    RspecInContext::InContext.outside_define_context(name, namespace, silent, &)
   end
 end

data/package.json

@@ -6,7 +6,21 @@
   "author": "Denis <Zaratan> Pasin <zaratan@hey.com>",
   "license": "MIT",
   "devDependencies": {
-    "@prettier/plugin-ruby": "^1.3.0",
-    "prettier": "^2.2.1"
+    "@prettier/plugin-ruby": "^4.0",
+    "prettier": "^3.8.1"
+  },
+  "prettier": {
+    "trailingComma": "es5",
+    "plugins": [
+      "@prettier/plugin-ruby"
+    ],
+    "overrides": [
+      {
+        "files": "*.rb",
+        "options": {
+          "parser": "ruby"
+        }
+      }
+    ]
   }
 }

data/rspec_in_context.gemspec

@@ -1,45 +1,46 @@
 # frozen_string_literal: true
 
-lib = File.expand_path('lib', __dir__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "rspec_in_context/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = "rspec_in_context"
-  spec.version       = RspecInContext::VERSION
-  spec.authors       = ["Denis <Zaratan> Pasin"]
-  spec.email         = ["denis@pasin.fr"]
+  spec.name = "rspec_in_context"
+  spec.version = RspecInContext::VERSION
+  spec.authors = ["Denis <Zaratan> Pasin"]
+  spec.email = ["denis@pasin.fr"]
 
-  spec.summary       = 'This gem is here to help DRYing your tests cases by giving a better "shared_examples".'
-  spec.homepage      = "https://github.com/denispasin/rspec_in_context"
+  spec.summary =
+    'This gem is here to help DRYing your tests cases by giving a better "shared_examples".'
+  spec.homepage = "https://github.com/denispasin/rspec_in_context"
 
   # 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         =
+  spec.files =
     Dir.chdir(File.expand_path(__dir__)) do
-      `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+      `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.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
-  spec.required_ruby_version = '>= 2.5.8' # rubocop:disable Gemspec/RequiredRubyVersion
-  spec.license = 'MIT'
+  spec.required_ruby_version = ">= 3.2.0"
+  spec.license = "MIT"
 
-  spec.add_dependency "activesupport", "> 2.0"
-  spec.add_dependency "rspec", "> 3.0"
+  spec.add_dependency "rspec", "~> 3.0"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "bundler-audit", "> 0.6.0"
-  spec.add_development_dependency "codacy-coverage", '>= 2.1.0'
-  spec.add_development_dependency "faker", "> 1.8"
+
   spec.add_development_dependency "guard-rspec", "> 4.7"
-  spec.add_development_dependency "overcommit", '> 0.46'
+  spec.add_development_dependency "overcommit", "> 0.46"
   spec.add_development_dependency "prettier"
-  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec_junit_formatter", "~> 0.4.1"
-  spec.add_development_dependency "rubocop", "> 0.58"
+  spec.add_development_dependency "rubocop", "~> 1.82"
   spec.add_development_dependency "rubocop-performance"
   spec.add_development_dependency "simplecov", "> 0.16"
   spec.add_development_dependency "solargraph"
   spec.add_development_dependency "yard"
+  spec.metadata["rubygems_mfa_required"] = "true"
 end

data/yarn.lock

@@ -2,14 +2,12 @@
 # yarn lockfile v1
 
 
-"@prettier/plugin-ruby@^1.3.0":
-  version "1.3.0"
-  resolved "https://registry.yarnpkg.com/@prettier/plugin-ruby/-/plugin-ruby-1.3.0.tgz#38ec1447ca43121cfe72961ed974038cbcb57ff7"
-  integrity sha512-8MHLLdHpb0MDmkh+GZa+MQcQVQzYc34Nv5/I5yQv4n14ogLRMs3oi5C9kQSG2PAYLhAwF8EU36OczzVaHrPHoA==
-  dependencies:
-    prettier ">=1.10"
+"@prettier/plugin-ruby@^4.0":
+  version "4.0.4"
+  resolved "https://registry.yarnpkg.com/@prettier/plugin-ruby/-/plugin-ruby-4.0.4.tgz#73d85fc2a1731a3f62b57ac3116cf1c234027cb6"
+  integrity sha512-lCpvfS/dQU5WrwN3AQ5vR8qrvj2h5gE41X08NNzAAXvHdM4zwwGRcP2sHSxfu6n6No+ljWCVx95NvJPFTTjCTg==
 
-prettier@>=1.10, prettier@^2.2.1:
-  version "2.2.1"
-  resolved "https://registry.yarnpkg.com/prettier/-/prettier-2.2.1.tgz#795a1a78dd52f073da0cd42b21f9c91381923ff5"
-  integrity sha512-PqyhM2yCjg/oKkFPtTGUojv7gnZAoG80ttl45O6x2Ug/rMJw4wcc9k6aaf2hibP7BGVCCM33gZoGjyvt9mm16Q==
+prettier@^3.8.1:
+  version "3.8.1"
+  resolved "https://registry.yarnpkg.com/prettier/-/prettier-3.8.1.tgz#edf48977cf991558f4fcbd8a3ba6015ba2a3a173"
+  integrity sha512-UOnG6LftzbdaHZcKoPFtOcCKztrQ57WkHDeRD9t/PTQtmT0NHSeWWepj6pS0z/N7+08BHFDQVUrfmfMRcZwbMg==