bri 0.4.2 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a207a768943836bb63dea1964e177e4eef7dbfa7e07c26b76fa3cf254c1db86
-  data.tar.gz: 6bb5e69bdb8bd7050e179cf51d49084facd31b8a900b06ddcacc030503718fee
+  metadata.gz: b20f64d2f12c1afba4d051de9aa6a091167743eefdc88410dddec663795e271f
+  data.tar.gz: 6c34a20f61319303f3877cdda56d757fc29a83ee8b89c8b2a9c4529b8f02d372
 SHA512:
-  metadata.gz: 4388dd1a1a040b7f51d49ddc67131d3f0865e39a3120e9816373490bddb408aa26b40b32a946b3246dacdb98113503165a9cdee368d248d07602dccd6bb685cc
-  data.tar.gz: 68b5edcf218e9c63545e253ce697851d0653f9c50104656962552566e8674ffe9848eff6c42e4dfbfe55b6b2ab6d9aa53323a48d43d8ba29a948fefce2cb7abf
+  metadata.gz: 6732a87a376c437b97f84f06617baea7b7e2f23ac208d1124adad119ff52beb65081208ec3d11a863a72718e43a5aeacb15a73fc76aad63ef0c2ab84e44e9c40
+  data.tar.gz: bc7d3406f8cca348c58f1435e88174d46f159243ff09661b9ddc0114bdc967d6954e1be263602692af4af98f24e3bf2285a8f69fb9d04311fc54f9ec7753b13b

data/Changelog

@@ -1,3 +1,9 @@
+0.4.3
+  - If multiple documentations are found that are all class documentations,
+    display all of these. This is useful in cases that gems extend core 
+    classes e.g. ActiveSupport.
+  - Reduce the amount of vertical whitespace caused by rendering empty rdoc nodes
+
 0.4.2
   - Fix broken --list-names option
   - Fix broken multiple choice display

data/README.rdoc

@@ -39,6 +39,13 @@ Bri is a Beautiful RI formatter.
             # the given search term, and finally looking for the term
             # anywhere in the method name
 
+= Note on ri docs generated by rvm
+
+If you're using `rvm docs generate` and can't see the listing of 
+methods in class documentations, this is due to rvm marking all methods
+as private during generation. A workaround for now is to generate the ri
+documentation with `rdoc --ri`.
+
 = 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

data/bin/bri

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby
 require 'bri'
 require 'optparse'
+require 'byebug'
 
 @options = {
   :list_classes => false,

data/lib/bri.rb

@@ -18,6 +18,8 @@ module Bri
       "No matching results found"
     elsif results.size == 1
       results.first.to_s
+    elsif results.all? { |r| r.is_a?(Bri::Match::Class) }
+      results.map(&:to_s)
     else
       qualified_methods = results.map(&:full_name).sort
       ERB.new( Bri::Templates::MULTIPLE_CHOICES, nil, '<>' ).result( binding )

data/lib/bri/match/base.rb

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

data/lib/bri/renderer.rb

@@ -54,9 +54,14 @@ module Bri
 
         else
           text = extract_text( element, width, alignment_width )
-          styled_text = replace_markup( text )
-          wrapped_text = wrap_to_width( styled_text, width )
-          indent( wrapped_text )
+
+          if text == "\n"
+            nil
+          else
+            styled_text = replace_markup( text )
+            wrapped_text = wrap_to_width( styled_text, width )
+            indent( wrapped_text )
+          end
       end
     end
 

data/lib/bri/search/class.rb

@@ -3,9 +3,9 @@ module Bri
     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.module_names.include?( @term ) }
-        @matches << Bri::Match::Class.new( store.load_class( @term ), store ) if store
+        Bri::Mall.instance.stores.select { |s| s.module_names.include?( @term ) }.each do |store|
+          @matches << Bri::Match::Class.new( store.load_class( @term ), store )
+        end
       end
     end
   end

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

@@ -47,7 +47,7 @@ describe Bri::Match::Class do
 
   describe "#description_paragraphs" do
     it "should be empty for an undocumented class" do
-      empty_class.description_paragraphs.should == [ '' ]
+      empty_class.description_paragraphs.should == []
     end
 
     it "should contain rendered text for a documented class" do

metadata

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