panda-motd 0.0.11 → 0.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 8d4906b3c8c203b722479456407cb2a14f1cc236e60e096bd819522d6bb5dbac
-  data.tar.gz: 0aed905391cc7877b3060d4d6f133980afac8e100a9c54be2bd1221160b50417
+SHA1:
+  metadata.gz: 5e27df79cdab81d15c44ff575075e876eb975b44
+  data.tar.gz: 954bf7eb0ff70fd62b86918dfe1cbd95c84d56bb
 SHA512:
-  metadata.gz: 7ae257444243189b4c6000b1151e7f9c3deb0a4a9fa8ce58766ac6c8bfef618d1df747cbe3f913972575116730bf9ceabad49fb1e0226b3c80b361617a943da1
-  data.tar.gz: bca4470e8c9e2513a794f99af9502b2c5e3dbc4171787bde6f2c66ca3cd4b8ed3fa9478cfdaedbc828b9af6f0025e818b14f2b2823703454aa67efbbb241496e
+  metadata.gz: af66d7e99d7396984468e5824b1902b1e595aea9022a27c1c128df98416f386c89f23f1c5415aca4da26045af458e4b6e5b5844111a3488aabb1e15270d79351
+  data.tar.gz: 306ec97a05b35bfb2a0418018fbfc1b627c0e69007bef88ac7932b29bb319418637f416ec2c3903de1ddfcd44f29e6abe413944b153ec85fc04669177ffbd4fc

data/bin/panda-motd

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-require 'panda_motd'
+require "panda_motd"
 
 motd = PandaMOTD.new_motd
 puts motd

data/lib/panda_motd.rb

@@ -1,16 +1,21 @@
-require 'require_all'
-require_rel 'panda_motd'
+# frozen_string_literal: true
+
+require "require_all"
+require_rel "panda_motd"
 
 class PandaMOTD
+  # Creates a new MOTD instance, assuming a config file has been passed as an
+  # argument to the command.
   def self.new_motd
     if ARGV[0].nil?
-      puts 'You must provide a config file path as an argument to panda-motd.'
+      puts "You must provide a config file path as an argument to panda-motd."
     else
       MOTD.new(ARGV[0])
     end
   end
 
+  # Gets the root path of the gem.
   def self.root
-    File.expand_path('..', __dir__)
+    File.expand_path("..", __dir__)
   end
 end

data/lib/panda_motd/component.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Component
   attr_reader :name, :errors, :results, :config
 
@@ -8,19 +10,26 @@ class Component
     @errors = []
   end
 
+  # Evaluates the component so that it has some meaningful output when it comes
+  # time to print the MOTD.
   def process
     raise NotImplementedError
   end
 
+  # Gives the output of a component as a string.
   def to_s
     raise NotImplementedError
   end
 
+  # The number of lines to print before the component in the context of the
+  # entire MOTD. 1 by default, if not configured.
   def lines_before
-    @motd.config.component_config(@name)['lines_before'] || 1
+    @motd.config.component_config(@name)["lines_before"] || 1
   end
 
+  # The number of lines to print after the component in the context of the
+  # entire MOTD. 1 by default, if not configured.
   def lines_after
-    @motd.config.component_config(@name)['lines_after'] || 1
+    @motd.config.component_config(@name)["lines_after"] || 1
   end
 end

data/lib/panda_motd/component_error.rb

@@ -1,4 +1,6 @@
-require 'colorize'
+# frozen_string_literal: true
+
+require "colorize"
 
 class ComponentError
   attr_reader :component, :message
@@ -8,6 +10,7 @@ class ComponentError
     @message = message
   end
 
+  # Gets a printable error string in red.
   def to_s
     return "#{@component.name} error: ".red + @message.to_s
   end

data/lib/panda_motd/components/ascii_text_art.rb

@@ -1,18 +1,20 @@
-require 'artii'
-require 'colorize'
+# frozen_string_literal: true
+
+require "artii"
+require "colorize"
 
 class ASCIITextArt < Component
   def initialize(motd)
-    super(motd, 'ascii_text_art')
+    super(motd, "ascii_text_art")
   end
 
   def process
