trenni-sanitize 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be872bc0f1f2f9b2fca5c5a8738090aea3faf1f2880b9201447edad78419f0ab
-  data.tar.gz: 822005447509aaabe1c4ee6fbc9b97fe17c7b4eb7f7f9faa7e0697e394e955be
+  metadata.gz: bf3bbcdec106d73031c57448faf27778de703faa62645433a3d533589886aa56
+  data.tar.gz: 335bf0b72300dcf0fbceb03da54fae1b22d30cdf30c73073803f9d402dab4cbd
 SHA512:
-  metadata.gz: 70651108fffab5e259895627a312b9eadfa66233c8f6f7e0ec8de4f56cdfe0bf7cbec26d6ca88d4db3ad1e0be24c664282a1f3d932e73b7336b0054a305a790d
-  data.tar.gz: 31c18d416cc9735cdf39e4b348b854db3a81a06041e66fcbcd87970165ba8b08e2a7b491f0f617aa5e58d051a66337a5dca4040c17f53f55f706dfe032355916
+  metadata.gz: dfeffd7990d49492e2cbb18fef5a630359464b3b35e2dab8026134674c0d7d9a560a45e806a8de1f0d4b4a32c867c2ae4116b9f25a119ce837ae83930251b52c
+  data.tar.gz: 91dab7bf62fb90065d0e25088d0df36c883ced831f05047bab6dc431252b9f005faaae3e5a7a579a985761a5b1f03482d7bd2fc0740f45c29cc4559985969471

data/lib/trenni/sanitize/fragment.rb

@@ -36,6 +36,11 @@ module Trenni
 				'em' => STANDARD_ATTRIBUTES,
 				'strong' => STANDARD_ATTRIBUTES,
 				'ul' => STANDARD_ATTRIBUTES,
+				'ol' => STANDARD_ATTRIBUTES,
+				'li' => STANDARD_ATTRIBUTES,
+				'dl' => STANDARD_ATTRIBUTES,
+				'dt' => STANDARD_ATTRIBUTES,
+				'dd' => STANDARD_ATTRIBUTES,
 				'strike' => STANDARD_ATTRIBUTES,
 				'h1' => STANDARD_ATTRIBUTES,
 				'h2' => STANDARD_ATTRIBUTES,

data/lib/trenni/sanitize/version.rb

@@ -20,6 +20,6 @@
 
 module Trenni
 	module Sanitize
-		VERSION = "0.5.0"
+		VERSION = "0.6.0"
 	end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trenni-sanitize
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Samuel Williams
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-02-20 00:00:00.000000000 Z
+date: 2020-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: trenni
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.5'
 - !ruby/object:Gem::Dependency
-  name: covered
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: covered
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -66,48 +66,25 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.4'
-- !ruby/object:Gem::Dependency
-  name: rake
-  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: 
+description:
 email:
-- samuel.williams@oriontransfer.co.nz
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
-- Gemfile
-- README.md
-- Rakefile
+- lib/.DS_Store
+- lib/trenni/.DS_Store
 - lib/trenni/sanitize.rb
 - lib/trenni/sanitize/filter.rb
 - lib/trenni/sanitize/fragment.rb
 - lib/trenni/sanitize/text.rb
 - lib/trenni/sanitize/version.rb
-- spec/spec_helper.rb
-- spec/trenni/sanitize/benchmark_spec.rb
-- spec/trenni/sanitize/fragment_spec.rb
-- spec/trenni/sanitize/sample.html
-- spec/trenni/sanitize/text_spec.rb
-- trenni-sanitize.gemspec
 homepage: https://github.com/ioquatix/trenni-sanitize
-licenses: []
-metadata: {}
-post_install_message: 
+licenses:
+- MIT
+metadata:
+  funding_uri: https://github.com/sponsors/ioquatix/
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -115,7 +92,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - "~>"
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -123,12 +100,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.2
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Sanitize markdown according to a set of rules.
-test_files:
-- spec/spec_helper.rb
-- spec/trenni/sanitize/benchmark_spec.rb
-- spec/trenni/sanitize/fragment_spec.rb
-- spec/trenni/sanitize/sample.html
-- spec/trenni/sanitize/text_spec.rb
+test_files: []

