kamisaku 0.1.0

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.4.3

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+
+### Changed
+
+### Removed

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at sinaru@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+ruby "3.4.3"
+
+# Specify your gem's dependencies in kamisaku.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+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

@@ -0,0 +1,72 @@
+PATH
+  remote: .
+  specs:
+    kamisaku (0.1.0)
+
+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)
+    rake (13.2.1)
+    regexp_parser (2.10.0)
+    rexml (3.4.1)
+    rubocop (1.57.2)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.4)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.44.1)
+      parser (>= 3.3.7.2)
+      prism (~> 1.4)
+    rubocop-minitest (0.33.0)
+      rubocop (>= 1.39, < 2.0)
+    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
+  arm64-darwin-22
+  x86_64-linux
+
+DEPENDENCIES
+  kamisaku!
+  minitest (~> 5.0)
+  pdfkit
+  prawn
+  rake (~> 13.0)
+  rubocop (= 1.57.2)
+  rubocop-minitest (~> 0.33.0)
+  rubocop-rake (~> 0.6.0)
+
+RUBY VERSION
+   ruby 3.4.3p32
+
+BUNDLED WITH
+   2.3.7

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Sinaru Gunawardena
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,128 @@
+# 📃 Kamisaku
+
+*Build a CV PDF from a yaml text file.*
+
+![Kamisaku](kamisaku.png)
+
+See [examples](/examples) directory for sample generated PDF files based of [templates](/lib/templates).
+
+## Usage
+
+First we need to have a `yaml` file with the CV data. The yaml file supports following sections.
+
+```yaml
+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 number that you started
+      year: # year number that you started
+  # if following is not given, it is assumed you are still working
+    to:
+      month: # month number that you stopped
+      year: # year number that you stopped
+    skills:
+      - # a short name for a specialized skilled you gained
+    achievements:
+      - # Things you have achieved or did
+
+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 number that you started
+      year: # year number that you started
+    # if following is not given, it is assumed you are still studying
+    to:
+      month: # month number that you stopped
+      year: # year number that you stopped
+    achievements:
+      - # Things you have achieved or did
+```
+See [examples](/examples) directory for sample generated PDF files based of [templates](/lib/templates).
+
+## 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.
+
+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
+
+Once you have the YAML text file, feed it into the `bin/console` and specify the output location.
+
+```bash
+bin/console -c examples/john_doe.yml -o examples/plain/john_doe.pdf  -t plain
+```
+
+#### Bash options
+
+- `-c` the YAML file
+- `-o` output location for the PDF file including the name
+- `-t` template to use
+
+## 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.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sinaru/kamisaku. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/kamisaku/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/mit).
+
+## Code of Conduct
+
+Everyone interacting in the Kamisaku project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/kamisaku/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/examples/john_doe.yml

@@ -0,0 +1,157 @@
+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:
+  - area: Development
+    items:
+      - Python
+      - Django
+      - ReactJS
+      - TypeScript
+      - Node.js
+  - area: Database
+    items:
+      - PostgreSQL
+      - MySQL
+      - Redis
+  - area: Testing
+    items:
+      - PyTest
+      - Jest
+      - Cypress
+      - Selenium
+  - area: Version Control
+    items:
+      - Git
+      - GitHub
+      - GitLab
+  - area: Platforms/OS
+    items:
+      - AWS
+      - Google Cloud
+      - Linux
+
+interests:
+  - Yoga
+  - Travelling
+  - Photography
+  - Hiking
+  - Chess
+  - Reading
+  - Cooking
+  - Gardening
+  - Running
+  - Fitness
+  - 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.

data/lib/kamisaku/arg_parser.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "optparse"
+
+module Kamisaku
+  module ArgParser
+    def self.parse!
+      options = {}
+
+      OptionParser.new do |parser|
+        parser.on("--html-debug-path HTML_OUTPUT") do |html_output|
+          options[:html_output] = html_output
+        end
+
+        parser.on("-c", "--cv-info INFO", "Require the INFO") do |cv_info|
+          options[:cv_info] = cv_info
+        end
+
+        parser.on("-o", "--output-path OUTPUT", "Require the OUTPUT") do |output_path|
+          options[:output_path] = output_path
+        end
+
+        parser.on("-t", "--template-path 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?
+
+      options
+    end
+  end
+end

data/lib/kamisaku/cv_data.rb

@@ -0,0 +1,56 @@
+# 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

@@ -0,0 +1,24 @@
+# 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

@@ -0,0 +1,15 @@
+# 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

@@ -0,0 +1,15 @@
+# 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

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