inclusive-code 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b984b231154566e4f8d334aec467d8a8e6f985a8e3bd3faccc7251b8bb76222a
-  data.tar.gz: 734179a39aa026ea3266a10709712552bc1ce7c8e7c0c43eee29e36bf5cd0f99
+  metadata.gz: f0e9a66b10fa6c3d82c8faa54ddacb5953682d660b3751567aec4af6e6a1d945
+  data.tar.gz: cdb7d1ec5ceaa41f4fa134c449a463251c59560a2d4ae6e8fe87d4e46b7acc6d
 SHA512:
-  metadata.gz: dab29167526189675e57a227a1e0c74c12651fff08b5f6eb258ae44daf82ac564d85a8d0b7f3703514a943a2bab1b3a8f7322f276380c866f048a054dc592fe7
-  data.tar.gz: 100acf863203a84c36a43c71252b8a10ca3f88f7eda70210b55ee6852ecd5a7a9d4a7e2a6e024e6691872a74c5e9c3edcda41939265f7729899d66a52750191d
+  metadata.gz: 87f0191b289b92d8b3241b05295d12b661fda42aa671519471b2bb494ed6ca3853d8b4a3aee662c8ba6828693fc50f4a219d60b8d6552069585571dacd99fd5d
+  data.tar.gz: 1782766b518b793d0e702a2977c499f672a4ea1bbfc5009f1efbb628e3458ac536469265b95e9b705cdf6fdf64ddccab27319ee2ce07572ebb98f8517254778a

data/README.md

@@ -26,8 +26,11 @@ require:
 Flexport/InclusiveCode:
   Enabled: true
   GlobalConfigPath: 'app/constants/inclusive_code/inclusive_code_flagged_terms.yml' # or your path
+  DisableAutoCorrect: false
 ```
 
 You can run the cop on your entire codebase with `rubocop --only Flexport/InclusiveCode`. 
 
 You can run the cop on a specific file with `rubocop --only Flexport/InclusiveCode file_path`.
+
+If you want to add inline `rubocop:disable` or `rubocop:todo` comments on all offenses, set `DisableAutoCorrect: true` in your .rubocop.yml, and run `rubocop --only Flexport/InclusiveCode --auto-correct --disable-uncorrectable`.

data/lib/rubocop/cop/inclusive_code.rb

@@ -61,19 +61,23 @@ module RuboCop
                 :scan,
                 scan_regex
               ).map { Regexp.last_match&.offset(0)&.first }
+
+              non_inclusive_words = line.scan /#{non_inclusive_word}/i
+
+              locations = locations.zip(non_inclusive_words).to_h
               next if locations.blank?
 
-              locations.each do |location|
+              locations.each do |location, word|
                 range = source_range(
                   processed_source.buffer,
                   line_number + 1,
                   location,
-                  non_inclusive_word.length
+                  word.length
                 )
                 add_offense(
                   range,
                   location: range,
-                  message: create_message(non_inclusive_word),
+                  message: create_message(word),
                   severity: SEVERITY
                 )
               end
@@ -99,11 +103,10 @@ module RuboCop
           return if cop_config['DisableAutoCorrect']
 
           word_to_correct = arg_pair.source
-          word_to_correct_downcase = word_to_correct.downcase
-          return unless @non_inclusive_words_alternatives_hash.key?(word_to_correct_downcase)
-          return if @non_inclusive_words_alternatives_hash[word_to_correct_downcase]['suggestions'].blank?
+          correction = correction_for_word(word_to_correct)
+          return if correction['suggestions'].blank?
 
-          corrected = @non_inclusive_words_alternatives_hash[word_to_correct_downcase]['suggestions'][0]
+          corrected = correction['suggestions'][0]
 
           # Only respects case if it is capitalized or uniform (all upper or all lower)
           to_upcase = word_to_correct == word_to_correct.upcase
@@ -128,11 +131,19 @@ module RuboCop
           (allowed + snake_case + pascal_case).join('|')
         end
 
+        def correction_for_word(word_to_correct)
+          _, correction = @non_inclusive_words_alternatives_hash.detect {|correction_key, _| Regexp.new(correction_key, Regexp::IGNORECASE).match? word_to_correct.downcase }
+
+          correction || {}
+        end
+
         def create_message(non_inclusive_word)
+          correction = correction_for_word(non_inclusive_word)
+
           format(
             MSG,
             non_inclusive_word: non_inclusive_word,
-            suggestions: @non_inclusive_words_alternatives_hash[non_inclusive_word]['suggestions'].join(', ')
+            suggestions: correction.fetch('suggestions') {[]}.join(', ')
           )
         end
       end

data/lib/rubocop/inclusive_code/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module InclusiveCode
-    VERSION = '0.1.3'
+    VERSION = '0.1.4'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inclusive-code
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Flexport Engineering
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-06 00:00:00.000000000 Z
+date: 2021-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -52,7 +52,7 @@ files:
 - lib/rubocop/inclusive_code.rb
 - lib/rubocop/inclusive_code/inject.rb
 - lib/rubocop/inclusive_code/version.rb
-homepage: https://github.com/flexport/inclusive-code
+homepage: https://github.com/flexport/rubocop-flexport
 licenses:
 - MIT
 metadata: {}