colours 0.8.12

data/lib/colours/testing/testing.rb

@@ -0,0 +1,168 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# Add the test() method to the Colours module here.
+# =========================================================================== #
+# require 'colours/testing/testing.rb'
+# =========================================================================== #
+module Colours
+
+  require 'colours/toplevel_methods/e.rb'
+  require 'colours/toplevel_methods/show_basic_colour_palette.rb'
+  require 'colours/toplevel_methods/make_colour.rb'
+  require 'colours/colour_table/colour_table.rb'
+
+  # ========================================================================= #
+  # === Colours.simple_colours_test
+  #
+  # This method purposely tests only the basic parts for colours-related
+  # output onto the terminal.
+  # ========================================================================= #
+  def self.simple_colours_test
+    show_basic_colour_palette
+  end
+
+  # ========================================================================= #
+  # === Colours.test
+  #
+  # This class-method can be used to test the Colours module.
+  #
+  # It will be called from the test.rb file, in order to test all components
+  # of the Colours module.
+  #
+  # To invoke it, do:
+  #
+  #   Colours.test
+  #
+  # ========================================================================= #
+  def self.test
+    require 'colours/basic_colours/basic_colours.rb'
+    require 'colours/colour_table/colour_table.rb'
+    cliner
+    show_basic_colour_palette
+    cliner
+    e red('Hello ')+cyan('World!')
+    e 'Hi '+Colours.red+'there.'+rev
+    e 'Hi '+Colours.cyan+'there.'+rev
+    e 'Hi '+Colours::BasicColours.bold_white+'there.'+rev
+    e 'Hi '+Colours.pink+'there.'+rev
+    e 'Hi '+Colours.brown+'there.'+rev
+    cliner
+    e CYAN+'Hi there.'
+    e BWHITE+'Hi there.'+BBLUE+' Yo there.'+rev
+    e sfancy('yo')+simp(' there')
+    disable_colours(true)
+    e sfancy('yo')+simp(' there')
+    enable_colours(true)
+    e sfancy('yo')+simp(' there')
+    e rgb_to_hex('155255255')
+    e col '/Depot/Audio'
+    e col '/Depot/Audio/Westbam_Sunshine.mp3'
+    e rev+'This is '+simp('elegant => simportant()')+'.'
+    e rev+'This is '+sfancy('elegant => sfancy()')+'.'
+    e rev+'This is '+sdir('elegant => sdir()')+'.'
+    e rev+'This is '+sfile('elegant => sfancy()')+'.'
+    e rev+'This is '+swarn('elegant => swarn()')+'.'
+    e rev+'This is '+ssym('elegant => ssym()')+'.'
+    ecomment 'An this # could be a comment.'
+    e
+    e 'Changing colour codes now. We should see different colours '+
+      'when compared to the above.'
+    e
+    ::Colours.update_the_colour_codes_with
+    e rev+'This is '+simportant('elegant => simportant()')+'.'
+    e rev+'This is '+sfancy('elegant => sfancy()')+'.'
+    e rev+'This is '+sdir('elegant => sdir()')+'.'
+    e rev+'This is '+sfile('elegant => sfancy()')+'.'
+    e rev+'This is '+swarn('elegant => swarn()')+'.'
+    e rev+'This is '+ssym('elegant => ssym()')+'.'
+    e 'Do we use colours? '+use_colours?.to_s
+    e cyan+' ==> Hi there.'
+    e red+' ==> Hi there.'
+    e green+' ==> Hi there.'
+    e brown+' ==> Hi there.'
+    e blue+' ==> Hi there.'
+    e teal+' ==> Hi there.'
+    e white+' ==> Hi there.'
+    e grey+' ==> Hi there.'
+    e lightblue+' ==> Hi there.'+red()+' yo'
+    e RED+'This is red galore.'
+    e 'right?'+::Colours.rev
+    e BLUE+'This is blue now.'
+    e 'right?'+rev
+    e 'Hi there - this should be white.'
+    # html_colours?
+    p main_colours
+    main_colours.each {|entry|
+      send(entry, 'test')
+    }
+    e 'yo this should '+pink('be pink.')
+    puts CFANCY+' Hi there.'
+    puts CIMPORTANT+' Hi there.'
+    # Next, we will disable the colours.
+    disable_colours(true)
+    # The following ones have a newline.
+    e rev+'This is '+simportant('elegant => simportant().',true)
+    e rev+'This is '+sfancy('elegant => sfancy().',true)
+    e rev+'This is '+sdir('elegant => sdir().',true)
+    e rev+'This is '+sfile('elegant => sfancy().',true)
+    ::Colours.enable_colours(true)
+    e rev+'This is '+simportant('elegant => simportant()')+'.'
+    e rev+'This is '+sfancy('elegant => sfancy()')+'.'
+    e rev+'This is '+sdir('elegant => sdir()')+'.'
+    e rev+'This is '+sfile('elegant => sfancy()')+'.'; e
+    e 'Next, trying to underline:'
+    underline 'Hi there'
+    e 'Next trying eparse:'
+    eparse 'Joe: Hey Tim, how do you do?'
+    eparse 'Tim: Really fine. How about you?'
+    eparse '   Joe: ok man let us proceed'
+    eparse '  [name of character here] # show when this character last logged in'
+    e
+    e 'Next some tests with col():'
+    e
+    e '  '+col('/Depot/Audio/AVAILABLE_SONGS').to_s
+    e '  '+col('/Depot/Audio').to_s
+    e
+    cliner
+    e 'Now testing Colours.red("foobar"):'
+    e red('foobar')
+    e 'Next, we test Colours.enable() and Colours.disable()'
+    disable
+    e 'Colours.disable()'
+    e rev+'This is '+simportant('elegant => simportant()')+'.'
+    e 'Colours.enable()'
+    enable
+    e rev+'This is '+simportant('elegant => simportant()')+'.'
+    e rev+'The colour for symlinks is: '+simportant('Colours.colour_for_symlinks')
+    pp colour_for_symlinks
+    e rev+'A classical Hello World! example, and the colour-code for it.'
+    efancy 'Hello World!'
+    pp sfancy('Hello World!')
+    e 'Next removing some escape sequences:'
+    e
+    e remove_escape_sequences("  \e[1;31mhello world\e[0;0m # <-- "+
+      "This here is not coloured and it also does not have "+
+      "escape-sequences either.")
+    e
+    e 'Next testing whether Colours.yellow() works:'
+    e
+    e "  hello #{Colours.yellow('world!')}#{rev}"
+    e
+    e 'Next testing Colours.eparse():'
+    e
+    eparse '  hello # world!'
+    e
+    e 'Next testing Colours.ecomment():'
+    e
+    ecomment '  hello # world!'
+    e
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  include Colours
+  ::Colours.test
+end # Colours.test

