Archives
/
koreader
mirror of https://github.com/koreader/koreader
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

[chore] Rework util spec, rework util.secondsToClock: round seconds to minutes in 00:00 mode + spec

Browse Source 
Most of the tests in util_spec were the wrong way around.
It's `assert(expected, given)`.
pull/3349/head
Frans de Jonge 7 years ago
parent 1508fe27c9
commit 0fa090ee47
2 changed files with 278 additions and 241 deletions
Show Stats Download Patch File Download Diff File

3
frontend/util.lua
Unescape Escape View File

@ -80,8 +80,9 @@ function util.secondsToClock(seconds, withoutSeconds)
return "00:00:00"; return "00:00:00";
end end
else else
local round = withoutSeconds and require("optmath").round or math.floor
local hours = string.format("%02.f", math.floor(seconds / 3600)); local hours = string.format("%02.f", math.floor(seconds / 3600));
local mins = string.format("%02.f", math.floor(seconds / 60 - (hours * 60))); local mins = string.format("%02.f", round(seconds / 60 - (hours * 60)));
if withoutSeconds then if withoutSeconds then
return hours .. ":" .. mins return hours .. ":" .. mins
end end

162
spec/unit/util_spec.lua
Unescape Escape View File

@ -7,24 +7,24 @@ describe("util module", function()
end) end)
it("should strip punctuations around word", function() it("should strip punctuations around word", function()
assert.is_equal(util.stripePunctuations("\"hello world\""), "hello world") assert.is_equal("hello world", util.stripePunctuations("\"hello world\""))
assert.is_equal(util.stripePunctuations("\"hello world?\""), "hello world") assert.is_equal("hello world", util.stripePunctuations("\"hello world?\""))
assert.is_equal(util.stripePunctuations("\"hello, world?\""), "hello, world") assert.is_equal("hello, world", util.stripePunctuations("\"hello, world?\""))
assert.is_equal(util.stripePunctuations("“你好“"), "你好") assert.is_equal("你好", util.stripePunctuations("“你好“"))
assert.is_equal(util.stripePunctuations("“你好?“"), "你好") assert.is_equal("你好", util.stripePunctuations("“你好?“"))
assert.is_equal(util.stripePunctuations(""), "") assert.is_equal("", util.stripePunctuations(""))
assert.is_equal(util.stripePunctuations(nil), nil) assert.is_nil(util.stripePunctuations(nil))
end) end)
describe("gsplit()", function()
it("should split string with patterns", function() it("should split string with patterns", function()
local sentence = "Hello world, welcome to KOReader!" local sentence = "Hello world, welcome to KOReader!"
local words = {} local words = {}
for word in util.gsplit(sentence, "%s+", false) do for word in util.gsplit(sentence, "%s+", false) do
table.insert(words, word) table.insert(words, word)
end end
assert.are_same(words, {"Hello", "world,", "welcome", "to", "KOReader!"}) assert.are_same({"Hello", "world,", "welcome", "to", "KOReader!"}, words)
end) end)
it("should split command line arguments with quotation", function() it("should split command line arguments with quotation", function()
local command = "./sdcv -nj \"words\" \"a lot\" 'more or less' --data-dir=dict" local command = "./sdcv -nj \"words\" \"a lot\" 'more or less' --data-dir=dict"
local argv = {} local argv = {}
@ -38,28 +38,28 @@ describe("util module", function()
end end
end end
end end
assert.are_same(argv, {"./sdcv", "-nj", "words", "a lot", "more or less", "--data-dir=dict"}) assert.are_same({"./sdcv", "-nj", "words", "a lot", "more or less", "--data-dir=dict"}, argv)
end) end)
it("should split string with dashes", function()
it("should split with splitter", function()
local words = {} local words = {}
for word in util.gsplit("a-b-c-d", "-", false) do for word in util.gsplit("a-b-c-d", "-", false) do
table.insert(words, word) table.insert(words, word)
end end
assert.are_same(words, {"a", "b", "c", "d"}) assert.are_same({"a", "b", "c", "d"}, words)
end) end)
it("should split string with dashes with final dash", function()
it("should also split with splitter", function()
local words = {} local words = {}
for word in util.gsplit("a-b-c-d-", "-", false) do for word in util.gsplit("a-b-c-d-", "-", false) do
table.insert(words, word) table.insert(words, word)
end end
assert.are_same(words, {"a", "b", "c", "d"}) assert.are_same({"a", "b", "c", "d"}, words)
end)
end) end)
describe("splitToWords()", function()
it("should split line into words", function() it("should split line into words", function()
local words = util.splitToWords("one two,three four . five") local words = util.splitToWords("one two,three four . five")
assert.are_same(words, { assert.are_same({
"one", "one",
" ", " ",
"two", "two",
@ -69,33 +69,32 @@ describe("util module", function()
"four", "four",
" . ", " . ",
"five", "five",
}) }, words)
end) end)
it("should split ancient greek words", function() it("should split ancient greek words", function()
local words = util.splitToWords("Λαρισαῖος Λευκοθέα Λιγυαστάδης.") local words = util.splitToWords("Λαρισαῖος Λευκοθέα Λιγυαστάδης.")
assert.are_same(words, { assert.are_same({
"Λαρισαῖος", "Λαρισαῖος",
" ", " ",
"Λευκοθέα", "Λευκοθέα",
" ", " ",
"Λιγυαστάδης", "Λιγυαστάδης",
"." "."
}) }, words)
end) end)
it("should split Chinese words", function() it("should split Chinese words", function()
local words = util.splitToWords("彩虹是通过太阳光的折射引起的。") local words = util.splitToWords("彩虹是通过太阳光的折射引起的。")
assert.are_same(words, { assert.are_same({
"彩","虹","是","通","过","太","阳","光","的","折","射","引","起","的","。", "彩","虹","是","通","过","太","阳","光","的","折","射","引","起","的","。",
}) }, words)
end) end)
it("should split words of multilingual text", function() it("should split words of multilingual text", function()
local words = util.splitToWords("BBC纪录片") local words = util.splitToWords("BBC纪录片")
assert.are_same(words, {"BBC", "纪", "录", "片"}) assert.are_same({"BBC", "纪", "录", "片"}, words)
end)
end) end)
describe("splitToChars()", function()
it("should split text to line - unicode", function() it("should split text to line - unicode", function()
local text = "Pójdźże, chmurność glück schließen Štěstí neštěstí. Uñas gavilán" local text = "Pójdźże, chmurność glück schließen Štěstí neštěstí. Uñas gavilán"
local word = "" local word = ""
@ -111,7 +110,7 @@ describe("util module", function()
end end
if i == #table_chars then table.insert(table_of_words, word) end if i == #table_chars then table.insert(table_of_words, word) end
end end
assert.are_same(table_of_words, { assert.are_same({
"Pójdźże, ", "Pójdźże, ",
"chmurność ", "chmurność ",
"glück ", "glück ",
@ -120,9 +119,8 @@ describe("util module", function()
"neštěstí. ", "neštěstí. ",
"Uñas ", "Uñas ",
"gavilán", "gavilán",
}) }, table_of_words)
end) end)
it("should split text to line - CJK", function() it("should split text to line - CJK", function()
local text = "彩虹是通过太阳光的折射引起的。" local text = "彩虹是通过太阳光的折射引起的。"
local word = "" local word = ""
@ -138,11 +136,10 @@ describe("util module", function()
end end
if i == #table_chars then table.insert(table_of_words, word) end if i == #table_chars then table.insert(table_of_words, word) end
end end
assert.are_same(table_of_words, { assert.are_same({
"彩","虹","是","通","过","太","阳","光","的","折","射","引","起","的","。", "彩","虹","是","通","过","太","阳","光","的","折","射","引","起","的","。",
}) }, table_of_words)
end) end)
it("should split text to line with next_c - unicode", function() it("should split text to line with next_c - unicode", function()
local text = "Ce test : 1) est très simple ; 2 ) simple comme ( 2/2 ) > 50 % ? ok." local text = "Ce test : 1) est très simple ; 2 ) simple comme ( 2/2 ) > 50 % ? ok."
local word = "" local word = ""
@ -159,7 +156,7 @@ describe("util module", function()
end end
if i == #table_chars then table.insert(table_of_words, word) end if i == #table_chars then table.insert(table_of_words, word) end
end end
assert.are_same(table_of_words, { assert.are_same({
"Ce ", "Ce ",
"test : ", "test : ",
"1) ", "1) ",
@ -173,9 +170,8 @@ describe("util module", function()
"2/2 ) > ", "2/2 ) > ",
"50 % ? ", "50 % ? ",
"ok." "ok."
}) }, table_of_words)
end) end)
it("should split text to line with next_c and prev_c - unicode", function() it("should split text to line with next_c and prev_c - unicode", function()
local text = "Ce test : 1) est « très simple » ; 2 ) simple comme ( 2/2 ) > 50 % ? ok." local text = "Ce test : 1) est « très simple » ; 2 ) simple comme ( 2/2 ) > 50 % ? ok."
local word = "" local word = ""
@ -193,7 +189,7 @@ describe("util module", function()
end end
if i == #table_chars then table.insert(table_of_words, word) end if i == #table_chars then table.insert(table_of_words, word) end
end end
assert.are_same(table_of_words, { assert.are_same({
"Ce ", "Ce ",
"test : ", "test : ",
"1) ", "1) ",
@ -205,7 +201,8 @@ describe("util module", function()
"comme ", "comme ",
"( 2/2 ) > 50 % ? ", "( 2/2 ) > 50 % ? ",
"ok." "ok."
}) }, table_of_words)
end)
end) end)
it("should split file path and name", function() it("should split file path and name", function()
@ -222,7 +219,7 @@ describe("util module", function()
test(nil, "", "") test(nil, "", "")
test("a/b", "a/", "b") test("a/b", "a/", "b")
test("/b", "/", "b") test("/b", "/", "b")
assert.are_same(util.splitFilePathName("/a/b/c.txt"), "/a/b/") assert.are_same("/a/b/", util.splitFilePathName("/a/b/c.txt"))
end) end)
it("should split file name and suffix", function() it("should split file name and suffix", function()
@ -239,74 +236,113 @@ describe("util module", function()
test("/a/.txt", "/a/", "txt") test("/a/.txt", "/a/", "txt")
test(nil, "", "") test(nil, "", "")
test("", "", "") test("", "", "")
assert.are_same(util.splitFileNameSuffix("a.txt"), "a") assert.are_same("a", util.splitFileNameSuffix("a.txt"))
end) end)
describe("fixUtf8()", function()
it("should replace invalid UTF-8 characters with an underscore", function() it("should replace invalid UTF-8 characters with an underscore", function()
assert.is_equal(util.fixUtf8("\127 \128 \194\127 ", "_"), "\127 _ _\127 ") assert.is_equal("\127 _ _\127 ", util.fixUtf8("\127 \128 \194\127 ", "_"))
end) end)
it("should replace invalid UTF-8 characters with multiple characters", function() it("should replace invalid UTF-8 characters with multiple characters", function()
assert.is_equal(util.fixUtf8("\127 \128 \194\127 ", "__"), "\127 __ __\127 ") assert.is_equal("\127 __ __\127 ", util.fixUtf8("\127 \128 \194\127 ", "__"))
end) end)
it("should replace invalid UTF-8 characters with empty char", function() it("should replace invalid UTF-8 characters with empty char", function()
assert.is_equal(util.fixUtf8("\127 \128 \194\127 ", ""), "\127 \127 ") assert.is_equal("\127 \127 ", util.fixUtf8("\127 \128 \194\127 ", ""))
end) end)
it("should not replace valid UTF-8 <20> character", function() it("should not replace valid UTF-8 <20> character", function()
assert.is_equal(util.fixUtf8("<EFBFBD>valid <20> char <20>", "__"), "<EFBFBD>valid <20> char <20>") assert.is_equal("<EFBFBD>valid <20> char <20>", util.fixUtf8("<EFBFBD>valid <20> char <20>", "__"))
end) end)
it("should not replace valid UTF-8 characters", function() it("should not replace valid UTF-8 characters", function()
assert.is_equal(util.fixUtf8("\99 \244\129\130\190", "_"), "\99 \244\129\130\190") assert.is_equal("\99 \244\129\130\190", util.fixUtf8("\99 \244\129\130\190", "_"))
end) end)
it("should not replace valid UTF-8 characters Polish chars", function() it("should not replace valid UTF-8 characters Polish chars", function()
assert.is_equal(util.fixUtf8("Pójdźże źółć", "_"), "Pójdźże źółć") assert.is_equal("Pójdźże źółć", util.fixUtf8("Pójdźże źółć", "_"))
end) end)
it("should not replace valid UTF-8 characters German chars", function() it("should not replace valid UTF-8 characters German chars", function()
assert.is_equal(util.fixUtf8("glück schließen", "_"), "glück schließen") assert.is_equal("glück schließen", util.fixUtf8("glück schließen", "_"))
end)
end) end)
describe("splitToArray()", function()
it("should split input to array", function() it("should split input to array", function()
assert.are_same(util.splitToArray("100\tabc\t\tdef\tghi200\t", "\t", true), assert.are_same({"100", "abc", "", "def", "ghi200"},
{"100", "abc", "", "def", "ghi200"}) util.splitToArray("100\tabc\t\tdef\tghi200\t", "\t", true))
end) end)
it("should also split input to array", function() it("should also split input to array", function()
assert.are_same(util.splitToArray("abcabcabcabca", "a", true), assert.are_same({"", "bc", "bc", "bc", "bc"},
{"", "bc", "bc", "bc", "bc"}) util.splitToArray("abcabcabcabca", "a", true))
end) end)
it("should split input to array without empty entities", function() it("should split input to array without empty entities", function()
assert.are_same(util.splitToArray("100 abc def ghi200 ", " ", false), assert.are_same({"100", "abc", "def", "ghi200"},
{"100", "abc", "def", "ghi200"}) util.splitToArray("100 abc def ghi200 ", " ", false))
end)
end) end)
describe("htmlToPlainTextIfHtml()", function()
it("should guess it is not HTML and let is as is", function() it("should guess it is not HTML and let is as is", function()
local s = "if (i < 0 && j < 0) j = i&amp;" local s = "if (i < 0 && j < 0) j = i&amp;"
assert.is_equal(util.htmlToPlainTextIfHtml(s), s) assert.is_equal(s, util.htmlToPlainTextIfHtml(s))
end) end)
it("should guess it is HTML and convert it to text", function() it("should guess it is HTML and convert it to text", function()
assert.is_equal(util.htmlToPlainTextIfHtml("<div> <br> Making <b>unit&nbsp;tests</b> is <i class='notreally'>fun &amp; n&#xE9;c&#233;ssaire</i><br/> </div>"), assert.is_equal("Making unit tests is fun & nécéssaire",
"Making unit tests is fun & nécéssaire") util.htmlToPlainTextIfHtml("<div> <br> Making <b>unit&nbsp;tests</b> is <i class='notreally'>fun &amp; n&#xE9;c&#233;ssaire</i><br/> </div>"))
end) end)
it("should guess it is double encoded HTML and convert it to text", function() it("should guess it is double encoded HTML and convert it to text", function()
assert.is_equal(util.htmlToPlainTextIfHtml("Deux parties.&lt;br&gt;Prologue.Désespérée, elle le tue...&lt;br&gt;Première partie. Sur la route &amp;amp; dans la nuit"), assert.is_equal("Deux parties.\nPrologue.Désespérée, elle le tue...\nPremière partie. Sur la route & dans la nuit",
"Deux parties.\nPrologue.Désespérée, elle le tue...\nPremière partie. Sur la route & dans la nuit") util.htmlToPlainTextIfHtml("Deux parties.&lt;br&gt;Prologue.Désespérée, elle le tue...&lt;br&gt;Première partie. Sur la route &amp;amp; dans la nuit"))
end)
end) end)
describe("isEmptyDir()", function()
it("should return true on empty dir", function() it("should return true on empty dir", function()
assert.is_equal(util.isEmptyDir(DataStorage:getDataDir() .. "/data/dict"), -- should be empty during unit tests assert.is_true(util.isEmptyDir(DataStorage:getDataDir() .. "/data/dict")) -- should be empty during unit tests
true)
end) end)
it("should return false on non-empty dir", function() it("should return false on non-empty dir", function()
assert.is_equal(util.isEmptyDir(DataStorage:getDataDir()), -- should contain subdirectories assert.is_false(util.isEmptyDir(DataStorage:getDataDir())) -- should contain subdirectories
false)
end) end)
it("should return nil on non-existent dir", function() it("should return nil on non-existent dir", function()
assert.is_equal(util.isEmptyDir("/this/is/just/some/nonsense/really/this/should/not/exist"), assert.is_nil(util.isEmptyDir("/this/is/just/some/nonsense/really/this/should/not/exist"))
nil) end)
end)
describe("secondsToClock()", function()
it("should convert seconds to 00:00 format", function()
assert.is_equal("00:00",
util.secondsToClock(0, true))
assert.is_equal("00:01",
util.secondsToClock(60, true))
end)
it("should round seconds to minutes in 00:00 format", function()
assert.is_equal("00:01",
util.secondsToClock(89, true))
assert.is_equal("00:02",
util.secondsToClock(90, true))
assert.is_equal("00:02",
util.secondsToClock(110, true))
assert.is_equal("00:02",
util.secondsToClock(120, true))
end)
it("should convert seconds to 00:00:00 format", function()
assert.is_equal("00:00:00",
util.secondsToClock(0))
assert.is_equal("00:01:00",
util.secondsToClock(60))
assert.is_equal("00:01:29",
util.secondsToClock(89))
assert.is_equal("00:01:30",
util.secondsToClock(90))
assert.is_equal("00:01:50",
util.secondsToClock(110))
assert.is_equal("00:02:00",
util.secondsToClock(120))
end)
end) end)
end) end)

Write Preview
Loading…
Cancel
Save