helium-console 0.1.0 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9dc5199dab8e2122be6f6601ac154b823a0f0c6a89b2fc52d7ce6e97ddb8122
-  data.tar.gz: 9fd7a98d45dd3e4ee441680a35e2f740f2cd44a01e403d4fa86e86f48a21f30a
+  metadata.gz: 6cc078f13cb540c2c2c9d14814cfe31da3b50ebdb59051918db1ac3d3fc63b51
+  data.tar.gz: c9fd23846bad166de9fd715c4166e60a162df08a6f820277c0815f539dac6306
 SHA512:
-  metadata.gz: 12758df2c4c32118f8416691d4179ccb53d85f8bc22fd4a46907f09c678f4a5d5fec4cee6df0f33e250d7e6ebf2e8624c453bd5c12eb44be376c949e01c48627
-  data.tar.gz: a2d9e9a75f7005aad6044639b783df65f59ad1bf570154829e51e841d1c74b995e31fceba3055fdb7c00614054717126bee99b56111be370a2f672aa34e0fc7b
+  metadata.gz: 9259047186f54a53e8378d8fc0c94c35a895334acfb97950ba22511453aa4a0b855866c94d22b323c2249847cf112bcec126ef63ec0c71764fc3dce6c8038213
+  data.tar.gz: 475285e8aae66982bfc86cf3250fbb6e97f88eddf7e7c14228b7158fd8694981c227cc8185e9794869d1c0be27ae6a7f97b789e15269c61a575c850a64ad1263

data/.gitignore

@@ -9,3 +9,5 @@
 
 # rspec failure tracking
 .rspec_status
+
+.byebug_history

data/Gemfile.lock

@@ -1,15 +1,22 @@
 PATH
   remote: .
   specs:
-    helium-console (0.1.0)
-      ruby-terminfo
+    helium-console (0.1.5)
+      colorize
+      pry
 
 GEM
   remote: https://rubygems.org/
   specs:
     byebug (11.1.3)
+    coderay (1.1.3)
+    colorize (0.8.1)
     diff-lcs (1.4.4)
     ffaker (2.18.0)
+    method_source (1.0.0)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
     rake (12.3.3)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
@@ -24,7 +31,6 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.2)
-    ruby-terminfo (0.1.1)
 
 PLATFORMS
   ruby

data/bin/console

@@ -3,12 +3,13 @@
 require "bundler/setup"
 require "helium/console"
 
-# 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.
+require 'byebug'
+require 'ffaker'
 
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
+class A
+  def initialize(a)
+    @a = a
+  end
+end
 
-require "irb"
-IRB.start(__FILE__)
+Pry.start

data/helium-console.gemspec

@@ -22,5 +22,6 @@ Gem::Specification.new do |spec|
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
-  spec.add_dependency "ruby-terminfo"
+  spec.add_dependency "pry"
+  spec.add_dependency "colorize"
 end

data/lib/helium/console.rb

@@ -1,26 +1,102 @@
-require "helium/console/version"
+require "pry"
 
+require "helium/console/version"
 require "helium/console/formatters/indent"
 require "helium/console/formatters/overflow"
 require "helium/console/formatters/max_lines"
-require "terminfo"
+require "helium/console/table"
+require "helium/console/registry"
+
+require "helium/console/printer"
 
 module Helium
-  module Console
+  class Console
     Error = Class.new(StandardError)
 
+    SIMPLE_OBJECTS = [
+      Numeric,
+      NilClass,
+      FalseClass,
+      TrueClass,
+      Symbol
+    ]
+
     class << self
-      def format(text, overflow: :wrap, indent: 0, max_lines: nil, max_width: TermInfo.screen_width)
-        formatters = [
-          Formatters::Overflow.get(overflow).new(max_width: max_width - indent),
-          Formatters::Indent.new(indent),
-          Formatters::MaxLines.new(max_lines: max_lines, max_width: max_width)
-        ]
-
-        formatters.inject(text) do |text, formatter|
-          formatter.call(text)
-        end
+      def instance
+        @instance ||= new(registry: Registry.new)
+      end
+
+      def method_missing(name, *args, &block)
+        super unless instance.respond_to?(name)
+
+        instance.public_send(name, *args, &block)
+      end
+    end
+
+    def initialize(registry:)
+      @registry = registry
+    end
+
+    def format(object, **options)
+      options = default_options.merge(options)
+      return "(...)" if options[:ignore_objects].include?(object.object_id)
+
+      handler = registry.handler_for(object, **options)
+
+      if handler
+        handler.call
+      else
+        format(object.inspect, **options)
       end
     end
