roebe 0.5.191 → 0.6.3

data/lib/roebe/classes/readme_generator/misc.rb

@@ -1,548 +0,0 @@
-#!/usr/bin/ruby -w
-# Encoding: UTF-8
-# frozen_string_literal: true
-# =========================================================================== #
-# === Roebe::ReadmeGenerator
-#
-# This class can be used to generate a README.md file. Input-templates
-# can also be used, such as README.gen. From such a template file, we
-# can autogenerate a README file.
-#
-# Usage example:
-#
-#   Roebe::ReadmeGenerator.new(ARGV)
-#
-# =========================================================================== #
-# require 'roebe/classes/readme_generator/misc.rb'
-# =========================================================================== #
-require 'roebe/base/base.rb'
-
-module Roebe
-
-class ReadmeGenerator < Base # === Roebe::ReadmeGenerator
-
-  require 'roebe/classes/readme_generator/constants.rb'
-  require 'roebe/classes/readme_generator/initialize.rb'
-  require 'roebe/classes/readme_generator/reset.rb'
-  require 'roebe/classes/readme_generator/run.rb'
-
-  # ========================================================================= #
-  # === main_file?
-  # ========================================================================= #
-  def main_file?
-    NAME_OF_THE_FILE_THAT_IS_AUTOGENERATED
-  end
-
-  # ========================================================================= #
-  # === set_input_gen_file
-  # ========================================================================= #
-  def set_input_gen_file(
-      i = FILE_DOC_README_GEN
-    )
-    i = i.first if i.is_a? Array
-    i = i.to_s.dup
-    if i.empty?
-      i = FILE_DOC_README_GEN
-    end
-    # ======================================================================= #
-    # Next, quickly see whether a file called "README.gen" exists in
-    # the current directory but not at e. g. doc/README.gen. In this
-    # case we will use that file instead.
-    # ======================================================================= #
-    if File.exist?('README.gen') and !File.exist?(i)
-      i = 'README.gen'
-    end
-    @input_gen_file = i
-  end
-
-  # ========================================================================= #
-  # === input_gen_file?
-  # ========================================================================= #
-  def input_gen_file?
-    @input_gen_file
-  end; alias gen_file? input_gen_file? # === gen_file?
-
-  # ========================================================================= #
-  # === try_to_embed_this_file
-  # ========================================================================= #
-  def try_to_embed_this_file(this_file)
-    # ======================================================================= #
-    # Turn it into an absolute path for now.
-    # ======================================================================= #
-    this_file = File.absolute_path(this_file)
-    if File.exist? this_file
-      # ===================================================================== #
-      # Read in the file then.
-      # ===================================================================== #
-      opne "Reading in the content of the file `#{sfile(this_file)}`."
-      add(
-        N+'<pre>'+N+File.read(this_file)+N+'</pre>'+N
-      )
-    else
-      opne "No file called #{sfile(this_file)} exists."
-    end
-  end
-
-  # ========================================================================= #
-  # === add_text_for_the_donate_macro
-  #
-  # This is the text that will be added for the donation-macro in a
-  # README.gen file.
-  # ========================================================================= #
-  def add_text_for_the_donate_macro
-    add('Currently this project does not accept donations, but')
-    add('in the future this may be subject to change, including')
-    add('more information in how folks could support the project,')
-    add('if they would like to.')
-    add
-    add('Of course **documentation**, **patches**, **bug fixes** and so')
-    add('forth are **always** appreciated.')
-  end
-
-  # ========================================================================= #
-  # === open_in_browser
-  # ========================================================================= #
-  def open_in_browser(i)
-    if File.exist?(i) and !(File.size(i) == 0)
-      Open.in_browser(i) if Object.const_defined? :Open
-    else
-      opne "No file exists at `#{sfile(i)}` - or "\
-           "has a file size larger than 0."
-    end
-  end
-
-  # ========================================================================= #
-  # === store_the_string
-  # ========================================================================= #
-  def store_the_string
-    what = @_
-    into = main_file?
-    opne 'Storing the dataset into the file `'+sfile(into)+'`.'
-    write_what_into(what, into)
-  end
-
-  # ========================================================================= #
-  # === return_name_of_the_project
-  #
-  # This method will return the name of the project at hand. Note that
-  # this functionality depends on guessing the directory name, so
-  # we need to have cd-ed to the correct directory prior to making
-  # use of this method here.
-  # ========================================================================= #
-  def return_name_of_the_project
-    File.basename(Dir.pwd)
-  end
-
-  # ========================================================================= #
-  # === try_to_add_the_content_of_this_file
-  #
-  # This method will try to add the file-content of an existing file,
-  # into the newly generated README.md file.
-  # ========================================================================= #
-  def try_to_add_the_content_of_this_file(this_file)
-    if File.exist? this_file
-      # ===================================================================== #
-      # Read in the file then.
-      # ===================================================================== #
-      opne "Reading in the content of the file `#{sfile(this_file)}`."
-      add(File.read(this_file))
-    else
-      e
-      opne crimson("No file called #{sfile(this_file)} exists.")
-      e
-      if is_on_roebe?
-        e 'Please fix the above error first.'
-        # =================================================================== #
-        # And using zenity to fix that, too.
-        # =================================================================== #
-        esystem "zenity --list --column='#{this_file}'"
-      end
-    end
-  end
-
-  # ========================================================================= #
-  # === generate_html_file_via_kramdown
-  # ========================================================================= #
-  def generate_html_file_via_kramdown
-    store_here = '/Depot/Information/foobar.html'
-    if File.exist? main_file?
-      _ = "kramdown #{main_file?} > #{store_here}"
-      esystem _ 
-      if File.exist? store_here
-        open_in_browser(store_here) if @open_in_browser
-      end
-    else
-      opne "No file exists at #{main_file?} - "\
-           "thus, kramdown can not be used."
-    end
-  end
-
-  # ========================================================================= #
-  # === add_string_showing_the_last_updated_programs
-  #
-  # Note that we will modify this String by replacing all
-  # newlines via HTML <br> tags.
-  # ========================================================================= #
-  def add_string_showing_the_last_updated_programs
-    require 'rbt/toplevel_methods/misc.rb'
-    begin
-      add(
-        RBT.return_string_showing_the_last_updated_programs.
-            gsub("\n","<br>\n")
-      )
-    rescue Exception => error
-      pp error
-    end
-    if is_on_roebe?
-      # ===================================================================== #
-      # Also remove the file if it exists.
-      # ===================================================================== #
-      require 'rbt/toplevel_methods/log_directory.rb'
-      this_file = "#{RBT.log_dir?}these_programs_were_updated_copy.yml"
-      if File.exist? this_file
-        remove_file(this_file)
-        this_file = "/home/x/programming/ruby/src/rbt/lib/rbt/yaml/these_programs_were_updated_copy.yml"
-        if File.exist?(this_file)
-          remove_file(this_file)
-        end
-      else
-        e rev+'Can not remove file '+sfile(this_file)+
-          rev+' because it does not exist.'
-      end
-    end
-  end
-
-  # ========================================================================= #
-  # === add                                                         (add tag)
-  # ========================================================================= #
-  def add(i = '')
-    i = i.join(N) if i.is_a? Array
-    @_ << "#{i}#{N}"
-  end
-
-  # ========================================================================= #
-  # === add_badge                                                 (badge tag)
-  #
-  # This will add the two main badges that I usually use in ruby projects.
-  #
-  # The first badge, to the left, is a link to the distribution called
-  # GoboLinux; the second badge, to the right of it, is a link to the
-  # official ruby-lang site.
-  #
-  # Note that since as of August 2019, a third badge will be shown -
-  # the badge that tags the gem-version onto the markdown file. This
-  # badge is special in that we need to attach the name of the project
-  # at hand.
-  # ========================================================================= #
-  def add_badge
-    homepage2 = 'https://www.ruby-lang.org/en/'.dup
-    name_of_the_project = return_name_of_the_project
-    add_gobolinux_badge
-    @_ << "[![forthebadge](https://forthebadge.com/images/badges/made-with-ruby.svg)](#{homepage2})#{N}"
-    # ======================================================================= #
-    # Next add the gem-version to the ruby-project at hand:
-    # ======================================================================= #
-    @_ << '[![Gem Version](https://badge.fury.io/rb/'+name_of_the_project+'.svg)](https://badge.fury.io/rb/'+name_of_the_project+')'+N
-  end; alias add_ruby_badge add_badge # === add_ruby_badge
-
-  # ========================================================================= #
-  # === add_gobolinux_badge
-  # ========================================================================= #
-  def add_gobolinux_badge(
-      homepage = 'https://www.gobolinux.org/'
-    )
-    @_ << "[![forthebadge](https://forthebadge.com/images/badges/built-with-love.svg)](#{homepage})#{N}"
-  end; alias add_gobolinux_logo add_gobolinux_badge # === add_gobolinux_logo
-
-  # ========================================================================= #
-  # === add_environment_information_properly_formatted_array
-  # ========================================================================= #
-  def add_environment_information_properly_formatted_array
-    require 'environment_information/constants/array_tracked_components.rb'
-    EnvironmentInformation::ARRAY_TRACKED_PROGRAMS.each {|entry|
-      @_ << "    #{entry}\n"
-    }
-    @_ << "\n"
-  end
-
-  # ========================================================================= #
-  # === add_time_stamp
-  #
-  # Add information to the README when this gem was last updated.
-  # ========================================================================= #
-  def add_time_stamp
-    add(
-      "\nThis gem was <b>last updated</b> on the "\
-      "<span style=\"color: darkblue; font-weight: bold\">#{dd_mm_yyyy}</span> "\
-      "(dd.mm.yyyy notation), at "\
-      "<span style=\"color: steelblue; font-weight: bold\">#{hh_mm_ss}</span> o'clock."
-    )
-  end
-
-  # ========================================================================= #
-  # === read_dataset_from_gen_file
-  # ========================================================================= #
-  def read_dataset_from_gen_file
-    _ = gen_file?
-    if File.exist? _
-      readlines_with_proper_encoding(_).each {|line|
-        line.chomp!
-        # =================================================================== #
-        # Process each line next.
-        # =================================================================== #
-        case line # case tag
-        # =================================================================== #
-        # === Handle files that begin with MACRO
-        #
-        # Several "aliases" exist to this entry point, such as
-        # INCLUDE_THIS_FILE or EMBED_THIS_FILE.
-        #
-        # Keep in mind that the file at hand should, ideally, exist. :)
-        # =================================================================== #
-        when /^MACRO read_file_as_pre_tag (.+)$/,
-             /^INCLUDE_THIS_FILE (.+)$/,
-             /^EMBED_THIS_FILE (.+)$/,
-             /^READ_AND_DISPLAY_THIS_FILE (.+)$/,
-             /^DISPLAY_THIS_FILE (.+)$/
-          this_file = $1.to_s.dup
-          try_to_embed_this_file(this_file)
-        # =================================================================== #
-        # === Add the default ruby header
-        # =================================================================== #
-        when /^RUBY_BADGE_AND_TIME_STAMP$/i,
-             /^DEFAULT_HEADER$/i
-          add_ruby_badge # <- This method will also invoke the method add_gobolinux_badge().
-          add_time_stamp
-        # =================================================================== #
-        # === ADD_CONTEXTFREE_ART_DISCLAIMER
-        #
-        # This entry point was specifically added in order to be used
-        # for linking to the fine contextfreedesign project (cfdg).
-        # =================================================================== #
-        when /ADD(_|-)?CONTEXTFREE(_|-)?ART(_|-)?DISCLAIMER$/
-          add_contextfree_art_disclaimer
-        # =================================================================== #
-        # === ADD_TIME_STAMP
-        #
-        # Add a time stamp, aka the current time, in combination with a
-        # "This gem was last updated on xyz." notification.
-        # =================================================================== #
-        when /^ADD_TIME_STAMP$/,
-             /^ADD_LAST_UPDATE$/,
-             /^ADD_MAIN_TIMESTAMP$/,
-             /^ADD_LAST_UPDATED_WHEN$/
-          add_time_stamp
-        # =================================================================== #
-        # === LICENCE_IS_MIT
-        # =================================================================== #
-        when /LICENCE_?IS_?MIT/,
-             /USE_?THE_?MIT_?LICENCE/
-          add_licence_is_MIT
-        # =================================================================== #
-        # === ADD_CONTACT_INFORMATION
-        #
-        # Add the default email address in use.
-        # =================================================================== #
-        when /ADD_?CONTACT_?INFORMATION/,
-             /ADD_?CONTACT_?DETAILS/,
-             /ADD_?EMAIL/,
-             /ADD_?MY_?EMAIL/,
-             /CONTACT_?INFORMATION/
-          add_contact_information
-        # =================================================================== #
-        # === ADD_GOBOLINUX_LINK
-        # =================================================================== #
-        when /^ADD_GOBOLINUX_LINK$/,
-             /^GOBOLINUX_IS_AWESOME$/
-          add_gobolinux_badge
-        # =================================================================== #
-        # === ADD_RUBY_LOGO_AND_TIMESTAMP
-        #
-        # This entry point combines two method-calls. This is the correct
-        # combination and order, too.
-        # =================================================================== #
-        when /^ADD_RUBY_LOGO_AND_TIMESTAMP$/,
-             /^MY_MAIN_HEADER$/,
-             /^ADD_DEFAULT_HEADER$/
-          add_badge
-          add_time_stamp
-        # =================================================================== #
-        # === ADD_BADGE
-        #
-        # Add a ruby badge to the autogenerated README.md file.
-        # =================================================================== #
-        when 'ADD_BADGE',
-             'DEFAULT_RUBY_HEADER',
-             'ADD_RUBY_HEADER',
-             'ADD_RUBY_BADGE',
-             /ADD_?RUBY_?BADGES/,
-             /ADD_?GOBOLINUX_?AND_?RUBY_?HEADER/,
-             /ADD_?DEFAULT_?HEADER/,
-             /RUBY_?HEADER/,
-             /ADD_?RUBY_?HEAD/,
-             /GOBOLINUX_?IS_?GREAT/,
-             /ADD(_|-)?MAIN(_|-)?HEADER/i
-          add_badge
-        # =================================================================== #
-        # === This will tap into RBT, to show which programs were last
-        #     updated.
-        # =================================================================== #
-        when /^INSERT_THE_LAST_UPDATED_PROGRAMS_HERE$/
-          add_string_showing_the_last_updated_programs
-        # =================================================================== #
-        # === Handle files that begin with MACRO or INCLUDE_FILE
-        # =================================================================== #
-        when /^MACRO read_file (.+)$/,
-             /^INCLUDE_FILE (.+)$/,
-             /^embed_this_file (.+)$/
-          this_file = $1.to_s.dup
-          try_to_add_the_content_of_this_file(this_file)
-        # =================================================================== #
-        # === Handle the donate-macro next
-        # =================================================================== #
-        when /^DONATE_MACRO$/
-          add_text_for_the_donate_macro
-        # =================================================================== #
-        # === ADD_ENVIRONMENT_INFORMATION_PROPERLY_FORMATTED_ARRAY
-        # =================================================================== #
-        when /^ADD_?ENVIRONMENT_?INFORMATION_?PROPERLY_?FORMATTED_?ARRAY$/i
-          add_environment_information_properly_formatted_array
-        # =================================================================== #
-        # === Handle RBT-specific macros next
-        # =================================================================== #
-        when /^MACRO RBT\.(.+)$/
-          require 'rbt' # In this case, just load the whole RBT project.
-          # ================================================================= #
-          # The next line of code is equivalent to:
-          #   RBT.will_install_which_binaries?
-          # ================================================================= #
-          if RBT.respond_to? $1.to_s.to_sym 
-            result = RBT.send($1.to_s.to_sym)
-            if result.is_a? Array # ← should always be an Array, but still, if check seems fine
-              result = result.map {|entry| entry.prepend('    ') }.join(N)
-            end
-            add(result) # ← Add it here.
-          else
-            e 'RBT does not respond to '+$1.to_s.to_sym.to_s+'().'
-          end
-        else
-          add(line)
-        end
-      }
-    else
-      opne "No file called #{sfile(_)} could be found."
-    end
-  end
-
-  # ========================================================================= #
-  # === add_contextfree_art_disclaimer
-  # ========================================================================= #
-  def add_contextfree_art_disclaimer
-    @_ << "(The <b>above image</b> was <b>partially autogenerated</b> "\
-          "using <b>cfdg rules</b>. See this fine project here for "\
-          "more information pertaining to the <b>autogeneration</b> of "\
-          "such - or similar - images: "\
-          "**https://www.contextfreeart.org/gallery/**)\n"
-  end
-
-  # ========================================================================= #
-  # === add_licence_is_MIT                                          (MIT tag)
-  #
-  # This will add the MIT licence to the readme.
-  # ========================================================================= #
-  def add_licence_is_MIT
-    @_ << "
-## Licence
-
-The licence for this gem is the MIT licence.
-
-Basically the most important part of the MIT licence is that, aside
-from you being able to use the project as you see fit, is the no
-warranty disclaimer to avoid any potential misuse from the use
-of the software at hand.
-
-You can read up on this licence here:
-
-https://opensource.org/licenses/MIT
-
-The usual copyright assignment is:
-
-Copyright #{current_year?} Robert Heiler
-
-"
-  end; alias use_the_mit_licence add_licence_is_MIT # === use_the_mit_licence
-
-  # ========================================================================= #
-  # === add_contact_information
-  # ========================================================================= #
-  def add_contact_information
-    @_ << "
-## Contact information and mandatory 2FA (no longer) coming up in 2022 / 2023
-
-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 the
-explanation here, allow me to just briefly state that I do not feel as if I
-want to promote any Google service anymore when the user becomes the end
-product (such as via data collection by upstream services, including other
-proxy-services). My feeling is that this is a hugely flawed business model
-to begin with, and I no longer wish to support this in any way, even if
-only indirectly so, such as by using services of companies that try to
-promote this flawed model.
-
-In regards to responding to emails: please keep in mind that responding 
-may take some time, depending on the amount of work I may have at that
-moment. So it is not that emails are ignored; it is more that I have not
-(yet) found the time to read and reply. This means there may be a delay
-of days, weeks and in some instances also months. There is, unfortunately,
-not much I can do when I need to prioritise my time investment, but I try
-to consider <b>all</b> feedback as an opportunity to improve my projects
-nonetheless.
-
-In <b>2022</b> rubygems.org decided to make 2FA mandatory for every
-gem owner eventually:
-
-see
-https://blog.rubygems.org/2022/06/13/making-packages-more-secure.html
-
-Mandatory 2FA will eventually be extended to all rubygems.org developers and
-maintainers. As I can not use 2FA, for reasons I will skip explaining here,
-this means that my projects will eventually be removed, as I no longer
-have any control over my projects hosted on rubygems.org (because I
-can not use 2FA).
-
-At that point, I no longer have any control what is done to my projects
-since whoever is controlling the gems ecosystem took away our control
-here. I am not sure at which point ruby became corporate-controlled -
-that was not the case several years ago, so something has
-changed.
-
-Ruby also only allows 2FA users to participate on the issue tracker these
-days:
-
-  https://bugs.ruby-lang.org/issues/18800
-
-But this has been reverted some months ago, so it is no longer applicable.
-Suffice to say that I do not think that we should only be allowed to
-interact on the world wide web when some 'authority' authenticated us,
-such as via mandatory 2FA, so I hope this won't come back again.
-
-Fighting spam is a noble goal, but when it also means you lock out
-real human people then this is definitely NOT a good situation
-to be had.
-
-"
-  end
-
-  # ========================================================================= #
-  # === Roebe::ReadmeGenerator[]
-  # ========================================================================= #
-  def self.[](i = '')
-    new(i)
-  end
-
-end; end

