kamisaku 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3ec65c8d7b635ea047a547d4fdf3a90ef1e4ddaa2b271b2178e8b2bdf9bca0f
-  data.tar.gz: c6fada80efb1876043306bc9c38842e627f5ee32a7ca18f1a3c97a1f1490a954
+  metadata.gz: '08311183150f22bf9897f33d7ecb93616573e99b90a49455efd27747316b3a5b'
+  data.tar.gz: b198531b11fdf5b409c1b9c39be5ca04c64a1b9174a867f38e93f7d928f534e9
 SHA512:
-  metadata.gz: ea270d4a7e392a32ffb83fbe87a9f31ba483b1827f99f52547278875f92f87989b629dd901e4047d31f288cafeac8f722a6534ac1d88858cd6e9b3f6e06c055a
-  data.tar.gz: '0877a0d602fe76e39cd955bd71557355d273b4d6f45b6bafd519757b1478d635da1c3c78e67488e1aa3cd23898d7eb3297f55870c328c811f506675847ca2c63'
+  metadata.gz: 621551dfa5fa5bf482ccccf5e8fb72a7a12b2736ed397f8a813f85274f8f33db09e1ffed4d1846dbd3dbb75f2ffc7abb53dd719229c1d00946945050949517d8
+  data.tar.gz: 6434717f692966c901becca7a7573ee69ed69b63516bdf356ea826c7d27302255dad520e72ac86519b87213ade8319d3a064de0f9991c5cf69f3242a3918aa20

data/CHANGELOG.md

@@ -13,6 +13,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Removed
 
+## [0.3.1] - 2025-06-01
+
+### Changed
+- Refactor code and update `Kamisaku::PDF` interface
+
+## [0.3.0] - 2025-05-28
+
+### Added
+- Add `Kamisaku::PDF` interface that can be used externally to generate PDF
+
 ## [0.2.1] - 2025-05-28
 
 ### Changed

data/Gemfile.lock

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

data/lib/kamisaku/arg_parser.rb

@@ -12,21 +12,21 @@ module Kamisaku
           options[:html_output] = html_output
         end
 
-        parser.on("-c", "--cv-info INFO", "Require the INFO") do |cv_info|
-          options[:cv_info] = cv_info
+        parser.on("-c", "--yaml-file INFO", "Require the INFO") do |yaml_file|
+          options[:yaml_file] = yaml_file
         end
 
-        parser.on("-o", "--output-path OUTPUT", "Require the OUTPUT") do |output_path|
-          options[:output_path] = output_path
+        parser.on("-o", "--pdf-file OUTPUT", "Require the OUTPUT") do |pdf_file|
+          options[:pdf_file] = pdf_file
         end
 
-        parser.on("-t", "--template-path TEMPLATE", "Provide the TEMPLATE name") do |template|
+        parser.on("-t", "--template TEMPLATE", "Provide the TEMPLATE name") do |template|
           options[:template] = template
         end
       end.parse!
 
-      raise OptionParser::MissingArgument.new("Provide the location of CV yaml file") if options[:cv_info].nil?
-      raise OptionParser::MissingArgument.new("Provide a valid path to generate the CV pdf file") if options[:output_path].nil?
+      raise OptionParser::MissingArgument.new("-c") if options[:yaml_file].nil?
+      raise OptionParser::MissingArgument.new("-o") if options[:pdf_file].nil?
 
       options
     end

data/lib/kamisaku/chrome_runner.rb

@@ -0,0 +1,18 @@
+module Kamisaku
+  class ChromeRunner
+    def initialize(sandbox: false, headless: true, gpu: false)
+      @base_args = ["--run-all-compositor-stages-before-draw"]
+      @base_args << "--no-sandbox" unless sandbox
+      @base_args << "--headless" if headless
+      @base_args << "--disable-gpu" unless gpu
+    end
+
+    def html_to_pdf(html_path, pdf_path, pdf_header_footer: false)
+      args = [*@base_args]
+      args << "--no-pdf-header-footer" unless pdf_header_footer
+      args << "--print-to-pdf=#{pdf_path}"
+      args << html_path
+      system("google-chrome", *args)
+    end
+  end
+end

data/lib/kamisaku/cli_runner.rb

@@ -0,0 +1,14 @@
+module Kamisaku
+  class CLIRunner
+    def self.run
+      options = Kamisaku::ArgParser.parse!
+      yaml_file = options[:yaml_file]
+      raise Kamisaku::Error.new "YAML file does not exist" unless File.exist?(yaml_file)
+
+      yaml_string = File.read(yaml_file)
+      pdf = PDF.new(content_hash: Helpers.yaml_str_to_content_hash(yaml_string), template: options[:template])
+      pdf.write_to(options[:pdf_file])
+      pdf.generate_html(options[:html_output]) if options[:html_output]
+    end
+  end
+end

data/lib/kamisaku/content_validator.rb

