dataMetaXtra 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 00761eca06212bd8aeb1fc0a7314ea2c6b617d0b
-  data.tar.gz: 0494fe83175c12733454a2be40b8830dfe80b255
+  metadata.gz: cca4846eafcfe7b4ef6f54372f4bc56e27195b0f
+  data.tar.gz: 191f595bcf3eab1fe6e07e0e431ec665c0c80d29
 SHA512:
-  metadata.gz: 49dfcb62a7601f35d4a4438c78c4a993587571b2629300468edad1532d62b41fe18cb09bcfbb36d1fedb6f879b30c6e0ca3f6ffe953aa451f397dd6489fbb86f
-  data.tar.gz: 5392d0eced309ab9a28c7de1da92b69b3423b350062d3fbbfc1d148cba38eb4e22a4fe5e97fd5ed000ca1d55828bd19ffcc15840047e787ebf3281351db9ad5f
+  metadata.gz: db358118e0f954b806dc7b359134d6124bb34ec238d887805cc54df8d5f078b2aba9d93b7bd5d2bfa3852cd07f3faddb315e4e7e7be3ece0ef9449c9d743bc71
+  data.tar.gz: db7c57ec86b6a84234c34f902449d05c4ec2e8dea9a951e455a5771741e2883885bd3c2c8aee91d4b3cc55306feeb30e03d0c767dc666a6435826a123567fbef

data/History.md

@@ -1,5 +1,9 @@
 # `dataMetaXtra` Release history:
 
+## `1.1.0` released `2018-11-14 Wed`
+* 1  minor enhancement:
+    * Added ANSI escape symbols handling and helpful glyphs to use in a terminal.
+
 ## `1.0.0` released `2017-01-15`
 * 1 major enhancement:
     * Initial release

data/lib/dataMetaXtra.rb

@@ -6,7 +6,7 @@ require 'logger'
 #Various extensions to the Ruby SDK addressing whatever shortcomings we run into.
 module DataMetaXtra
     # Current version
-    VERSION = '1.0.0'
+    VERSION = '1.1.0'
 
     # Default Logger datetime format
     LOGGER_DTTM_FMT = '%Y-%m-%d %H:%M:%S'
@@ -36,7 +36,7 @@ module DataMetaXtra
             when WINDOWS
                 "#{ENV['HOMEDRIVE']}/#{ENV['HOMEPATH'].gsub(/\\/, '/')}"
             when CYGWIN
-                "#{ENV['HOME']}" # changed in latest versions of CygWin, now you get /cygdrive/c/Users/mubergens/
+                "#{ENV['HOME']}"
                 #"/cygdrive/#{ENV['HOMEDRIVE'][0, 1].downcase}#{ENV['HOMEPATH'].gsub(/\\/, '/')}"
             else # Linux, MacOS (verified)
                 "#{ENV['HOME']}"

data/lib/dataMetaXtra/ansi.rb

