resme 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 41210e013344cdaa0ebf2bda62cb32e6a7ab12d0
+  data.tar.gz: 502428f940851e89c7d67434d1a7e159c51e8115
+SHA512:
+  metadata.gz: 3bbb1d5a0b1ec9a4aaecc61878d87cbb34c922058073c2660f4e06bdd42286d55956d49bccc988693d8ea4fd8dc28b58f89ab5052f4f7f9ae87c8fc0cccc6efb
+  data.tar.gz: 3376bfe326cc4bb00c97d858cabc4df8793408a9b5a979090dab19710bce64bb674e16dff02465a6fedb6defa125d02591c9fd939c47f2515190f26f42441034

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*~
+*.bak

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in resme.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Adolfo Villafiorita
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,170 @@
+# RESME - A Resume Generator
+
+Keep your resume in YAML and output it in various formats, including
+markdown, json, and the Europass XML format.
+
+Interesting features:
+
+- 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).
+- no gem/cli application I am aware of outputs in the Europass format
+
+
+## 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
+sectins hich are not relevant for your resume.
+
+Once you have started filling you resume, you can then generate a
+resume using the existing templates or by writing your own template
+(see below).
+
+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
+
+## 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,
+similar to what Jekyll and Middleman do with data files.  (See,
+e.g., [data files](https://middlemanapp.com/advanced/data-files/.)
+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 outputing a txt format,
+  for instance.
+
+Dates manipulation functions:
+
+* `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 some 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 slight differences in the information outputted in the
+various 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 choices (here
+"personal choices" could be also read "bug").
+
+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.
+
+Unkown number of unkown bugs.
+
+## Release History
+
+* **0.1** is th first release

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "resme"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/resme

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'resme'
+
+# read-eval-print-step passing all commands and the argument
+Resme::CommandSemantics.reps Resme::CommandSyntax.commands, ARGV

data/lib/resme.rb

@@ -0,0 +1,4 @@
+require "resme/version"
+require "resme/renderer/renderer"
+require "resme/cli/command_syntax"
+require "resme/cli/command_semantics"

data/lib/resme/cli/command_semantics.rb

@@ -0,0 +1,155 @@
+require 'resme/version'
+require 'readline'
+require 'fileutils'
+require 'date'
+require 'yaml'
+require 'erb'
+
+module Resme
+  module CommandSemantics
+    APPNAME = 'resme'
+    VERSION = Resme::VERSION
+
+    #
+    # Main App Starts Here!
+    #
+    def self.version opts = nil, argv = []
+      puts "#{APPNAME} version #{VERSION}"
+    end
+
+    def self.man opts = nil, argv = []
+      path = File.join(File.dirname(__FILE__), "/../../../README.md")
+      file = File.open(path, "r")
+      contents = file.read
+      puts contents
+    end
+
+    def self.help opts = nil, argv = []
+      all_commands = CommandSyntax.commands
+      
+      if argv != []
+        argv.map { |x| puts all_commands[x.to_sym][2] }
+      else
+        puts "#{APPNAME} command [options] [args]"
+        puts ""
+        puts "Available commands:"
+        puts ""
+        all_commands.keys.each do |key|
+          puts "  " + all_commands[key][0].banner
+        end
+      end
+    end
+
+    def self.console opts, argv = []
+      all_commands = CommandSyntax.commands
+      all_commands.delete(:console)
+      
+      i = 0
+      while true
+        string = Readline.readline("#{APPNAME}:%03d> " % i, true)
+        string.gsub!(/^#{APPNAME} /, "") # as a courtesy, remove any leading appname string
+        if string == "exit" or string == "quit" or string == "." then
+          exit 0
+        end
+        reps all_commands, string.split(' ')
+        i = i + 1
+      end
+    end
+
+    # read-eval-print step
+    def self.reps all_commands, argv
+      if argv == [] or argv[0] == "--help" or argv[0] == "-h"
+        CommandSemantics.help
+        exit 0
+      else
+        command = argv[0]
+        syntax_and_semantics = all_commands[command.to_sym]
+        if syntax_and_semantics
+          opts = syntax_and_semantics[0]
+          function = syntax_and_semantics[1]
+          
+          begin
+            parser = Slop::Parser.new(opts)
+
+            result = parser.parse(argv[1..-1])
+            options = result.to_hash
+            arguments = result.arguments
+
+            eval "CommandSemantics::#{function}(options, arguments)"
+          rescue Slop::Error => e
+            puts "#{APPNAME}: #{e}"
+          rescue Exception => e
+            puts e
+          end
+        else
+          puts "#{APPNAME}: '#{command}' is not a valid command. See '#{APPNAME} help'"
+        end
+      end
+    end
+
+    #
+    # APP SPECIFIC COMMANDS
+    #
+    def self.init opts, argv
+      output = opts[:output] || "resume.yml"
+      force = opts[:force]
+      template = File.join(File.dirname(__FILE__), "/../templates/resume.yml")
+
+      # avoid catastrophy
+      if File.exist?(output) and not force
+        puts "Error: file #{output} already exists.  Use --force if you want to overwrite it"
+      else
+        content = File.read(template)
+        backup_and_write output, content
+        puts "YML resume template generated in #{output}"
+      end
+    end
+
+    def self.md opts, argv
+      output = opts[:output] || "resume-#{Date.today}.md"
+      template = File.join(File.dirname(__FILE__), "/../templates/resume.md.erb")
+
+      render argv, template, output
+      puts "Resume generated in #{output}"
+    end
+
+    def self.json opts, argv
+      output = opts[:output] || "resume-#{Date.today}.json"
+      template = File.join(File.dirname(__FILE__), "/../templates/resume.json.erb")
+
+      render argv, template, output
+      puts "Resume generated in #{output}"
+    end
+
+    def self.europass opts, argv
+      output = opts[:output] || "resume-#{Date.today}.xml"
+      template = File.join(File.dirname(__FILE__), "/../templates/europass/eu.xml.erb")
+
+      render argv, template, output
+      puts "Resume generated in #{output}"
+      puts "Render via, e.g., http://interop.europass.cedefop.europa.eu/web-services/remote-upload/"
+    end
+
+    private
+
+    def self.render yml_files, template_filename, output_filename
+      data = Hash.new
+      yml_files.each do |file|
+        data = data.merge(YAML.load_file(file))
+      end
+      template = File.read(template_filename)
+      output = ERB.new(template).result(binding)
+      backup_and_write output_filename, output
+    end
+
+    def self.backup filename
+      FileUtils::cp filename, filename + "~"
+      puts "Backup copy #{filename} created in #{filename}~."
+    end
+
+    def self.backup_and_write filename, content
+      backup(filename) if File.exist?(filename)
+      File.open(filename, "w") { |f| f.puts content }
+    end
+  end
+end

data/lib/resme/cli/command_syntax.rb

@@ -0,0 +1,192 @@
+require 'slop'
+
+module Resme
+  module CommandSyntax
+    # return a hash with all the commands and their options 
+    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
+      end
+      return h
+    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] }
+    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] } 
+    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] }
+    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.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 YML 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 YML input files.
+
+EXAMPLES
+       
+   resme md -o r.md resume.yml
+EOS
+      return { md: [opts, :md, 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 YML input files.
+
+EXAMPLES
+       
+   resme json -o r.md resume.yml
+EOS
+      return { json: [opts, :json, help] }
+    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}
+
+SYNOPSYS
+   #{opts.to_s}
+
+DESCRIPTION
+
+   Generate a Europass XML resume from the YML input files.
+
+EXAMPLES
+       
+   resme europass -o r.md resume.yml
+EOS
+      return { europass: [opts, :europass, help] }
+    end 
+
+  end
+end