Better debugging and cleaner error handling

Author: Lupraxus

CHANGELOG.md

@@ -5,13 +5,17 @@ All notable changes to this project will be documented in this file.
 
 This changelog was automatically generated using [Caretaker](https://github.com/DevelopersToolbox/caretaker) by [Wolf Software](https://github.com/WolfSoftware)
 
-### [Unreleased](https://github.com/DevelopersToolbox/github-ripper/compare/v0.1.1...HEAD)
+### [v0.1.2](https://github.com/DevelopersToolbox/github-ripper/compare/v0.1.1...v0.1.2)
 
-- rebrand [`[head]`](https://github.com/DevelopersToolbox/github-ripper/commit/)
+> Released on May, 20th 2022
+
+- Better debugging and cleaner error handling [`[head]`](https://github.com/DevelopersToolbox/github-ripper/commit/)
+
+- rebrand [`[5c46d9c]`](https://github.com/DevelopersToolbox/github-ripper/commit/5c46d9c7fe28dc3be562c7534438fe8163633f52)
 
 - Update travis slack integration due to new slack organisation [`[751d7e3]`](https://github.com/DevelopersToolbox/github-ripper/commit/751d7e3994ba8ab24052568d521dd406b773a47f)
 
-### [v0.1.0](https://github.com/DevelopersToolbox/github-ripper/releases/v0.1.0)
+### [v0.1.1](https://github.com/DevelopersToolbox/github-ripper/compare/v0.1.0...v0.1.1)
 
 > Released on June, 12th 2021
 
@@ -21,5 +25,9 @@ This changelog was automatically generated using [Caretaker](https://github.com/
 
 - Fix travis rvm versions and slack integration [`[13e051b]`](https://github.com/DevelopersToolbox/github-ripper/commit/13e051b88cf6081e2e47665332f035b77c8c4aea)
 
+### [v0.1.0](https://github.com/DevelopersToolbox/github-ripper/releases/v0.1.0)
+
+> Released on March, 12th 2021
+
 - The initial commit [`[d6e8c31]`](https://github.com/DevelopersToolbox/github-ripper/commit/d6e8c3134a2a0f19446da799615aeda8998bc8b4)
 

VERSION.txt

@@ -1 +1 @@
-0.1.1
+0.1.2

exe/ghrip

@@ -54,13 +54,23 @@ def add_flag_parameters(parser, options)
     [parser, options]
 end
 
+# This method reeks of :reek:UtilityFunction, :reek:TooManyStatements
+def add_debug_flag_parameters(parser, options)
+    parser.separator ''
+    parser.separator 'Flags (Debugging):'
+    parser.on('-D', '--debug', 'Enable debugging') { |_debug| options[:debug] = true }
+    parser.on('-v', '--verbose', 'Verbose Output') { |_verbose| options[:verbose] = true }
+    [parser, options]
+end
+
 def create_parser
     options = DEFAULT_VALUES.dup
 
     parser = init_default_parser
     parser, options = add_parameters(parser, options)
     parser, options = add_repo_flag_parameters(parser, options)
     parser, options = add_flag_parameters(parser, options)
+    parser, options = add_debug_flag_parameters(parser, options)
 
     [parser, options]
 end

lib/github-ripper.rb

@@ -5,6 +5,7 @@
 require 'rainbow'
 require 'terminal-table'
 
+require_relative 'github-ripper/debugging'
 require_relative 'github-ripper/function-maps'
 require_relative 'github-ripper/git'
 require_relative 'github-ripper/report'
@@ -27,8 +28,15 @@ def rip(options = {})
             options[:use_slugs] = true
             options[:base_dir] = "#{File.expand_path('~')}/Downloads/Repos" unless get_option(options, :base_dir)
 
+            verbose(options, 'Verbose mode enabled')
+            debug(options, 'Debug mode enabled')
+
+            verbose(options, 'Getting repo list')
             repos = get_repo_list(options)
+
+            verbose(options, 'Ripping repos')
             results = rip_repos(options, repos)
+
             results, repo_count, error_count = process_results(results, options)
             draw_report(results, repo_count, error_count, options)
         end

lib/github-ripper/debugging.rb

@@ -0,0 +1,20 @@
+#
+# Class docs to go here
+#
+class GithubRipper
+    class << self
+        #
+        # Everything below here is private
+        #
+
+        private
+
+        def verbose(options, message)
+            print(Rainbow("[ VERBOSE ] #{message}\n").cyan.bright) if get_option(options, :verbose)
+        end
+
+        def debug(options, message)
+            print(Rainbow("[ DEBUG ] #{message}\n").yellow.bright) if get_option(options, :debug)
+        end
+    end
+end

lib/github-ripper/function-maps.rb

@@ -20,6 +20,8 @@ class << self
         private
 
         def function_map_lookup(options)
+            debug(options, "Function: #{__method__}")
+
             return FUNCTION_MAP[:user_repos] if flag_set?(options, :user_repos) || get_option(options, :user)
             return FUNCTION_MAP[:org_members_repos] if flag_set?(options, :org_members_repos)
             return FUNCTION_MAP[:all_repos] if flag_set?(options, :all_repos)

lib/github-ripper/git.rb

@@ -14,6 +14,8 @@ class << self
         private
 
         def get_clone_type(options)
+            debug(options, "Function: #{__method__}")
+
             return 'git clone [email protected]:' if flag_set?(options, :use_git)
 
             return "git clone https://#{options[:token]}@github.com/" if get_option(options, :token)
@@ -22,14 +24,20 @@ def get_clone_type(options)
         end
 
         def repo_full_path(options, repo)
+            debug(options, "Function: #{__method__}")
+
             "#{options[:base_dir]}/#{repo}"
         end
 
         def repo_exists?(repo_path)
+            debug(options, "Function: #{__method__}")
+
             File.directory?(repo_path)
         end
 
         def execute_command(command)
+            debug(options, "Function: #{__method__}")
+
             error_string = ''
             return_code = 0
 
@@ -42,6 +50,8 @@ def execute_command(command)
         end
 
         def clone_repo(options, repo, repo_path)
+            debug(options, "Function: #{__method__}")
+
             return { :repo => repo, :path => repo_path, :status => 'Dry Run', :when => 'git clone', :info => '' } if flag_set?(options, :dry_run)
 
             FileUtils.mkdir_p repo_path
@@ -56,6 +66,8 @@ def clone_repo(options, repo, repo_path)
         end
 
         def update_repo(options, repo, repo_path)
+            debug(options, "Function: #{__method__}")
+
             return { :repo => repo, :path => repo_path, :status => 'Dry Run', :when => 'git clone', :info => '' } if flag_set?(options, :dry_run)
 
             olddir = Dir.pwd
@@ -71,6 +83,8 @@ def update_repo(options, repo, repo_path)
         end
 
         def clone_repo_wrapper(options, repo)
+            debug(options, "Function: #{__method__}")
+
             repo_path = repo_full_path(options, repo)
 
             return update_repo(options, repo, repo_path) if repo_exists?(repo_path)

lib/github-ripper/report.rb

@@ -10,6 +10,8 @@ class << self
         private
 
         def display_table?(error_count, options)
+            debug(options, "Function: #{__method__}")
+
             # Dry run - force display of all
             return true if flag_set?(options, :dry_run)
 
@@ -27,6 +29,8 @@ def display_table?(error_count, options)
         # This method smells of :reek:LongParameterList, :reek:DuplicateMethodCall
         #
         def draw_report(results, repo_count, error_count, options)
+            debug(options, "Function: #{__method__}")
+
             return unless display_table?(error_count, options)
 
             table = create_table

lib/github-ripper/repos.rb

@@ -12,6 +12,8 @@ class << self
         # rubocop:disable Metrics/CyclomaticComplexity
         # This method smells of :reek:NilCheck
         def handle_required_parameters(options)
+            debug(options, "Function: #{__method__}")
+
             return if get_option(options, :token)
 
             raise StandardError.new('Please supply a username (-u) or a token (-t)') if (flag_set?(options, :user_repos) || flag_set?(options, :org_members_repos) || flag_set?(options, :all_repos)) && get_option(options, :user).nil?
@@ -24,6 +26,8 @@ def handle_required_parameters(options)
         # docs go here
         #
         def get_repo_list(options)
+            debug(options, "Function: #{__method__}")
+
             handle_required_parameters(options)
 
             function = function_map_lookup(options)
@@ -37,6 +41,8 @@ def get_repo_list(options)
         # This method smells of :reek:DuplicateMethodCall
         #
         def rip_repos(options, repos)
+            debug(options, "Function: #{__method__}")
+
             repo_count = repos.size
 
             results = if flag_set?(options, :silent)
@@ -48,6 +54,8 @@ def rip_repos(options, repos)
         end
 
         def process_results(results, options)
+            debug(options, "Function: #{__method__}")
+
             repo_count = count_repos(results)
             error_count = count_errors(results)
             results = filter_results(results, options)

lib/github-ripper/table.rb

@@ -11,11 +11,15 @@ class << self
 
         # This method smells of :reek:UtilityFunction
         def create_table
+            debug(options, "Function: #{__method__}")
+
             Terminal::Table.new :headings => ['Repo', 'Path', 'Status', 'When', 'Information']
         end
 
         # This method smells of :reek:ControlParameter, :reek:LongParameterList
         def add_title(table, repo_count, error_count, options)
+            debug(options, "Function: #{__method__}")
+
             title = "There were #{error_count} #{plural(error_count, 'error')}"
             title += " from #{repo_count} #{plural(repo_count, 'repository', 'respositories')}" if flag_set?(options, :full_report) || flag_set?(options, :dry_run)
 
@@ -25,24 +29,32 @@ def add_title(table, repo_count, error_count, options)
 
         # This method smells of :reek:UtilityFunction, :reek:ControlParameter
         def visible_row?(repo, options)
+            debug(options, "Function: #{__method__}")
+
             # Dry run - force display of all
             return true if flag_set?(options, :dry_run)
 
             repo[:status] == 'Failed' || flag_set?(options, :full_report)
         end
 
         def add_single_row(table, repo, options)
+            debug(options, "Function: #{__method__}")
+
             status = repo[:status]
             table.add_row [set_colour(repo[:repo], status), set_colour(repo[:path], status), set_colour(status, status), set_colour(repo[:when], status), set_colour(repo[:info], status)] if visible_row?(repo, options)
             table
         end
 
         def add_rows(table, results, options)
+            debug(options, "Function: #{__method__}")
+
             results.each { |repo| table = add_single_row(table, repo, options) }
             table
         end
 
         def display_table(table)
+            debug(options, "Function: #{__method__}")
+
             puts table
         end
     end