environment_information 1.4.89

data/lib/environment_information/class/colours.rb

@@ -0,0 +1,283 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'environment_information/class/colours.rb'
+# =========================================================================== #
+require 'environment_information/base/base.rb'
+
+module EnvironmentInformation
+
+class EnvironmentInformation < ::EnvironmentInformation::Base # === EnvironmentInformation::EnvironmentInformation
+
+  require 'environment_information/colours/colours.rb'
+  require 'environment_information/class/constants.rb'
+
+  # ========================================================================= #
+  # === colourize_this_in_the_right_side_colour
+  # ========================================================================= #
+  def colourize_this_in_the_right_side_colour(i)
+    if use_colours?
+      ::Colours.send(::EnvironmentInformation.colour_for_the_right_side, i)
+    else
+      i
+    end
+  end
+
+  # ========================================================================= #
+  # === set_use_colours
+  # ========================================================================= #
+  def set_use_colours(i = '')
+    ::EnvironmentInformation.set_use_colours(true)
+  end
+
+  # ========================================================================= #
+  # === use_colours?
+  # ========================================================================= #
+  def use_colours?
+    ::EnvironmentInformation.use_colours?
+  end
+
+  # ========================================================================= #
+  # === enable_colours
+  # ========================================================================= #
+  def enable_colours
+    ::EnvironmentInformation.use_colours = true
+  end
+
+  # ========================================================================= #
+  # === disable_colours
+  #
+  # Call this method when you wish to disable the colours. Note that
+  # this will disable colours on the toplevel.
+  # ========================================================================= #
+  def disable_colours
+    ::EnvironmentInformation.use_colours = false
+  end; alias no_colours disable_colours # === no_colours()
+
+  # ========================================================================= #
+  # === rev
+  # ========================================================================= #
+  def rev
+    if use_colours?
+      Colours::GREEN
+    else
+      ''
+    end
+  end
+
+  # ========================================================================= #
+  # === true_rev
+  # ========================================================================= #
+  def true_rev
+    if use_colours?
+      Colours::REV
+    else
+      ''
+    end
+  end
+
+  # ========================================================================= #
+  # === col1
+  #
+  # The "first" colour to be used.
+  # ========================================================================= #
+  def col1
+    if use_colours?
+      Colours::BOLD_BLUE
+    else
+      ''
+    end
+  end
+
+  # ========================================================================= #
+  # === cyan
+  # ========================================================================= #
+  def cyan(i = '')
+    if i.empty?
+      Colours::CYAN
+    end if use_colours?
+  end
+
+  # ========================================================================= #
+  # === blue
+  # ========================================================================= #
+  def blue(i = '')
+    if i.empty?
+      Colours::BLUE
+    end if use_colours?
+  end
+
+  # ========================================================================= #
+  # === simp
+  # ========================================================================= #
+  def simp(i)
+    return ::Colours.simp(i) if use_colours?
+    return i
+  end
+
+  # ========================================================================= #
+  # === sfile
+  # ========================================================================= #
+  def sfile(i)
+    return ::Colours.sfile(i) if use_colours?
+    return i
+  end
+
+  # ========================================================================= #
+  # === sfancy
+  # ========================================================================= #
+  def sfancy(i = '')
+    return ::Colours.sfancy(i) if use_colours?
+    return i
+  end
+
+  # ========================================================================= #
+  # === crimson
+  # ========================================================================= #
+  def crimson(i = '')
+    if use_colours? and TRY_TO_USE_HTML_COLOURS
+      i = ::Colours.crimson(i)
+    end
+    return i
+  end
+
+  # ========================================================================= #
+  # === darkgreen
+  # ========================================================================= #
+  def darkgreen(i = '')
+    if use_colours? and TRY_TO_USE_HTML_COLOURS
+      i = ::Colours.darkgreen(i)
+    end
+    return i
+  end
+
+  # ========================================================================= #
+  # === dimgray
+  # ========================================================================= #
+  def dimgray(i = '')
+    if use_colours? and TRY_TO_USE_HTML_COLOURS
+      i = ::Colours.dimgray(i)
+    end
+    return i
+  end
+
+  # ========================================================================= #
+  # === royalblue
+  # ========================================================================= #
+  def royalblue(i = '')
+    if use_colours? and TRY_TO_USE_HTML_COLOURS
+      i = ::Colours.royalblue(i)
+    end
+    return i
+  end
+
+  # ========================================================================= #
+  # === slateblue
+  # ========================================================================= #
+  def slateblue(i = '')
+    if use_colours? and TRY_TO_USE_HTML_COLOURS
+      i = ::Colours.slateblue(i)
+    end
+    return i
+  end
+
+  # ========================================================================= #
+  # === steelblue
+  # ========================================================================= #
+  def steelblue(i = '')
+    if use_colours? and TRY_TO_USE_HTML_COLOURS
+      i = ::Colours.steelblue(i)
+    end
+    return i
+  end
+
+  # ========================================================================= #
+  # === seagreen
+  # ========================================================================= #
+  def seagreen(i = '')
+    if use_colours? and TRY_TO_USE_HTML_COLOURS
+      i = ::Colours.seagreen(i)
+    end
+    return i
+  end
+
+  # ========================================================================= #
+  # === olivedrab
+  #
+  # This one will be used for the right-hand side.
+  # ========================================================================= #
+  def olivedrab(i = '')
+    if use_colours? and TRY_TO_USE_HTML_COLOURS
+      i = ::Colours.olivedrab(i)
+    end
+    return i
+  end
+
+  # ========================================================================= #
+  # === olive
+  # ========================================================================= #
+  def olive(i = '')
+    if use_colours? and TRY_TO_USE_HTML_COLOURS
+      i = ::Colours.olive(i)
+    end
+    return i
+  end
+
+  # ========================================================================= #
+  # === limegreen
+  # ========================================================================= #
+  def limegreen(i = '')
+    if use_colours? and TRY_TO_USE_HTML_COLOURS
+      i = ::Colours.limegreen(i)
+    end
+    return i
+  end
+
+  # ========================================================================= #
+  # === darkolivegreen
+  # ========================================================================= #
+  def darkolivegreen(i = '')
+    if use_colours? and TRY_TO_USE_HTML_COLOURS
+      i = ::Colours.darkolivegreen(i)
+    end
+    return i
+  end
+
+  # ========================================================================= #
+  # === lightgreen
+  # ========================================================================= #
+  def lightgreen(i = '')
+    if use_colours? and TRY_TO_USE_HTML_COLOURS
+      i = ::Colours.lightgreen(i)
+    end
+    return i
+  end
+
+  # ========================================================================= #
+  # === mediumpurple
+  # ========================================================================= #
+  def mediumpurple(i = '')
+    if use_colours? and TRY_TO_USE_HTML_COLOURS
+      i = ::Colours.mediumpurple(i)
+    end
+    return i
+  end
+
+  # ========================================================================= #
+  # === teal
+  # ========================================================================= #
+  def teal(i = '')
+    return ::Colours.teal(i) if use_colours?
+    return i
+  end
+
+  # ========================================================================= #
+  # === orange
+  # ========================================================================= #
+  def orange(i = '')
+    return ::Colours.orange(i) if use_colours?
+    return i
+  end
+
+end; end

