resme 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8abd7d17f0d2b9a777cba680826c21d6ee882f3f3df0c74ba086e1d617d4b6b
-  data.tar.gz: b34b33c2f2d0f3beae3bef713efba2e39b05537d8a208380e6392271e0cbcb09
+  metadata.gz: 27d07b29ff7369747e8f43ad9cbdc29efe1023cca20de554f94c02fdc33c57f8
+  data.tar.gz: fc048d5417183cba079e387caa3c08d2540fb937a384aae05759622b91b82846
 SHA512:
-  metadata.gz: fe74aa311a4dd110c26a0760cf6d2f8cb1ba1ee8e587f2a64d00ff6aa420a2a7f6c37b1eec392ddf1b28abbe49ffb94d6b26d5f43f2797ba9fd7cc9874ebf5c1
-  data.tar.gz: 3f2ae60c5c8a4e7f8135aa7f43aafa081f913dc8dd6c1b4c6065606447a41b6afe414ae4f32e0541fc06284227d94628f31f59e80af02aee2147c054032137c8
+  metadata.gz: 77bab2cbc35e21bb7ce669100d6b0f66d4b9f60e496814b35aec3a1fb3346730bbfe0700d884cde697500a479007cbac61dc834dcd358b3b1ab4375e59ee60db
+  data.tar.gz: fa2c84c4358a0c86469f83f11cb8c361a8a90602ed58eadf8cf53701757d4525d1f27f27599fdf361af46a2fcce0243c2e014395375c84a82489834be5b56118

data/CHANGELOG.org

@@ -0,0 +1,19 @@
+#+TITLE: CHANGELOG
+#+AUTHOR: Adolfo Villafiorita
+
+* Version 1.5.0
+  - [user] New command =view= allows to view the template used
+    for generating a resume in a specific format
+  - [user] Check command is now based on ClassyHash
+  - [code] Various changes to the code
+
+* Version 1.4.0
+  - [user] New option =--skip= allows to skip some top-level sections.
+    You mileage might vary, as some formats might require the
+    information you are trying to skip
+  - [user] New command =generate= is now used to generate the Resume
+    in different formats.
+  - [user] New option =--erb= allows to specify a custom template for
+    generating the resume. Use it in conjunction with =view= (released
+    in version 1.5.0) to jump-start your layout.
+  

data/README.org

