zypper-upgraderepo 1.8.0 → 1.9.0

data/lib/zypper/upgraderepo/traversable.rb

@@ -1,45 +1,50 @@
+# frozen_string_literal: true
+
 module Zypper
   module Upgraderepo
-
+    #
+    # Mixin module that introduces the generic procedures
+    # used to traverse the repository path and query the
+    # system to discover wheter or not the upgraded folder
+    # exists.
+    #
     module Traversable
-
       def traverse_url(uri, version)
         ping(uri)
 
-        if available? && !has_repodata?(uri)
-          return { url: '', message: 'This repository doesn\'t seem working and should be disabled.'}
+        if available? && !repodata?(uri)
+          return { url: "", message: "This repository doesn't seem working and should be disabled." }
         elsif forbidden?
-          res =  { url: url, message: 'Can\'t navigate through the repository!' }
+          res =  { url: url, message: "Can't navigate through the repository!" }
         elsif available? && uri.to_s =~ /#{version}/
           res = traverse_url_forward(uri, version)
         else
           res = traverse_url_backward(uri, version)
         end
 
-        res || { url: '', message: 'Can\'t find a valid alternative, try manually!' }
+        res || { url: "", message: "Can't find a valid alternative, try manually!" }
       end
 
-
       private
 
       def traverse_url_backward(uri, version)
         uri.path = File.dirname(uri.path)
 
-        return nil if uri.path == '/' || uri.path == '.' || (versioned? && (drop_back_level(uri) > max_drop_back))
+        return nil if uri.path == "/" || uri.path == "." || (versioned? && (drop_back_level(uri) > max_drop_back))
 
-        uri.path += '/' if uri.path[-1] != '/'
-        ping(uri, false)
+        uri.path += "/" if uri.path[-1] != "/"
+        ping(uri, head: false)
 
         if not_found?
           return traverse_url_backward(uri, version)
         elsif available?
-          if res = traverse_url_forward(uri, version)
-            return res
-          else
-            return traverse_url_backward(uri, version)
-          end
+          res = traverse_url_forward(uri, version)
+          return res if res
+
+          return traverse_url_backward(uri, version)
+
         elsif forbidden?
-          return { url: uri.to_s, message: 'Try to replace with this one' } if has_repodata?(uri)
+          return { url: uri.to_s, message: "Try to replace with this one" } if repodata?(uri)
 
           return traverse_url_backward(uri, version)
         end
@@ -48,20 +53,18 @@ module Zypper
       end
 
       def traverse_url_forward(uri, version)
-        uri.path += '/' if uri.path[-1] != '/'
-        ping(uri, false)
+        uri.path += "/" if uri.path[-1] != "/"
+        ping(uri, head: false)
 
         subfolders(uri).each do |dir|
           u = URI(uri.to_s)
           u.path += dir
 
