ectoplasm 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c1eb29f58f2221ef27a4f8f927700751434a9dcaf611b363d9d8e37475ab6dd8
+  data.tar.gz: 1d7a409eb8144a8f0d4aaeb4f5c021558187a2ae6dc919fbf68c17a0a25ed6e2
+SHA512:
+  metadata.gz: 9ebc3a14e186fccdba32800f8070d87cf161199101fa4cc003c7a585c906c7a358e6788dc695e73beeabf2b1779d28dcccf30c548b24432251027b4ff1e62bad
+  data.tar.gz: b7f0953c64c18024fe555cf2d68a4444c432ae567e291a8ab988b403e9c61b1f61b5ad09904fec57734114ccb167559da588d5524a4e7f21249ce1412baabd85

data/.gitignore

@@ -0,0 +1,3 @@
+vscode/
+*.lock
+*.gem

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem "rake", ">= 12.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Christian Neubauer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,3 @@
+# Ectoplasm
+
+A helper library for console output

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ectoplasm"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/ectoplasm.gemspec

@@ -0,0 +1,29 @@
+require_relative 'lib/ectoplasm'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ectoplasm"
+  spec.version       = Ectoplasm::VERSION
+  spec.authors       = ["Christian Neubauer"]
+  spec.email         = ["me@christianneubauer.de"]
+
+  spec.summary       = "A helper library for console output"
+  spec.description   = "Adds some extension methods to build in types to add prettier console output"
+  spec.homepage      = "https://bitbucket.org/cneubaur/ectoplasm-ruby"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://bitbucket.org/cneubaur/ectoplasm-ruby"
+  spec.metadata["changelog_uri"] = "https://bitbucket.org/cneubaur/ectoplasm-ruby/src/master/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

data/lib/ectoplasm.rb

@@ -0,0 +1,219 @@
+module Ectoplasm
+  module Version
+    MAJOR = 1
+    MINOR = 1
+    TINY  = 0
+  end
+
+  VERSION = [Version::MAJOR, Version::MINOR, Version::TINY].compact * '.'
+end
+
+class String
+  @@colored = false
+
+  def self.colored!
+    @@colored = true
+  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.lines.map { |line| char * amount + line }.join "\n"
+  end
+
+  def length
+    m = /\e\[\d{2}m(.*)\e\[0m/.match self
+    return self.chars.count - 9 if m
+    self.chars.count
+  end
+
+  def lines separator="\n"
+    self.split separator
+  end
+
+  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
+
+    str
+  end
+
+  private
+
+  def colored ansi_color
+    return self if !@@colored
+    "\e[#{ansi_color}m#{self}\e[0m"
+  end
+end
+
+
+class Object
+  def pretty width: nil
+    self.to_s
+  end
+end
+
+
+class TrueClass
+  def pretty width: nil
+    'yes'.green
+  end
+end
+
+
+class FalseClass
+  def pretty width: nil
+    'no'.yellow
+  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
+
+    self
+      .select { |x| x != nil && x != '' }
+      .map do |x|
+        ' - ' + x.pretty(width: width-3).strip.gsub(/\n/, "\n   ")
+      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 = self.slice(0, limit).map do |row|
+      heading.map do |key|
+        mappings.has_key?(key) ? mappings[key][row, row[key]] : row[key]
+      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 }
+
+    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
+
+      row.each do |col_size, data|
+        table_str += (data.to_s + ' ' * (col_size - data.to_s.length)) + '    '
+      end
+
+      table_str += "\n"
+    end
+    table_str += '[...]' if self.count > limit
+    print table_str
+  end
+end
+
+
+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
+
+        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
+
+        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
+          end
+
+          value = list
+        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"
+      end
+
+    s
+  end
+end
+
+
+class Float
+  def duration
+    seconds = self
+
+    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
+
+    duration_str = "#{seconds}s"
+    duration_str = "#{minutes}m #{duration_str}" if minutes
+    duration_str = "#{hours}h #{duration_str}" if hours
+
+    duration_str
+  end
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: ectoplasm
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+platform: ruby
+authors:
+- Christian Neubauer
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-11-30 00:00:00.000000000 Z
+dependencies: []
+description: Adds some extension methods to build in types to add prettier console
+  output
+email:
+- me@christianneubauer.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ectoplasm.gemspec
+- lib/ectoplasm.rb
+homepage: https://bitbucket.org/cneubaur/ectoplasm-ruby
+licenses:
+- MIT
+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: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: A helper library for console output
+test_files: []