bri 0.2.0 → 0.2.1

data/Changelog

@@ -1,3 +1,9 @@
+0.2.1
+  - Show origin of class/method in description output
+  - Better textflow within paragraphs by ignoring the original newlines
+  - But keep original newlines within list items
+  - Add missing newline after verbatim sections
+
 0.2.0
   - Add extensive specs for matching, searching and rendering
   - Fix bug with rendering very narrow horizontal rules

data/lib/bri/match/class.rb

@@ -9,9 +9,9 @@ module Bri
 
       attr_reader :type, :name, :description_paragraphs
       attr_reader :includes, :constants, :class_methods, :instance_methods
-      attr_reader :attributes
+      attr_reader :attributes, :origin
 
-      def initialize( rdoc_result )
+      def initialize( rdoc_result, store = nil )
         @type = rdoc_result.type
         @name = rdoc_result.full_name
         @description_paragraphs = build_description( rdoc_result.comment.parts )
@@ -26,6 +26,7 @@ module Bri
                                                       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
       end
 
     end

data/lib/bri/match/method.rb

@@ -4,14 +4,15 @@ module Bri
       include Bri::Templates::Helpers
       TEMPLATE = Bri::Templates::METHOD_DESCRIPTION
 
-      attr_accessor :full_name, :call_syntaxes, :description_paragraphs
+      attr_accessor :full_name, :call_syntaxes, :description_paragraphs, :origin
 
-      def initialize( rdoc_method )
+      def initialize( rdoc_method, store = nil )
         @full_name = rdoc_method.full_name
         @call_syntaxes = rdoc_method.arglists.split( "\n" ).
                                               map { |e| "  " + e }.
                                               join( "\n" ) + "\n" rescue ''
         @description_paragraphs = build_description( rdoc_method.comment.parts )
+        @origin = store ? store.friendly_path : nil
       end
     end
   end

data/lib/bri/renderer.rb

@@ -11,7 +11,7 @@ module Bri
         when RDoc::Markup::Verbatim 
           text = extract_text( element, width )
           styled_text = replace_markup( text )
-          indent( styled_text )
+          indent( styled_text ) + "\n"
 
         when RDoc::Markup::List
           item_width = width - INDENT.length
@@ -54,10 +54,11 @@ module Bri
       end
     end
 
-    def self.extract_text( element, width, label_alignment_width = 0 )
+    def self.extract_text( element, width, label_alignment_width = 0, conserve_newlines = false )
       text = case element
                when RDoc::Markup::Paragraph 
-                 element.parts.join( "\n" )
+                 join_char = conserve_newlines ? "\n" : " "
+                 element.parts.join( join_char )
                when RDoc::Markup::BlankLine
                  ""
                when RDoc::Markup::Rule
@@ -67,7 +68,7 @@ module Bri
                when RDoc::Markup::Heading
                  "<h>#{element.text}</h>" 
                when RDoc::Markup::ListItem
-                 parts = element.parts.collect { |part| extract_text part, width }.join
+                 parts = element.parts.collect { |part| extract_text part, width, 0, true }.join
                  element.label ? sprintf( "%*s %s", -label_alignment_width, "#{element.label}:", parts ) : parts
                when RDoc::Markup::List
                  render( element, width - INDENT.length )

data/lib/bri/search/class.rb

@@ -6,7 +6,7 @@ module Bri
         # 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 }
-        @matches << Bri::Match::Class.new( store.load_class( @term ) ) if store
+        @matches << Bri::Match::Class.new( store.load_class( @term ), store ) if store
       end
 
     end

data/lib/bri/search/method.rb

@@ -27,7 +27,7 @@ module Bri
       def fully_qualified_search
         store = store_for_method
         
-        @matches << Bri::Match::Method.new( method_rdoc( store ) ) if store
+        @matches << Bri::Match::Method.new( method_rdoc( store ), store ) if store
       end
 
       def store_for_method
@@ -58,7 +58,7 @@ module Bri
             match_data = method_rdoc( store, klass, @method_term ) 
             next unless match_data
 
-            @matches << Bri::Match::Method.new( match_data )
+            @matches << Bri::Match::Method.new( match_data, store )
           end
         end
       end
@@ -79,7 +79,7 @@ module Bri
               match_data = method_rdoc( store, klass, method )
               next unless match_data
 
-              @matches << Bri::Match::Method.new( match_data )
+              @matches << Bri::Match::Method.new( match_data, store )
             end
           end
         end

data/lib/bri/templates.rb

@@ -10,6 +10,8 @@ module Bri
 
     CLASS_DESCRIPTION =<<-EOT
 <%= hrule( type + ": " + name ) %>
