colours 0.5.55

data/lib/colours/rainbow_colours/print_rainbow_line.rb

@@ -0,0 +1,68 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'colours/rainbow_colours/print_rainbow_line.rb'
+# =========================================================================== #
+require 'colours/toplevel_methods/e.rb'
+require 'colours/rainbow_colours/constants.rb'
+require 'colours/rainbow_colours/println_plain.rb'
+
+module Colours
+
+module RainbowColours
+
+  # ========================================================================= #
+  # === Colours::RainbowColours.e
+  # ========================================================================= #
+  def self.e(i = '')
+    ::Colours.e(i)
+  end
+
+  # ========================================================================= #
+  # === Colours::RainbowColours.print_rainbow_line
+  #
+  # This line will do the colourizing part, on a per-line basis.
+  #
+  # The second and third arguments are Hashes.
+  #
+  # Simple invocation example:
+  #
+  #   Colours::RainbowColours.print_rainbow_line("Hello world! \n" * 80)
+  #
+  # ========================================================================= #
+  def self.print_rainbow_line(
+      string       = 'Hello world!',
+      defaults     = {},
+      options_hash = {}
+    )
+    if string.is_a? Array
+      string = string.join(' ').strip
+    end
+    options_hash.merge!(defaults)
+    string = string.dup if string.frozen?
+    string.chomp! if string.include? N
+    # ======================================================================= #
+    # Next, get rid of ANSI colours, unless the string is nil.
+    # ======================================================================= #
+    if !string.nil? and ($stdout.tty? or options_hash[:force])
+      string.gsub!(STRIP_ANSI, '')
+    end
+    # ======================================================================= #
+    # Replace all tabs with 2 spaces.
+    # ======================================================================= #
+    string.gsub!("\t", ' ' * 2) if string.include? "\t"
+    if options_hash[:animate]
+      # ===================================================================== #
+      # Handle animated frames, as specified by the options-hash.
+      # ===================================================================== #
+      println_ani(string, options_hash)
+    else
+      RainbowColours.println_plain(string, options_hash)
+    end
+    e
+  end; self.instance_eval { alias print_line          print_rainbow_line } # === Colours::RainbowColours.print_line
+       self.instance_eval { alias rainbow_line        print_rainbow_line } # === Colours::RainbowColours.rainbow_line
+       self.instance_eval { alias say_in_rainbow_line print_rainbow_line } # === Colours::RainbowColours.say_in_rainbow_line
+
+end; end

data/lib/colours/rainbow_colours/println_ani.rb

@@ -0,0 +1,32 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'colours/rainbow_colours/println_plain.rb'
+
+module Colours
+
+module RainbowColours
+
+  # ========================================================================= #
+  # === Colours::RainbowColours.println_ani
+  #
+  # This method here will be called if the "animate option" was enabled,
+  # that is, set to true.
+  # ========================================================================= #
+  def self.println_ani(
+      str, opts = {}
+    )
+    return if str.empty? # Return early in this case.
+    (1..opts[:duration]).each { |irrelevant_variable|
+      print "\e[#{str.length}D"
+      opts[:os] += opts[:spread]
+      # ===================================================================== #
+      # Next, delegate to println_plain():
+      # ===================================================================== #
+      println_plain(str, opts)
+      sleep 1.0/opts[:speed]
+    }
+  end
+
+end; end

data/lib/colours/rainbow_colours/println_plain.rb

@@ -0,0 +1,36 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'colours/rainbow_colours/println_plain.rb'
+# =========================================================================== #
+require 'colours/rainbow_colours/returnln_plain.rb'
+
+module Colours
+
+module RainbowColours
+
+  # ========================================================================= #
+  # === Colours::RainbowColours.println_plain
+  #
+  # This method will colourize the given input line.
+  #
+  # Usage example:
+  #
+  #   Colours::RainbowColours.println_plain
+  #   Colours::RainbowColours.println_plain 'one two three four five six seven eight'
+  #
+  # ========================================================================= #
+  def self.println_plain(
+      str      = "Hello world! Good morning sunshine.\n",
+      defaults = {},
+      opts     = {
+        spread:    DEFAULT_RAINBOW_SPREAD,
+        os:        rand(256),
+        truecolor: true
+      }
+    )
+    print returnln_plain(str, defaults, opts)
+  end
+
+end; end

