curriculum-generator 1.0.4 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 422c808d70f4336a9f937e4f950c8d09e77ca67b
-  data.tar.gz: 3e876d30240d0a78ba9f2dfd670df9e85e972574
+  metadata.gz: 35549f211438e86fe041498e882c7869b61d5f99
+  data.tar.gz: c11c2225c8bd3b934c33c1a0cd023b3d958efa9f
 SHA512:
-  metadata.gz: b6c890fca024c370f46ef4d929dd4efee648f502f5b9e49d86636808ae2890b4d008225032197179d37b64dcb14ac99bb697b95296bba1da33fd99d6e2ab0f8c
-  data.tar.gz: 99c1be97d54907554334db5605a9968168a793134330b99bd9e3d12eb78e9361a42a61dd2cccfe46864558faeaf512ee4541ece7b8e5195020ad4a90b3dc7bf4
+  metadata.gz: 4d4364d64e1631b1c7d6cf3d45e3a169f16e14f9de4d8e971492cb3be51691a9a71f2a7c2eefe9b1a2bd1e75865215fcce175da24d7da7b61dd2f437c79f6d1c
+  data.tar.gz: 276ca0fbfe4463bb8b606aafcfe65a408e893461d178dbf0289ca0fc69a2ba6f7db0d3a03ae6e8e9fdae06122d02b6b7bf04c66ef0b69abcef17530a311abc97

data/Gemfile

@@ -1,5 +1,5 @@
 source 'https://rubygems.org'
 
 
-# Specify your gem's dependencies in cgen.gemspec
+# Specify your gem's dependencies in `curriculum-generator.gemspec`.
 gemspec

data/README.md

@@ -1,6 +1,6 @@
-# CGen
+# CurriculumGenerator
 
-CGen is the next **localized Curriculum Vitae** editor, both for hackers and end-users.
+CurriculumGenerator is the next **localized Curriculum Vitae** editor, both for hackers and end-users.
 
 *Please note that this is still in early development stages, bug reporting is really welcome!*
 
@@ -12,7 +12,7 @@ Via rubygems
 
 ## Usage
 
-CGen provides two editing modes:
+CurriculumGenerator provides two editing modes:
 
 * **Hacking Mode**
 * **Normal Mode**
@@ -21,7 +21,7 @@ CGen provides two editing modes:
 
 ![Status](http://img.shields.io/badge/status-OK-green.svg)
 
-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:
+This is where CurriculumGenerator 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.
@@ -51,7 +51,7 @@ In this mode the curriculum is edited by using a GUI.
 
 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)
+The board is available under: [CurriculumGenerator Trello Board](https://trello.com/b/8er5R7dK/curriculum-generator)
 
 #### Report bugs / Request enhancements
 
@@ -64,7 +64,7 @@ Create a new card in the *Product Backlog* list:
 
 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 )
