ruby-bbcode 1.0.1 → 2.0.0

data/test/ruby_bbcode_validity_test.rb

@@ -0,0 +1,119 @@
+require 'test_helper'
+
+class RubyBbcodeValidityTest < Minitest::Test
+  def test_multiple_errors
+    input = '[b]Bold not closed, [li]Illegal list item[/li]'
+    errors = input.bbcode_check_validity
+    assert_equal 2, errors.length
+    assert_includes errors, "[b] not closed"
+    assert_includes errors, "[li] can only be used in [ul] and [ol], so using it in a [b] tag is not allowed"
+  end
+
+  def test_illegal_items
+    assert_equal ['[li] can only be used in [ul] and [ol]'],
+                   '[li]Illegal item[/li]'.bbcode_check_validity
+    assert_equal ['[li] can only be used in [ul] and [ol], so using it in a [b] tag is not allowed'],
+                   '[b][li]Illegal item[/li][/b]'.bbcode_check_validity
+  end
+
+  def test_illegal_list_contents
+    assert_equal ['[ul] can only contain [li] and [*] tags, so "Illegal list" is not allowed'],
+                   '[ul]Illegal list[/ul]'.bbcode_check_validity
+    assert_equal ['[ul] can only contain [li] and [*] tags, so [b] is not allowed'],
+                   '[ul][b]Illegal list[/b][/ul]'.bbcode_check_validity
+  end
+
+  def test_illegal_list_contents_text_between_list_items
+    assert_equal ['[ul] can only contain [li] and [*] tags, so "Illegal text" is not allowed'],
+                   '[ul][li]item[/li]Illegal text[/ul]'.bbcode_check_validity
+    assert_equal ['[ul] can only contain [li] and [*] tags, so "Illegal text" is not allowed'],
+                   '[ul][li]item[/li]Illegal text[li]item[/li][/ul]'.bbcode_check_validity
+  end
+
+  def test_unordered_list_omit_closing
+    errors = '[ul][li]item 1[li]item 2[/ul]'.bbcode_check_validity
+    assert_equal 5, errors.length
+
+    assert_includes errors, '[li] can only be used in [ul] and [ol], so using it in a [li] tag is not allowed'
+    assert_includes errors, 'Closing tag [/ul] doesn\'t match [li]'
+    assert_includes errors, '[ul] not closed'
+    assert_includes errors, '[li] not closed' # twice
+  end
+
+  def test_required_parameters
+    assert '[size=12]text[/size]'.bbcode_check_validity
+    assert '[size size=12]text[/size]'.bbcode_check_validity
+    assert_equal ['Tag [size] must have \'size\' parameter'], '[size]text[/size]'.bbcode_check_validity
+  end
+
+  def test_optional_parameters
+    assert '[img]http://www.ruby-lang.org/images/logo.gif[/img]'.bbcode_check_validity
+    assert '[img width=100 height=100]http://www.ruby-lang.org/images/logo.gif[/img]'.bbcode_check_validity
+
+    # Adding custom 'optional parameters' is not allowed though
+    assert_equal ['Tag [img] doesn\'t have a \'depth\' parameter'], '[img depth=100]http://www.ruby-lang.org/images/logo.gif[/img]'.bbcode_check_validity
+  end
+
+  def test_quick_parameters
+    assert '[size=12]text[/size]'.bbcode_check_validity
+    assert_equal ['The size parameter \'\' is incorrect, a number is expected'], '[size=]text[/size]'.bbcode_check_validity
+    assert_equal ['The size parameter \'abc\' is incorrect, a number is expected'], '[size=abc]text[/size]'.bbcode_check_validity
+
+    assert '[img=100x200]http://www.ruby-lang.org/images/logo.gif[/img]'.bbcode_check_validity
+    assert_equal ['The image parameters \'\' are incorrect, \'<width>x<height>\' excepted'], '[img=]http://www.ruby-lang.org/images/logo.gif[/img]'.bbcode_check_validity
+    assert_equal ['The image parameters \'x\' are incorrect, \'<width>x<height>\' excepted'], '[img=x]http://www.ruby-lang.org/images/logo.gif[/img]'.bbcode_check_validity
+  end
+
+  def test_illegal_link
+    assert_equal ['The URL should start with http:// https://, ftp:// or /, instead of \'index.html\''], '[url=index.html]Home[/url]'.bbcode_check_validity
+    assert_equal ['The URL should start with http:// https://, ftp:// or /, instead of \'www.google.com\''], '[url=www.google.com]Google[/url]'.bbcode_check_validity
+    assert_equal ['The URL should start with http:// https://, ftp:// or /, instead of \'htfp://www.google.com\''], '[url]htfp://www.google.com[/url]'.bbcode_check_validity
+  end
+
+  def test_no_ending_tag
+   assert_equal ["[b] not closed"], "this [b]should not be bold".bbcode_check_validity
+  end
+
+  def test_no_start_tag
+    assert_equal ["Closing tag [/b] doesn't match an opening tag"], "this should not be bold[/b]".bbcode_check_validity
+  end
+
+  def test_different_start_and_ending_tags
+    assert_equal ["Closing tag [/i] doesn't match [b]", "[b] not closed"], "this [b]should not do formatting[/i]".bbcode_check_validity
+  end
+
+  def test_failing_between_texts
+    assert_equal ['No text between [img] and [/img] tags.'], '[img][/img]'.bbcode_check_validity
+    assert_equal ['The URL should start with http:// https://, ftp:// or /, instead of \'illegal url\''], '[url]illegal url[/url]'.bbcode_check_validity
+    assert_equal ['Cannot determine multi-tag type: No text between [media] and [/media] tags.'], '[media][/media]'.bbcode_check_validity
+  end
+
+  def test_failing_media_tag
+    assert_equal ['Unknown multi-tag type for [media]'], '[media]http://www.youtoob.com/watch?v=cSohjlYQI2A[/media]'.bbcode_check_validity
+  end
+
+  def test_addition_of_tags
+    mydef = {
+      :test => {
+        :description => 'This is a test',
+        :example => '[test]Test here[/test]',
+        :param_tokens => [{:token => :param}]
+      }
+    }
+    # Currently, unknown tags are treated as text and no (missing) parameter values are checked for bbcode_check_validity
+    # So this test is quite boring
+    assert 'pre [test]Test here[/test] post'.bbcode_check_validity
+    assert 'pre [test]Test here[/test] post'.bbcode_check_validity(mydef)
+  end
+
+    # TODO:  This stack level problem should be validated during the validations
+  #def test_stack_level_too_deep
+  #  num = 2300  # increase this number if the test starts failing.  It's very near the tipping point
+  #  openers = "[s]hi i'm" * num
+  #  closers = "[/s]" * num
+  #  assert_raise( SystemStackError ) do
+  #    (openers+closers).bbcode_to_html
+  #  end
+  #end
+
+end

