bri 0.1.5 → 0.2.0

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

@@ -0,0 +1,112 @@
+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\n  This is line two" ] }
+  end
+
+  describe "#full_name" do
+    subject do 
+      search_instance = Bri::Search::InstanceMethod.new( "BriDummySpecClass#bri_dummy_spec_instance_method" )
+      search_instance.search( :fully_qualified )
+      search_instance.matches.first
+    end
+    
+    its( :full_name ) { should == "BriDummySpecClass#bri_dummy_spec_instance_method" }
+  end
+
+  describe "#call_syntaxes" do
+    context "for methods with no arguments" do
+      subject do 
+        search_instance = Bri::Search::InstanceMethod.new( "BriDummySpecClass#bri_dummy_spec_instance_method" )
+        search_instance.search( :fully_qualified )
+        search_instance.matches.first
+      end
+      
+      its( :call_syntaxes ) { should == "  bri_dummy_spec_instance_method()\n" }
+    end
+
+    context "for methods with arguments" do
+      subject do 
+        search_instance = Bri::Search::InstanceMethod.new( "BriDummySpecClass#bri_dummy_spec_instance_method_with_arguments" )
+        search_instance.search( :fully_qualified )
+        search_instance.matches.first
+      end
+      
+      its( :call_syntaxes ) { should == "  bri_dummy_spec_instance_method_with_arguments( a, b )\n" }
+    end
+
+    context "for methods with default arguments" do
+      subject do 
+        search_instance = Bri::Search::InstanceMethod.new( "BriDummySpecClass#bri_dummy_spec_instance_method_with_default_arguments" )
+        search_instance.search( :fully_qualified )
+        search_instance.matches.first
+      end
+      
+      its( :call_syntaxes ) { should == "  bri_dummy_spec_instance_method_with_default_arguments( a, b, c = nil )\n" }
+    end
+
+    context "for methods that yield" do
+      subject do 
+        search_instance = Bri::Search::InstanceMethod.new( "BriDummySpecClass#bri_dummy_spec_instance_method_which_yields" )
+        search_instance.search( :fully_qualified )
+        search_instance.matches.first
+      end
+      
+      its( :call_syntaxes ) { should == "  bri_dummy_spec_instance_method_which_yields() { |yield_param_one, yield_param_two| ... }\n" }
+    end
+
+    context "for methods with an rdoc yield override" do
+      subject do 
+        search_instance = Bri::Search::InstanceMethod.new( "BriDummySpecClass#bri_dummy_spec_instance_method_with_yield_override" )
+        search_instance.search( :fully_qualified )
+        search_instance.matches.first
+      end
+      
+      its( :call_syntaxes ) { should == "  bri_dummy_spec_instance_method_with_yield_override() { |foo, bar| ... }\n" }
+    end
+  end
+
+  describe "#description_paragraphs" do
+    context "for an undocumented method" do
+      subject do 
+        search_instance = Bri::Search::InstanceMethod.new( "BriDummySpecClass#bri_dummy_spec_instance_method" )
+        search_instance.search( :fully_qualified )
+        search_instance.matches.first
+      end
+
+      its( :description_paragraphs ) { should == [] }
+    end
+
+    context "for a documented method" do
+      subject do 
+        search_instance = Bri::Search::InstanceMethod.new( "BriDummySpecClass#basic_headline_and_paragraph_rendering_test_method" )
+        search_instance.search( :fully_qualified )
+        search_instance.matches.first
+      end
+
+      its( :description_paragraphs ) { should_not be_empty }
+      it "should contain rendered paragraphs as the array elements" do
+        subject.description_paragraphs.first.should =~ /This is a headline/
+      end
+    end
+  end
+end

data/spec/lib/bri/renderer_spec.rb

