ruby-bbcode 2.0.0 → 2.1.1

data/test/ruby_bbcode_validity_test.rb

@@ -1,33 +1,37 @@
 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
     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"
+    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
+                 '[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
+                 '[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
+                 '[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
+                 '[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
+                 '[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
+                 '[ul][li]item[/li]Illegal text[li]item[/li][/ul]'.bbcode_check_validity
   end
 
   def test_unordered_list_omit_closing
@@ -71,15 +75,15 @@ class RubyBbcodeValidityTest < Minitest::Test
   end
 
   def test_no_ending_tag
-   assert_equal ["[b] not closed"], "this [b]should not be bold".bbcode_check_validity
+    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
+    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
+    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
@@ -94,10 +98,10 @@ class RubyBbcodeValidityTest < Minitest::Test
 
   def test_addition_of_tags
     mydef = {
-      :test => {
-        :description => 'This is a test',
-        :example => '[test]Test here[/test]',
-        :param_tokens => [{:token => :param}]
+      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
@@ -106,14 +110,13 @@ class RubyBbcodeValidityTest < Minitest::Test
     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
+  # 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
 end

data/test/test_helper.rb

@@ -2,19 +2,18 @@ require 'coveralls'
 Coveralls.wear!
 
 require 'ruby-bbcode'
-require "minitest/autorun"
+require 'minitest/autorun'
 
 # 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
-    self.class_eval { public(*saved_private_instance_methods) }
+    saved_private_instance_methods = private_instance_methods
+    class_eval { public(*saved_private_instance_methods) }
     yield
-    self.class_eval { private(*saved_private_instance_methods) }
+    class_eval { private(*saved_private_instance_methods) }
   end
 end
 
-
 # This is for measuring memory usage...
 def get_current_memory_usage
   `ps -o rss= -p #{Process.pid}`.to_i

data/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

data/test/unit/tag_sifter_test.rb

@@ -3,36 +3,34 @@ require 'test_helper'
 class TagSifterTest < MiniTest::Test
   include RubyBBCode::Tags
   def test_youtube_parser
-    url1 = "http://www.youtube.com/watch?v=E4Fbk52Mk1w"
+    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"
+    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 = @@tags[:youtube][:url_matches]
 
     expected_output = 'E4Fbk52Mk1w'
 
     RubyBBCode::TagSifter.publicize_methods do
-      ts = RubyBBCode::TagSifter.new "", ""
+      ts = RubyBBCode::TagSifter.new '', ''
       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"
+    url_from_shortener = 'http://youtu.be/E4Fbk52Mk1w'
     expected_output = 'E4Fbk52Mk1w'
     mock_regex_matches = @@tags[:youtube][:url_matches]
 
     RubyBBCode::TagSifter.publicize_methods do
-      ts = RubyBBCode::TagSifter.new "", ""
+      ts = RubyBBCode::TagSifter.new '', ''
 
       # 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)

data/test/unit/tags_test.rb

@@ -3,7 +3,7 @@ require 'test_helper'
 class TagSifterTest < MiniTest::Test
   def test_taglist_modification
     tags = RubyBBCode::Tags.tag_list
-    assert_equal nil, RubyBBCode::Tags.tag_list[:test]
+    assert_nil RubyBBCode::Tags.tag_list[:test]
     begin
       tags[:test] = 'test'
 
@@ -12,6 +12,6 @@ class TagSifterTest < MiniTest::Test
       # Always restore as this change is permanent (and messes with other tests)
       tags.delete :test
     end
-    assert_equal nil, RubyBBCode::Tags.tag_list[:test]
+    assert_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: 2.0.0
+  version: 2.1.1
 platform: ruby
 authors:
 - Maarten Bezemer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-09 00:00:00.000000000 Z
+date: 2020-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,16 +16,30 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.3
+        version: 4.2.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.3
+        version: 4.2.2
 - !ruby/object:Gem::Dependency
-  name: rake
+  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
+- !ruby/object:Gem::Dependency
+  name: irb
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,34 +67,77 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  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: solargraph
+  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: term-ansicolor
+  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'
 description: Convert BBCode to HTML and check whether the BBCode is valid.
 email: maarten.bezemer@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files:
-- README.textile
+- README.md
 - CHANGELOG.md
 - MIT-LICENSE
 files:
 - CHANGELOG.md
 - MIT-LICENSE
-- README.textile
+- README.md
 - Rakefile
 - lib/ruby-bbcode.rb
 - lib/ruby-bbcode/bbtree.rb
+- lib/ruby-bbcode/configuration.rb
 - lib/ruby-bbcode/tag_collection.rb
 - lib/ruby-bbcode/tag_info.rb
 - lib/ruby-bbcode/tag_node.rb
@@ -93,6 +150,7 @@ files:
 - test/ruby_bbcode_html_test.rb
 - test/ruby_bbcode_validity_test.rb
 - test/test_helper.rb
+- test/unit/configuration_test.rb
 - test/unit/tag_sifter_test.rb
 - test/unit/tags_test.rb
 homepage: http://github.com/veger/ruby-bbcode
@@ -111,22 +169,22 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: ruby-bbcode-2.0.0
+summary: ruby-bbcode-2.1.1
 test_files:
+- test/unit/tags_test.rb
+- test/unit/tag_sifter_test.rb
+- test/unit/configuration_test.rb
 - test/test_helper.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/tags_test.rb

data/README.textile

@@ -1,56 +0,0 @@
-h1. Ruby-BBCode
-
-!https://badge.fury.io/rb/ruby-bbcode.svg!:http://badge.fury.io/rb/ruby-bbcode !https://travis-ci.org/veger/ruby-bbcode.svg?branch=master!:https://travis-ci.org/veger/ruby-bbcode !https://coveralls.io/repos/veger/ruby-bbcode/badge.svg?branch=master(Coverage Status)!:https://coveralls.io/r/veger/ruby-bbcode?branch=master
-
-This gem adds support for "BBCode":http:/www.bbcode.org/ to Ruby. The BBCode is parsed by a parser before converted to HTML, allowing to convert nested BBCode tags in strings to their correct HTML equivalent. The parser also checks whether the BBCode is valid and gives errors for incorrect BBCode texts.
-Additionally, annotations can be added to the BBCode string the showing errors that are present, assuming there are any errors.
-
-The parser recognizes all "official tags":http://www.bbcode.org/reference.php and allows to easily extend this set with custom tags.
-
-See "changelog":CHANGELOG.md for the (recent) notable changes of this gem.
-
-h2. Examples
-
-<code>bbcode_to_html</code> can be used to convert a BBCode string to HTML:
-
-<pre><code>'This is [b]bold[/b] and this is [i]italic[/i].'.bbcode_to_html
- => 'This is <strong>bold</strong> and this is <em>italic</em>.'</code></pre>
-
-<code>bbcode_show_errors</code> can be used to convert a BBCode to BBCode annotated with errors (assuming the original BBCode did contain errors):
-
-<pre><code>'[img=no_dimensions_here]image.png[/img]'.bbcode_show_errors
- => '<span class=\'bbcode_error\' data-bbcode-errors=\'["The image parameters \'no_dimensions_here\' are incorrect, \'<width>x<height>\' excepted"]\'>[img]</span>image.png[/img]'</code></pre>
-
-These HTML attributes containing the JSON representation of the errors can be used to inform the user about the problems.
-The following JavaScript/jQuery example makes use of the "Bootstrap tooltips plugin":http://getbootstrap.com/javascript/#tooltips to show the errors in tooltip popups:
-<pre><code>$(".bbcode_error").tooltip({
-  title: function() { 
-    var errors = JSON.parse($(this).attr('data-bbcode-errors'));
-    return errors.join("\n");
-  }
-});</code></pre>
-
-h2. Installing
-
-Add the following line to the Gemfile of your application:
-<pre><code>gem 'ruby-bbcode'</code></pre>
-
-Or to use the source code from the repository:
-<pre><code>gem 'ruby-bbcode', :git => 'git://github.com/veger/ruby-bbcode.git'</code></pre>
-
-Run
-<pre><code>bundle install</code></pre>
-
-And Ruby-BBCode is available in your application.
-
-_Note_: Do not forget to restart your server!
-
-h2. Acknowledgements
-
-A big thanks to "TheNotary":https://github.com/TheNotary for all contributions he made to this project!
-
-Some of the ideas and the tests came from "bb-ruby":http://github.com/cpjolicoeur/bb-ruby of Craig P Jolicoeur.
-
-h2. License
-
-MIT License. See the included "MIT-LICENCE":MIT-LICENSE file.