kamisaku 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 507f3a1b5ae9e613a6d26a63d7cf1035b2cc042f43d03bfabab971eb7fc93256
-  data.tar.gz: a7dee35db16af4ecd7db3a7ca6a5169698b2ca5ba2732a7f01d816d1cba5c80c
+  metadata.gz: d645fc6767b17f9d9d44e95336bf7d962b5d4e997b9f336e9ea787a8fdef86dc
+  data.tar.gz: 78b4d15cfbe0a405f6b9fc10569449e8d30bda716225da87e2e93b6a0b74f2e6
 SHA512:
-  metadata.gz: 806c66f84059a485ce933442dd7f23395b2754f1674edb94902573fd8e33be9522e2ff113f01a4cf09ef98d8e88fa0a56e1f168edb20ce3666608e2729ff6eb3
-  data.tar.gz: d5c7195770bc8c56ae2705a35af549a89d642a7661334f01ac82d704aba74e13b0a1746592dec422a51a22b151104324a48845fa7c4ae217656a343373db7a44
+  metadata.gz: 2a2b50652ea5854526cb11de2f81d630fa5f059f5a92277d3873846eb5bcf9225e59092c23225773ca651b38eb642746a5a3dc03e9999db23506722477fcc575
+  data.tar.gz: ea7c2af4a32411ef9b469a4381fc62fa3ad8f4a5ab4b82a40baa3f163dd5910988fbd6d483f03b0b08c9a869e70d7e4dc3c0aec7b43610df3926826e8f693b9f

data/CHANGELOG.md

@@ -12,3 +12,27 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Changed
 
 ### Removed
+
+## [0.2.0] - 2025-05-24
+
+### Added
+- Soft removing metadata in generated PDF using `exiftool`
+
+## [0.1.2] - 2025-05-24
+
+### Changed
+
+- Update the paper template contact section so that the separator is not applied to the last item.
+
+## [0.1.1] - 2025-05-24
+
+### Changed
+
+- Fix changelog URI in gemspec.
+
+## [0.1.0] - 2025-05-24
+
+### Added
+
+- Initial release.
+- Support for two themes.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    kamisaku (0.1.0)
+    kamisaku (0.1.2)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -2,6 +2,8 @@
 
 *Build a CV PDF from a yaml text file.*
 
