Refactor: migrate to JitPack-compatible package structure and add intallation docs

[mike-d-davydov]

Pull Request

Description

Migrate JPWise library package structure to be JitPack-compatible by changing the package name from com.functest.jpwise to io.github.mikeddavydov and updating all related configurations.

Type of Change

• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• Documentation update
• Code refactoring

Changes Made

• Package renamed: com.functest.jpwise → io.github.mikeddavydov
• Maven groupId updated: Changed to io.github.mikeddavydov for JitPack compatibility
• All source files moved to new package structure (src/main/java/io/github/mikeddavydov/)
• All test files moved to new package structure (src/test/java/io/github/mikeddavydov/)
• Import statements updated across all Java files using automated refactoring
• README.md updated with comprehensive JitPack installation instructions
• Old package directories removed after successful migration

Testing

• All existing tests pass (93/93 tests passing)
• New tests have been added for new functionality (N/A - refactoring only)
• Manual testing has been performed (local builds and git hooks tested)
• Code coverage has been maintained or improved (maintained with Jacoco)

Checklist

• My code follows the project's coding standards
• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• I have added tests that prove my fix is effective or that my feature works
• New and existing unit tests pass locally with my changes

Related Issues

Enables JitPack distribution for easier dependency management without requiring Maven Central publishing.

JitPack Benefits

• Automatic building from GitHub releases/tags
• No manual publishing to Maven Central required
• Version management through Git tags
• Easy dependency management for users

Breaking Changes

⚠️ This is a breaking change for existing users

For Library Users

Users must update their import statements and dependency coordinates:

Import Changes

// Old imports import com.functest.jpwise.JPWise; import com.functest.jpwise.core.*; // New imports  import io.github.mikeddavydov.JPWise; import io.github.mikeddavydov.core.*;

Dependency Changes

<!-- Old Maven dependency --> <dependency> <groupId>com.functest</groupId> <artifactId>jpwise</artifactId> <version>1.0-SNAPSHOT</version> </dependency> <!-- New JitPack dependency --> <repositories> <repository> <id>jitpack.io</id> <url>https://jitpack.io</url> </repository> </repositories> <dependency> <groupId>io.github.mikeddavydov</groupId> <artifactId>jpwise</artifactId> <version>Tag</version> </dependency>

Additional Notes

• All 93 tests continue to pass after the package migration
• No functional changes to the library API - only package structure changed
• JitPack installation instructions added to README.md
• This enables easier distribution and version management through GitHub releases

[github-actions]

Test Results (Java 17)

11 files  ±0  11 suites  ±0   0s ⏱️ ±0s
87 tests ±0  87 ✅ ±0  0 💤 ±0  0 ❌ ±0 
93 runs  ±0  93 ✅ ±0  0 💤 ±0  0 ❌ ±0 

Results for commit ddab68d. ± Comparison against base commit d55170d.

This pull request removes 87 and adds 87 tests. Note that renamed tests count towards both.

com.functest.jpwise.JPWiseTest ‑ testBuildAndGenerateSeparately com.functest.jpwise.JPWiseTest ‑ testBuilderFactoryMethods com.functest.jpwise.JPWiseTest ‑ testCombinatorialWithLimit com.functest.jpwise.JPWiseTest ‑ testCustomCombinatorialAlgorithm com.functest.jpwise.JPWiseTest ‑ testCustomPairwiseAlgorithm com.functest.jpwise.JPWiseTest ‑ testDirectCombinatorialGeneration com.functest.jpwise.JPWiseTest ‑ testDirectCombinatorialGenerationWithAlgorithm com.functest.jpwise.JPWiseTest ‑ testDirectCombinatorialGenerationWithLimit com.functest.jpwise.JPWiseTest ‑ testDirectPairwiseGeneration com.functest.jpwise.JPWiseTest ‑ testDirectPairwiseGenerationWithAlgorithm … 

io.github.mikeddavydov.JPWiseTest ‑ testBuildAndGenerateSeparately io.github.mikeddavydov.JPWiseTest ‑ testBuilderFactoryMethods io.github.mikeddavydov.JPWiseTest ‑ testCombinatorialWithLimit io.github.mikeddavydov.JPWiseTest ‑ testCustomCombinatorialAlgorithm io.github.mikeddavydov.JPWiseTest ‑ testCustomPairwiseAlgorithm io.github.mikeddavydov.JPWiseTest ‑ testDirectCombinatorialGeneration io.github.mikeddavydov.JPWiseTest ‑ testDirectCombinatorialGenerationWithAlgorithm io.github.mikeddavydov.JPWiseTest ‑ testDirectCombinatorialGenerationWithLimit io.github.mikeddavydov.JPWiseTest ‑ testDirectPairwiseGeneration io.github.mikeddavydov.JPWiseTest ‑ testDirectPairwiseGenerationWithAlgorithm … 

[github-actions]

Test Results (Java 11)

11 files  ±0  11 suites  ±0   0s ⏱️ ±0s
87 tests ±0  87 ✅ ±0  0 💤 ±0  0 ❌ ±0 
93 runs  ±0  93 ✅ ±0  0 💤 ±0  0 ❌ ±0 

Results for commit ddab68d. ± Comparison against base commit d55170d.

This pull request removes 87 and adds 87 tests. Note that renamed tests count towards both.

com.functest.jpwise.JPWiseTest ‑ testBuildAndGenerateSeparately com.functest.jpwise.JPWiseTest ‑ testBuilderFactoryMethods com.functest.jpwise.JPWiseTest ‑ testCombinatorialWithLimit com.functest.jpwise.JPWiseTest ‑ testCustomCombinatorialAlgorithm com.functest.jpwise.JPWiseTest ‑ testCustomPairwiseAlgorithm com.functest.jpwise.JPWiseTest ‑ testDirectCombinatorialGeneration com.functest.jpwise.JPWiseTest ‑ testDirectCombinatorialGenerationWithAlgorithm com.functest.jpwise.JPWiseTest ‑ testDirectCombinatorialGenerationWithLimit com.functest.jpwise.JPWiseTest ‑ testDirectPairwiseGeneration com.functest.jpwise.JPWiseTest ‑ testDirectPairwiseGenerationWithAlgorithm … 

io.github.mikeddavydov.JPWiseTest ‑ testBuildAndGenerateSeparately io.github.mikeddavydov.JPWiseTest ‑ testBuilderFactoryMethods io.github.mikeddavydov.JPWiseTest ‑ testCombinatorialWithLimit io.github.mikeddavydov.JPWiseTest ‑ testCustomCombinatorialAlgorithm io.github.mikeddavydov.JPWiseTest ‑ testCustomPairwiseAlgorithm io.github.mikeddavydov.JPWiseTest ‑ testDirectCombinatorialGeneration io.github.mikeddavydov.JPWiseTest ‑ testDirectCombinatorialGenerationWithAlgorithm io.github.mikeddavydov.JPWiseTest ‑ testDirectCombinatorialGenerationWithLimit io.github.mikeddavydov.JPWiseTest ‑ testDirectPairwiseGeneration io.github.mikeddavydov.JPWiseTest ‑ testDirectPairwiseGenerationWithAlgorithm …