helium-console 0.1.7 → 0.1.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2ab396ea29a8624295988320add6f5e930e63189df18d760f5a5d7b940757564
-  data.tar.gz: 67585b90c765f5c21085d142f09177062e09b7aaea8adab81405cfd78909f04f
+  metadata.gz: 8d935efaa6d5d2a98d58c2d0cea17911486522ce45bfd00432b089735994ce20
+  data.tar.gz: c86a17fc7b04379249cf491da55086537f7f8983c47758d9b20438495f12039e
 SHA512:
-  metadata.gz: 5f8c86fb6604d3be3a7c0de4485875da9be8b2b2ab0f62a39678cee552d55c4d6cb296d10803ca0b1962ada3e9b490525f5e05cff9c1905311afa27df6db4472
-  data.tar.gz: a960dc8a18594015a44d5fd83469869e96f8d33cae658c7a825a9fc45c73d53ce06e6386a187a3387ae6d9c9a0cf50cfc0495250ee122dbb109ae9d14ea8110b
+  metadata.gz: 2ab8ca592e31437b6e70cd269cd961b8fc38c3e544b24aa2eecfbddce474ed22ebda4c704849271b847656e22d15b25feb169aedad5593f6267378e211b068bf
+  data.tar.gz: 2915fa426caea028e549e9d55e5a4cb7799ef593cdd706529c9eac5bc582a841bdaaa67fb1480917df0543286a0d7743f5eb13b813b92ad4193eab207d49a378

data/.rubocop.yml

@@ -0,0 +1,70 @@
+require:
+  - rubocop-rspec
+  - rubocop-rake
+
+AllCops:
+  NewCops: enable
+
+Style/LambdaCall:
+  EnforcedStyle: braces
+
+Layout/CaseIndentation:
+  EnforcedStyle: end
+  IndentOneStep: true
+
+Style/NestedParenthesizedCalls:
+  AllowedMethods:
+    - be
+    - be_a
+    - be_an
+    - be_between
+    - be_falsey
+    - be_kind_of
+    - be_instance_of
+    - be_truthy
+    - be_within
+    - eq
+    - eql
+    - end_with
+    - expect
+    - include
+    - match
+    - raise_error
+    - respond_to
+    - start_with
+
+Layout/EndAlignment:
+  EnforcedStyleAlignWith: start_of_line
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Style/Documentation:
+  Enabled: false
+
+Bundler/OrderedGems:
+  Enabled: false
+
+Style/EmptyMethod:
+  EnforcedStyle: expanded
+
+Metrics/BlockLength:
+  IgnoredMethods:
+    - define_formatter_for
+  Exclude:
+    - "*.gemspec"
+    - "spec/**/*_spec.rb"
+
+Metrics/MethodLength:
+  Max: 15
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+Style/NumericPredicate:
+  Enabled: false
+
+Style/EachWithObject:
+  Enabled: false
+
+

data/Gemfile

@@ -1,9 +1,14 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in helium-console.gemspec
 gemspec
 
-gem "rake", "~> 12.0"
-gem "rspec", "~> 3.0"
-gem "ffaker"
-gem "byebug"
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'
+gem 'ffaker'
+gem 'byebug'
+gem 'rubocop', require: false
+gem 'rubocop-rspec', require: false
+gem 'rubocop-rake', require: false

data/Gemfile.lock

@@ -1,23 +1,30 @@
 PATH
   remote: .
   specs:
-    helium-console (0.1.7)
+    helium-console (0.1.11)
       colorize
       pry
 
 GEM
   remote: https://rubygems.org/
   specs:
+    ast (2.4.2)
     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)
+    parallel (1.20.1)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
+    rainbow (3.0.0)
     rake (12.3.3)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)
@@ -31,6 +38,24 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.2)
+    rubocop (1.19.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.9.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.10.0)
+      parser (>= 3.0.1.1)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.4.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.0.0)
 
 PLATFORMS
   ruby
@@ -41,6 +66,9 @@ DEPENDENCIES
   helium-console!
   rake (~> 12.0)
   rspec (~> 3.0)
+  rubocop
+  rubocop-rake
+  rubocop-rspec
 
 BUNDLED WITH
    2.1.4

data/Rakefile

@@ -1,6 +1,8 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/bin/console

@@ -1,15 +1,10 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "helium/console"
+require 'bundler/setup'
+require 'helium/console'
 
 require 'byebug'
 require 'ffaker'
 
-class A
-  def initialize(a)
-    @a = a
-  end
-end
-
 Pry.start

data/helium-console.gemspec

@@ -1,27 +1,29 @@
+# frozen_string_literal: true
+
 require_relative 'lib/helium/console/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "helium-console"
+  spec.name          = 'helium-console'
   spec.version       = Helium::Console::VERSION
-  spec.authors       = ["Stanislaw Klajn"]
-  spec.email         = ["sklajn@gmail.com"]
+  spec.authors       = ['Stanislaw Klajn']
+  spec.email         = ['sklajn@gmail.com']
 
-  spec.summary       = "Collection of tools for smooth integration with console"
-  spec.homepage      = "https://github.com/helium-rb/console"
-  spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+  spec.summary       = 'Collection of tools for smooth integration with console'
+  spec.homepage      = 'https://github.com/helium-rb/console'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
 
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/helium-rb/console"
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/helium-rb/console'
 
   # 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
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-  spec.add_dependency "pry"
-  spec.add_dependency "colorize"
+  spec.require_paths = ['lib']
+  spec.add_dependency 'colorize'
+  spec.add_dependency 'pry'
 end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Helium
   class Console
     module Formatters
