bri 0.4.3 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b20f64d2f12c1afba4d051de9aa6a091167743eefdc88410dddec663795e271f
-  data.tar.gz: 6c34a20f61319303f3877cdda56d757fc29a83ee8b89c8b2a9c4529b8f02d372
+  metadata.gz: a88edaf5dc38f84306db04f904d1fb32859536587b7fa5ce84f3be687c5d1638
+  data.tar.gz: 1d8ace29c2676219311960e6729bc8b0e453ae00fd5a88294f809be65955024f
 SHA512:
-  metadata.gz: 6732a87a376c437b97f84f06617baea7b7e2f23ac208d1124adad119ff52beb65081208ec3d11a863a72718e43a5aeacb15a73fc76aad63ef0c2ab84e44e9c40
-  data.tar.gz: bc7d3406f8cca348c58f1435e88174d46f159243ff09661b9ddc0114bdc967d6954e1be263602692af4af98f24e3bf2285a8f69fb9d04311fc54f9ec7753b13b
+  metadata.gz: 3e7eb14da6bd17fdff9e5db187fe086f9592dcb682c18e082248ab61ef37685fd81e16cbe49198fbf9446cf3eccb1ac5f163ba7da906ef1b67a38329cfdb3eb2
+  data.tar.gz: 91fef7322fd718245385929888a5dcf48616c07c247621d4e22f8369b625e77185969af70fff295bc1538c0bcb5b2651a716143d15b54ee8f830f71439bbe317

data/Changelog

@@ -1,3 +1,15 @@
+0.5.0
+  - Update rdoc requirement to 6.13
+0.4.4
+  - No longer display all found class/module documentation found. If core
+  documentation is available, output only that, otherwise falls back to gem
+  documentation. To show all found documentation use the --all command line
+  paramter.
+  - Remove blank lines between list items. While these make lists with
+  multi row items more readable, they waste a lot of space for lists 
+  containing only single row items. The blank line will be reintroduced for
+  lists containing multi row elements later on.
+
 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 

data/README.rdoc

@@ -24,7 +24,14 @@ Bri is a Beautiful RI formatter.
 
 = Usage
 
- bri Array # looks up the class description of Array in the ri documentation
+ bri Array # looks up the class description of Array in the ri documentation.
+           # As of 0.4.4 this form will only output core documentation if
+           # available, falling back to gem documentation if no core
+           # documentation is found. This way you can look at the documentation
+           # of core classes that gems love to money patch without having
+           # to scroll back through your terminal.
+           # If you really want to see everything there is, use --all:
+ bri --all Array
 
  bri Array.class_method # looks up the class method of the given class
 

data/bin/bri

@@ -1,12 +1,12 @@
 #!/usr/bin/env ruby
 require 'bri'
 require 'optparse'
-require 'byebug'
 
 @options = {
   :list_classes => false,
   :list_methods => false,
-  :list_names   => false
+  :list_names   => false,
+  :show_all     => false
 }
 
 def parse_options 
@@ -24,6 +24,8 @@ def parse_options
     opts.on( nil, "--methods", "List known methods" ) { |v| @options[:list_methods] = true }
     opts.on( "-l", "--list-names", "List known namespaces/methods" ) { |v| @options[:list_names] = true }
     opts.on( "-w", "--width [COLUMNS]", "Set the output width", Integer ) { |v| Bri.width = v.to_i - 8 }
+    opts.on( "-a", "--all", "Output all documentation for the term. Prefers core documents otherwise") { |v| @options[:show_all] = true }
+    opts.on( "-v", "--version", "0.5.0.beta1")
     opts.on_tail( "-h", "--help", "This help text" ) { puts opts; exit }
   end
   parser.parse!( ARGV )
@@ -44,5 +46,5 @@ elsif @options[:list_methods]
 elsif @options[:list_names]
   puts Bri.list_names
 else
