This is great:
+some_code(:first)
+#{html_fragment}
") # <- Wrap your own html fragments to avoid escaping
-```
+yourself.
### 2. How do I customize an allowlist for `SanitizationFilter`s?
-`SanitizationFilter::ALLOWLIST` is the default allowlist used if no `:allowlist`
-argument is given in the context. The default is a good starting template for
+`HTMLPipeline::SanitizationFilter::ALLOWLIST` is the default allowlist used if no `sanitization_config`
+argument is given. The default is a good starting template for
you to add additional elements. You can either modify the constant's value, or
-re-define your own constant and pass that in via the context.
-
-## Contributing
+re-define your own config and pass that in, such as:
-Please review the [Contributing Guide](https://github.com/jch/html-pipeline/blob/master/CONTRIBUTING.md).
-
-1. [Fork it](https://help.github.com/articles/fork-a-repo)
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Added some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new [Pull Request](https://help.github.com/articles/using-pull-requests)
-
-To see what has changed in recent versions, see the [CHANGELOG](https://github.com/jch/html-pipeline/blob/master/CHANGELOG.md).
+```ruby
+config = HTMLPipeline::SanitizerFilter::DEFAULT_CONFIG.dup
+config[:elements] << "iframe" # sure, whatever you want
+```
### Contributors
-Thanks to all of [these contributors](https://github.com/jch/html-pipeline/graphs/contributors).
-
-Project is a member of the [OSS Manifesto](http://ossmanifesto.org/).
-
-The current maintainer is @gjtorikian
-
-### Releasing A New Version
-
-This section is for gem maintainers to cut a new version of the gem.
+Thanks to all of [these contributors](https://github.com/gjtorikian/html-pipeline/graphs/contributors).
-* create a new branch named `release-x.y.z` where `x.y.z` follows [semver](http://semver.org)
-* update lib/html/pipeline/version.rb to next version number X.X.X
-* update CHANGELOG.md. Prepare a draft with `script/changelog`
-* push branch and create a new pull request
-* after tests are green, merge to master
-* on the master branch, run `script/release`
+This project is a member of the [OSS Manifesto](http://ossmanifesto.org/).
diff --git a/Rakefile b/Rakefile
index f26f9adc..a86d00c4 100755
--- a/Rakefile
+++ b/Rakefile
@@ -1,17 +1,24 @@
#!/usr/bin/env rake
# frozen_string_literal: true
-require 'rubygems'
-require 'bundler/setup'
-
-require 'bundler/gem_tasks'
-require 'rake/testtask'
+require "bundler/gem_tasks"
+require "rubygems/package_task"
+require "rake/testtask"
Rake::TestTask.new do |t|
- t.libs << 'test'
- t.test_files = FileList['test/**/*_test.rb']
+ t.libs << "test"
+ t.test_files = FileList["test/**/*_test.rb"]
t.verbose = true
t.warning = false
end
task default: :test
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new(:rubocop)
+
+GEMSPEC = Bundler.load_gemspec("html-pipeline.gemspec")
+gem_path = Gem::PackageTask.new(GEMSPEC).define
+desc "Package the ruby gem"
+task "package" => [gem_path]
diff --git a/UPGRADING.md b/UPGRADING.md
new file mode 100644
index 00000000..f0565678
--- /dev/null
+++ b/UPGRADING.md
@@ -0,0 +1,35 @@
+# Upgrade Guide
+
+## From v2 to v3
+
+HTMLPipeline v3 is a massive improvement over this still much loved (and woefully under-maintained) project. This section will attempt to list all of the breaking changes between the two versions and provide suggestions on how to upgrade.
+
+### Changed namespace
+
+This project is now under a module called `HTMLPipeline`, not `HTML::Pipeline`.
+
+### Removed filters
+
+The following filters were removed:
+
+- `AutolinkFilter`: this is handled by [Commonmarker](https://www.github.com/gjtorikian/commonmarker) and can be disabled/enabled through the `MarkdownFilter`'s `context` hash
+- `SyntaxHighlightFilter`: this is handled by [Commonmarker](https://www.github.com/gjtorikian/commonmarker) and can be disabled/enabled through the `MarkdownFilter`'s `context` hash
+- `SanitizationFilter`: this is handled by [Selma](https://www.github.com/gjtorikian/selma); configuration can be done through the `sanitization_config` hash
+
+- `EmailReplyFilter`
+- `CamoFilter`
+- `TextFilter`
+
+### Changed API
+
+The new way to call this project is as follows:
+
+```ruby
+HTMLPipeline.new(
+ text_filters: [], # array of instantiated (`.new`ed) `HTMLPipeline::TextFilter`
+ convert_filter:, # a filter that runs to turn text into HTML
+ sanitization_config: {}, # an allowlist of elements/attributes/protocols to keep
+ node_filters: []) # array of instantiated (`.new`ed) `HTMLPipeline::NodeFilter`
+```
+
+Please refer to the README for more information on constructing filters. In most cases, the underlying filter needs only a few changes, primarily to make use of [Selma](https://www.github.com/gjtorikian/selma) rather than Nokogiri.
diff --git a/bin/html-pipeline b/bin/html-pipeline
deleted file mode 100755
index f262ac6b..00000000
--- a/bin/html-pipeline
+++ /dev/null
@@ -1,78 +0,0 @@
-#!/usr/bin/env ruby
-require 'html/pipeline'
-
-require 'optparse'
-
-# Accept "help", too
-.map! { |a| a == 'help' ? '--help' : a }
-
-onParser.new do |opts|
- opts.banner = <<-HELP.gsub(/^ /, '')
- Usage: html-pipeline [-h] [-f]
- html-pipeline [FILTER [FILTER [...]]] < file.md
- cat file.md | html-pipeline [FILTER [FILTER [...]]]
- HELP
-
- opts.separator 'Options:'
-
- opts.on('-f', '--filters', 'List the available filters') do
- filters = HTML::Pipeline.constants.grep(/\w+Filter$/)
- .map { |f| f.to_s.gsub(/Filter$/, '') }
-
- # Text filter doesn't work, no call method
- filters -= ['Text']
-
- abort <<-HELP.gsub(/^ /, '')
- Available filters:
- #{filters.join("\n ")}
- HELP
- end
-end.parse!
-
-# Default to a GitHub-ish pipeline
-if ARGV.empty?
-
- filters = [
- HTML::Pipeline::MarkdownFilter,
- HTML::Pipeline::SanitizationFilter,
- HTML::Pipeline::ImageMaxWidthFilter,
- HTML::Pipeline::EmojiFilter,
- HTML::Pipeline::AutolinkFilter,
- HTML::Pipeline::TableOfContentsFilter
- ]
-
- # Add syntax highlighting if rouge is present
- begin
- require 'rouge'
- filters << HTML::Pipeline::SyntaxHighlightFilter
- rescue LoadError
- end
-
-else
-
- def filter_named(name)
- case name
- when 'Text'
- raise NameError # Text filter doesn't work, no call method
- end
-
- HTML::Pipeline.const_get("#{name}Filter")
- rescue NameError => e
- abort "Unknown filter '#{name}'. List filters with the -f option."
- end
-
- filters = []
- until ARGV.empty?
- name = ARGV.shift
- filters << filter_named(name)
- end
-
-end
-
-context = {
- asset_root: '/assets',
- base_url: '/',
- gfm: true
-}
-
-puts HTML::Pipeline.new(filters, context).call(ARGF.read)[:output]
diff --git a/gemfiles/rails_3.gemfile b/gemfiles/rails_3.gemfile
deleted file mode 100644
index d3497431..00000000
--- a/gemfiles/rails_3.gemfile
+++ /dev/null
@@ -1,27 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "rack", "< 2"
-gem "rails", "3.2.22.2"
-
-group :development do
- gem "appraisal"
- gem "bundler"
- gem "rake"
-end
-
-group :test do
- gem "commonmarker", "~> 0.16", require: false
- gem "email_reply_parser", "~> 0.5", require: false
- gem "gemoji", "~> 2.0", require: false
- gem "minitest"
- gem "RedCloth", "~> 4.2.9", require: false
- gem "rinku", "~> 1.7", require: false
- gem "sanitize", "~> 4.6", require: false
- gem "escape_utils", "~> 1.0", require: false
- gem "rouge", "~> 3.1", require: false
- gem "minitest-focus", "~> 1.1"
-end
-
-gemspec path: "../"
diff --git a/gemfiles/rails_4.gemfile b/gemfiles/rails_4.gemfile
deleted file mode 100644
index a00d20ad..00000000
--- a/gemfiles/rails_4.gemfile
+++ /dev/null
@@ -1,27 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "rack", "< 2"
-gem "rails", "~> 4.2.6"
-
-group :development do
- gem "appraisal"
- gem "bundler"
- gem "rake"
-end
-
-group :test do
- gem "commonmarker", "~> 0.16", require: false
- gem "email_reply_parser", "~> 0.5", require: false
- gem "gemoji", "~> 2.0", require: false
- gem "minitest"
- gem "RedCloth", "~> 4.2.9", require: false
- gem "rinku", "~> 1.7", require: false
- gem "sanitize", "~> 4.6", require: false
- gem "escape_utils", "~> 1.0", require: false
- gem "rouge", "~> 3.1", require: false
- gem "minitest-focus", "~> 1.1"
-end
-
-gemspec path: "../"
diff --git a/gemfiles/rails_5.gemfile b/gemfiles/rails_5.gemfile
deleted file mode 100644
index 1f64a4f9..00000000
--- a/gemfiles/rails_5.gemfile
+++ /dev/null
@@ -1,26 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "rails", "~> 5.0.0"
-
-group :development do
- gem "appraisal"
- gem "bundler"
- gem "rake"
-end
-
-group :test do
- gem "commonmarker", "~> 0.16", require: false
- gem "email_reply_parser", "~> 0.5", require: false
- gem "gemoji", "~> 2.0", require: false
- gem "minitest"
- gem "RedCloth", "~> 4.2.9", require: false
- gem "rinku", "~> 1.7", require: false
- gem "sanitize", "~> 4.6", require: false
- gem "escape_utils", "~> 1.0", require: false
- gem "rouge", "~> 3.1", require: false
- gem "minitest-focus", "~> 1.1"
-end
-
-gemspec path: "../"
diff --git a/gemfiles/rails_6.gemfile b/gemfiles/rails_6.gemfile
deleted file mode 100644
index 134e8425..00000000
--- a/gemfiles/rails_6.gemfile
+++ /dev/null
@@ -1,26 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "rails", "~> 6.0.0"
-
-group :development do
- gem "appraisal"
- gem "bundler"
- gem "rake"
-end
-
-group :test do
- gem "commonmarker", "~> 0.16", require: false
- gem "email_reply_parser", "~> 0.5", require: false
- gem "gemoji", "~> 2.0", require: false
- gem "minitest"
- gem "RedCloth", "~> 4.2.9", require: false
- gem "rinku", "~> 1.7", require: false
- gem "sanitize", "~> 4.6", require: false
- gem "escape_utils", "~> 1.0", require: false
- gem "rouge", "~> 3.1", require: false
- gem "minitest-focus", "~> 1.1"
-end
-
-gemspec path: "../"
diff --git a/html-pipeline.gemspec b/html-pipeline.gemspec
index ec88cfe2..1a7fd0ed 100644
--- a/html-pipeline.gemspec
+++ b/html-pipeline.gemspec
@@ -1,29 +1,39 @@
# frozen_string_literal: true
-require File.expand_path('../lib/html/pipeline/version', __FILE__)
+$LOAD_PATH.push(File.expand_path("lib", __dir__))
+require "html_pipeline/version"
Gem::Specification.new do |gem|
- gem.name = 'html-pipeline'
- gem.version = HTML::Pipeline::VERSION
- gem.license = 'MIT'
- gem.authors = ['Ryan Tomayko', 'Jerry Cheung', 'Garen J. Torikian']
- gem.email = ['ryan@github.com', 'jerry@github.com', 'gjtorikian@gmail.com']
- gem.description = 'GitHub HTML processing filters and utilities'
- gem.summary = 'Helpers for processing content through a chain of filters'
- gem.homepage = 'https://github.com/jch/html-pipeline'
+ gem.name = "html-pipeline"
+ gem.version = HTMLPipeline::VERSION
+ gem.license = "MIT"
+ gem.authors = ["Garen J. Torikian"]
+ gem.email = ["gjtorikian@gmail.com"]
+ gem.description = "HTML processing filters and utilities"
+ gem.summary = "Helpers for processing content through a chain of filters"
+ gem.homepage = "https://github.com/gjtorikian/html-pipeline"
- gem.files = `git ls-files -z`.split("\x0").reject { |f| f =~ %r{^(test|gemfiles|script)/} }
- gem.require_paths = ['lib']
+ gem.files = %x(git ls-files -z).split("\x0").reject { |f| f =~ %r{^(test|gemfiles|script)/} }
+ gem.require_paths = ["lib"]
- gem.add_dependency 'activesupport', '>= 2'
- gem.add_dependency 'nokogiri', '>= 1.4'
+ gem.required_ruby_version = "~> 3.1"
+ # https://github.com/rubygems/rubygems/pull/5852#issuecomment-1231118509
+ gem.required_rubygems_version = ">= 3.3.22"
- gem.post_install_message = <#{replacement}
").children.first.children
- end
- replace_without_encoding_fix(replacement)
- end
-
- alias replace_without_encoding_fix replace
- alias replace replace_with_encoding_fix
-
- def swap(replacement)
- replace(replacement)
- self
- end
- end
-end
diff --git a/lib/html/pipeline/@team_mention_filter.rb b/lib/html/pipeline/@team_mention_filter.rb
deleted file mode 100644
index 562ef344..00000000
--- a/lib/html/pipeline/@team_mention_filter.rb
+++ /dev/null
@@ -1,99 +0,0 @@
-# frozen_string_literal: true
-
-require 'set'
-
-module HTML
- class Pipeline
- # HTML filter that replaces @org/team mentions with links. Mentions within
- # , , , '
- assert_equal body, filter(body).to_html
- end
-
- def test_not_replacing_mentions_in_links
- body = '@kneath okay
'
- assert_equal body, filter(body).to_html
- end
-
- def test_entity_encoding_and_whatnot
- body = "@kneath what's up
"
- link = '@kneath'
- assert_equal "#{link} what's up
", filter(body, '/').to_html
- end
-
- def test_html_injection
- body = '@kneath <script>alert(0)</script>
'
- link = '@kneath'
- assert_equal "#{link} <script>alert(0)</script>
",
- filter(body, '/').to_html
- end
-
- def test_links_to_nothing_when_no_info_url_given
- body = 'How do I @mention someone?
'
- assert_equal 'How do I @mention someone?
',
- filter(body, '/').to_html
- end
-
- def test_links_to_more_info_when_info_url_given
- body = 'How do I @mention someone?
'
- link = '@mention'
- assert_equal "How do I #{link} someone?
",
- filter(body, '/', 'https://github.com/blog/821').to_html
- end
-
- def test_base_url_slash
- body = 'Hi, @jch!
'
- link = '@jch'
- assert_equal "Hi, #{link}!
",
- filter(body, '/').to_html
- end
-
- def test_base_url_under_custom_route
- body = 'Hi, @jch!
'
- link = '@jch'
- assert_equal "Hi, #{link}!
",
- filter(body, '/userprofile').to_html
- end
-
- def test_base_url_slash_with_tilde
- body = 'Hi, @jch!
'
- link = '@jch'
- assert_equal "Hi, #{link}!
",
- filter(body, '/~').to_html
- end
-
- MarkdownPipeline =
- HTML::Pipeline.new [
- HTML::Pipeline::MarkdownFilter,
- HTML::Pipeline::MentionFilter
- ]
-
- def mentioned_usernames
- result = {}
- MarkdownPipeline.call(@body, {}, result)
- result[:mentioned_usernames]
- end
-
- def test_matches_usernames_in_body
- @body = '@test how are you?'
- assert_equal %w[test], mentioned_usernames
- end
-
- def test_matches_usernames_with_dashes
- @body = 'hi @some-user'
- assert_equal %w[some-user], mentioned_usernames
- end
-
- def test_matches_usernames_followed_by_a_single_dot
- @body = 'okay @some-user.'
- assert_equal %w[some-user], mentioned_usernames
- end
-
- def test_matches_usernames_followed_by_multiple_dots
- @body = 'okay @some-user...'
- assert_equal %w[some-user], mentioned_usernames
- end
-
- def test_does_not_match_email_addresses
- @body = 'aman@tmm1.net'
- assert_equal [], mentioned_usernames
- end
-
- def test_does_not_match_domain_name_looking_things
- @body = 'we need a @github.com email'
- assert_equal [], mentioned_usernames
- end
-
- def test_does_not_match_organization_team_mentions
- @body = 'we need to @github/enterprise know'
- assert_equal [], mentioned_usernames
- end
-
- def test_matches_colon_suffixed_names
- @body = '@tmm1: what do you think?'
- assert_equal %w[tmm1], mentioned_usernames
- end
-
- def test_matches_list_of_names
- @body = '@defunkt @atmos @kneath'
- assert_equal %w[defunkt atmos kneath], mentioned_usernames
- end
-
- def test_matches_list_of_names_with_commas
- @body = '/cc @defunkt, @atmos, @kneath'
- assert_equal %w[defunkt atmos kneath], mentioned_usernames
- end
-
- def test_matches_inside_brackets
- @body = '(@mislav) and [@rtomayko]'
- assert_equal %w[mislav rtomayko], mentioned_usernames
- end
-
- def test_doesnt_ignore_invalid_users
- @body = '@defunkt @mojombo and @somedude'
- assert_equal %w[defunkt mojombo somedude], mentioned_usernames
- end
-
- def test_returns_distinct_set
- @body = '/cc @defunkt, @atmos, @kneath, @defunkt, @defunkt'
- assert_equal %w[defunkt atmos kneath], mentioned_usernames
- end
-
- def test_does_not_match_inline_code_block_with_multiple_code_blocks
- @body = "something\n\n`/cc @defunkt @atmos @kneath` `/cc @atmos/atmos`"
- assert_equal %w[], mentioned_usernames
- end
-
- def test_mention_at_end_of_parenthetical_sentence
- @body = "(We're talking 'bout @ymendel.)"
- assert_equal %w[ymendel], mentioned_usernames
- end
-
- def test_username_pattern_can_be_customized
- body = '@_abc: test.
'
- doc = Nokogiri::HTML::DocumentFragment.parse(body)
-
- res = filter(doc, '/', nil, /(_[a-z]{3})/)
-
- link = '@_abc'
- assert_equal "#{link}: test.
",
- res.to_html
- end
-
- def test_filter_does_not_create_a_new_object_for_default_username_pattern
- body = '@test'
- doc = Nokogiri::HTML::DocumentFragment.parse(body)
-
- filter(doc.clone, '/', nil)
- pattern_count = HTML::Pipeline::MentionFilter::MentionPatterns.length
- filter(doc.clone, '/', nil)
-
- assert_equal pattern_count, HTML::Pipeline::MentionFilter::MentionPatterns.length
- filter(doc.clone, '/', nil, /test/)
- assert_equal pattern_count + 1, HTML::Pipeline::MentionFilter::MentionPatterns.length
- end
-
- def test_mention_link_filter
- filter = HTML::Pipeline::MentionFilter.new nil
- expected = "@hubot"
- assert_equal expected, filter.mention_link_filter('@hubot')
- end
-end
diff --git a/test/html/pipeline/plain_text_input_filter_test.rb b/test/html/pipeline/plain_text_input_filter_test.rb
deleted file mode 100644
index c5a8c148..00000000
--- a/test/html/pipeline/plain_text_input_filter_test.rb
+++ /dev/null
@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-require 'test_helper'
-
-class HTML::Pipeline::PlainTextInputFilterTest < Minitest::Test
- PlainTextInputFilter = HTML::Pipeline::PlainTextInputFilter
-
- def test_fails_when_given_a_documentfragment
- body = 'heyo
'
- doc = Nokogiri::HTML::DocumentFragment.parse(body)
- assert_raises(TypeError) { PlainTextInputFilter.call(doc, {}) }
- end
-
- def test_wraps_input_in_a_div_element
- doc = PlainTextInputFilter.call('howdy pahtner', {})
- assert_equal 'howdy pahtner', doc.to_s
- end
-
- def test_html_escapes_plain_text_input
- doc = PlainTextInputFilter.call('See: ', {})
- assert_equal 'See: <http://example.org>',
- doc.to_s
- end
-end
diff --git a/test/html/pipeline/require_helper_test.rb b/test/html/pipeline/require_helper_test.rb
deleted file mode 100644
index e4aeafbc..00000000
--- a/test/html/pipeline/require_helper_test.rb
+++ /dev/null
@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-require 'test_helper'
-
-class HTML::Pipeline::RequireHelperTest < Minitest::Test
- def test_works_with_existing
- HTML::Pipeline.require_dependency('rake', 'SomeClass')
- end
-
- def test_raises_mising_dependency_error
- assert_raises HTML::Pipeline::MissingDependencyError do
- HTML::Pipeline.require_dependency('non-existant', 'SomeClass')
- end
- end
-
- def test_raises_error_including_message
- error = assert_raises(HTML::Pipeline::MissingDependencyError) do
- HTML::Pipeline.require_dependency('non-existant', 'SomeClass')
- end
- assert_includes(error.message, "Missing dependency 'non-existant' for SomeClass. See README.md for details.")
- end
-
- def test_raises_error_includes_underlying_message
- error = assert_raises HTML::Pipeline::MissingDependencyError do
- HTML::Pipeline.require_dependency('non-existant', 'SomeClass')
- end
- assert_includes(error.message, 'LoadError: cannot load such file')
- end
-end
diff --git a/test/html/pipeline/sanitization_filter_test.rb b/test/html/pipeline/sanitization_filter_test.rb
deleted file mode 100644
index 52d35ea2..00000000
--- a/test/html/pipeline/sanitization_filter_test.rb
+++ /dev/null
@@ -1,183 +0,0 @@
-# frozen_string_literal: true
-
-require 'test_helper'
-
-class HTML::Pipeline::SanitizationFilterTest < Minitest::Test
- SanitizationFilter = HTML::Pipeline::SanitizationFilter
-
- def test_removing_script_tags
- orig = %(
)
- html = SanitizationFilter.call(orig).to_s
- refute_match /script/, html
- end
-
- def test_removing_style_tags
- orig = %()
- html = SanitizationFilter.call(orig).to_s
- refute_match /style/, html
- end
-
- def test_removing_style_attributes
- orig = %(YO DAWG
)
- html = SanitizationFilter.call(orig).to_s
- refute_match /font-size/, html
- refute_match /style/, html
- end
-
- def test_removing_script_event_handler_attributes
- orig = %(YO DAWG)
- html = SanitizationFilter.call(orig).to_s
- refute_match /javscript/, html
- refute_match /onclick/, html
- end
-
- def test_sanitizes_li_elements_not_contained_in_ul_or_ol
- stuff = "a\nb \nc"
- html = SanitizationFilter.call(stuff).to_s
- assert_equal "a\nb\nc", html
- end
-
- def test_does_not_sanitize_li_elements_contained_in_ul_or_ol
- stuff = "a\n- b
\nc"
- assert_equal stuff, SanitizationFilter.call(stuff).to_s
- end
-
- def test_github_specific_protocols_are_not_removed
- stuff = 'Spill this yo and so on'
- assert_equal stuff, SanitizationFilter.call(stuff).to_s
- end
-
- def test_unknown_schemes_are_removed
- stuff = 'Wat is this'
- html = SanitizationFilter.call(stuff).to_s
- assert_equal 'Wat is this', html
- end
-
- def test_allowlisted_longdesc_schemes_are_allowed
- stuff = '
'
- html = SanitizationFilter.call(stuff).to_s
- assert_equal '', html
- end
-
- def test_weird_longdesc_schemes_are_removed
- stuff = ''
- html = SanitizationFilter.call(stuff).to_s
- assert_equal '', html
- end
-
- def test_standard_schemes_are_removed_if_not_specified_in_anchor_schemes
- stuff = 'No href for you'
- filter = SanitizationFilter.new(stuff, anchor_schemes: [])
- html = filter.call.to_s
- assert_equal 'No href for you', html
- end
-
- def test_custom_anchor_schemes_are_not_removed
- stuff = 'Wat is this'
- filter = SanitizationFilter.new(stuff, anchor_schemes: ['something-weird'])
- html = filter.call.to_s
- assert_equal stuff, html
- end
-
- def test_anchor_schemes_are_merged_with_other_anchor_restrictions
- stuff = 'Wat is this'
- allowlist = {
- elements: ['a'],
- attributes: { 'a' => %w[href ping] },
- protocols: { 'a' => { 'ping' => ['http'] } }
- }
- filter = SanitizationFilter.new(stuff, allowlist: allowlist, anchor_schemes: ['something-weird'])
- html = filter.call.to_s
- assert_equal 'Wat is this', html
- end
-
- def test_uses_anchor_schemes_from_allowlist_when_not_separately_specified
- stuff = 'Wat is this'
- allowlist = {
- elements: ['a'],
- attributes: { 'a' => ['href'] },
- protocols: { 'a' => { 'href' => ['something-weird'] } }
- }
- filter = SanitizationFilter.new(stuff, allowlist: allowlist)
- html = filter.call.to_s
- assert_equal stuff, html
- end
-
- def test_allowlist_contains_default_anchor_schemes
- assert_equal SanitizationFilter::ALLOWLIST[:protocols]['a']['href'], ['http', 'https', 'mailto', 'xmpp', :relative, 'github-windows', 'github-mac', 'irc', 'ircs']
- end
-
- def test_allowlist_from_full_constant
- stuff = 'Wat is this'
- filter = SanitizationFilter.new(stuff, allowlist: SanitizationFilter::FULL)
- html = filter.call.to_s
- assert_equal 'Wat is this', html
- end
-
- def test_exports_default_anchor_schemes
- assert_equal SanitizationFilter::ANCHOR_SCHEMES, ['http', 'https', 'mailto', 'xmpp', :relative, 'github-windows', 'github-mac', 'irc', 'ircs']
- end
-
- def test_script_contents_are_removed
- orig = ''
- assert_equal '', SanitizationFilter.call(orig).to_s
- end
-
- def test_table_rows_and_cells_removed_if_not_in_table
- orig = %(Foo Bar )
- assert_equal 'FooBar', SanitizationFilter.call(orig).to_s
- end
-
- def test_table_sections_removed_if_not_in_table
- orig = %(Foo
-Column 1 Sum 1
)
- assert_equal orig, SanitizationFilter.call(orig).to_s
- end
-
- def test_summary_tag_are_not_removed
- orig = %(Foo )
- assert_equal orig, SanitizationFilter.call(orig).to_s
- end
-
- def test_details_tag_and_open_attribute_are_not_removed
- orig = %(Foo)
- assert_equal orig, SanitizationFilter.call(orig).to_s
- end
-
- def test_nested_details_tag_are_not_removed
- orig = <<-NESTED
-
- Foo
-
- Bar
- Baz
-
- Qux
-
- NESTED
- assert_equal orig, SanitizationFilter.call(orig).to_s
- end
-
- def test_deprecated_whitelist_context
- orig = %()
- context = { whitelist: ['table'] }
-
- assert_equal ['table'], SanitizationFilter.new(orig, context).allowlist
- end
-
- def test_deprecation_warning_whitelist
- orig = %()
- _stdout, stderror = capture_io do
- SanitizationFilter.new(orig).whitelist
- end
- assert_match "[DEPRECATION] 'whitelist' is deprecated. Please use 'allowlist' instead.", stderror
- end
-end
diff --git a/test/html/pipeline/syntax_highlight_filter_test.rb b/test/html/pipeline/syntax_highlight_filter_test.rb
deleted file mode 100644
index 9d4a50a8..00000000
--- a/test/html/pipeline/syntax_highlight_filter_test.rb
+++ /dev/null
@@ -1,65 +0,0 @@
-# frozen_string_literal: true
-
-require 'test_helper'
-require 'escape_utils'
-
-SyntaxHighlightFilter = HTML::Pipeline::SyntaxHighlightFilter
-
-class HTML::Pipeline::SyntaxHighlightFilterTest < Minitest::Test
- def test_highlight_default
- filter = SyntaxHighlightFilter.new \
- 'hello
', highlight: 'coffeescript'
-
- doc = filter.call
- assert !doc.css('.highlight').empty?
- assert !doc.css('.highlight-coffeescript').empty?
- end
-
- def test_highlight_default_will_not_override
- filter = SyntaxHighlightFilter.new \
- "hello
", highlight: 'coffeescript'
-
- doc = filter.call
- assert doc.css('.highlight-coffeescript').empty?
- assert !doc.css('.highlight-c').empty?
- end
-
- def test_highlight_does_not_remove_pre_tag
- filter = SyntaxHighlightFilter.new \
- "hello
", highlight: 'coffeescript'
-
- doc = filter.call
-
- assert !doc.css('pre').empty?
- end
-
- def test_highlight_allows_optional_scope
- filter = SyntaxHighlightFilter.new \
- "hello
", highlight: 'coffeescript', scope: 'test-scope'
-
- doc = filter.call
-
- assert !doc.css('pre.test-scope').empty?
- end
-
- def test_highlight_keeps_the_pre_tags_lang
- filter = SyntaxHighlightFilter.new \
- "hello
", highlight: 'coffeescript'
-
- doc = filter.call
-
- assert !doc.css('pre[lang=c]').empty?
- end
-
- def test_highlight_handles_nested_pre_tags
- inner_code = "console.log('i am nested!')"
- escaped = CGI.escape_html(inner_code)
- html = "#{escaped}"
- filter = SyntaxHighlightFilter.new html, highlight: 'html'
-
- doc = filter.call
-
- assert_equal 2, doc.css('span[class=nt]').length
- assert_equal CGI.unescape_html(escaped), doc.inner_text
- end
-end
diff --git a/test/html/pipeline/team_mention_filter_test.rb b/test/html/pipeline/team_mention_filter_test.rb
deleted file mode 100644
index 127c2c19..00000000
--- a/test/html/pipeline/team_mention_filter_test.rb
+++ /dev/null
@@ -1,202 +0,0 @@
-# frozen_string_literal: true
-
-require 'test_helper'
-
-class HTML::Pipeline::TeamMentionFilterTest < Minitest::Test
- def filter(html, base_url = '/', team_pattern = nil)
- HTML::Pipeline::TeamMentionFilter.call(html, base_url: base_url, team_pattern: team_pattern)
- end
-
- def test_filtering_plain_text
- body = '@github/team: check it out.
'
- res = filter(body, '/')
-
- link = '@github/team'
- assert_equal "#{link}: check it out.
",
- res.to_html
- end
-
- def test_filtering_a_documentfragment
- body = '@github/team: check it out.
'
- doc = Nokogiri::HTML::DocumentFragment.parse(body)
-
- res = filter(doc, '/')
- assert_same doc, res
-
- link = '@github/team'
- assert_equal "#{link}: check it out.
",
- res.to_html
- end
-
- def test_not_replacing_mentions_in_pre_tags
- body = '@github/team: okay
'
- assert_equal body, filter(body).to_html
- end
-
- def test_not_replacing_mentions_in_code_tags
- body = '@github/team: okay
'
- assert_equal body, filter(body).to_html
- end
-
- def test_not_replacing_mentions_in_style_tags
- body = ''
- assert_equal body, filter(body).to_html
- end
-
- def test_not_replacing_mentions_in_links
- body = '@github/team okay
'
- assert_equal body, filter(body).to_html
- end
-
- def test_entity_encoding_and_whatnot
- body = "@github/team what's up
"
- link = '@github/team'
- assert_equal "#{link} what's up
", filter(body, '/').to_html
- end
-
- def test_html_injection
- body = '@github/team <script>alert(0)</script>
'
- link = '@github/team'
- assert_equal "#{link} <script>alert(0)</script>
",
- filter(body, '/').to_html
- end
-
- def test_links_to_nothing_with_user_mention
- body = 'Hi, @kneath
'
- assert_equal 'Hi, @kneath
',
- filter(body, '/').to_html
- end
-
- def test_base_url_slash
- body = 'Hi, @github/team!
'
- link = '@github/team'
- assert_equal "Hi, #{link}!
",
- filter(body, '/').to_html
- end
-
- def test_base_url_under_custom_route
- body = 'Hi, @org/team!
'
- link = '@org/team'
- assert_equal "Hi, #{link}!
",
- filter(body, 'www.github.com').to_html
- end
-
- def test_base_url_slash_with_tilde
- body = 'Hi, @github/team!
'
- link = '@github/team'
- assert_equal "Hi, #{link}!
",
- filter(body, '/~').to_html
- end
-
- def test_multiple_team_mentions
- body = 'Hi, @github/whale and @github/donut!
'
- link_whale = '@github/whale'
- link_donut = '@github/donut'
- assert_equal "Hi, #{link_whale} and #{link_donut}!
",
- filter(body).to_html
- end
-
- MarkdownPipeline =
- HTML::Pipeline.new [
- HTML::Pipeline::MarkdownFilter,
- HTML::Pipeline::TeamMentionFilter
- ]
-
- def mentioned_teams
- result = {}
- MarkdownPipeline.call(@body, {}, result)
- result[:mentioned_teams]
- end
-
- def test_matches_teams_in_body
- @body = '@test/team how are you?'
- assert_equal %w[team], mentioned_teams
- end
-
- def test_matches_orgs_with_dashes
- @body = 'hi @some-org/team'
- assert_equal %w[team], mentioned_teams
- end
-
- def test_matches_teams_with_dashes
- @body = 'hi @github/some-team'
- assert_equal %w[some-team], mentioned_teams
- end
-
- def test_matches_teams_followed_by_a_single_dot
- @body = 'okay @github/team.'
- assert_equal %w[team], mentioned_teams
- end
-
- def test_matches_teams_followed_by_multiple_dots
- @body = 'okay @github/team...'
- assert_equal %w[team], mentioned_teams
- end
-
- def test_does_not_match_email_addresses
- @body = 'aman@tmm1.net'
- assert_equal [], mentioned_teams
- end
-
- def test_does_not_match_domain_name_looking_things
- @body = 'we need a @github.com email'
- assert_equal [], mentioned_teams
- end
-
- def test_does_not_match_user_mentions
- @body = 'we need to @enterprise know'
- assert_equal [], mentioned_teams
- end
-
- def test_matches_colon_suffixed_team_names
- @body = '@github/team: what do you think?'
- assert_equal %w[team], mentioned_teams
- end
-
- def test_matches_list_of_teams
- @body = '@github/whale @github/donut @github/green'
- assert_equal %w[whale donut green], mentioned_teams
- end
-
- def test_matches_list_of_teams_with_commas
- @body = '/cc @github/whale, @github/donut, @github/green'
- assert_equal %w[whale donut green], mentioned_teams
- end
-
- def test_matches_inside_brackets
- @body = '(@github/whale) and [@github/donut]'
- assert_equal %w[whale donut], mentioned_teams
- end
-
- def test_returns_distinct_set
- @body = '/cc @github/whale, @github/donut, @github/whale, @github/whale'
- assert_equal %w[whale donut], mentioned_teams
- end
-
- def test_does_not_match_inline_code_block_with_multiple_code_blocks
- @body = "something\n\n`/cc @github/whale @github/donut @github/green` `/cc @donut/donut`"
- assert_equal %w[], mentioned_teams
- end
-
- def test_mention_at_end_of_parenthetical_sentence
- @body = "(We're talking 'bout @some-org/some-team.)"
- assert_equal %w[some-team], mentioned_teams
- end
-
- def test_team_pattern_can_be_customized
- body = '@_abc/XYZ: test
'
- doc = Nokogiri::HTML::DocumentFragment.parse(body)
-
- res = filter(doc, '/', /@(_[a-z]{3})\/([A-Z]{3})/)
-
- link = '@_abc/XYZ'
- assert_equal "#{link}: test
",
- res.to_html
- end
-
- def test_mention_link_filter
- filter = HTML::Pipeline::TeamMentionFilter.new nil
- expected = "@bot/hubot"
- assert_equal expected, filter.mention_link_filter('@bot/hubot')
- end
-end
diff --git a/test/html/pipeline/toc_filter_test.rb b/test/html/pipeline/toc_filter_test.rb
deleted file mode 100644
index b79ea238..00000000
--- a/test/html/pipeline/toc_filter_test.rb
+++ /dev/null
@@ -1,141 +0,0 @@
-# frozen_string_literal: true
-
-require 'test_helper'
-
-class HTML::Pipeline::TableOfContentsFilterTest < Minitest::Test
- TocFilter = HTML::Pipeline::TableOfContentsFilter
-
- TocPipeline =
- HTML::Pipeline.new [
- HTML::Pipeline::TableOfContentsFilter
- ]
-
- def toc
- result = {}
- TocPipeline.call(@orig, {}, result)
- result[:toc]
- end
-
- def test_anchors_are_added_properly
- orig = %(Ice cube
Will swarm on any motherfucker in a blue uniform
)
- assert_includes TocFilter.call(orig).to_s, 'github.com),
+ HttpsFilter.call(%(github.com), context: @options))
+ end
+
+ def test_https
+ assert_equal(%(github.com),
+ HttpsFilter.call(%(github.com), context: @options))
+ end
+
+ def test_subdomain
+ assert_equal(%(github.com),
+ HttpsFilter.call(%(github.com), context: @options))
+ end
+
+ def test_other
+ assert_equal(%(github.io),
+ HttpsFilter.call(%(github.io), context: @options))
+ end
+ end
+end
diff --git a/test/html_pipeline/node_filter/image_max_width_filter_test.rb b/test/html_pipeline/node_filter/image_max_width_filter_test.rb
new file mode 100644
index 00000000..df7f4f9d
--- /dev/null
+++ b/test/html_pipeline/node_filter/image_max_width_filter_test.rb
@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+class HTMLPipeline
+ class ImageMaxWidthFilterTest < Minitest::Test
+ def setup
+ @filter = HTMLPipeline::NodeFilter::ImageMaxWidthFilter
+ end
+
+ def test_rewrites_image_style_tags
+ body = 'Screenshot: 
'
+ res = @filter.call(body)
+
+ assert_equal('Screenshot:
',
+ res)
+ end
+
+ def test_leaves_existing_image_style_tags_alone
+ body = '
'
+
+ res = @filter.call(body)
+
+ assert_equal('
',
+ res)
+ end
+
+ def test_links_to_image
+ body = 'Screenshot:
'
+
+ res = @filter.call(body)
+
+ assert_equal('Screenshot:
',
+ res)
+ end
+
+ def test_doesnt_link_to_image_when_already_linked
+ body = 'Screenshot:
'
+
+ res = @filter.call(body)
+
+ assert_equal('Screenshot:
',
+ res)
+ end
+
+ def test_doesnt_screw_up_inlined_images
+ body = 'Screenshot , yes, this is a screenshot indeed.
'
+
+ res = @filter.call(body)
+
+ assert_equal('Screenshot , yes, this is a screenshot indeed.
', res)
+ end
+ end
+end
diff --git a/test/html_pipeline/node_filter/mention_filter_test.rb b/test/html_pipeline/node_filter/mention_filter_test.rb
new file mode 100644
index 00000000..bcd9b2d1
--- /dev/null
+++ b/test/html_pipeline/node_filter/mention_filter_test.rb
@@ -0,0 +1,219 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+class HTMLPipeline
+ class MentionFilterTest < Minitest::Test
+ def setup
+ @filter = HTMLPipeline::NodeFilter::MentionFilter
+ @context = { base_url: "/", info_url: nil, username_pattern: nil }
+
+ @pipeline = HTMLPipeline.new(convert_filter:
+ HTMLPipeline::ConvertFilter::MarkdownFilter.new,
+ node_filters: [
+ HTMLPipeline::NodeFilter::MentionFilter.new,
+ ])
+ end
+
+ def mentioned_usernames(body)
+ result = {}
+ result = @pipeline.call(body, result: result)
+ result[:mentioned_usernames]
+ end
+ @pipeline =
+ def test_filtering_plain_text
+ body = "@kneath: check it out.
"
+ res = @filter.call(body, context: @context)
+
+ link = '@kneath'
+
+ assert_equal("#{link}: check it out.
",
+ res)
+ end
+
+ def test_not_replacing_mentions_in_pre_tags
+ body = "@kneath: okay
"
+
+ assert_equal(body, @filter.call(body, context: @context))
+ end
+
+ def test_not_replacing_mentions_in_code_tags
+ body = "@kneath: okay
"
+
+ assert_equal(body, @filter.call(body, context: @context))
+ end
+
+ def test_not_replacing_mentions_in_style_tags
+ body = ""
+
+ assert_equal(body, @filter.call(body, context: @context))
+ end
+
+ def test_not_replacing_mentions_in_links
+ body = "@kneath okay
"
+
+ assert_equal(body, @filter.call(body, context: @context))
+ end
+
+ def test_entity_encoding_and_whatnot
+ body = "@kneath what's up
"
+
+ assert_equal(body, @filter.call(body, context: @context))
+ end
+
+ def test_html_injection
+ body = "@kneath <script>alert(0)</script>
"
+ link = '@kneath'
+
+ assert_equal("#{link} <script>alert(0)</script>
",
+ @filter.call(body, context: @context))
+ end
+
+ def test_base_url_slash
+ body = "Hi, @jch!
"
+ link = '@jch'
+
+ assert_equal("Hi, #{link}!
",
+ @filter.call(body, context: { base_url: "/" }))
+ end
+
+ def test_base_url_under_custom_route
+ body = "Hi, @jch!
"
+ link = '@jch'
+
+ assert_equal("Hi, #{link}!
",
+ @filter.call(body, context: @context.merge({ base_url: "/userprofile" })))
+ end
+
+ def test_base_url_slash_with_tilde
+ body = "Hi, @jch!
"
+ link = '@jch'
+
+ assert_equal("Hi, #{link}!
",
+ @filter.call(body, context: @context.merge({ base_url: "/~" })))
+ end
+
+ def test_matches_usernames_in_body
+ body = "@test how are you?"
+
+ assert_equal(["test"], mentioned_usernames(body))
+ end
+
+ def test_matches_usernames_with_dashes
+ body = "hi @some-user"
+
+ assert_equal(["some-user"], mentioned_usernames(body))
+ end
+
+ def test_matches_usernames_followed_by_a_single_dot
+ body = "okay @some-user."
+
+ assert_equal(["some-user"], mentioned_usernames(body))
+ end
+
+ def test_matches_usernames_followed_by_multiple_dots
+ body = "okay @some-user..."
+
+ assert_equal(["some-user"], mentioned_usernames(body))
+ end
+
+ def test_does_not_match_email_addresses
+ body = "aman@tmm1.net"
+
+ assert_empty(mentioned_usernames(body))
+ end
+
+ def test_does_not_match_domain_name_looking_things
+ body = "we need a @github.com email"
+
+ assert_empty(mentioned_usernames(body))
+ end
+
+ def test_does_not_match_organization_team_mentions
+ body = "we need to @github/enterprise know"
+
+ assert_empty(mentioned_usernames(body))
+ end
+
+ def test_matches_colon_suffixed_names
+ body = "@tmm1: what do you think?"
+
+ assert_equal(["tmm1"], mentioned_usernames(body))
+ end
+
+ def test_matches_list_of_names
+ body = "@defunkt @atmos @kneath"
+
+ assert_equal(["defunkt", "atmos", "kneath"], mentioned_usernames(body))
+ end
+
+ def test_matches_list_of_names_with_commas
+ body = "/cc @defunkt, @atmos, @kneath"
+
+ assert_equal(["defunkt", "atmos", "kneath"], mentioned_usernames(body))
+ end
+
+ def test_matches_inside_brackets
+ body = "(@mislav) and [@rtomayko]"
+
+ assert_equal(["mislav", "rtomayko"], mentioned_usernames(body))
+ end
+
+ def test_doesnt_ignore_invalid_users
+ body = "@defunkt @mojombo and @somedude"
+
+ assert_equal(["defunkt", "mojombo", "somedude"], mentioned_usernames(body))
+ end
+
+ def test_returns_distinct_set
+ body = "/cc @defunkt, @atmos, @kneath, @defunkt, @defunkt"
+
+ assert_equal(["defunkt", "atmos", "kneath"], mentioned_usernames(body))
+ end
+
+ def test_does_not_match_inline_code_block_with_multiple_code_blocks
+ body = "something\n\n`/cc @defunkt @atmos @kneath` `/cc @atmos/atmos`"
+
+ assert_empty(mentioned_usernames(body))
+ end
+
+ def test_mention_at_end_of_parenthetical_sentence
+ body = "(We're talking 'bout @ymendel.)"
+
+ assert_equal(["ymendel"], mentioned_usernames(body))
+ end
+
+ def test_username_pattern_can_be_customized
+ body = "@_abc: test.
"
+
+ res = @filter.call(body, context: { base_url: "/", username_pattern: /(_[a-z]{3})/ })
+
+ link = '@_abc'
+
+ assert_equal("#{link}: test.
",
+ res)
+ end
+
+ def test_filter_does_not_create_a_new_object_for_default_username_pattern
+ body = "@test"
+
+ @filter.call(body.dup)
+ pattern_count = HTMLPipeline::NodeFilter::MentionFilter::MENTION_PATTERNS.length
+
+ @filter.call(body.dup)
+
+ assert_equal(pattern_count, HTMLPipeline::NodeFilter::MentionFilter::MENTION_PATTERNS.length)
+
+ @filter.call(body.clone, context: { username_pattern: /test/ })
+
+ assert_equal(pattern_count + 1, HTMLPipeline::NodeFilter::MentionFilter::MENTION_PATTERNS.length)
+ end
+
+ def test_mention_link_filter
+ result = HTMLPipeline::NodeFilter::MentionFilter.call("@hubot
")
+ expected = ''
+
+ assert_equal(expected, result)
+ end
+ end
+end
diff --git a/test/html_pipeline/node_filter/syntax_highlight_filter_test.rb b/test/html_pipeline/node_filter/syntax_highlight_filter_test.rb
new file mode 100644
index 00000000..a2b47e0b
--- /dev/null
+++ b/test/html_pipeline/node_filter/syntax_highlight_filter_test.rb
@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+SyntaxHighlightFilter = HTMLPipeline::NodeFilter::SyntaxHighlightFilter
+
+class HTMLPipeline
+ class SyntaxHighlightFilterTest < Minitest::Test
+ def test_highlight_default
+ result = SyntaxHighlightFilter.call(\
+ "hello
", context: { highlight: "coffeescript" }
+ )
+
+ doc = Nokogiri.parse(result)
+
+ refute_empty(doc.css(".highlight"))
+ refute_empty(doc.css(".highlight-coffeescript"))
+ end
+
+ def test_highlight_default_will_not_override
+ result = SyntaxHighlightFilter.call(\
+ "hello
", context: { highlight: "coffeescript" }
+ )
+
+ doc = Nokogiri.parse(result)
+
+ assert_empty(doc.css(".highlight-coffeescript"))
+ refute_empty(doc.css(".highlight-c"))
+ end
+
+ def test_highlight_does_not_remove_pre_tag
+ result = SyntaxHighlightFilter.call(\
+ "hello
", context: { highlight: "coffeescript" }
+ )
+
+ doc = Nokogiri.parse(result)
+
+ refute_empty(doc.css("pre"))
+ end
+
+ def test_highlight_allows_optional_scope
+ result = SyntaxHighlightFilter.call(\
+ "hello
", context: { highlight: "coffeescript", scope: "test-scope" }
+ )
+
+ doc = Nokogiri.parse(result)
+
+ refute_empty(doc.css("pre.test-scope"))
+ end
+
+ def test_highlight_keeps_the_pre_tags_lang
+ result = SyntaxHighlightFilter.call(\
+ "hello
", context: { highlight: "coffeescript" }
+ )
+
+ doc = Nokogiri.parse(result)
+
+ refute_empty(doc.css("pre[lang=c]"))
+ end
+ end
+end
diff --git a/test/html_pipeline/node_filter/table_of_contents_filter_test.rb b/test/html_pipeline/node_filter/table_of_contents_filter_test.rb
new file mode 100644
index 00000000..33b62889
--- /dev/null
+++ b/test/html_pipeline/node_filter/table_of_contents_filter_test.rb
@@ -0,0 +1,186 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+class HTMLPipeline
+ class NodeFilter
+ class TableOfContentsFilterTest < Minitest::Test
+ TocFilter = HTMLPipeline::NodeFilter::TableOfContentsFilter
+
+ TocPipeline =
+ HTMLPipeline.new(convert_filter: HTMLPipeline::ConvertFilter::MarkdownFilter.new, node_filters: [
+ TocFilter.new,
+ ])
+
+ def toc_s(content)
+ result = TocPipeline.call(content, context: {}, result: result)
+ result[:toc].to_s
+ end
+
+ def test_anchors_and_list_are_added_properly
+ orig = %(# Ice cube\n\nWill swarm on any motherfucker in a blue uniform)
+ result = TocPipeline.call(orig)
+
+ assert_includes(result[:output], "Ice cube)
+ pipeline = HTMLPipeline.new(convert_filter: HTMLPipeline::ConvertFilter::MarkdownFilter, node_filters: [
+ TocFilter.new(context: { anchor_html: "#" }),
+ ])
+ result = pipeline.call(orig)
+
+ assert_equal(expected, result[:output])
+ end
+
+ def test_toc_list_added_properly
+ orig = %(# Ice cube\n\nWill swarm on any motherfucker in a blue uniform)
+ result = TocPipeline.call(orig)
+
+ assert_equal({ href: "#ice-cube", text: "Ice cube" }, result[:toc].first)
+ end
+
+ def test_anchors_have_sane_names
+ orig = %(# Dr. Dre\n\n# Ice Cube\n\n# Eazy-E\n\n# MC Ren)
+
+ result = TocPipeline.call(orig)[:output]
+
+ assert_includes(result, '"dr-dre"')
+ assert_includes(result, '"ice-cube"')
+ assert_includes(result, '"eazy-e"')
+ assert_includes(result, '"mc-ren"')
+ end
+
+ def test_anchors_have_aria_hidden
+ orig = "# Straight Outta Compton"
+ result = TocPipeline.call(orig)[:output]
+
+ assert_includes(result, 'aria-hidden="true"')
+ end
+
+ def test_toc_hrefs_have_sane_values
+ orig = %(# Dr. Dre\n\n# Ice Cube\n\n# Eazy-E\n\n# MC Ren)
+ result = TocPipeline.call(orig)[:output]
+
+ assert_includes(result, '"#dr-dre"')
+ assert_includes(result, '"#ice-cube"')
+ assert_includes(result, '"#eazy-e"')
+ assert_includes(result, '"#mc-ren"')
+ end
+
+ def test_dupe_headers_have_unique_trailing_identifiers
+ orig = <<~STR
+ # Straight Outta Compton
+
+ ## Dopeman
+
+ ### Express Yourself
+
+ # Dopeman
+ STR
+
+ result = TocPipeline.call(orig)[:output]
+
+ assert_includes(result, '"dopeman"')
+ assert_includes(result, '"dopeman-1"')
+ end
+
+ def test_dupe_headers_have_unique_toc_anchors
+ orig = <<~STR
+ # Straight Outta Compton
+
+ ## Dopeman
+
+ ### Express Yourself
+
+ # Dopeman
+ STR
+
+ assert_includes(toc_s(orig), '"#dopeman"')
+ assert_includes(toc_s(orig), '"#dopeman-1"')
+ end
+
+ def test_all_header_tags_are_found_when_adding_anchors
+ orig = <<~STR
+ # "Funky President" by James Brown
+ ## "It's My Thing" by Marva Whitney
+ ### "Boogie Back" by Roy Ayers
+ #### "Feel Good" by Fancy
+ ##### "Funky Drummer" by James Brown
+ ###### "Ruthless Villain" by Eazy-E
+ STR
+
+ result = TocPipeline.call(orig, context: {}, result: result)
+
+ doc = Nokogiri::HTML(result[:output])
+
+ assert_equal(6, doc.search("a").size)
+ end
+
+ def test_toc_outputs_escaped_html
+ orig = %(# <img src="x" onerror="alert(42)">)
+
+ refute_includes(toc_s(orig), %(
))
+ end
+
+ def test_toc_is_complete
+ orig = <<~STR
+ # "Funky President" by James Brown
+ ## "It's My Thing" by Marva Whitney
+ ### "Boogie Back" by Roy Ayers
+ #### "Feel Good" by Fancy
+ ##### "Funky Drummer" by James Brown
+ ###### "Ruthless Villain" by Eazy-E
+ STR
+
+ result = TocPipeline.call(orig)[:toc]
+ expected = [{ href: "#funky-president-by-james-brown", text: ""Funky President" by James Brown" },
+ { href: "#its-my-thing-by-marva-whitney", text: ""It's My Thing" by Marva Whitney" },
+ { href: "#boogie-back-by-roy-ayers", text: ""Boogie Back" by Roy Ayers" },
+ { href: "#feel-good-by-fancy", text: ""Feel Good" by Fancy" },
+ { href: "#funky-drummer-by-james-brown", text: ""Funky Drummer" by James Brown" },
+ { href: "#ruthless-villain-by-eazy-e", text: ""Ruthless Villain" by Eazy-E" },]
+
+ 0..6.times do |i|
+ assert_equal(expected[i], result[i])
+ end
+ end
+
+ def test_anchors_with_utf8_characters
+ orig = <<~STR
+ # 日本語
+
+ # Русский
+ STR
+
+ rendered_h1s = Nokogiri::HTML(TocPipeline.call(orig)[:output]).search("h1").map(&:to_s)
+
+ assert_equal("\n日本語
",
+ rendered_h1s[0])
+ assert_equal("\nРусский
",
+ rendered_h1s[1])
+ end
+
+ def test_toc_with_utf8_characters
+ orig = <<~STR
+ # 日本語
+
+ # Русский
+ STR
+
+ result = TocPipeline.call(orig)[:toc]
+
+ expected = [{ href: "#%E6%97%A5%E6%9C%AC%E8%AA%9E",
+ text: "日本語", },
+ { href: "#%D1%80%D1%83%D1%81%D1%81%D0%BA%D0%B8%D0%B9",
+ text: "Русский", },]
+
+ 0..2.times do |i|
+ assert_equal(expected[i], result[i])
+ end
+ end
+ end
+ end
+end
diff --git a/test/html_pipeline/node_filter/team_mention_filter_test.rb b/test/html_pipeline/node_filter/team_mention_filter_test.rb
new file mode 100644
index 00000000..4c93dbab
--- /dev/null
+++ b/test/html_pipeline/node_filter/team_mention_filter_test.rb
@@ -0,0 +1,220 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+class HTMLPipeline
+ class TeamMentionFilterTest < Minitest::Test
+ def setup
+ @filter = HTMLPipeline::NodeFilter::TeamMentionFilter
+
+ @pipeline =
+ HTMLPipeline.new(convert_filter: HTMLPipeline::ConvertFilter::MarkdownFilter.new,
+ node_filters: [
+ HTMLPipeline::NodeFilter::TeamMentionFilter.new,
+ ])
+ end
+
+ def mentioned_teams(body)
+ result = {}
+ result = @pipeline.call(body, result: result)
+ result[:mentioned_teams]
+ end
+
+ def test_filtering_plain_text
+ body = "@github/team: check it out.
"
+ res = @filter.call(body, context: { base_url: "/" })
+
+ link = '@github/team'
+
+ assert_equal("#{link}: check it out.
",
+ res)
+ end
+
+ def test_not_replacing_mentions_in_pre_tags
+ body = "@github/team: okay
"
+
+ assert_equal(body, @filter.call(body))
+ end
+
+ def test_not_replacing_mentions_in_code_tags
+ body = "@github/team: okay
"
+
+ assert_equal(body, @filter.call(body))
+ end
+
+ def test_not_replacing_mentions_in_style_tags
+ body = ""
+
+ assert_equal(body, @filter.call(body))
+ end
+
+ def test_not_replacing_mentions_in_links
+ body = "@github/team okay
"
+
+ assert_equal(body, @filter.call(body))
+ end
+
+ def test_entity_encoding_and_whatnot
+ body = "@github/team what's up
"
+ link = '@github/team'
+
+ assert_equal("#{link} what's up
", @filter.call(body, context: { base_url: "/" }))
+ end
+
+ def test_html_injection
+ body = "@github/team <script>alert(0)</script>
"
+ link = '@github/team'
+
+ assert_equal("#{link} <script>alert(0)</script>
",
+ @filter.call(body, context: { base_url: "/" }))
+ end
+
+ def test_links_to_nothing_with_user_mention
+ body = "Hi, @kneath
"
+
+ assert_equal("Hi, @kneath
",
+ @filter.call(body, context: { base_url: "/" }))
+ end
+
+ def test_base_url_slash
+ body = "Hi, @github/team!
"
+ link = '@github/team'
+
+ assert_equal("Hi, #{link}!
",
+ @filter.call(body, context: { base_url: "/" }))
+ end
+
+ def test_base_url_under_custom_route
+ body = "Hi, @org/team!
"
+ link = '@org/team'
+
+ assert_equal("Hi, #{link}!
",
+ @filter.call(body, context: { base_url: "www.github.com" }))
+ end
+
+ def test_base_url_slash_with_tilde
+ body = "Hi, @github/team!
"
+ link = '@github/team'
+
+ assert_equal("Hi, #{link}!
",
+ @filter.call(body, context: { base_url: "/~" }))
+ end
+
+ def test_multiple_team_mentions
+ body = "Hi, @github/whale and @github/donut!
"
+ link_whale = '@github/whale'
+ link_donut = '@github/donut'
+
+ assert_equal("Hi, #{link_whale} and #{link_donut}!
",
+ @filter.call(body))
+ end
+
+ def test_matches_teams_in_body
+ body = "@test/team how are you?"
+
+ assert_equal(["team"], mentioned_teams(body))
+ end
+
+ def test_matches_orgs_with_dashes
+ body = "hi @some-org/team"
+
+ assert_equal(["team"], mentioned_teams(body))
+ end
+
+ def test_matches_teams_with_dashes
+ body = "hi @github/some-team"
+
+ assert_equal(["some-team"], mentioned_teams(body))
+ end
+
+ def test_matches_teams_followed_by_a_single_dot
+ body = "okay @github/team."
+
+ assert_equal(["team"], mentioned_teams(body))
+ end
+
+ def test_matches_teams_followed_by_multiple_dots
+ body = "okay @github/team..."
+
+ assert_equal(["team"], mentioned_teams(body))
+ end
+
+ def test_does_not_match_email_addresses
+ body = "aman@tmm1.net"
+
+ assert_empty(mentioned_teams(body))
+ end
+
+ def test_does_not_match_domain_name_looking_things
+ body = "we need a @github.com email"
+
+ assert_empty(mentioned_teams(body))
+ end
+
+ def test_does_not_match_user_mentions
+ body = "we need to @enterprise know"
+
+ assert_empty(mentioned_teams(body))
+ end
+
+ def test_matches_colon_suffixed_team_names
+ body = "@github/team: what do you think?"
+
+ assert_equal(["team"], mentioned_teams(body))
+ end
+
+ def test_matches_list_of_teams
+ body = "@github/whale @github/donut @github/green"
+
+ assert_equal(["whale", "donut", "green"], mentioned_teams(body))
+ end
+
+ def test_matches_list_of_teams_with_commas
+ body = "/cc @github/whale, @github/donut, @github/green"
+
+ assert_equal(["whale", "donut", "green"], mentioned_teams(body))
+ end
+
+ def test_matches_inside_brackets
+ body = "(@github/whale) and [@github/donut]"
+
+ assert_equal(["whale", "donut"], mentioned_teams(body))
+ end
+
+ def test_returns_distinct_set
+ body = "/cc @github/whale, @github/donut, @github/whale, @github/whale"
+
+ assert_equal(["whale", "donut"], mentioned_teams(body))
+ end
+
+ def test_does_not_match_inline_code_block_with_multiple_code_blocks
+ body = "something\n\n`/cc @github/whale @github/donut @github/green` `/cc @donut/donut`"
+
+ assert_empty(mentioned_teams(body))
+ end
+
+ def test_mention_at_end_of_parenthetical_sentence
+ body = "(We're talking 'bout @some-org/some-team.)"
+
+ assert_equal(["some-team"], mentioned_teams(body))
+ end
+
+ def test_team_pattern_can_be_customized
+ body = "@_abc/XYZ: test
"
+
+ res = @filter.call(body, context: { team_pattern: %r{@(_[a-z]{3})/([A-Z]{3})} })
+
+ link = '@_abc/XYZ'
+
+ assert_equal("#{link}: test
",
+ res)
+ end
+
+ def test_mention_link_filter
+ result = HTMLPipeline::NodeFilter::TeamMentionFilter.call("@bot/hubot
")
+ expected = ""
+
+ assert_equal(expected, result)
+ end
+ end
+end
diff --git a/test/html_pipeline/require_helper_test.rb b/test/html_pipeline/require_helper_test.rb
new file mode 100644
index 00000000..3c1baeb4
--- /dev/null
+++ b/test/html_pipeline/require_helper_test.rb
@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+class HTMLPipeline
+ class RequireHelperTest < Minitest::Test
+ def test_works_with_existing_dependency
+ HTMLPipeline.require_dependency("rake", "SomeClass")
+ end
+
+ def test_works_with_existing_dependencies
+ HTMLPipeline.require_dependencies(["old_sql", "nokogiri"], "SomeClass")
+
+ assert_predicate(HTMLPipeline, :nokogiri_loaded?)
+ refute_predicate(HTMLPipeline, :old_sql_loaded?)
+ end
+
+ def test_raises_mising_dependency_error
+ assert_raises(HTMLPipeline::MissingDependencyError) do
+ HTMLPipeline.require_dependency("non-existant", "SomeClass")
+ end
+ end
+
+ def test_raises_mising_dependencies_error
+ assert_raises(HTMLPipeline::MissingDependencyError) do
+ HTMLPipeline.require_dependencies(["non-existant", "something"], "SomeClass")
+ end
+ end
+
+ def test_raises_dependency_error_including_message
+ error = assert_raises(HTMLPipeline::MissingDependencyError) do
+ HTMLPipeline.require_dependency("non-existant", "SomeClass")
+ end
+
+ assert_includes(error.message, "Missing dependency 'non-existant' for SomeClass. See README.md for details.")
+ end
+
+ def test_raises_dependencies_error_including_message
+ error = assert_raises(HTMLPipeline::MissingDependencyError) do
+ HTMLPipeline.require_dependencies(["non-existant", "something"], "SomeClass")
+ end
+
+ assert_includes(error.message, "Missing all dependencies 'non-existant, something' for SomeClass. See README.md for details.")
+ end
+
+ def test_raises_error_includes_underlying_message
+ error = assert_raises(HTMLPipeline::MissingDependencyError) do
+ HTMLPipeline.require_dependency("non-existant", "SomeClass")
+ end
+
+ assert_includes(error.message, "LoadError: cannot load such file")
+ end
+ end
+end
diff --git a/test/html_pipeline/text_filter/image_filter_test.rb b/test/html_pipeline/text_filter/image_filter_test.rb
new file mode 100644
index 00000000..be67c278
--- /dev/null
+++ b/test/html_pipeline/text_filter/image_filter_test.rb
@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+ImageFilter = HTMLPipeline::TextFilter::ImageFilter
+
+class HTMLPipeline
+ class ImageFilterTest < Minitest::Test
+ def setup
+ @filter = ImageFilter
+ end
+
+ def test_jpg
+ assert_equal(%(
),
+ @filter.call(%(http://example.com/test.jpg)))
+ end
+
+ def test_jpeg
+ assert_equal(%(
),
+ @filter.call(%(http://example.com/test.jpeg)))
+ end
+
+ def test_bmp
+ assert_equal(%(
),
+ @filter.call(%(http://example.com/test.bmp)))
+ end
+
+ def test_gif
+ assert_equal(%(
),
+ @filter.call(%(http://example.com/test.gif)))
+ end
+
+ def test_png
+ assert_equal(%(
),
+ @filter.call(%(http://example.com/test.png)))
+ end
+
+ def test_https_url
+ assert_equal(%(
),
+ @filter.call(%(https://example.com/test.png)))
+ end
+ end
+end
diff --git a/test/html_pipeline/text_filter/plain_text_input_filter_test.rb b/test/html_pipeline/text_filter/plain_text_input_filter_test.rb
new file mode 100644
index 00000000..742afab9
--- /dev/null
+++ b/test/html_pipeline/text_filter/plain_text_input_filter_test.rb
@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+class HTMLPipeline
+ class PlainTextInputFilterTest < Minitest::Test
+ PlainTextInputFilter = HTMLPipeline::TextFilter::PlainTextInputFilter
+
+ def test_fails_when_given_a_documentfragment
+ body = "heyo
"
+ doc = Nokogiri::HTML::DocumentFragment.parse(body)
+ assert_raises(TypeError) { PlainTextInputFilter.call(doc, context: {}) }
+ end
+
+ def test_wraps_input_in_a_div_element
+ doc = PlainTextInputFilter.call("howdy pahtner", context: {})
+
+ assert_equal("howdy pahtner", doc.to_s)
+ end
+
+ def test_html_escapes_plain_text_input
+ doc = PlainTextInputFilter.call("See: ", context: {})
+
+ assert_equal("See: <http://example.org>",
+ doc.to_s)
+ end
+ end
+end
diff --git a/test/html_pipeline_test.rb b/test/html_pipeline_test.rb
new file mode 100644
index 00000000..e6b2a933
--- /dev/null
+++ b/test/html_pipeline_test.rb
@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+require "test_helper"
+require "helpers/mocked_instrumentation_service"
+
+class HTMLPipelineTest < Minitest::Test
+ class TestFilter < HTMLPipeline::TextFilter
+ class << self
+ def call(input, context: {}, result: {})
+ input.reverse
+ end
+ end
+ end
+
+ def setup
+ @default_context = {}
+ @pipeline = HTMLPipeline.new(text_filters: [TestFilter], default_context: @default_context)
+ end
+
+ def test_filter_instrumentation
+ service = MockedInstrumentationService.new
+ events = service.subscribe("call_filter.html_pipeline")
+ @pipeline.instrumentation_service = service
+ body = "hello"
+ @pipeline.call(body)
+ event, payload, = events.pop
+
+ assert(event, "event expected")
+ assert_equal("call_filter.html_pipeline", event)
+ assert_equal(TestFilter.name, payload[:filter])
+ assert_equal(@pipeline.class.name, payload[:pipeline])
+ assert_equal(body.reverse, payload[:result][:output])
+ end
+
+ def test_pipeline_instrumentation
+ service = MockedInstrumentationService.new
+ events = service.subscribe("call_text_filters.html_pipeline")
+ @pipeline.instrumentation_service = service
+ body = "hello"
+ @pipeline.call(body)
+ event, payload, = events.pop
+
+ assert(event, "event expected")
+ assert_equal("call_text_filters.html_pipeline", event)
+ assert_equal(@pipeline.text_filters.map(&:name), payload[:text_filters])
+ assert_equal(@pipeline.class.name, payload[:pipeline])
+ assert_equal(body.reverse, payload[:result][:output])
+ end
+
+ def test_default_instrumentation_service
+ service = "default"
+ HTMLPipeline.default_instrumentation_service = service
+ pipeline = HTMLPipeline.new(text_filters: [], default_context: @default_context)
+
+ assert_equal(service, pipeline.instrumentation_service)
+ ensure
+ HTMLPipeline.default_instrumentation_service = nil
+ end
+
+ def test_setup_instrumentation
+ assert_nil(@pipeline.instrumentation_service)
+
+ service = MockedInstrumentationService.new
+ events = service.subscribe("call_text_filters.html_pipeline")
+ name = "foo"
+ @pipeline.setup_instrumentation(name, service: service)
+
+ assert_equal(service, @pipeline.instrumentation_service)
+ assert_equal(name, @pipeline.instrumentation_name)
+
+ body = "foo"
+ @pipeline.call(body)
+
+ event, payload, = events.pop
+
+ assert(event, "expected event")
+ assert_equal(name, payload[:pipeline])
+ assert_equal(body.reverse, payload[:result][:output])
+ end
+
+ def test_incorrect_text_filters
+ assert_raises(HTMLPipeline::InvalidFilterError) do
+ HTMLPipeline.new(text_filters: [HTMLPipeline::NodeFilter::MentionFilter], default_context: @default_context)
+ end
+ end
+
+ def test_incorrect_convert_filter
+ assert_raises(HTMLPipeline::InvalidFilterError) do
+ HTMLPipeline.new(convert_filter: HTMLPipeline::NodeFilter::ImageMaxWidthFilter, default_context: @default_context)
+ end
+ end
+
+ def test_incorrect_node_filters
+ assert_raises(HTMLPipeline::InvalidFilterError) do
+ HTMLPipeline.new(node_filters: [HTMLPipeline::ConvertFilter::MarkdownFilter], default_context: @default_context)
+ end
+ end
+end
diff --git a/test/sanitization_filter_test.rb b/test/sanitization_filter_test.rb
new file mode 100644
index 00000000..5e26f4ff
--- /dev/null
+++ b/test/sanitization_filter_test.rb
@@ -0,0 +1,262 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+class HTMLPipeline
+ class SanitizationFilterTest < Minitest::Test
+ SanitizationFilter = HTMLPipeline::SanitizationFilter
+ DEFAULT_CONFIG = SanitizationFilter::DEFAULT_CONFIG
+
+ def test_removing_script_tags
+ orig = %(
)
+ html = SanitizationFilter.call(orig, DEFAULT_CONFIG).to_s
+
+ refute_match(/script/, html)
+ end
+
+ def test_removing_style_tags
+ orig = %()
+ html = SanitizationFilter.call(orig, DEFAULT_CONFIG).to_s
+
+ refute_match(/style/, html)
+ end
+
+ def test_removing_style_attributes
+ orig = %(YO DAWG
)
+ html = SanitizationFilter.call(orig, DEFAULT_CONFIG).to_s
+
+ refute_match(/font-size/, html)
+ refute_match(/style/, html)
+ end
+
+ def test_removing_script_event_handler_attributes
+ orig = %(YO DAWG)
+ html = SanitizationFilter.call(orig, DEFAULT_CONFIG).to_s
+
+ refute_match(/javscript/, html)
+ refute_match(/onclick/, html)
+ end
+
+ def test_sanitizes_li_elements_not_contained_in_ul_or_ol
+ stuff = "a\nb \nc"
+ html = SanitizationFilter.call(stuff, { elements: {} }).to_s
+
+ assert_equal("a\nb\nc", html)
+ end
+
+ def test_does_not_sanitize_li_elements_contained_in_ul_or_ol
+ stuff = "a\n- b
\nc"
+
+ assert_equal(stuff, SanitizationFilter.call(stuff, DEFAULT_CONFIG).to_s)
+ end
+
+ def test_github_specific_protocols_are_removed
+ stuff = 'Spill this yo and so on'
+
+ assert_equal("Spill this yo and so on", SanitizationFilter.call(stuff, DEFAULT_CONFIG).to_s)
+ end
+
+ def test_unknown_schemes_are_removed
+ stuff = 'Wat is this'
+ html = SanitizationFilter.call(stuff, DEFAULT_CONFIG).to_s
+
+ assert_equal("Wat is this", html)
+ end
+
+ def test_allowlisted_longdesc_schemes_are_allowed
+ stuff = ''
+ html = SanitizationFilter.call(stuff, DEFAULT_CONFIG).to_s
+
+ assert_equal('', html)
+ end
+
+ def test_weird_longdesc_schemes_are_removed
+ stuff = ''
+ html = SanitizationFilter.call(stuff, DEFAULT_CONFIG).to_s
+
+ assert_equal('', html)
+ end
+
+ def test_standard_schemes_are_removed_if_not_specified_in_anchor_schemes
+ config = DEFAULT_CONFIG.merge(protocols: { "a" => { "href" => [] } })
+ stuff = 'No href for you'
+ html = SanitizationFilter.call(stuff, config)
+
+ assert_equal("No href for you", html)
+ end
+
+ def test_custom_anchor_schemes_are_not_removed
+ config = DEFAULT_CONFIG.merge(protocols: { "a" => { "href" => ["something-weird"] } })
+ stuff = 'Wat is this'
+ html = SanitizationFilter.call(stuff, config)
+
+ assert_equal(stuff, html)
+ end
+
+ def test_allow_svg_elements_to_be_added
+ config = DEFAULT_CONFIG.dup
+ frag = <<~FRAG
+
+ FRAG
+
+ html = SanitizationFilter.call(frag, config)
+
+ assert_equal("\n", html)
+
+ config = { elements: ["svg", "circle"],
+ attributes: { "svg" => ["width"],
+ "circle" => ["cx", "cy", "r"], }, }
+
+ result = <<~FRAG
+
+ FRAG
+
+ html = SanitizationFilter.call(frag, config)
+
+ assert_equal(result, html)
+ end
+
+ def test_anchor_schemes_are_merged_with_other_anchor_restrictions
+ stuff = 'Wat is this'
+ allowlist = {
+ elements: ["a"],
+ attributes: { "a" => ["href"] },
+ protocols: { "a" => { "href" => ["something-weird"] } },
+ }
+ html = SanitizationFilter.call(stuff, allowlist)
+
+ assert_equal('Wat is this', html)
+ end
+
+ def test_uses_anchor_schemes_from_allowlist_when_not_separately_specified
+ stuff = 'Wat is this'
+ allowlist = {
+ elements: ["a"],
+ attributes: { "a" => ["href"] },
+ protocols: { "a" => { "href" => ["something-weird"] } },
+ }
+ html = SanitizationFilter.call(stuff, allowlist)
+
+ assert_equal(stuff, html)
+ end
+
+ def test_allowlist_contains_default_anchor_schemes
+ assert_equal(["http", "https", "mailto", :relative], SanitizationFilter::DEFAULT_CONFIG[:protocols]["a"]["href"])
+ end
+
+ def test_exports_default_anchor_schemes
+ assert_equal(["http", "https", "mailto", :relative], SanitizationFilter::VALID_PROTOCOLS)
+ end
+
+ def test_script_contents_are_removed
+ orig = ""
+
+ assert_equal("", SanitizationFilter.call(orig, DEFAULT_CONFIG).to_s)
+ end
+
+ def test_table_rows_and_cells_removed_if_not_in_table
+ orig = %(Foo Bar )
+
+ assert_equal("FooBar", SanitizationFilter.call(orig, { elements: {} }))
+ end
+
+ def test_table_sections_removed_if_not_in_table
+ orig = %(Foo
+Column 1 Sum 1
)
+
+ assert_equal(orig, SanitizationFilter.call(orig, DEFAULT_CONFIG).to_s)
+ end
+
+ def test_summary_tag_are_not_removed
+ orig = %(Foo )
+
+ assert_equal(orig, SanitizationFilter.call(orig, DEFAULT_CONFIG).to_s)
+ end
+
+ def test_details_tag_and_open_attribute_are_not_removed
+ orig = %(Foo)
+
+ assert_equal(orig, SanitizationFilter.call(orig, DEFAULT_CONFIG).to_s)
+ end
+
+ def test_nested_details_tag_are_not_removed
+ orig = <<-NESTED
+
+ Foo
+
+ Bar
+ Baz
+
+ Qux
+
+ NESTED
+ assert_equal(orig, SanitizationFilter.call(orig, DEFAULT_CONFIG).to_s)
+ end
+
+ def test_sanitization_pipeline_can_be_configured
+ config = {
+ elements: ["p", "pre", "code"],
+ }
+
+ pipeline = HTMLPipeline.new(\
+ convert_filter:
+ HTMLPipeline::ConvertFilter::MarkdownFilter.new,
+ sanitization_config: config,
+ node_filters: [
+ HTMLPipeline::NodeFilter::MentionFilter.new,
+ ],
+ )
+
+ result = pipeline.call(<<~CODE)
+ This is *great*, @balevine:
+
+ some_code(:first)
+ CODE
+
+ expected = <<~HTML
+ This is great, @balevine:
+ some_code(:first)
+
+ HTML
+
+ assert_equal(result[:output].to_s, expected.chomp)
+ end
+
+ def test_sanitization_pipeline_can_be_removed
+ pipeline = HTMLPipeline.new(\
+ convert_filter: HTMLPipeline::ConvertFilter::MarkdownFilter.new(context: { markdown: { plugins: { syntax_highlighter: nil } } }),
+ sanitization_config: nil,
+ node_filters: [
+ HTMLPipeline::NodeFilter::MentionFilter.new,
+ ],
+ )
+
+ result = pipeline.call(<<~CODE)
+ This is *great*, @balevine:
+
+ some_code(:first)
+ CODE
+
+ expected = <<~HTML
+ This is great, @balevine:
+ some_code(:first)
+
+ HTML
+
+ assert_equal(result[:output].to_s, expected.chomp)
+ end
+ end
+end
diff --git a/test/test_helper.rb b/test/test_helper.rb
index ddb78e80..6e70b91a 100644
--- a/test/test_helper.rb
+++ b/test/test_helper.rb
@@ -1,20 +1,17 @@
# frozen_string_literal: true
-require 'bundler/setup'
-require 'html/pipeline'
-require 'minitest/autorun'
-require 'minitest/pride'
-require 'minitest/focus'
+require "bundler/setup"
+require "html_pipeline"
-require 'active_support/core_ext/string'
+require "minitest/autorun"
+require "minitest/pride"
+require "minitest/focus"
+
+require "awesome_print"
+
+require "nokogiri"
module TestHelpers
- # Asserts that two html fragments are equivalent. Attribute order
- # will be ignored.
- def assert_equal_html(expected, actual)
- assert_equal Nokogiri::HTML::DocumentFragment.parse(expected).to_hash,
- Nokogiri::HTML::DocumentFragment.parse(actual).to_hash
- end
end
-Minitest::Test.send(:include, TestHelpers)
+Minitest::Test.include(TestHelpers)
![](\"#{@image_base_url}/img.png\")
![](\"#{@image_subpage_url}/img.png\")
', context: {})
+ end
+ assert_raises(RuntimeError) do
+ AbsoluteSourceFilter.call('
), result)
+ end
+
+ def test_img_tag_attributes_can_be_customized
+ body = "
