resme 0.3.0 → 0.4.0

data/lib/resme/cli/command_syntax.rb

@@ -1,234 +1,253 @@
-require 'slop'
+require "optparse"
 
 module Resme
   module CommandSyntax
-    # return a hash with all the commands and their options 
+    # Return a hash of hashes.  Each key is the name of a command and
+    # includes useful information, such as an Option object to
+    # parse options and a documentation string.
     def self.commands
-      h = Hash.new
-      self.methods.each do |method|
-        if method.to_s.include?("_opts") then
-          h = h.merge(eval(method.to_s))
-        end
+      cmd_spec = {}
+      methods.each do |method|
+        cmd_spec = cmd_spec.merge eval(method.to_s) if method.to_s.include?("_opts")
       end
-      return h
+      cmd_spec
     end
 
-    private
-
     def self.version_opts
-      opts = Slop::Options.new
-      opts.banner = "version -- print version information"
-      help = <<EOS
-NAME
-   #{opts.banner}
-
-SYNOPSYS
-   #{opts.to_s}
-
-DESCRIPTION
-   return version information
-
-EXAMPLES
-   # resme version
-   resme version #{VERSION}
-EOS
-      return { :version => [opts, :version, help] }
+      opts = OptionParser.new do |opts|
+        opts.banner = "version # print version information"
+      end
+      
+      help = <<-EOS
+        NAME
+          #{opts.banner}
+
+        SYNOPSYS
+          #{opts.to_s}
+
+        DESCRIPTION
+          return version information
+
+        EXAMPLES
+          # resme version
+          resme version #{VERSION}
+      EOS
+      
+      {
+        version: {
+          name: :version,
+          options: opts,
+          help: help.gsub("        ", "")
+        }
+      }
     end
 
     def self.console_opts
-      opts = Slop::Options.new
-      opts.banner = "console [options] -- Enter the console"
-      help = <<EOS
-NAME
-   #{opts.banner}
-
-SYNOPSYS
-   #{opts.to_s}
-
-DESCRIPTION
-   Invoke a console, from which you can more easily run
-   resme commands.
-
-EXAMPLES
-   resme console
-   resme:000> 
-   resme:001> 
-   resme:002>
-EOS
-       return { :console => [opts, :console, help] } 
+      opts = OptionParser.new do |opts|
+        opts.banner = "console # enter the console"
+      end
+      
+      help = <<-EOS
+        NAME
+          #{opts.banner}
+
+        SYNOPSYS
+          #{opts.to_s}
+
+        DESCRIPTION
+          Invoke a console, from which you can more easily run
+          resme commands.
+
+        EXAMPLES
+          resme console
+          resme:000> check
+          resme:001> generate -t md
+          resme:002>
+      EOS
+      
+      {
+        console: {
+          name: :console,
+          options: opts,
+          help: help.gsub("        ", "")
+        }
+      }
     end
 
     def self.man_opts
-      opts = Slop::Options.new
-      opts.banner = "man -- print a manual page"
-      help = <<EOS
-NAME
-   #{opts.banner}
-
-SYNOPSYS
-   #{opts.to_s}
-
-DESCRIPTION
-   Print the README file of this gem
-
-EXAMPLES
-   resme man
-EOS
-      return { :man => [opts, :man, help] }
+      opts = OptionParser.new do |opts|
+        opts.banner = "man # print resme manual page"
+      end
+      
+      help = <<-EOS
+        NAME
+          #{opts.banner}
+
+        SYNOPSYS
+          #{opts.to_s}
+
+        DESCRIPTION
+          Print the README file of this gem
+
+        EXAMPLES
+          resme man
+      EOS
+      
+      {
+        man: {
+          name: :man,
+          options: opts,
+          help: help.gsub("        ", "")
+        }
+      }
     end
 
     def self.help_opts
-      opts = Slop::Options.new
-      opts.banner = "help [command] -- print usage string"
-      help = <<EOS
-NAME
-   #{opts.banner}
-
-SYNOPSYS
-   #{opts.to_s}
-
-DESCRIPTION
-   Print help about a command
-
-EXAMPLES
-   resme help
-   resme help generate
-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.
-
+      opts = OptionParser.new do |opts|
+        opts.banner = "help [command] # print command usage"
+      end
 
-EXAMPLES
-   resme file.yml
-EOS
-       return { :check => [opts, :check, help] } 
+      help = <<-EOS
+        NAME
+          #{opts.banner}
+
+        SYNOPSYS
+          #{opts.to_s}
+
+        DESCRIPTION
+          Print help about a command
+
+        EXAMPLES
+          resme help
+          resme help generate
+      EOS
+      {
+        help: {
+          name: :help,
+          options: opts,
+          help: help.gsub("        ", "")
+        }
+      }
     end
 
     def self.init_opts
