rubocop-i18n 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3e4f819b3b4f5bc73ec0b02ee1bd567ab2d3a40e
-  data.tar.gz: 4d0ec4a7cc1e6046d32421c9253c97a117e74b57
+  metadata.gz: e23a0dde90c58003d524a1baeca709a66c900822
+  data.tar.gz: 1ddec0669b48c044937bcc2b9c52eeb551eb3651
 SHA512:
-  metadata.gz: 2b7502eadea26d2982e80cf6c9e49926656cd1c572f12ec1fe8213279ffbf603d222841f522620d77f33a847a1acf365fb661eb59315e0ab70e377d09e2fccde
-  data.tar.gz: 9fca0a7581cf5cd57ca7741826d558463bef5e641aa1c96053ee2e3d0b6facaf4da6bb77a21b6bab9b6ff18b77042689a61f9d7ca18848c2b2038d0864c1cc12
+  metadata.gz: 855e9c7119359d442e3fc9b0833afaaa0adcb6f72de12403d4b4b3cab1e0cc3dea733b82cd001ca7c8bb9728302d3417fa8deae0056f0f56686e62b24737422f
+  data.tar.gz: 26b98a062a7634ca03c17037f46c7864cdc9bd31e95b2f9a6fd85ed9f8ed381053f36c6449fa95130da881f9afcebe7334c9dc6ead5ee20f2e3c566d362d3d21

data/.rubocop.yml

@@ -0,0 +1 @@
+inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -0,0 +1,69 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2017-10-13 16:58:50 -0700 using RuboCop version 0.49.1.
+# 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: 4
+Metrics/AbcSize:
+  Max: 31
+
+# Offense count: 5
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/BlockLength:
+  Max: 68
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 106
+
+# Offense count: 3
+Metrics/CyclomaticComplexity:
+  Max: 8
+
+# Offense count: 86
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 174
+
+# Offense count: 6
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 26
+
+# Offense count: 2
+Metrics/PerceivedComplexity:
+  Max: 8
+
+# Offense count: 2
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/rubocop/cop/i18n/gettext.rb'
+    - 'lib/rubocop/cop/i18n/gettext/decorate_function_message.rb'
+
+# Offense count: 1
+# Configuration parameters: ExpectMatchingDefinition, 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
+Style/FileName:
+  Exclude:
+    - 'lib/rubocop-i18n.rb'
+
+# Offense count: 7
+# Configuration parameters: SupportedStyles.
+# SupportedStyles: annotated, template
+Style/FormatStringToken:
+  EnforcedStyle: template
+
+# Offense count: 4
+# Configuration parameters: MinBodyLength.
+Style/GuardClause:
+  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_interpolation.rb'
+    - 'lib/rubocop/cop/i18n/gettext/decorate_string_formatting_using_percent.rb'

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## master (unreleased)
 
+ * 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)
+ * RuboCop lint fixes
+
 ### 1.1.0
 
  * Added support for DecorateStringFormattingUsingPercent

data/README.md

@@ -26,7 +26,7 @@ require:
  - rubocop-i18n
 ...
 GetText/DecorateString:
-  Enabled: false
+  Enabled: true
 GetText/DecorateFunctionMessage:
   Enabled: true
 GetText/DecorateStringFormattingUsingInterpolation
@@ -37,6 +37,36 @@ GetText/DecorateStringFormattingUsingPercent
 
 ## Cops
 
+### GetText/DecorateString
+
+This cop is looks for strings that appear to be sentences but are not decorated. 
+Sentences are determined by the STRING_REGEXP.
+
+##### Error message thrown
+
+```
+decorator is missing around sentence
+```
+
+##### Bad
+
+``` ruby
+"Result is bad."
+```
+
+##### Good
+
+``` ruby
+_("Result is good.")
+```
+
+##### Ignored
+``` ruby
+"string"
+"A string with out a punctuation at the end"
+"a string that doesn't start with a capital letter."
+```
+
 ### 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.
@@ -207,8 +237,9 @@ raise(_("Warning is %{value}") % { value: 'bad' })
 
 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/DecorateFunctionMessage
