ectoplasm 1.1.0 → 1.2.2

data/README.md

@@ -1,3 +1,23 @@
 # Ectoplasm
 
-A helper library for console output
+A helper library for prettier console output
+
+## Added Methods
+
+| Type | Method | Arguments | Description |
+| ---- | ------ | --------- | ----------- |
+| `String` | `colored!` | _none_ | Enables colored string output |
+| `string` | `white` | _none_ | Prints the text in white |
+| `string` | `red` | _none_ | Prints the text in red. Alias: `error` |
+| `string` | `green` | _none_ | Prints the text in green. Alias: `ok` |
+| `string` | `yellow` | _none_ | Prints the text in yellow. Alias: `warn` |
+| `string` | `blue` | _none_ | Prints the text in blue. Alias: `info` |
+| `string` | `magenta` | _none_ | Prints the text in magenta |
+| `string` | `cyan` | _none_ | Prints the text in cyan |
+| `string` | `grey` | _none_ | Prints the text in grey. Alias: `dim` |
+| `string` | `indent` | `amount, char: ' '` | Indents all lines of the string by the given amount with the provided character |
+| `string` | `frmt` | `prefix_suffix=['<', '>']` | Named string substitution |
+| `Hash` | `pretty` | `width: 25` | Outputs a `Hash` in a pretty structure |
+| `Hash` | `obfuscate` | `secure_keys=['password', 'secret', 'token', 'secure']` | Obfuscates the values of a `Hash`, when the key is like the given ones |
+| `Float` | `duration` | _none_ | Formats the `Float` as a duration string e.g. `1h 42m 2s` |
+

data/lib/ectoplasm.rb

@@ -1,219 +1,246 @@
+require 'ostruct'
+
 module Ectoplasm
   module Version
     MAJOR = 1
-    MINOR = 1
-    TINY  = 0
+    MINOR = 2
+    TINY  = 2
   end
 
   VERSION = [Version::MAJOR, Version::MINOR, Version::TINY].compact * '.'
-end
 
-class String
-  @@colored = false
+  DEFAULT_SECURE_KEYS = ['password', 'secret', 'token', 'secure']
 
-  def self.colored!
-    @@colored = true
-  end
+  class ::String
+    @@colored = false
 
-  def white;   self; end
-  def red; colored '31'; end
-  def green; colored '32'; end
-  def yellow; colored '33'; end
-  def blue; colored '34'; end
-  def magenta; colored '35'; end
-  def cyan; colored '36'; end
-  def grey; colored '90'; end
-
-  alias ok green
-  alias error red
-  alias warn yellow
-  alias info blue
-  alias dim grey
-
-  def indent amount, char: ' '
-    self.lines.map { |line| char * amount + line }.join "\n"
-  end
+    def self.colored!
+      @@colored = true
+    end
 