data/lib/colours/rainbow_colours/rainbow.rb

@@ -0,0 +1,38 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+module Colours
+
+module RainbowColours
+
+  # ========================================================================= #
+  # === Colours::RainbowColours.rainbow
+  #
+  # Do the colour calculations next, via the rainbow() method.
+  #
+  # The frequency is typically a value such as 0.1.
+  #
+  # We will calculate the RGB values here (R, G, B).
+  #
+  # Invocation example:
+  #
+  #   Colours::RainbowColours.rainbow(:default, 3)  # => "#A5D604"
+  #   Colours::RainbowColours.rainbow(:default, 12) # => "#F66C1C"
+  #
+  # ========================================================================= #
+  def self.rainbow(
+      frequency = 0.1, i
+    )
+    case frequency
+    when nil,
+         :default
+      frequency = 0.1
+    end
+    red   = Math.sin(frequency * i + 0) * 127 + 128
+    green = Math.sin(frequency * i + 2 * Math::PI/3) * 127 + 128
+    blue  = Math.sin(frequency * i + 4 * Math::PI/3) * 127 + 128
+    '#%02X%02X%02X' % [ red, green, blue ]
+  end
+
+end; end

data/lib/colours/rainbow_colours/report_errors.rb

@@ -0,0 +1,32 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'colours/rainbow_colours/report_errors.rb'
+# =========================================================================== #
+module Colours
+
+module RainbowColours
+
+  # ========================================================================= #
+  # === Colours::RainbowColours.report_no_such_file_or_directory
+  # ========================================================================= #
+  def self.report_no_such_file_or_directory(file)
+    e "Colours::RainbowColours: #{file}: No such file or directory"
+  end
+
+  # ========================================================================= #
+  # === Colours::RainbowColours.report_is_a_directory
+  # ========================================================================= #
+  def self.report_is_a_directory(file)
+    e "Colours::RainbowColours: #{file}: Is a directory"
+  end
+
+  # ========================================================================= #
+  # === Colours::RainbowColours.report_permission_denied
+  # ========================================================================= #
+  def self.report_permission_denied(file)
+    e "Colours::RainbowColours: #{file}: Permission denied"
+  end
+
+end; end

data/lib/colours/rainbow_colours/returnln_plain.rb

@@ -0,0 +1,63 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'colours/rainbow_colours/returnln_plain.rb'
+# =========================================================================== #
+require 'colours/rainbow_colours/rainbow.rb'
+require 'colours/rainbow_colours/set_mode.rb'
+
+module Colours
+
+module RainbowColours
+
+  # ========================================================================= #
+  # === Colours::RainbowColours.returnln_plain
+  #
+  # This will return a rainbow-coloured text.
+  #
+  # The first argument is the text that you wish to display.
+  #
+  # Invocation example:
+  #
+  #   puts Colours::RainbowColours.returnln_plain('abc def ' * 1000)
+  #
+  # ========================================================================= #
+  def self.returnln_plain(
+      str          = "Hello world! Good morning sunshine.\n",
+      defaults     = {},
+      options_hash = {
+        spread:    DEFAULT_RAINBOW_SPREAD,
+        os:        rand(256),
+        truecolor: true
+      }
+    )
+    options_hash.merge!(defaults)
+    RainbowColours.set_mode(options_hash[:truecolor])
+    the_chars = str.chomp.chars # We obtain the individual characters here.
+    # ======================================================================= #
+    # Iterate over the chars. i, aka the second argument, is the index.
+    # ======================================================================= #
+    result = ''.dup
+    the_chars.each_with_index { |character, index|
+      # ===================================================================== #
+      # Delegate towards the toplevel-method rainbow().
+      # ===================================================================== #
+      division_result = (
+        options_hash[:os]+index / options_hash[:spread]
+      )
+      # ===================================================================== #
+      # Next, we will obtain some ASCII value such as '#A5D604':
+      # ===================================================================== #
+      code = RainbowColours.rainbow(options_hash[:freq], division_result)
+      # ===================================================================== #
+      # Delegate towards Paint[] next. The painted character will be
+      # displayed one-per-char.
+      # This will yield a String such as "\e[38;2;16;236;130mo\e[0m".
+      # ===================================================================== #
+      result << Paint[character, *[ (:black if options_hash[:invert]), code ].compact ]
+    }
+    return result
+  end
+
+end; end

data/lib/colours/rainbow_colours/set_mode.rb

@@ -0,0 +1,24 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'colours/rainbow_colours/set_mode.rb'
+# =========================================================================== #
+module Colours
+
+module RainbowColours
+
+  # ========================================================================= #
+  # === Colours::RainbowColours.set_mode
+  # ========================================================================= #
+  def self.set_mode(truecolor)
+    begin
+      unless Object.const_defined? :Paint
+        require 'paint'
+      end
+      @paint_mode_detected ||= Paint.mode
+      Paint.mode = truecolor ? 0xffffff : @paint_mode_detected
+    rescue LoadError; end
+  end
+
+end; end

data/lib/colours/requires/require_all_colour_methods.rb

@@ -0,0 +1,5 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'colours/autogenerated/toplevel_basic_colour_methods.rb'

data/lib/colours/requires/require_commandline.rb

@@ -0,0 +1,7 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'colours/requires/require_commandline.rb'
+# =========================================================================== #
+require 'colours/commandline/commandline.rb'

data/lib/colours/requires/require_eparse.rb

@@ -0,0 +1,11 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'colours/requires/require_eparse.rb'
+# =========================================================================== #
+
+# =========================================================================== #
+# Add the .eparse() functionality:
+# =========================================================================== #
+require 'colours/eparse/eparse.rb'

data/lib/colours/requires/require_rgb.rb

@@ -0,0 +1,5 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'colours/rgb/rgb.rb'

data/lib/colours/requires/require_sdir.rb

@@ -0,0 +1,5 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'colours/colour_methods/sdir.rb'

data/lib/colours/requires/require_sfile.rb

@@ -0,0 +1,5 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'colours/colour_methods/sfile.rb'

data/lib/colours/requires/require_the_256_colours_module.rb

@@ -0,0 +1,16 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# Note that this .rb file is normally NOT required the colours gem by
+# default - it is only meant to be required manually.
+# =========================================================================== #
+# require 'colours/requires/require_the_256_colours_module.rb'
+# =========================================================================== #
+
+# =========================================================================== #
+# Add support for the 256-colours:
+# =========================================================================== #
+require 'colours/256_colours/support_for_256_colours.rb'
+
+require 'colours/autogenerated/support_for_256_colours.rb'

data/lib/colours/requires/require_the_basic_colours.rb

@@ -0,0 +1,7 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'colours/requires/require_the_basic_colours.rb'
+# =========================================================================== #
+require 'colours/basic_colours/basic_colours.rb'

data/lib/colours/requires/require_the_colour_methods.rb

@@ -0,0 +1,34 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# The "colour-methods" are methods such as sdir(), swarn() and so forth.
+#
+# The file here specifies code that can be used to require these .rb
+# files from the given colour_methods/ subdirectory of the colours
+# project.
+# =========================================================================== #
+# require 'colours/requires/require_the_colour_methods.rb'
+# =========================================================================== #
+require 'colours/project/project_base_directory.rb'
+
+module Colours
+
+  # ========================================================================= #
+  # === Colours.require_the_colour_methods
+  #
+  # This method will batch-require the .rb files that are found in the
+  # colour_methods/ subdirectory of the colours gem.
+  # ========================================================================= #
+  def self.require_the_colour_methods
+    target = "#{Colours::PROJECT_BASE_DIRECTORY}colour_methods/"
+
+    Dir["#{target}*.rb"].each {|this_file|
+      require target+File.basename(this_file)
+    }
+
+  end; self.instance_eval { alias default_string_methods require_the_colour_methods } # === Colours.default_string_methods
+
+  Colours.require_the_colour_methods # Also trigger the above method at once.
+
+end

data/lib/colours/requires/require_the_colour_table.rb

@@ -0,0 +1,7 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'colours/requires/require_the_colour_table.rb'
+# =========================================================================== #
+require 'colours/colour_table/colour_table.rb'

