Use Rubocop

.rubocop.yml

@@ -0,0 +1,63 @@
+inherit_from:
+  .rubocop_yast_style.yml
+
+# Offense count: 34
+Metrics/AbcSize:
+  Max: 220
+
+# Offense count: 5
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 513
+
+# Offense count: 13
+Metrics/CyclomaticComplexity:
+  Max: 31
+
+# Offense count: 49
+# Configuration parameters: AllowURI, URISchemes.
+Metrics/LineLength:
+  Max: 116
+
+# Offense count: 47
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 223
+
+# Offense count: 13
+Metrics/PerceivedComplexity:
+  Max: 35
+
+Style/Documentation:
+  Exclude:
+    - testsuite/tests/*.rb
+
+Style/FileName:
+  Exclude:
+    - src/clients/nfs-client.rb
+    - src/clients/nfs-client4part.rb
+    - src/modules/Nfs.rb
+    - src/modules/NfsOptions.rb
+
+# YCP Killer used rockets
+Style/HashSyntax:
+  Exclude:
+    - src/clients/nfs.rb
+    - src/clients/nfs_auto.rb
+    - src/include/nfs/ui.rb
+    - src/include/nfs/wizards.rb
+    - src/modules/Nfs.rb
+    - src/modules/NfsOptions.rb
+
+Style/MethodName:
+  Exclude:
+    - src/clients/nfs-client4part.rb
+    - src/clients/nfs.rb
+    - src/include/nfs/routines.rb
+    - src/include/nfs/ui.rb
+    - src/include/nfs/wizards.rb
+    - src/modules/Nfs.rb
+
+Style/VariableName:
+  Exclude:
+    - testsuite/tests/*.rb

.rubocop_yast_style.yml

@@ -0,0 +1,41 @@
+# Rubocop style configuration
+#
+# Following
+# https://github.com/SUSE/style-guides/blob/master/Ruby.md
+
+# https://github.com/SUSE/style-guides/blob/master/Ruby.md#strings
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+# Is there any justification for "aligned" which is the default?
+Style/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+# https://github.com/SUSE/style-guides/blob/master/Ruby.md#arrays
+Style/WordArray:
+  Enabled: false
+
+# align arrows:
+# "foo"     => true
+# "foo_bar" => false
+Style/AlignHash:
+  EnforcedHashRocketStyle: table
+
+# no extra indentation for multiline function calls
+Style/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+# no extra indentation for case
+Style/CaseIndentation:
+  IndentWhenRelativeTo: end
+
+# "unless" has a different connotation than "if not"
+Style/NegatedIf:
+  Enabled: false
+
+# use "raise" instead of "fail"
+Style/SignalException:
+  EnforcedStyle: only_raise

.travis.yml

@@ -5,10 +5,11 @@ before_install:
     # disable rvm, use system Ruby
     - rvm reset
     - wget https://raw.githubusercontent.com/yast/yast-devtools/master/travis-tools/travis_setup.sh
-    - sh ./travis_setup.sh -p "rake yast2-devtools yast2-testsuite yast2" -g "rspec:2.14.1 yast-rake gettext"
+    - sh ./travis_setup.sh -p "rake yast2-devtools yast2-testsuite yast2" -g "rspec:2.14.1 yast-rake gettext rubocop"
 script:
     - rake check:syntax
     - rake check:pot
+    - rubocop
     - make -f Makefile.cvs
     - make
     - sudo make install

Rakefile

@@ -1,6 +1,6 @@
 require "yast/rake"
 
 Yast::Tasks.configuration do |conf|
-  #lets ignore license check for now
+  # lets ignore license check for now
   conf.skip_license_check << /.*/
 end

src/clients/nfs-client.rb

@@ -1,9 +1,8 @@
 # encoding: utf-8
 
-# Author:	Martin Vidner <mvidner@suse.cz>
-# Summary:	Just a redirection
-# $Id$
+# YaST namespace
 module Yast
+  # Just a redirection
   class NfsClientClient < Client
     def main
       @target = "nfs"

src/clients/nfs-client4part.rb

@@ -1,10 +1,8 @@
 # encoding: utf-8
 
-# File:	clients/
-# Summary:	nfs-client stuff made accesible from
-# Author:	Bubli <kmachalkova@suse.cz>
-#
+# YaST namespace
 module Yast
+  # nfs-client stuff made accesible from the partitioner
   class NfsClient4partClient < Client
     def main
       Yast.import "UI"
@@ -76,7 +74,7 @@ def ToStorage(entry)
       entry = deep_copy(entry)
       ret = {}
 
