rubocop-inclusivity 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b6237d1e9d200e8c88398b425785f2b71e01d2cf7ff8853c208efd83a23449f
-  data.tar.gz: 29777d338a59293c206a6d3233a829c375a344cae93d554c06aa95296ca91e21
+  metadata.gz: 3833b1927a9e751644572e0cdad9b33db8e34fab732c39ba6baafa66eec33016
+  data.tar.gz: c38bfbc149c5553cde194d39382243e9563c842a1fbb28ba4d1c8e31a4211b5a
 SHA512:
-  metadata.gz: 4ab213c6f39cac2db6df37d991fccbb6121f12d71293c8970e5b5fcadf44a5a8c8a7510a62a9a57527a419702796c31d27816625b007037def98641edb81e18a
-  data.tar.gz: 3a46b067de2c5bbc3f968c04ff22f511f77d3e8087a3a167ef739b4193e72dd9fb6a44bdebdddc03e338d7874aadd97fa39b8aeffcfc3caeed6969ae19f2dab5
+  metadata.gz: 7e02c15c0180190c147d446273a13716510bd633e56d7f8b1666bf2331bef2395454a740bedb2d08c7d9f10e34ed74de8037f1cbb8d70d126a235e7afb82d946
+  data.tar.gz: f7613cb5850619a21bb8da40f603a7fd3a77bf6192557b3002aacac8b5b473e619150553a830cc42a9055484c515b37e01adddd9dfb4b1b907bbc1c2db8b7c67

data/.github/workflows/ci.yml

@@ -11,7 +11,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
-      - uses: actions/setup-ruby@v1
+      - uses: ruby/setup-ruby@v1
       - name: Run RSpec
         run: |
           gem install bundler

data/.gitignore

@@ -7,5 +7,7 @@
 /spec/reports/
 /tmp/
 
+.byebug_history
+
 # rspec failure tracking
 .rspec_status

data/.ruby-version

@@ -0,0 +1 @@
+3.0.3

data/Gemfile.lock

@@ -1,95 +1,70 @@
 PATH
   remote: .
   specs:
-    rubocop-inclusivity (1.0.0)
-      rubocop
+    rubocop-inclusivity (1.1.0)
+      activesupport (>= 4)
+      rubocop (> 0.87.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.0.2.2)
+    activesupport (7.0.2.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2)
-    addressable (2.7.0)
-      public_suffix (>= 2.0.2, < 5.0)
-    ast (2.4.0)
-    byebug (9.1.0)
-    concurrent-ruby (1.1.6)
-    diff-lcs (1.3)
-    faraday (0.17.3)
-      multipart-post (>= 1.2, < 3)
-    faraday-http-cache (2.0.0)
-      faraday (~> 0.8)
-    github_changelog_generator (1.15.0)
-      activesupport
-      faraday-http-cache
-      multi_json
-      octokit (~> 4.6)
-      rainbow (>= 2.2.1)
-      rake (>= 10.0)
-      retriable (~> 3.0)
-    i18n (1.8.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    ast (2.4.1)
+    byebug (11.1.3)
+    concurrent-ruby (1.1.9)
+    diff-lcs (1.4.4)
+    i18n (1.10.0)
       concurrent-ruby (~> 1.0)
-    jaro_winkler (1.5.4)
-    minitest (5.14.0)
-    multi_json (1.14.1)
-    multipart-post (2.1.1)
-    octokit (4.18.0)
-      faraday (>= 0.9)
-      sawyer (~> 0.8.0, >= 0.5.3)
-    parallel (1.19.1)
-    parser (2.7.1.0)
-      ast (~> 2.4.0)
-    public_suffix (4.0.3)
+    minitest (5.15.0)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
     rainbow (3.0.0)
     rake (12.3.3)
-    retriable (3.1.2)
+    regexp_parser (2.0.3)
     rexml (3.2.4)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.1)
-      rspec-support (~> 3.9.1)
-    rspec-expectations (3.9.1)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.2)
-    rubocop (0.80.1)
-      jaro_winkler (~> 1.5.1)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.1)
+    rubocop (1.8.1)
       parallel (~> 1.10)
-      parser (>= 2.7.0.1)
+      parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
       rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.0)
+      parser (>= 2.7.1.5)
     rubocop-performance (1.5.2)
       rubocop (>= 0.71.0)
