💡 Add documentation

Author: DevHyperCoder

src/commands.rs

@@ -1,51 +1,23 @@
 use super::config::Config;
-use super::data::get_data_file_path;
 use super::data::{Bookmark, Data};
-use super::parser::*;
-use chrono::prelude::Local;
-use regex::Regex;
-use std::fs;
-use substring::Substring;
-
-fn generate_name(link: &String, config: Config) -> String {
-    let mut name = config.name.unwrap_or("".to_owned());
 
-    // If name is not provided, use the domain name
-    // If provided, replace ' ' with '_'
-    if name == "" {
-        let m = get_name(&link);
-        name = link.substring(m.start(), m.end()).to_owned();
-    } else {
-        name = name.replace(' ', "_");
-    }
-
-    return name;
-}
-
-fn generate_bookmark(id:u32,link: String, name: String) -> Bookmark {
-    Bookmark {
-        is_file: !is_url(&link),
-        link: link,
-        name: name,
-        date: Local::now().to_string(),
-        id: id,
-    }
-}
+use regex::Regex;
 
+/// Insert commands
+/// Adds the bookmark to the data list and increments the last id
 pub fn insert(input: String, mut data: Data, config: Config) {
-    let name = generate_name(&input, config);
+    let name = Bookmark::generate_name(&input, config.name);
 
-    let bookmark = generate_bookmark(data.last_id+1, input, name);
+    let bookmark = Bookmark::generate_bookmark(data.last_id + 1, input, name);
     data.bookmarks.push(bookmark);
     data.last_id += 1;
 
-    fs::write(
-        get_data_file_path(),
-        serde_json::to_string_pretty(&data).unwrap(),
-    )
-    .unwrap();
+    data.write_to_file();
 }
 
+/// List command
+/// List all the bookmarks if no name flag was provided
+/// List bookmarks that match the regex provided in name flag
 pub fn list(data: Data, config: Config) {
     let name = config.name.unwrap_or("".to_owned());
 
@@ -67,6 +39,7 @@ pub fn list(data: Data, config: Config) {
     print_bookmark(&search_results);
 }
 
+/// Print all bookmarks in the vector
 fn print_bookmark(input: &Vec<Bookmark>) {
     for i in input {
         println!("{}", i);

src/data.rs

@@ -2,6 +2,10 @@ use home::home_dir;
 use serde::{Deserialize, Serialize};
 use std::fmt;
 use std::fs;
+use substring::Substring;
+use chrono::prelude::Local;
+
+use super::parser::{is_url,get_domain_name};
 
 #[derive(Serialize, Deserialize, Debug)]
 pub struct Bookmark {
@@ -12,6 +16,37 @@ pub struct Bookmark {
     pub id: u32,
 }
 
+impl Bookmark {
+    /// Generate a suitable name for Bookmark
+    /// If name is empty or not provided, link is parsed to get the domain name.
+    /// If name contains spaces, it is converted to underscores
+    pub fn generate_name(link: &String, name: Option<String>) -> String {
+        let mut name = name.unwrap_or("".to_owned());
+
+        // If name is not provided, use the domain name
+        // If provided, replace ' ' with '_'
+        if name == "" {
+            let m = get_domain_name(&link);
+            name = link.substring(m.start(), m.end()).to_owned();
+        } else {
+            name = name.replace(' ', "_");
+        }
+
+        return name;
+    }
+
+    /// Return bookmark with values
+    pub fn generate_bookmark(id: u32, link: String, name: String) -> Bookmark {
+        Bookmark {
+            is_file: !is_url(&link),
+            link: link,
+            name: name,
+            date: Local::now().to_string(),
+            id: id,
+        }
+    }
+}
+
 impl fmt::Display for Bookmark {
     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
         write!(f, "{} {} {}", self.id, self.name, self.link)
@@ -24,6 +59,19 @@ pub struct Data {
     pub last_id: u32,
 }
 
+impl Data {
+    /// Prettify the json and write to file
+    pub fn write_to_file(&self) {
+        fs::write(
+            get_data_file_path(),
+            serde_json::to_string_pretty(&self).unwrap(),
+        )
+        .unwrap();
+    }
+}
+
+/// Create data directory and data file.data
+/// Write a barebones JSON to the data file
 pub fn create_data_file() {
     let data_dir = home_dir().unwrap().join(".local/share/rbmenu/");
     let data_file = data_dir.join("bookmark.json");
@@ -36,11 +84,15 @@ pub fn create_data_file() {
         fs::File::create(&data_file).unwrap();
     }
 
-    let data = Data { bookmarks: vec![] ,last_id: 0};
+    let data = Data {
+        bookmarks: vec![],
+        last_id: 0,
+    };
 
     fs::write(data_file, serde_json::to_string_pretty(&data).unwrap()).unwrap();
 }
 
+/// Read and parse data file into Data struct
 pub fn read_data_file() -> Data {
     let data_file = get_data_file_path();
 
@@ -52,6 +104,7 @@ pub fn read_data_file() -> Data {
     serde_json::from_str(&content).unwrap()
 }
 
+/// Return data file path
 pub fn get_data_file_path() -> std::path::PathBuf {
     home_dir()
         .unwrap()

src/lib.rs

@@ -10,6 +10,7 @@ use data::read_data_file;
 use std::io::stdin;
 use structopt::StructOpt;
 
+/// Call command functions based on given options
 pub fn run() {
     let opts = Config::from_args();
     let data = read_data_file();

src/parser.rs

@@ -1,11 +1,15 @@
 use regex::Regex;
 
+/// Use regex to check if the given str is a URL
+/// input : link to check against
 pub fn is_url(input: &str) -> bool {
     let re = Regex::new( r"^(http://www\.|https://www.|http://|https://)?[a-z0-9]+([-.]{1}[a-z0-9]+)*.[a-z]{2,5}(:[0-9]{1,5})?(/.*)?$").unwrap();
     re.is_match(&input)
 }
 
-pub fn get_name(input: &str) -> regex::Match {
+/// Use regex to get the domain name and subdomains from the given URL
+/// input : link to get the domain and subdomains
+pub fn get_domain_name(input: &str) -> regex::Match {
     let re = Regex::new(r".*://(?:www.)?([^/]+)").unwrap();
     re.captures(&input).unwrap().get(1).unwrap()
 }