colours 0.6.12

data/lib/colours/testing/testing.rb

@@ -0,0 +1,157 @@
+#!/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'
+# =========================================================================== #
+require 'colours/toplevel_methods/e.rb'
+require 'colours/toplevel_methods/show_basic_colour_palette.rb'
+require 'colours/toplevel_methods/make_colour.rb'
+
+module Colours
+
+  # ========================================================================= #
+  # === 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

data/lib/colours/toplevel_methods/bold.rb

@@ -0,0 +1,35 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'colours/toplevel_methods/bold.rb'
+# Colours.bold
+# =========================================================================== #
+require 'colours/revert/revert.rb'
+
+module Colours
+
+  # ========================================================================= #
+  # === Colours.bold
+  #
+  # Usage example:
+  #
+  #   puts ' ok | '+Colours.bold('Hello world!')+' | ok'
+  #
+  # ========================================================================= #
+  def self.bold(
+      show_this_text = 'This must be bold.'
+    )
+    "\x1b[1m#{show_this_text}#{REVERT}"
+  end; self.instance_eval { alias return_bold bold } # === Colours.return_bold
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  if ARGV.empty?
+    puts Colours.bold('Hello world!')
+    puts 'Hello world!'
+  else
+    puts 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,36 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'colours/toplevel_methods/bold_and_italic.rb'
+# =========================================================================== #
+require 'colours/revert/revert.rb'
+require 'colours/toplevel_methods/bold.rb'
+require 'colours/toplevel_methods/italic.rb'
+
+module Colours
+
+  # ========================================================================= #
+  # === 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 # bold_and_italic 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'
+# =========================================================================== #
+require 'colours/rainbow_colours/print_rainbow_line.rb'
+
+module Colours
+
+  # ========================================================================= #
+  # === 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,19 @@
+#!/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)
+    if block_given?
+      yield
+    end
+    puts '=' * i
+  end
+
+end

data/lib/colours/toplevel_methods/col.rb

@@ -0,0 +1,56 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'colours/toplevel_methods/col.rb'
+# =========================================================================== #
+require 'colours/colour_methods/sfile.rb'
+require 'colours/colour_methods/sdir.rb'
+require 'colours/colour_methods/ssymlink.rb'
+
+module Colours
+
+  # ========================================================================= #
+  # === Colours.col                                                 (col tag)
+  #
+  # Careful - this method may collide with other methods named col().
+  #
+  # Usage examples:
+  #
+  #   Colours.col '/Depot/j/geojgirjh'
+  #   Colours.col '/Users/x/AUDIO/'
+  #   Colours.col '/Users/x/AUDIO/Westbam_Sunshine.mp3'
+  #
+  # ========================================================================= #
+  def self.col(
+      i,
+      optional_arg_not_in_use_right_now = ''
+    )
+    if File.exist? i
+      ftype = File.ftype(i)
+      # e 'The ftype is: '+ftype # <- This could be used for debugging.
+      case ftype
+      # ===================================================================== #
+      # === file
+      # ===================================================================== #
+      when 'file'
+        return sfile(i)
+      # ===================================================================== #
+      # === directory
+      # ===================================================================== #
+      when 'directory'
+        return sdir(i)
+      # ===================================================================== #
+      # === link
+      # ===================================================================== #
+      when 'link'
+        return ssymlink(i)
+      else
+        e "module Colours: We do not know the filetype `#{ftype}`"
+      end
+    else # Else return the input a bit changed.
+      return sfile(i) # We modify it because that is better.
+    end
+  end
+
+end

data/lib/colours/toplevel_methods/e.rb

@@ -0,0 +1,63 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'colours/toplevel_methods/e.rb'
+# =========================================================================== #
+require 'colours/constants/newline.rb'
+require 'colours/revert/revert.rb'
+
+module Colours
+
+  # ========================================================================= #
+  # === ef
+  # ========================================================================= #
+  def ef(i)
+    e(i, false) # The variant without newlines.
+  end
+
+  # ========================================================================= #
+  # === Colours.e
+  #
+  # This is essentially just a fancified wrapper over puts.
+  #
+  # Usage examples:
+  #   Colours.e 'hello world'
+  #   Colours.e "hi \n there\n is everything fine? \n\n"
+  # ========================================================================= #
+  def self.e(
+      i              = N,
+      append_newline = true
+    )
+    i = i.join(' ') if i.is_a? Array
+    _ = "#{rev}#{i.to_s.dup}".dup # Work with a copy here.
+    _.chomp! # So that we won't have more than one newline initially.
+    _ << N if append_newline # This should be the last modification before calling print.
+    print _ # And print the result finally.
+  end
+
+  # ========================================================================= #
+  # === e                                                             (e tag)
+  #
+  # This is just a wrapper towards the above method called Colours.e()
+  #
+  # If the second argument `make_newline` is true then we will append a
+  # newline. This is the default behaviour.
+  #
+  # This method just delegates to the module method Colours.e()
+  # ========================================================================= #
+  def e(
+      i = N, append_newline = true
+    ) # This is the main point of Colours.
+    ::Colours.e(i, append_newline) # Point towards the class method of e().
+  end; alias ci e # === ci
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  if ARGV.empty?
+    Colours.e('Hello World!')
+  else
+    Colours.e(ARGV)
+  end
+end

data/lib/colours/toplevel_methods/esystem.rb

@@ -0,0 +1,19 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'colours/toplevel_methods/esystem.rb'
+# =========================================================================== #
+require 'colours/toplevel_methods/e.rb'
+
+module Colours
+
+  # ========================================================================= #
+  # === esystem
+  # ========================================================================= #
+  def self.esystem(i)
+    e i
+    system i
+  end
+
+end

data/lib/colours/toplevel_methods/fancy_parse.rb

