my-last-cv 0.0.6 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d2bc19ff6ce026645ff9fc68e65345b76a3087db661be1eac66a48379b3395e
-  data.tar.gz: 9edb1b606e386db51aa0272ea2ed87fe290c6273619fe5b65213430aa117663e
+  metadata.gz: 031a4dc86e72946d0fb8673b77738a6cbb3d30c2404c028267a88a78b8ae1463
+  data.tar.gz: b2ac4623552d0ae8f597f8dd58cb9bcb481b09f201ff899335054767cfcd1620
 SHA512:
-  metadata.gz: e9f25db116d350985c4a016bfea94876b926702c606e93faf3e8daf239e1b027f89654fddc0d3495cc10746a1c723f98057b848058e2a32dbefe02a6e13ee8d6
-  data.tar.gz: f2802143d81a0d3a0a2fb9e8bd46f550bf093db531e9e43172d1d0746d24713251a90bdeed255034e6593e951c2c64993f5214ae14c0bb7456b27b6d14c73582
+  metadata.gz: bcd26c3ab542f8b2ddf18dc894351bab8c1332181609164b47e2b79ef433d83ec6298509844f20907ee91caf1a6aceea43f451e76567dd48afc457fedd74f889
+  data.tar.gz: d38f99b4d9fab6a4c700628282ef21cc125590d8e4a4a1ab48ad625c5ebbed132cc1c89cc1b1b5cbf306c13bf503d4fa780d0c637c425388d8c0728345706c0f

data/README.md

@@ -1,14 +1,123 @@
 # 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.
+
+## 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.
+
+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, 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`:
+
+```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/lib/my_last_cv/icons.rb

@@ -0,0 +1,14 @@
+module MyLastCV
+  module Icons
+    MAP = {
+      name: "fas-user",
+      title: "fas-briefcase",
+      email: "fas-envelope",
+      phone: "fas-phone",
+      linkedin: "fab-linkedin",
+      github: "fab-github",
+      website: "fas-globe",
+      location: "fas-location-dot"
+    }.freeze
+  end
+end

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

@@ -1,116 +1,170 @@
+require 'yaml'
+
 module MyLastCV
   class Parser
