rubocop-thread_safety 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa732d8bbefbcfc25dfd2b8adbfcc84788d77d8a21992b152975d9ee92e2f105
-  data.tar.gz: f2d29b69ad8e94c9c4b5de205b7301d45ffb3fb3a1c69429af27a5000e7350c6
+  metadata.gz: 440e483486f3d67ad21fa72aa04eb47535020324672c3e08646894cec3517450
+  data.tar.gz: 50fe186da5956ee780dd5c2839d7792fc57f10ed4860d0781d2f0d68180d635d
 SHA512:
-  metadata.gz: ec8b96d08f872297a64bbf558f93a27e09bbe61d2a06b7248fdb2a3896a7367c520eceb0ca7f1e88fdb26fc8a03e2eab1772794353b5e12a3724a3371360d689
-  data.tar.gz: 7479c57f327e71e7fbc7b263ea13af5e4e908d7a29849946329bae072ba454636dca72465b1c7dc64d9150064d5e61ca68a81eb45a4ea247a5af69027afd6fb7
+  metadata.gz: bb89cc31949d9803344f78556dc6f3351369bd2936ee8b26f93e6caa477b3bcfa6b7db9e8d78dade90eca9003455af4411c3ef064c9399f63455d6c7cd45c36c
+  data.tar.gz: b03de48386d763afe6d7a66aa2f604bcfc1fda637dfd864c2f09b52122fb8637c26f9a675299fe85fae464804e4e8cc2b569ba9fa8104cca2a592ef6fcb6c8c1

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Change log
 
