kamisaku 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9fdf1df53449c244e517a611ec8c4f86d70f177d7a1915510673ed284e459862
-  data.tar.gz: c46cb9fdd46698f10a9ace7d982973156fc9d8f456a476ce3f60419bf6eb01e4
+  metadata.gz: d645fc6767b17f9d9d44e95336bf7d962b5d4e997b9f336e9ea787a8fdef86dc
+  data.tar.gz: 78b4d15cfbe0a405f6b9fc10569449e8d30bda716225da87e2e93b6a0b74f2e6
 SHA512:
-  metadata.gz: dc698661abf790c25d7d4c76b20379087c044ccc5bd12029558e28055ac9c58a9abd78484b7468ec52d1f990892dba0d37abac0ae39f6c24404b6e02bec7ede4
-  data.tar.gz: 01102145a9e37cc5a5db0e49423da90491204bbed1279be82f7f70a0c1981e5e67ba6bcb5f74045c2b0dd19f809196b29e693a46317e2d0628e283bf99a1ba6f
+  metadata.gz: 2a2b50652ea5854526cb11de2f81d630fa5f059f5a92277d3873846eb5bcf9225e59092c23225773ca651b38eb642746a5a3dc03e9999db23506722477fcc575
+  data.tar.gz: ea7c2af4a32411ef9b469a4381fc62fa3ad8f4a5ab4b82a40baa3f163dd5910988fbd6d483f03b0b08c9a869e70d7e4dc3c0aec7b43610df3926826e8f693b9f

data/CHANGELOG.md

@@ -13,7 +13,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Removed
 
-## [0.1.2] - 2025-05-25
+## [0.2.0] - 2025-05-24
+
+### Added
+- Soft removing metadata in generated PDF using `exiftool`
+
+## [0.1.2] - 2025-05-24
 
 ### Changed
 

data/README.md

@@ -68,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
 
@@ -79,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:
 

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.2"
+  VERSION = "0.2.0"
 end

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.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Sinaru Gunawardena
@@ -45,6 +45,7 @@ files:
 - 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