Skip to content

Commit

Permalink
chore(library): move the model of the library in the library module o…
Browse files Browse the repository at this point in the history
…f the commands
  • Loading branch information
tmorin committed Mar 20, 2023
1 parent 7d2472e commit 38910b0
Show file tree
Hide file tree
Showing 30 changed files with 71 additions and 69 deletions.
6 changes: 3 additions & 3 deletions src/cmd/library/generate/generator.rs
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ use crate::cmd::library::generate::tasks::item::parse_item;
use crate::cmd::library::generate::tasks::library::parse_library;
use crate::cmd::library::generate::tasks::module::parse_module;
use crate::cmd::library::generate::tasks::package::parse_package;
use crate::cmd::library::manifest::library::Library;
use crate::counter::Counter;
use crate::manifest::library::Library;
use crate::plantuml::PlantUML;
use crate::result::Result;
use crate::urn::Urn;
Expand Down Expand Up @@ -157,7 +157,7 @@ mod tests {
&config.plantuml_jar,
&config.plantuml_version,
)
.unwrap();
.unwrap();
let yaml = &read_to_string(Path::new("test/library-full.yaml")).unwrap();
let library: &Library = &serde_yaml::from_str(yaml).unwrap();
let generator = &Generator::create(config, library, &[]).unwrap();
Expand Down Expand Up @@ -188,7 +188,7 @@ mod tests {
&config.plantuml_jar,
&config.plantuml_version,
)
.unwrap();
.unwrap();
let yaml = &read_to_string(Path::new("test/library-icon_reference.yaml")).unwrap();
let library: &Library = &serde_yaml::from_str(yaml).unwrap();
let generator = &Generator::create(config, library, &[]).unwrap();
Expand Down
2 changes: 1 addition & 1 deletion src/cmd/library/generate/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ use crate::cmd::library::generate::config::Config;
use crate::cmd::library::generate::generator::Generator;
use crate::cmd::library::generate::task::CleanupScope;
use crate::cmd::library::generate::templates::TEMPLATES;
use crate::cmd::library::manifest::library::Library;
use crate::error::Error;
use crate::manifest::library::Library;
use crate::plantuml::create_plantuml;
use crate::result::Result;
use crate::tera::create_tera;
Expand Down
14 changes: 8 additions & 6 deletions src/cmd/library/generate/tasks/item/element_snippet.rs
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@ use tera::{Context, Tera};

use crate::cmd::library::generate::config::Config;
use crate::cmd::library::generate::task::{CleanupScope, Task};
use crate::cmd::library::manifest::element::{Element, Shape};
use crate::cmd::library::manifest::item::Item;
use crate::cmd::library::manifest::library::Library;
use crate::cmd::library::manifest::package::Package;
use crate::error::Error;
use crate::manifest::element::{Element, Shape};
use crate::manifest::item::Item;
use crate::manifest::library::Library;
use crate::manifest::package::Package;
use crate::plantuml::PlantUML;
use crate::result::Result;
use crate::utils::{create_parent_directory, delete_file};
Expand Down Expand Up @@ -325,8 +325,10 @@ mod test {
technical_label: None,
description_label: None,
template: "custom_item_snippet.tera".to_string(),
full_destination_source_path: "target/tests/element_snippet/source.Custom.puml".to_string(),
full_destination_image_path: "target/tests/element_snippet/source.Custom.png".to_string(),
full_destination_source_path: "target/tests/element_snippet/source.Custom.puml"
.to_string(),
full_destination_image_path: "target/tests/element_snippet/source.Custom.png"
.to_string(),
properties: HashMap::default(),
};
generator.cleanup(&[CleanupScope::All]).unwrap();
Expand Down
4 changes: 2 additions & 2 deletions src/cmd/library/generate/tasks/item/item_documentation.rs
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ use tera::{Context, Tera};

use crate::cmd::library::generate::config::Config;
use crate::cmd::library::generate::task::{CleanupScope, Task};
use crate::cmd::library::manifest::item::Item;
use crate::cmd::library::manifest::library::Library;
use crate::error::Error;
use crate::manifest::item::Item;
use crate::manifest::library::Library;
use crate::result::Result;
use crate::utils::{create_parent_directory, delete_file};

Expand Down
6 changes: 3 additions & 3 deletions src/cmd/library/generate/tasks/item/item_icon.rs
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@ use image::GenericImageView;

