Merge 4a526df into f96cb1c

lib/ruby-bbcode.rb

@@ -1,4 +1,5 @@
 require 'tags/tags'
+require 'ruby-bbcode/configuration'
 require 'ruby-bbcode/tag_info'
 require 'ruby-bbcode/tag_sifter'
 require 'ruby-bbcode/tag_node'
@@ -11,6 +12,22 @@
 module RubyBBCode
   include ::RubyBBCode::Tags
 
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.reset
+    @configuration = Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
   # This method converts the given text (with BBCode tags) into a HTML representation
   # The escape_html parameter (default: true) escapes HTML tags that were present in the given text and therefore blocking (mallicious) HTML in the original text
   # The additional_tags parameter is used to add additional BBCode tags that should be accepted

lib/ruby-bbcode/configuration.rb

@@ -0,0 +1,18 @@
+# Configuration holds RubyBBCode configuration
+class Configuration
+  # Defines how to treat unknown tags
+  # * :exception throws and exception
+  # * :text converts it into a text
+  # * :ignore removes it from the output
+  attr_reader :ignore_unknown_tags
+
+  def initialize
+    @ignore_unknown_tags = :text
+  end
+
+  def ignore_unknown_tags=(value)
+    raise 'ignore_unknown_tags must be either :exception, :text or :ignore' unless %i[exception text ignore].include? value
+
+    @ignore_unknown_tags = value
+  end
+end

lib/ruby-bbcode/tag_info.rb

@@ -84,20 +84,37 @@ def invalid_quick_param?
 
     protected
 
+    # Returns a default info structure used by all tags
+    def default_tag_info(tag_info)
+      {
+        errors: [],
+        complete_match: tag_info[0]
+      }
+    end
+
     # Convert the result of the TagSifter#process_text regex into a more usable hash, that is used by the rest of the parser.
     # tag_info should a result of the regex of TagSifter#process_text
     # Returns the tag hash
     def find_tag_info(tag_info, dictionary)
-      ti = {}
-      ti[:errors] = []
-      ti[:complete_match] = tag_info[0]
+      ti = default_tag_info(tag_info)
       ti[:is_tag] = (tag_info[0].start_with? '[')
       if ti[:is_tag]
         ti[:closing_tag] = (tag_info[2] == '/')
         ti[:tag] = tag_info[3].to_sym.downcase
         ti[:params] = {}
         @definition = dictionary[ti[:tag]]
-        if (tag_info[5][0] == '=') && can_have_quick_param?
+        if !tag_in_dictionary?
+          # Tag is not defined in dictionary, so treat as text
+          raise "unknown tag #{ti[:tag]}" if RubyBBCode.configuration.ignore_unknown_tags == :exception
+
+          ti = default_tag_info(tag_info)
+          ti[:is_tag] = false
+          ti[:text] = if RubyBBCode.configuration.ignore_unknown_tags == :text
+                        tag_info[0]
+                      else
+                        ''
+                      end
+        elsif (tag_info[5][0] == '=') && can_have_quick_param?
           quick_param = tag_info[5][1..-1]
           # Get list of parameter values and add them as (regular) parameters
           value_array = quick_param.scan(@definition[:quick_param_format])[0]

test/ruby_bbcode_bbcode_test.rb

@@ -1,6 +1,10 @@
 require 'test_helper'
 
 class RubyBbcodeBbcodeTest < Minitest::Test
+  def before_setup
+    RubyBBCode.reset
+  end
+
   def test_multiline
     assert_equal "line1\nline2", "line1\nline2".bbcode_show_errors
     assert_equal "line1\r\nline2", "line1\r\nline2".bbcode_show_errors
@@ -182,6 +186,19 @@ def test_missing_parent_tags
     assert_equal '<span class=\'bbcode_error\' data-bbcode-errors=\'["[li] can only be used in [ul] and [ol]"]\'>[li]</span>[/li]', '[li][/li]'.bbcode_show_errors
   end
 