-      opts = Slop::Options.new
-      opts.banner = "init [-o output_filename]"
-      opts.string "-o", "--output", "Output filename"
-      opts.boolean "-f", "--force", "Overwrite existing file (if present)"
-      help = <<EOS
-NAME
-   #{opts.banner}
-
-SYNOPSYS
-   #{opts.to_s}
-
-DESCRIPTION
-
-   Generate a YAML template for your resume in the current directory.
-
-EXAMPLES
-       
-   resme init
-   resme -o r.yml
-   resme -o r.yml --force
-EOS
-      return { init: [opts, :init, help] }
-    end    
-
-    def self.md_opts
-      opts = Slop::Options.new
-      opts.banner = "md [-o output_filename] file.yml ..."
-      opts.string "-o", "--output", "Output filename"
-      help = <<EOS
-NAME
-   #{opts.banner}
-
-SYNOPSYS
-   #{opts.to_s}
-
-DESCRIPTION
-
-   Generate a markdown resume from the YAML input files.
-
-EXAMPLES
-       
-   resme md -o r.md resume.yml
-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 ..."
-      opts.string "-o", "--output", "Output filename"
-      help = <<EOS
-NAME
-   #{opts.banner}
-
-SYNOPSYS
-   #{opts.to_s}
-
-DESCRIPTION
-
-   Generate a JSON resume from the YAML input files.
-
-EXAMPLES
-       
-   resme json -o r.md resume.yml
-EOS
-      return { json: [opts, :json, help] }
+      opts = OptionParser.new do |opts|
+        opts.banner = "init [options] # generate an empty resume.yml file"
+        opts.on("-o", "--output FILENAME", String, "Output filename")
+        opts.on("-f", "--force", FalseClass, "Overwrite existing file (if present)")
+      end
+      
+      help = <<-EOS
+        NAME
+          #{opts.banner}
+
+        SYNOPSYS
+          #{opts.to_s}
+
+        DESCRIPTION
+          Generate a YAML template for your resume in the current directory.
+
+        EXAMPLES
+          resme init
+          resme init -o r.yml
+          resme init -o r.yml --force
+      EOS
+      {
+        init: {
+          name: :init,
+          options: opts,
+          help: help.gsub("        ", "")
+        }
+      }
     end
 
-    def self.europass_opts
-      opts = Slop::Options.new
-      opts.banner = "europass [-o output_filename] file.yml ..."
-      opts.string "-o", "--output", "Output filename"
-      help = <<EOS
-NAME
-   #{opts.banner}
+    def self.check_opts
+      opts = OptionParser.new do |opts|
+        opts.banner = "check resume.yml # Check syntax of resume.yml"
+      end
 
-SYNOPSYS
-   #{opts.to_s}
+      help = <<-EOS
+        NAME
+          #{opts.banner}
+
+        SYNOPSYS
+          #{opts.to_s}
+
+        DESCRIPTION
+          Check whether a YAML file conforms with the RESME syntax.
+
+        EXAMPLES
+          resme check file.yml
+      EOS
+      
+      {
+        check: {
+          name: :check,
+          options: opts,
+          help: help.gsub("        ", "")
+        }
+      }
+    end
 
-DESCRIPTION
+    def self.list_opts
+      opts = OptionParser.new do |opts|
+        opts.banner = "list resume.yml # List main sections in resume.yml"
+      end
 
-   Generate a Europass XML resume from the YAML input files.
+      help = <<-EOS
+        NAME
+          #{opts.banner}
+
+        SYNOPSYS
+          #{opts.to_s}
+
+        DESCRIPTION
+          List main sections in resume.yml.
+
+        EXAMPLES
+          resme list file.yml
+      EOS
+      
+      {
+        list: {
+          name: :list,
+          options: opts,
+          help: help.gsub("        ", "")
+        }
+      }
+    end
 
-EXAMPLES
-       
-   resme europass -o r.md resume.yml
-EOS
-      return { europass: [opts, :europass, help] }
-    end 
+    def self.generate_opts
+      opts = OptionParser.new do |o|
+        o.banner = "generate [options] resume.yml ... # output resume"
+        o.on("-e", "--erb FILENAME", String, "Template to use")
+        o.on("-t", "--to FORMAT", String, "Output format")
+        o.on("-o", "--output FILENAME", String, "Output filename")
+        o.on("-s", "--skip SECTION,SECTION", Array, "Sections to skip")
+      end
 
+      help = <<-EOS
+        NAME
+          #{opts.banner}
+
+        SYNOPSYS
+          #{opts.to_s}
+
+        DESCRIPTION
+          Generate a resume from the YAML input files.
+
+        EXAMPLES
+          resme generate -t org resume.yml
+          resme generate -t md -o r.md section-1.yml section-2.yml
+      EOS
+      
+      {
+        generate: {
+          name: :generate,
+          options: opts,
+          help: help.gsub("        ", "")
+        }
+      }
+    end
   end
 end

data/lib/resme/renderer/renderer.rb

@@ -133,23 +133,26 @@ def has_day input
   end
 end
 
-# Access hash keys like they were class methods
-# hash["key"] -> hash.key
+# Access hash keys like they were class methods (hash["key"] -> hash.key) and
+# report errors if key is missing
 class Hash
   def method_missing(m)
     key = m.to_s
 
+    # 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 = %w[
+      contacts addresses web_presence summary work teaching projects other
+      committees volunteer visits education publications talks awards
+      achievements software skills languages driving interests references
+    ]
+
     # 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
