rubocop-i18n 1.3.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1519b7393133fbbd4edcc8aa1fdeaa46bd93155b
-  data.tar.gz: 2e16dc911733af1dc139d31b69c383b226c3db51
+SHA256:
+  metadata.gz: 900bad082ace7d17bf13e8a01691f33c021fb683f5bf4963b1a4f217d98720c8
+  data.tar.gz: df4f70a869ae98441bb1d98b8b9365a8a06368ffeb6b63c16138291ff241fb32
 SHA512:
-  metadata.gz: 9f2110409579d9d8eae8d3d5501a841d6b75dae69b66048563808bb4ed40391256360d48c8700851979d32bf171757469429f5d3a98c7f0a26c4b879ac71ff7d
-  data.tar.gz: 8b1fde24e8b0368d2e7139369e3a94e799266f3be6bbb7b79c4bd3a887118adc5c6023ade4413183791856b0dc473e305258e772a1445acb71d3438e32abfd6d
+  metadata.gz: 666a5de6a09a035d64937dcdf1441faaef249ebc6df44572f37d858ffdf00f2509abc56581900fb839d857e2e4da2c7a9e71f0d20476ab67c8d83022670052b7
+  data.tar.gz: 9c5cc9f02c4408c8f3a2667125b65bb1a6385bf7d885b38787521961646240d4684d81988592298009ec54660f3533f8722b8c1118809528f2d6641f0ac808b2

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

data/.rubocop.yml

@@ -1,3 +1,11 @@
 inherit_from: .rubocop_todo.yml
 require:
   - rubocop/cop/internal_affairs
+
+AllCops:
+  TargetRubyVersion: 2.5
+
+Metrics/BlockLength:
+  Exclude:
+    # Exclude the spec directory because the rspec DSL results in long blocks
+    - 'spec/**/*'

data/.rubocop_todo.yml

@@ -1,43 +1,50 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2018-06-12 15:16:26 -0700 using RuboCop version 0.57.2.
+# on 2020-10-25 09:49:30 UTC using RuboCop version 1.0.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 6
+# Offense count: 1
+# Configuration parameters: Include.
+# Include: **/*.gemspec
+Gemspec/RequiredRubyVersion:
+  Exclude:
+    - 'rubocop-i18n.gemspec'
+
+# Offense count: 1
+# Cop supports --auto-correct.
 Lint/InterpolationCheck:
   Exclude:
-    - 'spec/rubocop/cop/i18n/gettext/decorate_string_formatting_using_interpolation_spec.rb'
     - 'spec/rubocop/cop/i18n/gettext/decorate_string_spec.rb'
 
-# Offense count: 4
+# Offense count: 2
+# Configuration parameters: IgnoredMethods.
 Metrics/AbcSize:
   Max: 29
 
-# Offense count: 6
-# Configuration parameters: CountComments, ExcludedMethods.
-Metrics/BlockLength:
-  Max: 61
-
 # Offense count: 1
-# Configuration parameters: CountComments.
+# Configuration parameters: CountComments, CountAsOne.
 Metrics/ClassLength:
-  Max: 106
+  Max: 108
 
-# Offense count: 3
+# Offense count: 5
+# Configuration parameters: IgnoredMethods.
 Metrics/CyclomaticComplexity:
   Max: 8
 
 # Offense count: 7
-# Configuration parameters: CountComments.
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods.
 Metrics/MethodLength:
   Max: 25
 
-# Offense count: 2
-Metrics/PerceivedComplexity:
-  Max: 8
+# Offense count: 1
+# Configuration parameters: ExpectMatchingDefinition, CheckDefinitionPathHierarchy, Regex, IgnoreExecutableScripts, AllowedAcronyms.
+# AllowedAcronyms: CLI, DSL, ACL, API, ASCII, CPU, CSS, DNS, EOF, GUID, HTML, HTTP, HTTPS, ID, IP, JSON, LHS, QPS, RAM, RHS, RPC, SLA, SMTP, SQL, SSH, TCP, TLS, TTL, UDP, UI, UID, UUID, URI, URL, UTF8, VM, XML, XMPP, XSRF, XSS
+Naming/FileName:
+  Exclude:
+    - 'lib/rubocop-i18n.rb'
 
 # Offense count: 2
 Style/Documentation:
@@ -47,35 +54,38 @@ Style/Documentation:
     - 'lib/rubocop/cop/i18n/gettext.rb'
     - 'lib/rubocop/cop/i18n/gettext/decorate_function_message.rb'
 
