my-last-cv 0.0.7 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56c56926e52415beebd4ff21594a85a4ef86be44f2ebe1716b5454204714f0e9
-  data.tar.gz: c75b9746a02372e488fd237f9d6ee667f9136b126826716b870c3f74816a0a1d
+  metadata.gz: 04b56bee3c092687375a967a44f81464be5f0b34fa3a453499fb4b3ac22fda06
+  data.tar.gz: dcaccb9a74c42cf24267201ddd6e95b17c434cbfb955fb8479ec3e88d76f5fab
 SHA512:
-  metadata.gz: 229b38de93a8b39be1ba36ae5f3de149e3bdef877967ee0dd2d6c4cf8db14003de54f804438da98d4711d9f37c6249d92c0a8c3a17e190fdd66d227736c1af08
-  data.tar.gz: 9426974cfee0e9c7abbf5759bb95a449ecf210ab24bc7c57db04889a5480f8a27a2ff9c2ccd4dab7efb201a4f60089673e1b118890fa61e6ea9bc02a5f10aa42
+  metadata.gz: ba6f2f816174ee03ed4f417caca9e65b8cfeec6c684b29166f687d8ca7ac0e8a090026d7f1cafc68fdac27a42cf934126fc339b3efef8e83920d5fdac7b8fd7f
+  data.tar.gz: b514c0f500dec9398744f3185295ee350d4deaf9b647a789a9f0f893d9c729716d8235c2c706571bab428785d31a0150f729582f94a8cba2c7354aadff9fed38

data/README.md

@@ -1,14 +1,128 @@
 # my-last-cv
-A simple gem to generate beautiful CV from a markdown file
 
-## How to use it?
+A Ruby gem and command-line tool that generates a styled PDF CV from Markdown.
+
+## Requirements
+
+Ruby 3.0 or later.
+
+## Installation
+
 ```bash
 bundle add my-last-cv
 bundle install
-bundle exec my_last_cv sample/cv.md output/cv.pdf
 ```
 
+For local development, install the project's dependencies:
+
+```bash
+bundle install
+```
+
+## Generate a CV
+
+```bash
+bundle exec my_last_cv path/to/cv.md output/cv.pdf
+```
+
+The output directory is created automatically. The CLI uses the bundled Inter and
+Lora fonts. Start from [`sample/cv.md`](sample/cv.md) to create your document.
+Its compact layout is designed to fit typical CVs on a single page.
+
+## Markdown format
+
+Use YAML front matter for contact information, a level-one heading for the name,
+level-two headings for sections, and level-three headings for entries within a
+section:
+
+```markdown
+---
+title: "Ruby developer"
+email: "jane@example.com"
+phone: "+33 6 12 34 56 78"
+linkedin: "https://www.linkedin.com/in/janedoe"
+github: "https://github.com/janedoe"
+website: "https://janedoe.dev"
+location: "Paris, France"
+---
+
+# Jane Doe
+Short professional introduction displayed below the header.
+
+## Experience
+### Senior Developer — Example Corp
+Introductory paragraph for this role.
+- Built and maintained Ruby applications.
+- Mentored other developers.
+
+## Skills
+- Ruby
+- PostgreSQL
+```
+
+Supported front-matter contact keys are `name`, `title`, `email`, `phone`,
+`linkedin`, `github`, `website`, and `location`. They are rendered with icons;
+`name` and `title` are omitted from the contact list when they duplicate the
+document heading or introduction.
+
+Text immediately below the main heading becomes the introduction. Section and
+entry content can contain paragraphs and bullet lists. A `###` entry without a
+preceding `##` section is placed in a section named `Divers`.
+
+## Inline Markdown support
+
+Contact fields, headings, paragraphs, and bullet items support:
+
+- `**bold**`
+- `*italic*`
+- `` `code` ``
+- `[links](https://example.com)`
+
+Escape Markdown punctuation with a backslash when it should remain literal, for
+example `\*not italic\*`.
+
+## Ruby API and styling
+
+```ruby
+require "my_last_cv"
+
+style = MyLastCV::Style.new(
+  header_font: "Inter",
+  header_size: 22,
+  section_font: "Inter",
+  section_size: 12,
+  body_font: "Lora",
+  body_size: 10,
+  page_options: { margin: 36 },
+  accent_color: "1F7AE0"
+)
+
+MyLastCV.generate("cv.md", "output/cv.pdf", style: style)
+```
+
+`MyLastCV::Style` defaults to Helvetica, sizes `18`, `12`, and `10`, a page
+margin of `48`, and a black accent color (`000000`). `page_options` is passed to
+`Prawn::Document`, so Prawn page settings such as `page_size` and `layout` can
+also be supplied.
+
 ## Custom fonts