data/test/test_helper.rb

@@ -1,7 +1,10 @@
+require 'coveralls'
+Coveralls.wear!
+
 require 'ruby-bbcode'
-require "test/unit"
+require "minitest/autorun"
 
-# This hack allows us to make all the private methods of a class public.  
+# This hack allows us to make all the private methods of a class public.
 class Class
   def publicize_methods
     saved_private_instance_methods = self.private_instance_methods

data/test/unit/tag_sifter_test.rb

@@ -1,51 +1,41 @@
 require 'test_helper'
 
-class TagSifterTest < Test::Unit::TestCase
+class TagSifterTest < MiniTest::Test
+  include RubyBBCode::Tags
   def test_youtube_parser
     url1 = "http://www.youtube.com/watch?v=E4Fbk52Mk1w"
     just_an_id = 'E4Fbk52Mk1w'
     url_without_http = "www.youtube.com/watch?v=E4Fbk52Mk1w"
     url_without_www = "youtube.com/watch?v=E4Fbk52Mk1w"
     url_with_feature = "http://www.youtube.com/watch?feature=player_embedded&v=E4Fbk52Mk1w"
-    mock_regex_matches = [/youtube.com.*[v]=([^&]*)/, /youtu.be\/([^&]*)/, /y2u.be\/([^&]*)/]
-    
+    mock_regex_matches = @@tags[:youtube][:url_matches]
+
     expected_output = 'E4Fbk52Mk1w'
-    
+
     RubyBBCode::TagSifter.publicize_methods do
       ts = RubyBBCode::TagSifter.new "", ""
-      assert_equal expected_output, 
-                     ts.conduct_special_formatting(url1, mock_regex_matches)
-      
-      assert_equal expected_output, 
-                   ts.conduct_special_formatting(just_an_id, mock_regex_matches)
-                   
-      assert_equal expected_output, 
-                     ts.conduct_special_formatting(url_without_http, mock_regex_matches)
-                     
-      assert_equal expected_output, 
-                     ts.conduct_special_formatting(url_without_www, mock_regex_matches)
-                     
-      assert_equal expected_output, 
-                     ts.conduct_special_formatting(url_with_feature, mock_regex_matches)
+      assert_equal expected_output, ts.match_url_id(url1, mock_regex_matches)
+      assert_equal expected_output, ts.match_url_id(just_an_id, mock_regex_matches)
+      assert_equal expected_output, ts.match_url_id(url_without_http, mock_regex_matches)
+      assert_equal expected_output, ts.match_url_id(url_without_www, mock_regex_matches)
+      assert_equal expected_output, ts.match_url_id(url_with_feature, mock_regex_matches)
     end