-    @text = `#{@config['command']}`
-    @art = Artii::Base.new font: @config['font']
+    @text = `#{@config["command"]}`
+    @art = Artii::Base.new font: @config["font"]
     @results = @art.asciify(@text)
-    @results = @results.colorize(@config['color'].to_sym) if @config['color']
+    @results = @results.colorize(@config["color"].to_sym) if @config["color"]
   rescue Errno::EISDIR # Artii doesn't handle invalid font names very well
-    @errors << ComponentError.new(self, 'Invalid font name')
+    @errors << ComponentError.new(self, "Invalid font name")
   end
 
   def to_s

data/lib/panda_motd/components/fail_2_ban.rb

@@ -1,31 +1,33 @@
+# frozen_string_literal: true
+
 class Fail2Ban < Component
   def initialize(motd)
-    super(motd, 'fail_2_ban')
+    super(motd, "fail_2_ban")
   end
 
   def process
     @results = {
-      jails: {}
+      jails: {},
     }
 
-    @config['jails'].each do |jail|
+    @config["jails"].each do |jail|
       status = jail_status(jail)
       @results[:jails][jail] = {
         total: status[:total],
-        current: status[:current]
+        current: status[:current],
       }
     end
   end
 
   def to_s
-    result = "Fail2Ban:\n"
+    result = +"Fail2Ban:\n"
     @results[:jails].each do |name, stats|
-      result += "  #{name}:\n"
-      result += "    Total bans:   #{stats[:total]}\n"
-      result += "    Current bans: #{stats[:current]}\n"
+      result << "  #{name}:\n"
+      result << "    Total bans:   #{stats[:total]}\n"
+      result << "    Current bans: #{stats[:current]}\n"
     end
 
-    result.gsub(/\s$/, '')
+    result.gsub!(/\s$/, "")
   end
 
   private

data/lib/panda_motd/components/filesystems.rb

@@ -1,13 +1,15 @@
-require 'ruby-units'
-require 'colorize'
+# frozen_string_literal: true
+
+require "ruby-units"
+require "colorize"
 
 class Filesystems < Component
   def initialize(motd)
-    super(motd, 'filesystems')
+    super(motd, "filesystems")
   end
 
   def process
-    @results = parse_filesystem_usage(@config['filesystems'])
+    @results = parse_filesystem_usage(@config["filesystems"])
   end
 
   def to_s
@@ -17,11 +19,11 @@ class Filesystems < Component
 
     size_w_padding = (name_col_size + 6) > 13 ? (name_col_size + 6) : 13
 
-    result = 'Filesystems'.ljust(size_w_padding, ' ')
-    result += "Size  Used  Free  Use%\n"
+    result = +"Filesystems".ljust(size_w_padding, " ")
+    result << "Size  Used  Free  Use%\n"
 
     @results.each do |filesystem|
-      result += format_filesystem(filesystem, size_w_padding)
+      result << format_filesystem(filesystem, size_w_padding)
     end
 
     result
@@ -33,30 +35,31 @@ class Filesystems < Component
     return "  #{filesystem}\n" if filesystem.is_a? String # handle fs not found
 
     # filesystem name
-    result = ''
-    result += "  #{filesystem[:pretty_name]}".ljust(size, ' ')
+    result = +""
+    result << "  #{filesystem[:pretty_name]}".ljust(size, " ")
 
     # statistics (size, used, free, use%)
     [:size, :used, :avail].each do |metric|
-      result += format_metric(filesystem, metric)
+      result << format_metric(filesystem, metric)
     end
+
     percent_used = calc_percent_used(filesystem)
-    result += format_percent_used(percent_used)
-    result += "\n"
+    result << format_percent_used(percent_used)
+    result << "\n"
 
     # visual bar representation of use%
-    result += generate_usage_bar(filesystem, size, percent_used)
+    result << generate_usage_bar(filesystem, size, percent_used)
 
     result
   end
 
   def generate_usage_bar(filesystem, size, percent_used)
-    result = ''
+    result = +""
     total_ticks = size + 18
     used_ticks = (total_ticks * (percent_used.to_f / 100)).round
