hardware_information 1.0.71

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c1d2ab2b6f90e714e2399478e380e88c43b08faf773bf45d2c391e1851d44d51
+  data.tar.gz: 5722c7a24b466396d4516a7e27bc9333f5679ac64856306b3469ff4cc51c1379
+SHA512:
+  metadata.gz: e4b7ee8f884a7f0a61a9c2434494d2db493bf404cb63c86b7d9bc827665901a3e64f17132d287fd0c5556000aa01c6960a6125f9d1985adb0b31b3476a628516
+  data.tar.gz: 661f01f937f830c54fad8a29d6b10e6528c5aa6be3d70495f13f73897b2b1d6ee51a2d0aa428cc9202f9ea268336c9a85d827c0d45d4a85637c2c6392525741f

data/README.md

@@ -0,0 +1,65 @@
+## Requiring the project
+
+You can require this gem via:
+
+    require 'hardware_information'
+
+## HardwareInformation.report
+
+This toplevel API will report what hardware has been found
+on the given computer system.
+
+## Colour support
+
+By default class HardwareInformation will try to show colours,
+if used from the commandline.
+
+If this is unwanted, you can pass any of the following flags
+to disable colour support:
+
+    --disable-colours
+    --disable-colors
+    --no-colours
+    --no-colors
+
+
+## Contact information and mandatory 2FA coming up in 2022
+
+If your creative mind has ideas and specific suggestions to make this gem
+more useful in general, feel free to drop me an email at any time, via:
+
+    shevy@inbox.lt
+
+Before that email I used an email account at Google gmail, but in **2021** I
+decided to slowly abandon gmail for various reasons. In order to limit this
+explanation here, allow me to just briefly state that I do not feel as if I
+want to promote any Google service anymore, for various reasons.
+
+Do keep in mind that responding to emails may take some time, depending on
+the amount of work I may have at that moment.
+
+In 2022 rubygems.org decided to make 2FA mandatory for every gem owner:
+see https://blog.rubygems.org/2022/06/13/making-packages-more-secure.html
+
+As I can not use 2FA, for reasons I will skip explaining here (see
+various github issue discussions in the past), this effectively means that
+Betty Li and others who run the show at rubygems.org will perma-ban me
+from using rubygems as a developer.
+
+As I disagree with that decision completely, this will mean that all my
+gems will be removed from rubygems.org prior to that sunset date, e. g.
+before they permanently lock me out from the code that I used
+to maintain. It is pointless to want to discuss this with them anymore -
+they have made up their minds and decided that you can only use
+the code if 2FA is in place, even though the code itself works just
+fine. If you don't use 2FA you are effectively locked out from your
+own code; I consider this a malicious attack. See also how they limited
+discussions to people with mandatory 2FA on the ruby-bugtracker, thus
+banning everyone permanently without 2FA:  
+
+https://bugs.ruby-lang.org/issues/18800
+
+Guess it may indeed be time to finally abandon ruby - not because
+ruby is a bad language, but there are people now in charge who
+really should not be part of ruby in the first place.
+

data/bin/hardware_information

@@ -0,0 +1,12 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'hardware_information'
+
+_ = HardwareInformation.new(:do_not_run_yet)
+unless ARGV.empty?
+  _.menu(ARGV)
+end
+_.run
+_.report_result

data/doc/README.gen

@@ -0,0 +1,25 @@
+## Requiring the project
+
+You can require this gem via:
+
+    require 'hardware_information'
+
+## HardwareInformation.report
+
+This toplevel API will report what hardware has been found
+on the given computer system.
+
+## Colour support
+
+By default class HardwareInformation will try to show colours,
+if used from the commandline.
+
+If this is unwanted, you can pass any of the following flags
+to disable colour support:
+
+    --disable-colours
+    --disable-colors
+    --no-colours
+    --no-colors
+
+ADD_CONTACT_INFORMATION

data/hardware_information.gemspec

