kamisaku 0.3.2 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c2b9b3a11f581cc1ee84330c7813cfc6e2875616de64d41fde78ad710891916
-  data.tar.gz: a54225bf6e5851ead275215047393339cbca5bd8834d9a2030fb4a121b0aded2
+  metadata.gz: 1bfceaef01ef3c1d4a92122575d3a8a1eaca248166559c1703b325f5cd5c78ce
+  data.tar.gz: 740b3acfe49425ca0e41ddeab7b026b880524cbbe06ee40799197d1039fd043d
 SHA512:
-  metadata.gz: ba93279fffb6b6f6af37123a580d6084bd3d570870167c7eb912ce3950b18d8affa157eb1adbc253f463bf293803270ef17c4b66eec26b444b4f3c7754005eda
-  data.tar.gz: b097d987aa90f78b613738e096e8ffb4218dba1de43e5ff796d3092e21a6a07ed47d803b126baab0f3bc8aebc01326254adac3a1dfafab4f8d6c830bca1396c4
+  metadata.gz: 8345ffa22c0407fcb09dca29ee3dd0d44add12e38e73f4dcb9732d576367333533ee19a05fee4aabf936e62628989f78f3ce71452e03ae5c196c6cc6746ac7f3
+  data.tar.gz: 3aab44e96289cae64acfd4530f92b570e26f4d010a5b639e4f21b6240e2cd4b667d1370426cbf0917a8c31d4fb0adbaabb66613cad48e05c4bbfe0bfd2dcb93d

data/CHANGELOG.md

@@ -13,6 +13,20 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Removed
 
+## [0.3.4] - 2025.06.06
+
+### Added
+- Add new templates `chromatic`, `gradient`, `meridian`, `prism`, and `zenith`
+
+### Changed
+- Update paper template
+
+
+## [0.3.3] - 2025.06.01
+
+### Changed
+- Update validations to allow empty `contact` section
+
 ## [0.3.2] - 2025.06.01
 
 ### Added

data/Gemfile.lock

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

data/README.md

@@ -2,7 +2,7 @@
 
 *Build a CV PDF from a yaml text file.*
 
-🚀 See it in action at [https://kamisaku.sinaru.com/](https://kamisaku.sinaru.com/).
+🚀 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)
 
@@ -108,7 +108,7 @@ education:
 Once you have the YAML text file, feed it into the `bin/console` and specify the output location.
 
 ```bash
-bin/console -c examples/paper/john_doe.yml -o examples/paper/john_doe.pdf  -t paper
+bin/console -c examples/john_doe.yml -o examples/paper/john_doe.pdf  -t paper
 ```
 
 #### Bash options
@@ -136,7 +136,25 @@ pdf.write_to('/path/to/generated_file.pdf')
 
 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.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+### Create or Update a template
+
+To a new template, create a folder with template name at `lib/templates`. Additionally add the template name to `Kamisaku::TemplateHelpers::TEMPLATES` list.
+
+Inside this folder, create `template.html.erb`.
+
+The template will be exposed to a Ruby hash variable called `data`. This data represent the data in the YAML file as a hash. 
+So you can use the Ruby hash methods to access and render the values.
+
+In addition, the template helper methods defined at `lib/kamisaku/template_helpers.rb` will also be available to use directly. 
+
+To test and build the template, you can run `scripts/rebuild_examples.rb -t <name of new template>`. This will create the PDF using the `lib/schema/example.yml`
+and place it in `examples/` folder.
+
+### Releasing a new gem version
+
+To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 

data/lib/kamisaku/cli_runner.rb

@@ -8,7 +8,7 @@ module Kamisaku
       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]
+      pdf.write_to_html_file(options[:html_output]) if options[:html_output]
     end
   end
 end

data/lib/kamisaku/content_validator.rb

@@ -25,14 +25,15 @@ module Kamisaku
       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]
+      allowed_fields = %i[name title about photo_url]
+      required_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
+      unless required_fields.all? { |field| profile_fields.include?(field) }
         raise Error, "Profile must contain exactly the fields: #{allowed_fields.join(", ")}"
       end
 
@@ -41,6 +42,19 @@ module Kamisaku
           raise Error, "Profile field '#{field}' must be a string"
         end
       end
+
+      if data[:profile][:photo_url]
+        validate_photo_url(data[:profile][:photo_url])
+      end
+    end
+
+    def validate_photo_url(photo_url)
+      raise Error, "Profile field '#{field}' must be a string" unless photo_url.is_a?(String)
+
+      valid_url_regex = /\Ahttps?:\/\/.+\.(jpg|jpeg)\z/i
+      unless valid_url_regex.match?(photo_url)
+        raise Error, "Invalid photo_url. It must be an HTTP/HTTPS URL ending with .jpg or .jpeg"
+      end
     end
 
     def validate_contact
