rubocop-i18n 2.0.2 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 298270613b63bb269fc258034c5a16aab14f764e5631540d672a44662e2d8b66
-  data.tar.gz: 2422d8f873a23edbbd9873df60af5db71370ceca545b4134a8ea9d7e0f1ffc37
+  metadata.gz: 900bad082ace7d17bf13e8a01691f33c021fb683f5bf4963b1a4f217d98720c8
+  data.tar.gz: df4f70a869ae98441bb1d98b8b9365a8a06368ffeb6b63c16138291ff241fb32
 SHA512:
-  metadata.gz: 3d4ae45e34a92d3b3eb013929e4fef7ae3fb7967575a55273575edf6032bfcac243e6e320e15a010f8c914032fc7e1e05acc0e14ab155f25d91512ea9e610e0e
-  data.tar.gz: 92507187ded035d39a07ae4b967cd97017a1879876c0cb74877fc20d0f04d3606aa6d0ef12b377a8e1e178a46e3da6f1a5d77a7fa995bfa1378ffce8c09d57dd
+  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

@@ -2,6 +2,9 @@ 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

data/.rubocop_todo.yml

@@ -1,44 +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_spec.rb'
 
-# Offense count: 4
+# Offense count: 2
+# Configuration parameters: IgnoredMethods.
 Metrics/AbcSize:
   Max: 29
 
-# Offense count: 6
-# Configuration parameters: CountComments, ExcludedMethods.
-Metrics/BlockLength:
-  Enabled: false
-  Max: 61
-
 # Offense count: 1
-# Configuration parameters: CountComments.
+# Configuration parameters: CountComments, CountAsOne.
 Metrics/ClassLength:
-  Enabled: false
-  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:
@@ -49,37 +55,37 @@ Style/Documentation:
     - 'lib/rubocop/cop/i18n/gettext/decorate_function_message.rb'
 
 # Offense count: 12
-# Configuration parameters: EnforcedStyle.
+# 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/rails_i18n/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_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_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
-
-Naming/FileName:
-  Exclude:
-    - 'lib/rubocop-i18n.rb'

data/.ruby-version

@@ -1 +1 @@
-2.5.6
+2.7.2

data/.travis.yml

@@ -1,4 +1,12 @@
+---
+os: linux
+dist: xenial
 language: ruby
-fast_finish: true
+rvm:
+  - 2.5.8
+  - 2.6.6
+  - 2.7.2
+jobs:
+  fast_finish: true
 notifications:
   email: true

data/CHANGELOG.md

@@ -1,6 +1,12 @@
 # Change Log
 
-### [master (Unreleased)](https://github.com/puppetlabs/rubocop-i18n/compare/v2.0.2...master)
+### [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)
 

data/CODEOWNERS

@@ -2,4 +2,4 @@
 # 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 @tphoney
+*       @highb @puppetlabs/open-source-stewards

data/README.md

@@ -34,33 +34,33 @@ require:
 ...
 # You *must* choose GetText or Rails-i18n style checking
 # If you want GetText-style checking
-GetText:
+I18n/GetText:
   Enabled: true
-RailsI18n:
+I18n/RailsI18n:
   Enabled: false
 # If you want rails-i18n-style checking
-RailsI18n:
+I18n/RailsI18n:
   Enabled: true
-GetText:
+I18n/GetText:
   Enabled: false
 # If you want custom control of all the cops
-GetText/DecorateString:
+I18n/GetText/DecorateString:
   Enabled: false
   # Disable the autocorrect
   AutoCorrect: false
-GetText/DecorateFunctionMessage:
+I18n/GetText/DecorateFunctionMessage:
   Enabled: false
-GetText/DecorateStringFormattingUsingInterpolation:
+I18n/GetText/DecorateStringFormattingUsingInterpolation:
   Enabled: false
-GetText/DecorateStringFormattingUsingPercent:
+I18n/GetText/DecorateStringFormattingUsingPercent:
   Enabled: false
-RailsI18n/DecorateString:
+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.
@@ -90,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.
@@ -206,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 '#{}'
@@ -233,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
@@ -256,7 +256,7 @@ raise(_("Warning is %s") % ['bad'])
 raise(_("Warning is %{value}") % { value: 'bad' })
 ```
 
-### RailsI18n/DecorateString
+### I18n/RailsI18n/DecorateString
 
 This cop looks for decorated rails-i18n methods.
 
@@ -280,7 +280,7 @@ raise(translate("Warning is %{value}") % { value: 'good' })
 raise(I18n.t("Warning is %{value}") % { value: 'good' })
 ```
 
-### RailsI18n/DecorateStringFormattingUsingInterpolation
+### 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 '#{}'
@@ -311,11 +311,11 @@ puts t("path.to.key.with.interpolation")
 
 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 RailsI18n/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/rubocop-i18n.gemspec

@@ -2,11 +2,10 @@
 
 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       = '2.0.2'
+  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']
 
@@ -22,11 +21,12 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  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,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-i18n
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 3.0.0
 platform: ruby
 authors:
 - Puppet
 - Brandon High
 - TP Honey
 - Helen Campbell
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-05-19 00:00:00.000000000 Z
+date: 2020-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -89,28 +89,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.51'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.51'
-- !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 (gettext and rails-i18n)
 email:
@@ -122,6 +108,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
 - ".gitignore"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
@@ -151,7 +139,7 @@ homepage: https://github.com/puppetlabs/rubocop-i18n
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -159,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.7.6.2
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: RuboCop rules for i18n
 test_files: []