colours 0.5.48

data/lib/colours/colour_methods/scomments.rb

@@ -0,0 +1,105 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'colours/colour_methods/scomments.rb'
+# =========================================================================== #
+require 'colours/revert/revert.rb'
+require 'colours/colour_table/colour_table.rb'
+require 'colours/toplevel_methods/use_colours.rb'
+require 'colours/toplevel_methods/prefer_this_colour_schemata.rb'
+require 'colours/autogenerated/support_for_html_colours.rb'
+require 'colours/map_symbol_to_corresponding_colour/map_symbol_to_corresponding_colour.rb'
+
+module Colours
+
+  # ========================================================================= #
+  # === Colours.scomments
+  #
+  # Invocation example:
+  #   Colours.scomments('Hello world!')
+  # ========================================================================= #
+  def self.scomments(
+      i            = '',
+      make_newline = false
+    )
+    if @use_colours
+      if @use_html_colours
+        i = SupportForHTMLColours.send(@colour_table[__method__.to_sym], i)
+      elsif @use_256_colours
+        use_this_colour = map_this_symbol_to_that_256_colour(@colour_table[__method__.to_sym])
+        i = SupportFor256Colours.send(use_this_colour, i)
+      else
+        i = "#{corresponding_colour?(@colour_table[__method__.to_sym])}"\
+            "#{i}"\
+            "#{rev}"
+      end
+    end
+    i
+  end; self.instance_eval { alias comment scomments } # === Colours.comment
+
+  # ========================================================================= #
+  # === scomments
+  # ========================================================================= #
+  def scomments(i = '')
+    ::Colours.scomments(i)
+  end; alias scomment scomments # === scomment
+
+  # ========================================================================= #
+  # === Colours.ecomment
+  #
+  # This method here was added on Nov 2013.
+  #
+  # In April 2014, the ability to split at any arbitrary character was
+  # added, which can be controlled via the second argument given to
+  # that method.
+  # ========================================================================= #
+  def self.ecomment(
+      i,
+      optional_split_at_this_character = '#' # <- Specify which character to split at.
+    )
+    _ = i.to_s
+    if optional_split_at_this_character.is_a? Hash
+      if optional_split_at_this_character.has_key? :token
+        optional_split_at_this_character = optional_split_at_this_character.delete :token
+      end
+    end
+    optional_split_at_this_character = optional_split_at_this_character.to_s
+    # ======================================================================= #
+    # === If we can find a token to split at
+    # ======================================================================= #
+    if _.include? optional_split_at_this_character
+      use_this_regex = /#(.+)/ # See: http://rubular.com/r/oRUg7lw4oE
+      colour_for_comments = map_colour_to_constant(scomments?)
+      _ = _.dup if _.frozen?
+      _.gsub!(use_this_regex,
+        colour_for_comments+optional_split_at_this_character.to_s+'\\1'+rev)
+    end
+    e _
+  end
+
+  # ========================================================================= #
+  # === Colours.scomments?
+  # ========================================================================= #
+  def self.scomments?
+    colour_table?[:scomments]
+  end
+
+  # ========================================================================= #
+  # === ecomment
+  #
+  # Just a wrapper over the Colours.ecomment() functionality.
+  # ========================================================================= #
+  def ecomment(
+      i,
+      optional_split_at_this_character = '#'
+    )
+    Colours.ecomment(i, optional_split_at_this_character)
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  puts Colours.scomments('Hello world!')
+  Colours.ecomment('Hello world! # this is the associated comment')
+end

data/lib/colours/colour_methods/sdir.rb

@@ -0,0 +1,66 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'colours/colour_methods/sdir.rb'
+# =========================================================================== #
+require 'colours/revert/revert.rb'
+require 'colours/colour_table/colour_table.rb'
+require 'colours/toplevel_methods/use_colours.rb'
+require 'colours/toplevel_methods/prefer_this_colour_schemata.rb'
+require 'colours/autogenerated/support_for_html_colours.rb'
+
+module Colours
+
+  # ========================================================================= #
+  # === Colours.sdir
+  #
+  # Invocation example:
+  #
+  #   puts Colours.sdir('Hello world!')
+  #
+  # ========================================================================= #
+  def self.sdir(
+      i            = '',
+      make_newline = false
+    )
+    if make_newline
+      i = "#{i}#{N}"
+    end
+    if @use_colours
+      if @use_html_colours
+        i = SupportForHTMLColours.send(@colour_table[__method__.to_sym], i)
+      elsif @use_256_colours
+        use_this_colour = map_this_symbol_to_that_256_colour(@colour_table[__method__.to_sym])  
+        i = SupportFor256Colours.send(use_this_colour, i)
+      else
+        i = "#{corresponding_colour?(@colour_table[__method__.to_sym])}"\
+            "#{i}"\
+            "#{rev}"
+      end
+    end
+    i
+  end
+
+  # ========================================================================= #
+  # === edir
+  # ========================================================================= #
+  def edir(
+      i            = '',
+      make_newline = false
+    )
+    e Colours.sdir(i, make_newline)
+  end
+
+  # ========================================================================= #
+  # === sdir
+  # ========================================================================= #
+  def sdir(i = '')
+    Colours.sdir(i)
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  puts Colours.sdir('Hello world!')
+end #

