Merge pull request #56 from nguyenquangminh0711/bug/better-edge-cases-handle

Better edge cases handle

Author: 0x2c7

.github/workflows/rspec.yml

@@ -51,6 +51,8 @@ jobs:
       run: ruby spec/wait_for_tmux.rb
     - name: Install dependencies
       run: bundle install
+    - name: Kill tmux
+      run: tmux kill-server || true
     - name: Run tests
       run: bundle exec parallel_rspec spec/
   test-macos:
@@ -78,13 +80,13 @@ jobs:
     - name: Run tests
       run: bundle exec parallel_rspec -n 2 spec/
   test-byebug:
-    runs-on: ubuntu-latest
     strategy:
       fail-fast: false
       matrix:
         byebug: [9.1.0, 10.0.2]
     env:
       BUNDLE_GEMFILE: "./spec/gemfiles/Gemfile-byebug-${{ matrix.byebug }}"
+    runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2
     - name: Set up Ruby
@@ -104,11 +106,13 @@ jobs:
       run: tmux -V
     - name: Start tmux
       run: tmux start-server
-    - name: start dummy tmux session
+    - name: Start dummy tmux session
       run: tmux new-session -t dummy -d
     - name: Wait for tmux
       run: ruby spec/wait_for_tmux.rb
     - name: Install dependencies
       run: bundle install
+    - name: Kill tmux
+      run: tmux kill-server || true
     - name: Run tests
       run: bundle exec parallel_rspec spec/

Gemfile

@@ -17,6 +17,8 @@ gem 'rubocop', '~> 0.89.1'
 gem 'rubocop-rspec', '~> 1.43.1', require: false
 
 group :test do
+  gem 'activerecord'
   gem 'parallel_tests'
   gem 'rspec-retry'
+  gem 'sqlite3'
 end

lib/ruby_jard/console.rb

@@ -8,6 +8,13 @@ module RubyJard
   # Wrapper for utilities to control screen
   class Console
     class << self
+      def attachable?
+        return false unless output.tty?
+
+        width, height = screen_size(output)
+        width != 0 && height != 0
+      end
+
       def redirected?
         output != $stdout
       end
@@ -22,7 +29,7 @@ def output
             begin
               File.open('/dev/tty', 'w+')
             rescue StandardError
-              STDOUT # Give up now. TODO: should warn, and let program continues
+              STDOUT # Give up now.
             end
           end
       end
@@ -37,7 +44,7 @@ def input
             begin
               File.open('/dev/tty', 'r+')
             rescue StandardError
-              STDIN # Give up. TODO: should warn, and let program continues
+              STDIN # Give up.
             end
           end
       end

lib/ruby_jard/decorators/color_decorator.rb

@@ -37,17 +37,28 @@ def initialize(color_scheme)
 
       def decorate(style_names, content)
         attributes = nil
+        foreground = nil
+        background = nil
+
         if style_names.is_a?(Symbol)
           styles = @color_scheme.styles_for(style_names)
         else
           attributes = translate_styles(style_names)
           styles = @color_scheme.styles_for(style_names.shift)
         end
-        foreground = translate_color(styles.shift, true)
-        background = translate_color(styles.shift, false)
+
+        if styles.is_a?(Array)
+          foreground = translate_color(styles.shift, true)
+          background = translate_color(styles.shift, false)
+        elsif !styles.nil?
+          raise RubyJard::Error, "Styles for #{style_names.inspect} must be an array"
+        end
+
         "#{foreground}#{background}#{attributes}#{content}#{CSI_RESET}"
       end
 
+      private
+
       def translate_color(color, foreground)
         if (matches = HEX_PATTERN_6.match(color.to_s))
           red = matches[1].to_i(16)
@@ -70,8 +81,6 @@ def translate_color(color, foreground)
         end
       end
 
-      private
-
       def translate_styles(styles = [])
         styles.map { |key| STYLES_CSI_MAP[key] }.compact.join
       end

lib/ruby_jard/decorators/rails_decorator.rb