+
+    def register(klass, &handler)
+      registry.add(klass, &handler)
+    end
+
+    def define_formatter_for(klass, &handler)
+      registry.define(klass, &handler)
+    end
+
+    def simple?(object)
+      SIMPLE_OBJECTS.any? {|simple_obj_class| object.is_a? simple_obj_class } ||
+        registry.handler_for(object).is_simple
+    end
+
+    def default_options
+      {
+        overflow: :wrap,
+        indent: 0,
+        max_width: `tput cols`.chomp.to_i,
+        level: 1,
+        ignore_objects: [],
+      }
+    end
+
+    def format_string(string, ellipses: "...", **options)
+      options = default_options.merge(options)
+
+      formatters = [
+        Formatters::Overflow.get(options[:overflow]).new(max_width: options[:max_width] - options[:indent]),
+        Formatters::Indent.new(options[:indent]),
+        Formatters::MaxLines.new(
+          max_lines: options[:max_lines],
+          max_width: options[:max_width],
+          ellipses: ellipses
+        )
+      ]
+
+      formatters.inject(string) do |string, formatter|
+        formatter.call(string)
+      end
+    end
+
+  private
+
+    attr_reader :registry
   end
 end
+
+Dir.glob(File.join(File.dirname(__FILE__), "console", "registry", "**/*.rb")).each do |file|
+  require file
+end

data/lib/helium/console/formatters/indent.rb

@@ -1,5 +1,5 @@
 module Helium
-  module Console
+  class Console
     module Formatters
       class Indent
         def initialize(indent)

data/lib/helium/console/formatters/max_lines.rb

@@ -1,11 +1,13 @@
 module Helium
-  module Console
+  class Console
     module Formatters
       class MaxLines
-        ELLIPSES = "..."
-        def initialize(max_lines:, max_width:)
+        ELLIPSES = "...\""
+
+        def initialize(max_lines:, max_width:, ellipses:)
           @max_lines = max_lines
           @max_width = max_width
+          @ellipses = ellipses
         end
 
         def call(string)
@@ -13,7 +15,7 @@ module Helium
 
           lines = string.lines.first(@max_lines)
           last_line = lines.pop
-          lines << last_line.chars.first(@max_width - ELLIPSES.length).join + ELLIPSES
+          lines << last_line.chars.first(@max_width - @ellipses.length).join + @ellipses
           lines.join()
         end
       end

data/lib/helium/console/formatters/overflow.rb

@@ -1,6 +1,6 @@
 
 module Helium
-  module Console
+  class Console
     module Formatters
       module Overflow
         def self.get(type)

data/lib/helium/console/formatters/overflow/wrap.rb

@@ -1,5 +1,5 @@
 module Helium
-  module Console
+  class Console
     module Formatters
       module Overflow
         class Wrap

data/lib/helium/console/printer.rb

@@ -0,0 +1,20 @@
+module Helium
+  class Console
+    class ColorPrinter < Pry::ColorPrinter
+      def self.pp(obj, output = $DEFAULT_OUTPUT, max_width = 79)
+        queue = ColorPrinter.new(output, max_width, "\n")
+        queue.guard_inspect_key { queue.pp(obj) }
+        queue.flush
+        output << "\n"
+      end
+
+      def pp(object)
+        formatted = Helium::Console.format(object)
+        formatted = $/ + formatted if formatted.lines.count > 1
+        output << formatted
+      end
+
+      ::Pry.config.print = self.method(:default)
+    end
+  end
+end

data/lib/helium/console/registry.rb

