jasonmfehr / combiner-maven-plugin Goto Github PK

Replace all tab characters in all files with 4 spaces

The LogHolder class has the static getParamLogger() method to retrieve the ParameterizedLogger. Switch to an all injected logging system. The pit exclusions will also need to be updated to ignore the new logger methods.

Several fields have a defaultValue specified on their Parameter annotation. Maven does not detect this and use it as the default value of that field. This necessitates CombinationDefaultsManager class. Figure out why this annotation is not properly detected by maven

The build should include a badge in the README.md file. It should also include a test/pit coverage badge.

Setup the maven-surefire-plugin to run unit tests in parallel.

In several classes (both main and test), the file path separator is hardcoded to a forward slash. Determine if this solution is acceptable or if the platform specific file separator character should be used.

also add the maven central badge to the README.md file:

The configuration of the plugins within the profiles should be moved to the pluginsManagement section. This way, the plugins can be executed from the command line without having to specify a profile.

As part of the maven build, run the checkstyle or pmd maven plugin.

Add the test reports for unit tests (surefire), mutation tests (pit), and integration tests (invoker) to the site.

Javadoc is missing or incorrect in most places. Review all classes and add/fix javadoc as necessary.

Each combination executes serially one after the other. Implement the ability to use a thread pool to process combinations in parallel.

The tag information is not present in the scm url section of the manifest. Need to either add the ${scm.tag} property to the manifest or update the scm-url entry in the manifest to ${scm.url}/tree/${scm.tag}

For any strings embedded within double quotes in the classes, move the ones that make sense into class level static final strings.

There is no documentation on how to use this plugin . Update the README.MD file to have instructions about how to use the plugin as well as some explanations of the decisions behind why it operates the way it does. Also set up the maven site documentation.

http://jasonmfehr.github.io/combiner-maven-plugin/

Setup the scm section with links to the github repo. Also uncomment the scm-url manifest entry in the maven-jar-plugin.

The maven site is generated using ${project.version} as its version. Once a release happens, switch to the build-helper-maven-plugin for the plugin version in the maven site so the site lists the latest release instead of the snapshot version.

Also, add the maven central badge to README.MD

http://mojo.codehaus.org/build-helper-maven-plugin/released-version-mojo.html

Move from com.jfehr to com.github.jasonmfehr as the package structure to match the new groupid

Move away from plexus as the dependency injection mechanism. Switch to the new Guice DI container.

Investigate making this change backwards compatible, but it is not necessary. Switch to version 2.0 if backwards compatibility is not maintained.

Add a check that the minimum maven version to use Guice is the version that the plugin is executing within via the section of the pom

Add the maven -B flag to the Travis city configuration

Some unit tests utilize the src/test/resources/tmp folder as a placeholder for files that are created and deleted during the running of the tests. These tests all need to be switched to utilize JUnit's TemporaryFolder rule to create temp folders for the tests.

https://github.com/junit-team/junit/wiki/Rules

All unit tests within the following test classes will need to be changed:
com.jfehr.combiner.file.MultiFileReaderTest
com.jfehr.combiner.output.FileOutputSourceWriterTest
com.jfehr.combiner.file.FileValidatorTest

Development of the combiner-maven-plugin was done on a Mac and the Travis-CI build runs on Linux. This plugin has not been tested on Windows yet. Run the maven build for this plugin and execute all unit and integration tests on a Windows machine.

Switch ta multi-module setup where the APIs are in their own jar and the plugin is in is own jar. This setup will allow for consumers to create their own implementations of the four pipeline stage interfaces.

Several plugins within the pom are not covered by a lifecycle configuration. Add the lifecycle-mapping plugin to plugins management and configure it to resolve these issues.

The only licensing info is in the LICENSE file. Add the MIT license to all classes.

There is plugin configuration within the <plugins> section of the parent pom. All plugin configuration should be within <pluginsManagement>

Swap out the unit test asserts with org.junit.Assert.assertThat statements.

https://github.com/junit-team/junit/wiki/Matchers-and-assertthat

The PipelineExecutor class is excessively coupled. It relies on too many other classes. Review this class to see if it can be refactored to have dependencies on a fewer number of classes.

The order that input resources are processed is undefined. Implement a way to specify the order in which the input resources are processed. My initial thought is to add a fifth stage between the input and transform stages that passes in a Map of resources backed by a LinkedHashMap that can be re-ordered

An error will be thrown if an input resource is missing. Currently only files are allowed as input resources. Add a pom configuration option to ignore missing input resources.

The design of the exception classes needs to be examined and refactored into a design that makes more sense. Additionally, the classes are still in the old package structure under com.jfehr.tojs.exception. Move them into the new packages structure com.jfehr.combiner.something

The only automated testing is unit testing. Implement integration tests that run both in an IDE and as part of the maven build.

Create a test that covers the case where no transformers are specified in the pom.
Create a test where no resources are found (should fail)

When constructing an object, the ObjectFactory will first attempt to instantiate the object using a constructor that takes a ParameterizedLogger thus injecting the logger via the constructor. However, for objects retrieved from the plexus container, there is no way to inject the logger.

Add a setLogger(ParameterizedLogger logger) method to the four pipeline stage interfaces and remove the ability to inject loggers via constructors.

Create a ResourceCombiner implementation that appends the contents of each resource together.

In the combiner-maven-plugin module, include the combiner-maven-plugin-api javadoc so the maven site can be self contained.