rubocop-rspec-extra 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 15b0c1d5b0b7c30874b0c8f567006e6ae733d4ad096eaa885b9397feed61de69
-  data.tar.gz: 47e774fa8976ee7a0d8f3b348224d2ccb95bc529334880aa1bd6a71f02e941a2
+  metadata.gz: d885353b04e17a9ba6e002a3aeaa1d58726f13d9134edfdbfb5adac37d72d312
+  data.tar.gz: 0720cb32f2ce81e26e687870cccd9fc6174e10340f077f50bdbc89661278ae45
 SHA512:
-  metadata.gz: 53973d3db669c54dcdcee88596381906a407d33d63eec4c1536c361f118b59de9a3f8bc90a4984462cd6507af0c9bb080cfd59de20724341c6e3fff7969a2609
-  data.tar.gz: ed2a3474c9676133f943bab5170cc0f0b20a1f5b5f06e8d6f6ba60e8aea78b721838e8df9ff2e8a4d85bc06902489e543e50d2a46d886421727d347fff2bb04a
+  metadata.gz: cfd41a33039afbd015fb9ee731ddb16055ecc42e29f844dfba12b307595dd9f06ab1f7d317e8e204ed39932d23b8a679eb3458d0da97e55274909d9e2b3407b8
+  data.tar.gz: e178ee6def16d08d667df04bd4fd4514fdc69d110d00dc825f213e5f797deacd8b6078f8b125d7a441643eef32ee5dbfd5a803f6bbc6735ae3d548fa98172751

data/.rubocop.yml

@@ -1,7 +1,7 @@
 inherit_from: .rubocop_todo.yml
 
-require:
-  - rubocop/cop/internal_affairs
+plugins:
+  - rubocop-internal_affairs
   - rubocop-performance
   - rubocop-rake
   - rubocop-rspec

data/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 ## Master (Unreleased)
 
+## 0.3.0 (2025-03-19)
+
+- Pluginfy RuboCop RSpec Extra. ([@ydah])
+- Add `RSpec/Extra/FlatExamples` cop. ([@ydah])
+
 ## 0.2.0 (2024-03-01)
 
 - Fix an error for `RSpec/Extra/RestrictBlockTag`. ([@ydah])

data/Gemfile

@@ -9,5 +9,5 @@ gem "rake"
 gem "rspec", "~> 3.11"
 gem "rubocop-performance", "~> 1.7"
 gem "rubocop-rake", "~> 0.6"
-gem "rubocop-rspec", "~> 2.18"
+gem "rubocop-rspec", "~> 3.0"
 gem "yard"

data/README.md

@@ -28,13 +28,13 @@ ways to do this:
 Put this into your `.rubocop.yml`.
 
 ```yaml
-require: rubocop-rspec-extra
+plugins: rubocop-rspec-extra
 ```
 
 Alternatively, use the following array notation when specifying multiple extensions.
 
 ```yaml
-require:
+plugins:
   - rubocop-rspec
   - rubocop-rspec-extra
 ```
@@ -42,17 +42,20 @@ require:
 Now you can run `rubocop` and it will automatically load the RuboCop RSpec Extra
 cops together with the standard cops.
 
+> [!NOTE]
+> The plugin system is supported in RuboCop 1.72+. In earlier versions, use `require` instead of `plugins`.
+
 ### Command line
 
 ```bash
-rubocop --require rubocop-rspec-extra
+rubocop --plugins rubocop-rspec-extra
 ```
 
 ### Rake task
 
 ```ruby
 RuboCop::RakeTask.new do |task|
-  task.requires << 'rubocop-rspec-extra'
+  task.plugins << 'rubocop-rspec-extra'
 end
 ```
 
@@ -62,7 +65,7 @@ All cops are located under
 [`lib/rubocop/cop/rspec/extra`](lib/rubocop/cop/rspec/extra), and contain
 examples/documentation.
 
