(CLOUD-1661) Fixing rubocop error andaddingi18ngem (#120)

Author: sheenaajay

.fixtures.yml

@@ -3,5 +3,6 @@ fixtures:
     stdlib: 'puppetlabs-stdlib'
     epel: 'stahnma-epel'
     apt: 'puppetlabs-apt'
+    translate: 'puppetlabs-translate'
   symlinks:
     docker: "#{source_dir}"

.rubocop.yml

@@ -0,0 +1,137 @@
+---
+require:
+ - rubocop-rspec
+ - rubocop-i18n
+AllCops:
+  TargetRubyVersion: '2.1'
+  Include:
+  - "./**/*.rb"
+  Exclude:
+  - bin/*
+  - ".vendor/**/*"
+  - Gemfile
+  - Rakefile
+  - pkg/**/*
+  - spec/fixtures/**/*
+  - vendor/**/*
+Metrics/LineLength:
+  Description: People have wide screens, use them.
+  Max: 200
+  Enabled: false
+RSpec/BeforeAfterAll:
+  Description: Beware of using after(:all) as it may cause state to leak between tests.
+    A necessary evil in acceptance testing.
+  Exclude:
+  - spec/acceptance/**/*.rb
+RSpec/HookArgument:
+  Description: Prefer explicit :each argument, matching existing module's style
+  EnforcedStyle: each
+Style/BlockDelimiters:
+  Description: Prefer braces for chaining. Mostly an aesthetical choice. Better to
+    be consistent then.
+  EnforcedStyle: braces_for_chaining
+Style/ClassAndModuleChildren:
+  Description: Compact style reduces the required amount of indentation.
+  EnforcedStyle: compact
+Style/EmptyElse:
+  Description: Enforce against empty else clauses, but allow `nil` for clarity.
+  EnforcedStyle: empty
+Style/FormatString:
+  Description: Following the main puppet project's style, prefer the % format format.
+  EnforcedStyle: percent
+  Exclude:
+  - lib/puppet/provider/docker_volume/ruby.rb
+  - lib/puppet/provider/docker_network/ruby.rb
+  - lib/puppet/parser/functions/docker_secrets_flags.rb
+  - lib/puppet/parser/functions/docker_run_flags.rb
+  - lib/puppet/type/docker_network.rb
+  - lib/puppet/type/docker_volume.rb
+Style/FormatStringToken:
+  Description: Following the main puppet project's style, prefer the simpler template
+    tokens over annotated ones.
+  EnforcedStyle: template
+Style/Lambda:
+  Description: Prefer the keyword for easier discoverability.
+  EnforcedStyle: literal
+  Enabled: true
+  Exclude:
+  - lib/puppet/provider/docker_volume/ruby.rb
+  - lib/puppet/parser/functions/docker_secrets_flags.rb
+  - lib/puppet/parser/functions/docker_run_flags.rb
+  - lib/puppet/provider/docker_network/ruby.rb
+Style/RegexpLiteral:
+  Description: Community preference. See https://github.com/voxpupuli/modulesync_config/issues/168
+  EnforcedStyle: percent_r
+Style/TernaryParentheses:
+  Description: Checks for use of parentheses around ternary conditions. Enforce parentheses
+    on complex expressions for better readability, but seriously consider breaking
+    it up.
+  EnforcedStyle: require_parentheses_when_complex
+Style/TrailingCommaInArguments:
+  Description: Prefer always trailing comma on multiline argument lists. This makes
+    diffs, and re-ordering nicer.
+  EnforcedStyleForMultiline: comma
+Style/TrailingCommaInLiteral:
+  Description: Prefer always trailing comma on multiline literals. This makes diffs,
+    and re-ordering nicer.
+  EnforcedStyleForMultiline: comma
+Style/SymbolArray:
+  Description: Using percent style obscures symbolic intent of array's contents.
+  EnforcedStyle: brackets
+Style/CollectionMethods:
+  Enabled: true
+Style/MethodCalledOnDoEndBlock:
+  Enabled: true
+Style/StringMethods:
+  Enabled: true
+Metrics/AbcSize:
+  Enabled: false
+Metrics/BlockLength:
+  Enabled: false
+Metrics/LineLength:
+  Enabled: false
+Metrics/ClassLength:
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Metrics/ModuleLength:
+  Enabled: false
+Metrics/ParameterLists:
+  Enabled: false
+Metrics/PerceivedComplexity:
+  Enabled: false
+RSpec/DescribeClass:
+  Enabled: false
+RSpec/MessageExpectation:
+  Enabled: false
+Style/AsciiComments:
+  Enabled: false
+Style/IfUnlessModifier:
+  Enabled: false
+Style/SymbolProc:
+  Enabled: false
+Style/HashSyntax:
+  UseHashRocketsWithSymbolValues: true
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+  SupportedStyles:
+    - single_quotes
+    - double_quotes
+  Exclude:
+  - lib/puppet/provider/docker_compose/ruby.rb
+GetText/DecorateString:
+  Enabled: true
+  Exclude:
+  - lib/puppet/type/docker_compose.rb
+GetText/DecorateFunctionMessage:
+  Enabled: true
+  Exclude:
+  - lib/puppet/type/docker_network.rb
+  - lib/puppet/type/docker_volume.rb
+  - lib/puppet/provider/docker_compose/ruby.rb
+GetText/DecorateStringFormattingUsingInterpolation:
+  Enabled: true 
+GetText/DecorateStringFormattingUsingPercent:
+  Enabled: true 

Gemfile

@@ -9,8 +9,8 @@ group :test do
   else
     gem "puppet"
   end
-  gem "puppet-lint"
-  gem "puppet-lint-unquoted_string-check"
+  gem "puppet-lint", "2.3.3"
+  gem "puppet-lint-unquoted_string-check", "0.3.0"
   gem "rspec-puppet"
   gem "puppet-syntax"
   gem "puppetlabs_spec_helper"
@@ -22,7 +22,11 @@ group :test do
   gem 'parallel_tests' # requires at least Ruby 1.9.3
   gem "json_pure", "<= 2.0.1" # 2.0.2 requires Ruby 2+
   gem 'rspec_junit_formatter', '~> 0.2.3'
-
+  gem "puppet-lint-i18n"
+  gem "puppet_pot_generator"
+  gem 'rubocop-i18n'
+  gem 'gettext-setup'
+  gem 'rubocop-rspec'
 end
 
 group :system_tests do

Rakefile

@@ -2,6 +2,7 @@ require 'rubygems'
 require 'bundler/setup'
 
 require 'puppetlabs_spec_helper/rake_tasks'
+require 'puppet_pot_generator/rake_tasks'
 
 # These gems aren't always present, for instance
 # on Travis with --without development

lib/facter/docker.rb

@@ -23,7 +23,8 @@ def interfaces
   setcode do
     if Facter::Util::Resolution.which('docker')
       value = Facter::Core::Execution.execute(
-        "docker version --format '{{json .}}'")
+        "docker version --format '{{json .}}'",
+      )
       val = JSON.parse(value)
     end
     val
