bri 0.4.4 → 1.0.0.pre.beta1

data/lib/bri/text_formatting_utils.rb

@@ -0,0 +1,92 @@
+module Bri
+  module TextFormattingUtils
+    RULE_CHARACTER = '-'.freeze
+
+    def wrap_to_width( styled_text, width )
+      styled_text.split( "\n" ).map { |row| wrap_row( row, width ) }.join
+    end
+    module_function :wrap_to_width
+
+    def wrap_row( physical_row, width )
+      output_text = ''
+      logical_row = ''
+      printable_row_length = 0
+      tokens_in_row = 0
+
+      scanner = StringScanner.new( physical_row )
+
+      while( !scanner.eos? ) 
+        token = scanner.scan( /\S+/ ).to_s
+        printable_token_length = printable_length( token )
+
+        if printable_token_length + printable_row_length > width && tokens_in_row > 0
+          output_text << logical_row.rstrip << "\n"
+          logical_row.clear
+          printable_row_length = 0
+          tokens_in_row = 0
+        end
+
+        logical_row << token
+        printable_row_length += printable_token_length
+        tokens_in_row += 1
+
+        # TODO: Instead of using rstrip when appending the logical row,
+        #       identify here if the whitespace token will be the last 
+        #       on the row, and if so, don't add it in the first place.
+        #       (sr 2019-06-23)
+        token = scanner.scan( /\s+/ ).to_s
+        logical_row << token
+        printable_row_length += token.length
+      end
+
+      output_text << logical_row.rstrip << "\n"
+    end
+    module_function :wrap_row
+
+    def indent( text, indent_depth: 2, each_row: true )
+      indent = " " * indent_depth
+
+      if each_row
+        text.lines.map { |row| row.prepend( indent ) }.join
+      else
+        text.prepend( indent )
+      end
+    end
+    module_function :indent
+
+    def printable_length( text )
+      Term::ANSIColor.uncolored( text ).length
+    end
+    module_function :printable_length
+
+    def wrap_list( array, width = Bri.width )
+      return '' if array.empty?
+
+      indent( wrap_to_width( array.join( "  " ), width - 2 ) )
+    end
+    module_function :wrap_list
+
+    def hrule( text = '', width = Bri.width )
+      return "#{RULE_CHARACTER * width}\n" if text.empty?
+
+      rule_length = width - text.length - 1
+      rule_length = 1 if rule_length < 1
+
+      rule = RULE_CHARACTER * rule_length
+      "#{rule} #{Term::ANSIColor::bold( text )}\n"
+    end
+    module_function :hrule
+
+    def print_origin( origin_text, width = Bri.width )
+      return '' if !origin_text || origin_text.empty?
+
+      "(#{origin_text})".rjust( width )
+    end
+    module_function :print_origin
+
+    def section_header( text )
+      "#{Term::ANSIColor.green}#{Term::ANSIColor.underline}#{text}#{Term::ANSIColor.reset}\n"
+    end
+    module_function :section_header
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bri
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 1.0.0.pre.beta1
 platform: ruby
 authors:
 - Sven Riedel
@@ -100,6 +100,23 @@ files:
 - lib/bri/match/method.rb
 - lib/bri/matcher.rb
 - lib/bri/renderer.rb
+- lib/bri/renderer/blank_line.rb
+- lib/bri/renderer/default.rb
+- lib/bri/renderer/document.rb
+- lib/bri/renderer/heading.rb
+- lib/bri/renderer/list.rb
+- lib/bri/renderer/list/base.rb
+- lib/bri/renderer/list/bullet.rb
+- lib/bri/renderer/list/labeled.rb
+- lib/bri/renderer/list/lower_lettered.rb
+- lib/bri/renderer/list/note.rb
+- lib/bri/renderer/list/numbered.rb
+- lib/bri/renderer/list/upper_lettered.rb
+- lib/bri/renderer/list_item.rb
+- lib/bri/renderer/paragraph.rb
+- lib/bri/renderer/result.rb
+- lib/bri/renderer/rule.rb
+- lib/bri/renderer/verbatim.rb
 - lib/bri/search.rb
 - lib/bri/search/base.rb
 - lib/bri/search/class.rb