-In your `.rubocop.yml`, you may treat the Committee cops just like any other
+In your `.rubocop.yml`, you may treat the RSpec extra cops just like any other
 cop. For example:
 
 ```yaml
@@ -77,5 +80,5 @@ Checkout the [contribution guidelines](.github/CONTRIBUTING.md).
 
 ## License
 
-`rubocop-committee` is MIT licensed. [See the accompanying file](MIT-LICENSE.md) for
+`rubocop-rspec-extra` is MIT licensed. [See the accompanying file](MIT-LICENSE.md) for
 the full text.

data/config/default.yml

@@ -8,6 +8,11 @@ RSpec/Extra/BeEmpty:
   VersionAdded: '0.1'
   Reference: https://www.rubydoc.info/gems/rubocop-rspec-extra/RuboCop/Cop/RSpec/Extra/BeEmpty
 
+RSpec/Extra/FlatExamples:
+  Description: 'Restrict unnecessary nesting by example groups.'
+  Enabled: false
+  VersionAdded: '0.3'
+
 RSpec/Extra/RestrictBlockTag:
   Description: 'Restrict to only allowed block tags.'
   Enabled: false

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

@@ -2,8 +2,9 @@
 
 === Department xref:cops_rspec_extra.adoc[RSpec/Extra]
 
-* xref:cops_rspec_extra.adoc#rspecextra/beempty[RSpec/Extra/BeEmpty]
-* xref:cops_rspec_extra.adoc#rspecextra/restrictblocktag[RSpec/Extra/RestrictBlockTag]
-* xref:cops_rspec_extra.adoc#rspecextra/restrictblocktagvalue[RSpec/Extra/RestrictBlockTagValue]
+* xref:cops_rspec_extra.adoc#rspecextrabeempty[RSpec/Extra/BeEmpty]
+* xref:cops_rspec_extra.adoc#rspecextraflatexamples[RSpec/Extra/FlatExamples]
+* xref:cops_rspec_extra.adoc#rspecextrarestrictblocktag[RSpec/Extra/RestrictBlockTag]
+* xref:cops_rspec_extra.adoc#rspecextrarestrictblocktagvalue[RSpec/Extra/RestrictBlockTagValue]
 
 // END_COP_LIST

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

@@ -6,20 +6,22 @@
 
 = RSpec/Extra
 
+[#rspecextrabeempty]
 == RSpec/Extra/BeEmpty
 
 |===
 | Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
 
-| Pending
+| Enabled
 | Yes
 | Always
-| 0.2
+| -
 | -
 |===
 
 Prefer using `be_empty` when checking for an empty array.
 
+[#examples-rspecextrabeempty]
 === Examples
 
 [source,ruby]
@@ -38,26 +40,56 @@ expect(array).to match_array([])
 expect(array).to be_empty
 ----
 
-=== References
+[#rspecextraflatexamples]
+== RSpec/Extra/FlatExamples
+
+|===
+| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
+
+| Enabled
+| Yes
+| No
+| -
+| -
+|===
+
+Restrict unnecessary nesting by example groups.
+
+[#examples-rspecextraflatexamples]
+=== Examples
+
+[source,ruby]
+----
+# bad
+context 'when condition' do
+  it 'tests something' do
+  end
+end
 
-* https://www.rubydoc.info/gems/rubocop-rspec-extra/RuboCop/Cop/RSpec/Extra/BeEmpty
+# good
+it 'tests something when condition' do
+end
+----
 
+[#rspecextrarestrictblocktag]
 == RSpec/Extra/RestrictBlockTag
 
 |===
 | Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
 
-| Disabled
+| Enabled
 | Yes
 | No
-| 0.2
+| -
 | -
 |===
 
 Restrict to only allowed block tags.
 
+[#examples-rspecextrarestrictblocktag]
 === Examples
 
+[#allowtags_-__foo__-_bar__-rspecextrarestrictblocktag]
 ==== AllowTags: ['foo', 'bar']
 
 [source,ruby]
@@ -83,32 +115,25 @@ RSpec.describe 'Something' do
 end
 ----
 
-=== Configurable attributes
-
-|===
-| Name | Default value | Configurable values
-
-| AllowTags
-| `[]`
-| Array
-|===
-
+[#rspecextrarestrictblocktagvalue]
 == RSpec/Extra/RestrictBlockTagValue
 
 |===
 | Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
 
-| Pending
+| Enabled
 | Yes
 | No
-| 0.2
+| -
 | -
 |===
 
 Restrict to only allowed block tag value.
 
+[#examples-rspecextrarestrictblocktagvalue]
 === Examples
 
+[#allowtagvalues_-_-foo_-_baz_-_-rspecextrarestrictblocktagvalue]
 ==== AllowTagValues: { foo: 'baz' }
 
 [source,ruby]
@@ -121,13 +146,3 @@ end
 RSpec.describe 'Something', foo: :baz do
 end
 ----
-
-=== Configurable attributes
-
-|===
-| Name | Default value | Configurable values
-
-| AllowTagValues
-| `{}`
-| 
-|===

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

@@ -8,13 +8,13 @@ There are some ways to do this:
 Put this into your `.rubocop.yml`:
 
 ----
-require: rubocop-rspec-extra
+plugins: rubocop-rspec-extra
 ----
 
 or, if you are using several extensions:
 
 ----
-require:
+plugins:
   - rubocop-rspec
   - rubocop-rspec-extra
 ----
@@ -24,7 +24,7 @@ cops together with the standard cops.
 
 [source,bash]
 ----
-$ rubocop --require rubocop-rspec-extra
+$ rubocop --plugins rubocop-rspec-extra
 ----
 
 == Rake task
@@ -32,6 +32,8 @@ $ rubocop --require rubocop-rspec-extra
 [source,ruby]
 ----
 RuboCop::RakeTask.new do |task|
-  task.requires << 'rubocop-rspec-extra'
+  task.plugins << 'rubocop-rspec-extra'
 end
 ----
+
+NOTE: The plugin system is supported in RuboCop 1.72+. In earlier versions, use `require` instead of `plugins`.

data/lib/rubocop/cop/rspec/extra/be_empty.rb

@@ -57,7 +57,7 @@ module RuboCop
             )
           PATTERN
 
-          def on_send(node)
+          def on_send(node) # rubocop:disable InternalAffairs/OnSendWithoutOnCSend
             expect_array_empty_true?(node.parent) do |actual, expect|
               register_offense(actual, expect)
             end

data/lib/rubocop/cop/rspec/extra/flat_examples.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      module Extra
+        # Restrict unnecessary nesting by example groups.
+        #
+        # @example
+        #   # bad
+        #   context 'when condition' do
+        #     it 'tests something' do
+        #     end
+        #   end
+        #
+        #   # good
+        #   it 'tests something when condition' do
+        #   end
+        #
+        class FlatExamples < Base
+          MSG = "Unnecessary nesting by example groups detected."
+
+          # @!method redundant?(node)
+          def_node_matcher :redundant?, <<~PATTERN
+            (block (send #rspec? #ExampleGroups.regular ...) _ (block (send _ #Examples.regular ...) ...))
+          PATTERN
+
+          def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
+            return unless redundant?(node)
+
+            add_offense(node)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/rspec/extra/plugin.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "lint_roller"
+
+module RuboCop
+  module RSpec
+    module Extra
+      # A plugin that integrates RuboCop RSpec Extra with RuboCop's plugin system.
+      class Plugin < LintRoller::Plugin
+        def about
+          LintRoller::About.new(
+            name: "rubocop-rspec-extra",
+            version: Version::STRING,
+            homepage: "https://github.com/ydah/rubocop-rspec-extra",
+            description: "A RuboCop extension focused on enforcing RSpec. A place where no one is officially employed, but where useful cops can gather."
+          )
+        end
+
+        def supported?(context)
+          context.engine == :rubocop
+        end
+
+        def rules(_context)
+          project_root = Pathname.new(__dir__).join("../../../..")
+
+          LintRoller::Rules.new(type: :path, config_format: :rubocop, value: project_root.join("config", "default.yml"))
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/rspec/extra/version.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 module Rubocop
-  module Rspec
+  module RSpec
     module Extra
-      VERSION = "0.2.0"
+      VERSION = "0.3.0"
     end
   end
 end

data/lib/rubocop-rspec-extra.rb

@@ -2,22 +2,17 @@
 
 require "rubocop-rspec"
 
-require_relative "rubocop/rspec/extra/inject"
 require_relative "rubocop/rspec/extra/version"
-
+require_relative "rubocop/rspec/extra/plugin"
 require_relative "rubocop/cop/rspec/extra/be_empty"
+require_relative "rubocop/cop/rspec/extra/flat_examples"
 require_relative "rubocop/cop/rspec/extra/restrict_block_tag"
 require_relative "rubocop/cop/rspec/extra/restrict_block_tag_value"
 
-module RuboCop
+module Rubocop
   module RSpec
+    # RuboCop RSpec Rails project namespace.
     module Extra
-      PROJECT_ROOT = ::Pathname.new(__dir__).parent.expand_path.freeze
-      CONFIG_DEFAULT = PROJECT_ROOT.join("config", "default.yml").freeze
-      CONFIG = ::YAML.safe_load(CONFIG_DEFAULT.read).freeze
-      private_constant(:CONFIG_DEFAULT, :PROJECT_ROOT)
     end
   end
 end
-
-RuboCop::RSpec::Extra::Inject.defaults!

data/tasks/cut_release.rake

@@ -13,7 +13,7 @@ namespace :cut_release do
   def add_header_to_changelog(version)
     update_file("CHANGELOG.md") do |changelog|
       changelog.sub("## Master (Unreleased)\n\n",
-                    '\0' "## #{version} (#{Time.now.strftime("%F")})\n\n")
+                    "\\0## #{version} (#{Time.now.strftime("%F")})\n\n")
     end
   end
 

metadata

@@ -1,29 +1,48 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-rspec-extra
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - ydah
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-29 00:00:00.000000000 Z
+date: 2025-03-18 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: lint_roller
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.72.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.72.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 description: |
   A RuboCop extension focused on enforcing RSpec.
   A place where no one is officially employed, but where useful cops can gather.
@@ -55,9 +74,10 @@ files:
 - docs/modules/ROOT/pages/usage.adoc
 - lib/rubocop-rspec-extra.rb
 - lib/rubocop/cop/rspec/extra/be_empty.rb
+- lib/rubocop/cop/rspec/extra/flat_examples.rb
 - lib/rubocop/cop/rspec/extra/restrict_block_tag.rb
 - lib/rubocop/cop/rspec/extra/restrict_block_tag_value.rb
-- lib/rubocop/rspec/extra/inject.rb
+- lib/rubocop/rspec/extra/plugin.rb
 - lib/rubocop/rspec/extra/version.rb
 - tasks/cops_documentation.rake
 - tasks/cut_release.rake
@@ -69,8 +89,8 @@ metadata:
   homepage_uri: https://github.com/ydah/rubocop-rspec-extra
   source_code_uri: https://github.com/ydah/rubocop-rspec-extra
   changelog_uri: https://github.com/ydah/rubocop-rspec-extra/blob/master/CHANGELOG.md
+  default_lint_roller_plugin: RuboCop::RSpec::Extra::Plugin
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -85,8 +105,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
-signing_key:
+rubygems_version: 3.7.0.dev
 specification_version: 4
 summary: A RuboCop extension focused on enforcing RSpec.
 test_files: []

data/lib/rubocop/rspec/extra/inject.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module RSpec
-    module Extra
-      module Inject
-        def self.defaults!
-          path = CONFIG_DEFAULT.to_s
-          hash = ::RuboCop::ConfigLoader.send(:load_yaml_configuration, path)
-          config = ::RuboCop::Config.new(hash, path).tap(&:make_excludes_absolute)
-          puts "configuration from #{path}" if ::RuboCop::ConfigLoader.debug?
-          config = ::RuboCop::ConfigLoader.merge_with_default(config, path)
-          ::RuboCop::ConfigLoader.instance_variable_set(:@default_configuration, config)
-        end
-      end
-    end
-  end
-end