bri 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c9a3a5911ab72b9546ab330dd5ee4513526deaecb4e508b818cef6f28b03283
-  data.tar.gz: 52dd0d1b13b6e74b54efebb4364ff56619776db6a8348f6ca8ab8aab67231fbf
+  metadata.gz: 2a207a768943836bb63dea1964e177e4eef7dbfa7e07c26b76fa3cf254c1db86
+  data.tar.gz: 6bb5e69bdb8bd7050e179cf51d49084facd31b8a900b06ddcacc030503718fee
 SHA512:
-  metadata.gz: 548798d2184a8c2f6543d7164fafcee5ee2699ffee6547aa16a982387aea81307755c5b9bef95cf667b3d80614f3d2bf8f18a21fe727c14f593a1207f6163f02
-  data.tar.gz: 1836149121859a7d8b66a19dbbd5c0b18b536c3c4af440b6e7c1c5bac298fd40903ecd240a6cdb9bf46fb8f02914378bbf0ecb68fe024b030c0fc5d848496f3a
+  metadata.gz: 4388dd1a1a040b7f51d49ddc67131d3f0865e39a3120e9816373490bddb408aa26b40b32a946b3246dacdb98113503165a9cdee368d248d07602dccd6bb685cc
+  data.tar.gz: 68b5edcf218e9c63545e253ce697851d0653f9c50104656962552566e8674ffe9848eff6c42e4dfbfe55b6b2ab6d9aa53323a48d43d8ba29a948fefce2cb7abf

data/Changelog

@@ -1,3 +1,12 @@
+0.4.2
+  - Fix broken --list-names option
+  - Fix broken multiple choice display
+  - Remove comma separators from method lists in order to ease copy and paste
+  actions
+  - List multiple choices one per line for easier visual searching
+  - More internal cleanups
+  - Add caveat to the readme
+
 0.4.1
   - Modernize and refactor code
   - Show extends of classes in rendered documentation

data/README.rdoc

@@ -1,11 +1,21 @@
 = What is this ?
-During the days of Ruby 1.8, the ri command was slow. I mean really slow. Glacially. Starting a web browser and looking up a class or method description on ruby-doc.org often felt faster.
+During the days of Ruby 1.8, the ri command was slow. I mean really slow.
+Glacially. Starting a web browser and looking up a class or method description
+on ruby-doc.org often felt faster.
 
-Then Mauricio Fernandez produced fastri and qri that produced results a whole lot faster than the native ri tool. Unfortunately, Mauricio seems to have lost interest and didn't port fastri to ruby 1.9. There are patches porting fastri to 1.9.1, but they are iffy and don't work well with 1.9.2 and the new rdoc cache format.
+Then Mauricio Fernandez produced fastri and qri that produced results a whole
+lot faster than the native ri tool. Unfortunately, Mauricio seems to have lost
+interest and didn't port fastri to ruby 1.9. There are patches porting fastri
+to 1.9.1, but they are iffy and don't work well with 1.9.2 and the new rdoc
+cache format.
 
-Now with ruby 1.9 and the rdoc 2.x/3.x gem ri is very responsive. However the output format looks like darkfish without the HTML and uses up a lot of space. And subjectively, it's ugly.
+With ruby 1.9 and rdoc 2.x/3.x ri became very responsive. However the output
+format looks like darkfish without the HTML and uses up a lot of space. 
 
-This is where bri comes in: it tries to emulate fastri/qris output format and lookup patterns while using the new rdoc 2.x/3.x infrastructure.
+And subjectively, it's ugly.
+
+This is where bri comes in: it tries to emulate fastri/qris output format and
+lookup patterns while using the more current rdoc infrastructure.
 
 To compare, do 'ri Array' and 'bri Array' and see which appeals more to you.
 
@@ -29,6 +39,12 @@ Bri is a Beautiful RI formatter.
             # the given search term, and finally looking for the term
             # anywhere in the method name
 
+= Caveats
+I'm reviving this project that has been left rotting for nearly 8 years.
+Due to bitrot, changes in rdoc internals and trying to understand my code
+from back then, some unexpected hickups may arise. All bug reports with 
+references to problematic ri class or method docs are welcome.
+
 = Requirements
  * Ruby 2.6 or later
  * rdoc 6.1 or later