-    ruby-progressbar (1.10.1)
-    sawyer (0.8.2)
-      addressable (>= 2.3.5)
-      faraday (> 0.8, < 2.0)
-    standard (0.2.3)
-      rubocop (~> 0.80.1)
-      rubocop-performance (~> 1.5.2)
-    thread_safe (0.3.6)
-    tzinfo (1.2.7)
-      thread_safe (~> 0.1)
-    unicode-display_width (1.6.1)
-    zeitwerk (2.3.0)
+    ruby-progressbar (1.11.0)
+    standard (0.0.36)
+      rubocop (>= 0.63)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.0.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   byebug
-  github_changelog_generator
   rake (~> 12.0)
   rspec
   rubocop-inclusivity!
@@ -97,4 +72,4 @@ DEPENDENCIES
   standard
 
 BUNDLED WITH
-   2.1.4
+   2.3.5

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.1.0

data/config/default.yml

@@ -4,6 +4,7 @@ Inclusivity/Race:
     accurate and inclusive words.
   Reference: https://github.com/rails/rails/issues/33677
   Enabled: true
+  Allowlist:
   Offenses:
     whitelist:
       - allowlist

data/lib/rubocop/cop/inclusivity/race.rb

@@ -1,5 +1,9 @@
 # frozen_string_literal: true
 
+require "active_support"
+
+# https://github.com/rubocop-hq/rubocop-ast/blob/5cd306f40e5d5ba4dacf78c698354747cdac7825/docs/modules/ROOT/pages/node_types.adoc
+
 module RuboCop
   module Cop
     module Inclusivity
@@ -16,41 +20,152 @@ module RuboCop
       #   # good
       #   banlist = 1
       #
-      class Race < Cop
+      class Race < Base
+        extend AutoCorrector
+        include ActiveSupport::Inflector
+
+        ALLOWLIST = "Allowlist"
+        OFFENSES = "Offenses"
+        DOUBLE_QUOTE = "\""
         MSG = "`%s` may be insensitive. Consider alternatives: %s"
+        PARTIAL = "partial"
+        SINGLE_QUOTE = "'"
+        SYMBOL = ":"
+        UTF_8 = "UTF-8"
+
+        def simple_substitution(node)
+          name, = *node
+          name && check(node.loc.name, name)
+        end
+        alias on_lvasgn simple_substitution
+        alias on_ivasgn simple_substitution
+        alias on_cvasgn simple_substitution
+        alias on_arg simple_substitution
+        alias on_optarg simple_substitution
+        alias on_restarg simple_substitution
+        alias on_kwoptarg simple_substitution
+        alias on_kwarg simple_substitution
+        alias on_kwrestarg simple_substitution
+        alias on_blockarg simple_substitution
+        alias on_lvar simple_substitution
+        alias on_cvar simple_substitution
+
+        def on_casgn(node)
+          _parent, constant_name, _value = *node
+          check(node.loc.name, constant_name) { |alternative| alternative.upcase }
+        end
 
-        def on_lvasgn(node)
+        def on_sym(node)
           name, = *node
-          return unless name
+          check(node.source_range, name) { |replacement| node.source[0] == SYMBOL ? ":#{replacement}" : replacement }
+        end
 
-          check_name(node, name, node.loc.name)
+        def on_str(node)
+          name, = *node
+          check(node.source_range, name) do |replacement|
+            quote = determine_quote(node.source)
+            "#{quote}#{replacement.downcase}#{quote}"
+          end
+        end
+
+        def on_def(node)
+          name, _args, _forward_args = *node
+          check(node.loc.name, name)
+        end
+
+        def on_send(node)
+          match_methods_and_variables(node) do |variable_name|
+            check(node.loc.selector, variable_name.to_s.delete_suffix("="))
+          end
+        end
+
+        def on_const(node)
+          match_consts(node) do |const_name|
+            check(node.loc.name, const_name)
+          end
         end
-        alias on_ivasgn on_lvasgn
-        alias on_cvasgn on_lvasgn
-        alias on_arg on_lvasgn
-        alias on_optarg on_lvasgn
-        alias on_restarg on_lvasgn
-        alias on_kwoptarg on_lvasgn
-        alias on_kwarg on_lvasgn
-        alias on_kwrestarg on_lvasgn
-        alias on_blockarg on_lvasgn
-        alias on_lvar on_lvasgn
 
         private
 
