bri 0.2.1 → 0.4.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9c9a3a5911ab72b9546ab330dd5ee4513526deaecb4e508b818cef6f28b03283
+  data.tar.gz: 52dd0d1b13b6e74b54efebb4364ff56619776db6a8348f6ca8ab8aab67231fbf
+SHA512:
+  metadata.gz: 548798d2184a8c2f6543d7164fafcee5ee2699ffee6547aa16a982387aea81307755c5b9bef95cf667b3d80614f3d2bf8f18a21fe727c14f593a1207f6163f02
+  data.tar.gz: 1836149121859a7d8b66a19dbbd5c0b18b536c3c4af440b6e7c1c5bac298fd40903ecd240a6cdb9bf46fb8f02914378bbf0ecb68fe024b030c0fc5d848496f3a

data/Changelog

@@ -1,3 +1,13 @@
+0.4.1
+  - Modernize and refactor code
+  - Show extends of classes in rendered documentation
+  - Show superclass of classes in rendered documentation
+
+0.4.0
+  - Update gems to their current versions
+  - Require ruby 2.6 or later
+  - Fix code and specs to work with current rspec and rdoc
+
 0.2.1
   - Show origin of class/method in description output
   - Better textflow within paragraphs by ignoring the original newlines

data/{README → README.rdoc}

@@ -30,8 +30,8 @@ Bri is a Beautiful RI formatter.
             # anywhere in the method name
 
 = Requirements
- * Ruby 1.9.2
- * rdoc 3.5.3 and above
+ * Ruby 2.6 or later
+ * rdoc 6.1 or later
  * term-ansicolor
 
 

data/TODO

@@ -3,3 +3,7 @@
   a line wrap occurs
 - Refactor the convoluted rendering of lists and list items
 - Detect ansi capabilities and use what is possible with graceful degradation?
