Class: UpdateRepo::Logger

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

Overview

Class : Logger. This class encapsulates printing to screen and logging to file if requried.

Instance Method Summary collapse

Methods included from Helpers

#trunc_dir

Constructor Details

#initialize(cmd) ⇒ void

Constructor for the Logger class.

Examples:

log = Logger.new(@cmd)

Parameters:

  • cmd (instance) —

    • pointer to the CmdConfig class



17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
 
# File 'lib/update_repo/logger.rb', line 17

def initialize(cmd)
  @cmd = cmd
  @legend = { failed: { char: 'x', color: 'red' },
              updated: { char: '^', color: 'green' },
              unchanged: { char: '.', color: 'white' },
              skipped: { char: 's', color: 'yellow' } }
  # don't prepare a logfile unless it's been requested.
  return unless @cmd[:log]

  # generate a filename depending on 'timestamp' setting.
  filename = generate_filename
  # open the logfile and set sync mode.
  @logfile = File.open(filename, 'w')
  @logfile.sync = true
end

Instance Method Details

#close ⇒ void

This method returns an undefined value.

close the logfile, if it exists

Parameters:

  • (none) 


103
104
105
 
# File 'lib/update_repo/logger.rb', line 103

def close
  @logfile&.close # if @logfile
end

#generate_filename ⇒ string

generate a filename for the log, with or without a timestamp

Parameters:

  • (none)

Returns:

  • (string) —

    Filename for the logfile.



36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/update_repo/logger.rb', line 36

def generate_filename
  # add a timestamp if requested
  name = if @cmd[:timestamp]
           'updaterepo-' + Time.new.strftime('%y%m%d-%H%M%S') + '.log'
         else
           'updaterepo.log'
         end
  # log to local directory instead of home directory if requested
  if @cmd[:log_local]
    File.expand_path(File.join('./', name))
  else
    File.expand_path(File.join('~/', name))
  end
end

#logfile ⇒ string

Return a string containing the logfile name and full path.

Returns:

  • (string) 


82
83
84
 
# File 'lib/update_repo/logger.rb', line 82

def logfile
  @logfile.path
end

#output(*string) ⇒ void

This method returns an undefined value.

this function will simply pass the given string to ‘print’, and also log to file if that is specified.

Parameters:

  • string (array) —

    Array of strings for print formatting



55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/update_repo/logger.rb', line 55

def output(*string)
  # nothing to screen if we want to be --quiet
  unless @cmd[:quiet]
    # log header and footer to screen regardless
    print(*string) if @cmd[:verbose] || !repo_text?
  end
  # log to file if that has been enabled
  return unless @cmd[:log]

  @logfile.write(string.join('').gsub(/\e\[(\d+)(;\d+)*m/, ''))
end

#repo_text? ⇒ boolean

returns non nil if we have been called originally by one of the Repo update output functions.

Parameters:

  • (none)

Returns:

  • (boolean) —

    True if we have been called during repo update



90
91
92
93
94
95
96
97
98
 
# File 'lib/update_repo/logger.rb', line 90

def repo_text?
  # get calling function - need to skip first 2, also remove 'block in '
  # prefix if exists
  calling_fn = caller_locations(3..3).first.label.gsub(/block in /, '')
  # array with the functions we want to skip
  repo_output = %w[do_update print_line handle_output skip_repo update]
  # return TRUE if DOES match, FALSE otherwise.
  repo_output.include?(calling_fn) ? true : false
end

#repostat(status) ⇒ void

This method returns an undefined value.

function repostat - outputs a coloured char depending on the status hash, but not if we are in quiet or verbose mode.

Parameters:

  • status (hash) —

    pointer to GitControl.status hash



71
72
73
74
75
76
77
78
 
# File 'lib/update_repo/logger.rb', line 71

def repostat(status)
  # only print if not quiet and not verbose!
  return if @cmd[:quiet] || @cmd[:verbose]

  @legend.each do |key, value|
    print value[:char].send(value[:color].to_sym) if status[key]
  end
end