fancy_irb 1.4.3 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e2983518481e3a3ea0996fa0db0b8eb01bf6a0c72072171746ff1dfe1fc4786f
-  data.tar.gz: 44d632ee043c0751300cd7ee48fddbd03e9086084f061803c6a1764d6a3ff706
+  metadata.gz: 89cbb2934ed19ad839cdc15eda21b617c01eb2bd6e689a54012c8eeee98098b9
+  data.tar.gz: dcded533d53ac26e54bce266d2a80eea702c38b22173735b014e50b163f258c8
 SHA512:
-  metadata.gz: 6d0b61c283bee3ccbf950c164ee96aadb8e5ff29fbc6438a2b6cd4989b7a17f8a8af244675d337a43820edca54a0eb1e0dba311308d9c59cd3abae80369ecd86
-  data.tar.gz: d119df23b3dc249a73d5ff733dfd48c49e046c2fb932b913399412831da3e19097182b7fd1692489aeee5bb5f56927cba8f5ea6795d2bb0316d267d8abc73829
+  metadata.gz: ba416ba54282e7172fcd88035163fa9f809d3465c2f85f3c7fd858456d41988de8df81ec709d26ee32ed254f78d0d4429765aa561edb5cde3cbb90ba5c5ded5a
+  data.tar.gz: 58d7c084efe90a61fc67857c497279ada9dd739ec732bf235e21a50171624ec2f103bdda48ef33ee31f91a995af9e0969459122910398a10329696575e7d5916

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # CHANGELOG
 
+## 2.1.0
+* Refactor IRB extension to accommodate IRB 1.8.2
+
+## 2.0.0
+* Fix core functionality for newer IRB
+* Require Ruby 3.x / IRB 1.7+
+* Bump display-width gem to latest version
+* Remove option to disable display-width check, since it now has good performance
+
 ## 1.4.3
 * Fix options given to `script` so it doesn't output timing info
 

data/MIT-LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2010-2012, 2015-2021 Jan Lelis
+Copyright (c) 2010-2012, 2015-2023 Jan Lelis
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,21 +1,23 @@
 # FancyIrb [![version](https://badge.fury.io/rb/fancy_irb.svg)](https://badge.fury.io/rb/fancy_irb)  [![[ci]](https://github.com/janlelis/fancy_irb/workflows/Test/badge.svg)](https://github.com/janlelis/fancy_irb/actions?query=workflow%3ATest)
 
 *   Colorizes IRB prompts, errors, `$stderr` and `$stdout`
