bb-ruby 0.9.4 → 0.9.5

data/History.txt

@@ -1,3 +1,11 @@
+== 0.9.5 2010-02-26
+
+* added to_html_with_formatting(!) methods
+
+== 0.9.4 2009-11-20
+
+* added Vimeo video embed tag support
+
 == 0.9.3 2009-06-11
 
 * better auto link support

data/README.rdoc

@@ -55,6 +55,12 @@ Define your own translation, in order to be more flexible:
     }
  
     text.bbcode_to_html(my_blockquote)
+    
+You can also use the simple_format method of ActionPack by using the *_with_formatting methods:
+
+  output = text.bbcode_to_html_with_formatting
+  output = text.bbcode_to_html_with_formatting!
+
 
 == TAGS PROCESSED:
 

data/Rakefile

@@ -1,6 +1,9 @@
 %w[rubygems rake rake/clean fileutils newgem rubigen hoe].each { |f| require f }
 require File.dirname(__FILE__) + '/lib/bb-ruby'
 
+Hoe.plugin :newgem
+Hoe.plugin :website
+
 # Generate all the Rake tasks
 # Run 'rake -T' to see list of generated tasks (from gem root directory)
 $hoe = Hoe.spec('bb-ruby') do |p|

data/lib/bb-ruby.rb

@@ -2,7 +2,7 @@ $:.unshift(File.dirname(__FILE__)) unless
   $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
 
 module BBRuby
-  VERSION = '0.9.4'
+  VERSION = '0.9.5'
 
   # allowable image formats
   @@imageformats = 'png|bmp|jpg|gif|jpeg'
@@ -244,7 +244,38 @@ module BBRuby
     #   BBRuby.to_html(text, {}, true, :disable, :image, :video, :color)
     #
     def to_html(text, tags_alternative_definition={}, escape_html=true, method=:disable, *tags)
-      text = text.clone
+      text = process_tags(text, tags_alternative_definition, escape_html, method, *tags)
+      
+      # parse spacing
+      text.gsub!( /\r\n?/, "\n" )
+      text.gsub!( /\n/, "<br />\n" )
+
+      # return markup
+      text
+    end
+    
+    # The same as BBRuby.to_html except the output is passed through simple_format first
+    #
+    # Returns text transformed into HTML using simple formatting rules. Two or more consecutive newlines(\n\n) 
+    # are considered as a paragraph and wrapped in <p> tags. One newline (\n) is considered as a linebreak and 
+    # a <br /> tag is appended. This method does not remove the newlines from the text.
+    #
+    def to_html_with_formatting(text, tags_alternative_definition={}, escape_html=true, method=:disable, *tags)
+      text = process_tags(text, tags_alternative_definition, escape_html, method, *tags)
+      
+      # parse spacing
+      simple_format( text )
+    end
+
+    # Returns the list of tags processed by BBRuby in a Hash object
+    def tag_list
+      @@tags
+    end
+    
+    private
+    
+    def process_tags(text, tags_alternative_definition={}, escape_html=true, method=:disable, *tags)
+      text = text.dup
       
       # escape "<, >, &" to remove any html
       if escape_html
@@ -263,18 +294,19 @@ module BBRuby
         # this works nicely because the default is disable and the default set of tags is [] (so none disabled) :)
         tags_definition.each_value { |t| text.gsub!(t[0], t[1]) unless tags.include?(t[4]) }
       end
-
-      # parse spacing
-      text.gsub!( /\r\n?/, "\n" )
-      text.gsub!( /\n/, "<br />\n" )
-
-      # return markup
+      
       text
     end
-
-    # Returns the list of tags processed by BBRuby in a Hash object
-    def tag_list
-      @@tags
+    
+    # extracted from Rails ActionPack
+    def simple_format( text )
+      start_tag = '<p>'
+      text = text.to_s.dup
+      text.gsub!(/\r\n?/, "\n")                     # \r\n and \r => \n
+      text.gsub!(/\n\n+/, "</p>\n\n#{start_tag}")  # 2+ newline  => paragraph
+      text.gsub!(/([^\n]\n)(?=[^\n])/, '\1<br />')  # 1 newline   => br
+      text.insert 0, start_tag
+      text << "</p>"
     end
   end # class << self
 
@@ -332,4 +364,13 @@ class String
   def bbcode_to_html!(tags_alternative_definition = {}, escape_html=true, method=:disable, *tags)
     self.replace(BBRuby.to_html(self, tags_alternative_definition, escape_html, method, *tags))
   end
+
+  def bbcode_to_html_with_formatting(tags_alternative_definition = {}, escape_html=true, method=:disable, *tags)
+    BBRuby.to_html_with_formatting(self, tags_alternative_definition, escape_html, method, *tags)
+  end
+
+  # Replace the string contents with the HTML-converted markup using simple_format
+  def bbcode_to_html_with_formatting!(tags_alternative_definition = {}, escape_html=true, method=:disable, *tags)
+    self.replace(BBRuby.to_html_with_formatting(self, tags_alternative_definition, escape_html, method, *tags))
+  end
 end

data/test/test_bb-ruby.rb

@@ -179,6 +179,16 @@ class TestBBRuby < Test::Unit::TestCase
     assert_equal "<strong>foobar</strong>", foo.bbcode_to_html!
     assert_equal "<strong>foobar</strong>", foo
   end
+  
+  def test_to_html_with_no_markup
+    foo = "first paragraph\n\nsecond paragraph\nwith a linebreak"
+    assert_equal "first paragraph<br />\n<br />\nsecond paragraph<br />\nwith a linebreak", foo.bbcode_to_html
+  end
+  
+  def test_to_html_with_formatting
+    foo = "first paragraph\n\nsecond paragraph\nwith a linebreak"
+    assert_equal %Q(<p>first paragraph</p>\n\n<p>second paragraph\n<br />with a linebreak</p>), foo.bbcode_to_html_with_formatting
+  end
 
   def test_self_tag_list
     assert_equal 32, BBRuby.tag_list.size

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: bb-ruby
 version: !ruby/object:Gem::Version 
-  version: 0.9.4
+  version: 0.9.5
 platform: ruby
 authors: 
 - Craig P Jolicoeur
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-20 00:00:00 -05:00
+date: 2010-02-26 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency