curriculum-generator 1.0.0

data/lib/cgen/generator/cv_item_with_comment.rb

@@ -0,0 +1,32 @@
+class CGen::Generator::CvItemWithComment < CGen::Generator::BasicGenerator
+
+  def initialize(param, data, lang)
+    super(param, data, lang)
+  end
+
+  def generate
+    value = get_value(param)
+    value = Array[value] unless value.is_a?(Array)
+
+    inst = self
+    value.collect do |elem|
+      result = Either.chain do
+        bind -> { elem.is_a?(Hash) }
+        bind -> {
+          elem.has_key?('title') &&
+              elem.has_key?('content') &&
+              elem.has_key?('comment')
+        }
+        bind -> {
+          inst.get_cv_item_with_comment(elem['title'], elem['content'], elem['comment'])
+        }
+      end
+      result.success? ? result.fetch : ''
+    end.join("\n")
+  end
+
+  def get_cv_item_with_comment(title, content, comment)
+    "\\cvitemwithcomment{#{title}}{#{content}}{#{comment}}"
+  end
+
+end

data/lib/cgen/generator/cv_list_double_item.rb

@@ -0,0 +1,31 @@
+class CGen::Generator::CvListDoubleItem < CGen::Generator::BasicGenerator
+
+  def initialize(param, data, lang)
+    super(param, data, lang)
+  end
+
+  def generate
+    value = get_value(param)
+    unless value.is_a?(Array)
+      value = Array[value]
+    end
+    value.collect do |elem|
+      instance = self
+      result = Either.chain do
+        bind -> { elem.is_a?(Hash) }
+        bind -> { elem.has_key?('item_0') && elem.has_key?('item_1') }
+        bind -> {
+          instance.get_cv_list_double_item(elem['item_0'], elem['item_1'])
+        }
+      end
+      result.success? ? result.fetch : ''
+    end.join("\n")
+  end
+
+  protected
+
+  def get_cv_list_double_item(item_0, item_1)
+    "\\cvlistdoubleitem{#{item_0}}{#{item_1}}"
+  end
+
+end

data/lib/cgen/generator/cv_list_item.rb

@@ -0,0 +1,23 @@
+class CGen::Generator::CvListItem < CGen::Generator::BasicGenerator
+
+  def initialize(param, data, lang)
+    super(param, data, lang)
+  end
+
+  def generate
+    value = get_value(param)
+    unless value.is_a?(Array)
+      value = Array[value]
+    end
+    value.collect do |content|
+      get_cv_list_item(content)
+    end.join("\n")
+  end
+
+  protected
+
+  def get_cv_list_item(content)
+    "\\cvlistitem{#{content}}"
+  end
+
+end

data/lib/cgen/generator/list.rb

@@ -0,0 +1,25 @@
+class CGen::Generator::List < CGen::Generator::BasicGenerator
+
+  def initialize(param, data, lang)
+    super(param, data, lang)
+  end
+
+  def generate
+    value = get_value(param)
+    unless value.is_a?(Array)
+      value = Array[value]
+    end
+    '\begin{itemize}' +
+    value.collect do |item|
+      get_list(item)
+    end.join('') +
+    '\end{itemize}'
+  end
+
+  protected
+
+  def get_list(item)
+    "\\item #{item}"
+  end
+
+end

data/lib/cgen/generator/macro_substitution.rb

@@ -0,0 +1,11 @@
+class CGen::Generator::MacroSubstitution < CGen::Generator::BasicGenerator
+
+  def initialize(param, data, lang)
+    super(param, data, lang)
+  end
+
+  def generate
+    get_value(param)
+  end
+
+end

data/lib/cgen/generator/specific/education.rb