-By default, the gem looks for fonts in `./fonts` of the calling project.
-You can override this with `Style.new(fonts_dir: "/path/to/fonts")`
-or `MY_LAST_CV_FONTS_DIR=/path/to/fonts`.
+
+Inter and Lora are bundled with the gem. To override them, provide a directory
+containing `Inter-Regular.ttf`, `Inter-Bold.ttf`, `Lora-Regular.ttf`, and
+`Lora-Bold.ttf`. Optional `Inter-Italic.ttf`, `Inter-BoldItalic.ttf`,
+`Lora-Italic.ttf`, and `Lora-BoldItalic.ttf` files enable matching italic
+styles; missing variants fall back to their regular or bold face.
+
+```ruby
+MyLastCV::Style.new(fonts_dir: "/path/to/fonts")
+```
+
+Alternatively, set `MY_LAST_CV_FONTS_DIR=/path/to/fonts`. Font directories are
+resolved in this order: `fonts_dir`, `MY_LAST_CV_FONTS_DIR`, `./fonts`, then the
+fonts bundled with the gem.
+
+## Development
+
+```bash
+bundle exec rake spec
+```

data/exe/my_last_cv

@@ -12,12 +12,12 @@ input, output = ARGV
 
 pro = MyLastCV::Style.new(
   header_font:  "Inter",
-  header_size:  22,
+  header_size:  20,
   section_font: "Inter",
-  section_size: 12,
+  section_size: 11,
   body_font:    "Lora",
-  body_size:    10,
-  page_options: { margin: 36 },
+  body_size:    9,
+  page_options: { margin: 30 },
   accent_color: "1F7AE0" # blue
 )
 

data/lib/my_last_cv/inline.rb