@@ -0,0 +1,44 @@
+# =========================================================================== #
+# Gemspec for Project HardwareInformation.
+# =========================================================================== #
+require 'hardware_information/version/version.rb'
+require 'roebe'
+
+Gem::Specification.new { |s|
+
+  s.name    = 'hardware_information'
+  s.version = HardwareInformation::VERSION
+  s.date    = Time.now.strftime('%Y-%m-%d')
+  
+  s.summary = <<-EOF
+
+This small class will output Information about your hardware,
+i.e. the Processor type and so on. It is supposed to be 
+a really small gem.
+
+  EOF
+  
+  s.description = <<-EOF
+
+This small class will output Information about your hardware,
+i.e. the Processor type and so on. It is supposed to be 
+a really small gem.
+
+  EOF
+
+  s.authors  = ['Robert A. Heiler']
+  s.email    = Roebe.email?
+  s.files    = Dir['**/*']
+  s.homepage = 'https://rubygems.org/gems/environment_information'
+  s.license  = 'GPL-2.0'
+
+  s.required_ruby_version     = '>= '+Roebe.third_most_stable_version_of_ruby
+  s.required_rubygems_version = '>= '+Gem::VERSION
+  s.rubygems_version          = '>= '+Gem::VERSION
+
+  # ============================================================== #
+  # Dependencies
+  # ============================================================== #
+  s.add_dependency 'colours'
+
+}

data/lib/hardware_information/class/colours.rb

@@ -0,0 +1,82 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+class HardwareInformation
+
+  begin
+    require 'colours'
+    include Colours
+  rescue LoadError; end
+
+  # ========================================================================= #
+  # === green?
+  # ========================================================================= #
+  def green?
+    Colours::GREEN
+  end
+
+  # ========================================================================= #
+  # === bold_teal?
+  # ========================================================================= #
+  def bold_teal?
+    Colours::BOLD_TEAL
+  end
+
+  # ========================================================================= #
+  # === use_colours?
+  # ========================================================================= #
+  def use_colours?
+    @use_colours
+  end
+
+  # ========================================================================= #
+  # === enable_colours
+  # ========================================================================= #
+  def enable_colours
+    @use_colours = true
+  end
+
+  # ========================================================================= #
+  # === disable_colours
+  # ========================================================================= #
+  def disable_colours
+    @use_colours = false
+  end
+
+  # ========================================================================= #
+  # === thistle
+  # ========================================================================= #
+  def thistle(i)
+    return Colours.thistle(i) if use_colours?
+    i
+  end
+
+  # ========================================================================= #
+  # === royalblue
+  # ========================================================================= #
+  def royalblue(i)
+    return Colours.royalblue(i) if use_colours?
+    i
+  end
+
+  # ========================================================================= #
+  # === steelblue
+  # ========================================================================= #
+  def steelblue(i)
+    return Colours.steelblue(i) if use_colours?
+    i
+  end
+
+  # ========================================================================= #
+  # === rev
+  # ========================================================================= #
+  def rev
+    if use_colours?
+      Colours.rev
+    else
+      ''
+    end
+  end
+
+end

data/lib/hardware_information/class/constants.rb