-# Offense count: 11
-# Configuration parameters: EnforcedStyle.
+# Offense count: 12
+# Configuration parameters: MaxUnannotatedPlaceholdersAllowed.
 # SupportedStyles: annotated, template, unannotated
 Style/FormatStringToken:
-  Exclude:
-    - 'spec/rubocop/cop/i18n/gettext/decorate_function_message_spec.rb'
-    - 'spec/rubocop/cop/i18n/gettext/decorate_string_formatting_using_interpolation_spec.rb'
-    - 'spec/rubocop/cop/i18n/gettext/decorate_string_formatting_using_percent_spec.rb'
-    - 'spec/rubocop/cop/i18n/gettext/decorate_string_spec.rb'
+  EnforcedStyle: template
 
-# Offense count: 3
+# Offense count: 2
 # Configuration parameters: MinBodyLength.
 Style/GuardClause:
   Exclude:
     - 'lib/rubocop/cop/i18n/gettext/decorate_function_message.rb'
-    - 'lib/rubocop/cop/i18n/gettext/decorate_string_formatting_using_interpolation.rb'
     - 'lib/rubocop/cop/i18n/gettext/decorate_string_formatting_using_percent.rb'
 
-# Offense count: 10
+# Offense count: 6
 # Cop supports --auto-correct.
 Style/IfUnlessModifier:
   Exclude:
     - 'lib/rubocop/cop/i18n/gettext/decorate_function_message.rb'
-    - 'lib/rubocop/cop/i18n/gettext/decorate_string_formatting_using_interpolation.rb'
     - 'lib/rubocop/cop/i18n/gettext/decorate_string_formatting_using_percent.rb'
-    - 'lib/rubocop/rspec/cop_helper.rb'
 
-# Offense count: 93
-# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# Offense count: 5
+# Configuration parameters: AllowModifier.
+Style/SoleNestedConditional:
+  Exclude:
+    - 'lib/rubocop/cop/i18n/gettext/decorate_function_message.rb'
+    - 'lib/rubocop/cop/i18n/gettext/decorate_string.rb'
+    - 'lib/rubocop/cop/i18n/gettext/decorate_string_formatting_using_percent.rb'
+    - 'lib/rubocop/cop/i18n/rails_i18n/decorate_string.rb'
+
+# Offense count: 50
+# Cop supports --auto-correct.
+# Configuration parameters: AutoCorrect, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https
-Metrics/LineLength:
+Layout/LineLength:
   Max: 174

data/.ruby-version

@@ -0,0 +1 @@
+2.7.2

data/.travis.yml

@@ -1,7 +1,12 @@
+---
+os: linux
+dist: xenial
 language: ruby
-matrix:
+rvm:
+  - 2.5.8
+  - 2.6.6
+  - 2.7.2
+jobs:
   fast_finish: true
-  include:
-    - rvm: 2.4.1
 notifications:
-  email: false
+  email: true

data/CHANGELOG.md

@@ -1,6 +1,31 @@
 # Change Log
 