use crate::cmd::library::generate::config::Config;
use crate::cmd::library::generate::task::{CleanupScope, Task};
use crate::cmd::library::manifest::icon::Icon;
use crate::cmd::library::manifest::item::Item;
use crate::cmd::library::manifest::library::Library;
use crate::error::Error;
use crate::manifest::icon::Icon;
use crate::manifest::item::Item;
use crate::manifest::library::Library;
use crate::result::Result;
use crate::utils::{create_parent_directory, delete_file};

Expand Down
16 changes: 8 additions & 8 deletions src/cmd/library/generate/tasks/item/item_source.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
use std::collections::HashMap;
use std::fs::{File, read_to_string};
use std::fs::{read_to_string, File};
use std::path::Path;

use serde::{Deserialize, Serialize};
Expand All @@ -8,10 +8,10 @@ use tera::{Context, Tera};

use crate::cmd::library::generate::config::Config;
use crate::cmd::library::generate::task::{CleanupScope, Task};
use crate::constants::{SPRITE_LG, SPRITES};
use crate::cmd::library::manifest::element::Shape;
use crate::cmd::library::manifest::item::Item;
use crate::constants::{SPRITES, SPRITE_LG};
use crate::error::Error;
use crate::manifest::element::Shape;
use crate::manifest::item::Item;
use crate::result::Result;
use crate::utils::{create_parent_directory, delete_file};