+      unless top_level_entries.include?(key)
         # $stderr.puts self.to_s
         self.keys.each do |k|
           $stderr.puts "  #{k}: #{self[k]}"
@@ -160,18 +163,17 @@ class Hash
 
     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
+    # 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]}"
+    unless top_level_entries.include?(key)
+      self.keys.each do |k|
+        $stderr.puts "  #{k}: #{self[k]}"
+      end
+      $stderr.puts ""
     end
-    $stderr.puts ""
-
+    
     return ""
   end
 end

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

@@ -1,8 +1,8 @@
-# <%= full_name data %>, <%= data.basics.title %>
+# <%= full_name data %>, <%= data.basics&.title %>
 
 <%
-addresses = data.addresses.map { |x| "**#{x.label}**: #{x.street}, #{x.zip_code} #{x.city}" }
-presence = data.contacts.map { |x| "**#{x.label}:** #{x.value}" } + data.web_presence.map { |x| "<" + x.value + ">" }
+addresses = (data["addresses"] || []).map { |x| "**#{x.label}**: #{x.street}, #{x.zip_code} #{x.city}" }
+presence = (data["contacts"] || []).map { |x| "**#{x.label}:** #{x.value}" } + (data["web_presence"] || []).map { |x| "<" + x.value + ">" }
 -%>
 <%= presence.map { |x| "* #{x}" }.join("\n") %>
 <%= addresses.map { |x| "* #{x}" }.join("\n") %>

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

@@ -1,26 +1,29 @@
-#+TITLE: <%= full_name data %>, <%= data.basics.title %>
-#+AUTHOR: <%= data.contacts.select { |x| x.label == "email" }.first.value %>
+#+TITLE: Curriculum Vitae
+#+AUTHOR: <%= full_name data %>, <%= data.basics&.title %>
+#+EMAIL: <%= (data["contacts"] || []).select { |x| x.label == "email" }.first&.value %>
 #+DATE: <<%= Date.today %>>
 #+STARTUP: showall
 #+OPTIONS: toc:nil num:nil
 #+OPTIONS: h:1
 #+OPTIONS: prop:nil
 
+<% if data["addresses"] or data["contacts"] %>
 * Contacts
   :PROPERTIES:
-<% data.addresses.each do |x| -%>
+<% (data["addresses"] || []).each do |x| -%>
   <%= ":#{x.label.upcase}: #{x.street}, #{x.zip_code} #{x.city}" %>
 <% end -%>
-<% data.contacts.each do |x| -%>
+<% (data["contacts"] || []).each do |x| -%>
   <%= ":#{x.label.upcase}: #{x.value}" %>
 <% end -%>
   :END:
 
-<% data.contacts.each do |x| -%>
+<% (data["contacts"] || []).each do |x| -%>
 | <%= "%-30s" % x.label %> | <%= "%-40s" % x.value %> |
 <% end -%>
+<% end %>
 
-<% if data["work"] -%>
+<% if data["summary"] -%>
 * Summary
 
 <%= reflow_to_string data.summary, 78 -%>
@@ -40,7 +43,7 @@
 * Work Experience
 
 <% (data.work || []).each do |item| -%>
-** *<%= period item %>: <%= clean [item.role, item.who].join(", ") %>*
+** <%= period item %>: <%= clean [item.role, item.who].join(", ") %>
 <%= propertify item, "   " %>
 
 <%= reflow_to_string item["summary"], 72, "   " -%>
@@ -52,7 +55,7 @@
 * Teaching
 
 <% (data.teaching || []).each do |item| -%>
-** *<%= period item %>: <%= item.subject %>*
+** <%= period item %>: <%= item.subject %>
 <%= propertify item, "   " %>
 
    <%= [item["role"], item["school"], item["who"]].join(", ") %>
@@ -64,7 +67,7 @@
 * Projects
 
 <% (data.projects || []).each do |item| -%>
-** *<%= period item %>: <%= [item.name, item.role].join(", ") %>*
+** <%= period item %>: <%= [item.name, item.role].join(", ") %>
 <%= propertify item, "   " %>
 
 <%= reflow_to_string item["summary"], 72, "   " -%>
@@ -73,10 +76,10 @@
 <% end -%>
 
 <% if data["other"] -%>
-* Other Initiatives
+* Other
 
 <% (data.other || []).each do |item| -%>
-** *<%= period item %>: <%= [item["who"], item["role"]].join(", ") %>*
+** <%= period item %>: <%= [item["who"], item["role"]].join(", ") %>
 <%= propertify item, "   " %>
 
 <%= reflow_to_string item["summary"], 72, "   " -%>
@@ -150,7 +153,7 @@
 * <%= group.capitalize %>
 
 <% (group || []).each do |item| -%>
-** *<%= item.date %>: <%= [item.title, item.who, item.address].join(", ") %>*
+** <%= item.date %>: <%= [item.title, item.who, item.address].join(", ") %>
 <%= propertify item, "  " %>
 
 <%= reflow_to_string item.summary, 72, "  " -%>