@@ -0,0 +1,74 @@
+require 'colorized_string'
+
+module Helium
+  class Console
+    class Registry
+      class Element
+        def initialize(object, **options)
+          @object = object
+          @options = options
+        end
+
+        attr_reader :object, :options
+
+        def format_nested(other_object, **options)
+          Helium::Console.format(other_object, **nested_opts(options))
+        end
+
+        def format(other_object, **options)
+          Helium::Console.format(other_object, **nested_opts(options, increase_level: false))
+        end
+
+        def format_string(string, **options)
+          Helium::Console.format_string(string, **options)
+        end
+
+        def simple?(object)
+          Helium::Console.simple?(object)
+        end
+
+        def is_simple
+          false
+        end
+
+        def method_missing(name, *args)
+          return @options[name] if @options.key?(name)
+          if ColorizedString.colors.include?(name)
+            return ColorizedString.new(*args).colorize(name)
+          end
+          super
+        end
+
+        def nested_opts(new_options, increase_level: true)
+          new_options = options.merge(new_options)
+          new_options[:level] += 1 if increase_level
+          new_options[:ignore_objects] << object.object_id
+          new_options
+        end
+      end
+
+      def add(klass, &handler)
+        define(klass) do
+          define_method(:call, &handler)
+        end
+      end
+
+      def define(klass, &block)
+        handlers[klass] = Class.new(Element, &block)
+      end
+
+      def handler_for(object, **options)
+        object.class.ancestors.each do |ancestor|
+          return handlers[ancestor].new(object, **options) if handlers.key?(ancestor)
+        end
+        nil
+      end
+
+    private
+
+      def handlers
+        @handlers ||= {}
+      end
+    end
+  end
+end

data/lib/helium/console/registry/array.rb

@@ -0,0 +1,75 @@
+module Helium
+  class Console
+    define_formatter_for Array do
+      def call
+        return "[]" if object.none?
+        return format_inline_with_truncation if force_inline?
+
+        format_inline_with_no_truncation || format_as_table
+      end
+
+      def is_simple
+        object.none?
+      end
+
+    private
+
+      def format_as_table
+        table = Table.new(runner: '  ', format_keys: false)
+        object.each.with_index do |element, index|
+          table.row(light_black("[#{index}]:"), element)
+        end
+
+        [
+          "[",
+          format(table),
+          "]"
+        ].join($/)
+      end
+
+      def format_inline_with_truncation
+        joined = nil
+        trunc = nil
+        total = object.length
+
+        object.each.with_index do |element, index|
+          formatted = format_nested(element, max_lines: 1, nesting: 1, max_width: 15)
+
+          new_joined = [joined, formatted].compact.join(" | ")
+          new_trunc = (" | (#{total - index - 1} #{index.zero? ? 'elements' : 'more'})" unless index == total - 1)
+
+          break if new_joined.length > max_width - (new_trunc&.length || 0) - 4
+
+          joined = new_joined
+          trunc = new_trunc
+        end
+
+        if joined
+          joined = [" ", joined, trunc, " "].compact.join if joined
+          ["[", joined, "]"].compact.join
+        else
+          "[...(#{object.length})]"
+        end
+      end
+
+      def format_inline_with_no_truncation
+        joined = nil
+
+        object.each do |element|
+          return unless simple?(element)
+
+          formatted = format_nested(element)
+          joined = [joined, formatted].compact.join(" | ")
+
+          return if joined.length > max_width - 4
+        end
+        joined = " #{joined} " if joined
+        ["[", joined, "]"].compact.join
+      end
+
+      def force_inline?
+        level > 2
+      end
+    end
+  end
+end

data/lib/helium/console/registry/booleans.rb

@@ -0,0 +1,15 @@
+module Helium
+  class Console
+    define_formatter_for TrueClass do
+      def call
+        green('true')
+      end
+    end
+
+    define_formatter_for FalseClass do
+      def call
+        red('false')
+      end
+    end
+  end
+end

data/lib/helium/console/registry/hash.rb