data/lib/colours/requires/require_the_colours_project.rb

@@ -0,0 +1,52 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'colours/project/project_base_directory.rb'
+require 'colours/requires/require_the_constants.rb'
+require 'colours/requires/require_the_basic_colours.rb'
+require 'colours/requires/require_the_toplevel_methods.rb'
+# =========================================================================== #
+# Next require the colour-methods:
+# =========================================================================== #
+require 'colours/requires/require_the_colour_methods.rb'
+# =========================================================================== #
+# Next require the html-colours components of the colours project:
+# =========================================================================== #
+require 'colours/requires/require_the_html_colours.rb'
+require 'colours/requires/require_eparse.rb'
+require 'colours/requires/require_commandline.rb'
+require 'colours/requires/require_the_colour_table.rb'
+require 'colours/requires/require_rgb.rb'
+require 'colours/requires/require_the_256_colours_module.rb'
+require 'colours/requires/require_the_kde_colour_palette.rb'
+require 'colours/html_colours/add_html_colours_onto_the_toplevel_namespace.rb'
+# =========================================================================== #
+# Require the big "symbol-mapper" next:
+# =========================================================================== #
+require 'colours/map_symbol_to_corresponding_colour/map_symbol_to_corresponding_colour.rb'
+# =========================================================================== #
+# Load up the testing-relevant code:
+# =========================================================================== #
+require 'colours/testing/testing.rb'
+# =========================================================================== #
+# Next, add the submodule at "Colours::E":
+# =========================================================================== #
+require 'colours/e/e.rb'
+require 'colours/autogenerated/support_for_html_colours.rb'
+require 'colours/autogenerated/toplevel_basic_colour_methods.rb'
+require 'colours/base/base.rb'
+require 'colours/version/version.rb'
+require 'colours/utility_scripts/autogenerate.rb'
+
+module Colours
+
+  # ========================================================================= #
+  # We have to put the ColourMethods into the toplevel namespace at once,
+  # so that methods such as slateblue() are defined.
+  # ========================================================================= #
+  extend ::Colours::AllColourMethods
+
+  include ::Colours::AllColourMethods
+
+end

data/lib/colours/requires/require_the_constants.rb

@@ -0,0 +1,11 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'colours/constants/colour_constants.rb'
+require 'colours/constants/file_constants.rb'
+require 'colours/constants/hash_simple_colours.rb'
+require 'colours/constants/misc.rb'
+require 'colours/constants/newline.rb'
+require 'colours/constants/registered_colour_methods.rb'
+require 'colours/revert/revert.rb'

data/lib/colours/requires/require_the_html_colours.rb

@@ -0,0 +1,11 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'colours/requires/require_the_html_colours.rb'
+# =========================================================================== #
+
+# =========================================================================== #
+# Require the html-colours components of the colours project:
+# =========================================================================== #
+require 'colours/html_colours/misc.rb'

data/lib/colours/requires/require_the_kde_colour_palette.rb

@@ -0,0 +1,7 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'colours/requires/require_the_kde_colour_palette.rb'
+# =========================================================================== #
+require 'colours/kde_colour_palette/kde_colour_palette.rb'

data/lib/colours/requires/require_the_toplevel_methods.rb

@@ -0,0 +1,42 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# This file will pull in all .rb files that reside in the
+# colours/toplevel_methods/ subdirectory.  
+# =========================================================================== #
+require 'colours/project/project_base_directory.rb'
+
+require_these_files = Dir["#{Colours::PROJECT_BASE_DIRECTORY}toplevel_methods/*.rb"]
+
+if require_these_files.empty?
+  # ===================================================================== #
+  # If we can not find any of the files then we will use a hardcoded
+  # approach, which follows next.
+  # ===================================================================== #
+  require_these_files = %w(
+    bold_and_italic.rb
+    bold.rb
+    cat.rb
+    clear_screen.rb
+    cliner.rb
+    col.rb
+    e.rb
+    html_colourize.rb
+    is_on_roebe.rb
+    italic.rb
+    make_colour.rb
+    misc.rb
+    prefer_this_colour_schemata.rb
+    random_html_colour.rb
+    random_value.rb
+    remove_escape_sequence.rb
+    show_basic_colour_palette.rb
+    underline.rb
+    use_colours.rb
+  )
+end
+
+require_these_files.each {|this_file|
+  require "colours/toplevel_methods/#{File.basename(this_file)}"
+}