-  puts Bri.ri( ARGV[0] )
+  puts Bri.ri( ARGV[0], show_all: @options[:show_all] )
 end

data/lib/bri/mall.rb

@@ -31,8 +31,11 @@ module Bri
     private
     def initialize
       # We want: system, site, home and gem documentation
-      @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 }
+      options = RDoc::Options.new
+      @stores = RDoc::RI::Paths.each( true, true, true, true ).
+                                each_with_object( [] ) do |(path, type), stores|
+                  stores << RDoc::Store.new( options, path: path, type: type ).
+                                        tap { |store| store.load_cache }
                 end
     end
   end

data/lib/bri/match/base.rb

@@ -2,11 +2,16 @@ module Bri
   module Match
     class Base
       def to_s
-        ERB.new( self.class.const_get( :TEMPLATE ), nil, '<>' ).
+        ERB.new( self.class.const_get( :TEMPLATE ), trim_mode: '<>' ).
             result( binding )
       end
 
       private 
+      def build_description_from_comment( comment )
+        document = comment.instance_variable_get( :@document )
+        build_description( document.parts )
+      end
+
       def build_description( source )
         source.map { |element| Bri::Renderer.render( element ) }.compact
       end

data/lib/bri/match/class.rb

@@ -18,7 +18,8 @@ module Bri
         @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 )
+
+        @description_paragraphs = build_description_from_comment( rdoc_result.comment )
         @includes               = rdoc_result.includes.map(&:full_name)
         @extends                = rdoc_result.extends.map(&:full_name)
         @attributes             = rdoc_result.attributes.map { |a| "#{a.name} (#{a.rw})" }

data/lib/bri/match/method.rb

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

data/lib/bri/renderer.rb

@@ -50,7 +50,7 @@ module Bri
               rendered_items.map! { |item| item.gsub( /\n/, "\n#{INDENT}" ) }
           end
 
-          "#{rendered_items.join( "\n\n" )}\n"
+          "#{rendered_items.join( "\n" )}\n"
 
         else
           text = extract_text( element, width, alignment_width )
@@ -66,44 +66,43 @@ module Bri
     end
 
     def self.extract_text( element, width, label_alignment_width = 0, conserve_newlines = false )
-      text = case element
-               when RDoc::Markup::Paragraph
-                 join_char = conserve_newlines ? "\n" : " "
-                 element.parts.map(&:strip).join( join_char )
-
-               when RDoc::Markup::BlankLine
-                 ""
-
-               when RDoc::Markup::Rule
-                 "-" * width
-
-               when RDoc::Markup::Verbatim
-                 element.parts.map { |part| part.prepend( "  " ) }.join
-
-               when RDoc::Markup::Heading
-                 "<h>#{element.text}</h>" 
-
-               when RDoc::Markup::ListItem
-                 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_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"
+      case element
+        when RDoc::Markup::Paragraph
+          join_char = conserve_newlines ? "\n" : " "
+          element.parts.map(&:strip).join( join_char ) + "\n"
+
+        when RDoc::Markup::BlankLine
+          "\n"
+
+        when RDoc::Markup::Rule
+          "-" * width + "\n"
+
+        when RDoc::Markup::Verbatim
+          element.parts.map { |part| part.prepend( "  " ) }.join + "\n"
+
+        when RDoc::Markup::Heading
+          "<h>#{element.text}</h>\n" 
+
+        when RDoc::Markup::ListItem
+          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_WIDTH ) + "\n"
+
+         when RDoc::Markup::Document
+           element.parts.
+                   map { |part| extract_text( part, width, label_alignment_width, conserve_newlines ) }.
+                   join + "\n"
+        else  
+          raise "Don't know how to handle type #{element.class}: #{element.inspect}"
+      end
     end
 
     def self.replace_markup( text )

data/lib/bri.rb

@@ -11,7 +11,7 @@ require_relative 'bri/match'
 module Bri
   DEFAULT_WIDTH = 72
 
