Skip to content

Commit 76cb4eb

Browse files
andrusandrus
committed
Refactoring: reorg Maven modules for reusability #84
* reanming...
1 parent d4048d3 commit 76cb4eb

12 files changed

Lines changed: 40 additions & 40 deletions

File tree

‎DEV-GUIDE.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ On MacOS and Linux, run the following commands:
77
```bash
88
mvn clean package
99
unzip -u jjava-distro/target/jjava-*-kernelspec.zip -d jjava-distro/target/unzip
10-
jupyter kernelspec remove java
10+
jupyter kernelspec remove -y java
1111
jupyter kernelspec install jjava-distro/target/unzip --name=java --user
1212
```
1313

‎jjava-distro/src/main/java/org/dflib/jjava/distro/JJava.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
import org.dflib.jjava.jupyter.channels.JupyterConnection;
44
import org.dflib.jjava.jupyter.channels.JupyterSocket;
55
import org.dflib.jjava.jupyter.kernel.KernelConnectionProperties;
6-
import org.dflib.jjava.kernel.JJavaKernel;
6+
import org.dflib.jjava.kernel.JavaKernel;
77
import org.dflib.jjava.kernel.magics.ClasspathMagic;
88
import org.dflib.jjava.kernel.magics.JarsMagic;
99
import org.dflib.jjava.kernel.magics.LoadCodeMagic;
@@ -47,7 +47,7 @@ public static void main(String[] args) throws Exception {
4747

4848
Properties pomProps = loadPomProps();
4949

50-
JJavaKernel kernel = JJavaKernel.builder()
50+
JavaKernel kernel = JavaKernel.builder()
5151
.name("JJava")
5252
.version((String) pomProps.getOrDefault("version", ""))
5353

jjava-kernel/src/main/java/org/dflib/jjava/kernel/JJavaKernel.java renamed to jjava-kernel/src/main/java/org/dflib/jjava/kernel/JavaKernel.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@
4040
/**
4141
* A Jupyter kernel for Java programming language.
4242
*/
43-
public class JJavaKernel extends BaseKernel {
43+
public class JavaKernel extends BaseKernel {
4444

4545
private static final CharPredicate IDENTIFIER_CHAR = CharPredicate.builder()
4646
.inRange('a', 'z')
@@ -63,7 +63,7 @@ public static Builder builder() {
6363
private final JShell jShell;
6464
private final CodeEvaluator evaluator;
6565

66-
protected JJavaKernel(
66+
protected JavaKernel(
6767
String name,
6868
String version,
6969
LanguageInfo languageInfo,
@@ -356,12 +356,12 @@ public JShell getJShell() {
356356
return jShell;
357357
}
358358

359-
public static class Builder extends JJavaKernelBuilder<Builder, JJavaKernel> {
359+
public static class Builder extends JavaKernelBuilder<Builder, JavaKernel> {
360360
private Builder() {
361361
}
362362

363363
@Override
364-
public JJavaKernel build() {
364+
public JavaKernel build() {
365365

366366
String name = buildName();
367367
Charset jupyterEncoding = buildJupyterIOEncoding();
@@ -370,7 +370,7 @@ public JJavaKernel build() {
370370
LanguageInfo langInfo = buildLanguageInfo();
371371
MagicTranspiler magicTranspiler = buildMagicTranspiler();
372372

373-
return new JJavaKernel(
373+
return new JavaKernel(
374374
name,
375375
buildVersion(),
376376
langInfo,

jjava-kernel/src/main/java/org/dflib/jjava/kernel/JJavaKernelBuilder.java renamed to jjava-kernel/src/main/java/org/dflib/jjava/kernel/JavaKernelBuilder.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,9 @@
2020
/**
2121
* A common builder superclass for JJavaKernel and subclasses.
2222
*/
23-
public abstract class JJavaKernelBuilder<
24-
B extends JJavaKernelBuilder<B, K>,
25-
K extends JJavaKernel> extends BaseKernelBuilder<B, K> {
23+
public abstract class JavaKernelBuilder<
24+
B extends JavaKernelBuilder<B, K>,
25+
K extends JavaKernel> extends BaseKernelBuilder<B, K> {
2626

2727
protected final String jShellExecControlID;
2828
protected JJavaExecutionControlProvider jShellExecControlProvider;
@@ -31,7 +31,7 @@ public abstract class JJavaKernelBuilder<
3131
protected final List<String> compilerOpts;
3232
protected final List<String> extraClasspath;
3333

34-
protected JJavaKernelBuilder() {
34+
protected JavaKernelBuilder() {
3535
this.jShellExecControlID = UUID.randomUUID().toString();
3636
this.startupSnippets = new ArrayList<>();
3737
this.compilerOpts = new ArrayList<>();

‎jjava-kernel/src/main/java/org/dflib/jjava/kernel/JavaNotebookStatics.java‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ public class JavaNotebookStatics implements Extension {
1313

1414
private static final String STARTUP_SCRIPT = "import static org.dflib.jjava.kernel.JavaNotebookStatics.*;";
1515

16-
private static JJavaKernel kernel;
16+
private static JavaKernel kernel;
1717

1818
@Override
1919
public void install(BaseKernel kernel) {
@@ -22,26 +22,26 @@ public void install(BaseKernel kernel) {
2222
throw new IllegalStateException("Already initialized with another kernel: " + JavaNotebookStatics.kernel.getBanner());
2323
}
2424

25-
if (kernel instanceof JJavaKernel) {
25+
if (kernel instanceof JavaKernel) {
2626
kernel.eval(STARTUP_SCRIPT);
27-
JavaNotebookStatics.kernel = (JJavaKernel) kernel;
27+
JavaNotebookStatics.kernel = (JavaKernel) kernel;
2828
} else {
2929
// TODO: should we have some kind of abstract logger?
30-
System.err.println("Ignoring unexpected kernel '" + kernel.getClass().getName() + "'. Only '" + JJavaKernel.class.getName() + "' is supported.");
30+
System.err.println("Ignoring unexpected kernel '" + kernel.getClass().getName() + "'. Only '" + JavaKernel.class.getName() + "' is supported.");
3131
}
3232
}
3333

3434
/**
3535
* @deprecated in favor of {@link #kernel()}
3636
*/
3737
@Deprecated(since = "1.0", forRemoval = true)
38-
public static JJavaKernel getKernelInstance() {
38+
public static JavaKernel getKernelInstance() {
3939
// TODO: should we have some kind of abstract logger?
4040
System.err.println("'getKernelInstance()' was deprecated in favor of 'kernel()' and will be eventually removed.");
4141
return kernel();
4242
}
4343

44-
public static JJavaKernel kernel() {
44+
public static JavaKernel kernel() {
4545
return Objects.requireNonNull(
4646
JavaNotebookStatics.kernel,
4747
"No Java kernel running. Likely called outside of the notebook lifecycle");

‎jjava-kernel/src/main/java/org/dflib/jjava/kernel/magics/ClasspathMagic.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
package org.dflib.jjava.kernel.magics;
22

3-
import org.dflib.jjava.kernel.JJavaKernel;
3+
import org.dflib.jjava.kernel.JavaKernel;
44
import org.dflib.jjava.jupyter.kernel.magic.LineMagic;
55
import org.dflib.jjava.jupyter.kernel.util.GlobFinder;
66

@@ -10,10 +10,10 @@
1010
import java.util.stream.Collectors;
1111
import java.util.stream.StreamSupport;
1212

13-
public class ClasspathMagic implements LineMagic<List<String>, JJavaKernel> {
13+
public class ClasspathMagic implements LineMagic<List<String>, JavaKernel> {
1414

1515
@Override
16-
public List<String> eval(JJavaKernel kernel, List<String> args) {
16+
public List<String> eval(JavaKernel kernel, List<String> args) {
1717
List<String> resolved = args.stream()
1818
.flatMap(a -> StreamSupport.stream(resolveGlob(a).spliterator(), false))
1919
.map(p -> p.toAbsolutePath().toString())

‎jjava-kernel/src/main/java/org/dflib/jjava/kernel/magics/JarsMagic.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
package org.dflib.jjava.kernel.magics;
22

3-
import org.dflib.jjava.kernel.JJavaKernel;
3+
import org.dflib.jjava.kernel.JavaKernel;
44
import org.dflib.jjava.jupyter.kernel.magic.LineMagic;
55
import org.dflib.jjava.jupyter.kernel.util.GlobFinder;
66

@@ -12,10 +12,10 @@
1212

1313
// TODO: this is a subset of ClasspathMagic. The only difference is calling "computeMatchingFiles()" instead of
1414
// "computeMatchingPaths()". Deprecate in favor of "classpath"?
15-
public class JarsMagic implements LineMagic<List<String>, JJavaKernel> {
15+
public class JarsMagic implements LineMagic<List<String>, JavaKernel> {
1616

1717
@Override
18-
public List<String> eval(JJavaKernel kernel, List<String> args) {
18+
public List<String> eval(JavaKernel kernel, List<String> args) {
1919
List<String> resolved = args.stream()
2020
.flatMap(a -> StreamSupport.stream(resolveGlob(a).spliterator(), false))
2121
.map(p -> p.toAbsolutePath().toString())

‎jjava-kernel/src/main/java/org/dflib/jjava/kernel/magics/LoadCodeMagic.java‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
import com.google.gson.Gson;
44
import com.google.gson.GsonBuilder;
55
import com.google.gson.stream.JsonReader;
6-
import org.dflib.jjava.kernel.JJavaKernel;
6+
import org.dflib.jjava.kernel.JavaKernel;
77
import org.dflib.jjava.jupyter.kernel.magic.LineMagic;
88
import org.dflib.jjava.jupyter.kernel.magic.MagicsArgs;
99

@@ -16,7 +16,7 @@
1616
import java.util.List;
1717
import java.util.Map;
1818

19-
public class LoadCodeMagic implements LineMagic<Void, JJavaKernel> {
19+
public class LoadCodeMagic implements LineMagic<Void, JavaKernel> {
2020

2121
private static final String NOTEBOOK_EXTENSION = ".ipynb";
2222

@@ -37,7 +37,7 @@ public LoadCodeMagic(String... fileExtensions) {
3737
}
3838

3939
@Override
40-
public Void eval(JJavaKernel kernel, List<String> args) throws Exception {
40+
public Void eval(JavaKernel kernel, List<String> args) throws Exception {
4141

4242
Map<String, List<String>> vals = LOAD_ARGS.parse(args);
4343
Path sourcePath = Paths.get(vals.get("source").get(0)).toAbsolutePath();
@@ -68,7 +68,7 @@ public Void eval(JJavaKernel kernel, List<String> args) throws Exception {
6868
// in which we can only take what we need on the fly and pass each cell to the handler without needing
6969
// to keep the entire notebook in memory.
7070
// This should be a big help for larger notebooks.
71-
private void execNotebook(JJavaKernel kernel, Path notebookPath) throws Exception {
71+
private void execNotebook(JavaKernel kernel, Path notebookPath) throws Exception {
7272
try (Reader in = Files.newBufferedReader(notebookPath, StandardCharsets.UTF_8)) {
7373
JsonReader reader = GSON.get().newJsonReader(in);
7474
reader.beginObject();

‎jjava-maven/src/main/java/org/dfllib/jjava/maven/magics/LoadFromPomCellMagic.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
package org.dfllib.jjava.maven.magics;
22

3-
import org.dflib.jjava.kernel.JJavaKernel;
3+
import org.dflib.jjava.kernel.JavaKernel;
44
import org.dflib.jjava.jupyter.kernel.magic.CellMagic;
55
import org.dfllib.jjava.maven.MavenDependencyResolver;
66
import org.w3c.dom.Document;
@@ -32,7 +32,7 @@
3232
import java.util.List;
3333
import java.util.Map;
3434

35-
public class LoadFromPomCellMagic implements CellMagic<Map<String, List<String>>, JJavaKernel> {
35+
public class LoadFromPomCellMagic implements CellMagic<Map<String, List<String>>, JavaKernel> {
3636

3737
private final MavenDependencyResolver mavenResolver;
3838

@@ -41,7 +41,7 @@ public LoadFromPomCellMagic(MavenDependencyResolver mavenResolver) {
4141
}
4242

4343
@Override
44-
public Map<String, List<String>> eval(JJavaKernel kernel, List<String> args, String body) throws Exception {
44+
public Map<String, List<String>> eval(JavaKernel kernel, List<String> args, String body) throws Exception {
4545
String rawPom = solidifyPartialPOM(body);
4646
File tempPomPath = File.createTempFile("jjava-maven-", ".pom").getAbsoluteFile();
4747
try {

‎jjava-maven/src/main/java/org/dfllib/jjava/maven/magics/LoadFromPomLineMagic.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
package org.dfllib.jjava.maven.magics;
22

3-
import org.dflib.jjava.kernel.JJavaKernel;
3+
import org.dflib.jjava.kernel.JavaKernel;
44
import org.dflib.jjava.jupyter.kernel.magic.LineMagic;
55
import org.dflib.jjava.jupyter.kernel.magic.MagicsArgs;
66
import org.dfllib.jjava.maven.MavenDependencyResolver;
@@ -9,7 +9,7 @@
99
import java.util.List;
1010
import java.util.Map;
1111

12-
public class LoadFromPomLineMagic implements LineMagic<Map<String, List<String>>, JJavaKernel> {
12+
public class LoadFromPomLineMagic implements LineMagic<Map<String, List<String>>, JavaKernel> {
1313

1414
private final MavenDependencyResolver mavenResolver;
1515

@@ -18,7 +18,7 @@ public LoadFromPomLineMagic(MavenDependencyResolver mavenResolver) {
1818
}
1919

2020
@Override
21-
public Map<String, List<String>> eval(JJavaKernel kernel, List<String> args) {
21+
public Map<String, List<String>> eval(JavaKernel kernel, List<String> args) {
2222
if (args.isEmpty()) {
2323
throw new IllegalArgumentException("Loading from POM requires at least the path to the POM file");
2424
}

0 commit comments

Comments
 (0)