-    result += "  [#{('=' * used_ticks).send(pct_color(percent_used))}"\
-              "#{('=' * (total_ticks - used_ticks)).light_black}]"
-    result += "\n" unless filesystem == @results.last
+    result << "  [#{("=" * used_ticks).send(pct_color(percent_used))}" \
+              "#{("=" * (total_ticks - used_ticks)).light_black}]"
+    result << "\n" unless filesystem == @results.last
     result
   end
 
@@ -74,7 +77,7 @@ class Filesystems < Component
   end
 
   def format_percent_used(percent_used)
-    (percent_used.to_s.rjust(3, ' ') + '%').send(pct_color(percent_used))
+    (percent_used.to_s.rjust(3, " ") + "%").send(pct_color(percent_used))
   end
 
   def calc_metric(value)
@@ -96,20 +99,21 @@ class Filesystems < Component
     whole_number_length = value.scalar.floor.to_s.length
     round_amount = whole_number_length > 1 ? 0 : 1
     formatted = value.scalar.round(round_amount).to_s + value.units[0].upcase
-    formatted.rjust(4, ' ') + '  '
+
+    formatted.rjust(4, " ") + "  "
   end
 
   def calc_units(value)
-    if value > 10**12
-      'terabytes'
-    elsif value > 10**9
-      'gigabytes'
-    elsif value > 10**6
-      'megabytes'
-    elsif value > 10**3
-      'kilobytes'
+    if value > 10 ** 12
+      "terabytes"
+    elsif value > 10 ** 9
+      "gigabytes"
+    elsif value > 10 ** 6
+      "megabytes"
+    elsif value > 10 ** 3
+      "kilobytes"
     else
-      'bytes'
+      "bytes"
     end
   end
 
@@ -126,7 +130,7 @@ class Filesystems < Component
         filesystem_name: filesystem_name,
         size: size.to_i * 1024,
         used: used.to_i * 1024,
-        avail: avail.to_i * 1024
+        avail: avail.to_i * 1024,
       }
     end
   end

data/lib/panda_motd/components/last_login.rb

@@ -1,15 +1,19 @@
-require 'date'
+# frozen_string_literal: true
+
+require "date"
 
 class LastLogin < Component
   def initialize(motd)
-    super(motd, 'last_login')
+    super(motd, "last_login")
   end
 
+  # @see Component#process
   def process
-    @users = @config['users']
-    @results = parse_last_logins(@users)
+    @users = @config["users"]
+    @results = parse_last_logins
   end
 
+  # @see Component#to_s
   def to_s
     <<~HEREDOC
       Last Login:
@@ -19,9 +23,17 @@ class LastLogin < Component
 
   private
 
+  # Takes the list of processed results and generates a complete printable
+  # component string.
+  #
+  # @param user [String] the username to generate a string for
+  # @param logins [Array<Hash>] an array of hashes with username keys and hash
+  #   values containing the login data (see {#hashify_login})
+  #
+  # @return [String] the printable string for a single user
   def parse_result(user, logins)
     logins_part = if logins.empty?
-                    '    no logins found for user.'
+                    "    no logins found for user."
                   else
                     longest_size = logins.map { |l| l[:location].length }.max
                     logins.map { |l| parse_login(l, longest_size) }.join("\n")
@@ -32,11 +44,18 @@ class LastLogin < Component
     HEREDOC
   end
 
+  # Takes login data and converts it to a heplful printable string.
+  #
+  # @param login [Hash] the login data, see {#hashify_login}
+  # @param longest_size [Integer] the longest string length to help with string
+  #   formatting
+  #
+  # @return [String] the formatted string for printing
   def parse_login(login, longest_size)
-    location = login[:location].ljust(longest_size, ' ')
-    start = login[:time_start].strftime('%m/%d/%Y %I:%M%p')
+    location = login[:location].ljust(longest_size, " ")
+    start = login[:time_start].strftime("%m/%d/%Y %I:%M%p")
     finish = if login[:time_end].is_a? String # not a date
-               if login[:time_end] == 'still logged in'
+               if login[:time_end] == "still logged in"
                  login[:time_end].green
                else
                  login[:time_end].yellow
@@ -47,8 +66,12 @@ class LastLogin < Component
     "    from #{location} at #{start} (#{finish})"
   end
 