@@ -7,7 +9,7 @@ module Helium
         end
 
         def call(string)
-          string.lines.map {|line| ' ' * @indent + line }.join
+          string.lines.map { |line| ' ' * @indent + line }.join
         end
       end
     end

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

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module Helium
   class Console
     module Formatters
       class MaxLines
-        ELLIPSES = "...\""
+        ELLIPSES = '..."'
 
         def initialize(max_lines:, max_width:, ellipses:)
           @max_lines = max_lines
@@ -16,7 +18,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.join()
+          lines.join
         end
       end
     end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Helium
   class Console
     module Formatters
@@ -11,8 +13,8 @@ module Helium
             result = string.lines.flat_map do |line|
               line.chomp.chars.each_slice(@max_width).map(&:join)
             end
-            result = result.join($/)
-            result += $/ if string.end_with?($/)
+            result = result.join("\n")
+            result += "\n" if string.end_with?("\n")
             result
           end
         end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 module Helium
   class Console
@@ -6,8 +7,8 @@ module Helium
         def self.get(type)
           require "helium/console/formatters/overflow/#{type}"
           const_get(type.to_s.split('_').map(&:capitalize).join)
-        rescue
-          raise Error.new("Unknown overflow option: #{type}")
+        rescue LoadError
+          raise Error, "Unknown overflow option: #{type}"
         end
       end
     end

data/lib/helium/console/printer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Helium
   class Console
     class ColorPrinter < Pry::ColorPrinter
@@ -10,11 +12,14 @@ module Helium
 
       def pp(object)
         formatted = Helium::Console.format(object)
-        formatted = $/ + formatted if formatted.lines.count > 1
-        output << formatted
+        output << "\n" if object.is_a? Registry::Element::LazyStringEvaluator
+        formatted.lines.each do |line|
+          output << "#{line.chomp}\n"
+        end
+        output << "\n"
       end
 
-      ::Pry.config.print = self.method(:default)
+      ::Pry.config.print = method(:default)
     end
   end
 end

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

@@ -1,18 +1,20 @@
+# frozen_string_literal: true
+
 module Helium
   class Console
     define_formatter_for Array do
       def call
-        return "[]" if object.none?
-        return format_inline_with_truncation if force_inline?
+        return '[]' if object.none?
+        return inline_with_truncation if force_inline?
 
-        format_inline_with_no_truncation || format_as_table
+        inline_without_truncation || format_as_table
       end
 
-      def is_simple
+      def simple?
         object.none?
       end
 
-    private
+      private
 
       def format_as_table
         table = Table.new(runner: '  ', format_keys: false)
@@ -20,51 +22,54 @@ module Helium
           table.row(light_black("[#{index}]:"), element)
         end
 
-        [
-          "[",
-          format(table),
-          "]"
-        ].join($/)
+        yield_lines do |y|
+          y << '['
+          format(table).lines.each { |line| y << line }
+          y << ']'
+        end
       end
 
-      def format_inline_with_truncation
-        joined = nil
-        trunc = nil
-        total = object.length
+      def inline_with_truncation
+        formatted = formatted_elements.with_index.inject([]) do |joined, (element, index)|
+          new_joined = [*joined[0..-2], element, trunc_message(object_size - index - 1, all_truncated: index.zero?)]
+          break joined if too_long?(new_joined, max_width: max_width - 4)
 
-        object.each.with_index do |element, index|
-          formatted = format_nested(element, max_lines: 1, nesting: 1, max_width: 15)
+          new_joined
+        end
 
-          new_joined = [joined, formatted].compact.join(" | ")
-          new_trunc = (" | (#{total - index - 1} #{index.zero? ? 'elements' : 'more'})" unless index == total - 1)
+        "[ #{formatted.compact.join(' | ')} ]"
+      end
 
-          break if new_joined.length > max_width - (new_trunc&.length || 0) - 4
+      def inline_without_truncation
+        return unless object.all? { |element| Helium::Console.simple? element }
 
-          joined = new_joined
-          trunc = new_trunc
-        end
+        formatted = formatted_elements.inject([]) do |joined, element|
+          joined = [*joined, element]
+          break if too_long?(joined, max_width: max_width - 4)
 
-        if joined
-          joined = [" ", joined, trunc, " "].compact.join if joined
-          ["[", joined, "]"].compact.join
-        else
-          "[...(#{object.length})]"
+          joined
         end
+
+        "[ #{formatted.join(' | ')} ]" unless formatted.nil?
+      end
+
+      def too_long?(object, max_width:)
+        string = object.respond_to?(:join) ? object.join(' | ') : object
+        length_of(string) > max_width - 4
       end
 
-      def format_inline_with_no_truncation
-        joined = nil
+      def formatted_elements(**options)
+        object.each.lazy.map { |element| format_nested(element, **options) }
+      end
 
-        object.each do |element|
-          return unless simple?(element)
+      def trunc_message(count, all_truncated: false)
+        return if count < 1
 
-          formatted = format_nested(element)
-          joined = [joined, formatted].compact.join(" | ")
+        "(#{count} #{all_truncated ? 'elements' : 'more'})"
+      end
 
-          return if joined.length > max_width - 4
-        end
-        joined = " #{joined} " if joined
-        ["[", joined, "]"].compact.join
+      def object_size
+        @object_size ||= object.size
       end
 
       def force_inline?