matthiasbeyer/imag
1
0
Fork 0
Code Releases Activity

Merge pull request #1190 from matthiasbeyer/imag-init/init

Browse source 
imag-init: initial import
This commit is contained in:
Matthias Beyer 2018-01-04 19:37:50 +01:00 committed by GitHub
commit 5aeaacc317
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 314 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
Cargo.toml
View file

@ -5,6 +5,7 @@ members = [
"bin/core/imag-diagnostics", "bin/core/imag-diagnostics",
"bin/core/imag-gps", "bin/core/imag-gps",
"bin/core/imag-grep", "bin/core/imag-grep",
"bin/core/imag-init",
"bin/core/imag-link", "bin/core/imag-link",
"bin/core/imag-mv", "bin/core/imag-mv",
"bin/core/imag-ref", "bin/core/imag-ref",

28
bin/core/imag-init/Cargo.toml Normal file
View file

@ -0,0 +1,28 @@
[package]
name = "imag-init"
version = "0.6.0"
authors = ["Matthias Beyer <mail@beyermatthias.de>"]
description = "Part of the imag core distribution: imag-init command"
keywords = ["imag", "PIM", "personal", "information", "management"]
readme = "../../../README.md"
license = "LGPL-2.1"
documentation = "https://matthiasbeyer.github.io/imag/imag_documentation/index.html"
repository = "https://github.com/matthiasbeyer/imag"
homepage = "http://imag-pim.org"
[badges]
travis-ci = { repository = "matthiasbeyer/imag" }
is-it-maintained-issue-resolution = { repository = "matthiasbeyer/imag" }
is-it-maintained-open-issues = { repository = "matthiasbeyer/imag" }
maintenance = { status = "actively-developed" }
[dependencies]
clap = ">=2.17"
version = "2.0.1"
[dev-dependencies]
toml = "0.4"

1
bin/core/imag-init/README.md Symbolic link
View file

@ -0,0 +1 @@
../../../doc/src/04020-module-init.md

226
bin/core/imag-init/src/main.rs Normal file
View file

@ -0,0 +1,226 @@
//
// imag - the personal information management suite for the commandline
// Copyright (C) 2015, 2016 Matthias Beyer <mail@beyermatthias.de> and contributors
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; version
// 2.1 of the License.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
//
#![deny(
non_camel_case_types,
non_snake_case,
path_statements,
trivial_numeric_casts,
unstable_features,
unused_allocation,
unused_import_braces,
unused_imports,
unused_must_use,
unused_mut,
unused_qualifications,
while_true,
)]
extern crate clap;
#[macro_use] extern crate version;
#[cfg(test)]
extern crate toml;
mod ui;
use std::fs::OpenOptions;
use std::io::Write;
use std::path::PathBuf;
use std::path::Path;
use std::process::Command;
const CONFIGURATION_STR : &'static str = include_str!("../../../../imagrc.toml");
const GITIGNORE_STR : &'static str = r#"
# We ignore the imagrc.toml file by default
#
# That is because we expect the user to put
# this dotfile into his dotfile repository
# and symlink it here.
# If you do not do this, feel free to remove
# this line from the gitignore and add the
# configuration to this git repository.
imagrc.toml
"#;
fn main() {
let app = ui::build_ui();
let matches = app.get_matches();
let path = matches
.value_of("path")
.map(String::from)
.map(PathBuf::from)
.unwrap_or_else(|| {
::std::env::var("HOME")
.map(PathBuf::from)
.map(|mut p| { p.push(".imag"); p })
.map(|path| if path.exists() {
println!("Path '{:?}' already exists!", path);
println!("Cannot continue.");
::std::process::exit(1)
} else {
path
})
.expect("Failed to retrieve/build path for imag directory.")
});
let _ = ::std::fs::create_dir_all(path.clone())
.expect("Failed to create directory");
let config_path = {
let mut config_path = path.clone();
config_path.push("imagrc.toml");
config_path
};
let _ = OpenOptions::new()
.write(true)
.create(true)
.open(config_path)
.map(|mut f| {
let content = if matches.is_present("devel") {
get_config_devel()
} else {
get_config()
};
let _ = f.write_all(content.as_bytes())
.expect("Failed to write complete config to file");
})
.expect("Failed to open new configuration file");
if find_command("git").is_some() && !matches.is_present("nogit") {
// we initialize a git repository
println!("Going to initialize a git repository in the imag directory...");
let gitignore_path = {
let mut gitignore_path = path.clone();
gitignore_path.push(".gitignore");
gitignore_path.to_str().map(String::from).expect("Cannot convert path to string")
};
let _ = OpenOptions::new()
.write(true)
.create(true)
.open(gitignore_path.clone())
.map(|mut f| {
let _ = f.write_all(GITIGNORE_STR.as_bytes())
.expect("Failed to write complete gitignore to file");
})
.expect("Failed to open new configuration file");
let path_str = path.to_str().map(String::from).expect("Cannot convert path to string");
let worktree = format!("--work-tree={}", path_str);
let gitdir = format!("--git-dir={}", path_str);
{
let output = Command::new("git")
.args(&[&worktree, &gitdir, "--no-pager", "init"])
.output()
.expect("Calling 'git init' failed");
if output.status.success() {
println!("{}", String::from_utf8(output.stdout).expect("No UTF-8 output"));
println!("'git {} {} --no-pager init' succeeded", worktree, gitdir);
} else {
println!("{}", String::from_utf8(output.stderr).expect("No UTF-8 output"));
::std::process::exit(output.status.code().unwrap_or(1));
}
}
{
let output = Command::new("git")
.args(&[&worktree, &gitdir, "--no-pager", "add", &gitignore_path])
.output()
.expect("Calling 'git add' failed");
if output.status.success() {
println!("{}", String::from_utf8(output.stdout).expect("No UTF-8 output"));
println!("'git {} {} --no-pager add {}' succeeded", worktree, gitdir, gitignore_path);
} else {
println!("{}", String::from_utf8(output.stderr).expect("No UTF-8 output"));
::std::process::exit(output.status.code().unwrap_or(1));
}
}
{
let output = Command::new("git")
.args(&[&worktree, &gitdir, "--no-pager", "commit", &gitignore_path, "-m", "'Initial import'"])
.output()
.expect("Calling 'git commit' failed");
if output.status.success() {
println!("{}", String::from_utf8(output.stdout).expect("No UTF-8 output"));
println!("'git {} {} --no-pager commit {} -m 'Initial import'' succeeded", worktree, gitdir, gitignore_path);
} else {
println!("{}", String::from_utf8(output.stderr).expect("No UTF-8 output"));
::std::process::exit(output.status.code().unwrap_or(1));
}
}
println!("git stuff finished!");
} else {
println!("No git repository will be initialized");
}
println!("Ready. Have fun with imag!");
}
fn get_config() -> String {
get_config_devel()
.replace(
r#"level = "debug""#,
r#"level = "info""#
)
}
fn get_config_devel() -> String {
String::from(CONFIGURATION_STR)
}
fn find_command<P: AsRef<Path>>(exe_name: P) -> Option<PathBuf> {
::std::env::var_os("PATH")
.and_then(|paths| {
::std::env::split_paths(&paths)
.filter_map(|dir| {
let full_path = dir.join(&exe_name);
if full_path.is_file() {
Some(full_path)
} else {
None
}
})
.next()
})
}
#[cfg(test)]
mod tests {
use toml::from_str;
use toml::Value;
use super::get_config;
use super::get_config_devel;
#[test]
fn test_config() {
assert!(from_str::<Value>(&get_config()[..]).is_ok());
assert!(from_str::<Value>(&get_config_devel()[..]).is_ok());
}
}

