Skip to content

Processes a language dictionary to find fun words

Notifications You must be signed in to change notification settings

ljacqu/wordeval

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

wordeval

Build Status Coverage Status Code Climate

Java application that processes dictionaries of various languages to find "interesting" words based on various criteria. The results are exported as JSON so they can be displayed by another module (planned).

Requirements

  • Java 17
  • Requires you install the Lombok plugin for your IDE or you won't see the accessors and builders it generates
  • Maven

General setup

  • Indentation with two spaces
  • 120 characters as max line width
  • JavaDoc on all public members

Technical layout

An Evaluator processes words and decides (based on its criteria) whether it keeps the words in its results. A Dictionary object takes a list of evaluators as argument. As it loads the words from its file, it passes it to the list of evaluators it received, allowing them to decide how "interesting" that word is individually. Once the dictionary has finished, the result of each evaluator is converted to an ExportObject; all together are then exported as JSON.

Certain evaluators yield a lot of results; we only keep the most interesting results in the export object and all others are aggregated, i.e. we only store the number of words found for the remaining entries.

The current tests yield a coverage of 80% over the project's code base and can serve as a good entry point to understand the purpose of a class.

About

Processes a language dictionary to find fun words

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages