Rename package to 'jab' because conflicting crate package name

Author: sendyhalim

.github/workflows/build_artifacts.yml

@@ -20,10 +20,10 @@ jobs:
         include:
           - os: macos-latest
             target: x86_64-apple-darwin
-            release_bin_name: cid.macos
+            release_bin_name: jab.macos
           - os: ubuntu-latest
             target: x86_64-unknown-linux-gnu
-            release_bin_name: cid.linux
+            release_bin_name: jab.linux
     steps:
       - uses: actions/checkout@v2
 
@@ -40,12 +40,12 @@ jobs:
 
       - name: Zip build result
         run: |
-          zip --junk-paths ./target/${{ matrix.target }}/release/cid-${{ matrix.target }}.zip ./target/${{ matrix.target }}/release/cid
+          zip --junk-paths ./target/${{ matrix.target }}/release/jab-${{ matrix.target }}.zip ./target/${{ matrix.target }}/release/jab
 
       - name: Create Release
         uses: softprops/action-gh-release@v1
         with:
-          files: ./target/${{ matrix.target }}/release/cid-${{ matrix.target }}.zip
+          files: ./target/${{ matrix.target }}/release/jab-${{ matrix.target }}.zip
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
@@ -55,7 +55,7 @@ jobs:
           #    env:
           #      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           #    with:
-          #      files: ./target/${{ matrix.target }}/release/cid.zip
+          #      files: ./target/${{ matrix.target }}/release/jab.zip
           #      release_name: Release ${{ github.ref }}
           #      draft: false
           #      prerelease: false
@@ -71,6 +71,6 @@ jobs:
           #      # See below blog post for more info:
           #      # https://jasonet.co/posts/new-features-of-github-actions/#passing-data-to-future-steps
           #      upload_url: ${{ steps.create_release.outputs.upload_url }}
-          #      asset_path: ./target/${{ matrix.target }}/release/cid.zip
+          #      asset_path: ./target/${{ matrix.target }}/release/jab.zip
           #      asset_name: ${{ matrix.release_bin_name }}
           #      asset_content_type: application/zip

Cargo.lock

@@ -1,16 +1,16 @@
 [package]
-name = "cid"
+name = "jab"
 version = "0.1.0"
 authors = ["Sendy Halim <sendyhalim93@gmail.com>"]
 edition = "2018"
 description = """\
-  CID is a database state management tool, think of it as git but for \
+  JAB is a database state management tool, think of it as git but for \
   database. You can commit your current db state and checkout to \
   your previous db state.\
 """
 readme = "readme.md"
-homepage = "https://github.com/sendyhalim/cid"
-repository = "https://github.com/sendyhalim/cid"
+homepage = "https://github.com/sendyhalim/jab"
+repository = "https://github.com/sendyhalim/jab"
 keywords = ["cli", "database", "developer-tools"]
 categories = ["command-line-utilities"]
 
@@ -39,5 +39,5 @@ name = "lib"
 path = "src/lib/lib.rs"
 
 [[bin]]
-name = "cid"
-path = "src/bin/cid.rs"
+name = "jab"
+path = "src/bin/jab.rs"

Cargo.toml

@@ -1,8 +1,8 @@
-# Cid
-CID is a database state management tool, think of it as git but for database. You can commit your current db state and checkout to your previous db state.
+# Jab
+`jab` is a database state management tool, think of it as git but for database. You can commit your current db state and checkout to your previous db state.
 