-  def parse_last_logins(users)
-    users.map do |(username, num_logins)|
+  # Takes a list of configured usernames and grabs login data from the system.
+  #
+  # @return [Hash{Symbol => Hash}] a hash with username keys and hash values
+  #   containing the login data (see {#hashify_login})
+  def parse_last_logins
+    @users.map do |(username, num_logins)|
       cmd_result = `last --time-format=iso #{username}`
       logins = cmd_result.lines
                          .select { |entry| entry.start_with?(username) }
@@ -58,6 +81,13 @@ class LastLogin < Component
     end.to_h
   end
 
+  # A hash representation of a single login.
+  #
+  # @param login [String] the raw string result from the call to the system
+  #   containing various bits of login information
+  # @param username [String] the username of the logged user
+  #
+  # @return [Hash] the parsed login entry data, with symbol keys
   def hashify_login(login, username)
     re = login.chomp.split(/(?:\s{2,})|(?<=\d)(?:\s-\s)/)
     date = re[4].scan(/\d{4}-\d{2}-[\dT:]+-\d{4}/)
@@ -65,10 +95,10 @@ class LastLogin < Component
     time_end = date.any? ? Time.parse(re[4]) : re[4]
 
     {
-      username: username,
-      location: re[2],
+      username: username,             # string username
+      location: re[2],                # string login location, an IP address
       time_start: Time.parse(re[3]),
-      time_end: time_end
+      time_end: time_end,             # Time or string, could be "still logged in"
     }
   end
 end

data/lib/panda_motd/components/service_status.rb

@@ -1,15 +1,20 @@
-require 'colorize'
+# frozen_string_literal: true
+
+require "colorize"
 
 class ServiceStatus < Component
   def initialize(motd)
-    super(motd, 'service_status')
+    super(motd, "service_status")
   end
 
+  # @see Component#process
   def process
-    @services = @config['services']
+    @services = @config["services"]
     @results = parse_services(@services)
   end
 
+  # Gets a printable string to be printed in the MOTD. If there are no services
+  # found in the result, it prints a warning message.
   def to_s
     return "Services:\n  No matching services found." unless @results.any?
 
@@ -17,29 +22,49 @@ class ServiceStatus < Component
     result = <<~HEREDOC
       Services:
       #{@results.map do |(name, status)|
-        spaces = (' ' * (longest_name_size - name.to_s.length + 1))
-        status_part = status.to_s.colorize(service_colors[status.to_sym])
-        "  #{name}#{spaces}#{status_part}"
-      end.join("\n")}
+      spaces = (" " * (longest_name_size - name.to_s.length + 1))
+      status_part = status.to_s.colorize(service_colors[status.to_sym])
+      "  #{name}#{spaces}#{status_part}"
+    end.join("\n")}
     HEREDOC
 
-    result.gsub(/\s$/, '')
+    result.gsub(/\s$/, "")
   end
 
   private
 
+  # Runs a `systemd` command to determine the state of a service. If the state
+  # of the service was unable to be determined, an error will be added to the
+  # component.
+  #
+  # @param service [String] the name of the systemd service
+  #
+  # @return [String] the state of the systemd service
   def parse_service(service)
-    cmd_result = `systemctl is-active #{service[0]}`.strip
+    cmd_result = `systemd is-active #{service[0]}`.strip
     if cmd_result.empty?
-      @errors << ComponentError.new(self, 'systemctl output was blank.')
+      @errors << ComponentError.new(self, "systemctl output was blank.")
     end
     cmd_result
   end
 
+  # Takes a list of services from a configuration file, and turns them into a
+  # hash with the service states as values.
+  #
+  # @param services [Array] a two-element array where the first element is the
+  #   name of the systemd service, and the second is the pretty name that
+  #   represents it.
+  #
+  # @return [Hash]
+  #   * `key`: The symbolized name of the systemd service
+  #   * `value`: The symbolized service state
   def parse_services(services)
     services.map { |s| [s[1].to_sym, parse_service(s).to_sym] }.to_h
   end
 
