Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add parse structure for testing #6291

Merged
merged 4 commits into from
Apr 13, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion src/main/java/ch/njol/skript/test/runner/ExprParseLogs.java
Original file line number Diff line number Diff line change
Expand Up @@ -40,14 +40,17 @@ public class ExprParseLogs extends SimpleExpression<String> {
Skript.registerExpression(ExprParseLogs.class, String.class, ExpressionType.SIMPLE, "[the] [last] parse logs");
}

@Nullable
public static String[] lastLogs;

@Override
public boolean init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelayed, ParseResult parseResult) {
return true;
}

@Override
protected String[] get(Event event) {
return SecParse.lastLogs;
return lastLogs;
}

@Override
Expand Down
4 changes: 1 addition & 3 deletions src/main/java/ch/njol/skript/test/runner/SecParse.java
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,6 @@ public class SecParse extends Section {
Skript.registerSection(SecParse.class, "parse");
}

@Nullable
public static String[] lastLogs;
private String[] logs;

@Override
Expand All @@ -74,7 +72,7 @@ public boolean init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelaye

@Override
protected @Nullable TriggerItem walk(Event event) {
lastLogs = logs;
ExprParseLogs.lastLogs = logs;
return walk(event, false);
}

Expand Down
116 changes: 116 additions & 0 deletions src/main/java/ch/njol/skript/test/runner/StructParse.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,116 @@
/**
* This file is part of Skript.
*
* Skript is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Skript is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with Skript. If not, see <http://www.gnu.org/licenses/>.
*
* Copyright Peter Güttinger, SkriptLang team and contributors
*/
package ch.njol.skript.test.runner;

import ch.njol.skript.ScriptLoader;
import ch.njol.skript.Skript;
import ch.njol.skript.classes.Changer;
import ch.njol.skript.classes.Changer.ChangeMode;
import ch.njol.skript.classes.Changer.ChangerUtils;
import ch.njol.skript.config.Node;
import ch.njol.skript.config.SectionNode;
import ch.njol.skript.doc.Description;
import ch.njol.skript.doc.Name;
import ch.njol.skript.doc.NoDoc;
import ch.njol.skript.lang.Expression;
import ch.njol.skript.lang.Literal;
import ch.njol.skript.lang.util.ContextlessEvent;
import ch.njol.skript.log.LogEntry;
import ch.njol.skript.log.RetainingLogHandler;
import ch.njol.skript.log.SkriptLogger;
import com.google.common.collect.Iterables;
import org.bukkit.event.Event;
import org.eclipse.jdt.annotation.Nullable;
import org.skriptlang.skript.lang.entry.EntryContainer;
import org.skriptlang.skript.lang.entry.EntryValidator;
import org.skriptlang.skript.lang.entry.util.ExpressionEntryData;
import org.skriptlang.skript.lang.structure.Structure;

import static ch.njol.skript.lang.SkriptParser.ParseResult;


@Name("Parse Structure")
@Description("Parses the code inside this structure as a structure and use 'parse logs' to grab any logs from it.")
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

a little more explanation on how to use would be nice. What should I put in results? Do I need a code entry? etc,

@NoDoc
public class StructParse extends Structure {

static {
Skript.registerStructure(StructParse.class, "parse");
}

private static EntryValidator validator = EntryValidator.builder()
.addEntryData(new ExpressionEntryData<>("results", null, false, Object.class))
.addSection("code", false)
.build();

private SectionNode structureSectionNodeToParse;
private String[] logs;
private Expression<?> resultsExpression;

@Override
public boolean init(Literal<?>[] args, int matchedPattern, ParseResult parseResult, EntryContainer entryContainer) {
SectionNode parseStructureSectionNode = entryContainer.getSource();

Class<? extends Event>[] originalEvents = getParser().getCurrentEvents();
getParser().setCurrentEvent("parse", ContextlessEvent.class);
EntryContainer validatedEntries = validator.validate(parseStructureSectionNode);
getParser().setCurrentEvents(originalEvents);
if (validatedEntries == null) {
Skript.error("A parse structure must have a result entry and a code section");
return false;
}
Expression<?> maybeResultsExpression = (Expression<?>) validatedEntries.get("results", false);
if (!ChangerUtils.acceptsChange(maybeResultsExpression, ChangeMode.SET, String[].class)) {
Skript.error(maybeResultsExpression.toString(null, false) + " cannot be set to strings");
}
SectionNode codeSectionNode = (SectionNode) validatedEntries.get("code", false);
Node maybeStructureSectionNodeToParse = Iterables.getFirst(codeSectionNode, null);
if (Iterables.size(codeSectionNode) != 1 || !(maybeStructureSectionNodeToParse instanceof SectionNode)) {
Skript.error("The code section must contain a single section to parse as a structure");
}
resultsExpression = maybeResultsExpression;
structureSectionNodeToParse = (SectionNode) maybeStructureSectionNodeToParse;
return true;
}

@Override
public boolean postLoad() {
resultsExpression.change(ContextlessEvent.get(), logs, ChangeMode.SET);
return true;
}

@Override
public boolean load() {
try (RetainingLogHandler handler = SkriptLogger.startRetainingLog()) {
String structureSectionNodeKey = ScriptLoader.replaceOptions(structureSectionNodeToParse.getKey());
String error = "Can't understand this structure: " + structureSectionNodeKey;
Structure.parse(structureSectionNodeKey, structureSectionNodeToParse, error);
logs = handler.getLog().stream()
.map(LogEntry::getMessage)
.toArray(String[]::new);
}
return true;
}

@Override
public String toString(@Nullable Event event, boolean debug) {
return "parse";
}

}
11 changes: 11 additions & 0 deletions src/test/skript/tests/syntaxes/structures/StructParse.sk
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
parse:
results: {StructParse::parse::*}
code:
parse:
results: "oops"
code:
on script load:
broadcast "hi"

test "StructParse":
assert {StructParse::parse::*} contains """oops"" cannot be set to strings" with "StructParse error not found"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It sounds cool but I really honestly cannot tell what on earth is going on in your test, I think some more explanation or documentation for the feature might help (even some javadoc would be pretty cool).

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's indeed cool! He is using a nested StructParse with invalid store object "oops" that will throw an error and catching it for testing