data/lib/environment_information/class/constants.rb

@@ -0,0 +1,35 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'environment_information/class/constants.rb'
+# =========================================================================== #
+require 'environment_information/base/base.rb'
+
+module EnvironmentInformation
+
+class EnvironmentInformation < ::EnvironmentInformation::Base # === EnvironmentInformation::EnvironmentInformation
+
+  # ========================================================================= #
+  # === EnvironmentInformation::EnvironmentInformation::THIS_FILE
+  #
+  # THIS_FILE = __FILE__
+  #
+  # We hardcode this since it is only relevant on my home system, anyway.
+  # ========================================================================= #
+  THIS_FILE  =
+    '/home/x/programming/ruby/src/'\
+    'environment_information/lib/environment_information/class/'\
+    'environment_information.rb'
+
+  # ========================================================================= #
+  # === EnvironmentInformation::EnvironmentInformation::TRY_TO_USE_HTML_COLOURS
+  #
+  # If true then we will try to use the konsole-colours, when possible.
+  #
+  # These are part of the colours gem, so this adds a dependency on the
+  # colours gem.
+  # ========================================================================= #
+  TRY_TO_USE_HTML_COLOURS = true
+
+end; end

data/lib/environment_information/class/environment_information.rb

@@ -0,0 +1,51 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === EnvironmentInformation::EnvironmentInformation
+#
+# Usage example:
+#
+#   EnvironmentInformation.new
+#
+# =========================================================================== #
+# require 'environment_information/class/environment_information.rb'
+# =========================================================================== #
+require 'environment_information/base/base.rb'
+
+module EnvironmentInformation
+
+class EnvironmentInformation < ::EnvironmentInformation::Base # === EnvironmentInformation::EnvironmentInformation
+
+  require 'environment_information/class/initialize.rb'
+  require 'environment_information/class/menu.rb'
+  require 'environment_information/class/register_sigint.rb'
+  require 'environment_information/class/reset.rb'
+  require 'environment_information/class/run.rb'
+  require 'environment_information/colours/colours.rb'
+  require 'environment_information/queries/complex_version.rb'
+  require 'environment_information/queries/pkg_config.rb'
+  require 'environment_information/queries/simple_version.rb'
+  require 'environment_information/toplevel_methods/hash.rb'
+  require 'environment_information/toplevel_methods/misc.rb'
+  require 'environment_information/toplevel_methods/return_pkgconfig_based_programs.rb'
+  require 'environment_information/toplevel_methods/return_simple_version_based_programs'
+
+  begin
+    require 'rbt/utility_scripts/report_mate_desktop_version.rb'
+  rescue LoadError; end
+
+end
+
+# =========================================================================== #
+# === EnvironmentInformation.run
+# =========================================================================== #
+def self.run(i = ARGV)
+  ::EnvironmentInformation::EnvironmentInformation.new(i)
+end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  EnvironmentInformation::EnvironmentInformation.new(ARGV)
+end # environment_information.rb