@@ -34,22 +35,23 @@ def interfaces
   setcode do
     if Facter::Util::Resolution.which('docker')
       docker_json_str = Facter::Util::Resolution.exec(
-        "docker info --format '{{json .}}'")
+        "docker info --format '{{json .}}'",
+      )
       docker = JSON.parse(docker_json_str)
-      docker['network'] = Hash.new
+      docker['network'] = {}
 
-      docker['network']['managed_interfaces'] = Hash.new
+      docker['network']['managed_interfaces'] = {}
       network_list = Facter::Util::Resolution.exec('docker network ls | tail -n +2')
-      docker_network_names = Array.new
-      network_list.each_line {|line| docker_network_names.push line.split[1] }
-      docker_network_ids = Array.new
-      network_list.each_line {|line| docker_network_ids.push line.split[0] }
+      docker_network_names = []
+      network_list.each_line { |line| docker_network_names.push line.split[1] }
+      docker_network_ids = []
+      network_list.each_line { |line| docker_network_ids.push line.split[0] }
       docker_network_names.each do |network|
         inspect = JSON.parse(Facter::Util::Resolution.exec("docker network inspect #{network}"))
         docker['network'][network] = inspect[0]
         network_id = docker['network'][network]['Id'][0..11]
         interfaces.each do |iface|
