trenni-sanitize 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: fd1bd015d1fe0b61494d1289eb43e200e1610e5a
-  data.tar.gz: 4ae3952d6ef7bf38a8b16ae3aff29f0a1f38dee4
+SHA256:
+  metadata.gz: 692099586ce2e3dfb2e1ff3911cafa0e39a22d5dac957ef4401f3fd31be32565
+  data.tar.gz: d0a4d9ff3f8e5937119f08638b188c6d7c386fa428fb3c98fe64334d8fd8e705
 SHA512:
-  metadata.gz: 7e352c69337f48b62c5292970cbb849563d4e10974a0547d9abcdc79979cc80e26523db4453c5e9c26d085b628b57a883ca86b6bbbdf05cea27f861db53b888e
-  data.tar.gz: 77aa0739c366265b9cf2fa91c256155d709f59c179fa18cac859cf26d5bcfcf5fcd61fc61c7286ce098e67c812962be39da860815f09b1ab1713b2af33377d1f
+  metadata.gz: 4668acf3447f634251f01a4b3ffef72592552ff6da12178b7201a221e25b6dc1f0f6115903201ad75532e73d6df93dda13cb8e4cb68a890e651569710700852c
+  data.tar.gz: bde8b725c3a2455b3eb762eb25036538d4a591aa77e3e6e5c30642a8680f3907fd4f429c906e893b70401b1e7b9b1616dd4153f38d7c0533dfc698351658aebe

data/.travis.yml

@@ -1,17 +1,22 @@
 language: ruby
-sudo: false
-rvm:
-  - 2.1
-  - 2.2
-  - 2.3
-  - 2.4
-  - ruby-head
-  - jruby-head
-  - rbx-2
-env:
-  - COVERAGE=true
+dist: xenial
+cache: bundler
+
 matrix:
+  include:
+    - rvm: 2.3
+    - rvm: 2.4
+    - rvm: 2.5
+    - rvm: 2.6
+    - rvm: 2.6
+      os: osx
+    - rvm: 2.6
+      env: COVERAGE=BriefSummary,Coveralls
+    - rvm: truffleruby
+    - rvm: jruby-head
+      env: JRUBY_OPTS="--debug -X+O"
+    - rvm: ruby-head
   allow_failures:
-    - rvm: "rbx-2"
-    - rvm: "ruby-head"
-    - rvm: "jruby-head"
+    - rvm: truffleruby
+    - rvm: ruby-head
+    - rvm: jruby-head

data/README.md

@@ -1,31 +1,36 @@
-# trenni-sanitize::Sanitize
+# Trenni::Sanitize
 
-Sanitize markup by adding, changing or removing tags. 
+Sanitize markup by adding, changing or removing tags, using the [trenni] stream processor (which has a naive C implementation).
 
 [![Build Status](https://secure.travis-ci.org/ioquatix/trenni-sanitize.svg)](http://travis-ci.org/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.
+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
+			Sanitize    96.000  i/100ms
 		Trenni::Sanitize     4.447k i/100ms
 Calculating -------------------------------------
-						Sanitize    958.020  (± 4.5%) i/s -      4.800k in   5.020564s
+			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
+			Sanitize:      958.0 i/s - 46.68x  slower
+```
 
 ## Installation
 
@@ -52,7 +57,7 @@ You can extract text using something similar to the following parser delegate:
 ```ruby
 class Text < Trenni::Sanitize::Filter
 	def filter(node)
-		skip!(TAG)
+		node.skip!(TAG)
 	end
 	
 	def doctype(string)
@@ -78,16 +83,16 @@ class Fragment < Trenni::Sanitize::Filter
 		'em' => [],
 		'strong' => [],
 		'p' => [],
-		'img' => [] + ['src', 'alt', 'width', 'height'],
-		'a' => ['href', 'target']
+		'img' => ['src', 'alt', 'width', 'height'],
+		'a' => ['href']
 	}.freeze
 	
 	def filter(node)
 		if attributes = ALLOWED_TAGS[node.name]
-			node.tag.attributes.slice!(attributes)
+			node.tag.attributes.slice!(*attributes)
 		else
 			# Skip the tag, and all contents
-			skip!(ALL)
+			node.skip!(ALL)
 		end
 	end
 	

data/lib/trenni/sanitize/version.rb

@@ -20,6 +20,6 @@
 
 module Trenni
 	module Sanitize
-		VERSION = "0.2.0"
+		VERSION = "0.3.0"
 	end
 end

data/spec/spec_helper.rb

@@ -1,23 +1,6 @@
 
-if ENV['COVERAGE']
-	begin
-		require 'simplecov'
-		
-		SimpleCov.start do
-			add_filter "/spec/"
-		end
-		
-		if ENV['TRAVIS']
-			require 'coveralls'
-			Coveralls.wear!
-		end
-	rescue LoadError
-		warn "Could not load simplecov: #{$!}"
-	end
-end
-
-require "bundler/setup"
-require "trenni/sanitize"
+require 'covered/rspec'
+require 'bundler/setup'
 
 begin
 	require 'ruby-prof'

data/spec/trenni/sanitize/benchmark_spec.rb

@@ -18,8 +18,8 @@ RSpec.describe Trenni::Sanitize do
 		
 		text = buffer.read
 		
-		puts Sanitize.fragment(text).inspect
-		puts Trenni::Sanitize::Text.parse(buffer).output.inspect
+		# puts Sanitize.fragment(text).inspect
+		# puts Trenni::Sanitize::Text.parse(buffer).output.inspect
 		
 		Benchmark.ips do |x|
 			x.report("Sanitize") do

data/trenni-sanitize.gemspec

@@ -17,8 +17,9 @@ Gem::Specification.new do |spec|
 	
 	spec.required_ruby_version = '~> 2.1'
 	
-	spec.add_dependency "trenni", '~> 3.5.0'
+	spec.add_dependency "trenni", '~> 3.5'
 	
+	spec.add_development_dependency "covered"
 	spec.add_development_dependency "bundler", "~> 1.3"
 	spec.add_development_dependency "rspec", "~> 3.4"
 	spec.add_development_dependency "rake"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trenni-sanitize
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-15 00:00:00.000000000 Z
+date: 2019-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: trenni
@@ -16,14 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: '3.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: covered
+  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: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -111,8 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Sanitize markdown according to a set of rules.