+  # A hash of mappings between a service state and a color which represents it.
+  # The hash has a default value of red in order to handle unexpected service
+  # status strings returned by `systemctl`.
   def service_colors
     colors = Hash.new(:red)
     colors[:active] = :green

data/lib/panda_motd/components/ssl_certificates.rb

@@ -1,51 +1,77 @@
-require 'date'
+# frozen_string_literal: true
+
+require "date"
 
 class SSLCertificates < Component
   def initialize(motd)
-    super(motd, 'ssl_certificates')
+    super(motd, "ssl_certificates")
   end
 
+  # @see Component#process
   def process
-    @certs = @config['certs']
+    @certs = @config["certs"]
     @results = cert_dates(@certs)
   end
 
+  # Prints the list of SSL certificates with their statuses. If a certificate
+  # is not found at the configured location, a message will be printed which
+  # explains this.
   def to_s
     <<~HEREDOC
       SSL Certificates:
       #{sorted_results.map do |cert|
-          return "  #{cert}" if cert.is_a? String # print the not found message
+      return "  #{cert}" if cert.is_a? String # print the not found message
 
-          parse_cert(cert)
-        end.join("\n")}
+      parse_cert(cert)
+    end.join("\n")}
     HEREDOC
   end
 
   private
 
+  # Takes an entry from `@results` and formats it in a way that is conducive
+  # to being printed in the context of the MOTD.
+  #
+  # @param cert [Array] a two-element array in the same format as the return
+  #   value of {#parse_result}
   def parse_cert(cert)
-    name_portion = cert[0].ljust(longest_cert_name_length + 6, ' ')
+    name_portion = cert[0].ljust(longest_cert_name_length + 6, " ")
     status_sym = cert_status(cert[1])
     status = cert_status_strings[status_sym].to_s
     colorized_status = status.colorize(cert_status_colors[status_sym])
-    date_portion = cert[1].strftime('%e %b %Y %H:%M:%S%p')
+    date_portion = cert[1].strftime("%e %b %Y %H:%M:%S%p")
     "  #{name_portion} #{colorized_status} #{date_portion}"
   end
 
+  # Determines the length of the longest SSL certificate name for use in
+  # formatting the output of the component.
+  #
+  # @return [Integer] the length of the longest certificate name
   def longest_cert_name_length
     @results.map { |r| r[0].length }.max
   end
 
+  # Takes the results array and sorts it according to the configured sort
+  # method. If the option is not set or is set improperly, it will default to
+  # alphabetical.
   def sorted_results
-    if @config['sort_method'] == 'alphabetical'
+    if @config["sort_method"] == "alphabetical"
       @results.sort_by { |c| c[0] }
-    elsif @config['sort_method'] == 'expiration'
+    elsif @config["sort_method"] == "expiration"
       @results.sort_by { |c| c[1] }
     else # default to alphabetical
       @results.sort_by { |c| c[0] }
     end
   end
 
+  # Takes a list of certificates and compiles a list of results for each
+  # certificate. If a certificate was not found, a notice will be returned
+  # instead.
+  #
+  # @return [Array] An array of parsed results. If there was an error, the
+  #   element will be just a string. If it was successful, the element will be
+  #   another two-element array in the same format as the return value of
+  #   {#parse_result}.
   def cert_dates(certs)
     certs.map do |name, path|
       if File.exist?(path)
@@ -56,26 +82,41 @@ class SSLCertificates < Component
     end.compact # remove nil entries, will have nil if error ocurred
   end
 
+  # Uses `openssl` to obtain and parse and expiration date for the certificate.
+  #
+  # @param name [String] the name of the SSL certificate
+  # @param path [String] the file path to the SSL certificate
+  #
+  # @return [Array] A pair where the first element is the configured name of
+  #   the SSL certificate, and the second element is the expiration date of
+  #   the certificate.
   def parse_result(name, path)
     cmd_result = `openssl x509 -in #{path} -dates`
     # match indices: 1 - month, 2 - day, 3 - time, 4 - year, 5 - zone
-    exp = /notAfter=([A-Za-z]+) (\d+) ([\d:]+) (\d{4}) ([A-Za-z]+)\n/
+    exp = /notAfter=([A-Za-z]+) +(\d+) +([\d:]+) +(\d{4}) +([A-Za-z]+)\n/
     parsed = cmd_result.match(exp)
 
     if parsed.nil?
