Merge branch 'dev'

Author: myOmikron

Cargo.toml

@@ -7,7 +7,7 @@ members = [
 
 [package]
 name = "rorm-cli"
-version = "0.5.0"
+version = "0.6.0"
 edition = "2021"
 authors = ["myOmikron <[email protected]>"]
 repository = "https://github.com/rorm-orm/rorm-cli"
@@ -18,60 +18,54 @@ documentation = "https://docs.rorm.rs"
 license = "MIT"
 description = "The cli tool for managing rorm applications."
 
+[lib]
+path = "src/lib.rs"
+name = "rorm_cli"
+
+[[bin]]
+name = "rorm-cli"
+path = "src/main.rs"
+
 [dependencies]
 # Internal dependencies
 rorm-declaration = { version = "~0.3", path = "rorm-declaration" }
-rorm-sql = { version = "~0.5", path = "rorm-sql" }
+rorm-sql = { version = "~0.5", path = "rorm-sql", features = ["sqlite", "mysql", "postgres"] }
 
 # CLI parsing tool
-clap = { version = "~4.0" }
+clap = { version = "~4", features = ["derive"] }
 
 # Serialization library
-serde = { version = "~1.0" }
-serde_json = { version = "~1.0" }
-toml = { version = "~0.5" }
+serde = { version = "~1", features = ["derive"] }
+serde_json = { version = "~1" }
+toml = { version = "~0.7" }
 
 # Generic error package
-anyhow = { version = "~1.0" }
+anyhow = { version = "~1" }
 
 # Regex
-regex = { version = "~1.7" }
+regex = { version = "~1" }
 
 # Lazy implementation
-once_cell = { version = "~1.16" }
+once_cell = { version = "~1" }
 
 # SQL database abstraction
-sqlx = { version = "~0.6" }
+sqlx = { version = "~0.6", features = ["mysql", "postgres", "sqlite", "any", "chrono", "runtime-tokio-rustls"] }
 
 # Runtime
-tokio = { version = "~1.23" }
+tokio = { version = ">=1.23.1", features = ["macros"] }
 
 # Enum simplification
 strum = { version = "~0.24" }
 
 # Read passwords from cli
-rpassword = { version = "~7.2" }
+rpassword = { version = "~7" }
 
 [dev-dependencies]
 # Creating and clearing temporary directories
 temp-dir = { version = "~0.1" }
 
-[features]
-default = [
-    "sqlx/runtime-tokio-rustls",
-    "sqlx/mysql",
-    "sqlx/sqlite",
-    "sqlx/postgres",
-    "sqlx/any",
-    "sqlx/chrono",
-
-    "tokio/macros",
-
-    "serde/derive",
-
-    "clap/derive",
-
-    "rorm-sql/sqlite",
-    "rorm-sql/postgres",
-    "rorm-sql/mysql",
-]
+[profile.fat-lto]
+inherits = "release"
+opt-level = "s"
+lto = "fat"
+strip = true

changelog.txt

@@ -1,4 +1,2 @@
-Since 0.4.1
+Since 0.5.0
 -----------
-
-- Added init subcommand.

rorm-sql

@@ -0,0 +1,217 @@
+use clap::{ArgAction, Parser, Subcommand};
+
+use crate::init::init;
+use crate::make_migrations::{run_make_migrations, MakeMigrationsOptions};
+use crate::migrate::{run_migrate, MigrateOptions};
+use crate::squash_migrations::squash_migrations;
+
+#[derive(Subcommand)]
+pub enum InitDriver {
+    #[clap(about = "Initialize a sqlite configuration")]
+    Sqlite {
+        #[clap(long = "filename")]
+        #[clap(default_value_t = String::from("db.sqlite3"))]
+        #[clap(help = "Name of the sqlite file.")]
+        filename: String,
+    },
+    #[clap(about = "Initialize a mysql configuration")]
+    Mysql {
+        #[clap(long = "host")]
+        #[clap(default_value_t = String::from("127.0.0.1"))]
+        #[clap(help = "The address to use to connect to the database.")]
+        host: String,
+        #[clap(long = "port")]
+        #[clap(default_value_t = 5432)]
+        #[clap(help = "The port to use to connect to the database.")]
+        port: u16,
+        #[clap(long = "user")]
+        #[clap(default_value_t = String::from("dbuser"))]
+        #[clap(help = "The user to use to connect to the database.")]
+        user: String,
+        #[clap(long = "password")]
+        #[clap(
+            help = "Set the password. To minimize the risk of exposing your password, use --ask-password instead."
+        )]
+        password: Option<String>,
+        #[clap(long = "ask-password")]
+        #[clap(
+            help = "Ask for the password for the database. If specified with the --password option, this value will be prevalent."
+        )]
+        ask_password: bool,
+        #[clap(long = "name")]
+        #[clap(default_value_t = String::from("dbname"))]
+        #[clap(help = "The name of the database to connect to.")]
+        name: String,
+    },
+    #[clap(about = "Initialize a postgres configuration")]
+    Postgres {
+        #[clap(long = "host")]
+        #[clap(default_value_t = String::from("127.0.0.1"))]
+        #[clap(help = "The address to use to connect to the database.")]
+        host: String,
+        #[clap(long = "port")]
+        #[clap(default_value_t = 5432)]
+        #[clap(help = "The port to use to connect to the database.")]
+        port: u16,
+        #[clap(long = "user")]
+        #[clap(default_value_t = String::from("dbuser"))]
+        #[clap(help = "The user to use to connect to the database.")]
+        user: String,
+        #[clap(long = "password")]
+        #[clap(
+            help = "Set the password. To minimize the risk of exposing your password, use --ask-password instead."
+        )]
+        password: Option<String>,
+        #[clap(long = "ask-password")]
+        #[clap(
+            help = "Ask for the password for the database. If specified with the --password option, this value will be prevalent."
+        )]
+        ask_password: bool,
+        #[clap(long = "name")]
+        #[clap(default_value_t = String::from("dbname"))]
+        #[clap(help = "The name of the database to connect to.")]
+        name: String,
+    },
+}
+
+#[derive(Subcommand)]
+enum Commands {
+    #[clap(about = "Create the database configuration file")]
+    Init {
+        #[clap(long = "database-config")]
+        #[clap(default_value_t = String::from("./database.toml"))]
+        #[clap(help = "Path to the database configuration file that should be created.")]
+        database_config: String,
+
+        #[clap(short = 'f', long = "force")]
+        #[clap(help = "Overwrite the database configuration if it is existent already")]
+        force: bool,
+
+        #[clap(subcommand)]
+        driver: InitDriver,
+    },
+
+    #[clap(about = "Tool to create migrations")]
+    MakeMigrations {
+        #[clap(long = "models-file")]
+        #[clap(default_value_t=String::from("./.models.json"))]
+        #[clap(help = "Location of the intermediate representation of models.")]
+        models_file: String,
+
+        #[clap(short = 'm', long = "migration-dir")]
+        #[clap(default_value_t=String::from("./migrations/"))]
+        #[clap(help = "Destination to / from which migrations are written / read.")]
+        migration_dir: String,
+
+        #[clap(help = "Use this name as migration name instead of generating one.")]
+        name: Option<String>,
+
+        #[clap(long = "non-interactive")]
+        #[clap(action = ArgAction::SetTrue)]
+        #[clap(help = "If set, no questions will be asked.")]
+        non_interactive: bool,
+
+        #[clap(long = "disable-warnings")]
+        #[clap(action = ArgAction::SetTrue)]
+        #[clap(help = "If set, no warnings will be printed.")]
+        warnings_disabled: bool,
+    },
+
+    #[clap(about = "Apply migrations")]
+    Migrate {
+        #[clap(short = 'm', long = "migration-dir")]
+        #[clap(default_value_t=String::from("./migrations/"))]
+        #[clap(help = "Destination to / from which migrations are written / read.")]
+        migration_dir: String,
+
+        #[clap(long = "database-config")]
+        #[clap(default_value_t=String::from("./database.toml"))]
+        #[clap(help = "Path to the database configuration file.")]
+        database_config: String,
+
+        #[clap(long = "log-sql")]
+        #[clap(action = ArgAction::SetTrue)]
+        #[clap(help = "If turned on, all queries to the database will be logged")]
+        log_queries: bool,
+
+        #[clap(long = "apply-until")]
+        #[clap(id = "MIGRATION_ID")]
+        #[clap(help = "Only apply the migrations to (inclusive) the given migration.")]
+        apply_until: Option<u16>,
+    },
+
+    #[clap(about = "Squash migrations")]
+    SquashMigrations {
+        #[clap(short = 'm', long = "migration-dir")]
+        #[clap(default_value_t = String::from("./migrations/"))]
+        #[clap(help = "Destination to / from which migrations are written / read.")]
+        migration_dir: String,
+
+        #[clap(help = "First migration to start squashing from.")]
+        first_migration: u16,
+
+        #[clap(help = "Last migration to squash.")]
+        last_migration: u16,
+    },
+
+    #[clap(about = "Merge migrations")]
+    MergeMigrations {},
+}
+
+#[derive(Parser)]
+#[clap(version, about = "CLI tool for rorm", long_about = None)]
+#[clap(arg_required_else_help = true)]
+#[clap(name = "rorm-cli")]
+pub struct Cli {
+    #[clap(subcommand)]
+    command: Option<Commands>,
+}
+
+pub async fn entry(cli: Cli) -> anyhow::Result<()> {
+    match cli.command {
+        Some(Commands::Init {
+            force,
+            driver,
+            database_config,
+        }) => init(database_config, driver, force)?,
+        Some(Commands::MakeMigrations {
+            models_file,
+            migration_dir,
+            name,
+            non_interactive,
+            warnings_disabled,
+        }) => {
+            run_make_migrations(MakeMigrationsOptions {
+                models_file,
+                migration_dir,
+                name,
+                non_interactive,
+                warnings_disabled,
+            })?;
+        }
+        Some(Commands::Migrate {
+            migration_dir,
+            database_config,
+            log_queries,
+            apply_until,
+        }) => {
+            run_migrate(MigrateOptions {
+                migration_dir,
+                database_config,
+                log_queries,
+                apply_until,
+            })
+            .await?;
+        }
+        Some(Commands::SquashMigrations {
+            migration_dir,
+            first_migration,
+            last_migration,
+        }) => {
+            squash_migrations(migration_dir, first_migration, last_migration).await?;
+        }
+        _ => {}
+    }
+
+    Ok(())
+}

src/entry.rs

@@ -5,8 +5,8 @@ use std::process::exit;
 
 use rorm_declaration::config::{DatabaseConfig, DatabaseDriver};
 
+use crate::entry::InitDriver;
 use crate::migrate::config::DatabaseConfigFile;
-use crate::InitDriver;
 
 pub fn init(database_configuration: String, driver: InitDriver, force: bool) -> anyhow::Result<()> {
     let p = Path::new(&database_configuration);

src/init/mod.rs

@@ -0,0 +1,15 @@
+/// Exports for [rorm-cli-lib].
+///
+/// Reexports for executing the defined cli parser via another
+pub mod entry;
+/// This module is used for creating a configuration file that can be used by the
+/// binary version.
+pub mod init;
+/// This module handles the creation of migration files
+pub mod make_migrations;
+/// This module is used for applying migrations
+pub mod migrate;
+
+mod linter;
+mod squash_migrations;
+mod utils;