data/lib/colours/toplevel_methods/autogenerate.rb

@@ -0,0 +1,310 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# This file contains code that can be used to autogenerate ruby code,
+# and store this into a .rb file. That functionality is mostly useful
+# on my home system, though.
+# =========================================================================== #
+# require 'colours/toplevel_methods/autogenerate.rb'
+# =========================================================================== #
+module Colours
+
+  require 'yaml'
+  require 'colours/constants/newline.rb'
+  require 'colours/constants/file_constants.rb'
+  require 'colours/toplevel_methods/is_on_roebe.rb'
+  require 'colours/256_colours/support_for_256_colours.rb'
+  require 'colours/html_colours/html_colours.rb'
+
+  # ========================================================================= #
+  # === GENERIC_RUBY_HEADER
+  # ========================================================================= #
+  GENERIC_RUBY_HEADER = "#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #"
+
+  # ========================================================================= #
+  # === Colours.autogenerate_the_module_for_the_html_colours
+  #
+  # This method will autogenerate the module that will support
+  # the html colours.
+  # ========================================================================= #
+  def self.autogenerate_the_module_for_the_html_colours(
+      into = HOME_DIRECTORY_OF_USER_X+'programming/ruby/src/'\
+             'colours/lib/colours/autogenerated/support_for_html_colours.rb'
+    )
+    _ = ''.dup
+    _ << GENERIC_RUBY_HEADER+"
+# require 'colours/autogenerated/support_for_html_colours.rb'
+# =========================================================================== #
+"
+    _ << "module Colours\n\n"
+    _ << "module SupportForHTMLColours # include Colours::SupportForHTMLColours\n\n".dup
+    _ << "  require 'colours/toplevel_methods/html_colourize.rb'\n"
+    _ << "  require 'colours/toplevel_methods/use_colours.rb'\n\n"
+    comment_line = '  # '+('='*73)+' #'+N
+    available_html_colours?.each {|name_of_the_html_colour|
+      _ << comment_line
+      _ << '  # === Colours::SupportForHTMLColours.'+name_of_the_html_colour+N
+      _ << comment_line
+      _ << "  def self.#{name_of_the_html_colour}(i = '', &block)\n"
+      _ << "    if ::Colours.use_html_colours?\n"
+      _ << "      return ::Colours.html_colourize(__method__, i, &block)\n"
+      _ << "    else\n"
+      _ << "      return i\n"
+      _ << "    end\n"
+      _ << "  end; def #{name_of_the_html_colour}(i = '', &block); SupportForHTMLColours.#{name_of_the_html_colour}(i, &block); end#{N}"
+      # ===================================================================== #
+      # Next, due to several reasons, we add a prepended "konsole_colour_"
+      # as name to this method.
+      # ===================================================================== #
+      _ << "       def konsole_colour_#{name_of_the_html_colour}(i = '', &block); SupportForHTMLColours.#{name_of_the_html_colour}(i, &block); end#{N}#{N}"
+    }
+    _ << 'end; end'
+    what = _
+    # ======================================================================= #
+    # This is only useful on my home system really:
+    # ======================================================================= #
+    puts 'Storing into:'
+    puts
+    puts '  '+into
+    puts
+    require 'save_file'
+    SaveFile.write_what_into(what, into)
+  end
+
+  # ========================================================================= #
+  # === Colours.autogenerate_toplevel_basic_colour_methods
+  #
+  # The code in this method will autogenerate the toplevel colour
+  # methods, such as Colours.yellow().
+  #
+  # The code needs to respect several settings. For example, whether colours
+  # are used or not. Additionally, for methods such as Colours.yellow(),
+  # we need to find out whether we use the basic colours, the 256-colours or
+  # the HTML colours, and call the corresponding method in these cases.
+  # ========================================================================= # 
+  def self.autogenerate_toplevel_basic_colour_methods(
+      into = HOME_DIRECTORY_OF_USER_X+'programming/ruby/src/'\
+             'colours/lib/colours/autogenerated/'\
+             'toplevel_basic_colour_methods.rb'
+    )
+    comment_line = "  # ======================================================================== \n"
+    store_this_string = ''.dup
+    header = <<-EOF
+#{GENERIC_RUBY_HEADER}
+# This file contains the code that will call the corresponding colour method
+# depending on which colour-mode the user prefers.
+# =========================================================================== #
+# require 'colours/autogenerated/toplevel_basic_colour_methods.rb'
+# =========================================================================== #
+module Colours
+
+require 'colours/toplevel_methods/use_colours.rb'
+require 'colours/basic_colours/basic_colours.rb'
+require 'colours/256_colours/support_for_256_colours.rb'
+require 'colours/autogenerated/support_for_html_colours.rb'
+require 'colours/html_colours/html_colours.rb'
+
+module AllColourMethods # include Colours::AllColourMethods
+
+EOF
+
+    store_this_string << header
+    # ======================================================================= #
+    # First define the methods for the basic colours:
+    # ======================================================================= #
+    array = return_a_unique_array_containing_all_available_colours
+    array.each {|this_basic_colour| # <- e. g. "yellow".
+      this_basic_colour = this_basic_colour.dup
+      if this_basic_colour.include?(' ') and
+         array.include?(this_basic_colour.delete(' '))
+        # =================================================================== #
+        # === This must be an alias
+        #
+        # In this case we will also add an alias containing the '_' part.
+        # We will only add this as an alias for include-actions, though.
+        # (This may change at a later point in the future - not sure yet.)
+        # =================================================================== #
+        store_this_string << "       def #{this_basic_colour.tr(' ','_')}(i = ARGV)
+         if i.is_a? Array
+           i = i.join(' ').strip
+         end
+         AllColourMethods.#{this_basic_colour.delete(' ')}(i)
+       end\n\n"
+      else
+        name_of_the_method = this_basic_colour.downcase.delete(' ').dup
+        store_this_string << comment_line
+        store_this_string << "  # === Colours::AllColourMethods.#{name_of_the_method}\n"
+        store_this_string << comment_line
+        store_this_string << "  def self.#{name_of_the_method}(i = '', &block)\n"
+        store_this_string << "    if ::Colours.use_colours?\n"
+        # =================================================================== #
+        # Ok, so we determine what to do with this colour-method:
+        # =================================================================== #
+        store_this_string << "      if ::Colours.is_this_a_html_colour?(__method__)\n"
+        store_this_string << "        return ::Colours::SupportForHTMLColours.#{name_of_the_method}(i, &block)\n"
+        store_this_string << "      elsif ::Colours.is_this_a_256_colour?(__method__)\n"
+        store_this_string << "        return ::Colours::SupportFor256Colours.#{name_of_the_method}(i, &block)\n"
+        store_this_string << "      else\n"
+        store_this_string << "        return ::Colours::BasicColours.#{name_of_the_method}(i, &block)\n"
+        store_this_string << "      end\n"
+        store_this_string << "    else\n"
+        store_this_string << "      return i\n"
+        store_this_string << "    end\n"
+        store_this_string << "  end; def #{name_of_the_method}(i = '', &block); AllColourMethods.#{name_of_the_method}(i, &block); end\n"
+        # =================================================================== #
+        # Next, due to several reasons, we add a prepended "konsole_colour_"
+        # as name to this method.
+        # =================================================================== #
+        store_this_string << "       def konsole_colour_#{name_of_the_method}(i = ''); AllColourMethods.#{name_of_the_method}(i); end\n"
+        store_this_string << "       def konsole_#{name_of_the_method}(i = ''); AllColourMethods.#{name_of_the_method}(i); end\n"
+        store_this_string << "       self.instance_eval { alias konsole_colour_#{name_of_the_method} #{name_of_the_method} } # === Colours::AllColourMethods.konsole_colour_#{name_of_the_method}\n"
+        # =================================================================== #
+        # The next line adds something like: Colours.egreen(), as a method.
+        # =================================================================== #
+        store_this_string << "       def Colours.e#{name_of_the_method}(i = ARGV); i = i.join(' ') if i.is_a? Array; puts AllColourMethods.#{name_of_the_method}(i); end\n"
+        store_this_string << "       def e#{name_of_the_method}(i = ''); puts AllColourMethods.#{name_of_the_method}(i); end\n"
+        store_this_string << "       alias ekonsole_colour_#{name_of_the_method} e#{name_of_the_method}\n"
+        store_this_string << "\n"
+      end
+    }
+    store_this_string << "end; end\n"
+    what = store_this_string .dup
+    # ======================================================================= #
+    # This is only useful on my home system really:
+    # ======================================================================= #
+    puts 'Storing into the file:'
+    puts
+    puts "  #{into}"
+    puts
+    File.delete(into) if File.exist? into # Get rid of the old file.
+    begin
+      require 'save_file'
+      SaveFile.write_what_into(what, into)
+    rescue LoadError
+      puts 'save_file gem is not available/installed.'
+    end
+  end; self.instance_eval { alias define_colour_methods autogenerate_toplevel_basic_colour_methods } # === Colours.define_colour_methods
+
+  # ========================================================================= #
+  # === Colours.autogenerate_the_module_for_the_256_colours
+  #
+  # This method will autogenerate the module that will support
+  # the 256 colours.
+  # ========================================================================= #
+  def self.autogenerate_the_module_for_the_256_colours
+    _ = ''.dup
+    _ << GENERIC_RUBY_HEADER+"
+# require 'colours/autogenerated/support_for_256_colours.rb'
+# =========================================================================== #
+"
+    _ << "module Colours\n\n"
+    _ << "module SupportFor256Colours # include Colours::SupportFor256Colours\n\n".dup
+    _ << "  require 'colours/256_colours/support_for_256_colours.rb'\n\n"
+    comment_line = '  # '+('='*73)+' #'+N
+    @dataset_for_the_256_colours.each {|name_of_the_colour, id|
+      use_this_name = name_of_the_colour.downcase
+      _ << comment_line
+      _ << '  # === Colours::SupportFor256Colours.'+use_this_name+N
+      _ << comment_line
+      _ << "  def self.#{use_this_name}(i = '')#{N}"
+      _ << "    if Colours.use_colours?\n"
+      _ << "      return Colours.return_this_256_colour(__method__, i)\n"
+      _ << "    else\n"
+      _ << "      return i\n"
+      _ << "    end\n"
+      _ << "  end; def #{use_this_name}(i = ''); SupportFor256Colours.#{use_this_name}(i); end#{N}#{N}"
+    }
+    _ << 'end; end'
+    what = _
+    # ======================================================================= #
+    # This is only useful on my home system really:
+    # ======================================================================= #
+    into = HOME_DIRECTORY_OF_USER_X+'programming/ruby/src/'\
+           'colours/lib/colours/autogenerated/support_for_256_colours.rb'
+    puts 'Storing into:'
+    puts
+    puts '  '+into
+    puts
+    require 'save_file'
+    SaveFile.write_what_into(what, into)
+  end
+
+  require 'colours/toplevel_methods/html_colourize.rb'
+  # ========================================================================= #
+  # === Colours.generate_shell_file_containing_the_html_colours
+  #
+  # This method will generate a shell file into the current directory
+  # by default.
+  #
+  # The code in that file will generate a shell script that holds all
+  # the HTML-colours, via UPCASED names.
+  #
+  # These entries will then look like this:
+  #
+  #   SADDLEBROWN:  "\e[38;2;139;69;19m"
+  #   PERU:         "\e[38;2;205;133;63m"
+  #   CHOCOLATE:    "\e[38;2;210;105;30m"
+  #
+  # ========================================================================= #
+  def self.generate_shell_file_containing_the_html_colours(
+      generate_the_shell_file_into_this_directory = Dir.pwd
+    )
+    require 'save_file/module'
+    unless generate_the_shell_file_into_this_directory.end_with? '/'
+      if generate_the_shell_file_into_this_directory.frozen?
+        generate_the_shell_file_into_this_directory = generate_the_shell_file_into_this_directory.dup
+      end
+      generate_the_shell_file_into_this_directory << '/'
+    end
+    result = ''.dup
+    result << "# This is a shell file that contains the HTML colours\n"
+    available_html_colours?.each {|this_colour|
+      colour_code_to_use = ::Colours.html_colourize(this_colour.to_sym,'',false).inspect
+      result << "export #{this_colour.upcase}=#{colour_code_to_use}\n"
+    }
+    generate_the_shell_file_into_this_directory << 'shell_file_containing_the_html_colours.sh'
+    into = generate_the_shell_file_into_this_directory
+    e "Now creating a shell file at `#{into}`."
+    SaveFile.write_what_into(result, into)
+    # ======================================================================= #
+    # Generate files on my home system as well:
+    # ======================================================================= #
+    if is_on_roebe?
+      into = '/home/x/programming/ruby/src/'\
+             'roebe/lib/roebe/shell_scripts/'+
+             File.basename(generate_the_shell_file_into_this_directory)
+      puts "And also saving into `#{into}`."
+      SaveFile.write_what_into(result, into)
+    end
+  end; self.instance_eval { alias autogenerate_shell_file_containing_the_html_colours generate_shell_file_containing_the_html_colours } # === Colours.autogenerate_shell_file_containing_the_html_colours
+
+  # ========================================================================= #
+  # === Colours.return_a_unique_array_containing_all_available_colours
+  # ========================================================================= #
+  def self.return_a_unique_array_containing_all_available_colours
+    array = []
+    array << YAML.load_file(FILE_HTML_COLOURS).keys                # (1) First the HTML colours
+    array << YAML.load_file(FILE_256_COLOURS).keys.map(&:downcase) # (2) Then the basic colours
+    array << YAML.load_file(FILE_BASIC_COLOURS)                    # (3) And finally the basic colours
+    array.flatten!
+    array.uniq!
+    array.map!(&:strip)
+    array.sort
+  end; self.instance_eval { alias all_available_colour_methods? return_a_unique_array_containing_all_available_colours } # === Colours.all_available_colour_methods?
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  alias e puts
+  e
+  # pp Colours.return_a_unique_array_containing_all_available_colours
+  # e
+  Colours.autogenerate_the_module_for_the_html_colours
+  Colours.autogenerate_shell_file_containing_the_html_colours
+  Colours.autogenerate_the_module_for_the_256_colours
+  Colours.autogenerate_toplevel_basic_colour_methods
+end # autogeneratecolours