@@ -0,0 +1,145 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'hardware_information/class/constants.rb'
+# =========================================================================== #
+require 'hardware_information/project/project.rb'
+
+class HardwareInformation
+
+  # ========================================================================= #
+  # === N
+  # ========================================================================= #
+  N = "\n"
+
+  # ========================================================================= #
+  # === ERROR_LINE
+  # ========================================================================= #
+  ERROR_LINE = '2>&1'
+
+  # ========================================================================= #
+  # === LEFT_PADDING
+  #
+  # How many characters to pad on the left side. Used for the
+  # header_content() method.
+  # ========================================================================= #
+  LEFT_PADDING = 26
+
+  # ========================================================================= #
+  # === MAIN_DEFAULT_RJUST
+  # ========================================================================= #
+  MAIN_DEFAULT_RJUST = 48
+
+  # ========================================================================= #
+  # === CPUINFO_LOCATION
+  #
+  # This constants stores where cpuinfo is kept. Will work only on
+  # Linux, I think.
+  # ========================================================================= #
+  CPUINFO_LOCATION = '/proc/cpuinfo'
+
+  # ========================================================================= #
+  # === PROC_MEMINFO
+  # ========================================================================= #
+  PROC_MEMINFO = '/proc/meminfo'
+
+  # ========================================================================= #
+  # === FILE_COLOURS_FOR_THE_HARDWARE_PROJECT
+  # ========================================================================= #
+  FILE_COLOURS_FOR_THE_HARDWARE_PROJECT =
+    "#{PROJECT_YAML_DIRECTORY}colours_for_the_hardware_information_project.yml"
+
+  # ========================================================================= #
+  # === HardwareInformation.kb_to_mb(i)
+  # ========================================================================= #
+  def self.kb_to_mb(i)
+    (
+      i.gsub(/ kB/,'').to_i / 1024
+    ).to_s+ ' MB'
+  end
+
+  # ========================================================================= #
+  # === HardwareInformation.is_on_windows?
+  # ========================================================================= #
+  def self.is_on_windows?
+    if RUBY_PLATFORM.include?('win') or # if on windows.
+       RUBY_PLATFORM.include?('mingw')
+      return true
+    end
+    return false
+  end
+
+  # ========================================================================= #
+  # === LSCPU
+  #
+  # The `lscpu` command may fail, which is why it has to be put into
+  # a begin/rescue clause.
+  # ========================================================================= #
+  if is_on_windows?
+    LSCPU = nil
+  else
+    begin
+      LSCPU = `lscpu`.split("\n")
+    rescue Errno::ENOENT
+      puts 'No binary called lscpu could be found.'
+    end
+  end
+
+  # ========================================================================= #
+  # === CPUINFO
+  #
+  # We must first check whether the target location actually does happen
+  # to exist.
+  # ========================================================================= #
+  _ = CPUINFO_LOCATION
+  if File.exist? _
+    CPUINFO = File.read(_)
+  else
+    CPUINFO = nil
+  end
+
+  # ========================================================================= #
+  # === SPLITTED_CPUINFO
+  # ========================================================================= #
+  if CPUINFO
+    SPLITTED_CPUINFO = CPUINFO.split(N)
+    begin
+      LSPCI = `lspci`
+    rescue # Must rescue here because lspci might not be available.
+      LSPCI = nil
+    end
+  end
+
+  # ========================================================================= #
+  # === DATASET_FROM_PROC_MEMINFO
+  # ========================================================================= #
+  if File.exist? PROC_MEMINFO
+    DATASET_FROM_PROC_MEMINFO = File.readlines(PROC_MEMINFO)
+    _ = DATASET_FROM_PROC_MEMINFO.select {|entry|
+      entry.include? 'MemTotal'
+    }.first.strip.split(':').last.strip
+    # ======================================================================= #
+    # We discard all but the gigs for RAM.
+    # ======================================================================= #
+    _ = (_.gsub(/ kB/,'').to_i / 1024).to_s+ ' MB'
+  else
+    DATASET_FROM_PROC_MEMINFO = nil
+  end
+
+  # ========================================================================= #
+  # === RAM_AVAILABLE
+  # ========================================================================= #
+  RAM_AVAILABLE = _
+
+  if DATASET_FROM_PROC_MEMINFO
+    _ = DATASET_FROM_PROC_MEMINFO.select {|entry|
+        entry.include? 'MemFree'
+      }.first.strip.split(':').last.strip #.gsub(/ kB/,'').to_i / 1024).to_s+ ' MB'
+    # ======================================================================= #
+    # === RAM_AVAILABLE_FREE
+    # ======================================================================= #
+    RAM_AVAILABLE_FREE = kb_to_mb(_)
+  end
+
+end

data/lib/hardware_information/class/hardware_information.rb