+  def test_unknown_tag
+    RubyBBCode.configuration.ignore_unknown_tags = :exception
+    assert_raises RuntimeError do
+      '[unknown]This is an unknown tag[/unknown]'.bbcode_show_errors
+    end
+
+    RubyBBCode.configuration.ignore_unknown_tags = :ignore
+    assert_equal 'This is an unknown tag', '[unknown]This is an unknown tag[/unknown]'.bbcode_show_errors
+
+    RubyBBCode.configuration.ignore_unknown_tags = :text
+    assert_equal '[unknown]This is an unknown tag[/unknown]', '[unknown]This is an unknown tag[/unknown]'.bbcode_show_errors
+  end
+
   def test_illegal_unallowed_childs
     assert_equal '[ul]<span class=\'bbcode_error\' data-bbcode-errors=\'["[ul] can only contain [li] and [*] tags, so &quot;Illegal text&quot; is not allowed"]\'>Illegal text</span>[/ul]', '[ul]Illegal text[/ul]'.bbcode_show_errors
     assert_equal '[ul]<span class=\'bbcode_error\' data-bbcode-errors=\'["[ul] can only contain [li] and [*] tags, so [b] is not allowed"]\'>[b]</span>Illegal tag[/b][/ul]', '[ul][b]Illegal tag[/b][/ul]'.bbcode_show_errors

test/ruby_bbcode_html_test.rb

@@ -1,6 +1,10 @@
 require 'test_helper'
 
 class RubyBbcodeHtmlTest < Minitest::Test
+  def before_setup
+    RubyBBCode.reset
+  end
+
   def test_multiline
     assert_equal "line1<br />\nline2", "line1\nline2".bbcode_to_html
     assert_equal "line1<br />\nline2", "line1\r\nline2".bbcode_to_html
@@ -205,6 +209,19 @@ def test_vimeo_tag
                  '[vimeo width=640 height=480]46141955[/vimeo]'.bbcode_to_html
   end
 
+  def test_unknown_tag
+    RubyBBCode.configuration.ignore_unknown_tags = :exception
+    assert_raises RuntimeError do
+      '[unknown]This is an unknown tag[/unknown]'.bbcode_to_html
+    end
+
+    RubyBBCode.configuration.ignore_unknown_tags = :ignore
+    assert_equal 'This is an unknown tag', '[unknown]This is an unknown tag[/unknown]'.bbcode_to_html
+
+    RubyBBCode.configuration.ignore_unknown_tags = :text
+    assert_equal '[unknown]This is an unknown tag[/unknown]', '[unknown]This is an unknown tag[/unknown]'.bbcode_to_html
+  end
+
   def test_raised_exceptions
     # Test whether exceptions are raised when the BBCode contains errors
     assert_raises RuntimeError do

test/ruby_bbcode_validity_test.rb

@@ -1,6 +1,10 @@
 require 'test_helper'
 
 class RubyBbcodeValidityTest < Minitest::Test
+  def before_setup
+    RubyBBCode.reset
+  end
+
   def test_multiple_errors
     input = '[b]Bold not closed, [li]Illegal list item[/li]'
     errors = input.bbcode_check_validity

test/unit/configuration_test.rb

@@ -0,0 +1,37 @@
+require 'test_helper'
+
+class ConfigurationTest < MiniTest::Test
+  def before_setup
+    RubyBBCode.reset
+  end
+
+  def test_configuration
+    refute_equal :ignore, RubyBBCode.configuration.ignore_unknown_tags
+
+    RubyBBCode.configuration.ignore_unknown_tags = :ignore
+
+    assert_equal :ignore, RubyBBCode.configuration.ignore_unknown_tags
+  end
+
+  def test_configuration_reset
+    refute_equal :exception, RubyBBCode.configuration.ignore_unknown_tags
+
+    RubyBBCode.configuration.ignore_unknown_tags = :exception
+
+    assert_equal :exception, RubyBBCode.configuration.ignore_unknown_tags
+
+    RubyBBCode.reset
+
+    refute_equal :exception, RubyBBCode.configuration.ignore_unknown_tags
+  end
+
+  def test_configuration_block
+    refute_equal :ignore, RubyBBCode.configuration.ignore_unknown_tags
+
+    RubyBBCode.configure do |config|
+      config.ignore_unknown_tags = :ignore
+    end
+
+    assert_equal :ignore, RubyBBCode.configuration.ignore_unknown_tags
+  end
+end