rspec-armour 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3cd64c8d03babf2b9a79453d2c6c2eaa62126ad2880135e73c03fe6d6f56e824
+  data.tar.gz: 91a57cfa13c6a701acc53ee7281a9cf64608c4dd4fe87f96d0290d0a575bf8ca
+SHA512:
+  metadata.gz: c29cbe69ed17b4e69bfbbf62e3e79545e789c04ee8f8ba827cce9bcb91334bcaae3732a86716d37ad8e89de00aa355a6089b1e805a8415b03d0c34ff34742d88
+  data.tar.gz: 21cf05dc106bf0f06ea4ae60f3625f5a6e61c210e037ba0654670e6f89e3a20c471b159e43e5470e9b4820dadea48e3eff8a86cc5fa4086b92c22776ac89c137

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2026-06-04
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Harry Lascelles
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,55 @@
+# rspec-armour
+
+`rspec-armour` protects your ActiveRecord models from being mocked or stubbed in RSpec tests. It forces you to use real database objects (or factories) for your models, leading to more robust and reliable tests.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rspec-armour'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install rspec-armour
+
+## Usage
+
+Once required, `rspec-armour` automatically prevents mocking of ActiveRecord finders, associations, and persistence methods.
+
+### Examples of restricted methods:
+
+*   **Class methods:** `.find`, `.where`, `.create`, `.update`, etc.
+*   **Instance methods:** `#save`, `#update`, `#destroy`, `#reload`, etc.
+*   **Associations:** `has_many`, `belongs_to`, and their helper methods (e.g., `user.items`, `user.item_ids`).
+
+### Disabling restrictions
+
+If you absolutely must mock an ActiveRecord method, you can do so by wrapping the code in a block:
+
+```ruby
+RSpec::Armour.without_restrictions do
+  allow(User).to receive(:where).and_return([])
+end
+```
+
+Or by using RSpec metadata:
+
+```ruby
+it "does something specific", :without_rspec_armour do
+  allow(User).to receive(:where).and_return([])
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hlascelles/rspec-armour.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/rspec/armour/checker.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+require "active_record"
+require "active_support/core_ext/string/inflections"
+
+module RSpec
+  module Armour
+    module Checker
+      RESTRICTED_CLASS_METHODS = %i[
+        find find_by find_by! where all first last count sum average minimum
+        maximum pluck pick exists? create create! find_or_create_by
+        find_or_create_by! find_or_initialize_by update update! destroy_all
+        delete_all delete_by destroy_by first_or_create first_or_create!
+        first_or_initialize
+      ].freeze
+
+      RESTRICTED_INSTANCE_METHODS = %i[
+        save save! update update! update_attribute update_columns update_column
+        destroy destroy! delete delete! touch reload increment! decrement!
+        toggle!
+      ].freeze
+
+      DISABLED_KEY = :rspec_armour_disabled
+
+      def self.restricted?(target, method_name)
+        return false if disabled?
+
+        method_sym = method_name.to_sym
+        is_class, klass = resolve_target_info(target)
+
+        return false unless klass.is_a?(Class) && klass < ::ActiveRecord::Base
+
+        restricted_by_list?(is_class,
+                            method_sym) || association_method_on_class?(klass, method_sym)
+      end
+
+      def self.resolve_target_info(target)
+        if test_double?(target)
+          resolve_double_info(target)
+        else
+          is_class = target.is_a?(Class)
+          [is_class, is_class ? target : target.class]
+        end
+      end
+
+      def self.test_double?(target)
+        defined?(::RSpec::Mocks::TestDouble) && target.is_a?(::RSpec::Mocks::TestDouble)
+      end
+
+      def self.resolve_double_info(target)
+        ref = target.instance_variable_get(:@doubled_module)
+        return [false, nil] unless ref.respond_to?(:target)
+
+        underlying_target = ref.target
+        case target
+        when ::RSpec::Mocks::InstanceVerifyingDouble
+          [false, underlying_target]
+        when ::RSpec::Mocks::ClassVerifyingDouble
+          [true, underlying_target]
+        when ::RSpec::Mocks::ObjectVerifyingDouble
+          is_class = underlying_target.is_a?(Class)
+          [is_class, is_class ? underlying_target : underlying_target.class]
+        else
+          [false, nil]
+        end
+      end
+
+      def self.restricted_by_list?(is_class, method_sym)
+        return true if RESTRICTED_INSTANCE_METHODS.include?(method_sym)
+
+        is_class && RESTRICTED_CLASS_METHODS.include?(method_sym)
+      end
+
+      def self.association_method_on_class?(klass, method_name)
+        return false unless klass.respond_to?(:reflections)
+
+        reflections = klass.reflections
+        reflections.any? do |name, _reflection|
+          singular_name = name.to_s.singularize
+          [
+            name.to_sym,
+            :"#{name}=",
+            :"#{singular_name}_ids",
+            :"#{singular_name}_ids=",
+          ].include?(method_name)
+        end
+      end
+
+      def self.disabled?
+        Thread.current[DISABLED_KEY]
+      end
+
+      def self.disable!
+        previous = Thread.current[DISABLED_KEY]
+        Thread.current[DISABLED_KEY] = true
+        yield
+      ensure
+        Thread.current[DISABLED_KEY] = previous
+      end
+    end
+  end
+end

data/lib/rspec/armour/receive_patch.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module RSpec
+  module Mocks
+    module Matchers
+      # This class is patched to prevent mocking ActiveRecord associations and finders.
+      class Receive
+        def self.patch_for_armour!
+          # rubocop:disable ThreadSafety/ClassInstanceVariable
+          @armour_patched ||= false
+          return if @armour_patched
+
+          @armour_patched = true
+          # rubocop:enable ThreadSafety/ClassInstanceVariable
+
+          %i[
+            setup_expectation
+            setup_negative_expectation
+            setup_allowance
+            setup_any_instance_expectation
+            setup_any_instance_negative_expectation
+            setup_any_instance_allowance
+            matches?
+            does_not_match?
+          ].each do |method|
+            next unless method_defined?(method)
+
+            patch_method(method)
+          end
+        end
+
+        def self.patch_method(method)
+          original_method = instance_method(method)
+          define_method(method) do |subject, &block|
+            if ENV["RSPEC_ARMOUR_DEBUG"] == "true"
+              puts "Checking RSpec::Armour '#{@message}' on #{subject}"
+            end
+            if RSpec::Armour::Checker.restricted?(subject, @message)
+              message = "Mocking/stubbing ActiveRecord association or finder `#{@message}` " \
+                        "on `#{subject.inspect}` is restricted by rspec-armour."
+              raise RSpec::Armour::MockError, message
+            end
+            original_method.bind_call(self, subject, &block)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rspec/armour/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module RSpec
+  module Armour
+    VERSION = "0.1.0"
+  end
+end