-raise(_("We don't want this translated #{crazy}")  # rubocop:disable GetText/DecorateStringFormattingUsingInterpolation)
+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)
 ```
 

data/Rakefile

@@ -1,6 +1,12 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :test
+
+task test: %i[rubocop spec]
+
+task :rubocop do
+  sh 'rubocop -P'
+end

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "rubocop/i18n"
+require 'bundler/setup'
+require 'rubocop/i18n'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +10,5 @@ require "rubocop/i18n"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

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

@@ -4,6 +4,41 @@ module RuboCop
   module Cop
     module I18n
       module GetText
+        def self.supported_methods
+          %w[raise fail]
+        end
+
+        # Supports decorators from
+        # * mutoh/gettext https://github.com/mutoh/gettext/blob/master/lib/gettext.rb
+        # * grosser/fast_gettext https://github.com/grosser/fast_gettext/blob/master/lib/fast_gettext/translation.rb
+        def self.supported_decorators
+          %w[
+            _
+            n_
+            np_
+            ns_
+            N_
+            Nn_
+            D_
+            Dn_
+            Ds_
+            Dns_
+            d_
+            dn_
+            ds_
+            dns_
+            p_
+            s_
+          ]
+        end
+
+        def self.supported_method?(method_name)
+          supported_methods.include?(method_name)
+        end
+
+        def self.supported_decorator?(decorator_name)
+          supported_decorators.include?(decorator_name)
+        end
       end
     end
   end

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

@@ -3,19 +3,16 @@ module RuboCop
     module I18n
       module GetText
         class DecorateFunctionMessage < Cop
-          SUPPORTED_METHODS = ['raise', 'fail']
-          SUPPORTED_DECORATORS = ['_', 'n_', 'N_']
-
           def on_send(node)
             method_name = node.loc.selector.source
-            return if !supported_method_name?(method_name)
+            return unless GetText.supported_method?(method_name)
             _, method_name, *arg_nodes = *node
             if !arg_nodes.empty? && !already_decorated?(node) && (contains_string?(arg_nodes) || string_constant?(arg_nodes))
-              if string_constant?(arg_nodes)
-                message_section = arg_nodes[1]
-              else
-                message_section = arg_nodes[0]
-              end
+              message_section = if string_constant?(arg_nodes)
+                                  arg_nodes[1]
+                                else
+                                  arg_nodes[0]
+                                end
 
               detect_and_report(node, message_section, method_name)
             end
@@ -23,15 +20,11 @@ module RuboCop
 
           private
 
-          def supported_method_name?(method_name)
-            SUPPORTED_METHODS.include?(method_name)
-          end
-
           def already_decorated?(node, parent = nil)
             parent ||= node
 
             if node.respond_to?(:loc) && node.loc.respond_to?(:selector)
-              return true if SUPPORTED_DECORATORS.include?(node.loc.selector.source)
+              return true if GetText.supported_decorator?(node.loc.selector.source)
             end
 
             return false unless node.respond_to?(:children)
@@ -44,10 +37,10 @@ module RuboCop
           end
 
           def contains_string?(nodes)
-            nodes[0].inspect.include?(":str") || nodes[0].inspect.include?(":dstr")
+            nodes[0].inspect.include?(':str') || nodes[0].inspect.include?(':dstr')
           end
 
-          def detect_and_report(node, message_section, method_name)
+          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, "
@@ -68,7 +61,7 @@ module RuboCop
             errors.push :multiline if message_section.multiline?
             errors.push :concatenation if concatenation_offense?(message_section)
             errors.push :interpolation if interpolation_offense?(message_section)
-            errors.push :no_decoration if !already_decorated?(message_section)
+            errors.push :no_decoration unless already_decorated?(message_section)
 
             # only display no_decoration, if that is the only problem.
             if errors.size > 1 && errors.include?(:no_decoration)
@@ -92,7 +85,7 @@ module RuboCop
           def interpolation_offense?(node, parent = nil)
             parent ||= node
 
-            return true if node.class == RuboCop::AST::Node  && node.dstr_type?
+            return true if node.class == RuboCop::AST::Node && node.dstr_type?
 
             return false unless node.respond_to?(:children)
 
@@ -103,52 +96,51 @@ module RuboCop
             if node.str_type?
               single_string_correct(node)
             elsif interpolation_offense?(node)
-#              interpolation_correct(node)
+              #              interpolation_correct(node)
             end
           end
 
           def single_string_correct(node)
-            ->(corrector) {
-              corrector.insert_before(node.source_range , "_(")
-            corrector.insert_after(node.source_range , ")") }
+            lambda { |corrector|
+              corrector.insert_before(node.source_range, '_(')
+              corrector.insert_after(node.source_range, ')')
+            }
           end
 
           def interpolation_correct(node)
-            interpolated_values_string = ""
+            interpolated_values_string = ''
             count = 0
-            ->(corrector) {
+            lambda { |corrector|
               node.children.each do |child|
                 # dstrs are split into "str" segments and other segments.
                 # The "other" segments are the interpolated values.
-                if child.type == :begin
-                  value = child.children[0]
-                  hash_key = "value"
-                  if value.type == :lvar
-                    # Use the variable's name as the format key
-                    hash_key = value.loc.name.source
-                  else
-                    # These are placeholders that will manually need to be given
-                    # a descriptive name
-                    hash_key << "#{count}"
-                    count += 1
-                  end
-                  if interpolated_values_string.empty?
-                    interpolated_values_string << "{ "
-                  end
-                  interpolated_values_string << "#{hash_key}: #{value.loc.expression.source}, "
-
-                  # Replace interpolation with format string
-                  corrector.replace(child.loc.expression, "%{#{hash_key}}")
+                next unless child.type == :begin
+                value = child.children[0]
+                hash_key = 'value'
+                if value.type == :lvar
+                  # Use the variable's name as the format key
+                  hash_key = value.loc.name.source
+                else
+                  # These are placeholders that will manually need to be given
+                  # a descriptive name
+                  hash_key << count.to_s
+                  count += 1
+                end
+                if interpolated_values_string.empty?
+                  interpolated_values_string << '{ '
                 end
+                interpolated_values_string << "#{hash_key}: #{value.loc.expression.source}, "
+
+                # Replace interpolation with format string
+                corrector.replace(child.loc.expression, "%{#{hash_key}}")
               end
-              if !interpolated_values_string.empty?
-                interpolated_values_string << "}"
+              unless interpolated_values_string.empty?
+                interpolated_values_string << '}'
               end
               corrector.insert_before(node.source_range, '_(')
               corrector.insert_after(node.source_range, ") % #{interpolated_values_string}")
             }
           end
-
         end
       end
     end

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

@@ -4,35 +4,70 @@ module RuboCop
   module Cop
     module I18n
       module GetText
-        # This cop checks for butt or ass,
-        # which is redundant.
+        # This cop is looks for strings that appear to be sentences but are not decorated.
+        # Sentences are determined by the STRING_REGEXP. (Upper case character, at least one space,
+        # and sentence punctuation at the end)
         #
         # @example
         #
         #   # bad
         #
-        #   "result is #{something.to_s}"
+        #   "Result is bad."
         #
         # @example
         #
         #   # good
         #
-        #   "result is #{something}"
+        #   _("Result is good.")
         class DecorateString < Cop
+          STRING_REGEXP = /^\s*[[:upper:]][[:alpha:]]*[[:blank:]]+.*[.!?]$/
+
+          def on_dstr(node)
+            check_for_parent_decorator(node) if dstr_contains_sentence?(node)
+          end
+
           def on_str(node)
-            str = node.children[0]
-            #ignore strings with no whitespace - are typically keywords or interpolation statements and cover the above commented-out statements
-            if str !~ /^\S*$/
-              add_offense(node, :expression, "decorator is missing around sentence") if node.loc.respond_to?(:begin)
+            return unless sentence?(node)
+
+            parent = node.parent
+            if parent.respond_to?(:type)
+              return if parent.type == :regexp || parent.type == :dstr
             end
+
+            check_for_parent_decorator(node)
           end
 
           private
 
-          def message(node)
-            node.receiver ? MSG_DEFAULT : MSG_SELF
+          def sentence?(node)
+            child = node.children[0]
+            if child.is_a?(String)
+              if child.valid_encoding?
+                child.encode(Encoding::UTF_8).chomp =~ STRING_REGEXP
+              else
+                false
+              end
+            elsif child.respond_to?(:type) && child.type == :str
+              sentence?(child)
+            else
+              false
+            end
+          end
+
+          def dstr_contains_sentence?(node)
+            node.children.any? { |child| sentence?(child) }
           end
 
+          def check_for_parent_decorator(node)
+            parent = node.parent
+            if parent.respond_to?(:type) && parent.type == :send
+              method_name = parent.loc.selector.source
+              return if GetText.supported_decorator?(method_name)
+            elsif parent.respond_to?(:method_name) && parent.method_name == :[]
+              return
+            end
+            add_offense(node, :expression, 'decorator is missing around sentence')
+          end
         end
       end
     end

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

@@ -3,8 +3,9 @@ module RuboCop
     module I18n
       module GetText
         # 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. This cop checks the
-        # decorators listed in SUPPORTED_DECORATORS
+        # the '#{}' interpolation string as this makes it hard to translate the strings.
+        #
+        # Check GetText.supported_decorators for a list of decorators that can be used.
         #
         # @example
         #
@@ -20,12 +21,9 @@ module RuboCop
         #   _("result is %{detail}" % {detail: message})
         #
         class DecorateStringFormattingUsingInterpolation < Cop
-
-          SUPPORTED_DECORATORS = ['_', 'n_', 'N_']
-
           def on_send(node)
             decorator_name = node.loc.selector.source
-            return if !supported_decorator_name?(decorator_name)
+            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]
@@ -35,10 +33,6 @@ module RuboCop
 
           private
 
-          def supported_decorator_name?(decorator_name)
-            SUPPORTED_DECORATORS.include?(decorator_name)
-          end
-
           def string_contains_interpolation_format?(str)
             str.match(/\#{[^}]+}/)
           end
@@ -49,7 +43,7 @@ module RuboCop
             end
 
             if node.respond_to?(:type)
-              if node.type == :str or node.type == :dstr
+              if node.type == :str || node.type == :dstr
                 return string_contains_interpolation_format?(node.source)
               end
             end
@@ -57,9 +51,8 @@ module RuboCop
             if node.respond_to?(:children)
               return node.children.any? { |child| contains_string_formatting_with_interpolation?(child) }
             end
-            return false
+            false
           end
-
         end
       end
     end

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

@@ -4,7 +4,7 @@ module RuboCop
       module GetText
         # When using a decorated string to support I18N, any strings inside the decoration should not contain sprintf
         # style formatting as this makes it hard to translate the string. This cop checks the decorators listed in
-        # SUPPORTED_DECORATORS and checks for each of the formats in SUPPORTED_FORMATS. NOTE: this cop does not
+        # GetText.supported_decorators and checks for each of the formats in SUPPORTED_FORMATS. NOTE: this cop does not
         # check for all possible sprintf formats.
         #
         # @example
@@ -22,13 +22,11 @@ module RuboCop
         #   _("result is %{detail}" % {detail: message})
         #
         class DecorateStringFormattingUsingPercent < Cop
-
-          SUPPORTED_DECORATORS = ['_', 'n_', 'N_']
-          SUPPORTED_FORMATS = %w[b B d i o u x X e E f g G a A c p s]
+          SUPPORTED_FORMATS = %w[b B d i o u x X e E f g G a A c p s].freeze
 
           def on_send(node)
             decorator_name = node.loc.selector.source
-            return if !supported_decorator_name?(decorator_name)
+            return unless GetText.supported_decorator?(decorator_name)
             _, method_name, *arg_nodes = *node
             if !arg_nodes.empty? && contains_string_with_percent_format?(arg_nodes)
               message_section = arg_nodes[0]
@@ -38,10 +36,6 @@ module RuboCop
 
           private
 
-          def supported_decorator_name?(decorator_name)
-            SUPPORTED_DECORATORS.include?(decorator_name)
-          end
-
           def string_contains_percent_format?(str)
             SUPPORTED_FORMATS.any? { |format| str.match(/%([-+])?[0-9]*(\.[0-9]*)?#{format}/) }
           end
@@ -52,7 +46,7 @@ module RuboCop
             end
 
             if node.respond_to?(:type)
-              if node.type == :str or node.type == :dstr
+              if node.type == :str || node.type == :dstr
                 return string_contains_percent_format?(node.source)
               end
             end
@@ -62,7 +56,6 @@ module RuboCop
             end
             false
           end
-
         end
       end
     end

data/rubocop-i18n.gemspec

@@ -1,29 +1,32 @@
 # coding: utf-8
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+rubocop_version = '~> 0.49.0'
 
 Gem::Specification.new do |spec|
-  spec.name          = "rubocop-i18n"
-  spec.version       = '1.1.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.name          = 'rubocop-i18n'
+  spec.version       = '1.2.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       = %q{RuboCop rules for i18n}
-  spec.description   = %q{RuboCop rules for detecting and autocorrecting undecorated strings for i18n}
-  spec.homepage      = "https://github.com/puppetlabs/rubocop-i18n"
+  spec.summary       = 'RuboCop rules for i18n'
+  spec.description   = 'RuboCop rules for detecting and autocorrecting undecorated strings for i18n'
+  spec.homepage      = 'https://github.com/puppetlabs/rubocop-i18n'
   spec.license       = 'Apache-2'
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.14"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "rb-readline"
-  spec.add_development_dependency "pry"
-  spec.add_runtime_dependency "rubocop", "~> 0.49"
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rb-readline'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rubocop', rubocop_version
+  spec.add_runtime_dependency 'rubocop', rubocop_version
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-i18n
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Puppet
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-13 00:00:00.000000000 Z
+date: 2017-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -89,14 +89,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.49'
+        version: 0.49.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.49.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.49.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.49'
+        version: 0.49.0
 description: RuboCop rules for detecting and autocorrecting undecorated strings for
   i18n
 email:
@@ -109,6 +123,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md