rich-ri 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c0ebea7b8adc8c270a62c2f34f0ede696b4440199e801d3126f1c828bd6606f6
-  data.tar.gz: 9d01b69cee3ae3f39c045240a67f7559ba9cf511fbd86dc6cb429dc0cfee38c3
+  metadata.gz: 95c76ed20ec9838602c3383b2e69d8e4058ef66b3b0b68407e61200c41e76898
+  data.tar.gz: b21c83e29a2eda62583447d52f530199217e89e704eeb9a4e697031318c2cef8
 SHA512:
-  metadata.gz: 57e14eb941738b7a3d7850990b777f94ceaa1d1b30cd4b03068cf0dd7047cad15f0d858e66df315b10275d17bf01cebd4e92de5893bc31641fcf23db0ac42ac2
-  data.tar.gz: 982792737323335b89e85bd0fffa9f2fbd675d4192f14545ff654a14ac974815f76445758da6e2f4a49b4825029a82585d72748a496cdbda76245da016d22320
+  metadata.gz: 1b5d3313a6f77aa580faaad650df0333aa22bdb42f6b3b9f7870157822bfac65ae79accf53de783619fd6b2cf8b8b58dfc0d98e55bb5eed8a055af69e68cdb4b
+  data.tar.gz: 2dff498b7fa8d4b7594e6ec88a446a8b9ea638dc206a7eef5b1b11d59024bce039104c9511829b6ec07777b760fd98b9a0a15674c58f9038902225e534848a8d

data/CHANGELOG.md

@@ -6,6 +6,31 @@ User-visible changes are recorded here. This project follows
 
 ## [Unreleased]
 
+## [0.1.1] - 2026-10-06
+
+### Fixed
+
+- Tab at the interactive prompt no longer ends the session when an installed gem
+  has documentation pages.
+- An empty configuration file means no overrides, as documented, instead of
+  stopping every command.
+- Names with pattern characters, such as `Array[`, are reported as unknown and no
+  longer end interactive lookup.
+- Configuration paths outside ASCII are read under the C locale.
+- Ctrl-C is left to the pager while a page is open; it no longer leaves the pager
+  running in a terminal without echo.
+- Colors reach less when `LESS` ends with a string-valued option such as `-P`.
+- The `dark` and `light` presets keep the terminal palette at basic color depth,
+  where `dark` used to paint every role white.
+- Type signatures no longer disable bat for the rest of the page, and a bat that
+  prints nothing no longer stops it.
+- Documentation stored by an RDoc class that the running RDoc lacks is reported
+  as an incompatible cache.
+- The manual no longer has an empty "Style roles" section.
+- Unexpected failures are reported in one line, with the error class, instead of
+  a backtrace.
+- Bash completion keeps a name that contains `=`, such as a setter, intact.
+
 ## [0.1.0] - 2026-10-05
 
 ### Added
@@ -53,5 +78,6 @@ User-visible changes are recorded here. This project follows
 - Invalid dump paths and a missing manual viewer produce actionable errors.
 - Contributor checks handle shallow pull request merge histories.
 
-[Unreleased]: https://github.com/hvpaiva/rich-ri/compare/v0.1.0...HEAD
+[Unreleased]: https://github.com/hvpaiva/rich-ri/compare/v0.1.1...HEAD
 [0.1.0]: https://github.com/hvpaiva/rich-ri/releases/tag/v0.1.0
+[0.1.1]: https://github.com/hvpaiva/rich-ri/releases/tag/v0.1.1

data/completions/rich-ri.bash