@@ -0,0 +1,173 @@
+module Kamisaku
+  class ContentValidator
+    attr_reader :content_hash
+    alias_method :data, :content_hash
+
+    def initialize(content_hash:)
+      @content_hash = content_hash
+    end
+
+    def validate!
+      validate_version
+      validate_profile
+      validate_contact
+      validate_skills
+      validate_experiences
+    end
+
+    private
+
+    def validate_version
+      raise Error, "Invalid version" unless data[:version] && data[:version] == 1
+    end
+
+    def validate_profile
+      raise Error, "Missing profile" unless data[:profile]
+      raise Error, "Profile must be a hash" unless data[:profile].is_a?(Hash)
+
+      allowed_fields = %i[name title about]
+      profile_fields = data[:profile].keys
+
+      unless profile_fields.all? { |field| allowed_fields.include?(field) }
+        raise Error, "Profile contains invalid fields"
+      end
+
+      unless profile_fields.size == allowed_fields.size
+        raise Error, "Profile must contain exactly the fields: #{allowed_fields.join(", ")}"
+      end
+
+      data[:profile].each do |field, value|
+        unless value.is_a?(String)
+          raise Error, "Profile field '#{field}' must be a string"
+        end
+      end
+    end
+
+    def validate_contact
+      raise Error, "Missing contact" unless data[:contact]
+      raise Error, "Contact must be a hash" unless data[:contact].is_a?(Hash)
+
+      allowed_fields = %i[github mobile linkedin website email location]
+      contact_fields = data[:contact].keys
+
+      unless contact_fields.all? { |field| allowed_fields.include?(field) }
+        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")
+        else
+          raise Error, "Contact field '#{field}' must be a string" unless value.is_a?(String)
+        end
+      end
+    end
+
+    def validate_location(location, section)
+      raise Error, "#{section}: Location must be a hash" unless location.is_a?(Hash)
+
+      allowed_fields = %i[country city]
+      location_fields = location.keys
+
+      unless location_fields.all? { |field| allowed_fields.include?(field) }
+        raise Error, "#{section}: Location contains invalid fields"
+      end
+
+      allowed_fields.each do |field|
+        raise Error, "#{section}: Location missing required field '#{field}'" unless location_fields.include?(field)
+        raise Error, "#{section}: Location field '#{field}' must be a string" unless location[field].is_a?(String)
+      end
+    end
+
+    def validate_skills
+      return unless data[:skills]
+
+      raise Error, "Skills must be an array" unless data[:skills].is_a?(Array)
+
+      data[:skills].each do |skill|
+        raise Error, "Each skill must be a hash" unless skill.is_a?(Hash)
+
+        allowed_fields = %i[area items]
+        skill_fields = skill.keys
+
+        unless skill_fields.all? { |field| allowed_fields.include?(field) }
+          raise Error, "Skills section: Skill contains invalid fields"
+        end
+
+        allowed_fields.each do |field|
+          raise Error, "Skills section: Skill missing required field '#{field}'" unless skill_fields.include?(field)
+        end
+
+        raise Error, "Skills section: Skill field 'area' must be a string" unless skill[:area].is_a?(String)
+        raise Error, "Skills section: Skill field 'items' must be an array" unless skill[:items].is_a?(Array)
+
+        skill[:items].each do |item|
+          raise Error, "Skills section: Each skill item must be a string" unless item.is_a?(String)
+        end
+      end
+    end
+
+    def validate_experiences
+      return unless data[:experiences]
+
+      raise Error, "Experiences must be an array" unless data[:experiences].is_a?(Array)
+
+      data[:experiences].each do |experience|
+        raise Error, "Each experience must be a hash" unless experience.is_a?(Hash)
+
+        allowed_fields = %i[title organisation location from to skills achievements]
+        required_fields = %i[title organisation location from skills achievements]
+        experience_fields = experience.keys
+
+        unless experience_fields.all? { |field| allowed_fields.include?(field) }
+          raise Error, "Experiences section: Experience contains invalid fields"
+        end
+
+        required_fields.each do |field|
+          raise Error, "Experiences section: Experience missing required field '#{field}'" unless experience_fields.include?(field)
+        end
+
+        raise Error, "Experiences section: Experience field 'title' must be a string" unless experience[:title].is_a?(String)
+        raise Error, "Experiences section: Experience field 'organisation' must be a string" unless experience[:organisation].is_a?(String)
+
+        validate_location(experience[:location], "Experiences section")
+
+        raise Error, "Experiences section: Experience field 'from' must be a hash" unless experience[:from].is_a?(Hash)
+        validate_date_format(experience[:from], "Experiences section")
+
+        if experience.key?(:to)
+          raise Error, "Experiences section: Experience field 'to' must be a hash" unless experience[:to].is_a?(Hash)
+          validate_date_format(experience[:to], "Experiences section")
+        end
+
+        raise Error, "Experiences section: Experience field 'skills' must be an array" unless experience[:skills].is_a?(Array)
+        experience[:skills].each do |skill|
+          raise Error, "Experiences section: Each experience skill item must be a string" unless skill.is_a?(String)
+        end
+
+        raise Error, "Experiences section: Experience field 'achievements' must be an array" unless experience[:achievements].is_a?(Array)
+        experience[:achievements].each do |achievement|
+          raise Error, "Experiences section: Each experience achievement item must be a string" unless achievement.is_a?(String)
+        end
+      end
+    end
+
+    def validate_date_format(date, section)
+      allowed_fields = %i[month year]
+      date_fields = date.keys
+
+      unless date_fields.all? { |field| allowed_fields.include?(field) }
+        raise Error, "#{section}: Date contains invalid fields"
+      end
+
+      allowed_fields.each do |field|
+        raise Error, "#{section}: Date missing required field '#{field}'" unless date_fields.include?(field)
+        raise Error, "#{section}: Date field '#{field}' must be an integer" unless date[field].is_a?(Integer)
+      end
+    end
+  end
+end