@@ -54,10 +68,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")
@@ -91,7 +101,7 @@ module Kamisaku
       data[:skills].each do |skill|
         raise Error, "Each skill must be a hash" unless skill.is_a?(Hash)
 
-        allowed_fields = %i[area items]
+        allowed_fields = %i[name items]
         skill_fields = skill.keys
 
         unless skill_fields.all? { |field| allowed_fields.include?(field) }
@@ -102,7 +112,7 @@ module Kamisaku
           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 'name' must be a string" unless skill[:name].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|

data/lib/kamisaku/pdf.rb

@@ -1,3 +1,5 @@
+require "tempfile"
+
 module Kamisaku
   class PDF
     attr_reader :content_hash, :template
@@ -17,7 +19,7 @@ module Kamisaku
       end
     end
 
-    def generate_html(html_location)
+    def write_to_html_file(html_location)
       html_file { |file_path| FileUtils.cp(file_path, html_location) }
     end
 

data/lib/kamisaku/template_helpers.rb

@@ -2,7 +2,15 @@ require "date"
 
 module Kamisaku
   module TemplateHelpers
-    TEMPLATES = %w[paper sleek].freeze
+    TEMPLATES = %w[
+      paper
+      sleek
+      zenith
+      meridian
+      prism
+      gradient
+      chromatic
+    ].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.2"
+  VERSION = "0.3.4"
 end

data/lib/schema/example.yml

@@ -0,0 +1,274 @@
+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:
+  - name: Development
+    items:
+      - Python
+      - Django
+      - ReactJS
+      - TypeScript
+      - Node.js
+  - name: Database
+    items:
+      - PostgreSQL
+      - MySQL
+      - Redis
+  - name: Testing
+    items:
+      - PyTest
+      - Jest
+      - Cypress
+      - Selenium
+  - name: Version Control
+    items:
+      - Git
+      - GitHub
+      - GitLab
+  - name: Platforms/OS
+    items:
+      - AWS
+      - Google Cloud
+      - Linux
+
+interests:
+  - name: Yoga
+  - name: Travelling
+  - name: Photography
+  - name: Hiking
+  - name: Chess
+  - name: Reading
+  - name: Cooking
+  - name: Gardening
+  - name: Running
+  - name: Fitness
+  - name: 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.
+
+projects:
+  - name: E-commerce Analytics Platform
+    description: >
+      Developed a comprehensive full-stack web application for real-time sales analytics and inventory management.
+      The platform features interactive dashboards, automated reporting, real-time inventory tracking, predictive
+      analytics for sales forecasting, and integration with multiple payment gateways.
+    technologies:
+      - React
+      - Python
+      - PostgreSQL
+      - Redis
+      - Docker
+    link: https://github.com/johndoe/ecommerce-analytics
+
+  - name: Open Source Task Scheduler
+    description: >
+      Created a distributed task scheduling library with Redis backend that supports job queuing, task 
+      prioritization, retry mechanisms, and dead letter queues. Features include task dependencies, 
+      scheduling with cron expressions, real-time monitoring dashboard, horizontal scaling capabilities,
+      and fault tolerance with automatic task recovery.
+    technologies:
+      - Python
+      - Redis
+      - Celery
+      - Docker
+    link: https://github.com/johndoe/task-scheduler
+
+certifications:
+  - name: AWS Certified Solutions Architect
+    issuer: Amazon Web Services
+    date:
+      day: 15
+      month: 8
+      year: 2022
+    credential_url: https://aws.amazon.com/verification/ABCD1234EFGH5678
+
+  - name: Certified Kubernetes Administrator
+    issuer: Cloud Native Computing Foundation
+    date:
+      day: 20
+      month: 11
+      year: 2021
+    credential_url: https://training.linuxfoundation.org/certification/verify
+
+awards:
+  - title: Employee of the Year
+    issuer: CloudCore Solutions
+    date:
+      day: 1
+      month: 12
+      year: 2023
+    description: Recognized for outstanding contribution to team performance and technical innovation
+
+  - title: Best Final Year Project
+    issuer: Brighton Institute of Technology
+    date:
+      day: 15
+      month: 5
+      year: 2013
+    description: Awarded for developing an innovative machine learning algorithm for image recognition
+
+languages:
+  - name: English
+  - name: Spanish
+  - name: French
+
+publications:
+  - title: "Microservices Architecture Patterns for Scalable Web Applications"
+    publisher: Tech Journal Quarterly
+    date:
+      day: 15
+      month: 3
+      year: 2023
+    link: https://techjournal.com/articles/microservices-patterns
+
+  - title: "Optimizing Database Performance in High-Traffic Applications"
+    publisher: Software Engineering Today
+    date:
+      day: 10
+      month: 9
+      year: 2022
+    link: https://se-today.com/db-optimization
+
+conferences:
+  - name: AWS re:Invent 2023
+    role: Attendee
+    date:
+      day: 27
+      month: 11
+      year: 2023
+    description: Attended sessions on serverless architecture and machine learning
+
+  - name: PyCon UK 2022
+    role: Speaker
+    date:
+      day: 16
+      month: 9
+      year: 2022
+    description: Presented on "Building Scalable APIs with FastAPI and PostgreSQL"
+
+volunteering:
+  - organization: Code for Good
+    role: Technical Mentor
+    description: Mentoring young developers and contributing to open-source projects for non-profits
+    date:
+      day: 1
+      month: 6
+      year: 2020
+
+  - organization: Local Food Bank
+    role: Technology Volunteer
+    description: Developed a volunteer scheduling system to improve operational efficiency
+    date:
+      day: 15
+      month: 3
+      year: 2019

