diff --git a/demo/wikimedia.html b/demo/wikimedia.html new file mode 100644 index 000000000..ab50042c9 --- /dev/null +++ b/demo/wikimedia.html @@ -0,0 +1,40 @@ + + + + + + + + + + \ No newline at end of file diff --git a/demo/wikimedia.js b/demo/wikimedia.js new file mode 100644 index 000000000..a79ce712c --- /dev/null +++ b/demo/wikimedia.js @@ -0,0 +1,242 @@ +/* + Given a domain and a category, list its member pages and readability score + EX: http://localhost/wikimedia.html?domain=en.wikipedia.org&page=Earth +*/ +(function (wm) { + wm.category = new function() { + // ********************************************** + // member variables + // ********************************************** + // wikimedia domain; EX: en.wikipedia.org + this.domain = 'en.wikipedia.org'; + + // array of categories + this.categories = []; + + // number of pages in category + this.categoriesTotal = 0; + + // number of excerpts found + this.excerptsFound = 0; + + // maximum number of excerpts to find + this.excerptsMax = 50; + + // ********************************************** + // main entry function + // ********************************************** + this.run = function() { + // parse url to get domain and page + var url = window.location.href; + var domain = wm.category.getQueryArg(url, 'domain'); + var category = wm.category.getQueryArg(url, 'category'); + + // use domain arg if available; otherwise use default + if (domain) + wm.category.domain = domain; + + // find pages in category + wm.category.findPagesInCategory(wm.category.domain, category); + } + + this.getQueryArg = function(url, name) { + // http://stackoverflow.com/questions/901115/how-can-i-get-query-string-values-in-javascript + if (!url) { + url = window.location.href; + } + name = name.replace(/[\[\]]/g, "\\$&"); + var regex = new RegExp("[?&]" + name + "(=([^&#]*)|&|#|$)"), + categories = regex.exec(url); + if (!categories) return null; + if (!categories[2]) return ''; + return decodeURIComponent(categories[2].replace(/\+/g, " ")); + } + + // ********************************************** + // find page in category + // ********************************************** + this.findPagesInCategory = function(domain, category) { + // run ajax + var url = 'https://' + domain + '/w/api.php?action=query&format=json&formatversion=2&list=categorymembers&cmlimit=' + wm.category.excerptsMax + '&cmtitle=Category:' + category; + wm.category.runAjax(url, wm.category.findPagesInCategoryCallback); + /* + */ + + /* + // run mock code + var root = {"query":{"categorymembers":[{"pageid":9228,"ns":0,"title":"Earth"},{"pageid":51506837,"ns":0,"title":"Outline of Earth"},{"pageid":25287133,"ns":0,"title":"Anywhere on Earth"},{"pageid":174069,"ns":0,"title":"Asteroid impact avoidance"},{"pageid":35971482,"ns":0,"title":"Day length fluctuations"},{"pageid":33256286,"ns":0,"title":"Demographics of the world"},{"pageid":19509955,"ns":0,"title":"Earth in culture"},{"pageid":212485,"ns":0,"title":"Earth religion"},{"pageid":944638,"ns":0,"title":"Earth's energy budget"},{"pageid":41077022,"ns":0,"title":"Earth's internal heat budget"}]}}; + var root = {"query":{"categorymembers":[{"pageid":9228,"ns":0,"title":"Earth"}]}}; + wm.category.findPagesInCategoryCallbackRoot(root); + */ + } + + this.findPagesInCategoryCallback = function() { + if (this.readyState != 4 || this.status != 200) return; + wm.category.findPagesInCategoryCallbackRoot(JSON.parse(this.responseText)); + } + + this.findPagesInCategoryCallbackRoot = function(root) { + // loop each page in category + var categorymembers = root.query.categorymembers; + for (var categoryIndex in categorymembers) { + // get category + var category = categorymembers[categoryIndex]; + + // get member vars + var page_id = category.pageid; + var ns = category.ns; + var title = category.title; + + // populate local categories table + wm.category.categories[page_id] = category; + + // increment total + wm.category.categoriesTotal++; + + // assign score + category.score = 0; + } + + // now, get excerpts + wm.category.getExcerpts(); + } + + // ********************************************** + // get excerpts + // ********************************************** + this.getExcerpts = function() { + // loop each page to get excerpt + var excerptsCount = 0; + for (var page_id in wm.category.categories) { + var category = wm.category.categories[page_id]; + + // exit if too many + if (excerptsCount++ >= wm.category.excerptsMax) { + // NOTE: must update categoriesTotal + wm.category.categoriesTotal = wm.category.excerptsMax; + break; + } + + // run ajax + var url = 'https://' + wm.category.domain + '/w/api.php?action=query&format=json&formatversion=2&prop=extracts&exintro=1&explaintext&titles=' + category.title; + wm.category.runAjax(url, wm.category.getExcerptCallback); + /* + */ + + /* + // run mock code + var root = {"query":{"pages": + [ + {"pageid":9228,"ns":0,"title":"Earth","extract":"Earth (Greek: Γαῖα Gaia; Latin: Terra)."} + ]}}; + wm.category.getExcerptCallbackRoot(root); + */ + } + } + this.getExcerptCallback = function() { + if (this.readyState != 4 || this.status != 200) return; + + var root = JSON.parse(this.responseText); + wm.category.getExcerptCallbackRoot(root); + } + this.getExcerptCallbackRoot = function(root) { + // get variables + var page = root.query.pages[0]; // only 1 page per api call + var page_id = page.pageid; + var excerpt = page.extract; + + // calc score + var score = wm.category.calcReadabilityScore(excerpt); + + // update category + var category = wm.category.categories[page_id]; + category.excerpt = excerpt; + category.score = score; + + // if last category, print all + if (++wm.category.excerptsFound == wm.category.categoriesTotal) { + wm.category.printResults(); + } + } + + // ********************************************** + // calc readability + // ********************************************** + this.calcReadabilityScore = function(s) { + // REF: https://en.wikipedia.org/wiki/Flesch–Kincaid_readability_tests + var words = wm.category.toWordArray(s); + var totalWords = words.length; + var totalSentences = wm.category.countSentences(s); + + var totalSyllables = 0; + for (var word in words) { + totalSyllables += wm.category.countSyllablesInWord(word); + } + + return 206.835 - (1.015 * (totalWords / totalSentences)) - (84.6 * (totalSyllables / totalWords)); + } + + this.toWordArray = function(s){ + // REF: http://stackoverflow.com/a/18679657 + s = s.replace(/(^\s*)|(\s*$)/gi,"");//exclude start and end white-space + s = s.replace(/[ ]{2,}/gi," ");//2 or more space to 1 + s = s.replace(/\n /,"\n"); // exclude newline with a start spacing + return s.split(' '); + } + + this.countSentences = function(s) { + // REF: http://stackoverflow.com/questions/35215348/count-sentences-in-string-with-javascript + return s.replace(/\w[.?!](\s|$)/g, "$1|").split("|").length; + } + + this.countSyllablesInWord = function(word) { + // REF: http://stackoverflow.com/questions/5686483/how-to-compute-number-of-syllables-in-a-word-in-javascript + word = word.toLowerCase(); //word.downcase! + if(word.length <= 3) {return 1;} //return 1 if word.length <= 3 + word = word.replace(/(?:[^laeiouy]es|ed|[^laeiouy]e)$/, ''); //word.sub!(/(?:[^laeiouy]es|ed|[^laeiouy]e)$/, '') + word = word.replace(/^y/, ''); //word.sub!(/^y/, '') + return word.match(/[aeiouy]{1,2}/g).length; //word.scan(/[aeiouy]{1,2}/).size + } + + // ********************************************** + // printResults + // ********************************************** + this.printResults = function() { + // sort results by score + wm.category.categories.sort(wm.category.compareResult); + + // generate string + var s = ''; + s += '
\n'; + s += '
\n'; + s += '
Title
\n'; + s += '
Score
\n'; + s += '
'; + for (var page_id in wm.category.categories) { + var category = wm.category.categories[page_id]; + s += '
\n'; + s += '
' + category.title + '
\n' + s += '
' + category.score.toFixed(2) + '
\n' + s += '
'; + } + s += '
'; + + // print it + document.body.innerHTML = s; + } + this.compareResult = function(lhs, rhs) { + // sort from least readable to most readable + return (lhs.score - rhs.score); + } + + // ********************************************** + // utility + // ********************************************** + this.runAjax = function(url, callback) { + var req = new XMLHttpRequest(); + req.onreadystatechange = callback; + req.open("GET", url, true); + req.send(); + } + } +}(window.wm = window.wm || {}));