@@ -89,7 +89,9 @@ def decorate_singleline(variable, line_limit:, depth: 0)
           if variable.respond_to?(:loaded?) && variable.loaded?
             spans = []
             label = RubyJard::Span.new(
-              content: RubyJard::Reflection.call_to_s(variable).chomp('>'), styles: :text_primary
+              content: RubyJard::Reflection.call_to_s(variable).chomp('>'),
+              styles: :text_primary,
+              margin_right: variable.length >= 1 ? 1 : 0
             )
             spans << label
             spans += @attributes_decorator.inline_values(
@@ -99,6 +101,10 @@ def decorate_singleline(variable, line_limit:, depth: 0)
             )
             spans << RubyJard::Span.new(content: '>', styles: :text_primary)
 
+            if variable.length <= 0
+              spans << RubyJard::Span.new(content: '(empty)', margin_left: 1, styles: :text_primary)
+            end
+
             spans
           else
             relation_summary(variable, line_limit)
@@ -138,7 +144,7 @@ def relation_summary(variable, line_limit)
           width = overview.length + 1 + 12
           spans = [RubyJard::Span.new(content: overview, styles: :text_primary)]
           if RubyJard::Reflection.call_respond_to?(variable, :to_sql) && width < line_limit
-            detail = variable.to_sql
+            detail = variable.to_sql.inspect
             detail = detail[0..line_limit - width - 2] + '…' if width + detail.length < line_limit
             spans << RubyJard::Span.new(content: detail, styles: :text_dim, margin_left: 1)
           end

lib/ruby_jard/session.rb

@@ -24,6 +24,14 @@ def instance
       end
 
       def attach
+        unless RubyJard::Console.attachable?
+          $stdout.puts 'Failed to attach. Jard could not detect a valid tty device.'
+          $stdout.puts 'This bug occurs when the process Jard trying to access is a non-interactive environment '\
+            ' such as docker, daemon, sub-processes, etc.'
+          $stdout.puts 'If you are confused, please submit an issue in https://github.com/nguyenquangminh0711/ruby_jard/issues.'
+          return
+        end
+
         instance.start unless instance.started?
 
         Byebug.attach

lib/ruby_jard/span.rb

