resme 0.3.1 → 0.5.0

data/lib/resme/cli/resume_structure_validator.rb

@@ -0,0 +1,293 @@
+require "classy_hash"
+require "date"
+
+module Resme
+  module ResumeStructureValidator
+    OPTIONAL_STRING = [:optional, String, NilClass]
+    OPTIONAL_PARTIAL_DATE = [:optional, Date, String, Integer, NilClass]
+    PARTIAL_DATE = [Date, String, Integer]
+
+    def self.validate(loaded_yaml)
+      errors = []
+      ClassyHash.validate(
+        loaded_yaml,
+        SCHEMA,
+        errors: errors,
+        strict: true,
+        raise_errors: true,
+        full: true
+      )
+      errors
+    end
+
+    #
+    # This defines the structure of resume.yml
+    # We validate it with ClassyHash
+    #
+    SCHEMA = {
+      "basics" => {
+        "first_name" => String,
+        "middle_name" => OPTIONAL_STRING,
+        "last_name" => String,
+        "title" => OPTIONAL_STRING,
+        "picture" => OPTIONAL_STRING,
+        "birthdate" => [:optional, Date, NilClass],
+        "nationality" => OPTIONAL_STRING,
+        "marital_status" => OPTIONAL_STRING,
+        "gender" => OPTIONAL_STRING
+      },
+      "contacts" => [[ {
+                         "label" => String, 
+                         "value" => String 
+                       } ]],
+      "addresses" => [[ {
+                          "label" => String,
+                          "street" => OPTIONAL_STRING,
+                          "zip_code" => [:optional, String, Integer, NilClass],
+                          "city" => OPTIONAL_STRING,
+                          "country" => OPTIONAL_STRING
+                        } ]],
+      "web_presence" => [:optional,
+                         [[
+                            {
+                              "label" => String,                         
+                              "value" => String
+                            },
+                          ]],
+                         NilClass
+                        ],
+      "summary" => OPTIONAL_STRING,
+      "work" => [:optional,
+                 [[
+                    {
+                      "who" => OPTIONAL_STRING,
+                      "website" => OPTIONAL_STRING,
+                      "address" => OPTIONAL_STRING,
+                      "till" => OPTIONAL_PARTIAL_DATE,
+                      "from" => OPTIONAL_PARTIAL_DATE,
+                      "role" => String,
+                      "summary" => String,
+                      "details" => OPTIONAL_STRING
+                    },
+                  ]],
+                 NilClass
+                ],
+      "teaching" => [:optional,
+                     [[
+                        {
+                          "who" => String,
+                          "school" => OPTIONAL_STRING,
+                          "address" => OPTIONAL_STRING,
+                          "till" => OPTIONAL_PARTIAL_DATE,
+                          "from" => OPTIONAL_PARTIAL_DATE,
+                          "role" => String,
+                          "subject" => String,
+                          "summary" => OPTIONAL_STRING,
+                          "details" => OPTIONAL_STRING
+                        }
+                      ]],
+                     NilClass
+                    ],
+      "projects" => [:optional,
+                     [[
+                        {
+                          "name" => String,
+                          "size" => OPTIONAL_STRING,
+                          "who" => OPTIONAL_STRING,
+                          "till" => OPTIONAL_PARTIAL_DATE,
+                          "from" => OPTIONAL_PARTIAL_DATE,
+                          "role" => String,
+                          "summary" => OPTIONAL_STRING,
+                        }
+                      ]],
+                     NilClass
+                    ],
+      "other" => [:optional,
+                  [[
+                     {
+                       "who" => OPTIONAL_STRING,
+                       "till" => OPTIONAL_PARTIAL_DATE,
+                       "from" => OPTIONAL_PARTIAL_DATE,
+                       "role" => String,
+                       "summary" => OPTIONAL_STRING,
+                     }
+                   ]],
+                  NilClass
+                 ],
+      "committees" => [:optional,
+                       [[
+                          {
+                            "who" => String,
+                            "role" => String,
+                            "editions" => [String, Integer],
+                            "url" => OPTIONAL_STRING,
+                          }
+                        ]],
+                       NilClass
+                      ],
+      "volunteer" => [:optional,
+                      [[
+                         {
+                           "who" => String,
+                           "where" => OPTIONAL_STRING,
+                           "date" => OPTIONAL_PARTIAL_DATE,
+                           "till" => OPTIONAL_PARTIAL_DATE,
+                           "from" => OPTIONAL_PARTIAL_DATE,
+                           "role" => String,
+                           "summary" => OPTIONAL_STRING,
+                         }
+                       ]],
+                      NilClass
+                     ],
+      "visits" => [:optional,
+                   [[
+                      {
+                        "who" => String,
+                        "address" => OPTIONAL_STRING,
+                        "till" => OPTIONAL_PARTIAL_DATE,
+                        "from" => OPTIONAL_PARTIAL_DATE,
+                        "role" => String,
+                        "summary" => OPTIONAL_STRING,
+                      }
+                    ]],
+                   NilClass
+                  ],
+      "education" => [:optional,
+                      [[
+                         {
+                           "degree" => OPTIONAL_STRING,
+                           "topic" => OPTIONAL_STRING,
+                           "school" => String,
+                           "address" => OPTIONAL_STRING,
+                           "date" => OPTIONAL_PARTIAL_DATE,
+                           "till" => OPTIONAL_PARTIAL_DATE,
+                           "from" => OPTIONAL_PARTIAL_DATE,
+                           "publish" => TrueClass,
+                           "score" => [:optional, String, Integer, NilClass],
+                         }
+                       ]],
+                      NilClass
+                     ],
+      "publications" => [:optional,
+                         [[
+                            {
+                              "title" => String,
+                              "authors" => String,
+                              "publisher" => String,
+                              "date" => PARTIAL_DATE,
+                              "url" => OPTIONAL_STRING,
+                            }
+                          ]],
+                         NilClass
+                        ],
+      "talks" => [:optional,
+                  [[
+                     {
+                       "title" => String,
+                       "venue" => String,
+                       "date" => PARTIAL_DATE,
+                       "url" => OPTIONAL_STRING,
+                     }
+                   ]],
+                  NilClass
+                 ],
+      "awards" => [:optional,
+                   [[
+                      {
+                        "who" => String,
+                        "address" => OPTIONAL_STRING,
+                        "date" => PARTIAL_DATE,
+                        "title" => String,
+                        "summary" => OPTIONAL_STRING
+                      }
+                    ]],
+                   NilClass
+                  ],
+      "achievements" => [:optional,
+                         [[
+                            {
+                              "who" => String,
+                              "address" => OPTIONAL_STRING,
+                              "date" => OPTIONAL_PARTIAL_DATE,
+                              "title" => String,
+                              "summary" => OPTIONAL_STRING
+                            }
+                          ]],
+                         NilClass
+                        ],
+      "software" => [:optional,
+                     [[
+                        {
+                          "title" => String,
+                          "url" => OPTIONAL_STRING,
+                          "programming_language" => OPTIONAL_STRING,
+                          "license" => OPTIONAL_STRING,
+                          "role" => OPTIONAL_STRING,
+                          "summary" => OPTIONAL_STRING,
+                        }
+                      ]],
+                     NilClass
+                    ],
+      "skills" => [:optional,
+                   [[
+                      {
+                        "name" => String,
+                        "level" => OPTIONAL_STRING,
+                        "summary" => OPTIONAL_STRING,
+                      }
+                    ]],
+                   NilClass
+                  ],
+      "driving" => [:optional,
+                    [[ { "license" => String, } ]],
+                    NilClass
+                   ],
+      "languages" => [:optional,
+                      {
+                        "mother_tongues" => [[
+                                               {
+                                                 "code" => OPTIONAL_STRING,
+                                                 "language" => String,
+                                               }
+                                             ]],
+                        "foreign" => [:optional,
+                                      [[
+                                         {
+                                           "code" => OPTIONAL_STRING,
+                                           "language" => String,
+                                           "level" => OPTIONAL_STRING,
+                                           "listening" => OPTIONAL_STRING,
+                                           "reading" => OPTIONAL_STRING,
+                                           "spoken_interaction" => OPTIONAL_STRING,
+                                           "spoken_production" => OPTIONAL_STRING,
+                                           "writing" =>  OPTIONAL_STRING
+                                         }
+                                       ]],
+                                      NilClass
+                                     ]
+                      },
+                      NilClass
+                     ],
+      "interests" => [:optional,
+                      [[
+                         {
+                           "name" => String,
+                           "level" => OPTIONAL_STRING,
+                           "summary" => OPTIONAL_STRING,
+                         }
+                       ]],
+                      NilClass
+                     ],
+      "references" => [:optional,
+                       [[
+                          {
+                            "name" => String,
+                            "reference" => String,
+                            "contacts" => [[ {"label" => String, "value" => String} ]]
+                          }
+                        ]],
+                       NilClass
+                      ]
+    }
+  end
+end