data/lib/kamisaku/errors.rb

@@ -0,0 +1,3 @@
+module Kamisaku
+  class Error < StandardError; end
+end

data/lib/kamisaku/helpers.rb

@@ -0,0 +1,15 @@
+require "psych"
+
+module Kamisaku
+  module Helpers
+    def self.yaml_str_to_content_hash(yaml_str)
+      Psych.safe_load(yaml_str, symbolize_names: true, aliases: false, freeze: true)
+    rescue Psych::SyntaxError, Psych::DisallowedClass, Psych::AliasesNotEnabled => error
+      raise Kamisaku::Error.new error.message
+    end
+
+    def self.remove_metadata_from_pdf_file(file_path)
+      system("exiftool", "-all=", file_path, "-overwrite_original")
+    end
+  end
+end

data/lib/kamisaku/html_builder.rb

@@ -0,0 +1,27 @@
+require "erb"
+
+module Kamisaku
+  class HtmlBuilder
+    attr_reader :content_hash, :template
+    alias_method :data, :content_hash
+
+    include TemplateHelpers
+
+    def initialize(content_hash, template)
+      @content_hash = content_hash
+      @template = template
+    end
+
+    def html
+      rhtml = ::ERB.new(template_html)
+      rhtml.result(binding)
+    end
+
+    private
+
+    def template_html
+      path = File.join(File.dirname(__FILE__), "/../templates/#{template}/template.html.erb")
+      File.read(path)
+    end
+  end
+end

data/lib/kamisaku/pdf.rb

@@ -1,47 +1,34 @@
 module Kamisaku
   class PDF
-    attr_reader :yaml_content, :pdf_location, :html_location, :cv_data, :template
+    attr_reader :content_hash, :template
 
-    def initialize(yaml_content:, pdf_location:, html_location: nil, template: nil)
-      @yaml_content = yaml_content
-      @cv_data = CvData.new(YAML.load(yaml_content))
-      @pdf_location = pdf_location
-      @html_location = html_location
+    def initialize(content_hash:, template: nil)
+      @content_hash = content_hash
       @template = template || "sleek"
+      ContentValidator.new(content_hash:).validate!
     end
 
-    def create
-      generated_html_file do |file_path|
-        FileUtils.cp(file_path, html_location) if html_location
+    def write_to(pdf_location)
+      html_file do |file_path|
         html_file_to_pdf_file(file_path, pdf_location)
-        soft_remove_metadata_from_pdf_file(pdf_location)
+        Helpers.remove_metadata_from_pdf_file(pdf_location)
       end
     end
 
+    def generate_html(html_location)
+      html_file { |file_path| FileUtils.cp(file_path, html_location) }
+    end
+
     private
 
     def html_file_to_pdf_file(html_file_path, pdf_file_path)