Expand Down Expand Up @@ -172,7 +172,7 @@ impl ItemSourceTask {
})
}
fn get_relative_source_path(&self) -> Box<Path> {
Box::from(Path::new(format!("{}.puml", self.item_urn, ).as_str()))
Box::from(Path::new(format!("{}.puml", self.item_urn,).as_str()))
}
fn get_full_source_path(&self) -> Box<Path> {
Path::new(&self.output_directory)
Expand Down Expand Up @@ -303,7 +303,7 @@ mod test {
"{}/{}.puml",
generator.output_directory, generator.item_urn,
))
.unwrap();
.unwrap();
assert!(content.contains("LX_6N8UPcPbT0G"));
assert!(content.contains(
r"IconElement($id, 'IconElement', 'Package/Module/Family/BuiltInItem', $name, $tech, $desc)"
Expand All @@ -325,7 +325,7 @@ mod test {
keyB: [ itemA, itemB ]
"#,
)
.unwrap();
.unwrap();
let generator = ItemSourceTask {
item_urn: "Package/Module/Family/CustomItem".to_string(),
cached_sprite_paths: vec![],
Expand All @@ -343,7 +343,7 @@ mod test {
"{}/{}.puml",
generator.output_directory, generator.item_urn,
))
.unwrap();
.unwrap();
assert!(content.contains("' valueA"));
assert!(content.contains("' itemA,itemB"));
assert!(content.contains("!procedure CustomItem($id)"));
Expand Down
12 changes: 6 additions & 6 deletions src/cmd/library/generate/tasks/item/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@ use crate::cmd::library::generate::tasks::item::item_icon::ItemIconTask;
use crate::cmd::library::generate::tasks::item::item_source::ItemSourceTask;
use crate::cmd::library::generate::tasks::item::sprite_icon::SpriteIconTask;
use crate::cmd::library::generate::tasks::item::sprite_value::SpriteValueTask;
use crate::cmd::library::manifest::icon::Icon;
use crate::cmd::library::manifest::item::Item;
use crate::cmd::library::manifest::library::Library;
use crate::cmd::library::manifest::module::Module;
use crate::cmd::library::manifest::package::Package;
use crate::error::Error;
use crate::manifest::icon::Icon;
use crate::manifest::item::Item;
use crate::manifest::library::Library;
use crate::manifest::module::Module;
use crate::manifest::package::Package;

mod element_snippet;
mod item_documentation;
Expand All @@ -28,7 +28,7 @@ pub fn parse_item(
_package: &Package,
_module: &Module,
_item: &Item,
) -> std::result::Result<Vec<Box<dyn Task>>, Error> {
) -> Result<Vec<Box<dyn Task>>, Error> {
log::debug!("parse item {}", &_item.urn);

let mut tasks: Vec<Box<dyn Task>> = vec![];
Expand Down
4 changes: 2 additions & 2 deletions src/cmd/library/generate/tasks/item/sprite_icon.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ use serde::{Deserialize, Serialize};

use crate::cmd::library::generate::config::Config;
use crate::cmd::library::generate::task::{CleanupScope, Task};
use crate::cmd::library::manifest::icon::Icon;
use crate::cmd::library::manifest::item::Item;
use crate::error::Error;
use crate::manifest::icon::Icon;
use crate::manifest::item::Item;
use crate::result::Result;
use crate::utils::{create_parent_directory, delete_file};

Expand Down
4 changes: 2 additions & 2 deletions src/cmd/library/generate/tasks/item/sprite_value.rs
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ use serde::{Deserialize, Serialize};

use crate::cmd::library::generate::config::Config;
use crate::cmd::library::generate::task::{CleanupScope, Task};
use crate::cmd::library::manifest::icon::Icon;
use crate::cmd::library::manifest::item::Item;
use crate::error::Error;
use crate::manifest::icon::Icon;
use crate::manifest::item::Item;
use crate::result::Result;
use crate::utils::{create_parent_directory, delete_file};

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ use tera::{Context, Tera};

use crate::cmd::library::generate::config::Config;
use crate::cmd::library::generate::task::{CleanupScope, Task};
use crate::cmd::library::manifest::library::Library;
use crate::error::Error;
use crate::manifest::library::Library;
use crate::result::Result;
use crate::utils::{create_parent_directory, delete_file};

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ use tera::{Context, Tera};

use crate::cmd::library::generate::config::Config;
use crate::cmd::library::generate::task::{CleanupScope, Task};
use crate::cmd::library::manifest::library::Library;
use crate::error::Error;
use crate::manifest::library::Library;
use crate::result::Result;
use crate::utils::{create_parent_directory, delete_file};

Expand Down
2 changes: 1 addition & 1 deletion src/cmd/library/generate/tasks/library/library_summary.rs
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ use tera::{Context, Tera};

use crate::cmd::library::generate::config::Config;
use crate::cmd::library::generate::task::{CleanupScope, Task};
use crate::cmd::library::manifest::library::Library;
use crate::error::Error;
use crate::manifest::library::Library;
use crate::result::Result;
use crate::utils::{create_parent_directory, delete_file};

Expand Down
2 changes: 1 addition & 1 deletion src/cmd/library/generate/tasks/library/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ use crate::cmd::library::generate::task::Task;
use crate::cmd::library::generate::tasks::library::library_bootstrap::LibraryBootstrapTask;
use crate::cmd::library::generate::tasks::library::library_documentation::LibraryDocumentationTask;
use crate::cmd::library::generate::tasks::library::library_summary::LibrarySummaryTask;
use crate::manifest::library::Library;
use crate::cmd::library::manifest::library::Library;
use crate::result::Result;

mod library_bootstrap;
Expand Down
6 changes: 3 additions & 3 deletions src/cmd/library/generate/tasks/module/mod.rs
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
use crate::cmd::library::generate::config::Config;
use crate::cmd::library::generate::task::Task;
use crate::cmd::library::generate::tasks::module::module_documentation::ModuleDocumentationTask;
use crate::manifest::library::Library;
use crate::manifest::module::Module;
use crate::manifest::package::Package;
use crate::cmd::library::manifest::library::Library;
use crate::cmd::library::manifest::module::Module;
use crate::cmd::library::manifest::package::Package;
use crate::result::Result;

mod module_documentation;
Expand Down
10 changes: 5 additions & 5 deletions src/cmd/library/generate/tasks/module/module_documentation.rs
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@ use tera::{Context, Tera};

use crate::cmd::library::generate::config::Config;
use crate::cmd::library::generate::task::{CleanupScope, Task};
use crate::cmd::library::manifest::library::Library;
use crate::cmd::library::manifest::module::Module;
use crate::error::Error;
use crate::manifest::library::Library;
use crate::manifest::module::Module;
use crate::result::Result;
use crate::utils::{create_parent_directory, delete_file};

type ItemManifest = crate::manifest::item::Item;
type ItemManifest = crate::cmd::library::manifest::item::Item;

#[derive(Debug, Deserialize, Serialize)]
pub struct Item {
Expand Down Expand Up @@ -87,7 +87,7 @@ impl ModuleDocumentationTask {
}
fn get_relative_destination_path(&self) -> Box<Path> {
Box::from(Path::new(
format!("{}/README.md", self.module_urn, ).as_str(),
format!("{}/README.md", self.module_urn,).as_str(),
))
}
fn get_full_destination_path(&self) -> Box<Path> {
Expand Down Expand Up @@ -190,7 +190,7 @@ mod test {
"{}/Package/Module/README.md",
generator.output_directory
))
.unwrap();
.unwrap();
assert!(content.contains("The module contains 4 items."));
assert!(content.contains("[Package/Module/itemD](../../Package/Module/itemD.md)"));
assert!(content.contains("## FamilyA"));
Expand Down
4 changes: 2 additions & 2 deletions src/cmd/library/generate/tasks/package/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ use crate::cmd::library::generate::tasks::package::package_embedded::{
EmbeddedMode, PackageEmbeddedTask,
};
use crate::cmd::library::generate::tasks::package::package_example::PackageExampleTask;
use crate::manifest::library::Library;
use crate::manifest::package::Package;
use crate::cmd::library::manifest::library::Library;
use crate::cmd::library::manifest::package::Package;
use crate::result::Result;

mod package_bootstrap;
Expand Down
4 changes: 2 additions & 2 deletions src/cmd/library/generate/tasks/package/package_bootstrap.rs
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ use tera::{Context, Tera};

use crate::cmd::library::generate::config::Config;
use crate::cmd::library::generate::task::{CleanupScope, Task};
use crate::cmd::library::manifest::package::Package;
use crate::error::Error;
use crate::manifest::package::Package;
use crate::result::Result;
use crate::utils::{create_parent_directory, delete_file};

Expand Down Expand Up @@ -103,7 +103,7 @@ mod test {
"{}/Package/bootstrap.puml",
generator.output_directory
))
.unwrap();
.unwrap();
assert!(content.trim().contains("header"));
assert!(content.trim().contains("content"));
assert!(content.trim().contains("footer"));
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ use tera::{Context, Tera};

use crate::cmd::library::generate::config::Config;
use crate::cmd::library::generate::task::{CleanupScope, Task};
use crate::cmd::library::manifest::library::Library;
use crate::cmd::library::manifest::package::Package;
use crate::error::Error;
use crate::manifest::library::Library;
use crate::manifest::package::Package;
use crate::result::Result;
use crate::utils::{create_parent_directory, delete_file};

Expand Down
4 changes: 2 additions & 2 deletions src/cmd/library/generate/tasks/package/package_embedded.rs
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ use tera::{Context, Tera};

use crate::cmd::library::generate::config::Config;
use crate::cmd::library::generate::task::{CleanupScope, Task};
use crate::cmd::library::manifest::package::Package;
use crate::error::Error;
use crate::manifest::package::Package;
use crate::result::Result;
use crate::utils::{create_parent_directory, delete_file, read_file_to_string};

Expand Down Expand Up @@ -109,7 +109,7 @@ impl PackageEmbeddedTask {
EmbeddedMode::Full => "full",
}
)
.as_str(),
.as_str(),
))
}
fn get_embedded_destination_path(&self) -> Box<Path> {
Expand Down
6 changes: 3 additions & 3 deletions src/cmd/library/generate/tasks/package/package_example.rs
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ use tera::{Context, Tera};

use crate::cmd::library::generate::config::Config;
use crate::cmd::library::generate::task::{CleanupScope, Task};
use crate::cmd::library::manifest::example::Example;
use crate::cmd::library::manifest::library::Library;
use crate::cmd::library::manifest::package::Package;
use crate::error::Error;
use crate::manifest::example::Example;
use crate::manifest::library::Library;
use crate::manifest::package::Package;
use crate::plantuml::PlantUML;
use crate::result::Result;
use crate::utils::{create_parent_directory, delete_file};
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
6 changes: 3 additions & 3 deletions src/manifest/item.rs → src/cmd/library/manifest/item.rs
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
use serde::{Deserialize, Serialize};

use crate::manifest::element::Element;
use crate::manifest::icon::Icon;
use crate::manifest::item::templates::ItemTemplates;
use crate::cmd::library::manifest::element::Element;
use crate::cmd::library::manifest::icon::Icon;
use crate::cmd::library::manifest::item::templates::ItemTemplates;
use crate::urn::Urn;

mod templates {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
use serde::{Deserialize, Serialize};

use crate::manifest::library::customization::Customization;
use crate::manifest::library::templates::LibraryTemplates;
use crate::manifest::package::Package;
use crate::cmd::library::manifest::library::customization::Customization;
use crate::cmd::library::manifest::library::templates::LibraryTemplates;
use crate::cmd::library::manifest::package::Package;

pub mod customization {
use serde::{Deserialize, Serialize};
Expand Down
File renamed without changes.
4 changes: 2 additions & 2 deletions src/manifest/module.rs → src/cmd/library/manifest/module.rs
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
use serde::{Deserialize, Serialize};

use crate::manifest::item::Item;
use crate::manifest::module::templates::ModuleTemplates;
use crate::cmd::library::manifest::item::Item;
use crate::cmd::library::manifest::module::templates::ModuleTemplates;
use crate::urn::Urn;

mod templates {
Expand Down
Loading

0 comments on commit 38910b0

Please sign in to comment.