data/lib/schema/schema.yml

@@ -0,0 +1,112 @@
+# Template schema structure for resume
+
+version: 1
+profile: # required
+  name: # required: the name
+  title: # optional: job title if applicable
+  about: # optional: A short summary of the experience and person
+
+contact: # optional
+  github: # optional: GitHub username
+  mobile: # optional: mobile or phone number
+  email: # optional: email address
+  linkedin: # optional: LinkedIn username
+  location: #
+    country: # optional: country name you are based at
+    city: # optional: city name you are based at
+
+skills: # optional
+  - name: # required: specific skill name you are specialized in
+    items: # optional
+      - # subitem such as a technology you have the skill in under the specialized area
+
+experiences: # optional
+  - title: # required: job title
+    organisation: # required: Name of the place you worked
+    location: # optional
+      city: # optional: city name
+      country: # optional: country name
+    from: # required
+      month: # required: month integer number that you started
+      year: # required: year integer number that you started
+    to: # optional: if the section not given, it is assumed you are still working
+      month: # required: month integer number that you stopped
+      year: # required: year integer number that you stopped
+    skills: # optional
+      - # a short name for a specialized skill you gained at the organization
+    achievements: # optional
+      - # A short sentence of things you have achieved. Consider reflecting the impact it made.
+
+education: # optional
+  - institute: # required: name of the place you studied
+    location: # optional
+      city: # optional: city name
+      country: # optional: country name
+    qualification: # required: name of the degree, diploma, or certificate qualification
+    field: # optional: name of the field such as Computer Science
+    from: # optional
+      month: # required: month integer number that you started
+      year: # required: year integer number that you started
+    to: # optional: if you have finished studying at the institute, provide this section. Otherwise, do not provide
+      month: # required: month integer number that you stopped
+      year: # required: year integer number that you stopped
+    achievements: # optional
+      - # A list of things you have achieved or did at the institute.
+
+projects: # optional: Showcase notable personal or professional projects
+  - name: # required: Project title
+    description: # optional: Short summary of the project
+    technologies: # optional: Tools or stack used
+      - # required: technology/stack name
+    link: # optional: URL to the project or code
+
+certifications: # optional: Any licenses, exams, or certifications earned
+  - name: # required: Name of the certification
+    issuer: # optional: Organization that issued it
+    date: # optional: Date earned or issued
+      day: # required: day of month between 1 and 31
+      month: # required: month integer number
+      year: # required: year integer number
+    credential_url: # optional: Verification or badge link
+
+awards: # optional: Any recognition, awards, or honors received
+  - title: # required: Name of the award
+    issuer: # optional: Organization or context in which it was awarded
+    date: # optional: When it was awarded
+      day: # required: day of month between 1 and 31
+      month: # required: month integer number
+      year: # required: year integer number
+    description: # optional: Brief explanation or context
+
+languages: # optional: Languages you speak and your proficiency level
+  - name: # required: Language (e.g., English, Spanish)
+
+interests: # optional: Hobbies or areas of personal interest
+  - name: # required: Interest or activity name
+
+publications: # optional: For academic or research roles
+  - title: # required
+    publisher: # optional
+    date: # optional:
+      day: # required: day of month between 1 and 31
+      month: # required: month integer number
+      year: # required: year integer number
+    link: # optional
+
+conferences: # optional: Attended or spoken at industry events
+  - name: # required
+    role: # optional: (e.g., Speaker, Attendee)
+    date: # optional:
+      day: # required: day of month between 1 and 31
+      month: # required: month integer number
+      year: # required: year integer number
+    description: # optional
+
+volunteering: # optional: Especially useful for non-profit or early-career roles
+  - organization: # required
+    role: # optional
+    description: # optional
+    date: # optional:
+      day: # required: day of month between 1 and 31
+      month: # required: month integer number
+      year: # required: year integer number