rubocop-committee 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 85d35285a988e66ac1d5976d7ac3bf7ac7f207015d1fcd352eed7b8bdac60625
-  data.tar.gz: 6c2d9fa4b9d4d28bcbb596446e750a4befd6f0674301d1f03a1f5a604a5679b7
+  metadata.gz: ff90da55bb78b45d0022371df0b3a2f0cd6d54c7c0714f79cb95f7878e34d285
+  data.tar.gz: d19b4f2aa1c16ae1de412f1ed7ba076a578f936a624334e7c80ed9a728ee5e59
 SHA512:
-  metadata.gz: 2af73171d6c98048f001c48be91ebcf2a7c92c1dce94c1af6fb07cb91e1ace600f52d6787c3792dd12929a93e934fa1ac22f3e2db8c91831d21f1e9f65706436
-  data.tar.gz: 2fcb0125bdece926274d5b9cfab219497126bf3dbc599c386daa8ed3e02069c3a73f710c2de2d0efc98c2d24c213005b822de4c36c54a5181c9ec402a0fe96dc
+  metadata.gz: 14004eb8a7fac00b1b6aa96729c0a69dd685cc76b0631e57a190894dac5aea81bc67da20744738f423b88a6d968246d75a3e6dc01be1ab8b0d8b84d7beab996a
+  data.tar.gz: 8e2ba75e78b4785045f5d1e87d2d264577ce50ff41fc7f09ca03bed801db20e2af0890635192929d6767f86355846aa21b10edc127f11b72b5f91a253ace7a6b

data/.rubocop.yml

@@ -1,12 +1,14 @@
-require:
-  - rubocop/cop/internal_affairs
+inherit_from: .rubocop_todo.yml
+
+plugins:
+  - rubocop-internal_affairs
   - rubocop-performance
   - rubocop-rake
   - rubocop-rspec
 
 AllCops:
   NewCops: enable
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 2.7
   SuggestExtensions: false
 
 Layout/LineLength:
@@ -28,5 +30,9 @@ Style/StringLiterals:
 Style/StringLiteralsInInterpolation:
   EnforcedStyle: double_quotes
 
+RSpec/DescribeClass:
+  Exclude:
+    - spec/project/**/*.rb
+
 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.41.1.
+# 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: 6
+Rake/MethodDefinitionInTask:
+  Exclude:
+    - 'tasks/cut_release.rake'

data/.simplecov

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+SimpleCov.start do
+  enable_coverage :branch
+  add_filter "/spec/"
+  add_filter "/vendor/bundle/"
+end

data/CHANGELOG.md

@@ -1,9 +1,25 @@
-## Unreleased
+# Changelog
 