data/lib/colours/toplevel_methods/bold.rb

@@ -0,0 +1,41 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'colours/toplevel_methods/bold.rb'
+# Colours.bold
+# =========================================================================== #
+module Colours
+
+  require 'colours/toplevel_methods/revert.rb'
+
+  # ========================================================================= #
+  # === Colours.bold
+  #
+  # ANSI colour escape code for bold is "1".
+  #
+  # The method has to call Colours.rev() at the end, because that way
+  # downstream users can modify the default rev-colour in use.
+  #
+  # Usage example:
+  #
+  #   puts ' ok | '+Colours.bold('Hello world!')+' | ok'
+  #
+  # ========================================================================= #
+  def self.bold(
+      show_this_text = 'This must be bold.'
+    )
+    return "\x1b[1m#{show_this_text}#{::Colours.rev}"
+  end; self.instance_eval { alias return_bold bold } # === Colours.return_bold
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  alias e puts
+  if ARGV.empty?
+    e Colours.bold('Hello world!')
+    e 'Hello world!'
+  else
+    e Colours.bold(ARGV.join(' ').strip)
+  end
+end # colours_bold hello there how do you do

data/lib/colours/toplevel_methods/bold_and_italic.rb

@@ -0,0 +1,38 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'colours/toplevel_methods/bold_and_italic.rb'
+# =========================================================================== #
+module Colours
+
+  require 'colours/toplevel_methods/bold.rb'
+  require 'colours/toplevel_methods/italic.rb'
+  require 'colours/toplevel_methods/revert.rb'
+
+  # ========================================================================= #
+  # === Colours.bold_and_italic
+  #
+  # Usage example:
+  #
+  #   puts Colours.bold_and_italic 'Hello world!'
+  #
+  # ========================================================================= #
+  def self.bold_and_italic(
+      i = 'This must be bold.'
+    )
+    if i.is_a? Array
+      i = i.join(' ')
+    end
+    italic(bold(i))
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  if ARGV.empty?
+    puts Colours.bold_and_italic('Hello world!')+' All is fine.'
+  else
+    puts Colours.bold_and_italic(ARGV)
+  end
+end # boldanditalic yo there yoda