@@ -0,0 +1,95 @@
+class CGen::Generator::Education < CGen::Generator::BasicGenerator
+
+  def initialize(param, data, lang)
+    super(param, data, lang)
+  end
+
+  def generate
+    value = get_value(param)
+    value.collect do |elem|
+      get_education(elem)
+    end.join('')
+  end
+
+  protected
+
+  def get_education(context)
+    context.merge!({'titles' => get_value('titles')})
+
+    input = <<-CODE
+
+    \\cventry
+
+    <% if @date.nil? %>
+      {}
+    <% elsif @date.is_a?(Hash) && @date.has_key?('from') && @date.has_key?('to') %>
+      {<%= @date['from'] %>\\\\<%= @date['to'] %>}
+    <% else %>
+      {<%= @date %>}
+    <% end %>
+
+    {<%= @title.nil? ? '' : @title %>}
+
+    {}{}{}
+
+    {\\begin{itemize}
+
+    <% if @qualification %>
+      \\item \\textit{<%= @titles['S_4']['qualification'] %>}: <%= @qualification %>
+    <% end %>
+
+    <% if @organisation %>
+      \\item \\textit{<%= @titles['S_4']['organisation'] %>}: <%= @organisation %>
+    <% end %>
+
+    <% if @level %>
+      \\item \\textit{<%= @titles['S_4']['level'] %>}: <%= @level %>
+    <% end %>
+
+    <% if @lessons %>
+      \\item \\textit{<%= @titles['S_4']['lessons'] %>}: <%= @lessons %>
+    <% end %>
+
+    <% if @validity %>
+      \\item \\textit{<%= @titles['S_4']['validity'] %>}: <%= @validity %>
+    <% end %>
+
+    <% if @location %>
+      \\item \\textit{<%= @titles['S_4']['location'] %>}: <%= @location %>
+    <% end %>
+
+    <% if @teacher %>
+      \\item \\textit{<%= @titles['S_4']['teacher'] %>}: <%= @teacher %>
+    <% end %>
+
+    <% if @skills_covered %>
+
+      <% unless @skills_covered.is_a?(Array) %>
+        <% @skills_covered = Array[@skills_covered] %>
+      <% end %>
+
+      <% @skills_covered.compact! %>
+
+      <% if @skills_covered.length > 0 %>
+
+        \\item \\textit{<%= @titles['S_4']['skills_covered'] %>}:
+        \\begin{itemize}
+
+        <% @skills_covered.each do |skill_covered| %>
+          \\item <%= skill_covered %>
+        <% end %>
+
+        \\end{itemize}
+
+      <% end %>
+
+    <% end %>
+
+    \\end{itemize}}
+
+    CODE
+
+    evaluate(input, context).gsub(/^\s+/,'').gsub(/\n/,'') + "\n\n"
+  end
+
+end

data/lib/cgen/generator/specific/self_assessment.rb

@@ -0,0 +1,61 @@
+class CGen::Generator::SelfAssessment < CGen::Generator::BasicGenerator
+
+  def initialize(param, data, lang)
+    super(param, data, lang)
+  end
+
+  def generate
+    get_self_assessment(get_value(param))
+  end
+
+  protected
+
+  def get_self_assessment(context)
+    context.merge!({'titles' => get_value('titles')})
+
+    input = <<-CODE
+
+    \\cvitem{<%= @titles['S_5']['self_assessment'] %>}
+
+    {
+    \\scriptsize
+    \\begin{tabular}{l|l|l|l|l|l|l|l|l|l|l}
+
+      \\multicolumn{1}{c|}{<%= ' ' %>} &
+      \\multicolumn{4}{|c|}{\\textbf{<%= @titles['S_5']['understanding'] %>}} &
+      \\multicolumn{4}{|c|}{\\textbf{<%= @titles['S_5']['speaking'] %>}} &
+      \\multicolumn{2}{|c|}{\\textbf{<%= @titles['S_5']['writing'] %>}} \\\\
+
+      \\multicolumn{1}{c|}{<%= ' ' %>} &
+      \\multicolumn{2}{|c|}{<%= @titles['S_5']['listening'] %>} &
+      \\multicolumn{2}{|c|}{<%= @titles['S_5']['reading'] %>} &
+      \\multicolumn{2}{|c|}{<%= @titles['S_5']['spoken_interaction'] %>} &
+      \\multicolumn{2}{|c|}{<%= @titles['S_5']['spoken_production'] %>} &
+      \\multicolumn{2}{|c|}{<%= @titles['S_5']['written_production'] %>} \\\\
+      \\hline
+
+      <% @languages.each do |language| %>
+        \\hline
+        \\textbf{<%= language['name'] %>} &
+        <%= language['listening']['level'] %> &
+        <%= language['listening']['description'] %> &
+        <%= language['reading']['level'] %> &
+        <%= language['reading']['description'] %> &
+        <%= language['spoken_interaction']['level'] %> &
+        <%= language['spoken_interaction']['description'] %> &
+        <%= language['spoken_production']['level'] %> &
+        <%= language['spoken_production']['description'] %> &
+        <%= language['written_production']['level'] %> &
+        <%= language['written_production']['description'] %> \\\\
+      <% end %>
+      \\hline
+
+    \\end{tabular}
+    }
+
+    CODE
+
+    evaluate(input, context).gsub(/^\s+/,'').gsub(/\n/,'') + "\n\n"
+  end
+
+end