@@ -64,18 +64,33 @@ Supported formats include:
 - =json=: JSON format (https://jsonresume.org/)
 
 If you are not satisfied with the provided templates, you can write
-your own (see below).  In this case, however, =resme= is mainly an ERB
-renderer.
+your own (see below).
 
-Remarks:
+Notice that you can specify more than one YML file in input. This allows you to
+store data about your resume in different files, if you like to do so
+(e.g., work experiences could be in one file and talks in another).
+The YML files are merged before processing them.
 
-- You can specify more than one YML file in input. This allows you to
-  store data about your resume in different files, if you like to do so
-  (e.g., work experiences could be in one file and talks in another).
-  The YML files are merged before processing them.
-- The output filename is optional. If you do not specify one, the resume
-  is generated to =resume-YYYY.MM.DD.format=, where =YYYY-MM-DD= is
-  today's date and =format= is the chosen output format
+Full syntax:
+
+#+begin_src shell :results raw output :wrap example
+resme help
+#+end_src
+
+#+RESULTS:
+#+begin_example
+resme command [options] [args]
+Available commands:
+  view --template FORMAT # Print template used for format
+  console # enter the console
+  man # print resme manual page
+  help [command] # print command usage
+  init [options] # generate an empty resume.yml file
+  check resume.yml # Check syntax of resume.yml
+  list resume.yml # List main sections in resume.yml
+  version # print version information
+  generate [options] resume.yml ... # output resume
+#+end_example
 
 ** Checking validity
    :PROPERTIES:
@@ -110,24 +125,32 @@ The third and the forth format allows you to enter "partial" dates
    :END:
 
 The resumes are generated from the YML matter using ERB templates. The
-provided output formats should support different back ends (Org Mode
-and Markdown easily allow for generation of PDFs, HTML, and ODT, to
-mention a few).
+provided output formats should support different back ends.  Org Mode
+and Markdown, for instance, easily allow for generation of PDFs, HTML,
+and ODT, to mention a few.
+
+However, if you want, you can define your own templates.
 
-However, if you want, you can define your own templates.  All the data
-in the resume is made available in the =data= variable.  Thus, for
-instance, the following code snippets generates a list of all the work
-experiences:
+Use the command =view= to print one of the templates used by =resme=
+and build from that.
+
+#+begin_example
+resme view --template md
+#+end_example
+
+Notice that all the data in the resume is made available in the =data=
+variable.  Thus, for instance, the following code snippets generates a
+list of all the work experiences:
 
 #+BEGIN_EXAMPLE
-  <% data.work each do |exp| %>
-  - <%= exp.who %>
-    From: <%=  exp.from %> till: <%= exp.till %>
+  <% data["work"] each do |exp| %>
+  - <%= exp["who"] %>
+    From: <%=  exp["from"] %> till: <%= exp["till"] %>
   <% end %>
 #+END_EXAMPLE
 
-To specify your own ERB template use the option =-e= (=--erb=). Thus,
-for instance:
+To specify your own ERB template to build your resume use the option
+=-e= (=--erb=). Thus, for instance:
 
 #+BEGIN_EXAMPLE
   $ resme render -e template.md.erb [-o output_filename] file.yaml ...
@@ -200,6 +223,10 @@ https://github.com/avillafiorita/resme.
 The gem is available as open source under the terms of the
 [[http://opensource.org/licenses/MIT][MIT License]].
 
+** Change Log
+
+In =doc/changelog.org=
+
 ** Roadmap
    :PROPERTIES:
    :CUSTOM_ID: roadmap

data/lib/resme/cli/command_semantics.rb

@@ -5,7 +5,6 @@ require "date"
 require "yaml"
 require "erb"
 require "json"
-require "kwalify"
 
 module Resme
   module CommandSemantics
@@ -93,24 +92,24 @@ module Resme
     # APP SPECIFIC COMMANDS
     #
     def self.check(opts, argv)
-      path = File.join(File.dirname(__FILE__), "/../templates/schema.yml")
-      schema = Kwalify::Yaml.load_file(path)
-
-      # create validator
-      validator = Kwalify::Validator.new(schema)
-      # load document
-      document = Kwalify::Yaml.load_file(argv[0])
-      # validate
-      errors = validator.validate(document)
-
-      # show errors
-      if errors && !errors.empty?
-        for e in errors
-          puts "[#{e.path}] #{e.message}"
+      begin
+        document = YAML.load_file(argv[0], permitted_classes: [Date])
+      rescue Psych::SyntaxError => ex
+        puts "The file #{argv[0]} has an invalid structure."
+        puts ex.message
+        exit 1
+      end
+        
+      begin
+        errors = ResumeStructureValidator.validate(document)
+      rescue Exception => ex
+        puts "The files #{argv[0]} does not validate"
+        ex.entries.each do |error|
+          puts "#{error[:full_path]}: #{error[:message]}"
         end
-      else
-        puts "The file #{argv[0]} validates."
+        exit 1
       end
+      puts "The file #{argv[0]} has a valid structure."
     end
 
     def self.init(opts, argv)
@@ -141,6 +140,12 @@ module Resme
       end
     end
 
+    def self.view(opts, argv)
+      format = opts[:template] == "europass" ? "xml" : opts[:template]
+      template = File.join(File.dirname(__FILE__), "/../templates/resume.#{format}.erb")
+      puts File.read template
+    end
+
     def self.generate(opts, argv)
       format = opts[:to] == "europass" ? "xml" : opts[:to]
       output = opts[:output] || "resume-#{Date.today}.#{format}"

data/lib/resme/cli/command_syntax.rb

@@ -217,6 +217,35 @@ module Resme
       }
     end
 
+    def self.view_opts
+      opts = OptionParser.new do |o|
+        o.banner = "view --template FORMAT # Print template used for format"
+        o.on("-t", "--template FORMAT", String, "View template for FORMAT")
+      end
+
+      help = <<-EOS
+        NAME
+          #{opts.banner}
+
+        SYNOPSYS
+          #{opts.to_s}
+
+        DESCRIPTION
+          Print template used for FORMAT
+
+        EXAMPLES
+          resme view --template md
+      EOS
+      
+      {
+        view: {
+          name: :view,
+          options: opts,
+          help: help.gsub("        ", "")
+        }
+      }
+    end
+
     def self.generate_opts
       opts = OptionParser.new do |o|
         o.banner = "generate [options] resume.yml ... # output resume"

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,49 +132,3 @@ def has_day input
     input.size == 10
   end
 end
-
-# 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:"
-
-      unless top_level_entries.include?(key)
-        # $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
-
-    $stderr.puts "[E] Key '#{key}' not found in the following entry:"
-    unless top_level_entries.include?(key)
-      self.keys.each do |k|
-        $stderr.puts "  #{k}: #{self[k]}"
-      end
-      $stderr.puts ""
-    end
-    
-    return ""
-  end
-end
-