rubocop-thread_safety 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c4f37c2216cfdace60b7ef3f2e2f0b5bb743b9b8a3ee2543bb3a2ed10c90de1a
-  data.tar.gz: 2cfa26d1da425d7d39ee0897d8137d24a5af25cd8911637dfd8093c7097b5a30
+  metadata.gz: fa732d8bbefbcfc25dfd2b8adbfcc84788d77d8a21992b152975d9ee92e2f105
+  data.tar.gz: f2d29b69ad8e94c9c4b5de205b7301d45ffb3fb3a1c69429af27a5000e7350c6
 SHA512:
-  metadata.gz: 405f5f9007c0d1aef55173a0ee4aefb44d16ec4ae5113acdb05750a8792fcbc7759ceab4267132f47906ac999194f2a550b2ce63eef2d117a35c5c9cd1c7d438
-  data.tar.gz: 78e4b72c55d6745a979bff3acf5bf4b393534ca448dfec5aaa765f77dd32a66db5b0291a5fb55d8fa02044407ec95c72185b7e28add1801b456b1eb1f0be904a
+  metadata.gz: ec8b96d08f872297a64bbf558f93a27e09bbe61d2a06b7248fdb2a3896a7367c520eceb0ca7f1e88fdb26fc8a03e2eab1772794353b5e12a3724a3371360d689
+  data.tar.gz: 7479c57f327e71e7fbc7b263ea13af5e4e908d7a29849946329bae072ba454636dca72465b1c7dc64d9150064d5e61ca68a81eb45a4ea247a5af69027afd6fb7

data/.github/workflows/ci.yml

@@ -1,26 +1,55 @@
 name: CI
 
-on: [push, pull_request]
+on:
+  push:
+    branches:
+      - master
+  pull_request:
 
 jobs:
-  test:
-
+  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.5", "2.6", "2.7", "3.0", "3.1", "3.2", ruby-head, jruby-9.2, jruby-9.3]
-        rubocop_version: ["0.90", "1.20"]
+        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@v3
-    - 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
+      - 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,6 +1,10 @@
-name: Lint 
+name: Lint
 
-on: [push, pull_request]
+on:
+  push:
+    branches:
+      - master
+  pull_request:
 
 jobs:
   lint:
@@ -9,11 +13,11 @@ jobs:
     name: Rubocop
 
     steps:
-    - uses: actions/checkout@v3
-    - 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
+      - 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/.rspec

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

data/.rubocop.yml

@@ -1,11 +1,12 @@
-inherit_from: .rubocop_todo.yml
-
 require:
   - rubocop/cop/internal_affairs
+  - rubocop-rake
+  - rubocop-rspec
 
 AllCops:
   DisplayCopNames: true
-  TargetRubyVersion: 2.5
+  TargetRubyVersion: 2.7
+  NewCops: enable
 
 Lint/RaiseException:
   Enabled: true
@@ -40,10 +41,6 @@ Style/FormatStringToken:
   Exclude:
     - spec/**/*
 
-Style/FrozenStringLiteralComment:
-  Exclude:
-    - "gemfiles/*.gemfile"
-
 Style/HashEachMethods:
   Enabled: true
 
@@ -68,12 +65,17 @@ Style/OptionHash:
 Style/Send:
   Enabled: true
 
-Style/StringLiterals:
-  Exclude:
-    - "gemfiles/*.gemfile"
-
 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,9 +1,21 @@
 # frozen_string_literal: true
 
