Add "highway" theme, update Readme, minor code fixes (#3)

* Add new theme, improve the "simple" theme * Update README.md, add more log output * Separate themes docs * Remove file * Clean up the code * Increase a version to v0.2.2 Co-authored-by: Serhii Cheredko <[email protected]>
SergChr · Nov 20, 2020 · 321d6b8 · 321d6b8
1 parent 48598d5
commit 321d6b8
Show file tree

Hide file tree

Showing 12 changed files with 158 additions and 11 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "qcv"
-version = "0.2.0"
+version = "0.2.2"
 authors = ["SergChr <[email protected]>"]
 edition = "2018"
 license = "MIT"

diff --git a/README.md b/README.md
@@ -1,6 +1,13 @@
 `qcv` is a tool to generate HTML resume from JSON template.
 ![img](https://travis-ci.com/SergChr/qcv.svg?token=2R5NQSKq8dFxzneyxJie&branch=master)
 
+## Content
+- [Use cases](#use-cases)
+- [How does it work](#how-does-it-work)
+- [List of the available themes](/src/assets/themes/README.md)
+- [Custom HTML themes](#custom-html-themes)
+- **[How to install](#installing)**
+
 ## Use cases
 #### Keeping a JSON resume in Git
 The tool allows to have one JSON file where the resume information placed. It can be stored in a `git` repository to make the updating process more seamless. There could be branching applied for different versions; the diffs are more simpler to track.
@@ -10,7 +17,7 @@ No more `CV_1.pdf`, `CV_1_updated.pdf`, `CV_1_updated_for_facebook.pdf`.
 No need to move between different services that generate a resume or/and store it.
 
 #### Generating a simple portfolio website
-The tool generates a HTML file based on a HTML template that can be customizable.
+The tool generates a HTML file based on a HTML template that can be customized.
 
 ## How does it work
 The tool replaces variables in a HTML template (see `src/assets/themes`) with corresponding values in the JSON template. Example:
@@ -85,6 +92,9 @@ This is the JSON template example below. It will be generated by the `init` comm
 ```
 Put your information into this file. Then use the `build simple` command to generate the `cv.html` output.
 
+## Available themes
+See [themes documentation](/src/assets/themes/README.md)
+
 ## Custom HTML themes
 There is an ability to build your custom HTML template and generate a resume from it. Example:
 ```sh

diff --git a/src/assets/themes/README.md b/src/assets/themes/README.md
@@ -0,0 +1,12 @@
+## Available themes
+Usage:
+```sh
+$ qcv build <theme_name>
+# See theme names below
+# e.g. qcv build simple
+```
+#### Simple
+![Simple](/src/assets/themes/simple/simple.png "Simple")
+
+#### Highway
+![Highway](/src/assets/themes/highway/highway.png "Highway")
diff --git a/src/assets/themes/highway/highway.png b/src/assets/themes/highway/highway.png
diff --git a/src/assets/themes/highway/index.html b/src/assets/themes/highway/index.html
@@ -0,0 +1,96 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+
+<head>
+     <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
+
+     <title>{{basics.name}}'s resume</title>
+     <link href="https://unpkg.com/tailwindcss@^1.0/dist/tailwind.min.css" rel="stylesheet">
+     <style type="text/css">
+        * { margin: 0; padding: 0; }
+     </style>
+</head>
+
+<body class="h-screen">
+    <div class="flex flex-col md:flex-row bg-gray-900 h-full py-8">
+        <div class="flex-1 text-gray-700 justify-start flex-col h-auto mx-3">
+            <div class="bg-gray-100 w-full h-auto mb-5 rounded-md p-5 leading-9">
+                <div class="font-bold text-4xl">{{basics.name}}</div>
+                <div class="text-xl text-gray-600">{{basics.label}}</div>
+                <hr class="my-5">
+                <div class="font-light">{{basics.location.address}} {{basics.location.city}}, {{basics.location.country}}</div>
+                <div class="font-light">
+                    <a href="mailto:{{basics.email}}">{{basics.email}}</a>
+                    | {{basics.phone}}
+                    <br>
+                    <a href="{{basics.website}}" class="underline">{{basics.website}}</a>
+                </div>
+                <hr class="my-4">
+                <div>
+                    {!basics.profiles
+                        <a class="font-light mx-2" href="{url}">{network}:{username}</a>
+                    !}
+                </div>
+            </div>
+
+            <div class="bg-gray-100 w-full h-auto mb-5 rounded-md p-5">
+                <div class="font-light leading-9">{{basics.summary}}</div>
+                <hr class="my-4">
+
+                <div class="flex">
+                    {!skills
+                        <div class="text-sm bg-gray-800 p-2 text-gray-100 rounded-md mx-2">{name}</div>
+                    !}
+                </div>
+
+                <hr class="my-4">
+                <div class="font-light">Languages</div>
+                {!languages
+                    <div class="flex flex-col px-4 py-2 m-2">
+                        <div class="font-bold">{language}</div>
+                        <div class="font-light">{level}</div>
+                    </div>
+                !}
+            </div>
+        </div>
+
+        <div class="flex-1 text-gray-700 justify-start flex-col h-auto mx-3">
+            <div class="bg-gray-100 w-full h-auto mb-5 rounded-md p-5 leading-7">
+                <div class="text-lg">Education</div>
+                <hr class="my-4">
+                {!education
+                    <div class="font-bold uppercase">{institution}</div>
+                    <div class="font-thin text-xs my-1">{location}</div>
+                    <div>{area} - {study_type} | {start_date} - {end_date}</div>
+                !}
+            </div>
+
+            <div class="bg-gray-100 w-full h-auto mb-5 rounded-md p-5 leading-7">
+                <div class="text-lg">Work experience</div>
+                <hr class="my-4">
+                {!work
+                    <a href="{website}" class="font-bold uppercase">{company}</a>
+                    <div class="font-thin my-1">{position} | {start_date} - {end_date}</div>
+                    <div>{summary}</div>
+                    <hr class="my-4">
+                !}
+            </div>
+        </div>
+
+        <div class="flex-1 text-gray-700 justify-start flex-col h-auto mx-3">
+            <div class="bg-gray-100 w-full h-auto mb-5 rounded-md p-5 leading-7">
+                <div class="text-lg">Projects</div>
+                <hr class="my-4">
+                {!projects
+                    <div class="font-bold">{name}</div>
+                    <div class="font-light text-sm">{description}</div>
+                !}
+            </div>
+        </div>
+
+    </div>
+</body>
+
+</html>
diff --git a/src/assets/themes/simple/index.html b/src/assets/themes/simple/index.html
@@ -15,10 +15,10 @@
 
 <body class="flex justify-center font-sans bg-gray-100">
     <div class="main flex flex-col p-1 w-9/12 bg-white rounded-sm p-6 shadow-sm">
-        <section id="header">
+        <section id="header" class="leading-8">
             <div class="font-bold text-2xl">{{basics.name}}</div>
             <div>{{basics.label}}</div>
-            <div class="font-light">{{basics.location.address}}, {{basics.location.city}}, {{basics.location.country}}</div>
+            <div class="font-light">{{basics.location.address}} {{basics.location.city}}, {{basics.location.country}}</div>
             <div class="font-light">
                 <a href="mailto:{{basics.email}}">{{basics.email}}</a>
                 | {{basics.phone}}
@@ -52,6 +52,7 @@
                 <a href="{website}" class="font-bold uppercase">{company}</a>
                 <div class="font-thin my-1">{position} | {start_date} - {end_date}</div>
                 <div>{summary}</div>
+                <div class="m-8"></div>
             !}
         </section>
 
@@ -70,7 +71,7 @@
 
         <section id="skills" class="p-4 flex">
             {!skills
-                <div class="text-sm bg-gray-600 p-2 text-gray-200 rounded-sm">{name}</div>
+                <div class="text-sm bg-gray-600 p-2 text-gray-200 rounded-sm mx-1">{name}</div>
             !}
         </section>
 

diff --git a/src/assets/themes/simple/simple.png b/src/assets/themes/simple/simple.png
diff --git a/src/cli/mod.rs b/src/cli/mod.rs
@@ -1,8 +1,10 @@
 use std::fs;
 use std::io::prelude::*;
 use rust_embed::RustEmbed;
+use std::path::Path;
 
 use crate::parser;
+use crate::utils::logger;
 
 const JSON_FILE_NAME: &str = "cv.json";
 const OUTPUT_HTML_FILE_NAME: &str = "cv.html";
@@ -45,7 +47,7 @@ fn create_json() {
             Ok(f) => f,
             Err(_err) => panic!("Cannot create a JSON file. Probably it already exists.")
         };
-    println!("File created.");
+    logger::write("File created.");
     let template = Asset::get("cv_template.json")
         .expect("Cannot read the CV template file");
     file.write(&template)
@@ -77,7 +79,19 @@ fn cmd_build() {
 fn build_from_template(html: &str) {
     let resume = parser::extract_resume(JSON_FILE_NAME);
     let result = parser::replace_html_vars(html, resume);
+    let write_file = || {
+        fs::write(OUTPUT_HTML_FILE_NAME, result)
+            .expect("Cannot write the result to html file");
+        logger::write("Successfully created HTML(see cv.html).");
+    };
 
-    fs::write(OUTPUT_HTML_FILE_NAME, result)
-        .expect("Cannot write the result to html file");
+    let is_html_exists = Path::new(OUTPUT_HTML_FILE_NAME).exists();
+    if is_html_exists {
+        match fs::remove_file(OUTPUT_HTML_FILE_NAME) {
+            Ok(()) => write_file(),
+            Err(_e) => panic!("Cannot rewrite the HTML file"),
+        };
+    } else {
+        write_file();
+    }
 }
diff --git a/src/main.rs b/src/main.rs
@@ -1,5 +1,7 @@
 mod cli;
 mod parser;
+#[path="utils/logger.rs"]
+mod utils;
 
 extern crate regex;
 

diff --git a/src/parser/mod.rs b/src/parser/mod.rs
@@ -5,9 +5,17 @@ use regex::{Captures, Regex};
 use std::fs;
 use std::io::prelude::*;
 use structs::Resume;
+use crate::utils::logger;
 
 pub fn extract_resume(path: &str) -> Resume {
-    let mut file = fs::File::open(path).expect("Unable to read the JSON file");
+    let mut file;
+    match fs::File::open(path) {
+       Ok(f) => file = f,
+       Err(_e) => {
+            logger::write("Make sure you created 'cv.json' file in the root. Run 'qcv init'");
+            panic!("Unable to read JSON file");
+       },
+    };
     let mut content = String::new();
     file.read_to_string(&mut content)
         .expect("Unable to read the JSON file");
@@ -55,7 +63,6 @@ pub fn replace_html_vars(html: &str, resume: Resume) -> String {
 pub fn json_get(json: &serde_json::Value, key_str: &str) -> serde_json::Value {
     use serde_json::Value;
     let keys: Vec<&str> = key_str.split(".").collect();
-    eprintln!("{:?}", keys);
     let get_err_msg = |key: &str| {
         format!(
             "Invalid key used in the HTML template: \"{}\"; full path: \"{}\"",

diff --git a/src/utils/logger.rs b/src/utils/logger.rs
@@ -0,0 +1,5 @@
+pub mod logger {
+    pub fn write(m: &str) {
+        println!("{}", m);
+    }
+}