+- Potentially try to detect method references in documentation prose and 
+  highlight these (e.g. Object#send and Object.new)
+- Add display of in_files
+- Add display of module constant aliases

data/lib/bri.rb

@@ -43,21 +43,21 @@ module Bri
     elsif results.size == 1
       results.first.to_s
     else
-      qualified_methods = results.collect{ |result| result.full_name }.sort
       ERB.new( Bri::Templates::MULTIPLE_CHOICES, nil, '<>' ).result( binding )
     end
   end
 
   def self.width
-    return @@width if defined?( @@width )
+    return @width if instance_variable_defined?( :@width )
+
     base_width = ENV['COLUMNS'].to_i 
     base_width = 80 if base_width == 0
 
-    @@width ||= [ base_width - 8, 1 ].max
+    @width ||= [ base_width - 8, 1 ].max
   end
 
   def self.width=( width )
-    @@width = [ width, 1 ].max
+    @width = [ width, 1 ].max
   end
 
   def self.list_classes

data/lib/bri/mall.rb

@@ -9,35 +9,31 @@ module Bri
     attr_reader :stores
 
     def classes
-      @stores.collect { |store| store.modules }.flatten.uniq.sort
+      stores.flat_map(&:module_names).uniq.sort
     end
 
     def class_methods
-      Bri::Mall.instance.stores.map do |store|
+      stores.flat_map do |store|
         store.class_methods.map do |klass, methods|
           methods.map { |method| "#{klass}.#{method}" }
         end
-      end.flatten.uniq
+      end.uniq
     end
 
     def instance_methods
-      Bri::Mall.instance.stores.map do |store|
+      stores.flat_map do |store|
         store.instance_methods.map do |klass, methods|
           methods.map { |method| "#{klass}##{method}" }
         end
-      end.flatten.uniq
+      end.uniq
     end
 
     private
     def initialize
-      @stores = []
-
       # We want: system, site, home and gem documentation
-      RDoc::RI::Paths.each( true, true, true, true ) do |path, type|
-        @stores << RDoc::RI::Store.new( path, type ).
-                                   tap { |store| store.load_cache }
-      end
+      @stores = RDoc::RI::Paths.each( true, true, true, true ).each_with_object( [] ) do |(path, type), stores|
+                  stores << RDoc::Store.new( path, type ).tap { |store| store.load_cache }
+                end
     end
-
   end
 end

data/lib/bri/match/base.rb

@@ -8,7 +8,7 @@ module Bri
 
       private 
       def build_description( source )
-        source.collect { |element| Bri::Renderer.render element }
+        source.map { |element| Bri::Renderer.render( element ) }
       end
     end
   end

data/lib/bri/match/class.rb

@@ -7,28 +7,28 @@ module Bri
       include Bri::Templates::Helpers
       TEMPLATE = Bri::Templates::CLASS_DESCRIPTION
 
-      attr_reader :type, :name, :description_paragraphs
-      attr_reader :includes, :constants, :class_methods, :instance_methods
-      attr_reader :attributes, :origin
+      attr_reader :type, :name, :description_paragraphs,
+                  :includes, :extends, :constants, :class_methods,
+                  :instance_methods, :attributes, :origin
 
       def initialize( rdoc_result, store = nil )
-        @type = rdoc_result.type
-        @name = rdoc_result.full_name
-        @description_paragraphs = build_description( rdoc_result.comment.parts )
-        @includes = rdoc_result.includes.collect { |i| i.full_name }
-        @constants = rdoc_result.constants.collect do |c|
-                       c.value ? "#{c.name} = #{c.value}" : c.name
-                     end
-        @attributes = rdoc_result.attributes.collect { |a| "#{a.name} (#{a.rw})" }
-
         class_methods, instance_methods = rdoc_result.method_list.
                                                       select {|m| m.visibility == :public }.
                                                       partition { |m| m.singleton }
-        @class_methods = class_methods.collect { |m| m.name }
-        @instance_methods = instance_methods.collect { |m| m.name }
-        @origin = store ? store.friendly_path : nil
+        @type                   = rdoc_result.type
+        @name                   = "#{rdoc_result.full_name}"
+        @name                   << " < #{rdoc_result.superclass}" if @type == "class" && rdoc_result.superclass
+        @description_paragraphs = build_description( rdoc_result.comment.parts )
+        @includes               = rdoc_result.includes.map(&:full_name)
+        @extends                = rdoc_result.extends.map(&:full_name)
+        @attributes             = rdoc_result.attributes.map { |a| "#{a.name} (#{a.rw})" }
+        @class_methods          = class_methods.map(&:name)
+        @instance_methods       = instance_methods.map(&:name)
+        @origin                 = store&.friendly_path
+        @constants = rdoc_result.constants.map do |c|
+                       c.value ? "#{c.name} = #{c.value}" : c.name
+                     end
       end
-
     end
   end
 end

data/lib/bri/match/method.rb

@@ -8,11 +8,11 @@ module Bri
 
       def initialize( rdoc_method, store = nil )
         @full_name = rdoc_method.full_name
-        @call_syntaxes = rdoc_method.arglists.split( "\n" ).
-                                              map { |e| "  " + e }.
+        @call_syntaxes = rdoc_method.arglists.lines( chomp: true ).
+                                              map { |e| e.prepend( "  " ) }.
                                               join( "\n" ) + "\n" rescue ''
         @description_paragraphs = build_description( rdoc_method.comment.parts )
-        @origin = store ? store.friendly_path : nil
+        @origin = store&.friendly_path
       end
     end
   end

data/lib/bri/renderer.rb

@@ -3,48 +3,52 @@ require 'strscan'
 module Bri
   module Renderer
     INDENT = ' ' * 2
-    ALPHABET = ('a'..'z').to_a
+    INDENT_WIDTH = 2
+    LOWER_ALPHABET = ('a'..'z').to_a.map { |char| "#{char}." }.freeze
+    UPPER_ALPHABET = ('A'..'Z').to_a.map { |char| "#{char}." }.freeze
 
     def self.render( element, width = Bri.width, alignment_width = 0 )
-      # STDERR.puts "Rendering #{element.inspect}"
       case element
         when RDoc::Markup::Verbatim 
           text = extract_text( element, width )
           styled_text = replace_markup( text )
-          indent( styled_text ) + "\n"
+          "#{indent( styled_text )}\n"
 
         when RDoc::Markup::List
-          item_width = width - INDENT.length
+          item_width = width - INDENT_WIDTH
           case element.type
             when :BULLET 
-              rendered_items = element.items.collect { |item| render item, item_width }
+              rendered_items = element.items.map { |item| render( item, item_width ) }
               rendered_items.map! { |item| item.gsub( /\n/, "\n#{INDENT}" ) }
-              rendered_items.map! { |item| ' *' + item }
+              rendered_items.map! { |item| item.prepend( ' *' ) }
 
             when :NUMBER
-              i = 0
-              rendered_items = element.items.collect { |item| render item, item_width }
+              rendered_items = element.items.map { |item| render( item, item_width ) }
               rendered_items.map! { |item| item.gsub( /\n/, "\n#{INDENT}" ) }
-              rendered_items.map! { |item| i+=1; sprintf "%d.%s", i, item }
+              rendered_items.map!.with_index( 1 ) { |item, i| item.prepend( "#{i}." ) }
 
             when :LALPHA
-              i = -1
-              rendered_items = element.items.collect { |item| render item, item_width }
+              rendered_items = element.items.map { |item| render( item, item_width ) }
               rendered_items.map! { |item| item.gsub( /\n/, "\n#{INDENT}" ) }
-              rendered_items.map! { |item| i+=1; sprintf "%s.%s", ALPHABET[i], item }
+              rendered_items.map!.with_index { |item, i| item.prepend( LOWER_ALPHABET[i] ) }
+
+            when :UALPHA
+              rendered_items = element.items.map { |item| render( item, item_width ) }
+              rendered_items.map! { |item| item.gsub( /\n/, "\n#{INDENT}" ) }
+              rendered_items.map!.with_index { |item, index| item.prepend( UPPER_ALPHABET[i] ) }
               
             when :LABEL
               # do nothing
-              rendered_items = element.items.collect { |item| render item, item_width }
+              rendered_items = element.items.map { |item| render( item, item_width ) }
               rendered_items.map! { |item| item.gsub( /\n/, "\n#{INDENT}" ) }
 
             when :NOTE
-              alignment_width = element.items.collect { |item| item.label.size }.max + 1
-              rendered_items = element.items.collect { |item| render item, item_width, alignment_width }
+              alignment_width = element.items.flat_map(&:label).map(&:size).max + 1
+              rendered_items = element.items.map { |item| render( item, item_width, alignment_width ) }
               rendered_items.map! { |item| item.gsub( /\n/, "\n#{INDENT}" ) }
           end
 
-          rendered_items.join( "\n\n" ) + "\n"
+          "#{rendered_items.join( "\n\n" )}\n"
 
         else
           text = extract_text( element, width, alignment_width )
@@ -56,64 +60,81 @@ module Bri
 
     def self.extract_text( element, width, label_alignment_width = 0, conserve_newlines = false )
       text = case element
-               when RDoc::Markup::Paragraph 
+               when RDoc::Markup::Paragraph
                  join_char = conserve_newlines ? "\n" : " "
-                 element.parts.join( join_char )
+                 element.parts.map(&:strip).join( join_char )
+
                when RDoc::Markup::BlankLine
                  ""
+
                when RDoc::Markup::Rule
                  "-" * width
+
                when RDoc::Markup::Verbatim
-                 element.text
+                 element.parts.map { |part| part.prepend( "  " ) }.join
+
                when RDoc::Markup::Heading
                  "<h>#{element.text}</h>" 
+
                when RDoc::Markup::ListItem
-                 parts = element.parts.collect { |part| extract_text part, width, 0, true }.join
-                 element.label ? sprintf( "%*s %s", -label_alignment_width, "#{element.label}:", parts ) : parts
+                 parts = element.parts.map { |part| extract_text( part, width, 0, true ) }.join
+
+                 if element.label
+                   labels = element.label.map { |l| "#{l}:" }.join("\n")
+                   sprintf( "%*s %s", -label_alignment_width, labels, parts )
+                 else
+                   parts
+                 end
+
                when RDoc::Markup::List
-                 render( element, width - INDENT.length )
+                 render( element, width - INDENT_WIDTH )
+
+                when RDoc::Markup::Document
+                  element.parts.
+                          map { |part| extract_text( part, width, label_alignment_width, conserve_newlines ) }.
+                          join
                else  
                  raise "Don't know how to handle type #{element.class}: #{element.inspect}"
              end
-      text + "\n"
+      text << "\n"
     end
 
     def self.replace_markup( text )
-      text.gsub!( /(?<!\\)<(?:tt|code)>/, Term::ANSIColor::cyan )
-      text.gsub!( /(?<!\\)<\/(?:tt|code)>/, Term::ANSIColor::reset )
+      text.gsub!( /(?<!\\)<(?:tt|code)>/, Term::ANSIColor.cyan )
+      text.gsub!( /(?<!\\)<\/(?:tt|code)>/, Term::ANSIColor.reset )
 
-      text.gsub!( /(?<!\\)<b>/, Term::ANSIColor::bold )
-      text.gsub!( /(?<!\\)<\/b>/, Term::ANSIColor::reset )
+      text.gsub!( /(?<!\\)<b>/, Term::ANSIColor.bold )
+      text.gsub!( /(?<!\\)<\/b>/, Term::ANSIColor.reset )
 
-      text.gsub!( /(?<!\\)<(?:em|i)>/, Term::ANSIColor::yellow )
-      text.gsub!( /(?<!\\)<\/(?:em|i)>/, Term::ANSIColor::reset )
+      text.gsub!( /(?<!\\)<(?:em|i)>/, Term::ANSIColor.yellow )
+      text.gsub!( /(?<!\\)<\/(?:em|i)>/, Term::ANSIColor.reset )
 
-      text.gsub!( "<h>", Term::ANSIColor::green )
-      text.gsub!( "</h>", Term::ANSIColor::reset )
+      text.gsub!( "<h>", Term::ANSIColor.green )
+      text.gsub!( "</h>", Term::ANSIColor.reset )
 
       text.gsub!( "\\<", "<" )
 
       text.gsub!( /(^|\s)\*(.*?[a-zA-Z0-9]+.*?)\*/, 
-                  "\\1#{Term::ANSIColor::bold}\\2#{Term::ANSIColor::reset}" )
+                  "\\1#{Term::ANSIColor.bold}\\2#{Term::ANSIColor.reset}" )
       text.gsub!( /(^|\s)\+(.*?[a-zA-Z0-9]+.*?)\+/, 
-                  "\\1#{Term::ANSIColor::cyan}\\2#{Term::ANSIColor::reset}" )
+                  "\\1#{Term::ANSIColor.cyan}\\2#{Term::ANSIColor.reset}" )
       text.gsub!( /(^|\s)_(.*?[a-zA-Z0-9]+.*?)_/, 
-                  "\\1#{Term::ANSIColor::yellow}\\2#{Term::ANSIColor::reset}" )
+                  "\\1#{Term::ANSIColor.yellow}\\2#{Term::ANSIColor.reset}" )
 
       text.gsub!( %r{\b((?:https?|ftp)://[-\w.?%&=/]+)\b}, 
-                  "#{Term::ANSIColor::underline}\\1#{Term::ANSIColor::reset}" )
+                  "#{Term::ANSIColor.underline}\\1#{Term::ANSIColor.reset}" )
 
       text.gsub!( %r{\b(mailto:[-\w.%]+@[-\w.]+)\b}, 
-                  "#{Term::ANSIColor::underline}\\1#{Term::ANSIColor::reset}" )
+                  "#{Term::ANSIColor.underline}\\1#{Term::ANSIColor.reset}" )
 
       text.gsub!( %r{\b((?<!:\/\/)www.[-\w.?%&=]+)\b}, 
-                  "#{Term::ANSIColor::underline}\\1#{Term::ANSIColor::reset}" )
+                  "#{Term::ANSIColor.underline}\\1#{Term::ANSIColor.reset}" )
 
       text.gsub!( %r{\blink:(.*?)(\s|$)}, 
-                  "#{Term::ANSIColor::underline}\\1#{Term::ANSIColor::reset}\\2" )
+                  "#{Term::ANSIColor.underline}\\1#{Term::ANSIColor.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( Term::ANSIColor.underline )}.*?#{Regexp.escape( Term::ANSIColor.reset )})\]}, 
                   " (\\1)" )
       text
     end
