rubocop-thread_safety 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d2f9c0ded508d65e482cd339fc6bafe4a843f19982884ea8c03aa0f6ceb1f4cd
-  data.tar.gz: bcfb88db93ee4c0bacdb1df6e60e72bdd044209ecd1c9c27fc8b8e8597f5eff9
+  metadata.gz: ca09c8c0f8772fca865f55df6d350d28c0d3b6ab11a81f2837b76b74ce29b8bb
+  data.tar.gz: 16ac028cb86f4853370d6863974e2ac6cacd64253fbe9b93d2f4084ec0e89125
 SHA512:
-  metadata.gz: 81a037e33675b2aa5cf77bad8732b43e4b09bcbb0fc1127fe64eda0481516a20068e70f3afd32d4a69673729c8ce68422374b81ad7788a9de6bbe0ab9d4ae4bd
-  data.tar.gz: e6c0c3e2626e371eaf47b7fc144eb7659661d98184c47e2002d49a3f276e744f6ebc67c932fa361ff4379e536322d775579303b51e0dcf806907e9e712e61532
+  metadata.gz: 5c303f9423fe7dccfc38f47ce3a22bcc2dbb573b6754c46c3216bf49787e0bf4c5ab162af9cd1471021b5b6eea1a57ec5358d4cb699bd5a369d2116fb0d4b25b
+  data.tar.gz: 57ca57201e7dbc8e36458d1d97d95aae84a6b7ec7cd7d4282fd632b8f29caf54f98402315d678dbbf98f9a83d2cfecd411cb345907dead297d19f56ad1d94ee3

data/.gitignore

@@ -1,6 +1,7 @@
 /.bundle/
 /.yardoc
 /Gemfile.lock