-appraise 'rubocop-0.90' do
-  gem 'rubocop', '~> 0.90.0'
+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.20' do
-  gem 'rubocop', '~> 1.20.0'
+appraise 'rubocop-1.66' do
+  gem 'rubocop', '~> 1.66.0'
 end

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Change log
+
+## 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))
+* [#55](https://github.com/rubocop/rubocop-thread_safety/pull/55): Enhance `ThreadSafety::InstanceVariableInClassMethod` cop to detect offenses within `class_eval/exec` blocks. ([@viralpraxis](https://github.com/viralpraxis))
+* [#54](https://github.com/rubocop/rubocop-thread_safety/pull/54): Drop support for RuboCop older than 1.48. ([@viralpraxis](https://github.com/viralpraxis))
+* [#52](https://github.com/rubocop/rubocop-thread_safety/pull/52): Add new `RackMiddlewareInstanceVariable` cop to detect instance variables in Rack middleware. ([@viralpraxis](https://github.com/viralpraxis))
+* [#48](https://github.com/rubocop/rubocop-thread_safety/pull/48): Do not report instance variables in `ActionDispatch` callbacks in singleton methods. ([@viralpraxis](https://github.com/viralpraxis))
+* [#43](https://github.com/rubocop/rubocop-thread_safety/pull/43): Make detection of ActiveSupport's `class_attribute` configurable. ([@viralpraxis](https://github.com/viralpraxis))
+* [#42](https://github.com/rubocop/rubocop-thread_safety/pull/42): Fix some `InstanceVariableInClassMethod` cop false positive offenses. ([@viralpraxis](https://github.com/viralpraxis))
+* [#41](https://github.com/rubocop/rubocop-thread_safety/pull/41): Drop support for MRI older than 2.7. ([@viralpraxis](https://github.com/viralpraxis))
+* [#38](https://github.com/rubocop/rubocop-thread_safety/pull/38): Fix `NewThread` cop detection is case of `Thread.start`, `Thread.fork`, or `Thread.new` with arguments. ([@viralpraxis](https://github.com/viralpraxis))
+* [#36](https://github.com/rubocop/rubocop-thread_safety/pull/36): Add new `DirChdir` cop to detect `Dir.chdir` calls. ([@viralpraxis](https://github.com/viralpraxis))

data/Gemfile

@@ -2,5 +2,16 @@
 
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in rubocop-thread_safety.gemspec
 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/README.md

@@ -1,7 +1,7 @@
 # RuboCop::ThreadSafety
 
 Thread-safety analysis for your projects, as an extension to
-[RuboCop](https://github.com/bbatsov/rubocop).
+[RuboCop](https://github.com/rubocop/rubocop).
 
 ## Installation and Usage
 
@@ -60,6 +60,8 @@ Improvements that would make shared state thread-safe include:
 * Use [`RequestStore`](https://github.com/steveklabnik/request_store)
 * Use `Thread.current[:name]`
 
+Certain system calls, such as `chdir`, affect the entire process. To avoid potential thread-safety issues, it's preferable to use (if possible) the `chdir` option in methods like `Kernel.system` and `IO.popen` rather than relying on `Dir.chdir`.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/Rakefile

@@ -1,8 +1,22 @@
 # 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/config/default.yml

@@ -5,6 +5,7 @@
 ThreadSafety/ClassAndModuleAttributes:
   Description: 'Avoid mutating class and module attributes.'
   Enabled: true
+  ActiveSupportClassAttributeAllowed: false
 
 ThreadSafety/InstanceVariableInClassMethod:
   Description: 'Avoid using instance variables in class methods.'
@@ -30,3 +31,17 @@ ThreadSafety/NewThread:
                  Avoid starting new threads.
                  Let a framework like Sidekiq handle the threads.
   Enabled: true
+
+ThreadSafety/DirChdir:
+  Description: Avoid using `Dir.chdir` due to its process-wide effect.
+  Enabled: true
+
+ThreadSafety/RackMiddlewareInstanceVariable:
+  Description: Avoid instance variables in Rack middleware.
+  Enabled: true
+  Include:
+    - 'app/middleware/**/*.rb'
+    - 'lib/middleware/**/*.rb'
+    - 'app/middlewares/**/*.rb'
+    - 'lib/middlewares/**/*.rb'
+  AllowedIdentifiers: []

data/config/obsoletion.yml

@@ -0,0 +1,2 @@
+renamed:
+  ThreadSafety/InstanceVariableInClassMethod: ThreadSafety/ClassInstanceVariable

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

@@ -0,0 +1,8 @@
+=== 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

@@ -0,0 +1,361 @@
+////
+  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

@@ -0,0 +1,20 @@
+# 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: '../'