Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
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
11 changes: 5 additions & 6 deletions eo-maven-plugin/src/main/java/org/eolang/maven/LatexMojo.java
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
import java.nio.file.Path;
import org.apache.maven.plugins.annotations.LifecyclePhase;
import org.apache.maven.plugins.annotations.Mojo;
import org.eolang.maven.latex.LatexTemplate;
import org.eolang.maven.tojos.ForeignTojo;
import org.eolang.maven.util.Home;

Expand All @@ -42,10 +43,6 @@
* we need to generate summary in universe.tex file,
* which will include all generated objects. And this file
* should be a standalone compilable document.
* @todo #1206:30min Generate a standalone compilable document from
* each of the file in "latex" directory. All of this files are already
* ".tex" files. But they are contain only the EO code without LaTex
* structure.
*/
@Mojo(
name = "latex",
Expand All @@ -62,7 +59,7 @@ public final class LatexMojo extends SafeMojo {
/**
* Latex extension (.tex).
*/
public static final String EXT = ".tex";
public static final String EXT = "tex";

/**
* Truncated the last part of the filename,
Expand Down Expand Up @@ -94,7 +91,9 @@ void exec() throws IOException {
dir.resolve(LatexMojo.DIR), LatexMojo.EXT
);
new Home(dir).save(
new XMLDocument(file).nodes("/program/listing").get(0).toString(),
new LatexTemplate(
new XMLDocument(file).nodes("/program/listing").get(0).toString()
).asString(),
dir.relativize(target)
);
Logger.info(
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
/*
* The MIT License (MIT)
*
* Copyright (c) 2016-2023 Objectionary.com
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included
* in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
package org.eolang.maven.latex;

import org.cactoos.io.ResourceOf;
import org.cactoos.text.TextOf;
import org.cactoos.text.UncheckedText;

/**
* Latex template. Generates the LaTex template from the code
* in LaTex notation as a standalone compilable document.
*
* @since 0.30
* @todo #2067:30min We need to refactor LatexTemplate class.
* And to remove redundant parts in the code, like DOM variables and
* license header. E.g.: "<listing># The MIT License (MIT)...</listing>".
*/
public final class LatexTemplate {

/**
* The code.
*/
private final String code;

/**
* Ctor.
* @param code The code.
*/
public LatexTemplate(final String code) {
this.code = code;
}

/**
* Generates the template from the code from
* resources/latex-template.txt.
* @return The generated template with the code as string.
*/
public String asString() {
return String.format(
new UncheckedText(
new TextOf(
new ResourceOf("org/eolang/maven/latex/latex-template.txt")
)
).asString(),
this.code
);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
/*
* The MIT License (MIT)
*
* Copyright (c) 2016-2023 Objectionary.com
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included
* in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
/**
* LaTex.
*
* @since 0.30
*/
package org.eolang.maven.latex;
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
\documentclass{article}
\usepackage{ffcode}
\begin{document}
\begin{ffcode}
%s
\end{ffcode}
\end{document}
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
/*
* The MIT License (MIT)
*
* Copyright (c) 2016-2023 Objectionary.com
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included
* in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
package org.eolang.maven.latex;

import org.hamcrest.MatcherAssert;
import org.hamcrest.Matchers;
import org.junit.jupiter.api.Test;

/**
* Test case for {@link LatexTemplate}.
*
* @since 0.30
*/
class LatexTemplateTest {

/**
* Check the full template.
*/
@Test
void generatesFullTemplate() {
MatcherAssert.assertThat(
new LatexTemplate(
"+package f\n[args] > main\n stdout \"Hello!\""
).asString(),
Matchers.stringContainsInOrder(
"\\documentclass{article}",
"\\usepackage{ffcode}",
"\\begin{document}",
"\\begin{ffcode}",
"+package f",
"[args] > main",
" stdout \"Hello!\"",
"\\end{ffcode}",
"\\end{document}"
)
);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
/*
* The MIT License (MIT)
*
* Copyright (c) 2016-2023 Objectionary.com
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included
* in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
/**
* Test cases for {@link org.eolang.maven.latex} package.
*
* @since 0.30
*/
package org.eolang.maven.latex;