+/gemfiles/*.lock
 /_yardoc/
 /coverage/
 /doc/

data/.rubocop.yml

@@ -1,5 +1,12 @@
 AllCops:
   DisplayCopNames: true
+  TargetRubyVersion: 2.3
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
 
 Metrics/BlockLength:
   Exclude:
@@ -24,6 +31,19 @@ Style/AutoResourceCleanup:
 Style/CollectionMethods:
   Enabled: true
 
+Style/FrozenStringLiteralComment:
+  Exclude:
+    - "gemfiles/*.gemfile"
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: false
+
+Style/HashTransformValues:
+  Enabled: false
+
 Style/MethodCalledOnDoEndBlock:
   Enabled: true
   Exclude:
@@ -39,6 +59,10 @@ Style/OptionHash:
 Style/Send:
   Enabled: true
 
+Style/StringLiterals:
+  Exclude:
+    - "gemfiles/*.gemfile"
+
 Style/StringMethods:
   Enabled: true
 

data/.travis.yml

@@ -1,20 +1,55 @@
-sudo: false
 cache: bundler
 language: ruby
 rvm:
-  - jruby-9.1.14.0
+  - jruby-9.2.9.0
   - 2.3.0
   - 2.4
   - 2.5
   - 2.6
   - 2.7
 
-matrix:
+gemfile:
+  - gemfiles/rubocop_0.53.gemfile
+  - gemfiles/rubocop_0.81.gemfile
+  - gemfiles/rubocop_0.86.gemfile
+
+script_rubocop: &script_rubocop
+  - bundle exec rspec
+  - bundle exec rubocop
+
+jobs:
   fast_finish: true
+  exclude:
+  - rvm: 2.3.0
+    gemfile: gemfiles/rubocop_0.86.gemfile
+  - rvm: 2.5
+    gemfile: gemfiles/rubocop_0.53.gemfile
+  - rvm: 2.6
+    gemfile: gemfiles/rubocop_0.53.gemfile
+  - rvm: 2.7
+    gemfile: gemfiles/rubocop_0.53.gemfile
+  include:
+  - rvm: jruby-9.2.9.0
+    gemfile: gemfiles/rubocop_0.81.gemfile
+    script: *script_rubocop
+  - rvm: 2.3.0
+    gemfile: gemfiles/rubocop_0.81.gemfile
+    script: *script_rubocop
+  - rvm: 2.4
+    gemfile: gemfiles/rubocop_0.81.gemfile
+    script: *script_rubocop
+  - rvm: 2.5
+    gemfile: gemfiles/rubocop_0.81.gemfile
+    script: *script_rubocop
+  - rvm: 2.6
+    gemfile: gemfiles/rubocop_0.81.gemfile
+    script: *script_rubocop
+  - rvm: 2.7
+    gemfile: gemfiles/rubocop_0.81.gemfile
+    script: *script_rubocop
 
 before_install: gem install --remote bundler
 install:
   - bundle install --retry=3
 script:
   - bundle exec rspec
-  - bundle exec rubocop

data/Appraisals

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+appraise 'rubocop-0.53' do
+  gem 'rubocop', '~> 0.53.0'
+end
+
+appraise 'rubocop-0.81' do
+  gem 'rubocop', '~> 0.81.0'
+end
+
+if Gem::Requirement.new('>= 2.4.0')
+                   .satisfied_by?(Gem::Version.new(RUBY_VERSION))
+  appraise 'rubocop-0.86' do
+    gem 'rubocop', '~> 0.86.0'
+  end
+end

data/README.md

@@ -38,6 +38,27 @@ Scan the application for just thread-safety issues:
 
 There are some added [configuration options](https://github.com/covermymeds/rubocop-thread_safety/blob/master/config/default.yml) that can be tweaked to modify the behaviour of these thread-safety cops.
 
+### Correcting code for thread-safety
+
+There are a few ways to improve thread-safety that stem around avoiding
+unsynchronized mutation of state that is shared between multiple threads.
+
+State shared between threads may take various forms, including:
+
+* Class variables (`@@name`). Note: these affect child classes too.
+* Class instance variables (`@name` in class context or class methods)
+* Constants (`NAME`). Ruby will warn if a constant is re-assigned to a new value but will allow it. Mutable objects can still be mutated (e.g. push to an array) even if they are assigned to a constant.
+* Globals (`$name`), with the possible exception of some special globals provided by ruby that are documented as thread-local like regular expression results.
+* Variables in the scope of created threads (where `Thread.new` is called).
+
+Improvements that would make shared state thread-safe include:
+
+* `freeze` objects to protect against mutation. Note: `freeze` is shallow, i.e. freezing an array will not also freeze its elements.
+* Use data structures or concurrency abstractions from [concurrent-ruby](https://github.com/ruby-concurrency/concurrent-ruby), e.g. `Concurrent::Map`
+* Use a `Mutex` or similar to `synchronize` access.
+* Use [`RequestStore`](https://github.com/steveklabnik/request_store)
+* Use `Thread.current[:name]`
+
 ## 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/config/default.yml

@@ -28,3 +28,4 @@ ThreadSafety/NewThread:
   Description: >-
                  Avoid starting new threads.
                  Let a framework like Sidekiq handle the threads.
+  Enabled: true

data/gemfiles/rubocop_0.53.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rubocop", "~> 0.53.0"
+
+gemspec path: "../"

data/gemfiles/rubocop_0.81.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rubocop", "~> 0.81.0"
+
+gemspec path: "../"

data/gemfiles/rubocop_0.86.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rubocop", "~> 0.86.0"
+
+gemspec path: "../"

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

@@ -15,25 +15,25 @@ module RuboCop
       class ClassAndModuleAttributes < Cop
         MSG = 'Avoid mutating class and module attributes.'
 
-        def_node_matcher :mattr?, <<-MATCHER
+        def_node_matcher :mattr?, <<~MATCHER
           (send nil?
             {:mattr_writer :mattr_accessor :cattr_writer :cattr_accessor}
             ...)
         MATCHER
 
-        def_node_matcher :attr?, <<-MATCHER
+        def_node_matcher :attr?, <<~MATCHER
           (send nil?
             {:attr :attr_accessor :attr_writer}
             ...)
         MATCHER
 
-        def_node_matcher :attr_internal?, <<-MATCHER
+        def_node_matcher :attr_internal?, <<~MATCHER
           (send nil?
             {:attr_internal :attr_internal_accessor :attr_internal_writer}
             ...)
         MATCHER
 
-        def_node_matcher :class_attr?, <<-MATCHER
+        def_node_matcher :class_attr?, <<~MATCHER
           (send nil?
             :class_attribute
             ...)
@@ -50,7 +50,19 @@ module RuboCop
 
         def singleton_attr?(node)
           (attr?(node) || attr_internal?(node)) &&
-            node.ancestors.map(&:type).include?(:sclass)
+            defined_in_singleton_class?(node)
+        end
+
+        def defined_in_singleton_class?(node)
+          node.ancestors.each do |ancestor|
+            case ancestor.type
+            when :def then return false
+            when :sclass then return true
+            else next
+            end
+          end
+
+          false
         end
       end
     end

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

@@ -29,14 +29,22 @@ module RuboCop
       #       end
       #     end
       #   end
+      #
+      #   module Example
+      #     module ClassMethods
+      #       def test(params)
+      #         @params = params
+      #       end
+      #     end
+      #   end
       class InstanceVariableInClassMethod < Cop
         MSG = 'Avoid instance variables in class methods.'
 
-        def_node_matcher :instance_variable_set_call?, <<-MATCHER
+        def_node_matcher :instance_variable_set_call?, <<~MATCHER
           (send nil? :instance_variable_set (...) (...))
         MATCHER
 
-        def_node_matcher :instance_variable_get_call?, <<-MATCHER
+        def_node_matcher :instance_variable_get_call?, <<~MATCHER
           (send nil? :instance_variable_get (...))
         MATCHER
 
@@ -61,6 +69,7 @@ module RuboCop
         def class_method_definition?(node)
           in_defs?(node) ||
             in_def_sclass?(node) ||
+            in_def_class_methods?(node) ||
             singleton_method_definition?(node)
         end
 
@@ -80,6 +89,18 @@ module RuboCop
           end
         end
 
+        def in_def_class_methods?(node)
+          defn = node.ancestors.find(&:def_type?)
+          return unless defn
+
+          mod = defn.ancestors.find do |ancestor|
+            %i[class module].include?(ancestor.type)
+          end
+          return unless mod
+
+          class_methods_module?(mod)
+        end
+
         def singleton_method_definition?(node)
           node.ancestors.any? do |ancestor|
             next unless ancestor.children.first.is_a? AST::SendNode
@@ -100,6 +121,10 @@ module RuboCop
         def instance_variable_call?(node)
           instance_variable_set_call?(node) || instance_variable_get_call?(node)
         end
+
+        def_node_matcher :class_methods_module?, <<~PATTERN
+          (module (const _ :ClassMethods) ...)
+        PATTERN
       end
     end
   end

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

@@ -34,7 +34,7 @@ module RuboCop
       #
       #   # good
       #   class Model
-      #     @var = <<-TESTING.freeze
+      #     @var = <<~TESTING.freeze
       #       This is a heredoc
       #     TESTING
       #   end
@@ -138,6 +138,7 @@ module RuboCop
         def strict_check(value)
           return if immutable_literal?(value)
           return if operation_produces_immutable_object?(value)
+          return if operation_produces_threadsafe_object?(value)
           return if frozen_string_literal?(value)
 
           add_offense(value)
@@ -167,7 +168,9 @@ module RuboCop
         end
 
         def mutable_literal?(node)
-          node&.mutable_literal?
+          return if node.nil?
+
+          node.mutable_literal? || range_type?(node)
         end
 
         def immutable_literal?(node)
@@ -180,10 +183,14 @@ module RuboCop
         end
 
         def requires_parentheses?(node)
-          node.range_type? ||
+          range_type?(node) ||
             (node.send_type? && node.loc.dot.nil?)
         end
 
+        def range_type?(node)
+          node.erange_type? || node.irange_type?
+        end
+
         def correct_splat_expansion(corrector, expr, splat_value)
           if range_enclosed_in_parentheses?(splat_value)
             corrector.replace(expr, "#{splat_value.source}.to_a")
@@ -192,33 +199,65 @@ module RuboCop
           end
         end
 
-        def_node_matcher :define_singleton_method?, <<-PATTERN
+        def_node_matcher :define_singleton_method?, <<~PATTERN
           (block (send nil? :define_singleton_method ...) ...)
         PATTERN
 
-        def_node_matcher :splat_value, <<-PATTERN
+        def_node_matcher :splat_value, <<~PATTERN
           (array (splat $_))
         PATTERN
 
         # NOTE: Some of these patterns may not actually return an immutable
         # object but we will consider them immutable for this cop.
-        def_node_matcher :operation_produces_immutable_object?, <<-PATTERN
+        def_node_matcher :operation_produces_immutable_object?, <<~PATTERN
           {
             (const _ _)
-            (send (const nil? :Struct) :new ...)
-            (block (send (const nil? :Struct) :new ...) ...)
+            (send (const {nil? cbase} :Struct) :new ...)
+            (block (send (const {nil? cbase} :Struct) :new ...) ...)
             (send _ :freeze)
             (send {float int} {:+ :- :* :** :/ :% :<<} _)
             (send _ {:+ :- :* :** :/ :%} {float int})
             (send _ {:== :=== :!= :<= :>= :< :>} _)
-            (send (const nil? :ENV) :[] _)
-            (or (send (const nil? :ENV) :[] _) _)
+            (send (const {nil? cbase} :ENV) :[] _)
+            (or (send (const {nil? cbase} :ENV) :[] _) _)
             (send _ {:count :length :size} ...)
             (block (send _ {:count :length :size} ...) ...)
           }
         PATTERN
 
-        def_node_matcher :range_enclosed_in_parentheses?, <<-PATTERN
+        def_node_matcher :operation_produces_threadsafe_object?, <<~PATTERN
+          {
+            (send (const {nil? cbase} :Queue) :new ...)
+            (send
+              (const (const {nil? cbase} :ThreadSafe) {:Hash :Array})
+              :new ...)
+            (block
+              (send
+                (const (const {nil? cbase} :ThreadSafe) {:Hash :Array})
+                :new ...)
+              ...)
+            (send (const (const {nil? cbase} :Concurrent) _) :new ...)
+            (block
+              (send (const (const {nil? cbase} :Concurrent) _) :new ...)
+              ...)
+            (send (const (const (const {nil? cbase} :Concurrent) _) _) :new ...)
+            (block
+              (send
+                (const (const (const {nil? cbase} :Concurrent) _) _)
+                :new ...)
+              ...)
+            (send
+              (const (const (const (const {nil? cbase} :Concurrent) _) _) _)
+              :new ...)
+            (block
+              (send
+                (const (const (const (const {nil? cbase} :Concurrent) _) _) _)
+                :new ...)
+              ...)
+          }
+        PATTERN
+
+        def_node_matcher :range_enclosed_in_parentheses?, <<~PATTERN
           (begin ({irange erange} _ _))
         PATTERN
       end

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

@@ -13,8 +13,8 @@ module RuboCop
       class NewThread < Cop
         MSG = 'Avoid starting new threads.'
 
-        def_node_matcher :new_thread?, <<-MATCHER
-          (send (const nil? :Thread) :new)
+        def_node_matcher :new_thread?, <<~MATCHER
+          (send (const {nil? cbase} :Thread) :new)
         MATCHER
 
         def on_send(node)

data/lib/rubocop/thread_safety/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module ThreadSafety
-    VERSION = '0.4.1'
+    VERSION = '0.4.2'
   end
 end

data/rubocop-thread_safety.gemspec

@@ -26,10 +26,12 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'rubocop', '>= 0.51.0'
+  spec.required_ruby_version = '>= 2.3.0'
 
+  spec.add_runtime_dependency 'rubocop', '>= 0.53.0'
+
+  spec.add_development_dependency 'appraisal'
   spec.add_development_dependency 'bundler', '>= 1.10', '< 3'
-  spec.add_development_dependency 'powerpack', '~> 0.1'
   spec.add_development_dependency 'pry' unless ENV['CI']
   spec.add_development_dependency 'rake', '>= 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-thread_safety
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - Michael Gee
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-26 00:00:00.000000000 Z
+date: 2020-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -16,48 +16,48 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.51.0
+        version: 0.53.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.51.0
+        version: 0.53.0
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.10'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.10'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: powerpack
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.10'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.10'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -113,6 +113,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- Appraisals
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -120,6 +121,9 @@ files:
 - bin/console
 - bin/setup
 - config/default.yml
+- gemfiles/rubocop_0.53.gemfile
+- gemfiles/rubocop_0.81.gemfile
+- gemfiles/rubocop_0.86.gemfile
 - lib/rubocop-thread_safety.rb
 - lib/rubocop/cop/thread_safety/class_and_module_attributes.rb
 - lib/rubocop/cop/thread_safety/instance_variable_in_class_method.rb
@@ -141,7 +145,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="