rbbcode 0.1.5 → 0.1.6

data/lib/rbbcode/schema.rb

@@ -35,6 +35,16 @@ module RbbCode
 	end
 	
 	class SchemaTag < SchemaNode
+		def closes_twins
+			@schema.close_twins(@name)
+			self
+		end
+		
+		def does_not_close_twins
+			@schema.dont_close_twins(@name)
+			self
+		end
+		
 		def initialize(schema, name)
 			@schema = schema
 			@name = name
@@ -143,6 +153,19 @@ module RbbCode
 			@forbidden_descent = {}
 			@required_parents = {}
 			@no_text = []
+			@twin_closers = []
+		end
+		
+		def close_twins(tag_name)
+			@twin_closers << tag_name.to_s unless @twin_closers.include?(tag_name.to_s)
+		end
+		
+		def close_twins?(tag_name)
+			@twin_closers.include?(tag_name.to_s)
+		end
+		
+		def does_not_close_twins(tag_name)
+			@twin_closers.delete(tag_name.to_s)
 		end
 		
 		def forbid_children_except(parent, children)
@@ -175,6 +198,7 @@ module RbbCode
 			@child_requirements = {}
 			@never_empty = []
 			@no_text = []
+			@twin_closers = []
 			use_defaults
 		end
 		
@@ -248,6 +272,7 @@ module RbbCode
 			tag('code').may_not_be_nested
 			tag('p').may_not_be_nested
 			tag('*').must_be_child_of('list')
+			tag('*').closes_twins
 			tag('list').may_not_descend_from('p')
 			tag('list').may_only_be_parent_of('*')
 			tag('list').may_not_contain_text

data/lib/rbbcode/tree_maker.rb

@@ -100,7 +100,7 @@ module RbbCode
 		end
 		
 		def make_tree(str)
