Norconex / importer

Norconex Importer is a Java library and command-line application meant to "parse" and "extract" content out of a file as plain text, whatever its format (HTML, PDF, Word, etc). In addition, it allows you to perform any manipulation on the extracted text before using it in your own service or application.
http://www.norconex.com/collectors/importer/
Apache License 2.0
33 stars 23 forks source link

W21 SENG401 #113

Closed youup99 closed 3 years ago

youup99 commented 3 years ago

Hello! My name is Youup Kim. My colleague Youstina Attia (@youstina-attia) and I created this PR for an undergraduate Software Architecture course at the University of Calgary.

Our assignment requirements were to perform refactoring and introduce a software pattern into a pre-existing repository. Yours (Norconex Importer) was one of the repositories we selected.

This PR was not tested!!! We don't want to break your project, but we also most likely don't have the time commitment to test our changes.

We opened this PR so that if any current or future maintainer is interested, they can give it a look and decide if something like this is desirable for the repo.

This PR introduces a Singleton Pattern for all of the util classes. This would allow the class to be tested and extended for future maintainability and extensibility.

We also wanted to note that the BufferUtil.java file could be removed as it is never referenced in any part of the project.

essiembre commented 3 years ago

Thank you for your interest in this project. There is no need for this project to keep singleton instances around for utility classes. Nothing prevents adding unit tests to static methods. You are welcomed to add more Junit test coverage where you feel more are needed.