Skip to content

Implement progress callback #62

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
miqmago wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Implement progress callback #62

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9072323
Implement progress callback
miqmago Jun 15, 2017
891f0c3
remove not applying test
miqmago Jun 15, 2017
473e527
improve readme
miqmago Jun 15, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,17 @@ To use Typo in a standard web application you need to pass a settings object tha
var dictionary = new Typo("en_US", false, false, { dictionaryPath: "typo/dictionaries" }),
```

To load custom dic and aff files, and you can also provide a callback progress:

```javascript
var dictionary = new Typo("en_US", affData, wordsData, {
progressCallback: function (objectType, i, total) {
var pct = parseInt((10000 * i) / total, 10) / 100;
console.log('Processing ' + objectType + ': ' + pct + '%...');
}
}),
```

If using in node.js, load it like so:

```javascript
Expand Down
19 changes: 19 additions & 0 deletions tests/general.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,25 @@ function run() {
var dict = new Typo("en_US", affData, wordData);
checkLoadedDict(dict);
});

test("Progress callbacks are being called", function() {
var dicCb = false;
var affCb = false;
var affData = empty_dict._readFile(chrome.extension.getURL("../typo/dictionaries/en_US/en_US.aff"));
var wordData = empty_dict._readFile(chrome.extension.getURL("../typo/dictionaries/en_US/en_US.dic"));
var dict = new Typo("en_US", affData, wordData, {
progressCallback: function (obType, i, total) {
if (obType === 'dic') {
dicCb = true;
} else if (obType === 'aff') {
affCb = true;
}
}
});
checkLoadedDict(dict);
ok(dicCb);
ok(affCb);
});

test("Synchronous load of dictionary data", function() {
var dict = new Typo("en_US");
Expand Down
46 changes: 27 additions & 19 deletions typo/typo.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,8 @@ var Typo;
* {Function} [loadedCallback]: Called when both affData and wordsData
* have been loaded. Only used if asyncLoad is set to true. The parameter
* is the instantiated Typo object.
* {Function} [progressCallback]: Called when processing .aff and .dic files
* signature: progressCallback(opType, i, total), where opType = 'dic' or 'aff'
*
* @returns {Typo} A Typo object.
*/
Expand All @@ -57,7 +59,7 @@ Typo = function (dictionary, affData, wordsData, settings) {

this.replacementTable = [];

this.flags = settings.flags || {};
this.flags = settings.flags || {};

this.memoized = {};

Expand All @@ -75,7 +77,7 @@ Typo = function (dictionary, affData, wordsData, settings) {

// If the data is preloaded, just setup the Typo object.
if (affData && wordsData) {
setup();
setup(settings.progressCallback);
}
// Loading data for Chrome extentions.
else if (typeof window !== 'undefined' && 'chrome' in window && 'extension' in window.chrome && 'getURL' in window.chrome.extension) {
Expand All @@ -86,8 +88,8 @@ Typo = function (dictionary, affData, wordsData, settings) {
path = "typo/dictionaries";
}

if (!affData) readDataFile(chrome.extension.getURL(path + "/" + dictionary + "/" + dictionary + ".aff"), setAffData);
if (!wordsData) readDataFile(chrome.extension.getURL(path + "/" + dictionary + "/" + dictionary + ".dic"), setWordsData);
if (!affData) readDataFile(chrome.extension.getURL(path + "/" + dictionary + "/" + dictionary + ".aff"), setAffData, settings.progressCallback);
if (!wordsData) readDataFile(chrome.extension.getURL(path + "/" + dictionary + "/" + dictionary + ".dic"), setWordsData, settings.progressCallback);
}
else {
if (settings.dictionaryPath) {
Expand All @@ -100,42 +102,42 @@ Typo = function (dictionary, affData, wordsData, settings) {
path = './dictionaries';
}

if (!affData) readDataFile(path + "/" + dictionary + "/" + dictionary + ".aff", setAffData);
if (!wordsData) readDataFile(path + "/" + dictionary + "/" + dictionary + ".dic", setWordsData);
if (!affData) readDataFile(path + "/" + dictionary + "/" + dictionary + ".aff", setAffData, settings.progressCallback);
if (!wordsData) readDataFile(path + "/" + dictionary + "/" + dictionary + ".dic", setWordsData, settings.progressCallback);
}
}

function readDataFile(url, setFunc) {
function readDataFile(url, setFunc, progressCallback) {
var response = self._readFile(url, null, settings.asyncLoad);

if (settings.asyncLoad) {
response.then(function(data) {
setFunc(data);
setFunc(data, progressCallback);
});
}
else {
setFunc(response);
setFunc(response, progressCallback);
}
}

function setAffData(data) {
function setAffData(data, progressCallback) {
affData = data;

if (wordsData) {
setup();
setup(progressCallback);
}
}

function setWordsData(data) {
function setWordsData(data, progressCallback) {
wordsData = data;

if (affData) {
setup();
setup(progressCallback);
}
}

function setup() {
self.rules = self._parseAFF(affData);
function setup(progressCallback) {
self.rules = self._parseAFF(affData, progressCallback);

// Save the rule codes that are used in compound rules.
self.compoundRuleCodes = {};
Expand All @@ -154,7 +156,7 @@ Typo = function (dictionary, affData, wordsData, settings) {
self.compoundRuleCodes[self.flags.ONLYINCOMPOUND] = [];
}

self.dictionaryTable = self._parseDIC(wordsData);
self.dictionaryTable = self._parseDIC(wordsData, progressCallback);

// Get rid of any codes from the compound rule codes that are never used
// (or that were special regex characters). Not especially necessary...
Expand Down Expand Up @@ -289,7 +291,7 @@ Typo.prototype = {
* @returns object The rules from the file.
*/

_parseAFF : function (data) {
_parseAFF : function (data, progressCallback) {
var rules = {};

var line, subline, numEntries, lineParts;
Expand All @@ -301,6 +303,9 @@ Typo.prototype = {
var lines = data.split("\n");

for (i = 0, _len = lines.length; i < _len; i++) {
if (progressCallback) {
progressCallback('aff', i, _len);
}
line = lines[i];

var definitionParts = line.split(/\s+/);
Expand Down Expand Up @@ -427,7 +432,7 @@ Typo.prototype = {
* word forms from the dictionary.
*/

_parseDIC : function (data) {
_parseDIC : function (data, progressCallback) {
data = this._removeDicComments(data);

var lines = data.split("\n");
Expand All @@ -450,13 +455,16 @@ Typo.prototype = {

// The first line is the number of words in the dictionary.
for (var i = 1, _len = lines.length; i < _len; i++) {
if (progressCallback) {
progressCallback('dic', i, _len);
}
var line = lines[i];

if (!line) {
// Ignore empty lines.
continue;
}

var parts = line.split("/", 2);

var word = parts[0];
Expand Down