summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLars Wirzenius <liw@liw.fi>2022-09-03 09:25:26 +0300
committerLars Wirzenius <liw@liw.fi>2022-09-03 09:30:16 +0300
commit2341869c78cea3647eadd46bbfc7f703541cee0b (patch)
tree2d870c6eec99a782bbc421bd678003b3ae323515
parentba31a2ad25fa0ae3f3fd49eaa5174f9520248b90 (diff)
downloadsubplot-2341869c78cea3647eadd46bbfc7f703541cee0b.tar.gz
refactor: rename DataFile{,s} to EmbeddedFile{,s} to be systematic
Sponsored-by: author
-rw-r--r--src/bin/cli/mod.rs4
-rw-r--r--src/bin/subplot.rs4
-rw-r--r--src/doc.rs12
-rw-r--r--src/embedded.rs (renamed from src/datafiles.rs)22
-rw-r--r--src/lib.rs6
-rw-r--r--src/visitor/embedded.rs (renamed from src/visitor/datafiles.rs)8
-rw-r--r--src/visitor/mod.rs2
7 files changed, 29 insertions, 29 deletions
diff --git a/src/bin/cli/mod.rs b/src/bin/cli/mod.rs
index a16df87..e78a92d 100644
--- a/src/bin/cli/mod.rs
+++ b/src/bin/cli/mod.rs
@@ -9,9 +9,9 @@ use std::fmt::Debug;
use std::path::Path;
use std::str::FromStr;
use std::{collections::HashMap, convert::TryFrom};
-use subplot::{DataFile, Document, Style, SubplotError};
+use subplot::{Document, EmbeddedFile, Style, SubplotError};
-pub fn extract_file<'a>(doc: &'a Document, filename: &str) -> Result<&'a DataFile> {
+pub fn extract_file<'a>(doc: &'a Document, filename: &str) -> Result<&'a EmbeddedFile> {
for file in doc.files() {
if file.filename() == filename {
return Ok(file);
diff --git a/src/bin/subplot.rs b/src/bin/subplot.rs
index 759b70b..b618ac9 100644
--- a/src/bin/subplot.rs
+++ b/src/bin/subplot.rs
@@ -6,7 +6,7 @@ use anyhow::Result;
use env_logger::fmt::Color;
use log::{debug, error, info, trace, warn};
use subplot::{
- codegen, load_document, resource, DataFile, Document, MarkupOpts, Style, SubplotError,
+ codegen, load_document, resource, Document, EmbeddedFile, MarkupOpts, Style, SubplotError,
};
use time::{format_description::FormatItem, macros::format_description, OffsetDateTime};
@@ -165,7 +165,7 @@ impl Extract {
fn run(&self) -> Result<()> {
let doc = load_linted_doc(&self.filename, Style::default(), None, self.merciful)?;
- let files: Vec<&DataFile> = if self.embedded.is_empty() {
+ let files: Vec<&EmbeddedFile> = if self.embedded.is_empty() {
doc.files()
.iter()
.map(Result::Ok)
diff --git a/src/doc.rs b/src/doc.rs
index 8a70306..ace3e67 100644
--- a/src/doc.rs
+++ b/src/doc.rs
@@ -2,8 +2,8 @@ use crate::ast;
use crate::generate_test_program;
use crate::get_basedir_from;
use crate::visitor;
-use crate::DataFile;
-use crate::DataFiles;
+use crate::EmbeddedFile;
+use crate::EmbeddedFiles;
use crate::LintingVisitor;
use crate::MatchedScenario;
use crate::Metadata;
@@ -84,7 +84,7 @@ pub struct Document {
markdowns: Vec<PathBuf>,
ast: Pandoc,
meta: Metadata,
- files: DataFiles,
+ files: EmbeddedFiles,
style: Style,
warnings: Warnings,
}
@@ -94,7 +94,7 @@ impl Document {
markdowns: Vec<PathBuf>,
ast: Pandoc,
meta: Metadata,
- files: DataFiles,
+ files: EmbeddedFiles,
style: Style,
) -> Document {
Document {
@@ -130,7 +130,7 @@ impl Document {
// Currently we can't really return more than one error so return one
return Err(linter.issues.remove(0));
}
- let files = DataFiles::new(&mut ast);
+ let files = EmbeddedFiles::new(&mut ast);
let doc = Document::new(markdowns, ast, meta, files, style);
trace!("Loaded from JSON OK");
Ok(doc)
@@ -273,7 +273,7 @@ impl Document {
}
/// Return list of files embeddedin the document.
- pub fn files(&self) -> &[DataFile] {
+ pub fn files(&self) -> &[EmbeddedFile] {
self.files.files()
}
diff --git a/src/datafiles.rs b/src/embedded.rs
index 83e90d9..c868054 100644
--- a/src/datafiles.rs
+++ b/src/embedded.rs
@@ -3,15 +3,15 @@ use serde::{Deserialize, Serialize};
/// A data file embedded in the document.
#[derive(Debug, Eq, PartialEq, Clone, Serialize, Deserialize)]
-pub struct DataFile {
+pub struct EmbeddedFile {
filename: String,
contents: String,
}
-impl DataFile {
+impl EmbeddedFile {
/// Create a new data file, with a name and contents.
- pub fn new(filename: String, contents: String) -> DataFile {
- DataFile { filename, contents }
+ pub fn new(filename: String, contents: String) -> EmbeddedFile {
+ EmbeddedFile { filename, contents }
}
/// Return name of embedded file.
@@ -27,25 +27,25 @@ impl DataFile {
/// A collection of data files embedded in document.
#[derive(Debug, Eq, PartialEq, Clone, Serialize, Deserialize)]
-pub struct DataFiles {
- files: Vec<DataFile>,
+pub struct EmbeddedFiles {
+ files: Vec<EmbeddedFile>,
}
-impl DataFiles {
+impl EmbeddedFiles {
/// Create new set of data files.
- pub fn new(ast: &mut Pandoc) -> DataFiles {
- let mut files = DataFiles { files: vec![] };
+ pub fn new(ast: &mut Pandoc) -> EmbeddedFiles {
+ let mut files = EmbeddedFiles { files: vec![] };
files.walk_pandoc(ast);
files
}
/// Return slice of all data files.
- pub fn files(&self) -> &[DataFile] {
+ pub fn files(&self) -> &[EmbeddedFile] {
&self.files
}
/// Append a new data file.
- pub fn push(&mut self, file: DataFile) {
+ pub fn push(&mut self, file: EmbeddedFile) {
self.files.push(file);
}
}
diff --git a/src/lib.rs b/src/lib.rs
index 23076d5..1d0060b 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -23,9 +23,9 @@ pub mod resource;
mod diagrams;
pub use diagrams::{DiagramMarkup, DotMarkup, MarkupOpts, PikchrMarkup, PlantumlMarkup, Svg};
-mod datafiles;
-pub use datafiles::DataFile;
-pub use datafiles::DataFiles;
+mod embedded;
+pub use embedded::EmbeddedFile;
+pub use embedded::EmbeddedFiles;
mod panhelper;
mod typeset;
diff --git a/src/visitor/datafiles.rs b/src/visitor/embedded.rs
index 53ab7bb..891240b 100644
--- a/src/visitor/datafiles.rs
+++ b/src/visitor/embedded.rs
@@ -1,10 +1,10 @@
use crate::panhelper;
-use crate::DataFile;
-use crate::DataFiles;
+use crate::EmbeddedFile;
+use crate::EmbeddedFiles;
use pandoc_ast::{Block, MutVisitor};
-impl MutVisitor for DataFiles {
+impl MutVisitor for EmbeddedFiles {
fn visit_vec_block(&mut self, vec_block: &mut Vec<Block>) {
use panhelper::is_class;
for block in vec_block {
@@ -23,7 +23,7 @@ impl MutVisitor for DataFiles {
} else {
contents.clone()
};
- self.push(DataFile::new(panhelper::get_filename(attr), contents));
+ self.push(EmbeddedFile::new(panhelper::get_filename(attr), contents));
}
}
_ => {
diff --git a/src/visitor/mod.rs b/src/visitor/mod.rs
index 95bf2b1..1c095ac 100644
--- a/src/visitor/mod.rs
+++ b/src/visitor/mod.rs
@@ -1,7 +1,7 @@
mod block_class;
pub use block_class::BlockClassVisitor;
-mod datafiles;
+mod embedded;
mod image;
pub use image::ImageVisitor;