-      @errors << ComponentError.new(self, 'Unable to find certificate '\
-                                          'expiration date')
+      @errors << ComponentError.new(self, "Unable to find certificate " \
+                                          "expiration date")
       nil
     else
-      expiry_date = Time.parse([1, 2, 4, 3, 5].map { |n| parsed[n] }.join(' '))
+      expiry_date = Time.parse([1, 2, 4, 3, 5].map { |n| parsed[n] }.join(" "))
       [name, expiry_date]
     end
   rescue ArgumentError
-    @errors << ComponentError.new(self, 'Found expiration date, but unable '\
-                                        'to parse as date')
+    @errors << ComponentError.new(self, "Found expiration date, but unable " \
+                                        "to parse as date")
     [name, Time.now]
   end
 
+  # Maps an expiration date to a symbol representing the expiration status of
+  # an SSL certificate.
+  #
+  # @param expiry_date [Time] the time at which the certificate expires
+  #
+  # @return [Symbol] A symbol representing the expiration status of the
+  #   certificate. Valid values are `:expiring`, `:expired`, and `:valid`.
   def cert_status(expiry_date)
     if (Time.now...Time.now + 30).cover? expiry_date # ... range excludes last
       :expiring
@@ -86,19 +127,22 @@ class SSLCertificates < Component
     end
   end
 
+  # Maps a certificate expiration status to a color that represents it.
   def cert_status_colors
     {
       valid: :green,
       expiring: :yellow,
-      expired: :red
+      expired: :red,
     }
   end
 
+  # Maps a certificate expiration status to a string which can be prefixed to
+  # the expiration date, to aid in explaining when the certificate expires.
   def cert_status_strings
     {
-      valid: 'valid until',
-      expiring: 'expiring at',
-      expired: 'expired at'
+      valid: "valid until",
+      expiring: "expiring at",
+      expired: "expired at",
     }
   end
 end

data/lib/panda_motd/components/uptime.rb

@@ -1,12 +1,18 @@
-require 'sysinfo'
+# frozen_string_literal: true
+
+require "sysinfo"
 
 class Uptime < Component
   attr_reader :days, :hours, :minutes
 
   def initialize(motd)
-    super(motd, 'uptime')
+    super(motd, "uptime")
   end
 
+  # Calculates the number of days, hours, and minutes based on the current
+  # uptime value.
+  #
+  # @see Component#process
   def process
     uptime = SysInfo.new.uptime
 
@@ -15,16 +21,27 @@ class Uptime < Component
     @minutes = ((uptime - @days * 24 - hours) * 60).floor
   end
 
+  # Gets a printable uptime string with a prefix. The prefix can be configured,
+  # and defaults to "up".
   def to_s
-    "#{@config['prefix'] || 'up'} #{format_uptime}"
+    "#{@config["prefix"] || "up"} #{format_uptime}"
   end
 
   private
 
+  # Formats the uptime values in such a way that it is easier to read. If any
+  # of the measurements are zero, that part is omitted. Words are properly
+  # pluralized.
+  #
+  # Examples:
+  #
+  # `3d 20h 55m` becomes `3 days, 20 hours, 55 minutes`
+  #
+  # `3d 0h 55m` becomes `3 days, 55 minutes`
   def format_uptime
     [@days, @hours, @minutes].zip(%w[day hour minute])
                              .reject { |n, _word| n.zero? }
-                             .map { |n, word| "#{n} #{word}#{'s' if n != 1}" }
-                             .join(', ')
+                             .map { |n, word| "#{n} #{word}#{"s" if n != 1}" }
+                             .join(", ")
   end
 end

data/lib/panda_motd/config.rb

@@ -1,11 +1,15 @@
-require 'yaml'
-require 'fileutils'
+# frozen_string_literal: true
+
+require "yaml"
+require "fileutils"
 
 class Config
   attr_reader :file_path
 
+  # @param file_path [String] The file path to look for the configuration file.
+  #   If not provided, the default file path will be used.
   def initialize(file_path = nil)
