rubocop-thoughtbot 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56b7014c878946a04e2619ecb8a50cd7e2cd60199c4c4e3ea4fd362ca601b3e0
-  data.tar.gz: 964048a771865a0092dd7461cfe3205bc8365818c62fd10302065fee2665f4c8
+  metadata.gz: c605025e3fecafd33bad54f248518f13564c99fb048c788fb3a08c73d9f1eb88
+  data.tar.gz: 6f5410b06ae7db53ec37016e0e09ba41edc71b4f410c258152c03bd976d946e4
 SHA512:
-  metadata.gz: ce3ee7c537f213881a88c69798f2ffd282a7a124446b96034b2715b09b8491246399fc8a584ff0810e065f7928213ccb1a530441784922c1dcdfe9df865d6737
-  data.tar.gz: ff3e7287274ab79cc20953993a44bd3edd2c456b7b529156b7b2ac26a54b22ab152a00dc2b41757901200a003507f91be650b27c4c9f271ba759fd194fd54b34
+  metadata.gz: f0d338a84df29c9c4d05d592623bce1b74b57107aa978ad53ac0274d9ea6ebf12f92ec3dc71b1c5719efa5f3fca4c3c75c741bc0fe45711640b6d025449ae266
+  data.tar.gz: e39d00609e04d7abb483421c76a241b2e278f1d1b2ebe32273a61d2d65416336b8688d962ff2f5c93356c01f59ec6b6ecf214f6ecf2feda284762405c6e3b478

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 ## [Unreleased]
 
-## [0.1.0] - 2026-07-29
+## [0.1.1] - 2026-08-14
+
+### Fixed
+
+- `Thoughtbot/NoBefore` and `Thoughtbot/NoLet` now only flag a call that belongs to
+  an RSpec example group (`describe`, `context`, `feature`, `shared_examples` and
+  friends, with or without an `RSpec.` receiver). Sinatra and Grape define a
+  `before` of their own, so a fake app under `spec/support` was being flagged for a
+  hook that has nothing to do with RSpec.
+
+## [0.1.0] - 2026-08-14
 
 - Initial release
   - See [README](README.md) for context

data/README.md

@@ -51,14 +51,11 @@ to be more trouble than it's worth will be removed.
 
 ## Installation
 
-This gem is not published to RubyGems yet, so install it from GitHub. Add it to
-your Gemfile:
+Add the gem to your Gemfile:
 
 ```ruby
 group :development, :test do
-  gem "rubocop-thoughtbot", github: "thoughtbot/rubocop-thoughtbot", require: false
-  # Or via SSH while the repo is private
-  # gem "rubocop-thoughtbot", git: "git@github.com:thoughtbot/rubocop-thoughtbot.git", require: false
+  gem "rubocop-thoughtbot", require: false
 end
 ```
 
@@ -146,7 +143,15 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rubocop-thoughtbot. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/rubocop-thoughtbot/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/thoughtbot/rubocop-thoughtbot. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/thoughtbot/rubocop-thoughtbot/blob/main/CODE_OF_CONDUCT.md).
+
+## Resources
+
+- [RubyGems] — the published gem
+- [Changelog] — release notes and version history
+
+[RubyGems]: https://rubygems.org/gems/rubocop-thoughtbot
+[Changelog]: CHANGELOG.md
 
 ## License
 
@@ -154,4 +159,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Rubocop::Thoughtbot project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/rubocop-thoughtbot/blob/main/CODE_OF_CONDUCT.md).
+Everyone interacting in the Rubocop::Thoughtbot project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/thoughtbot/rubocop-thoughtbot/blob/main/CODE_OF_CONDUCT.md).

data/config/default.yml

@@ -6,6 +6,7 @@ Thoughtbot/NoBefore:
   Description: 'Checks for `before` hooks in specs.'
   Enabled: true
   VersionAdded: '0.1.0'
+  VersionChanged: '0.1.1'
   Include:
     - '**/*_spec.rb'
     - '**/spec/**/*.rb'
@@ -14,6 +15,7 @@ Thoughtbot/NoLet:
   Description: 'Checks for `let` and `let!` declarations in specs.'
   Enabled: true
   VersionAdded: '0.1.0'
+  VersionChanged: '0.1.1'
   Include:
     - '**/*_spec.rb'
     - '**/spec/**/*.rb'