-        def check_name(node, name, name_range)
-          if (alternatives = preferred_language(name))
-            msg = message(name, alternatives)
-            add_offense(node, location: name_range, message: msg)
+        def_node_matcher :match_methods_and_variables, <<~PATTERN
+          (send _ $_ ...)
+        PATTERN
+
+        def_node_matcher :match_consts, <<~PATTERN
+          (const ... $_)
+        PATTERN
+
+        def determine_quote(source)
+          return SINGLE_QUOTE if source[0] == SINGLE_QUOTE
+          DOUBLE_QUOTE if source[0] == DOUBLE_QUOTE
+        end
+
+        def check(range, input)
+          string = input.to_s.encode(Encoding.find(UTF_8), invalid: :replace, undef: :replace, replace: "")
+          alternatives = preferred_language(string)
+          return unless alternatives
+
+          add_offense(range, message: format(MSG, string, alternatives.join(", "))) do |corrector|
+            replacement = block_given? ? yield(alternatives.first) : alternatives.first
+            corrector.replace(range, replacement)
           end
         end
 
         def preferred_language(word)
-          cop_config["Offenses"][word.to_s.downcase]
+          exclusive_language_matcher.match(word) do |match|
+            next if allow?(word)
+
+            offense = match[0].downcase
+            alternatives = cop_config["Offenses"].fetch(offense)
+            matcher = %r{#{offense}}i
+
+            alternatives.map do |alternative|
+              word.to_s.gsub(matcher) { |match| replace_match(match, alternative) }
+            end
+          end
+        end
+
+        def on_new_investigation
+          processed_source.comments.each do |comment|
+            start_position = comment.location.expression.to_range.first
+            comment.text.split(" ").each do |word|
+              alternatives = preferred_language(word)
+              next unless alternatives
+
+              buffer = @processed_source.buffer
+              end_position = start_position + word.to_s.size
+              range = Parser::Source::Range.new(buffer, start_position, end_position)
+              add_offense(range, message: format(MSG, word.to_s, alternatives.join(", "))) do |corrector|
+                corrector.replace(range, alternatives.first)
+              end
+            ensure
+              start_position += word.size + 1
+            end
+          end
+        end
+
+        def replace_match(word, alternative)
+          normalized_alternative = alternative.downcase
+          return normalized_alternative if word.downcase == word
+          return normalized_alternative.upcase if word.upcase == word
+          return underscore(normalized_alternative) if underscore(word) == word
+          return camelize(normalized_alternative) if camelize(word) == word
+          return camelize(normalized_alternative, false) if camelize(word, false) == word
+          word
+        end
+
+        def allow?(text)
+          allowlist.any? do |(allow, config)|
+            config.fetch(PARTIAL, false) ? text.to_s.match(%r{#{allow}}i) : text.to_s.downcase == allow.to_s.downcase
+          end
+        end
+
+        def allowlist
+          @_allowlist ||= cop_config[ALLOWLIST] || {}
         end
 
-        def message(insensitive, alternatives)
-          format(MSG, insensitive, alternatives.join(", "))
+        def exclusive_language_matcher
+          @_exclusive_language_matcher ||= %r{(#{cop_config[OFFENSES].keys.join("|")})}i
         end
       end
     end

data/rubocop-inclusivity.gemspec

@@ -26,5 +26,6 @@ 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"
+  spec.add_runtime_dependency "rubocop", "> 0.87.0"
+  spec.add_runtime_dependency "activesupport", ">= 4"
 end

metadata

@@ -1,30 +1,44 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-inclusivity
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Chris Fung
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-06-19 00:00:00.000000000 Z
+date: 2022-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 0.87.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 0.87.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-description: 
+        version: '4'
+description:
 email:
 - aergonaut@gmail.com
 executables: []
@@ -35,6 +49,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- ".ruby-version"
 - ".travis.yml"
 - ".versionrc.json"
 - CHANGELOG.md
@@ -65,7 +80,7 @@ metadata:
   homepage_uri: https://github.com/aergonaut/rubocop-inclusivity
   source_code_uri: https://github.com/aergonaut/rubocop-inclusivity
   changelog_uri: https://github.com/aergonaut/rubocop-inclusivity/blob/master/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -80,8 +95,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.3
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: A RuboCop extension to promote inclusive language
 test_files: []