Skip to content

Commit d791d4f

Browse files
authored
Merge pull request #100 from scijava/scijava/scijava-ops-engine/clarify-nullable-param-descriptions
Closes #146
2 parents 2917457 + a4b1d2c commit d791d4f

3 files changed

Lines changed: 45 additions & 1 deletion

File tree

‎scijava/scijava-ops-engine/src/main/java/org/scijava/ops/engine/matcher/simplify/SimplifiedOpDescriptionGenerator.java‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@
3737
import org.scijava.ops.api.OpInfo;
3838
import org.scijava.ops.api.OpRequest;
3939
import org.scijava.ops.engine.OpDescriptionGenerator;
40+
import org.scijava.ops.engine.matcher.reduce.ReducedOpInfo;
4041
import org.scijava.ops.engine.util.Infos;
4142
import org.scijava.priority.Priority;
4243

@@ -119,13 +120,18 @@ private String allNamespaces(final OpEnvironment env, final String name) {
119120
private List<OpInfo> filterInfos(Iterable<? extends OpInfo> infos, OpRequest req) {
120121
List<OpInfo> filtered = new ArrayList<>();
121122
for (var info: infos) {
123+
if (info instanceof ReducedOpInfo) {
124+
continue;
125+
}
126+
122127
var numPureInputs = info.inputs().stream() //
123128
.filter(m -> !m.isOutput()) //
124129
.count();
125130

126131
if (req.getArgs() == null || req.getArgs().length == numPureInputs) {
127132
filtered.add(info);
128133
}
134+
129135
}
130136
return filtered;
131137
}

‎scijava/scijava-ops-engine/src/main/java/org/scijava/ops/engine/util/Infos.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -227,7 +227,7 @@ private static void appendParam(final StringBuilder sb, final Member<?> arg,
227227
sb.append(typeString(arg.getType(), verbose));
228228
sb.append(" ");
229229
sb.append(arg.getKey());
230-
if (!arg.isRequired()) sb.append("?");
230+
if (!arg.isRequired()) sb.append(" = null");
231231
if (!arg.getDescription().isEmpty()) {
232232
sb.append(" -> ");
233233
sb.append(arg.getDescription());
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
package org.scijava.ops.engine.util;
2+
3+
import org.junit.jupiter.api.Assertions;
4+
import org.junit.jupiter.api.BeforeAll;
5+
import org.junit.jupiter.api.Test;
6+
import org.scijava.ops.engine.AbstractTestEnvironment;
7+
import org.scijava.ops.spi.Nullable;
8+
import org.scijava.ops.spi.OpCollection;
9+
import org.scijava.ops.spi.OpMethod;
10+
11+
import java.util.function.BiFunction;
12+
13+
/**
14+
* Test class for {@link Infos} static methods.
15+
*
16+
* @author Gabriel Selzer
17+
*/
18+
public class InfosTest extends AbstractTestEnvironment implements OpCollection {
19+
20+
@BeforeAll
21+
public static void addNeededOps() {
22+
ops.register(new InfosTest());
23+
}
24+
25+
@OpMethod(names="test.nullableMethod", type=BiFunction.class)
26+
public static Integer nullableMethod(Integer i1, @Nullable Integer i2) {
27+
if (i2 == null) i2 = 0;
28+
return i1 + i2;
29+
}
30+
31+
@Test
32+
public void testDescriptionOfNullableParameter() {
33+
var actual = ops.help("test.nullableMethod");
34+
var expected = "Ops:\n\t> test.nullableMethod(\n\t\t Inputs:\n\t\t\tInteger input1\n\t\t\tInteger input2 = null\n\t\t Outputs:\n\t\t\tInteger output1\n\t)\n\t";
35+
Assertions.assertEquals(expected, actual);
36+
}
37+
}
38+

0 commit comments

Comments
 (0)