-			delete_empty_paragraphs!(
+			delete_junk_breaks!(
 				delete_invalid_empty_tags!(
 					parse_str(str)
 				)
@@ -130,14 +130,18 @@ module RbbCode
 			end
 		end
 		
-		def delete_empty_paragraphs!(node)
+		# Delete empty paragraphs and line breaks at the end of block-level elements
+		def delete_junk_breaks!(node)
 			node.children.reject! do |child|
 				if child.is_a?(TagNode)
 					if !child.children.empty?
-						delete_empty_paragraphs!(child)
+						delete_junk_breaks!(child)
 						false
 					elsif child.tag_name == @schema.paragraph_tag_name
-						# It's an empty paragraph tag, so the reject! block should return true
+						# It's an empty paragraph tag
+						true
+					elsif @schema.block_level?(node.tag_name) and child.tag_name == @schema.line_break_tag_name and node.children.last == child
+						# It's a line break a the end of the block-level element
 						true
 					else
 						false
@@ -217,7 +221,7 @@ module RbbCode
 						current_token << char
 					end
 				when :break
-					if char == CR_CODE or char_code == LF_CODE
+					if char_code == CR_CODE or char_code == LF_CODE
 						current_token << char
 					else
 						if break_type(current_token) == :paragraph
@@ -289,6 +293,11 @@ module RbbCode
 							current_parent << tag_node
 							current_parent = tag_node
 							# If all of this results in empty paragraph tags, no worries: they will be deleted later.
+						elsif tag_node.tag_name == current_parent.tag_name and @schema.close_twins?(tag_node.tag_name)
+							# The current tag and the tag we're now opening are of the same type, and this kind of tag auto-closes its twins
+							# (E.g. * tags in the default config.)
+							current_parent.parent << tag_node
+							current_parent = tag_node
 						elsif @schema.tag(tag_node.tag_name).valid_in_context?(*ancestor_list(current_parent))
 							current_parent << tag_node
 							current_parent = tag_node

data/spec/parser_spec.rb

@@ -95,5 +95,11 @@ describe RbbCode::Parser do
 			@parser.parse('[url=http://www.google.com][img]http://www.123.com/123.png[/img][/url]').should ==
 				'<p><a href="http://www.google.com"><img src="http://www.123.com/123.png" alt=""/></a></p>'
 		end
+		
+		it 'can parse phpBB-style [*] tags' do
+			# Thanks to motiv for finding this
+			@parser.parse("[list]\n[*]one\n[*]two\n[/list]"
+			).should == '<ul><li>one</li><li>two</li></ul>'
+		end
 	end
 end

data/spec/tree_maker_spec.rb

@@ -16,7 +16,7 @@ describe RbbCode::TreeMaker do
 			@tree_maker = RbbCode::TreeMaker.new(@schema)
 		end		
 
-		it 'should make a tree from a string with one tag' do
+		it 'makes a tree from a string with one tag' do
 			str = 'This is [b]bold[/b] text'
 			
 			expect_tree(str) do
@@ -28,7 +28,7 @@ describe RbbCode::TreeMaker do
 			end
 		end
 	
-		it 'should ignore tags that are invalid in their context' do
+		it 'ignores tags that are invalid in their context' do
 			@schema.tag('u').may_not_descend_from('b')
 			
 			str = 'This is [b]bold and [u]underlined[/u][/b] text'
@@ -45,7 +45,7 @@ describe RbbCode::TreeMaker do
 			end
 		end
 
-		it 'should create paragraph tags' do
+		it 'creates paragraph tags' do
 			str = "This is a paragraph.\n\nThis is another."
 			
 			expect_tree(str) do
@@ -58,7 +58,7 @@ describe RbbCode::TreeMaker do
 			end
 		end
 
-		it 'should not put block-level elements inside paragraph tags' do
+		it 'does not put block-level elements inside paragraph tags' do
 			str = "This is a list:\n\n[list]\n\n[*]Foo[/i]\n\n[/list]\n\nwith some text after it"
 			
 			expect_tree(str) do
@@ -74,7 +74,7 @@ describe RbbCode::TreeMaker do
 			end
 		end
 		
-		it 'should not insert br tags in the midst of block-level elements' do
+		it 'does not insert br tags in the midst of block-level elements' do
 			str = "List:\n[list]\n[*]Foo[/*]\n[*]Bar[/*]\n[/list]\nText after list"
 			
 			expect_tree(str) do
@@ -91,7 +91,7 @@ describe RbbCode::TreeMaker do
 			end
 		end
 		
-		it 'should store tag values' do
+		it 'stores tag values' do
 			str = 'This is a [url=http://google.com]link[/url]'
 			
 			expect_tree(str) do
@@ -103,5 +103,20 @@ describe RbbCode::TreeMaker do
 				end
 			end
 		end
+		
+		it 'auto-closes twins when the schema says it should' do
+			str = "[list]\n[*]One\n[*]Two\n[/list]"
+			
+			expect_tree(str) do
+				tag('list') do
+					tag('*') do
+						text 'One'
+					end
+					tag('*') do
+						text 'Two'
+					end
+				end
+			end
+		end
 	end
 end

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: rbbcode
 version: !ruby/object:Gem::Version 
-  version: 0.1.5
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 6
+  version: 0.1.6
 platform: ruby
 authors: 
 - Jarrett Colby
@@ -9,29 +14,37 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-26 00:00:00 -06:00
+date: 2010-03-07 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 3
+        - 0
         version: 1.3.0
-    version: 
+  type: :development
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: sanitize-url
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 1
+        - 3
         version: 0.1.3
-    version: 
+  type: :runtime
+  version_requirements: *id002
 description: RbbCode is a customizable Ruby library for parsing BB Code. RbbCode validates and cleans input. It supports customizable schemas so you can set rules about what tags are allowed where. The default rules are designed to ensure valid HTML output.
 email: jarrett@jarrettcolby.com
 executables: []
@@ -60,18 +73,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Ruby BB Code parser