data/lib/roebe/classes/readme_generator/reset.rb

@@ -1,28 +0,0 @@
-#!/usr/bin/ruby -w
-# Encoding: UTF-8
-# frozen_string_literal: true
-# =========================================================================== #
-# require 'roebe/classes/readme_generator/reset.rb'
-# =========================================================================== #
-module Roebe
-
-class ReadmeGenerator < Base # === Roebe::ReadmeGenerator
-
-  # ========================================================================= #
-  # === reset                                                     (reset tag)
-  # ========================================================================= #
-  def reset
-    super()
-    infer_the_namespace
-    try_to_require_the_open_gem
-    # ======================================================================= #
-    # === @open_in_browser
-    # ======================================================================= #
-    @open_in_browser = true
-    # ======================================================================= #
-    # === @_
-    # ======================================================================= #
-    @_ = ''.dup
-  end
-
-end; end

data/lib/roebe/classes/readme_generator/run.rb

@@ -1,20 +0,0 @@
-#!/usr/bin/ruby -w
-# Encoding: UTF-8
-# frozen_string_literal: true
-# =========================================================================== #
-# require 'roebe/classes/readme_generator/run.rb'
-# =========================================================================== #
-module Roebe
-
-class ReadmeGenerator < Base # === Roebe::ReadmeGenerator
-
-  # ========================================================================= #
-  # === run                                                         (run tag)
-  # ========================================================================= #
-  def run
-    read_dataset_from_gen_file
-    store_the_string
-    generate_html_file_via_kramdown
-  end
-
-end; end