-      # Convert the HTML file to a PDF using Google Chrome in headless mode
-      pdf_conversion_command = <<~CMD
-        google-chrome --headless --disable-gpu --run-all-compositor-stages-before-draw \
-                      --print-to-pdf=#{pdf_file_path} --no-pdf-header-footer \
-                      #{html_file_path}
-      CMD
-
-      system(pdf_conversion_command)
-      raise "PDF generation failed" unless File.exist?(pdf_file_path)
+      runner = ChromeRunner.new
+      runner.html_to_pdf(html_file_path, 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
+    def html_file
       temp_html_file = Tempfile.new(%w[kamisaku .html])
-      temp_html_file.write(cv_html)
+      temp_html_file.write(html)
       temp_html_file.close
       begin
         yield temp_html_file.path
@@ -50,9 +37,11 @@ module Kamisaku
       end
     end
 
-    def cv_html
-      rhtml = ERB.new(template_html)
-      rhtml.result(@cv_data.get_bindings)
+    def html
+      return @html if defined? @html
+
+      builder = HtmlBuilder.new(content_hash, template)
+      @html = builder.html
     end
 
     def template_html

data/lib/kamisaku/template_helpers.rb

@@ -0,0 +1,11 @@
+require "date"
+
+module Kamisaku
+  module TemplateHelpers
+    def month_name(month_int)
+      return "" if month_int.nil?
+
+      ::Date::MONTHNAMES[month_int]
+    end
+  end
+end

data/lib/kamisaku/version.rb

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

data/lib/kamisaku.rb

@@ -1,29 +1,10 @@
-# frozen_string_literal: true
-
 require_relative "kamisaku/version"
-require_relative "kamisaku/cv_data_sections/parse_helpers/month_parser"
-require_relative "kamisaku/cv_data_sections/base"
-require_relative "kamisaku/cv_data_sections/skill"
-require_relative "kamisaku/cv_data_sections/interest"
-require_relative "kamisaku/cv_data_sections/experience"
-require_relative "kamisaku/cv_data_sections/education"
-require_relative "kamisaku/cv_data"
-require_relative "kamisaku/meta_file_parser"
-require_relative "kamisaku/cv_generator"
+require_relative "kamisaku/errors"
+require_relative "kamisaku/helpers"
 require_relative "kamisaku/arg_parser"
 require_relative "kamisaku/pdf"
-
-module Kamisaku
-  class Error < StandardError; end
-
-  class Builder
-    def run
-      options = Kamisaku::ArgParser.parse!
-      raise Error.new "CV info file does not exist" unless File.exist?(options[:cv_info])
-
-      parser = MetaFileParser.new(options[:cv_info])
-      cv_data = parser.parse!
-      CvGenerator.new(cv_data, pdf_location: options[:output_path], html_location: options[:html_output], template: options[:template]).generate
-    end
-  end
-end
+require_relative "kamisaku/chrome_runner"
+require_relative "kamisaku/cli_runner"
+require_relative "kamisaku/template_helpers"
+require_relative "kamisaku/html_builder"
+require_relative "kamisaku/content_validator"

data/lib/templates/paper/template.html.erb

@@ -286,58 +286,66 @@
   </style>
 </head>
 <body>
-<div class="bottom-ruler contact-section">
-  <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>
-    <% end %>
-    <% if has? :contact, :mobile %>
-      <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 %>
-    <% end %>
-    <% if has? :contact, :website %>
-      <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>
+<% if (profile = data[:profile]) %>
+  <div class="bottom-ruler contact-section">
+    <div class="name bottom-ruler"><%= profile.dig(:name) %></div>
+    <% if (contact = data[:contact]) %>
+      <div class="contact">
+        <% if (email = contact[:email]) %>
+          <a href="mailto:<%= email %>"><%= email %></a>
+        <% end %>
+
+        <% if (mobile = contact[:mobile]) %>
+          <a href="tel:<%= mobile %>"><%= mobile %></a>
+        <% end %>
+
+        <% if (city = contact.dig(:location, :city)) || (country = contact.dig(:location, :country)) %>
+          <%= "#{city}, #{country}".strip %>
+        <% end %>
+
+        <% if (website = contact[:website]) %>
+          <a href="<%= website %>"><%= website %></a>
+        <% end %>
+
+        <% if (github = contact[:github]) %>
+          <a href="https://github.com/<%= github %>">github.com/<%= github %></a>
+        <% end %>
+
+        <% if (linkedin = contact[:linkedin]) %>
+          <a href="https://linkedin.com/in/<%= linkedin %>">linkedin.com/in/<%= linkedin %></a>
+        <% end %>
+      </div>
     <% end %>
   </div>
-</div>
-
-<div class="summary">
-  <div class="upcase bottom-ruler section-title">Summary</div>
-  <div class="about"><%= dig :profile, :about %></div>
-</div>
+  <div class="summary">
+    <div class="upcase bottom-ruler section-title">Summary</div>
+    <div class="about"><%= profile[:about] %></div>
+  </div>
+<% end %>
 
-<% if has?(:experiences) %>
+<% if (experiences = data[:experiences]) %>
   <div class="work-experience">
     <div class="upcase bottom-ruler section-title">Work Experience</div>
-    <% dig :experiences do |experience| %>
+    <% experiences.each do |experience| %>
       <div class="experience">
         <div class="flex flex-grow sb">
-          <div class="organisation-name"><%= dig experience, :organisation %></div>
+          <div class="organisation-name"><%= experience[:organisation] %></div>
           <div class="time-period">
-            <%= "#{dig experience, :from, :month} #{dig experience, :from, :year}" %> -
-            <%= has?(experience, :to) ? "#{dig experience, :to, :month} #{dig experience, :to, :year}" : "Present" %>
+            <%= "#{month_name experience.dig(:from, :month)} #{experience.dig(:from, :year)}" %> -
+            <%= experience[:to] ? "#{month_name experience.dig(:to, :month)} #{experience.dig(:to, :year)}" : "Present" %>
           </div>
         </div>
 
         <div class="flex flex-grow sb">
-          <div class="job-title"><%= dig experience, :title %></div>
+          <div class="job-title"><%= experience[:title] %></div>
           <div class="job-location">
-            <%= "#{dig(experience, :location, :city)}, #{dig(experience, :location, :country)}" %>
+            <%= "#{experience.dig(:location, :city)}, #{experience.dig(:location, :country)}" %>
           </div>
         </div>
 
-        <% if has? experience, :achievements %>
+        <% if (achievements = experience[:achievements]) %>
           <ul class="achievements">
-            <% dig(experience, :achievements).each do |achievement| %>
+            <% achievements.each do |achievement| %>
               <li class="achievement-item"><%= achievement %></li>
             <% end %>
           </ul>
@@ -347,30 +355,31 @@
   </div>
 <% end %>
 
-<% if has?(:education) %>
+<% if (education_list = data[:education]) %>
   <div class="education">
     <div class="upcase bottom-ruler section-title">Education</div>
-    <% dig :education do |education| %>
+    <% education_list.each do |education| %>
       <div class="education-item">
         <div class="flex flex-grow sb">
           <div class="institute-name">
-            <%= dig education, :institute %>
+            <%= education[:institute] %>
           </div>
           <div class="time-period">
-            <%= has?(education, :from) ? "#{dig education, :from, :month} #{dig education, :from, :year} - " : "" %>
-            <%= has?(education, :to) ? "#{dig education, :to, :month} #{dig education, :to, :year}" : "Present" %>
+            <%= education.dig(:from) ? "#{month_name education.dig(:from, :month)} #{education.dig(:from, :year)} - " : "" %>
+            <%= education.dig(:to) ? "#{month_name education.dig(:to, :month)} #{education.dig(:to, :year)}" : "Present" %>
           </div>
         </div>
 
         <div class="flex flex-grow sb">
-          <div class="qualification"><%= dig education, :qualification %></div>
+          <div class="qualification"><%= education[:qualification] %></div>
           <div class="education-location">
-            <%= dig education, :location, :city %>, <%= dig education, :location, :country %>
+            <%= "#{education.dig(:location, :city)}, #{education.dig(:location, :country)}".strip %>
           </div>
         </div>
-        <% if has?(education, :achievements) %>
+
+        <% if (achievements = education[:achievements]) %>
           <ul class="achievements">
-            <% dig(education, :achievements).each do |achievement| %>
+            <% achievements.each do |achievement| %>
               <li class="achievement-item"><%= achievement %></li>
             <% end %>
           </ul>
@@ -380,37 +389,32 @@
   </div>
 <% end %>
 
-<% generic_sections = [has?(:skills) ? 'Skills' : nil, has?(:interests) ? 'Interests' : nil].compact %>
-
-<% unless generic_sections.empty? %>
 
+<% if (generic_sections = data.slice(:skills, :interests).compact) %>
+<% show_subtitle = generic_sections.keys.size > 1 %>
   <div class="generic-section">
-    <div class="upcase bottom-ruler section-title"><%= generic_sections.join(', ') %></div>
+    <div class="upcase bottom-ruler section-title"><%= generic_sections.keys.map(&:capitalize).join(', ') %></div>
     <ul>
-      <% if has?(:skills) %>
+      <% if (skills = generic_sections[:skills]) %>
         <li class="item">
-          <% if generic_sections.length > 1 %>
+          <% if show_subtitle %>
             <b>Skills: </b>
           <% end %>
-          <% skill_list = [] %>
-          <% dig :skills do |skill| %>
-            <% dig(skill, :items).each { |item| skill_list.push(item) } %>
-          <% end %>
-
-          <%= skill_list.join('; ') %>
+          <%= skills.flat_map { |skill| skill[:items] }.join('; ') %>
         </li>
       <% end %>
 
-      <% if has?(:interests) %>
+      <% if (interests = generic_sections[:interests]) %>
         <li class="item">
-          <% if generic_sections.length > 1 %>
+          <% if show_subtitle %>
             <b>Interests: </b>
           <% end %>
-          <%= dig(:interests).join('; ') %>
+          <%= interests.join('; ') %>
         </li>
       <% end %>
     </ul>
   </div>
 <% end %>
+
 </body>
 </html>

data/lib/templates/sleek/template.html.erb

@@ -133,39 +133,39 @@
 <div class="profile">
   <div class="flex">
     <div>
-      <div class="name"> <%= dig :profile, :name %></div>
-      <div class="title"> <%= dig :profile, :title %></div>
+      <div class="name"> <%= data.dig(:profile, :name) %></div>
+      <div class="title"> <%= data.dig(:profile, :title) %></div>
     </div>
     <div class="flex contact">
       <div style="margin-right: 10px;">
         <div class="contact-item">
           <span class="icon"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 496 512"><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6zm-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3zm44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9zM244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8zM97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1zm-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7zm32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1zm-11.4-14.7c-1.6 1-1.6 3.6 0 5.9 1.6 2.3 4.3 3.3 5.6 2.3 1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2z"/></svg></span>
-          <span><a href="https://github.com/<%= dig :contact, :github %>">github.com/<%= dig :contact, :github %></a></span>
+          <span><a href="https://github.com/<%= data.dig(:contact, :github) %>">github.com/<%= data.dig(:contact,:github) %></a></span>
         </div>
 
         <div class="contact-item">
           <span class="icon"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M416 32H31.9C14.3 32 0 46.5 0 64.3v383.4C0 465.5 14.3 480 31.9 480H416c17.6 0 32-14.5 32-32.3V64.3c0-17.8-14.4-32.3-32-32.3zM135.4 416H69V202.2h66.5V416zm-33.2-243c-21.3 0-38.5-17.3-38.5-38.5S80.9 96 102.2 96c21.2 0 38.5 17.3 38.5 38.5 0 21.3-17.2 38.5-38.5 38.5zm282.1 243h-66.4V312c0-24.8-.5-56.7-34.5-56.7-34.6 0-39.9 27-39.9 54.9V416h-66.4V202.2h63.7v29.2h.9c8.9-16.8 30.6-34.5 62.9-34.5 67.2 0 79.7 44.3 79.7 101.9V416z"/></svg></span>
-          <span><a href="https://linkedin.com/in/<%= dig :contact, :linkedin %>">linkedin.com/in/<%= dig :contact, :linkedin %></a></span>
+          <span><a href="https://linkedin.com/in/<%= data.dig :contact, :linkedin %>">linkedin.com/in/<%= data.dig :contact, :linkedin %></a></span>
         </div>
 
         <div class="contact-item">
           <span class="icon"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><path d="M352 256c0 22.2-1.2 43.6-3.3 64H163.3c-2.2-20.4-3.3-41.8-3.3-64s1.2-43.6 3.3-64H348.7c2.2 20.4 3.3 41.8 3.3 64zm28.8-64H503.9c5.3 20.5 8.1 41.9 8.1 64s-2.8 43.5-8.1 64H380.8c2.1-20.6 3.2-42 3.2-64s-1.1-43.4-3.2-64zm112.6-32H376.7c-10-63.9-29.8-117.4-55.3-151.6c78.3 20.7 142 77.5 171.9 151.6zm-149.1 0H167.7c6.1-36.4 15.5-68.6 27-94.7c10.5-23.6 22.2-40.7 33.5-51.5C239.4 3.2 248.7 0 256 0s16.6 3.2 27.8 13.8c11.3 10.8 23 27.9 33.5 51.5c11.6 26 20.9 58.2 27 94.7zm-209 0H18.6C48.6 85.9 112.2 29.1 190.6 8.4C165.1 42.6 145.3 96.1 135.3 160zM8.1 192H131.2c-2.1 20.6-3.2 42-3.2 64s1.1 43.4 3.2 64H8.1C2.8 299.5 0 278.1 0 256s2.8-43.5 8.1-64zM194.7 446.6c-11.6-26-20.9-58.2-27-94.6H344.3c-6.1 36.4-15.5 68.6-27 94.6c-10.5 23.6-22.2 40.7-33.5 51.5C272.6 508.8 263.3 512 256 512s-16.6-3.2-27.8-13.8c-11.3-10.8-23-27.9-33.5-51.5zM135.3 352c10 63.9 29.8 117.4 55.3 151.6C112.2 482.9 48.6 426.1 18.6 352H135.3zm358.1 0c-30 74.1-93.6 130.9-171.9 151.6c25.5-34.2 45.2-87.7 55.3-151.6H493.4z"/></svg></span>
-          <span><a href="https://<%= dig :contact, :website %>"><%= dig :contact, :website %></a></span>
+          <span><a href="https://<%= data.dig :contact, :website %>"><%= data.dig :contact, :website %></a></span>
         </div>
       </div>
 
       <div>
         <div class="contact-item">
           <span class="icon"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 320 512"><path d="M0 64C0 28.7 28.7 0 64 0H256c35.3 0 64 28.7 64 64V448c0 35.3-28.7 64-64 64H64c-35.3 0-64-28.7-64-64V64zm64 96v64c0 17.7 14.3 32 32 32H224c17.7 0 32-14.3 32-32V160c0-17.7-14.3-32-32-32H96c-17.7 0-32 14.3-32 32zM80 352a24 24 0 1 0 0-48 24 24 0 1 0 0 48zm24 56a24 24 0 1 0 -48 0 24 24 0 1 0 48 0zm56-56a24 24 0 1 0 0-48 24 24 0 1 0 0 48zm24 56a24 24 0 1 0 -48 0 24 24 0 1 0 48 0zm56-56a24 24 0 1 0 0-48 24 24 0 1 0 0 48zm24 56a24 24 0 1 0 -48 0 24 24 0 1 0 48 0zM128 48c-8.8 0-16 7.2-16 16s7.2 16 16 16h64c8.8 0 16-7.2 16-16s-7.2-16-16-16H128z"/></svg></span>
-          <span><a href="tel:<%= dig :contact, :mobile %>"><%= dig :contact, :mobile %></a></span>
+          <span><a href="tel:<%= data.dig :contact, :mobile %>"><%= data.dig :contact, :mobile %></a></span>
         </div>
         <div class="contact-item">
           <span class="icon"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><path d="M48 64C21.5 64 0 85.5 0 112c0 15.1 7.1 29.3 19.2 38.4L236.8 313.6c11.4 8.5 27 8.5 38.4 0L492.8 150.4c12.1-9.1 19.2-23.3 19.2-38.4c0-26.5-21.5-48-48-48H48zM0 176V384c0 35.3 28.7 64 64 64H448c35.3 0 64-28.7 64-64V176L294.4 339.2c-22.8 17.1-54 17.1-76.8 0L0 176z"/></svg></span>
-          <span><%= dig :contact, :email %></span>
+          <span><%= data.dig :contact, :email %></span>
         </div>
         <div class="contact-item">
           <span class="icon"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 384 512"><path d="M215.7 499.2C267 435 384 279.4 384 192C384 86 298 0 192 0S0 86 0 192c0 87.4 117 243 168.3 307.2c12.3 15.3 35.1 15.3 47.4 0zM192 128a64 64 0 1 1 0 128 64 64 0 1 1 0-128z"/></svg></span>
-          <span><%= dig :contact, :location, :city %>, <%= dig :contact, :location, :country %></span>
+          <span><%= data.dig :contact, :location, :city %>, <%= data.dig :contact, :location, :country %></span>
         </div>
       </div>
 
@@ -173,16 +173,16 @@
   </div>
   <div class="about">
     <h2 class="upcase heading">Professional Summary</h2>
-    <p><%= dig :profile, :about %></p>
+    <p><%= data.dig :profile, :about %></p>
   </div>
 </div>
 
-<% if has? :skills %>
+<% if data[:skills] %>
   <div class="skills">
-    <% dig :skills do |skill| %>
+    <% data[:skills].each do |skill| %>
       <div>
-        <b><%= dig skill, :area %> </b>
-        <% dig(skill, :items).each do |item| %>
+        <b><%= skill.dig :area %> </b>
+        <% skill.dig(:items).each do |item| %>
           • <%= item %>
         <% end %>
       </div>
@@ -190,36 +190,36 @@
   </div>
 <% end %>
 
-<% if has? :experiences %>
+<% if data[:experiences] %>
   <div class="experiences">
     <h2 class="upcase heading">Work Experience</h2>
-    <% dig :experiences do |experience| %>
+    <% data[:experiences].each do |experience| %>
       <div class="experience">
-        <h3 class="job-title"><%= dig(experience, :title) %></h3>
+        <h3 class="job-title"><%= experience.dig(:title) %></h3>
         <div class="flex">
           <div class="flex-grow">
           <span style="font-weight: bold">
-            <%= dig(experience, :organisation) %>
+            <%= experience.dig(:organisation) %>
           </span> /
-            <span><%= "#{dig(experience, :location, :city)}, #{dig(experience, :location, :country)}" %></span>
+            <span><%= "#{experience.dig(:location, :city)}, #{experience.dig(:location, :country)}" %></span>
           </div>
           <div class="time-period">
           <span class="time">
-            <%= dig(experience, :from, :month) %> <%= dig(experience, :from, :year) %> -
-            <%= has?(experience, :to) ? "#{dig(experience, :to, :month)} #{dig(experience, :to, :year)}" : 'Present' %>
+            <%= month_name experience.dig(:from, :month) %> <%= experience.dig(:from, :year) %> -
+            <%= experience[:to] ? "#{month_name experience.dig(:to, :month)} #{experience.dig(:to, :year)}" : 'Present' %>
           </span>
           </div>
         </div>
-        <% if has? experience, :achievements %>
+        <% if experience[:achievements] %>
           <div class="achievements">
-            <% dig(experience, :achievements).each do |achievement| %>
+            <% experience.dig(:achievements).each do |achievement| %>
               <div class="achievement-item">• <%= achievement %></div>
             <% end %>
           </div>
         <% end %>
         <div class="skills">
           <span class="label">Skills</span>
-          <% dig(experience, :skills).each do |item| %>
+          <% experience.dig(:skills).each do |item| %>
             <span class="skill-item">• <%= item %></span>
           <% end %>
         </div>
@@ -228,28 +228,28 @@
   </div>
 <% end %>
 
-<% if has? :education %>
+<% if data[:education] %>
   <div class="education">
     <h2 class="upcase heading">Education</h2>
-    <% dig :education do |education| %>
+    <% data[:education].each do |education| %>
       <div class="education-item">
-        <h3><%= dig(education, :qualification) %></h3>
+        <h3><%= education.dig(:qualification) %></h3>
         <div class="flex">
           <div class="flex-grow">
           <span style="font-weight: bold">
-            <%= dig(education, :institute) %>
+            <%= education.dig(:institute) %>
           </span> /
-            <span><%= "#{dig(education, :location, :city)}, #{dig(education, :location, :country)}" %></span>
+            <span><%= "#{education.dig(:location, :city)}, #{education.dig(:location, :country)}" %></span>
           </div>
           <div class="time-period">
           <span class="time">
-            <%= has?(education, :from) ? "#{dig(education, :from, :month)} #{dig(education, :from, :year)} - " : '' %>
-            <%= has?(education, :to) ? "#{dig(education, :to, :month)} #{dig(education, :to, :year)}" : 'Present' %>
+            <%= education[:from] ? "#{month_name education.dig(:from, :month)} #{education.dig(:from, :year)} - " : '' %>
+            <%= education[:to] ? "#{month_name education.dig(:to, :month)} #{education.dig(:to, :year)}" : 'Present' %>
           </span>
           </div>
         </div>
         <div class="achievements-section">
-          <% dig(education, :achievements).each do |achievement| %>
+          <% education.dig(:achievements).each do |achievement| %>
             <div>
               • <%= achievement %>
             </div>
@@ -260,4 +260,4 @@
   </div>
 <% end %>
 </body>
-</html>
+</html>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kamisaku
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Sinaru Gunawardena
@@ -33,16 +33,14 @@ files:
 - kamisaku.png
 - lib/kamisaku.rb
 - lib/kamisaku/arg_parser.rb
-- lib/kamisaku/cv_data.rb
-- lib/kamisaku/cv_data_sections/base.rb
-- lib/kamisaku/cv_data_sections/education.rb
-- lib/kamisaku/cv_data_sections/experience.rb
-- lib/kamisaku/cv_data_sections/interest.rb
-- lib/kamisaku/cv_data_sections/parse_helpers/month_parser.rb
-- lib/kamisaku/cv_data_sections/skill.rb
-- lib/kamisaku/cv_generator.rb
-- lib/kamisaku/meta_file_parser.rb
+- lib/kamisaku/chrome_runner.rb
+- lib/kamisaku/cli_runner.rb
+- lib/kamisaku/content_validator.rb
+- lib/kamisaku/errors.rb
+- lib/kamisaku/helpers.rb
+- lib/kamisaku/html_builder.rb
 - lib/kamisaku/pdf.rb
+- lib/kamisaku/template_helpers.rb
 - lib/kamisaku/version.rb
 - lib/templates/paper/template.html.erb
 - lib/templates/sleek/template.html.erb

data/lib/kamisaku/cv_data.rb

@@ -1,56 +0,0 @@
-# frozen_string_literal: true
-
-module Kamisaku
-  class CvData
-    DATA_SECTION_CLASSES = [
-      CvDataSection::Skill,
-      CvDataSection::Experience,
-      CvDataSection::Education,
-      CvDataSection::Interest
-    ]
-    def initialize(hash)
-      @hash = hash
-    end
-
-    def get_bindings
-      binding
-    end
-
-    def has?(*path)
-      if DATA_SECTION_CLASSES.any? { |klass| path.first.instance_of? klass }
-        return path.first.has?(*path[1..])
-      end
-
-      path_s = path.map(&:to_s)
-      !@hash.dig(*path_s).nil?
-    end
-
-    def dig(*path)
-      if DATA_SECTION_CLASSES.any? { |klass| path.first.instance_of? klass }
-        return path.first.dig(*path[1..])
-      end
-
-      path_s = path.map(&:to_s)
-      case path_s.first
-      when "skills"
-        @hash[path_s.first].each do |skill_hash|
-          yield CvDataSection::Skill.new(skill_hash)
-        end
-      when "experiences"
-        @hash[path_s.first].each do |skill_hash|
-          yield CvDataSection::Experience.new(skill_hash)
-        end
-      when "education"
-        @hash[path_s.first].each do |skill_hash|
-          yield CvDataSection::Education.new(skill_hash)
-        end
-      when "interests"
-        @hash[path_s.first].each do |skill_hash|
-          CvDataSection::Interest.new(skill_hash)
-        end
-      else
-        @hash.dig(*path_s)
-      end
-    end
-  end
-end

data/lib/kamisaku/cv_data_sections/base.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-module CvDataSection
-  class Base
-    def initialize(hash)
-      @hash = hash
-    end
-
-    def get_bindings
-      binding
-    end
-
-    def has?(*path)
-      path_s = path.map(&:to_s)
-      data = @hash.dig(*path_s)
-      !data.nil?
-    end
-
-    def dig(*path)
-      path_s = path.map(&:to_s)
-      @hash.dig(*path_s)
-    end
-  end
-end

data/lib/kamisaku/cv_data_sections/education.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-module CvDataSection
-  class Education < Base
-    include ParseHelper::Date
-
-    def dig(*path)
-      data = super
-      return [] if data.nil? && path.first == :achievements
-      return to_month(data) if path[-2..] == [:from, :month]
-      return to_month(data) if path[-2..] == [:to, :month]
-      data
-    end
-  end
-end

data/lib/kamisaku/cv_data_sections/experience.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-module CvDataSection
-  class Experience < Base
-    include ParseHelper::Date
-    def dig(*path)
-      data = super
-      return [] if data.nil? && path.first == :technologies
-      return [] if data.nil? && path.first == :achievements
-      return to_month(data) if path[-2..] == [:from, :month]
-      return to_month(data) if path[-2..] == [:to, :month]
-      data
-    end
-  end
-end

data/lib/kamisaku/cv_data_sections/interest.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-module CvDataSection
-  class Interest < Base
-    def dig(*_path)
-      super
-    end
-  end
-end

data/lib/kamisaku/cv_data_sections/parse_helpers/month_parser.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-require "date"
-
-module CvDataSection
-  module ParseHelper
-    module Date
-      private
-
-      def to_month(month_int)
-        return "" if month_int.nil?
-
-        ::Date::MONTHNAMES[month_int]
-      end
-    end
-  end
-end

data/lib/kamisaku/cv_data_sections/skill.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-module CvDataSection
-  class Skill < Base
-    def dig(*path)
-      data = super
-      return [] if data.nil? && path.first == :items
-      data
-    end
-  end
-end

data/lib/kamisaku/cv_generator.rb

@@ -1,66 +0,0 @@
-# frozen_string_literal: true
-
-require "erb"
-
-module Kamisaku
-  class CvGenerator
-    attr_reader :pdf_location, :html_location, :cv_data, :template
-
-    def initialize(cv_data, pdf_location:, html_location: nil, template: nil)
-      @cv_data = cv_data
-      @pdf_location = pdf_location
-      @html_location = html_location
-      @template = template || "sleek"
-    end
-
-    def generate
-      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
-
-    private
-
-    def html_file_to_pdf_file(html_file_path, pdf_file_path)
-      # Convert the HTML file to a PDF using Google Chrome in headless mode
-      pdf_conversion_command = <<~CMD
-        google-chrome --headless --disable-gpu --run-all-compositor-stages-before-draw \
-                      --print-to-pdf=#{pdf_file_path} --no-pdf-header-footer \
-                      #{html_file_path}
-      CMD
-
-      system(pdf_conversion_command)
-      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)
-      temp_html_file.close
-      begin
-        yield temp_html_file.path
-      ensure
-        temp_html_file.unlink
-      end
-    end
-
-    def cv_html
-      rhtml = ERB.new(template_html)
-      rhtml.result(@cv_data.get_bindings)
-    end
-
-    def template_html
-      path = File.join(File.dirname(__FILE__), "/../templates/#{template}/template.html.erb")
-      File.read(path)
-    end
-  end
-end

data/lib/kamisaku/meta_file_parser.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-require "yaml"
-
-module Kamisaku
-  class MetaFileParser
-    attr_reader :location
-
-    def initialize(location)
-      @location = location
-    end
-
-    def validate!
-      # TODO: Check if file contains correct fields
-    end
-
-    def parse!
-      validate!
-      CvData.new(yaml)
-    end
-
-    def yaml
-      @yaml ||= YAML.load_file(location)
-    end
-  end
-end