data/lib/environment_information/class/help.rb

@@ -0,0 +1,90 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'environment_information/class/help.rb'
+# =========================================================================== #
+require 'environment_information/base/base.rb'
+
+module EnvironmentInformation
+
+class EnvironmentInformation < ::EnvironmentInformation::Base # === EnvironmentInformation::EnvironmentInformation
+
+  require 'environment_information/requires/require_asciitable.rb'
+
+  # ========================================================================= #
+  # === do_show_help                                               (help tag)
+  #
+  # Show the commandline-usage through this method here.
+  #
+  # To invoke this, try:
+  #
+  #   envi --help
+  #
+  # ========================================================================= #
+  def do_show_help
+    e
+    lpad = "#{col1}    "
+    e "#{rev}The following options are available for "\
+      "#{simp('class EnvironmentInformation:')}#{rev}#{N}#{N}"
+    if ASCIITABLE_IS_AVAILABLE
+      e col1+'    asciitable        '+rev+'# Print in Ascii Table format'
+    end
+    e lpad+'html              '+rev+'# Save the environment information '\
+      'into a .html file'
+    e lpad+'gui               '+rev+'# Start the GTK gui bindings; some '\
+      'aliases are possible such as --GUI'
+    e lpad+'nocolours         '+rev+'# Disable colours '\
+      '(--disable-colours also works)'
+    e lpad+'noruby            '+rev+'# dont show ruby-related environment '\
+      'information'
+    e lpad+'help              '+rev+'# show some help'
+    e lpad+'xorg              '+rev+'# show some xorg-specific '\
+      'components (also --xorg-components)'
+    e lpad+'OS                '+rev+'# show the OS then exit'
+    e lpad+'full              '+rev+'# show full information, including '\
+      'GTK, Glib, Atk and Pango Version'
+    e '                      # ^^^ This is probably the most useful usage.'
+    e lpad+'openssl           '+rev+'# display openssl option'
+    e lpad+'REALLY_ALL        '+rev+'# also compare the program_versions '\
+      '(--really-everything is an alias to this)'
+    e lpad+'save              '+rev+'# display the result, then '\
+      'save it into a file'
+    e lpad+'sinatra           '+rev+'# start the sinatra-interface '\
+      'of the environment_information project'
+    e lpad+'version           '+rev+'# show the version of '\
+      'EnvironmentInformation in use'
+    e lpad+'--show-remote-url '+rev+'# show the remote URLs '\
+      'of a program (requires the RBT project)'
+    e lpad+'padding=value     '+rev+'# set to another padding value'
+    e lpad+'--one-liner       '+rev+'# show everything compacted, without a newline'
+    e lpad+'--nentries?       '+rev+'# feedback how many entries are tracked in total'
+    e rev+N+'The above commands should be commandline arguments, '\
+      'such as: "'+teal('envi full')+rev+'".'
+    e
+    e "#{rev}Do note that you can prefix the above commands via "\
+      "a leading --, of course."
+    e
+    # ======================================================================= #
+    # Show a simple usage example next:
+    # ======================================================================= #
+    e 'Usage example:'
+    e
+    e steelblue(
+        '    envi --version'
+      )
+    e
+    e rev+'If you wish to show only some programs, you could '\
+      'use the following:'
+    e
+    e steelblue(
+        '    envi --use-these-programs=bash,binutils,bison,yacc,bzip2,coreutils,diff,find,gawk,gcc'
+      )
+    e steelblue(
+        '    envi --use-these-programs=:lfs'
+      )
+    e true_rev # Reset via Colours.rev here.
+    do_exit_the_program
+  end; alias show_help do_show_help # === show_help
+
+end; end

