resme 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b346f37deb079117dd466833d47d6b1f9d4b01e916c19c5b853652297fd3d67
-  data.tar.gz: 0dfceeaabf0074a619d9f67faf499882ad641128e918b995cb8eb0d7a3b6fde2
+  metadata.gz: 4c7490069bf046c56808342ad427c9f055bba680506486029770761517b92099
+  data.tar.gz: eb69e1752e4b4f4564e0e8cf9c7f5fa65756f7b3e599073a52d8c49583084776
 SHA512:
-  metadata.gz: 2d7013a8e980341a3d3abdbb3d3f814df116b98915711257c8a79ca5b0cac1406ec4f158629c1190af332200667afffc1f8c8e88caa5f521bb63578a64416750
-  data.tar.gz: d57c6fd89c9acf4ead44af434ed4ccba9b0c0117e1e1a653f6e0ba15307d1572d384550efa606c529516c37f1c548e77524a292573c2830aba6391ff1e2490e2
+  metadata.gz: cb0ac162ee646457be8d70f51359de1e7d2ad99ad545c79d1403f565c220e975e5927b0ab2fb00c72346edff04ccc0143282d666a08034f2174e7fe770cefc50
+  data.tar.gz: 3eb1f599f8ca2abbf274632c3afa0076349a85bc44e7c1b468761112627a086aa5de5385a5d4f79a2f6f438fe343b8f5c8de2979dc1bdacbc10ee7a72a258abb

data/README.org

