Browse code Reimplemented plugin in Java (closes #1) main
1 parent a242b4f commit a5f3a2898403dee6cd79f36792361b0a0eedc56e Nigel Stanger authored on 20 Nov 2022

Showing 12 changed files

• 01_lecture/build.gradle
• 01_lecture/build.gradle.kts
• README.md
• build.gradle
• build.gradle.kts
• buildSrc/build.gradle
• buildSrc/build.gradle.kts
• buildSrc/src/main/java/nz/stanger/lecture/Lecture.java
• buildSrc/src/main/java/nz/stanger/lecture/LectureExtension.java
• buildSrc/src/main/kotlin/lectures.gradle.kts
• settings.gradle
• settings.gradle.kts

Ignore Space Show notes View 01_lecture/build.gradle 0 → 100644

plugins { id "lecture" // for debugging task dependencies // https://plugins.gradle.org/plugin/org.barfuin.gradle.taskinfo // id "org.barfuin.gradle.taskinfo" version "2.0.0" } lecture { docTargets = [ // remove those you don't need "slides", "handout", // "notes", // "examples", ] slidesImages = [ // example: // "image1.png", // "image2.pdf", // "image3.pdf", ] generatedImages = [ // key = destination, value = source // example: // "image2.pdf": "image2.svg", // "image3.pdf": "image3.R", ]

Show notes View 01_lecture/build.gradle.kts 100644 → 0
val docTargets by extra(mutableSetOf<String>( // remove those you don't need "slides", "handout" )) val slidesImages by extra(mutableSetOf<String>( // example: // "image1.png", // "image2.pdf", // "image3.pdf" )) val generatedImages by extra(mutableMapOf<String, String>( // key = destination, value = source // example: // "image2.pdf" to "image2.svg", // "image3.pdf" to "image3.R" ))

Ignore Space Show notes View README.md

# Gradle build infrastructure for lectures Gradle infrastructure to build Information Science lectures based on Nigel’s LaTeX lecture classes. Features: * multiple configurable document targets: slides, handout, notes, examples * dynamic targets for building PDF images from PlantUML, SVG, R * builds separate working preview and final published PDFs with lecture numbers (the latter include the lecture number in the file name) * uses XeLaTeX via `latexmk` This repository serves as both the canonical source for the Gradle files and as an example of how to set things up. ## Setting up a new set of lectures 1. Clone this repo somewhere. 2. Create a top level `lectures` directory. 3. If you’re using Git, copy `.gitignore` into `lectures`. 4. Copy `build.gradle`, `settings.gradle`, and `buildSrc` into `lectures`. 5. Copy `01_lecture` to `lectures` and rename it to something that makes sense. **The prefix numbering is important.** Gradle uses it to figure out the lecture number (but you can override this manually per lecture). You can duplicate and rename this folder for each new lecture you need (e.g., `01_foo`, `02_bar`, …). 6. Edit `lectures/settings.gradle` and make sure there is an `include` line for each individual lecture. Remember to update if you change things later, otherwise things will probably not build. 7. Edit each lecture’s `build.gradle` to configure targets and images. The individual lecture folders must **not** have a `settings.gradle` file, **it will break things.** 8. Add the various content files as outlined below. ### Typical lecture directory tree The way Nigel does things 😁. ```sh lectures 01_foo/ build.gradle doc_init.tex images/ ... lecture_content.tex lecture_handout.tex lecture_slides.tex lecturedates.tex -> ../lecturedates.tex paper_init.tex -> ../paper_init.tex pdfs/ lecture_01_handout.pdf lecture_01_slides.pdf 02_bar/ ... 03_baz etc... .gitignore build.gradle lecturedates.tex paper_init_tex settings.gradle ``` ## Typical gradle tasks As applicable depending on which document targets are enabled. This list is not comprehensive, run `gradle tasks --all` for a complete list. ### Build tasks * **docs** - Build all documents. [preview] * **examples** - Build examples document. [preview] * **examples.numbered** - Build numbered version of examples document. [final] * **handout** - Build handout document. [preview] * **handout.numbered** - Build numbered version of handout document. [final] * **images** - Generate all images from their sources (e.g., PlantUML). * **notes** - Build notes document. [preview] * **notes.numbered** - Build numbered version of notes document. [final] * **numbered** - Create numbered versions of all documents. [final] * **slides** - Build slides document. [preview] * **slides.numbered** - Build numbered version of slides document. [final] A dynamic task is created for each generated image, e.g.: * **images.image1.pdf** - Generate `image1.pdf` from `image1.whatever`. ### Housekeeping tasks * **debug** - Print debugging information. * **clean** - Clean up intermediate files. * **deepClean** - Remove all files not in Git. [`git clean -fXd`] # Gradle build infrastructure for lectures Gradle infrastructure to build Information Science lectures based on Nigel’s LaTeX lecture classes. Features: * multiple configurable document targets: slides, handout, notes, examples * dynamic targets for building PDF images from PlantUML, SVG, R * builds separate working preview and final published PDFs with lecture numbers (the latter include the lecture number in the file name) * uses XeLaTeX via `latexmk` This repository serves as both the canonical source for the Gradle files and as an example of how to set things up. ## Setting up a new set of lectures 1. Create a top level `lectures` directory. 1. If you’re using Git, copy `.gitignore` into `lectures`. 1. Create a sub-directory for each lecture, e.g., `01_foo`, `02_bar`, …. **The prefix numbering is important.** Gradle uses it to figure out the lecture number. 1. Copy `build.gradle.kts` and `settings.gradle.kts` into `lectures`. 1. Copy `lecture.build.gradle.kts` into `01_foo`, `02_bar`, etc., and rename it to `build.gradle.kts` 1. Edit each lecture’s `build.gradle.kts` to configure targets and images. 1. Add the various content files as outlined below. ### Typical lecture directory tree The way Nigel does things 😁. ```sh lectures 01_foo/ build.gradle.kts doc_init.tex images/ ... lecture_content.tex lecture_handout.tex lecture_slides.tex lecturedates.tex -> ../lecturedates.tex paper_init.tex -> ../paper_init.tex pdfs/ lecture_01_handout.pdf lecture_01_slides.pdf 02_bar/ ... 03_baz etc... .gitignore build.gradle.kts lecturedates.tex paper_init_tex settings.gradle.kts ``` ## Typical gradle tasks As applicable depending on which document targets are enabled. This list is not comprehensive, see `gradle tasks --all` for a complete list. ### Build tasks * **docs** - Build all documents. [preview] * **examples** - Build examples document. [preview] * **examples.numbered** - Build numbered version of examples document. * **handout** - Build handout document. [preview] * **handout.numbered** - Build numbered version of handout document. * **images** - Generate images. * **notes** - Build notes document. [preview] * **notes.numbered** - Build numbered version of notes document. * **numbered** - Create numbered versions of all documents. * **slides** - Build slides document. [preview] * **slides.numbered** - Build numbered version of slides document. A dynamic task is created for each generated image, e.g.: * **images.image1.pdf** - Generate image1.pdf from image1.svg. ### Housekeeping tasks * **debug** - Print debugging information. * **clean** - Clean up intermediate files. * **deepClean** - Remove all files not in Git. [`git clean -fXd`]

Ignore Space Show notes View build.gradle 0 → 100644
plugins { id "lecture" apply false } defaultTasks "docs", "numbered"

Show notes View build.gradle.kts 100644 → 0
plugins { id("lectures") apply false } subprojects { apply(plugin = "lectures") } tasks.register("slides") { subprojects.forEach { dependsOn("${it.name}:slides") } } tasks.register("handout") { subprojects.forEach { dependsOn("${it.name}:handout") } } tasks.register("notes") { subprojects.forEach { dependsOn("${it.name}:notes") } }

Ignore Space Show notes View buildSrc/build.gradle 0 → 100644

plugins { id "java-gradle-plugin" } repositories { mavenCentral() } dependencies { // https://mvnrepository.com/artifact/org.danilopianini/gradle-latex implementation "org.danilopianini:gradle-latex:0.2.7" // as of 2021-12-02 } gradlePlugin { plugins { lecture { id = "lecture" implementationClass = "nz.stanger.lecture.Lecture" } } } // compileJava { // options.compilerArgs << '-Xlint:unchecked' // }

Show notes View buildSrc/build.gradle.kts 100644 → 0
plugins { `kotlin-dsl` } repositories { gradlePluginPortal() } dependencies { // https://plugins.gradle.org/plugin/org.danilopianini.gradle-latex implementation("org.danilopianini:gradle-latex:0.2.7") // as of 2021-12-02 }

Ignore Space Show notes View buildSrc/src/main/java/nz/stanger/lecture/Lecture.java 0 → 100644

package nz.stanger.lecture; import java.io.File; import java.util.ArrayList; import java.util.Arrays; import java.util.Collection; import java.util.List; import java.util.HashMap; import java.util.HashSet; import java.util.Map; import java.util.Set; import java.util.stream.Collectors; import org.danilopianini.gradle.latex.LatexExtension; import org.gradle.api.Plugin; import org.gradle.api.Project; import org.gradle.api.file.ConfigurableFileTree; import org.gradle.api.file.Directory; import org.gradle.api.provider.Provider; import org.gradle.api.provider.SetProperty; import org.gradle.api.tasks.Copy; import org.gradle.api.tasks.Delete; import org.gradle.api.tasks.Exec; import org.gradle.api.tasks.TaskContainer; public class Lecture implements Plugin<Project> { private static final String CONTENT = "content"; private static final String SLIDES = "slides"; private static final String HANDOUT = "handout"; private static final String NOTES = "notes"; private static final String EXAMPLES = "examples"; private static final String LECTURE_PREFIX = "lecture"; private static final String TASK_GROUP = "Lecture"; private static final Set<String> VALID_TARGET_NAMES = Set.of( SLIDES, HANDOUT, NOTES, EXAMPLES ); // Some handy references that are used a lot. private TaskContainer projectTasks; private Directory projectDirectory; private LectureExtension lecture; private LatexExtension latex; /** * Find directories whose names match a regular expression. * * Adapted from https://gist.github.com/Ethsaam/2b8dd748fcc25e6973bb. * * @param dir the directory to start the search in * @param pattern regular expression matching directory names * @return the collection of matching directories */ private Collection<File> getListOfDirectories(Directory dir, String pattern) { return new ArrayList<>(Arrays.asList(dir.getAsFile().listFiles(file -> file.isDirectory() && file.getName().matches(pattern)))); } /** * Register a task to generate an image from some other format. * * @param srcRegex regular expression matching source files (inputs) * @param dstRegex regular expression matching destination files (outputs) * @param cmdTemplate list of command line components (strings) */ private void registerGeneratedImageTask(String srcRegex, String dstRegex, List<String> cmdTemplate) { lecture.getGeneratedImages().get().entrySet().stream() .filter(entry -> entry.getValue().matches(srcRegex)) .filter(entry -> entry.getKey().matches(dstRegex)) .forEach(entry -> { File dst = lecture.getImageDir().file(entry.getKey()).get().getAsFile(); File src = lecture.getImageDir().file(entry.getValue()).get().getAsFile(); projectTasks.register("images." + entry.getKey(), Exec.class, task -> { task.setDescription("Generate " + entry.getKey() + " from " + entry.getValue() + "."); task.setGroup(TASK_GROUP); File cropped = lecture.getImageDir().file(entry.getKey().replace(".pdf", "-crop.pdf")).get().getAsFile(); // set working directory to imageDir so that relative // references work, e.g., PlantUML includes task.setWorkingDir(lecture.getImageDir().get()); task.getInputs().files(src); task.getOutputs().files(dst); List<String> command = cmdTemplate.stream().map( part -> part.replaceAll("<<src>>", src.getName()) .replaceAll("<<dst>>", dst.getName()) .replaceAll("<<cropped>>", cropped.getName()) ).collect(Collectors.toList()); task.commandLine(command); }); // Every PDF generation will have a different hash, so only run the // task if the input is newer than the output. projectTasks.getByPath("images." + entry.getKey()).onlyIf(t -> { return src.lastModified() > dst.lastModified(); }); }); } @Override public void apply(Project project) { projectTasks = project.getTasks(); projectDirectory = project.getLayout().getProjectDirectory(); project.getPluginManager().apply("org.danilopianini.gradle-latex"); // Plugin extensions. lecture = project.getExtensions().create("lecture", LectureExtension.class); latex = project.getExtensions().getByType(LatexExtension.class); // Configure LaTeX extension. latex.getPdfLatexCommand().set("xelatex"); /** * Set plugin defaults. */ // Supported document targets. lecture.getDocTargets().convention(VALID_TARGET_NAMES); // Validate document target configuration. Must be afterEvaluate() to // ensure everything has been finalised. project.afterEvaluate(p -> { lecture.getDocTargets().get().stream().forEach(target -> { if (!VALID_TARGET_NAMES.contains(target)) { throw new RuntimeException("unsupported target name " + target); } }); }); // Supported targets (numbered documents). Automatically derived from // LectureExtension.docTargets. Provider<Set<String>> numberedDocTargets = lecture.getDocTargets().map( docTargets -> docTargets.stream().map(target -> target + ".numbered").collect(Collectors.toSet()) ); // Standard lecture prefix string. lecture.getDocPrefix().convention(LECTURE_PREFIX); lecture.getLectureNum().convention(project.getName().substring(0, 2)); // Standard document names (unnumbered). Automatically derived from // LectureExtension.docTargets, plus "content". Provider<Map<String, String>> docNames = lecture.getDocTargets().map(docTargets -> { Map<String, String> names = new HashMap<>(); docTargets.forEach(target -> names.put(target, lecture.getDocPrefix().get() + "_" + target)); names.put(CONTENT, lecture.getDocPrefix().get() + "_" + CONTENT); return names; }); // Standard document names (numbered). Automatically derived from // LectureExtension.docTargets, plus "content". Provider<Map<String, String>> numberedDocNames = lecture.getDocTargets().map(docTargets -> { Map<String, String> names = new HashMap<>(); docTargets.forEach(target -> names.put(target, lecture.getDocPrefix().get() + "_" + lecture.getLectureNum().get() + "_" + target)); names.put(CONTENT, lecture.getDocPrefix().get() + "_" + lecture.getLectureNum().get() + "_" + CONTENT); return names; }); lecture.getImageDir().convention(projectDirectory.dir("images")); lecture.getPdfDir().convention(projectDirectory.dir("pdfs")); // slidesImages defaults to empty lecture.getSlidesFiles().convention( lecture.getDocPrefix().map( (String prefix) -> Set.of( prefix + "_" + CONTENT + ".tex", "paper_init.tex", "lecturedates.tex", "doc_init.tex" ) ) ); // examplesImages defaults to empty lecture.getExamplesFiles().convention( lecture.getDocPrefix().map((String prefix) -> { if (lecture.getDocTargets().get().contains(EXAMPLES)) { return Set.of( prefix + "_" + EXAMPLES + ".tex", "paper_init.tex", "lecturedates.tex", "doc_init.tex" ); } else { return Set.of(); } }) ); // Document dependencies. Automatically derived from slidesImages, // slidesFiles, examplesImages, and examplesFiles. Images are mapped to // imageDir. The slides, handout, and notes will always share the same // dependencies. Only the examples will be different. Provider<Set<String>> slideDependencies = lecture.getSlidesImages().map(slideImages -> { Set<String> slideDeps = new HashSet<>(); slideDeps.addAll(slideImages.stream().map(image -> lecture.getImageDir().get() + "/" + image).collect(Collectors.toSet())); slideDeps.addAll(lecture.getSlidesFiles().get()); return slideDeps; }); Provider<Map<String, List<String>>> docDependencies = lecture.getDocTargets().map(docTargets -> { Map<String, List<String>> docDeps = new HashMap<>(); docTargets.forEach(target -> { if (target.equals("examples")) { List<String> deps = lecture.getExamplesFiles().get().stream().collect(Collectors.toList()); deps.addAll(lecture.getExamplesImages().get().stream() .map(image -> lecture.getImageDir().get() + "/" + image) .collect(Collectors.toList()) ); docDeps.put(target, deps); } else { docDeps.put(target, slideDependencies.get().stream().collect(Collectors.toList())); } }); return docDeps; }); // generatedImages defaults to empty lecture.getCleanFiles().convention(Set.of( "*.aux", "*.dvi", "*.fdb_latexmk", "*.fls", "*.head", "*.listing", "*.log", "*.nav", "*.out", "*.pyg", "*.snm", "*.synctex.gz", "*.tmp", "*.toc", "*.vrb", "*.xdv" )); // These are regular expressions, NOT glob patterns. lecture.getCleanDirs().convention(Set.of( "_minted.*" )); lecture.getLatexFlags().convention(Set.of( "-shell-escape", "-synctex=1", "-interaction=nonstopmode", "-halt-on-error", "-file-line-error" )); /** * Tasks. * * It doesn't always seem to be strictly necessary, but it seems safer * in general to assume that all tasks need to be afterEvaluate(). It's * certainly necessary for generated tasks that derive from * configuration variables. */ project.afterEvaluate(p -> { project.setDefaultTasks(Arrays.asList("docs", "numbered")); // All unnumbered documents. projectTasks.register("docs", task -> { task.setDescription("Build all documents."); task.setGroup(TASK_GROUP); task.dependsOn(lecture.getDocTargets()); }); // Generate tasks for each of the unnumbered document targets. // All generated tasks that derive from configuration variables must be // afterEvaluate() to ensure everything has been finalised. lecture.getDocTargets().get().forEach(target -> { projectTasks.register(target, task -> { task.setDescription("Build " + target + " document."); task.setGroup(TASK_GROUP); task.dependsOn("pdfLatex." + docNames.get().get(target)); }); }); // All numbered documents. projectTasks.register("numbered", task -> { task.setDescription("Create numbered versions of all documents."); task.setGroup(TASK_GROUP); task.dependsOn(numberedDocTargets); }); // Generate tasks for each of the numbered document targets. numberedDocTargets.get().forEach(target -> { projectTasks.register(target, Copy.class, task -> { String baseTarget = target.replace(".numbered", ""); task.setDescription("Build numbered version of " + baseTarget + " document."); task.setGroup(TASK_GROUP); task.from(project.getTasksByName("pdfLatex." + docNames.get().get(baseTarget), true)); task.into(lecture.getPdfDir()); // The LaTeX tasks include the .aux file in their outputs. // Exclude or they will also be copied into the PDFs directory. task.exclude("*.aux"); task.rename(src -> src.replace("_", "_" + lecture.getLectureNum().get() + "_")); }); }); // Generate LaTeX build tasks for each of the targets. This uses the // string invocation method supplied by the LaTeX plugin. lecture.getDocTargets().get().forEach(target -> { latex.invoke(docNames.get().get(target), (dsl) -> { dsl.setExtraArguments(lecture.getLatexFlags().get()); dsl.setWatching(docDependencies.get().get(target)); return null; // workaround for Kotlin Unit (void) return }); }); // Add image task dependencies to the generated LaTeX tasks. // No need to check whether there are any generated images, Gradle does // the right thing if the list is empty. This also makes *all* LaTeX // documents dependent on *all* generated images, even when a document // doesn't actually depend on a specific image. This would be too much // of a hassle to fix given the relatively small benefit. projectTasks.matching(task -> task.getName().startsWith("pdfLatex")).forEach(pdfLatexTask -> { pdfLatexTask.dependsOn(projectTasks.matching(t -> t.getName().startsWith("images."))); }); // All generated images. projectTasks.register("images", task -> { task.setDescription("Generate images."); task.setGroup(TASK_GROUP); task.setDependsOn(projectTasks.matching(t -> t.getName().startsWith("images."))); }); // Remove files specified in cleanFiles and directories specified // in cleanDirs. //!! Does this need afterEvaluate()? projectTasks.register("clean", Delete.class, task -> { task.setDescription("Clean up intermediate files."); task.setGroup(TASK_GROUP); ConfigurableFileTree tree = project.fileTree(projectDirectory); tree.include(lecture.getCleanFiles().get()); task.delete(tree); lecture.getCleanDirs().get().forEach( pattern -> task.delete(getListOfDirectories(projectDirectory, pattern)) ); }); // Remove everything not under version control. Unfortunately this *doesn't* // include the .gradle directory :(, but in hindsight that's not surprising. projectTasks.register("deepClean", Exec.class, task -> { task.setDescription("Remove all files not in Git."); task.setGroup(TASK_GROUP); task.setCommandLine("git", "clean", "-fXd"); }); /** * Per-file tasks to convert images. * * By default these assume single-file inputs, e.g., foo.svg -> * foo.pdf. If you have a file that is dependent on multiple inputs * (e.g., bar.pu -> foo.pu -> foo.pdf), register an independent task * in the lecture's build.gradle.kts by copying the corresponding * registration code below, substituting the actual filenames in * place of the variable references like key and * generatedImages[key]. Also remove the file from generatedImages * to avoid a name clash. You can access properties like imageDir * via project.properties (these will probably need explicit type * casting). */ // Generate per-file tasks to convert PlantUML to PDF. registerGeneratedImageTask( ".*\\.(pu|puml|plantuml)$", ".*\\.pdf$", // Direct PDF from PlantUML is problematic, go via SVG instead. new ArrayList<>(Arrays.asList( "bash", "-c", "plantuml -tsvg -pipe < <<src>> | rsvg-convert --format pdf > <<dst>> && pdfcrop <<dst>> <<cropped>> && mv -f <<cropped>> <<dst>>" )) ); // Generate per-file tasks to convert SVG to PDF. registerGeneratedImageTask( ".*\\.svg$", ".*\\.pdf$", new ArrayList<>(Arrays.asList( "bash", "-c", "rsvg-convert --format pdf <<src>> > <<dst>> && pdfcrop <<dst>> <<cropped>> && mv -f <<cropped>> <<dst>>" )) ); // Generate per-file tasks to convert R to PDF. registerGeneratedImageTask( ".*\\.R$", ".*\\.pdf$", new ArrayList<>(Arrays.asList( "bash", "-c", "R --no-echo --file=<<src>> --args <<dst>> && pdfcrop <<dst>> <<cropped>> && mv -f <<cropped>> <<dst>>" )) ); }); // Debugging information. projectTasks.register("debug", task -> { task.setDescription("Print debugging information."); task.setGroup(TASK_GROUP); task.doLast(s -> { System.out.println("project name = <" + project.getName() + ">"); System.out.println("project directory = <" + projectDirectory + ">"); System.out.println("docTargets = <" + lecture.getDocTargets().get().toString() + ">"); System.out.println("numberedDocTargets = <" + numberedDocTargets.get().toString() + ">"); System.out.println("docPrefix = <" + lecture.getDocPrefix().get() + ">"); System.out.println("lectureNum = <" + lecture.getLectureNum().get() + ">"); System.out.println("docNames = <" + docNames.get().toString() + ">"); System.out.println("numberedDocNames = <" + numberedDocNames.get().toString() + ">"); System.out.println("imageDir = <" + lecture.getImageDir().get().getAsFile().getName() + ">"); System.out.println("pdfDir = <" + lecture.getPdfDir().get().getAsFile().getName() + ">"); System.out.println("slidesImages = <" + lecture.getSlidesImages().get().toString() + ">"); System.out.println("slidesFiles = <" + lecture.getSlidesFiles().get().toString() + ">"); System.out.println("examplesImages = <" + lecture.getExamplesImages().get().toString() + ">"); System.out.println("examplesFiles = <" + lecture.getExamplesFiles().get().toString() + ">"); System.out.println("slideDependencies = <" + slideDependencies.get().toString() + ">"); System.out.println("docDependencies = <" + docDependencies.get().toString() + ">"); System.out.println("generatedImages = <" + lecture.getGeneratedImages().get().toString() + ">"); System.out.println("cleanFiles = <" + lecture.getCleanFiles().get().toString() + ">"); System.out.println("cleanDirs = <" + lecture.getCleanDirs().get().toString() + ">"); System.out.println("latexFlags = <" + lecture.getLatexFlags().get().toString() + ">"); System.out.println("latex.terminalEmulator = <" + latex.getTerminalEmulator().get() + ">"); System.out.println("latex.waitTime = <" + latex.getWaitTime().get() + ">"); System.out.println("latex.waitUnit = <" + latex.getWaitUnit().get() + ">"); System.out.println("latex.pdfLatexCommand = <" + latex.getPdfLatexCommand().get() + ">"); System.out.println("latex.bibTexCommand = <" + latex.getBibTexCommand().get() + ">"); System.out.println("latex.inkscapeCommand = <" + latex.getInkscapeCommand().get() + ">"); System.out.println("latex.gitLatexdiffCommand = <" + latex.getGitLatexdiffCommand().get() + ">"); }); }); } }

Ignore Space Show notes View buildSrc/src/main/java/nz/stanger/lecture/LectureExtension.java 0 → 100644

package nz.stanger.lecture; import org.gradle.api.provider.Property; import org.gradle.api.provider.MapProperty; import org.gradle.api.provider.SetProperty; import org.gradle.api.file.DirectoryProperty; abstract public class LectureExtension { /** * Supported targets (unnumbered documents). * * These are configurable, but only within a list of valid target names * i.e., you can disable supported targets but not create new ones. * * Remove any targets that don't exist for this lecture. New targets must be * registered in the lecture's build.gradle.kts. The target list for * numbered documents is automatically derived from this (see Lecture.java). * * @return the configured set of targets */ abstract public SetProperty<String> getDocTargets(); /** * Standard prefix for lecture documents. * * Document files are named as "prefix_type.tex", e.g., * "lecture_slides.tex". * * @return the configured lecture document prefix */ abstract public Property<String> getDocPrefix(); /** * Lecture number. * * Default is to derive from the project name (assumes the project folder is * named something like "01_Lecture_Title"). This is inserted into the file * names of numbered outputs (e.g., "lecture_01_slides.pdf". * * @return the configured lecture number (0 prefixed if necessary) */ abstract public Property<String> getLectureNum(); /** * Subdirectory in which images are kept. * * @return the configured images directory */ abstract public DirectoryProperty getImageDir(); /** * Subdirectory to which numbered PDFs will be written. * * Originally these were written into the project directory, but it seemed * to completely confuse Gradle into thinking that all the input files in * the project had been touched and it yelled about implicit task * dependencies. See * https://docs.gradle.org/7.3.1/userguide/validation_problems.html#implicit_dependency. * * @return the configured PDFs directory */ abstract public DirectoryProperty getPdfDir(); /** * Images used by the slides, handout, and notes documents. * * These will become dependencies of the document. Images will be * automatically mapped to imageDir (above). * * @return the configured set of images */ abstract public SetProperty<String> getSlidesImages(); /** * Files used by the slides, handout, and notes documents. * * These will become dependencies of the document. * * @return the configured set of files */ abstract public SetProperty<String> getSlidesFiles(); /** * Images used by the examples document. * * These will become dependencies of the document. Images will be * automatically mapped to imageDir (above). * * @return the configured set of images */ abstract public SetProperty<String> getExamplesImages(); /** * Images and files used by the examples document. * * These will become dependencies of the document. * * @return the configured set of files */ abstract public SetProperty<String> getExamplesFiles(); /** * Images that are generated from another format. * * The key is the target image, the value is the source image. This is * independent of the slidesImages and examplesImages (above). All images * will be mapped to imageDir (above). * * @return MapProperty<String> */ abstract public MapProperty<String, String> getGeneratedImages(); /** * Files to be removed by the clean task. * * @return the configured set of files to remove */ abstract public SetProperty<String> getCleanFiles(); /** * Directories to be removed by the clean task. * * Directories are separate because FileTree only stores files :(. * * @return the configured set of directories to remove */ abstract public SetProperty<String> getCleanDirs(); /** * Command line options for LaTeX. * * This is a set, so duplicates will be automatically eliminated. * * @return the configured LaTeX command line options */ abstract public SetProperty<String> getLatexFlags(); }

Show notes View buildSrc/src/main/kotlin/lectures.gradle.kts 100644 → 0

/*********************************************************************** * CONFIGURABLE SETTINGS * * Override the following values in each lecture's build.gradle.kts. * In most cases simply adding a modified copy of the original line * should do what you need. Most collections are sets to avoid accidental * duplication. You can append to an existing set value by doing something * like this (e.g.): * * extra["latexFlags"] = (extra["latexFlags"] as Set<String>) + "--barf" ***********************************************************************/ /*********************************************************************** * Supported targets (unnumbered documents). * Remove any targets that don't exist for this lecture. * New targets must be registered in the lecture's build.gradle.kts. * The target list for numbered documents is automatically derived from * this (see below). */ val docTargets by extra(mutableSetOf<String>( "slides", "handout", "notes", "examples" )) /*********************************************************************** * Command line options for LaTeX. This is a set, so duplicates will be * automatically eliminated. */ val latexFlags by extra(mutableSetOf<String>( "-shell-escape", "-synctex=1", "-interaction=nonstopmode", "-halt-on-error", "-file-line-error" )) /*********************************************************************** * Standard document names (unnumbered). The keys are mostly the Gradle * target names in docTargets, plus "content". */ val docNames by extra(mutableMapOf<String, String>( "content" to "lecture_content", "slides" to "lecture_slides", "handout" to "lecture_handout", "notes" to "lecture_notes", "examples" to "lecture_examples" )) /*********************************************************************** * Lecture number, derived from the project name (assumes the project * folder is named something like "01_Lecture_Title"). */ val lectureNum by extra(project.name.substring(0, 2)) /*********************************************************************** * Name of subdirectory in which images are kept. */ val imageDir by extra(layout.projectDirectory.dir("images")) /*********************************************************************** * Name of subdirectory to which numbered PDFs will be written. Originally * These were written into the project directory, but it seemed to completely * confuse Gradle into thinking that all the input files in the project * has been touched and it yelled about implicit task dependencies. See * <https://docs.gradle.org/7.3.1/userguide/validation_problems.html#implicit_dependency>. */ val pdfDir by extra(layout.projectDirectory.dir("pdfs")) /*********************************************************************** * Images and files used by the slides, handout, and notes documents. * Images will be automatically mapped to imageDir (above). */ val slidesImages by extra(mutableSetOf<String>()) val slidesFiles by extra(mutableSetOf<String>( "${docNames["content"]}.tex", "paper_init.tex", "lecturedates.tex", "doc_init.tex" )) /*********************************************************************** * Images and files used by the examples document. * Images will be automatically mapped to imageDir (above). */ val examplesImages by extra(mutableSetOf<String>()) val examplesFiles by extra(mutableSetOf<String>( "${docNames["examples"]}.tex", "paper_init.tex", "lecturedates.tex", "doc_init.tex" )) /*********************************************************************** * Images that are generated from another format. * Key is the target image, value is the source image. * All images will be mapped to imageDir (above). */ val generatedImages by extra(mutableMapOf<String, String>()) /*********************************************************************** * Files and directories to be removed by the clean task. * Directories are separate because FileTree only stores files :(. */ val cleanFiles by extra(mutableSetOf<String>( "*.aux", "*.dvi", "*.fdb_latexmk", "*.fls", "*.head", "*.listing", "*.log", "*.nav", "*.out", "*.pyg", "*.snm", "*.synctex.gz", "*.tmp", "*.toc", "*.vrb", "*.xdv" )) // These are regular expressions, NOT glob patterns. val cleanDirs by extra(mutableSetOf<String>( """_minted.*""", )) /*********************************************************************** * END OF CONFIGURABLE SETTINGS ***********************************************************************/ /*********************************************************************** * Supported targets (numbered documents). * Automatically derived from docTargets. */ val numberedTargets by extra(docTargets.map { it + ".numbered" }) /*********************************************************************** * Standard document names (unnumbered). * Automatically derived from docNames. */ val numberedNames by extra(docNames.mapValues { pair -> pair.value.replace("_", "_${lectureNum}_") }) /*********************************************************************** * Document dependencies. * Automatically derived from slidesImages, slidesFiles, examplesImages, * and examplesFiles. Images are mapped to imageDir. * The slides, handout, and notes will always share the same dependencies. * Only the examples will be different. */ val slideDependencies by extra(slidesImages.map { "${imageDir}/${it}" } + slidesFiles) val docDependencies by extra(mapOf<String, List<String>>( "slides" to slideDependencies, "handout" to slideDependencies, "notes" to slideDependencies, "examples" to examplesImages.map { "${imageDir}/${it}" } + examplesFiles )) /*********************************************************************** * LaTeX plugin configuration. */ plugins { id("org.danilopianini.gradle-latex") // for debugging task dependencies // https://plugins.gradle.org/plugin/org.barfuin.gradle.taskinfo // id("org.barfuin.gradle.taskinfo") version "1.3.1" } latex { pdfLatexCommand.set("xelatex") // Generate LaTeX build tasks for each of the targets. docTargets.forEach { target -> "${docNames[target]}" { extraArguments = latexFlags watching = docDependencies[target] as List<String> } } } // Add image task dependencies to the generated LaTeX tasks. // No need to check whether there are any generated images, Gradle does // the right thing if the list is empty. tasks.matching { it.name.startsWith("pdfLatex") }.forEach { it.dependsOn(tasks.matching { task -> task.name.startsWith("images.") }) } /*********************************************************************** * Tasks. */ defaultTasks("docs", "numbered") // All unnumbered documents. tasks.register("docs") { dependsOn(docTargets) description = "Build all documents." } // Generate tasks for each of the unnumbered document targets. (docTargets as Set<String>).forEach { target -> tasks.register(target) { dependsOn("pdfLatex.${docNames[target]}") description = "Build ${target} document." } } // All numbered documents. tasks.register("numbered") { dependsOn(numberedTargets) description = "Create numbered versions of all documents." } /* Generate tasks for each of the numbered document targets. * Slight oddity: numberedTargets is a List not a Set because it's * generated by a map() call. It's not normally configurable, so OK. */ numberedTargets.forEach { target -> tasks.register<Copy>(target) { val plainTarget = target.replace(".numbered", "") from(tasks.getByName("pdfLatex.${docNames[plainTarget]}")) into(pdfDir) // The LaTeX tasks include the .aux file in their outputs. // Exclude or they will also be copied into the PDFs directory. exclude("*.aux") rename { src -> src.replace("_", "_${lectureNum}_") } description = "Build numbered version of ${plainTarget} document." } } // All generated images. tasks.register("images") { dependsOn(tasks.matching { it.name.startsWith("images.") }) description = "Generate images." } // Find folders matching regular expression. // Adapted from <https://gist.github.com/Ethsaam/2b8dd748fcc25e6973bb>. fun getListOfFolders(dir: Directory, pattern: String): Collection<File> { return dir.getAsFile().listFiles({ file -> file.isDirectory() && file.name.matches(Regex(pattern)) }).toList() } // Remove files specified in cleanFiles and directories specified // in cleanDirs. tasks.register<Delete>("clean") { description = "Clean up intermediate files." delete(fileTree(layout.projectDirectory) { include(cleanFiles) }) cleanDirs.forEach { pattern -> delete(getListOfFolders(layout.projectDirectory, pattern)) } } // Remove everything not under version control. Unfortunately this *doesn't* // include the .gradle directory :(, but in hindsight that's not surprising. tasks.register<Exec>("deepClean") { description = "Remove all files not in Git." commandLine("git", "clean", "-fXd") } /*********************************************************************** * Per-file tasks to convert images. * By default these assume single-file inputs, e.g., foo.svg -> foo.pdf. * If you have a file that is dependent on multiple inputs (e.g., * bar.pu -> foo.pu -> foo.pdf), register an independent task in the * lecture's build.gradle.kts by copying the corresponding registration * code below, substituting the actual filenames in place of the variable * references like key and generatedImages[key]. Also remove the file * from generatedImages to avoid a name clash. You can access properties * like imageDir via project.properties (these will probably need explicit * type casting). */ // Generate per-file tasks to convert PlantUML to PDF. generatedImages.filterValues { it.matches(Regex(""".*\.(pu|puml|plantuml)$""")) }.filterKeys { it.matches(Regex(""".*\.pdf$""")) }.keys .forEach { key -> val dst = imageDir.file(key) val src = imageDir.file(generatedImages[key].toString()) tasks.register<Exec>("images.${key}") { val cropped = imageDir.file(key.replace(".pdf", "-crop.pdf")) // set working directory to imageDir so that relative includes work workingDir(imageDir) inputs.files(src) outputs.files(dst) // Direct PDF from PlantUML is problematic, go via SVG instead. commandLine( "bash", "-c", "plantuml -tsvg -pipe < ${src} | rsvg-convert --format pdf > ${dst} && pdfcrop ${dst} ${cropped} && mv -f ${cropped} ${dst}" ) description = "Generate ${key} from ${generatedImages[key]}." } // Every PDF generation will have a different hash, so only run the // task if the input is newer than the output. tasks.getByPath("images.${key}").onlyIf { src.getAsFile().lastModified() > dst.getAsFile().lastModified() } } // Generate per-file tasks to convert SVG to PDF. generatedImages.filterValues { it.matches(Regex(""".*\.svg$""")) }.filterKeys { it.matches(Regex(""".*\.pdf$""")) }.keys .forEach { key -> val dst = imageDir.file(key) val src = imageDir.file(generatedImages[key].toString()) tasks.register<Exec>("images.${key}") { val cropped = imageDir.file(key.replace(".pdf", "-crop.pdf")) inputs.files(src) outputs.files(dst) commandLine( "bash", "-c", "rsvg-convert --format pdf ${src} > ${dst} && pdfcrop ${dst} ${cropped} && mv -f ${cropped} ${dst}" ) description = "Generate ${key} from ${generatedImages[key]}." } // Every PDF generation will have a different hash, so only run the // task if the input is newer than the output. tasks.getByPath("images.${key}").onlyIf { src.getAsFile().lastModified() > dst.getAsFile().lastModified() } } // Generate per-file tasks to convert R to PDF. generatedImages.filterValues { it.matches(Regex(""".*\.R$""")) }.filterKeys { it.matches(Regex(""".*\.pdf$""")) }.keys .forEach { key -> val dst = imageDir.file(key) val src = imageDir.file(generatedImages[key].toString()) tasks.register<Exec>("images.${key}") { val cropped = imageDir.file(key.replace(".pdf", "-crop.pdf")) inputs.files(src) outputs.files(dst) commandLine( "bash", "-c", "R --no-echo --file=${src} --args ${dst} && pdfcrop ${dst} ${cropped} && mv -f ${cropped} ${dst}" ) description = "Generate ${key} from ${generatedImages[key]}." } // Every PDF generation will have a different hash, so only run the // task if the input is newer than the output. tasks.getByPath("images.${key}").onlyIf { src.getAsFile().lastModified() > dst.getAsFile().lastModified() } } // Debugging information. tasks.register("debug") { description = "Print debugging information." doLast { println("project name = <${project.name}>") println("project directory = <${layout.projectDirectory}>") // println("project.properties = <${project.properties}>") println("docTargets = <${docTargets}>") println("numberedTargets = <${numberedTargets}>") println("lectureNum = <${lectureNum}>") println("imageDir = <${imageDir}>") println("docNames = <${docNames}>") println("numberedNames = <${numberedNames}>") println("slidesImages = <${slidesImages}>") println("slidesFiles = <${slidesFiles}>") println("examplesImages = <${examplesImages}>") println("examplesFiles = <${examplesFiles}>") println("docDependencies = <${docDependencies}>") println("generatedImages = <${generatedImages}>") println("latexFlags = <${latexFlags}>") println("latex.terminalEmulator = <${project.latex.terminalEmulator.get()}>") println("latex.waitTime = <${project.latex.waitTime.get()}>") println("latex.waitUnit = <${project.latex.waitUnit.get()}>") println("latex.pdfLatexCommand = <${project.latex.pdfLatexCommand.get()}>") println("latex.bibTexCommand = <${project.latex.bibTexCommand.get()}>") println("latex.inkscapeCommand = <${project.latex.inkscapeCommand.get()}>") println("latex.gitLatexdiffCommand = <${project.latex.gitLatexdiffCommand.get()}>") // tasks.matching { it.name.startsWith("pdfLatex") }.forEach { // println("${it}, ${it.property("artifact")}") // } // tasks.forEach { // println(it) // println("inputs: ${it.getInputs().getFiles().getFiles()}") // println("outputs: ${it.getOutputs().getFiles().getFiles()}") // } } }

Ignore Space Show notes View settings.gradle 0 → 100644
rootProject.name = "lectures" include "01_lecture"

Show notes View settings.gradle.kts 100644 → 0
rootProject.name = "lectures" include("01_lecture") // etc.

Show line notes below