-## master (unreleased)
+### [master (Unreleased)](https://github.com/puppetlabs/rubocop-i18n/compare/v3.0.0...master)
+### [3.0.0](https://github.com/puppetlabs/rubocop-i18n/compare/v2.0.2...v3.0.0)
+
+* Update Rubocop version to 1.0! Thank you @mvz!
+* Cop namespace fixes, documentation updates, loading issues. Thank you again @mvz !
+* Gem maintainership has been passed to @highb. Thank you @binford2k and @lucywyman!
+* Update Ruby versions in gemspec, Travis, .ruby-version. Thank you @sfeuga!
+
+### [2.0.2](https://github.com/puppetlabs/rubocop-i18n/compare/v2.0.1...v2.0.2)
+
+* Add auto-correct for `DecorateString` (#40) Thanks @mvz!
+* Update rake and bundler requirements to be more permissive of newer versions (#43)
+
+### 2.0.1
+
+* `chmod` all the files to be world readable and ensured that `gem
+build` doesn't emit any warnings.
+* fixes license name
+* specifies version for pry and rb-readline
+* bump Z version
+
+### 2.0.0
+
+* Add rails-i18n support and documentation in README. Thanks @kbacha!
+
+### 1.3.1, 1.3.0, 1.2.0
 
  * Updated DecorateString to look for sentences using a regular expression that should be decorated. This limits the number of strings that it finds to things that look like a sentence.
  * Code restructure (no API changes)

data/CODEOWNERS

@@ -0,0 +1,5 @@
+# These owners will be the default owners for everything in
+# the repo. Unless a later match takes precedence,
+# @global-owner1 and @global-owner2 will be requested for
+# review when someone opens a pull request.
+*       @highb @puppetlabs/open-source-stewards

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in rubocop-i18n.gemspec

data/README.md

@@ -1,7 +1,14 @@
 # Rubocop::I18n
 
+[![Build Status](https://travis-ci.org/puppetlabs/rubocop-i18n.svg?branch=master)](https://travis-ci.org/puppetlabs/rubocop-i18n)
+
 A set of cops for detecting strings that need i18n decoration in your project.
 
+Supports the following framework styles:
+
+- gettext
+- rails-i18n
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -25,19 +32,35 @@ In your `rubocop.yml`:
 require:
  - rubocop-i18n
 ...
-GetText/DecorateString:
+# You *must* choose GetText or Rails-i18n style checking
+# If you want GetText-style checking
+I18n/GetText:
   Enabled: true
-GetText/DecorateFunctionMessage:
-  Enabled: true
-GetText/DecorateStringFormattingUsingInterpolation
-  Enabled: true
-GetText/DecorateStringFormattingUsingPercent
+I18n/RailsI18n:
+  Enabled: false
+# If you want rails-i18n-style checking
+I18n/RailsI18n:
   Enabled: true
+I18n/GetText:
+  Enabled: false
+# If you want custom control of all the cops
+I18n/GetText/DecorateString:
+  Enabled: false
+  # Disable the autocorrect
+  AutoCorrect: false
+I18n/GetText/DecorateFunctionMessage:
+  Enabled: false
+I18n/GetText/DecorateStringFormattingUsingInterpolation:
+  Enabled: false
+I18n/GetText/DecorateStringFormattingUsingPercent:
+  Enabled: false
+I18n/RailsI18n/DecorateString:
+  Enabled: false
 ```
 
 ## Cops
 
-### GetText/DecorateString
+### I18n/GetText/DecorateString
 
 This cop is looks for strings that appear to be sentences but are not decorated. 
 Sentences are determined by the STRING_REGEXP.
@@ -67,7 +90,7 @@ _("Result is good.")
 "a string that doesn't start with a capital letter."
 ```
 
-### GetText/DecorateFunctionMessage
+### I18n/GetText/DecorateFunctionMessage
 
 This cop looks for any raise or fail functions and checks that the user visible message is using gettext decoration with the _() function.
 This cop makes sure the message is decorated, as well as checking that the formatting of the message is compliant according to the follow rules.
@@ -183,7 +206,7 @@ raise(someOtherFuntioncall(foo, "bar"))
 In this raise or fail function, the message does not contain any decoration at all and the message is not a simple string. It may make sense to convert the message to a simple string. eg [Simple decoration of a message](#Simple-decoration-of-a-message). 
 Or ignore this raise or fail function following this [How to ignore rules in code](#How-to-ignore-rules-in-code) section.
 
-### GetText/DecorateStringFormattingUsingInterpolation
+### I18n/GetText/DecorateStringFormattingUsingInterpolation
 
 This cop looks for decorated gettext methods _() and checks that all strings contained
 within do not use string interpolation '#{}'
@@ -210,7 +233,7 @@ puts _("a message with a #{'interpolation'}")
 puts _("a message that is %{type}") % { type: 'translatable' }
 ```
 
-### GetText/DecorateStringFormattingUsingPercent
+### I18n/GetText/DecorateStringFormattingUsingPercent
 
 This cop looks for decorated gettext methods _() and checks that all strings contained
 within do not use sprintf formatting '%s' etc
@@ -233,14 +256,66 @@ raise(_("Warning is %s") % ['bad'])
 raise(_("Warning is %{value}") % { value: 'bad' })
 ```
 
+### I18n/RailsI18n/DecorateString
+
+This cop looks for decorated rails-i18n methods.
+
+##### Error message thrown
+
+```
+decorator is missing around sentence
+```
+
+##### Bad
+
+``` ruby
+raise("Warning is %s" % ['bad'])
+```
+
+##### Good
+
+``` ruby
+raise(t("Warning is %{value}") % { value: 'good' })
+raise(translate("Warning is %{value}") % { value: 'good' })
+raise(I18n.t("Warning is %{value}") % { value: 'good' })
+```
+
+### I18n/RailsI18n/DecorateStringFormattingUsingInterpolation
+
+This cop looks for decorated rails-i18n methods like `t()` and `translate()` and checks that all strings contained
+within do not use string interpolation '#{}'
+
+#### Simple decoration of a message
+
+Simple message strings should be decorated with the t() function
+
+##### Error message thrown
+
+```
+'t' function, message key string should not contain #{} formatting
+```
+
+##### Bad
+
+``` ruby
+puts t("path.to.key.with.#{'interpolation'}")
+```
+
+##### Good
+
+``` ruby
+puts t("path.to.key.with.interpolation")
+```
+
 ## How to ignore rules in code
 
 It may be necessary to ignore a cop for a particular piece of code. We follow standard rubocop idioms.
 ``` ruby
-raise("We don't want this translated.")                 # rubocop:disable GetText/DecorateString
-raise("We don't want this translated")                  # rubocop:disable GetText/DecorateFunctionMessage
-raise(_("We don't want this translated #{crazy}")       # rubocop:disable GetText/DecorateStringFormattingUsingInterpolation)
-raise(_("We don't want this translated %s") % ['crazy'] # rubocop:disable GetText/DecorateStringFormattingUsingPercent)
+raise("We don't want this translated.")                 # rubocop:disable I18n/GetText/DecorateString
+raise("We don't want this translated.")                 # rubocop:disable I18n/RailsI18n/DecorateString
+raise("We don't want this translated")                  # rubocop:disable I18n/GetText/DecorateFunctionMessage
+raise(_("We don't want this translated #{crazy}")       # rubocop:disable I18n/GetText/DecorateStringFormattingUsingInterpolation)
+raise(_("We don't want this translated %s") % ['crazy'] # rubocop:disable I18n/GetText/DecorateStringFormattingUsingPercent)
 ```
 
 ## Known Issues

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bundler/setup'
 require 'rubocop/i18n'

data/lib/rubocop-i18n.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require 'rubocop/cop/i18n'

data/lib/rubocop/cop/i18n.rb

@@ -1,6 +1,12 @@
+# frozen_string_literal: true
+
 require 'rubocop'
 require 'rubocop/cop/i18n/gettext'
 require 'rubocop/cop/i18n/gettext/decorate_string'
 require 'rubocop/cop/i18n/gettext/decorate_function_message'
 require 'rubocop/cop/i18n/gettext/decorate_string_formatting_using_interpolation'
 require 'rubocop/cop/i18n/gettext/decorate_string_formatting_using_percent'
+
+require 'rubocop/cop/i18n/rails_i18n'
+require 'rubocop/cop/i18n/rails_i18n/decorate_string'
+require 'rubocop/cop/i18n/rails_i18n/decorate_string_formatting_using_interpolation'

data/lib/rubocop/cop/i18n/gettext/decorate_function_message.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RuboCop
   module Cop
     module I18n
@@ -6,7 +8,9 @@ module RuboCop
           def on_send(node)
             method_name = node.loc.selector.source
             return unless GetText.supported_method?(method_name)
-            _, method_name, *arg_nodes = *node
+
+            method_name = node.method_name
+            arg_nodes = node.arguments
             if !arg_nodes.empty? && !already_decorated?(node) && (contains_string?(arg_nodes) || string_constant?(arg_nodes))
               message_section = if string_constant?(arg_nodes)
                                   arg_nodes[1]
@@ -51,7 +55,8 @@ module RuboCop
           def detect_and_report(_node, message_section, method_name)
             errors = how_bad_is_it(message_section)
             return if errors.empty?
-            error_message = "'#{method_name}' function, "
+
+            error_message = ["'#{method_name}' function, "]
             errors.each do |error|
               error_message << 'message string should be decorated. ' if error == :simple
               error_message << 'message should not be a concatenated string. ' if error == :concatenation
@@ -59,6 +64,7 @@ module RuboCop
               error_message << 'message should use correctly formatted interpolation. ' if error == :interpolation
               error_message << 'message should be decorated. ' if error == :no_decoration
             end
+            error_message = error_message.join('\n')
             add_offense(message_section, message: error_message)
           end
 
@@ -115,6 +121,7 @@ module RuboCop
                 # dstrs are split into "str" segments and other segments.
                 # The "other" segments are the interpolated values.
                 next unless child.begin_type?
+
                 value = child.children[0]
                 hash_key = 'value'
                 if value.lvar_type?

data/lib/rubocop/cop/i18n/gettext/decorate_string.rb

@@ -20,7 +20,7 @@ module RuboCop
         #
         #   _("Result is good.")
         class DecorateString < Cop
-          STRING_REGEXP = /^\s*[[:upper:]][[:alpha:]]*[[:blank:]]+.*[.!?]$/
+          STRING_REGEXP = /^\s*[[:upper:]][[:alpha:]]*[[:blank:]]+.*[.!?]$/.freeze
 
           def on_dstr(node)
             check_for_parent_decorator(node) if dstr_contains_sentence?(node)
@@ -37,6 +37,10 @@ module RuboCop
             check_for_parent_decorator(node)
           end
 
+          def autocorrect(node)
+            single_string_correct(node) if node.str_type?
+          end
+
           private
 
           def sentence?(node)
@@ -63,11 +67,18 @@ module RuboCop
             if parent.respond_to?(:type) && parent.send_type?
               method_name = parent.loc.selector.source
               return if GetText.supported_decorator?(method_name)
-            elsif parent.respond_to?(:method_name) && parent.method_name == :[]
+            elsif parent.respond_to?(:method_name) && parent.method?(:[])
               return
             end
             add_offense(node, message: 'decorator is missing around sentence')
           end
+
+          def single_string_correct(node)
+            lambda { |corrector|
+              corrector.insert_before(node.source_range, '_(')
+              corrector.insert_after(node.source_range, ')')
+            }
+          end
         end
       end
     end

data/lib/rubocop/cop/i18n/gettext/decorate_string_formatting_using_interpolation.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RuboCop
   module Cop
     module I18n
@@ -24,11 +26,13 @@ module RuboCop
           def on_send(node)
             decorator_name = node.loc.selector.source
             return unless GetText.supported_decorator?(decorator_name)
-            _, method_name, *arg_nodes = *node
-            if !arg_nodes.empty? && contains_string_formatting_with_interpolation?(arg_nodes)
-              message_section = arg_nodes[0]
-              add_offense(message_section, message: "'#{method_name}' function, message string should not contain \#{} formatting")
-            end
+
+            method_name = node.method_name
+            arg_nodes = node.arguments
+            return unless !arg_nodes.empty? && contains_string_formatting_with_interpolation?(arg_nodes)
+
+            message_section = arg_nodes[0]
+            add_offense(message_section, message: "'#{method_name}' function, message string should not contain \#{} formatting")
           end
 
           private
@@ -38,19 +42,12 @@ module RuboCop
           end
 
           def contains_string_formatting_with_interpolation?(node)
-            if node.is_a?(Array)
-              return node.any? { |n| contains_string_formatting_with_interpolation?(n) }
-            end
-
-            if node.respond_to?(:type)
-              if node.str_type? || node.dstr_type?
-                return string_contains_interpolation_format?(node.source)
-              end
-            end
-
-            if node.respond_to?(:children)
-              return node.children.any? { |child| contains_string_formatting_with_interpolation?(child) }
-            end
+            return node.any? { |n| contains_string_formatting_with_interpolation?(n) } if node.is_a?(Array)
+
+            return string_contains_interpolation_format?(node.source) if node.respond_to?(:type) && (node.str_type? || node.dstr_type?)
+
+            return node.children.any? { |child| contains_string_formatting_with_interpolation?(child) } if node.respond_to?(:children)
+
             false
           end
         end

data/lib/rubocop/cop/i18n/gettext/decorate_string_formatting_using_percent.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RuboCop
   module Cop
     module I18n
@@ -27,7 +29,9 @@ module RuboCop
           def on_send(node)
             decorator_name = node.loc.selector.source
             return unless GetText.supported_decorator?(decorator_name)
-            _, method_name, *arg_nodes = *node
+
+            method_name = node.method_name
+            arg_nodes = node.arguments
             if !arg_nodes.empty? && contains_string_with_percent_format?(arg_nodes)
               message_section = arg_nodes[0]
               add_offense(message_section, message: "'#{method_name}' function, message string should not contain sprintf style formatting (ie %s)")
@@ -54,6 +58,7 @@ module RuboCop
             if node.respond_to?(:children)
               return node.children.any? { |child| contains_string_with_percent_format?(child) }
             end
+
             false
           end
         end

data/lib/rubocop/cop/i18n/rails_i18n.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module I18n
+      # The Rails I18n module contains cops used to lint and enforce the use of strings
+      # in rails applications that want to use the I18n gem.
+      module RailsI18n
+        def self.supported_decorators
+          %w[
+            t
+            t!
+            translate
+            translate!
+          ].freeze
+        end
+
+        def self.supported_decorator?(decorator_name)
+          supported_decorators.include?(decorator_name)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/i18n/rails_i18n/decorate_string.rb

@@ -0,0 +1,176 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module I18n
+      module RailsI18n
+        # This cop is looks for strings that appear to be sentences but are not decorated.
+        # Sentences are determined by the SENTENCE_REGEXP. (Upper case character, at least one space,
+        # and sentence punctuation at the end)
+        #
+        # @example
+        #
+        #   # bad
+        #
+        #   "Result is bad."
+        #
+        # @example
+        #
+        #   # good
+        #
+        #   t("result_is_good")
+        #   I18n.t("result_is_good")
+        #
+        # There are several options for configuration.
+        #
+        # @example IgnoreExceptions: true
+        #   # OK
+        #
+        #   raise "Some string sentence"
+        #
+        # @example EnforcedSentenceType: sentence
+        #   # bad
+        #
+        #   "Result is bad."
+        #
+        #   # good
+        #
+        #   t("result_is_good")
+        #   I18n.t("result_is_good")
+        #
+        # @example EnforcedSentenceType: fragmented_sentence
+        #   # bad
+        #
+        #   "Result is bad"   # Contains a capital to start
+        #   "result is bad."  # Ends in punctuation
+        #
+        #   # good
+        #
+        #   t("result_is_good")
+        #   I18n.t("result_is_good")
+        #
+        # @example EnforcedSentenceType: fragment
+        #   # bad
+        #
+        #   "result is bad"   # A series of words
+        #
+        #   # good
+        #
+        #   t("result_is_good")
+        #   I18n.t("result_is_good")
+        #
+        # @example Regexp: ^only-this-text$
+        #
+        #   # bad
+        #
+        #   "only-this-text"
+        #
+        #   # good
+        #
+        #   "Any other string is fine now"
+        #   t("only_this_text")
+        #
+        class DecorateString < Cop
+          SENTENCE_REGEXP = /^\s*[[:upper:]][[:alpha:]]*[[:blank:]]+.*[.!?]$/.freeze
+          FRAGMENTED_SENTENCE_REGEXP = /^\s*([[:upper:]][[:alpha:]]*[[:blank:]]+.*)|([[:alpha:]]*[[:blank:]]+.*[.!?])$/.freeze
+          FRAGMENT_REGEXP = /^\s*[[:alpha:]]*[[:blank:]]+.*$/.freeze
+          SUPPORTED_DECORATORS = %w[
+            t
+            t!
+            translate
+            translate!
+          ].freeze
+
+          def on_dstr(node)
+            check_for_parent_decorator(node) if dstr_contains_sentence?(node)
+          end
+
+          def on_str(node)
+            return unless sentence?(node)
+
+            parent = node.parent
+            if parent.respond_to?(:type)
+              return if parent.regexp_type? || parent.dstr_type?
+            end
+
+            check_for_parent_decorator(node)
+          end
+
+          private
+
+          def sentence?(node)
+            child = node.children[0]
+            if child.is_a?(String)
+              if child.valid_encoding?
+                child.encode(Encoding::UTF_8).chomp =~ regexp
+              else
+                false
+              end
+            elsif child.respond_to?(:type) && child.str_type?
+              sentence?(child)
+            else
+              false
+            end
+          end
+
+          def regexp
+            @regexp ||= regexp_from_config || regexp_from_string_type
+          end
+
+          def regexp_from_string_type
+            case cop_config['EnforcedSentenceType'].to_s.downcase
+            when 'sentence'            then SENTENCE_REGEXP
+            when 'fragmented_sentence' then FRAGMENTED_SENTENCE_REGEXP
+            when 'fragment'            then FRAGMENT_REGEXP
+            else
+              SENTENCE_REGEXP
+            end
+          end
+
+          def regexp_from_config
+            Regexp.new(cop_config['Regexp']) if cop_config['Regexp']
+          end
+
+          def dstr_contains_sentence?(node)
+            node.children.any? { |child| sentence?(child) }
+          end
+
+          def check_for_parent_decorator(node)
+            return if parent_is_translator?(node.parent)
+            return if parent_is_indexer?(node.parent)
+            return if ignoring_raised_parent?(node.parent)
+
+            add_offense(node, message: 'decorator is missing around sentence')
+          end
+
+          def ignoring_raised_parent?(parent)
+            return false unless cop_config['IgnoreExceptions']
+
+            return true if parent.respond_to?(:method_name) && %i[raise fail].include?(parent.method_name)
+
+            # Commonly exceptions are initialized manually.
+            return ignoring_raised_parent?(parent.parent) if parent.respond_to?(:method_name) && parent.method?(:new)
+
+            false
+          end
+
+          def parent_is_indexer?(parent)
+            parent.respond_to?(:method_name) && parent.method?(:[])
+          end
+
+          def parent_is_translator?(parent)
+            if parent.respond_to?(:type) && parent.send_type?
+              method_name = parent.loc.selector.source
+              if RailsI18n.supported_decorator?(method_name)
+                # Implicit receiver is assumed correct.
+                return true if parent.receiver.nil?
+                return true if parent.receiver.children == [nil, :I18n]
+              end
+            end
+            false
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/i18n/rails_i18n/decorate_string_formatting_using_interpolation.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module I18n
+      module RailsI18n
+        # When using an decorated string to support I18N, any strings inside the decoration should not contain
+        # the '#{}' interpolation string as this makes it hard to translate the strings.
+        #
+        # @example
+        #
+        #   # bad
+        #
+        #   t("status.#{status_string}")
+        #   t("status." + "accepted")
+        #
+        # @example
+        #
+        #   # good
+        #
+        #   t("status.accepted")
+        #
+        class DecorateStringFormattingUsingInterpolation < Cop
+          def on_send(node)
+            return unless node&.loc&.selector
+
+            decorator_name = node.loc.selector.source
+            return unless RailsI18n.supported_decorator?(decorator_name)
+
+            method_name = node.method_name
+            arg_nodes = node.arguments
+            return unless !arg_nodes.empty? && contains_string_formatting_with_interpolation?(arg_nodes)
+
+            message_section = arg_nodes[0]
+            add_offense(message_section, message: error_message(method_name))
+          end
+
+          private
+
+          def error_message(method_name)
+            "'#{method_name}' function, message key string should not contain \#{} formatting"
+          end
+
+          def string_contains_interpolation_format?(str)
+            str.match(/\#{[^}]+}/)
+          end
+
+          def contains_string_formatting_with_interpolation?(node)
+            return node.any? { |n| contains_string_formatting_with_interpolation?(n) } if node.is_a?(Array)
+
+            return string_contains_interpolation_format?(node.source) if node.respond_to?(:type) && (node.str_type? || node.dstr_type?)
+
+            return node.children.any? { |child| contains_string_formatting_with_interpolation?(child) } if node.respond_to?(:children)
+
+            false
+          end
+        end
+      end
+    end
+  end
+end

data/rubocop-i18n.gemspec

@@ -1,17 +1,18 @@
+# frozen_string_literal: true
+
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-rubocop_version = '~> 0.51'
 
 Gem::Specification.new do |spec|
   spec.name          = 'rubocop-i18n'
-  spec.version       = '1.3.0'
+  spec.version       = '3.0.0'
   spec.authors       = ['Puppet', 'Brandon High', 'TP Honey', 'Helen Campbell']
   spec.email         = ['team-modules@puppet.com', 'brandon.high@puppet.com', 'tp@puppet.com', 'helen@puppet.com']
 
   spec.summary       = 'RuboCop rules for i18n'
-  spec.description   = 'RuboCop rules for detecting and autocorrecting undecorated strings for i18n'
+  spec.description   = 'RuboCop rules for detecting and autocorrecting undecorated strings for i18n (gettext and rails-i18n)'
   spec.homepage      = 'https://github.com/puppetlabs/rubocop-i18n'
-  spec.license       = 'Apache-2'
+  spec.license       = 'Apache-2.0'
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
@@ -20,11 +21,12 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.14'
-  spec.add_development_dependency 'pry'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rb-readline'
+  spec.required_ruby_version = '>= 2.5.8'
+
+  spec.add_development_dependency 'bundler', '>= 1.17.3'
+  spec.add_development_dependency 'pry', '~> 0.13.1'
+  spec.add_development_dependency 'rake', '>= 12.3.3'
+  spec.add_development_dependency 'rb-readline', '~> 0.5.5'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rubocop', rubocop_version
-  spec.add_runtime_dependency 'rubocop', rubocop_version
+  spec.add_runtime_dependency 'rubocop', '~> 1.0'
 end

metadata

@@ -1,118 +1,104 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-i18n
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Puppet
 - Brandon High
 - TP Honey
 - Helen Campbell
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2018-09-21 00:00:00.000000000 Z
+date: 2020-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.14'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.14'
-- !ruby/object:Gem::Dependency
-  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.17.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.17.3
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 0.13.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 0.13.1
 - !ruby/object:Gem::Dependency
-  name: rb-readline
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rb-readline
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 0.5.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 0.5.5
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.51'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.51'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.51'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.51'
+        version: '1.0'
 description: RuboCop rules for detecting and autocorrecting undecorated strings for
-  i18n
+  i18n (gettext and rails-i18n)
 email:
 - team-modules@puppet.com
 - brandon.high@puppet.com
@@ -122,11 +108,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
 - ".gitignore"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
+- ".ruby-version"
 - ".travis.yml"
 - CHANGELOG.md
+- CODEOWNERS
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE
@@ -141,13 +131,15 @@ files:
 - lib/rubocop/cop/i18n/gettext/decorate_string.rb
 - lib/rubocop/cop/i18n/gettext/decorate_string_formatting_using_interpolation.rb
 - lib/rubocop/cop/i18n/gettext/decorate_string_formatting_using_percent.rb
-- lib/rubocop/rspec/cop_helper.rb
+- lib/rubocop/cop/i18n/rails_i18n.rb
+- lib/rubocop/cop/i18n/rails_i18n/decorate_string.rb
+- lib/rubocop/cop/i18n/rails_i18n/decorate_string_formatting_using_interpolation.rb
 - rubocop-i18n.gemspec
 homepage: https://github.com/puppetlabs/rubocop-i18n
 licenses:
-- Apache-2
+- Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -155,16 +147,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.8
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14.1
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: RuboCop rules for i18n
 test_files: []

data/lib/rubocop/rspec/cop_helper.rb

@@ -1,98 +0,0 @@
-# frozen_string_literal: true
-
-require 'tempfile'
-
-# This module provides methods that make it easier to test Cops.
-module CopHelper
-  extend RSpec::SharedContext
-
-  let(:ruby_version) { 2.2 }
-  let(:enabled_rails) { false }
-  let(:rails_version) { false }
-
-  def inspect_source_file(source)
-    Tempfile.open('tmp') { |f| inspect_source(source, f) }
-  end
-
-  def inspect_gemfile(source)
-    inspect_source(source, 'Gemfile')
-  end
-
-  def inspect_source(source, file = nil)
-    if source.is_a?(Array) && source.size == 1
-      raise "Don't use an array for a single line of code: #{source}"
-    end
-    RuboCop::Formatter::DisabledConfigFormatter.config_to_allow_offenses = {}
-    RuboCop::Formatter::DisabledConfigFormatter.detected_styles = {}
-    processed_source = parse_source(source, file)
-    raise 'Error parsing example code' unless processed_source.valid_syntax?
-    _investigate(cop, processed_source)
-  end
-
-  def parse_source(source, file = nil)
-    source = source.join($RS) if source.is_a?(Array)
-
-    if file && file.respond_to?(:write)
-      file.write(source)
-      file.rewind
-      file = file.path
-    end
-
-    RuboCop::ProcessedSource.new(source, ruby_version, file)
-  end
-
-  def autocorrect_source_file(source)
-    Tempfile.open('tmp') { |f| autocorrect_source(source, f) }
-  end
-
-  def autocorrect_source(source, file = nil)
-    cop.instance_variable_get(:@options)[:auto_correct] = true
-    processed_source = parse_source(source, file)
-    _investigate(cop, processed_source)
-
-    corrector =
-      RuboCop::Cop::Corrector.new(processed_source.buffer, cop.corrections)
-    corrector.rewrite
-  end
-
-  def autocorrect_source_with_loop(source, file = nil)
-    loop do
-      cop.instance_variable_set(:@corrections, [])
-      new_source = autocorrect_source(source, file)
-      return new_source if new_source == source
-      source = new_source
-    end
-  end
-
-  def _investigate(cop, processed_source)
-    forces = RuboCop::Cop::Force.all.each_with_object([]) do |klass, instances|
-      next unless cop.join_force?(klass)
-      instances << klass.new([cop])
-    end
-
-    commissioner =
-      RuboCop::Cop::Commissioner.new([cop], forces, raise_error: true)
-    commissioner.investigate(processed_source)
-    commissioner
-  end
-end
-
-module RuboCop
-  module Cop
-    # Monkey-patch Cop for tests to provide easy access to messages and
-    # highlights.
-    class Cop
-      def messages
-        offenses.sort.map(&:message)
-      end
-
-      def highlights
-        offenses.sort.map { |o| o.location.source }
-      end
-    end
-  end
-end
-
-RSpec.configure do |config|
-  config.include CopHelper
-end