bri 0.4.4 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 74b87ae62d01b5be9164734271754be0cc3a1ef68ad3b35bd78b633d829a529a
-  data.tar.gz: 27fdfe717c1cea3b49525ff5e9c59b462757d1d86db440bd4dc1fd9719f47c70
+  metadata.gz: a88edaf5dc38f84306db04f904d1fb32859536587b7fa5ce84f3be687c5d1638
+  data.tar.gz: 1d8ace29c2676219311960e6729bc8b0e453ae00fd5a88294f809be65955024f
 SHA512:
-  metadata.gz: e0d96c3ae752ec0b5b3fb59ad58da596869fd91665282eeb588ba8c03041b3f26040f331189b9db84a6d55aaf5e5540430dddbd07c925a7dde198ed6939bc7f0
-  data.tar.gz: 4f3cc64561cb91cc53caf689611c32f6daf8d0482eb2bee3407358fad32fd808e0b70ce613c979b57917c0c2afe4b135f48f46e19de8888a167591d205aadecc
+  metadata.gz: 3e7eb14da6bd17fdff9e5db187fe086f9592dcb682c18e082248ab61ef37685fd81e16cbe49198fbf9446cf3eccb1ac5f163ba7da906ef1b67a38329cfdb3eb2
+  data.tar.gz: 91fef7322fd718245385929888a5dcf48616c07c247621d4e22f8369b625e77185969af70fff295bc1538c0bcb5b2651a716143d15b54ee8f830f71439bbe317

data/Changelog

@@ -1,3 +1,5 @@
+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

data/bin/bri

@@ -25,6 +25,7 @@ def parse_options
     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 )

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/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.4
+  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.4
-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