@@ -0,0 +1,248 @@
+#+TITLE: RESME - A Resume Generator
+#+AUTHOR: Adolfo Villafiorita
+#+DATE: <2020-07-14 Tue>
+#+STARTUP: showall
+
+* RESME - A Resume Generator
+  :PROPERTIES:
+  :CUSTOM_ID: resme---a-resume-generator
+  :END:
+
+Keep your resume in YAML and output it in various formats, including
+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
+   :PROPERTIES:
+   :CUSTOM_ID: installation
+   :END:
+
+Add this line to your application's Gemfile:
+
+#+BEGIN_SRC ruby
+      gem 'resme'
+#+END_SRC
+
+And then execute:
+
+#+BEGIN_EXAMPLE
+  $ bundle
+#+END_EXAMPLE
+
+Or install it yourself as:
+
+#+BEGIN_EXAMPLE
+  $ gem install resme
+#+END_EXAMPLE
+
+** Usage
+   :PROPERTIES:
+   :CUSTOM_ID: usage
+   :END:
+
+Start with:
+
+#+BEGIN_EXAMPLE
+  $ resme init
+#+END_EXAMPLE
+
+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 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).
+
+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:
+
+$ resme md [-o output_filename] file.yml ...
+
+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/):
+
+$ resme json [-o output_filename] file.yaml ...
+
+Remarks:
+
+- 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
+
+** Checking validity
+   :PROPERTIES:
+   :CUSTOM_ID: checking-validity
+   :END:
+
+Use the =check= command to verify whether your YAML file conforms with
+the intended syntax.
+
+#+BEGIN_SRC ruby
+  resme check resume.yaml
+#+END_SRC
+
+** Dates in the resume
+   :PROPERTIES:
+   :CUSTOM_ID: dates-in-the-resume
+   :END:
+
+Enter dates in the resume in one of the following formats:
+
+- Any format accepted by Ruby for a full date (year, month, day)
+- YYYY-MM-DD
+- YYYY-MM
+- YYYY
+
+The third and the forth format allows you to enter "partial" dates
+(e.g., when the month or the day have been forgotten or are irrelevant).
+
+** Creating your own templates
+   :PROPERTIES:
+   :CUSTOM_ID: creating-your-own-templates
+   :END:
+
+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.
+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 %>
+  <% end %>
+#+END_EXAMPLE
+
+To specify your own ERB template use the option =-t=. Thus, for
+instance:
+
+#+BEGIN_EXAMPLE
+  $ resme render -t template.md.erb [-o output_filename] file.yaml ...
+#+END_EXAMPLE
+
+uses =template.md.erb= to generate the resume.
+
+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 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
+  a date or it is in the form =YYYY-MM=
+- =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 the templates in =lib/resme/templates=. These might be good
+starting points if you want to develop your own.
+
+** Contributing your templates
+   :PROPERTIES:
+   :CUSTOM_ID: contributing-your-templates
+   :END:
+
+If you develop an output template and want to make it available, please
+let me know, so that I can include it in future releases of this gem.
+
+** Development
+   :PROPERTIES:
+   :CUSTOM_ID: development
+   :END:
+
+After checking out the repo, run =bin/setup= to install dependencies.
+You can also run =bin/console= for an interactive prompt that will allow
+you to experiment.
+
+To install this gem onto your local machine, run
+=bundle exec rake install=. To release a new version, update the version
+number in =version.rb=, and then run =bundle exec rake release=, which
+will create a git tag for the version, push git commits and tags, and
+push the =.gem= file to [[https://rubygems.org][rubygems.org]].
+
+** Contributing
+   :PROPERTIES:
+   :CUSTOM_ID: contributing
+   :END:
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/avillafiorita/resme.
+
+** License
+   :PROPERTIES:
+   :CUSTOM_ID: license
+   :END:
+
+The gem is available as open source under the terms of the
+[[http://opensource.org/licenses/MIT][MIT License]].
+
+** Roadmap
+   :PROPERTIES:
+   :CUSTOM_ID: roadmap
+   :END:
+
+In =doc/todo.org= ... guess what is my preferred editor!
+
+** Bugs
+   :PROPERTIES:
+   :CUSTOM_ID: bugs
+   :END:
+
+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.*
+
+Unknown number of unknown bugs.
+
+** Release History
+   :PROPERTIES:
+   :CUSTOM_ID: release-history
+   :END:
+
+- *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

data/lib/resme/templates/europass/eu.xml.erb

@@ -415,7 +415,7 @@ end
             <Description>
                 <% if data.interests and not data.interests.empty? %>
                     &lt;ul&gt;
-                    <% data.interests.do |x| %>
+                    <% data.interests do |x| %>
                     &lt;li&gt;<%= "#{x.name || ""}: #{x.level || ""}, #{x.summary || ""}; " %>&lt;/li&gt;
                     <% end %>
                     &lt;/ul&gt;

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

@@ -1,5 +1,6 @@
-#+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
@@ -40,7 +41,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 +53,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 +65,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, "   " -%>
@@ -76,7 +77,7 @@
 * Other Initiatives
 
 <% (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 +151,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, "  " -%>

data/lib/resme/version.rb

@@ -1,3 +1,3 @@
 module Resme
-  VERSION = "0.3.1"
+  VERSION = "0.3.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: resme
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Adolfo Villafiorita
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-06-12 00:00:00.000000000 Z
+date: 2020-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -79,7 +79,7 @@ files:
 - ".gitignore"
 - Gemfile
 - LICENSE.txt
-- README.md
+- README.org
 - Rakefile
 - bin/console
 - bin/setup

data/README.md

@@ -1,192 +0,0 @@
-# RESME - A Resume Generator
-
-Keep your resume in YAML and output it in various formats, including
-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'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install resme
-
-## Usage
-
-Start with:
-
-    $ resme init
-
-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
-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).
-
-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:
-
-   $ resme md [-o output_filename] file.yml ... 
-
-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/):
-
-   $ resme json [-o output_filename] file.yaml ...
-
-Remarks:
-
-* 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
-
-## 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:
-
-* Any format accepted by Ruby for a full date (year, month, day)
-* YYYY-MM-DD
-* YYYY-MM
-* YYYY
-
-The third and the forth format allows you to enter "partial" dates
-(e.g., when the month or the day have been forgotten or are
-irrelevant).
-
-## Creating your own templates
-
-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.
-Thus, for instance, the following code snippets generates a list of
-all the work experiences:
-
-	<% data.work each do |exp| %>
-	- <%= exp.who %>
-	  From: <%=  exp.from %> till: <%= exp.till %>
-	<% end %>
-
-To specify your own ERB template use the option `-t`. Thus, for instance:
-
-    $ resme render -t template.md.erb [-o output_filename] file.yaml ...
-
-uses `template.md.erb` to generate the resume.
-
-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 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
-  a date or it is in the form `YYYY-MM`
-* `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 the templates in `lib/resme/templates`.  These might be
-good starting points if you want to develop your own.
-
-## Contributing your templates
-
-If you develop an output template and want to make it available,
-please let me know, so that I can include it in future releases of
-this gem.
-
-## Development
-
-After checking out the repo, run `bin/setup` to install
-dependencies. You can also run `bin/console` for an interactive prompt
-that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake
-install`. To release a new version, update the version number in
-`version.rb`, and then run `bundle exec rake release`, which will
-create a git tag for the version, push git commits and tags, and push
-the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at
-https://github.com/avillafiorita/resme.
-
-## License
-
-The gem is available as open source under the terms of
-the [MIT License](http://opensource.org/licenses/MIT).
-
-## Roadmap
-
-In `doc/todo.org` ... guess what is my preferred editor!
-
-## Bugs
- 
-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.**
-
-Unknown number of unknown bugs.
-
-## Release History
-
-* **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