resme 0.3.1 → 0.5.0

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

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

@@ -1,491 +0,0 @@
-<%
-email = data.contacts.select { |x| x.label == "email" }.first
-phones = data.contacts.select { |x|
-  ["phone", "mobile", "cell"].include?(x.label)
-}
-messaging = data.contacts.select { |x|
-  ["skype", "gtalk", "telegram", "whatsup"].include?(x.label)
-}
-address = data.addresses.select { |x| x.label == "home" }.first
-
-# make a period (2015, 2015-10, 2015-01-01 into the xml attributes day, month, year for a date tag
-def self.period_tod period
-    el = period.to_s.split("-")
-    fields = ["year=\"%d\"", "month=\"--%02d\"", "day=\"---%02d\""]
-    el.each_with_index.map { |x, i| fields[i] % x.to_i }.join(" ")
-end
-
-
--%>
-<?xml version="1.0" encoding="UTF-8"?>
-<SkillsPassport xmlns="http://europass.cedefop.europa.eu/Europass" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://europass.cedefop.europa.eu/Europass http://europass.cedefop.europa.eu/xml/v3.3.0/EuropassSchema.xsd" locale="en">
-<DocumentInfo>
-    <DocumentType>ECV</DocumentType>
-    <Bundle></Bundle>
-    <CreationDate><%= DateTime.now.iso8601 %></CreationDate>
-    <LastUpdateDate><%= DateTime.now.iso8601 %></LastUpdateDate>
-    <XSDVersion>V3.3</XSDVersion>
-    <Generator>resume.rb</Generator>
-    <Comment></Comment>
-    <Copyright>© European Communities | http://europass.cedefop.europa.eu</Copyright>
-    <EuropassLogo>false</EuropassLogo>
-</DocumentInfo>
-<!-- <PrintingPreferences> </PrintingPreferences> -->
-<LearnerInfo>
-    <Identification>
-        <PersonName>
-            <Title>
-                <Code>dr</Code>
-                <Label><%= data.basics.title %></Label>
-            </Title>
-            <FirstName><%= data.basics.first_name %></FirstName>
-            <Surname><%= data.basics.last_name %></Surname>
-        </PersonName>
-        <ContactInfo>
-            <Address>
-                <Contact>
-                    <AddressLine><%= address.street %></AddressLine>
-                    <PostalCode><%= address.zip_code %></PostalCode>
-                    <Municipality><%= address.city %></Municipality>
-                    <Country>
-                        <Code><%= address.country[0..1].upcase %></Code>
-                        <Label><%= address.country %></Label>
-                    </Country>
-                </Contact>
-            </Address>
-            <Email>
-                <Contact><%= email.value %></Contact>
-            </Email>
-            <% if phones %>
-            <TelephoneList>
-                <% phones.each do |phone| %>
-                    <Telephone>
-                        <Contact><%= phone.value %></Contact>
-                        <Use>
-                            <Code><%= phone.label %></Code>
-                            <Label><%= phone.value %></Label>
-                        </Use>
-                    </Telephone>
-                <% end %>
-            </TelephoneList>
-            <% end %>
-            <% if data.web_presence %>
-            <WebsiteList>
-                <% data.web_presence.each do |web| %>
-                    <Website>
-                        <Contact><%= web.value %></Contact>
-                        <Use>
-                            <!-- <Code><%= web.label %></Code> -->
-                            <Label><%= web.label.capitalize %></Label>
-                        </Use>
-                    </Website>
-                <% end %>
-            </WebsiteList>
-            <% end %>
-            <% if messaging and not messaging.empty? %>
-            <InstantMessagingList>
-                <% messaging.each do |im| %>
-                    <InstantMessaging>
-                        <Contact><%= im.value %></Contact>
-                        <Use>
-                            <!-- <Code><%= im.label %></Code> -->
-                            <Label><%= im.label.capitalize %></Label>
-                        </Use>
-                    </InstantMessaging>
-                <% end %>
-            </InstantMessagingList>
-            <% end %>
-            <ContactMethodList>
-                <!-- other contacts not defined above -->
-            </ContactMethodList>
-        </ContactInfo>
-        <Demographics>
-            <Birthdate day="---<%= "%02d" % data.basics.birthdate.day %>" month="--<%= "%02d" % data.basics.birthdate.month %>" year="<%= data.basics.birthdate.year %>" />
-            <%# ["gender"] in place of .gender, so that the code does not complain about gender not being defined (being nil) %>
-            <% if data.basics["gender"] == "M" or data.basics["gender"] == "F" %>
-                <Gender>
-                    <Code><%= data.basics.gender %></Code>
-                    <Label><%= data.basics.gender == "M" ? "Male" : "Female" %></Label>
-                </Gender>
-            <% end %>
-            <NationalityList>
-                <Nationality>
-                    <Label><%= data.basics.nationality %></Label>
-                </Nationality>
-            </NationalityList>
-            <!--
-                 <Photo>
-                 <MimeType>image/jpeg</MimeType>
-                 <Data></Data>
-                 <MetadataList>
-                 <Metadata key="photo-dimensions" value="100x110"/>
-                 </MetadataList>
-                 </Photo>
-                 <Signature>
-                 <MimeType>image/jpeg</MimeType>
-                 <Data></Data>
-                 <MetadataList>
-                 <Metadata key="signature-dimensions" value="250x150" />
-                 </MetadataList>
-                 </Signature>
-               -->
-        </Demographics>
-    </Identification>
-    <Headline>
-        <Description><Label><%= data.summary %></Label></Description>
-    </Headline>
-    <WorkExperienceList>
-        <% data.work.each do |pos| %>
-        <WorkExperience>
-            <Period>
-                <From <%= self.period_tod pos.from %>/>
-                <% if pos.till and pos.till != "" %>
-                <To <%= self.period_tod pos.till %>/>
-                <% else %>
-                <Current>true</Current>
-                <% end %>
-            </Period>
-            <!-- 
-            <Documentation>
-                <ReferenceTo idref="ATT_1"/>
-            </Documentation>
-            -->
-            <Position>
-                <Label><%= pos.role %></Label>
-            </Position>
-            <Activities>
-                <%= pos.summary %>
-            </Activities>
-            <Employer>
-                <Name><%= pos["who"] ? pos.who : "" %></Name>
-                <% if pos["address"] %>
-                <ContactInfo>
-                    <Address>
-                        <Contact>
-                            <AddressLine><%= pos.address %></AddressLine>
-                            <!-- <Country>
-                                <Code></Code>
-                                <Label></Label>
-                                </Country> -->
-                        </Contact>
-                    </Address>
-                    <Website>
-                        <Contact><%= pos.website %></Contact>
-                    </Website>
-                </ContactInfo>
-                <!--
-                  <Sector>
-                    <Code></Code>
-                    <Label></Label>
-                  </Sector>
-                -->
-               <% end %>
-            </Employer>
-        </WorkExperience>
-        <% end %>
-        <% if data.teaching and not data.teaching.empty? %>
-        <% data.teaching.each do |pos| %>
-            <WorkExperience>
-                <Period>
-                    <% if pos.from and pos.from != "" %>
-                        <From <%= self.period_tod pos.from %>/>
-                    <% end %>
-                    <% if pos.till and pos.till != "" %>
-                        <To <%= self.period_tod pos.till %>/>
-                    <% else %>
-                        <Current>true</Current>
-                    <% end %>
-                </Period>
-                <!-- 
-                     <nation>
-                     <ReferenceTo idref="ATT_1"/>
-                     </Documentation>
-                   -->
-                <Position>
-                    <Label><%= pos.role %></Label>
-                </Position>
-                <Activities>
-                    <%= pos.summary %>
-                </Activities>
-                <Employer>
-                    <Name><%= "#{pos.who} #{pos['school'] ? pos.school : ''}" %></Name>
-                    <% if pos["address"] %>
-                        <ContactInfo>
-                            <Address>
-                                <Contact>
-                                    <AddressLine><%= pos.address %></AddressLine>
-                                    <!-- <Country>
-                                         <Code></Code>
-                                         <Label></Label>
-                                         </Country> -->
-                                </Contact>
-                            </Address>
-                            <Website>
-                                <Contact><%= pos["website"] %></Contact>
-                            </Website>
-                        </ContactInfo>
-                        <!--
-                             <Sector>
-                             <Code></Code>
-                             <Label></Label>
-                             </Sector>
-                           -->
-                    <% end %>
-                </Employer>
-            </WorkExperience>
-        <% end %>
-        <% end %>
-        <% if data.volunteer and not data.volunteer.empty? %>
-            <% data.volunteer.each do |pos| %>
-                <WorkExperience>
-                    <% if pos["date"] %>
-                        <Period>
-                            <From <%= self.period_tod pos.date.strftime("%Y-%m-%d") %>/>
-                            <To <%= self.period_tod pos.date.strftime("%Y-%m-%d") %>/>
-                        </Period>
-                    <% elsif pos.from or (pos.till and pos.till != "") %>
-                        <Period>
-                            <% if pos.from %>
-                                <From <%= self.period_tod pos.from %>/>
-                            <% end %>
-                            <% if pos.till and pos.till != "" %>
-                                <To <%= self.period_tod pos.till %>/>
-                            <% else %>
-                                <Current>true</Current>
-                            <% end %>
-                        </Period>
-                    <% end %>
-                    <!-- 
-                         <ntation>
-                         <ReferenceTo idref="ATT_1"/>
-                         </Documentation>
-                       -->
-                    <Position>
-                        <Label><%= pos.role %></Label>
-                    </Position>
-                    <Activities>
-                        <%= pos.summary %>
-                    </Activities>
-                    <Employer>
-                        <Name><%= pos.who %></Name>
-                        <% if pos["address"] %>
-                            <ContactInfo>
-                                <Address>
-                                    <Contact>
-                                        <AddressLine><%= pos.address %></AddressLine>
-                                        <!-- <Country>
-                                             <Code></Code>
-                                             <Label></Label>
-                                             </Country> -->
-                                    </Contact>
-                                </Address>
-                                <Website>
-                                    <Contact><%= pos["website"] %></Contact>
-                                </Website>
-                            </ContactInfo>
-                            <!--
-                                 <Sector>
-                                 <Code></Code>
-                                 <Label></Label>
-                                 </Sector>
-                               -->
-                        <% end %>
-                    </Employer>
-                </WorkExperience>
-            <% end %>
-        <% end %>
-    </WorkExperienceList>
-    <% if data.education and not data.education.empty? %>
-    <EducationList>
-        <% data.education.select { |x| x.publish }.each do |edu| %>
-         <Education>
-             <Period>
-                 <% if edu.from and not edu.from == "" %>
-                     <From <%= self.period_tod edu.from %>/>
-                 <% end %>
-                 <% if edu.till and not edu.till == "" %>
-                     <To <%= self.period_tod edu.till %>/>
-                 <% end %>
-             </Period>
-             <!-- 
-                  <Documentation>
-                  <ReferenceTo idref="ATT_1"/>
-                  <ReferenceTo idref="ATT_2"/>
-                  </Documentation>
-                -->
-             <Title><%= edu.degree %></Title>
-             <Activities></Activities>
-             <Organisation>
-                 <Name><%= edu["school"] %></Name>
-                 <ContactInfo>
-                     <Address>
-                         <Contact>
-                             <AddressLine><%= edu.address %></AddressLine>
-                             <!-- <Country>
-                                  <Code>US</Code>
-                                  <Label>United States</Label>
-                                  </Country>
-                                -->
-                         </Contact>
-                     </Address>
-                 </ContactInfo>
-             </Organisation>
-         </Education>
-        <% end %>
-    </EducationList>
-    <% end %>
-    <Skills>
-        <% if data.languages %>
-        <Linguistic>
-            <% if data.languages.mother_tongues and not data.languages.mother_tongues.empty? %>
-            <MotherTongueList>
-                <% data.languages.mother_tongues.each do |mt| %>
-                <MotherTongue>
-                    <Description>
-                        <Code><%= mt.code %></Code>
-                        <Label><% mt.language %></Label>
-                    </Description>
-                </MotherTongue>
-                <% end %>
-            </MotherTongueList>
-            <% end %>
-            <% if data.languages.foreign and not data.languages.foreign.empty? %>
-            <ForeignLanguageList>
-                <% data.languages.foreign.each do |language| %>
-                <ForeignLanguage>
-                    <Description>
-                        <Code><%= language.code %></Code>
-                        <Label><%= language.language %></Label>
-                    </Description>
-                    <ProficiencyLevel>
-                        <Listening>
-                            <%= language.listening.upcase %>
-                        </Listening>
-                        <Reading>
-                            <%= language.reading.upcase %>
-                        </Reading>
-                        <SpokenInteraction>
-                            <%= language.spoken_interaction.upcase %>
-                        </SpokenInteraction>
-                        <SpokenProduction>
-                            <%= language.spoken_production.upcase %>
-                        </SpokenProduction>
-                        <Writing>
-                            <%= language.writing.upcase %>
-                        </Writing>
-                    </ProficiencyLevel>
-                </ForeignLanguage>
-                <% end %>
-            </ForeignLanguageList>
-            <% end %>
-        </Linguistic>
-        <% end %>
-        <!--
-        <Communication>
-            <Description></Description>
-            <Documentation></Documentation>
-        </Communication>
-        <Organisational>
-            <Description></Description>
-            <Documentation></Documentation>
-        </Organisational>
-        <JobRelated>
-            <Description></Description>
-            <Documentation></Documentation>
-        </JobRelated>
-        <Computer>
-            <Description></Description>
-            <ProficiencyLevel></ProficiencyLevel>
-            <VerifiedBy>
-                <Certificate><Title></Title></Certificate>
-            </VerifiedBy>
-            <Documentation></Documentation>
-        </Computer>
-        -->
-        <% if data.driving and not data.driving.empty? %>
-        <Driving>
-            <Description>
-                <% data.driving.each do |license| %>
-                <Licence><%= license.license %></Licence>
-                <% end %>
-            </Description>
-        </Driving>
-        <% end %>
-        <Other>
-            <Description>
-                <% if data.interests and not data.interests.empty? %>
-                    &lt;ul&gt;
-                    <% data.interests.do |x| %>
-                    &lt;li&gt;<%= "#{x.name || ""}: #{x.level || ""}, #{x.summary || ""}; " %>&lt;/li&gt;
-                    <% end %>
-                    &lt;/ul&gt;
-                <% end %>
-            </Description>
-        </Other>
-    </Skills>
-    <AchievementList>
-        <% if data.awards and not data.awards.empty? %>
-        <% data.awards.each do |award| %>
-            <Achievement>
-                <Title>
-                    <Label><%= award.title %></Label>
-                </Title>
-                <Description>
-                    <%= award.summary %> 
-                    (<%= achievement.who %>, <%= achievement.where %>, <%= achievement.date %>)
-                </Description>
-            </Achievement>
-        <% end %>
-        <% end %>
-        <% if data.achievements and not data.achievements.empty? %>
-        <% data.achievements.each do |achievement| %>
-            <Achievement>
-                <Title>
-                    <Label><%= achievement.title %></Label>
-                </Title>
-                <Description>
-                    <%= achievement.summary %> 
-                    (<%= achievement.who %>, <%= achievement.where %>, <%= achievement.date %>)
-                </Description>
-            </Achievement>
-        <% end %>
-        <% end %>
-        <% if data.projects and not data.projects.empty? %>
-            <Achievement>
-                <Title>
-                    <Code>projects</Code>
-                    <Label>Projects</Label>
-                </Title>
-                <Description>
-                    &lt;ul&gt;
-                    <% data.projects.each do |x| %>
-                        &lt;/li&gt; <%= "#{x.name} (#{x.who}): #{x.role} (#{x.from}--#{x.till})" %> &lt;/li&gt;
-                    <% end %>
-                    &lt;/ul&gt;
-                </Description>
-            </Achievement>
-        <% end %>
-        <% if data.publications and not data.publications.empty? %>
-        <Achievement>
-            <Title>
-                <Code>publications</Code>
-                <Label>Publications</Label>
-            </Title>
-            <Description>
-                &lt;ul&gt;
-                <% data.publications.each do |x| %>
-                    &lt;li&gt; <%= "#{x.title}, #{x.authors}, #{x.publisher}, #{x.date}" %> &lt;/li&gt;
-                <% end %>
-                &lt;/ul&gt;
-            </Description>
-        </Achievement>
-        <% end %>
-    </AchievementList>
-    <Documentation>
-    </Documentation>
-</LearnerInfo>
-<!--
-<AttachmentList>
-</AttachmentList>
--->
-</SkillsPassport>