@@ -0,0 +1,231 @@
+require_relative './glyphs'
+module DataMetaXtra
+
+# ANSI control sequences.
+module AnsiCtl
+
+# https://en.wikipedia.org/wiki/ANSI_escape_code
+
+# Skip ANSI Escape sequences unless this env var is defined and set to 'yes'
+  SKIP_ANSI_ESC = ENV['DATAMETA_USE_ANSI_CTL'] != 'yes'
+  include Glyphs
+  # ANSI escape operation start
+  OP = SKIP_ANSI_ESC ? '' : 27.chr + '['
+  # ANSI atribute divider. When the ANSI seqs are disabled, this takes care of concatenating those.
+  ATRB_DIV = SKIP_ANSI_ESC ? ';' : ''
+  # Plain text
+  PLAIN = SKIP_ANSI_ESC ? '' : '0'
+  # Reset sequence
+  RESET = SKIP_ANSI_ESC ? '' : "#{OP}m"
+  
+  # Styles:
+  # Bold
+  BOLD = SKIP_ANSI_ESC ? '' : '1'
+  # Dimmed
+  DIM = SKIP_ANSI_ESC ? '' : '2'
+  # Underline
+  ULINE = SKIP_ANSI_ESC ? '' : '4'
+  # Blinking
+  BLINK = SKIP_ANSI_ESC ? '' : '5'
+  # Reverse graphics
+  REVERSE = SKIP_ANSI_ESC ? '' : '7'
+  # Hidden text - to enter passwords
+  HIDDEN = SKIP_ANSI_ESC ? '' : '8'
+  # Reset Bold
+  REBOLD = SKIP_ANSI_ESC ? '' : "2#{BOLD}"
+  # Reset Dim
+  REDIM = SKIP_ANSI_ESC ? '' : "2#{DIM}"
+  # Reset Underline
+  REULINE = SKIP_ANSI_ESC ? '' : "2#{ULINE}"
+  # Reset Blink
+  REBLINK = SKIP_ANSI_ESC ? '' : "2#{BLINK}"
+  # Reset reverse graphics
+  REREVERSE = SKIP_ANSI_ESC ? '' : "2#{REVERSE}"
+  # Reset hidden text
+  REHIDDEN = SKIP_ANSI_ESC ? '' : "2#{HIDDEN}"
+  
+  # Foregrounds:
+  # Default foreground
+  F_DEF = SKIP_ANSI_ESC ? '' : '39'
+  # Black foreground
+  F_BLACK = SKIP_ANSI_ESC ? '' : '30'
+  #  Red foreground
+  F_RED = SKIP_ANSI_ESC ? '' : '31'
+  # Green foreground
+  F_GREEN = SKIP_ANSI_ESC ? '' : '32'
+  # Brown foreground
+  F_BROWN = SKIP_ANSI_ESC ? '' : '33'
+  # Yellow, alias for BROWN foreground
+  F_YELLOW = SKIP_ANSI_ESC ? '' : F_BROWN
+  # blue foreground
+  F_BLUE = SKIP_ANSI_ESC ? '' : '34'
+  # Purple foreground
+  F_PURPLE = SKIP_ANSI_ESC ? '' : '35'
+  # Magenta, alias or PURPLE foreground
+  F_MAGENTA = SKIP_ANSI_ESC ? '' : F_PURPLE
+  # Cyan foreground
+  F_CYAN = SKIP_ANSI_ESC ? '' : '36'
+  # Light Grey foreground
+  F_LGREY = SKIP_ANSI_ESC ? '' : '37'
+  # Light Gray, alias for GREY foreground
+  F_LGRAY = SKIP_ANSI_ESC ? '' : F_LGREY
+  # Dark Grey foreground
+  F_DGREY = SKIP_ANSI_ESC ? '' : '90'
+  # Dark Gray, alias for GRAY foreground
+  F_DGRAY = SKIP_ANSI_ESC ? '' : F_DGREY
+
+  # Light Red foreground
+  F_LRED = SKIP_ANSI_ESC ? '' : '91'
+  # Light Green foreground
+  F_LGREEN = SKIP_ANSI_ESC ? '' : '92'
+  # Light Brown foreground
+  F_LBROWN = SKIP_ANSI_ESC ? '' : '93'
+  # Light Yellow, alias for BROWN foreground
+  F_LYELLOW = SKIP_ANSI_ESC ? '' : F_LBROWN
+  # Light Blue foreground
+  F_LBLUE = SKIP_ANSI_ESC ? '' : '94'
+  # Light Purple foreground
+  F_LPURPLE = SKIP_ANSI_ESC ? '' : '95'
+  # Light Magenta, alias for PURPLE foreground
+  F_LMAGENTA = SKIP_ANSI_ESC ? '' : F_LPURPLE
+  # Light Cyan foreground
+  F_LCYAN = SKIP_ANSI_ESC ? '' : '96'
+  # Light White foreground
+  F_WHITE = SKIP_ANSI_ESC ? '' : '97'
+
+  # Close the ANSI Escape Sequence
+  CL = SKIP_ANSI_ESC ? '' : 'm'
+
+  # Black background
+  B_BLACK = SKIP_ANSI_ESC ? '' : '40'
+  # Red background
+  B_RED = SKIP_ANSI_ESC ? '' : '41'
+  # Green background
+  B_GREEN = SKIP_ANSI_ESC ? '' : '42'
+  # Brown background
+  B_BROWN = SKIP_ANSI_ESC ? '' : '43'
+  # Yellow, alias for BROWN background
+  B_YELLOW = SKIP_ANSI_ESC ? '' : B_BROWN
+  # Blue background
+  B_BLUE = SKIP_ANSI_ESC ? '' : '44'
+  # Purple background
+  B_PURPLE = SKIP_ANSI_ESC ? '' : '45'
+  # Magenta, alias for PURPLE background
+  B_MAGENTA = SKIP_ANSI_ESC ? '' : B_PURPLE
+  # Cyan background
+  B_CYAN = SKIP_ANSI_ESC ? '' : '46'
+  # Light Grey background
+  B_LGREY = SKIP_ANSI_ESC ? '' : '47'
+  # Light Gray, alias for GRAY background
+  B_LGRAY = SKIP_ANSI_ESC ? '' : B_LGREY
+  # Dark Grey background
+  B_DGREY = SKIP_ANSI_ESC ? '' : '100'
+  # Dark Gray, alias for GRAY background
+  B_DGRAY = SKIP_ANSI_ESC ? '' : B_DGREY
+
+  # Plain background
+  B_PLAIN = SKIP_ANSI_ESC ? '' : '49'
+  # Default background
+  B_DEFAULT = SKIP_ANSI_ESC ? '' : B_PLAIN
+
+  # Light Red background
+  B_LRED = SKIP_ANSI_ESC ? '' : '101'
+  # Light Green background
+  B_LGREEN = SKIP_ANSI_ESC ? '' : '102'
+  # Light Brown background
+  B_LBROWN = SKIP_ANSI_ESC ? '' : '103'
+  # Light Yellow, alias for BROWN background
+  B_LYELLOW = SKIP_ANSI_ESC ? '' : B_LBROWN
+  # Light Blue background
+  B_LBLUE = SKIP_ANSI_ESC ? '' : '104'
+  # Light Purple background
+  B_LPURPLE = SKIP_ANSI_ESC ? '' : '105'
+  # Light Magenta, alias for PURPLE background
+  B_LMAGENTA = SKIP_ANSI_ESC ? '' : B_LPURPLE
+  # Light Cyan background
+  B_LCYAN = SKIP_ANSI_ESC ? '' : '106'
+  # Light White background
+  B_WHITE = SKIP_ANSI_ESC ? '' : '107'
+
+  # All Styles with names
+  STYLES = {
+      BOLD => 'BOLD',
+      DIM => 'DIM',
+      ULINE => 'ULINE',
+      BLINK => 'BLINK',
+      REVERSE => 'REVERSE',
+      HIDDEN => 'HIDDEN',
+      REBOLD => 'RE-BOLD',
+      REDIM => 'RE-DIM',
+      REULINE => 'RE-ULINE',
+      REBLINK => 'RE-BLINK',
+      REREVERSE => 'RE-REVERSE',
+      REHIDDEN => 'RE-HIDDEN'
+  }
+
+  # All Foregrounds with names
+  FORES = {
+      F_DEF => 'F_DEF',
+      F_BLACK => 'F_BLACK',
+      F_RED => 'F_RED',
+      F_GREEN => 'F_GREEN',
+      F_BROWN => 'F_BROWN',
+      F_BLUE => 'F_BLUE',
+      F_PURPLE => 'F_PURPLE',
+      F_CYAN => 'F_CYAN',
+      F_LGREY => 'F_LGREY',
+      F_DGREY => 'F_DGREY',
+      F_LRED => 'F_LRED',
+      F_LGREEN => 'F_LGREEN',
+      F_LBROWN => 'F_LBROWN',
+      F_LBLUE => 'F_LBLUE',
+      F_LPURPLE => 'F_LPURPLE',
+      F_LCYAN => 'F_LCYAN',
+      F_WHITE => 'F_WHITE',
+  }
+
+  # All Backgrounds with names
+  BACKS = {
+      B_BLACK => 'B_BLACK',
+      B_RED => 'B_RED',
+      B_GREEN => 'B_GREEN',
+      B_BROWN => 'B_BROWN',
+      B_BLUE => 'B_BLUE',
+      B_PURPLE => 'B_PURPLE',
+      B_CYAN => 'B_CYAN',
+      B_LGREY => 'B_LGREY',
+      B_DGREY => 'B_DGREY',
+
+      B_DEFAULT => 'B_DEFAULT',
+
+      B_LRED => 'B_LRED',
+      B_LGREEN => 'B_LGREEN',
+      B_LBROWN => 'B_LBROWN',
+      B_LBLUE => 'B_LBLUE',
+      B_LPURPLE => 'B_LPURPLE',
+      B_LCYAN => 'B_LCYAN',
+      B_WHITE => 'B_WHITE',
+  }
+
+  # convenient test for all styles
+  def test
+    puts
+    out = ''
+    BACKS.keys.each { |b|
+      FORES.keys.each { |f|
+        STYLES.keys.each { |s|
+          out << %<#{LLQBIG}#{OP}#{s};#{f};#{b}m#{FORES[f]}/#{BACKS[b]}:#{STYLES[s]}#{RESET}#{RRQBIG}>
+          if out.length > 240
+            puts out
+            out = ''
+          end
+        }
+      }
+      print "\n"
+    }
+    puts
+  end
+  module_function :test
+end
+
+end