-*   Uses "Hash Rockets" (# =>) to display IRB results
+*   Uses "Hash Rockets" (#=>) to display IRB results
+
+## Version 2.0 for Modern IRB
+
+**Please note:** Version 2.0 of this gem requires Ruby 3 and IRB 1.7+
 
 ## Usage
 
     require 'fancy_irb'
     FancyIrb.start
 
-You can pass an options hash. These are the default values:
+You can pass an options hash as argument. These are the default values:
 
     DEFAULT_OPTIONS = {
       :rocket_mode     => true,       # activate or deactivate #=> rocket
       :rocket_prompt   => '#=> ',     # prompt to use for the rocket
       :result_prompt   => '=> ',      # prompt to use for normal output
-      :unicode_display_width => true, # set to false if you don't want to check for proper
-                                      # string width for better performance
       :colorize => {                  # colors hash. Set to nil to deactivate colors
         :rocket_prompt => [:blue],
         :result_prompt => [:blue],
@@ -27,27 +29,21 @@ You can pass an options hash. These are the default values:
        },
     }
 
-Rocket mode means: Output result as comment if there is enough space left on
-the terminal line and `stdout` does not output more than the current terminal
-height.
+Rocket mode means: Instead of displaying the result on the next line, show it
+on the same line (if there is enough space)
 
 For more information on which colors can be used, see the [paint documentation](https://github.com/janlelis/paint).
 
 ## Troubleshooting
 ### Windows Support
-You will need [ansicon](https://github.com/adoxa/ansicon) or [ConEmu](https://code.google.com/p/conemu-maximus5/).
-
-### Need More Performance?
-The gem checks for the Unicode display width of characters, which requires a
-lookup of every character. You can deactivate this check by setting
- `:unicode_display_width` to `false`.
+You will need [ansicon](https://github.com/adoxa/ansicon) or [ConEmu](https://code.google.com/p/conemu-maximus5/) or [WSL](https://docs.microsoft.com/en-us/windows/wsl/install-win10).
 
 ### Known Bugs
-Not all stdin methods are patched properly to work with the rocket: The gems
-focuses on the often used ones
+Not all methods dealing with input data are patched properly to work with the rocket,
+the gem focuses on the commonly used ones, like `gets` or `getc`.
 
 ## J-_-L
 Inspired by the irb_rocket gem by genki.
 
-Copyright (c) 2010-2012, 2015-2021 Jan Lelis <https://janlelis.com> released under
+Copyright (c) 2010-2012, 2015-2023 Jan Lelis <https://janlelis.com> released under
 the MIT license.

data/fancy_irb.gemspec

@@ -8,15 +8,16 @@ Gem::Specification.new do |s|
   s.authors     = ["Jan Lelis"]
   s.email       = ["hi@ruby.consulting"]
   s.homepage    = "https://github.com/janlelis/fancy_irb"
-  s.summary     = "FancyIrb makes IRB # => friendly."
-  s.description = "A fancy IRB has a colorful input prompt and profiles rocket-style #=> return values"
-  s.required_ruby_version = '>= 1.9.3'
+  s.summary     = "Colors and rockets in IRB"
+  s.description = "A fancy IRB has rocket-style #=> return values and colorful prompts and streams."
+  s.required_ruby_version = '>= 3.0', '< 4.0'
+  s.metadata = { "rubygems_mfa_required" => "true" }
   s.license = 'MIT'
-  s.requirements = ['Windows: ansicon <https://github.com/adoxa/ansicon>']
   s.add_dependency 'paint', '>= 0.9', '< 3.0'
-  s.add_dependency 'unicode-display_width', ">= 1.1"
-  s.add_development_dependency 'rspec', "~> 3.2"
-  s.add_development_dependency 'rake', "~> 10.4"
+  s.add_dependency 'irb', '>= 1.7', '< 2.0'
+  s.add_dependency 'unicode-display_width', '>= 2.5'
+  s.add_development_dependency 'rspec', '~> 3.2'
+  s.add_development_dependency 'rake', '~> 13.0'
   s.files = [
     "MIT-LICENSE.txt",
     "README.md",

data/lib/fancy_irb/implementation.rb

@@ -50,19 +50,14 @@ module FancyIrb
       }
     end
 
-    def unicode_display_width?
-      @options[:unicode_display_width] || @options[:east_asian_width]
-    end
-    alias east_asian_width? unicode_display_width?
-
     def reset_line!
       @tracked_height = 0
       @tracked_indent = 0
     end
 
-    def handle_prompt(prompt, scanner_indent, track_indent)
-      @tracked_indent = 2 if track_indent
-      @current_indent = width_of(prompt) + scanner_indent + @tracked_indent
+    def handle_prompt(prompt, scanner_indent)#, track_indent)
+      # @tracked_indent = 2 if track_indent
+      @current_indent = width_of(prompt) + scanner_indent# + @tracked_indent
 
       append_input_color colorize(prompt, :input_prompt)
     end
@@ -84,14 +79,11 @@ module FancyIrb
       end
     end
 
-    def output_value(context, scanner)
-      show_output(context.inspect_last_value, scanner)
-    end
-
-    def show_output(output, scanner)
+    def output_value(context, _scanner)
+      output = context.inspect_last_value
       if @options[:rocket_mode] && !@skip_next_rocket && !output.include?("\n")
-        offset = get_offset_from_irb_scanner(scanner)
-        cols_to_show  = get_cols_to_show_from_output_and_offset(output, offset)
+        offset = get_offset_from_reline
+        cols_to_show  = offset + width_of(@options[:rocket_prompt] + output)
         lines_to_show = 1 + @tracked_height
 
         if TerminalInfo.lines > lines_to_show && TerminalInfo.cols > cols_to_show
@@ -110,15 +102,12 @@ module FancyIrb
       puts colorize(@options[:result_prompt], :result_prompt) + output
     end
 
-    def get_offset_from_irb_scanner(irb_scanner)
-      last_line = irb_scanner.instance_variable_get(:@line).split("\n").last
+    def get_offset_from_reline
+      last_buffer = (Reline::HISTORY || [])[-1] || ""
+      last_line = last_buffer.split("\n").last
       1 + @current_indent + width_of(last_line)
     end
 
-    def get_cols_to_show_from_output_and_offset(output, offset)
-      offset + width_of(@options[:rocket_prompt] + output)
-    end
-
     # TODO testing and improving, e.g. getc does not contain "\n"
     def register_height_trackers(object, methods_)
       methods_.each{ |method_|

data/lib/fancy_irb/irb_ext.rb

@@ -1,22 +1,12 @@
-module IRB
-  class Irb
+module FancyIrb
+  module IrbExtCommon
     def output_value
       FancyIrb.output_value(@context, @scanner)
     end
 
-    alias prompt_non_fancy prompt
-    def prompt(*args, &block)
-      FancyIrb.handle_prompt(
-        prompt_non_fancy(*args, &block),
-        IRB.conf[:AUTO_INDENT] ? @scanner.instance_variable_get(:@indent) * 2 : 0,
-        IRB.conf[:AUTO_INDENT] && IRB.conf[:PROMPT][IRB.conf[:PROMPT_MODE]][:PROMPT_C] == args[0]
-      )
-    end
-
-    alias signal_status_non_fancy signal_status
     def signal_status(name, *args, &block)
       FancyIrb.reset_line!
-      signal_status_non_fancy(name, *args, &block)
+      super(name, *args, &block)
     ensure
       if name == :IN_EVAL
         FancyIrb.present_and_clear_captured_error!
@@ -24,14 +14,48 @@ module IRB
     end
   end
 
-  class Context
-    alias evaluate_non_fancy evaluate
+  module IrbExtPrompt
+    private def format_prompt(format, ltype, indent, line_no)
+      FancyIrb.handle_prompt(
+        super(format, ltype, indent, line_no),
+        IRB.conf[:AUTO_INDENT] ? indent * 2 : 0
+        # IRB.conf[:AUTO_INDENT] && IRB.conf[:PROMPT][IRB.conf[:PROMPT_MODE]][:PROMPT_C] == format
+      )
+    end
+  end
+
+  module IrbExtPromptLegacy
+    def prompt(format, ltype, indent, line_no)
+      FancyIrb.handle_prompt(
+        super(format, ltype, indent, line_no),
+        IRB.conf[:AUTO_INDENT] ? indent * 2 : 0
+        # IRB.conf[:AUTO_INDENT] && IRB.conf[:PROMPT][IRB.conf[:PROMPT_MODE]][:PROMPT_C] == format
+      )
+    end
+  end
 
+  module ContextExt
     def evaluate(*args, **kwargs)
-      evaluate_non_fancy(*args, **kwargs)
+      super(*args, **kwargs)
     rescue Exception
       FancyIrb.register_error_capturer!
       raise
     end
   end
 end
+
+module IRB
+  class Irb
+    prepend FancyIrb::IrbExtCommon
+
+    if IRB::VERSION < "1.8.2"
+      prepend FancyIrb::IrbExtPromptLegacy
+    else
+      prepend FancyIrb::IrbExtPrompt
+    end
+  end
+
+  class Context
+    prepend FancyIrb::ContextExt
+  end
+end

data/lib/fancy_irb/size_detector.rb

@@ -3,9 +3,7 @@ module FancyIrb
     extend self
 
     def width_of(data)
-      return 0 unless data
-      data = Paint.unpaint data.to_s
-      FancyIrb.unicode_display_width? ? Unicode::DisplayWidth.of(data) : data.length
+      Unicode::DisplayWidth.of(Paint.unpaint(data.to_s))
     end
 
     def height_of(data, width)

data/lib/fancy_irb/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FancyIrb
-  VERSION = '1.4.3'
+  VERSION = '2.1.0'
 end

data/spec/size_detector_spec.rb

@@ -4,10 +4,6 @@ require_relative 'fixtures'
 describe FancyIrb::SizeDetector do
   include FancyIrb::SizeDetector
 
-  before do
-    FancyIrb.instance_variable_set(:@options, { unicode_display_width: true })
-  end
-
   describe ".width_of" do
     it "returns 0 when no data given" do
       expect( width_of(nil) ).to eq 0
@@ -24,16 +20,6 @@ describe FancyIrb::SizeDetector do
     it "respects double-width chars by default" do
       expect( width_of('一') ).to eq 2
     end
-
-    context "unicode_display_width? false" do
-      before do
-        FancyIrb.instance_variable_set(:@options, { unicode_display_width: false })
-      end
-
-      it "does not respect double-width chars" do
-        expect( width_of('一') ).to eq 1
-      end
-    end
   end
 
   describe ".height_of" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fancy_irb
 version: !ruby/object:Gem::Version
-  version: 1.4.3
+  version: 2.1.0
 platform: ruby
 authors:
 - Jan Lelis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-20 00:00:00.000000000 Z
+date: 2023-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: paint
@@ -30,20 +30,40 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: irb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: unicode-display_width
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '2.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '2.5'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -64,16 +84,16 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.4'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.4'
-description: 'A fancy IRB has a colorful input prompt and profiles rocket-style #=>
-  return values'
+        version: '13.0'
+description: 'A fancy IRB has rocket-style #=> return values and colorful prompts
+  and streams.'
 email:
 - hi@ruby.consulting
 executables: []
@@ -100,7 +120,8 @@ files:
 homepage: https://github.com/janlelis/fancy_irb
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -109,16 +130,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: '3.0'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '4.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-requirements:
-- 'Windows: ansicon <https://github.com/adoxa/ansicon>'
-rubygems_version: 3.2.3
+requirements: []
+rubygems_version: 3.4.21
 signing_key: 
 specification_version: 4
-summary: 'FancyIrb makes IRB # => friendly.'
+summary: Colors and rockets in IRB
 test_files: []