@@ -0,0 +1,83 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'colours/toplevel_methods/fancy_parse.rb'
+# =========================================================================== #
+module Colours
+
+  require 'colours/toplevel_methods/bold.rb'
+  require 'colours/toplevel_methods/italic.rb'
+  require 'colours/toplevel_methods/methods_related_to_html_colours.rb'
+  require 'colours/toplevel_methods/underline.rb'
+
+  # ========================================================================= #
+  # === Colours.fancy_parse
+  #
+  # This method can be used to parse a line containing special tags,
+  # such as <i> or <teal>, and replace them with the corresponding
+  # ASCII code for the commandline. The second example, e. g. <teal>,
+  # is known as a HTML colour tag (htmlcolour).
+  #
+  # The idea for this method is to simply use it to quickly colourize
+  # some arbitrary text.
+  #
+  # The method will only return the resulting, sanitizing String;
+  # if you wish to display this on the terminal/commandline then
+  # you will have to use puts or print on your own.
+  #
+  # Usage examples:
+  #
+  #   Colours.fancy_parse '<i>hey</i> <teal>there</teal>'
+  #   puts Colours.fancy_parse '<i>hey</i> <teal>there</teal> ok'
+  #
+  # ========================================================================= #
+  def self.fancy_parse(
+      i               = '',
+      use_this_colour = :default_colour
+    )
+    if i.is_a? Array
+      i = i.join
+    end
+    i = i.dup # Work on a copy.
+    # ======================================================================= #
+    # === Handle italic tags, aka <i>
+    # ======================================================================= #
+    if i.include?('<i>') and
+       i.include?('</i>')
+      use_this_regex = /<i>([A-Za-zöäüÖÄÜ\s-]+)<\/i>/ # See: https://rubular.com/r/U35iBGeQRQLFxe
+      i.gsub!(
+        use_this_regex,
+        return_italic('\1')
+      )
+    end
+    # ======================================================================= #
+    # === Handle bold tags, aka <b>
+    # ======================================================================= #
+    if i.include?('<b>') and
+       i.include?('</b>')
+      use_this_regex = /<b>(.+)<\/b>/
+      i.gsub!(
+        use_this_regex,
+        return_bold('\1')
+      )
+    end
+    # ======================================================================= #
+    # Finally, handle all HTML colours in the given line.
+    # ======================================================================= #
+    i = replace_all_html_colours_in_this_line(i, use_this_colour)
+    return i
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  result = Colours.fancy_parse(ARGV)
+  puts result
+  # pp result # <- This line is just for simple debugging.
+end # fancy_parse "<lightgreen><i>hey</i></lightgreen> <teal>there</teal>"
+    # fancy_parse "<tomato>hey</tomato> <teal>there</teal>"
+    # fancy_parse "<tomato><i>hey</i></tomato> <teal>there</teal>"
+    # fancy_parse "<tomato><b><i>hey</i></b></tomato> <teal>there</teal>"
+    # fancy_parse "<tomato><b><i>hey</i></b></tomato> <teal>there</teal> <b>how do you do</b>"
+    # fancy_parse "<tomato><b>Hello world.</b></tomato>"

data/lib/colours/toplevel_methods/html_colourize.rb

@@ -0,0 +1,64 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'colours/toplevel_methods/html_colourize.rb'
+# =========================================================================== #
+module Colours
+
+  require 'colours/rgb/rgb.rb'
+  require 'colours/revert/revert.rb'
+
+  # ========================================================================= #
+  # === Colours.html_colourize
+  #
+  # This method will simply return the colour-code + text.
+  #
+  # The third argument, called `append_revert`, can be used to determine
+  # whether we will append the revert code to the generated output String
+  # or whether we will not. By default we will, but there are examples
+  # where we may wish to assemble our own colour string, and in these
+  # cases we do not yet know which text is to be shown - hence, this
+  # must become an optional argument.
+  #
+  # A block can be passed to this method. If the block has, as content,
+  # the Symbol :omit_end then the end-part of the ANSI code will not
+  # be used.
+  #
+  # Usage examples:
+  #
+  #   x = Colours.colourize('slateblue', 'Hello world!'); pp x
+  #   y = Colours.colourize('slateblue', 'Hello world!') { :omit_end }; pp y
+  #
+  # ========================================================================= #
+  def self.html_colourize(
+      colour_to_use = return_random_html_colour,
+      this_text     = nil,
+      append_revert = true,
+      &block
+    )
+    if block_given?
+      yielded = yield
+      case yielded
+      when :omit_end
+        append_revert = false
+      end
+    end
+    if this_text.nil?
+      this_text = colour_to_use.to_s.dup
+    end
+    if append_revert
+      "#{rgb_value_as_escape_code_string(colour_to_use)}#{this_text}#{revert}"
+    else
+      "#{rgb_value_as_escape_code_string(colour_to_use)}#{this_text}"
+    end
+  end; self.instance_eval { alias colourize       html_colourize } # === Colours.colourize
+       self.instance_eval { alias kde_colour      html_colourize } # === Colours.kde_colour
+       self.instance_eval { alias konsole_colours html_colourize } # === Colours.konsole_colours
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  puts Colours.html_colourize('slateblue', 'Hello world 1!')
+  puts Colours.html_colourize(:crimson, 'Hello world 2!')
+end

data/lib/colours/toplevel_methods/is_on_roebe.rb

@@ -0,0 +1,16 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'colours/toplevel_methods/is_on_roebe.rb'
+# =========================================================================== #
+module Colours
+
+  # ========================================================================= #
+  # === Colours.is_on_roebe?
+  # ========================================================================= #
+  def self.is_on_roebe?
+    ENV['IS_ROEBE'].to_s == '1'
+  end
+
+end