kamisaku 0.3.1 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '08311183150f22bf9897f33d7ecb93616573e99b90a49455efd27747316b3a5b'
-  data.tar.gz: b198531b11fdf5b409c1b9c39be5ca04c64a1b9174a867f38e93f7d928f534e9
+  metadata.gz: 82cbb110627e0fb58ce9d9dee310d46ee9339ad54728676ed0f4b010ad664c5e
+  data.tar.gz: e2f4b74163a6febdf4576be058a64bf051f86e59b08a2679f38251f840eda83e
 SHA512:
-  metadata.gz: 621551dfa5fa5bf482ccccf5e8fb72a7a12b2736ed397f8a813f85274f8f33db09e1ffed4d1846dbd3dbb75f2ffc7abb53dd719229c1d00946945050949517d8
-  data.tar.gz: 6434717f692966c901becca7a7573ee69ed69b63516bdf356ea826c7d27302255dad520e72ac86519b87213ade8319d3a064de0f9991c5cf69f3242a3918aa20
+  metadata.gz: 5a2c519714481d39b458e56cb1865b20fdf0c3133f856013692b6bd19c5fb43b7ede85eb1fb59d07cbcbcaccd4524933bfe92c3656e032ec27e6da6757787ba0
+  data.tar.gz: 02a8381a44b6f732bf86beb985fea8d9bd383c960ce640793bd23faaf1e38e57b28e887da8c0d2060f7cc51502575e3b2f1585f87a051f0b21d47ed181b1d546

data/CHANGELOG.md

@@ -13,6 +13,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Removed
 
+## [0.3.3] - 2025.06.01
+
+### Changed
+- Update validations to allow empty `contact` section
+
+## [0.3.2] - 2025.06.01
+
+### Added
+- Template name validation to `Kamisaku::PDF` interface
+
 ## [0.3.1] - 2025-06-01
 
 ### Changed

data/Gemfile.lock

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

data/README.md

@@ -2,15 +2,47 @@
 
 *Build a CV PDF from a yaml text file.*
 
+🚀 See it in action at [https://kamisaku.sinaru.com/](https://kamisaku.sinaru.com/?utm_source=github).
+
 [![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).
 
+## Templates
+For a list of templates availble for CV generation, check the [examples](/examples) directory where each directory name is a template name.
+
+## Installation
+
+This is a Ruby gem. So you can either install as a gem or clone the repo and use `bin/console` file run from terminal.
+
+### Dependency Requirement
+- Ruby 3.4.3
+- 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:
+
+```ruby
+gem 'kamisaku'
+```
+
+And then execute:
+```bash
+$ bundle install
+```
+Or install it yourself as:
+```bash
+$ gem install kamisaku
+```
+
 ## Usage
 
-First we need to have a `yaml` file with the CV data. The yaml file supports following sections.
+First we need to have a `yaml` file or a string with the CV data. The gem supports the following sections.
 
 ```yaml
 version: 1
@@ -69,36 +101,6 @@ education:
       - # Things you have achieved or did
 ```
 
-## Template
-For a list of templates availble for CV generation, check the [examples](/examples) directory where each directory name is a template name.
-
-## Installation
-
-This is a Ruby gem. So you can either install as a gem or clone the repo and use `bin/console` file run from terminal.
-
-### Dependency Requirement
-- Ruby 3.4.3
-- 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:
-
-```ruby
-gem 'kamisaku'
-```
-
-And then execute:
-```bash
-$ bundle install
-```
-Or install it yourself as:
-```bash
-$ gem install kamisaku
-```
-
 ## Generating PDF
 
 ### Using terminal
@@ -115,6 +117,21 @@ bin/console -c examples/paper/john_doe.yml -o examples/paper/john_doe.pdf  -t pa
 - `-o` output location for the PDF file including the name
 - `-t` template to use
 
+### Using `PDF` class
+
+```ruby
+# Have a YAML string
+yaml_str = "..."
+# Create a hash
+content_hash = Kamisaku::Helpers.yaml_str_to_content_hash(yaml_str)
+# Validate the hash is correct. If there is any issue, it will raise a ` Kamisaku::Error ` exception.
+Kamisaku::ContentValidator.new(content_hash:).validate!
+# create a pdf instance
+pdf = Kamisaku::PDF.new(content_hash:, template: "paper")
+# create the PDF at given path
+pdf.write_to('/path/to/generated_file.pdf')
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/kamisaku/content_validator.rb

@@ -54,10 +54,6 @@ module Kamisaku
         raise Error, "Contact contains invalid fields"
       end
 
-      allowed_fields.each do |field|
-        raise Error, "Contact missing required field '#{field}'" unless contact_fields.include?(field)
-      end
-
       data[:contact].each do |field, value|
         if field == :location
           validate_location(value, "Contact section")

data/lib/kamisaku/pdf.rb

@@ -6,6 +6,8 @@ module Kamisaku
       @content_hash = content_hash
       @template = template || "sleek"
       ContentValidator.new(content_hash:).validate!
+      raise Error, "Invalid template name '#{template}'" unless template.is_a?(String)
+      raise Error, "Invalid template name '#{template}'" unless TemplateHelpers::TEMPLATES.include? @template
     end
 
     def write_to(pdf_location)

data/lib/kamisaku/template_helpers.rb

@@ -2,6 +2,8 @@ require "date"
 
 module Kamisaku
   module TemplateHelpers
+    TEMPLATES = %w[paper sleek].freeze
+
     def month_name(month_int)
       return "" if month_int.nil?
 

data/lib/kamisaku/version.rb

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

data/template.yml

@@ -1,7 +1,10 @@
 # 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 "#"
+#
+# Tip: If you already have a sample file like an exising Resume/CV PDF and you want to convert that to a YAML file based on the structure,
+#  You could provide this template file and the PDF to an LLM like Claude.AI prompt to generate a new YAML file.
+#  Example prompt: "Based on the given template_structure.yml file, create a resume.yml for data in Profile.pdf"
+#
 
 version: 1
 profile:
@@ -10,13 +13,13 @@ profile:
   about: # Some sleek details about your experience
 
 contact:
-  github: # Github username
-  mobile: # Mobile number
-  email: # email address
-  linkedin: # Linkedin username
+  github: # GitHub username if available, otherwise ignore
+  mobile: # Mobile number if available, otherwise ignore
+  email: # email address if available, otherwise ignore
+  linkedin: # LinkedIn username if available, otherwise ignore
   location:
-    country: # country name
-    city: # city name
+    country: # country name you are based at
+    city: # city name you are based at
 
 skills:
   - area: # specific skill area you are specialized in
@@ -37,8 +40,8 @@ experiences:
       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:
+      - # a short name for a specialized skill you gained at the organization
+    achievements: # Optional section
       - # Things you have achieved or did as a sentence. Consider reflecting the impact it made.
 
 education:
@@ -51,9 +54,11 @@ education:
     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:
+    to: # Optional. If you have finished studying at the institute, provide this section
       month: # month integer number that you stopped
       year: # year integer number that you stopped
-    achievements:
-      - # Things you have achieved or did
+    achievements: # Optional section
+      - # A list of things you have achieved or did at the institute.
+
+interests: # optional section
+  - # things that are interests to you

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kamisaku
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.3
 platform: ruby
 authors:
 - Sinaru Gunawardena