data/docs/modules/ROOT/pages/cops_thoughtbot.adoc

@@ -16,7 +16,7 @@
 | Yes
 | No
 | 0.1.0
-| -
+| 0.1.1
 |===
 
 Checks for `before` hooks in specs.
@@ -38,17 +38,21 @@ See https://thoughtbot.com/blog/the-arrange-act-assert-pattern
 [source,ruby]
 ----
 # bad
-before { @user = build(:user) }
+RSpec.describe User do
+  before { @user = build(:user) }
 
-it "is valid" do
-  expect(@user).to be_valid
+  it "is valid" do
+    expect(@user).to be_valid
+  end
 end
 
 # good
-it "is valid" do
-  user = build(:user)
+RSpec.describe User do
+  it "is valid" do
+    user = build(:user)
 
-  expect(user).to be_valid
+    expect(user).to be_valid
+  end
 end
 ----
 
@@ -73,7 +77,7 @@ end
 | Yes
 | No
 | 0.1.0
-| -
+| 0.1.1
 |===
 
 Checks for `let` and `let!` declarations in specs.
@@ -95,17 +99,21 @@ See https://thoughtbot.com/blog/the-arrange-act-assert-pattern
 [source,ruby]
 ----
 # bad
-let(:user) { build(:user) }
+RSpec.describe User do
+  let(:user) { build(:user) }
 
-it "is valid" do
-  expect(user).to be_valid
+  it "is valid" do
+    expect(user).to be_valid
+  end
 end
 
 # good
-it "is valid" do
-  user = build(:user)
+RSpec.describe User do
+  it "is valid" do
+    user = build(:user)
 
-  expect(user).to be_valid
+    expect(user).to be_valid
+  end
 end
 ----
 

