resme 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 75fc73b4333ce4f6b51a02625a846fa6a7bdb16b0c53e0dc97bbcd0a1011f681
-  data.tar.gz: 38b29db1c99a03d07d29036985291f5181e4f0e92225824bf131b5e006faaa92
+  metadata.gz: 675ed552cd44f44d7d6dd7467393e70cf92481d0945257a5827a11980e60bc14
+  data.tar.gz: 994c0d2599cbe669390eae3c1490d185937734d21770606d88ef00596b2d09f1
 SHA512:
-  metadata.gz: 83f7f01cdd3c00932b7cdcb6cbe4e169c8f3a5129c06163582dfe6ecbfdd541b951c6812fa87836b26f30ecd4c8789dcea12f6fa8b212b7ef486b9b95cc1906e
-  data.tar.gz: d148e71395e5abf9b3ab39d4770cbed5da1f66a17ec35c061b194ceabce7f94021d8ac37af678394a4c0bad94329147f761d89b1a52409b96a5a77a0ee0c0450
+  metadata.gz: d8ee5198d200f8c03df7691fbec10adef9808f8c001be028f5f94890443e366d0fbf7c1d930d975f9a8879033276fc7c9ad2e09448b35dd19305e9944b87b3c8
+  data.tar.gz: 86d4ae8e4df7c7efcd46bbedbf28c26471bb2fd0553427b96628757143ac27d494a4bb0b4f93eb3ba57f3620a309415b05d78daf5f5f140ff893f86be774a886

data/CHANGELOG.org

@@ -1,6 +1,11 @@
 #+TITLE: CHANGELOG
 #+AUTHOR: Adolfo Villafiorita
 
+* Version 2.1.0
+
+- Output to HTML
+- Small fixes to documentation  
+
 * Version 2.0.1 and 2.0.0
 
 - Fully rewritten code (and rubocopped for most part)

data/README.org

@@ -3,8 +3,8 @@
 #+DATE: <2020-07-14 Tue>
 #+STARTUP: showall
 