@@ -0,0 +1,81 @@
+module Helium
+  class Console
+    define_formatter_for Hash do
+      def call
+        return format_inline_with_truncation if force_inline?
+        format_inline_with_no_truncation || format_as_table
+      end
+
+    private
+
+      def format_as_table
+        table = Table.new(runner: '  ', after_key: after_key, format_keys: !all_symbol?)
+        object.each do |key, value|
+          key = light_blue(key.to_s) if all_symbol?
+          table.row(key, value)
+        end
+
+        [
+          "{",
+          format(table, **options),
+          "}"
+        ].join($/)
+      end
+
+      def format_inline_with_truncation
+        joined = nil
+        trunc = nil
+        total = object.length
+
+        object.each.with_index do |(key, value), index|
+          formatted_key = format(key, max_lines: 1, nesting: 1, max_with: 15)
+          formatted_value = format(value, max_lines: 1, nesting: 1, max_width: 15)
+
+          formatted = "#{formatted_key} => #{formatted_value}"
+
+          new_joined = [joined, formatted].compact.join(", ")
+          new_trunc = (", (#{total - index - 1} #{index.zero? ? 'elements' : 'more'})" unless index == total - 1)
+
+          break if new_joined.length > max_width - (new_trunc&.length || 0) - 4
+
+          joined = new_joined
+          trunc = new_trunc
+        end
+
+        joined = [" ", joined, trunc, " "].compact.join if joined
+        ["{", joined, "}"].compact.join
+      end
+
+      def format_inline_with_no_truncation
+        joined = nil
+        one_complex = false
+
+        object.each do |key, value|
+          return unless simple?(value)
+
+          formatted_key = format(key, max_lines: 1, nesting: 1, max_with: 15)
+          formatted_value = format(value, max_lines: 1, nesting: 1, max_width: 15)
+          formatted = "#{formatted_key} => #{formatted_value}"
+
+          joined = [joined, formatted].compact.join(", ")
+
+          return if joined.length > max_width - 4
+        end
+        joined = " #{joined} " if joined
+        ["{", joined, "}"].compact.join
+      end
+
+      def force_inline?
+        level > 2
+      end
+
+      def all_symbol?
+        object.keys.all? { |key| key.is_a? Symbol }
+      end
+
+      def after_key
+        all_symbol? ? light_blue(": ") : light_black(" => ")
+      end
+    end
+  end
+end

data/lib/helium/console/registry/module.rb

@@ -0,0 +1,16 @@
+module Helium
+  class Console
+    define_formatter_for Module do
+      def call
+        light_yellow(object.name || anonymus_text)
+      end
+
+      private
+
+      def anonymus_text
+        closest = object.ancestors.find(&:name).name
+        "(ananymus #{closest})"
+      end
+    end
+  end
+end

data/lib/helium/console/registry/nil.rb

@@ -0,0 +1,9 @@
+module Helium
+  class Console
+    define_formatter_for NilClass do
+      def call
+        light_black('nil')
+      end
+    end
+  end
+end

data/lib/helium/console/registry/numeric.rb

@@ -0,0 +1,9 @@
+module Helium
+  class Console
+    define_formatter_for Numeric do
+      def call
+        light_cyan(object.to_s)
+      end
+    end
+  end
+end

data/lib/helium/console/registry/object.rb

@@ -0,0 +1,64 @@
+module Helium
+  class Console
+    define_formatter_for Object do
+      def call
+        return format_inline_with_truncation if force_inline?
+        format_as_table
+      end
+
+    private
+
+      def format_as_table
+        table = Table.new(runner: light_black('| '), after_key: light_black(": "), format_keys: false)
+
+        object.instance_variables.each do |inst|
+          table.row(magenta(inst.to_s), object.instance_variable_get(inst))
+        end
+
+        [
+          table_header,
+          format(table),
+        ].reject(&:empty?).join($/)
+      end
+
+      def format_inline_with_truncation
+        "#{object.class.name}##{object.object_id.to_s(16)}"
+      end
+
+      def format_inline_with_no_truncation
+        joined = nil
+
+        object.each do |key, value|
+          return unless simple?(value)
+
+          formatted_key = format(key, level: 3, max_with: 15)
+          formatted_value = format(value, level: 3, max_width: 15)
+          formatted = "#{formatted_key} => #{formatted_value}"
+
+          joined = [joined, formatted].compact.join(", ")
+
+          return if joined.length > max_width - 4
+        end
+        joined = " #{joined} " if joined
+        ["{", joined, "}"].compact.join
+      end
+
+      def table_header
+        type = case object
+          when Class then :class
+          when Module then :module
+          else :instance
+        end
+        "#{light_black('#')} #{light_yellow(type == :instance ? object.class.name : object.name)} #{type}"
+      end
+
+      def force_inline?
+        level > 2
+      end
+
+      def all_symbol?
+        object.keys.all? { |key| key.is_a? Symbol }
+      end
+    end
+  end
+end

data/lib/helium/console/registry/string.rb

@@ -0,0 +1,27 @@
+module Helium
+  class Console
+    define_formatter_for String do
+      def call
+        formatted = Helium::Console.format_string(
+          object.dump.gsub('\n', "\n"),
+          max_width: max_width,
+          max_lines: max_lines,
+          overflow: overflow,
+          ellipses: "...\""
+        )
+
+        formatted.lines
+          .map { |line| light_green(line) }
+          .join
+      end
+
+      def max_lines
+        case level
+        when 1 then nil
+        when 2 then 3
+        else 1
+        end
+      end
+    end
+  end
+end