-          docker['network']['managed_interfaces'][iface] = network if iface =~ /#{network_id}/
+          docker['network']['managed_interfaces'][iface] = network if iface =~ %r{#{network_id}}
         end
       end
       docker

lib/puppet/parser/functions/docker_exec_flags.rb

@@ -1,5 +1,7 @@
 require 'shellwords'
-
+#
+# docker_exec_flags.rb
+#
 module Puppet::Parser::Functions
   # Transforms a hash into a string of docker exec flags
   newfunction(:docker_exec_flags, :type => :rvalue) do |args|
@@ -18,6 +20,6 @@ module Puppet::Parser::Functions
       flags << '--tty=true'
     end
 
-    flags.flatten.join(" ")
+    flags.flatten.join(' ')
   end
 end

lib/puppet/parser/functions/docker_run_flags.rb

@@ -1,5 +1,7 @@
 require 'shellwords'
-
+#
+# docker_run_flags.rb
+#
 module Puppet::Parser::Functions
   # Transforms a hash into a string of docker flags
   newfunction(:docker_run_flags, :type => :rvalue) do |args|
@@ -65,7 +67,7 @@ module Puppet::Parser::Functions
       ['-p %s',             'ports'],
       ['-l %s',             'labels'],
       ['--add-host %s',     'hostentries'],
-      ['-v %s',             'volumes']
+      ['-v %s',             'volumes'],
     ].each do |(format, key)|
       values    = opts[key]
       new_flags = multi_flags.call(values, format)
@@ -76,6 +78,6 @@ module Puppet::Parser::Functions
       flags << param
     end
 
-    flags.flatten.join(" ")
+    flags.flatten.join(' ')
   end
 end

lib/puppet/parser/functions/docker_secrets_flags.rb

@@ -1,5 +1,7 @@
 require 'shellwords'
-
+#
+# docker_secrets_flags.rb
+#
 module Puppet::Parser::Functions
   # Transforms a hash into a string of docker swarm init flags
   newfunction(:docker_secrets_flags, :type => :rvalue) do |args|
@@ -23,13 +25,13 @@ module Puppet::Parser::Functions
       filtered.map { |val| sprintf(format + " \\\n", val) }
     }
     [
-      ['-l %s', 'label']
+      ['-l %s', 'label'],
     ].each do |(format, key)|
       values    = opts[key]
       new_flags = multi_flags.call(values, format)
       flags.concat(new_flags)
     end
 
-    flags.flatten.join(" ")
+    flags.flatten.join(' ')
   end
 end

lib/puppet/parser/functions/docker_service_flags.rb

@@ -1,5 +1,7 @@
 require 'shellwords'
-
+#
+# docker_service_flags.rb
+#
 module Puppet::Parser::Functions
   # Transforms a hash into a string of docker swarm init flags
   newfunction(:docker_service_flags, :type => :rvalue) do |args|
@@ -64,6 +66,6 @@ module Puppet::Parser::Functions
       flags << "--registry-mirror='#{opts['registry_mirror']}'"
     end
 
-    flags.flatten.join(" ")
+    flags.flatten.join(' ')
   end
 end

lib/puppet/parser/functions/docker_stack_flags.rb

@@ -1,5 +1,7 @@
 require 'shellwords'
-
+#
+# docker_stack_flags.rb
+#
 module Puppet::Parser::Functions
   # Transforms a hash into a string of docker swarm init flags
   newfunction(:docker_stack_flags, :type => :rvalue) do |args|
@@ -8,20 +10,20 @@ module Puppet::Parser::Functions
 
     if opts['bundle_file'].to_s != 'undef'
       flags << "--bundle-file '#{opts['bundle_file']}'"
-    end	
+    end
 
     if opts['compose_file'].to_s != 'undef'
       flags << "--compose-file '#{opts['compose_file']}'"
-    end      
+    end
 
     if opts['prune'].to_s != 'undef'
       flags << "--prune '#{opts['prune']}'"
-    end  
-    
+    end
+
     if opts['with_registry_auth'].to_s != 'undef'
       flags << "--with-registry-auth '#{opts['with_registry_auth']}'"
-    end      
+    end
 
-    flags.flatten.join(" ")
+    flags.flatten.join(' ')
   end
-end  
+end