+## master
+
+## 0.7.0
+
+- [#80](https://github.com/rubocop/rubocop-thread_safety/pull/80) Make RuboCop ThreadSafety work as a RuboCop plugin. ([@bquorning](https://github.com/bquorning))
+- [#76](https://github.com/rubocop/rubocop-thread_safety/pull/76): Detect offenses when using safe navigation for `ThreadSafety/DirChdir`, `ThreadSafety/NewThread` and `ThreadSafety/RackMiddlewareInstanceVariable` cops. ([@viralpraxis](https://github.com/viralpraxis))
+- [#73](https://github.com/rubocop/rubocop-thread_safety/pull/73): Add `AllowCallWithBlock` option to `ThreadSafety/DirChdir` cop. ([@viralpraxis](https://github.com/viralpraxis))
+
 ## 0.6.0
 
 * [#59](https://github.com/rubocop/rubocop-thread_safety/pull/59): Rename `ThreadSafety::InstanceVariableInClassMethod` cop to `ThreadSafety::ClassInstanceVariable` to better reflect its purpose. ([@viralpraxis](https://github.com/viralpraxis))

data/README.md

@@ -19,11 +19,14 @@ Install it with Bundler by invoking:
 
 Add this line to your application's `.rubocop.yml`:
 
-    require: rubocop-thread_safety
+    plugins: rubocop-thread_safety
 
 Now you can run `rubocop` and it will automatically load the RuboCop
 Thread-Safety cops together with the standard cops.
 
+> [!NOTE]
+> The plugin system is supported in RuboCop 1.72+. In earlier versions, use `require` instead of `plugins`.
+
 ### Scanning an application without adding it to the Gemfile
 
 Install the gem:
@@ -32,7 +35,7 @@ Install the gem:
 
 Scan the application for just thread-safety issues:
 
-    $ rubocop -r rubocop-thread_safety --only ThreadSafety,Style/GlobalVars,Style/ClassVars,Style/MutableConstant
+    $ rubocop --plugin rubocop-thread_safety --only ThreadSafety,Style/GlobalVars,Style/ClassVars,Style/MutableConstant
 
 ### Configuration
 

data/config/default.yml

@@ -35,6 +35,7 @@ ThreadSafety/NewThread:
 ThreadSafety/DirChdir:
   Description: Avoid using `Dir.chdir` due to its process-wide effect.
   Enabled: true
+  AllowCallWithBlock: false
 
 ThreadSafety/RackMiddlewareInstanceVariable:
   Description: Avoid instance variables in Rack middleware.

data/lib/rubocop/cop/thread_safety/class_and_module_attributes.rb

@@ -49,7 +49,7 @@ module RuboCop
             ...)
         MATCHER
 
-        def on_send(node)
+        def on_send(node) # rubocop:disable InternalAffairs/OnSendWithoutOnCSend
           return unless mattr?(node) || (!class_attribute_allowed? && class_attr?(node)) || singleton_attr?(node)
 
           add_offense(node)

data/lib/rubocop/cop/thread_safety/class_instance_variable.rb

@@ -87,7 +87,7 @@ module RuboCop
         end
         alias on_ivasgn on_ivar
 
-        def on_send(node)
+        def on_send(node) # rubocop:disable InternalAffairs/OnSendWithoutOnCSend
           return unless instance_variable_call?(node)
           return unless class_method_definition?(node)
           return if method_definition?(node)

data/lib/rubocop/cop/thread_safety/dir_chdir.rb

@@ -4,6 +4,8 @@ module RuboCop
   module Cop
     module ThreadSafety
       # Avoid using `Dir.chdir` due to its process-wide effect.
+      # If `AllowCallWithBlock` (disabled by default) option is enabled,
+      # calling `Dir.chdir` with block will be allowed.
       #
       # @example
       #   # bad
@@ -11,25 +13,51 @@ module RuboCop
       #
       #   # bad
       #   FileUtils.chdir("/var/run")
+      #
+      # @example AllowCallWithBlock: false (default)
+      #   # good
+      #   Dir.chdir("/var/run") do
+      #     puts Dir.pwd
+      #   end
+      #
+      # @example AllowCallWithBlock: true
+      #   # bad
+      #   Dir.chdir("/var/run") do
+      #     puts Dir.pwd
+      #   end
+      #
       class DirChdir < Base
-        MESSAGE = 'Avoid using `%<module>s.%<method>s` due to its process-wide effect.'
+        MESSAGE = 'Avoid using `%<module>s%<dot>s%<method>s` due to its process-wide effect.'
         RESTRICT_ON_SEND = %i[chdir cd].freeze
 
         # @!method chdir?(node)
         def_node_matcher :chdir?, <<~MATCHER
           {
-            (send (const {nil? cbase} {:Dir :FileUtils}) :chdir ...)
-            (send (const {nil? cbase} :FileUtils) :cd ...)
+            (call (const {nil? cbase} {:Dir :FileUtils}) :chdir ...)
+            (call (const {nil? cbase} :FileUtils) :cd ...)
           }
         MATCHER
 
         def on_send(node)
-          chdir?(node) do
-            add_offense(
-              node,
-              message: format(MESSAGE, module: node.receiver.short_name, method: node.method_name)
+          return unless chdir?(node)
+          return if allow_call_with_block? && (node.block_argument? || node.parent&.block_type?)
+
+          add_offense(
+            node,
+            message: format(
+              MESSAGE,
+              module: node.receiver.short_name,
+              method: node.method_name,
+              dot: node.loc.dot.source
             )
-          end
+          )
+        end
+        alias on_csend on_send
+
+        private
+
+        def allow_call_with_block?
+          !!cop_config['AllowCallWithBlock']
         end
       end
     end

data/lib/rubocop/cop/thread_safety/mutable_class_instance_variable.rb

@@ -198,7 +198,7 @@ module RuboCop
         end
 
         def range_type?(node)
-          node.erange_type? || node.irange_type?
+          node.type?(:erange, :irange)
         end
 
         def correct_splat_expansion(corrector, expr, splat_value)
@@ -245,7 +245,7 @@ module RuboCop
 
         # @!method range_enclosed_in_parentheses?(node)
         def_node_matcher :range_enclosed_in_parentheses?, <<~PATTERN
-          (begin ({irange erange} _ _))
+          (begin (range _ _))
         PATTERN
       end
     end

data/lib/rubocop/cop/thread_safety/new_thread.rb

@@ -16,12 +16,13 @@ module RuboCop
 
         # @!method new_thread?(node)
         def_node_matcher :new_thread?, <<~MATCHER
-          (send (const {nil? cbase} :Thread) {:new :fork :start} ...)
+          (call (const {nil? cbase} :Thread) {:new :fork :start} ...)
         MATCHER
 
         def on_send(node)
           new_thread?(node) { add_offense(node) }
         end
+        alias on_csend on_send
       end
     end
   end

data/lib/rubocop/cop/thread_safety/rack_middleware_instance_variable.rb

@@ -88,11 +88,12 @@ module RuboCop
         def on_send(node)
           argument = node.first_argument
 
-          return unless argument&.sym_type? || argument&.str_type?
+          return unless argument&.type?(:sym, :str)
           return if allowed_identifier?(argument.value)
 
           add_offense node
         end
+        alias on_csend on_send
 
         private
 

data/lib/rubocop/thread_safety/plugin.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'lint_roller'
+
+module RuboCop
+  module ThreadSafety
+    # A plugin that integrates RuboCop ThreadSafety with RuboCop's plugin system.
+    class Plugin < LintRoller::Plugin
+      # :nocov:
+      def about
+        LintRoller::About.new(
+          name: 'rubocop-thread_safety',
+          version: Version::STRING,
+          homepage: 'https://github.com/rubocop/rubocop-thread_safety',
+          description: 'Thread-safety checks via static analysis.'
+        )
+      end
+      # :nocov:
+
+      def supported?(context)
+        context.engine == :rubocop
+      end
+
+      def rules(_context)
+        project_root = Pathname.new(__dir__).join('../../..')
+
+        obsoletion = project_root.join('config', 'obsoletion.yml')
+        ConfigObsoletion.files << obsoletion
+
+        LintRoller::Rules.new(
+          type: :path,
+          config_format: :rubocop,
+          value: project_root.join('config/default.yml')
+        )
+      end
+    end
+  end
+end

data/lib/rubocop/thread_safety/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module ThreadSafety
-    VERSION = '0.6.0'
+    VERSION = '0.7.0'
   end
 end

data/lib/rubocop/thread_safety.rb

@@ -3,12 +3,5 @@
 module RuboCop
   # RuboCop::ThreadSafety detects some potential thread safety issues.
   module ThreadSafety
-    PROJECT_ROOT = Pathname.new(File.expand_path('../../', __dir__))
-    CONFIG_DEFAULT = PROJECT_ROOT.join('config', 'default.yml').freeze
-    CONFIG = YAML.safe_load(CONFIG_DEFAULT.read).freeze
-
-    private_constant(:CONFIG_DEFAULT, :PROJECT_ROOT)
-
-    ::RuboCop::ConfigObsoletion.files << PROJECT_ROOT.join('config', 'obsoletion.yml')
   end
 end

data/lib/rubocop-thread_safety.rb

@@ -4,9 +4,7 @@ require 'rubocop'
 
 require 'rubocop/thread_safety'
 require 'rubocop/thread_safety/version'
-require 'rubocop/thread_safety/inject'
-
-RuboCop::ThreadSafety::Inject.defaults!
+require 'rubocop/thread_safety/plugin'
 
 require 'rubocop/cop/mixin/operation_with_threadsafe_result'
 

metadata

@@ -1,29 +1,48 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-thread_safety
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Michael Gee
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-11 00:00:00.000000000 Z
+date: 2025-02-22 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: '1.72'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.48.1
+        version: 1.72.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.72'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.48.1
+        version: 1.72.1
 description: |2
       Thread-safety checks via static analysis.
       A plugin for the RuboCop code style enforcing & linting tool.
@@ -33,26 +52,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/dependabot.yml"
-- ".github/workflows/ci.yml"
-- ".github/workflows/lint.yml"
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- Appraisals
 - CHANGELOG.md
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
-- bin/console
-- bin/setup
 - config/default.yml
 - config/obsoletion.yml
-- docs/modules/ROOT/pages/cops.adoc
-- docs/modules/ROOT/pages/cops_threadsafety.adoc
-- gemfiles/rubocop_1.48.gemfile
-- gemfiles/rubocop_1.66.gemfile
 - lib/rubocop-thread_safety.rb
 - lib/rubocop/cop/mixin/operation_with_threadsafe_result.rb
 - lib/rubocop/cop/thread_safety/class_and_module_attributes.rb
@@ -62,10 +66,8 @@ files:
 - lib/rubocop/cop/thread_safety/new_thread.rb
 - lib/rubocop/cop/thread_safety/rack_middleware_instance_variable.rb
 - lib/rubocop/thread_safety.rb
-- lib/rubocop/thread_safety/inject.rb
+- lib/rubocop/thread_safety/plugin.rb
 - lib/rubocop/thread_safety/version.rb
-- rubocop-thread_safety.gemspec
-- tasks/cops_documentation.rake
 homepage: https://github.com/rubocop/rubocop-thread_safety
 licenses:
 - MIT
@@ -74,7 +76,7 @@ metadata:
   source_code_uri: https://github.com/rubocop/rubocop-thread_safety
   bug_tracker_uri: https://github.com/rubocop/rubocop-thread_safety/issues
   rubygems_mfa_required: 'true'
-post_install_message:
+  default_lint_roller_plugin: RuboCop::ThreadSafety::Plugin
 rdoc_options: []
 require_paths:
 - lib
@@ -89,8 +91,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
-signing_key:
+rubygems_version: 3.6.3
 specification_version: 4
 summary: Thread-safety checks via static analysis
 test_files: []

data/.github/dependabot.yml

@@ -1,6 +0,0 @@
-version: 2
-updates:
-  - package-ecosystem: 'github-actions'
-    directory: '/'
-    schedule:
-      interval: 'weekly'

data/.github/workflows/ci.yml

@@ -1,55 +0,0 @@
-name: CI
-
-on:
-  push:
-    branches:
-      - master
-  pull_request:
-
-jobs:
-  confirm_documentation:
-    runs-on: ubuntu-latest
-    name: Confirm documentation
-    steps:
-      - uses: actions/checkout@v4
-      - uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: "3.2"
-          bundler-cache: true
-      - run: bundle exec rake documentation_syntax_check confirm_documentation
-
-  test:
-    runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        ruby: ["2.7", "3.0", "3.1", "3.2", "3.3", ruby-head, jruby-9.4]
-        rubocop_version: ["1.48", "1.66"]
-    env:
-      BUNDLE_GEMFILE: "gemfiles/rubocop_${{ matrix.rubocop_version }}.gemfile"
-    steps:
-      - uses: actions/checkout@v4
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          bundler-cache: true # 'bundle install' and cache gems
-          ruby-version: ${{ matrix.ruby }}
-          bundler: 2.3.26
-      - name: Run tests
-        run: bundle exec rspec
-
-  test-prism:
-    runs-on: ubuntu-latest
-    env:
-      BUNDLE_GEMFILE: "gemfiles/rubocop_1.66.gemfile"
-      PARSER_ENGINE: parser_prism
-    steps:
-      - uses: actions/checkout@v4
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          bundler-cache: true # 'bundle install' and cache gems
-          ruby-version: 3.3
-          bundler: 2.3.26
-      - name: Run tests
-        run: bundle exec rspec

data/.github/workflows/lint.yml

@@ -1,23 +0,0 @@
-name: Lint
-
-on:
-  push:
-    branches:
-      - master
-  pull_request:
-
-jobs:
-  lint:
-
-    runs-on: ubuntu-latest
-    name: Rubocop
-
-    steps:
-      - uses: actions/checkout@v4
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          bundler-cache: true # 'bundle install' and cache gems
-          ruby-version: "2.7"
-      - name: Run Rubocop
-        run: bundle exec rubocop

data/.gitignore

@@ -1,10 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/gemfiles/*.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/

data/.rspec

@@ -1,3 +0,0 @@
---color
---require spec_helper
---warnings

data/.rubocop.yml

@@ -1,81 +0,0 @@
-require:
-  - rubocop/cop/internal_affairs
-  - rubocop-rake
-  - rubocop-rspec
-
-AllCops:
-  DisplayCopNames: true
-  TargetRubyVersion: 2.7
-  NewCops: enable
-
-Lint/RaiseException:
-  Enabled: true
-
-Lint/StructNewOverride:
-  Enabled: true
-
-Metrics/BlockLength:
-  Exclude:
-    - "spec/**/*"
-
-Metrics/ClassLength:
-  Enabled: false
-
-Metrics/MethodLength:
-  Max: 14
-
-Naming/FileName:
-  Exclude:
-    - lib/rubocop-thread_safety.rb
-    - rubocop-thread_safety.gemspec
-
-# Enable more cops that are disabled by default:
-
-Style/AutoResourceCleanup:
-  Enabled: true
-
-Style/CollectionMethods:
-  Enabled: true
-
-Style/FormatStringToken:
-  Exclude:
-    - spec/**/*
-
-Style/HashEachMethods:
-  Enabled: true
-
-Style/HashTransformKeys:
-  Enabled: false
-
-Style/HashTransformValues:
-  Enabled: false
-
-Style/MethodCalledOnDoEndBlock:
-  Enabled: true
-  Exclude:
-    - spec/**/*
-
-Style/MissingElse:
-  Enabled: true
-  EnforcedStyle: case
-
-Style/OptionHash:
-  Enabled: true
-
-Style/Send:
-  Enabled: true
-
-Style/StringMethods:
-  Enabled: true
-
-Style/SymbolArray:
-  Enabled: true
-
-RSpec/ExampleLength:
-  Max: 11
-  Exclude:
-    - spec/rubocop/cop/thread_safety/rack_middleware_instance_variable_spec.rb
-
-RSpec/ContextWording:
-  Exclude:
-    - spec/shared_contexts.rb

data/Appraisals

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-customize_gemfiles do
-  {
-    single_quotes: true,
-    heading: <<~HEADING.strip
-      frozen_string_literal: true
-
-      This file was generated by Appraisal
-    HEADING
-  }
-end
-
-appraise 'rubocop-1.48' do
-  gem 'base64', '~> 0.1.1'
-  gem 'rubocop', '~> 1.48.0'
-end
-
-appraise 'rubocop-1.66' do
-  gem 'rubocop', '~> 1.66.0'
-end

data/Gemfile

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-gemspec
-
-gem 'appraisal'
-gem 'bundler', '>= 1.10', '< 3'
-gem 'prism', '~> 1.2.0'
-gem 'pry' unless ENV['CI']
-gem 'rake', '>= 10.0'
-gem 'rspec', '~> 3.0'
-gem 'rubocop', github: 'rubocop/rubocop'
-gem 'rubocop-rake', '~> 0.6.0'
-gem 'rubocop-rspec'
-gem 'simplecov'
-gem 'yard'

data/Rakefile

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-require 'bundler/gem_tasks'
-require 'open3'
-require 'rspec/core/rake_task'
-
-Dir['tasks/**/*.rake'].each { |t| load t }
-
-RSpec::Core::RakeTask.new(:spec)
-
-desc 'Confirm documentation is up to date'
-task confirm_documentation: :generate_cops_documentation do
-  _, _, _, process =
-    Open3.popen3('git diff --exit-code docs/')
-
-  unless process.value.success?
-    abort 'Please run `rake generate_cops_documentation` ' \
-          'and add docs/ to the commit.'
-  end
-end
-
-task default: :spec

data/bin/console

@@ -1,15 +0,0 @@
-#!/usr/bin/env ruby
-
-# frozen_string_literal: true
-
-require 'bundler/setup'
-require 'rubocop-thread_safety'
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-require 'pry'
-Pry.start
-
-# require "irb"
-# IRB.start

data/bin/setup

@@ -1,6 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install

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

@@ -1,8 +0,0 @@
-=== Department xref:cops_threadsafety.adoc[ThreadSafety]
-
-* xref:cops_threadsafety.adoc#threadsafetyclassandmoduleattributes[ThreadSafety/ClassAndModuleAttributes]
-* xref:cops_threadsafety.adoc#threadsafetyclassinstancevariable[ThreadSafety/ClassInstanceVariable]
-* xref:cops_threadsafety.adoc#threadsafetymutableclassinstancevariable[ThreadSafety/MutableClassInstanceVariable]
-* xref:cops_threadsafety.adoc#threadsafetynewthread[ThreadSafety/NewThread]
-* xref:cops_threadsafety.adoc#threadsafetydirchdir[ThreadSafety/DirChdir]
-* xref:cops_threadsafety.adoc#threadsafetyrackmiddlewareinstancevariable[ThreadSafety/RackMiddlewareInstanceVariable]

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

@@ -1,361 +0,0 @@
-////
-  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.
-////
-
-= ThreadSafety
-
-[#threadsafetyclassandmoduleattributes]
-== ThreadSafety/ClassAndModuleAttributes
-
-|===
-| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
-
-| Enabled
-| Yes
-| No
-| -
-| -
-|===
-
-Avoid mutating class and module attributes.
-
-They are implemented by class variables, which are not thread-safe.
-
-[#examples-threadsafetyclassandmoduleattributes]
-=== Examples
-
-[source,ruby]
-----
-# bad
-class User
-  cattr_accessor :current_user
-end
-----
-
-[#configurable-attributes-threadsafetyclassandmoduleattributes]
-=== Configurable attributes
-
-|===
-| Name | Default value | Configurable values
-
-| ActiveSupportClassAttributeAllowed
-| `false`
-| Boolean
-|===
-
-[#threadsafetyclassinstancevariable]
-== ThreadSafety/ClassInstanceVariable
-
-|===
-| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
-
-| Enabled
-| Yes
-| No
-| -
-| -
-|===
-
-Avoid class instance variables.
-
-[#examples-threadsafetyclassinstancevariable]
-=== Examples
-
-[source,ruby]
-----
-# bad
-class User
-  def self.notify(info)
-    @info = validate(info)
-    Notifier.new(@info).deliver
-  end
-end
-
-class Model
-  class << self
-    def table_name(name)
-      @table_name = name
-    end
-  end
-end
-
-class Host
-  %i[uri port].each do |key|
-    define_singleton_method("#{key}=") do |value|
-      instance_variable_set("@#{key}", value)
-    end
-  end
-end
-
-module Example
-  module ClassMethods
-    def test(params)
-      @params = params
-    end
-  end
-end
-
-module Example
-  class_methods do
-    def test(params)
-      @params = params
-    end
-  end
-end
-
-module Example
-  module_function
-
-  def test(params)
-    @params = params
-  end
-end
-
-module Example
-  def test(params)
-    @params = params
-  end
-
-  module_function :test
-end
-----
-
-[#threadsafetydirchdir]
-== ThreadSafety/DirChdir
-
-|===
-| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
-
-| Enabled
-| Yes
-| No
-| -
-| -
-|===
-
-Avoid using `Dir.chdir` due to its process-wide effect.
-
-[#examples-threadsafetydirchdir]
-=== Examples
-
-[source,ruby]
-----
-# bad
-Dir.chdir("/var/run")
-
-# bad
-FileUtils.chdir("/var/run")
-----
-
-[#threadsafetymutableclassinstancevariable]
-== ThreadSafety/MutableClassInstanceVariable
-
-|===
-| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
-
-| Enabled
-| Yes
-| Always (Unsafe)
-| -
-| -
-|===
-
-Checks whether some class instance variable isn't a
-mutable literal (e.g. array or hash).
-
-It is based on Style/MutableConstant from RuboCop.
-See https://github.com/rubocop/rubocop/blob/master/lib/rubocop/cop/style/mutable_constant.rb
-
-Class instance variables are a risk to threaded code as they are shared
-between threads. A mutable object such as an array or hash may be
-updated via an attr_reader so would not be detected by the
-ThreadSafety/ClassAndModuleAttributes cop.
-
-Strict mode can be used to freeze all class instance variables, rather
-than just literals.
-Strict mode is considered an experimental feature. It has not been
-updated with an exhaustive list of all methods that will produce frozen
-objects so there is a decent chance of getting some false positives.
-Luckily, there is no harm in freezing an already frozen object.
-
-[#examples-threadsafetymutableclassinstancevariable]
-=== Examples
-
-[#enforcedstyle_-literals-_default_-threadsafetymutableclassinstancevariable]
-==== EnforcedStyle: literals (default)
-
-[source,ruby]
-----
-# bad
-class Model
-  @list = [1, 2, 3]
-end
-
-# good
-class Model
-  @list = [1, 2, 3].freeze
-end
-
-# good
-class Model
-  @var = <<~TESTING.freeze
-    This is a heredoc
-  TESTING
-end
-
-# good
-class Model
-  @var = Something.new
-end
-----
-
-[#enforcedstyle_-strict-threadsafetymutableclassinstancevariable]
-==== EnforcedStyle: strict
-
-[source,ruby]
-----
-# bad
-class Model
-  @var = Something.new
-end
-
-# bad
-class Model
-  @var = Struct.new do
-    def foo
-      puts 1
-    end
-  end
-end
-
-# good
-class Model
-  @var = Something.new.freeze
-end
-
-# good
-class Model
-  @var = Struct.new do
-    def foo
-      puts 1
-    end
-  end.freeze
-end
-----
-
-[#configurable-attributes-threadsafetymutableclassinstancevariable]
-=== Configurable attributes
-
-|===
-| Name | Default value | Configurable values
-
-| EnforcedStyle
-| `literals`
-| `literals`, `strict`
-|===
-
-[#threadsafetynewthread]
-== ThreadSafety/NewThread
-
-|===
-| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
-
-| Enabled
-| Yes
-| No
-| -
-| -
-|===
-
-Avoid starting new threads.
-
-Let a framework like Sidekiq handle the threads.
-
-[#examples-threadsafetynewthread]
-=== Examples
-
-[source,ruby]
-----
-# bad
-Thread.new { do_work }
-----
-
-[#threadsafetyrackmiddlewareinstancevariable]
-== ThreadSafety/RackMiddlewareInstanceVariable
-
-|===
-| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
-
-| Enabled
-| Yes
-| No
-| -
-| -
-|===
-
-Avoid instance variables in rack middleware.
-
-Middlewares are initialized once, meaning any instance variables are shared between executor threads.
-To avoid potential race conditions, it's recommended to design middlewares to be stateless
-or to implement proper synchronization mechanisms.
-
-[#examples-threadsafetyrackmiddlewareinstancevariable]
-=== Examples
-
-[source,ruby]
-----
-# bad
-class CounterMiddleware
-  def initialize(app)
-    @app = app
-    @counter = 0
-  end
-
-  def call(env)
-    app.call(env)
-  ensure
-    @counter += 1
-  end
-end
-
-# good
-class CounterMiddleware
-  def initialize(app)
-    @app = app
-    @counter = Concurrent::AtomicReference.new(0)
-  end
-
-  def call(env)
-    app.call(env)
-  ensure
-    @counter.update { |ref| ref + 1 }
-  end
-end
-
-class IdentityMiddleware
-  def initialize(app)
-    @app = app
-  end
-
-  def call(env)
-    app.call(env)
-  end
-end
-----
-
-[#configurable-attributes-threadsafetyrackmiddlewareinstancevariable]
-=== Configurable attributes
-
-|===
-| Name | Default value | Configurable values
-
-| Include
-| `+app/middleware/**/*.rb+`, `+lib/middleware/**/*.rb+`, `+app/middlewares/**/*.rb+`, `+lib/middlewares/**/*.rb+`
-| Array
-
-| AllowedIdentifiers
-| `[]`
-| Array
-|===

data/gemfiles/rubocop_1.48.gemfile

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-# This file was generated by Appraisal
-
-source 'https://rubygems.org'
-
-gem 'appraisal'
-gem 'base64', '~> 0.1.1'
-gem 'bundler', '>= 1.10', '< 3'
-gem 'prism', '~> 1.2.0'
-gem 'pry'
-gem 'rake', '>= 10.0'
-gem 'rspec', '~> 3.0'
-gem 'rubocop', '~> 1.48.0'
-gem 'rubocop-rake', '~> 0.6.0'
-gem 'rubocop-rspec'
-gem 'simplecov'
-gem 'yard'
-
-gemspec path: '../'

data/gemfiles/rubocop_1.66.gemfile

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-# This file was generated by Appraisal
-
-source 'https://rubygems.org'
-
-gem 'appraisal'
-gem 'bundler', '>= 1.10', '< 3'
-gem 'prism', '~> 1.2.0'
-gem 'pry'
-gem 'rake', '>= 10.0'
-gem 'rspec', '~> 3.0'
-gem 'rubocop', '~> 1.66.0'
-gem 'rubocop-rake', '~> 0.6.0'
-gem 'rubocop-rspec'
-gem 'simplecov'
-gem 'yard'
-
-gemspec path: '../'

data/lib/rubocop/thread_safety/inject.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-# The original code is from https://github.com/rubocop/rubocop-rspec/blob/master/lib/rubocop/rspec/inject.rb
-# See https://github.com/rubocop/rubocop-rspec/blob/master/MIT-LICENSE.md
-module RuboCop
-  module ThreadSafety
-    # Because RuboCop doesn't yet support plugins, we have to monkey patch in a
-    # bit of our configuration.
-    module Inject
-      def self.defaults!
-        path = CONFIG_DEFAULT.to_s
-        hash = ConfigLoader.__send__(:load_yaml_configuration, path)
-        config = Config.new(hash, path).tap(&:make_excludes_absolute)
-        puts "configuration from \#{path}" if ConfigLoader.debug?
-        config = ConfigLoader.merge_with_default(config, path)
-        ConfigLoader.instance_variable_set(:@default_configuration, config)
-      end
-    end
-  end
-end

data/rubocop-thread_safety.gemspec

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-lib = File.expand_path('lib', __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'rubocop/thread_safety/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = 'rubocop-thread_safety'
-  spec.version       = RuboCop::ThreadSafety::VERSION
-  spec.authors       = ['Michael Gee']
-  spec.email         = ['michaelpgee@gmail.com']
-
-  spec.summary       = 'Thread-safety checks via static analysis'
-  spec.description   = <<-DESCRIPTION
-    Thread-safety checks via static analysis.
-    A plugin for the RuboCop code style enforcing & linting tool.
-  DESCRIPTION
-  spec.homepage = 'https://github.com/rubocop/rubocop-thread_safety'
-  spec.licenses = ['MIT']
-
-  spec.files = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
-  end
-
-  spec.metadata = {
-    'changelog_uri' => 'https://github.com/rubocop/rubocop-thread_safety/blob/master/CHANGELOG.md',
-    'source_code_uri' => 'https://github.com/rubocop/rubocop-thread_safety',
-    'bug_tracker_uri' => 'https://github.com/rubocop/rubocop-thread_safety/issues',
-    'rubygems_mfa_required' => 'true'
-  }
-
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
-
-  spec.required_ruby_version = '>= 2.7.0'
-
-  spec.add_dependency 'rubocop', '>= 1.48.1'
-end

data/tasks/cops_documentation.rake

@@ -1,46 +0,0 @@
-# frozen_string_literal: true
-
-require 'rubocop'
-require 'rubocop-thread_safety'
-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
-  deps = ['ThreadSafety']
-  CopsDocumentationGenerator.new(departments: deps).call
-end
-
-desc 'Syntax check for the documentation comments'
-task documentation_syntax_check: :yard_for_generate_documentation do
-  require 'parser/ruby31'
-
-  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::Ruby31.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