curriculum-generator 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9d188f9f8afdc19e86cada3e6707bf0cbd0d7f89
+  data.tar.gz: e82273c0742e3da2644db4c48508499c2de0d6a2
+SHA512:
+  metadata.gz: 965ded86275d134b62ab68dda1b54333d607ac28ac7cd7acf91f435e5c750b6381cd3a58da277894ae725f779273d5b4f27c200ce0ab4c493d7666d9396d8f1a
+  data.tar.gz: 4059c63ef2bc1e468bf0f9b633396a0903e0019a1b0d0c925690d904ed197f07855988049669bdf21ae8bba9f8ecc003be02a11e6fb535fea82fc3d0fba954aa

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+/.idea

data/.ruby-version

@@ -0,0 +1 @@
+2.1.1

data/CGen.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cgen/version'
+
+
+Gem::Specification.new do |spec|
+
+  spec.name          = 'curriculum-generator'
+  spec.version       = CGen::VERSION
+  spec.authors       = ['Alessandro Molari']
+  spec.email         = ['molari.alessandro@gmail.com']
+  spec.summary       = %q{Curriculum Vitae generator}
+  spec.homepage      = 'http://github.com/alem0lars/cgen'
+  spec.license       = 'Apache 2'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake'
+
+  spec.add_runtime_dependency     'hash-deep-merge'
+  spec.add_runtime_dependency     'monadic'
+
+  spec.add_runtime_dependency     'awesome_print'
+  spec.add_runtime_dependency     'colorize'
+  spec.add_runtime_dependency     'highline'
+
+  spec.add_runtime_dependency     'erubis'
+
+end

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+
+# Specify your gem's dependencies in CGen.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Alessandro Molari
+
+MIT License
+
+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,62 @@
+# CGen
+
+CGen is the next **localized Curriculum Vitae** editor, both for hackers and end-users.
+
+*Please note that this is still in early development stages. If you are an end-user you may want to check this project out in a couple of weeks.*
+
+## Installation
+
+Via homebrew
+
+    $ brew install cgen
+    
+Via rubygems
+
+    $ gem install curriculum-generator
+
+
+## Usage
+
+CGen provides two editing modes:
+1. **Hacking Mode**
+2. **Normal Mode**
+
+### Hacking Mode
+
+This is where CGen shrines, by allowing users to **just provide the data** and let the system do the rest. This system comes with *extensibility* in mind, by providing different levels of customization:
+1. **Data-level**: The first level is the most commonly used. The system automatically pulls all of your defined data. This means that there isn't anything wired-in, no names, no values, anything. Data is just data and you can use it as you want !
+2. **Templates-level**: For basic customizations you can write your own (LaTeX) **templates**, or modify an existing one.
+3. **Generators-level**: For more advanced customizations, you can write your own (Ruby) **generators**.
+
+### Normal Mode
+
+This is primarly for non-hackers. In this mode the curriculum is edited by using a GUI.
+
+*This mode is still in development: not released yet*.
+
+## Contributing
+
+### Project management
+
+#### Scrum & Trello
+
+The project follows the **Scrum Methodology**, using Trello as the main tool.
+
+The board is available under: [CGen Trello Board](https://trello.com/b/8er5R7dK/cgen)
+
+#### Report bugs / Request enhancements
+
+Create a new card in the *Product Backlog* list:
+
+* With the *red* label for bug reporting
+* With the *blue* label to request an enhancement
+
+### Fork-Pull pattern
+
+The project contribution is commonly done by using the so-much-famous *fork-pull pattern*:
+
+1. Fork it ( https://github.com/[my-github-username]/cgen/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,3 @@
+require 'bundler/gem_tasks'
+require 'rake'
+require 'rake/clean'

data/bin/cgen.rb

@@ -0,0 +1,86 @@
+#!/usr/bin/env ruby
+
+
+require 'cgen'
+
+
+# == Setup functions ===================================================================================================
+
+def setup_opts
+
+  $tmp_pth = Pathname.new Dir.mktmpdir
+  $tex_out_pth = Pathname.new Dir.mktmpdir
+  $log_dir = $tmp_pth.join('log')
+
+  $data_pth = Pathname.new File.expand_path(ask("What's the path for the directory containing the data ? ".magenta))
+  $out_pth = Pathname.new File.expand_path(ask("What's the destination path ? ".magenta))
+  $main_tex_file_name = ask('Main TeX file name ? '.magenta) { |q| q.default = 'main.tex' }
+  $resources_dir_name = ask("What's the name for the directory containing the resources (relative to the directory that contains the template) ? ".magenta) { |q| q.default = 'resources' }
+  $template_dir_pth = Pathname.new(File.expand_path(
+      ask("What's the path of the template (leave empty for the default template) ? ".magenta) { |q|
+        q.default = File.join(File.dirname(File.dirname(__FILE__)), 'static', 'bundled_templates', 'moderncv')
+      }))
+  $template_deps_file_pth = Pathname.new(File.expand_path(
+      ask("What's the path for the YAML file containing the dependencies ? ".magenta) { |q|
+        q.default = $template_dir_pth.join('deps.yml').to_s
+      }))
+
+  # Ensure that the languages are correctly setup, i.e. if they aren't given use all of the available languages
+  $langs ||= Dir.glob($data_pth.join('*')).collect do |lang_data_pth|
+    File.basename(lang_data_pth).to_sym
+  end
+
+end
+
+# Setup the files / directories
+def setup_filesystem
+  FileUtils.mkdir_p($out_pth)
+  FileUtils.mkdir_p($log_dir)
+end
+
+
+# == Utilities =========================================================================================================
+
+def create_log_file(name)
+  $log_dir.join("log_#{DateTime.now.strftime('%Y.%m.%d')}_#{name}.txt")
+end
+
+
+# == CGen entry point ==================================================================================================
+
+puts '> Starting Curriculum'.green
+
+setup_opts
+setup_filesystem
+
+$curriculum = CGen::Curriculum.new(
+    CGen::DataLoader::YamlDataLoader.new, # TODO: Let the user choose the data loader
+    CGen::Compiler.new($tex_out_pth),
+    $data_pth,
+    $template_dir_pth,
+    $langs,
+    File.directory?($data_pth.join('en')) ? :en : nil)
+
+unless $curriculum.validate_deps($template_deps_file_pth)
+  CGen::Util::Logging.log(:fatal_error, msg: 'The dependencies are not satisfied')
+end
+
+$curriculum.compile($langs)
+
+puts '>> Generating PDFs'.green
+
+$langs.each do |lang|
+  puts '>> Generating PDF for language '.cyan + lang.to_s.light_black
+
+  input_dir = $tex_out_pth.join(lang.to_s)
+  out_pth = $out_pth.join(lang.to_s)
+  FileUtils.mkdir_p(out_pth)
+
+  latex_to_pdf = CGen::Util::LatexToPdf.new($main_tex_file_name,
+                                            input_dir,
+                                            input_dir.join($resources_dir_name).join('*').to_s,
+                                            out_pth,
+                                            create_log_file('latex_to_pdf'))
+  latex_to_pdf.generate
+
+end

data/lib/CGen.rb

@@ -0,0 +1,27 @@
+# The common module for all of the CGen classes
+module CGen; end
+
+
+# ==> Setup RubyGems and Bundler
+require 'rubygems'
+require 'bundler/setup'
+
+# ==> Require the core dependencies
+require 'tmpdir'
+require 'pathname'
+
+# ==> Require all of the external dependencies
+require 'hash_deep_merge'
+require 'monadic'
+require 'awesome_print'
+require 'colorize'
+require 'highline/import'
+require 'erubis'
+
+# ==> Require the project stuff
+require 'cgen/version'
+require 'cgen/util'
+require 'cgen/compiler'
+require 'cgen/curriculum'
+require 'cgen/data_loader'
+require 'cgen/generator'

data/lib/cgen/compiler.rb

@@ -0,0 +1,96 @@
+class CGen::Compiler
+
+  def initialize(tex_out_pth)
+    @tex_out_pth = tex_out_pth
+    @generator_regex = /^generate\s*\(\s*(?<generator>[^,()]+)\s*,\s*(?<param>[^,()]+)\s*\)\s*$/i
+    @line_regex = /(?<re>\<=(?:(?<ctnt>(?>[^<>=]+)|\g<re>)+)\=\>)/
+  end
+
+  def validate_deps(deps_file_pth)
+    puts '>> Ensuring that the dependencies are satisfied'
+
+    # ==> Load the data from the YAML file
+    data = {}
+    File.open(deps_file_pth.to_s, 'r') { |deps_file| data.merge!(YAML::load(deps_file)) }
+
+    # ==> Validate commands are available on the system
+    data.has_key?('cmds') && data['cmds'].respond_to?(:all?) && data['cmds'].all? do |cmd|
+      CGen::Util::ShellCommand.exist?(cmd) ? true : puts(">> Command #{cmd} not found".red)
+    end
+
+    # ==> Validate that the required fonts are available
+    data.has_key?('pkgs') && data['pkgs'].respond_to?(:all?) && data['pkgs'].all? do |pkg|
+      `tlmgr list --only-installed | grep "i #{pkg}:"`.strip.length > 0 ? true : puts(">> Package #{pkg} not found".red)
+    end
+
+    # Outputs the manual dependencies
+    data.has_key?('manual_deps') && data['manual_deps'].respond_to?(:each) do |manual_dep|
+      puts '>> Please ensure that the manual dependency is installed:'.yellow + manual_dep.to_s.light_black
+    end
+  end
+
+  def compile(data, template_pth, lang)
+    puts '>> Compiling the language    '.cyan + ":#{lang}".light_black
+    puts '   against the template      '.cyan + template_pth.to_s.light_black
+    puts '   into the output directory '.cyan + @tex_out_pth.to_s.light_black
+
+    Dir.glob(template_pth.join('**').join('*')) do |file_pth|
+      if File.file?(file_pth)
+        rel_file_pth = file_pth.to_s.gsub(/#{template_pth}[\/]?/, '')
+        out_file_pth = @tex_out_pth.join(lang.to_s).join(rel_file_pth)
+
+        if File.extname(file_pth) == '.tex'
+          out_lines = []
+
+          File.open(file_pth, 'r').each do |line|
+            out_lines << line.gsub(@line_regex) do |_|
+              req_str = $2.strip.dup
+
+              md = @generator_regex.match(req_str)
+              if md
+                # Generate command
+                handle_generate(md[:generator].to_sym, md[:param], data, lang)
+              else
+                # Macro substitution
+                handle_generate(:macro_substitution, req_str, data, lang)
+              end
+            end
+          end
+
+          FileUtils.mkdir_p(out_file_pth.dirname)
+          File.open(out_file_pth, 'w') do |tex_out_file|
+            tex_out_file.write(out_lines.join(''))
+          end
+        else
+          FileUtils.mkdir_p(out_file_pth.dirname)
+          FileUtils.cp_r(file_pth, out_file_pth)
+        end
+      end
+    end
+  end
+
+  def handle_generate(generator, param, data, lang)
+    generators = {
+        # Generic
+        cvitem: CGen::Generator::CvItem,
+        cventry: CGen::Generator::CvEntry,
+        cvitemwithcomment: CGen::Generator::CvItemWithComment,
+        cvdoubleitem: CGen::Generator::CvDoubleItem,
+        cvlistitem: CGen::Generator::CvListItem,
+        cvlistdoubleitem: CGen::Generator::CvListDoubleItem,
+        cvcolumn: CGen::Generator::CvColumn,
+        list: CGen::Generator::List,
+        # Specific
+        work_experience: CGen::Generator::WorkExperience,
+        education: CGen::Generator::Education,
+        self_assessment: CGen::Generator::SelfAssessment,
+        # Macro
+        macro_substitution: CGen::Generator::MacroSubstitution
+    }
+
+    generators.has_key?(generator) ?
+        generators[generator].new(param, data, lang).generate :
+        raise("Invalid generator: #{generator}. Expected one of: #{generators}")
+  end
+
+end

data/lib/cgen/curriculum.rb

@@ -0,0 +1,57 @@
+class CGen::Curriculum
+
+  attr_accessor :langs, :master_lang, :data_loader, :compiler, :data_pth
+
+  def initialize(data_loader, compiler, data_pth, template_pth, langs=[], master_lang=nil)
+    # Preconditions
+    raise 'Invalid langs. It cannot be empty' if langs.empty?
+
+    @data_loader = data_loader
+    @compiler = compiler
+    @langs = {}
+    # if the master language is not provided, then defaults to the first provided language
+    @master_lang = master_lang.nil? ? langs[0] : master_lang
+
+    @data_pth = data_pth
+    @template_pth = template_pth
+
+    puts '> Picking up the available languages'.green
+
+    langs.each do |lang|
+      lang_data_pth = @data_pth.join(lang.to_s)
+
+      inst = self
+      Either.chain do
+        bind -> { lang_data_pth.directory? }
+        bind -> {
+          lang_data = inst.data_loader.load_data(inst.data_pth, lang.to_sym, inst.master_lang.to_sym)
+          lang_data.is_a?(Hash) ? Success(lang_data) : Failure('lang data')
+        }
+        bind ->(lang_data) {
+          inst.langs[lang.to_sym] = { data: lang_data }
+        }
+      end
+    end
+  end
+
+  def validate_deps(template_deps_file_pth)
+    @compiler.validate_deps template_deps_file_pth
+  end
+
+  # Compile the curriculum for the provided languages
+  def compile(langs)
+    puts "> Compiling the curriculum for the languages: #{langs}".green
+
+    if langs.respond_to?(:each)
+      langs.each do |lang|
+        lang = lang.to_sym
+        @compiler.compile(@langs[lang][:data], @template_pth, lang)
+      end
+    elsif @langs.include? langs
+      @compiler.compile(@langs[lang][:data], @template_pth, langs)
+    else
+      raise 'Invalid lang'
+    end
+  end
+
+end

data/lib/cgen/data_loader/yaml_data_loader.rb

@@ -0,0 +1,31 @@
+require 'yaml'
+
+
+class CGen::DataLoader::YamlDataLoader
+
+  # Load the localized data from the directory `data_dir_pth`, following the convention that the localized data for
+  # a language are in a subdirectory of `data_dir_pth` named with the same name of the language.
+  # The target language name (which is also the subdirectory name) is `trgt_lang`, which fallbacks to the `master_lang`
+  def load_data(data_dir_pth, trgt_lang, master_lang)
+    CGen::Util::Logging.log(:loading_curriculum_data, trgt_lang: trgt_lang, master_lang: master_lang)
+
+    trgt_lang_data_dir_pth = data_dir_pth.join(trgt_lang.to_s)
+    master_lang_data_dir_pth = data_dir_pth.join(master_lang.to_s)
+
+    master_data = load_recursive_from_pth(trgt_lang_data_dir_pth)
+    trgt_data = load_recursive_from_pth(master_lang_data_dir_pth)
+
+    trgt_data.deep_merge(master_data) # return
+  end
+
+  # Load all of the YAML file starting from the given `base_dir_pth` and merges all of the data into an `Hash` and
+  # returns it
+  def load_recursive_from_pth(base_dir_pth)
+    data = {}
+    Dir.glob(base_dir_pth.join('**').join('*.yml')) do |yml_file_pth|
+      File.open(yml_file_pth, 'r') { |yml_file| data.merge!(YAML::load(yml_file)) }
+    end
+    data # return
+  end
+
+end

data/lib/cgen/data_loader.rb

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

data/lib/cgen/generator/basic_generator.rb

@@ -0,0 +1,37 @@
+# Abstract class for a generator. All generators should inherit from this class
+class CGen::Generator::BasicGenerator
+
+  attr_accessor(:param)
+  attr_accessor(:data)
+  attr_accessor(:lang)
+
+  def initialize(param, data, lang)
+    @param = param
+    @data = data
+    @lang = lang
+  end
+
+  def generate
+    raise 'Abstract class'
+  end
+
+  def get_value(keys_str)
+    keys = keys_str.split('.').reverse
+    if keys.empty?
+      '' # return
+    else
+      data_tmp = @data.dup
+      until keys.empty?
+        key = keys.pop
+        data_tmp = data_tmp[key]
+      end
+      data_tmp # return
+    end
+  end
+
+  def evaluate(input, context)
+    eruby = Erubis::Eruby.new(input)
+    eruby.evaluate(context) # return
+  end
+
+end

data/lib/cgen/generator/cv_column.rb

@@ -0,0 +1,32 @@
+class CGen::Generator::CvColumn < 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{cvcolumns}" + (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{cvcolumns")
+  end
+
+  protected
+
+  def get_cv_list_double_item(item_0, item_1)
+    "\\cvcolumn{#{item_0}}{#{item_1}}"
+  end
+
+end

data/lib/cgen/generator/cv_double_item.rb

@@ -0,0 +1,42 @@
+class CGen::Generator::CvDoubleItem < 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['item_0'].has_key?('title') &&
+              elem['item_0'].has_key?('content')
+        }
+        bind -> {
+          elem.has_key?('item_1') &&
+              elem['item_1'].has_key?('title') &&
+              elem['item_1'].has_key?('content')
+        }
+        bind -> {
+          instance.get_cv_double_item(elem['item_0'], elem['item_1'])
+        }
+      end
+      result.success? ? result.fetch : ''
+    end.join("\n")
+  end
+
+  protected
+
+  def get_cv_double_item(item_0, item_1)
+    "\\cvdoubleitem" +
+        "{#{item_0['title']}}{#{item_0['content']}}" +
+        "{#{item_1['title']}}{#{item_1['content']}}"
+  end
+
+end

data/lib/cgen/generator/cv_entry.rb

@@ -0,0 +1,33 @@
+class CGen::Generator::CvEntry < 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
+    instance = self
+    result = Either.chain do
+      bind -> { value.is_a?(Array) }
+      bind -> { instance.get_cv_entry(value) }
+    end
+    result.success? ? result.fetch : ''
+  end
+
+  protected
+
+  def get_cv_entry(context)
+    result = "\\cventry"
+    context.each do |elem|
+      result += "{#{elem}}"
+    end
+    (6 - context.size).times do
+      result += '{}'
+    end
+    result # return
+  end
+
+end

data/lib/cgen/generator/cv_item.rb

@@ -0,0 +1,29 @@
+class CGen::Generator::CvItem < 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?('title') && elem.has_key?('content') }
+        bind -> { instance.get_cv_item(elem['title'], elem['content']) }
+      end
+      result.success? ? result.fetch : ''
+    end.join("\n")
+  end
+
+  protected
+
+  def get_cv_item(title, content)
+    "\\cvitem{#{title}}{#{content}}"
+  end
+
+end