-  def self.ri( query )
+  def self.ri( query, show_all: false )
     results = Bri::Matcher.new( query ).find
 
     if results.size == 0
@@ -19,7 +19,14 @@ module Bri
     elsif results.size == 1
       results.first.to_s
     elsif results.all? { |r| r.is_a?(Bri::Match::Class) }
-      results.map(&:to_s)
+      if show_all
+        results.map(&:to_s)
+      else
+        gem_docs, core_docs = results.partition { |r| r.origin =~ %r{gem\b} }
+
+        docs_to_output = core_docs.empty? ? gem_docs : core_docs
+        docs_to_output.map(&:to_s)
+      end
     else
       qualified_methods = results.map(&:full_name).sort
       ERB.new( Bri::Templates::MULTIPLE_CHOICES, nil, '<>' ).result( binding )

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

@@ -9,10 +9,14 @@ describe Bri::Match::Method do
     double( RDoc::Markup::Document, :parts => [ fake_paragraph ] )
   end
 
+  let( :fake_comment ) do
+    double( RDoc::Comment, :instance_variable_get => fake_description )
+  end
+
   let( :rdoc_method ) do
     double( RDoc::AnyMethod, :full_name => "This::IS::My.full_name",
-                           :arglists => "First\nSecond\nThird",
-                           :comment => fake_description )
+                             :arglists  => "First\nSecond\nThird",
+                             :comment   => fake_comment )
   end
 
   describe "#initialize" do

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

@@ -4,9 +4,10 @@ describe Bri::Search::ClassMethod do
   context "the searches" do
     let( :paragraph ) { RDoc::Markup::Paragraph.new( "Foo Description" ) }
     let( :document ) { double( RDoc::Markup::Document, :parts => [ paragraph ] ) }
+    let( :comment ) { double( RDoc::Comment, :instance_variable_get => document ) }
     let( :rdoc_method ) { double( RDoc::AnyMethod, :full_name => "Foo",
-                                                 :arglists => "",
-                                                 :comment => document ) }
+                                                   :arglists => "",
+                                                   :comment => comment ) }
     before( :each ) do
       store_one = double( RDoc::RI::Store, :load_cache    => true,
                                          :load_class    => true,

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

@@ -4,9 +4,10 @@ describe Bri::Search::InstanceMethod do
   context "the searches" do
     let( :paragraph ) { RDoc::Markup::Paragraph.new( "Foo Description" ) }
     let( :document ) { double( RDoc::Markup::Document, :parts => [ paragraph ] ) }
+    let( :comment ) { double( RDoc::Comment, :instance_variable_get => document ) }
     let( :rdoc_method ) { double( RDoc::AnyMethod, :full_name => "Foo",
-                                                 :arglists => "",
-                                                 :comment => document ) }
+                                                   :arglists  => "",
+                                                   :comment   => comment ) }
     before( :each ) do
       store_one = double( RDoc::RI::Store, :load_cache       => true,
                                          :load_class       => true,

metadata

@@ -1,11 +1,10 @@
 --- !ruby/object:Gem::Specification
 name: bri
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.5.0
 platform: ruby
 authors:
 - Sven Riedel
-autorequire: 
 bindir: bin
 cert_chain: []
 date: 2011-05-20 00:00:00.000000000 Z
@@ -30,28 +29,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.1.1
+        version: 6.13.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.1.1
+        version: 6.13.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.8.0
+        version: 3.13.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.8.0
+        version: 3.13.0
 - !ruby/object:Gem::Dependency
   name: rspec-its
   requirement: !ruby/object:Gem::Requirement
@@ -121,7 +120,6 @@ files:
 homepage: http://github.com/sriedel/bri
 licenses: []
 metadata: {}
-post_install_message: 
 rdoc_options:
 - "--charset=UTF-8"
 require_paths:
@@ -137,8 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.6.5
 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