@@ -0,0 +1,32 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === HardwareInformation
+#
+# This class will show some information about the local computer system,
+# e. g. hardware information, via colours.
+# =========================================================================== #
+# require 'hardware_information'
+# =========================================================================== #
+require 'hardware_information/version/version.rb'
+require 'hardware_information/class/colours.rb'
+require 'hardware_information/class/constants.rb'
+require 'hardware_information/class/initialize.rb'
+require 'hardware_information/class/make_line.rb'
+require 'hardware_information/class/menu.rb'
+require 'hardware_information/class/misc.rb'
+require 'hardware_information/class/obtain.rb'
+require 'hardware_information/class/reset.rb'
+require 'hardware_information/class/run.rb'
+
+class HardwareInformation # === HardwareInformation
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  _ = HardwareInformation.new(false)
+  # _.disable_colours
+  _.run
+  _.report_result
+end # hardi

data/lib/hardware_information/class/initialize.rb

@@ -0,0 +1,24 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+class HardwareInformation
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      run_already = true
+    )
+    reset
+    case run_already
+    when :do_not_run_yet
+      run_already = false
+    end
+    set_run_already(
+      run_already
+    )
+    run if run_already
+  end
+
+end

data/lib/hardware_information/class/make_line.rb

@@ -0,0 +1,55 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+class HardwareInformation
+
+  # ========================================================================= #
+  # === make_line
+  #
+  # The first argument to this method should be the title that will
+  # be displayed.
+  #
+  # The second argument should show the content towards that argument.
+  # ========================================================================= #
+  def make_line(
+      title, content
+    )
+    title = title.dup if title.frozen?
+    use_this_colour_for_change = bold_teal?
+    use_this_colour_to_revert  = @default_colour # First a copy.
+    title << ': ' if @use_colon_as_delimiter
+    title   = default_ljust(title)
+    content = default_rjust(content)
+    # ======================================================================= #
+    # === Handle blocks next
+    #
+    # The passed block can modify the variable called content. This
+    # will happen after the various padding-operations above.
+    # ======================================================================= #
+    if block_given?
+      yielded = yield
+      case yielded
+      when nil
+        # Pas through.
+      else # Else, use colours.
+        if use_colours?
+          content = Colours.send(yielded, content)
+        end
+      end
+    end
+    string = ''.dup
+    string << use_this_colour_for_change if use_colours?
+    string << title
+    string << use_this_colour_to_revert if use_colours?
+    string = string.ljust(40)
+    if content.is_a? Array
+      _ string
+      content.each {|line| _ "    #{line}" }
+    else
+      string << content
+      _ string
+    end
+  end
+
+end

data/lib/hardware_information/class/menu.rb

@@ -0,0 +1,52 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'hardware_information/class/menu.rb'
+# =========================================================================== #
+class HardwareInformation # === HardwareInformation
+
+  # ========================================================================= #
+  # === start_the_sinatra_interface
+  #
+  # To invoke this method, do:
+  #
+  #   hardi --sinatra
+  #
+  # ========================================================================= #
+  def start_the_sinatra_interface
+    require 'hardware_information/www/my_hardware_for_sinatra.rb'
+    HardwareInformation::SinatraMyHardware.start_sinatra_interface
+  end
+
+  # ========================================================================= #
+  # === menu                                                       (menu tag)
+  #
+  # Commandline-arguments, e. g. ARGV, will be passed into this menu
+  # interface.
+  # ========================================================================= #
+  def menu(
+      i = nil
+    )
+    if i
+      if i.is_a? Array
+        i.each {|entry| menu(entry) }
+      else
+        case i # case tag
+        # =================================================================== #
+        # === hardi --sinatra
+        # =================================================================== #
+        when /^-?-?sinatra$/
+          start_the_sinatra_interface
+        # =================================================================== #
+        # === hardi --disable-colours
+        # =================================================================== #
+        when /^-?-?disable(-|_)?colou?rs$/,
+             /^-?-?no(-|_)?colou?rs$/
+          disable_colours
+        end
+      end
+    end
+  end
+
+end