resme 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c6651b4bfa0fa13684adffb20867adec59cbc93d7d611451f68b042e0f41147d
-  data.tar.gz: f53176624b4f6dd462bcedeee0ac9d1233b3dfa374ef377cd7237c60878733c6
+  metadata.gz: 88b2d8e225f97233ed991e95c8be2798b982d803941dacb7fd71b623a32e7822
+  data.tar.gz: 7f44a0bf98b3e49b33fce8924ae74545aa6591bfec53f1952aa9067167a8079c
 SHA512:
-  metadata.gz: 8ef0373b98367dd22913213ef546899b8f20161d5e3cd8e4db4982e8d5602d9b3006fade7f899ce6010a82dda06a7f306c7f702150d8a099a7f39dff19015a24
-  data.tar.gz: 2bf517a51726b9a89d6a7f71b5ba50b612c69283ed3f56900477d81b1f036183a4203448f7503087e4c817ed69ac2a57a9b56ae0e522ba7f63d70cf678e98afd
+  metadata.gz: e0bdffd6b716cc6056c158a1672144343a66674c5371136d70c302d6e338279e0e582f0fbd126e577967d6f668557537f6732102faad014ec3478d87c4e2cd9b
+  data.tar.gz: 8feff2a7f410655dffc1199c6b47d9358acbaf5f0450715608b95dc393ec0ab2a25fc53b87a3accac0e047cca05c7ac2e02c0e2f710051b4af7bcde44e46180c

data/README.md

@@ -1,22 +1,18 @@
 # RESME - A Resume Generator
 
 Keep your resume in YAML and output it in various formats, including