@@ -107,17 +124,7 @@ files:
 - lib/bri/search/instance_method.rb
 - lib/bri/search/method.rb
 - lib/bri/templates.rb
-- spec/bri_dummy_spec_class.rb
-- spec/lib/bri/mall_spec.rb
-- spec/lib/bri/match/class_spec.rb
-- spec/lib/bri/match/method_spec.rb
-- spec/lib/bri/matcher_spec.rb
-- spec/lib/bri/renderer_spec.rb
-- spec/lib/bri/search/class_method_spec.rb
-- spec/lib/bri/search/class_spec.rb
-- spec/lib/bri/search/instance_method_spec.rb
-- spec/lib/bri/search/method_spec.rb
-- spec/spec_helper.rb
+- lib/bri/text_formatting_utils.rb
 homepage: http://github.com/sriedel/bri
 licenses: []
 metadata: {}

data/spec/bri_dummy_spec_class.rb

@@ -1,132 +0,0 @@
-# This is a class description
-class BriDummySpecClassTwo
-  include BriDummySpecModule
-  extend BriDummySpecModuleTwo
-  CONSTANT = 'value'
-  OTHER_CONSTANT = nil
-  attr_reader :read_attr
-  attr_writer :write_attr
-  attr_accessor :access_attr
-
-  def self.bri_dummy_spec_second_singleton_method; end
-  def bri_dummy_spec_instance_method_with_arguments( a, b ); end
-end
-
-class BriDummySpecClassEmpty; end
-
-module BriDummySpecModule; end
-module BriDummySpecModuleTwo; end
-
-module BriDummySpec
-  class Class; end
-end
-
-class BriDummySpecClass
-  def self.bri_dummy_spec_singleton_method; end
-  def self.bri_dummy_spec_second_singleton_method; end
-
-  def bri_dummy_spec_instance_method; end
-
-  def bri_dummy_spec_instance_method_with_arguments( a, b ); end
-
-  def bri_dummy_spec_instance_method_with_default_arguments( a, b, c = nil ); end
-
-  def bri_dummy_spec_instance_method_which_yields
-    yield yield_param_one, yield_param_two
-  end
-
-  def bri_dummy_spec_instance_method_with_yield_override # :yields: foo, bar
-    yield yield_param_one, yield_param_two
-  end
-
-
-  # = This is a headline
-  #
-  # Followed by some introduction text.
-  def basic_headline_and_paragraph_rendering_test_method; end
-
-  # == This is a level two headline
-  # This is a paragraph with a really really really really really really really really really really long line that needs to be wrapped.
-  def level_two_headline_and_line_wrapping_rendering_test_method; end
-
-  # This is some text before a horizontal rule.
-  # ---
-  # After a horizontal rule, the text continues.
-  def horizontal_rule_rendering_test_method; end
-
-  # * First item in a bulleted list
-  #   With a second line
-  # * Second item in a bulleted list
-  #   * First item of a nested bulleted list
-  #   * Second item of a nested bulleted list
-  # * Ending a bulleted list with a really really really really really really really really long line that needs to be wrapped
-  def bulleted_list_rendering_test_method; end
-
-  # - A second bulleted list
-  # - Second item in second bulleted list
-  #   - Nested bulleted list
-  #   - Second nested bulleted list item
-  # - Ending the second bulleted list
-  def second_bulleted_list_rendering_test_method; end
-
-  # 1. First numbered list item
-  # 2. Second numbered list
-  #    1. Nested numbered list item
-  #    2. Second nested numbered list item
-  # 3. Ending the main numbered list item
-  def numbered_list_rendering_test_method; end
-
-  # a. Some goes for lettered lists
-  # b. Second item in a lettered list
-  #    a. And a nested lettered list item
-  #    c. Second nested lettered list item
-  # c. Ending the main lettered list item.
-  def lettered_list_rendering_test_method; end
-
-  # * A mixed list, containing
-  # * bullets in the main list
-  #   1. And numbers in a sublist
-  def mixed_list_rendering_test_method; end
-
-  # 1. Also in reverse
-  # 2. Second item
-  #    * Nested bulleted list
-  def second_mixed_list_rendering_test_method; end
-
-  # [First] And this is the list item body
-  #         With a second line containing more text
-  #
-  # [Second] Another labled list item
-  def labeled_list_rendering_test_method; end
-
-  # First:: With some text.
-  # Secondarily:: Lets see if this lines up.
-  def lined_up_labeled_list_rendering_test_method; end
-
-  # * a list item
-  #   with a long item text
-  #  Containing verbatim text
-  def list_containing_verbatim_text_rendering_test_method; end
-
-  # Text with stylings: *bold*, _emphasized_ and +monospaced+. 
-  def simple_styling_rendering_test_method; end
-  
-  # Also with html: <b>Bold</b>, <em>emphasized</em>, <i>also emphasized</i> 
-  # and <tt>monospaced tt</tt> or <code>monospaced code</code>. 
-  def html_styling_rendering_test_method; end
-
-  # These should not be styled: \<b>Not bold\</b>, \<em>not emphasized\</em>.
-  def escaped_styling_rendering_test_method; end
-
-  # Furthermore, this text contains links to raw links http://www.google.com mailto:spamidyspam@spam.com ftp://warez.teuto.de and plain web links: www.test.com .
-  #
-  # Then we have local links to other files: link:/etc/fstab
-  def raw_link_rendering_test_method; end
-
-  # Plus: Labled links SingleWordLabel[http://duckduckgo.com] and 
-  # {Multi Word Labels}[http://www.github.com].
-  def labeled_link_rendering_test_method; end
-
-  # Conversion characters: this: -- or --- should be an em-dash. We also have an ellipsis: ... . Copyright: (c) and registered trademark (r).
-  def conversion_character_rendering_test_method; end
-end

