Merge pull request #457 from gauge-sh/refactoring-12-3

Refactoring

Makefile

@@ -39,8 +39,8 @@ install: ##  Install the crate as module in the current virtualenv
 
 .PHONY: test
 test: ## Run tests
-	cd python/tests && \
-	../../$(VENV_BIN)/pytest
+	$(VENV_BIN)/pytest
+	cargo test
 
 
 .PHONY: lint fmt lint-rust lint-python fmt-rust fmt-python

src/check_ext.rs → src/commands/check_external.rs

@@ -6,14 +6,16 @@ use std::path::{Path, PathBuf};
 
 use thiserror::Error;
 
+use crate::external::{
+    error::ParsingError, parsing::normalize_package_name, parsing::parse_pyproject_toml,
+};
 use crate::filesystem::relative_to;
-use crate::parsing::external::{normalize_package_name, parse_pyproject_toml};
-use crate::{filesystem, imports, parsing};
+use crate::{filesystem, imports};
 
 #[derive(Error, Debug)]
 pub enum ExternalCheckError {
     #[error("Parsing error: {0}")]
-    Parse(#[from] parsing::error::ParsingError),
+    Parse(#[from] ParsingError),
     #[error("Import parsing error: {0}")]
     ImportParse(#[from] imports::ImportParseError),
     #[error("IO error: {0}")]

src/check_int.rs → src/commands/check_internal.rs

@@ -8,15 +8,12 @@ use pyo3::{pyclass, pymethods};
 use thiserror::Error;
 
 use crate::{
-    core::{
-        config::{ProjectConfig, RootModuleTreatment, RuleSetting},
-        interfaces::InterfaceChecker,
-        module::{ModuleNode, ModuleTree},
-    },
+    core::config::{ProjectConfig, RootModuleTreatment, RuleSetting},
     exclusion::{self, is_path_excluded, set_excluded_paths},
     filesystem as fs,
     imports::{get_project_imports, ImportParseError},
-    parsing::{self, module::build_module_tree},
+    interfaces::InterfaceChecker,
+    modules::{self, build_module_tree, ModuleNode, ModuleTree},
 };
 
 #[derive(Error, Debug)]
@@ -26,7 +23,7 @@ pub enum CheckError {
     #[error("Filesystem error: {0}")]
     Filesystem(#[from] fs::FileSystemError),
     #[error("Module tree error: {0}")]
-    ModuleTree(#[from] parsing::error::ModuleTreeError),
+    ModuleTree(#[from] modules::error::ModuleTreeError),
     #[error("Exclusion error: {0}")]
     Exclusion(#[from] exclusion::PathExclusionError),
 }
@@ -477,8 +474,8 @@ pub fn check(
 mod tests {
     use super::*;
     use crate::core::config::InterfaceConfig;
-    use crate::core::module::ModuleTree;
-    use crate::tests::check_int::fixtures::{interface_config, module_tree};
+    use crate::modules::ModuleTree;
+    use crate::tests::check_internal::fixtures::{interface_config, module_tree};
 
     use rstest::rstest;
 

src/commands/mod.rs

@@ -0,0 +1,5 @@
+pub mod check_external;
+pub mod check_internal;
+pub mod report;
+pub mod sync;
+pub mod test;

src/reports.rs → src/commands/report.rs

@@ -13,7 +13,7 @@ use crate::filesystem::{
     file_to_module_path, validate_project_modules, walk_pyfiles, FileSystemError,
 };
 use crate::imports::{get_project_imports, ImportParseError, NormalizedImport};
-use crate::parsing::{error::ModuleTreeError, module::build_module_tree};
+use crate::modules::{build_module_tree, error::ModuleTreeError};
 
 struct Dependency {
     file_path: PathBuf,

src/sync.rs → src/commands/sync.rs

@@ -1,10 +1,11 @@
 use thiserror::Error;
 
-use crate::check_int::{check, CheckError};
+use crate::commands::check_internal::{check, CheckError};
 use crate::core::config::{
     global_visibility, DependencyConfig, ModuleConfig, ProjectConfig, RootModuleTreatment,
+    ROOT_MODULE_SENTINEL_TAG,
 };
-use crate::filesystem::{self as fs, ROOT_MODULE_SENTINEL_TAG};
+use crate::filesystem::{self as fs};
 use crate::parsing::config::dump_project_config_to_toml;
 use std::collections::HashMap;
 use std::path::PathBuf;

src/test.rs → src/commands/test.rs

@@ -5,10 +5,9 @@ use pyo3::{pyclass, pymethods};
 use thiserror::Error;
 
 use crate::core::config::{ModuleConfig, ProjectConfig};
-use crate::core::module::ModuleTree;
 use crate::filesystem::{self as fs};
 use crate::imports::get_project_imports;
-use crate::parsing::module::build_module_tree;
+use crate::modules::{build_module_tree, ModuleTree};
 
 #[derive(Error, Debug)]
 pub enum TestError {

src/core/config.rs

@@ -3,7 +3,8 @@ use serde::{Deserialize, Serialize};
 use std::collections::{HashMap, HashSet};
 use std::path::PathBuf;
 
-use crate::filesystem::{self, ROOT_MODULE_SENTINEL_TAG};
+pub const ROOT_MODULE_SENTINEL_TAG: &str = "<root>";
+pub const DEFAULT_EXCLUDE_PATHS: [&str; 4] = ["tests", "docs", ".*__pycache__", ".*egg-info"];
 
 // for serde
 fn default_true() -> bool {
@@ -14,7 +15,7 @@ fn default_source_roots() -> Vec<PathBuf> {
 }
 
 fn default_excludes() -> Vec<String> {
-    filesystem::DEFAULT_EXCLUDE_PATHS
+    DEFAULT_EXCLUDE_PATHS
         .iter()
         .map(|s| s.to_string())
         .collect()

src/core/error.rs

@@ -0,0 +1,16 @@
+use std::io;
+use thiserror::Error;
+
+use crate::filesystem::FileSystemError;
+
+#[derive(Error, Debug)]
+pub enum ParsingError {
+    #[error("IO error: {0}")]
+    Io(#[from] io::Error),
+    #[error("Filesystem error: {0}")]
+    Filesystem(#[from] FileSystemError),
+    #[error("TOML parsing error: {0}")]
+    TomlParse(#[from] toml::de::Error),
+    #[error("Missing field in TOML: {0}")]
+    MissingField(String),
+}

src/core/mod.rs

@@ -1,3 +1,2 @@
 pub mod config;
-pub mod interfaces;
-pub mod module;
+pub mod error;

src/external/error.rs

@@ -0,0 +1,16 @@
+use std::io;
+use thiserror::Error;
+
+use crate::filesystem::FileSystemError;
+
+#[derive(Error, Debug)]
+pub enum ParsingError {
+    #[error("IO error: {0}")]
+    Io(#[from] io::Error),
+    #[error("Filesystem error: {0}")]
+    Filesystem(#[from] FileSystemError),
+    #[error("TOML parsing error: {0}")]
+    TomlParse(#[from] toml::de::Error),
+    #[error("Missing field in TOML: {0}")]
+    MissingField(String),
+}

src/external/mod.rs

@@ -0,0 +1,2 @@
+pub mod error;
+pub mod parsing;

src/parsing/external.rs → src/external/parsing.rs

@@ -5,12 +5,14 @@ use toml::Value;
 
 use super::error;
 
+pub type Result<T> = std::result::Result<T, error::ParsingError>;
+
 pub struct ProjectInfo {
     pub dependencies: HashSet<String>,
     pub source_paths: Vec<PathBuf>,
 }
 
-pub fn parse_pyproject_toml(pyproject_path: &Path) -> error::Result<ProjectInfo> {
+pub fn parse_pyproject_toml(pyproject_path: &Path) -> Result<ProjectInfo> {
     let content = fs::read_to_string(pyproject_path)?;
     let toml_value: Value = toml::from_str(&content)?;
     let dependencies = extract_dependencies(&toml_value);

src/filesystem.rs

@@ -9,12 +9,9 @@ use globset::GlobSetBuilder;
 use thiserror::Error;
 use walkdir::{DirEntry, WalkDir};
 
-use crate::core::config::ModuleConfig;
+use crate::core::config::{ModuleConfig, ROOT_MODULE_SENTINEL_TAG};
 use crate::exclusion::is_path_excluded;
 
-pub const ROOT_MODULE_SENTINEL_TAG: &str = "<root>";
-pub const DEFAULT_EXCLUDE_PATHS: [&str; 4] = ["tests", "docs", ".*__pycache__", ".*egg-info"];
-
 #[derive(Error, Debug)]
 pub enum FileSystemError {
     #[error("Encountered unexpected I/O error.\n{0}")]

src/imports.rs

@@ -14,16 +14,16 @@ use ruff_python_ast::{Expr, Mod, Stmt, StmtIf, StmtImport, StmtImportFrom};
 use ruff_source_file::Locator;
 use thiserror::Error;
 
-use crate::parsing::py_ast::parse_python_source;
-use crate::{exclusion, filesystem, parsing};
+use crate::python::{error::ParsingError, parsing::parse_python_source};
+use crate::{exclusion, filesystem};
 
 #[derive(Error, Debug)]
 pub enum ImportParseError {
     #[error("Failed to parse project imports.\nFile: {file}\nFailure: {source}")]
     Parsing {
         file: String,
         #[source]
-        source: parsing::ParsingError,
+        source: ParsingError,
     },
     #[error("Failed to parse project imports.\n{0}")]
     Filesystem(#[from] filesystem::FileSystemError),

src/interfaces/mod.rs

@@ -0,0 +1,3 @@
+pub mod check;
+
+pub use check::InterfaceChecker;