Skip to content

Commit ddab68d

Browse files
mike-d-davydovmike-d-davydov
committed
refactor: migrate to JitPack-compatible package structure and add installation docs
1 parent ac12ac3 commit ddab68d

31 files changed

+122
-68
lines changed

‎README.md‎

Lines changed: 57 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -62,12 +62,66 @@ JPWise uses specific terminology to describe its concepts:
6262

6363
## Installation
6464

65-
Add to your pom.xml:
65+
### Using JitPack (Recommended)
66+
67+
JPWise is available through [JitPack](https://jitpack.io), which builds the library automatically from GitHub releases.
68+
69+
#### Maven
70+
Add the JitPack repository to your `pom.xml`:
71+
```xml
72+
<repositories>
73+
<repository>
74+
<id>jitpack.io</id>
75+
<url>https://jitpack.io</url>
76+
</repository>
77+
</repositories>
78+
```
79+
80+
Then add the dependency:
81+
```xml
82+
<dependency>
83+
<groupId>com.github.mikeddavydov</groupId>
84+
<artifactId>jpwise</artifactId>
85+
<version>v1.0.0</version>
86+
</dependency>
87+
```
88+
89+
#### Gradle
90+
Add the JitPack repository to your `build.gradle`:
91+
```gradle
92+
repositories {
93+
maven { url 'https://jitpack.io' }
94+
}
95+
```
96+
97+
Then add the dependency:
98+
```gradle
99+
dependencies {
100+
implementation 'com.github.mikeddavydov:jpwise:v1.0.0'
101+
}
102+
```
103+
104+
#### How JitPack Works
105+
- JitPack automatically builds the library when you request it
106+
- The first build may take a few minutes, subsequent requests are served from cache
107+
- Use Git tags (like `v1.0.0`) or commit hashes as versions
108+
- Check build status at: https://jitpack.io/#mikeddavydov/jpwise
109+
110+
### Alternative: Local Installation
111+
112+
If you prefer to build locally, clone the repository and install:
113+
```bash
114+
git clone https://github.com/mikeddavydov/jpwise.git
115+
cd jpwise
116+
mvn clean install
117+
```
118+
119+
Then add to your pom.xml:
66120
```xml
67121
<dependency>
68-
<groupId>com.functest</groupId>
122+
<groupId>io.github.mikeddavydov</groupId>
69123
<artifactId>jpwise</artifactId>
70-
<version>1.0.0</version>
124+
<version>1.0-SNAPSHOT</version>
71125
</dependency>
72126
```
73127

‎pom.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
55
<modelVersion>4.0.0</modelVersion>
66

7-
<groupId>com.functest.jpwise</groupId>
7+
<groupId>io.github.mikeddavydov</groupId>
88
<artifactId>jpwise</artifactId>
99
<version>1.0-SNAPSHOT</version>
1010

‎src/main/java/com/functest/jpwise/JPWise.java‎ renamed to ‎src/main/java/io/github/mikeddavydov/JPWise.java‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
1-
package com.functest.jpwise;
1+
package io.github.mikeddavydov;
22

33
import java.util.Arrays;
44
import java.util.Collection;
55
import java.util.List;
66
import java.util.Objects;
77

8-
import com.functest.jpwise.algo.CombinatorialAlgorithm;
9-
import com.functest.jpwise.algo.PairwiseAlgorithm;
10-
import com.functest.jpwise.core.CombinationTable;
11-
import com.functest.jpwise.core.CompatibilityPredicate;
12-
import com.functest.jpwise.core.EquivalencePartition;
13-
import com.functest.jpwise.core.GenerationAlgorithm;
14-
import com.functest.jpwise.core.TestGenerator;
15-
import com.functest.jpwise.core.TestInput;
16-
import com.functest.jpwise.core.TestParameter;
8+
import io.github.mikeddavydov.algo.CombinatorialAlgorithm;
9+
import io.github.mikeddavydov.algo.PairwiseAlgorithm;
10+
import io.github.mikeddavydov.core.CombinationTable;
11+
import io.github.mikeddavydov.core.CompatibilityPredicate;
12+
import io.github.mikeddavydov.core.EquivalencePartition;
13+
import io.github.mikeddavydov.core.GenerationAlgorithm;
14+
import io.github.mikeddavydov.core.TestGenerator;
15+
import io.github.mikeddavydov.core.TestInput;
16+
import io.github.mikeddavydov.core.TestParameter;
1717

1818
/**
1919
* A facade class providing a simplified API for the JPWise test generation framework. This class

‎src/main/java/com/functest/jpwise/algo/CombinatorialAlgorithm.java‎ renamed to ‎src/main/java/io/github/mikeddavydov/algo/CombinatorialAlgorithm.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
package com.functest.jpwise.algo;
1+
package io.github.mikeddavydov.algo;
22

33
import java.util.ArrayList;
44
import java.util.Collections;
55
import java.util.List;
66

7-
import com.functest.jpwise.core.*;
7+
import io.github.mikeddavydov.core.*;
88

99
/**
1010
* Implements a full combinatorial test case generation algorithm. This algorithm generates all

‎src/main/java/com/functest/jpwise/algo/LegacyPairwiseAlgorithm.java‎ renamed to ‎src/main/java/io/github/mikeddavydov/algo/LegacyPairwiseAlgorithm.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
package com.functest.jpwise.algo;
1+
package io.github.mikeddavydov.algo;
22

33
import java.util.*;
44

55
import org.slf4j.Logger;
66
import org.slf4j.LoggerFactory;
77

8-
import com.functest.jpwise.core.*;
8+
import io.github.mikeddavydov.core.*;
99
import com.google.common.base.Preconditions;
1010

1111
/**

‎src/main/java/com/functest/jpwise/algo/PairwiseAlgorithm.java‎ renamed to ‎src/main/java/io/github/mikeddavydov/algo/PairwiseAlgorithm.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
package com.functest.jpwise.algo;
1+
package io.github.mikeddavydov.algo;
22

33
import java.util.*;
44

55
import org.slf4j.Logger;
66
import org.slf4j.LoggerFactory;
77

8-
import com.functest.jpwise.core.*;
8+
import io.github.mikeddavydov.core.*;
99
import com.google.common.base.Preconditions;
1010

1111
/**

‎src/main/java/com/functest/jpwise/core/BaseEquivalencePartition.java‎ renamed to ‎src/main/java/io/github/mikeddavydov/core/BaseEquivalencePartition.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package com.functest.jpwise.core;
1+
package io.github.mikeddavydov.core;
22

33
/**
44
* Base class for equivalence partitions. An equivalence partition represents a set of values that

‎src/main/java/com/functest/jpwise/core/Combination.java‎ renamed to ‎src/main/java/io/github/mikeddavydov/core/Combination.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
* DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
1717
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
1818
*/
19-
package com.functest.jpwise.core;
19+
package io.github.mikeddavydov.core;
2020

2121
import java.util.ArrayList;
2222
import java.util.Arrays;

‎src/main/java/com/functest/jpwise/core/CombinationTable.java‎ renamed to ‎src/main/java/io/github/mikeddavydov/core/CombinationTable.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
* DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
1717
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
1818
*/
19-
package com.functest.jpwise.core;
19+
package io.github.mikeddavydov.core;
2020

2121
import java.util.ArrayList;
2222
import java.util.HashMap;

‎src/main/java/com/functest/jpwise/core/CompatibilityPredicate.java‎ renamed to ‎src/main/java/io/github/mikeddavydov/core/CompatibilityPredicate.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package com.functest.jpwise.core;
1+
package io.github.mikeddavydov.core;
22

33
/**
44
* @author DavydovMD Date: 20.06.13 Time: 14:16

0 commit comments

Comments
 (0)