-[![Crates.io](https://img.shields.io/crates/v/cid)](https://crates.io/crates/cid)
-[![Crates.io](https://img.shields.io/crates/l/cid)](LICENSE)
+[![Crates.io](https://img.shields.io/crates/v/jab)](https://crates.io/crates/jab)
+[![Crates.io](https://img.shields.io/crates/l/jab)](LICENSE)
 
 ## 📠 Notes
 * Currently only supports postgres.
@@ -11,39 +11,39 @@ CID is a database state management tool, think of it as git but for database. Yo
 ## 🔩 Installation
 ### Manual (requires rust)
 ```bash
-git clone git@github.com:sendyhalim/cid.git
+git clone git@github.com:sendyhalim/jab.git
 
 make install
 ```
 
 ### Download
-Dynamically linked binaries are only available for macos and linux. Go [here](https://github.com/sendyhalim/cid/releases/latest).
+Dynamically linked binaries are only available for macos and linux. Go [here](https://github.com/sendyhalim/jab/releases/latest).
 
 ## 🎮 Usage
 ```bash
 # First create project.
 # Currently only supports postgres.
 # ------------------------------------------
-cid project create awesomestuff --database-uri="username:password@localhost:5433"
+jab project create awesomestuff --database-uri="username:password@localhost:5433"
 
 # Start commiting your db
 # ------------------------------------------
-cid project commit awesomestuff --message "my first commit"
+jab project commit awesomestuff --message "my first commit"
 
 # See log
 # ------------------------------------------
-cid project log awesomestuff
+jab project log awesomestuff
 
 # Restore your db to the latest commit
 # ------------------------------------------
-cid project restore awesomestuff
+jab project restore awesomestuff
 
 # Restore your db to a specific commit
 # ------------------------------------------
-cid project restore awesomestuff [optional-hash]
+jab project restore awesomestuff [optional-hash]
 
 
 # List of available projects
 # ------------------------------------------
-cid project list
+jab project list
 ```

readme.md

@@ -8,7 +8,7 @@ use log;
 
 use env_logger;
 use lib::config;
-use lib::config::CidConfig;
+use lib::config::JabConfig;
 use lib::config::ProjectConfig;
 use lib::db::postgresql::client as pg;
 use lib::project;
@@ -25,10 +25,10 @@ pub mod built_info {
 fn main() -> Result<(), Box<dyn std::error::Error>> {
   env_logger::init();
 
-  log::debug!("Preparing cid..");
+  log::debug!("Preparing jab..");
   MainProjectManager::bootstrap()?;
 
-  let cli = Cli::new("CID")
+  let cli = Cli::new("jab")
     .version(built_info::PKG_VERSION)
     .author(built_info::PKG_AUTHORS)
     .setting(clap::AppSettings::ArgRequiredElseHelp)
@@ -102,10 +102,10 @@ fn project_cmd<'a, 'b>() -> Cli<'a, 'b> {
 }
 
 fn handle_project_cli(cli: &ArgMatches) -> ResultDynError<()> {
-  log::debug!("Reading cid config");
+  log::debug!("Reading jab config");
 
-  let cid_config = CidConfig::read()?;
-  let mut project_manager: MainProjectManager = MainProjectManager::new(cid_config);
+  let jab_config = JabConfig::read()?;
+  let mut project_manager: MainProjectManager = MainProjectManager::new(jab_config);
 
   if let Some(create_cli) = cli.subcommand_matches("create") {
     log::debug!("Creating project...");
@@ -114,7 +114,7 @@ fn handle_project_cli(cli: &ArgMatches) -> ResultDynError<()> {
     let db_uri = create_cli.value_of("database-uri").unwrap();
 
     let project = project_manager.create_project(&CreateProjectInput {
-      project_dir: config::get_cid_dir().as_ref(),
+      project_dir: config::get_jab_dir().as_ref(),
       project_name,
       db_uri,
     })?;
@@ -194,16 +194,16 @@ fn handle_project_cli(cli: &ArgMatches) -> ResultDynError<()> {
 }
 
 struct MainProjectManager {
-  cid_config: CidConfig,
+  jab_config: JabConfig,
 }
 
 impl MainProjectManager {
   fn open_project_from_args(&self, matches: &ArgMatches) -> ResultDynError<Project> {
     let project_name = matches.value_of("project").unwrap();
-    let project_config = self.cid_config.project_config(project_name)?;
+    let project_config = self.jab_config.project_config(project_name)?;
 
     return self.open_project(&OpenProjectInput {
-      project_dir: config::get_cid_dir().as_ref(),
+      project_dir: config::get_jab_dir().as_ref(),
       project_name,
       db_uri: &project_config.db_uri,
     });
@@ -212,23 +212,23 @@ impl MainProjectManager {
 
 impl ProjectManager for MainProjectManager {
   fn bootstrap() -> ResultDynError<()> {
-    let cid_dir = config::get_cid_dir();
+    let jab_dir = config::get_jab_dir();
 
-    if !cid_dir.exists() {
-      fs::create_dir(cid_dir)?;
+    if !jab_dir.exists() {
+      fs::create_dir(jab_dir)?;
     }
 
-    let config_path = CidConfig::get_path();
+    let config_path = JabConfig::get_path();
 
     if !config_path.exists() {
-      fs::write(config_path, CidConfig::empty_config_str())?;
+      fs::write(config_path, JabConfig::empty_config_str())?;
     }
 
     return Ok(());
   }
 
-  fn new(cid_config: CidConfig) -> MainProjectManager {
-    return MainProjectManager { cid_config };
+  fn new(jab_config: JabConfig) -> MainProjectManager {
+    return MainProjectManager { jab_config };
   }
 
   fn create_project(&mut self, input: &CreateProjectInput) -> ResultDynError<Project> {
@@ -238,12 +238,12 @@ impl ProjectManager for MainProjectManager {
       db_uri: input.db_uri,
     })?;
 
-    self.cid_config.register_project_config(ProjectConfig {
+    self.jab_config.register_project_config(ProjectConfig {
       name: String::from(project.name()),
       db_uri: String::from(project.db_uri()),
     });
 
-    CidConfig::persist(&self.cid_config)?;
+    JabConfig::persist(&self.jab_config)?;
 
     return Ok(project);
   }
@@ -258,7 +258,7 @@ impl ProjectManager for MainProjectManager {
 
   fn get_project_names(&self) -> ResultDynError<Vec<&str>> {
     let project_names: Vec<&str> = self
-      .cid_config
+      .jab_config
       .projects
       .values()
       .map(|config| config.name.as_ref())

src/bin/cid.rs src/bin/jab.rssrc/bin/cid.rs renamed to src/bin/jab.rs

@@ -25,21 +25,21 @@ pub struct ProjectConfig {
 }
 
 #[derive(Serialize, Deserialize)]
-pub struct CidConfig {
+pub struct JabConfig {
   pub projects: HashMap<String, ProjectConfig>,
 }
 
-impl CidConfig {
-  pub fn read() -> ResultDynError<CidConfig> {
-    let config_path = CidConfig::get_path();
+impl JabConfig {
+  pub fn read() -> ResultDynError<JabConfig> {
+    let config_path = JabConfig::get_path();
     let config_str = String::from(fs::read_to_string(config_path)?);
-    let config: CidConfig = serde_json::from_str(&config_str)?;
+    let config: JabConfig = serde_json::from_str(&config_str)?;
 
     return Ok(config);
   }
 
-  pub fn persist(config: &CidConfig) -> ResultDynError<()> {
-    let config_path = CidConfig::get_path();
+  pub fn persist(config: &JabConfig) -> ResultDynError<()> {
+    let config_path = JabConfig::get_path();
 
     let config_str = serde_json::to_string_pretty(&config)?;
     fs::write(config_path, config_str)?;
@@ -48,19 +48,19 @@ impl CidConfig {
   }
 
   pub fn get_path() -> PathBuf {
-    return get_cid_dir().join("config");
+    return get_jab_dir().join("config");
   }
 
   pub fn empty_config_str() -> String {
-    let config = CidConfig {
+    let config = JabConfig {
       projects: HashMap::new(),
     };
 
     return serde_json::to_string_pretty(&config).unwrap();
   }
 }
 
-impl CidConfig {
+impl JabConfig {
   pub fn register_project_config(&mut self, project_config: ProjectConfig) {
     self
       .projects
@@ -77,8 +77,8 @@ impl CidConfig {
   }
 }
 
-pub fn get_cid_dir() -> PathBuf {
+pub fn get_jab_dir() -> PathBuf {
   let project_dir = dirs::home_dir().unwrap();
 
-  return project_dir.join(".cid");
+  return project_dir.join(".jab");
 }

src/lib/config.rs

@@ -164,7 +164,7 @@ impl DbConnectionConfig {
 pub fn restore(input: RestoreInput) -> ResultDynError<String> {
   let db_uri = input.db_uri;
   let db_connection_config = DbConnectionConfig::from(db_uri)?;
-  let temp_file_path = "/tmp/cid.sql";
+  let temp_file_path = "/tmp/jab.sql";
 
   log::debug!("Parsed config {:?}", db_connection_config);
   log::debug!("Writing dump to a temp file");

src/lib/db/postgresql/client.rs

@@ -1,6 +1,6 @@
 use std::path::Path;
 
-use crate::config::CidConfig;
+use crate::config::JabConfig;
 use crate::project::Project;
 use crate::types::ResultDynError;
 
@@ -18,7 +18,7 @@ pub struct OpenProjectInput<'a> {
 
 pub trait ProjectManager {
   fn bootstrap() -> ResultDynError<()>;
-  fn new(cid_config: CidConfig) -> Self;
+  fn new(jab_config: JabConfig) -> Self;
   fn create_project(&mut self, input: &CreateProjectInput) -> ResultDynError<Project>;
   fn open_project(&self, input: &OpenProjectInput) -> ResultDynError<Project>;
   fn get_project_names(&self) -> ResultDynError<Vec<&str>>;