data/lib/roebe/shell_scripts/lfs/lfs_variables.sh

@@ -1,31 +0,0 @@
-#!/bin/bash
-# =========================================================================== #
-
-# =========================================================================== #
-# All variables which are commonly used by LFS.
-#
-#   source $ROEBERIA/shell_scripts/lfs/lfs_variables.sh
-#
-# =========================================================================== #
-# source /home/x/programming/ruby/src/roebe/lib/roebe/shell_scripts/lfs/lfs_variables.sh
-# =========================================================================== #
-# export MNT="/mnt"
-export MNT="/mnt"
-export MOUNT="$MNT"
-export LFS="$MOUNT/lfs"
-export DEV="/dev"
-export LFS_PARTITION="$DEV/sdb1" # This setting will define your LFS Partition.
-export LFS_TMP="$LFS/temp"
-export LFS_PROGRAMS="$LFS/home/Programs"
-# export LFS_SOURCES="$LFS/home/x/SRC"
-export LFS_SOURCES="$LFS/sources"
-export LFS_SOURCE="$LFS_SOURCES"
-export LFS_TOOLS="$LFS/tools" #
-export LFS_SWAP="$DEV/sdb2"
-export LFS_TEMP="$LFS/temp"
-export MY_SRC="/home/x/src/"
-
-# =========================================================================== #
-# The next variable has to be manually updated:
-# =========================================================================== #
-export LFS_BACKUP="$LFS/last_backup/"