Initial big commit

Author: evasseure

.formatter.exs

@@ -0,0 +1,5 @@
+# Used by "mix format"
+[
+  line_length: 120,
+  inputs: ["{mix,.formatter}.exs", "{config,lib,test}/**/*.{ex,exs}"]
+]

.gitignore

@@ -0,0 +1,28 @@
+# The directory Mix will write compiled artifacts to.
+/_build/
+
+# If you run "mix test --cover", coverage assets end up here.
+/cover/
+
+# The directory Mix downloads your dependencies sources to.
+/deps/
+
+# Where third-party dependencies like ExDoc output generated docs.
+/doc/
+
+# Ignore .fetch files in case you like to edit your project deps locally.
+/.fetch
+
+# If the VM crashes, it generates a dump, let's ignore it too.
+erl_crash.dump
+
+# Also ignore archive artifacts (built via "mix archive.build").
+*.ez
+
+# Ignore package tarball (built via "mix hex.build").
+checkcheckcheck-*.tar
+
+# Temporary files, for example, from tests.
+/tmp/
+
+.elixir_ls

README.md

@@ -0,0 +1,47 @@
+# checkcheckcheck
+
+A small Spelling Corrector written with Elixir to discover the language, and learn some new things!
+
+## Usage
+
+To get errors and suggestions from an input file or a string:  
+`mix correct FILE_PATH | STRING`
+
+## Examples
+
+```
+$ mix correct "hello wrld waht is up?
+Errors in input:
+Word: wrld, Suggestions: [world, wild, weld]
+Word: waht, Suggestions: [what, wat, wah]
+```
+
+```
+$ ex: `mix correct ./data/inputs/ashford-short.txt`
+Errors in input:
+Word: peaple, Suggestions: [people, peale, pepple]
+Word: salteena, Suggestions: []
+Word: wiskers, Suggestions: [whiskers, weskers, wishers]
+... lots more
+```
+
+## Running tests
+
+Simply run: `mix test`
+
+## Performance tests
+
+`./data/inputs/ashford-short.txt`  
+Total time: 1.176746s  
+Words: 490  
+Words per second: 416.41 word/s
+
+`./data/inputs/ashford.txt`  
+Total time: 58.445784s  
+Words: 12,484  
+Words per second: 213.6 word/s
+
+`"hello wrld waht is up?"`  
+Total time: 0.104436s  
+Words: 5  
+Words per second: 47.88 word/s

TODO.md

@@ -0,0 +1,3 @@
+- [ ] Have a better dictionnary, with probability
+- [ ] Be faster?
+- [ ] Give up this project and start something new to also give up