data/lib/rspec/armour.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "rspec"
+require "rspec/mocks"
+require_relative "armour/version"
+require_relative "armour/checker"
+require_relative "armour/receive_patch"
+
+module RSpec
+  module Armour
+    class MockError < StandardError; end
+
+    def self.without_restrictions(&)
+      Checker.disable!(&)
+    end
+  end
+end
+
+# Ensure the matcher is loaded
+require "rspec/mocks/matchers/receive"
+
+RSpec::Mocks::Matchers::Receive.patch_for_armour!
+
+RSpec.configure do |config|
+  config.around(:each, without_rspec_armour: true) do |example|
+    RSpec::Armour.without_restrictions do
+      example.run
+    end
+  end
+end

data/quality.sh

@@ -0,0 +1,11 @@
+#! /usr/bin/env bash
+set -euo pipefail
+
+cd "${0%/*}"
+bundle check || bundle install
+echo "Running fasterer..."
+bundle exec fasterer
+echo "Running rubocop..."
+bundle exec rubocop
+echo "Running reek..."
+bundle exec reek

metadata

@@ -0,0 +1,183 @@
+--- !ruby/object:Gem::Specification
+name: rspec-armour
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Harry Lascelles
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-magic_numbers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-thread_safety
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 'rspec-armour prevents developers from mocking ActiveRecord finders,
+  associations, and persistence methods, ensuring tests use real database interactions.
+
+  '
+email:
+- harry@harryl.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rspec/armour.rb
+- lib/rspec/armour/checker.rb
+- lib/rspec/armour/receive_patch.rb
+- lib/rspec/armour/version.rb
+- quality.sh
+homepage: https://github.com/hlascelles/rspec-armour
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/hlascelles/rspec-armour
+  source_code_uri: https://github.com/hlascelles/rspec-armour
+  changelog_uri: https://github.com/hlascelles/rspec-armour/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.6
+specification_version: 4
+summary: Restrict mocking and stubbing of ActiveRecord models in RSpec.
+test_files: []