iterator() {
43 | return this.dirs.iterator();
44 | }
45 |
46 | /**
47 | * Add an exception.
48 | * @param error Exception to add
49 | * @since 1.4
50 | */
51 | public void add(final Exception error) {
52 | this.dirs.add("error")
53 | .attr("type", "exception")
54 | .attr("line", "1")
55 | .attr("pos", "0")
56 | .set(error.getLocalizedMessage()).up();
57 | }
58 |
59 | }
60 |
--------------------------------------------------------------------------------
/requs-core/src/main/java/org/requs/facet/syntax/SyntaxException.java:
--------------------------------------------------------------------------------
1 | /*
2 | * SPDX-FileCopyrightText: Copyright (c) 2009-2025, Yegor Bugayenko
3 | * SPDX-License-Identifier: MIT
4 | */
5 | package org.requs.facet.syntax;
6 |
7 | /**
8 | * Syntax exception.
9 | *
10 | * @since 1.4
11 | */
12 | final class SyntaxException extends RuntimeException {
13 |
14 | /**
15 | * Serialization marker.
16 | */
17 | private static final long serialVersionUID = 1497953278746134529L;
18 |
19 | /**
20 | * Ctor.
21 | * @param cause Cause of it
22 | */
23 | SyntaxException(final String cause) {
24 | super(cause);
25 | }
26 |
27 | }
28 |
--------------------------------------------------------------------------------
/requs-core/src/main/java/org/requs/facet/syntax/ontology/Acronym.java:
--------------------------------------------------------------------------------
1 | /*
2 | * SPDX-FileCopyrightText: Copyright (c) 2009-2025, Yegor Bugayenko
3 | * SPDX-License-Identifier: MIT
4 | */
5 | package org.requs.facet.syntax.ontology;
6 |
7 | /**
8 | * Acronym.
9 | *
10 | * @since 1.14
11 | */
12 | public interface Acronym extends Mentioned, Informal {
13 |
14 | }
15 |
--------------------------------------------------------------------------------
/requs-core/src/main/java/org/requs/facet/syntax/ontology/Flow.java:
--------------------------------------------------------------------------------
1 | /*
2 | * SPDX-FileCopyrightText: Copyright (c) 2009-2025, Yegor Bugayenko
3 | * SPDX-License-Identifier: MIT
4 | */
5 | package org.requs.facet.syntax.ontology;
6 |
7 | /**
8 | * Flow.
9 | *
10 | * @since 1.1
11 | */
12 | public interface Flow extends Informal {
13 |
14 | /**
15 | * SELF binding.
16 | */
17 | String SELF = "_self";
18 |
19 | /**
20 | * Get its step by number.
21 | * @param number Number of the step
22 | * @return Step
23 | */
24 | Step step(int number);
25 |
26 | /**
27 | * Declare a binding used in the method.
28 | * @param name Unique name of it
29 | * @param type Type of it
30 | */
31 | void binding(String name, String type);
32 |
33 | }
34 |
--------------------------------------------------------------------------------
/requs-core/src/main/java/org/requs/facet/syntax/ontology/Informal.java:
--------------------------------------------------------------------------------
1 | /*
2 | * SPDX-FileCopyrightText: Copyright (c) 2009-2025, Yegor Bugayenko
3 | * SPDX-License-Identifier: MIT
4 | */
5 | package org.requs.facet.syntax.ontology;
6 |
7 | /**
8 | * Can be informal.
9 | *
10 | * @since 1.1
11 | */
12 | public interface Informal {
13 |
14 | /**
15 | * Explain this slot.
16 | * @param informal Informal explanation
17 | */
18 | void explain(String informal);
19 |
20 | }
21 |
--------------------------------------------------------------------------------
/requs-core/src/main/java/org/requs/facet/syntax/ontology/Mentioned.java:
--------------------------------------------------------------------------------
1 | /*
2 | * SPDX-FileCopyrightText: Copyright (c) 2009-2025, Yegor Bugayenko
3 | * SPDX-License-Identifier: MIT
4 | */
5 | package org.requs.facet.syntax.ontology;
6 |
7 | /**
8 | * Something mentioned in source code.
9 | *
10 | * @since 1.1
11 | */
12 | public interface Mentioned {
13 |
14 | /**
15 | * Mention it in the given lines of source.
16 | * @param where Where was it mentioned
17 | */
18 | void mention(int where);
19 |
20 | }
21 |
--------------------------------------------------------------------------------
/requs-core/src/main/java/org/requs/facet/syntax/ontology/Method.java:
--------------------------------------------------------------------------------
1 | /*
2 | * SPDX-FileCopyrightText: Copyright (c) 2009-2025, Yegor Bugayenko
3 | * SPDX-License-Identifier: MIT
4 | */
5 | package org.requs.facet.syntax.ontology;
6 |
7 | /**
8 | * Use case.
9 | *
10 | * @since 1.1
11 | */
12 | public interface Method extends Flow, Mentioned, Signature {
13 |
14 | /**
15 | * Add an attributes.
16 | * @param name Attribute name
17 | * @param seal Seal to attach
18 | */
19 | void attribute(String name, String seal);
20 |
21 | /**
22 | * Get an NFR by name.
23 | * @param name NFR name
24 | * @return NFR
25 | */
26 | Nfr nfr(String name);
27 |
28 | }
29 |
--------------------------------------------------------------------------------
/requs-core/src/main/java/org/requs/facet/syntax/ontology/Nfr.java:
--------------------------------------------------------------------------------
1 | /*
2 | * SPDX-FileCopyrightText: Copyright (c) 2009-2025, Yegor Bugayenko
3 | * SPDX-License-Identifier: MIT
4 | */
5 | package org.requs.facet.syntax.ontology;
6 |
7 | /**
8 | * Non-functional requirement.
9 | *
10 | * @since 1.5
11 | */
12 | public interface Nfr extends Mentioned, Informal {
13 |
14 | }
15 |
--------------------------------------------------------------------------------
/requs-core/src/main/java/org/requs/facet/syntax/ontology/Ontology.java:
--------------------------------------------------------------------------------
1 | /*
2 | * SPDX-FileCopyrightText: Copyright (c) 2009-2025, Yegor Bugayenko
3 | * SPDX-License-Identifier: MIT
4 | */
5 | package org.requs.facet.syntax.ontology;
6 |
7 | import org.xembly.Directive;
8 |
9 | /**
10 | * Ontology.
11 | *
12 | * The ontology is write-only. This is how you're supposed to use it:
13 | *
14 | *
15 | * Ontology onto = // make it
16 | * Type type = onto.type("Employee");
17 | * type.mention("3-5");
18 | * type.explain("a person working in a Company");
19 | *
20 | *
21 | * @since 1.1
22 | */
23 | public interface Ontology extends Iterable {
24 |
25 | /**
26 | * Found new type.
27 | * @param name Name of it
28 | * @return Type
29 | */
30 | Type type(String name);
31 |
32 | /**
33 | * Find method.
34 | * @param name Name of it
35 | * @return Method
36 | */
37 | Method method(String name);
38 |
39 | /**
40 | * Find page.
41 | * @param name Name of it
42 | * @return Page
43 | */
44 | Page page(String name);
45 |
46 | /**
47 | * Get acronym.
48 | * @param name Name of it
49 | * @return Acronym
50 | */
51 | Acronym acronym(String name);
52 |
53 | }
54 |
--------------------------------------------------------------------------------
/requs-core/src/main/java/org/requs/facet/syntax/ontology/Page.java:
--------------------------------------------------------------------------------
1 | /*
2 | * SPDX-FileCopyrightText: Copyright (c) 2009-2025, Yegor Bugayenko
3 | * SPDX-License-Identifier: MIT
4 | */
5 | package org.requs.facet.syntax.ontology;
6 |
7 | /**
8 | * Page in Markdown.
9 | *
10 | * @since 1.7
11 | */
12 | public interface Page extends Mentioned, Informal {
13 |
14 | }
15 |
--------------------------------------------------------------------------------
/requs-core/src/main/java/org/requs/facet/syntax/ontology/Signature.java:
--------------------------------------------------------------------------------
1 | /*
2 | * SPDX-FileCopyrightText: Copyright (c) 2009-2025, Yegor Bugayenko
3 | * SPDX-License-Identifier: MIT
4 | */
5 | package org.requs.facet.syntax.ontology;
6 |
7 | /**
8 | * Signature of a function call or declaration.
9 | *
10 | * @since 1.1
11 | */
12 | public interface Signature extends Informal {
13 |
14 | /**
15 | * Sign it.
16 | * @param text Text to use (in quotes if informal)
17 | */
18 | void sign(String text);
19 |
20 | /**
21 | * Set the object.
22 | * @param name Variable of the object
23 | */
24 | void object(String name);
25 |
26 | /**
27 | * Result variable.
28 | * @param name Variable of the result
29 | */
30 | void result(String name);
31 |
32 | /**
33 | * Input argument.
34 | * @param name Name of the argument
35 | */
36 | void input(String name);
37 |
38 | }
39 |
--------------------------------------------------------------------------------
/requs-core/src/main/java/org/requs/facet/syntax/ontology/Slot.java:
--------------------------------------------------------------------------------
1 | /*
2 | * SPDX-FileCopyrightText: Copyright (c) 2009-2025, Yegor Bugayenko
3 | * SPDX-License-Identifier: MIT
4 | */
5 | package org.requs.facet.syntax.ontology;
6 |
7 | /**
8 | * Slot of a type.
9 | *
10 | * @since 1.1
11 | */
12 | public interface Slot extends Mentioned, Informal {
13 |
14 | /**
15 | * Arity.
16 | *
17 | * @since 1.1
18 | */
19 | enum Arity {
20 | /**
21 | * One or many.
22 | */
23 | MANY("1..*"),
24 |
25 | /**
26 | * Zero or many: 0..*.
27 | */
28 | ANY("0..*"),
29 |
30 | /**
31 | * Strictly one.
32 | */
33 | ONE("1");
34 |
35 | /**
36 | * Mnemo.
37 | */
38 | private final transient String text;
39 |
40 | /**
41 | * Ctor.
42 | * @param mnemo Mnemo
43 | */
44 | Arity(final String mnemo) {
45 | this.text = mnemo;
46 | }
47 |
48 | /**
49 | * Mnemo.
50 | * @return Mnemo
51 | */
52 | public String mnemo() {
53 | return this.text;
54 | }
55 | }
56 |
57 | /**
58 | * Assign a type to the slot.
59 | * @param type Type to assign
60 | */
61 | void assign(String type);
62 |
63 | /**
64 | * Set its arity.
65 | * @param arity Arity to set
66 | */
67 | void arity(Slot.Arity arity);
68 |
69 | /**
70 | * Is it a composition?
71 | * @param cmp TRUE if it's a composition
72 | * @since 1.14
73 | */
74 | void composition(boolean cmp);
75 |
76 | }
77 |
--------------------------------------------------------------------------------
/requs-core/src/main/java/org/requs/facet/syntax/ontology/Step.java:
--------------------------------------------------------------------------------
1 | /*
2 | * SPDX-FileCopyrightText: Copyright (c) 2009-2025, Yegor Bugayenko
3 | * SPDX-License-Identifier: MIT
4 | */
5 | package org.requs.facet.syntax.ontology;
6 |
7 | /**
8 | * Step.
9 | *
10 | * @since 1.1
11 | */
12 | public interface Step extends Mentioned, Signature {
13 |
14 | /**
15 | * Exception at a step.
16 | * @param text Exception text
17 | * @return Flow for this exception
18 | */
19 | Flow exception(String text);
20 |
21 | }
22 |
--------------------------------------------------------------------------------
/requs-core/src/main/java/org/requs/facet/syntax/ontology/Type.java:
--------------------------------------------------------------------------------
1 | /*
2 | * SPDX-FileCopyrightText: Copyright (c) 2009-2025, Yegor Bugayenko
3 | * SPDX-License-Identifier: MIT
4 | */
5 | package org.requs.facet.syntax.ontology;
6 |
7 | /**
8 | * Type.
9 | *
10 | * @since 1.1
11 | */
12 | public interface Type extends Mentioned, Informal {
13 |
14 | /**
15 | * Set parent.
16 | * @param type Name of parent type
17 | */
18 | void parent(String type);
19 |
20 | /**
21 | * Set TRUE if it's an actor.
22 | * @param act TRUE if an actor
23 | * @since 1.14
24 | */
25 | void actor(boolean act);
26 |
27 | /**
28 | * Found a slot of the type.
29 | * @param name Slot name
30 | * @return Slot
31 | */
32 | Slot slot(String name);
33 |
34 | }
35 |
--------------------------------------------------------------------------------
/requs-core/src/main/java/org/requs/facet/syntax/ontology/XeAcronym.java:
--------------------------------------------------------------------------------
1 | /*
2 | * SPDX-FileCopyrightText: Copyright (c) 2009-2025, Yegor Bugayenko
3 | * SPDX-License-Identifier: MIT
4 | */
5 | package org.requs.facet.syntax.ontology;
6 |
7 | import com.jcabi.aspects.Loggable;
8 | import lombok.EqualsAndHashCode;
9 | import lombok.ToString;
10 | import org.xembly.Directives;
11 |
12 | /**
13 | * Xembly acronym.
14 | *
15 | * @since 1.14
16 | */
17 | @ToString
18 | @EqualsAndHashCode
19 | @Loggable(Loggable.DEBUG)
20 | final class XeAcronym implements Acronym {
21 |
22 | /**
23 | * Mentioned helper.
24 | */
25 | private final transient Mentioned mentioned;
26 |
27 | /**
28 | * Informal helper.
29 | */
30 | private final transient Informal informal;
31 |
32 | /**
33 | * Ctor.
34 | * @param directives Directives to extend
35 | * @param xpath XPath to start with
36 | */
37 | XeAcronym(final Directives directives, final String xpath) {
38 | this.mentioned = new XeMentioned(directives, xpath);
39 | this.informal = new XeInformal(directives, xpath);
40 | }
41 |
42 | @Override
43 | public void explain(final String info) {
44 | this.informal.explain(info);
45 | }
46 |
47 | @Override
48 | public void mention(final int where) {
49 | this.mentioned.mention(where);
50 | }
51 | }
52 |
--------------------------------------------------------------------------------
/requs-core/src/main/java/org/requs/facet/syntax/ontology/XeFlow.java:
--------------------------------------------------------------------------------
1 | /*
2 | * SPDX-FileCopyrightText: Copyright (c) 2009-2025, Yegor Bugayenko
3 | * SPDX-License-Identifier: MIT
4 | */
5 | package org.requs.facet.syntax.ontology;
6 |
7 | import com.jcabi.aspects.Loggable;
8 | import lombok.EqualsAndHashCode;
9 | import lombok.ToString;
10 | import org.xembly.Directives;
11 |
12 | /**
13 | * Xembly use case.
14 | *
15 | * @since 1.1
16 | */
17 | @ToString
18 | @EqualsAndHashCode(of = { "dirs", "start" })
19 | @Loggable(Loggable.DEBUG)
20 | final class XeFlow implements Flow {
21 |
22 | /**
23 | * All directives.
24 | */
25 | private final transient Directives dirs;
26 |
27 | /**
28 | * Starting XPath.
29 | */
30 | private final transient String start;
31 |
32 | /**
33 | * Informal helper.
34 | */
35 | private final transient Informal informal;
36 |
37 | /**
38 | * Ctor.
39 | * @param directives Directives to extend
40 | * @param xpath XPath to start with
41 | */
42 | XeFlow(final Directives directives, final String xpath) {
43 | this.informal = new XeInformal(directives, xpath);
44 | this.dirs = directives;
45 | this.start = xpath;
46 | }
47 |
48 | @Override
49 | public Step step(final int number) {
50 | this.dirs.xpath(this.start).strict(1).addIf("steps")
51 | .xpath(this.start)
52 | .xpath(String.format("steps[not(step/number=%d)]", number))
53 | .add("step").add("number").set(Integer.toString(number));
54 | return new XeStep(
55 | this.dirs,
56 | String.format("%s/steps/step[number=%d]", this.start, number)
57 | );
58 | }
59 |
60 | @Override
61 | public void binding(final String name, final String type) {
62 | this.dirs.xpath(this.start).strict(1).addIf("bindings").up().xpath(
63 | String.format(
64 | "bindings[not(binding[name='%s' and type=%s])]",
65 | name, XeOntology.escapeXPath(type)
66 | )
67 | ).add("binding").add("name").set(name).up().add("type").set(type);
68 | }
69 |
70 | @Override
71 | public void explain(final String info) {
72 | this.informal.explain(info);
73 | }
74 |
75 | }
76 |
--------------------------------------------------------------------------------
/requs-core/src/main/java/org/requs/facet/syntax/ontology/XeInformal.java:
--------------------------------------------------------------------------------
1 | /*
2 | * SPDX-FileCopyrightText: Copyright (c) 2009-2025, Yegor Bugayenko
3 | * SPDX-License-Identifier: MIT
4 | */
5 | package org.requs.facet.syntax.ontology;
6 |
7 | import com.jcabi.aspects.Loggable;
8 | import lombok.EqualsAndHashCode;
9 | import lombok.ToString;
10 | import org.xembly.Directives;
11 |
12 | /**
13 | * Xembly informal.
14 | *
15 | * @since 1.1
16 | */
17 | @ToString
18 | @EqualsAndHashCode(of = { "dirs", "start" })
19 | @Loggable(Loggable.DEBUG)
20 | final class XeInformal implements Informal {
21 |
22 | /**
23 | * All directives.
24 | */
25 | private final transient Directives dirs;
26 |
27 | /**
28 | * Starting XPath.
29 | */
30 | private final transient String start;
31 |
32 | /**
33 | * Ctor.
34 | * @param directives Directives to extend
35 | * @param xpath XPath to start with
36 | */
37 | XeInformal(final Directives directives, final String xpath) {
38 | this.dirs = directives;
39 | this.start = xpath;
40 | }
41 |
42 | @Override
43 | public void explain(final String informal) {
44 | this.dirs.xpath(this.start).strict(1)
45 | .addIf("info").add("informal").set(informal);
46 | }
47 |
48 | }
49 |
--------------------------------------------------------------------------------
/requs-core/src/main/java/org/requs/facet/syntax/ontology/XeMentioned.java:
--------------------------------------------------------------------------------
1 | /*
2 | * SPDX-FileCopyrightText: Copyright (c) 2009-2025, Yegor Bugayenko
3 | * SPDX-License-Identifier: MIT
4 | */
5 | package org.requs.facet.syntax.ontology;
6 |
7 | import com.jcabi.aspects.Loggable;
8 | import lombok.EqualsAndHashCode;
9 | import lombok.ToString;
10 | import org.xembly.Directives;
11 |
12 | /**
13 | * Xembly mentioned.
14 | *
15 | * @since 1.1
16 | */
17 | @ToString
18 | @EqualsAndHashCode(of = { "dirs", "start" })
19 | @Loggable(Loggable.DEBUG)
20 | final class XeMentioned implements Mentioned {
21 |
22 | /**
23 | * All directives.
24 | */
25 | private final transient Directives dirs;
26 |
27 | /**
28 | * Starting XPath.
29 | */
30 | private final transient String start;
31 |
32 | /**
33 | * Ctor.
34 | * @param directives Directives to extend
35 | * @param xpath XPath to start with
36 | */
37 | XeMentioned(final Directives directives, final String xpath) {
38 | this.dirs = directives;
39 | this.start = xpath;
40 | }
41 |
42 | @Override
43 | public void mention(final int where) {
44 | this.dirs.xpath(this.start).strict(1).addIf("mentioned")
45 | .strict(1)
46 | .add("where").set(Integer.toString(where));
47 | }
48 | }
49 |
--------------------------------------------------------------------------------
/requs-core/src/main/java/org/requs/facet/syntax/ontology/XeNfr.java:
--------------------------------------------------------------------------------
1 | /*
2 | * SPDX-FileCopyrightText: Copyright (c) 2009-2025, Yegor Bugayenko
3 | * SPDX-License-Identifier: MIT
4 | */
5 | package org.requs.facet.syntax.ontology;
6 |
7 | import com.jcabi.aspects.Loggable;
8 | import lombok.EqualsAndHashCode;
9 | import lombok.ToString;
10 | import org.xembly.Directives;
11 |
12 | /**
13 | * Xembly NFR.
14 | *
15 | * @since 1.5
16 | */
17 | @ToString
18 | @EqualsAndHashCode(of = "dirs")
19 | @Loggable(Loggable.DEBUG)
20 | final class XeNfr implements Nfr {
21 |
22 | /**
23 | * All directives.
24 | */
25 | private final transient Directives dirs;
26 |
27 | /**
28 | * Starting XPath.
29 | */
30 | private final transient String start;
31 |
32 | /**
33 | * Mentioned helper.
34 | */
35 | private final transient Mentioned mentioned;
36 |
37 | /**
38 | * Informal helper.
39 | */
40 | private final transient Informal informal;
41 |
42 | /**
43 | * Ctor.
44 | * @param directives Directives to extend
45 | * @param xpath XPath to start with
46 | */
47 | XeNfr(final Directives directives, final String xpath) {
48 | this.mentioned = new XeMethod(directives, xpath);
49 | this.informal = new XeInformal(directives, xpath);
50 | this.dirs = directives;
51 | this.start = xpath;
52 | }
53 |
54 | @Override
55 | public void mention(final int where) {
56 | this.mentioned.mention(where);
57 | }
58 |
59 | @Override
60 | public void explain(final String info) {
61 | assert this.dirs != null;
62 | assert this.start != null;
63 | this.informal.explain(info);
64 | }
65 |
66 | }
67 |
--------------------------------------------------------------------------------
/requs-core/src/main/java/org/requs/facet/syntax/ontology/XePage.java:
--------------------------------------------------------------------------------
1 | /*
2 | * SPDX-FileCopyrightText: Copyright (c) 2009-2025, Yegor Bugayenko
3 | * SPDX-License-Identifier: MIT
4 | */
5 | package org.requs.facet.syntax.ontology;
6 |
7 | import com.jcabi.aspects.Loggable;
8 | import lombok.EqualsAndHashCode;
9 | import lombok.ToString;
10 | import org.xembly.Directives;
11 |
12 | /**
13 | * Xembly page.
14 | *
15 | * @since 1.7
16 | */
17 | @ToString
18 | @EqualsAndHashCode
19 | @Loggable(Loggable.DEBUG)
20 | final class XePage implements Page {
21 |
22 | /**
23 | * Mentioned helper.
24 | */
25 | private final transient Mentioned mentioned;
26 |
27 | /**
28 | * Informal helper.
29 | */
30 | private final transient Informal informal;
31 |
32 | /**
33 | * Ctor.
34 | * @param directives Directives to extend
35 | * @param xpath XPath to start with
36 | */
37 | XePage(final Directives directives, final String xpath) {
38 | this.mentioned = new XeMentioned(directives, xpath);
39 | this.informal = new XeInformal(directives, xpath);
40 | }
41 |
42 | @Override
43 | public void explain(final String info) {
44 | this.informal.explain(info);
45 | }
46 |
47 | @Override
48 | public void mention(final int where) {
49 | this.mentioned.mention(where);
50 | }
51 | }
52 |
--------------------------------------------------------------------------------
/requs-core/src/main/java/org/requs/facet/syntax/ontology/XeSignature.java:
--------------------------------------------------------------------------------
1 | /*
2 | * SPDX-FileCopyrightText: Copyright (c) 2009-2025, Yegor Bugayenko
3 | * SPDX-License-Identifier: MIT
4 | */
5 | package org.requs.facet.syntax.ontology;
6 |
7 | import com.jcabi.aspects.Loggable;
8 | import lombok.EqualsAndHashCode;
9 | import lombok.ToString;
10 | import org.xembly.Directives;
11 |
12 | /**
13 | * Xembly signature.
14 | *
15 | * @since 1.1
16 | */
17 | @ToString
18 | @EqualsAndHashCode(of = { "dirs", "start" })
19 | @Loggable(Loggable.DEBUG)
20 | final class XeSignature implements Signature {
21 |
22 | /**
23 | * All directives.
24 | */
25 | private final transient Directives dirs;
26 |
27 | /**
28 | * Starting XPath.
29 | */
30 | private final transient String start;
31 |
32 | /**
33 | * Informal helper.
34 | */
35 | private final transient Informal informal;
36 |
37 | /**
38 | * Ctor.
39 | * @param directives Directives to extend
40 | * @param xpath XPath to start with
41 | */
42 | XeSignature(final Directives directives, final String xpath) {
43 | this.dirs = directives;
44 | this.start = xpath;
45 | this.informal = new XeInformal(directives, xpath);
46 | }
47 |
48 | @Override
49 | public void sign(final String text) {
50 | this.dirs.xpath(this.start).strict(1)
51 | .add("signature").set(text);
52 | }
53 |
54 | @Override
55 | public void object(final String name) {
56 | this.dirs.xpath(this.start).strict(1)
57 | .add("object").set(name);
58 | }
59 |
60 | @Override
61 | public void result(final String name) {
62 | this.dirs.xpath(this.start).strict(1)
63 | .add("result").set(name);
64 | }
65 |
66 | @Override
67 | public void input(final String name) {
68 | this.dirs.xpath(this.start).strict(1)
69 | .addIf("args").add("arg").set(name);
70 | }
71 |
72 | @Override
73 | public void explain(final String info) {
74 | this.informal.explain(info);
75 | }
76 |
77 | }
78 |
--------------------------------------------------------------------------------
/requs-core/src/main/java/org/requs/facet/syntax/ontology/XeSlot.java:
--------------------------------------------------------------------------------
1 | /*
2 | * SPDX-FileCopyrightText: Copyright (c) 2009-2025, Yegor Bugayenko
3 | * SPDX-License-Identifier: MIT
4 | */
5 | package org.requs.facet.syntax.ontology;
6 |
7 | import com.jcabi.aspects.Loggable;
8 | import lombok.EqualsAndHashCode;
9 | import lombok.ToString;
10 | import org.xembly.Directives;
11 |
12 | /**
13 | * Xembly slot in a type.
14 | *
15 | * @since 1.1
16 | */
17 | @ToString
18 | @EqualsAndHashCode(of = "dirs")
19 | @Loggable(Loggable.DEBUG)
20 | final class XeSlot implements Slot {
21 |
22 | /**
23 | * All directives.
24 | */
25 | private final transient Directives dirs;
26 |
27 | /**
28 | * Starting XPath.
29 | */
30 | private final transient String start;
31 |
32 | /**
33 | * Mentioned helper.
34 | */
35 | private final transient Mentioned mentioned;
36 |
37 | /**
38 | * Informal helper.
39 | */
40 | private final transient Informal informal;
41 |
42 | /**
43 | * Ctor.
44 | * @param directives Directives to extend
45 | * @param xpath XPath to start with
46 | */
47 | XeSlot(final Directives directives, final String xpath) {
48 | this.mentioned = new XeMethod(directives, xpath);
49 | this.informal = new XeInformal(directives, xpath);
50 | this.dirs = directives;
51 | this.start = xpath;
52 | }
53 |
54 | @Override
55 | public void assign(final String type) {
56 | this.dirs.xpath(this.start).strict(1)
57 | .addIf("type").set(type);
58 | }
59 |
60 | @Override
61 | public void arity(final Slot.Arity arity) {
62 | this.dirs.xpath(this.start).strict(1)
63 | .addIf("arity").set(arity.mnemo());
64 | }
65 |
66 | @Override
67 | public void composition(final boolean cmp) {
68 | this.dirs.xpath(this.start).strict(1)
69 | .addIf("composition").set(Boolean.toString(cmp));
70 | }
71 |
72 | @Override
73 | public void mention(final int where) {
74 | this.mentioned.mention(where);
75 | }
76 |
77 | @Override
78 | public void explain(final String info) {
79 | this.informal.explain(info);
80 | }
81 |
82 | }
83 |
--------------------------------------------------------------------------------
/requs-core/src/main/java/org/requs/facet/syntax/ontology/XeStep.java:
--------------------------------------------------------------------------------
1 | /*
2 | * SPDX-FileCopyrightText: Copyright (c) 2009-2025, Yegor Bugayenko
3 | * SPDX-License-Identifier: MIT
4 | */
5 | package org.requs.facet.syntax.ontology;
6 |
7 | import com.jcabi.aspects.Loggable;
8 | import lombok.EqualsAndHashCode;
9 | import lombok.ToString;
10 | import org.xembly.Directives;
11 |
12 | /**
13 | * Xembly step.
14 | *
15 | * @since 1.1
16 | */
17 | @ToString
18 | @EqualsAndHashCode(of = { "dirs", "start" })
19 | @Loggable(Loggable.DEBUG)
20 | final class XeStep implements Step {
21 |
22 | /**
23 | * All directives.
24 | */
25 | private final transient Directives dirs;
26 |
27 | /**
28 | * Starting XPath.
29 | */
30 | private final transient String start;
31 |
32 | /**
33 | * Mentioned helper.
34 | */
35 | private final transient Mentioned mentioned;
36 |
37 | /**
38 | * Signature helper.
39 | */
40 | private final transient Signature signature;
41 |
42 | /**
43 | * Ctor.
44 | * @param directives Directives to extend
45 | * @param xpath XPath to start with
46 | */
47 | XeStep(final Directives directives, final String xpath) {
48 | this.mentioned = new XeMentioned(directives, xpath);
49 | this.signature = new XeSignature(directives, xpath);
50 | this.dirs = directives;
51 | this.start = xpath;
52 | }
53 |
54 | @Override
55 | public Flow exception(final String text) {
56 | this.dirs.xpath(this.start)
57 | .strict(1).addIf("exceptions")
58 | .xpath(this.start)
59 | .xpath(
60 | String.format(
61 | "exceptions[not(exception/when=%s)]",
62 | XeOntology.escapeXPath(text)
63 | )
64 | )
65 | .add("exception").add("when").set(text);
66 | return new XeFlow(
67 | this.dirs,
68 | String.format(
69 | "%s/exceptions/exception[when=%s ]",
70 | this.start, XeOntology.escapeXPath(text)
71 | )
72 | );
73 | }
74 |
75 | @Override
76 | public void sign(final String text) {
77 | this.signature.sign(text);
78 | }
79 |
80 | @Override
81 | public void object(final String name) {
82 | this.signature.object(name);
83 | }
84 |
85 | @Override
86 | public void result(final String name) {
87 | this.signature.result(name);
88 | }
89 |
90 | @Override
91 | public void input(final String name) {
92 | this.signature.input(name);
93 | }
94 |
95 | @Override
96 | public void mention(final int where) {
97 | this.mentioned.mention(where);
98 | }
99 |
100 | @Override
101 | public void explain(final String informal) {
102 | this.signature.explain(informal);
103 | }
104 | }
105 |
--------------------------------------------------------------------------------
/requs-core/src/main/java/org/requs/facet/syntax/ontology/XeType.java:
--------------------------------------------------------------------------------
1 | /*
2 | * SPDX-FileCopyrightText: Copyright (c) 2009-2025, Yegor Bugayenko
3 | * SPDX-License-Identifier: MIT
4 | */
5 | package org.requs.facet.syntax.ontology;
6 |
7 | import com.jcabi.aspects.Loggable;
8 | import lombok.EqualsAndHashCode;
9 | import lombok.ToString;
10 | import org.xembly.Directives;
11 |
12 | /**
13 | * Xembly type.
14 | *
15 | * @since 1.1
16 | */
17 | @ToString
18 | @EqualsAndHashCode(of = { "dirs", "start" })
19 | @Loggable(Loggable.DEBUG)
20 | final class XeType implements Type {
21 |
22 | /**
23 | * All directives.
24 | */
25 | private final transient Directives dirs;
26 |
27 | /**
28 | * Starting XPath.
29 | */
30 | private final transient String start;
31 |
32 | /**
33 | * Mentioned helper.
34 | */
35 | private final transient Mentioned mentioned;
36 |
37 | /**
38 | * Informal helper.
39 | */
40 | private final transient Informal informal;
41 |
42 | /**
43 | * Ctor.
44 | * @param directives Directives to extend
45 | * @param xpath XPath to start with
46 | */
47 | XeType(final Directives directives, final String xpath) {
48 | this.mentioned = new XeMentioned(directives, xpath);
49 | this.informal = new XeInformal(directives, xpath);
50 | this.dirs = directives;
51 | this.start = xpath;
52 | }
53 |
54 | @Override
55 | public void parent(final String type) {
56 | this.dirs.xpath(this.start).strict(1)
57 | .addIf("parents").add("type").set(type);
58 | }
59 |
60 | @Override
61 | public void actor(final boolean act) {
62 | this.dirs.xpath(this.start).strict(1)
63 | .addIf("actor").set(Boolean.toString(act));
64 | }
65 |
66 | @Override
67 | public Slot slot(final String name) {
68 | this.dirs.xpath(this.start).strict(1)
69 | .addIf("slots").add("slot").add("name").set(name);
70 | return new XeSlot(
71 | this.dirs,
72 | String.format(
73 | "%s/slots/slot[name=%s]", this.start,
74 | XeOntology.escapeXPath(name)
75 | )
76 | );
77 | }
78 |
79 | @Override
80 | public void explain(final String info) {
81 | this.informal.explain(info);
82 | }
83 |
84 | @Override
85 | public void mention(final int where) {
86 | this.mentioned.mention(where);
87 | }
88 | }
89 |
--------------------------------------------------------------------------------
/requs-core/src/main/java/org/requs/facet/syntax/ontology/package-info.java:
--------------------------------------------------------------------------------
1 | /*
2 | * SPDX-FileCopyrightText: Copyright (c) 2009-2025, Yegor Bugayenko
3 | * SPDX-License-Identifier: MIT
4 | */
5 |
6 | /**
7 | * Ontology.
8 | *
9 | * @since 1.1
10 | */
11 | package org.requs.facet.syntax.ontology;
12 |
--------------------------------------------------------------------------------
/requs-core/src/main/java/org/requs/facet/syntax/package-info.java:
--------------------------------------------------------------------------------
1 | /*
2 | * SPDX-FileCopyrightText: Copyright (c) 2009-2025, Yegor Bugayenko
3 | * SPDX-License-Identifier: MIT
4 | */
5 |
6 | /**
7 | * Syntax analysis.
8 | */
9 | package org.requs.facet.syntax;
10 |
--------------------------------------------------------------------------------
/requs-core/src/main/java/org/requs/facet/uml/Plant.java:
--------------------------------------------------------------------------------
1 | /*
2 | * SPDX-FileCopyrightText: Copyright (c) 2009-2025, Yegor Bugayenko
3 | * SPDX-License-Identifier: MIT
4 | */
5 | package org.requs.facet.uml;
6 |
7 | import com.jcabi.aspects.Immutable;
8 | import com.jcabi.xml.XMLDocument;
9 | import java.io.ByteArrayOutputStream;
10 | import java.io.IOException;
11 | import lombok.EqualsAndHashCode;
12 | import lombok.ToString;
13 | import net.sourceforge.plantuml.FileFormat;
14 | import net.sourceforge.plantuml.FileFormatOption;
15 | import net.sourceforge.plantuml.SourceStringReader;
16 | import org.apache.commons.lang3.SystemUtils;
17 |
18 | /**
19 | * Plant UML compiler.
20 | *
21 | * @since 1.11
22 | */
23 | @Immutable
24 | @ToString(of = { })
25 | @EqualsAndHashCode
26 | public final class Plant {
27 |
28 | /**
29 | * Utility class.
30 | */
31 | private Plant() {
32 | // empty
33 | }
34 |
35 | /**
36 | * Make a diagram, in SVG.
37 | * @param src PlantUML source
38 | * @return SVG as a text
39 | * @throws IOException If fails
40 | */
41 | @SuppressWarnings("PMD.ProhibitPublicStaticMethods")
42 | public static String svg(final String src) throws IOException {
43 | final String svg;
44 | if (SystemUtils.IS_OS_WINDOWS) {
45 | svg = "SVG can't be rendered in Windows
";
46 | } else {
47 | final SourceStringReader reader = new SourceStringReader(src);
48 | final ByteArrayOutputStream baos = new ByteArrayOutputStream();
49 | reader.generateImage(baos, new FileFormatOption(FileFormat.SVG));
50 | svg = new XMLDocument(
51 | new String(baos.toByteArray())
52 | ).nodes("/*").get(0).toString().replace("xmlns=\"\"", "");
53 | }
54 | return svg;
55 | }
56 |
57 | }
58 |
--------------------------------------------------------------------------------
/requs-core/src/main/java/org/requs/facet/uml/package-info.java:
--------------------------------------------------------------------------------
1 | /*
2 | * SPDX-FileCopyrightText: Copyright (c) 2009-2025, Yegor Bugayenko
3 | * SPDX-License-Identifier: MIT
4 | */
5 |
6 | /**
7 | * UML diagrams.
8 | *
9 | * @since 1.11
10 | */
11 | package org.requs.facet.uml;
12 |
--------------------------------------------------------------------------------
/requs-core/src/main/java/org/requs/package-info.java:
--------------------------------------------------------------------------------
1 | /*
2 | * SPDX-FileCopyrightText: Copyright (c) 2009-2025, Yegor Bugayenko
3 | * SPDX-License-Identifier: MIT
4 | */
5 |
6 | /**
7 | * Requs.
8 | */
9 | package org.requs;
10 |
--------------------------------------------------------------------------------
/requs-core/src/main/resources/org/requs/facet/cleanup/incomplete-binding.xsl:
--------------------------------------------------------------------------------
1 |
2 |
31 |
32 |
35 |
36 |
38 |
39 |
40 |
42 | method
43 | has incorrect binding
45 |
46 |
47 |
48 |
49 |
50 |
51 |
52 |
53 |
54 |
56 |
57 |
58 |
--------------------------------------------------------------------------------
/requs-core/src/main/resources/org/requs/facet/cleanup/incomplete-step-signature.xsl:
--------------------------------------------------------------------------------
1 |
2 |
31 |
32 |
35 |
36 |
38 |
39 |
40 |
41 |
43 |
44 |
45 |
47 | step
48 | doesn't have a signature
50 |
51 |
52 |
53 |
54 |
55 |
56 | unknown
58 |
59 |
60 |
61 |
--------------------------------------------------------------------------------
/requs-core/src/main/resources/org/requs/facet/pages-in-html.xsl:
--------------------------------------------------------------------------------
1 |
2 |
31 |
32 |
35 |
36 |
38 |
39 |
40 |
41 |
46 |
47 |
48 |
49 |
51 |
52 |
53 |
--------------------------------------------------------------------------------
/requs-core/src/main/resources/org/requs/facet/sanity/broken-order-of-steps.xsl:
--------------------------------------------------------------------------------
1 |
2 |
31 |
32 |
35 |
36 |
38 |
39 |
40 |
42 | Step "
43 | " is not in order with others
45 |
46 |
47 |
48 |
49 |
50 |
51 |
53 |
54 |
55 |
--------------------------------------------------------------------------------
/requs-core/src/main/resources/org/requs/facet/sanity/empty-re-throws.xsl:
--------------------------------------------------------------------------------
1 |
2 |
31 |
32 |
35 |
36 |
38 |
39 |
40 |
42 | Exception flow of
43 | /
45 | simply re-throws an exception, it is pointless
47 |
48 |
49 |
50 |
51 |
52 |
53 |
55 |
56 |
57 |
--------------------------------------------------------------------------------
/requs-core/src/main/resources/org/requs/facet/sanity/misplaced-failure-check.xsl:
--------------------------------------------------------------------------------
1 |
2 |
31 |
32 |
35 |
36 |
38 |
39 |
40 |
42 | Step "
43 | " fails while it is not the last step in the flow
45 |
46 |
47 |
48 |
49 |
50 |
51 |
53 |
54 |
55 |
--------------------------------------------------------------------------------
/requs-core/src/main/resources/org/requs/facet/sanity/missed-step-numbers.xsl:
--------------------------------------------------------------------------------
1 |
2 |
31 |
32 |
35 |
36 |
38 |
39 |
40 |
42 | Step "
43 | " follows "
45 | ", some steps are probably missing
47 |
48 |
49 |
50 |
51 |
52 |
53 |
55 |
56 |
57 |
--------------------------------------------------------------------------------
/requs-core/src/main/resources/org/requs/facet/sanity/orphan-types.xsl:
--------------------------------------------------------------------------------
1 |
2 |
31 |
32 |
35 |
36 |
38 |
40 |
41 |
42 |
44 | Type "
45 | " is not used in any slot or a use case
47 |
48 |
49 |
50 |
51 |
52 |
53 |
54 |
56 |
57 |
58 |
--------------------------------------------------------------------------------
/requs-core/src/main/resources/org/requs/facet/sanity/too-many-steps.xsl:
--------------------------------------------------------------------------------
1 |
2 |
31 |
32 |
35 |
36 |
38 |
39 |
40 |
42 | There are more than eight steps, the flow is difficult to understand
43 |
44 |
45 |
46 |
47 |
48 |
49 |
51 |
52 |
53 |
--------------------------------------------------------------------------------
/requs-core/src/main/resources/org/requs/facet/seal-methods.xsl:
--------------------------------------------------------------------------------
1 |
2 |
31 |
32 |
35 |
36 |
38 |
39 |
40 |
41 |
42 |
44 |
45 |
46 |
47 |
49 |
51 |
52 |
53 |
54 |
56 |
57 |
58 |
--------------------------------------------------------------------------------
/requs-core/src/main/resources/org/requs/facet/step-refs.xsl:
--------------------------------------------------------------------------------
1 |
2 |
31 |
32 |
35 |
36 |
39 |
40 |
42 |
43 |
45 |
46 |
47 |
48 |
50 |
51 |
52 |
--------------------------------------------------------------------------------
/requs-core/src/main/scss/requs.scss:
--------------------------------------------------------------------------------
1 | /*
2 | * SPDX-FileCopyrightText: Copyright (c) 2009-2025, Yegor Bugayenko
3 | * SPDX-License-Identifier: MIT
4 | */
5 |
6 | * {
7 | padding: 0;
8 | margin: 0;
9 | }
10 |
11 | body {
12 | margin: 2em;
13 | font-family: 'Ubuntu', 'Arial', serif;
14 | font-size: 16px;
15 | color: #4e4e4e;
16 | }
17 |
18 | a {
19 | color: #428bca;
20 | text-decoration: none;
21 | &:hover {
22 | text-decoration: underline;
23 | }
24 | }
25 |
26 | code, pre {
27 | font-family: 'Monaco', 'Courier New', monospace;
28 | background-color: #ccc;
29 | }
30 |
31 | code {
32 | padding: 0 .4em;
33 | }
34 |
35 | p, ul, ol {
36 | margin-top: 1em;
37 | margin-bottom: 1em;
38 | }
39 |
40 | td, th {
41 | padding: .3em;
42 | border-bottom: 1px solid #ccc;
43 | }
44 |
45 | th {
46 | text-align: left;
47 | background-color: #ddd;
48 | border-bottom: 1px solid #444;
49 | font-weight: 500;
50 | }
51 |
52 | h1 {
53 | margin-top: 2em;
54 | font-size: 1.4em;
55 | }
56 |
57 | h2 {
58 | margin-top: 2em;
59 | font-size: 1.2em;
60 | }
61 |
62 | li {
63 | margin-left: 2em;
64 | }
65 |
66 | .intro {
67 | font-size: 0.9em;
68 | color: #999;
69 | }
70 |
71 | .type {
72 | margin-top: 3em;
73 | }
74 |
75 | .slots {
76 | margin-left: 1em;
77 | margin-top: 1em;
78 | }
79 |
80 | .method {
81 | margin-top: 1em;
82 | margin-left: 1em;
83 | }
84 |
85 | .steps {
86 | margin-top: 1em;
87 | margin-left: 1em
88 | }
89 |
90 | .step {
91 | margin-top: 0.25em;
92 | }
93 |
94 | .nfrs {
95 | margin-top: 1em;
96 | margin-left: 1em
97 | }
98 |
99 | .nfr {
100 | margin-top: 0.25em;
101 | }
102 |
103 | .exception {
104 | margin-left: 1em;
105 | margin-top: 1em;
106 | margin-bottom: 1em;
107 | }
108 |
109 | .informal {
110 | color: #666;
111 | }
112 |
113 | .warning {
114 | color: #d9534f;
115 | }
116 |
117 | .crud, .fail {
118 | color: #5cb85c;
119 | }
120 |
121 | .label {
122 | margin-left: 0.5em;
123 | color: white;
124 | border-radius: .25em;
125 | font-size: 0.85em;
126 | padding: .1em .3em .15em;
127 | }
128 |
129 | .attribute {
130 | background-color: #999;
131 | }
132 |
133 | .sealed {
134 | background-color: #5cb85c;
135 | }
136 |
137 | .seal {
138 | background-color: #5bc0de;
139 | }
140 |
141 | .uml {
142 | display: inline-block;
143 | margin-top: 0.5em;
144 | margin-bottom: 0.5em;
145 | border: 1px solid gray;
146 | padding: 1em;
147 | }
148 |
--------------------------------------------------------------------------------
/requs-core/src/test/java/org/requs/facet/package-info.java:
--------------------------------------------------------------------------------
1 | /*
2 | * SPDX-FileCopyrightText: Copyright (c) 2009-2025, Yegor Bugayenko
3 | * SPDX-License-Identifier: MIT
4 | */
5 |
6 | /**
7 | * Facets, tests.
8 | *
9 | * @since 1.2
10 | */
11 | package org.requs.facet;
12 |
--------------------------------------------------------------------------------
/requs-core/src/test/java/org/requs/facet/sa/CascadingRuleTest.java:
--------------------------------------------------------------------------------
1 | /*
2 | * SPDX-FileCopyrightText: Copyright (c) 2009-2025, Yegor Bugayenko
3 | * SPDX-License-Identifier: MIT
4 | */
5 | package org.requs.facet.sa;
6 |
7 | import com.jcabi.aspects.Tv;
8 | import org.hamcrest.MatcherAssert;
9 | import org.hamcrest.Matchers;
10 | import org.junit.jupiter.api.Test;
11 |
12 | /**
13 | * Test case for {@link CascadingRule}.
14 | * @since 1.14
15 | */
16 | public final class CascadingRuleTest {
17 |
18 | @Test
19 | public void checksInput() {
20 | MatcherAssert.assertThat(
21 | new CascadingRule().enforce("hey\n works\n fine\nstart"),
22 | Matchers.empty()
23 | );
24 | }
25 |
26 | @Test
27 | public void checksInvalidInput() {
28 | MatcherAssert.assertThat(
29 | new CascadingRule().enforce(
30 | "\n\n\n hey\n three!"
31 | ).iterator().next().line(),
32 | Matchers.equalTo(Tv.FIVE)
33 | );
34 | }
35 |
36 | }
37 |
--------------------------------------------------------------------------------
/requs-core/src/test/java/org/requs/facet/sa/IndentationRuleTest.java:
--------------------------------------------------------------------------------
1 | /*
2 | * SPDX-FileCopyrightText: Copyright (c) 2009-2025, Yegor Bugayenko
3 | * SPDX-License-Identifier: MIT
4 | */
5 | package org.requs.facet.sa;
6 |
7 | import org.hamcrest.MatcherAssert;
8 | import org.hamcrest.Matchers;
9 | import org.junit.jupiter.api.Test;
10 |
11 | /**
12 | * Test case for {@link IndentationRule}.
13 | * @since 1.14
14 | */
15 | public final class IndentationRuleTest {
16 |
17 | @Test
18 | public void checksInput() throws Exception {
19 | MatcherAssert.assertThat(
20 | new IndentationRule().check(" works fine"),
21 | Matchers.empty()
22 | );
23 | }
24 |
25 | @Test
26 | public void checksInvalidInput() throws Exception {
27 | MatcherAssert.assertThat(
28 | new IndentationRule().check(" works fine"),
29 | Matchers.not(Matchers.empty())
30 | );
31 | }
32 |
33 | }
34 |
--------------------------------------------------------------------------------
/requs-core/src/test/java/org/requs/facet/sa/LineRuleTest.java:
--------------------------------------------------------------------------------
1 | /*
2 | * SPDX-FileCopyrightText: Copyright (c) 2009-2025, Yegor Bugayenko
3 | * SPDX-License-Identifier: MIT
4 | */
5 | package org.requs.facet.sa;
6 |
7 | import com.jcabi.aspects.Tv;
8 | import org.hamcrest.MatcherAssert;
9 | import org.hamcrest.Matchers;
10 | import org.junit.jupiter.api.Test;
11 |
12 | /**
13 | * Test case for {@link LineRule}.
14 | * @since 1.14
15 | */
16 | public final class LineRuleTest {
17 |
18 | @Test
19 | public void checksInvalidInput() throws Exception {
20 | MatcherAssert.assertThat(
21 | new LineRule.Wrap(new RegexRule("[a-z]+", "")).enforce(
22 | "\n\n\nhey"
23 | ).iterator().next().line(),
24 | Matchers.equalTo(Tv.FOUR)
25 | );
26 | }
27 |
28 | }
29 |
--------------------------------------------------------------------------------
/requs-core/src/test/java/org/requs/facet/sa/RegexRuleTest.java:
--------------------------------------------------------------------------------
1 | /*
2 | * SPDX-FileCopyrightText: Copyright (c) 2009-2025, Yegor Bugayenko
3 | * SPDX-License-Identifier: MIT
4 | */
5 | package org.requs.facet.sa;
6 |
7 | import org.hamcrest.MatcherAssert;
8 | import org.hamcrest.Matchers;
9 | import org.junit.jupiter.api.Test;
10 |
11 | /**
12 | * Test case for {@link RegexRule}.
13 | * @since 1.14
14 | */
15 | public final class RegexRuleTest {
16 |
17 | @Test
18 | public void checksInput() throws Exception {
19 | MatcherAssert.assertThat(
20 | new RegexRule("[a-z]+", "").check("abjkljeklsf"),
21 | Matchers.not(Matchers.empty())
22 | );
23 | }
24 |
25 | @Test
26 | public void checksInvalidInput() throws Exception {
27 | MatcherAssert.assertThat(
28 | new RegexRule("[0-9]", "").check("broken input"),
29 | Matchers.empty()
30 | );
31 | }
32 |
33 | }
34 |
--------------------------------------------------------------------------------
/requs-core/src/test/java/org/requs/facet/sa/RulesTest.java:
--------------------------------------------------------------------------------
1 | /*
2 | * SPDX-FileCopyrightText: Copyright (c) 2009-2025, Yegor Bugayenko
3 | * SPDX-License-Identifier: MIT
4 | */
5 | package org.requs.facet.sa;
6 |
7 | import com.jcabi.matchers.XhtmlMatchers;
8 | import com.jcabi.xml.XMLDocument;
9 | import java.io.IOException;
10 | import org.apache.commons.lang3.StringUtils;
11 | import org.hamcrest.MatcherAssert;
12 | import org.junit.jupiter.api.Test;
13 | import org.requs.XeFacet;
14 |
15 | /**
16 | * Test case for {@link Rules}.
17 | * @since 1.10
18 | */
19 | public final class RulesTest {
20 |
21 | @Test
22 | public void checksInput() throws IOException {
23 | MatcherAssert.assertThat(
24 | new XeFacet.Wrap(new Rules()).touch(
25 | new XMLDocument(
26 | StringUtils.join(
27 | "This is also
44 | """.
45 |
--------------------------------------------------------------------------------
/requs-core/src/test/resources/org/requs/facet/syntax/example.req:
--------------------------------------------------------------------------------
1 | :UC1 is a must.
2 |
3 | Fraction is "a math calculator".
4 |
5 | Fraction needs:
6 | numerator as Float, and
7 | denominator as Float.
8 |
9 | UC1 where User (a user) divides two numbers:
10 | 1. The user creates Fraction (a fraction);
11 | 2. The fraction calculates Float (a quotient);
12 | 3. The user "receives results" using the quotient.
13 |
14 | UC1/2 when "division by zero":
15 | 1. Fail as "denominator can't be zero".
16 |
17 | UC1/PRF must "be 500 milliseconds per HTTP request".
18 |
--------------------------------------------------------------------------------
/requs-core/src/test/resources/org/requs/facet/syntax/samples/all-possible-mistakes.xml:
--------------------------------------------------------------------------------
1 |
2 |
31 |
32 |
33 | Test is "a test".
34 | "This is an informal text"
35 | UC1 where User (a user) saves "a file".
36 | UC1 where another User saves.
37 | " some user saves something"""...
38 |
39 | "duplicate signatures of the same method".
40 | UC5 where User loads file:
41 | 1. User loads.
42 | UC5 where User loads file:
43 | 1. User loads another file.
44 |
45 | "duplicate signatures of the same methods".
46 | UC7 where User loads some file: "something".
47 | UC7 where Customer loads some file: "tbd".
48 |
49 | "duplicate signatures of the different methods".
50 | UC9 where User saves good file: "something".
51 | UC11 where Customer saves good file: "tbd".
52 |
53 | UC1 where System (a system) works:
54 | 1. The system creates Message (a.
55 |
56 | UC76 where User does it:
57 | 1. User creates Message (a.
58 | UC76/1 when "something happens":
59 | 1. User send Message (a message).
60 |
61 |
62 | /spec/errors/error
63 |
64 |
65 |
--------------------------------------------------------------------------------
/requs-core/src/test/resources/org/requs/facet/syntax/samples/nfr.xml:
--------------------------------------------------------------------------------
1 |
2 |
31 |
32 |
33 | UC1 where User saves file: "empty".
34 | UC1/UX must "be awesome".
35 |
36 |
37 | /spec/errors[not(error)]
38 | /spec/methods[count(method)=1]
39 | //method[id='UC1']
40 | //method/nfrs[count(nfr)=1]
41 | //nfr[id='UX']
42 | //nfr/info[informal='be awesome']
43 |
44 |
45 |
--------------------------------------------------------------------------------
/requs-core/src/test/resources/org/requs/facet/syntax/samples/pages.xml:
--------------------------------------------------------------------------------
1 |
2 |
31 |
32 |
33 | User is "a human being".
34 | Vision: """ this is a "test" """.
35 |
36 |
37 | /spec/errors[not(error)]
38 | /spec[not(methods)]
39 | /spec/types[count(type)=1]
40 | /spec/pages[count(page)=1]
41 | /spec/pages/page[title='Vision' and info/informal=' this is a "test" ']
42 |
43 |
44 |
--------------------------------------------------------------------------------
/requs-core/src/test/resources/org/requs/facet/syntax/samples/types.xml:
--------------------------------------------------------------------------------
1 |
2 |
31 |
32 |
33 | User is a "human being".
34 | S3Repo is a "repository".
35 | BmwMPower is a "car".
36 |
37 |
38 | /spec/errors[not(error)]
39 | /spec/types[count(type)=3]
40 |
41 |
42 |
--------------------------------------------------------------------------------
/requs-core/src/test/resources/org/requs/samples/clean-spec.xml:
--------------------------------------------------------------------------------
1 |
2 |
31 |
32 |
33 | User is a "human being".
34 |
35 | File is a "binary object on disc".
36 |
37 | File includes:
38 | name as "unique text",
39 | content as Binary "that complies to our requirements".
40 |
41 | Binary is "a collection of bytes".
42 |
43 | UC1 where User (a user) saves very complex File (a file):
44 | 1. The user "opens Excel";
45 | 2. The user "clicks SAVE and saves the content" using the file;
46 | 3. The user creates the file;
47 | 4. The user validates the file;
48 | 5. Storage (a storage) reads the user.
49 |
50 | UC2 where User validates File: "we'll define later".
51 |
52 | """This is a comment""".
53 |
54 | Vision: "some **Markdown** document".
55 |
56 | :UC1 is a must.
57 |
58 | UC1/UX must "be cool".
59 |
60 | Storage is an actor.
61 |
62 |
63 | /spec/errors[count(error)=0]
64 |
65 |
66 |
--------------------------------------------------------------------------------
/requs-core/src/test/resources/org/requs/samples/empty-input.xml:
--------------------------------------------------------------------------------
1 |
2 |
31 |
32 |
33 |
34 | /processing-instruction()[contains(.,'href')]
35 | /spec/errors[count(error)=0]
36 |
37 |
38 |
--------------------------------------------------------------------------------
/requs-core/src/test/resources/org/requs/samples/exceptions.xml:
--------------------------------------------------------------------------------
1 |
2 |
31 |
32 |
33 | UC1 where User (a user) works:
34 | 1. The user creates;
35 | 2. Fail as "it doesn't work";
36 | 3. The user reads.
37 | UC1/1 when "something goes wrong":
38 | 1. Fail as "something went wrong".
39 | UC1/2 when "something goes wrong":
40 | 1. "Do something else".
41 |
42 |
43 | /processing-instruction()[contains(.,'href')]
44 | /spec/errors[count(error)=3]
45 |
46 |
47 |
--------------------------------------------------------------------------------
/requs-core/src/test/resources/org/requs/samples/order-of-steps.xml:
--------------------------------------------------------------------------------
1 |
2 |
31 |
32 |
33 | UC1 where User (a user) works:
34 | 1. The user creates;
35 | 3. The user reads;
36 | 2. The user updates.
37 | UC2 where User (a user) works again:
38 | 1. The user creates;
39 | 2. The user reads;
40 | 3. The user reads;
41 | 4. The user reads;
42 | 5. The user reads;
43 | 6. The user reads;
44 | 7. The user reads;
45 | 8. The user reads;
46 | 9. The user reads;
47 | 10. The user reads.
48 |
49 |
50 | /processing-instruction()[contains(.,'href')]
51 | /spec/errors[count(error)=4]
52 |
53 |
54 |
--------------------------------------------------------------------------------
/requs-core/src/test/resources/org/requs/samples/wrong-steps-numbering.xml:
--------------------------------------------------------------------------------
1 |
2 |
31 |
32 |
33 | UC1 where User (a user) works:
34 | 1. The user creates;
35 | 2. The user reads;
36 | 5. The user updates.
37 |
38 |
39 | /spec/errors[count(error)=1]
40 |
41 |
42 |
--------------------------------------------------------------------------------
/requs-exec/LICENSE.txt:
--------------------------------------------------------------------------------
1 | Copyright (c) 2009-2025, Yegor Bugayenko
2 | All rights reserved.
3 |
4 | Redistribution and use in source and binary forms, with or without
5 | modification, are permitted provided that the following conditions
6 | are met: 1) Redistributions of source code must retain the above
7 | copyright notice, this list of conditions and the following
8 | disclaimer. 2) Redistributions in binary form must reproduce the above
9 | copyright notice, this list of conditions and the following
10 | disclaimer in the documentation and/or other materials provided
11 | with the distribution. 3) Neither the name of the requs.org nor
12 | the names of its contributors may be used to endorse or promote
13 | products derived from this software without specific prior written
14 | permission.
15 |
16 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17 | "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT
18 | NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
19 | FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
20 | THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
21 | INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22 | (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
23 | SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 | HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
25 | STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26 | ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
27 | OF THE POSSIBILITY OF SUCH DAMAGE.
28 |
--------------------------------------------------------------------------------
/requs-exec/src/it/compiles-simple-syntax/invoker.properties:
--------------------------------------------------------------------------------
1 | # SPDX-FileCopyrightText: Copyright (c) 2009-2025, Yegor Bugayenko
2 | # SPDX-License-Identifier: MIT
3 |
4 | invoker.goals = test
5 |
--------------------------------------------------------------------------------
/requs-exec/src/it/compiles-simple-syntax/requs-src/input.req:
--------------------------------------------------------------------------------
1 | Fraction is a "math calculator".
2 |
3 | Fraction needs:
4 | numerator as Float, and
5 | denominator as Float.
6 |
7 | UC1 where User (a user) divides two numbers:
8 | 1. The user creates Fraction (a fraction);
9 | 2. The fraction "calculates" Float (a quotient);
10 | 3. The user "receives results" using the quotient.
11 |
12 | UC1/2 when "division by zero":
13 | 1. Fail as "denominator can't be zero".
14 |
15 | UC1/UX must "look amazing".
16 |
--------------------------------------------------------------------------------
/requs-exec/src/it/compiles-simple-syntax/verify.groovy:
--------------------------------------------------------------------------------
1 | /*
2 | * SPDX-FileCopyrightText: Copyright (c) 2009-2025, Yegor Bugayenko
3 | * SPDX-License-Identifier: MIT
4 | */
5 |
6 | import com.jcabi.matchers.XhtmlMatchers
7 | import org.hamcrest.MatcherAssert
8 |
9 | def xml = new File(basedir, 'target/requs/requs.xml')
10 | if (!xml.exists()) {
11 | throw new IllegalStateException(
12 | 'XML was not generated at ' + xml
13 | )
14 | }
15 | MatcherAssert.assertThat(
16 | XhtmlMatchers.xhtml(xml.text),
17 | XhtmlMatchers.hasXPaths(
18 | '/spec/types/type[name="Fraction"]',
19 | '/spec/types/type[name="User"]'
20 | )
21 | )
22 |
--------------------------------------------------------------------------------
/requs-exec/src/it/settings.xml:
--------------------------------------------------------------------------------
1 |
2 |
31 |
32 |
33 |
34 | it-repo
35 |
36 | true
37 |
38 |
39 |
40 | local.central
41 | @localRepositoryUrl@
42 |
43 | true
44 |
45 |
46 | true
47 |
48 |
49 |
50 |
51 |
52 | local.central
53 | @localRepositoryUrl@
54 |
55 | true
56 |
57 |
58 | true
59 |
60 |
61 |
62 |
63 |
64 |
65 |
--------------------------------------------------------------------------------
/requs-exec/src/main/assembly/bin.xml:
--------------------------------------------------------------------------------
1 |
2 |
31 |
32 | bin
33 | false
34 |
35 | jar
36 |
37 |
38 |
39 | ${project.build.outputDirectory}
40 | /
41 |
42 |
43 |
44 |
45 | false
46 |
47 |
48 | true
49 | runtime
50 |
51 |
52 |
53 |
--------------------------------------------------------------------------------
/requs-exec/src/main/java/org/requs/exec/Main.java:
--------------------------------------------------------------------------------
1 | /*
2 | * SPDX-FileCopyrightText: Copyright (c) 2009-2025, Yegor Bugayenko
3 | * SPDX-License-Identifier: MIT
4 | */
5 | package org.requs.exec;
6 |
7 | import com.jcabi.manifests.Manifests;
8 | import java.io.File;
9 | import java.io.IOException;
10 | import java.io.PrintStream;
11 | import java.nio.charset.StandardCharsets;
12 | import joptsimple.OptionParser;
13 | import joptsimple.OptionSet;
14 | import org.apache.commons.io.IOUtils;
15 |
16 | /**
17 | * Entry point of the JAR.
18 | *
19 | * @since 1.1
20 | * @checkstyle MultipleStringLiteralsCheck (500 lines)
21 | */
22 | public final class Main {
23 |
24 | /**
25 | * Private ctor, to avoid instantiation of this class.
26 | */
27 | private Main() {
28 | // intentionally empty
29 | }
30 |
31 | /**
32 | * Entry point of the entire JAR.
33 | * @param args List of command-line arguments
34 | * @throws IOException If something goes wrong inside
35 | */
36 | @SuppressWarnings("PMD.ProhibitPublicStaticMethods")
37 | public static void main(final String... args) throws IOException {
38 | final OptionParser parser = new OptionParser("h*vi:o:");
39 | final PrintStream out = System.out;
40 | parser.posixlyCorrect(true);
41 | final OptionSet options = parser.parse(args);
42 | if (options.has("v")) {
43 | IOUtils.write(
44 | String.format(
45 | "%s/%s",
46 | Manifests.read("Requs-Version"),
47 | Manifests.read("Requs-Revision")
48 | ),
49 | out,
50 | StandardCharsets.UTF_8
51 | );
52 | } else if (options.has("i") && options.has("o")) {
53 | new org.requs.Compiler(
54 | new File(options.valueOf("i").toString()),
55 | new File(options.valueOf("o").toString())
56 | ).compile();
57 | } else {
58 | out.println("Usage: java -jar requs-exec.jar [options]");
59 | out.println("where options include:\n");
60 | parser.printHelpOn(out);
61 | }
62 | }
63 |
64 | }
65 |
--------------------------------------------------------------------------------
/requs-exec/src/main/java/org/requs/exec/package-info.java:
--------------------------------------------------------------------------------
1 | /*
2 | * SPDX-FileCopyrightText: Copyright (c) 2009-2025, Yegor Bugayenko
3 | * SPDX-License-Identifier: MIT
4 | */
5 |
6 | /**
7 | * Command Line Interface (CLI) classes.
8 | */
9 | package org.requs.exec;
10 |
--------------------------------------------------------------------------------
/requs-exec/src/main/resources/log4j.properties:
--------------------------------------------------------------------------------
1 | # Copyright (c) 2009-2025, Yegor Bugayenko
2 | # All rights reserved.
3 | #
4 | # Redistribution and use in source and binary forms, with or without
5 | # modification, are permitted provided that the following conditions
6 | # are met: 1) Redistributions of source code must retain the above
7 | # copyright notice, this list of conditions and the following
8 | # disclaimer. 2) Redistributions in binary form must reproduce the above
9 | # copyright notice, this list of conditions and the following
10 | # disclaimer in the documentation and/or other materials provided
11 | # with the distribution. 3) Neither the name of the requs.org nor
12 | # the names of its contributors may be used to endorse or promote
13 | # products derived from this software without specific prior written
14 | # permission.
15 | #
16 | # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17 | # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT
18 | # NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
19 | # FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
20 | # THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
21 | # INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22 | # (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
23 | # SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 | # HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
25 | # STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26 | # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
27 | # OF THE POSSIBILITY OF SUCH DAMAGE.
28 |
29 | #
30 | # SPDX-FileCopyrightText: Copyright (c) 2009-2025, Yegor Bugayenko
31 | # SPDX-License-Identifier: MIT
32 |
33 | log4j.rootLogger=WARN, CONSOLE
34 |
35 | log4j.appender.CONSOLE=org.apache.log4j.ConsoleAppender
36 | log4j.appender.CONSOLE.layout=com.jcabi.log.MulticolorLayout
37 | log4j.appender.CONSOLE.layout.ConversionPattern=[%color{%p}] %t %c: %m%n
38 | log4j.logger.org.requs=INFO
39 |
--------------------------------------------------------------------------------
/requs-exec/src/test/java/org/requs/exec/MainTest.java:
--------------------------------------------------------------------------------
1 | /*
2 | * SPDX-FileCopyrightText: Copyright (c) 2009-2025, Yegor Bugayenko
3 | * SPDX-License-Identifier: MIT
4 | */
5 | package org.requs.exec;
6 |
7 | import com.jcabi.matchers.XhtmlMatchers;
8 | import java.io.ByteArrayOutputStream;
9 | import java.io.File;
10 | import java.io.PrintStream;
11 | import java.nio.charset.StandardCharsets;
12 | import java.nio.file.Path;
13 | import org.apache.commons.io.FileUtils;
14 | import org.hamcrest.MatcherAssert;
15 | import org.hamcrest.Matchers;
16 | import org.junit.jupiter.api.AfterEach;
17 | import org.junit.jupiter.api.BeforeEach;
18 | import org.junit.jupiter.api.Test;
19 | import org.junit.jupiter.api.io.TempDir;
20 |
21 | /**
22 | * Test case for {@link Main}.
23 | * @since 1.1
24 | */
25 | public final class MainTest {
26 |
27 | /**
28 | * Output stream for tests.
29 | */
30 | private transient ByteArrayOutputStream out;
31 |
32 | @BeforeEach
33 | public void changeSystemOutputSteam() throws Exception {
34 | this.out = new ByteArrayOutputStream();
35 | System.setOut(new PrintStream(this.out, true));
36 | }
37 |
38 | @AfterEach
39 | public void revertChangedSystemOutputStream() throws Exception {
40 | System.setOut(null);
41 | }
42 |
43 | @Test
44 | public void displaysVersionNumber() throws Exception {
45 | Main.main(new String[]{"-v"});
46 | MatcherAssert.assertThat(
47 | this.out.toString(),
48 | Matchers.containsString("-SNAPSHOT")
49 | );
50 | }
51 |
52 | @Test
53 | public void rendersHelpMessage() throws Exception {
54 | Main.main(new String[] {"-h"});
55 | MatcherAssert.assertThat(
56 | this.out.toString(),
57 | Matchers.containsString("Usage:")
58 | );
59 | }
60 |
61 | @Test
62 | public void compilesRequsSources(@TempDir final Path temp) throws Exception {
63 | final File input = temp.resolve("input").toFile();
64 | final File output = temp.resolve("output").toFile();
65 | FileUtils.write(
66 | new File(input, "employee.req"),
67 | "Employee is a \"user of the system\".",
68 | StandardCharsets.UTF_8
69 | );
70 | Main.main(
71 | new String[] {
72 | "-i", input.getAbsolutePath(),
73 | "-o", output.getAbsolutePath(),
74 | }
75 | );
76 | MatcherAssert.assertThat(
77 | this.out.toString(),
78 | Matchers.containsString("compiled and saved to")
79 | );
80 | MatcherAssert.assertThat(
81 | XhtmlMatchers.xhtml(
82 | FileUtils.readFileToString(
83 | new File(output, "requs.xml"),
84 | StandardCharsets.UTF_8
85 | )
86 | ),
87 | XhtmlMatchers.hasXPaths("/spec/types/type[name='Employee']")
88 | );
89 | }
90 |
91 | }
92 |
--------------------------------------------------------------------------------
/requs-exec/src/test/java/org/requs/exec/package-info.java:
--------------------------------------------------------------------------------
1 | /*
2 | * SPDX-FileCopyrightText: Copyright (c) 2009-2025, Yegor Bugayenko
3 | * SPDX-License-Identifier: MIT
4 | */
5 |
6 | /**
7 | * Command Line Interface (CLI) classes, tests.
8 | */
9 | package org.requs.exec;
10 |
--------------------------------------------------------------------------------
/requs-exec/src/test/resources/META-INF/MANIFEST.MF:
--------------------------------------------------------------------------------
1 | Requs-Version: 1.0-SNAPSHOT
2 | Requs-Revision: 1a2b3e4f
3 | Requs-Date: 1-Jan-2017
4 |
--------------------------------------------------------------------------------
/requs-exec/src/test/resources/log4j.properties:
--------------------------------------------------------------------------------
1 | # Copyright (c) 2009-2025, Yegor Bugayenko
2 | # All rights reserved.
3 | #
4 | # Redistribution and use in source and binary forms, with or without
5 | # modification, are permitted provided that the following conditions
6 | # are met: 1) Redistributions of source code must retain the above
7 | # copyright notice, this list of conditions and the following
8 | # disclaimer. 2) Redistributions in binary form must reproduce the above
9 | # copyright notice, this list of conditions and the following
10 | # disclaimer in the documentation and/or other materials provided
11 | # with the distribution. 3) Neither the name of the requs.org nor
12 | # the names of its contributors may be used to endorse or promote
13 | # products derived from this software without specific prior written
14 | # permission.
15 | #
16 | # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17 | # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT
18 | # NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
19 | # FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
20 | # THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
21 | # INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22 | # (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
23 | # SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 | # HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
25 | # STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26 | # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
27 | # OF THE POSSIBILITY OF SUCH DAMAGE.
28 |
29 | #
30 | # SPDX-FileCopyrightText: Copyright (c) 2009-2025, Yegor Bugayenko
31 | # SPDX-License-Identifier: MIT
32 |
33 | log4j.rootLogger=WARN, CONSOLE
34 |
35 | log4j.appender.CONSOLE=org.apache.log4j.ConsoleAppender
36 | log4j.appender.CONSOLE.layout=com.jcabi.log.MulticolorLayout
37 | log4j.appender.CONSOLE.layout.ConversionPattern=[%color{%p}] %t %c: %m%n
38 |
39 | log4j.logger.org.requs=INFO
40 |
--------------------------------------------------------------------------------
/requs-maven-plugin/LICENSE.txt:
--------------------------------------------------------------------------------
1 | Copyright (c) 2009-2025, Yegor Bugayenko
2 | All rights reserved.
3 |
4 | Redistribution and use in source and binary forms, with or without
5 | modification, are permitted provided that the following conditions
6 | are met: 1) Redistributions of source code must retain the above
7 | copyright notice, this list of conditions and the following
8 | disclaimer. 2) Redistributions in binary form must reproduce the above
9 | copyright notice, this list of conditions and the following
10 | disclaimer in the documentation and/or other materials provided
11 | with the distribution. 3) Neither the name of the requs.org nor
12 | the names of its contributors may be used to endorse or promote
13 | products derived from this software without specific prior written
14 | permission.
15 |
16 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17 | "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT
18 | NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
19 | FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
20 | THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
21 | INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22 | (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
23 | SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 | HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
25 | STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26 | ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
27 | OF THE POSSIBILITY OF SUCH DAMAGE.
28 |
--------------------------------------------------------------------------------
/requs-maven-plugin/src/it/absent-input-dir/invoker.properties:
--------------------------------------------------------------------------------
1 | # SPDX-FileCopyrightText: Copyright (c) 2009-2025, Yegor Bugayenko
2 | # SPDX-License-Identifier: MIT
3 |
4 | invoker.goals = compile
5 | invoker.buildResult = success
6 |
--------------------------------------------------------------------------------
/requs-maven-plugin/src/it/absent-input-dir/pom.xml:
--------------------------------------------------------------------------------
1 |
2 |
31 |
32 | 4.0.0
33 | org.requs
34 | requs-test
35 | 2.0-SNAPSHOT
36 | absent-input-dir
37 |
38 |
39 |
40 | org.requs
41 | requs-maven-plugin
42 | @project.version@
43 |
44 |
45 |
46 | compile
47 |
48 |
49 |
50 |
51 |
52 |
53 |
54 |
--------------------------------------------------------------------------------
/requs-maven-plugin/src/it/broken-spec/invoker.properties:
--------------------------------------------------------------------------------
1 | # SPDX-FileCopyrightText: Copyright (c) 2009-2025, Yegor Bugayenko
2 | # SPDX-License-Identifier: MIT
3 |
4 | invoker.goals = compile
5 | invoker.buildResult = failure
6 |
--------------------------------------------------------------------------------
/requs-maven-plugin/src/it/broken-spec/pom.xml:
--------------------------------------------------------------------------------
1 |
2 |
31 |
32 | 4.0.0
33 | org.requs
34 | requs-test
35 | 2.0-SNAPSHOT
36 | broken-facet
37 |
38 |
39 |
40 | org.requs
41 | requs-maven-plugin
42 | @project.version@
43 |
44 |
45 |
46 | compile
47 |
48 |
49 |
50 |
51 |
52 |
53 |
54 |
--------------------------------------------------------------------------------
/requs-maven-plugin/src/it/broken-spec/src/main/requs/input.req:
--------------------------------------------------------------------------------
1 | Fraction is a math calculator.
2 |
3 | Fraction needs some data.
4 |
--------------------------------------------------------------------------------
/requs-maven-plugin/src/it/broken-spec/verify.groovy:
--------------------------------------------------------------------------------
1 | /*
2 | * SPDX-FileCopyrightText: Copyright (c) 2009-2025, Yegor Bugayenko
3 | * SPDX-License-Identifier: MIT
4 | */
5 |
6 | import com.jcabi.matchers.XhtmlMatchers
7 | import org.hamcrest.MatcherAssert
8 | import org.hamcrest.Matchers
9 |
10 | def log = new File(basedir, 'build.log')
11 | MatcherAssert.assertThat(
12 | log.text,
13 | Matchers.containsString(' requs error(s)')
14 | )
15 | def xml = new File(basedir, 'target/requs/requs.xml')
16 | if (!xml.exists()) {
17 | throw new IllegalStateException(
18 | 'XML was not generated at ' + xml
19 | )
20 | }
21 | MatcherAssert.assertThat(
22 | XhtmlMatchers.xhtml(xml.text),
23 | XhtmlMatchers.hasXPaths(
24 | '/spec/types/type[name="Fraction"]',
25 | '/spec/errors/error'
26 | )
27 | )
28 |
--------------------------------------------------------------------------------
/requs-maven-plugin/src/it/report-in-site/invoker.properties:
--------------------------------------------------------------------------------
1 | # SPDX-FileCopyrightText: Copyright (c) 2009-2025, Yegor Bugayenko
2 | # SPDX-License-Identifier: MIT
3 |
4 | invoker.goals = site
5 |
--------------------------------------------------------------------------------
/requs-maven-plugin/src/it/report-in-site/pom.xml:
--------------------------------------------------------------------------------
1 |
2 |
31 |
32 | 4.0.0
33 | org.requs
34 | requs-test
35 | 2.0-SNAPSHOT
36 | report-in-site
37 |
38 |
39 |
40 | org.requs
41 | requs-maven-plugin
42 | @project.version@
43 |
44 |
45 |
46 |
47 |
48 |
49 | org.requs
50 | requs-maven-plugin
51 | @project.version@
52 |
53 |
54 | maven-site-plugin
55 | 3.9.1
56 |
57 |
58 |
59 |
60 |
--------------------------------------------------------------------------------
/requs-maven-plugin/src/it/report-in-site/src/main/requs/input.req:
--------------------------------------------------------------------------------
1 | Fraction is a "math calculator".
2 |
3 | Fraction needs:
4 | numerator as Float, and
5 | denominator as Float.
6 |
7 | UC1 where User (a user) divides two numbers:
8 | 1. The user creates Fraction (a fraction);
9 | 2. The fraction "calculates" Float (a quotient);
10 | 3. The user "receives results" using the quotient.
11 |
12 | UC1/2 when "division by zero":
13 | 1. Fail as "denominator can't be zero".
14 |
15 | UC1/MTBF must "be 3 minutes".
16 |
--------------------------------------------------------------------------------
/requs-maven-plugin/src/it/report-in-site/verify.groovy:
--------------------------------------------------------------------------------
1 | /*
2 | * SPDX-FileCopyrightText: Copyright (c) 2009-2025, Yegor Bugayenko
3 | * SPDX-License-Identifier: MIT
4 | */
5 |
6 | def index = new File(basedir, 'target/site/requs.html')
7 | if (!index.exists()) {
8 | throw new IllegalStateException(
9 | 'Index was not generated at ' + index
10 | )
11 | }
12 | if (!index.text.contains('SRS')) {
13 | throw new IllegalStateException(
14 | 'SRS is not in the index ' + index
15 | )
16 | }
17 |
18 | def dir = new File(basedir, 'target/site/requs')
19 | if (!dir.exists()) {
20 | throw new IllegalStateException(
21 | 'Report was not generated at ' + dir
22 | )
23 | }
24 | if (!dir.isDirectory()) {
25 | throw new IllegalStateException(
26 | 'Report is not a directory: ' + dir
27 | )
28 | }
29 |
--------------------------------------------------------------------------------
/requs-maven-plugin/src/it/settings.xml:
--------------------------------------------------------------------------------
1 |
2 |
31 |
32 |
33 |
34 | it-repo
35 |
36 | true
37 |
38 |
39 |
40 | local.central
41 | @localRepositoryUrl@
42 |
43 | true
44 |
45 |
46 | true
47 |
48 |
49 |
50 |
51 |
52 | local.central
53 | @localRepositoryUrl@
54 |
55 | true
56 |
57 |
58 | true
59 |
60 |
61 |
62 |
63 |
64 |
65 |
--------------------------------------------------------------------------------
/requs-maven-plugin/src/it/simple-compile/invoker.properties:
--------------------------------------------------------------------------------
1 | # SPDX-FileCopyrightText: Copyright (c) 2009-2025, Yegor Bugayenko
2 | # SPDX-License-Identifier: MIT
3 |
4 | invoker.goals = compile
5 |
--------------------------------------------------------------------------------
/requs-maven-plugin/src/it/simple-compile/pom.xml:
--------------------------------------------------------------------------------
1 |
2 |
31 |
32 | 4.0.0
33 | org.requs
34 | requs-test
35 | 2.0-SNAPSHOT
36 | simple-read
37 |
38 |
39 |
40 | org.requs
41 | requs-maven-plugin
42 | @project.version@
43 |
44 |
45 |
46 | compile
47 |
48 |
49 |
50 | hello
51 |
52 |
53 |
54 |
55 |
56 |
57 |
58 |
59 |
--------------------------------------------------------------------------------
/requs-maven-plugin/src/it/simple-compile/src/main/requs/input.req:
--------------------------------------------------------------------------------
1 | Float is "a number".
2 |
3 | Fraction is "a math calculator".
4 |
5 | Fraction needs:
6 | numerator as Float, and
7 | denominator as Float.
8 | UC1 where User (a user) divides two numbers:
9 | 1. The user creates Fraction (a fraction);
10 | 2. The fraction "calculates" Float (a quotient);
11 | 3. The user "receives results" using the quotient.
12 |
13 | UC1/2 when "division by zero":
14 | 1. The user "gets notification";
15 | 2. Fail as "denominator can't be zero".
16 |
17 | UC1/PERF must "be 500 millisecond per request".
18 |
--------------------------------------------------------------------------------
/requs-maven-plugin/src/it/simple-compile/verify.groovy:
--------------------------------------------------------------------------------
1 | /*
2 | * SPDX-FileCopyrightText: Copyright (c) 2009-2025, Yegor Bugayenko
3 | * SPDX-License-Identifier: MIT
4 | */
5 |
6 | import com.jcabi.matchers.XhtmlMatchers
7 | import org.hamcrest.MatcherAssert
8 |
9 | def xml = new File(basedir, 'target/requs/requs.xml')
10 | if (!xml.exists()) {
11 | throw new IllegalStateException(
12 | 'XML was not generated at ' + xml
13 | )
14 | }
15 | MatcherAssert.assertThat(
16 | XhtmlMatchers.xhtml(xml.text),
17 | XhtmlMatchers.hasXPaths(
18 | '/spec/types/type[name="Fraction"]',
19 | '/spec/types/type[name="User"]'
20 | )
21 | )
22 |
--------------------------------------------------------------------------------
/requs-maven-plugin/src/main/java/org/requs/maven/package-info.java:
--------------------------------------------------------------------------------
1 | /*
2 | * SPDX-FileCopyrightText: Copyright (c) 2009-2025, Yegor Bugayenko
3 | * SPDX-License-Identifier: MIT
4 | */
5 |
6 | /**
7 | * The requs-maven-plugin.
8 | *
9 | * @since 1.1
10 | */
11 | package org.requs.maven;
12 |
--------------------------------------------------------------------------------
/requs-maven-plugin/src/test/java/org/requs/maven/CompileMojoTest.java:
--------------------------------------------------------------------------------
1 | /*
2 | * SPDX-FileCopyrightText: Copyright (c) 2009-2025, Yegor Bugayenko
3 | * SPDX-License-Identifier: MIT
4 | */
5 | package org.requs.maven;
6 |
7 | import org.junit.jupiter.api.Test;
8 |
9 | /**
10 | * Test case for {@link CompileMojo}.
11 |
12 | * @since 1.0
13 | */
14 | public final class CompileMojoTest {
15 |
16 | /**
17 | * CompileMojo can work.
18 | * @throws Exception If fails
19 | */
20 | @Test
21 | public void testMojoGoal() throws Exception {
22 | // todo
23 | }
24 |
25 | }
26 |
--------------------------------------------------------------------------------
/requs-maven-plugin/src/test/java/org/requs/maven/ReportMojoTest.java:
--------------------------------------------------------------------------------
1 | /*
2 | * SPDX-FileCopyrightText: Copyright (c) 2009-2025, Yegor Bugayenko
3 | * SPDX-License-Identifier: MIT
4 | */
5 | package org.requs.maven;
6 |
7 | import org.junit.jupiter.api.Test;
8 |
9 | /**
10 | * Test case for {@link ReportMojo}.
11 | *
12 | * @since 1.0
13 | */
14 | public class ReportMojoTest {
15 |
16 | /**
17 | * ReportMojo can work.
18 | * @throws Exception If fails
19 | */
20 | @Test
21 | public void testMojoReportGoal() throws Exception {
22 | // todo
23 | }
24 |
25 | }
26 |
--------------------------------------------------------------------------------
/requs-maven-plugin/src/test/java/org/requs/maven/package-info.java:
--------------------------------------------------------------------------------
1 | /*
2 | * SPDX-FileCopyrightText: Copyright (c) 2009-2025, Yegor Bugayenko
3 | * SPDX-License-Identifier: MIT
4 | */
5 |
6 | /**
7 | * The requs-maven-plugin, tests.
8 | */
9 | package org.requs.maven;
10 |
--------------------------------------------------------------------------------
/requs_pygment/.gitignore:
--------------------------------------------------------------------------------
1 | build/
2 | requs_pygment.egg-info
3 |
--------------------------------------------------------------------------------
/requs_pygment/requs_pygment.py:
--------------------------------------------------------------------------------
1 | # -*- coding: utf-8 -*-
2 |
3 | # SPDX-FileCopyrightText: Copyright (c) 2009-2025, Yegor Bugayenko
4 | # SPDX-License-Identifier: MIT
5 |
6 | from pygments.lexer import RegexLexer
7 | from pygments.token import Punctuation, Text, Keyword, Name, String, Operator
8 | from pygments.util import shebang_matches
9 |
10 |
11 | class RequsLexer(RegexLexer):
12 | name = 'requs'
13 | aliases = ['requs']
14 | tokens = {
15 | 'root': [
16 | (r'"""[\n.]+"""', Text),
17 | (r'"[^"]+"', String),
18 | (
19 | r'\b(includes|requires|contains|actor|needs|means|using|of|with|when|must|is|a|(T|t)he|as|where|and)\b',
20 | Keyword,
21 | ),
22 | (r'\b(creates|reads|updates|deletes|Fail\s+since)\b', Operator),
23 | (r'\b[A-Z]+\b', Name),
24 | (r'\b([A-Z][a-z0-9]*)+\b', Name),
25 | (r'[,;:]', Punctuation),
26 | ],
27 | }
28 |
29 | def analyse_text(text):
30 | return shebang_matches(text, r'requs')
31 |
--------------------------------------------------------------------------------
/requs_pygment/setup.py:
--------------------------------------------------------------------------------
1 | # -*- coding: utf-8 -*-
2 |
3 | # SPDX-FileCopyrightText: Copyright (c) 2009-2025, Yegor Bugayenko
4 | # SPDX-License-Identifier: MIT
5 |
6 | from setuptools import setup, find_packages
7 |
8 | setup(
9 | name='requs_pygment',
10 | version='0.1',
11 | packages=find_packages(),
12 | install_requires=['pygments'],
13 | py_modules=['requs_pygment'],
14 | author='Yegor Bugayenko',
15 | author_email='yegor256@gmail.com',
16 | description='Requs Highlighting Pygment',
17 | license='BSD',
18 | keywords='requs',
19 | url='http://www.requs.org/',
20 | entry_points={
21 | 'pygments.lexers': [
22 | 'requs = requs_pygment:RequsLexer'
23 | ]
24 | }
25 | )
26 |
--------------------------------------------------------------------------------
/sdd/.gitignore:
--------------------------------------------------------------------------------
1 | *.bbl
2 | *.bcf
3 | *.blg
4 | *.fdb_latexmk
5 | _minted-*
6 | *.fls
7 | *.log
8 | *.run.xml
9 | *.aux
10 | *.pyg
11 | *.out
12 | wp.pdf
13 |
--------------------------------------------------------------------------------
/sdd/.latexmkrc:
--------------------------------------------------------------------------------
1 | $pdflatex = 'pdflatex %O --shell-escape %S';
2 |
3 | $success_cmd = 'texqc && texsc';
4 |
--------------------------------------------------------------------------------
/sdd/README.md:
--------------------------------------------------------------------------------
1 | To build it you need to have LaTeX, GNU aspell,
2 | [texqc](https://github.com/yegor256/texqc),
3 | and
4 | [texsc](https://github.com/yegor256/texsc) installed.
5 | Then, just do this:
6 |
7 | ```bash
8 | $ latexmk -pdf
9 | ```
10 |
11 | Everything will be built just fine and you will get the `.pdf` file.
12 |
--------------------------------------------------------------------------------
/sdd/logo.pdf:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/yegor256/requs/925dd42328c55fa610d8bd3f79898887a21456a3/sdd/logo.pdf
--------------------------------------------------------------------------------
/sdd/sdd.bib:
--------------------------------------------------------------------------------
1 | % SPDX-FileCopyrightText: Copyright (c) 2009-2025, Yegor Bugayenko
2 | % SPDX-License-Identifier: MIT
3 |
4 | @techreport{mof2,
5 | Author = {Object Management Group},
6 | Institution = {Object Management Group},
7 | Month = {January},
8 | Number = {formal/06-01-01},
9 | Title = {Meta Object Facility {(MOF)} Core Specification, version 2.0},
10 | Year = {2006}}
11 |
12 | @book{shapiro94,
13 | Author = {Ehud Shapiro and Sterling, Leon},
14 | Publisher = {{The MIT Press}},
15 | Title = {The Art of {PROLOG}: Advanced Programming Techniques},
16 | Year = {1994}}
17 |
18 | @webpage{xml,
19 | Author = {Tim Bray and Jean Paoli and C. M. Sperberg-McQueen and Eve Maler and Fran{\c c}ois Yergeau},
20 | Date-Added = {2010-01-08 11:36:30 +0100},
21 | Date-Modified = {2010-07-23 18:01:48 +0200},
22 | Keywords = {XML},
23 | Month = {November},
24 | Read = {Yes},
25 | Title = {Extensible Markup Language {(XML)} 1.0 (Fifth Edition)},
26 | Url = {http://www.w3.org/TR/2008/REC-xml-20081126/},
27 | Urldate = {3/4/09},
28 | Year = {2008},
29 | Bdsk-Url-1 = {http://www.w3.org/TR/2008/REC-xml-20081126/}}
30 |
31 | @book{graham93,
32 | Author = {Paul Graham},
33 | Publisher = {{Prentice Hall}},
34 | Title = {On {LISP}: Advanced Techniques for Common {LISP}},
35 | Year = {1993}}
36 |
37 | @techreport{mof-to-xmi,
38 | Author = {OMG},
39 | Institution = {Object Management Group},
40 | Title = {{MOF} 2.0/{XMI} Mapping, Version 2.1.1},
41 | Year = {2007}}
42 |
43 | @techreport{ieee830,
44 | Author = {IEEE},
45 | Institution = {The Institute of Electrical and Electronics Engineers},
46 | Number = {IEEE Std 830-1998},
47 | Title = {Recommended Practice for Software Requirements Specifications},
48 | Year = {1998}}
49 |
--------------------------------------------------------------------------------
/sdd/sdd.pdf:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/yegor256/requs/925dd42328c55fa610d8bd3f79898887a21456a3/sdd/sdd.pdf
--------------------------------------------------------------------------------
41 | 
2 |
3 | [](https://www.elegantobjects.org)
4 | [](https://www.rultor.com/p/yegor256/requs)
5 | [](https://www.jetbrains.com/idea/)
6 |
7 | [](https://github.com/yegor256/requs/actions/workflows/mvn.yml)
8 | [](https://codecov.io/gh/yegor256/requs)
9 | [](https://www.0pdd.com/p?name=yegor256/requs)
10 | [](https://maven-badges.herokuapp.com/maven-central/org.requs/requs)
11 | [](https://hitsofcode.com/view/github/yegor256/requs)
12 |
13 | REQUS is a controlled natural language (CNL) for requirements specifications.
14 | It is explained in details in [this paper](https://www.yegor256.com/pdf/2021/requs.pdf),
15 | which was published in the
16 | [Proceedings of the 1st ACM SIGPLAN International Workshop on Beyond Code: No Code (BCNC)](https://dl.acm.org/doi/abs/10.1145/3486949.3486963).
17 | More details about REQUS syntax you can find at [www.requs.org](http://www.requs.org/).
18 |
19 | In order to use it in a Java project, just add this plugin to your `pom.xml`
20 | (get the latest version [from here](https://github.com/yegor256/requs/releases)):
21 |
22 | ```xml
23 | 
47 |
48 |