data/TODO

@@ -7,3 +7,5 @@
   highlight these (e.g. Object#send and Object.new)
 - Add display of in_files
 - Add display of module constant aliases
+- Rewrite the search code into something understandable and maintainable
+  (sleep deprivation is one hell of a drug)

data/lib/bri.rb

@@ -1,40 +1,16 @@
-$: << File.dirname( __FILE__ )
 require 'erb'
 require 'term/ansicolor'
 
-
-require 'bri/renderer'
-require 'bri/mall'
-require 'bri/matcher'
-require 'bri/templates'
-require 'bri/search'
-require 'bri/match'
+require_relative 'bri/renderer'
+require_relative 'bri/mall'
+require_relative 'bri/matcher'
+require_relative 'bri/templates'
+require_relative 'bri/search'
+require_relative 'bri/match'
 
 module Bri
   DEFAULT_WIDTH = 72
 
-  def self.format_elements( array )
-    rows = []
-    row = []
-    row_length = 0
-
-    array.each do |element|
-      element_length_with_separator = element.length + 2
-
-      if row_length + element_length_with_separator >= Bri.width
-        rows << row
-        row = []
-        row_length = 0
-      end
-
-      row << element
-      row_length += element_length_with_separator
-    end
-
-    rows << row
-    rows
-  end
-
   def self.ri( query )
     results = Bri::Matcher.new( query ).find
 
@@ -43,6 +19,7 @@ module Bri
     elsif results.size == 1
       results.first.to_s
     else
+      qualified_methods = results.map(&:full_name).sort
       ERB.new( Bri::Templates::MULTIPLE_CHOICES, nil, '<>' ).result( binding )
     end
   end

data/lib/bri/mall.rb

@@ -13,17 +13,17 @@ module Bri
     end
 
     def class_methods
-      stores.flat_map do |store|
-        store.class_methods.map do |klass, methods|
-          methods.map { |method| "#{klass}.#{method}" }
+      stores.each_with_object( [] ) do |store, result|
+        store.class_methods.each do |klass, methods|
+          methods.each { |method| result << "#{klass}.#{method}" }
         end
       end.uniq
     end
 
     def instance_methods
-      stores.flat_map do |store|
-        store.instance_methods.map do |klass, methods|
-          methods.map { |method| "#{klass}##{method}" }
+      stores.each_with_object( [] ) do |store, result|
+        store.instance_methods.each do |klass, methods|
+          methods.each { |method| result << "#{klass}##{method}" }
         end
       end.uniq
     end

data/lib/bri/match.rb

@@ -1,3 +1,3 @@
-require 'bri/match/base'
-require 'bri/match/class'
-require 'bri/match/method'
+require_relative 'match/base'
+require_relative 'match/class'
+require_relative 'match/method'

data/lib/bri/renderer.rb

@@ -2,6 +2,8 @@ require 'strscan'
 
 module Bri
   module Renderer
+    Color = ::Term::ANSIColor
+
     INDENT = ' ' * 2
     INDENT_WIDTH = 2
     LOWER_ALPHABET = ('a'..'z').to_a.map { |char| "#{char}." }.freeze
@@ -100,41 +102,44 @@ module Bri
     end
 
     def self.replace_markup( text )
-      text.gsub!( /(?<!\\)<(?:tt|code)>/, Term::ANSIColor.cyan )
-      text.gsub!( /(?<!\\)<\/(?:tt|code)>/, Term::ANSIColor.reset )
+      text.gsub!( /(?<!\\)<(?:tt|code)>/, Color.cyan )
+      text.gsub!( /(?<!\\)<\/(?:tt|code)>/, Color.reset )
 
-      text.gsub!( /(?<!\\)<b>/, Term::ANSIColor.bold )
-      text.gsub!( /(?<!\\)<\/b>/, Term::ANSIColor.reset )
+      text.gsub!( /(?<!\\)<b>/, Color.bold )
+      text.gsub!( /(?<!\\)<\/b>/, Color.reset )
 
-      text.gsub!( /(?<!\\)<(?:em|i)>/, Term::ANSIColor.yellow )
-      text.gsub!( /(?<!\\)<\/(?:em|i)>/, Term::ANSIColor.reset )
+      text.gsub!( /(?<!\\)<(?:em|i)>/, Color.yellow )
+      text.gsub!( /(?<!\\)<\/(?:em|i)>/, Color.reset )
 
-      text.gsub!( "<h>", Term::ANSIColor.green )
-      text.gsub!( "</h>", Term::ANSIColor.reset )
+      text.gsub!( "<h>", Color.green )
+      text.gsub!( "</h>", Color.reset )
 
       text.gsub!( "\\<", "<" )
 
+      text.gsub!( /(#\s*=>)(.*)/,
+                  "#{Color.dark}\\1#{Color.reset}#{Color.bold}\\2#{Color.reset}" )
+
       text.gsub!( /(^|\s)\*(.*?[a-zA-Z0-9]+.*?)\*/, 
-                  "\\1#{Term::ANSIColor.bold}\\2#{Term::ANSIColor.reset}" )
+                  "\\1#{Color.bold}\\2#{Color.reset}" )
       text.gsub!( /(^|\s)\+(.*?[a-zA-Z0-9]+.*?)\+/, 
-                  "\\1#{Term::ANSIColor.cyan}\\2#{Term::ANSIColor.reset}" )
+                  "\\1#{Color.cyan}\\2#{Color.reset}" )
       text.gsub!( /(^|\s)_(.*?[a-zA-Z0-9]+.*?)_/, 
-                  "\\1#{Term::ANSIColor.yellow}\\2#{Term::ANSIColor.reset}" )
+                  "\\1#{Color.yellow}\\2#{Color.reset}" )
 
       text.gsub!( %r{\b((?:https?|ftp)://[-\w.?%&=/]+)\b}, 
-                  "#{Term::ANSIColor.underline}\\1#{Term::ANSIColor.reset}" )
+                  "#{Color.underline}\\1#{Color.reset}" )
 
       text.gsub!( %r{\b(mailto:[-\w.%]+@[-\w.]+)\b}, 
-                  "#{Term::ANSIColor.underline}\\1#{Term::ANSIColor.reset}" )
+                  "#{Color.underline}\\1#{Color.reset}" )
 
       text.gsub!( %r{\b((?<!:\/\/)www.[-\w.?%&=]+)\b}, 
-                  "#{Term::ANSIColor.underline}\\1#{Term::ANSIColor.reset}" )
+                  "#{Color.underline}\\1#{Color.reset}" )
 
       text.gsub!( %r{\blink:(.*?)(\s|$)}, 
-                  "#{Term::ANSIColor.underline}\\1#{Term::ANSIColor.reset}\\2" )
+                  "#{Color.underline}\\1#{Color.reset}\\2" )
 
       text.gsub!( %r{\{(.*?)\}\[(.*?)\]}, "\\1 (\\2)" )
