readabilitySAX - npm Package Compare versions

Comparing version 0.3.3 to 0.5.0

browsers/DOMasSAX.js

@@ -10,32 +10,27 @@ /*
 		throw 'please provide callbacks!';
+
+	//todo: support further events, options for trim & space normalisation
 	
-	var emptyFunction = function(){},
-		onopentag = callbacks.onopentag || emptyFunction,
-		onclosetag = callbacks.onclosetag || emptyFunction,
-		ontext = callbacks.ontext || emptyFunction,
-		onattribute = callbacks.onattribute,
-		oncomment = callbacks.oncomment || emptyFunction;
-		//todo: support further events, options for trim & space normalisation
-	
 	function parse(node){
-		var elem = {name:node.tagName.toLowerCase(),attributes:{}}, 
-		    attributeNodes = node.attributes, 
-		    attrNum = attributeNodes.length;
-		for(var j = 0; j < attrNum; j++){
-		  elem.attributes[attributeNodes[j].name+''] = attributeNodes[j].value;
+		var name = node.tagName.toLowerCase(),
+			attributes = {},
+			attributeNodes = node.attributes, 
+			attrNum = attributeNodes.length;
+		for(var i = 0; i < attrNum; i++){
+			attributes[attributeNodes[i].name+''] = attributeNodes[i].value;
 		}
-		onopentag(elem);
+		callbacks.onopentag(name, attributes);
 		
-		if(onattribute)
-			for(j in elem.attributes) onattribute({ name: j, value: elem.attributes[j] });
-		
 		var childs = node.childNodes, num = childs.length, nodeType;
 		for(var i = 0; i < num; i++){
 			nodeType = childs[i].nodeType;
-			if(nodeType === 3 /*text*/) ontext(childs[i].textContent);
-    		else if(nodeType === 1 /*element*/) parse(childs[i]);
-    		else if(nodeType === 8 /*comment*/) oncomment(childs[i].toString());
-    		//[...]
+			if(nodeType === 3 /*text*/)
+				callbacks.ontext(childs[i].textContent);
+			else if(nodeType === 1 /*element*/) parse(childs[i]);
+			/*else if(nodeType === 8) //comment
+				if(callbacks.oncomment) callbacks.oncomment(childs[i].toString());
+			[...]
+			*/
 		}
-		onclosetag(elem.name);
+		callbacks.onclosetag(name);
 	}
@@ -42,0 +37,0 @@

package.json

 {
     "name": "readabilitySAX",
-    "version": "0.3.3",
+    "version": "0.5.0",
     "description": "the readability script ported to a sax parser",
     "author": "Felix Boehm <[e-mail]>",
-    "main": "./readabilitySAX.js",
+    "main": "./node/index.js",
     "engine": "*",
@@ -14,7 +14,7 @@ "repository": {
         "request": ">= 2.1.1",
-        "htmlparser2": ">= 1.0.0"
+        "htmlparser2": ">= 1.9.0"
     },
     "scripts": {
-    	"test": "node ./node_examples/mkread.js"
+    	"test": "node ./tests/test_output.js"
     }
 }

readabilitySAX.js