-    
+
   end
 
-	# I think the answer to this is creating a new tag named [youtube]
-	# but that captures specifically the .be or .com and treats them differently...
-	def test_youtubes_via_there_url_shortener
-		url_from_shortener = "http://youtu.be/E4Fbk52Mk1w"
-		directory_format = "http://youtube.googleapis.com/v/E4Fbk52Mk1w"
+  # I think the answer to this is creating a new tag named [youtube]
+  # but that captures specifically the .be or .com and treats them differently...
+  def test_youtubes_via_there_url_shortener
+    url_from_shortener = "http://youtu.be/E4Fbk52Mk1w"
+    directory_format = "http://youtube.googleapis.com/v/E4Fbk52Mk1w"
     expected_output = 'E4Fbk52Mk1w'
-    mock_regex_matches = [/youtube.com.*[v]=([^&]*)/, /youtu.be\/([^&]*)/, /y2u.be\/([^&]*)/]
+    mock_regex_matches = @@tags[:youtube][:url_matches]
 
-    
     RubyBBCode::TagSifter.publicize_methods do
       ts = RubyBBCode::TagSifter.new "", ""
-      
-      
-			assert_equal expected_output, 
-				             ts.conduct_special_formatting(url_from_shortener, mock_regex_matches)   # this test is now hopelessly broken because generating an ID from a link requires that @bbtree.current_node.definition be properly populated with regex matches...
-		end
-	end
+
+      # this test is now hopelessly broken because generating an ID from a link requires that @bbtree.current_node.definition be properly populated with regex matches...
+      assert_equal expected_output, ts.match_url_id(url_from_shortener, mock_regex_matches)
+    end
+  end
 end

data/test/unit/tags_test.rb

@@ -0,0 +1,17 @@
+require 'test_helper'
+
+class TagSifterTest < MiniTest::Test
+  def test_taglist_modification
+    tags = RubyBBCode::Tags.tag_list
+    assert_equal nil, RubyBBCode::Tags.tag_list[:test]
+    begin
+      tags[:test] = 'test'
+
+      assert_equal 'test', RubyBBCode::Tags.tag_list[:test]
+    ensure
+      # Always restore as this change is permanent (and messes with other tests)
+      tags.delete :test
+    end
+    assert_equal nil, RubyBBCode::Tags.tag_list[:test]
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-bbcode
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Maarten Bezemer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-04 00:00:00.000000000 Z
+date: 2015-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -38,6 +38,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.0
 description: Convert BBCode to HTML and check whether the BBCode is valid.
 email: maarten.bezemer@gmail.com
 executables: []
@@ -57,14 +85,16 @@ files:
 - lib/ruby-bbcode/tag_info.rb
 - lib/ruby-bbcode/tag_node.rb
 - lib/ruby-bbcode/tag_sifter.rb
+- lib/ruby-bbcode/templates/bbcode_errors_template.rb
+- lib/ruby-bbcode/templates/html_template.rb
 - lib/ruby-bbcode/version.rb
 - lib/tags/tags.rb
-- test/current_test.rb
-- test/debugging.rb
-- test/ruby_bbcode_test.rb
+- test/ruby_bbcode_bbcode_test.rb
+- test/ruby_bbcode_html_test.rb
+- test/ruby_bbcode_validity_test.rb
 - test/test_helper.rb
-- test/unit/debugging_test.rb
 - test/unit/tag_sifter_test.rb
+- test/unit/tags_test.rb
 homepage: http://github.com/veger/ruby-bbcode
 licenses:
 - MIT
@@ -81,7 +111,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -92,11 +122,11 @@ rubyforge_project:
 rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
-summary: ruby-bbcode-1.0.1
+summary: ruby-bbcode-2.0.0
 test_files:
 - test/test_helper.rb
-- test/current_test.rb
+- test/ruby_bbcode_validity_test.rb
+- test/ruby_bbcode_bbcode_test.rb
+- test/ruby_bbcode_html_test.rb
 - test/unit/tag_sifter_test.rb
-- test/unit/debugging_test.rb
-- test/debugging.rb
-- test/ruby_bbcode_test.rb
+- test/unit/tags_test.rb

data/test/current_test.rb

@@ -1,8 +0,0 @@
-require 'test_helper'
-require 'benchmark'
-
-
-
-class RubyBbcodeTest < Test::Unit::TestCase
-  
-end

data/test/debugging.rb