@@ -0,0 +1,338 @@
+require 'spec_helper'
+
+describe Bri::Renderer do
+  def render_description_for_method( method_name )
+    search_instance = Bri::Search::InstanceMethod.new( "BriDummySpecClass##{method_name}_rendering_test_method" ) 
+    search_instance.search( :fully_qualified )
+    search_instance.matches.first.to_s
+  end
+
+  let( :green ) { Regexp.escape( Term::ANSIColor::green ) }
+  let( :yellow )  { Regexp.escape( Term::ANSIColor::yellow ) }
+  let( :cyan )  { Regexp.escape( Term::ANSIColor::cyan ) }
+  let( :bold )  { Regexp.escape( Term::ANSIColor::bold ) }
+  let( :italic )  { Regexp.escape( Term::ANSIColor::italic ) }
+  let( :underline )  { Regexp.escape( Term::ANSIColor::underline ) }
+  let( :reset ) { Regexp.escape( Term::ANSIColor::reset ) }
+
+  describe "headers" do
+    context " for level one headlines" do
+      subject { render_description_for_method( "basic_headline_and_paragraph" ) }
+
+      it "should be marked in green" do
+        subject.should =~ /#{green}This is a headline#{reset}\n/
+      end
+    end
+
+    context "for level two headlines" do
+      subject { render_description_for_method( "level_two_headline_and_line_wrapping" ) }
+
+      it "should be marked in green" do
+        subject.should =~ /#{green}This is a level two headline#{reset}\n/
+      end
+    end
+  end
+
+  describe "paragraphs" do
+    subject { render_description_for_method( "basic_headline_and_paragraph" ) }
+
+    it "should be indented by two spaces" do
+      subject.should =~ /^  Followed by some introduction text.\s*\n/
+    end
+
+    context "containing long rows" do
+      subject { render_description_for_method( "level_two_headline_and_line_wrapping" ) }
+
+      it "should be wrapped" do
+        subject.should =~ /\n  This is a paragraph with a really really really really really really\s*\n  really really really really long line that needs to be wrapped\.\n/
+      end
+    end
+  end
+
+  describe "horizontal rules" do
+    subject { render_description_for_method( "horizontal_rule" ) }
+
+    it "should be rendered as an indented row of dashes" do
+      rule = "-" * Bri.width
+      subject.should =~ /\n  #{rule}\n/
+    end
+  end
+
+  describe "bulleted lists with *" do
+    subject { render_description_for_method( "bulleted_list" ) }
+    it "should indent the list with one space" do
+      subject.should =~ /\n .  First item in a bulleted list/
+    end
+
+    it "should prefix each list item with a '*' bullet" do
+      subject.should =~ /\*  First item in a bulleted list/
+      subject.should =~ /\*  Second item in a bulleted list/
+      subject.should =~ /\*  Ending a bulleted list/
+    end
+
+    it "should wrap long lines" do
+      subject.should =~ /\n \*  Ending a bulleted list with a really really really really really \n    really really really long line that needs to be wrapped\n/
+    end
+
+    it "should start second lines of a list item with the same left alignment as the first list items content" do
+      subject.should =~ /\n \*  First item in a bulleted list\n    With a second line\n/
+    end
+
+    context "contained verbatim text" do
+      subject { render_description_for_method( "list_containing_verbatim_text" ) }
+      
+      it "should correctly display verbatim text" do
+        subject.should =~ /\n  Containing verbatim text\n/
+      end
+    end
+
+    context "a nested bulleted list" do
+      it "should indent the second level with five spaces" do
+        subject.should =~ /\n     .  First item of a nested bulleted list/
+        subject.should =~ /\n     .  Second item of a nested bulleted list/
+      end
+    end
+
+    context "a nested numbered list" do
+      subject { render_description_for_method( "mixed_list" ) }
+      it "should indent the second level with four spaces" do
+        subject.should =~ /\n    \d\.  And numbers in a sublist\n/
+      end
+    end
+  end
+
+  describe "bulleted lists with -" do
+    subject { render_description_for_method "second_bulleted_list" }
+    it "should indent the list with one space" do
+      subject.should =~ /\n .  A second bulleted list/
+    end
+
+    it "should prefix each list item with a '*' bullet" do
+      subject.should =~ /\*  A second bulleted list/
+      subject.should =~ /\*  Second item in second bulleted list/
+      subject.should =~ /\*  Ending the second bulleted list/
+    end
+
+    it "should indent the second level with four spaces" do
+      subject.should =~ /\n     .  Nested bulleted list/
+      subject.should =~ /\n     .  Second nested bulleted list item/
+    end
+  end
+
+  describe "numbered lists" do
+    subject { render_description_for_method "numbered_list" }
+
+    it "should not indent the list items" do
+      subject.should =~ /\n\d\.  First numbered list item/
+    end
+
+    it "should prefix each list item with a consecutive number" do
+      subject.should =~ /1\.  First numbered list item/
+      subject.should =~ /2\.  Second numbered list/
+      subject.should =~ /3\.  Ending the main numbered list item/
+    end
+
+    context "nested numbered lists" do
+      it "should indent the second level with four spaces" do
+        subject.should =~ /\n    \d\.  Nested numbered list item/
+        subject.should =~ /\n    \d\.  Second nested numbered list item/
+      end
+
+      it "should restart the numbering for nested lists" do
+        subject.should =~ /1\.  Nested numbered list item/
+        subject.should =~ /2\.  Second nested numbered list item/
+      end
+    end
+
+    context "nested bulleted lists" do
+      subject { render_description_for_method "second_mixed_list" }
+      it "should indent the second level with five spaces" do
+        subject.should =~ /\n     .  Nested bulleted list/
+      end
+
+      it "should prefix each nested list item with a '*' bullet" do
+        subject.should =~ /\*  Nested bulleted list/
+      end
+    end
+  end
+
+  describe "lettered lists" do
+    subject { render_description_for_method "lettered_list" }
+
+    it "should not indent the list items" do
+      subject.should =~ /\n.\.  Some goes for lettered lists/
+    end
+
+    it "should prefix each list item with a consecutive letter" do
+      subject.should =~ /a\.  Some goes for lettered lists/
+      subject.should =~ /b\.  Second item in a lettered list/
+      subject.should =~ /c\.  Ending the main lettered list item/
+    end
+
+    context "nested lettered lists" do
+      it "should indent the second level with four spaces" do
+        subject.should =~ /\n    .\.  And a nested lettered list item/
+      end
+
+      it "should restart the lettering for nested lists" do
+        subject.should =~ /a\.  And a nested lettered list item/
+        subject.should =~ /b\.  Second nested lettered list item/
+      end
+    end
+  end
+
+  describe "labeled lists" do
+    subject { render_description_for_method "labeled_list" }
+
+    context "with plain labels" do
+      it "should indent the list with two spaces" do
+        subject.should =~ /\n  \w+: And this is the list item body/
+      end
+
+      it "should prefix each list item with its note" do
+        subject.should =~ /First: And this is the list item body/
+        subject.should =~ /Second: Another labled list item/
+      end
+    end
+
+    context "with aligned labels" do
+      subject { render_description_for_method "lined_up_labeled_list" }
+
+      it "should intent the list with two spaces" do
+        subject.should =~ /\n  \w+:\s+With some text\./
+      end
+
+      it "should prefix each list item with its note" do
+        subject.should =~ /First:\s+With some text\./
+        subject.should =~ /Secondarily:\s+Lets see if this lines up\./
+      end
+
+      it "should have the list item bodies left aligned to the same position" do
+        subject.should =~ /First:       With some text\./
+        subject.should =~ /Secondarily: Lets see if this lines up\./
+      end
+    end
+  end
+
+  describe "text stylings" do
+    context "for bold text" do
+      it "should mark *bold* text with an ANSI bold code" do
+        text = render_description_for_method( "simple_styling" )
+        text.should =~ /#{bold}bold#{reset},/
+      end
+
+      it "should mark <b>bold</b> text with an ANSI bold code" do
+        text = render_description_for_method( "html_styling" )
+        text.should =~ /#{bold}Bold#{reset},/
+      end
+
+      it "should not mark escaped \<b>bold\</b> text" do
+        text = render_description_for_method( "escaped_styling" )
+        text.should =~ /<b>Not bold<\/b>,/
+      end
+    end
+
+    context "for emphasized text" do
+      it "should mark _emphasized_ text with an ANSI yellow code" do
+        text = render_description_for_method( "simple_styling" )
+        text.should =~ /, #{yellow}emphasized#{reset} and/
+      end
+
+      it "should mark <em>emphasized</em> text with an ANSI yellow code" do
+        text = render_description_for_method( "html_styling" )
+        text.should =~ /, #{yellow}emphasized#{reset},/
+      end
+
+      it "should mark <i>emphasized</i> text with an ANSI yellow code" do
+        text = render_description_for_method( "html_styling" )
+        text.should =~ /, #{yellow}also emphasized#{reset}/
+      end
+
+      it "should not mark escaped \<em>emphasized\</em> text" do
+        text = render_description_for_method( "escaped_styling" )
+        text.should =~ /<em>not emphasized<\/em>/
+      end
+    end
+
+    context "for code" do
+      it "should mark +code+ with an ANSI cyan code" do
+        text = render_description_for_method( "simple_styling" ) 
+        text.should =~ /and #{cyan}monospaced#{reset}/
+      end
+
+      it "should mark <tt>code</tt> with an ANSI cyan code" do
+        text = render_description_for_method( "html_styling" )
+        text.should =~ /#{cyan}monospaced tt#{reset}/
+      end
+
+      it "should mark <code>code</code> with an ANSI cyan code" do
+        text = render_description_for_method( "html_styling" )
+        text.should =~ /#{cyan}monospaced code#{reset}/
+      end
+    end
+  end
+
+  describe "links" do
+    context "raw links" do
+      subject { render_description_for_method "raw_link" }
+
+      it "should underline raw http links" do
+        subject.should =~ /#{underline}http:\/\/www.google.com#{reset}/
+      end
+
+      it "should underline raw mailto links" do
+        subject.should =~ /#{underline}mailto:spamidyspam@spam.com#{reset}/
+      end
+
+      it "should underline raw ftp links" do
+        subject.should =~ /#{underline}ftp:\/\/warez.teuto.de#{reset}/
+      end
+
+      it "should underline plain www links" do
+        subject.should =~ /#{underline}www.test.com#{reset}/
+      end
+
+      it "should underline local file links" do
+        subject.should =~ /#{underline}\/etc\/fstab#{reset}/
+      end
+    end
+
+    context "labeled links" do
+      subject { render_description_for_method "labeled_link" }
+
+      context "with single word labels" do
+        it "should show the link underlined after the label in brackets" do
+          subject.should =~ /Labled links SingleWordLabel \(#{underline}http:\/\/duckduckgo.com#{reset}\)/
+        end
+      end
+
+      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}\)/
+        end
+      end
+    end
+  end
+
+  describe "conversion characters" do
+    subject { render_description_for_method "conversion_character" }
+
+    it "should leave -- as is" do
+      subject.should =~ /this: -- or/
+    end
+
+    it "should leave --- as is" do
+      subject.should =~ /or --- should/
+    end
+
+    it "should leave (c) as is" do
+      subject.should =~ /Copyright: \(c\)/
+    end
+
+    it "should leave (r) as is" do
+      subject.should =~ /registered trademark \(r\)/
+    end
+  end
+
+
+end

