kamisaku 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 60a3dc3cc7212e2e7f161aaac32c7ff2ed0480a6e9282d38580a4a179df387d5
-  data.tar.gz: 475477cd26f0190e240133ead67e367f1a64539e2bdd21574c76d8e3284b4821
+  metadata.gz: 4292c2079171e643c3b2cbc54a57710c23e5b2abcc8689b03dcb25ecef691af2
+  data.tar.gz: f101f3fae445b34b437612c29bb64e067c27d4f46e036d0c3e4d2d1d32019ddc
 SHA512:
-  metadata.gz: 9c376919d7dde1c68506dceb3f9aec9e447edbd4dec8211e0e49fbcea00c809f8752f04ec908a517fec2016c50646a85472d26fe1f5d7c49d80d4f8d948d4e65
-  data.tar.gz: efd056f25b356c0cb2ca24a9f75d0c760db7d2d51f9e0d5cf27749e7d144c81f85c17c7e4814f98813781e30b874facff8402f8fbd8ead50cf235f3e83cbc063
+  metadata.gz: 281c18ed0c9ab2d7131c11cda21ba48be132fb5e09ac0aac738bb6e4f53644b767778dc2cd08c622f4e9a597aeaa2c7a28b15f6752beb8e778711bd331e805c7
+  data.tar.gz: 8f07ab76298f53cd2d75790797d4a5823850ad5108f23dfcb9cdcf8e393b18417d8e525bbde89aa837831480b2a7392074826bddbc53bda285b0d618df6f7db3

data/CHANGELOG.md

@@ -13,10 +13,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Removed
 
+## [0.4.2] - 2025.12.31
+
+### Changed
+- Use symbols for template names internally
+
 ## [0.4.1] - 2025.06.09
 
 ### Changed
- - Fix `Kamisaku::BirthdayInvitationContentValidator` template listing
+- Fix `Kamisaku::BirthdayInvitationContentValidator` template listing
 
 ## [0.4.0] - 2025.06.09
 

data/Gemfile.lock

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

data/README.md

@@ -1,6 +1,6 @@
 # 📃 Kamisaku
 
-*Build resume PDF from a yaml text file.*
+*Build resume PDF from a YAML text file.*
 
 🚀 See it in action at [https://kamisaku.sinaru.com/](https://kamisaku.sinaru.com/?utm_source=github).
 
@@ -8,10 +8,18 @@
 
 ![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 PDF generation, check the [examples](/examples) directory where each directory name is a template name.
+
+For a list of templates available for PDF generation, check the [examples](/examples) directory where each directory 
+name is a template name.
+
+The templates are simple ERB files. You can find the templates in [`/lib/templates`](/lib/templates).
+
+## Example YAML files
+
+Each type of document (e.g., resume) has its own schema based of YAML. There are example YAML files for the schemas for 
+each document type in `/lib/schema`. For example, for resume, see [`/lib/schema/resume/example.yml`](/lib/schema/resume/example.yml).
+You can use them to try the PDF generation.
 
 ## Installation
 
@@ -23,7 +31,7 @@ This is a Ruby gem. So you can either install as a gem or clone the repo and use
 - 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.
+  - exiftool is used to soft-remove metadata added by chrome in the PDF file.
 
 Add this line to your application's Gemfile:
 
@@ -42,9 +50,9 @@ $ gem install kamisaku
 
 ## Usage
 
-First we need to have a `yaml` file or a string with the correct schema data structure for the type of the PDF you are generating.
+First, we need to have a YAML file or a string with the correct schema data structure for the type of the PDF you are generating.
 
-For the list of schemas, check `lib/schema` folder. E.g. For resume it is `lib/schema/resume/schema.yml`.
+For the list of schemas, check `lib/schema` folder. E.g. For resume, it is `lib/schema/resume/schema.yml`.
 
 ## Generating PDF
 
@@ -53,7 +61,7 @@ For the list of schemas, check `lib/schema` folder. E.g. For resume it is `lib/s
 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/paper/john_doe.pdf -k resume -t paper
+bin/console -c lib/schema/resume/example.yml -o ~/Downloads/test_resume.pdf -k resume -t paper
 ```
 
 #### Bash options
@@ -80,31 +88,36 @@ 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.
+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`.
 
 ### 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.
+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. 
+The template will be exposed to a Ruby hash variable called `data`. This data represents 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`
+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).
+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).
+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
 
@@ -112,4 +125,5 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## 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).
+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

@@ -6,7 +6,7 @@ require "rake/testtask"
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
   t.libs << "lib"
-  t.test_files = FileList["test/**/test_*.rb"]
+  t.test_files = FileList["test/**/*_test.rb"]
 end
 
 require "rubocop/rake_task"

data/lib/kamisaku/content_validators/birthday_invitation_content_validator.rb

@@ -1,6 +1,6 @@
 module Kamisaku
   class BirthdayInvitationContentValidator < BaseContentValidator
-    TEMPLATES = %w[
+    TEMPLATES = %i[
       dino
     ].freeze
 

data/lib/kamisaku/content_validators/resume_content_validator.rb

@@ -1,6 +1,6 @@
 module Kamisaku
   class ResumeContentValidator < Kamisaku::BaseContentValidator
-    TEMPLATES = %w[
+    TEMPLATES = %i[
       paper
       sleek
       zenith

data/lib/kamisaku/pdf.rb

@@ -11,13 +11,14 @@ module Kamisaku
 
     def initialize(content_hash:, category:, template:)
       @content_hash = content_hash
-      @category = category
-      @template = template
+      @category = category.to_sym
+      @template = template.to_sym
+
       raise Error, "Invalid template name '#{template}'" unless template.is_a?(String)
-      validator_klass = CONTENT_VALIDATOR_MAP[category.to_sym]
-      raise Error, "Invalid template name '#{category}'" unless validator_klass
+      validator_klass = CONTENT_VALIDATOR_MAP[@category]
+      raise Error, "Invalid template name '#{@category}'" unless validator_klass
       validator_klass.new(content_hash:).validate!
-      raise Error, "Invalid template name '#{template}'" unless validator_klass::TEMPLATES.include?(template)
+      raise Error, "Invalid template name '#{@template}'" unless validator_klass::TEMPLATES.include?(@template)
     end
 
     def write_to(pdf_location)

data/lib/kamisaku/version.rb

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

data/scripts/rebuild_examples.rb

@@ -27,11 +27,11 @@ end.parse!
 
 categories = options[:category] ? [options[:category]] : Kamisaku::PDF::CONTENT_VALIDATOR_MAP.keys
 
-Kamisaku::PDF::CONTENT_VALIDATOR_MAP.select {|key, value| categories.include? key }.each do | category, klass |
+Kamisaku::PDF::CONTENT_VALIDATOR_MAP.slice(*categories).each do |category, klass|
   templates = klass::TEMPLATES
 
   # Use specified template or all templates
-  templates = options[:template] ? templates.select {|t| t == options[:template] } : templates
+  templates = options[:template] ? templates.select { |t| t == options[:template] } : templates
 
   templates.each do |template|
     template_dir = File.expand_path("../examples/#{category}/#{template}", __dir__)

metadata

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