data/lib/colours/colour_methods/sfancy.rb

@@ -0,0 +1,84 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'colours/colour_methods/sfancy.rb'
+# =========================================================================== #
+require 'colours/revert/revert.rb'
+require 'colours/colour_table/colour_table.rb'
+require 'colours/toplevel_methods/use_colours.rb'
+require 'colours/toplevel_methods/prefer_this_colour_schemata.rb'
+require 'colours/autogenerated/support_for_html_colours.rb'
+
+module Colours
+
+  # ========================================================================= #
+  # === Colours.sfancy
+  #
+  # Invocation example:
+  #   Colours.sfancy('Hello world!')
+  # ========================================================================= #
+  def self.sfancy(
+      i            = '',
+      make_newline = false
+    )
+    if @use_colours
+      if @use_html_colours
+        i = SupportForHTMLColours.send(
+          map_this_symbol_to_that_html_colour(@colour_table[__method__.to_sym]), i
+        )
+      elsif @use_256_colours
+        use_this_colour = map_this_symbol_to_that_256_colour(@colour_table[__method__.to_sym])
+        i = SupportFor256Colours.send(use_this_colour, i)
+      else
+        i = "#{corresponding_colour?(@colour_table[__method__.to_sym])}"\
+            "#{i}"\
+            "#{rev}"
+      end
+    end
+    i
+  end
+
+  # ========================================================================= #
+  # === Colours.efancy
+  #
+  # This simply will output the result from sfancy(), defined above.
+  # ========================================================================= #
+  def self.efancy(
+      i            = '',
+      make_newline = false
+    )
+    e sfancy(i, make_newline)
+  end
+
+  # ========================================================================= #
+  # === efancy
+  # ========================================================================= #
+  def efancy(
+      i            = '',
+      make_newline = false
+    )
+    Colours.efancy(i, make_newline)
+  end; alias f efancy # === f (f tag)
+
+  # ========================================================================= #
+  # === sfancy
+  # ========================================================================= #
+  def sfancy(i = '')
+    ::Colours.sfancy(i)
+  end
+
+  # ========================================================================= #
+  # === cif
+  #
+  # This is efancy, but we won't use newlines.
+  # ========================================================================= #
+  def cif(i)
+    efancy(i, false)
+  end; alias ff cif # === ff (alias to the above ^^^)
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  puts Colours.sfancy('Hello world!')
+end

data/lib/colours/colour_methods/sfile.rb

@@ -0,0 +1,71 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'colours/colour_methods/sfile.rb'
+# =========================================================================== #
+require 'colours/revert/revert.rb'
+require 'colours/colour_table/colour_table.rb'
+require 'colours/toplevel_methods/use_colours.rb'
+require 'colours/toplevel_methods/prefer_this_colour_schemata.rb'
+require 'colours/autogenerated/support_for_256_colours.rb'
+require 'colours/autogenerated/support_for_html_colours.rb'
+
+module Colours
+
+  # ========================================================================= #
+  # === Colours.sfile
+  #
+  # This method can be explicitely used to colour files, such as
+  # '/opt/foobar.rb'.
+  #
+  # Invocation examples:
+  #
+  #   Colours.sfile('/opt/foobar.rb')
+  #   Colours.sfile('/tmp/test.md')
+  #   Colours.sfile('Hello world!')
+  #
+  # ========================================================================= #
+  def self.sfile(
+      i            = '',
+      make_newline = false
+    )
+    if @use_colours
+      if @use_html_colours
+        i = SupportForHTMLColours.send(
+          map_this_symbol_to_that_html_colour(@colour_table[__method__.to_sym]), i
+        )
+      elsif @use_256_colours
+        use_this_colour = map_this_symbol_to_that_256_colour(@colour_table[__method__.to_sym])
+        i = SupportFor256Colours.send(use_this_colour, i)
+      else
+        i = "#{corresponding_colour?(@colour_table[__method__.to_sym])}"\
+            "#{i}"\
+            "#{rev}"
+      end
+    end
+    i
+  end
+
+  # ========================================================================= #
+  # === sfile
+  # ========================================================================= #
+  def sfile(i = '')
+    ::Colours.sfile(i)
+  end
+
+  # ========================================================================= #
+  # === efile
+  # ========================================================================= #
+  def efile(
+      i            = '',
+      make_newline = false
+    )
+    e sfile(i, make_newline)
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  puts Colours.sfile('Hello world!')+' And this should appear in another colour.'
+end # 