data/lib/cgen/generator/specific/work_experience.rb

@@ -0,0 +1,81 @@
+class CGen::Generator::WorkExperience < CGen::Generator::BasicGenerator
+
+  def initialize(param, data, lang)
+    super(param, data, lang)
+  end
+
+  def generate
+    value = get_value(param)
+    value.collect do |elem|
+      get_work_experience(elem)
+    end.join("\n")
+  end
+
+  protected
+
+  def get_work_experience(context)
+
+    context.merge!({'titles' => get_value('titles')})
+
+    input = <<-CODE
+
+    \\cventry
+
+    <% if @date.nil? %>
+      {}
+    <% elsif @date.is_a?(Hash) && @date.has_key?('from') && @date.has_key?('to') %>
+      {<%= @date['from'] %>\\\\<%= @date['to'] %>}
+    <% else %>
+      {<%= @date %>}
+    <% end %>
+
+    {<%= @occupation.nil? ? '' : @occupation %>}
+
+    <% if @employer_name %>
+
+      {
+      <%= @employer_name %>
+      <% if @type_of_business %>
+        (<%= @type_of_business %>)
+      <% end %>
+      }
+
+      <% if @employer_address %>
+        {<%= @employer_address %>}
+      <% end %>
+
+    <% end %>
+
+    {}
+
+    {
+    <% if @main_activities %>
+
+      <% unless @main_activities.is_a?(Array) %>
+        <% @main_activities = Array[@main_activities] %>
+      <% end %>
+
+      <% @main_activities.compact! %>
+
+      <% if @main_activities.length > 0 %>
+
+        \\textit{<%= @titles['S_3']['main_activities'] %>}:
+        \\begin{itemize}
+
+        <% @main_activities.each do |main_activity| %>
+          \\item <%= main_activity %>
+        <% end %>
+
+        \\end{itemize}
+
+      <% end %>
+
+    <% end %>
+    }
+
+    CODE
+
+    evaluate(input, context).gsub(/^\s+/,'').gsub(/\n/,'') + "\n\n"
+  end
+
+end

data/lib/cgen/generator.rb

@@ -0,0 +1,10 @@
+# All of the classes under cgen/generator should be namespaced with this module
+module CGen::Generator; end
+
+
+# Require the basic generator before the others, since they will assume the BasicGenerator class is already available
+require 'cgen/generator/basic_generator'
+# Require the 'generic' generators
+Dir.glob(File.join(File.dirname(__FILE__), 'generator/*.rb')) { |mod| require(mod) if mod != 'basic_generator' }
+# Require the 'specific' generators
+Dir.glob(File.join(File.dirname(__FILE__), 'generator/specific/*.rb')) { |mod| require(mod) }

data/lib/cgen/util/latex_to_pdf.rb

@@ -0,0 +1,61 @@
+class CGen::Util::LatexToPdf
+
+  def initialize(
+      input_file_name, input_dir, resources_pths, out_dir, log_file,
+      halt_on_error=true, shell_enabled=true, interpreter='xelatex', additional_args=[])
+    @interpreter = interpreter
+    @halt_on_error = !!halt_on_error
+    @shell_enabled = !!shell_enabled
+    @out_dir = out_dir
+    @input_file_name = input_file_name
+    @input_dir = input_dir
+    @resources_pths = resources_pths
+    @log_file = log_file
+    @additional_args = additional_args.is_a?(Array) ? additional_args : []
+  end
+
+  def generate
+
+    # Store the starting resources for later cleanup
+    starting_resources = resources_files
+
+    # Create the command used to generate the PDF
+    gen_pdf_cmd = CGen::Util::ShellCommand.new(get_tex_cmd, @input_dir, @log_file)
+    # Create the command used to generate the bibliography
+    gen_bib_cmd = CGen::Util::ShellCommand.new(get_bibtex_cmd, @out_dir, @log_file)
+
+    Either.chain do
+      bind -> { gen_pdf_cmd.run }
+      bind -> { gen_bib_cmd.run }
+      bind -> { gen_pdf_cmd.run }
+      bind -> { gen_pdf_cmd.run }
+      bind -> {
+        # ==> Cleanup resources files
+        dirty_files = resources_files - starting_resources
+        dirty_files.length > 0 ? system("rm #{dirty_files.join(' ')}") : false
+      }
+    end
+  end
+
+  protected
+
+  def get_tex_cmd
+    args = %w(-synctex=1 -interaction=batchmode)                 # default arguments
+    args << '-halt-on-error' if @halt_on_error                   # halt on error
+    args += %w(-shell-escape --enable-write18) if @shell_enabled # shell escape
+    args << "-output-directory=#{@out_dir}"                      # output directory
+    args += @additional_args                                     # add the additional arguments to the computed ones
+    args << @input_file_name
+
+    "#{@interpreter} #{args.join(' ')}"                          # build the tex command and return it
+  end
+
+  def get_bibtex_cmd
+    "BIBINPUTS=\"#{@input_dir}\" " + "bibtex #{@input_file_name}" # build the bibtex command and return it
+  end
+
+  def resources_files
+    Dir.glob(@resources_pths)
+  end
+
+end

