bri 0.1.5 → 0.2.0

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

@@ -1,32 +1,65 @@
 require 'spec_helper'
 
 describe Bri::Search::Class 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 } )
-    Bri::Mall.instance.stub!( :stores => [ store_one, store_two ] )
-    Bri::Match::Class.stub!( :new ).and_return( mock( Bri::Match::Class ) )
+  describe "#initialize" do
+    context "for an empty search" do
+      subject { Bri::Search::Class.new( "term" ) }
+      its( :term ) { should == "term" }
+      its( :matches ) { should be_empty }
+    end
   end
 
+
   describe "#search" do
-    context "if there are no matching modules in any store" do
-      subject { Bri::Search::Class.new( "I::Dont::Exist" ) }
-      it "should have no matches" do
-        subject.search
-        subject.matches.should == []
+    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 } )
+        Bri::Mall.instance.stub!( :stores => [ store_one, store_two ] )
+        Bri::Match::Class.stub!( :new ).and_return( mock( Bri::Match::Class ) )
+      end
+
+      context "if there are no matching modules in any store" do
+        subject { Bri::Search::Class.new( "I::Dont::Exist" ) }
+        it "should have no matches" do
+          subject.search
+          subject.matches.should == []
+        end
+      end
+
+      context "if there is a matching module in the stores" do
+        subject { Bri::Search::Class.new( "ClassOne" ) }
+        it "should have a match for each name" do
+          subject.search
+          subject.matches.size.should == 1
+        end
       end
     end
 
-    context "if there is a matching module in the stores" do
-      subject { Bri::Search::Class.new( "ClassOne" ) }
-      it "should have a match for each name" do
-        subject.search
-        subject.matches.size.should == 1
+    context "for the type :fully_qualified" do
+      context "when searching for the class BriDummySpecClass" do
+        subject { Bri::Search::Class.new( "BriDummySpecClass" ) }
+
+        it "should have matches" do
+          subject.search
+          subject.matches.should_not be_empty
+          subject.matches.any?{ |match| match.name == "BriDummySpecClass" }.should be_true
+        end
+      end
+      
+      context "when searching for the class IAmQuiteCertainIDontExist" do
+        subject { Bri::Search::Class.new( "IAmQuiteCertainIDontExist" ) }
+
+        it "should not have any matches" do
+          subject.search
+          subject.matches.any? { |match| match.name == "IAmQuiteCertainIDontExist" }.should be_false
+        end
       end
     end
+
   end
 end

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

@@ -87,4 +87,85 @@ describe Bri::Search::InstanceMethod do
       end
     end
   end