data/lib/colours/colour_methods/simportant.rb

@@ -0,0 +1,92 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'colours/colour_methods/simportant.rb'
+# =========================================================================== #
+require 'colours/revert/revert.rb'
+require 'colours/colour_table/colour_table.rb'
+require 'colours/toplevel_methods/use_colours.rb'
+require 'colours/toplevel_methods/prefer_this_colour_schemata.rb'
+require 'colours/autogenerated/support_for_html_colours.rb'
+
+module Colours
+
+  # ========================================================================= #
+  # === Colours.simportant
+  #
+  #This method is the one to denote "important" text components.
+  #
+  # Invocation examples:
+  #
+  #   Colours.simportant('Hello world!')
+  #   Colours.simportant('yo there')
+  #
+  # ========================================================================= #
+  def self.simportant(
+      i            = '',
+      make_newline = false
+    )
+    if @use_colours
+      if @use_html_colours
+        i = SupportForHTMLColours.send(
+          map_this_symbol_to_that_html_colour(@colour_table[__method__.to_sym]), i
+        )
+      elsif @use_256_colours
+        use_this_colour = map_this_symbol_to_that_256_colour(@colour_table[__method__.to_sym])
+        i = SupportFor256Colours.send(use_this_colour, i)
+      else
+        i = "#{corresponding_colour?(@colour_table[__method__.to_sym])}"\
+            "#{i}"\
+            "#{rev}"
+      end
+    end
+    i
+  end; self.instance_eval { alias simp simportant } # === Colours.simp
+
+  # ========================================================================= #
+  # === simportant
+  #
+  # Delegate towards Colours.simportant() here.
+  # ========================================================================= #
+  def simportant(
+      i            = '',
+      make_newline = false
+    )
+    Colours.simportant(i, make_newline)
+  end; alias simp simportant # === simp
+       alias si   simportant # === si
+
+  # ========================================================================= #
+  # === ciif
+  # ========================================================================= #
+  def ciif(i)
+    eimportant(i, false)
+  end # Alias to the above, basically.
+
+  # ========================================================================= #
+  # === Colours.eimp
+  # ========================================================================= #
+  def self.eimp(
+      i            = '',
+      make_newline = false
+    )
+    e simp(i, make_newline)
+  end
+
+  # ========================================================================= #
+  # === eimportant
+  # ========================================================================= #
+  def eimportant(
+      i            = '',
+      make_newline = false
+    )
+    Colours.eimp(i, make_newline)
+  end; alias eimp eimportant # === eimp
+       alias cii  eimportant # === cii
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  puts Colours.simportant('Hello world!')
+end

data/lib/colours/colour_methods/snormal.rb

@@ -0,0 +1,66 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'colours/colour_methods/snormal.rb'
+# =========================================================================== #
+require 'colours/revert/revert.rb'
+require 'colours/colour_table/colour_table.rb'
+require 'colours/toplevel_methods/use_colours.rb'
+require 'colours/toplevel_methods/prefer_this_colour_schemata.rb'
+require 'colours/autogenerated/support_for_html_colours.rb'
+
+module Colours
+
+  # ========================================================================= #
+  # === Colours.snormal
+  #
+  # Invocation example:
+  #   Colours.snormal('Hello world!')
+  # ========================================================================= #
+  def self.snormal(
+      i            = '',
+      make_newline = false
+    )
+    if @use_colours
+      if @use_html_colours
+        i = SupportForHTMLColours.send(
+          map_this_symbol_to_that_html_colour(@colour_table[__method__.to_sym]), i
+        )
+      elsif @use_256_colours
+        use_this_colour = map_this_symbol_to_that_256_colour(@colour_table[__method__.to_sym])
+        i = SupportFor256Colours.send(use_this_colour, i)
+      else
+        i = "#{corresponding_colour?(@colour_table[__method__.to_sym])}"\
+            "#{i}"\
+            "#{rev}"
+      end
+    end
+    i
+  end
+
+  # ========================================================================= #
+  # === snormal
+  # ========================================================================= #
+  def snormal(
+      i            = '',
+      make_newline = false
+    )
+    Colours.snormal(i, make_newline)
+  end
+
+  # ========================================================================= #
+  # === enormal
+  # ========================================================================= #
+  def enormal(
+      i            = '',
+      make_newline = false
+    )
+    e snormal(i, make_newline)
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  puts Colours.snormal('Hello world!')
+end #