@@ -1,93 +0,0 @@
-module RubyBBCode
-  def self.log(string, clear_file = true)
-    clear_log_file_at_beginning_of_execution clear_file
-
-    File.open('/tmp/ruby-bbcode.log', 'a') do |f|
-      f.puts string
-    end
-  end
-
-  def self.clear_log_file_at_beginning_of_execution(clear_file)
-    return if !clear_file
-    if defined?(@@cleared_file).nil?
-      @@cleared_file = true
-      File.open('/tmp/ruby-bbcode.log', 'w+') do |f|
-        puts ''
-      end
-    end
-  end
-
-
-  # This module can be included in the BBTree and TagNode to give them debugging features
-  module DebugBBTree
-    # For Debugging/ visualization purposes.
-    # This can be used to render the #nodes array in a pretty manor, showing the hirarchy.
-    def to_v
-      tree = self
-      visual_string = ''
-
-      walk_tree(tree) do |node, depth|
-        indentation = '  ' * depth
-        case node[:is_tag]
-        when true
-          visual_string += "#{indentation}" + node[:tag].to_s + "\n"
-        when false
-          visual_string += "#{indentation}\"#{node[:text]}\"\n"
-        end
-      end
-
-      visual_string
-    end
-
-
-    # this blocky method counts how many children are
-    # in the TagNode.children, recursively walking the tree
-    def count_child_nodes(hash = self)
-      count = 0
-      walk_tree(hash) do
-        count += 1
-      end
-      count
-    end
-
-    # For BBTree, teh to_s method shows the count of the children plus a graphical
-    # depiction of the tree, and the relation of the nodes.
-    # For TagNodes, the root-most tag is displayed, and the children are counted.
-    def to_s
-      object_identifier = "#<#{self.class.to_s}:0x#{'%x' % (self.object_id << 1)}\n"
-      close_object = ">\n"
-
-      case self
-      when RubyBBCode::BBTree
-        object_identifier + "Children: #{count_child_nodes}\n" + self.to_v + close_object
-      when RubyBBCode::TagNode   # when inspecting TagNodes, it's better not to show the tree display
-        if self[:is_tag]
-          object_identifier + "Tag:  #{self[:tag].to_s}, Children: #{count_child_nodes}\n" + close_object
-        else
-          object_identifier + '"' + self[:text].to_s + "\"\n" + close_object
-        end
-      end
-    end
-
-    private
-
-    # This function is used by to_v and anything else that needs to iterate through the
-    # @bbtree
-    def walk_tree(tree, depth = -1, &blk)
-      return enum_for(:walk_tree) unless blk  # ignore me for now, I'm a convention for being versatile
-
-      # Perform the block action specified at top level!!!
-      yield tree, depth unless depth == -1
-
-      # next if we're a text node
-      return if tree.type == :text
-
-      # Enter into recursion (including block action) for each child node in this node
-      tree.children.each do |node|
-        walk_tree(node, depth + 1, &blk)
-      end
-    end
-
-  end
-
-end

data/test/unit/debugging_test.rb

@@ -1,48 +0,0 @@
-require 'test_helper'
-require 'debugging'
-
-class RubyBbcodeTest < Test::Unit::TestCase
-  include ::RubyBBCode::Tags
-  
-  def test_bbtree_to_v
-    text = "[i][b]a[/b][b]a[/b][b]a[/b][b]a[/b]item 1[/i][i]item 2[/i]"
-    visual = <<eos
-i
-  b
-    "a"
-  b
-    "a"
-  b
-    "a"
-  b
-    "a"
-  "item 1"
-i
-  "item 2"
-eos
-    
-    tags = @@tags
-    @tag_sifter = RubyBBCode::TagSifter.new(text, tags)
-    @tag_sifter.process_text
-    
-    # manually include the debugging methods if they've been disabled for cleanliness purposes
-    @tag_sifter.bbtree.extend(::RubyBBCode::DebugBBTree) unless @tag_sifter.bbtree.respond_to? :to_v
-    
-    assert_equal visual, @tag_sifter.bbtree.to_v
-  end
-  
-  def test_bbtree_counting_nodes
-    text = "[ol][li][b][/b][b][/b][b][/b][b][/b]item 1[/li][li]item 2[/li][/ol]"
-    tags = @@tags
-    
-    @tag_sifter = RubyBBCode::TagSifter.new(text, tags)
-    
-    @tag_sifter.process_text
-    
-    # manually include debugging methods if needed.  
-    @tag_sifter.bbtree.extend(::RubyBBCode::DebugBBTree) unless @tag_sifter.bbtree.respond_to? :count_child_nodes
-    
-    assert_equal 9, @tag_sifter.bbtree.count_child_nodes
-  end
-  
-end