@@ -0,0 +1,141 @@
+require 'cgi'
+
+module MyLastCV
+  class Inline
+    LINK_COLOR = '0563C1'.freeze
+    ESCAPABLE_CHARACTERS = "`*[]()".chars.freeze
+
+    def self.parse(text)
+      new(text).parse
+    end
+
+    def initialize(text)
+      @text = text.to_s
+      @index = 0
+    end
+
+    def parse
+      parse_until(nil).first
+    end
+
+    private
+
+    def parse_until(stop_token)
+      output = +""
+
+      while @index < @text.length
+        if stop_token && token?(stop_token)
+          @index += stop_token.length
+          return [output, true]
+        end
+
+        output << if escaped_character?
+                    consume_escaped_character
+                  elsif token?('**')
+                    parse_emphasis('**', 'b')
+                  elsif token?('*')
+                    parse_emphasis('*', 'i')
+                  elsif token?('`')
+                    parse_code
+                  elsif token?('[')
+                    parse_link
+                  else
+                    consume_plain_character
+                  end
+      end
+
+      [output, false]
+    end
+
+    def escaped_character?
+      current_character == '\\' && (next_character == '\\' || ESCAPABLE_CHARACTERS.include?(next_character))
+    end
+
+    def consume_escaped_character
+      character = next_character
+      @index += 2
+      CGI.escapeHTML(character)
+    end
+
+    def consume_plain_character
+      character = current_character
+      @index += 1
+      CGI.escapeHTML(character)
+    end
+
+    def parse_emphasis(delimiter, tag)
+      start_index = @index
+      @index += delimiter.length
+      content, closed = parse_until(delimiter)
+
+      return "<#{tag}>#{content}</#{tag}>" if closed && !content.empty?
+
+      CGI.escapeHTML(@text[start_index...@index])
+    end
+
+    def parse_code
+      start_index = @index
+      @index += 1
+      content = +""
+
+      while @index < @text.length && !token?('`')
+        content << @text[@index]
+        @index += 1
+      end
+
+      return CGI.escapeHTML(@text[start_index...@index]) if @index >= @text.length
+
+      @index += 1
+      "<font name=\"Courier\">#{CGI.escapeHTML(content)}</font>"
+    end
+
+    def parse_link
+      start_index = @index
+      @index += 1
+      label, closed = parse_until(']')
+      return CGI.escapeHTML(@text[start_index...@index]) unless closed
+      return CGI.escapeHTML(@text[start_index...@index]) unless token?('(')
+
+      @index += 1
+      url, closed = parse_link_destination
+      return CGI.escapeHTML(@text[start_index...@index]) unless closed
+      return CGI.escapeHTML(@text[start_index...@index]) if url.strip.empty?
+
+      %(<color rgb="#{LINK_COLOR}"><u><link href="#{CGI.escapeHTML(url)}">#{label}</link></u></color>)
+    end
+
+    def parse_link_destination
+      start_index = @index
+      depth = 0
+
+      while @index < @text.length
+        if token?('(')
+          depth += 1
+        elsif token?(')')
+          if depth.zero?
+            url = @text[start_index...@index]
+            @index += 1
+            return [url, true]
+          end
+
+          depth -= 1
+        end
+        @index += 1
+      end
+
+      [@text[start_index...@index], false]
+    end
+
+    def token?(value)
+      @text[@index, value.length] == value
+    end
+
+    def current_character
+      @text[@index]
+    end
+
+    def next_character
+      @text[@index + 1]
+    end
+  end
+end

data/lib/my_last_cv/parser.rb

@@ -129,7 +129,8 @@ module MyLastCV
     def handle_contact(line)
       key, value = line.split(":", 2)
       @result[:contact] ||= {}
-      @result[:contact][key] = value.strip
+      normalized_key = key.to_s.strip.downcase
+      @result[:contact][normalized_key] = value.to_s.strip
     end
 
     def handle_section(line)

data/lib/my_last_cv/renderer.rb

@@ -2,6 +2,7 @@ require 'prawn'
 require 'prawn/icon'
 require 'fileutils'
 require_relative 'icons'
+require_relative 'inline'
 
 module MyLastCV
   class Renderer
@@ -37,28 +38,38 @@ module MyLastCV
       fonts_dir = resolved_fonts_dir
       return unless fonts_dir
 
-      # Example : Inter (Regular / Bold)
       pdf.font_families.update(
-        "Inter" => {
-          normal: File.join(fonts_dir, "Inter-Regular.ttf"),
-          bold:   File.join(fonts_dir, "Inter-Bold.ttf")
-        },
-        "Lora" => {
-          normal: File.join(fonts_dir, "Lora-Regular.ttf"),
-          bold:   File.join(fonts_dir, "Lora-Bold.ttf")
-        }
+        "Inter" => font_family_files(fonts_dir, "Inter"),
+        "Lora" => font_family_files(fonts_dir, "Lora")
       )
     end
 
+    def font_family_files(fonts_dir, family)
+      regular = File.join(fonts_dir, "#{family}-Regular.ttf")
+      bold = File.join(fonts_dir, "#{family}-Bold.ttf")
+      italic = File.join(fonts_dir, "#{family}-Italic.ttf")
+      bold_italic = File.join(fonts_dir, "#{family}-BoldItalic.ttf")
+
+      {
+        normal: regular,
+        bold: bold,
+        italic: File.file?(italic) ? italic : regular,
+        bold_italic: File.file?(bold_italic) ? bold_italic : bold
+      }
+    end
+
     def render_header(pdf)
-      pdf.move_down 12
+      pdf.move_down 4
       pdf.font(@style.body_font)
-      @parsed_cv[:contact].each_key do |key|
+      contact = @parsed_cv[:contact] || {}
+      contact.each do |key, value|
+        next if redundant_contact_field?(key, value)
+
         icon = "<icon size=\"#{@style.body_size}\">#{MyLastCV::Icons::MAP[key.to_sym]}</icon>"
-        pdf.icon("#{icon}  #{@parsed_cv[:contact][key]}", inline_format: true)
+        pdf.icon("#{icon}  #{Inline.parse(value)}", inline_format: true)
       end
 
-      pdf.move_down 6
+      pdf.move_down 2
       pdf.font(@style.header_font)
       with_color(pdf, @style.accent_color) do
         pdf.text(@parsed_cv[:title] || '-', size: @style.header_size, align: :center)
@@ -69,29 +80,43 @@ module MyLastCV
       pdf.stroke_horizontal_rule
 
       if @parsed_cv[:intro]&.any?
-        pdf.move_down 10
+        pdf.move_down 4
         @parsed_cv[:intro].each do |p|
-          pdf.text(p, size: @style.body_size, leading: 2)
+          pdf.text(Inline.parse(p), size: @style.body_size, leading: 2, inline_format: true)
+        end
+      end
+      pdf.move_down 4
+    end
+
+    def redundant_contact_field?(key, value)
+      case key
+      when "name"
+        value.to_s.strip.casecmp?(@parsed_cv[:title].to_s.strip)
+      when "title"
+        title = value.to_s.strip
+        Array(@parsed_cv[:intro]).any? do |paragraph|
+          paragraph.to_s.sub(/\A\*+/, "").start_with?(title)
         end
+      else
+        false
       end
-      pdf.move_down 10
     end
 
     def render_sections(pdf)
       (@parsed_cv[:sections] || []).each do |section|
-        pdf.move_down 8
+        pdf.move_down 4
         pdf.font(@style.section_font)
 
         with_color(pdf, @style.accent_color) do
-          pdf.text(section[:title], size: @style.section_size, style: :bold)
+          pdf.text(Inline.parse(section[:title]), size: @style.section_size, style: :bold, inline_format: true)
         end
 
         render_items(pdf, section[:items])
 
         (section[:elements] || []).each do |el|
-          pdf.move_down 6
+          pdf.move_down 3
           pdf.font(@style.section_font)
-          pdf.text(el[:title], size: (@style.section_size - 3), style: :bold)
+          pdf.text(Inline.parse(el[:title]), size: (@style.section_size - 3), style: :bold, inline_format: true)
           render_items(pdf, el[:items])
         end
       end
@@ -100,16 +125,16 @@ module MyLastCV
     def render_items(pdf, items)
       return if items.nil? || items.empty?
 
-      pdf.move_down 4
+      pdf.move_down 1
       pdf.font(@style.body_font)
 
       (items || []).each do |item|
         case item[:type]
         when :bullet
-          pdf.text("• #{item[:text]}", size: @style.body_size, indent_paragraphs: 16)
+          pdf.text("• #{Inline.parse(item[:text])}", size: @style.body_size, indent_paragraphs: 16, inline_format: true)
         when :paragraph
-          pdf.text(item[:text], size: @style.body_size, leading: 2)
-          pdf.move_down 4
+          pdf.text(Inline.parse(item[:text]), size: @style.body_size, leading: 2, inline_format: true)
+          pdf.move_down 1
         else
           # fallback (au cas où)
           pdf.text(item.to_s, size: @style.body_size)

data/lib/my_last_cv/version.rb

@@ -1,3 +1,3 @@
   module MyLastCV
-    VERSION = "0.0.7"
+    VERSION = "0.0.9"
   end

data/lib/my_last_cv.rb

@@ -1,4 +1,5 @@
 require_relative 'my_last_cv/version'
+require_relative 'my_last_cv/inline'
 require_relative 'my_last_cv/parser'
 require_relative 'my_last_cv/style'
 require_relative 'my_last_cv/renderer'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: my-last-cv
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.9
 platform: ruby
 authors:
 - Maxime Hanicotte
@@ -76,8 +76,14 @@ extra_rdoc_files: []
 files:
 - README.md
 - exe/my_last_cv
+- fonts/Inter-Bold.ttf
+- fonts/Inter-Italic.ttf
+- fonts/Inter-Regular.ttf
+- fonts/Lora-Bold.ttf
+- fonts/Lora-Regular.ttf
 - lib/my_last_cv.rb
 - lib/my_last_cv/icons.rb
+- lib/my_last_cv/inline.rb
 - lib/my_last_cv/parser.rb
 - lib/my_last_cv/renderer.rb
 - lib/my_last_cv/style.rb
@@ -106,7 +112,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.1
+rubygems_version: 3.7.2
 specification_version: 4
 summary: Generate your CV from Markdown to PDF
 test_files: []