@@ -1,574 +0,588 @@
-var readability = function(parser, settings){
+//list of values
+var tagsToSkip = {textarea:true,head:true,script:true,noscript:true,input:true,select:true,style:true,link:true,aside:true,header:true,nav:true,footer:true},
+	tagCounts = {address:-3,article:30,blockquote:3,body:-5,dd:-3,div:5,dl:-3,dt:-3,form:-3,h2:-5,h3:-5,h4:-5,h5:-5,h6:-5,li:-3,ol:-3,pre:3,td:3,th:-5,ul:-3},
+	embeds = {embed:true,object:true,iframe:true}, //iframe added for html5 players
+	goodAttributes = {href:true,src:true,title:true,alt:true/*,style:true*/},
+	cleanConditionaly = {form:true,table:true,ul:true,ol:true,div:true},
+	tagsToScore = {p:true,pre:true,td:true},
+	newLinesAfter = {br:true,p:true,h2:true,h3:true,h4:true,h5:true,h6:true,li:true},
+	newLinesBefore = {p:true,h2:true,h3:true,h4:true,h5:true,h6:true},
 
-	"use strict";
+	divToPElements = ["a","blockquote","dl","div","img","ol","p","pre","table","ul"],
+
+	re_videos = /http:\/\/(?:www\.)?(?:youtube|vimeo)\.com/i,
+	re_skipFootnoteLink =/^\s*(?:\[?[a-z0-9]{1,2}\]?|^|edit|citation needed)\s*$/i,
+	re_nextLink = /next|weiter|continue|>(?:[^\|]|$)|»(?:[^\|]|$)/i,
+	re_prevLink = /prev|earl|old|new|<|«/i,
+	re_extraneous = /print|archive|comment|discuss|e-?mail|share|reply|all|login|sign|single/i,
+	re_pages = /pag(?:e|ing|inat)/i,
+	re_pagenum = /p(?:a|g|ag)?(?:e|ing|ination)?(?:=|\/)[0-9]{1,2}/i,
+
+	re_positive = /article|body|content|entry|main|page|pagination|post|text|blog|story|hentry|instapaper_body/,
+	re_negative = /combx|comment|com-|contact|foot|footer|footnote|masthead|media|meta|outbrain|promo|related|scroll|shoutbox|sidebar|sponsor|shopping|tags|tool|widget/,
+	re_unlikelyCandidates =/combx|comment|community|disqus|extra|foot|header|menu|remark|rss|shoutbox|sidebar|sponsor|ad-break|agegate|pagination|pager|popup|tweet|twitter|entry-unrelated/,
+	re_okMaybeItsACandidate = /and|article|body|column|main|shadow/,
+
+	re_badStart = /\.(?: |$)/,
+
+	re_pageInURL = /(?:(?:_|-)?p[a-zA-Z]*|(?:_|-))[0-9]{1,2}$/,
+	re_noLetters = /[^a-zA-Z]/,
+	re_digits = /\d/,
+	re_justDigits = /^\d{1,2}$/,
+	re_slashes = /\/+/,
 	
-	//list of values
-	var tagsToSkip = {textarea:true,head:true,script:true,noscript:true,input:true,select:true,style:true,link:true,aside:true,header:true,nav:true,footer:true},
-		tagsToCount = {a:true,audio:true,blockquote:true,div:true,dl:true,embed:true,img:true,input:true,li:true,object:true,ol:true,p:true,pre:true,table:true,ul:true,video:true},
-		tagCounts = {address:-3,article:30,blockquote:3,body:-5,dd:-3,div:5,dl:-3,dt:-3,form:-3,h2:-5,h3:-5,h4:-5,h5:-5,h6:-5,li:-3,ol:-3,pre:3,td:3,th:-5,ul:-3},
-		embeds = {embed:true,object:true,iframe:true}, //iframe added for html5 players
-		goodAttributes = {href:true,src:true,title:true,alt:true/*,style:true*/},
-		cleanConditionaly = {form:true,table:true,ul:true,ol:true,div:true},
-		tagsToScore = {p:true,pre:true,td:true},
-		divToPElements = ["a","blockquote","dl","div","img","ol","p","pre","table","ul"],
-		newLinesAfter = {br:true,p:true,h2:true,h3:true,h4:true,h5:true,h6:true,li:true},
-		newLinesBefore = {p:true,h2:true,h3:true,h4:true,h5:true,h6:true},
-		
-		re_videos = /http =\/\/(www\.)?(vimeo|youtube|yahoo|flickr)\.com/i,
-		re_skipFootnoteLink =/^\s*(\[?[a-z0-9]{1,2}\]?|^|edit|citation needed)\s*$/i,
-		re_nextLink = /(next|weiter|continue|>([^\|]|$)|»([^\|]|$))/i,
-		re_prevLink = /(prev|earl|old|new|<|«)/i,
-		re_extraneous = /print|archive|comment|discuss|e[\-]?mail|share|reply|all|login|sign|single/i,
-		re_pages = /pag(e|ing|inat)/i,
-		re_pagenum = /p(a|g|ag)?(e|ing|ination)?(=|\/)[0-9]{1,2}/i,
-		
-		re_positive = /article|body|content|entry|hentry|main|page|pagination|post|text|blog|story/,
-		re_negative = /combx|comment|com-|contact|foot|footer|footnote|masthead|media|meta|outbrain|promo|related|scroll|shoutbox|sidebar|sponsor|shopping|tags|tool|widget/,
-		re_unlikelyCandidates =/combx|comment|community|disqus|extra|foot|header|menu|remark|rss|shoutbox|sidebar|sponsor|ad-break|agegate|pagination|pager|popup|tweet|twitter|entry-unrelated/,
-		re_okMaybeItsACandidate = /and|article|body|column|main|shadow/,
-		
-		re_badStart = /\.( |$)/,
-		
-		re_pageInURL = /((_|-)?p[a-z]*|(_|-))[0-9]{1,2}$/i,
-		re_noLetters = /[^a-z]/i,
-		re_justDigits = /^\d{1,2}$/,
-		re_slashes = /\/+/,
-		
-		re_commas	 = /,[\s\,]*/g;
-	
-	//the tree element
-	var Element = function(tagName){
-			this.name = tagName;
-			this.attributes = {};
-			this.children = [];
-			this.skip = false;
-			this.tagScore = 0;
-			this.attributeScore = 0;
-			this.totalScore = 0;
-			this.info = {
-				textLength: 0,
-				linkLength: 0,
-				commas:		0,
-				density:	0,
-				tagCount:	{}
-			};
-			this.isCandidate = false;
-	};
-	
-	Element.prototype = {
-		addInfo: function(){
-			var info = this.info,
-				childs = this.children,
-				childNum = this.children.length,
-				elem;
-			for(var i=0; i < childNum; i++){
-				elem = childs[i];
-				if(typeof elem === "string"){
-					info.textLength += elem.length;
-					info.commas += elem.split(re_commas).length - 1;
+	re_closing = /\/?(?:#.*)?$/,
+
+	re_commas	 = /,[\s\,]*/g;
+
+//the tree element
+var Element = function(tagName){
+		this.name = tagName;
+		this.attributes = {};
+		this.children = [];
+		this.skip = false;
+		this.tagScore = 0;
+		this.attributeScore = 0;
+		this.totalScore = 0;
+		this.info = {
+			textLength: 0,
+			linkLength: 0,
+			commas:		0,
+			density:	0,
+			tagCount:	{}
+		};
+		this.isCandidate = false;
+};
+
+Element.prototype = {
+	addInfo: function(){
+		var info = this.info,
+			childs = this.children,
+			childNum = childs.length,
+			elem;
+		for(var i=0; i < childNum; i++){
+			elem = childs[i];
+			if(typeof elem === "string"){
+				info.textLength += elem.length;
+				info.commas += elem.split(re_commas).length - 1;
+			}
+			else if(!elem.skip){
+				if(elem.name === "a"){
+					info.linkLength += elem.info.textLength + elem.info.linkLength;
 				}
-				else if(!elem.skip){
-					if(elem.name === "a"){
-						info.linkLength += elem.info.textLength + elem.info.linkLength;
-					}
-					else{
-						info.textLength += elem.info.textLength;
-						info.linkLength += elem.info.linkLength;
-					}
-					info.commas += elem.info.commas;
-					
-					for(var j in elem.info.tagCount){
-						if(info.tagCount[j]) info.tagCount[j] += elem.info.tagCount[j];
-						else info.tagCount[j] = elem.info.tagCount[j];
-					}
-					
-					if(info.tagCount[elem.name]) info.tagCount[elem.name] += 1;
-					else info.tagCount[elem.name] = 1;
+				else{
+					info.textLength += elem.info.textLength;
+					info.linkLength += elem.info.linkLength;
 				}
-			}
-			info.density = info.linkLength / (info.textLength + info.linkLength);
-			if(isNaN(info.density))
-				info.density = 1; //just ensure it gets skipped (is the case for 0/0)
-			return info;
-		},
-		getOuterHTML: function(){
-			if(this.skip) return "";
-			var ret = "<" + this.name,
-				i;
-			
-			for(i in this.attributes)
-				if(this.attributes.hasOwnProperty(i))
-					ret += " " + i + "=\"" + this.attributes[i] + "\"";
-			
-			return ret + ">" + this.getInnerHTML() + "</" + this.name + ">";
-		},
-		getInnerHTML: function(){
-			var nodes = this.children, ret = "";
-			
-			for(var i = 0, j = nodes.length; i < j; i++){
-				if(typeof nodes[i] === "string") ret += nodes[i];
-				else ret += nodes[i].getOuterHTML();
-			}
-			return ret;
-		},
-		getText: function(){
-			var nodes = this.children, ret = "", text;
-			for(var i = 0, j = nodes.length; i < j; i++){
-				if(typeof nodes[i] === "string") ret += nodes[i];
-				else if(!nodes[i].skip){
-					text = nodes[i].getText();
-					
-					if(text === "") continue;
-					
-					if(newLinesBefore[ nodes[i].name ]) ret += "\n";
-					
-					ret += text;
-					
-					if(newLinesAfter[ nodes[i].name ]) ret +=	"\n";
+				info.commas += elem.info.commas;
+
+				for(var j in elem.info.tagCount){
+					if(info.tagCount[j]) info.tagCount[j] += elem.info.tagCount[j];
+					else info.tagCount[j] = elem.info.tagCount[j];
 				}
+
+				if(info.tagCount[elem.name]) info.tagCount[elem.name] += 1;
+				else info.tagCount[elem.name] = 1;
 			}
-			return ret;
 		}
-	};
-	
-	//settings
-	var Settings = {
-		stripUnlikelyCandidates: true,
-		weightClasses: true,
-		cleanConditionally: true,
-		cleanAttributes: true,
-		searchFurtherPages: true,
-		linksToSkip: {},	//pages that are already parsed
-		/*
-		url: null,			//nodes URL module (or anything that provides its api)
-		pageURL: null,		//URL of the page which is parsed
-		convertLinks: null, //function to redirect links
-		link: null,			//instance of url, may be provided if url was already parsed (pageURL isn't required after that)
-		*/
-		log : typeof console === "undefined" ? function(){} : console.log
-	};
-	
-	//helper functions
-	var getBaseURL = function(pageURL){
-		var noUrlParams		= pageURL.split("?", 1)[0],
-			linkElements	= noUrlParams.split(re_slashes),
-			urlSlashes		= linkElements.splice(2).reverse(),
-			cleanedSegments = [],
-			possibleType	= "",
-			i = 0, 
-			slashLen = urlSlashes.length;
-		
-		if(slashLen < 2) return noUrlParams; //return what we got
-		
-		//look if the first to elements get skipped
-		var first = urlSlashes[0],
-			second= urlSlashes[1];
-		
-		if((first.length < 3 && re_noLetters.test(first)) || first.toLowerCase() === "index" || re_justDigits.test(first)){
-			if(( second.length < 3 && re_noLetters.test(first) ) || re_justDigits.test(second)) i = 2;
-			else i = 1;
+		info.density = info.linkLength / (info.textLength + info.linkLength);
+		if(isNaN(info.density))
+			info.density = 1; //just ensure it gets skipped (is the case for 0/0)
+		return info;
+	},
+	getOuterHTML: function(){
+		if(this.skip) return "";
+		var ret = "<" + this.name,
+			i;
+
+		for(i in this.attributes)
+			if(this.attributes.hasOwnProperty(i))
+				ret += " " + i + "=\"" + this.attributes[i] + "\"";
+
+		return ret + ">" + this.getInnerHTML() + "</" + this.name + ">";
+	},
+	getInnerHTML: function(){
+		var nodes = this.children, ret = "";
+
+		for(var i = 0, j = nodes.length; i < j; i++){
+			if(typeof nodes[i] === "string") ret += nodes[i];
+			else ret += nodes[i].getOuterHTML();
 		}
-		else{
-			if(re_pageInURL.test(first))
-				urlSlashes[0] = first.replace(re_pageInURL, "");
-			
-			//if only the second one gets skiped, start at an index of 1 and position the first element there
-			if( (second.length < 3 && re_noLetters.test(first)) || re_justDigits.test(second))
-				urlSlashes[ i = 1 ] = first;
-			
-			else if(re_pageInURL.test(second))
-				urlSlashes[1] = second.replace(re_pageInURL, "");
+		return ret;
+	},
+	getText: function(){
+		var nodes = this.children, ret = "", text;
+		for(var i = 0, j = nodes.length; i < j; i++){
+			if(typeof nodes[i] === "string") ret += nodes[i];
+			else if(!nodes[i].skip){
+				text = nodes[i].getText();
+
+				if(text === "") continue;
+
+				if(newLinesBefore[ nodes[i].name ]) ret += "\n";
+
+				ret += text;
+
+				if(newLinesAfter[ nodes[i].name ]) ret +=	"\n";
+			}
 		}
-		
-		var dotSplit, segment;
-		
-		for(;i < slashLen; i++){
-			// Split off and save anything that looks like a file type.
-			dotSplit = urlSlashes[i].split(".", 3);
-			
-			//change from readability: ensure that segments with multiple points get skipped
-			if (dotSplit.length === 2 && !re_noLetters.test(dotSplit[1]))
-				segment = dotSplit[0];
-			else segment = urlSlashes[i];
-			
-			if(segment.indexOf(",00") !== -1)
-				segment = segment.replace(",00", "");
-			
-			cleanedSegments.push(segment);
-		}
+		return ret;
+	}
+};
 
-		// This is our final, cleaned, base article URL.
-		return linkElements[0] + "//" + linkElements[1] + "/" + cleanedSegments.reverse().join("/");
-	};
+//helper functions
+var getBaseURL = function(pageURL){
+	var noUrlParams		= pageURL.split("?", 1)[0],
+		linkElements	= noUrlParams.split(re_slashes),
+		urlSlashes		= linkElements.splice(2).reverse(),
+		cleanedSegments = [],
+		i = 0,
 
+		slashLen = urlSlashes.length;
+
+	if(slashLen < 2) return noUrlParams; //return what we got
+
+	//look if the first to elements get skipped
+	var first = urlSlashes[0],
+		second= urlSlashes[1];
+
+	if((first.length < 3 && re_noLetters.test(first)) || first.toLowerCase() === "index" || re_justDigits.test(first)){
+		if(( second.length < 3 && re_noLetters.test(first) ) || re_justDigits.test(second)) i = 2;
+		else i = 1;
+	}
+	else{
+		if(re_pageInURL.test(first))
+			urlSlashes[0] = first.replace(re_pageInURL, "");
+
+		//if only the second one gets skiped, start at an index of 1 and position the first element there
+		if( (second.length < 3 && re_noLetters.test(first)) || re_justDigits.test(second))
+			urlSlashes[ i = 1 ] = first;
+
+		else if(re_pageInURL.test(second))
+			urlSlashes[1] = second.replace(re_pageInURL, "");
+	}
+
+	var dotSplit, segment;
+
+	for(;i < slashLen; i++){
+		// Split off and save anything that looks like a file type.
+		dotSplit = urlSlashes[i].split(".", 3);
+
+		//change from Readability: ensure that segments with multiple points get skipped
+		if (dotSplit.length === 2 && !re_noLetters.test(dotSplit[1]))
+			segment = dotSplit[0];
+		else segment = urlSlashes[i];
+
+		if(segment.indexOf(",00") !== -1)
+			segment = segment.replace(",00", "");
+
+		cleanedSegments.push(segment);
+	}
+
+	// This is our final, cleaned, base article URL.
+	return linkElements[0] + "//" + linkElements[1] + "/" + cleanedSegments.reverse().join("/");
+};
+
+var Readability = function(settings){
 	//our tree (used instead of the dom)
-	var docElements = [new Element("document")],
-		topCandidate, topParent,
-		origTitle, headerTitle;
-	
-	
-	//process settings
-	for(var i in Settings)
-		if(!settings.hasOwnProperty(i) && Settings.hasOwnProperty(i))
-			settings[i] = Settings[i];
-	
-	//skipLevel is a shortcut to allow more elements of the page
-	if(settings.skipLevel){
-		if(settings.skipLevel > 0) settings.stripUnlikelyCandidates = false;
-		if(settings.skipLevel > 1) settings.weightClasses = false;
-		if(settings.skipLevel > 2) settings.cleanConditionally = false;
+	this._docElements = [new Element("document")];
+	this._topCandidate = this._topParent = null;
+	this._origTitle = this._headerTitle = "";
+	this._scannedLinks = {};
+	if(settings) this._processSettings(settings);
+};
+
+Readability.prototype._settings = {
+	stripUnlikelyCandidates: true,
+	weightClasses: true,
+	cleanConditionally: true,
+	cleanAttributes: true,
+	searchFurtherPages: true,
+	linksToSkip: {},	//pages that are already parsed
+	/*
+	url: null,			//nodes URL module (or anything that provides its api)
+	pageURL: null,		//URL of the page which is parsed
+	convertLinks: null, //function to redirect links
+	link: null,			//instance of url, may be provided if url was already parsed (pageURL isn't required after that)
+	*/
+	log : typeof console === "undefined" ? function(){} : console.log
+};
+
+Readability.prototype._convertLinks = function(a){return a;};
+
+Readability.prototype._processSettings = function(settings){
+	var Settings = this._settings;
+	this._settings = {};
+
+	for(var i in Settings){
+		if(typeof settings[i] !== "undefined")
+			this._settings[i] = settings[i];
+		else this._settings[i] = Settings[i];
 	}
-	
-	if(settings.log === false) settings.log = function(){};
-	
-	if(!settings.link && settings.url && settings.pageURL)
-		settings.link = settings.url.parse( settings.pageURL );
-	
-	if(!settings.pageURL && settings.link && settings.url)
-		settings.pageURL = settings.url.format(settings.link);
+
+	if(settings.log === false) this._settings.log = function(){};
+
+	if(!settings.link && settings.url && settings.pageURL){
+		this._settings.link = settings.url.parse(settings.pageURL);
+	}
+
 	//clean pageURL for search of further pages
-	if(settings.pageURL)
-		settings.pageURL = settings.pageURL.replace(/#.*$/, "").replace(/\/$/, "");
-	
-	if(!settings.convertLinks) 
-		if(settings.link && settings.url)
-			settings.convertLinks = settings.url.resolve.bind(null, settings.link);
-		else settings.convertLinks = function(a){ return a; };
-	
-	var baseURL;
-	if(settings.pageURL)
-		baseURL = getBaseURL(settings.pageURL);
-	
-	var scannedLinks = {};
-	
-	var scanLink = function(elem){
-		var href = elem.attributes.href;
-		
-		if(!href) return;
-		
-		href = href.replace(/#.*$/, "").replace(/\/$/, "");
-		
-		if(href === "" || href === baseURL || href === settings.pageURL) return;
-		
-		if(settings.linksToSkip[href]) return;
-		
-		if(settings.pageURL && href.split(re_slashes, 2)[1] !== settings.pageURL.split(re_slashes, 2)[1]) return;
-		
-		var text = elem.getText();
-		
-		if(text.length > 25 || re_extraneous.test(text)) return;
-		if(!/\d/.test(href.replace(baseURL, ""))) return;
-		
-		var score = 0,
-			linkData = text + " " + elem.attributes["class"] + " " + elem.attributes.id;
-		
-		if(re_nextLink.test(linkData)) score += 50;
-		if(re_pages.test(linkData)) score += 25;
-		
-		if(/(first|last)/i.test(linkData)){
-			if(!re_nextLink.test(text))
-				if(!(scannedLinks[href] && re_nextLink.test(scannedLinks[href].text)))
-					score -= 65;
+	if(settings.pageURL){
+		this._settings.pageURL = settings.pageURL.replace(re_closing, "");
+	}
+
+	if(!settings.convertLinks && settings.link && settings.url){
+		this._convertLinks = function(url){ 
+			settings.url.resolve(settings.link, url);
+		};
+	}
+	else this._convertLinks = settings.convertLinks;
+
+	this._baseURL = settings.pageURL && getBaseURL(settings.pageURL);
+};
+
+Readability.prototype._scanLink = function(elem){
+	var href = elem.attributes.href;
+
+	if(!href) return;
+
+	href = this._convertLinks(href.replace(re_closing, ""));
+
+	if(href === this._baseURL || href === this._settings.pageURL) return;
+
+	if(this._settings.linksToSkip[href]) return;
+
+	if(this._settings.pageURL && href.split(re_slashes, 2)[1] !== this._settings.pageURL.split(re_slashes, 2)[1]) return;
+
+	var text = elem.getText();
+
+	if(text.length > 25 || re_extraneous.test(text)) return;
+	if(!re_digits.test(href.replace(this._baseURL, ""))) return;
+
+	var score = 0,
+		linkData = text + " " + elem.attributes["class"] + " " + elem.attributes.id;
+
+	if(re_nextLink.test(linkData)) score += 50;
+	if(re_pages.test(linkData)) score += 25;
+
+	if(/first|last/i.test(linkData)){
+		if(!re_nextLink.test(text))
+			if(!(this._scannedLinks[href] && re_nextLink.test(this._scannedLinks[href].text)))
+				score -= 65;
+	}
+
+	if(re_negative.test(linkData) || re_extraneous.test(linkData)) score -= 50;
+	if(re_prevLink.test(linkData)) score -= 200;
+
+	if(re_pagenum.test(href) || re_pages.test(href)) score += 25;
+	if(re_extraneous.test(href)) score -= 15;
+
+	var pos = this._docElements.length,
+		posMatch = true,
+		negMatch = true,
+		parentData = "";
+
+	while(--pos !== 0){
+		parentData = this._docElements[pos].attributes["class"] + " " + this._docElements[pos].attributes.id;
+		if(parentData === " ") continue;
+		if(posMatch && re_pages.test(parentData)){
+			score += 25;
+			if(!negMatch) break;
+			else posMatch = false;
 		}
-		
-		if(re_negative.test(linkData) || re_extraneous.test(linkData)) score -= 50;
-		if(re_prevLink.test(linkData)) score -= 200;
-		
-		if(re_pagenum.test(href) || re_pages.test(href)) score += 25;
-		if(re_extraneous.test(href)) score -= 15;
-		
-		var pos = docElements.length,
-			posMatch = true, 
-			negMatch = true, 
-			parentData = "";
-		
-		while(--pos !== 0){
-			parentData = docElements[pos].attributes["class"] + " " + docElements[pos].attributes.id;
-			if(parentData === " ") continue;
-			if(posMatch && re_pages.test(parentData)){
-				score += 25;
-				if(!negMatch) break;
-				else posMatch = false;
-			}
-			if(negMatch && re_negative.test(parentData) && !re_positive.test(parentData)){
-				score -= 25;
-				if(!posMatch) break;
-				else negMatch = false;
-			}
+		if(negMatch && re_negative.test(parentData) && !re_positive.test(parentData)){
+			score -= 25;
+			if(!posMatch) break;
+			else negMatch = false;
 		}
-		
-		var parsedNum = parseInt(text, 10);
-		if(parsedNum){
-			if(parsedNum === 1) score -= 10;
-			else score += Math.max(0, 10 - parsedNum);
+	}
+
+	var parsedNum = parseInt(text, 10);
+	if(parsedNum){
+		if(parsedNum === 1) score -= 10;
+		else score += Math.max(0, 10 - parsedNum);
+	}
+
+	if(this._scannedLinks[href]){
+		this._scannedLinks[href].score += score;
+		this._scannedLinks[href].text += " | " + text;
+	}
+	else this._scannedLinks[href] = {
+			score: score,
+			text: text
+		};
+};
+
+//parser methods
+Readability.prototype.onopentag = function(tagName, attributes){
+	var parent = this._docElements[this._docElements.length - 1],
+		elem = new Element(tagName);
+
+	this._docElements.push(elem);
+
+	if(parent.skip === true || tagsToSkip[tagName]){
+		elem.attributes = attributes;
+		elem.skip = true;
+		return;
+	}
+
+	var value;
+
+	if(this._settings.stripUnlikelyCandidates){
+		value = ((attributes.id || "") + (attributes["class"] || "")).toLowerCase();
+		if(re_unlikelyCandidates.test(value) && !re_okMaybeItsACandidate.test(value)){
+				elem.skip = true; return;
 		}
-		
-		if(scannedLinks[href]){
-			scannedLinks[href].score += score;
-			scannedLinks[href].text += " | " + text;
+	}
+
+	for(var name in attributes){
+		value = attributes[name];
+
+		if(name === "id" || name === "class"){
+			if(re_negative.test(value)) elem.attributeScore -= 25;
+			else if(re_positive.test(value)) elem.attributeScore += 25;
+
+			elem.attributes[name] = value;
 		}
-		else scannedLinks[href] = {
-				score: score,
-				text: text
-			};
-	};
-	
-	//parser methods
-	parser.onopentag = function(tag){
-		var parent = docElements[docElements.length - 1],
-			tagName = tag.name,
-			elem = new Element(tagName);
-		
-		docElements.push(elem);
-		
-		if(parent.skip === true || tagsToSkip[tagName]){
-			elem.skip = true; return;
+		else if(name === "href" || name === "src"){
+			//fix links
+			elem.attributes[name] = this._convertLinks(value);
 		}
-		
-		var attributes = tag.attributes, value;
-		
-		if(settings.stripUnlikelyCandidates){
-			value = ((attributes.id || "") + (attributes["class"] || "")).toLowerCase();
-			if(re_unlikelyCandidates.test(value) && !re_okMaybeItsACandidate.test(value)){
-					elem.skip = true; return;
-			}
-		}
-		
-		for(var name in attributes){
-			name = name.toLowerCase();
-			value = attributes[name];
-			
-			if(name === "id" || name === "class"){
-				if(re_negative.test(value)) elem.attributeScore -= 25;
-				else if(re_positive.test(value)) elem.attributeScore += 25;
-		
+		else if(this._settings.cleanAttributes){
+			if(goodAttributes[name])
 				elem.attributes[name] = value;
-			}
-			else if(name === "href" || name === "src"){
-				//fix links
-				elem.attributes[name] = settings.convertLinks(value);
-			}
-			else if(settings.cleanAttributes){
-				if(goodAttributes[name])
-					elem.attributes[name] = value;
-			}
-			else elem.attributes[name] = value;
 		}
-		
-		//add points for the tags name
-		elem.tagScore += tagCounts[tagName] || 0;
-		
-		//do this now, so gc can remove it after onclosetag
-		parent.children.push(elem);
-	};
-	
-	parser.ontext = function(text){ docElements[docElements.length-1].children.push(text); };
-	
-	parser.onclosetag = function(tagname){
-		var elem = docElements.pop(),
-			elemLevel = docElements.length - 1;
-		
-		//if(tagname !== elem.name) settings.log("Tagname didn't match!:", tagname, "vs.", elem.name);
-		
-		//prepare title
-		if(tagname === "title") origTitle = elem.getText();
-		else if(tagname === "h1"){
-			elem.skip = true;
-			if(headerTitle !== false)
-				if(!headerTitle) headerTitle = elem.getText();
-				else headerTitle = false;
-		}
-		else if(tagname === "a" && settings.searchFurtherPages){
-			scanLink(elem);
-		}
-		
-		if(elem.skip) return;
-		
-		elem.addInfo();
-		
-		var i, j, cnvrt;
-		//clean conditionally
-		if(tagname === "p"){
-			if(!elem.info.tagCount.img && !elem.info.tagCount.embed && !elem.info.tagCount.object && elem.info.linkLength === 0 && elem.info.textLength === 0)
+		else elem.attributes[name] = value;
+	}
+
+	//add points for the tags name
+	if(tagCounts[tagName]) elem.tagScore += tagCounts[tagName];
+
+	//do this now, so gc can remove it after onclosetag
+	parent.children.push(elem);
+};
+
+Readability.prototype.ontext = function(text){ this._docElements[this._docElements.length-1].children.push(text); };
+
+Readability.prototype.onclosetag = function(tagname){
+	var elem = this._docElements.pop(),
+		elemLevel = this._docElements.length - 1;
+
+	//if(tagname !== elem.name) this._settings.log("Tagname didn't match!:", tagname, "vs.", elem.name);
+
+	//prepare title
+	if(this._settings.searchFurtherPages && tagname === "a"){
+		this._scanLink(elem);
+	}
+	else if(tagname === "title") this._origTitle = elem.getText();
+	else if(tagname === "h1"){
+		elem.skip = true;
+		if(this._headerTitle !== false)
+			if(!this._headerTitle) this._headerTitle = elem.getText();
+			else this._headerTitle = false;
+	}
+
+	if(elem.skip) return;
+
+	elem.addInfo();
+
+	var i, j, cnvrt;
+	//clean conditionally
+	if(tagname === "p"){
+		if(!elem.info.tagCount.img && !elem.info.tagCount.embed && !elem.info.tagCount.object 
+			&& elem.info.linkLength === 0 && elem.info.textLength === 0)
 				elem.skip = true;
-		}
-		else if(embeds[tagname]){
-			//check if tag is wanted (youtube or vimeo)
-			cnvrt = true;
-			for(i in elem.attributes)
-				if(elem.hasOwnProperty(i))
-					if(re_videos.test(i)){ cnvrt = false; break; }
-			
-			if(cnvrt) elem.skip = true;
-		}
-		else if(tagname === "h2" || tagname === "h3"){
-			//clean headers
-			if (elem.attributeScore < 0 || elem.info.density > 0.33) elem.skip = true;
-		}
-		else if(settings.cleanConditionally && cleanConditionaly[tagname]){
-			var p = elem.info.tagCount.p || 0,
-				contentLength = elem.info.textLength + elem.info.linkLength;
-			
-			if( elem.info.tagCount.img > p ) elem.skip = true;
-			else if( (elem.info.tagCount.li - 100) > p && tagname !== "ul" && tagname !== "ol") elem.skip = true;
-			else if(elem.info.tagCount.input > Math.floor(p/3) ) elem.skip = true;
-			else if(contentLength < 25 && (!elem.info.tagCount.img || elem.info.tagCount.img > 2) ) elem.skip = true;
-			else if(elem.attributeScore < 25 && elem.info.density > 0.2) elem.skip = true;
-			else if(elem.attributeScore >= 25 && elem.info.density > 0.5) elem.skip = true;
-			else if((elem.info.tagCount.embed === 1 && contentLength < 75) || elem.info.tagCount.embed > 1) elem.skip = true;
-		}
-		
-		if(elem.skip) return;
-				
-		//should node be scored?
-		var score = tagsToScore[tagname];
-		if(!score && tagname === "div"){
-			cnvrt = true;
-			for(i = 0, j = divToPElements.length; i < j; i++)
-				if(elem.info.tagCount[divToPElements[i]]) cnvrt = false;
-			
-			if(cnvrt){
-				elem.name = "p";
-				score = true;
+	}
+	else if(embeds[tagname]){
+		//check if tag is wanted (youtube or vimeo)
+		cnvrt = true;
+		for(i in elem.attributes){
+			if(re_videos.test(elem.attributes[i])){
+				cnvrt = false;
+				break;
 			}
 		}
-		if(score){
-			if((elem.info.textLength + elem.info.linkLength) >= 25 && elemLevel > 0){
-				docElements[elemLevel].isCandidate = docElements[elemLevel-1].isCandidate = true;
-				var addScore = 1 + elem.info.commas + Math.min( Math.floor( (elem.info.textLength + elem.info.linkLength) / 100 ), 3);
-				docElements[elemLevel].tagScore	+= addScore;
-				docElements[elemLevel-1].tagScore	+= addScore / 2;
-			}
+
+		if(cnvrt) elem.skip = true;
+	}
+	else if(tagname === "h2" || tagname === "h3"){
+		//clean headers
+		if (elem.attributeScore < 0 || elem.info.density > 0.33) elem.skip = true;
+	}
+	else if(this._settings.cleanConditionally && cleanConditionaly[tagname]){
+		var p = elem.info.tagCount.p || 0,
+			contentLength = elem.info.textLength + elem.info.linkLength;
+
+		if( elem.info.tagCount.img > p ) elem.skip = true;
+		else if( (elem.info.tagCount.li - 100) > p && tagname !== "ul" && tagname !== "ol") elem.skip = true;
+		else if(elem.info.tagCount.input > Math.floor(p/3) ) elem.skip = true;
+		else if(contentLength < 25 && (!elem.info.tagCount.img || elem.info.tagCount.img > 2) ) elem.skip = true;
+		else if(elem.attributeScore < 25 && elem.info.density > 0.2) elem.skip = true;
+		else if(elem.attributeScore >= 25 && elem.info.density > 0.5) elem.skip = true;
+		else if((elem.info.tagCount.embed === 1 && contentLength < 75) || elem.info.tagCount.embed > 1) elem.skip = true;
+	}
+
+	if(elem.skip) return;
+
+	//should node be scored?
+	var score = tagsToScore[tagname];
+	if(!score && tagname === "div"){
+		cnvrt = true;
+		for(i = 0, j = divToPElements.length; i < j; i++)
+			if(elem.info.tagCount[divToPElements[i]]) cnvrt = false;
+
+		if(cnvrt){
+			elem.name = "p";
+			score = true;
 		}
-		
-		if(elem.isCandidate){
-			elem.totalScore = Math.floor((elem.tagScore + elem.attributeScore) * (1 - elem.info.density));
-			if(!topCandidate || elem.totalScore > topCandidate.totalScore){
-				topCandidate = elem;
-				if(elemLevel >= 0)
-					topParent = docElements[elemLevel];
-				else
-					topParent = null;
-			}
+	}
+	if(score){
+		if((elem.info.textLength + elem.info.linkLength) >= 25 && elemLevel > 0){
+			this._docElements[elemLevel].isCandidate = this._docElements[elemLevel-1].isCandidate = true;
+			var addScore = 1 + elem.info.commas + Math.min( Math.floor( (elem.info.textLength + elem.info.linkLength) / 100 ), 3);
+			this._docElements[elemLevel].tagScore	+= addScore;
+			this._docElements[elemLevel-1].tagScore	+= addScore / 2;
 		}
-	};
-	
-	var getCandidateSiblings = function(){
-		if(!topCandidate){
-			try{
-				topCandidate = docElements[0].children.pop().children.pop(); //body
-			}
-			catch(e){
-				topCandidate = new Element("",{});
-			}
-			topCandidate.name = "div";
+	}
+
+	if(elem.isCandidate){
+		elem.totalScore = Math.floor((elem.tagScore + elem.attributeScore) * (1 - elem.info.density));
+		if(!this._topCandidate || elem.totalScore > this._topCandidate.totalScore){
+			this._topCandidate = elem;
+			if(elemLevel >= 0)
+				this._topParent = this._docElements[elemLevel];
+			else
+				this._topParent = null;
 		}
-		//check all siblings
-		if(!topParent)
-			return [topCandidate];
-		
-		var ret = [],
-			childs = topParent.children,
-			childNum = childs.length,
-			siblingScoreThreshold = Math.max(10, topCandidate.totalScore * 0.2);
-		
-		for(var i = 0; i < childNum; i++){
-			if(typeof childs[i] === "string") continue;
-			var append = false;
-			if(childs[i] === topCandidate) append = true;
-			else{
-				var contentBonus = 0;
-				if(topCandidate.attributes["class"] && topCandidate.attributes["class"] === childs[i].attributes["class"]) 
-					contentBonus += topCandidate.totalScore * 0.2;
-				if((childs[i].totalScore + contentBonus) >= siblingScoreThreshold) append = true;
-				else if(childs[i].name === "p")
-					if(childs[i].info.textLength > 80 && childs[i].info.density < 0.25) append = true;
-					else if(childs[i].info.textLength < 80 && childs[i].info.density === 0 && childs[i].getText().search(re_badStart) !== -1)
-						append = true;
-			}
-			if(append){
-				if(childs[i].name !== "p")
-					childs[i].name = "div";
-				
-				ret.push(childs[i]);
-			}
+	}
+};
+
+Readability.prototype.onreset = Readability;
+
+Readability.prototype._getCandidateSiblings = function(){
+	var tmp;
+	if(!this._topCandidate){
+		if((tmp = this._docElements) 
+			&& (tmp = tmp[0]) && (tmp = tmp.children) 
+			&& (tmp = tmp[tmp.length-1]) && (tmp = tmp.children) 
+			&& (tmp = tmp[tmp.length-1])){
+			//use body	
+			this._topCandidate = tmp;
 		}
-		return ret;
-	};
-	this.getTitle = function(){
-		var curTitle = origTitle || "";
-		
-		if(/ [\|\-] /.test(curTitle)){
-			curTitle = origTitle.replace(/(.*)[\|\-] .*/gi,'$1');
-			
-			if(curTitle.split(' ', 3).length < 3)
-				curTitle = origTitle.replace(/[^\|\-]*[\|\-](.*)/gi,"$1");
+		else this._topCandidate = new Element("");
+		this._topCandidate.name = "div";
+	}
+	//check all siblings
+	if(!this._topParent)
+		return [this._topCandidate];
+
+	var ret = [],
+		childs = this._topParent.children,
+		childNum = childs.length,
+		siblingScoreThreshold = Math.max(10, this._topCandidate.totalScore * 0.2);
+
+	for(var i = 0; i < childNum; i++){
+		if(typeof childs[i] === "string") continue;
+		var append = false;
+		if(childs[i] === this._topCandidate) append = true;
+		else{
+			var contentBonus = 0;
+			if(this._topCandidate.attributes["class"] && this._topCandidate.attributes["class"] === childs[i].attributes["class"])
+
+				contentBonus += this._topCandidate.totalScore * 0.2;
+			if((childs[i].totalScore + contentBonus) >= siblingScoreThreshold) append = true;
+			else if(childs[i].name === "p")
+				if(childs[i].info.textLength > 80 && childs[i].info.density < 0.25) append = true;
+				else if(childs[i].info.textLength < 80 && childs[i].info.density === 0 && childs[i].getText().search(re_badStart) !== -1)
+					append = true;
 		}
-		else if(curTitle.indexOf(': ') !== -1){
-			curTitle = origTitle.replace(/.*:(.*)/gi, '$1');
+		if(append){
+			if(childs[i].name !== "p")
+				childs[i].name = "div";
 
-			if(curTitle.split(" ", 3).length < 3)
-				curTitle = origTitle.replace(/[^:]*[:](.*)/gi,'$1');
+			ret.push(childs[i]);
 		}
-		else if(curTitle.length > 150 || curTitle.length < 15)
-			if(headerTitle)
-				curTitle = headerTitle;
+	}
+	return ret;
+};
 
-		curTitle = curTitle.trim();
+//skipLevel is a shortcut to allow more elements of the page
+Readability.prototype.setSkipLevel = function(skipLevel){
+	if(this._settings.skipLevel > 0) this._settings.stripUnlikelyCandidates = false;
+	if(this._settings.skipLevel > 1) this._settings.weightClasses = false;
+	if(this._settings.skipLevel > 2) this._settings.cleanConditionally = false;
+};
 
-		if(curTitle.split(" ", 5).length < 5)
-			curTitle = origTitle;
-		
-		return curTitle;
-	};
-	this.getNextPage = function(){
-		var topScore = 49, topLink = "";
-		for(var link in scannedLinks){
-			if(scannedLinks.hasOwnProperty(link))
-				if(scannedLinks[link].score > topScore){
-					topLink = link;
-					topScore = scannedLinks[link].score;
-				}
+Readability.prototype.getTitle = function(){
+	var origTitle = this._origTitle,
+		curTitle = origTitle || "";
+
+	if(/ [\|\-] /.test(curTitle)){
+		curTitle = origTitle.replace(/(.*)[\|\-] .*/g,"$1");
+
+		if(curTitle.split(" ", 3).length < 3)
+			curTitle = origTitle.replace(/[^\|\-]*[\|\-](.*)/g,"$1");
+	}
+	else if(curTitle.indexOf(": ") !== -1){
+		curTitle = origTitle.replace(/.*:(.*)/g,"$1");
+
+		if(curTitle.split(" ", 3).length < 3)
+			curTitle = origTitle.replace(/[^:]*[:](.*)/g,"$1");
+	}
+	else if(curTitle.length > 150 || curTitle.length < 15)
+		if(this._headerTitle) curTitle = this._headerTitle;
+
+	curTitle = curTitle.trim();
+
+	if(curTitle.split(" ", 5).length < 5)
+		curTitle = origTitle;
+
+	return curTitle;
+};
+
+Readability.prototype.getNextPage = function(){
+	var topScore = 49, topLink = "";
+	for(var link in this._scannedLinks){
+		if(this._scannedLinks[link].score > topScore){
+			topLink = link;
+			topScore = this._scannedLinks[link].score;
 		}
-		
-		if(topScore !== 49) settings.log("Top link score:", topScore);
-		
-		return topLink;
-	};
-	this.getArticle = function(type){
-		var ret = {
-			title: this.getTitle(),
-			nextPage: this.getNextPage()
-		};
-		
-		//create a new object so that the prototype methods are callable
-		var elem = new Element("", {});
-		elem.children = getCandidateSiblings();
-		elem.addInfo();
-		
-		ret.textLength = elem.info.textLength;
-		
-		if(type === "text")
-			ret.text = elem.getText().trim();
-		
-		else ret.html = elem.getInnerHTML() //=> clean it
-			//kill breaks
-			.replace(/(<\/?br\s*\/?>(\s|&nbsp;?)*)+/g,'<br/>')
-			//turn all double brs into ps
-			.replace(/(<br[^>]*>[ \n\r\t]*){2,}/g, '</p><p>')
-			//remove font tags
-			.replace(/<(\/?)font[^>]*>/g, '<$1span>')
-			//remove breaks in front of paragraphs
-			.replace(/<br[^>]*>\s*<p/g,"<p");
-		
-		ret.score = topCandidate.totalScore;
-		return ret;
-	};
+	}
+
+	//if(topScore !== 49) this._settings.log("Top link score:", topScore);
+
+	return topLink;
 };
 
-//for legacy reasons
-readability.process = function(a,b){
-	return new readability(a, b);
+Readability.prototype.getArticle = function(type){
+	//create a new object so that the prototype methods are callable
+	var elem = new Element("");
+	elem.children = this._getCandidateSiblings();
+	elem.addInfo();
+
+	var ret = {
+		title: this.getTitle(),
+		nextPage: this.getNextPage(),
+		textLength: elem.info.textLength,
+		score: this._topCandidate.totalScore
+	};
+	
+	//if(elem.info.tagCount.h2 === 1){}
+
+	if(type === "text")
+		ret.text = elem.getText().trim();
+
+	else ret.html = elem.getInnerHTML() //=> clean it
+		//kill breaks
+		.replace(/(?:<\/?br\s*\/?>(?:\s|&nbsp;?)*)+/g,'<br/>')
+		//turn all double brs into ps
+		.replace(/(?:<br[^>]*>[ \n\r\t]*){2,}/g, '</p><p>')
+		//remove font tags
+		.replace(/<(\/?)font[^>]*>/g, '<$1span>')
+		//remove breaks in front of paragraphs
+		.replace(/<br[^>]*>\s*<p/g,"<p");
+
+	return ret;
 };
 
-if(typeof module !== "undefined" && typeof module.exports !== "undefined") module.exports = readability;
+if(typeof module !== "undefined" && typeof module.exports !== "undefined") module.exports = Readability;

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Long strings

Supply chain risk

Contains long string literals, which may be a sign of obfuscated or packed code.

Found 1 instance in 1 package

Fixed alerts

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

105638

increased by32.67%

Number of package files

11

increased by10%

Lines of code

796

increased by20.06%

Number of lines in readme file

50

increased by21.95%

Worsened metrics

Number of low supply chain risk alerts

4

increased by100%

Dependency changes

• Updatedhtmlparser2@>= 1.9.0