data/lib/rubocop/cop/thoughtbot/mixin/spec_group.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Thoughtbot
+      # Common functionality for cops that flag a bare RSpec DSL call.
+      #
+      # A spec directory holds more than specs. A fake Sinatra or Grape app
+      # under `spec/support` defines a `before` of its own, so a cop that
+      # matches on the method name alone flags code that has nothing to do
+      # with RSpec. Asking where the call sits keeps the cop to RSpec's DSL.
+      module SpecGroup
+        extend RuboCop::AST::NodePattern::Macros
+
+        SCOPES = %i[block numblock itblock class module].freeze
+
+        # Matches rubocop-rspec's `ExampleGroups` and `SharedGroups`.
+        SPEC_GROUPS = %i[
+          describe context feature example_group
+          xdescribe xcontext xfeature
+          fdescribe fcontext ffeature
+          shared_examples shared_examples_for shared_context
+        ].freeze
+
+        # @!method spec_group?(node)
+        def_node_matcher :spec_group?, <<~PATTERN
+          (any_block
+            (send {nil? (const {nil? cbase} :RSpec)} #spec_group_name? ...) ...)
+        PATTERN
+
+        # @!method extends_shared_context?(node)
+        def_node_matcher :extends_shared_context?, <<~PATTERN
+          (send nil? :extend (const (const {nil? cbase} :RSpec) :SharedContext))
+        PATTERN
+
+        private
+
+        def inside_spec_group?(node)
+          scope = enclosing_scope(node)
+
+          spec_group?(scope) || shared_context_module?(scope)
+        end
+
+        def spec_group_name?(name)
+          SPEC_GROUPS.include?(name)
+        end
+
+        def shared_context_module?(node)
+          return false unless node&.module_type?
+
+          body_statements(node).any? { |statement| extends_shared_context?(statement) }
+        end
+
+        def body_statements(node)
+          body = node.body
+
+          if body.nil?
+            []
+          elsif body.begin_type?
+            body.children
+          else
+            [body]
+          end
+        end
+
+        def enclosing_scope(node)
+          call = node.block_node || node
+
+          call.each_ancestor(*SCOPES).first
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/thoughtbot/no_before.rb

@@ -18,20 +18,26 @@ module RuboCop
       #
       # @example
       #   # bad
-      #   before { @user = build(:user) }
+      #   RSpec.describe User do
+      #     before { @user = build(:user) }
       #
-      #   it "is valid" do
-      #     expect(@user).to be_valid
+      #     it "is valid" do
+      #       expect(@user).to be_valid
+      #     end
       #   end
       #
       #   # good
-      #   it "is valid" do
-      #     user = build(:user)
+      #   RSpec.describe User do
+      #     it "is valid" do
+      #       user = build(:user)
       #
-      #     expect(user).to be_valid
+      #       expect(user).to be_valid
+      #     end
       #   end
       #
       class NoBefore < Base
+        include SpecGroup
+
         MSG = "Avoid `before` — set up test data inside each example so it " \
               "doesn't become a mystery guest. See https://thoughtbot.com/blog/lets-not"
 
@@ -39,6 +45,7 @@ module RuboCop
 
         def on_send(node)
           return if node.receiver
+          return unless inside_spec_group?(node)
 
           add_offense(node.loc.selector)
         end

data/lib/rubocop/cop/thoughtbot/no_let.rb

@@ -18,20 +18,26 @@ module RuboCop
       #
       # @example
       #   # bad
-      #   let(:user) { build(:user) }
+      #   RSpec.describe User do
+      #     let(:user) { build(:user) }
       #
-      #   it "is valid" do
-      #     expect(user).to be_valid
+      #     it "is valid" do
+      #       expect(user).to be_valid
+      #     end
       #   end
       #
       #   # good
-      #   it "is valid" do
-      #     user = build(:user)
+      #   RSpec.describe User do
+      #     it "is valid" do
+      #       user = build(:user)
       #
-      #     expect(user).to be_valid
+      #       expect(user).to be_valid
+      #     end
       #   end
       #
       class NoLet < Base
+        include SpecGroup
+
         MSG = "Avoid `%<method>s` — set up test data inside each example so it " \
               "doesn't become a mystery guest. See https://thoughtbot.com/blog/lets-not"
 
@@ -39,6 +45,7 @@ module RuboCop
 
         def on_send(node)
           return if node.receiver
+          return unless inside_spec_group?(node)
 
           add_offense(node.loc.selector, message: format(MSG, method: node.method_name))
         end

data/lib/rubocop/cop/thoughtbot_cops.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative "thoughtbot/mixin/spec_group"
+
 require_relative "thoughtbot/no_before"
 require_relative "thoughtbot/no_let"
 require_relative "thoughtbot/resourceful_actions"

data/lib/rubocop/thoughtbot/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module Thoughtbot
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-thoughtbot
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Jared Turner
@@ -62,6 +62,7 @@ files:
 - docs/modules/ROOT/pages/cops.adoc
 - docs/modules/ROOT/pages/cops_thoughtbot.adoc
 - lib/rubocop-thoughtbot.rb
+- lib/rubocop/cop/thoughtbot/mixin/spec_group.rb
 - lib/rubocop/cop/thoughtbot/no_before.rb
 - lib/rubocop/cop/thoughtbot/no_let.rb
 - lib/rubocop/cop/thoughtbot/resourceful_actions.rb
@@ -69,13 +70,15 @@ files:
 - lib/rubocop/thoughtbot.rb
 - lib/rubocop/thoughtbot/plugin.rb
 - lib/rubocop/thoughtbot/version.rb
-homepage: http://github.com/thoughtbot/rubocop-thoughtbot
+homepage: https://github.com/thoughtbot/rubocop-thoughtbot
 licenses:
 - MIT
 metadata:
-  homepage_uri: http://github.com/thoughtbot/rubocop-thoughtbot
-  source_code_uri: http://github.com/thoughtbot/rubocop-thoughtbot
-  changelog_uri: http://github.com/thoughtbot/rubocop-thoughtbot/blob/main/CHANGELOG.md
+  homepage_uri: https://github.com/thoughtbot/rubocop-thoughtbot
+  source_code_uri: https://github.com/thoughtbot/rubocop-thoughtbot
+  changelog_uri: https://github.com/thoughtbot/rubocop-thoughtbot/blob/main/CHANGELOG.md
+  documentation_uri: https://github.com/thoughtbot/rubocop-thoughtbot/blob/main/docs/modules/ROOT/pages/cops_thoughtbot.adoc
+  bug_tracker_uri: https://github.com/thoughtbot/rubocop-thoughtbot/issues
   rubygems_mfa_required: 'true'
   default_lint_roller_plugin: RuboCop::Thoughtbot::Plugin
 rdoc_options: []