@@ -15,7 +15,7 @@ def initialize(content: '', content_length: nil, margin_left: 0, margin_right: 0
         content += ' ' * margin_right if margin_right > 0
       end
 
-      @content = content.to_s
+      @content = content.to_s.gsub(/\r\n/, '\n').gsub(/\n/, '\n')
       @content_length = content_length || @content.length
       @styles = styles
     end

spec/gemfiles/Gemfile-byebug-10.0.2

@@ -17,6 +17,8 @@ gem 'rubocop', '~> 0.88'
 gem 'rubocop-rspec', require: false
 
 group :test do
+  gem 'activerecord'
   gem 'parallel_tests'
   gem 'rspec-retry'
+  gem 'sqlite3'
 end

spec/gemfiles/Gemfile-byebug-11.1.0

@@ -17,6 +17,8 @@ gem 'rubocop', '~> 0.89.1'
 gem 'rubocop-rspec', '~> 1.43.1', require: false
 
 group :test do
+  gem 'activerecord'
   gem 'parallel_tests'
   gem 'rspec-retry'
+  gem 'sqlite3'
 end

spec/gemfiles/Gemfile-byebug-9.1.0

@@ -17,6 +17,8 @@ gem 'rubocop', '~> 0.88'
 gem 'rubocop-rspec', require: false
 
 group :test do
+  gem 'activerecord'
   gem 'parallel_tests'
   gem 'rspec-retry'
+  gem 'sqlite3'
 end

spec/helpers/active_record_helper.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'active_record'
+require 'sqlite3'
+
+ActiveRecord::Base.establish_connection(
+  adapter: 'sqlite3',
+  database: ':memory:'
+)
+
+# Set up database tables and columns
+ActiveRecord::Schema.define do
+  create_table :ar_pets, force: true do |t|
+    t.string :name
+    t.integer :age
+  end
+
+  create_table :ar_posts, force: true do |t|
+    t.string :title
+    t.string :description
+    t.datetime :created_at
+  end
+end
+
+# Set up model classes
+class ArPet < ActiveRecord::Base; end
+class ArPost < ActiveRecord::Base; end

spec/ruby_jard/decorators/color_decorator_spec.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+def color_decorator_test_case_name(test_case)
+  "when translated style is #{test_case[:input][0].inspect} "\
+    "and content is #{test_case[:input][1].inspect}"
+end
+
+RSpec.describe RubyJard::Decorators::ColorDecorator do
+  subject(:color_decorator) { described_class.new(color_scheme) }
+
+  let(:color_scheme) do
+    Class.new(RubyJard::ColorScheme) do
+      const_set(
+        :STYLES,
+        {
+          color0: [],
+          color1: ['234'],
+          color2: ['#aaa'], # 170, 170, 170
+          color3: ['#80b57b'], # 128, 181, 123
+          color4: %w[234 245],
+          color5: ['#bbb', '#aaa'], # 187, 187, 187 and 170, 170, 170
+          color6: ['#80b57b', '#78b5ff'], # 128, 181, 123 and 120, 181, 255
+          color_not_supported_1: ['rgb(0, 255, 255)'],
+          color_not_supported_2: ['rgb(0, 255, 255)', 'rgb(0, 255, 255)'],
+          color_invalid: 'invalid'
+        }.freeze
+      )
+    end.new
+  end
+
+  [
+    # Input style is a symbol
+    { input: [:color0, nil], output: "\e[0m" },
+    { input: [:color0, 'hello'], output: "hello\e[0m" },
+    { input: [:color1, nil], output: "\e[38;5;234m\e[0m" },
+    { input: [:color1, 'hello'], output: "\e[38;5;234mhello\e[0m" },
+    { input: [:color2, nil], output: "\e[38;2;170;170;170m\e[0m" },
+    { input: [:color2, 'hello'], output: "\e[38;2;170;170;170mhello\e[0m" },
+    { input: [:color3, nil], output: "\e[38;2;128;181;123m\e[0m" },
+    { input: [:color3, 'hello'], output: "\e[38;2;128;181;123mhello\e[0m" },
+    { input: [:color4, nil], output: "\e[38;5;234m\e[48;5;245m\e[0m" },
+    { input: [:color4, 'hello'], output: "\e[38;5;234m\e[48;5;245mhello\e[0m" },
+    { input: [:color5, nil], output: "\e[38;2;187;187;187m\e[48;2;170;170;170m\e[0m" },
+    { input: [:color5, 'hello'], output: "\e[38;2;187;187;187m\e[48;2;170;170;170mhello\e[0m" },
+    { input: [:color6, nil], output: "\e[38;2;128;181;123m\e[48;2;120;181;255m\e[0m" },
+    { input: [:color6, 'hello'], output: "\e[38;2;128;181;123m\e[48;2;120;181;255mhello\e[0m" },
+    { input: [:color_not_supported_1, nil], output: "\e[0m" },
+    { input: [:color_not_supported_1, 'hello'], output: "hello\e[0m" },
+    { input: [:color_not_supported_2, nil], output: "\e[0m" },
+    { input: [:color_not_supported_2, 'hello'], output: "hello\e[0m" },
+    { input: [:color_invalid, nil], error: /must be an array/ },
+    { input: [:color_not_found, nil], output: "\e[0m" },
+    # Input style is an array with single symbol
+    { input: [[:color0], nil], output: "\e[0m" },
+    { input: [[:color0], 'hello'], output: "hello\e[0m" },
+    { input: [[:color1], nil], output: "\e[38;5;234m\e[0m" },
+    { input: [[:color1], 'hello'], output: "\e[38;5;234mhello\e[0m" },
+    { input: [[:color2], nil], output: "\e[38;2;170;170;170m\e[0m" },
+    { input: [[:color2], 'hello'], output: "\e[38;2;170;170;170mhello\e[0m" },
+    { input: [[:color3], nil], output: "\e[38;2;128;181;123m\e[0m" },
+    { input: [[:color3], 'hello'], output: "\e[38;2;128;181;123mhello\e[0m" },
+    { input: [[:color4], nil], output: "\e[38;5;234m\e[48;5;245m\e[0m" },
+    { input: [[:color4], 'hello'], output: "\e[38;5;234m\e[48;5;245mhello\e[0m" },
+    { input: [[:color5], nil], output: "\e[38;2;187;187;187m\e[48;2;170;170;170m\e[0m" },
+    { input: [[:color5], 'hello'], output: "\e[38;2;187;187;187m\e[48;2;170;170;170mhello\e[0m" },
+    { input: [[:color6], nil], output: "\e[38;2;128;181;123m\e[48;2;120;181;255m\e[0m" },
+    { input: [[:color6], 'hello'], output: "\e[38;2;128;181;123m\e[48;2;120;181;255mhello\e[0m" },
+    { input: [[:color_not_supported_1], nil], output: "\e[0m" },
+    { input: [[:color_not_supported_1], 'hello'], output: "hello\e[0m" },
+    { input: [[:color_not_supported_2], nil], output: "\e[0m" },
+    { input: [[:color_not_supported_2], 'hello'], output: "hello\e[0m" },
+    { input: [[:color_invalid], nil], error: /must be an array/ },
+    { input: [[:color_not_found], nil], output: "\e[0m" },
+    # Input style includes text attributes
+    { input: [[:color0, :underline], nil], output: "\e[4m\e[0m" },
+    { input: [[:color0, :underline], 'hello'], output: "\e[4mhello\e[0m" },
+    { input: [[:color1, :underline], nil], output: "\e[38;5;234m\e[4m\e[0m" },
+    { input: [[:color1, :underline], 'hello'], output: "\e[38;5;234m\e[4mhello\e[0m" },
+    { input: [[:color2, :underline], nil], output: "\e[38;2;170;170;170m\e[4m\e[0m" },
+    { input: [[:color2, :underline], 'hello'], output: "\e[38;2;170;170;170m\e[4mhello\e[0m" },
+    { input: [[:color3, :underline], nil], output: "\e[38;2;128;181;123m\e[4m\e[0m" },
+    { input: [[:color3, :underline], 'hello'], output: "\e[38;2;128;181;123m\e[4mhello\e[0m" },
+    { input: [[:color4, :underline], nil], output: "\e[38;5;234m\e[48;5;245m\e[4m\e[0m" },
+    { input: [[:color4, :underline], 'hello'], output: "\e[38;5;234m\e[48;5;245m\e[4mhello\e[0m" },
+    { input: [[:color5, :underline], nil], output: "\e[38;2;187;187;187m\e[48;2;170;170;170m\e[4m\e[0m" },
+    { input: [[:color5, :underline], 'hello'], output: "\e[38;2;187;187;187m\e[48;2;170;170;170m\e[4mhello\e[0m" },
+    { input: [[:color6, :underline], nil], output: "\e[38;2;128;181;123m\e[48;2;120;181;255m\e[4m\e[0m" },
+    { input: [[:color6, :underline], 'hello'], output: "\e[38;2;128;181;123m\e[48;2;120;181;255m\e[4mhello\e[0m" },
+    { input: [[:color_not_supported_1, :underline], nil], output: "\e[4m\e[0m" },
+    { input: [[:color_not_supported_1, :underline], 'hello'], output: "\e[4mhello\e[0m" },
+    { input: [[:color_not_supported_2, :underline], nil], output: "\e[4m\e[0m" },
+    { input: [[:color_not_supported_2, :underline], 'hello'], output: "\e[4mhello\e[0m" },
+    { input: [[:color_invalid, :underline], nil], error: /must be an array/ },
+    { input: [[:color_not_found, :underline], nil], output: "\e[4m\e[0m" },
+    # Completed example
+    {
+      input: [[:color4, :underline, :bold, :italic], '#<Thread:0x000055fcf5f64c38@Super thread test1.rb:78 sleep>'],
+      output: "\e[38;5;234m\e[48;5;245m\e[4m\e[1m\e[3m#<Thread:0x000055fcf5f64c38@Super thread test1.rb:78 sleep>\e[0m"
+    }
+  ].each do |test_case|
+    context color_decorator_test_case_name(test_case) do
+      it do
+        if test_case[:error]
+          expect do
+            color_decorator.decorate(*test_case[:input])
+          end.to raise_error(RubyJard::Error, test_case[:error])
+        else
+          expect(color_decorator.decorate(*test_case[:input])).to eql(test_case[:output])
+        end
+      end
+    end
+  end
+end