resme 0.4.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8abd7d17f0d2b9a777cba680826c21d6ee882f3f3df0c74ba086e1d617d4b6b
-  data.tar.gz: b34b33c2f2d0f3beae3bef713efba2e39b05537d8a208380e6392271e0cbcb09
+  metadata.gz: de3845cee948da0b1588b074a720662d5ea22a8c1cb1176aad2fa09f6f7cab3f
+  data.tar.gz: 83ae22f7d7731406fdd3940e97c9e39c9a61b07336e95f2efc369cae719687f9
 SHA512:
-  metadata.gz: fe74aa311a4dd110c26a0760cf6d2f8cb1ba1ee8e587f2a64d00ff6aa420a2a7f6c37b1eec392ddf1b28abbe49ffb94d6b26d5f43f2797ba9fd7cc9874ebf5c1
-  data.tar.gz: 3f2ae60c5c8a4e7f8135aa7f43aafa081f913dc8dd6c1b4c6065606447a41b6afe414ae4f32e0541fc06284227d94628f31f59e80af02aee2147c054032137c8
+  metadata.gz: 32d94c5d909f54888d2a8fa184aaa05f8a9d8075d6f3f19ff6654bf23e58f82e54e96d84ea08de148548ed0260396c6d9790b6dbc0e3992c295157b5713bb952
+  data.tar.gz: 41386481b15b5b14ba86efbd23b29331341b22f91ebcc70497d8293609414a15e8c06518ad441e0cd26f78b552a47e7d125c42bc495f17def2bbd16314fe52b5

data/CHANGELOG.org

@@ -0,0 +1,60 @@
+#+TITLE: CHANGELOG
+#+AUTHOR: Adolfo Villafiorita
+
+* Version 0.5.1
+
+  A bug-fixing release.
+
+  More in details:
+
+  - [bug] Add dependency to =classy_hash=
+  - [doc] Fix links to source code and Changelog.
+  - [doc] Merge Release History and Changelog.
+  - [doc] Fix version numbers in headers of Changelog (1.5.0 -> 0.5.0)
+
+* Version 0.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 0.4.0
+
+  Version 0.4.0 refactors all generation commands under =generate=, provides
+  new filtering options, adds =-e= option (for custom templates), and
+  refactors various portions of code.  It also revises this document
+  and fixes some minor bugs.
+
+  More in details:
+  
+  - [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.
+  
+* Version 0.3.2 and 0.3.1
+
+  Version 0.3.2 and 0.3.1 fix errors with the Europass format: lists of
+  projects, interests, ... are now properly formatted.
+
+* Version 0.3
+
+  Version 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
+
+* Version 0.2
+
+  Version 0.2 improves output of volunteering activities and other information
+  in the Europass and *significantly improves error and warning
+  reporting*
+
+* Version 0.1
+
+  Version 0.1 is the first release

data/Gemfile.lock

@@ -0,0 +1,20 @@
+PATH
+  remote: .
+  specs:
+    resme (0.5.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    rake (12.3.3)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  bundler (~> 2.3.20)
+  rake (~> 12.0)
+  resme!
+
+BUNDLED WITH
+   2.3.20

data/README.org

@@ -17,20 +17,20 @@ needs).
 
 Add this line to your application's Gemfile:
 
-#+BEGIN_SRC ruby
-      gem 'resme'
-#+END_SRC
+#+begin_example ruby
+  gem 'resme'
+#+end_example
 
 And then execute:
 
-#+BEGIN_EXAMPLE
-  $ bundle
-#+END_EXAMPLE
+#+begin_example sh
+  bundle
+#+end_example
 
 Or install it yourself as:
 
-#+BEGIN_EXAMPLE
-  $ gem install resme
+#+begin_example sh
+  gem install resme
 #+END_EXAMPLE
 
 ** Usage
@@ -40,9 +40,9 @@ Or install it yourself as:
 
 Start with:
 
-#+BEGIN_EXAMPLE
+#+begin_example sh
   resme init
-#+END_EXAMPLE
+#+end_example
 
 which generates a YML template for your resume in the current directory.
 Comments in the YML file should help you fill the various entries.
@@ -51,7 +51,7 @@ are not relevant for your resume.
 
 You can now generate a resume using one of the existing formats:
 
-#+begin_example
+#+begin_example sh
   resme --to org resume.yml
 #+end_example
 
@@ -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:
+  check resume.yml # Check syntax of resume.yml
+  list resume.yml # List main sections in resume.yml
+  version # print version information
+  view --template FORMAT # Print template used for format
+  generate [options] resume.yml ... # output resume
+  console # enter the console
+  man # print resme manual page
+  help [command] # print command usage
+  init [options] # generate an empty resume.yml file
+#+end_example
 
 ** Checking validity
    :PROPERTIES:
@@ -85,9 +100,9 @@ Remarks:
 Use the =check= command to verify whether your YAML file conforms with
 the intended syntax.
 
-#+BEGIN_SRC ruby
+#+begin_example sh
   resme check resume.yaml
-#+END_SRC
+#+end_example
 
 ** Dates in the resume
    :PROPERTIES:
@@ -110,28 +125,36 @@ 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).
-
-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:
-
-#+BEGIN_EXAMPLE
-  <% data.work each do |exp| %>
-  - <%= exp.who %>
-    From: <%=  exp.from %> till: <%= exp.till %>
+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.
+
+Use the command =view= to print one of the templates used by =resme=
+and build from that.
+
+#+begin_example sh
+  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 xml
+  <% data["work"] each do |exp| %>
+  - <%= exp["who"] %>
+    From: <%=  exp["from"] %> till: <%= exp["till"] %>
   <% end %>
-#+END_EXAMPLE
+#+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 ...
-#+END_EXAMPLE
+#+begin_example sh
+  resme render -e template.md.erb [-o output_filename] file.yaml ...
+#+end_example
 
 uses =template.md.erb= to generate the resume.
 
@@ -200,12 +223,16 @@ 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 [[file:./CHANGELOG.org][CHANGELOG.org]]
+
 ** Roadmap
    :PROPERTIES:
    :CUSTOM_ID: roadmap
    :END:
 
-In =doc/todo.org= ... guess what is my preferred editor!
+In [[file:./doc/todo.org][todo.org]] ... guess what is my preferred editor!
 
 ** Bugs
    :PROPERTIES:
@@ -228,18 +255,4 @@ Unknown number of unknown bugs.
    :CUSTOM_ID: release-history
    :END:
 
-- *0.4.0* refactors all generation commands under =generate=, provides
-  new filtering options, adds =-e= option (for custom templates), and
-  refactors various portions of code.  It also revises this document
-  and fixes some minor bugs.
-- *0.3.2* and *0.3.1* fix errors with the Europass format: lists of
-  projects, interests, ... are now properly formatted.
-- *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
+   Moved to [[file:./CHANGELOG.org][CHANGELOG.org]].

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