-Keep your resume in YAML and output it Org Mode and JSON Resume formats.
-Org Mode is flexible enough to export to various other formats.
+Keep your resume in YAML and output it Org Mode and JSON Resume.  Org Mode is
+flexible enough to export to various other formats.
 
 The rendering engine is based on ERB. This simplifies the creation of
 new output formats (and extending/modifying the YML structure to one's

data/lib/resme/cli.rb

@@ -13,7 +13,7 @@ module Resme
     end
 
     def parse
-      @options = {}
+      @options = default_values
       parser.parse!(@arguments)
     end
 
@@ -23,20 +23,33 @@ module Resme
 
     private
 
+    def default_values
+      { theme: "default" }
+    end
+
     # rubocop:disable Metrics
     def parser
       OptionParser.new do |parser|
-        parser.banner = "resme [options] - Format and manage a resume in YAML"
+        parser.banner = "resme [options] " \
+                        "# Keep resume in YML, output Org Mode, HTML, and JSON"
 
-        parser.on("--format FORMAT", String, "Output format") do |v|
+        parser.on("--format FORMAT", String, "Output format (json, org)") do |v|
           @options[:format] = v
         end
 
+        parser.on("--theme THEME", String, "Choose a CSS theme") do |v|
+          @options[:theme] = v
+        end
+
+        parser.on("--themes", String, "List all available CSS theme") do |_|
+          @options[:cmd] = :themes
+        end
+
         parser.on("--init", "Init a new resume") do |_|
           @options[:cmd] = :init
         end
 
-        parser.on("--validate FILENAME", "Validate the resume") do |v|
+        parser.on("--validate FILENAME", "Validate the resume in FILENAME") do |v|
           @options[:cmd] = :validate
           @options[:filename] = v
         end
@@ -55,11 +68,11 @@ module Resme
           @options[:cmd] = :list
         end
 
-        parser.on("--except x,y,z", Array, "Excluded section") do |v|
+        parser.on("--except x,y,z", Array, "Exclude section x,y,z") do |v|
           @options[:except] = v.map(&:to_sym)
         end
 
-        parser.on("--cat TEMPLATE", "View a template") do |v|
+        parser.on("--cat TEMPLATE", "View the YAML of a resume") do |v|
           @options[:cmd] = :cat
           @options[:template] = v
         end

data/lib/resme/document_validator.rb

@@ -222,6 +222,7 @@ module Resme
                ],
       languages: [:optional,
                   {
+                    assessment: OPTIONAL_STRING,
                     mother_tongues: [[{
                                         code: OPTIONAL_STRING,
                                         language: String,

data/lib/resme/executor.rb

@@ -3,7 +3,7 @@
 module Resme
   #
   # Execute!
-  # 
+  #
   class Executor
     # include all formatter helpers
     include Resme::Helper
@@ -44,23 +44,41 @@ module Resme
         template = File.read(template_name)
 
         # add the json format, if specified
-        if format.to_s == "json"
+        if format.to_s.downcase == "json"
           js = JsonResume.new Document.new(filename)
           @json_resume = js.build
         end
 
-        output = ERB.new(template, trim_mode: "-").result(binding)
+        # copy the theme and set it in data for the tempalte, if output is html
+        if format.to_s.downcase == "html"
+          css_filename = theme_css_file @options.options[:theme]
+          css_template = File.join __dir__, "../../templates/#{css_filename}"
+          FileUtils.cp css_template, css_filename
+
+          @data[:theme] = css_filename
+        end
 
+        output = ERB.new(template, trim_mode: "-").result(binding)
         # it is difficult to write readable ERBs with no empty lines...  we use
         # gsub to replace multiple empty lines with \n\n in the final output
         output.gsub!(/([\t ]*\n){3,}/, "\n\n")
-        backup_and_write(output_filename(format), output)
+
+        output_filename = output_filename(format)
+        backup_and_write(output_filename, output)
+        puts "Resume generated and saved to #{output_filename}"
 
       when :list
         templates = File.join __dir__, "../../templates/*.erb"
         files = Dir.glob(templates).map { |x| "#{File.basename(x)} => #{x}" }
         puts files.join("\n")
 
+      when :themes
+        templates = File.join __dir__, "../../templates/*.css"
+        files = Dir.glob(templates).map do |x|
+          File.basename(x).gsub("resume-", "").gsub(".css", "")
+        end
+        puts files.join("\n")
+
       when :cat
         template = @options.options[:template]
         template_path = File.join __dir__, "../../templates/#{template}"
@@ -78,12 +96,16 @@ module Resme
 
     private
 
+    def theme_css_file(theme_name)
+      "resume-#{theme_name}.css"
+    end
+
     def output_filename(format)
       "resume-#{Date.today.iso8601}.#{format}"
     end
 
     def backup(filename)
-      FileUtils.cp "filename, "#{filename}~"
+      FileUtils.cp filename, "#{filename}~"
       puts "Backup copy #{filename} created in #{filename}~."
     end
 

data/lib/resme/helper.rb

@@ -14,7 +14,7 @@ module Resme
       [
         data.dig(:basics, :first_name),
         data.dig(:basics, :middle_name),
-        data.dig(:basics, :last_name),
+        data.dig(:basics, :last_name)
       ].compact.join(" ")
     end
 
@@ -150,6 +150,11 @@ module Resme
       contact ? contact[:value] : nil
     end
 
+    # break text into paragraphs and wrap in <p>
+    def html_summary(text)
+      text.split("\n\n").map { |x| "<p>#{x}</p>" }.join
+    end
+
     #
     # Utility functions for managing dates in the form 2015-01-01 and partial
     # dates (e.g., 2015-05, 2015)

data/lib/resme/json_resume.rb

@@ -12,7 +12,7 @@ module Resme
       @data = document.data
     end
 
-    # rubocop:disable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity, Metrics/AbcSize
+    # rubocop:disable Metrics
     def build
       address = @data[:addresses]&.first || {}
       education = @data[:education].select { |x| x[:publish] } || []
@@ -145,8 +145,7 @@ module Resme
         end
       }.compact
     end
-    # rubocop:enable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity, Metrics/AbcSize
-
+    # rubocop:enable Metrics
 
     private
 

data/lib/resme/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Resme
-  VERSION = "2.0.1"
+  VERSION = "2.1.0"
 end

data/templates/html.erb

@@ -0,0 +1,337 @@
+<html>
+  <head>
+    <title><%= full_name @data %> Resume</title>
+
+    <meta name="author" content="<%= full_name @data %>">
+    <meta name="created" content="<%= Date.today %>">
+    <meta name="generator" content="resme">
+
+    <link rel="stylesheet" href="./<%= @data[:theme] %>">
+  </head>
+
+  <body>
+    <div class="container">
+      <div class="contact-information">
+        <!-- this is also replicated in the main section, to simplify styling -->
+        <!-- you might want to set display:none for one or the other -->
+        <div class="fullname-title">
+          <%= full_name @data %>, <%= @data[:basics][:title] %>
+        </div>
+
+        <% if @data[:addresses] %>
+        <div class="addresses section">
+          <h2>Addresses</h2>
+
+          <% (@data[:addresses] || []).each do |x| %>
+          <div class="address item">
+            <span class="label"><%= x[:label] %></span>
+            <span class="value">
+              <span class="street"><%= x[:street] %></span>
+              <span class="postal-code"><%= x[:postal_code] %></span>
+              <span class="city"><%= x[:city] %></span>
+            </span>
+          </div>
+          <% end %>
+        </div>
+        <% end %>
+        
+        <% if @data[:contacts] %>
+        <div class="contacts section">
+          <h2>Contacts</h2>
+
+          <% (@data[:contacts] || []).each do |x| %>
+          <div class="contact item">
+            <span class="label"><%= x[:label] %></span>
+            <span class="value"><%= x[:value] %></span>
+          </div>
+          <% end %>
+        </div>
+        <% end %>
+
+        <% if @data[:web_presence] %>
+        <div class="web-presence section">
+          <h2>Web</h2>
+
+          <% (@data[:web_presence] || []).each do |x| %>
+          <div class="web-presence-item item">
+            <span class="label"><%= x[:label] %></span>
+            <span class="value"><%= x[:value] %></span>
+          </div>
+          <% end %>
+        </div>
+        <% end %>
+      </div>
+
+      <div class="main">
+        <div class="fullname-title">
+          <%= full_name @data %>, <%= @data[:basics][:title] %>
+        </div>
+
+        <% if @data[:summary] %>
+        <div class="summary section">
+          <h2>Summary</h2>
+          
+          <%= html_summary @data[:summary] %>
+        </div>
+        <% end %>
+
+        <% if @data[:skills] %>
+        <div class="skills section">
+          <h2>Skills</h2>
+
+          <% (@data[:skills] || []).each do |item| %>
+          <div class="skill item">
+            <span class="label"><%= item[:name] %></span>
+            <span class="value"><%= item[:level] %></span>
+          </div>
+          <% end %>
+        </div>
+        <% end %>
+
+        <% if @data[:work] %>
+        <div class="work-experiences section">
+          <h2>Work Experience</h2>
+
+          <% (@data[:work] || []).each do |item| %>
+          <div class="work-experience item">
+            <div class="period"><%= period item, separator: "&mdash;" %></div>
+            <div class="position"><%= item[:position] %></div>
+            <div class="name"><%= item[:name] %></div>
+            <div class="summary"><%= html_summary item[:summary] %></div>
+          </div>
+          <% end %>
+        </div>
+        <% end %>
+
+        <% if @data[:teaching] %>
+        <div class="teachings section">
+          <h2>Teaching</h2>
+
+          <% (@data[:teaching] || []).each do |item| %>
+          <div class="teaching item">
+            <div class="period"><%= period item, separator: "&mdash;" %></div>
+            <div class="subject"><%= item[:subject] %></div>
+            <div class="position"><%= item[:position] %></div>
+            <div class="school"><%= item[:school] %></div>
+            <div class="name"><%= item[:name] %></div>
+          </div>
+          <% end %>
+        </div>
+        <% end %>
+
+        <% if @data[:projects] %>
+        <div class="projects section">
+          <h2>Projects</h2>
+
+          <% (@data[:projects] || []).each do |item| %>
+          <div class="project item">
+            <div class="period"><%= period item, separator: "&mdash;" %></div>
+            <div class="position"><%= item[:position] %></div>
+            <div class="name"><%= item[:name] %></div>
+            <div class="summary"><%= html_summary item[:summary] %></div>
+          </div>
+          <% end %>
+        </div>
+        <% end %>
+
+        <% if @data[:other] -%>
+        <div class="other section">
+          <h2>Other</h2>
+
+          <% (@data[:other] || []).each do |item| %>
+          <div class="other item">
+            <div class="period"><%= period item, separator: "&mdash;" %></div>
+            <div class="position"><%= item[:position] %></div>
+            <div class="name"><%= item[:name] %></div>
+            <div class="summary"><%= html_summary item[:summary] %></div>
+          </div>
+          <% end %>
+        </div>
+        <% end %>
+
+        <% if @data[:committees] %>
+        <div class="committees section">
+          <h2>Committees</h2>
+
+          <% (@data[:committees] || []).each do |item| %>
+          <div class="committee item">
+            <div class="name"><%= item[:name] %></div>
+            <div class="position"><%= item[:position] %></div>
+            <div class="editions"><%= item[:editions] %></div>
+          </div>
+          <% end %>
+        </div>
+        <% end %>
+
+        <% if @data[:volunteer] -%>
+        <div class="volunteer section">
+          <h2>Volunteer</h2>
+
+          <% (@data[:volunteer] || []).each do |item| %>
+          <div class="volunteer-item item">
+            <div class="period"><%= period item, separator: "&mdash;" %></div>
+            <div class="position"><%= item[:position] %></div>
+            <div class="name"><%= item[:name] %></div>
+            <div class="summary"><%= html_summary item[:summary] %></div>
+          </div>
+          <% end %>
+        </div>
+        <% end %>
+
+        <% if @data[:publications] %>
+        <div class="publications section">
+          <h2>Publications</h2>
+
+          <% (@data[:publications] || []).each do |item| %>
+          <div class="publication item">
+            <div class="authors"><%= item[:authors] %></div>
+            <div class="title"><%= item[:title] %></div>
+            <div class="publisher"><%= item[:publisher] %></div>
+            <div class="date"><%= item[:date] %></div>
+          </div>
+          <% end %>
+        </div>
+        <% end -%>
+
+        <% if @data[:talks] -%>
+        <div class="talks section">
+          <h2>Talks</h2>
+
+          <% (@data[:talks] || []).each do |item| -%>
+          <div class="talk item">
+            <div class="title"><%= item[:title] %></div>
+            <div class="venue"><%= item[:venue] %></div>
+            <div class="date"><%= item[:date] %></div>
+          </div>
+          <% end -%>
+        </div>
+        <% end -%>
+
+        <% if @data[:visits] -%>
+        <div class="visits section">
+          <h2>Visits</h2>
+
+          <% (@data[:visits] || []).each do |item| -%>
+          <div class="visit">
+            <div class="period"><%= period item, separator: "&mdash;" %></div>
+            <div class="position"><%= item[:position] %></div>
+            <div class="name"><%= item[:name] %></div>
+            <div class="address"><%= item[:address] %></div>
+            <div class="summary"><%= html_summary item[:summary] %></div>
+          </div>          
+          <% end -%>
+        </div>
+        <% end -%>
+
+        <% if @data[:education] %>
+        <div class="education section">
+          <h2>Education</h2>
+          
+          <% @data[:education].select { |x| x[:publish] }.each do |item| -%>
+          <div class="education-item item">
+            <div class="year"><%= year(item[:end_date]) %></div>
+            <div class="degree"><%= item[:degree] %></div>
+            <div class="school"><%= item[:school] %></div>
+            <div class="address"><%= item[:address] %></div>
+          </div>
+          <% end %>
+        </div>
+        <% end %>
+
+        <% [:awards, :achievements].each do |group| %>
+        <% if @data[group] -%>
+        <div class="<%= group %> section">
+          <h2><%= group.capitalize %></h2>
+
+          <% (@data[group] || []).each do |item| %>
+          <div class="<%= group %>-item item">
+            <% %w[date title name address summary].each do |element| %>
+            <div class="<%= element %>"><%= item[element] %></div>
+            <% end %>
+          </div>
+          <% end %>
+        </div>
+        <% end %>
+        <% end %>
+
+        <% if @data[:software] %>
+        <div class="software section">
+          <h2>Software</h2>
+
+          <% (@data[:software] || []).each do |item| -%>
+          <div class="software-item item">
+            <div class="title">
+              <a href="<%= item[:url] %>"><%= item[:title] %></a>
+            </div>
+            <div class="position"><%= item[:position] %></div>
+          </div>
+          <% end -%>
+        </div>
+        <% end -%>
+
+        <% if @data[:interests] -%>
+        <div class="interests section">
+          <h2>Interests</h2>
+
+          <% (@data[:interests] || []).each do |item| -%>
+          <div class="interest item">
+            <div class="name"><%= item[:name] %></div>
+            <div class="summary"><%= html_summary item[:summary] %></div>
+          </div>
+          <% end -%>
+        </div>
+        <% end -%>
+
+        <% if @data[:languages] %>
+        <div class="languages section">
+          <h2>Languages</h2>
+
+          <% if @data[:languages] and @data[:languages][:assessment] %>
+          <div class="assessment item">
+            <span class="label">Assessment</span>
+            <span class="value"><%= @data[:languages][:assessment] %></span>
+          </div>
+          <% end %>
+
+          <% if @data[:languages] and @data[:languages][:mother_tongues] %>
+          <div class="mother-tongues item">
+            <span class="label">Mother Tongues</span>
+            <% @data[:languages][:mother_tongues].each do |x| %>
+            <div class="mother-tongue">
+              <div class="language"><%= x[:language] %></div>
+              <div class="level"><%= x[:level] %></div>
+            </div>
+            <% end %>
+          </div>
+          <% end -%>
+
+          <% if @data[:languages] and @data[:languages][:foreign] %>
+          <div class="foreign-languages item">
+            <span class="label">Foreign Languages</span>
+            <% @data[:languages][:foreign].each do |x| %>
+            <div class="foreign-language">
+              <div class="language"><%= x[:language] %></div>
+              <div class="level"><%= x[:level] %></div>
+            </div>
+            <% end %>
+          </div>
+          <% end %>
+        </div>
+        <% end %>
+
+        <% if @data[:references] %>
+        <div class="references">
+          <h2>References</h2>
+
+          <% (@data[:references] || []).each do |item| -%>
+          <div class="reference item">
+            <div class="name"><%= item[:name] %></div>
+            <div class="reference"><%= item[:reference] %></div>
+          </div>
+          <% end %>
+        </div>
+        <% end %>
+      </div>
+    </div>
+  </body>
+</html>

data/templates/org.erb

@@ -196,6 +196,10 @@
 <% if @data[:languages] %>
 * Languages
 
+<% if @data[:languages] and @data[:languages][:assessment] %>
+Assessment <%= @data[:languages][:assessment] %>
+<% end %>
+
 <% if @data[:languages] and @data[:languages][:mother_tongues] -%>
 - Mother Tongue(s): <%= @data[:languages][:mother_tongues].map { |x| x[:language] }.join(",") %>
 <% end -%>