+1. Fork it ( https://github.com/[my-github-username]/curriculum-generator/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`)

data/Rakefile

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

data/bin/{cgen → curriculum-generator}

@@ -1,10 +1,16 @@
 #!/usr/bin/env ruby
 
 
-require 'cgen'
+begin
+  require "rubygems"
+  gem "curriculum-generator"
+rescue LoadError
+end
+
+require "curriculum-generator"
 
 
-# == Setup functions ===================================================================================================
+# == Setup functions ===========================================================
 
 def setup_opts
 
@@ -39,48 +45,49 @@ def setup_filesystem
 end
 
 
-# == Utilities =========================================================================================================
+# == Utilities =================================================================
 
 def create_log_file(name)
   $log_dir.join("log_#{DateTime.now.strftime('%Y.%m.%d')}_#{name}.txt")
 end
 
 
-# == CGen entry point ==================================================================================================
+# == CurriculumGenerator 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),
+$curriculum = CurriculumGenerator::Curriculum.new(
+    CurriculumGenerator::DataLoader::YamlDataLoader.new, # TODO: Let the user choose the data loader
+    CurriculumGenerator::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')
+  CurriculumGenerator::Util::Logging.log(:fatal_error, msg: "The dependencies are not satisfied.")
 end
 
 $curriculum.compile($langs)
 
-puts '>> Generating PDFs'.green
+puts ">> Generating PDFs".green
 
 $langs.each do |lang|
-  puts '>> Generating PDF for language '.cyan + lang.to_s.light_black
+  puts ">> Generating PDF for language #{lang.to_s.light_black}".cyan
 
   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
+  latex_to_pdf = CurriculumGenerator::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/curriculum-generator.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "curriculum-generator/version"
+
+
+Gem::Specification.new do |spec|
+
+  spec.name          = "curriculum-generator"
+  spec.version       = CurriculumGenerator::VERSION
+  spec.authors       = ["Alessandro Molari"]
+  spec.email         = ["molari.alessandro@gmail.com"]
+  spec.summary       = %q{Curriculum Vitae generator}
+  spec.homepage      = "http://github.com/alem0lars/curriculum-generator"
+  spec.license       = "Apache v2.0"
+
+  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/lib/curriculum-generator.rb

@@ -0,0 +1,19 @@
+# ==> 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 "curriculum-generator/version"
+require "curriculum-generator/util"
+require "curriculum-generator/compiler"
+require "curriculum-generator/curriculum"
+require "curriculum-generator/data_loader"
+require "curriculum-generator/generator"

data/lib/curriculum-generator/compiler.rb

@@ -0,0 +1,102 @@
+module CurriculumGenerator
+  class Compiler
+
+    GENERATORS = {
+      # Generic.
+      cvitem:            CurriculumGenerator::Generator::CvItem,
+      cventry:           CurriculumGenerator::Generator::CvEntry,
+      cvitemwithcomment: CurriculumGenerator::Generator::CvItemWithComment,
+      cvdoubleitem:      CurriculumGenerator::Generator::CvDoubleItem,
+      cvlistitem:        CurriculumGenerator::Generator::CvListItem,
+      cvlistdoubleitem:  CurriculumGenerator::Generator::CvListDoubleItem,
+      cvcolumn:          CurriculumGenerator::Generator::CvColumn,
+      list:              CurriculumGenerator::Generator::List,
+      # Specific.
+      work_experience: CurriculumGenerator::Generator::WorkExperience,
+      education:       CurriculumGenerator::Generator::Education,
+      self_assessment: CurriculumGenerator::Generator::SelfAssessment,
+      # Macro.
+      macro_substitution: CurriculumGenerator::Generator::MacroSubstitution
+    }
+
+    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") do |deps_file|
+        data.merge!(YAML::load(deps_file))
+      end
+
+      # ==> Validate commands are available on the system.
+      data.has_key?('cmds') && data['cmds'].respond_to?(:all?) && data['cmds'].all? do |cmd|
+        CurriculumGenerator::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)
+      if GENERATORS.has_key?(generator)
+        GENERATORS[generator].new(param, data, lang).generate
+      else
+        fail("Invalid generator `#{generator}`: expected one of `#{GENERATORS}`.")
+      end
+    end
+
+  end
+end

data/lib/curriculum-generator/curriculum.rb

@@ -0,0 +1,63 @@
+module CurriculumGenerator
+  class 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.join(" ").light_black}`.".green
+
+      # TODO: Refactor into monads, with better error detection.
+      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 language."
+      end
+    end
+
+  end
+end

data/lib/curriculum-generator/data_loader.rb

@@ -0,0 +1,4 @@
+# Require all of the data loaders
+Dir.glob(File.join(File.dirname(__FILE__), "data_loader/*.rb")) do |mod|
+  require(mod)
+end

data/lib/{cgen → curriculum-generator}/data_loader/yaml_data_loader.rb

@@ -1,13 +1,13 @@
 require 'yaml'
 
 
-class CGen::DataLoader::YamlDataLoader
+class CurriculumGenerator::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)
+    CurriculumGenerator::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)

data/lib/curriculum-generator/generator.rb

@@ -0,0 +1,13 @@
+# Require the basic generator before the others, since they will inherit from it
+# (assuming the class `BasicGenerator` is already available).
+require "curriculum-generator/generator/basic_generator"
+
+# Require the `generic` generators.
+Dir.glob(File.join(File.dirname(__FILE__), "generator/*.rb")) do |mod|
+  require(mod) if mod != "basic_generator"
+end
+
+# Require the `specific` generators.
+Dir.glob(File.join(File.dirname(__FILE__), "generator/specific/*.rb")) do |mod|
+  require(mod)
+end

data/lib/curriculum-generator/generator/basic_generator.rb

@@ -0,0 +1,42 @@
+module CurriculumGenerator
+  module Generator
+    # Abstract class for a generator.
+    # All generators should inherit from this class.
+    class BasicGenerator
+
+      attr_accessor(:param)
+      attr_accessor(:data)
+      attr_accessor(:lang)
+
+      def initialize(param, data, lang)
+        @param = param
+        @data = data
+        @lang = lang
+      end
+
+      def generate
+        fail("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
+  end
+end

data/lib/curriculum-generator/generator/cv_column.rb

@@ -0,0 +1,36 @@
+module CurriculumGenerator
+  module Generator
+    class CvColumn < 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
+  end
+end

data/lib/curriculum-generator/generator/cv_double_item.rb

@@ -0,0 +1,46 @@
+module CurriculumGenerator
+  module Generator
+    class CvDoubleItem < 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
+  end
+end

data/lib/curriculum-generator/generator/cv_entry.rb

@@ -0,0 +1,37 @@
+module CurriculumGenerator
+  module Generator
+    class CvEntry < 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
+  end
+end

data/lib/curriculum-generator/generator/cv_item.rb

@@ -0,0 +1,33 @@
+module CurriculumGenerator
+  module Generator
+    class CvItem < 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
+  end
+end

data/lib/{cgen → curriculum-generator}/generator/cv_item_with_comment.rb

@@ -1,4 +1,4 @@
-class CGen::Generator::CvItemWithComment < CGen::Generator::BasicGenerator
+class CurriculumGenerator::Generator::CvItemWithComment < CurriculumGenerator::Generator::BasicGenerator
 
   def initialize(param, data, lang)
     super(param, data, lang)

data/lib/{cgen → curriculum-generator}/generator/cv_list_double_item.rb

@@ -1,4 +1,4 @@
-class CGen::Generator::CvListDoubleItem < CGen::Generator::BasicGenerator
+class CurriculumGenerator::Generator::CvListDoubleItem < CurriculumGenerator::Generator::BasicGenerator
 
   def initialize(param, data, lang)
     super(param, data, lang)

data/lib/{cgen → curriculum-generator}/generator/cv_list_item.rb

@@ -1,4 +1,4 @@
-class CGen::Generator::CvListItem < CGen::Generator::BasicGenerator
+class CurriculumGenerator::Generator::CvListItem < CurriculumGenerator::Generator::BasicGenerator
 
   def initialize(param, data, lang)
     super(param, data, lang)

data/lib/{cgen → curriculum-generator}/generator/list.rb

@@ -1,4 +1,4 @@
-class CGen::Generator::List < CGen::Generator::BasicGenerator
+class CurriculumGenerator::Generator::List < CurriculumGenerator::Generator::BasicGenerator
 
   def initialize(param, data, lang)
     super(param, data, lang)

data/lib/{cgen → curriculum-generator}/generator/macro_substitution.rb

@@ -1,4 +1,4 @@
-class CGen::Generator::MacroSubstitution < CGen::Generator::BasicGenerator
+class CurriculumGenerator::Generator::MacroSubstitution < CurriculumGenerator::Generator::BasicGenerator
 
   def initialize(param, data, lang)
     super(param, data, lang)

data/lib/{cgen → curriculum-generator}/generator/specific/education.rb

@@ -1,4 +1,4 @@
-class CGen::Generator::Education < CGen::Generator::BasicGenerator
+class CurriculumGenerator::Generator::Education < CurriculumGenerator::Generator::BasicGenerator
 
   def initialize(param, data, lang)
     super(param, data, lang)

data/lib/{cgen → curriculum-generator}/generator/specific/self_assessment.rb

@@ -1,4 +1,4 @@
-class CGen::Generator::SelfAssessment < CGen::Generator::BasicGenerator
+class CurriculumGenerator::Generator::SelfAssessment < CurriculumGenerator::Generator::BasicGenerator
 
   def initialize(param, data, lang)
     super(param, data, lang)

data/lib/{cgen → curriculum-generator}/generator/specific/work_experience.rb

@@ -1,4 +1,4 @@
-class CGen::Generator::WorkExperience < CGen::Generator::BasicGenerator
+class CurriculumGenerator::Generator::WorkExperience < CurriculumGenerator::Generator::BasicGenerator
 
   def initialize(param, data, lang)
     super(param, data, lang)

data/lib/curriculum-generator/util.rb

@@ -0,0 +1,4 @@
+# Require all of the data loaders
+Dir.glob(File.join(File.dirname(__FILE__), "util/*.rb")) do |mod|
+  require(mod)
+end

data/lib/{cgen → curriculum-generator}/util/latex_to_pdf.rb

@@ -1,4 +1,4 @@
-class CGen::Util::LatexToPdf
+class CurriculumGenerator::Util::LatexToPdf
 
   def initialize(
       input_file_name, input_dir, resources_pths, out_dir, log_file,
@@ -20,9 +20,9 @@ class CGen::Util::LatexToPdf
     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)
+    gen_pdf_cmd = CurriculumGenerator::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)
+    gen_bib_cmd = CurriculumGenerator::Util::ShellCommand.new(get_bibtex_cmd, @out_dir, @log_file)
 
     Either.chain do
       bind -> { gen_pdf_cmd.run }

data/lib/{cgen → curriculum-generator}/util/logging.rb

@@ -1,4 +1,4 @@
-module CGen::Util::Logging
+module CurriculumGenerator::Util::Logging
 
   def self.log(name, opts={})
     case name

data/lib/{cgen → curriculum-generator}/util/shell_command.rb

@@ -1,4 +1,4 @@
-class CGen::Util::ShellCommand
+class CurriculumGenerator::Util::ShellCommand
 
   def initialize(command, execution_dir, log_file=nil)
     @command = command
@@ -7,7 +7,7 @@ class CGen::Util::ShellCommand
   end
 
   def run
-    CGen::Util::Logging.log(:executing_command, cmd: @command, exec_dir: @execution_dir, log_file: @log_file)
+    CurriculumGenerator::Util::Logging.log(:executing_command, cmd: @command, exec_dir: @execution_dir, log_file: @log_file)
 
     status = true
 

data/lib/curriculum-generator/version.rb

@@ -0,0 +1,6 @@
+module CurriculumGenerator
+
+  # This is the current version of `CurriculumGenerator`.
+  VERSION = "1.0.5"
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: curriculum-generator
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors:
 - Alessandro Molari
@@ -126,7 +126,7 @@ description:
 email:
 - molari.alessandro@gmail.com
 executables:
-- cgen
+- curriculum-generator
 extensions: []
 extra_rdoc_files: []
 files:
@@ -136,40 +136,40 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/cgen
-- cgen.gemspec
-- lib/cgen.rb
-- lib/cgen/compiler.rb
-- lib/cgen/curriculum.rb
-- lib/cgen/data_loader.rb
-- lib/cgen/data_loader/yaml_data_loader.rb
-- lib/cgen/generator.rb
-- lib/cgen/generator/basic_generator.rb
-- lib/cgen/generator/cv_column.rb
-- lib/cgen/generator/cv_double_item.rb
-- lib/cgen/generator/cv_entry.rb
-- lib/cgen/generator/cv_item.rb
-- lib/cgen/generator/cv_item_with_comment.rb
-- lib/cgen/generator/cv_list_double_item.rb
-- lib/cgen/generator/cv_list_item.rb
-- lib/cgen/generator/list.rb
-- lib/cgen/generator/macro_substitution.rb
-- lib/cgen/generator/specific/education.rb
-- lib/cgen/generator/specific/self_assessment.rb
-- lib/cgen/generator/specific/work_experience.rb
-- lib/cgen/util.rb
-- lib/cgen/util/latex_to_pdf.rb
-- lib/cgen/util/logging.rb
-- lib/cgen/util/shell_command.rb
-- lib/cgen/version.rb
+- bin/curriculum-generator
+- curriculum-generator.gemspec
+- lib/curriculum-generator.rb
+- lib/curriculum-generator/compiler.rb
+- lib/curriculum-generator/curriculum.rb
+- lib/curriculum-generator/data_loader.rb
+- lib/curriculum-generator/data_loader/yaml_data_loader.rb
+- lib/curriculum-generator/generator.rb
+- lib/curriculum-generator/generator/basic_generator.rb
+- lib/curriculum-generator/generator/cv_column.rb
+- lib/curriculum-generator/generator/cv_double_item.rb
+- lib/curriculum-generator/generator/cv_entry.rb
+- lib/curriculum-generator/generator/cv_item.rb
+- lib/curriculum-generator/generator/cv_item_with_comment.rb
+- lib/curriculum-generator/generator/cv_list_double_item.rb
+- lib/curriculum-generator/generator/cv_list_item.rb
+- lib/curriculum-generator/generator/list.rb
+- lib/curriculum-generator/generator/macro_substitution.rb
+- lib/curriculum-generator/generator/specific/education.rb
+- lib/curriculum-generator/generator/specific/self_assessment.rb
+- lib/curriculum-generator/generator/specific/work_experience.rb
+- lib/curriculum-generator/util.rb
+- lib/curriculum-generator/util/latex_to_pdf.rb
+- lib/curriculum-generator/util/logging.rb
+- lib/curriculum-generator/util/shell_command.rb
+- lib/curriculum-generator/version.rb
 - static/bundled_templates/moderncv/.gitkeep
 - static/bundled_templates/moderncv/deps.yml
 - static/bundled_templates/moderncv/main.tex
 - static/bundled_templates/moderncv/publications.bib
 - static/bundled_templates/moderncv/resources/AuthorPhoto.png
-homepage: http://github.com/alem0lars/cgen
+homepage: http://github.com/alem0lars/curriculum-generator
 licenses:
-- Apache 2
+- Apache v2.0
 metadata: {}
 post_install_message: 
 rdoc_options: []

data/cgen.gemspec

@@ -1,35 +0,0 @@
-# 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/lib/cgen.rb

@@ -1,27 +0,0 @@
-# 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

@@ -1,96 +0,0 @@
-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

@@ -1,58 +0,0 @@
-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: '.green + langs.join(' ').light_black
-
-    # TODO: Refactor into monads, with better error detection
-    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.rb

@@ -1,6 +0,0 @@
-# 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.rb

@@ -1,10 +0,0 @@
-# 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/generator/basic_generator.rb

@@ -1,37 +0,0 @@
-# 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

@@ -1,32 +0,0 @@
-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

@@ -1,42 +0,0 @@
-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

@@ -1,33 +0,0 @@
-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

@@ -1,29 +0,0 @@
-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

data/lib/cgen/util.rb

@@ -1,6 +0,0 @@
-# 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

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