data/lib/colours/toplevel_methods/cat.rb

@@ -0,0 +1,39 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'colours/toplevel_methods/cat.rb'
+# =========================================================================== #
+module Colours
+
+  require 'colours/rainbow_colours/print_rainbow_line.rb'
+
+  # ========================================================================= #
+  # === Colours.cat
+  #
+  # The first argument may be ARGF. It ought to respond to .each anyway.
+  #
+  # Note that .cat() will delegate towards print_line().
+  # ========================================================================= #
+  def self.cat(
+      file_descriptor, hash_options = {}
+    )
+    print "\e[?25l" if hash_options[:animate] # Print this if we animate (enabling psychedelics).
+    # ======================================================================= #
+    # Iterate over the file_descriptor passed.
+    # ======================================================================= #
+    file_descriptor.each { |line|
+      hash_options[:os] += 1 # Increase the output-count.
+      # ===================================================================== #
+      # Next, colourize the line. This depends on the method called
+      # print_rainbow_line().
+      # ===================================================================== #
+      RainbowColours.print_rainbow_line(
+        line, hash_options
+      ) # Delegate towards print_line.
+    }
+  ensure
+    print "\e[?25h" if hash_options[:animate]
+  end
+
+end

data/lib/colours/toplevel_methods/clear_screen.rb

@@ -0,0 +1,18 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'colours/toplevel_methods/clear_screen.rb'
+# =========================================================================== #
+module Colours
+
+  # ========================================================================= #
+  # === Colours.clear_screen
+  #
+  # Simply perform 'clear' here.
+  # ========================================================================= #
+  def self.clear_screen
+    system 'clear'
+  end; self.instance_eval { alias clear clear_screen } # === Colours.clear_screen
+
+end

data/lib/colours/toplevel_methods/cliner.rb

@@ -0,0 +1,17 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'colours/toplevel_methods/cliner.rb'
+# =========================================================================== #
+module Colours
+
+  # ========================================================================= #
+  # === Colours.cliner
+  # ========================================================================= #
+  def self.cliner(i = 78, &block)
+    yield if block_given?
+    puts '=' * i
+  end
+
+end