data/lib/resme/renderer/renderer.rb

@@ -10,7 +10,7 @@ def clean string
 end
 
 def full_name data
-  [data.basics["first_name"], data.basics["middle_name"], data.basics["last_name"]].join(" ")
+  [data["basics"]["first_name"], data["basics"]["middle_name"], data["basics"]["last_name"]].join(" ")
 end
 
 # break a string into substrings of length chars breaking at spaces
@@ -59,13 +59,13 @@ end
 # abstract dates at the year level, taking care of periods if from and
 # till are in two different years
 def period entry
-  if entry["date"] then
-    "#{year entry.date}"
+  if entry["date"]
+    "#{year entry["date"]}"
   else
-    from_year = entry["from"] ? year(entry.from.to_s) : nil
-    till_year = entry["till"] ? year(entry.till.to_s) : nil
+    from_year = entry["from"] ? year(entry["from"].to_s) : nil
+    till_year = entry["till"] ? year(entry["till"].to_s) : nil
 
-    if from_year and till_year and from_year == till_year then
+    if from_year && till_year && from_year == till_year
       from_year
     else
       "#{from_year} -- #{till_year ? till_year : "today"}"
@@ -132,47 +132,3 @@ def has_day input
     input.size == 10
   end
 end
-
-# Access hash keys like they were class methods
-# hash["key"] -> hash.key
-class Hash
-  def method_missing(m)
-    key = m.to_s
-
-    # error: nil value
-    if self.has_key? key and self[key] == nil
-      $stderr.puts "[W] The value of key '#{key}' is nil in the following entry:"
-
-      # we put a bit of info about the top level structure of a resume to avoid extra-long error messages
-      # I don't want to print detailed information about top-level entries missing in the resume
-      top_level_entries = [
-        "contacts", "addresses", "web_presence", "summary", "work", "teaching", "projects", "other",
-        "committees", "volunteer", "visits", "education", "publications", "talks", "awards", "achievements",
-        "software", "skills", "languages", "driving", "interests", "references"]
-      if not top_level_entries.include?(key) then
-        # $stderr.puts self.to_s
-        self.keys.each do |k|
-          $stderr.puts "  #{k}: #{self[k]}"
-        end
-        $stderr.puts ""
-      end
-    end
-
-    return self[key] if self.has_key? key
-
-    # we get here if the key is not found
-    # we report an error, return "" and continue
-    # the actual mileage might vary
-
-    # more error reporting: key not found
-    $stderr.puts "[E] Key '#{key}' not found in the following entry:"
-    # $stderr.puts self.to_s
-    self.keys.each do |k|
-      $stderr.puts "  #{k}: #{self[k]}"
-    end
-    $stderr.puts ""
-
-    return ""
-  end
-end
-