+
+  context "real searches going through rdoc" do
+    context "a fully qualified search" do
+      context "with no matching methods" do
+        it "should have no matches" do
+          search_instance = Bri::Search::InstanceMethod.new( "BriDummySpecClass#i_dont_exist" )
+          search_instance.search( :fully_qualified )
+          search_instance.matches.should be_empty
+        end
+      end
+
+      context "with a matching method" do
+        it "should have a match" do
+          search_instance = Bri::Search::InstanceMethod.new( "BriDummySpecClass#bri_dummy_spec_instance_method" )
+          search_instance.search( :fully_qualified )
+          search_instance.matches.should_not be_empty
+          search_instance.matches.first.full_name.should == "BriDummySpecClass#bri_dummy_spec_instance_method"
+        end
+      end
+    end
+
+    context "a partially qualified search" do
+      context "with no matching methods" do
+        it "should have no matches" do
+          search_instance = Bri::Search::InstanceMethod.new( "#i_dont_exist" )
+          search_instance.search( :partially_qualified )
+          search_instance.matches.should be_empty
+        end
+      end
+
+      context "with one matching method" do
+        it "should have one match" 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
+        end
+      end
+
+      context "with multiple matching methods" do
+        it "should have all matches" 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
+        end
+      end
+    end
+
+    context "an unqualified search" do
+      context "with no matching methods" do
+        it "should have no matches" do
+          search_instance = Bri::Search::InstanceMethod.new( "i_dont_exist_go_away" )
+          search_instance.search( :unqualified )
+          search_instance.matches.should be_empty
+        end
+      end
+
+      context "with one matching method" do
+        it "should have one match" 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
+        end
+      end
+
+      context "with multiple matching methods" do
+        it "should have all matches" 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
+        end
+      end
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -1 +1,7 @@
-require File.join( File.dirname( __FILE__ ), '..', 'lib', 'bri.rb' )
+spec_root = File.dirname( __FILE__ )
+require File.join( spec_root, '..', 'lib', 'bri.rb' )
+
+puts "Regenerating ri document cache"
+output_path = File.join( spec_root, 'ri' )
+class_file = File.join( spec_root, 'bri_dummy_spec_class.rb' )
+%x{rdoc --ri #{class_file}}

metadata

@@ -2,7 +2,7 @@
 name: bri
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.5
+  version: 0.2.0
 platform: ruby
 authors: 
 - Sven Riedel
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-04 00:00:00 +01:00
+date: 2011-02-20 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -64,12 +64,14 @@ files:
 - 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/match/class_match_spec.rb
-- spec/lib/bri/match/method_match_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/search/class_method_search_spec.rb
+- 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
@@ -99,6 +101,6 @@ rubyforge_project:
 rubygems_version: 1.5.0
 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 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: []
 

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

@@ -1,90 +0,0 @@
-require 'spec_helper'
-
-describe Bri::Match::Class do
-  let( :fake_paragraph ) do
-    mock( RDoc::Markup::Paragraph, :parts => [ "This is row one", 
-                                               "And this is row 2" ] )
-  end
-
-  let( :fake_description ) do 
-    mock( RDoc::Markup::Document, :parts => [ fake_paragraph ] ) 
-  end
-
-  let( :fake_include ) do
-    mock( RDoc::Include, :full_name => "Included::Module" )
-  end
-
-  let( :fake_constant ) do
-    mock( RDoc::Constant, :name => "MockConstant", :value => "This is my value" )
-  end
-
-  let( :fake_attribute ) do
-    mock( RDoc::Constant, :name => "attribute", :rw => 'R' )
-  end
-
-  let( :fake_public_instance_method ) do
-    mock( RDoc::AnyMethod, :name => "public_instance",  
-                           :singleton => false,
-                           :visibility => :public )
-  end
-
-  let( :fake_protected_instance_method ) do
-    mock( RDoc::AnyMethod, :name => "protected_instance",  
-                           :singleton => false,
-                           :visibility => :protected )
-  end
-
-  let( :fake_private_instance_method ) do
-    mock( RDoc::AnyMethod, :name => "private_instance",  
-                           :singleton => false,
-                           :visibility => :private )
-  end
-
-  let( :fake_public_class_method ) do
-    mock( RDoc::AnyMethod, :name => "public_class",  
-                           :singleton => true,
-                           :visibility => :public )
-  end
-
-  let( :fake_protected_class_method ) do
-    mock( RDoc::AnyMethod, :name => "protected_class",  
-                           :singleton => true,
-                           :visibility => :protected )
-  end
-
-  let( :fake_private_class_method ) do
-    mock( RDoc::AnyMethod, :name => "private_class",  
-                           :singleton => true,
-                           :visibility => :private )
-  end
-
-  let( :rdoc_class ) { mock( RDoc::NormalClass, :type => "module",
-                                                :name => "MyModule",
-                                                :comment => fake_description,
-                                                :includes => [ fake_include ],
-                                                :constants => [ fake_constant ],
-                                                :attributes => [ fake_attribute ],
-                                                :method_list => [ fake_public_instance_method,
-                                                                  fake_protected_instance_method,
-                                                                  fake_private_instance_method,
-                                                                  fake_public_class_method,
-                                                                  fake_protected_class_method,
-                                                                  fake_private_class_method ]
-                                                )
-                                                }
-
-  describe "#initialize" do
-    context "a class with everything" do
-      subject { Bri::Match::Class.new( rdoc_class ) }
-
-      its( :type ) { should == rdoc_class.type }
-      its( :name ) { should == rdoc_class.name }
-      its( :description_paragraphs ) { should == fake_description.parts.collect { |p| p.parts.join( " " ) } }
-      its( :includes ) { should == rdoc_class.includes.collect{ |i| i.full_name } }
-      its( :constants ) { should == rdoc_class.constants.collect { |c| { :name => c.name, :value => c.value } } }
-      its( :attributes ) { should == rdoc_class.attributes.collect { |a| "#{a.name} (#{a.rw})" } }
-      its( :instance_methods ) { should == rdoc_class.method_list.select { |m| m.visibility == :public && m.singleton == false }.collect { |m| m.name } }
-      its( :class_methods ) { should == rdoc_class.method_list.select { |m| m.visibility == :public && m.singleton == true }.collect { |m| m.name } }
-    end
-  end
-end

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

@@ -1,25 +0,0 @@
-require 'spec_helper'
-
-describe Bri::Match::Method do
-  let( :fake_paragraph ) do
-    RDoc::Markup::Paragraph.new "This is line one", "This is line two" 
-  end
-
-  let( :fake_description ) do
-    mock( RDoc::Markup::Document, :parts => [ fake_paragraph ] )
-  end
-
-  let( :rdoc_method ) do
-    mock( RDoc::AnyMethod, :full_name => "This::IS::My.full_name",
-                           :arglists => "First\nSecond\nThird",
-                           :comment => fake_description )
-  end
-
-  describe "#initialize" do
-    subject { Bri::Match::Method.new( rdoc_method ) }
-
-    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 This is line two" ] }
-  end
-end