rubocop-rspec-extra 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b6d37e0a9b8e12b308c8f45612176fd83edd6a6ce1852746dc0140efba3efb6b
+  data.tar.gz: ef9b88f0c670940a7f79b8c4ae6e73f1f8b492b630cceb540dab1c6a85ec003e
+SHA512:
+  metadata.gz: 6ba9025e60e671873a082672d0677fc2eacd07c60f1d1fca1d9ac6068fdd9d1894faf6336e37d63f86bfbc9bcb482477bd246176e23967cd9f36df316107a323
+  data.tar.gz: e6b5eda765dd616f7ba4d9e24c93462b0440986b00098f11c21993c45e93e8391723e6301db74f2a53beae6745caf7e51cee045f4696a03b8f44d1808669aa37

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,35 @@
+inherit_from: .rubocop_todo.yml
+
+require:
+  - rubocop/cop/internal_affairs
+  - rubocop-performance
+  - rubocop-rake
+  - rubocop-rspec
+  - rubocop-rspec-extra
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.6
+  SuggestExtensions: false
+
+Layout/LineLength:
+  Enabled: false
+
+Metrics:
+  Enabled: false
+
+Naming/FileName:
+  Exclude:
+    - lib/rubocop-rspec-extra.rb
+
+Style/Documentation:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+RSpec/ExampleLength:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,12 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config --auto-gen-only-exclude --no-exclude-limit --no-auto-gen-timestamp`
+# using RuboCop version 1.47.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 10
+Rake/MethodDefinitionInTask:
+  Exclude:
+    - 'tasks/cut_release.rake'

data/.yamllint.yml

@@ -0,0 +1,9 @@
+extends: default
+
+rules:
+  comments:
+    min-spaces-from-content: 1
+  document-start: disable
+  line-length: disable
+  truthy:
+    check-keys: false

data/.yardopts

@@ -0,0 +1,2 @@
+--markup markdown
+--hide-void-return

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## Unreleased
+
+## 0.1.0 - 2023-04-18
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at t.yudai92@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.
+
+[homepage]: https://www.contributor-covenant.org

data/Gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+gem "bump", require: false
+gem "rake"
+gem "rspec", "~> 3.11"
+gem "rubocop-performance", "~> 1.7"
+gem "rubocop-rake", "~> 0.6"
+gem "rubocop-rspec", "~> 2.18"
+gem "yard"

data/MIT-LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Yudai Takada
+
+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,81 @@
+# Rubocop::Rspec::Extra
+
+![GitHub top language](https://img.shields.io/github/languages/top/ydah/rubocop-rspec-extra) ![GitHub](https://img.shields.io/github/license/ydah/rubocop-rspec-extra) ![Ruby Style Guide](https://img.shields.io/badge/code_style-rubocop-brightgreen.svg) [![CI](https://github.com/ydah/rubocop-rspec-extra/actions/workflows/ci.yml/badge.svg)](https://github.com/ydah/rubocop-rspec-extra/actions/workflows/ci.yml) [![Maintainability](https://api.codeclimate.com/v1/badges/6b1f27edd867a4b64661/maintainability)](https://codeclimate.com/github/ydah/rubocop-rspec-extra/maintainability)
+
+A [RuboCop](https://github.com/rubocop/rubocop) extension focused on enforcing RSpec. A place where no one is officially employed, but where useful cops can gather.
+
+## Installation
+
+Just install the `rubocop-rspec-extra` gem
+
+```bash
+gem install rubocop-rspec-extra
+```
+
+or if you use bundler put this in your `Gemfile`
+
+```bash
+gem 'rubocop-rspec-extra', require: false
+```
+
+## Usage
+
+You need to tell RuboCop to load the RSpec Extra extension. There are two
+ways to do this:
+
+### RuboCop configuration file
+
+Put this into your `.rubocop.yml`.
+
+```yaml
+require: rubocop-rspec-extra
+```
+
+Alternatively, use the following array notation when specifying multiple extensions.
+
+```yaml
+require:
+  - rubocop-rspec
+  - rubocop-rspec-extra
+```
+
+Now you can run `rubocop` and it will automatically load the RuboCop RSpec Extra
+cops together with the standard cops.
+
+### Command line
+
+```bash
+rubocop --require rubocop-rspec-extra
+```
+
+### Rake task
+
+```ruby
+RuboCop::RakeTask.new do |task|
+  task.requires << 'rubocop-rspec-extra'
+end
+```
+
+## The Cops
+
+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
+cop. For example:
+
+```yaml
+RSpec/Extra/RestrictBlockTag:
+  Exclude:
+    - spec/my_poorly_named_spec_file.rb
+```
+
+## Contributing
+
+Checkout the [contribution guidelines](.github/CONTRIBUTING.md).
+
+## License
+
+`rubocop-committee` is MIT licensed. [See the accompanying file](MIT-LICENSE.md) for
+the full text.

data/Rakefile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+Dir["tasks/**/*.rake"].each { |t| load t }
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/config/default.yml

@@ -0,0 +1,21 @@
+---
+RSpec/Extra:
+  Enabled: true
+
+RSpec/Extra/BeEmpty:
+  Description: Prefer using `be_empty` when checking for an empty array.
+  Enabled: pending
+  VersionAdded: '<<next>>'
+  Reference: https://www.rubydoc.info/gems/rubocop-rspec-extra/RuboCop/Cop/RSpec/Extra/BeEmpty
+
+RSpec/Extra/RestrictBlockTag:
+  Description: 'Restrict to only allowed block tags.'
+  Enabled: false
+  VersionAdded: '<<next>>'
+  AllowTags: []
+
+RSpec/Extra/RestrictBlockTagValue:
+  Description: 'Restrict to only allowed block tag value.'
+  Enabled: pending
+  VersionAdded: '<<next>>'
+  AllowTagValues: {}

data/docs/antora.yml

@@ -0,0 +1,5 @@
+name: rubocop-rspec-extra
+title: RuboCop RSpec Extra
+version: ~
+nav:
+  - modules/ROOT/nav.adoc

data/docs/modules/ROOT/nav.adoc

@@ -0,0 +1,6 @@
+* xref:index.adoc[Home]
+* xref:installation.adoc[Installation]
+* xref:usage.adoc[Usage]
+* xref:cops.adoc[Cops]
+* Cops Documentation
+** xref:cops_rspec_extra.adoc[Extra]

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

@@ -0,0 +1,9 @@
+// START_COP_LIST
+
+=== 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]
+
+// END_COP_LIST

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

@@ -0,0 +1,127 @@
+= RSpec/Extra
+
+== RSpec/Extra/BeEmpty
+
+|===
+| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
+
+| Pending
+| Yes
+| Yes
+| <<next>>
+| -
+|===
+
+Prefer using `be_empty` when checking for an empty array.
+
+=== Examples
+
+[source,ruby]
+----
+# bad
+expect(array.empty?).to be true
+expect(array.empty?).to be_truthy
+expect(array.size).to eq(0)
+expect(array.length).to eq(0)
+expect(array.count).to eq(0)
+expect(array).to eql([])
+expect(array).to contain_exactly
+expect(array).to match_array([])
+
+# good
+expect(array).to be_empty
+----
+
+=== References
+
+* https://www.rubydoc.info/gems/rubocop-rspec-extra/RuboCop/Cop/RSpec/Extra/BeEmpty
+
+== RSpec/Extra/RestrictBlockTag
+
+|===
+| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
+
+| Disabled
+| Yes
+| No
+| <<next>>
+| -
+|===
+
+Restrict to only allowed block tags.
+
+=== Examples
+
+==== AllowTags: ['foo', 'bar']
+
+[source,ruby]
+----
+# bad
+RSpec.describe 'Something', :baz do
+end
+
+# bad
+RSpec.describe 'Something' do
+  context 'when something', baz: :foo do
+  end
+end
+
+# good
+RSpec.describe 'Something', :foo do
+end
+
+# good
+RSpec.describe 'Something' do
+  context 'when something', bar: :foo do
+  end
+end
+----
+
+=== Configurable attributes
+
+|===
+| Name | Default value | Configurable values
+
+| AllowTags
+| `[]`
+| Array
+|===
+
+== RSpec/Extra/RestrictBlockTagValue
+
+|===
+| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
+
+| Pending
+| Yes
+| No
+| <<next>>
+| -
+|===
+
+Restrict to only allowed block tag value.
+
+=== Examples
+
+==== AllowTagValues: { foo: 'baz' }
+
+[source,ruby]
+----
+# bad
+RSpec.describe 'Something', foo: :bar do
+end
+
+# good
+RSpec.describe 'Something', foo: :baz do
+end
+----
+
+=== Configurable attributes
+
+|===
+| Name | Default value | Configurable values
+
+| AllowTagValues
+| `{}`
+| 
+|===

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

@@ -0,0 +1,17 @@
+= RuboCop RSpec Extra
+
+RSpec-specific analysis for your projects, as an extension to
+https://github.com/rubocop/rubocop[RuboCop].
+A place where no one is officially employed, but where useful cops can gather.
+
+RuboCop RSpec Extra follows the https://docs.rubocop.org/rubocop/versioning.html[RuboCop versioning guide].
+In a nutshell, between major versions new cops are introduced in a special `pending` status.
+That means that they won’t be run unless explicitly told otherwise.
+RuboCop will warn on start that certain cops are neither explicitly enabled and disabled.
+On a major version release, all `pending` cops are enabled.
+
+== Project Goals
+
+
+* Simplify the process of adopting new RSpec functionality
+* A collection of cops who are not hired by RuboCop RSpec but are useful when writing test code in RSpec

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

@@ -0,0 +1,15 @@
+= Installation
+
+Just install the `rubocop-rspec` gem
+
+[source,bash]
+----
+gem install rubocop-rspec-extra
+----
+
+or if you use bundler put this in your `Gemfile`
+
+[source,ruby]
+----
+gem 'rubocop-rspec-extra'
+----

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

@@ -0,0 +1,37 @@
+= Usage
+
+You need to tell RuboCop to load the RuboCop RSpec Extra extension.
+There are some ways to do this:
+
+== RuboCop configuration file
+
+Put this into your `.rubocop.yml`:
+
+----
+require: rubocop-rspec-extra
+----
+
+or, if you are using several extensions:
+
+----
+require:
+  - rubocop-rspec
+  - rubocop-rspec-extra
+----
+
+Now you can run `rubocop` and it will automatically load the RuboCop RSpec Extra
+cops together with the standard cops.
+
+[source,bash]
+----
+$ rubocop --require rubocop-rspec-extra
+----
+
+== Rake task
+
+[source,ruby]
+----
+RuboCop::RakeTask.new do |task|
+  task.requires << 'rubocop-rspec-extra'
+end
+----

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

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      module Extra
+        # Prefer using `be_empty` when checking for an empty array.
+        #
+        # @example
+        #   # bad
+        #   expect(array.empty?).to be true
+        #   expect(array.empty?).to be_truthy
+        #   expect(array.size).to eq(0)
+        #   expect(array.length).to eq(0)
+        #   expect(array.count).to eq(0)
+        #   expect(array).to eql([])
+        #   expect(array).to contain_exactly
+        #   expect(array).to match_array([])
+        #
+        #   # good
+        #   expect(array).to be_empty
+        #
+        class BeEmpty < Base
+          extend AutoCorrector
+
+          MSG = "Use `be_empty` matchers for checking an empty array."
+          RESTRICT_ON_SEND =
+            %i[be be_truthy eq eql contain_exactly match_array].freeze
+
+          # @!method expect_array_empty_true?(node)
+          def_node_matcher :expect_array_empty_true?, <<~PATTERN
+            (send
+              (send nil? :expect $(send _ :empty?))
+              #Runners.all
+              ${(send nil? :be true) (send nil? :be_truthy)}
+            )
+          PATTERN
+
+          # @!method expect_array_size_zero?(node)
+          def_node_matcher :expect_array_size_zero?, <<~PATTERN
+            (send
+              (send nil? :expect $(send _ {:size :length :count}))
+              #Runners.all
+              $(send nil? {:eq :eql} (int 0))
+            )
+          PATTERN
+
+          # @!method expect_array_matcher?(node)
+          def_node_matcher :expect_array_matcher?, <<~PATTERN
+            (send
+              (send nil? :expect _)
+              #Runners.all
+              ${
+                (send nil? {:eq :eql :match_array} (array))
+                (send nil? :contain_exactly)
+              }
+            )
+          PATTERN
+
+          def on_send(node)
+            expect_array_empty_true?(node.parent) do |actual, expect|
+              register_offense(actual, expect)
+            end
+            expect_array_size_zero?(node.parent) do |actual, expect|
+              register_offense(actual, expect)
+            end
+            expect_array_matcher?(node.parent) do |expect|
+              register_offense(nil, expect)
+            end
+          end
+
+          private
+
+          def register_offense(actual, expect)
+            add_offense(expect) do |corrector|
+              corrector.replace(actual, actual.receiver.source) if actual
+              corrector.replace(expect, "be_empty")
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      module Extra
+        # Restrict to only allowed block tags.
+        #
+        # @example AllowTags: ['foo', 'bar']
+        #   # bad
+        #   RSpec.describe 'Something', :baz do
+        #   end
+        #
+        #   # bad
+        #   RSpec.describe 'Something' do
+        #     context 'when something', baz: :foo do
+        #     end
+        #   end
+        #
+        #   # good
+        #   RSpec.describe 'Something', :foo do
+        #   end
+        #
+        #   # good
+        #   RSpec.describe 'Something' do
+        #     context 'when something', bar: :foo do
+        #     end
+        #   end
+        #
+        class RestrictBlockTag < Base
+          include Metadata
+
+          def on_metadata(symbols, pairs)
+            offenses = (symbols + pairs.map(&:key)).filter do |symbol|
+              !allow_tags.include?(symbol.value.to_s)
+            end
+
+            return unless offenses.any?
+
+            offenses.each do |offense|
+              add_offense(offense, message: offense_message)
+            end
+          end
+
+          private
+
+          def offense_message
+            if allow_tags.any?
+              format("This tag is not allowed. Allowed tags: %<allow_tags>s.", allow_tags: allow_tags.join(", "))
+            else
+              "Tags are not allowed."
+            end
+          end
+
+          def allow_tags
+            cop_config.fetch("AllowTags", [])
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      module Extra
+        # Restrict to only allowed block tag value.
+        #
+        # @example AllowTagValues: { foo: 'baz' }
+        #   # bad
+        #   RSpec.describe 'Something', foo: :bar do
+        #   end
+        #
+        #   # good
+        #   RSpec.describe 'Something', foo: :baz do
+        #   end
+        #
+        class RestrictBlockTagValue < Base
+          include Metadata
+          MSG = "This value is not allowed in this tag. Allowed tag value: %<allow_tag_value>s."
+
+          def on_metadata(_symbols, pairs)
+            offenses = pairs.filter do |pair|
+              allow_tag_values.any? do |k, v|
+                pair.key.value.to_s == k &&
+                  pair.value.value.to_s != v
+              end
+            end
+
+            return unless offenses.any?
+
+            offenses.each do |offense|
+              add_offense(offense, message: format(MSG, allow_tag_value: allow_tag_values[offense.key.value.to_s]))
+            end
+          end
+
+          private
+
+          def allow_tag_values
+            cop_config.fetch("AllowTagValues", {})
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# 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

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

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Rubocop
+  module Rspec
+    module Extra
+      VERSION = "0.1.0"
+    end
+  end
+end

data/lib/rubocop-rspec-extra.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "rubocop-rspec"
+
+require_relative "rubocop/rspec/extra/inject"
+require_relative "rubocop/rspec/extra/version"
+
+require_relative "rubocop/cop/rspec/extra/be_empty"
+require_relative "rubocop/cop/rspec/extra/restrict_block_tag"
+require_relative "rubocop/cop/rspec/extra/restrict_block_tag_value"
+
+module RuboCop
+  module RSpec
+    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/changelog.rake

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+autoload :Changelog, "#{__dir__}/changelog"
+
+namespace :changelog do
+  %i[new fix change].each do |type|
+    desc "Create a Changelog entry (#{type})"
+    task type, [:id] do |_task, args|
+      ref_type = :pull if args[:id]
+      path = Changelog::Entry.new(type: type, ref_id: args[:id], ref_type: ref_type).write
+      cmd = "git add #{path}"
+      system cmd
+      puts "Entry '#{path}' created and added to git index"
+    end
+  end
+
+  desc "Merge entries and delete them"
+  task :merge do
+    raise "No entries!" unless Changelog.pending?
+
+    Changelog.new.merge!.and_delete!
+    cmd = "git commit -a -m 'Update Changelog'"
+    puts cmd
+    system cmd
+  end
+
+  desc "Check to see if there are any entries left"
+  task :check_clean do
+    next unless Changelog.pending?
+
+    puts "*** Pending changelog entries!"
+    puts "Do `bundle exec rake changelog:merge`"
+    exit(1)
+  end
+end

data/tasks/changelog.rb

@@ -0,0 +1,193 @@
+# frozen_string_literal: true
+
+if RUBY_VERSION < "2.6"
+  puts "Changelog utilities available only for Ruby 2.6+"
+  exit(1)
+end
+
+# Changelog utility
+class Changelog
+  ENTRIES_PATH = "changelog/"
+  FIRST_HEADER = /#{Regexp.escape("## Master (Unreleased)\n")}/m.freeze
+  CONTRIBUTORS_HEADER = /#{Regexp.escape("<!-- Contributors (alphabetically) -->\n\n")}/m.freeze
+  ENTRIES_PATH_TEMPLATE = "#{ENTRIES_PATH}%<type>s_%<name>s.md"
+  TYPE_REGEXP = /#{Regexp.escape(ENTRIES_PATH)}([a-z]+)_/.freeze
+  TYPE_TO_HEADER = { new: "New features", fix: "Bug fixes", change: "Changes" }.freeze
+  HEADER = /### (.*)/.freeze
+  PATH = "CHANGELOG.md"
+  REF_URL = "https://github.com/rubocop/rubocop-rspec-extra"
+  MAX_LENGTH = 40
+  CONTRIBUTOR = "[@%<link>s]: https://github.com/%<user>s"
+  SIGNATURE = Regexp.new(format(Regexp.escape("[@%<user>s]"), user: '([\w-]+)'))
+  EOF = "\n"
+
+  # New entry
+  Entry = Struct.new(:type, :body, :ref_type, :ref_id, :user, keyword_init: true) do
+    def initialize(type:, body: last_commit_title, ref_type: nil, ref_id: nil, user: github_user)
+      id, body = extract_id(body)
+      ref_id ||= id || "x"
+      ref_type ||= id ? :issues : :pull
+      super
+    end
+
+    def write
+      FileUtils.mkdir_p(ENTRIES_PATH)
+      File.write(path, content)
+      path
+    end
+
+    def path
+      format(ENTRIES_PATH_TEMPLATE, type: type, name: str_to_filename(body))
+    end
+
+    def content
+      period = "." unless body.end_with? "."
+      "- #{ref}: #{body}#{period} ([@#{user}])\n"
+    end
+
+    def ref
+      "[##{ref_id}](#{REF_URL}/#{ref_type}/#{ref_id})"
+    end
+
+    def last_commit_title
+      `git log -1 --pretty=%B`.lines.first.chomp
+    end
+
+    def extract_id(body)
+      /^\[Fix(?:es)? #(\d+)\] (.*)/.match(body)&.captures || [nil, body]
+    end
+
+    def str_to_filename(str)
+      str
+        .split
+        .reject(&:empty?)
+        .map { |s| prettify(s) }
+        .inject do |result, word|
+          s = "#{result}_#{word}"
+          return result if s.length > MAX_LENGTH
+
+          s
+        end
+    end
+
+    def github_user
+      user = `git config --global credential.username`.chomp
+      warn 'Set your username with `git config --global credential.username "myusernamehere"`' if user.empty?
+
+      user
+    end
+
+    private
+
+    def prettify(str)
+      str.gsub!(/\W/, "_")
+
+      # Separate word boundaries by `_`.
+      str.gsub!(/([A-Z]+)(?=[A-Z][a-z])|([a-z\d])(?=[A-Z])/) do
+        (Regexp.last_match(1) || Regexp.last_match(2)) << "_"
+      end
+
+      str.gsub!(/\A_+|_+\z/, "")
+      str.downcase!
+      str
+    end
+  end
+
+  def self.pending?
+    entry_paths.any?
+  end
+
+  def self.entry_paths
+    Dir["#{ENTRIES_PATH}*"]
+  end
+
+  def self.read_entries
+    entry_paths.to_h { |path| [path, File.read(path)] }
+  end
+
+  attr_reader :header, :rest
+
+  def initialize(content: File.read(PATH), entries: Changelog.read_entries)
+    require "strscan"
+
+    parse(content)
+    @entries = entries
+  end
+
+  def and_delete!
+    @entries.each_key { |path| File.delete(path) }
+  end
+
+  def merge!
+    File.write(PATH, merge_content)
+    self
+  end
+
+  def unreleased_content
+    entry_map = parse_entries(@entries)
+    merged_map = merge_entries(entry_map)
+    merged_map.flat_map do |header, things|
+      ["### #{header}\n", *things, ""]
+    end.join("\n")
+  end
+
+  def merge_content
+    merged_content = [@header, unreleased_content, @changes.chomp, *all_contributors].join("\n")
+
+    merged_content << EOF
+  end
+
+  def all_contributors
+    (@contributors.split(/\R/) + new_contributors).uniq.sort
+  end
+
+  def new_contributors
+    contributors
+      .map { |user| format(CONTRIBUTOR, link: user.downcase, user: user) }
+  end
+
+  def contributors
+    contributors = @entries.values.flat_map do |entry|
+      entry.match(/\. \((?<contributors>.+)\)\n/)[:contributors].split(",")
+    end
+
+    contributors.join.scan(SIGNATURE).flatten
+  end
+
+  private
+
+  def merge_entries(entry_map)
+    all = @unreleased.merge(entry_map) { |_k, v1, v2| v1.concat(v2) }
+    canonical = TYPE_TO_HEADER.values.to_h { |v| [v, nil] }
+    canonical.merge(all).compact
+  end
+
+  def parse(content)
+    ss = StringScanner.new(content)
+    @header = ss.scan_until(FIRST_HEADER)
+    @unreleased = parse_release(ss.scan_until(/\n(?=## )/m))
+    @changes = ss.scan_until(CONTRIBUTORS_HEADER)
+    @contributors = ss.rest
+  end
+
+  # @return [Hash<type, Array<String>]]
+  def parse_release(unreleased)
+    unreleased
+      .lines
+      .map(&:chomp)
+      .reject(&:empty?)
+      .slice_before(HEADER)
+      .to_h do |header, *entries|
+        [HEADER.match(header)[1], entries]
+      end
+  end
+
+  def parse_entries(path_content_map)
+    changes = Hash.new { |h, k| h[k] = [] }
+    path_content_map.each do |path, content|
+      header = TYPE_TO_HEADER.fetch(TYPE_REGEXP.match(path)[1].to_sym)
+      changes[header].concat(content.lines.map(&:chomp))
+    end
+    changes
+  end
+end

data/tasks/cops_documentation.rake

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "rubocop"
+require "rubocop-rspec-extra"
+require "rubocop/cops_documentation_generator"
+require "yard"
+
+YARD::Rake::YardocTask.new(:yard_for_generate_documentation) do |task|
+  task.files = ["lib/rubocop/cop/**/*.rb"]
+  task.options = ["--no-output"]
+end
+
+desc "Generate docs of all cops departments"
+task generate_cops_documentation: :yard_for_generate_documentation do
+  generator = CopsDocumentationGenerator.new(
+    departments: %w[RSpec/Extra]
+  )
+  generator.call
+end
+
+desc "Syntax check for the documentation comments"
+task documentation_syntax_check: :yard_for_generate_documentation do
+  require "parser/ruby25"
+
+  ok = true
+  YARD::Registry.load!
+  cops = RuboCop::Cop::Registry.global
+  cops.each do |cop|
+    examples = YARD::Registry.all(:class).find do |code_object|
+      next unless RuboCop::Cop::Badge.for(code_object.to_s) == cop.badge
+
+      break code_object.tags("example")
+    end
+
+    examples.to_a.each do |example|
+      buffer = Parser::Source::Buffer.new("<code>", 1)
+      buffer.source = example.text
+      parser = Parser::Ruby25.new(RuboCop::AST::Builder.new)
+      parser.diagnostics.all_errors_are_fatal = true
+      parser.parse(buffer)
+    rescue Parser::SyntaxError => e
+      path = example.object.file
+      puts "#{path}: Syntax Error in an example. #{e}"
+      ok = false
+    end
+  end
+  abort unless ok
+end

data/tasks/cut_release.rake

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require "bump"
+
+namespace :cut_release do
+  %w[major minor patch pre].each do |release_type|
+    desc "Cut a new #{release_type} release and create release notes."
+    task release_type => "changelog:check_clean" do
+      run(release_type)
+    end
+  end
+
+  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")
+    end
+  end
+
+  def create_release_notes(version)
+    release_notes = new_version_changes.strip
+    contributor_links = user_links(release_notes)
+
+    File.open("relnotes/v#{version}.md", "w") do |file|
+      file << release_notes
+      file << "\n\n"
+      file << contributor_links
+      file << "\n"
+    end
+  end
+
+  def update_antora_yml(new_version)
+    antora_metadata = File.read("docs/antora.yml")
+
+    File.open("docs/antora.yml", "w") do |f|
+      f << antora_metadata.sub("version: ~", "version: '#{version_sans_patch(new_version)}'")
+    end
+  end
+
+  def version_sans_patch(version)
+    version.split(".").take(2).join(".")
+  end
+
+  # Replace `<<next>>` (and variations) with version being cut.
+  def update_cop_versions(version)
+    update_file("config/default.yml") do |default|
+      default.gsub(/['"]?<<\s*next\s*>>['"]?/i,
+                   "'#{version_sans_patch(version)}'")
+    end
+    RuboCop::ConfigLoader.default_configuration = nil # invalidate loaded conf
+  end
+
+  def new_version_changes
+    changelog = File.read("CHANGELOG.md")
+    _, _, new_changes, _older_changes = changelog.split(/^## .*$/, 4)
+    new_changes
+  end
+
+  def update_file(path)
+    content = File.read(path)
+    File.write(path, yield(content))
+  end
+
+  def user_links(text)
+    names = text.scan(/\[@(\S+)\]/).map(&:first).uniq
+    names.map { |name| "[@#{name}]: https://github.com/#{name}" }.join("\n")
+  end
+
+  def update_docs(version)
+    update_file("docs/antora.yml") do |antora_metadata|
+      antora_metadata.sub("version: ~",
+                          "version: '#{version_sans_patch(version)}'")
+    end
+  end
+
+  def run(release_type)
+    old_version = Bump::Bump.current
+    Bump::Bump.run(release_type, commit: false, bundle: false, tag: false)
+    new_version = Bump::Bump.current
+
+    update_cop_versions(new_version)
+    `bundle exec rake generate_cops_documentation`
+    update_docs(new_version) if %w[major minor].include?(release_type)
+
+    add_header_to_changelog(new_version)
+    create_release_notes(new_version)
+    update_antora_yml(new_version)
+
+    puts "Changed version from #{old_version} to #{new_version}."
+  end
+end

data/tasks/new_cop.rake

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+desc "Generate a new cop with a template"
+task :new_cop, [:cop] do |_task, args|
+  require "rubocop"
+
+  cop_name = args.fetch(:cop) do
+    warn "usage: bundle exec rake 'new_cop[RSpec/Extra/Name]'"
+    exit!
+  end
+
+  generator = RuboCop::Cop::Generator.new(cop_name)
+
+  generator.write_source
+  generator.write_spec
+  generator.inject_require(root_file_path: "lib/rubocop-rspec-extra.rb")
+  generator.inject_config(config_file_path: "config/default.yml")
+
+  puts generator.todo
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-rspec-extra
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ydah
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-04-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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'
+description: |
+  Automatic committee code style checking tool.
+  A RuboCop extension focused on enforcing RSpec.
+  A place where no one is officially employed, but where useful cops can gather.
+email:
+- t.yudai92@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".codespellignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".yamllint.yml"
+- ".yardopts"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- MIT-LICENSE.md
+- README.md
+- Rakefile
+- config/default.yml
+- docs/antora.yml
+- docs/modules/ROOT/nav.adoc
+- docs/modules/ROOT/pages/cops.adoc
+- docs/modules/ROOT/pages/cops_rspec_extra.adoc
+- docs/modules/ROOT/pages/index.adoc
+- docs/modules/ROOT/pages/installation.adoc
+- docs/modules/ROOT/pages/usage.adoc
+- lib/rubocop-rspec-extra.rb
+- lib/rubocop/cop/rspec/extra/be_empty.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/version.rb
+- tasks/changelog.rake
+- tasks/changelog.rb
+- tasks/cops_documentation.rake
+- tasks/cut_release.rake
+- tasks/new_cop.rake
+homepage: https://github.com/ydah/rubocop-rspec-extra
+licenses:
+- MIT
+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
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.5
+signing_key:
+specification_version: 4
+summary: Automatic committee code style checking tool.
+test_files: []