@@ -127,7 +148,7 @@ module Bri
     end
 
     def self.wrap_to_width( styled_text, width )
-      styled_text.split( "\n" ).collect { |row| wrap_row row, width }.join
+      styled_text.split( "\n" ).map { |row| wrap_row( row, width ) }.join
     end
 
     def self.wrap_row( physical_row, width )
@@ -146,6 +167,7 @@ module Bri
           logical_row = ''
           printable_row_length = 0
         end
+
         logical_row << token
         printable_row_length += printable_token_length
 
@@ -153,11 +175,12 @@ module Bri
         logical_row << token
         printable_row_length += token.length
       end
+
       output_text << logical_row << "\n"
     end
 
     def self.indent( text )
-      text.split( "\n" ).collect { |row| "#{INDENT}#{row}" }.join("\n" )
+      text.split( "\n" ).map { |row| "#{INDENT}#{row}" }.join("\n" )
     end
   end
 end

data/lib/bri/search/class.rb

@@ -1,14 +1,12 @@
 module Bri
   module Search
     class Class < Base
-
       def search( type = :fully_qualified )
         # NOTE: classes are only searched as fully qualified for the time being
         # FIXME: What do we do if more than one store defines the same class?
-        store = Bri::Mall.instance.stores.detect { |s| s.modules.include? @term }
+        store = Bri::Mall.instance.stores.detect { |s| s.module_names.include?( @term ) }
         @matches << Bri::Match::Class.new( store.load_class( @term ), store ) if store
       end