+<%= print_origin( origin ) %>
+
 <% if description_paragraphs.empty? %>
   (no description...)
 <% else %>
@@ -52,6 +54,8 @@ module Bri
 
     METHOD_DESCRIPTION =<<-EOT
 <%= hrule( full_name ) %>
+<%= print_origin( origin ) %>
+
 <%= call_syntaxes %>
 <%= hrule %>
 <% if description_paragraphs.empty? %>
@@ -73,6 +77,11 @@ module Bri
       end
       module_function :hrule
 
+      def print_origin( origin_text, width = Bri.width )
+        return unless origin_text
+        "(#{origin_text})".rjust( width )
+      end
+
       def section_header( text )
         Term::ANSIColor::green + Term::ANSIColor::underline + text + Term::ANSIColor::reset + "\n"
       end

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

@@ -20,7 +20,7 @@ describe Bri::Match::Method do
 
     its( :full_name ) { should == rdoc_method.full_name }
     its( :call_syntaxes ) { should == "  First\n  Second\n  Third\n" }
-    its( :description_paragraphs ) { should == [ "  This is line one\n  This is line two" ] }
+    its( :description_paragraphs ) { should == [ "  This is line one This is line two" ] }
   end
 
   describe "#full_name" do

data/spec/lib/bri/renderer_spec.rb

@@ -308,7 +308,7 @@ describe Bri::Renderer do
 
       context "with multi word labels" do
         it "should show the link underlined after the label in brackets and remove the rdoc label curly braces" do
-          subject.should =~ /Multi Word Labels \(#{underline}http:\/\/www.github.com#{reset}\)/
+          subject.should =~ /Multi\s+Word\s+Labels\s+\(#{underline}http:\/\/www.github.com#{reset}\)/m
         end
       end
     end

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

@@ -8,15 +8,17 @@ describe Bri::Search::ClassMethod do
                                                  :arglists => "",
                                                  :comment => document ) }
     before( :each ) do
-      store_one = mock( RDoc::RI::Store, :load_cache => true, 
-                                         :load_class => true,
-                                         :load_method => rdoc_method,
-                                         :modules    => %w{ ClassThree },
+      store_one = mock( 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, 
-                                         :load_class => true,
-                                         :load_method => rdoc_method,
-                                         :modules    => %w{ ClassOne ClassTwo },
+      store_two = mock( 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 ] )

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

@@ -13,12 +13,14 @@ 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,
-                                           :modules => %w{ ClassThree } )
-        store_two = mock( RDoc::RI::Store, :load_cache => true, 
-                                           :load_class => true,
-                                           :modules => %w{ ClassOne ClassTwo } )
+        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 ) )
       end

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

@@ -8,15 +8,17 @@ describe Bri::Search::InstanceMethod do
                                                  :arglists => "",
                                                  :comment => document ) }
     before( :each ) do
-      store_one = mock( RDoc::RI::Store, :load_cache => true, 
-                                         :load_class => true,
-                                         :load_method => rdoc_method,
-                                         :modules    => %w{ ClassThree },
+      store_one = mock( 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, 
-                                         :load_class => true,
-                                         :load_method => rdoc_method,
-                                         :modules    => %w{ ClassOne ClassTwo },
+      store_two = mock( 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 ] )

metadata

@@ -1,49 +1,46 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: bri
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.2.1
   prerelease: 
-  version: 0.2.0
 platform: ruby
-authors: 
+authors:
 - Sven Riedel
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-02-20 00:00:00 +01:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-05-20 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: term-ansicolor
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &10035380 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 1.0.5
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rdoc
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *10035380
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &10211940 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 3.5.2
   type: :runtime
-  version_requirements: *id002
+  prerelease: false
+  version_requirements: *10211940
 description: An alternative to the ri command
 email: sr@gimp.org
-executables: 
+executables:
 - bri
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README
-files: 
+files:
 - README
 - TODO
 - Changelog
@@ -74,33 +71,30 @@ files:
 - spec/lib/bri/search/class_method_spec.rb
 - spec/lib/bri/search/instance_method_spec.rb
 - spec/lib/bri/search/method_spec.rb
-has_rdoc: true
 homepage: http://github.com/sriedel/bri
 licenses: []
-
 post_install_message: 
-rdoc_options: 
+rdoc_options:
 - --charset=UTF-8
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.9.2
-required_rubygems_version: !ruby/object:Gem::Requirement 
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.5.0
+rubygems_version: 1.8.2
 signing_key: 
 specification_version: 3
-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
+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: []
-