rubocop-i18n 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e2792a2344ae871fa62e564786c03d892bd5072d
-  data.tar.gz: 1354b5ac2e3a9606deb1b9c594edf8a23327db38
+  metadata.gz: 3e4f819b3b4f5bc73ec0b02ee1bd567ab2d3a40e
+  data.tar.gz: 4d0ec4a7cc1e6046d32421c9253c97a117e74b57
 SHA512:
-  metadata.gz: 76633906bc7a3ad0612fff96eab7a80eb21bf26f58b95d6a31c8e24ca2958df6c95f079000c5002785ad184711e207b22b2059383d1791665728a3a73330697e
-  data.tar.gz: 4f58a7770df70e74ea4d5150140ee35aaef1b31aacd65b776de7c6ceb6f638715756d71bf43dd5a4b870c724496e01fda0e3f95bdee02da3f7755e98935997bc
+  metadata.gz: 2b7502eadea26d2982e80cf6c9e49926656cd1c572f12ec1fe8213279ffbf603d222841f522620d77f33a847a1acf365fb661eb59315e0ab70e377d09e2fccde
+  data.tar.gz: 9fca0a7581cf5cd57ca7741826d558463bef5e641aa1c96053ee2e3d0b6facaf4da6bb77a21b6bab9b6ff18b77042689a61f9d7ca18848c2b2038d0864c1cc12

data/.gitignore

@@ -9,6 +9,7 @@
 /test/tmp/
 /test/version_tmp/
 /tmp/
+/.idea/
 
 # Used by dotenv library to load environment variables.
 # .env

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Change Log
+
+## master (unreleased)
+
+### 1.1.0
+
+ * Added support for DecorateStringFormattingUsingPercent
+ * Added support for DecorateStringFormattingUsingInterpolation
+
+### 1.0.0
+
+ * Improvements to DecorateFunctionMessage
+
+### 0.0.1
+
+ * Initial import of rubocop rules from https://github.com/tphoney/puppetlabs-mysql/tree/poc_i18nTesting/rubocop by [@tphoney]

data/README.md

@@ -29,6 +29,10 @@ GetText/DecorateString:
   Enabled: false
 GetText/DecorateFunctionMessage:
   Enabled: true
+GetText/DecorateStringFormattingUsingInterpolation
+  Enabled: true
+GetText/DecorateStringFormattingUsingPercent
+  Enabled: true
 ```
 
 ## Cops
@@ -149,16 +153,69 @@ 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
+
+This cop looks for decorated gettext methods _() 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 _() function
+
+##### Error message thrown
+
+```
+'_' function, message string should not contain #{} formatting
+```
+
+##### Bad
+
+``` ruby
+puts _("a message with a #{'interpolation'}")
+```
+
+##### Good
+
+``` ruby
+puts _("a message that is %{type}") % { type: 'translatable' }
+```
+
+### GetText/DecorateStringFormattingUsingPercent
+
+This cop looks for decorated gettext methods _() and checks that all strings contained
+within do not use sprintf formatting '%s' etc
+
+##### Error message thrown
+
+```
+'_' function, message string should not contain sprintf style formatting (ie %s)
+```
+
+##### Bad
+
+``` ruby
+raise(_("Warning is %s") % ['bad'])
+```
+
+##### Good
+
+``` ruby
+raise(_("Warning is %{value}") % { value: 'bad' })
+```
+
 ## 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/DecorateFunctionMessage 
+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)
 ```
 
 ## Known Issues
 
 Rubocop currently does not detect Heredoc style messages in functions correctly, which in turn prevents this plugin from detecting them correctly.
+Not all sprintf formatting strings are detected.
 
 ## Development
 

data/lib/rubocop/cop/i18n.rb

@@ -2,3 +2,5 @@ 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'

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

@@ -0,0 +1,67 @@
+module RuboCop
+  module Cop
+    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
+        #
+        # @example
+        #
+        #   # bad
+        #
+        #   _("result is #{this_is_the_result}")
+        #   n_("a string" + "a string with a #{float_value}")
+        #
+        # @example
+        #
+        #   # good
+        #
+        #   _("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)
+            _, 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, :expression, "'#{method_name}' function, message string should not contain \#{} formatting")
+            end
+          end
+
+          private
+
+          def supported_decorator_name?(decorator_name)
+            SUPPORTED_DECORATORS.include?(decorator_name)
+          end
+
+          def string_contains_interpolation_format?(str)
+            str.match(/\#{[^}]+}/)
+          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.type == :str or node.type == :dstr
+                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 false
+          end
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,70 @@
+module RuboCop
+  module Cop
+    module I18n
+      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
+        # check for all possible sprintf formats.
+        #
+        # @example
+        #
+        #   # bad
+        #
+        #   _("result is %s" % ["value"])
+        #   n_("a string" + "a string with a %-3.1f" % [size])
+        #   N_("a string" + "a string with a %04d" % [size])
+        #
+        # @example
+        #
+        #   # good
+        #
+        #   _("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]
+
+          def on_send(node)
+            decorator_name = node.loc.selector.source
+            return if !supported_decorator_name?(decorator_name)
+            _, method_name, *arg_nodes = *node
+            if !arg_nodes.empty? && contains_string_with_percent_format?(arg_nodes)
+              message_section = arg_nodes[0]
+              add_offense(message_section, :expression, "'#{method_name}' function, message string should not contain sprintf style formatting (ie %s)")
+            end
+          end
+
+          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
+
+          def contains_string_with_percent_format?(node)
+            if node.is_a?(Array)
+              return node.any? { |n| contains_string_with_percent_format?(n) }
+            end
+
+            if node.respond_to?(:type)
+              if node.type == :str or node.type == :dstr
+                return string_contains_percent_format?(node.source)
+              end
+            end
+
+            if node.respond_to?(:children)
+              return node.children.any? { |child| contains_string_with_percent_format?(child) }
+            end
+            false
+          end
+
+        end
+      end
+    end
+  end
+end

data/rubocop-i18n.gemspec

@@ -4,9 +4,9 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "rubocop-i18n"
-  spec.version       = '1.0.0'
-  spec.authors       = ["Brandon High", "TP Honey", "Helen Campbell"]
-  spec.email         = ["brandon.high@puppet.com", "tp@puppet.com", "helen@puppet.com"]
+  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.summary       = %q{RuboCop rules for i18n}
   spec.description   = %q{RuboCop rules for detecting and autocorrecting undecorated strings for i18n}

metadata

@@ -1,16 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-i18n
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
+- Puppet
 - Brandon High
 - TP Honey
 - Helen Campbell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-06 00:00:00.000000000 Z
+date: 2017-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -99,6 +100,7 @@ dependencies:
 description: RuboCop rules for detecting and autocorrecting undecorated strings for
   i18n
 email:
+- team-modules@puppet.com
 - brandon.high@puppet.com
 - tp@puppet.com
 - helen@puppet.com
@@ -108,6 +110,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE
@@ -120,6 +123,8 @@ files:
 - lib/rubocop/cop/i18n/gettext.rb
 - 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
 - lib/rubocop/rspec/cop_helper.rb
 - rubocop-i18n.gemspec
 homepage: https://github.com/puppetlabs/rubocop-i18n