+[![Gem Version](https://badge.fury.io/rb/kamisaku.svg)](https://badge.fury.io/rb/kamisaku)
+
 ![Kamisaku](kamisaku.png)
 
 See [examples](/examples) directory for sample generated PDF files based of [templates](/lib/templates).
@@ -66,7 +68,9 @@ education:
     achievements:
       - # Things you have achieved or did
 ```
-See [examples](/examples) directory for sample generated PDF files based of [templates](/lib/templates).
+
+## Template
+For a list of templates availble for CV generation, check the [examples](/examples) directory where each directory name is a template name.
 
 ## Installation
 
@@ -77,6 +81,8 @@ This is a Ruby gem. So you can either install as a gem or clone the repo and use
 - Ensure that [Google Chrome](https://www.google.com/chrome/) is installed.
 - Chrome must be accessible from the terminal as `google-chrome`.
   - Kamisaku uses Chrome's [headless mode](https://developer.chrome.com/docs/chromium/headless/) to generate PDF files.
+- Ensure `exiftool` is installed available in command line.
+  - exiftool is used to soft remove metadata added by chrome in the PDF file.
 
 Add this line to your application's Gemfile:
 
@@ -100,7 +106,7 @@ $ gem install kamisaku
 Once you have the YAML text file, feed it into the `bin/console` and specify the output location.
 
 ```bash
-bin/console -c examples/john_doe.yml -o examples/plain/john_doe.pdf  -t plain
+bin/console -c examples/paper/john_doe.yml -o examples/paper/john_doe.pdf  -t paper
 ```
 
 #### Bash options

data/examples/sleek/john_doe.yml

@@ -0,0 +1,157 @@
+version: 1
+
+profile:
+  name: John Doe
+  title: Senior Software Engineer
+  about: >
+    Seasoned software engineer with more than a decade of experience
+    in designing and developing scalable web applications. Passionate
+    about building clean, maintainable code and driving best practices
+    in software development. Experienced in leading teams, mentoring
+    developers, and collaborating with cross-functional teams to deliver
+    high-quality solutions.
+
+contact:
+  github: johndoe
+  mobile: +44 7912345678
+  website: https://johndoe.dev
+  email: john.doe@example.com
+  linkedin: john-doe
+  location:
+    country: United Kingdom
+    city: London
+
+skills:
+  - area: Development
+    items:
+      - Python
+      - Django
+      - ReactJS
+      - TypeScript
+      - Node.js
+  - area: Database
+    items:
+      - PostgreSQL
+      - MySQL
+      - Redis
+  - area: Testing
+    items:
+      - PyTest
+      - Jest
+      - Cypress
+      - Selenium
+  - area: Version Control
+    items:
+      - Git
+      - GitHub
+      - GitLab
+  - area: Platforms/OS
+    items:
+      - AWS
+      - Google Cloud
+      - Linux
+
+interests:
+  - Yoga
+  - Travelling
+  - Photography
+  - Hiking
+  - Chess
+  - Reading
+  - Cooking
+  - Gardening
+  - Running
+  - Fitness
+  - Volunteering
+
+experiences:
+  - title: Senior Software Engineer
+    organisation: CloudCore Solutions
+    location:
+      city: London
+      country: United Kingdom
+    from:
+      month: 3
+      year: 2021
+    skills:
+      - Django
+      - React
+      - GraphQL
+      - AWS Lambda
+      - PostgreSQL
+      - Docker
+      - Terraform
+    achievements:
+      - >
+        Led the migration from a monolithic system to a microservices
+        architecture, significantly improving scalability and performance.
+      - >
+        Designed and implemented a serverless data processing pipeline
+        using AWS Lambda and S3, reducing operational costs by 30%.
+      - Established CI/CD workflows for automated deployments and testing.
+
+  - title: Lead Backend Engineer
+    organisation: FinEdge Technologies
+    location:
+      city: Manchester
+      country: United Kingdom
+    from:
+      month: 5
+      year: 2018
+    to:
+      month: 2
+      year: 2021
+    skills:
+      - Python
+      - FastAPI
+      - PostgreSQL
+      - Redis
+      - Kafka
+      - Kubernetes
+      - Jenkins
+    achievements:
+      - >
+        Spearheaded the development of a real-time financial analytics
+        platform, handling millions of transactions per second.
+      - >
+        Improved API response times by optimizing database queries and
+        implementing Redis caching.
+      - Led a team of backend engineers, conducting code reviews and
+        mentoring junior developers.
+
+  - title: Software Engineer
+    organisation: NextGen Media
+    location:
+      city: Birmingham
+      country: United Kingdom
+    from:
+      month: 7
+      year: 2015
+    to:
+      month: 4
+      year: 2018
+    skills:
+      - Node.js
+      - Express.js
+      - MongoDB
+      - WebSockets
+      - AWS
+    achievements:
+      - Developed a high-traffic video streaming platform, implementing
+        WebSockets for real-time interactions.
+      - Built a recommendation engine using machine learning models to
+        personalize user content.
+      - Automated deployment processes with AWS CodePipeline and Docker.
+
+education:
+  - institute: Brighton Institute of Technology
+    location:
+      city: Brighton
+      country: United Kingdom
+    qualification: Bachelor of Science in Computer Science
+    field: Software Engineering
+    to:
+      month: 5
+      year: 2013
+    achievements:
+      - Awarded a scholarship for outstanding academic performance.

data/lib/kamisaku/cv_generator.rb

@@ -18,6 +18,7 @@ module Kamisaku
       generated_html_file do |file_path|
         FileUtils.cp(file_path, html_location) if html_location
         html_file_to_pdf_file(file_path, pdf_location)
+        soft_remove_metadata_from_pdf_file(pdf_location)
       end
     end
 
@@ -35,6 +36,13 @@ module Kamisaku
       raise "PDF generation failed" unless File.exist?(pdf_file_path)
     end
 
+    def soft_remove_metadata_from_pdf_file(file_path)
+      command = <<~CMD
+        exiftool -all= #{file_path} -overwrite_original
+      CMD
+      system(command)
+    end
+
     def generated_html_file
       temp_html_file = Tempfile.new(%w[kamisaku .html])
       temp_html_file.write(cv_html)

data/lib/kamisaku/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Kamisaku
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/lib/templates/{plain → paper}/template.html.erb

@@ -167,6 +167,10 @@
               font-size: 16pt;
               font-weight: 400;
               font-family: "Garamond";
+
+              a:not(:last-child)::after {
+                  content: " |";
+              }
           }
       }
 
@@ -286,20 +290,23 @@
   <div class="name bottom-ruler"><%= dig :profile, :name %></div>
   <div class="contact">
     <% if has? :contact, :email %>
-      <a href="mailto:<%= dig :contact, :email %>"><%= dig :contact, :email %></a> |
+      <a href="mailto:<%= dig :contact, :email %>"><%= dig :contact, :email %></a>
     <% end %>
     <% if has? :contact, :mobile %>
-      <a href="tel:<%= dig :contact, :mobile %>"><%= dig :contact, :mobile %></a> |
+      <a href="tel:<%= dig :contact, :mobile %>"><%= dig :contact, :mobile %></a>
     <% end %>
     <% if has?(:contact, :location, :city) || has?(:contact, :location, :country) %>
-      <%= dig :contact, :location, :city %>, <%= dig :contact, :location, :country %> |
+      <%= dig :contact, :location, :city %>, <%= dig :contact, :location, :country %>
     <% end %>
     <% if has? :contact, :website %>
-      <a href="<%= dig :contact, :website %>"><%= dig :contact, :website %></a> |
+      <a href="<%= dig :contact, :website %>"><%= dig :contact, :website %></a>
     <% end %>
     <% if has? :contact, :github %>
       <a href="https://github.com/<%= dig :contact, :github %>">github.com/<%= dig :contact, :github %></a>
     <% end %>
+    <% if has? :contact, :linkedin %>
+      <a href="https://linkedin.com/in/<%= dig :contact, :linkedin %>">linkedin.com/in/<%= dig :contact, :linkedin %></a>
+    <% end %>
   </div>
 </div>
 

data/template.yml

@@ -0,0 +1,59 @@
+# Template structure for CV. The content should be in YAML format.
+# If you are not familiar with YAML, refer: https://devhints.io/yaml
+# Some hints:
+# - comments start with "#"
+
+version: 1
+profile:
+  name: # Your name
+  title: # Your current job title
+  about: # Some sleek details about your experience
+
+contact:
+  github: # Github username
+  mobile: # Mobile number
+  email: # email address
+  linkedin: # Linkedin username
+  location:
+    country: # country name
+    city: # city name
+
+skills:
+  - area: # specific skill area you are specialized in
+    items:
+      - # sub item such as a technology you have the skill in under the specialized area
+
+experiences:
+  - title: # job title
+    organisation: # Name of the place you worked
+    location:
+      city: # city name
+      country: # country name
+    from:
+      month: # month integer number that you started
+      year: # year integer number that you started
+    # if following is not given, it is assumed you are still working
+    to:
+      month: # month integer number that you stopped
+      year: # year integer number that you stopped
+    skills:
+      - # a short name for a specialized skilled you gained
+    achievements:
+      - # Things you have achieved or did as a sentence. Consider reflecting the impact it made.
+
+education:
+  - institute: # name of the place you studied
+    location:
+      city: # city name
+      country: # country name
+    qualification: # name of the degree/diploma qualification
+    field: # name of the field such as Computer Science
+    from:
+      month: # month integer number that you started
+      year: # year integer number that you started
+    # if following is not given, it is assumed you are still studying
+    to:
+      month: # month integer number that you stopped
+      year: # year integer number that you stopped
+    achievements:
+      - # Things you have achieved or did

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kamisaku
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Sinaru Gunawardena
@@ -25,9 +25,10 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- examples/john_doe.yml
-- examples/plain/john_doe.pdf
+- examples/paper/john_doe.pdf
+- examples/paper/john_doe.yml
 - examples/sleek/john_doe.pdf
+- examples/sleek/john_doe.yml
 - kamisaku.png
 - lib/kamisaku.rb
 - lib/kamisaku/arg_parser.rb
@@ -41,9 +42,10 @@ files:
 - lib/kamisaku/cv_generator.rb
 - lib/kamisaku/meta_file_parser.rb
 - lib/kamisaku/version.rb
-- lib/templates/plain/template.html.erb
+- lib/templates/paper/template.html.erb
 - lib/templates/sleek/template.html.erb
 - sig/kamisaku.rbs
+- template.yml
 homepage: https://github.com/sinaru/kamisaku
 licenses:
 - MIT