-          if has_repodata?(u)
-            if (versioned?) && (u.to_s =~ /#{version}/)
-              return { url: u.to_s, message: 'Override with this one' }
-            end
+          if repodata?(u)
+            return { url: u.to_s, message: "Override with this one" } if versioned? && (u.to_s =~ /#{version}/)
           else
             res = traverse_url_forward(u, version)
-            return res if res.class == Hash
+            return res if res.instance_of?(Hash)
           end
         end
 
@@ -69,27 +72,26 @@ module Zypper
       end
 
       def repodata_uri(uri = nil)
-        if uri
-          uri = URI(uri.to_s)
-        else
-          uri = URI(url)
-        end
+        uri = if uri
+                URI(uri.to_s)
+              else
+                URI(url)
+              end
 
-        uri.path = uri.path.gsub(/\/$/, '') + '/repodata/repomd.xml'
+        uri.path = "#{uri.path.gsub(%r{/$}, "")}/repodata/repomd.xml"
 
         uri
       end
 
       def drop_back_level(uri)
-        URI(url).path.split('/').index { |x| x =~ /\d\d.\d/ } - uri.path.split('/').count
+        URI(url).path.split("/").index { |x| x =~ /\d\d.\d/ } - uri.path.split("/").count
       end
 
       # to implement on each repository type class
       #
-      # def has_repodata?(uri)
+      # def repodata?(uri)
       #
       # def subfolders
-
     end
   end
 end

data/lib/zypper/upgraderepo/utils.rb

@@ -1,82 +1,170 @@
+# frozen_string_literal: true
+
 module Zypper
+  #
+  # Collection of util classes.
+  #
   module Upgraderepo
-
+    #
+    # String class patch.
+    #
     class ::String
-      def black;          "\033[30m#{self}\033[0m" end
-      def red;            "\033[31m#{self}\033[0m" end
-      def green;          "\033[32m#{self}\033[0m" end
-      def yellow;         "\033[33m#{self}\033[0m" end
-      def blue;           "\033[34m#{self}\033[0m" end
-      def magenta;        "\033[35m#{self}\033[0m" end
-      def cyan;           "\033[36m#{self}\033[0m" end
-      def gray;           "\033[37m#{self}\033[0m" end
-      def bg_black;       "\033[40m#{self}\0330m"  end
-      def bg_red;         "\033[41m#{self}\033[0m" end
-      def bg_green;       "\033[42m#{self}\033[0m" end
-      def bg_brown;       "\033[43m#{self}\033[0m" end
-      def bg_blue;        "\033[44m#{self}\033[0m" end
-      def bg_magenta;     "\033[45m#{self}\033[0m" end
-      def bg_cyan;        "\033[46m#{self}\033[0m" end
-      def bg_gray;        "\033[47m#{self}\033[0m" end
-      def bold;           "\033[1m#{self}\033[22m" end
-      def reverse_color;  "\033[7m#{self}\033[27m" end
-      def cr;             "\r#{self}" end
-      def clean;          "\e[K#{self}" end
-      def new_line;       "\n#{self}" end
+      def black
+        "\033[30m#{self}\033[0m"
+      end
+
+      def red
+        "\033[31m#{self}\033[0m"
+      end
+
+      def green
+        "\033[32m#{self}\033[0m"
+      end
+
+      def yellow
+        "\033[33m#{self}\033[0m"
+      end
+
+      def blue
+        "\033[34m#{self}\033[0m"
+      end
+
+      def magenta
+        "\033[35m#{self}\033[0m"
+      end
+
+      def cyan
+        "\033[36m#{self}\033[0m"
+      end
+
+      def gray
+        "\033[37m#{self}\033[0m"
+      end
+
+      def bg_black
+        "\033[40m#{self}\0330m"
+      end
+
+      def bg_red
+        "\033[41m#{self}\033[0m"
+      end
+
+      def bg_green
+        "\033[42m#{self}\033[0m"
+      end
+
+      def bg_brown
+        "\033[43m#{self}\033[0m"
+      end
+
+      def bg_blue
+        "\033[44m#{self}\033[0m"
+      end
+
+      def bg_magenta
+        "\033[45m#{self}\033[0m"
+      end
+
+      def bg_cyan
+        "\033[46m#{self}\033[0m"
+      end
+
+      def bg_gray
+        "\033[47m#{self}\033[0m"
+      end
+
+      def bold
+        "\033[1m#{self}\033[22m"
+      end
+
+      def reverse_color
+        "\033[7m#{self}\033[27m"
+      end
+
+      def cr
+        "\r#{self}"
+      end
+
+      def clean
+        "\e[K#{self}"
+      end
+
+      def new_line
+        "\n#{self}"
+      end
     end
 
+    #
+    # Default error code.
+    #
     class ::StandardError
       def error_code
         1
       end
     end
 
+    #
+    # Color the error message.
+    #
     class Messages
-
-      def self.error(e)
-        if e.class == String
-          puts ' [E] '.bold.red + e
-        elsif e.class == Interruption
-          STDERR.puts e.message =~ /\(/ ? e.message.gsub(/.*\((.*)\).*/, '\1').green : e.message.green
+      def self.error(err)
+        if err.instance_of?(String)
+          puts " [E] ".bold.red + err
+        elsif err.instance_of?(Interruption)
+          warn err.message =~ /\(/ ? err.message.gsub(/.*\((.*)\).*/, '\1').green : err.message.green
         else
-          STDERR.puts 'Error! '.bold.red + e.message
+          warn "Error! ".bold.red + err.message
         end
       end
 
-      def self.ok(m)
-        puts ' [V] '.bold.green + m
+      def self.ok(msg)
+        puts " [V] ".bold.green + msg
       end
 
-      def self.warning(m)
-        puts ' [W] '.bold.yellow + m
+      def self.warning(msg)
+        puts " [W] ".bold.yellow + msg
       end
-
     end
 
+    #
+    # File not found error.
+    #
     class FileNotFound < StandardError
       def initialize(filename)
         super "The File #{filename} doesn't exist."
       end
     end
 
+    #
+    # Osrelease file not found.
+    #
     class ReleaseFileNotFound < StandardError
       def initialize
-        super 'The release file is not found.'
+        super "The release file is not found."
       end
     end
 
+    #
+    # Invalid repository protocol.
+    #
     class InvalidProtocol < StandardError
       def initialize(repo)
         super "The repository #{repo.name} has an unknown protocol: #{repo.protocol}; disable it to continue."
       end
     end
 
+    #
+    # Invalid release version.
+    #
     class InvalidVersion < StandardError
       def initialize(version)
         super "The version #{version} is not valid"
       end
     end
 
+    #
+    # Repository file writing not allowed.
+    #
     class InvalidWritePermissions < StandardError
       def initialize(filename)
         super "Don't have the right permission to write #{filename}"
@@ -87,6 +175,9 @@ module Zypper
       end
     end
 
+    #
+    # An application is running an update.
+    #
     class SystemUpdateRunning < StandardError
       def initialize(args)
         super "The application #{args[:process].bold} with pid #{args[:pid].bold} is running a system update!"
@@ -97,9 +188,13 @@ module Zypper
       end
     end
 
+    #
+    # The repository URL can't be interpolated.
+    #
     class UnableToUpgrade < StandardError
       def initialize(args)
-        super "The repository n.#{args[:num].to_s.bold.red} named #{args[:repo].name.bold.red} can't be upgraded, a manual check is required!"
+        super "The repository n.#{args[:num].to_s.bold.red} named #{args[:repo].name.bold.red} " \
+              "can't be upgraded, a manual check is required!"
       end
 
       def error_code
@@ -107,9 +202,13 @@ module Zypper
       end
     end
 
+    #
+    # Repository with missing URL.
+    #
     class MissingOverride < StandardError
       def initialize(args)
-        super "The repository n.#{args[:num].to_s.bold.red} named #{args[:ini]['name'].bold.red} doesn't contain the URL key!"
+        super "The repository n.#{args[:num].to_s.bold.red} named #{args[:ini]["name"].bold.red} " \
+              "doesn't contain the URL key!"
       end
 
       def error_code
@@ -117,9 +216,13 @@ module Zypper
       end
     end
 
+    #
+    # Repository overrides failure.
+    #
     class UnmatchingOverrides < StandardError
       def initialize(args)
-        super "The repository n.#{args[:num]} named #{args[:repo].name.bold.red} doesn't match with the repository named #{args[:ini]['name'].bold.red} in the ini file"
+        super "The repository n.#{args[:num]} named #{args[:repo].name.bold.red} doesn't match with " \
+              "the repository named #{args[:ini]["name"].bold.red} in the ini file"
       end
 
       def error_code
@@ -127,6 +230,9 @@ module Zypper
       end
     end
 
+    #
+    # The system doesn't require any upgrade.
+    #
     class AlreadyUpgraded < StandardError
       def initialize(version)
         super "The system is already upgraded to the #{version} version"
@@ -137,9 +243,12 @@ module Zypper
       end
     end
 
+    #
+    # There are not unstable versions,
+    #
     class NoUnstableVersionAvailable < StandardError
       def initialize
-        super 'No unstable version is available, remove the --allow-unstable switch to continue'
+        super "No unstable version is available, remove the --allow-unstable switch to continue"
       end
 
       def error_code
@@ -147,9 +256,11 @@ module Zypper
       end
     end
 
+    #
+    # No internet connection.
     class NoConnection < StandardError
       def initialize
-        super 'Internet connection has some trouble'
+        super "Internet connection has some trouble"
       end
 
       def error_code
@@ -157,14 +268,16 @@ module Zypper
       end
     end
 
+    #
+    # Ctrl + C message error.
+    #
     class Interruption < StandardError
       def initialize
-        super 'Ok ok... Exiting!'
+        super "Ok ok... Exiting!"
       end
     end
 
-    Signal.trap('INT') { raise Interruption }
-
-    Signal.trap('TERM') { raise Interruption }
+    Signal.trap("INT") { raise Interruption }
+    Signal.trap("TERM") { raise Interruption }
   end
 end

data/lib/zypper/upgraderepo/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Zypper
   module Upgraderepo
-    VERSION = "1.8.0"
+    VERSION = "1.9.0"
   end
 end