-      if entry != nil && entry != {}
+      if entry && entry != {}
         ret = {
           "device"  => Ops.get_string(entry, "spec", ""),
           "mount"   => Ops.get_string(entry, "file", ""),

src/clients/nfs.rb

@@ -1,27 +1,14 @@
 # encoding: utf-8
 
-# File:	clients/nfs.ycp
-# Package:	Configuration of NFS
-# Summary:	Main file
-# Authors:
-#   Jan Holesovsky <kendy@suse.cz>
-#   Dan Vesely <dan@suse.cz>
-#   Martin Vidner <mvidner@suse.cz>
-#
-# $Id$
-#
-# Main file for nfs configuration. Uses all other files.
+# YaST namespace
 module Yast
+  # Main file
   class NfsClient < Client
     def main
       Yast.import "UI"
 
-      #**
-      # <h3>Configuration of NFS</h3>
-
       textdomain "nfs"
 
-      # The main ()
       Builtins.y2milestone("----------------------------------------")
       Builtins.y2milestone("NFS module started")
 
@@ -47,7 +34,7 @@ def main
         "finish"     => fun_ref(Nfs.method(:Write), "boolean ()"),
         "actions"    => {
           "list"   => {
-            # TODO summary is probably better...
+            # TODO: summary is probably better...
             "handler" => fun_ref(
               method(:NfsListHandler),
               "boolean (map)"
@@ -74,7 +61,7 @@ def main
           }
         },
         "options"    => {
-          # TODO adjust names? create comaptibility aliases?
+          # TODO: adjust names? create comaptibility aliases?
           "spec"   => {
             "type" => "string",
             # host:path
@@ -138,7 +125,7 @@ def main
       Builtins.y2milestone("NFS module finished")
       Builtins.y2milestone("----------------------------------------")
 
-      deep_copy(@ret) 
+      deep_copy(@ret)
 
       # EOF
     end
@@ -147,8 +134,7 @@ def main
     # Print summary in command line
     # @param [Hash] options command options
     # @return false so that Write is not called in non-interactive mode
-    def NfsListHandler(options)
-      options = deep_copy(options)
+    def NfsListHandler(_options)
       nfs_entries = deep_copy(Nfs.nfs_entries)
       if Ops.less_than(Builtins.size(nfs_entries), 1)
         CommandLine.Print(Summary.NotConfigured)

src/clients/nfs_auto.rb

@@ -1,28 +1,8 @@
 # encoding: utf-8
 
-# File:
-#   nfs_auto.ycp
-#
-# Package:
-#   Configuration of NFS client
-#
-# Summary:
-#   Client for autoinstallation
-#
-# Authors:
-#   Martin Vidner <mvidner@suse.cz>
-#
-# $Id$
-#
-# This is a client for autoinstallation. It takes its arguments,
-# goes through the configuration and return the setting.
-# Does not do any changes to the configuration.
-
-# @param first a map of mail settings
-# @return [Hash] edited settings or empty map if canceled
-# @example map mm = $[ "FAIL_DELAY" : "77" ];
-# @example map ret = WFM::CallModule ("mail_auto", [ mm ]);
+# YaST namespace
 module Yast
+  # Client for autoinstallation
   class NfsAutoClient < Client
     def main
       Yast.import "UI"
@@ -54,7 +34,8 @@ def main
         if Ops.greater_than(Builtins.size(WFM.Args), 1) &&
             Ops.is_list?(WFM.Args(1))
           Builtins.y2warning(
-            "Old-style configuration detected (got list, expected map). <nfs> section needs to be converted to match up-to-date schema"
+            "Old-style configuration detected (got list, expected map). " \
+              "<nfs> section needs to be converted to match up-to-date schema"
           )
         end
       end
@@ -104,7 +85,7 @@ def main
       Builtins.y2milestone("Nfs auto finished")
       Builtins.y2milestone("----------------------------------------")
 
-      deep_copy(@ret) 
+      deep_copy(@ret)
 
       # EOF
     end

src/include/nfs/routines.rb

@@ -1,25 +1,10 @@
 # encoding: utf-8
 
-# File:
-#   routines.ycp
-#
-# Module:
-#   Configuration of nfs
-#
-# Summary:
-#   Network NFS routines
-#
-# Authors:
-#   Jan Holesovsky <kendy@suse.cz>
-#   Dan Vesely <dan@suse.cz>
-#
-# $Id$
-#
-# Network NFS routines
-#
+# YaST namespace
 module Yast
+  # Miscellaneous
   module NfsRoutinesInclude
-    def initialize_nfs_routines(include_target)
+    def initialize_nfs_routines(_include_target)
       textdomain "nfs"
 
       Yast.import "Package"
@@ -37,7 +22,7 @@ def SpecToServPath(spec)
       serv = ""
 
       # no :/ inside => <server>: or [/]<path>
-      if path_begin == nil
+      if path_begin.nil?
         if spec ==
             Ops.add(
               Builtins.filterchars(spec, Ops.add("-_.", String.CAlnum)),
@@ -48,14 +33,13 @@ def SpecToServPath(spec)
         end
       end
 
-      if path_begin != nil
+      if path_begin
         serv = Builtins.substring(spec, 0, path_begin)
         spec = Builtins.substring(spec, Ops.add(path_begin, 1))
       end
       term(:couple, serv, spec)
     end
 
-
     # Creates a list of ui table items for nfs fstab entries
     # @param [Array<Hash>] fstab     list of nfs fstab entries
     # @return          itemized table entries
@@ -97,11 +81,11 @@ def CheckHostName(name)
       Report.Error(
         Builtins.sformat(
           _(
-            "The hostname entered is invalid. It must be\n" +
-              "shorter than 50 characters and only use\n" +
-              "valid IPv4, IPv6 or domain name.\n" +
-              "Valid IPv4: %1\n" +
-              "Valid IPv6: %2\n" +
+            "The hostname entered is invalid. It must be\n" \
+              "shorter than 50 characters and only use\n" \
+              "valid IPv4, IPv6 or domain name.\n" \
+              "Valid IPv4: %1\n" \
+              "Valid IPv6: %2\n" \
               "Valid domain: %3"
           ),
           IP.Valid4,
@@ -153,16 +137,15 @@ def CheckPath(name)
       Report.Error(
         Builtins.sformat(
           _(
-            "The path entered is invalid.\n" +
-              "It must be shorter than 70 characters\n" +
+            "The path entered is invalid.\n" \
+              "It must be shorter than 70 characters\n" \
               "and it must begin with a slash (/)."
           )
         )
       )
       false
     end
 
-
     # Strips a superfluous slash off the end of a pathname.
     # @param [String] p       pathname
     # @return          stripped pathname