data/spec/lib/bri/mall_spec.rb

@@ -1,38 +0,0 @@
-require 'spec_helper'
-
-describe Bri::Mall do
-  # NOTE the specs here are commented out until I figure out how to properly
-  #      test singletons. Otherwise specs will fail in a bulk run while
-  #      running fine on their own
-  subject { Bri::Mall.instance }
-
-  before( :each ) do
-    RDoc::RI::Paths.stub!( :each ).
-                    and_yield( "store1_path", "store1_type" ).
-                    and_yield( "store2_path", "store2_type" )
-    RDoc::RI::Store.stub!( :new ).
-                    and_return { mock( RDoc::RI::Store, :load_cache=> true ) }
-  end
-
-  # describe "the instance" do
-
-  #   its( :stores ) { should have(2).objects }
-  # end
-
-  # describe "#classes" do
-  #   it "should query all stores for their modules" do
-  #     subject.stores.each do |store|
-  #       store.should_receive( :modules ).and_return( true )
-  #     end
-
-  #     subject.classes
-  #   end
-
-  #   it "should return a sorted array of unique class names" do
-  #     subject.stores.first.stub!( :modules => [ "C", "B", "A" ] )
-  #     subject.stores.last.stub!( :modules => [ "Z", "B", "C" ] )
-  #     subject.classes.should == [ "A", "B", "C", "Z" ]
-  #   end
-  # end
-
-end

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