data/lib/dataMetaXtra/fileSys.rb

@@ -218,7 +218,7 @@ Creates an instance
 @param [String] user user permissions, can be passed as {Perm} object or String or Fixnum, see the method {PosixPerms.from} for details.
 @param [String] group group permissions, can be passed as {Perm} object or String or Fixnum, see the method {PosixPerms.from} for details.
 @param [String] world world permissions, can be passed as {Perm} object or String or Fixnum, see the method {PosixPerms.from} for details.
-@param [String] sticky flag, can be passed as {Perm} object or String or Fixnum, see the method {PosixPerms.from} for details.
+@param [String] sys system permissions, can be passed as {Perm} object or String or Fixnum, see the method {PosixPerms.from} for details.
 =end
             def initialize(user, group, world, sys = nil)
                 @u = PosixPerms.from(user, 'user')

data/lib/dataMetaXtra/glyphs.rb

@@ -0,0 +1,96 @@
+module DataMetaXtra
+  # Useful glyphs that can be used on the console and beyond
+  module Glyphs
+    # a version of an arrow pointing right
+    SPEAR = '➤'
+    # a version of an arrow pointing right
+    RTRI = '►'
+    # a version of an arrow pointing left
+    LTRI = '◄'
+    # a version of an arrow pointing right
+    RRTRI = '⏩'
+    # a version of an arrow pointing left
+    LLTRI = '⏪'
+    # Small left quote
+    LLQ = '«'
+    # Small right quote
+    RRQ = '»'
+
+    # Big left quote
+    LLQBIG = '《'
+    # Big right quote
+    RRQBIG = '》'
+
+    # Huge left square bracket
+    LSQBR = '【'
+    # Huge right square bracket
+    RSQBR = '】'
+    # Small black box
+    SFSQ = '▮'
+    # Small white box
+    SESQ = '▯'
+    # Big Star
+    STAR = '✱'
+    # Small diamond
+    DIAM = '♦'
+    # Big black rectangle
+    SQRBULLF = '⬛'
+    # Big White rectangle
+    SQRBULLE = '⬜'
+    # Big black circle
+    CIRBULLF = '⬤'
+    # Big White circle
+    CIRBULLE = '◯'
+    # Sparse shade
+    SHADE1 = '░'
+    # Dense shade
+    SHADE2 = '▒'
+
+    # Tall black rectangle 1
+    TALLBLK1 = '▉'
+    # Tall black rectangle 2
+    TALLBLK2 = '▇'
+    # Tall black rectangle 3
+    TALLBLK3 = '▆'
+    # Tall black rectangle 4
+    TALLBLK4 = '█'
+
+    # Small checkmark
+    CHKT = '✓'
+    # Big checkmark
+    CHKF = '✔'
+
+    # Thin x
+    XTHIN = '✗'
+    # Thick x
+    XFAT = '✘'
+
+    # Left pointing arrow (West, W)
+    RARR = '←'
+    # Right pointing arrow (East, E)
+    LARR = '→'
+    # Up pointing arrow (North, N)
+    UARR = '↑'
+    # Down pointing arrow (South, S)
+    DARR = '↓'
+    # WE arrow
+    LRARR = '↔'
+    # NS arrow
+    UDARR = '↕'
+    # NW arrow
+    ULARR = '↖'
+    # NE arrow
+    URARR = '↗'
+    # SE arrow
+    DLARR = '↘'
+    # SW arrow
+    DRARR = '↙'
+    # Long left arrow
+    LARRR = '⟵'
+    # Long right arrow
+    RARRR = '⟶'
+    # Long WE arrow.
+    RLARRR = '⟷'
+
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dataMetaXtra
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Michael Bergens
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-15 00:00:00.000000000 Z
+date: 2018-11-14 00:00:00.000000000 Z
 dependencies: []
 description: A few small enhancements to some standard Ruby classes in one place convenient
   place.
@@ -24,7 +24,9 @@ files:
 - README.md
 - Rakefile
 - lib/dataMetaXtra.rb
+- lib/dataMetaXtra/ansi.rb
 - lib/dataMetaXtra/fileSys.rb
+- lib/dataMetaXtra/glyphs.rb
 homepage: https://github.com/eBayDataMeta
 licenses:
 - Apache-2.0
@@ -45,7 +47,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2.1
 signing_key: 
 specification_version: 4
 summary: Small enhancements to a few Ruby standard classes.