multiformat-cv2 0.0.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ea0b2f804d7fb2f5343f838661479add46a24a796fb87bff6ca464233bf9d88a
+  data.tar.gz: 469da0d9732299829d39f1837767cbf27eab1af019ea826a62d5d24139297f27
+SHA512:
+  metadata.gz: 5ea427348ba5d91c7458e2edbdcb7a0e847cf5d57880ee35706726dee23321fda0d87e783057ab6c5960b11e5d4ced7bcb19dc18affe726ee4c15841f3b9ae8b
+  data.tar.gz: 9d4c3f21ca9cd0977eaa23cc88f290523f35aef2b1a6f172e9b996671d0da9960d7342c57d602418ea3c7c1c705f8ac98b66f33b27cb41810ddb831861248716

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2004-2019 David Heinemeier Hansson
+
+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,34 @@
+# Multiformat CV
+
+Multi-format CV generator from YAML files and ERB templates.
+
+## Install
+
+```bash
+$ gem install multiformat-cv
+```
+
+## Usage
+
+Taking this repository's `sample` directory as a starting point, we can
+generate the CV as follows:
+
+```bash
+$ tree
+.
+├── data
+│   ├── contact.yml
+│   ├── jobs.yml
+│   └── personal.yml
+└── onepager
+    ├── cv.css
+    └── cv.html.erb
+
+2 directories, 5 files
+$ multiformatcv -d sample/data -s sample/onepager -o sample/onepager/cv.html
+$ open sample/onepager/cv.html
+```
+
+Which, after being printed from the browser, would look something like this:
+
+![Printed CV](sample/onepager/images/cv.png)

data/bin/multiformatcv

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "multiformatcv"
+require "mercenary"
+
+Mercenary.program(:multiformatcv) do |p|
+  p.version MultiformatCV::VERSION
+  p.description "Generate your CV in different formats"
+  p.syntax "multiformatcv <format> [-d './data'] [-t <directory>] [-o <file>]"
+
+  p.option "format", "-f FORMAT", "--format FORMAT", "Output format", String
+  p.option "data_dir", "-d DIR", "--data DIR", "YAML data files directory", String
+  p.option "templates", "-s DIR", "--templates DIR", "Templates directory, MUST contain cv.<format>.erb file", String
+  p.option "output", "-o FILE", "--outpu FILEt", "Output where to write result, defaults to STDOUT", String
+
+  p.action do |args, options|
+    MultiformatCV::generate(options)
+  end
+end

data/lib/multiformatcv.rb

@@ -0,0 +1,60 @@
+require 'yaml'
+require 'erubi'
+
+module MultiformatCV
+
+  # YAML files that will be read from the specified directory
+  YML_FILES = %w( contact jobs personal )
+
+  # Parse yaml files located at data directory
+  #
+  # @param [Hash] opts Options to specify format and templates source
+  # @option opts [String] 'data_dir' Directory where the YAML files are located.
+  # @option opts [Symbol] 'format' One of [ :html, :tex ]
+  # @option opts [Symbol] 'output' Output file
+  # @option opts [String] 'templates' Directory where templates are located,
+  #   expected template files are `cv.#{ format }.erb`
+  #
+  # @return [MultiformatCV::Resume] Resume with parsed data
+  # @see https://www.rubydoc.info/gems/erubi/1.8.0 Erubi documentation
+  # @see Erubi::Engine
+
+  def self.generate(opts = {})
+    opts['format'] ||= 'html'
+    opts['data_dir'] ||= 'data'
+    opts['templates'] ||= default_template_path
+    opts['output'] ||= nil
+
+    template = File.read("#{ opts['templates'] }/cv.#{ opts['format'] }.erb")
+    resume = Resume.new
+    yml = nil
+
+    YML_FILES.each do |f|
+      yml = YAML.load_file("#{ opts['data_dir'] }/#{ f }.yml")
+      if yml then
+        resume.send("add_#{ f }", yml[f])
+      end
+    end
+
+    resume.rendered = eval Erubi::Engine.new(template).src
+
+    if opts['output'] then
+      File.open(opts['output'], 'w') { |f| f.write(resume.rendered) }
+    end
+
+    resume
+  end
+
+  private
+
+  def self.default_template_path
+    File.expand_path('../../sample/onepager', __FILE__)
+  end
+end
+
+require 'multiformatcv/contact'
+require 'multiformatcv/job'
+require 'multiformatcv/personal'
+require 'multiformatcv/project'
+require 'multiformatcv/resume'
+require 'multiformatcv/version'

data/lib/multiformatcv/contact.rb