-## 0.1.0 - 2022-12-29
+## Master (Unreleased)
+
+## 1.0.0 (2025-04-02)
+
+### New features
+
+- [#8](https://github.com/rubocop/rubocop-committee/pull/8): Pluginfy RuboCop Committee. ([@ydah][])
+
+### Changes
+
+- [#4](https://github.com/rubocop/rubocop-committee/pull/4): Drop Ruby 2.6 runtime support. ([@ydah])
+
+## 0.1.1 (2022-12-29)
+
+- Add rubocop-rspec in runtime dependency. ([@ydah])
+
+## 0.1.0 (2022-12-29)
 
 - Initial release ([@ydah])
 
-<!-- Contributors -->
+<!-- Contributors (alphabetically) -->
 
 [@ydah]: https://github.com/ydah

data/CODE_OF_CONDUCT.md

@@ -67,7 +67,7 @@ Community leaders will follow these Community Impact Guidelines in determining t
 
 ### 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.
+**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.
 

data/Gemfile

@@ -4,10 +4,11 @@ source "https://rubygems.org"
 
 gemspec
 
-gem 'bump', require: false
+gem "bump", require: false
 gem "rake"
-gem "rspec"
-gem "rubocop-performance"
-gem "rubocop-rake"
-gem "rubocop-rspec"
+gem "rspec", "~> 3.11"
+gem "rubocop-performance", "~> 1.7"
+gem "rubocop-rake", "~> 0.7"
+gem "rubocop-rspec", "~> 3.5"
+gem "simplecov", ">= 0.19"
 gem "yard"

data/README.md

@@ -2,7 +2,7 @@
 
 ![GitHub top language](https://img.shields.io/github/languages/top/ydah/rubocop-committee?color=39ff14) [![Gem Version](https://badge.fury.io/rb/rubocop-committee.svg)](https://badge.fury.io/rb/rubocop-committee) [![Ruby Style Guide](https://img.shields.io/badge/code_style-rubocop-brightgreen.svg)](https://github.com/rubocop/rubocop) [![CI](https://github.com/ydah/rubocop-committee/actions/workflows/ci.yml/badge.svg)](https://github.com/ydah/rubocop-committee/actions/workflows/ci.yml) [![Maintainability](https://api.codeclimate.com/v1/badges/a1b121696e9d1b425406/maintainability)](https://codeclimate.com/github/ydah/rubocop-committee/maintainability)
 
-Committee-specific analysis for your projects, as an extension to
+[Committee](https://github.com/interagent/committee)-specific analysis for your projects, as an extension to
 [RuboCop](https://github.com/rubocop/rubocop).
 
 ## Installation
@@ -29,13 +29,13 @@ ways to do this:
 Put this into your `.rubocop.yml`.
 
 ```yaml
-require: rubocop-committee
+plugins: rubocop-committee
 ```
 
 Alternatively, use the following array notation when specifying multiple extensions.
 
 ```yaml
-require:
+plugins:
   - rubocop-other-extension
   - rubocop-committee
 ```
@@ -43,23 +43,26 @@ require:
 Now you can run `rubocop` and it will automatically load the RuboCop Committee
 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-committee
+rubocop --plugin rubocop-committee
 ```
 
 ### Rake task
 
 ```ruby
 RuboCop::RakeTask.new do |task|
-  task.requires << 'rubocop-committee'
+  task.plugins << 'rubocop-committee'
 end
 ```
 
 ## Documentation
 
-You can read more about RuboCop Committee in its official manual.
+You can read more about RuboCop Committee in its [official manual](https://ydah.github.io/rubocop.docs/rubocop-committee/).
 
 ## The Cops
 

data/config/default.yml

@@ -6,14 +6,14 @@ inherit_mode:
 Committee:
   Enabled: true
 
+Committee/RedundantResponseStatusAssertions:
+  Description: Check for validation of redundant response HTTP status codes.
+  Enabled: pending
+  VersionAdded: "0.1"
+
 Committee/UnspecifiedExpectedStatus:
   Description: |
     Check if the status code is specified as an argument to the method of the Committee
     where the expected response status code is required.
   Enabled: pending
-  VersionAdded: '0.1'
-
-Committee/RedundantResponseStatusAssertions:
-  Description: Check for validation of redundant response HTTP status codes.
-  Enabled: pending
-  VersionAdded: '0.1'
+  VersionAdded: "0.1"

data/docs/{modules/antora.yml → antora.yml}

@@ -1,5 +1,5 @@
 name: rubocop-committee
 title: RuboCop Committee
-version: "0.1.0"
+version: '1.0'
 nav:
   - modules/ROOT/nav.adoc

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

@@ -1,66 +1,75 @@
+////
+  Do NOT edit this file by hand directly, as it is automatically generated.
+
+  Please make any necessary changes to the cop documentation within the source files themselves.
+////
+
 = Committee
 
+[#committeeredundantresponsestatusassertions]
 == Committee/RedundantResponseStatusAssertions
 
 |===
 | Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
 
-| Pending
+| Enabled
 | Yes
-| Yes
-| 0.1
+| Always
+| -
 | -
 |===
 
 Check for validation of redundant response HTTP status codes.
 
+[#examples-committeeredundantresponsestatusassertions]
 === Examples
 
 [source,ruby]
 ----
 # bad
-it 'something' do
+it 'does something' do
   subject
   expect(response).to have_http_status 400
   assert_schema_conform(400)
 end
 
 # good
-it 'something' do
+it 'does something' do
   subject
   assert_schema_conform(400)
 end
 ----
 
+[#committeeunspecifiedexpectedstatus]
 == Committee/UnspecifiedExpectedStatus
 
 |===
 | Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
 
-| Pending
+| Enabled
 | Yes
-| Yes
-| 0.1
+| Always
+| -
 | -
 |===
 
 Check if the status code is specified as an argument to the method of the Committee
-where the expected response status code is required.
+where the expected response HTTP status code is required.
 
+[#examples-committeeunspecifiedexpectedstatus]
 === Examples
 
 [source,ruby]
 ----
 # bad
-it 'something' do
+it 'does something' do
   subject
-  expect(response).to have_http_status 400
   assert_schema_conform
 end
 
 # good
-it 'something' do
+it 'does something' do
   subject
-  assert_schema_conform(400)
+  assert_schema_conform(200)
 end
 ----

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

@@ -1,6 +1,6 @@
 = RuboCop Committee
 
-Committee-specific analysis for your projects, as an extension to
+https://github.com/interagent/committee[Committee]-specific analysis for your projects, as an extension to
 https://github.com/rubocop/rubocop[RuboCop].
 
 RuboCop Committee follows the https://docs.rubocop.org/rubocop/versioning.html[RuboCop versioning guide].

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-committee
+plugins: rubocop-committee
 ----
 
 or, if you are using several extensions:
 
 ----
-require:
+plugins:
   - rubocop-committee
   - rubocop-rspec
 ----
@@ -24,7 +24,7 @@ cops together with the standard cops.
 
 [source,bash]
 ----
-$ rubocop --require rubocop-committee
+$ rubocop --plugin rubocop-committee
 ----
 
 == Rake task
@@ -32,6 +32,8 @@ $ rubocop --require rubocop-committee
 [source,ruby]
 ----
 RuboCop::RakeTask.new do |task|
-  task.requires << 'rubocop-committee'
+  task.plugins << 'rubocop-committee'
 end
 ----
+
+NOTE: The plugin system is supported in RuboCop 1.72+. In earlier versions, use `require` instead of `plugins`.

data/lib/rubocop/committee/plugin.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "lint_roller"
+
+module RuboCop
+  module Committee
+    # A plugin that integrates RuboCop Committee with RuboCop's plugin system.
+    class Plugin < LintRoller::Plugin
+      def about
+        LintRoller::About.new(
+          name: "rubocop-committee",
+          version: Version::STRING,
+          homepage: "https://github.com/ydah/rubocop-committee",
+          description: "Committee-specific analysis for your projects, as an extension to RuboCop."
+        )
+      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

data/lib/rubocop/committee/version.rb

@@ -2,6 +2,8 @@
 
 module Rubocop
   module Committee
-    VERSION = "0.1.0"
+    module Version
+      STRING = "1.0.0"
+    end
   end
 end

data/lib/rubocop/cop/committee/redundant_response_status_assertions.rb

@@ -7,14 +7,14 @@ module RuboCop
       #
       # @example
       #   # bad
-      #   it 'something' do
+      #   it 'does something' do
       #     subject
       #     expect(response).to have_http_status 400
       #     assert_schema_conform(400)
       #   end
       #
       #   # good
-      #   it 'something' do
+      #   it 'does something' do
       #     subject
       #     assert_schema_conform(400)
       #   end
@@ -31,11 +31,11 @@ module RuboCop
           $(send nil? :have_http_status (:int _))
         PATTERN
 
-        def on_send(node)
+        def on_send(node) # rubocop:disable InternalAffairs/OnSendWithoutOnCSend
           return if node.first_argument.nil?
 
           have_http_status(node.parent) do |http_node|
-            return autocorrect(node, http_node.parent.loc.expression)
+            autocorrect(node, http_node.parent.source_range)
           end
         end
 

data/lib/rubocop/cop/committee/unspecified_expected_status.rb

@@ -4,20 +4,19 @@ module RuboCop
   module Cop
     module Committee
       # Check if the status code is specified as an argument to the method of the Committee
-      # where the expected response status code is required.
+      # where the expected response HTTP status code is required.
       #
       # @example
       #   # bad
-      #   it 'something' do
+      #   it 'does something' do
       #     subject
-      #     expect(response).to have_http_status 400
       #     assert_schema_conform
       #   end
       #
       #   # good
-      #   it 'something' do
+      #   it 'does something' do
       #     subject
-      #     assert_schema_conform(400)
+      #     assert_schema_conform(200)
       #   end
       #
       class UnspecifiedExpectedStatus < Base
@@ -32,7 +31,7 @@ module RuboCop
           (send nil? :have_http_status (:int $_))
         PATTERN
 
-        def on_send(node)
+        def on_send(node) # rubocop:disable InternalAffairs/OnSendWithoutOnCSend
           return if node.arguments?
 
           have_http_status(node.parent) do |status|

data/lib/rubocop-committee.rb

@@ -1,18 +1,9 @@
 # frozen_string_literal: true
 
-require_relative "rubocop/committee/inject"
+require "rubocop"
+
 require_relative "rubocop/committee/version"
+require_relative "rubocop/committee/plugin"
 
 require_relative "rubocop/cop/committee/redundant_response_status_assertions"
 require_relative "rubocop/cop/committee/unspecified_expected_status"
-
-module RuboCop
-  module Committee
-    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
-
-RuboCop::Committee::Inject.defaults!

data/relnotes/v1.0.0.md

@@ -0,0 +1,10 @@
+### New features
+
+- [#8](https://github.com/rubocop/rubocop-committee/pull/8): Pluginfy RuboCop Committee. ([@ydah][])
+
+### Changes
+
+- [#4](https://github.com/rubocop/rubocop-committee/pull/4): Drop Ruby 2.6 runtime support. ([@ydah])
+
+[@ydah][]: https://github.com/ydah][
+[@ydah]: https://github.com/ydah

data/rubocop-committee.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative "lib/rubocop/committee/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "rubocop-committee"
+  spec.version = Rubocop::Committee::Version::STRING
+  spec.authors = ["ydah"]
+  spec.email = ["t.yudai92@gmail.com"]
+
+  spec.summary = "Automatic committee code style checking tool."
+  spec.description = <<~DESCRIPTION
+    Automatic committee code style checking tool.
+    A RuboCop extension focused on enforcing committee.
+  DESCRIPTION
+  spec.homepage = "https://github.com/ydah/rubocop-committee"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.7.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/releases"
+  spec.metadata["rubygems_mfa_required"] = "true"
+  spec.metadata["default_lint_roller_plugin"] = "RuboCop::Committee::Plugin"
+
+  # 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 = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "lint_roller", "~> 1.1"
+  spec.add_dependency "rubocop", ">= 1.72.1", "< 2.0"
+end

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-committee"
+  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/cut_release.rake

@@ -3,18 +3,40 @@
 require "bump"
 
 namespace :cut_release do
-  def update_file(path)
-    content = File.read(path)
-    File.write(path, yield(content))
-  end
-
   %w[major minor patch pre].each do |release_type|
-    desc "Cut a new #{release_type} release and update documents."
-    task release_type do
+    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
@@ -28,6 +50,22 @@ namespace :cut_release do
     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: ~",
@@ -35,13 +73,6 @@ namespace :cut_release do
     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 run(release_type)
     old_version = Bump::Bump.current
     Bump::Bump.run(release_type, commit: false, bundle: false, tag: false)
@@ -50,7 +81,10 @@ namespace :cut_release do
     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

metadata

@@ -1,29 +1,48 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-committee
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - ydah
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-12-28 00:00:00.000000000 Z
+date: 2025-04-02 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: |
   Automatic committee code style checking tool.
   A RuboCop extension focused on enforcing committee.
@@ -36,6 +55,8 @@ files:
 - ".codespellignore"
 - ".rspec"
 - ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".simplecov"
 - ".yamllint.yml"
 - ".yardopts"
 - CHANGELOG.md
@@ -45,18 +66,22 @@ files:
 - 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_committee.adoc
 - docs/modules/ROOT/pages/index.adoc
 - docs/modules/ROOT/pages/installation.adoc
 - docs/modules/ROOT/pages/usage.adoc
-- docs/modules/antora.yml
 - lib/rubocop-committee.rb
-- lib/rubocop/committee/inject.rb
+- lib/rubocop/committee/plugin.rb
 - lib/rubocop/committee/version.rb
 - lib/rubocop/cop/committee/redundant_response_status_assertions.rb
 - lib/rubocop/cop/committee/unspecified_expected_status.rb
+- relnotes/v1.0.0.md
+- rubocop-committee.gemspec
+- tasks/changelog.rake
+- tasks/changelog.rb
 - tasks/cops_documentation.rake
 - tasks/cut_release.rake
 - tasks/new_cop.rake
@@ -68,7 +93,7 @@ metadata:
   source_code_uri: https://github.com/ydah/rubocop-committee
   changelog_uri: https://github.com/ydah/rubocop-committee/releases
   rubygems_mfa_required: 'true'
-post_install_message:
+  default_lint_roller_plugin: RuboCop::Committee::Plugin
 rdoc_options: []
 require_paths:
 - lib
@@ -76,15 +101,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Automatic committee code style checking tool.
 test_files: []

data/lib/rubocop/committee/inject.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-require "rubocop"
-require "rubocop-rspec"
-
-module RuboCop
-  module Committee
-    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