data/spec/lib/bri/search/{class_method_search_spec.rb → class_method_spec.rb}

@@ -87,4 +87,84 @@ describe Bri::Search::ClassMethod 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::ClassMethod.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::ClassMethod.new( "BriDummySpecClass.bri_dummy_spec_singleton_method" )
+          search_instance.search( :fully_qualified )
+          search_instance.matches.should_not be_empty
+          search_instance.matches.first.full_name.should == "BriDummySpecClass::bri_dummy_spec_singleton_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::ClassMethod.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::ClassMethod.new( ".bri_dummy_spec_singleton_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_singleton_method" }.should be_true
+        end
+      end
+
+      context "with multiple matching methods" do
+        it "should have all matches" do
+          search_instance = Bri::Search::ClassMethod.new( ".bri_dummy_spec_second_singleton_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_second_singleton_method" }.should be_true
+          search_instance.matches.any? { |match| match.full_name == "BriDummySpecClassTwo::bri_dummy_spec_second_singleton_method" }.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::ClassMethod.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::ClassMethod.new( "bri_dummy_spec_singleton_method" )
+          search_instance.search( :unqualified )
+          search_instance.matches.should_not be_empty
+          search_instance.matches.any? { |match| match.full_name == "BriDummySpecClass::bri_dummy_spec_singleton_method" }.should be_true
+        end
+      end
+
+      context "with multiple matching methods" do
+        it "should have all matches" do
+          search_instance = Bri::Search::ClassMethod.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_singleton_method" }.should be_true
+          search_instance.matches.any? { |match| match.full_name == "BriDummySpecClass::bri_dummy_spec_second_singleton_method" }.should be_true
+          search_instance.matches.any? { |match| match.full_name == "BriDummySpecClassTwo::bri_dummy_spec_second_singleton_method" }.should be_true
+        end
+      end
+    end
+  end
 end