data/lib/helium/console/registry/symbol.rb

@@ -0,0 +1,9 @@
+module Helium
+  class Console
+    define_formatter_for Symbol do
+      def call
+        light_blue(':' + object.to_s)
+      end
+    end
+  end
+end

data/lib/helium/console/registry/table.rb

@@ -0,0 +1,75 @@
+module Helium
+  class Console
+    define_formatter_for Table do
+      def call
+        [
+          *formatted_values,
+          truncation,
+        ].compact.join($/)
+      end
+
+      def formatted_values
+        rows.flat_map do |key, value|
+          formatted_value = format_nested(value, max_width: max_value_width)
+
+          formatted_value.lines.map.with_index do |line, index|
+            [
+              object.runner,
+              index.zero? ? rjust(format_key(key), key_width) : " " * key_width,
+              index.zero? ? object.after_key : " " * length_of(object.after_key),
+              line.chomp,
+            ].join
+          end
+        end
+      end
+
+      def truncation
+        return unless object.rows.length > rows.length
+
+        [
+          object.runner,
+          light_black("(#{object.rows.length - rows.length} more)")
+        ].join
+      end
+
+
+      def key_width
+        @key_width ||= rows
+          .map(&:first)
+          .map(&method(:format_key))
+          .map(&method(:length_of))
+          .max
+      end
+
+      def max_value_width
+        max_width - length_of(object.runner) - key_width - length_of(object.after_key)
+      end
+
+      def format_key(key)
+        object.format_keys ? format(key, max_width: 15, level: 3) : key
+      end
+
+      def rjust(string, width)
+        " " * (width - length_of(string)) + string
+      end
+
+      def length_of(string)
+        if string.respond_to?(:uncolorize)
+          string.uncolorize.length
+        else
+          string.length
+        end
+      end
+
+      def rows
+        @rows ||= case level
+        when 1 then object.rows
+        when 2
+          object.rows.count < 10 ? object.rows : object.rows.first(9)
+        else
+          object.rows.count < 3 ? object.rows : object.rows.first(2)
+        end
+      end
+    end
+  end
+end

data/lib/helium/console/table.rb

@@ -0,0 +1,22 @@
+module Helium
+  class Console
+    class Table
+
+      def initialize(runner: "|", after_key: " ", format_keys: true)
+        @runner = runner
+        @after_key = after_key
+        @format_keys = format_keys
+      end
+
+      attr_reader :runner, :after_key, :format_keys
+
+      def row(key, value)
+        rows << [key, value]
+      end
+
+      def rows
+        @rows ||= []
+      end
+    end
+  end
+end

data/lib/helium/console/version.rb

@@ -1,5 +1,5 @@
 module Helium
-  module Console
-    VERSION = "0.1.0"
+  class Console
+    VERSION = "0.1.5"
   end
 end

metadata

@@ -1,17 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: helium-console
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.5
 platform: ruby
 authors:
 - Stanislaw Klajn
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-05-22 00:00:00.000000000 Z
+date: 2021-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: ruby-terminfo
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: colorize
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -31,7 +45,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".byebug_history"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -49,6 +62,19 @@ files:
 - lib/helium/console/formatters/max_lines.rb
 - lib/helium/console/formatters/overflow.rb
 - lib/helium/console/formatters/overflow/wrap.rb
+- lib/helium/console/printer.rb
+- lib/helium/console/registry.rb
+- lib/helium/console/registry/array.rb
+- lib/helium/console/registry/booleans.rb
+- lib/helium/console/registry/hash.rb
+- lib/helium/console/registry/module.rb
+- lib/helium/console/registry/nil.rb
+- lib/helium/console/registry/numeric.rb
+- lib/helium/console/registry/object.rb
+- lib/helium/console/registry/string.rb
+- lib/helium/console/registry/symbol.rb
+- lib/helium/console/registry/table.rb
+- lib/helium/console/table.rb
 - lib/helium/console/version.rb
 homepage: https://github.com/helium-rb/console
 licenses:

data/.byebug_history

@@ -1,7 +0,0 @@
-c
-FFaker::Lorem.sentences(rand(4..10)).count
-FFaker::Lorem.sentences(rand(4..10))
-FFaker::Lorem.sentences
-FFaker::Lorem.sentence
-rand(4..10)
-text