Class: UpdateRepo::ConsoleOutput

Inherits:
Object
  • Object
show all
Includes:
Helpers
Defined in:
lib/update_repo/console_output.rb

Overview

Class : ConsoleOutput. This class has functions to print header, footer and metrics.

Instance Method Summary collapse

Methods included from Helpers

#trunc_dir

Constructor Details

#initialize(logger, metrics, cmd) ⇒ void

Constructor for the ConsoleOutput class.

Examples:

console = ConsoleOutput.new(@log)

Parameters:

  • logger (class) —

    Pointer to the Logger class

  • metrics (class) —

    Pointer to the Metrics class

  • cmd (class) —

    Pointer to the CmdConfig class



17
18
19
20
21
22
23
 
# File 'lib/update_repo/console_output.rb', line 17

def initialize(logger, metrics, cmd)
  @summary = { processed: 'green', updated: 'cyan', skipped: 'yellow',
               failed: 'red', unchanged: 'white' }
  @metrics = metrics
  @log = logger
  @cmd = cmd
end

Instance Method Details

#list_exceptions ⇒ void

This method returns an undefined value.

Print a list of any defined expections that will not be updated.

Parameters:

  • (none) 


97
98
99
100
101
102
 
# File 'lib/update_repo/console_output.rb', line 97

def list_exceptions
  exceptions = @cmd['exceptions']
  return unless exceptions
  print_log "\nExclusions:".underline, ' ',
            exceptions.join(', ').yellow, "\n"
end

#list_failures ⇒ void

This method returns an undefined value.

List any repositories that failed their update, and the error.

Parameters:

  • (none) 


74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/update_repo/console_output.rb', line 74

def list_failures
  # ensure we don't have duplicate errors from the same repo
  remove_dups
  print_log "\n\n!! Note : The following #{@metrics[:failed_list].count}",
            ' repositories ', 'FAILED'.red.underline, ' during this run :'
  # print out any and all errors into a nice list
  @metrics[:failed_list].each do |failed|
    print_log "\n  [", 'x'.red, "] #{failed[:loc]}"
    print_log "\n    -> ", "\"#{failed[:line].chomp}\"".red
  end
end

#list_locations ⇒ void

This method returns an undefined value.

Print a list of all top-level directories that will be searched and any Git repos contained within updated.



107
108
109
110
111
112
 
# File 'lib/update_repo/console_output.rb', line 107

def list_locations
  print_log "\nRepo location(s):\n".underline
  @cmd['location'].each do |loc|
    print_log '-> ', loc.cyan, "\n"
  end
end

#print_metrics ⇒ void

This method returns an undefined value.

Print end-of-run metrics to console / log

Parameters:

  • (none) 


61
62
63
64
65
66
67
68
69
 
# File 'lib/update_repo/console_output.rb', line 61

def print_metrics
  @summary.each do |metric, color|
    metric_value = @metrics[metric]
    output = "#{metric_value} #{metric.capitalize}"
    print_log ' | ', output.send(color.to_sym) unless metric_value.zero?
  end
  print_log ' |'
  list_failures unless @metrics[:failed_list].empty?
end

#remove_dups ⇒ void

This method returns an undefined value.

removes any duplications in the list of failed repos.

Parameters:

  • (none) 


89
90
91
92
 
# File 'lib/update_repo/console_output.rb', line 89

def remove_dups
  # removes duplicate ':loc' values from the Failed list.
  @metrics[:failed_list].uniq! { |error| error[:loc] }
end

#show_footer ⇒ void

This method returns an undefined value.

print out a brief footer. This will be expanded later.

Parameters:

  • (none) 


49
50
51
52
53
54
55
56
 
# File 'lib/update_repo/console_output.rb', line 49

def show_footer
  duration = Time.now - @metrics[:start_time]
  print_log "\nUpdates completed in ", show_time(duration).cyan
  print_metrics
  print_log " \n\n"
  # close the log file now as we are done, just to be sure ...
  @log.close
end

#show_header ⇒ void

This method returns an undefined value.

Display a simple header to the console

Examples:

show_header

Parameters:

  • (none) 


30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/update_repo/console_output.rb', line 30

def show_header
  # print an informative header before starting
  print_log "\nGit Repo update utility (v", VERSION, ')',
            " \u00A9 Grant Ramsay <[email protected]>\n"
  print_log "Using Configuration from '#{@cmd.getconfig.config_path}'\n"
  # show the logfile location, but only if it is enabled
  show_logfile
  # list out the locations that will be searched
  list_locations
  # list any exceptions that we have from the config file
  list_exceptions
  # save the start time for later display in the footer...
  @metrics[:start_time] = Time.now
  print_log "\n" # blank line before processing starts
end

#show_logfile ⇒ void

This method returns an undefined value.

print out the logfile name and location, if we are logging to file



116
117
118
119
 
# File 'lib/update_repo/console_output.rb', line 116

def show_logfile
  return unless @cmd[:log]
  print_log "\nLogging to file:".underline, " #{@log.logfile}\n".cyan
end