kamisaku 0.1.2 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9fdf1df53449c244e517a611ec8c4f86d70f177d7a1915510673ed284e459862
-  data.tar.gz: c46cb9fdd46698f10a9ace7d982973156fc9d8f456a476ce3f60419bf6eb01e4
+  metadata.gz: c810e820b25f0105dcd4bda49ea0de6aa29a9d802079105fc6ee8b6f055d39e5
+  data.tar.gz: 63a00b823e8881454a73a660f4e74b0c467c0cf2e1cdc49af37bff7ec70221a5
 SHA512:
-  metadata.gz: dc698661abf790c25d7d4c76b20379087c044ccc5bd12029558e28055ac9c58a9abd78484b7468ec52d1f990892dba0d37abac0ae39f6c24404b6e02bec7ede4
-  data.tar.gz: 01102145a9e37cc5a5db0e49423da90491204bbed1279be82f7f70a0c1981e5e67ba6bcb5f74045c2b0dd19f809196b29e693a46317e2d0628e283bf99a1ba6f
+  metadata.gz: d0a4b2ff2d49eeafaaae02f00a7d7765ffd0958eca484047deea258b06e3a914ac5a9dc66bc590b564b2296874c4ee3706a5e3acd8ddca98cb1c5a4a94c7c2bc
+  data.tar.gz: 16afe349ee8f3696d08eca40f98241a5d05f6e647790fb9596c6b1eaf42d4597ace2cd42c3383658fbe39ebbbc6dc6a937a669b5e9c2dbc1f14bd4089e6acb88

data/CHANGELOG.md

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

data/Gemfile

@@ -14,6 +14,3 @@ gem "minitest", "~> 5.0"
 gem "rubocop", "1.57.2", require: false
 gem "rubocop-rake", "~> 0.6.0"
 gem "rubocop-minitest", "~> 0.33.0"
-
-gem "prawn"
-gem "pdfkit"

data/Gemfile.lock

@@ -1,27 +1,19 @@
 PATH
   remote: .
   specs:
-    kamisaku (0.1.2)
+    kamisaku (0.2.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.3)
-    bigdecimal (3.1.9)
     json (2.12.0)
     language_server-protocol (3.17.0.5)
-    matrix (0.4.2)
     minitest (5.25.5)
     parallel (1.27.0)
     parser (3.3.8.0)
       ast (~> 2.4.1)
       racc
-    pdf-core (0.10.0)
-    pdfkit (0.8.7.3)
-    prawn (2.5.0)
-      matrix (~> 0.4)
-      pdf-core (~> 0.10.0)
-      ttfunk (~> 1.8)
     prism (1.4.0)
     racc (1.8.1)
     rainbow (3.1.1)
@@ -47,8 +39,6 @@ GEM
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
     ruby-progressbar (1.13.0)
-    ttfunk (1.8.0)
-      bigdecimal (~> 3.1)
     unicode-display_width (2.6.0)
 
 PLATFORMS
@@ -58,8 +48,6 @@ PLATFORMS
 DEPENDENCIES
   kamisaku!
   minitest (~> 5.0)
-  pdfkit
-  prawn
   rake (~> 13.0)
   rubocop (= 1.57.2)
   rubocop-minitest (~> 0.33.0)

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/kamisaku.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative "lib/kamisaku/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "kamisaku"
+  spec.version = Kamisaku::VERSION
+  spec.authors = ["Sinaru Gunawardena"]
+  spec.email = ["sinaru@gmail.com"]
+
+  spec.summary = "Build a CV PDF from a yaml text file."
+  spec.description = "Build a CV PDF from a yaml text file."
+  spec.homepage = "https://github.com/sinaru/kamisaku"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.4.3"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/sinaru/kamisaku"
+  spec.metadata["changelog_uri"] = "https://github.com/sinaru/kamisaku/blob/main/CHANGELOG.md"
+  spec.metadata["bug_tracker_uri"] = "https://github.com/sinaru/kamisaku/issues?q=is%3Aissue%20state%3Aopen%20label%3Abug"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "bin"
+  spec.executables = spec.files.grep(%r{\Abin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/crea  ting_gem.html
+end

data/lib/kamisaku/cv_generator.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "erb"
-require "pdfkit"
 
 module Kamisaku
   class CvGenerator
@@ -18,6 +17,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 +35,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.1"
 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.1
 platform: ruby
 authors:
 - Sinaru Gunawardena
@@ -29,6 +29,7 @@ files:
 - examples/paper/john_doe.yml
 - examples/sleek/john_doe.pdf
 - examples/sleek/john_doe.yml
+- kamisaku.gemspec
 - kamisaku.png
 - lib/kamisaku.rb
 - lib/kamisaku/arg_parser.rb
@@ -45,6 +46,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