data/lib/environment_information/class/html.rb

@@ -0,0 +1,78 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'environment_information/class/html.rb'
+# =========================================================================== #
+require 'environment_information/base/base.rb'
+
+module EnvironmentInformation
+
+class EnvironmentInformation < ::EnvironmentInformation::Base # === EnvironmentInformation::EnvironmentInformation
+
+  require 'environment_information/class/opn.rb'
+  require 'environment_information/toplevel_methods/write_what_into.rb'
+  require 'environment_information/constants/temp_directory.rb'
+
+  # ========================================================================= #
+  # === do_generate_a_html_file                                    (html tag)
+  #
+  # The action-method that will generate the html file. This depends
+  # on the gem html_tags, with module HtmlTags though.
+  #
+  # To invoke this method, do:
+  #
+  #   envi --generate-html-file
+  #
+  # ========================================================================= #
+  def do_generate_a_html_file(
+      styling_instructions = :none
+    )
+    # ======================================================================= #
+    # === Ensure that the html_tags project is available
+    # ======================================================================= #
+    unless Object.const_defined? :HtmlTags
+      begin
+        require 'html_tags'
+      rescue LoadError
+        e 'html_tags is not available. Considering installing it via:'
+        e
+        e '  gem install html_tags'
+        e
+      end
+    end
+    # ======================================================================= #
+    # === Define where to store the .html file in question
+    # ======================================================================= #
+    this_html_file = "#{::EnvironmentInformation.temp_directory?}environment_information.html"
+    # ======================================================================= #
+    # Obtain the main dataset next.
+    # ======================================================================= #
+    what = dataset_as_string
+    case styling_instructions
+    when :bold
+      what = HtmlTags.b(what)
+    end
+    what = HtmlTags.html(
+      HtmlTags.title('Information about the local environment')+
+      HtmlTags.body(
+        HtmlTags.h1(
+          'Your environment',
+          css_style: 'margin-top: 0.5em; margin-bottom: 0.5em; padding: 2px;'
+        )+
+        HtmlTags.pre(
+          what,
+          css_style: 'font-weight: bold; font-size: 2em; padding-left: 1.0em; margin-top:2px;'
+        )
+      )
+    )
+    ::EnvironmentInformation.write_what_into(what, this_html_file)
+    # ======================================================================= #
+    # Notify the user what has been done.
+    # ======================================================================= #
+    if File.exist? this_html_file
+      opnn; e "Generated a HTML file at `#{sfile(this_html_file)}`."
+    end
+  end
+
+end; end