data/lib/colours/revert/revert.rb

@@ -0,0 +1,106 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal =  true
+# =========================================================================== #
+# require 'colours/revert/revert.rb'
+# =========================================================================== #
+module Colours
+
+  # ========================================================================= #
+  # === Colours::ESC
+  #
+  # Escape sequences start with the character ESC (ASCII decimal 27/hex
+  # 0x1B/octal 033).
+  #
+  # The characters ESC and [ (left bracket) are called CSI, for "Control
+  # Sequence Initiator".
+  #
+  # Keep in mind that "\e" can be represented via "\u001b" in Ruby, too.
+  # ========================================================================= #
+  ESC = "\e["
+
+  # ========================================================================= #
+  # === Colours::COLOUR_NC
+  #
+  # Note that this will actually reset all attributes.
+  #
+  # The "\e[0m" sequence removes all attributes, including formatting
+  # and colours. It may be useful to add it to the end of each colour
+  # text - and this is what the Colours project is essentially doing.
+  #
+  # An alternative may be to assign REVERT to WHITE, but this seems
+  # to be incorrect according to the specification.
+  # ========================================================================= #
+  COLOUR_NC        = "#{ESC}0m" # No Colour.
+    REVERT         = COLOUR_NC    # === REVERT
+    REV            = COLOUR_NC    # === REV
+    CLOSING_TAG    = COLOUR_NC    # === CLOSING_TAG (also represented as "#{ESC}0m")
+    RESET          = COLOUR_NC    # === RESET
+    RESET_TERMINAL = COLOUR_NC    # === RESET_TERMINAL
+    CLEAR          = COLOUR_NC    # === CLEAR
+    COLOUR_RESET   = COLOUR_NC    # === COLOUR_RESET
+    DEFAULT_COLOUR = COLOUR_RESET # === DEFAULT_COLOUR
+
+  # ========================================================================= #
+  # === RESET_ALL_ATTRIBUTES
+  #
+  # This is essentially the same as COLOUR_NC / RESET.
+  # ========================================================================= #
+  RESET_ALL_ATTRIBUTES = "\x1b[0m"
+
+  # ========================================================================= #
+  # === @revert
+  # ========================================================================= #
+  @revert = "\e[0;37m"
+
+  # ========================================================================= #
+  # === Colours.set_revert
+  # ========================================================================= #
+  def self.set_revert(i = :default)
+    case i
+    when :default
+      i = REVERT
+    end
+    @revert = i
+  end
+
+  # ========================================================================= #
+  # === Colours.rev
+  #
+  # We use this method to revert to the old default, that is, the prior
+  # state for ANSI colours. It should be equivalent to: "\x1b[0m" e. g.
+  # REVERT = "\x1b[0m" # "\x1b[39;49m" <--- This here seems to fail for Konsole.underline, though.
+  #
+  # An alternative could be DEFAULT_COLOUR.
+  # ========================================================================= #
+  def self.rev
+    # REVERT # <- This used to be: "\e[0;37m"
+    @revert # This is light white. I prefer this colour actually.
+  end; self.instance_eval { alias revert   rev } # === Colours.revert
+       self.instance_eval { alias revert?  rev } # === Colours.revert?
+       self.instance_eval { alias restore? rev } # === Colours.restore?
+
+  # ========================================================================= #
+  # === rev
+  #
+  # Use this method to "revert" to the old default colour again, by
+  # delegating towards the Colours.rev() method defined above.
+  #
+  # From this point on, we use methods that can be toggled.
+  # ========================================================================= #
+  def rev(i = '')
+    ::Colours.rev # This will refer to the Colours.rev() module method.
+  end; alias revert rev # === revert
+       # alias default_colour rev
+
+  # ========================================================================= #
+  # === restore?
+  #
+  # This will restore to the default again.
+  # ========================================================================= #
+  def restore?
+    Colours.restore?
+  end; alias revert restore? # === revert
+       alias rev?   restore? # === rev?
+
+end