@@ -0,0 +1,32 @@
+class MultiformatCV::Contact
+  attr_accessor :name,
+    :title,
+    :phone,
+    :email
+
+  # Hash of links
+  #
+  # == Example:
+  #   links = { github: 'https://www.github.com/john.doe/personal-dashboard' }
+  attr_accessor :links
+
+  # Create Contact instance
+  #
+  # == Example:
+  #   contact = MultiformatCV::Contact.new(title: 'Accountant', name: 'John Doe')
+  #
+  # @param [Hash] h Instance initializer; keys *MUST* be strings
+  # @option h [String] 'name'
+  # @option h [String] 'title'
+  # @option h [String] 'email'
+  # @option h [String] 'phone'
+  # @option h [Hash<String, String>] 'links'
+
+  def initialize(h = {})
+    @name  = h['name']
+    @title = h['title']
+    @email = h['email']
+    @phone = h['phone']
+    @links = h['links']
+  end
+end

data/lib/multiformatcv/job.rb

@@ -0,0 +1,42 @@
+class MultiformatCV::Job
+  attr_accessor :position,
+    :company,
+    :start_date,
+    :end_date,
+    :summary
+
+  # List of projects that you worked on during this job
+  # @return [Array<MultiformatCV::Project>]
+  attr_accessor :projects
+
+  # Create Job instance
+  #
+  # == Example:
+  #   job = MultiformatCV::Job.new(position: 'Accountant', company: 'Accountants Inc.')
+  #
+  # @param [Hash] h Instance initializer; keys *MUST* be strings
+  # @option h [String] 'position'
+  # @option h [String] 'company'
+  # @option h [String] 'start_date'
+  # @option h [String] 'end_date'
+  # @option h [String] 'summary'
+  # @option h [Array<Hash>] 'projects' List of hashes that will be used to
+  #   initialize new MultiformatCV::Porject entries
+  #
+  # @see MultiformatCV::Project
+
+  def initialize(h = {})
+    @position = h['position']
+    @company = h['company']
+    @start_date = h['start_date']
+    @end_date = h['end_date']
+    @summary = h['summary']
+    @projects = []
+
+    if h['projects']
+      h['projects'].each do |p|
+        @projects << MultiformatCV::Project.new(p)
+      end
+    end
+  end
+end

data/lib/multiformatcv/personal.rb

@@ -0,0 +1,26 @@
+class MultiformatCV::Personal
+  attr_accessor :summary
+
+  # List of personal projects
+  # @return [Array<MultiformatCV::Project>]
+  attr_accessor :projects
+
+  # Create Personal information instance
+  #
+  # == Example:
+  #   personal = MultiformatCV::Personal.new(summary: 'Volunteer at...', projects: [])
+  #
+  # @param [Hash] h Instance initializer; keys *MUST* be strings
+  # @option h [String] 'summary'
+  # @option h [Array<Hash>] 'projects' List of hashes that will be used to
+  #   initialize new MultiformatCV::Porject entries
+  #
+  # @see MultiformatCV::Project
+
+  def initialize(h = {})
+    @summary = h['summary']
+    @projects = []
+
+    h['projects'].each { |p| @projects << MultiformatCV::Project.new(p) }
+  end
+end

data/lib/multiformatcv/project.rb

@@ -0,0 +1,60 @@
+class MultiformatCV::Project
+  attr_accessor :name,
+    :position,
+    :summary,
+    :tasks,
+    :skills
+
+  # Repository URL for the project
+  attr_accessor :repo
+
+  # Page or site URL for the project
+  attr_accessor :url
+
+  # Create Project instance
+  #
+  # == Example:
+  #   project = MultiformatCV::Project.new(name: 'Life Solver (TM)', summary: '...', ...)
+  #
+  # @param [Hash] h Instance initializer; keys *MUST* be strings
+  # @option h [String] 'name'
+  # @option h [String] 'position'
+  # @option h [String] 'start_date'
+  # @option h [String] 'end_date'
+  # @option h [String] 'repo' Repository URL
+  # @option h [String] 'url' URL for the project
+  # @option h [String] 'summary' Project description, goals, etc.
+  # @option h [Array<String>] 'tasks' Tasks done for the project
+  # @option h [Array<String>] 'skills' skills used in the project
+
+  def initialize(h = {})
+    @name = h['name']
+    @position = h['position']
+    @start_date = h['start_date']
+    @end_date = h['end_date']
+    @repo = h['repo']
+    @summary = h['summary']
+    @url = h['url']
+    @tasks = []
+    @skills = []
+
+    h['tasks'].each  { |t| @tasks << t } if h['tasks']
+    h['skills'].each { |t| @skills << t } if h['skills']
+  end
+
+  # @return [DateTime] Date or nil
+  def end_date
+    if @end_date and @end_date != ''
+      return DateTime.parse(@end_date)
+    end
+    return nil
+  end
+
+  # @return [DateTime] Date or nil
+  def start_date
+    if @start_date and @start_date != ''
+      return DateTime.parse(@start_date)
+    end
+    return nil
+  end
+end

