colours 0.5.48

data/lib/colours/rainbow_colours/do_parse_via_rainbow_colours.rb

@@ -0,0 +1,164 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Colours::RainbowColours
+# =========================================================================== #
+# require 'colours/rainbow_colours/do_parse_via_rainbow_colours.rb'
+# =========================================================================== #
+require 'colours/toplevel_methods/cat.rb'
+require 'colours/toplevel_methods/clear_screen.rb'
+require 'colours/toplevel_methods/e.rb'
+# =========================================================================== #
+# Require rainbow_colours specific code next:
+# =========================================================================== #
+require 'colours/rainbow_colours/check_for_trollop_being_available_or_exit.rb'
+require 'colours/rainbow_colours/constants.rb'
+require 'colours/rainbow_colours/paint_detected_mode.rb'
+require 'colours/rainbow_colours/report_errors.rb'
+
+module Colours
+
+module RainbowColours
+
+  begin
+    require 'stringio'
+  rescue LoadError; end
+
+  begin
+    require 'trollop'
+  rescue LoadError; end
+
+  # ========================================================================= #
+  # === Colours::RainbowColours.do_parse_via_rainbow_colours
+  #
+  # This is the rainbow_colours initializer.
+  # ========================================================================= #
+  def self.do_parse_via_rainbow_colours(
+      i = ARGV
+    )
+    check_for_trollop_being_available_or_exit
+    # ======================================================================= #
+    # Setup the trollop-parser instance next.
+    # ======================================================================= #
+    trollop_parser = Trollop::Parser.new {
+      banner <<HEADER
+
+Usage: rainbow_colours [OPTION]... [FILE]...
+
+Display one or several files. Alternatively, obtain input via STDIN.
+
+With no FILE, or when FILE is -, read standard input.
+
+HEADER
+      banner ''
+      # ll | rainbowc -a
+      opt :animate,   'Enable psychedelics',        short: 'a', :default => false
+      opt :spread,    'Rainbow spread',             short: 'p', :default => DEFAULT_RAINBOW_SPREAD
+      opt :freq,      'Rainbow frequency',          short: 'F', :default => 0.1
+      opt :seed,      'Rainbow seed, 0 = random',   short: 'S', :default => 0
+      opt :duration,  'Animation duration',         short: 'd', :default => 12
+      opt :speed,     'Animation speed',            short: 's', :default => 20.0
+      opt :invert,    'Invert fg and bg',           short: 'i', :default => false
+      opt :truecolor, '24-bit (truecolor)',         short: 't', :default => false
+      opt :force,     'Force color even when stdout is not a tty', short: 'f', :default => false
+      opt :help,      'Show this help menu',        short: 'h'
+      banner <<FOOTER
+
+Examples:
+
+  rainbow_colours f - g      Output f's contents, then stdin, then g's contents.
+  rainbow_colours            Copy standard input to standard output.
+  fortune | rainbow_colours  Display a rainbow cookie.
+
+FOOTER
+    } # End of the help-banner.
+    # ======================================================================= #
+    # Keep the Trollop instance assigned to the variable opts.
+    # ======================================================================= #
+    opts = Trollop.with_standard_exception_handling(trollop_parser) {
+      begin
+        o = trollop_parser.parse(i) # Parse the given input here.
+      rescue Trollop::HelpNeeded # If we need some more help.
+        string_io_buffer = StringIO.new
+        trollop_parser.educate(string_io_buffer) # <- display the help message and then exit.
+        string_io_buffer.rewind
+        opts = {
+          animate:  false,
+          speed:     20,
+          duration:  12,
+          os:       rand(256),
+          spread:   8.0,
+          freq:     0.3
+        }
+        splitted = string_io_buffer.read.split("\n")
+        ::Colours.cat(splitted, opts)
+        e
+        string_io_buffer.close # Close the buffer again.
+        exit 1
+      end
+      o
+    }
+
+    p.die(:spread,   'must be >= 0.1') if opts[:spread]   < 0.1
+    p.die(:duration, 'must be >= 0.1') if opts[:duration] < 0.1
+    p.die(:speed,    'must be >= 0.1') if opts[:speed]    < 0.1
+
+    # ======================================================================= #
+    # Build up the option-hash next.
+    # ======================================================================= #
+    opts[:os] = opts[:seed]
+    opts[:os] = rand(256) if opts[:os] == 0
+
+    begin
+      if ARGV.empty?
+        files = [:stdin]
+      else
+        files = ARGV[0..-1]
+      end
+      files.each { |file|
+        case file
+        when '-', :stdin
+          fd = ARGF
+        end
+        begin
+          fd = File.open(file) unless fd == ARGF
+          if $stdout.tty? or opts[:force]
+            # =============================================================== #
+            # Work on TTY terminals. This also includes terminals such
+            # as KDE Konsole. The second argument are the options passed
+            # towards Colours.cat().
+            # =============================================================== #
+            ::Colours.cat(fd, opts)
+          else
+            until fd.eof? do
+              # ============================================================= #
+              # Keep on writing the input to $stdout here.
+              # ============================================================= #
+              $stdout.write(fd.read(8192))
+            end
+          end
+        rescue Errno::ENOENT
+          report_no_such_file_or_directory(file)
+          exit 1
+        rescue Errno::EACCES
+          report_permission_denied(file)
+          exit 1
+        rescue Errno::EISDIR
+          report_is_a_directory(file)
+          exit 1
+        rescue Errno::EPIPE
+          exit 1
+        end
+      }
+    rescue Interrupt
+    end
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Colours::RainbowColours.do_parse_via_rainbow_colours(ARGV)
+end # rainbow_colours
+    # ll | rainbow_colours
+    # ll | rainbow_colours -a

data/lib/colours/rainbow_colours/paint_detected_mode.rb

@@ -0,0 +1,20 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'paint_detected_mode.rb'
+# =========================================================================== #
+module Colours
+
+module RainbowColours
+
+  # ========================================================================= #
+  # === @paint_detected_mode
+  # ========================================================================= #
+  if Object.const_defined? :Paint
+    @paint_detected_mode = Paint.detect_mode
+  else
+    @paint_detected_mode = nil
+  end
+
+end; end

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