rubocop-rspec-extra 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b6d37e0a9b8e12b308c8f45612176fd83edd6a6ce1852746dc0140efba3efb6b
-  data.tar.gz: ef9b88f0c670940a7f79b8c4ae6e73f1f8b492b630cceb540dab1c6a85ec003e
+  metadata.gz: 15b0c1d5b0b7c30874b0c8f567006e6ae733d4ad096eaa885b9397feed61de69
+  data.tar.gz: 47e774fa8976ee7a0d8f3b348224d2ccb95bc529334880aa1bd6a71f02e941a2
 SHA512:
-  metadata.gz: 6ba9025e60e671873a082672d0677fc2eacd07c60f1d1fca1d9ac6068fdd9d1894faf6336e37d63f86bfbc9bcb482477bd246176e23967cd9f36df316107a323
-  data.tar.gz: e6b5eda765dd616f7ba4d9e24c93462b0440986b00098f11c21993c45e93e8391723e6301db74f2a53beae6745caf7e51cee045f4696a03b8f44d1808669aa37
+  metadata.gz: 53973d3db669c54dcdcee88596381906a407d33d63eec4c1536c361f118b59de9a3f8bc90a4984462cd6507af0c9bb080cfd59de20724341c6e3fff7969a2609
+  data.tar.gz: ed2a3474c9676133f943bab5170cc0f0b20a1f5b5f06e8d6f6ba60e8aea78b721838e8df9ff2e8a4d85bc06902489e543e50d2a46d886421727d347fff2bb04a

data/.rubocop.yml

@@ -9,7 +9,7 @@ require:
 
 AllCops:
   NewCops: enable
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 2.7
   SuggestExtensions: false
 
 Layout/LineLength:

data/CHANGELOG.md

@@ -1,5 +1,17 @@
-## Unreleased
+# Changelog
 
-## 0.1.0 - 2023-04-18
+## Master (Unreleased)
+
+## 0.2.0 (2024-03-01)
+
+- Fix an error for `RSpec/Extra/RestrictBlockTag`. ([@ydah])
+- Fix an error for `RSpec/Extra/RestrictBlockTagValue`. ([@ydah])
+- Drop Ruby 2.6 support. ([@ydah])
+
+## 0.1.0 (2023-04-18)
 
 - Initial release
+
+<!-- Contributors (alphabetically) -->
+
+[@ydah]: https://github.com/ydah

data/README.md

@@ -1,6 +1,6 @@
 # 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)
+![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) [![Gem Version](https://badge.fury.io/rb/rubocop-rspec-extra.svg)](https://badge.fury.io/rb/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.
 

data/config/default.yml

@@ -5,17 +5,17 @@ RSpec/Extra:
 RSpec/Extra/BeEmpty:
   Description: Prefer using `be_empty` when checking for an empty array.
   Enabled: pending
-  VersionAdded: '<<next>>'
+  VersionAdded: '0.1'
   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>>'
+  VersionAdded: '0.1'
   AllowTags: []
 
 RSpec/Extra/RestrictBlockTagValue:
   Description: 'Restrict to only allowed block tag value.'
   Enabled: pending
-  VersionAdded: '<<next>>'
+  VersionAdded: '0.1'
   AllowTagValues: {}

data/docs/antora.yml

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

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

@@ -1,3 +1,9 @@
+////
+  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.
+////
+
 = RSpec/Extra
 
 == RSpec/Extra/BeEmpty
@@ -7,8 +13,8 @@
 
 | Pending
 | Yes
-| Yes
-| <<next>>
+| Always
+| 0.2
 | -
 |===
 
@@ -44,7 +50,7 @@ expect(array).to be_empty
 | Disabled
 | Yes
 | No
-| <<next>>
+| 0.2
 | -
 |===
 
@@ -95,7 +101,7 @@ end
 | Pending
 | Yes
 | No
-| <<next>>
+| 0.2
 | -
 |===
 

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

@@ -30,8 +30,9 @@ module RuboCop
         class RestrictBlockTag < Base
           include Metadata
 
-          def on_metadata(symbols, pairs)
-            offenses = (symbols + pairs.map(&:key)).filter do |symbol|
+          def on_metadata(symbols, hash)
+            symbols += hash.pairs.map(&:key) unless hash.nil?
+            offenses = symbols.filter do |symbol|
               !allow_tags.include?(symbol.value.to_s)
             end
 

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

@@ -19,8 +19,10 @@ module RuboCop
           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|
+          def on_metadata(_symbols, hash)
+            return if hash.nil?
+
+            offenses = hash.pairs.filter do |pair|
               allow_tag_values.any? do |k, v|
                 pair.key.value.to_s == k &&
                   pair.value.value.to_s != v

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

@@ -3,7 +3,7 @@
 module Rubocop
   module Rspec
     module Extra
-      VERSION = "0.1.0"
+      VERSION = "0.2.0"
     end
   end
 end

data/tasks/cut_release.rake

@@ -5,7 +5,7 @@ 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
+    task release_type do
       run(release_type)
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-rspec-extra
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - ydah
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-17 00:00:00.000000000 Z
+date: 2024-02-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -25,7 +25,6 @@ dependencies:
       - !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:
@@ -60,8 +59,6 @@ files:
 - 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
@@ -81,15 +78,15 @@ 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.4.5
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
-summary: Automatic committee code style checking tool.
+summary: A RuboCop extension focused on enforcing RSpec.
 test_files: []

data/tasks/changelog.rake

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

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