data/lib/multiformatcv/resume.rb

@@ -0,0 +1,127 @@
+require 'date'
+
+class MultiformatCV::Resume
+  # Contact information
+  # @return [MultiformatCV::Contact]
+  attr_accessor :contact
+
+  # List of jobs
+  # @return [Array<MultiformatCV::Job>]
+  attr_accessor :jobs
+
+  # List of skills
+  # @key    skill name
+  # @value  time duration in months
+  # @return [Hash]
+  attr_accessor :skills
+
+  # Personal accomplishments and projects
+  # @return [MultiformatCV::Personal]
+  attr_accessor :personal
+
+  # Rendered templates with CV data
+  # @return [String]
+  attr_accessor :rendered
+
+  # Initialize Resume
+  #
+  # @param [Hash] h Options
+  # @option h [Array<MultiformatCV::Contact>] 'contact' Contact information
+  # @option h [Array<MultiformatCV::Job>] 'jobs' Jobs list
+  # @option h [Array<MultiformatCV::Personal>] 'personal' Personal information
+
+  def initialize(h = {})
+    @contact = MultiformatCV::Contact.new(h['contact'] || []) if h['contact']
+    @jobs = []
+    @skills = {}
+    @personal = MultiformatCV::Personal.new(h['personal'] || []) if h['personal']
+
+    h['jobs'].each { |j| @jobs << MultiformatCV::Job.new(j) } if h['jobs']
+
+    estimate_skills_experience_duration! if jobs.length > 0
+  end
+
+  # Set contact information
+  # @param [Hash] h Hash used to initialize new MultiformatCV::Contact
+  # @see MultiformatCV::Contact
+
+  def add_contact(h = {})
+    @contact = MultiformatCV::Contact.new(h)
+  end
+
+  # Add list of job entries to @jobs list
+  #
+  # @param [Array<Hash>] arr List of hashes that will be used to initialize new
+  #   MultiformatCV::Job entries
+  #
+  # @see MultiformatCV::Job
+
+  def add_jobs(arr = [])
+    arr.each { |j| @jobs << MultiformatCV::Job.new(j) }
+    estimate_skills_experience_duration!
+  end
+
+  # Set personal information
+  # @param [Hash] h Hash used to initialize new MultiformatCV::Personal
+  # @see MultiformatCV::Personal
+
+  def add_personal(h = {})
+    @personal = MultiformatCV::Personal.new(h)
+  end
+
+  private
+
+  # A skill can be shared among projects, so we need to **NOT** count the
+  # same skill more than once if it appears in more than one.
+  #
+  # We do a naive calculation of _assuming_ if a skill has the same
+  # duration in more than one project, then we count it only once.
+  #
+  # **NOTE**: the way dates are parsed, if they don't specify the day,
+  # start of the month assumed; if they don't specify month, start of the
+  # year is assumed.
+  #
+  # For example, this approach will give approximate results when
+  # `skill1` was used from January 'til March in `project1` and from
+  # June 'til August in `project2`, giving a total of 4 months
+  # assuming dates are:
+  #
+  # * 2020-01-01 -> 2020-03-01: 2 months
+  # * 2020-06-01 -> 2020-08-01: 2 months
+
+  def estimate_skills_experience_duration!
+    jobs.each do |job|
+      job_skills = {}
+      default_start_date = job.start_date
+      default_end_date   = job.end_date || Time.now # present/current job
+
+      job.projects.each do |proj|
+        start_date = proj.start_date || default_start_date
+        end_date   = proj.end_date   || default_end_date
+
+        proj.skills.each do |s|
+          job_skills[s] ||= []
+          job_skills[s] << diff_in_months(start_date.to_time, end_date.to_time)
+        end
+      end
+
+      # we assume that if the same skill has the same duration twice for the
+      # same job, the projects were developed in parallel so we count the skill
+      # only once
+      job_skills.each { |s, arr| job_skills[s] = arr.uniq.sum }
+      skills.merge!(job_skills) { |k, oldval, newval| oldval + newval }
+    end
+
+    skills
+  end
+
+  # Generic (30-day) month duration in seconds
+  ONE_MONTH = 3600 * 24 * 30
+
+  # @param [Time] t1
+  # @param [Time] t2
+  # @return [Integer] Difference in months between dates
+  def diff_in_months(t1, t2)
+    ((t1 - t2) / ONE_MONTH).abs.round
+  end
+end

data/lib/multiformatcv/templates/cv.html.erb