data/.gitignore

@@ -1,19 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-
-lib/trenni/trenni.bundle

data/.rspec

@@ -1,5 +0,0 @@
---color
---format documentation
---backtrace
---warnings
---require spec_helper

data/.travis.yml

@@ -1,22 +0,0 @@
-language: ruby
-dist: xenial
-cache: bundler
-
-matrix:
-  include:
-    - rvm: 2.4
-    - rvm: 2.5
-    - rvm: 2.6
-    - rvm: 2.6
-      os: osx
-    - rvm: 2.6
-      env: COVERAGE=BriefSummary,Coveralls
-    - rvm: 2.7
-    - rvm: truffleruby
-    - rvm: jruby-head
-      env: JRUBY_OPTS="--debug -X+O"
-    - rvm: ruby-head
-  allow_failures:
-    - rvm: truffleruby
-    - rvm: ruby-head
-    - rvm: jruby-head

data/Gemfile

@@ -1,16 +0,0 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in trenni.gemspec
-gemspec
-
-group :development do
-	gem 'pry'
-end
-
-group :test do
-	gem 'ruby-prof', platforms: [:mri]
-	gem "benchmark-ips"
-	
-	# For comparisons:
-	gem "sanitize"
-end

data/README.md

@@ -1,139 +0,0 @@
-# Trenni::Sanitize
-
-Sanitize markup by adding, changing or removing tags, using the [trenni] stream processor (which has a naive C implementation).
-
-[![Build Status](https://travis-ci.com/ioquatix/trenni-sanitize.svg)](https://travis-ci.com/ioquatix/trenni-sanitize)
-[![Code Climate](https://codeclimate.com/github/ioquatix/trenni-sanitize.svg)](https://codeclimate.com/github/ioquatix/trenni-sanitize)
-[![Coverage Status](https://coveralls.io/repos/ioquatix/trenni-sanitize/badge.svg)](https://coveralls.io/r/ioquatix/trenni-sanitize)
-
-[trenni]: https://github.com/ioquatix/trenni
-
-## Motivation
-
-I use the [sanitize] gem and generally it's great. However, it's performance can be an issue and additionally, it doesn't preserve tag namespaces when parsing fragments due to how Nokogiri works internally. This is a problem when processing content destined for [utopia] since it heavily depends on tag namespaces.
-
-[sanitize]: https://github.com/rgrove/sanitize/
-[utopia]: https://github.com/ioquatix/utopia
-
-## Is it fast?
-
-In my informal testing, this gem is about ~50x faster than the [sanitize] gem when generating plain text.
-
-```
-Warming up --------------------------------------
-			Sanitize    96.000  i/100ms
-		Trenni::Sanitize     4.447k i/100ms
-Calculating -------------------------------------
-			Sanitize    958.020  (± 4.5%) i/s -      4.800k in   5.020564s
-		Trenni::Sanitize     44.718k (± 4.2%) i/s -    226.797k in   5.080756s
-
-Comparison:
-		Trenni::Sanitize:    44718.1 i/s
-			Sanitize:      958.0 i/s - 46.68x  slower
-```
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-	gem 'trenni-sanitize'
-
-And then execute:
-
-	$ bundle
-
-Or install it yourself as:
-
-	$ gem install trenni-sanitize
-
-## Usage
-
-`Trenni::Sanitize::Delegate` is a stream-based processor. That means it parses the incoming markup and makes decisions about what to keep and what to discard during parsing.
-
-### Extracting Text
-
-You can extract text using something similar to the following parser delegate:
-
-```ruby
-class Text < Trenni::Sanitize::Filter
-	def filter(node)
-		node.skip!(TAG)
-	end
-	
-	def doctype(string)
-	end
-	
-	def instruction(string)
-	end
-end
-
-text = Text.parse("<p>Hello World</p>").output
-# => "Hello World"
-```
-
-### Extracting Safe Markup
-
-Here is a simple filter that only allows a limited set of tags:
-
-```ruby
-class Fragment < Trenni::Sanitize::Filter
-	STANDARD_ATTRIBUTES = ['class'].freeze
-	
-	ALLOWED_TAGS = {
-		'em' => [],
-		'strong' => [],
-		'p' => [],
-		'img' => ['src', 'alt', 'width', 'height'],
-		'a' => ['href']
-	}.freeze
-	
-	def filter(node)
-		if attributes = ALLOWED_TAGS[node.name]
-			node.tag.attributes.slice!(*attributes)
-		else
-			# Skip the tag, and all contents
-			node.skip!(ALL)
-		end
-	end
-	
-	def doctype(string)
-	end
-	
-	def instruction(string)
-	end
-end
-```
-
-As you can see, while [sanitize] is driven by configuration, `Trenni::Sanitize::Filter` is driven by code.
-
-## Contributing
-
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
-
-## License
-
-Released under the MIT license.
-
-Copyright, 2018, by [Samuel G. D. Williams](http://www.codeotaku.com/samuel-williams).
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.

data/Rakefile

@@ -1,19 +0,0 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-# Load all rake tasks:
-import(*Dir.glob('tasks/**/*.rake'))
-
-RSpec::Core::RakeTask.new
-
-task :environment do
-	$LOAD_PATH.unshift File.expand_path('lib', __dir__)
-end
-
-task :console => :environment do
-	require 'pry'
-	
-	Pry.start
-end
-
-task :default => :spec

data/spec/spec_helper.rb

@@ -1,36 +0,0 @@
-
-require 'covered/rspec'
-require 'bundler/setup'
-
-begin
-	require 'ruby-prof'
-	
-	RSpec.shared_context "profile" do
-		before(:all) do
-			RubyProf.start
-		end
-		
-		after(:all) do
-			result = RubyProf.stop
-			
-			# Print a flat profile to text
-			printer = RubyProf::FlatPrinter.new(result)
-			printer.print(STDOUT)
-		end
-	end
-rescue LoadError
-	RSpec.shared_context "profile" do
-		before(:all) do
-			puts "Profiling not supported on this platform."
-		end
-	end
-end
-
-RSpec.configure do |config|
-	# Enable flags like --only-failures and --next-failure
-	config.example_status_persistence_file_path = ".rspec_status"
-
-	config.expect_with :rspec do |c|
-		c.syntax = :expect
-	end
-end

data/spec/trenni/sanitize/benchmark_spec.rb

@@ -1,36 +0,0 @@
-
-require 'sanitize'
-require 'benchmark/ips'
-
-require 'trenni/sanitize/text'
-
-RSpec.describe Trenni::Sanitize do
-	let(:buffer) {Trenni::Buffer.load_file(File.join(__dir__, "sample.html"))}
-	
-	it "should be faster than alternatives" do
-		config = Sanitize::Config.freeze_config(
-			:elements => %w[b i em strong ul li strike h1 h2 h3 h4 h5 h6 p img image a],
-			:attributes => {
-				'img' => %w[src alt width],
-				'a' => %w[href]
-			},
-		)
-		
-		text = buffer.read
-		
-		# puts Sanitize.fragment(text).inspect
-		# puts Trenni::Sanitize::Text.parse(buffer).output.inspect
-		
-		Benchmark.ips do |x|
-			x.report("Sanitize") do
-				Sanitize.fragment text
-			end
-			
-			x.report("Trenni::Sanitize") do
-				Trenni::Sanitize::Text.parse(buffer)
-			end
-			
-			x.compare!
-		end
-	end
-end

data/spec/trenni/sanitize/fragment_spec.rb

@@ -1,66 +0,0 @@
-# Copyright, 2018, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-# 
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-# 
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
-
-require 'trenni/sanitize/fragment'
-
-RSpec.describe Trenni::Sanitize::Fragment do
-	it "should filter out script tags" do
-		fragment = described_class.parse("<p onclick='malicious()'>Hello World</p><script>doot()</script>")
-		
-		expect(fragment.output).to be == "<p>Hello World</p>"
-	end
-	
-	it "should filter out nested script tags" do
-		fragment = described_class.parse("<div><p>Hello World</p><script>doot()</script></div>")
-		
-		expect(fragment.output).to be == "<div><p>Hello World</p></div>"
-	end
-	
-	it "should filter out tags" do
-		fragment = described_class.parse("<p onclick='malicious()'>Hello World</p><script>script</script>")
-		
-		expect(fragment.output).to be == "<p>Hello World</p>"
-	end
-	
-	it "should ignore unbalanced closing tags" do
-		fragment = described_class.parse("<p>Hello World</a></p>")
-		
-		expect(fragment.output).to be == "<p>Hello World</p>"
-	end
-	
-	it "should include trailing text" do
-		fragment = described_class.parse("Hello<script/>World")
-		
-		expect(fragment.output).to be == "HelloWorld"
-	end
-	
-	it "should escape text" do
-		fragment = described_class.parse("x&amp;y")
-		
-		expect(fragment.output).to be == "x&amp;y"
-	end
-	
-	it "should include nested img" do
-		fragment = described_class.parse("<table><img src='foo'/></table>")
-		
-		expect(fragment.output).to be == "<img src=\"foo\"/>"
-	end
-end
-

data/spec/trenni/sanitize/sample.html

@@ -1,12 +0,0 @@
-<hr>
-<a href="http://somegreatsite.com">Link Name</a>
-is a link to another nifty site
-<h1>This is a Header</h1>
-<h1>This is a Medium Header</h2>
-Send me mail at <a href="mailto:support@yourcompany.com">
-support@yourcompany.com</a>.
-<hr>
-<p>This is a new paragraph!</p>
-<p><b>This is a new paragraph!</b></p>
-<br/><b><i>This is a new sentence without a paragraph break, in bold italics.</i></b>
-<hr>

data/spec/trenni/sanitize/text_spec.rb

@@ -1,43 +0,0 @@
-# Copyright, 2019, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-# 
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-# 
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
-
-require 'trenni/sanitize/text'
-
-RSpec.describe Trenni::Sanitize::Text do
-	let(:text) {"One\n\nTwo\n\nThree\n\n"}
-	
-	it "passes through plain text unchanged" do
-		fragment = described_class.parse(text)
-		
-		expect(fragment.output).to be == text
-	end
-	
-	it "should extract text" do
-		fragment = described_class.parse("<p onclick='malicious()'>Hello World</p><script>doot()</script>")
-		
-		expect(fragment.output).to be == "Hello World\n\n"
-	end
-	
-	it "replaces line breaks" do
-		fragment = described_class.parse("One<br/>Two<br/>Three")
-		
-		expect(fragment.output).to be == "One\n\nTwo\n\nThree"
-	end
-end

data/trenni-sanitize.gemspec

@@ -1,26 +0,0 @@
-
-require_relative 'lib/trenni/sanitize/version'
-
-Gem::Specification.new do |spec|
-	spec.name          = "trenni-sanitize"
-	spec.platform      = Gem::Platform::RUBY
-	spec.version       = Trenni::Sanitize::VERSION
-	spec.authors       = ["Samuel Williams"]
-	spec.email         = ["samuel.williams@oriontransfer.co.nz"]
-	spec.summary       = %q{Sanitize markdown according to a set of rules.}
-	spec.homepage      = "https://github.com/ioquatix/trenni-sanitize"
-
-	spec.files         = `git ls-files`.split($/)
-	spec.executables   = spec.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-	spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-	spec.require_paths = ["lib"]
-	
-	spec.required_ruby_version = '~> 2.4'
-	
-	spec.add_dependency "trenni", '~> 3.5'
-	
-	spec.add_development_dependency "covered"
-	spec.add_development_dependency "bundler"
-	spec.add_development_dependency "rspec", "~> 3.4"
-	spec.add_development_dependency "rake"
-end