-  def length
-    m = /\e\[\d{2}m(.*)\e\[0m/.match self
-    return self.chars.count - 9 if m
-    self.chars.count
-  end
+    def white;   self; end
+    def red; colored '31'; end
+    def green; colored '32'; end
+    def yellow; colored '33'; end
+    def blue; colored '34'; end
+    def magenta; colored '35'; end
+    def cyan; colored '36'; end
+    def grey; colored '90'; end
+
+    alias ok green
+    alias error red
+    alias warn yellow
+    alias info blue
+    alias dim grey
+
+    def indent amount, char: ' '
+      self.split("\n").map { |line| char * amount + line }.join "\n"
+    end
 
-  def lines separator="\n"
-    self.split separator
-  end
+    def length
+      m = /\e\[\d{2}m(.*)\e\[0m/.match self
+      return self.chars.count - 9 if m
+      self.chars.count
+    end
+
+    def frmt props, prefix_suffix=['<', '>']
+      str = self
 
-  def frmt props, prefix_suffix=['<', '>']
-    str = self
+      props.keys.each do |key|
+        placeholder = prefix_suffix[0] + key.to_s + prefix_suffix[1]
+        str = str.gsub(placeholder, props[key])
+      end
 
-    props.keys.each do |key|
-      placeholder = prefix_suffix[0] + key.to_s + prefix_suffix[1]
-      str = str.gsub(placeholder, props[key])
+      str
     end
 
-    str
+    private
+
+    def colored ansi_color
+      return self if !@@colored
+      "\e[#{ansi_color}m#{self}\e[0m"
+    end
   end
 
-  private
 
-  def colored ansi_color
-    return self if !@@colored
-    "\e[#{ansi_color}m#{self}\e[0m"
+  class ::Object
+    def pretty width: nil
+      self.to_s
+    end
+
+    def obfuscate! secure_keys
+      self
+    end
   end
-end
 
 
-class Object
-  def pretty width: nil
-    self.to_s
+  class ::TrueClass
+    def pretty width: nil
+      'yes'.green
+    end
   end
-end
 
 
-class TrueClass
-  def pretty width: nil
-    'yes'.green
+  class ::FalseClass
+    def pretty width: nil
+      'no'.yellow
+    end
   end
-end
 
 
-class FalseClass
-  def pretty width: nil
-    'no'.yellow
+  class ::NilClass
+    def pretty width: nil
+      'n/a'.grey
+    end
   end
-end
 
 
-class NilClass
-  def pretty width: nil
-    'n/a'.grey
-  end
-end
+  class ::Array
+    def pretty width: 25
+      return 'empty'.grey if self.length == 0
 
+      list_length = self.map { |x| x.to_s.length }.reduce(:+)
+      return self.join ', ' if list_length && list_length < 30
 
-class Array
-  def pretty width: 25
-    return 'empty'.grey if self.length == 0
+      self
+        .select { |x| x != nil && x != '' }
+        .map do |x|
+          ' - ' + x.pretty(width: width-3).strip.gsub(/\n/, "\n   ")
+        end
+        .join "\n"
+    end
 
-    list_length = self.map { |x| x.to_s.length }.reduce(:+)
-    return self.join ', ' if list_length && list_length < 30
+    def table header: nil, mappings: {}, with_index: false, limit: 50
+      header = self[0].keys if header == nil
+      heading = header.is_a?(Array) ? header : self[0].keys
 
-    self
-      .select { |x| x != nil && x != '' }
-      .map do |x|
-        ' - ' + x.pretty(width: width-3).strip.gsub(/\n/, "\n   ")
+      table_data = self.slice(0, limit).map do |row|
+        heading.map do |key|
+          mappings.has_key?(key) ? mappings[key][row, row[key]] : row[key]
+        end
       end
-      .join "\n"
-  end
 
-  def table header: nil, mappings: {}, with_index: false, limit: 50
-    header = self[0].keys if header == nil
-    heading = header.is_a?(Array) ? header : self[0].keys
+      table_data.insert(0, heading) if header != false
 
-    table_data = self.slice(0, limit).map do |row|
-      heading.map do |key|
-        mappings.has_key?(key) ? mappings[key][row, row[key]] : row[key]
+      data_sizes = table_data.map do |row|
+        row.map { |data| data.to_s.length }
       end
-    end
-
-    table_data.insert(0, heading) if header != false
 
-    data_sizes = table_data.map do |row|
-      row.map { |data| data.to_s.length }
-    end
+      column_sizes = data_sizes[0]
+        .zip(*data_sizes[1..-1])
+        .map { |row| row.max }
 
-    column_sizes = data_sizes[0]
-      .zip(*data_sizes[1..-1])
-      .map { |row| row.max }
+      table = table_data.map { |row| column_sizes.zip row }
 
-    table = table_data.map { |row| column_sizes.zip row }
+      table_str = ''
+      table.each_with_index do |row, index|
+        if with_index
+          if index == 0
+            table_str += '     '
+          else
+            table_str += "[#{index}]  "
+          end
+        end
 
-    table_str = ''
-    table.each_with_index do |row, index|
-      if with_index
-        if index == 0
-          table_str += '     '
-        else
-          table_str += "[#{index}]  "
+        row.each do |col_size, data|
+          table_str += (data.to_s + ' ' * (col_size - data.to_s.length)) + '    '
         end
-      end
 
-      row.each do |col_size, data|
-        table_str += (data.to_s + ' ' * (col_size - data.to_s.length)) + '    '
+        table_str += "\n"
       end
+      table_str += '[...]' if self.count > limit
+      print table_str
+    end
 
-      table_str += "\n"
+    def obfuscate! secure_keys = DEFAULT_SECURE_KEYS
+      self.map { |x| x.obfuscate!(secure_keys) }
     end
-    table_str += '[...]' if self.count > limit
-    print table_str
   end
-end
 
 
-class Hash
-  def pretty indent: 0, width: 25
-    s = ''
+  class ::Hash
+    def pretty indent: 0, width: 25
+      s = ''
 
-    self
-      .select { |key, value| value != nil || value != '' }
-      .map do |key, value|
-        value = true if value == 'true'
-        value = false if value == 'false'
-        value = '********' if /password|pwd|pass|passwd|secret/ =~ key.to_s
+      self
+        .select { |key, value| value != nil || value != '' }
+        .map do |key, value|
+          value = true if value == 'true'
+          value = false if value == 'false'
+          value = '********' if /password|pwd|pass|passwd|secret/ =~ key.to_s
 
-        if value.is_a? Hash
-          s += key.to_s.cyan.indent(indent) + "\n"
-          s += value.pretty(width: width-indent-2).indent(indent+2)
-          s += "\n"
-          next
-        end
+          if value.is_a? Hash
+            s += key.to_s.cyan.indent(indent) + "\n"
+            s += value.pretty(width: width-indent-2).indent(indent+2)
+            s += "\n"
+            next
+          end
 
-        s += ' ' * indent
+          s += ' ' * indent
 
-        if value.is_a? Array
-          list = value.pretty(width: width)
+          if value.is_a? Array
+            list = value.pretty(width: width)
 
-          if list.lines.count > 1
-            s += key.to_s.cyan + "\n"
-            s += value.pretty(width: width).indent(indent)
-            s += "\n"
-            next
+            if list.split("\n").count > 1
+              s += key.to_s.cyan + "\n"
+              s += value.pretty(width: width).indent(indent)
+              s += "\n"
+              next
+            end
+
+            value = list
           end
 
-          value = list
+          s += key.to_s.cyan
+          s += ' ' + '.' * (width-key.to_s.length-indent) if width-key.to_s.length > indent
+          s += ': '
+          s += value.pretty + "\n"
         end
 
-        s += key.to_s.cyan
-        s += ' ' + '.' * (width-key.to_s.length-indent) if width-key.to_s.length > indent
-        s += ': '
-        s += value.pretty + "\n"
+      s
+    end
+
+    def obfuscate! secure_keys = DEFAULT_SECURE_KEYS
+      self.each do |k, v|
+        if v.is_a? Hash
+          v.obfuscate!(secure_keys)
+        elsif v.is_a? Array
+          v.each { |x| v.obfuscate!(secure_keys) }
+        elsif secure_keys.any? { |x| k.to_s.downcase.include? x.downcase  }
+          self[k] = '*****'
+        end
       end
+    end
+  end
+
 
-    s
+  class ::OpenStruct
+    def obfuscate! secure_keys = ['password', 'secret', 'token', 'secure', 'pass', 'key', 'cert']
+      OpenStruct.new(self.to_h.obfuscate! secure_keys)
+    end
   end
-end
 
 
-class Float
-  def duration
-    seconds = self
+  class ::Float
+    def duration
+      seconds = self
 
-    if seconds > 60
-      seconds = seconds.to_i
-      minutes = seconds / 60
-      seconds = seconds % 60
-    end
+      if seconds > 60
+        seconds = seconds.to_i
+        minutes = seconds / 60
+        seconds = seconds % 60
+      end
 
-    if minutes && minutes > 60
-      hours = minutes / 60
-      minutes = minutes % 60
-    end
+      if minutes && minutes > 60
+        hours = minutes / 60
+        minutes = minutes % 60
+      end
 
-    duration_str = "#{seconds}s"
-    duration_str = "#{minutes}m #{duration_str}" if minutes
-    duration_str = "#{hours}h #{duration_str}" if hours
+      duration_str = "#{seconds}s"
+      duration_str = "#{minutes}m #{duration_str}" if minutes
+      duration_str = "#{hours}h #{duration_str}" if hours
 
-    duration_str
+      duration_str
+    end
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ectoplasm
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.2
 platform: ruby
 authors:
 - Christian Neubauer
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-11-30 00:00:00.000000000 Z
+date: 2022-08-01 00:00:00.000000000 Z
 dependencies: []
 description: Adds some extension methods to build in types to add prettier console
   output
@@ -18,7 +18,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/build.yml"
+- ".github/workflows/gem-push.yml"
 - ".gitignore"
+- ".rubocop.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -34,7 +38,7 @@ metadata:
   homepage_uri: https://bitbucket.org/cneubaur/ectoplasm-ruby
   source_code_uri: https://bitbucket.org/cneubaur/ectoplasm-ruby
   changelog_uri: https://bitbucket.org/cneubaur/ectoplasm-ruby/src/master/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -49,8 +53,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: A helper library for console output
 test_files: []