@@ -0,0 +1,66 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta http-equiv="Content-Type" content="text/html;charset=utf-8">
+  <title><%= "#{ resume.contact.name } - #{ resume.contact.title }" %></title>
+  <style>
+    html {
+      font: normal 16px/20px sans-serif, serif;
+      max-width: 90%;
+      margin: 2rem auto;
+    }
+    h1 { font-size: 1.6rem; line-height: 1.8rem; color: #000; }
+    h2 { font-size: 1.5rem; line-height: 1.7rem; color: #222; }
+    h3 { font-size: 1.4rem; line-height: 1.6rem; color: #444; }
+    h4 { font-size: 1.3rem; line-height: 1.5rem; color: #555; }
+    h5 { font-size: 1.2rem; line-height: 1.4rem; color: #666; }
+    h6 { font-size: 1.1rem; line-height: 1.3rem; color: #777; }
+    .text-right { text-align: right; }
+
+    .job {
+      border-bottom: 1px solid #666;
+    }
+    .project {}
+  </style>
+</head>
+<body>
+  <header>
+    <h1><%= "#{ resume.contact.name } - #{ resume.contact.title }" %></h1>
+    <div class="text-right">
+      <a href="mailto:<%= resume.contact.email %>" class="email"><%= resume.contact.email %></a><br>
+      <a href="tel:<%= resume.contact.phone %>" class="phone"><%= resume.contact.phone %></a>
+    </div>
+  </header>
+
+  <section id="jobs">
+    <h2>Work Experience</h2>
+  <% resume.jobs.each do |job| %>
+    <article class="job">
+      <header>
+        <h3><%= "#{ job.position } &mdash; #{ job.company }" %></h3>
+      </header>
+      <p><%= job.summary.chomp %></p>
+    <% job.projects.each do |project| %>
+      <article class="project">
+        <h4><%= project.name %></h4>
+
+        <h5>Skills</h5>
+        <ul class="skills">
+        <% project.skills.each do |tech| %>
+          <li><%= tech %></li>
+        <% end %>
+        </ul>
+
+        <h5>Tasks</h5>
+        <ul class="tasks">
+        <% project.tasks.each do |task| %>
+          <li><%= task %></li>
+        <% end %>
+        </ul>
+      </article>
+    <% end %>
+    </article>
+  <% end %>
+  </section>
+</body>
+</html>

data/lib/multiformatcv/templates/cv.tex.erb

@@ -0,0 +1,66 @@
+\documentclass{article}
+
+\title{<%= resume.contact.name %>}
+\author{<%= resume.contact.name %>}
+
+\begin{document}
+
+\maketitle
+
+\section{\centerline{Proffesional Experience}}
+
+\vspace{8pt}
+
+<% resume.jobs.each do |job| %>
+
+\subsection{<%= job.company %> -- <%= job.position %>}
+\hfill <%= job.start_date %> -- <%= job.end_date or 'present' %>
+
+<%- if job.summary %><%= job.summary %><% end -%>
+
+<% job.projects.each do |project| %>
+\subsubsection{<%= project.name %>}
+
+<%- if project.summary %><%= project.summary %><% end -%>
+
+
+\noindent Skills
+
+\begin{itemize}
+<% project.skills.each do |tech| %>
+  \item <%= tech %>
+<% end %>
+\end{itemize}
+
+\noindent Tasks
+
+\begin{itemize}
+<% project.tasks.each do |task| %>
+  \item <%= task %>
+<% end %>
+\end{itemize}
+<% end %>
+<% end %>
+
+\section{\centerline{Personal Projects}}
+
+\vspace{8pt}
+
+<%- if resume.personal and resume.personal.summary %>
+<%= resume.personal.summary %>
+<% end -%>
+
+<% resume.personal.projects.each do |project| %>
+\subsubsection{<%= project.name %>}
+
+<%- if project.summary %><%= project.summary %><% end -%>
+
+\noindent Skills
+
+\begin{itemize}
+<% project.skills.each do |tech| %>
+  \item <%= tech %>
+<% end %>
+\end{itemize}
+<% end %>
+\end{document}

data/lib/multiformatcv/version.rb

@@ -0,0 +1,4 @@
+module MultiformatCV
+  # Gem version
+  VERSION = '0.0.6'
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: multiformat-cv2
+version: !ruby/object:Gem::Version
+  version: 0.0.6
+platform: ruby
+authors:
+- juankman94
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-08-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: erubi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: mercenary
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.3
+description: Multi-format CV generator from YAML files
+email: juan.carlos@hey.com
+executables:
+- multiformatcv
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- bin/multiformatcv
+- lib/multiformatcv.rb
+- lib/multiformatcv/contact.rb
+- lib/multiformatcv/job.rb
+- lib/multiformatcv/personal.rb
+- lib/multiformatcv/project.rb
+- lib/multiformatcv/resume.rb
+- lib/multiformatcv/templates/cv.html.erb
+- lib/multiformatcv/templates/cv.tex.erb
+- lib/multiformatcv/version.rb
+homepage: https://www.gitlab.com/juankman94/multiformat-cv
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Generate your CV in different formats
+test_files: []