@@ -1,125 +0,0 @@
-require 'spec_helper'
-
-describe Bri::Match::Class do
-  let( :fully_developed_class ) do
-    search_instance = Bri::Search::Class.new( "BriDummySpecClassTwo" ) 
-    search_instance.search
-    search_instance.matches.first
-  end
-
-  let( :empty_class ) do
-    search_instance = Bri::Search::Class.new( "BriDummySpecClassEmpty" ) 
-    search_instance.search
-    search_instance.matches.first
-  end
-
-  let( :empty_module ) do
-    search_instance = Bri::Search::Class.new( "BriDummySpecModule" ) 
-    search_instance.search
-    search_instance.matches.first
-  end
-
-  let( :namespaced_class ) do
-    search_instance = Bri::Search::Class.new( "BriDummySpec::Class" ) 
-    search_instance.search
-    search_instance.matches.first
-  end
-
-  describe "#type" do
-    it "should be class for a class" do
-      empty_class.type.should == "class"
-    end
-
-    it "should be module for a module" do
-      empty_module.type.should == "module"
-    end
-  end
-
-  describe "#name" do
-    it "should contain the name of a class" do
-      empty_class.name.should == "BriDummySpecClassEmpty < Object"
-    end
-
-    it "should contain the fully qualified name of a namespaced class" do
-      namespaced_class.name.should == "BriDummySpec::Class < Object"
-    end
-  end
-
-  describe "#description_paragraphs" do
-    it "should be empty for an undocumented class" do
-      empty_class.description_paragraphs.should == []
-    end
-
-    it "should contain rendered text for a documented class" do
-      fully_developed_class.description_paragraphs.size.should == 1
-      fully_developed_class.description_paragraphs.first.should =~ /This is a class description/
-    end
-  end
-
-  describe "#includes" do
-    it "should be empty for a class without includes" do
-      empty_class.includes.should be_empty
-    end
-
-    it "should contain a list of includes for classes with includes" do
-      fully_developed_class.includes.size.should == 1
-      fully_developed_class.includes.should include( "BriDummySpecModule" )
-    end
-  end
-
-  describe "#constants" do
-    it "should be empty for a class without constants" do
-      empty_class.constants.should be_empty
-    end
-
-    it "should contain a list of constants for classes with constants" do
-      fully_developed_class.constants.size.should == 2
-      fully_developed_class.constants.should include( "CONSTANT" )
-      fully_developed_class.constants.should include( "OTHER_CONSTANT" )
-    end
-  end
-
-  describe "#attributes" do
-    it "should be empty for a class without attributes" do
-      empty_class.attributes.should be_empty
-    end
-
-    it "should contain a list of attributes for classes with attr_* declarations" do
-      fully_developed_class.attributes.should_not be_empty
-    end
-
-    it "should mark attr_readers as read only" do
-      fully_developed_class.attributes.should include( "read_attr (R)" )
-    end
-
-    it "should mark attr_writers as write only" do
-      fully_developed_class.attributes.should include( "write_attr (W)" )
-    end
-
-    it "should mark attr_accessors as read/writeable" do
-      fully_developed_class.attributes.should include( "access_attr (RW)" )
-    end
-  end
-
-  describe "#class_methods" do
-    it "should be empty for a class without class methods" do
-      empty_class.class_methods.should be_empty
-    end
-
-    it "should contain class methods for classes with class methods" do
-      fully_developed_class.class_methods.size.should == 1
-      fully_developed_class.class_methods.first.should == "bri_dummy_spec_second_singleton_method"
-    end
-  end
-
-  describe "#instance_methods" do
-    it "should be empty for a class without instance methods" do
-      empty_class.instance_methods.should be_empty
-    end
-
-    it "should contain class methods for classes with class methods" do
-      fully_developed_class.instance_methods.size.should == 1
-      fully_developed_class.instance_methods.first.should == "bri_dummy_spec_instance_method_with_arguments"
-    end
-  end
-end

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

@@ -1,112 +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
-    double( RDoc::Markup::Document, :parts => [ fake_paragraph ] )
-  end
-
-  let( :rdoc_method ) do
-    double( 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
-
-  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