-      text.gsub!( %r{\[(#{Regexp.escape( Term::ANSIColor.underline )}.*?#{Regexp.escape( Term::ANSIColor.reset )})\]}, 
+      text.gsub!( %r{\[(#{Regexp.escape( Color.underline )}.*?#{Regexp.escape( Color.reset )})\]}, 
                   " (\\1)" )
       text
     end
@@ -144,7 +149,7 @@ module Bri
     end
 
     def self.wrap_list( array, width = Bri.width )
-      indent( wrap_to_width( array.join(", "), width ) )
+      indent( wrap_to_width( array.join("  "), width ) )
     end
 
     def self.wrap_to_width( styled_text, width )

data/lib/bri/search.rb

@@ -1,5 +1,5 @@
-require 'bri/search/base'
-require 'bri/search/class'
-require 'bri/search/method'
-require 'bri/search/class_method'
-require 'bri/search/instance_method'
+require_relative 'search/base'
+require_relative 'search/class'
+require_relative 'search/method'
+require_relative 'search/class_method'
+require_relative 'search/instance_method'

data/lib/bri/templates.rb

@@ -5,7 +5,7 @@ module Bri
     MULTIPLE_CHOICES =<<-EOT
 <%= Bri::Templates::Helpers.hrule( "Multiple choices:" ) %>
 
-<%= Bri::Renderer.wrap_list( qualified_methods.sort ) %>
+<%= qualified_methods.sort.join("\n") %>
 
 
     EOT

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bri
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - Sven Riedel