+    LineHandler = Struct.new(:pattern, :method)
+
+    HANDLERS = [
+      LineHandler.new(/^(name|title|email|phone|linkedin|github|website|location):\s*(.+)/i, :handle_contact),
+      LineHandler.new(/^#\s+(.*)/, :handle_title),
+      LineHandler.new(/^##\s+(.*)/, :handle_section),
+      LineHandler.new(/^###\s+(.*)/, :handle_element),
+      LineHandler.new(/^[-*]\s+(.*)/, :handle_bullet)
+    ].freeze
+
+    CONTACT_KEYS = %w[name title email phone linkedin github website location].freeze
+
     def initialize(markdown)
       @markdown = markdown
     end
 
     def parse
-      lines = @markdown.lines.map(&:chomp)
-      result = { sections: [] }
-
-      current_section = nil
-      current_element = nil
-
-      # buffer
-      pending = []
-
-      # helpers
-      flush_pending_to = lambda do |target|
-        return if pending.empty?
-        text = pending.join(" ").strip
-        pending.clear
-        return if text.empty?
-        target[:items] ||= []
-        target[:items] << { type: :paragraph, text: text }
+      setup_state
+      extract_front_matter!
+      @markdown.each_line do |raw|
+        line = raw.rstrip
+
+        stripped = line.strip
+        next if stripped.empty? || stripped == '---'
+
+        handler = HANDLERS.find { |h| h.pattern.match?(line) }
+        if handler
+          send(handler.method, line)
+        else
+          handle_text(line)
+        end
       end
 
-      flush_pending_nowhere = lambda do
-        return if pending.empty?
-        text = pending.join(" ").strip
-        pending.clear
-        return if text.empty?
-        result[:intro] ||= []
-        result[:intro] << text
+      finalize
+      @result
+    end
+
+    private
+
+    def setup_state
+      @result = { sections: [] }
+      @current_section = nil
+      @current_element = nil
+      @pending = []
+    end
+
+    def extract_front_matter!
+      lines = @markdown.lines
+      return if lines.empty?
+      return unless lines.first&.strip == '---'
+
+      closing_index = lines[1..]&.find_index { |l| l.strip == '---' }
+      return unless closing_index
+
+      closing_index += 1
+
+      yaml_content = lines[1...closing_index].join
+      rest = lines[(closing_index + 1)..] || []
+
+      begin
+        data = YAML.safe_load(yaml_content) || {}
+      rescue StandardError
+        data = {}
       end
 
-      lines.each do |raw|
-        line = raw.rstrip
-        next if line.strip.empty?
-
-        if (m = line.match(/^#\s+(.*)/)) # New header
-          if current_element
-            flush_pending_to.call(current_element)
-          elsif current_section
-            flush_pending_to.call(current_section)
-          else
-            flush_pending_nowhere.call
-          end
-
-          result[:name] = m[1].strip
-          current_section = nil
-          current_element = nil
-
-        elsif (m = line.match(/^(email|phone|location):\s*(.+)/i))
-          (result[:contact] ||= []) << m[2].strip
-
-        elsif (m = line.match(/^##\s+(.*)/)) # New section
-          if current_element
-            flush_pending_to.call(current_element)
-          elsif current_section
-            flush_pending_to.call(current_section)
-          else
-            flush_pending_nowhere.call
-          end
-
-          current_section = { title: m[1].strip, items: [], elements: [] }
-          result[:sections] << current_section
-          current_element = nil
-
-        elsif (m = line.match(/^###\s+(.*)/)) # New element
-          if current_element
-            flush_pending_to.call(current_element)
-          elsif current_section
-            flush_pending_to.call(current_section)
-          else
-            flush_pending_nowhere.call
-          end
-
-          current_section ||= { title: "Divers", items: [], elements: [] }
-          result[:sections] << current_section unless result[:sections].include?(current_section)
-
-          current_element = { title: m[1].strip, items: [] }
-          current_section[:elements] ||= []
-          current_section[:elements] << current_element
-
-        elsif (m = line.match(/^[-*]\s+(.*)/)) # Bullet point
-          item = { type: :bullet, text: m[1].strip }
-          if current_element
-            flush_pending_to.call(current_element)
-            current_element[:items] << item
-          elsif current_section
-            flush_pending_to.call(current_section)
-            current_section[:items] << item
-          else
-            current_section = { title: "Divers", items: [item], elements: [] }
-            result[:sections] << current_section
-          end
+      if data.is_a?(Hash)
+        # Prefer explicit YAML title if present
+        @result[:title] = data['title'].to_s.strip unless data['title'].to_s.strip.empty?
 
-        else
-          pending << line.strip
+        CONTACT_KEYS.each do |k|
+          v = data[k]
+          next if v.nil? || v.to_s.strip.empty?
+          @result[:contact] ||= {}
+          @result[:contact][k] = v.to_s.strip
         end
       end
 
-      # End of parsing, flush any remaining pending text
-      if current_element
-        flush_pending_to.call(current_element)
-      elsif current_section
-        flush_pending_to.call(current_section)
+      @markdown = rest.join
+    end
+
+    def flush_pending_to(target)
+      return if @pending.empty?
+      text = @pending.join(" ").strip
+      @pending.clear
+      return if text.empty?
+      target[:items] ||= []
+      target[:items] << { type: :paragraph, text: text }
+    end
+
+    def flush_pending_nowhere
+      return if @pending.empty?
+      text = @pending.join(" ").strip
+      @pending.clear
+      return if text.empty?
+      (@result[:intro] ||= []) << text
+    end
+
+    def finalize
+      if @current_element
+        flush_pending_to(@current_element)
+      elsif @current_section
+        flush_pending_to(@current_section)
       else
-        flush_pending_nowhere.call
+        flush_pending_nowhere
       end
+    end
+
+    def flush_pending_current
+      if @current_element
+        flush_pending_to(@current_element)
+      elsif @current_section
+        flush_pending_to(@current_section)
+      else
+        flush_pending_nowhere
+      end
+    end
+
+    def handle_title(line)
+      flush_pending_current
+      @result[:title] = line.sub(/^#\s+/, "").strip
+      @current_section = nil
+      @current_element = nil
+    end
+
+    def handle_contact(line)
+      key, value = line.split(":", 2)
+      @result[:contact] ||= {}
+      normalized_key = key.to_s.strip.downcase
+      @result[:contact][normalized_key] = value.to_s.strip
+    end
+
+    def handle_section(line)
+      flush_pending_current
+      @current_section = { title: line.sub(/^##\s+/, "").strip, items: [], elements: [] }
+      @result[:sections] << @current_section
+      @current_element = nil
+    end
+
+    def handle_element(line)
+      flush_pending_current
+      @current_section ||= { title: "Divers", items: [], elements: [] }
+      @result[:sections] << @current_section unless @result[:sections].include?(@current_section)
+      @current_element = { title: line.sub(/^###\s+/, "").strip, items: [] }
+      @current_section[:elements] ||= []
+      @current_section[:elements] << @current_element
+    end
+
+    def handle_bullet(line)
+      item = { type: :bullet, text: line.sub(/^[-*]\s+/, "").strip }
+      if @current_element
+        flush_pending_to(@current_element)
+        @current_element[:items] << item
+      elsif @current_section
+        flush_pending_to(@current_section)
+        @current_section[:items] << item
+      else
+        @current_section = { title: "Divers", items: [item], elements: [] }
+        @result[:sections] << @current_section
+      end
+    end
 
-      result[:contact] = (result[:contact] || []).join(" · ")
-      result
+    def handle_text(line)
+      @pending << line.strip
     end
   end
 end

data/lib/my_last_cv/renderer.rb

@@ -1,5 +1,8 @@
 require 'prawn'
+require 'prawn/icon'
 require 'fileutils'
+require_relative 'icons'
+require_relative 'inline'
 
 module MyLastCV
   class Renderer
@@ -35,7 +38,7 @@ module MyLastCV
       fonts_dir = resolved_fonts_dir
       return unless fonts_dir
 
-      # Exemple : Inter (Regular / Bold)
+      # Example : Inter (Regular / Bold)
       pdf.font_families.update(
         "Inter" => {
           normal: File.join(fonts_dir, "Inter-Regular.ttf"),
@@ -49,36 +52,41 @@ module MyLastCV
     end
 
     def render_header(pdf)
-      pdf.font(@style.header_font)
       pdf.move_down 12
-      with_color(pdf, @style.accent_color) do
-        pdf.text(@parsed_cv[:name] || '-', size: @style.header_size, align: :center)
+      pdf.font(@style.body_font)
+      contact = @parsed_cv[:contact] || {}
+      contact.each_key do |key|
+        icon = "<icon size=\"#{@style.body_size}\">#{MyLastCV::Icons::MAP[key.to_sym]}</icon>"
+        pdf.icon("#{icon}  #{Inline.parse(contact[key])}", inline_format: true)
       end
+
       pdf.move_down 6
-      pdf.font(@style.body_font)
-      pdf.text(@parsed_cv[:contact] || '', size: @style.body_size, align: :center)
+      pdf.font(@style.header_font)
+      with_color(pdf, @style.accent_color) do
+        pdf.text(@parsed_cv[:title] || '-', size: @style.header_size, align: :center)
+      end
+
+      pdf.move_down 4
+      pdf.stroke_color(@style.accent_color)
+      pdf.stroke_horizontal_rule
 
       if @parsed_cv[:intro]&.any?
         pdf.move_down 10
         @parsed_cv[:intro].each do |p|
-          pdf.text(p, size: @style.body_size, leading: 2)
-          pdf.move_down 4
+          pdf.text(Inline.parse(p), size: @style.body_size, leading: 2, inline_format: true)
         end
-      else
-        pdf.move_down 4
-      end
-
-      with_color(pdf, @style.accent_color) do
-        pdf.stroke_horizontal_rule
       end
-      pdf.move_down 12
+      pdf.move_down 10
     end
 
     def render_sections(pdf)
       (@parsed_cv[:sections] || []).each do |section|
         pdf.move_down 8
         pdf.font(@style.section_font)
-        pdf.text(section[:title], size: @style.section_size, style: :bold)
+
+        with_color(pdf, @style.accent_color) do
+          pdf.text(section[:title], size: @style.section_size, style: :bold)
+        end
 
         render_items(pdf, section[:items])
 
@@ -100,9 +108,9 @@ module MyLastCV
       (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.text(Inline.parse(item[:text]), size: @style.body_size, leading: 2, inline_format: true)
           pdf.move_down 4
         else
           # fallback (au cas où)

data/lib/my_last_cv/version.rb

@@ -1,3 +1,3 @@
   module MyLastCV
-    VERSION = "0.0.6"
+    VERSION = "0.0.8"
   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.6
+  version: 0.0.8
 platform: ruby
 authors:
 - Maxime Hanicotte
@@ -23,6 +23,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: prawn-icon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -62,7 +76,13 @@ extra_rdoc_files: []
 files:
 - README.md
 - exe/my_last_cv
+- fonts/Inter-Bold.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
@@ -91,7 +111,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: []