multiformat-cv 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b6677b813b81fb570431de8d0879e0fd7f03688d
+  data.tar.gz: 5341b0590756511b160d9ea80af26122d8ed423a
+SHA512:
+  metadata.gz: e7d2d60c6602c4583ea0f7745f735e1019655306457d8622c972d668aea42c59d6af380a2e46e8fe864c0a7d898a08370a0cc28bad2b6170878d483ce23f701d
+  data.tar.gz: 8b7e24762a0cf2e6a096bf7a396b746758264f072129805ece8b59c2af43b7fd71102ae785851b33d6b5f7085c091ea3f4f589ae29ccde9ed5677a92b6f5ca1a

data/lib/multiformatcv.rb

@@ -0,0 +1,44 @@
+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 [String] :templates Directory where templates are located,
+  #   expected template files are `cv.#{ format }.erb`
+  #
+  # @return [String] Evaluated Erubi::Engine's source
+  # @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] ||= File.expand_path("../multiformatcv/templates", __FILE__)
+
+    template = File.read("#{ opts[:templates] }/cv.#{ opts[:format].to_s }.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
+
+    eval Erubi::Engine.new(template).src
+  end
+end
+
+require 'multiformatcv/contact'
+require 'multiformatcv/job'
+require 'multiformatcv/personal'
+require 'multiformatcv/project'
+require 'multiformatcv/resume'

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,40 @@
+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 = []
+
+    h['projects'].each do |p|
+      @projects << MultiformatCV::Project.new(p)
+    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,46 @@
+class MultiformatCV::Project
+  attr_accessor :name,
+    :start_date,
+    :end_date,
+    :position,
+    :summary,
+    :tasks,
+    :technologies
+
+  # 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>] 'technologies' Technologies 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 = []
+    @technologies = []
+
+    h['tasks'].each { |t| @tasks << t } if h['tasks']
+    h['technologies'].each { |t| @technologies << t } if h['technologies']
+  end
+end

data/lib/multiformatcv/resume.rb

@@ -0,0 +1,41 @@
+class MultiformatCV::Resume
+  # Contact information
+  # @return [MultiformatCV::Contact]
+  attr_accessor :contact
+
+  # List of jobs
+  # @return [Array<MultiformatCV::Job>]
+  attr_accessor :jobs
+
+  # Personal accomplishments and projects
+  # @return [MultiformatCV::Personal]
+  attr_accessor :personal
+
+  def initialize(h = {})
+    @jobs = []
+  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) }
+  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
+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>Technologies</h5>
+        <ul class="technologies">
+        <% project.technologies.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 Technologies
+
+\begin{itemize}
+<% project.technologies.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 Technologies
+
+\begin{itemize}
+<% project.technologies.each do |tech| %>
+  \item <%= tech %>
+<% end %>
+\end{itemize}
+<% end %>
+\end{document}

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: multiformat-cv
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- JuanKman94
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-07-10 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'
+description: Multi-format CV generator from YAML files
+email: juan.carlos.menonita@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- 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
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.14.3
+signing_key: 
+specification_version: 4
+summary: Generate your CV in different formats
+test_files: []