-    @file_path = file_path || File.join(Dir.home, '.config', 'panda-motd.yaml')
+    @file_path = file_path || File.join(Dir.home, ".config", "panda-motd.yaml")
     unless File.exist?(@file_path)
       create_config(@file_path)
       puts "panda-motd created a default config file at: #{@file_path}"
@@ -13,17 +17,23 @@ class Config
     load_config(@file_path)
   end
 
+  # A list of enabled components' class constants.
   def components_enabled
     # iterate config hash and grab names of enabled components
-    enabled = @config['components'].map { |c, s| c if s['enabled'] }.compact
+    enabled = @config["components"].map { |c, s| c if s["enabled"] }.compact
     # get the class constant
     enabled.map { |e| Config.component_classes[e.to_sym] }
   end
 
+  # Gets the configuration for a component.
+  #
+  # @param component_name [String] the name of the component to fetch the
+  #   configuration for
   def component_config(component_name)
-    @config['components'][component_name.to_s]
+    @config["components"][component_name.to_s]
   end
 
+  # The mapping of component string names to class constants.
   def self.component_classes
     {
       ascii_text_art: ASCIITextArt,
@@ -32,21 +42,28 @@ class Config
       ssl_certificates: SSLCertificates,
       filesystems: Filesystems,
       last_login: LastLogin,
-      fail_2_ban: Fail2Ban
+      fail_2_ban: Fail2Ban,
     }
   end
 
   private
 
+  # Creates a configuration file at a given file path, from the default
+  # configuration file.
+  #
+  # @param file_path [String] the file path at which to create the config
   def create_config(file_path)
     default_config_path = File.join(
-      File.dirname(__dir__), 'panda_motd', 'default_config.yaml'
+      File.dirname(__dir__), "panda_motd", "default_config.yaml"
     )
     FileUtils.cp(default_config_path, file_path)
   end
 
+  # Loads a configuration file.
+  #
+  # @param file_path [String] the file path of the config to load
   def load_config(file_path)
     @config = YAML.safe_load(File.read(file_path))
-    @config['components'] = [] if @config['components'].nil?
+    @config["components"] = [] if @config["components"].nil?
   end
 end

data/lib/panda_motd/motd.rb

@@ -1,14 +1,27 @@
-require 'sysinfo'
+# frozen_string_literal: true
+
+require "sysinfo"
 
 class MOTD
   attr_reader :config, :components
 
+  # Creates an MOTD by parsing the provided config file, and processing each
+  # component.
+  #
+  # @param config_path [String] The path to the configuration file. If not
+  #   provided, the default config path will be used.
+  # @param process [Boolean] whether or not to actually process and evaluate
+  #   the printable results of each component
   def initialize(config_path = nil, process = true)
-    @config = config_path ? Config.new(config_path) : Config.new
+    @config = Config.new(config_path)
     @components = @config.components_enabled.map { |ce| ce.new(self) }
     @components.each(&:process) if process
   end
 
+  # Takes each component on the MOTD and joins them together in a printable
+  # format. It inserts two newlines in between each component, ensuring that
+  # there is one empty line between each. If a component has any errors, the
+  # error will be printed in a clean way.
   def to_s
     @components.map do |c|
       if c.errors.any?

data/lib/panda_motd/version.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
+
 class PandaMOTD
   #:nodoc:
-  VERSION ||= '0.0.11'.freeze
+  VERSION ||= "0.0.12"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: panda-motd
 version: !ruby/object:Gem::Version
-  version: 0.0.11
+  version: 0.0.12
 platform: ruby
 authors:
 - Taylor Thurlow
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-12-31 00:00:00.000000000 Z
+date: 2021-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: artii
@@ -150,6 +150,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -192,6 +206,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rufo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -206,8 +234,22 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: solargraph
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Enhance your MOTD with useful at-a-glance information.
-email: taylorthurlow8@gmail.com
+email: taylorthurlow@me.com
 executables:
 - panda-motd
 extensions: []
@@ -232,7 +274,7 @@ homepage: https://github.com/taylorthurlow/panda-motd
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -240,15 +282,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.6.14.4
+signing_key:
 specification_version: 4
 summary: Make your MOTD prettier, and more useful.
 test_files: []