-
     end
   end
 end

data/lib/bri/search/class_method.rb

@@ -8,6 +8,7 @@ module Bri
 
       def method_rdoc( store, klass = @class_term, method = @method_term )
         store.load_method( klass, method )
+
       rescue Errno::ENOENT
         nil
       end

data/lib/bri/search/instance_method.rb

@@ -7,7 +7,8 @@ module Bri
       end
 
       def method_rdoc( store, klass = @class_term, method = @method_term )
-        store.load_method( klass, "#" + method )
+        store.load_method( klass, "##{method}" )
+
       rescue Errno::ENOENT
         nil
       end

data/lib/bri/search/method.rb

@@ -7,11 +7,11 @@ module Bri
         super
         @class_term, @method_term = term.split( /[\.#]/, 2 )
 
-        if @class_term !~ /^[A-Z]/ && @method_term.nil?
+        if @class_term !~ /^[A-Z]/ && !@method_term
           @method_term, @class_term = @class_term, @method_term
         end
 
-        @class_term = nil if @class_term == ""
+        @class_term = nil if @class_term&.empty?
       end
 
       def search( type = :fully_qualified )
@@ -38,17 +38,18 @@ module Bri
       end
 
       def classes_with_method( store, method )
-        store_methods( store ).select { |klass, methods| methods.include? method }.keys
+        store_methods( store ).select do |_klass, methods|
+                                 methods.include?( method )
+                               end.keys
       end
 
       def candidates_from_method_re( store, method_re )
-        candidates = {}
-        store_methods( store ).each do |klass, methods|
+        store_methods( store ).each_with_object( {} ) do |(klass, methods), candidates|
           matching_methods = methods.grep( method_re )
           next if matching_methods.empty?
+
           candidates[klass] = matching_methods
         end
-        candidates
       end
 
 
@@ -64,9 +65,9 @@ module Bri
       end
 
       def unqualified_search
-        [ /^#{Regexp.escape @method_term}$/,
-          /^#{Regexp.escape @method_term}/,
-          /#{Regexp.escape @method_term}/ ].each do |method_re|
+        [ /^#{Regexp.escape( @method_term )}$/,
+          /^#{Regexp.escape( @method_term )}/,
+          /#{Regexp.escape( @method_term )}/ ].each do |method_re|
           unqualified_search_worker( method_re )
           break unless @matches.empty?
         end
@@ -84,7 +85,6 @@ module Bri
           end
         end
       end
-
     end
   end
 end

data/lib/bri/templates.rb

@@ -1,5 +1,7 @@
 module Bri
   module Templates
+    RULE_CHARACTER = '-'.freeze
+
     MULTIPLE_CHOICES =<<-EOT
 <%= Bri::Templates::Helpers.hrule( "Multiple choices:" ) %>
 
@@ -25,6 +27,12 @@ module Bri
 <%= Bri::Renderer.wrap_list( includes.sort ) %>
 
 
+<% end %>
+<% if !extends.empty? %>
+<%= section_header( "Extends:" ) %>
+<%= Bri::Renderer.wrap_list( extends.sort ) %>
+
+
 <% end %>
 <% if !constants.empty? %>
 <%= section_header( "Constants:" ) %>
@@ -68,12 +76,13 @@ module Bri
 
     module Helpers
       def hrule( text = '', width = Bri.width )
-        if text == ''
-          '-' * width + "\n"
-        else
-          text = " " + text if text != ''
-          ( '-' * [ ( width - text.length ), 1 ].max ) + Term::ANSIColor::bold( text ) + "\n"
-        end
+        text.prepend( " " ) unless text.empty?
+
+        rule_length = width - text.length
+        rule_length = 1 if rule_length < 1
+
+        rule = RULE_CHARACTER * rule_length
+        "#{rule}#{Term::ANSIColor::bold( text )}\n"
       end
       module_function :hrule
 
@@ -83,7 +92,7 @@ module Bri
       end
 
       def section_header( text )
-        Term::ANSIColor::green + Term::ANSIColor::underline + text + Term::ANSIColor::reset + "\n"
+        "#{Term::ANSIColor.green}#{Term::ANSIColor.underline}#{text}#{Term::ANSIColor.reset}\n"
       end
       module_function :section_header
     end

data/spec/lib/bri/match/class_spec.rb

@@ -37,17 +37,17 @@ describe Bri::Match::Class do
 
   describe "#name" do
     it "should contain the name of a class" do
-      empty_class.name.should == "BriDummySpecClassEmpty"
+      empty_class.name.should == "BriDummySpecClassEmpty < Object"
     end
 
     it "should contain the fully qualified name of a namespaced class" do
-      namespaced_class.name.should == "BriDummySpec::Class"
+      namespaced_class.name.should == "BriDummySpec::Class < Object"
     end
   end
 
   describe "#description_paragraphs" do
     it "should be empty for an undocumented class" do
-      empty_class.description_paragraphs.should be_empty
+      empty_class.description_paragraphs.should == [ '' ]
     end
 
     it "should contain rendered text for a documented class" do

data/spec/lib/bri/match/method_spec.rb

@@ -6,11 +6,11 @@ describe Bri::Match::Method do
   end
 
   let( :fake_description ) do
-    mock( RDoc::Markup::Document, :parts => [ fake_paragraph ] )
+    double( RDoc::Markup::Document, :parts => [ fake_paragraph ] )
   end
 
   let( :rdoc_method ) do
-    mock( RDoc::AnyMethod, :full_name => "This::IS::My.full_name",
+    double( RDoc::AnyMethod, :full_name => "This::IS::My.full_name",
                            :arglists => "First\nSecond\nThird",
                            :comment => fake_description )
   end

data/spec/lib/bri/renderer_spec.rb

@@ -75,14 +75,14 @@ describe Bri::Renderer do
     end
 
     it "should start second lines of a list item with the same left alignment as the first list items content" do
-      subject.should =~ /\n \*  First item in a bulleted list\n    With a second line\n/
+      subject.should =~ /\n \*  First item in a bulleted list(?:\s*?)\n    With a second line\n/
     end
 
     context "contained verbatim text" do
       subject { render_description_for_method( "list_containing_verbatim_text" ) }
       
       it "should correctly display verbatim text" do
-        subject.should =~ /\n  Containing verbatim text\n/
+        subject.should =~ /\n    Containing verbatim text\n/
       end
     end
 

data/spec/lib/bri/search/class_method_spec.rb

@@ -3,26 +3,26 @@ require 'spec_helper'
 describe Bri::Search::ClassMethod do
   context "the searches" do
     let( :paragraph ) { RDoc::Markup::Paragraph.new( "Foo Description" ) }
-    let( :document ) { mock( RDoc::Markup::Document, :parts => [ paragraph ] ) }
-    let( :rdoc_method ) { mock( RDoc::AnyMethod, :full_name => "Foo",
+    let( :document ) { double( RDoc::Markup::Document, :parts => [ paragraph ] ) }
+    let( :rdoc_method ) { double( RDoc::AnyMethod, :full_name => "Foo",
                                                  :arglists => "",
                                                  :comment => document ) }
     before( :each ) do
-      store_one = mock( RDoc::RI::Store, :load_cache    => true,
+      store_one = double( RDoc::RI::Store, :load_cache    => true,
                                          :load_class    => true,
                                          :load_method   => rdoc_method,
                                          :friendly_path => "ruby core",
                                          :modules       => %w{ ClassThree },
                                          :class_methods => { "ClassThree" => [ "method" ] } )
-      store_two = mock( RDoc::RI::Store, :load_cache    => true,
+      store_two = double( RDoc::RI::Store, :load_cache    => true,
                                          :load_class    => true,
                                          :load_method   => rdoc_method,
                                          :friendly_path => "ruby core",
                                          :modules       => %w{ ClassOne ClassTwo },
                                          :class_methods => { "ClassOne" => [ "method" ],
                                                              "ClassTwo" => [ "method", "my_other_method" ] } )
-      Bri::Mall.instance.stub!( :stores => [ store_one, store_two ] )
-      Bri::Match::Class.stub!( :new ).and_return( mock( Bri::Match::Class ) )
+      allow(Bri::Mall.instance).to receive( :stores ).and_return( [ store_one, store_two ] )
+      allow(Bri::Match::Class).to receive( :new ).and_return( double( Bri::Match::Class ) )
     end
 
     describe "a fully qualified search" do 
@@ -124,7 +124,7 @@ describe Bri::Search::ClassMethod do
           search_instance = Bri::Search::ClassMethod.new( ".bri_dummy_spec_singleton_method" )
           search_instance.search( :partially_qualified )
           search_instance.matches.should_not be_empty
-          search_instance.matches.any? { |match| match.full_name == "BriDummySpecClass::bri_dummy_spec_singleton_method" }.should be_true
+          search_instance.matches.any? { |match| match.full_name == "BriDummySpecClass::bri_dummy_spec_singleton_method" }.should be(true)
         end
       end
 
@@ -133,8 +133,8 @@ describe Bri::Search::ClassMethod do
           search_instance = Bri::Search::ClassMethod.new( ".bri_dummy_spec_second_singleton_method" )
           search_instance.search( :partially_qualified )
           search_instance.matches.should_not be_empty
-          search_instance.matches.any? { |match| match.full_name == "BriDummySpecClass::bri_dummy_spec_second_singleton_method" }.should be_true
-          search_instance.matches.any? { |match| match.full_name == "BriDummySpecClassTwo::bri_dummy_spec_second_singleton_method" }.should be_true
+          search_instance.matches.any? { |match| match.full_name == "BriDummySpecClass::bri_dummy_spec_second_singleton_method" }.should be(true)
+          search_instance.matches.any? { |match| match.full_name == "BriDummySpecClassTwo::bri_dummy_spec_second_singleton_method" }.should be(true)
         end
       end
     end
@@ -153,7 +153,7 @@ describe Bri::Search::ClassMethod do
           search_instance = Bri::Search::ClassMethod.new( "bri_dummy_spec_singleton_method" )
           search_instance.search( :unqualified )
           search_instance.matches.should_not be_empty
-          search_instance.matches.any? { |match| match.full_name == "BriDummySpecClass::bri_dummy_spec_singleton_method" }.should be_true
+          search_instance.matches.any? { |match| match.full_name == "BriDummySpecClass::bri_dummy_spec_singleton_method" }.should be(true)
         end
       end
 
@@ -162,9 +162,9 @@ describe Bri::Search::ClassMethod do
           search_instance = Bri::Search::ClassMethod.new( "bri_dummy_spec" )
           search_instance.search( :unqualified )
           search_instance.matches.should_not be_empty
-          search_instance.matches.any? { |match| match.full_name == "BriDummySpecClass::bri_dummy_spec_singleton_method" }.should be_true
-          search_instance.matches.any? { |match| match.full_name == "BriDummySpecClass::bri_dummy_spec_second_singleton_method" }.should be_true
-          search_instance.matches.any? { |match| match.full_name == "BriDummySpecClassTwo::bri_dummy_spec_second_singleton_method" }.should be_true
+          search_instance.matches.any? { |match| match.full_name == "BriDummySpecClass::bri_dummy_spec_singleton_method" }.should be(true)
+          search_instance.matches.any? { |match| match.full_name == "BriDummySpecClass::bri_dummy_spec_second_singleton_method" }.should be(true)
+          search_instance.matches.any? { |match| match.full_name == "BriDummySpecClassTwo::bri_dummy_spec_second_singleton_method" }.should be(true)
         end
       end
     end

data/spec/lib/bri/search/class_spec.rb

@@ -13,16 +13,16 @@ describe Bri::Search::Class do
   describe "#search" do
     context "basic functionality" do
       before( :each ) do
-        store_one = mock( RDoc::RI::Store, :load_cache    => true,
-                                           :load_class    => true,
-                                           :friendly_path => "ruby core",
-                                           :modules       => %w{ ClassThree } )
-        store_two = mock( RDoc::RI::Store, :load_cache    => true,
-                                           :load_class    => true,
-                                           :friendly_path => "ruby core",
-                                           :modules       => %w{ ClassOne ClassTwo } )
-        Bri::Mall.instance.stub!( :stores => [ store_one, store_two ] )
-        Bri::Match::Class.stub!( :new ).and_return( mock( Bri::Match::Class ) )
+        store_one = double( RDoc::Store, :load_cache    => true,
+                                         :load_class    => true,
+                                         :friendly_path => "ruby core",
+                                         :module_names  => %w{ ClassThree } )
+        store_two = double( RDoc::Store, :load_cache    => true,
+                                         :load_class    => true,
+                                         :friendly_path => "ruby core",
+                                         :module_names  => %w{ ClassOne ClassTwo } )
+        allow(Bri::Mall.instance).to receive( :stores ).and_return( [ store_one, store_two ] )
+        allow(Bri::Match::Class).to receive( :new ).and_return( double( Bri::Match::Class ) )
       end
 
       context "if there are no matching modules in any store" do
@@ -49,7 +49,7 @@ describe Bri::Search::Class do
         it "should have matches" do
           subject.search
           subject.matches.should_not be_empty
-          subject.matches.any?{ |match| match.name == "BriDummySpecClass" }.should be_true
+          subject.matches.any?{ |match| match.name == "BriDummySpecClass < Object" }.should be(true)
         end
       end
       
@@ -58,10 +58,9 @@ describe Bri::Search::Class do
 
         it "should not have any matches" do
           subject.search
-          subject.matches.any? { |match| match.name == "IAmQuiteCertainIDontExist" }.should be_false
+          subject.matches.any? { |match| match.name == "IAmQuiteCertainIDontExist" }.should be(false)
         end
       end
     end
-
   end
 end

data/spec/lib/bri/search/instance_method_spec.rb

@@ -3,26 +3,26 @@ require 'spec_helper'
 describe Bri::Search::InstanceMethod do
   context "the searches" do
     let( :paragraph ) { RDoc::Markup::Paragraph.new( "Foo Description" ) }
-    let( :document ) { mock( RDoc::Markup::Document, :parts => [ paragraph ] ) }
-    let( :rdoc_method ) { mock( RDoc::AnyMethod, :full_name => "Foo",
+    let( :document ) { double( RDoc::Markup::Document, :parts => [ paragraph ] ) }
+    let( :rdoc_method ) { double( RDoc::AnyMethod, :full_name => "Foo",
                                                  :arglists => "",
                                                  :comment => document ) }
     before( :each ) do
-      store_one = mock( RDoc::RI::Store, :load_cache       => true,
+      store_one = double( RDoc::RI::Store, :load_cache       => true,
                                          :load_class       => true,
                                          :load_method      => rdoc_method,
                                          :friendly_path    => "ruby core",
                                          :modules          => %w{ ClassThree },
                                          :instance_methods => { "ClassThree" => [ "method" ] } )
-      store_two = mock( RDoc::RI::Store, :load_cache       => true,
+      store_two = double( RDoc::RI::Store, :load_cache       => true,
                                          :load_class       => true,
                                          :load_method      => rdoc_method,
                                          :friendly_path    => "ruby core",
                                          :modules          => %w{ ClassOne ClassTwo },
                                          :instance_methods => { "ClassOne" => [ "method" ],
                                                              "ClassTwo" => [ "method", "my_other_method" ] } )
-      Bri::Mall.instance.stub!( :stores => [ store_one, store_two ] )
-      Bri::Match::Class.stub!( :new ).and_return( mock( Bri::Match::Class ) )
+      allow(Bri::Mall.instance).to receive(:stores).and_return( [ store_one, store_two ] )
+      allow(Bri::Match::Class).to receive( :new ).and_return( double( Bri::Match::Class ) )
     end
 
     describe "a fully qualified search" do 
@@ -124,7 +124,7 @@ describe Bri::Search::InstanceMethod do
           search_instance = Bri::Search::InstanceMethod.new( "#bri_dummy_spec_instance_method" )
           search_instance.search( :partially_qualified )
           search_instance.matches.should_not be_empty
-          search_instance.matches.any? { |match| match.full_name == "BriDummySpecClass#bri_dummy_spec_instance_method" }.should be_true
+          search_instance.matches.any? { |match| match.full_name == "BriDummySpecClass#bri_dummy_spec_instance_method" }.should be(true)
         end
       end
 
@@ -133,8 +133,8 @@ describe Bri::Search::InstanceMethod do
           search_instance = Bri::Search::InstanceMethod.new( "#bri_dummy_spec_instance_method_with_arguments" )
           search_instance.search( :partially_qualified )
           search_instance.matches.should_not be_empty
-          search_instance.matches.any? { |match| match.full_name == "BriDummySpecClass#bri_dummy_spec_instance_method_with_arguments" }.should be_true
-          search_instance.matches.any? { |match| match.full_name == "BriDummySpecClassTwo#bri_dummy_spec_instance_method_with_arguments" }.should be_true
+          search_instance.matches.any? { |match| match.full_name == "BriDummySpecClass#bri_dummy_spec_instance_method_with_arguments" }.should be(true)
+          search_instance.matches.any? { |match| match.full_name == "BriDummySpecClassTwo#bri_dummy_spec_instance_method_with_arguments" }.should be(true)
         end
       end
     end
@@ -153,7 +153,7 @@ describe Bri::Search::InstanceMethod do
           search_instance = Bri::Search::InstanceMethod.new( "bri_dummy_spec_instance_method" )
           search_instance.search( :unqualified )
           search_instance.matches.should_not be_empty
-          search_instance.matches.any? { |match| match.full_name == "BriDummySpecClass#bri_dummy_spec_instance_method" }.should be_true
+          search_instance.matches.any? { |match| match.full_name == "BriDummySpecClass#bri_dummy_spec_instance_method" }.should be(true)
         end
       end
 
@@ -162,10 +162,10 @@ describe Bri::Search::InstanceMethod do
           search_instance = Bri::Search::InstanceMethod.new( "bri_dummy_spec" )
           search_instance.search( :unqualified )
           search_instance.matches.should_not be_empty
-          search_instance.matches.any? { |match| match.full_name == "BriDummySpecClass#bri_dummy_spec_instance_method" }.should be_true
-          search_instance.matches.any? { |match| match.full_name == "BriDummySpecClass#bri_dummy_spec_instance_method_with_arguments" }.should be_true
-          search_instance.matches.any? { |match| match.full_name == "BriDummySpecClassTwo#bri_dummy_spec_instance_method_with_arguments" }.should be_true
-          search_instance.matches.any? { |match| match.full_name == "BriDummySpecClass#bri_dummy_spec_instance_method_with_default_arguments" }.should be_true
+          search_instance.matches.any? { |match| match.full_name == "BriDummySpecClass#bri_dummy_spec_instance_method" }.should be(true)
+          search_instance.matches.any? { |match| match.full_name == "BriDummySpecClass#bri_dummy_spec_instance_method_with_arguments" }.should be(true)
+          search_instance.matches.any? { |match| match.full_name == "BriDummySpecClassTwo#bri_dummy_spec_instance_method_with_arguments" }.should be(true)
+          search_instance.matches.any? { |match| match.full_name == "BriDummySpecClass#bri_dummy_spec_instance_method_with_default_arguments" }.should be(true)
         end
       end
     end

data/spec/spec_helper.rb

@@ -1,7 +1,22 @@
-spec_root = File.dirname( __FILE__ )
-require File.join( spec_root, '..', 'lib', 'bri.rb' )
+require 'rspec/its'
+require 'byebug'
+require_relative '../lib/bri'
+
+RSpec.configure do |config|
+  config.mock_with :rspec do |mocks|
+    mocks.syntax = [ :should, :expect ]
+  end
+
+  config.expect_with :rspec do |expect|
+    expect.syntax = [ :should, :expect ]
+  end
+
+  config.order = :random
+  Kernel.srand config.seed
+end
+
+RSpec::Expectations.configuration.on_potential_false_positives = :nothing
 
 puts "Regenerating ri document cache"
-output_path = File.join( spec_root, 'ri' )
-class_file = File.join( spec_root, 'bri_dummy_spec_class.rb' )
+class_file = File.join( __dir__, 'bri_dummy_spec_class.rb' )
 %x{rdoc --ri #{class_file}}

metadata

@@ -1,100 +1,145 @@
 --- !ruby/object:Gem::Specification
 name: bri
 version: !ruby/object:Gem::Version
-  version: 0.2.1
-  prerelease: 
+  version: 0.4.1
 platform: ruby
 authors:
 - Sven Riedel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-05-20 00:00:00.000000000Z
+date: 2011-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: term-ansicolor
-  requirement: &10035380 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.5
+        version: 1.7.1
   type: :runtime
   prerelease: false
-  version_requirements: *10035380
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.1
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &10211940 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.5.2
+        version: 6.1.1
   type: :runtime
   prerelease: false
-  version_requirements: *10211940
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: An alternative to the ri command
 email: sr@gimp.org
 executables:
 - bri
 extensions: []
 extra_rdoc_files:
-- README
+- README.rdoc
 files:
-- README
-- TODO
 - Changelog
+- README.rdoc
+- TODO
 - bin/bri
 - lib/bri.rb
 - lib/bri/mall.rb
-- lib/bri/matcher.rb
 - lib/bri/match.rb
 - lib/bri/match/base.rb
 - lib/bri/match/class.rb
 - lib/bri/match/method.rb
+- lib/bri/matcher.rb
+- lib/bri/renderer.rb
 - lib/bri/search.rb
 - lib/bri/search/base.rb
 - lib/bri/search/class.rb
-- lib/bri/search/method.rb
 - lib/bri/search/class_method.rb
 - lib/bri/search/instance_method.rb
+- lib/bri/search/method.rb
 - lib/bri/templates.rb
-- lib/bri/renderer.rb
-- spec/spec_helper.rb
 - spec/bri_dummy_spec_class.rb
 - spec/lib/bri/mall_spec.rb
-- spec/lib/bri/matcher_spec.rb
-- spec/lib/bri/renderer_spec.rb
 - spec/lib/bri/match/class_spec.rb
 - spec/lib/bri/match/method_spec.rb
-- spec/lib/bri/search/class_spec.rb
+- spec/lib/bri/matcher_spec.rb
+- spec/lib/bri/renderer_spec.rb
 - spec/lib/bri/search/class_method_spec.rb
+- spec/lib/bri/search/class_spec.rb
 - spec/lib/bri/search/instance_method_spec.rb
 - spec/lib/bri/search/method_spec.rb
+- spec/spec_helper.rb
 homepage: http://github.com/sriedel/bri
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options:
-- --charset=UTF-8
+- "--charset=UTF-8"
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.2
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 1.8.2
+rubygems_version: 3.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Beautified RI in the spirit of fastri/qri. Unlike fastri, bri builds on top
   of the rdoc 2.x/3.x backend, only output and formatting is handled by bri
 test_files: []