rubocop-i18n 1.3.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 05f242d66df11b40d7d4e4e33bb98ae8be347062
-  data.tar.gz: b9e07ef3ce86a5c34f409620a2ce3eae4917341b
+  metadata.gz: c8ec74372e48d2888a1e145600899f36250f1d41
+  data.tar.gz: c45019b849416c7d3e67d5a0f0677f4cff193fef
 SHA512:
-  metadata.gz: c4afff3c8a1d356f37de79fd59c34a2ed4ad8e977692d888c265791ca180779c8145012b70c8b542fc251c68f1325a7370c729d9180b31c233f40fea623fcd82
-  data.tar.gz: da4a2892bb9a3450475afc776d435eae64f0be2766b3b5f061d824adc39dd9512e458555b018992f6222c4452b9445b82c52969985bb6447999e26ed8f1c555f
+  metadata.gz: f229adc2ced75db0cc05dae0bb4d0cb3d1d6bf28f6d832ee9897d3a6d6a383a4be15bffb40b4805fb8ef28334197d0017f0341fa58e986d2ee2ae1906588e303
+  data.tar.gz: 5720548d777aaa871358d9f8fcc3107e54574e7fbcbf5032f29d7442a0055624f7bc3a24c2d6ca0a6f4c9575ec5480f07700ae2bfd1cc6924852cbb705206f7a

data/.rubocop.yml

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

data/CHANGELOG.md

@@ -1,6 +1,14 @@
 # Change Log
 
-## master (unreleased)
+### master (Unreleased)
+
+* None
+
+### 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/README.md

@@ -2,6 +2,11 @@
 
 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,14 +30,28 @@ In your `rubocop.yml`:
 require:
  - rubocop-i18n
 ...
-GetText/DecorateString:
+# You *must* choose GetText or Rails-i18n style checking
+# If you want GetText-style checking
+GetText:
   Enabled: true
-GetText/DecorateFunctionMessage:
-  Enabled: true
-GetText/DecorateStringFormattingUsingInterpolation
-  Enabled: true
-GetText/DecorateStringFormattingUsingPercent
+RailsI18n:
+  Enabled: false
+# If you want rails-i18n-style checking
+RailsI18n:
   Enabled: true
+GetText:
+  Enabled: false
+# If you want custom control of all the cops
+GetText/DecorateString:
+  Enabled: false
+GetText/DecorateFunctionMessage:
+  Enabled: false
+GetText/DecorateStringFormattingUsingInterpolation:
+  Enabled: false
+GetText/DecorateStringFormattingUsingPercent:
+  Enabled: false
+RailsI18n/DecorateString:
+  Enabled: false
 ```
 
 ## Cops
@@ -233,11 +252,36 @@ raise(_("Warning is %s") % ['bad'])
 raise(_("Warning is %{value}") % { value: 'bad' })
 ```
 
+### 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' })
+```
+
 ## 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 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)

data/lib/rubocop/cop/i18n.rb

@@ -4,3 +4,6 @@ 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'

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)

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

@@ -0,0 +1,12 @@
+# 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
+      end
+    end
+  end
+end

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

@@ -0,0 +1,111 @@
+# 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 STRING_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")
+        #
+        class DecorateString < Cop
+          STRING_REGEXP = /^\s*[[:upper:]][[: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 =~ STRING_REGEXP
+              else
+                false
+              end
+            elsif child.respond_to?(:type) && child.str_type?
+              sentence?(child)
+            else
+              false
+            end
+          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_name == :new
+
+            false
+          end
+
+          def parent_is_indexer?(parent)
+            parent.respond_to?(:method_name) && parent.method_name == :[]
+          end
+
+          def parent_is_translator?(parent)
+            if parent.respond_to?(:type) && parent.send_type?
+              method_name = parent.loc.selector.source
+              if 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
+
+          def supported_decorator?(decorator_name)
+            SUPPORTED_DECORATORS.include?(decorator_name)
+          end
+        end
+      end
+    end
+  end
+end

data/rubocop-i18n.gemspec

@@ -4,12 +4,12 @@ rubocop_version = '~> 0.51'
 
 Gem::Specification.new do |spec|
   spec.name          = 'rubocop-i18n'
-  spec.version       = '1.3.1'
+  spec.version       = '2.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'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-i18n
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Puppet
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-21 00:00:00.000000000 Z
+date: 2018-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -112,7 +112,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.51'
 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
@@ -141,6 +141,8 @@ 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/cop/i18n/rails_i18n.rb
+- lib/rubocop/cop/i18n/rails_i18n/decorate_string.rb
 - lib/rubocop/rspec/cop_helper.rb
 - rubocop-i18n.gemspec
 homepage: https://github.com/puppetlabs/rubocop-i18n
@@ -163,7 +165,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14.1
+rubygems_version: 2.6.6
 signing_key: 
 specification_version: 4
 summary: RuboCop rules for i18n