data/lib/resme/templates/resume.json.erb

@@ -1,137 +1,155 @@
 {
- "basics": {
-   "name": "<%= full_name(data).to_json %>",
-   "label": "<%= data.basics.title.to_json %>",
-   "picture": "<%= data.basics.picture %>",
-   "email": "<%= e = data.contacts.select { |x| x.label == "email" }.first; e.value if e %>",
-   "phone": "<%= p = data.contacts.select { |x| x.label == "mobile" }.first; p.value if p %>",
-   "website": "<%= w = data.web_presence.select { |x| x.label == "website" }.first; w.value if w %>",
-   "summary": "<%= data.summary.to_json %>",
-   "location": {
-     "address": "<%= data.addresses[0].street.to_json %>",
-     "postalCode": "<%= data.addresses[0].zip_code %>",
-     "city": "<%= data.addresses[0].city %>",
-     "countryCode": "<%= data.addresses[0].country %>",
-     "region": "<%= data.addresses[0].region %>"
-   },
-   "profiles": [
-   <% sequence = data.web_presence || []; sequence.each_with_index do |profile, index| %>
-   {
-     "network": "<%= profile.label %>",
-     <%# "username": "", %>
-     "url": "<%= profile.value %>"
-   }
-   <%= "," unless index == sequence.size - 1 %>
-   <% end %>
-   ]
- },
- "work": [
-   <% sequence = data.work || []; sequence.each_with_index do |job, index| %>
-   {
-     "company": "<%= job.who.to_json %>",
-     "position": "<%= job.role.to_json %>",
-     "website": "<%= job.website %>",
-     "startDate": "<%= job.from %>",
-     "endDate": "<%= job.till %>",
-     "summary": "<%= job.summary.to_json %>"
-     <%# "highlights": [ "Started the company" ] %>
-   }
-   <%= "," unless index == sequence.size - 1 %>
-   <% end %>
- ],
- "volunteer": [
-   <% sequence = data.volunteer || []; sequence.each_with_index do |job, index| %>
-   {
-     "organization": "<%= job.who.to_json %>",
-     "position": "<%= job.role.to_json %>",
-     "website": "<%= job.website %>",
-     "startDate": "<%= job.from %>",
-     "endDate": "<%= job.till %>",
-     "summary": "<%= job.summary.to_json %>"
-     <%# "highlights": [ "Started the company" ] %>
-    }
-    <%= "," unless index == sequence.size - 1 %>
-    <% end %>
- ],
- "education": [
-    <% sequence = data.education.select { |x| x.publish }; sequence.each_with_index do |edu, index| %>
+  "basics": {
+    "name": <%= full_name(data).to_json %>,
+    "label": <%= data["basics"]["title"].to_json %>,
+<% if data["basics"]["picture"] -%>
+    "picture": <%= data["basics"]["picture"] %>,
+<% end -%>
+<% if data["contacts"] -%>
+    "email": "<%= ((data["contacts"] || []).select { |x| x["label"] == "email" }.first || {})["value"]  %>",
+    "phone": "<%= ((data["contacts"] || []).select { |x| x["label"] == "mobile" }.first || {})["value"] %>",
+<% end %>
+<% if data["web_presence"] -%>
+    "website": "<%= ((data["web_presence"] || []).select { |x| x["label"] == "website" }.first || {})["value"] %>",
+<% end -%>
+<% if data["summary"] -%>
+    "summary": <%= data["summary"].to_json %>,
+<% end -%>
+<% if data["addresses"] -%>
+    "location": {
+      "address": <%= data["addresses"][0]["street"].to_json %>,
+      "postalCode": "<%= data["addresses"][0]["zip_code"] %>",
+      "city": "<%= data["addresses"][0]["city"] %>",
+      "countryCode": "<%= data["addresses"][0]["country"] %>",
+      "region": "<%= data["addresses"][0]["region"] %>"
+    },
+<% end -%>
+<% if data["web_presence"] -%>
+    "profiles": [
+<% (data["web_presence"] || []).each do |profile| -%>
+      {
+        "network": "<%= profile["label"] %>",
+        "url": "<%= profile["value"] %>"
+      },
+<% end -%>
+    ]
+<% end -%>
+  },
+<% if data["work"] -%>
+  "work": [
+<% (data["work"] || []).each do |job| -%>
     {
-         "institution": "<%= edu.school.to_json %>",
-         "area": "<%= edu.topic.to_json %>",
-         "studyType": "<%= edu.degree.to_json %>",
-         "startDate": "<%= edu.from %>",
-         "endDate": "<%= edu.till %>",
-         "gpa": "<%= edu.score %>"
-         <%# "courses": [ "DB1101 - Basic SQL" ] %>
-    }
-    <%= "," unless index == sequence.size - 1 %>
-    <% end %>
- ],
- "awards": [
-   <% sequence = data.awards || []; sequence.each_with_index do |award, index| %>
-   {
-     "title": "<%= award.title.to_json %>",
-     "date": "<%= award.date %>",
-     "awarder": "<%= award.who.to_json %>"
-     "summary": "<%= award.summary.to_json %>"
-   }
-   <%= "," unless index == sequence.size - 1 %>
-   <% end %>
- ],
- "publications": [
-   <% squence = data.publications || []; sequence.each_with_index do |pub, index| %>
-   {
-     "name": "<%= pub.title.to_json %>",
-     "publisher": "<%= pub.publisher.to_json %>",
-     "releaseDate": "<%= pub.date %>",
-     "website": "<%= pub.url %>",
-     "summary": "<%= pub.summary.to_json %>"
-   }
-   <%= "," unless index == sequence.size - 1 %>
-   <% end %>
- ],
- "skills": [
-   <% sequence = data.skills || []; sequence.each_with_index do |skill, index| %>
-   {
-     "name": "<%= skill.name.to_json %>",
-     "level": "<%= skill.level.to_json %>"
-     <%# "keywords": [...] %>
-   }
-   <%= "," unless index == sequence.size - 1 %>
-   <% end %>
- ],
- "languages": [
-    <% data.languages.mother_tongues.each do |mt| %>
+      "company": <%= job["who"].to_json %>,
+      "position": <%= job["role"].to_json %>,
+      "website": "<%= job["website"] %>",
+      "startDate": "<%= job["from"] %>",
+      "endDate": "<%= job["till"] %>",
+      "summary": <%= job["summary"].to_json %>
+<%# "highlights": [ "Started the company" ] %>
+    },
+<% end -%>
+  ],
+<% end -%>
+<% if data["volunteer"] -%>
+  "volunteer": [
+<% (data["volunteer"] || []).each do |job| -%>
     {
-      "name": "<%= mt.language.to_json %>",
-      "level": "Native speaker"
-    }
-    <%= "," unless data.languages.foreign == nil %>
-    <% end %>
-    <% sequence = data.languages.foreign || []; sequence.each_with_index do |lang, index| %>
+      "organization": <%= job["who"].to_json %>,
+      "position": <%= job["role"].to_json %>,
+      "website": "<%= job["website"] %>",
+      "startDate": "<%= job["from"] %>",
+      "endDate": "<%= job["till"] %>",
+      "summary": <%= job["summary"].to_json %>
+<%# "highlights": [ "Started the company" ] %>
+    },
+<% end -%>
+  ],
+<% end %>
+<% if data["education"] %>
+  "education": [
+<% data["education"].select { |x| x["publish"] }.each do |edu| -%>
+     {
+          "institution": <%= edu["school"].to_json %>,
+          "area": <%= edu["topic"].to_json %>,
+          "studyType": <%= edu["degree"].to_json %>,
+          "startDate": "<%= edu["from"] %>",
+          "endDate": "<%= edu["till"] %>",
+          "gpa": "<%= edu["score"] %>"
+<%# "courses": [ "DB1101 - Basic SQL" ] %>
+     },
+<% end -%>
+  ],
+<% end -%>
+<% if data["awards"] -%>
+  "awards": [
+<% (data["awards"] || []).each do |award| -%>
     {
-      "name": "<%= lang.language.to_json %>",
-      "level": "<%= lang.level.to_json %>"
-    }
-    <%= "," unless index == sequence.size - 1 %>
-    <% end %>
- ],
- "interests": [
-    <% sequence = data.interests || []; sequence.each_with_index do |interest, index| %>
+      "title": <%= award["title"].to_json %>,
+      "date": <%= award["date"] %>,
+      "awarder": <%= award["who"].to_json %>,
+      "summary": <%= award["summary"].to_json %>
+    },
+<% end -%>
+  ],
+<% end -%>
+<% if data["publications"] -%>
+  "publications": [
+<% (data["publications"] || []).each do |pub| -%>
     {
-      "name": "<%= interest.name.to_json %>",
-      <%# "keywords": [...] %>
+      "name": <%= pub["title"].to_json %>,
+      "publisher": <%= pub["publisher"].to_json %>,
+      "releaseDate": "<%= pub["date"] %>",
+      "website": "<%= pub["url"] %>",
+      "summary": <%= pub["summary"].to_json %>
     },
-    <%= "," unless index == sequence.size - 1 %>
-    <% end %>
- ],
- "references": [
-  <% sequence = data.references || []; sequence.each_with_index do |reference, index| %>
-  {
-   "name": "<%= reference.name.to_json %>",
-   "reference": "<%= reference.reference.to_json %>"
-  }
-  <%= "," unless index == sequence.size - 1 %>
-  <% end %>
- ]
+<% end -%>
+  ],
+<% end -%>
+<% if data["skills"] -%>
+  "skills": [
+<% (data["skills"] || []).each do |skill| -%>
+    {
+      "name": <%= skill["name"].to_json %>,
+      "level": <%= skill["level"].to_json %>
+<%# "keywords": [...] -%>
+    },
+<% end -%>
+  ],
+<% end -%>
+<% if data["languages"] -%>
+  "languages": [
+<% data["languages"]["mother_tongues"].each do |mt| -%>
+     {
+       "name": <%= mt["language"].to_json %>,
+       "level": "Native speaker"
+     },
+<% end -%>
+<% (data["languages"]["foreign"] || []).each do |lang| -%>
+     {
+       "name": <%= lang["language"].to_json %>,
+       "level": <%= lang["level"].to_json %>
+     },
+<% end -%>
+  ],
+<% end -%>
+<% if data["interests"] -%>
+  "interests": [
+<% (data["interests"] || []).each do |interest| -%>
+     {
+       "name": <%= interest["name"].to_json %>,
+<%# "keywords": [...] -%>
+     },
+<% end -%>
+  ],
+<% end -%>
+<% if data["references"] -%>
+  "references": [
+<% (data["references"] || []).each do |reference| -%>
+   {
+    "name": <%= reference["name"].to_json %>,
+    "reference": <%= reference["reference"].to_json %>
+   },
+<% end -%>
+  ]
+<% end %>
 }