@@ -4,7 +4,7 @@
 _rich_ri() {
   # _init_completion assigns prev through Bash's dynamic scope.
   # shellcheck disable=SC2034
-  local cur prev words cword value _description
+  local cur prev words cword value _description prefix
   COMPREPLY=()
   _init_completion -n ':=' || return
   while IFS=$'\t' read -r value _description; do
@@ -15,7 +15,11 @@ _rich_ri() {
   fi
   [[ $cur == *:* ]] && __ltrim_colon_completions "$cur"
   if [[ $cur == *=* && $COMP_WORDBREAKS == *'='* ]]; then
-    COMPREPLY=("${COMPREPLY[@]#*=}")
+    prefix=${cur%"${cur##*=}"}
+    COMPREPLY=("${COMPREPLY[@]#"$prefix"}")
+    if ((${#COMPREPLY[@]} == 1)) && [[ -z ${COMPREPLY[0]} ]]; then
+      COMPREPLY=()
+    fi
   fi
   return 0
 }

data/docs/configuration.md

@@ -105,7 +105,9 @@ configuration does not start a pager.
 `terminal` uses your terminal's ANSI palette, preserving rich-ri's default
 appearance. `dark` and `light` supply foreground colors suited to those
 backgrounds. They do not set the terminal background or try to detect it.
-Choose explicitly if your terminal palette needs different contrast.
+Choose explicitly if your terminal palette needs different contrast. At `basic`
+color depth both presets keep the terminal palette, because sixteen colors cannot
+tell their shades apart.
 
 Each style is a colon-separated string. A bare color sets the foreground;
 `fg=COLOR` and `bg=COLOR` set foreground and background explicitly. Attributes
@@ -213,7 +215,7 @@ an empty value, to fall back to the file or an earlier layer.
 | `RI` | Default command-line options, parsed as shell words. |
 | `RI_PAGER` | Documentation pager command; overrides the file, below `--pager-command`. |
 | `PAGER` | Fallback documentation pager; also used by man according to its own rules. |
-| `LESS` | Options for less; rich-ri appends `-R` for its child documentation pager. |
+| `LESS` | Options for less; rich-ri adds `-R` for its child documentation pager. |
 | `BAT_THEME` | Backward-compatible bat theme override when `RICH_RI_BAT_THEME` is unset. |
 | `NO_COLOR` | Nonempty values disable automatic colors. |
 | `TERM` | `dumb` disables automatic colors; `256color` indicates 256-color capability. |

data/docs/development.md

@@ -72,15 +72,20 @@ To test the minimum runtime dependencies, use Ruby 3.4 with Bash, Zsh, Fish and
 bash-completion 2.x installed locally, then run:
 
 ```sh
-BUNDLE_GEMFILE=gemfiles/legacy.gemfile bundle install
-BUNDLE_GEMFILE=gemfiles/legacy.gemfile bundle exec ruby -rrdoc/rdoc -e \
-  'RDoc::RDoc.new.document(ARGV)' -- --ri --quiet --op tmp/legacy-ri test/fixtures/example.rb
-BUNDLE_GEMFILE=gemfiles/minimum.gemfile bundle install
-LEGACY_RI_STORE="$PWD/tmp/legacy-ri" BUNDLE_GEMFILE=gemfiles/minimum.gemfile \
-  RICH_RI_REQUIRE_SHELLS=1 bundle exec ruby bin/test-compatibility
+(
+  export BUNDLE_PATH="$PWD/tmp/compatibility-gems"
+  BUNDLE_GEMFILE=gemfiles/legacy.gemfile bundle install
+  BUNDLE_GEMFILE=gemfiles/legacy.gemfile bundle exec ruby -rrdoc/rdoc -e \
+    'RDoc::RDoc.new.document(ARGV)' -- --ri --quiet --op tmp/legacy-ri test/fixtures/example.rb
+  BUNDLE_GEMFILE=gemfiles/minimum.gemfile bundle install
+  LEGACY_RI_STORE="$PWD/tmp/legacy-ri" BUNDLE_GEMFILE=gemfiles/minimum.gemfile \
+    RICH_RI_REQUIRE_SHELLS=1 bundle exec ruby bin/test-compatibility
+)
 ```
 
-The first bundle generates a store using RDoc 6.14. The second runs the runtime
+The subshell's own bundle path keeps RDoc 6.14 out of the active Ruby, where
+installing it would replace the RubyGems plugin that `gem rdoc` loads. The first
+bundle generates a store using RDoc 6.14. The second runs the runtime
 tests using the minimum direct dependencies compatible with RDoc 8.1, including
 lookup and completion against that older store. Maintenance-only tests and the
 optional server/profiler modes use the main bundle; missing-gem behavior is tested

data/docs/usage.md

@@ -143,5 +143,8 @@ needed gem to that bundle too.
 
 ## Exit status
 
-The command exits with 0 on success, 1 for lookup or usage errors and 130 when
-interrupted. A closed output pipe is a normal exit.
+The command exits with 0 on success, 1 for any failure and 130 when
+interrupted. A closed output pipe is a normal exit, and so is a name that RDoc
+answers with similar names or with the pages of its source. While a pager is
+open, Ctrl-C belongs to the pager; at the interactive prompt it ends the session
+with status 0.

data/lib/rich_ri/ansi.rb

@@ -18,6 +18,7 @@ module RichRI
   # Documentation may contain literal terminal controls. Show them as text;
   # only styles produced by this reader may reach the terminal as escapes.
   def self.sanitize(text)
+    text = text.dup.force_encoding(Encoding::UTF_8) unless text.encoding == Encoding::UTF_8 || text.ascii_only?
     text.gsub(/[\x00-\x08\x0b\x0c\x0e-\x1f\x7f\u0080-\u009f\u202a-\u202e\u2066-\u2069]|\r(?!\n)/) do |char|
       format("\\u%04x", char.ord)
     end

data/lib/rich_ri/bat.rb

@@ -37,7 +37,7 @@ module RichRI
         completed = false
         writer = Thread.new { write(input, text) }
         Timeout.timeout(@timeout) do
-          result = output.read(@max_output + 1).to_s
+          result = output.read(@max_output + 1) || +""
           next if result.bytesize > @max_output
 
           writer.value

data/lib/rich_ri/cli.rb

@@ -32,31 +32,39 @@ module RichRI
       0
     rescue Errno::EPIPE
       0
-    rescue OptionParser::ParseError, ArgumentError, RDoc::Error, TypeError, LoadError, SystemCallError => e
-      if (dependency = optional_dependency(e))
+    rescue OptionParser::ParseError, ArgumentError, RDoc::Error, TypeError, LoadError, SystemCallError, RegexpError => e
+      report(e)
+    rescue StandardError => e
+      warn "rich-ri: #{e.class}: #{RichRI.sanitize(e.message)}"
+      1
+    rescue Interrupt
+      130
+    end
+
+    private
+
+    def report(error)
+      if (dependency = optional_dependency(error))
         warn "rich-ri: --#{dependency == 'webrick' ? 'server' : 'profile'} requires the optional #{dependency} gem.\n" \
              "Install it for your active Ruby: gem install #{dependency}"
-      elsif incompatible_cache?(e)
+      elsif incompatible_cache?(error)
         warn "rich-ri: incompatible RI cache format for this Ruby and RDoc.\n" \
              "Regenerate the documentation with your current Ruby and RDoc. For gems: gem rdoc GEM_NAME --ri.\n" \
              "For Ruby core documentation, see https://github.com/hvpaiva/rich-ri/blob/main/docs/troubleshooting.md"
       else
-        warn "rich-ri: #{RichRI.sanitize(e.message)}\nRun rich-ri --help for usage."
+        warn "rich-ri: #{RichRI.sanitize(error.message)}\nRun rich-ri --help for usage."
       end
       1
-    rescue Interrupt
-      130
     end
 
-    private
-
     def optional_dependency(error)
       error.path if error.is_a?(LoadError) && %w[profile webrick].include?(error.path)
     end
 
     def incompatible_cache?(error)
       (error.is_a?(TypeError) && error.message.match?(/class RDoc::Markup::\w+ not a struct/)) ||
-        (error.is_a?(ArgumentError) && error.message == "dump format error")
+        (error.is_a?(ArgumentError) &&
+          (error.message == "dump format error" || error.message.start_with?("undefined class/module RDoc::")))
     end
 
     def color?(mode)
@@ -102,7 +110,7 @@ module RichRI
       previous_pager = ENV.fetch("RI_PAGER", nil)
       ENV["RI_PAGER"] = command if command
       previous = ENV.fetch("LESS", nil)
-      ENV["LESS"] = "#{previous || '-Fi'} -R"
+      ENV["LESS"] = "-R #{previous || '-Fi'}"
       yield
     ensure
       ENV["LESS"] = previous

data/lib/rich_ri/configuration.rb

@@ -42,7 +42,7 @@ module RichRI
     end
 
     def self.text!(value, name)
-      if value.is_a?(String) && !value.strip.empty? && RichRI.sanitize(value) == value && !value.match?(/[\r\n\t]/)
+      if value.is_a?(String) && !value.strip.empty? && RichRI.sanitize(value).b == value.b && !value.match?(/[\r\n\t]/)
         return
       end
 
@@ -73,7 +73,7 @@ module RichRI
     def read_file
       raise ArgumentError, "Configuration is not a readable regular file: #{@path}" unless File.file?(@path)
 
-      content = File.read(@path, MAX_BYTES + 1)
+      content = File.read(@path, MAX_BYTES + 1).to_s
       raise ArgumentError, "Configuration exceeds #{MAX_BYTES} bytes: #{@path}" if content.bytesize > MAX_BYTES
 
       stream = Psych.parse_stream(content, filename: @path)

data/lib/rich_ri/driver.rb

@@ -47,7 +47,20 @@ module RichRI
     end
 
     def page
-      super { |io| yield(@list && !@formatter_klass ? ListOutput.new(io) : io) }
+      interrupt = nil
+      super do |io|
+        interrupt = trap("INT", "IGNORE") if paging?
+        yield(@list && !@formatter_klass ? ListOutput.new(io) : io)
+      end
+    ensure
+      trap("INT", interrupt) if interrupt
+    end
+
+    def expand_name(name)
+      super
+    rescue RegexpError
+      # RDoc builds a pattern from the name without escaping it.
+      raise NotFoundError, name
     end
 
     def start_server
@@ -76,7 +89,8 @@ module RichRI
           next if (store.cache[:pages] || []).empty?
 
           source = store.type == :gem ? store.source.sub(/-\d[^-]*\z/, "") : store.source
-          candidates << "#{source}:" if source.start_with?(name)
+          # RubyGems reports its directories as binary strings, which Reline refuses to offer.
+          candidates << "#{source}:".force_encoding(Encoding::UTF_8) if source.start_with?(name)
         end
       end
       candidates.uniq.sort

data/lib/rich_ri/highlighter.rb

@@ -26,7 +26,7 @@ module RichRI
                                    shell_session(text) || other_language(text, format, theme: @shell_theme)
                                  elsif SESSION_FORMATS.include?(format)
                                    shell_session(text) || text
-                                 elsif %i[c cpp javascript js json yaml yml diff sql rbs].include?(format)
+                                 elsif %i[c cpp javascript js json yaml yml diff sql].include?(format)
                                    other_language(text, format)
                                  else
                                    text

data/lib/rich_ri/theme.rb

@@ -35,7 +35,8 @@ module RichRI
       @name = name.dup.freeze
       @depth = (depth == "auto" ? self.class.detect_depth(env) : depth).dup.freeze
       @styles = COLORS.dup
-      apply_styles(PALETTES.fetch(name, {}))
+      # Sixteen colors cannot tell the shades of a preset apart; the terminal's own palette can.
+      apply_styles(PALETTES.fetch(name, {})) unless @depth == "basic"
       apply_styles(styles)
       @styles.transform_values!(&:freeze)
       @styles.freeze

data/lib/rich_ri/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RichRI
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/man/man1/rich-ri.1

@@ -1,4 +1,4 @@
-.TH RICH-RI 1 "" "rich-ri 0.1.0" "User Commands"
+.TH RICH-RI 1 "" "rich-ri 0.1.1" "User Commands"
 .SH NAME
 rich-ri - readable, colorful Ruby documentation
 .SH SYNOPSIS
@@ -151,7 +151,6 @@ Show this help.
 .TP
 .B \-v, \-\-version
 Show the rich\-ri version.
-.SS Style roles
 .SH EXAMPLES
 .nf
 rich\-ri Array#map
@@ -187,7 +186,8 @@ broken file. Use --no-config to bypass it for other commands.
 .TP
 .B theme
 terminal (default), dark or light. Presets change foreground colors;
-they do not detect or set the terminal background.
+they do not detect or set the terminal background. With basic color depth
+dark and light keep the terminal palette.
 .TP
 .B color
 auto (default), always or never. Auto colors only terminal output, unless
@@ -411,7 +411,7 @@ bat comes from PATH; its configuration file is disabled.
 bat calls have a two-second deadline, a 1 MiB input limit and an 8 MiB output limit.
 Failed or invalid output leaves the original text and disables bat for the rest of the page.
 .SH EXIT STATUS
-0: success (including a closed output pipe); 1: lookup or usage failure;
+0: success (including a closed output pipe); 1: any failure;
 130: interrupted.
 .SH SEE ALSO
 ri(1), ruby(1), less(1), bat(1)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rich-ri
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Highlander Paiva