49
bin/core/imag-init/src/ui.rs Normal file
View file

@ -0,0 +1,49 @@
//
// imag - the personal information management suite for the commandline
// Copyright (C) 2015, 2016 Matthias Beyer <mail@beyermatthias.de> and contributors
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; version
// 2.1 of the License.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
//
use clap::{Arg, App};
pub fn build_ui<'a>() -> App<'a, 'a> {
App::new("imag-init")
.version(&version!()[..])
.author("Matthias Beyer <mail@beyermatthias.de>")
.about("Initialize a ~/.imag repository. Optionally with git")
.arg(Arg::with_name("devel")
.long("dev")
.takes_value(false)
.required(false)
.multiple(false)
.help("Put dev configuration into the generated repo (with debugging enabled)"))
.arg(Arg::with_name("nogit")
.long("no-git")
.takes_value(false)
.required(false)
.multiple(false)
.help("Do not initialize git repository, even if 'git' executable is in $PATH"))
.arg(Arg::with_name("path")
.long("path")
.takes_value(true)
.required(false)
.multiple(false)
.help("Alternative path where to put the repository. Default: ~/.imag"))
}

9
doc/src/04020-module-init.md Normal file
View file

@ -0,0 +1,9 @@
## Init {#sec:modules:init}
This is the only `imag-*` command which does _not_ set up a runtime and check
whether the store is available. This command can be used to set up a imag store.
It also puts a default configuration in the right place and initializes a git
repository, if there is a `git` command in `$PATH` (via calling git on the
commandline, not via `libgit2` or some other library).