data/lib/cgen/util/logging.rb

@@ -0,0 +1,27 @@
+module CGen::Util::Logging
+
+  def self.log(name, opts={})
+    case name
+      when :fatal_error
+        puts "#{prefix} Fatal error: #{opts[:msg].light_black}. Aborting...".red
+      when :loading_curriculum_data
+        puts "#{prefix} Loading the curriculum data for ".cyan + opts[:trgt_lang].to_s.light_black
+        puts "#{indent} using ".cyan + opts[:master_lang].to_s.light_black + ' as the default'.cyan
+      when :executing_command
+        puts "#{prefix} Executing          ".cyan + opts[:cmd].to_s.light_black
+        puts "#{indent} from the directory ".cyan + opts[:exec_dir].to_s.light_black if opts.has_key? :exec_dir
+        puts "#{indent} logging to         ".cyan + opts[:log_file].to_s.light_black if opts.has_key? :log_file
+      else
+        # nothing to do
+    end
+  end
+
+  def self.prefix
+    '>>'
+  end
+
+  def self.indent
+    '  '
+  end
+
+end

data/lib/cgen/util/shell_command.rb

@@ -0,0 +1,48 @@
+class CGen::Util::ShellCommand
+
+  def initialize(command, execution_dir, log_file=nil)
+    @command = command
+    @execution_dir = execution_dir
+    @log_file = log_file
+  end
+
+  def run
+    CGen::Util::Logging.log(:executing_command, cmd: @command, exec_dir: @execution_dir, log_file: @log_file)
+
+    status = true
+
+    Process.waitpid(
+        fork do
+          original_stdout, original_stderr = $stdout, $stderr
+          FileUtils.chdir @execution_dir do
+            File.open(@log_file, 'a') do |log_file|
+              $stderr = $stdout = log_file
+              system @command
+              $stdout, $stderr = original_stdout, original_stderr
+            end
+          end
+        end)
+
+    status # return
+  end
+
+  def self.exist?(command)
+    exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
+    ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
+      exts.collect do |ext|
+        exe = File.join(path, "#{command}#{ext}")
+        return true if File.executable? exe
+      end
+    end
+    false # return
+  end
+
+  def exist?
+    self.class.exist? @command
+  end
+
+  def find_executable_part(command)
+    command.split(' ').first
+  end
+
+end

data/lib/cgen/util.rb

@@ -0,0 +1,6 @@
+# All of the classes under cgen/util should be namespaced with this module
+module CGen::Util; end
+
+
+# Require all of the data loaders
+Dir.glob(File.join(File.dirname(__FILE__), 'util/*.rb')) { |mod| require mod }

data/lib/cgen/version.rb

@@ -0,0 +1,6 @@
+module CGen
+
+  # This is the current version of CGen
+  VERSION = '1.0.0'
+
+end

data/static/bundled_templates/moderncv/deps.yml

@@ -0,0 +1,15 @@
+cmds:
+  - pygmentize
+
+pkgs:
+  - fontawesome
+  - epigraph
+  - minted
+  - framed
+  - csquotes
+  - xcolor
+  - ulem
+  - todonotes
+
+manual_deps:
+  - The FontAwesome system font (http://fortawesome.github.io/Font-Awesome)