5 Commits

Author SHA1 Message Date
b95f90b7ec docs: mention direnv in README bootstrap section 2026-03-27 23:30:41 +01:00
c55d862e14 chore: add .envrc for direnv integration 2026-03-27 23:28:09 +01:00
df29d4f1c3 docs: add README with bootstrap, run and test instructions 2026-03-27 23:27:15 +01:00
25e086b62e feat: add Nix flake for dev environment
Provide a reproducible dev shell with JDK 17 and Maven 3.9.x.
JDK 17 (LTS) is used since JDK 16 (project target) is non-LTS
and unavailable in nixpkgs; it is fully backward-compatible with
--source 16 --target 16. Maven is overridden via overlay to use
the same JDK.
2026-03-27 23:25:07 +01:00
1cabbd0224 Merge pull request 'test: add ResizeHandle enum unit tests' (#22) from issue-12/resize-handle-tests into master
All checks were successful
CI / build-and-test (push) Successful in 18s
Reviewed-on: #22
2026-03-27 18:06:55 +00:00
4 changed files with 130 additions and 0 deletions

1
.envrc Normal file
View File

@@ -0,0 +1 @@
use flake

54
README.md Normal file
View File

@@ -0,0 +1,54 @@
# new-shapes
A shape editor desktop application built with Java Swing. Supports rectangles, circles, triangles, text, shape collections, resize handles, and export to HTML/SVG.
## Prerequisites
- JDK >= 16 (project targets Java 16)
- A graphical display (X11/Wayland) since this is a Swing GUI application
## Bootstrap
### With Nix (recommended)
If you have [direnv](https://direnv.net/) installed, the environment activates automatically:
```sh
direnv allow # one-time, then auto-activates on cd
```
Otherwise, enter the dev shell manually:
```sh
nix develop
```
Both provide JDK 17 and Maven 3.9.x preconfigured. No other setup needed.
### Without Nix
Install JDK 16+ and use the bundled Maven wrapper — no separate Maven installation required:
```sh
./mvnw --version # downloads Maven 3.9.12 on first run
```
## Run the application
```sh
./mvnw compile exec:java -Dexec.mainClass="ovh.gasser.newshapes.App"
```
## Run tests
```sh
./mvnw test
```
To run the full verification pipeline (compile, test, JaCoCo coverage check with 50% minimum line coverage):
```sh
./mvnw verify
```
Coverage reports are generated in `target/site/jacoco/`.

27
flake.lock generated Normal file
View File

@@ -0,0 +1,27 @@
{
"nodes": {
"nixpkgs": {
"locked": {
"lastModified": 1774386573,
"narHash": "sha256-4hAV26quOxdC6iyG7kYaZcM3VOskcPUrdCQd/nx8obc=",
"owner": "nixos",
"repo": "nixpkgs",
"rev": "46db2e09e1d3f113a13c0d7b81e2f221c63b8ce9",
"type": "github"
},
"original": {
"owner": "nixos",
"ref": "nixos-unstable",
"repo": "nixpkgs",
"type": "github"
}
},
"root": {
"inputs": {
"nixpkgs": "nixpkgs"
}
}
},
"root": "root",
"version": 7
}

48
flake.nix Normal file
View File

@@ -0,0 +1,48 @@
{
description = "new-shapes - Java Swing shape editor";
inputs.nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable";
outputs = { self, nixpkgs }:
let
# JDK 16 (project target) is non-LTS and unavailable in nixpkgs.
# JDK 17 (LTS) is fully backward-compatible with --source 16 --target 16.
javaVersion = 17;
supportedSystems = [ "x86_64-linux" "aarch64-linux" "x86_64-darwin" "aarch64-darwin" ];
forEachSystem = f:
nixpkgs.lib.genAttrs supportedSystems (system: f {
pkgs = import nixpkgs {
inherit system;
overlays = [ self.overlays.default ];
};
});
in
{
overlays.default = final: prev:
let
jdk = prev."jdk${toString javaVersion}";
in
{
inherit jdk;
# Override Maven to use the same JDK version
maven = prev.maven.override { jdk_headless = jdk; };
};
devShells = forEachSystem ({ pkgs }: {
default = pkgs.mkShell {
packages = with pkgs; [
jdk
maven
];
shellHook = ''
echo "new-shapes dev shell"
echo " Java: $(java -version 2>&1 | head -1)"
echo " Maven: $(mvn -version 2>&1 | head -1)"
'';
};
});
};
}