-markdown, json, and the Europass XML format.
-
-Interesting features:
-
-- the rendering engine is based on ERB.  This simplifies the creation
-  of new output formats (and extending/modifying the YML structure to
-  one's needs).
-- no gem/cli application I am aware of outputs in the Europass format
+org-mode, markdown, json, and the Europass XML format.
 
+The rendering engine is based on ERB.  This simplifies the creation of
+new output formats (and extending/modifying the YML structure to
+one's needs).
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'resme'
+    gem 'resme'
 ```
 
 And then execute:
@@ -36,11 +32,14 @@ Start with:
 whih generates a YML template for your resume in the current
 directory.  Comments in the YML file should help you fill the various
 entries.  Notice that most entries are optional and you can remove
-sectins hich are not relevant for your resume.
+sections which are not relevant for your resume.
+
+You can then generate a resume using one of the existing templates or
+by writing your own template (see below).
 
-Once you have started filling you resume, you can then generate a
-resume using the existing templates or by writing your own template
-(see below).
+To generate a resume in Markdown using the provided template:
+
+   $ resme org [-o output_filename] file.yml ... 
 
 To generate a resume in Markdown using the provided template:
 
@@ -50,7 +49,7 @@ To generate a resume in the Europass XML format using the provided template:
 
    $ resme europass [-o output_filename] file.yml ...
 
-To generate a resume in the Json format (https://jsonresume.org/):
+To generate a resume in the JSON format (https://jsonresume.org/):
 
    $ resme json [-o output_filename] file.yaml ...
 
@@ -64,6 +63,15 @@ Remarks:
   generated to `resume-YYYY.MM.DD.format`, where `YYYY-MM-DD` is today's date
   and `format` is the chosen output format
 
+## Checking validity
+
+Use the `check` command to verify whether your YAML file conforms with
+the intended syntax.
+
+```ruby
+resme check resume.yaml
+```
+
 ## Dates in the resume
 
 Enter dates in the resume in one of the following formats:
@@ -79,9 +87,11 @@ irrelevant).
 
 ## Creating your own templates
 
-The resumes are generated from the YML matter using ERB templates,
-similar to what Jekyll and Middleman do with data files.  (See,
-e.g., [data files](https://middlemanapp.com/advanced/data-files/.)
+The resumes are generated from the YML matter using ERB templates.
+The output formats should support different backends (OrgMode and
+Markdown easily allow for generation of PDFs, HTML, and ODT to mention
+a few).
+
 You can define your own templates if you wish to do so.
 
 All the data in the resume is made available in the `data` variable.
@@ -104,12 +114,16 @@ Some functions can be used in the templates to better control the output.
 String manipulation functions:
 
 * `clean string` removes any space at the beginning of `string`
-* `reflow string, n` makes `string` into an array of strings of
-  length lower or equal to `n` (useful if you are outputing a txt format,
-  for instance.
+* `reflow string, n` makes `string` into an array of strings of length
+  lower or equal to `n` (useful if you are outputting a textual
+  format, for instance.
 
 Dates manipulation functions:
 
+* `period` generates a string recapping a period.  The function
+  abstracts different syntax you can use for entries (i.e., `date` or
+  `from` and `till`) and different values for the entries (e.g., a
+  missing value for `till`)
 * `year string`, `month string`, `day string` return, respectively the
   year, month and day from strings in the format `YYYY-MM-DD`s
 * `has_month input` returns true if `input` has a month, that is, it is
@@ -117,7 +131,7 @@ Dates manipulation functions:
 * `has_day input` returns true if `input` has a day, that is, it is
   a date or it is in the form `YYYY-MM-DD`
 
-You can find some templates in `lib/resme/templates`.  These might be
+You can find the templates in `lib/resme/templates`.  These might be
 good starting points if you want to develop your own.
 
 ## Contributing your templates
@@ -154,17 +168,25 @@ In `doc/todo.org` ... guess what is my preferred editor!
 
 ## Bugs
  
-There are slight differences in the information outputted in the
-various formats.  For instance, gender and birthdate are used in the
-Europass format, but not in the Markdown format.  This is in part due
-to the different standards and in part due to personal choices (here
-"personal choices" could be also read "bug").
+There are still slight differences in the syntax of entries and in the
+way in which the information is formatted in various output formats.
+For instance, gender and birthdate are used in the Europass format,
+but not in the Markdown format.  This is in part due to the different
+standards and in part due to personal preferences.
 
-Entries are not sorted by date before outputting them.  Make sure you
-put them in the order you want them to appear in your resume.
+**Entries are not sorted by date before outputting them.  Make sure you
+put them in the order you want them to appear in your resume.**
 
-Unkown number of unkown bugs.
+Unknown number of unknown bugs.
 
 ## Release History
 
-* **0.1** is th first release
+* **0.3** introduces output to org-mode, introduces references for the
+  CV, improves output to JSON, adds a `check` command, removes useless
+  blank lines in the output, supports `-%>` in the ERB templates,
+  fixes various typos in the documentation, introduces various new
+  formatting functions, to simplify template generation
+* **0.2** improves output of volunteering activities and other
+  information in the Europass and **significantly improves error and
+  warning reporting**
+* **0.1** is the first release

data/lib/resme/cli/command_semantics.rb

@@ -4,6 +4,8 @@ require 'fileutils'
 require 'date'
 require 'yaml'
 require 'erb'
+require 'json'
+require 'kwalify'
 
 module Resme
   module CommandSemantics
@@ -90,6 +92,32 @@ module Resme
     #
     # APP SPECIFIC COMMANDS
     #
+    def self.check opts, argv
+      schema = Kwalify::Yaml.load_file(File.join(File.dirname(__FILE__), "/../templates/schema.yml"))
+      ## or
+      # schema = YAML.load_file('schema.yaml')
+
+      ## create validator
+      validator = Kwalify::Validator.new(schema)
+
+      ## load document
+      document = Kwalify::Yaml.load_file(argv[0])
+      ## or
+      #document = YAML.load_file('document.yaml')
+
+      ## validate
+      errors = validator.validate(document)
+
+      ## show errors
+      if errors && !errors.empty?
+        for e in errors
+          puts "[#{e.path}] #{e.message}"
+        end
+      else
+        puts "The file #{argv[0]} validates."
+      end
+    end
+
     def self.init opts, argv
       output = opts[:output] || "resume.yml"
       force = opts[:force]
@@ -113,6 +141,14 @@ module Resme
       puts "Resume generated in #{output}"
     end
 
+    def self.org opts, argv
+      output = opts[:output] || "resume-#{Date.today}.org"
+      template = File.join(File.dirname(__FILE__), "/../templates/resume.org.erb")
+
+      render argv, template, output
+      puts "Resume generated in #{output}"
+    end
+
     def self.json opts, argv
       output = opts[:output] || "resume-#{Date.today}.json"
       template = File.join(File.dirname(__FILE__), "/../templates/resume.json.erb")
@@ -138,7 +174,10 @@ module Resme
         data = data.merge(YAML.load_file(file))
       end
       template = File.read(template_filename)
-      output = ERB.new(template).result(binding)
+      output = ERB.new(template, nil, '-').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, output
     end
 

data/lib/resme/cli/command_syntax.rb

@@ -97,6 +97,26 @@ EOS
       return { :help => [opts, :help, help] }
     end
 
+    def self.check_opts
+      opts = Slop::Options.new
+      opts.banner = "check -- Check whether a YAML file conforms with the RESME syntax"
+      help = <<EOS
+NAME
+   #{opts.banner}
+
+SYNOPSYS
+   #{opts.to_s}
+
+DESCRIPTION
+   Check whether a YAML file conforms with the RESME syntax.
+
+
+EXAMPLES
+   resme file.yml
+EOS
+       return { :check => [opts, :check, help] } 
+    end
+
     def self.init_opts
       opts = Slop::Options.new
       opts.banner = "init [-o output_filename]"
@@ -111,7 +131,7 @@ SYNOPSYS
 
 DESCRIPTION
 
-   Generate a YML template for your resume in the current directory.
+   Generate a YAML template for your resume in the current directory.
 
 EXAMPLES
        
@@ -135,7 +155,7 @@ SYNOPSYS
 
 DESCRIPTION
 
-   Generate a markdown resume from the YML input files.
+   Generate a markdown resume from the YAML input files.
 
 EXAMPLES
        
@@ -144,6 +164,28 @@ EOS
       return { md: [opts, :md, help] }
     end    
 
+    def self.org_opts
+      opts = Slop::Options.new
+      opts.banner = "org [-o output_filename] file.yml ..."
+      opts.string "-o", "--output", "Output filename"
+      help = <<EOS
+NAME
+   #{opts.banner}
+
+SYNOPSYS
+   #{opts.to_s}
+
+DESCRIPTION
+
+   Generate an org-mode resume from the YAML input files.
+
+EXAMPLES
+       
+   resme md -o r.md resume.yml
+EOS
+      return { org: [opts, :org, help] }
+    end    
+
     def self.json_opts
       opts = Slop::Options.new
       opts.banner = "json [-o output_filename] file.yml ..."
@@ -157,7 +199,7 @@ SYNOPSYS
 
 DESCRIPTION
 
-   Generate a JSON resume from the YML input files.
+   Generate a JSON resume from the YAML input files.
 
 EXAMPLES
        
@@ -179,7 +221,7 @@ SYNOPSYS
 
 DESCRIPTION
 
-   Generate a Europass XML resume from the YML input files.
+   Generate a Europass XML resume from the YAML input files.
 
 EXAMPLES
        

data/lib/resme/renderer/renderer.rb

@@ -1,14 +1,18 @@
 #
 # Utility functions you might want to use in your ERB
-# template
+# templates
 #
 
 # remove spaces at the beginning of string
-# remove extra spaces and special chars with a single space
+# replace extra spaces and special chars with a single space
 def clean string
   string.gsub(/^[\t\n ]+/, "").gsub(/[\t\n ]+/, " ")
 end
 
+def full_name data
+  [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
 # and newlines
 #
@@ -20,24 +24,86 @@ end
 # special cases: if one line is longer than chars characters, then
 # break at the first space after chars
 #
-def reflow string, chars
+def reflow_to_array string, chars
   if string.length < chars
     return [clean(string)]
   else
     chars.downto(0).each do |index|
       if string[index] == " " or string[index] == "\n" or string[index] == "\t"
-        return [clean(string[0..index-1])] + reflow(string[index+1..-1], chars)
+        return [clean(string[0..index-1])] + reflow_to_array(string[index+1..-1], chars)
       end
     end
     chars.upto(string.length).each do |index|
       if string[index] == " " or string[index] == "\n" or string[index] == "\t"
-        return [clean(string[0..index-1])] + reflow(string[index+1..-1], chars)
+        return [clean(string[0..index-1])] + reflow_to_array(string[index+1..-1], chars)
       end
     end
     return [clean(string)]
   end
 end
 
+def reflow_to_string string, chars, indentation = ""
+  array = reflow_to_array string, chars
+  output = ""
+  array.each do |line|
+    output << indentation + line + "\n"
+  end
+  output
+end
+
+# manage dates of an entry flexibly supporting the following formats:
+#
+# - from - till (with `from` or `till` possibly partial or empty)
+# - date (possibly partial)
+#
+# 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}"
+  else
+    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
+      from_year
+    else
+      "#{from_year} -- #{till_year ? till_year : "today"}"
+    end
+  end
+end
+
+# make an entry into an item of a list
+# - first argument, entry, is a hash containing the symbols specified in header and
+#   the following fields: summary and then from, till, or date
+# - second argument, header, is an array of symbols, whose values, comma-separated will generate the
+#   header line
+#
+# The output is along the lines of:
+#
+# - value of key1, value of key2
+#   period
+#   reflowed summary
+def itemize entry, header = ["role", "who", "address"]
+<<EOS
+- #{clean header.map { |x| entry[x] }.join(", ")}
+  #{period entry}
+#{reflow_to_string entry["summary"], 72, "  "}
+EOS
+end
+
+# generate a list of org-mode properties from item and exclude summary from the list
+def propertify item, indentation=""
+  output = ":PROPERTIES:\n"
+  item.each do |k, v|
+    if not ["summary", "details"].include? k
+      output << ":#{k.upcase}: #{v}\n"
+    end
+  end
+  output << ":END:"
+  output.gsub!(/^/, indentation)
+end
+
 # Utility function for managing dates (2015-01-01) and partial dates (2015-05)
 def year string
   string.to_s[0..3]
@@ -75,7 +141,7 @@ class Hash
 
     # error: nil value
     if self.has_key? key and self[key] == nil
-      $stderr.puts "WARNING!! The value of key '#{key}' is 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
@@ -84,10 +150,9 @@ class Hash
         "committees", "volunteer", "visits", "education", "publications", "talks", "awards", "achievements",
         "software", "skills", "languages", "driving", "interests", "references"]
       if not top_level_entries.include?(key) then
-        $stderr.puts "Offending entry:"
         # $stderr.puts self.to_s
         self.keys.each do |k|
-          $stderr.puts "\t#{k}: #{self[k]}"
+          $stderr.puts "  #{k}: #{self[k]}"
         end
         $stderr.puts ""
       end
@@ -100,7 +165,7 @@ class Hash
     # the actual mileage might vary
 
     # more error reporting: key not found
-    $stderr.puts "ERROR!! Key '#{key}' not found in the following entry."
+    $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]}"