xmlresume2x 0.2.0

data/README

@@ -0,0 +1,57 @@
+xmlresume2x: converts an xml resume to various output formats
+
+Copyright (C) 2004 Thomas Leitner
+
+= Description
+
+The "XML Resume Library" at http://xmlresume.sourceforge.net provides a way for storing one's resume
+data in a consistent way. The XML r�sum� can be transformed to various output formats, including
+text, HTML and PDF by utilizing XSLT.
+
+I came across the European Curriculum Vitae format at http://www.cedefop.eu.int/transparency/cv.asp
+which provides a standard for CVs in Europe. Nicola Vitacolonna has used this information to provide
+a LaTeX class - europecv (http://www.ctan.org/tex-archive/help/Catalogue/entries/europecv.html) -
+which (nearly) conforms to this standard. As the XML R�sum� Library does not have a converter for
+this, I wrote this program to convert an XML r�sum� to a LaTeX file which uses the europecv class.
+
+During the development process I realized that it would be useful to add support for other output
+formats. Therefore I changed the conversion process to use configuration files so that this program
+can be used to transform a r�sum� to any output format.
+
+= Dependencies
+
+No Ruby dependencies but if you want to convert the resulting LaTeX file to a PDF file, you need to
+have LaTeX and the europecv class installed.
+
+= Installation
+
+ $ ruby setup.rb config
+ $ ruby setup.rb setup
+ $ ruby setup.rb install
+
+Or you could use Rake and substitute the above commands with this:
+ $ rake install
+
+Or you could use the RPA way:
+ $ rpa install xmlresume2x
+
+Or you could use the RubyGem way:
+ $ gem install xmlresume2x
+
+= Documentation
+
+The documentation is located in the "doc/output" directory and has to be generated with webgen
+(http://webgen.rubyforge.org) by issuing the command <code>rake doc</code>. If you do not want to do
+this, you can still view the whole documentation for the latest version at
+http://xmlresume2x.rubyforge.org.
+
+= Example
+
+Example files are provided in the "testfiles" directory.
+
+= Contact
+
+Author: Thomas Leitner
+* Web: xmlresume2x.rubyforge.org
+* e-Mail: t_leitner@gmx.at
+* GPG Key-Id: 0xD942E7F6

data/Rakefile

@@ -0,0 +1,275 @@
+# -*- ruby -*-
+#
+# $Id$
+#
+# xmlresume2x: converts an xml resume to various output formats
+# Copyright (C) 2004 Thomas Leitner
+#
+# This program is free software; you can redistribute it and/or modify it under the terms of the GNU
+# General Public License as published by the Free Software Foundation; either version 2 of the
+# License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
+# even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+# General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along with this program; if not,
+# write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+#
+
+
+begin
+  require 'rubygems'
+  require 'rake/gempackagetask'
+rescue Exception
+  nil
+end
+
+require 'rake/clean'
+require 'rake/packagetask'
+require 'rake/rdoctask'
+require 'rake/testtask'
+
+# General actions  ##############################################################
+
+$:.push "lib"
+require 'xmlresume2x/converter'
+
+PKG_NAME = "xmlresume2x"
+PKG_VERSION = XMLResume2x::VERSION.join( '.' )
+PKG_FULLNAME = PKG_NAME + "-" + PKG_VERSION
+PKG_SUMMARY = "Converts an xml resume to various output formats"
+PKG_DESCRIPTION = "xmlresume2x can convert CVs written in the XML Resume
+Library format (http://xmlresume.sourceforge.net) to a number
+of formats, including LaTeX markup which uses the europecv
+(http://www.ctan.org/tex-archive/help/Catalogue/entries/europecv.html)
+class which is based on the 'standard' European Curriculum Vitae
+format at http://www.cedefop.eu.int/transparency/cv.asp."
+
+SRC_RB = FileList['lib/**/*.rb', 'bin/**/*', 'data/**/*.cfg']
+
+# The default task is run if rake is given no explicit arguments.
+
+desc "Default Task"
+task :default => :version
+
+
+# End user tasks ################################################################
+
+desc "Prepares for installation"
+task :prepare do
+  ruby "setup.rb config"
+  ruby "setup.rb setup"
+end
+
+
+desc "Installs the package #{PKG_NAME}"
+task :install => [:prepare] do
+  ruby "setup.rb install"
+end
+
+
+task :clean do
+  ruby "setup.rb clean"
+end
+
+
+CLOBBER << "doc/output" << FileList['texput.*'].to_a
+desc "Builds the documentation (needs webgen and LaTeX with latex-europecv package installed)"
+task :doc => [:rdoc, :gen_version] do
+  chdir "doc" do
+    sh "webgen -V 3"
+  end
+  ruby "-Ilib bin/xmlresume2x -d data/xmlresume2x -f xhtml -l en testfiles/example1.xml > doc/output/examples/example1.html"
+  ruby "-Ilib bin/xmlresume2x -d data/xmlresume2x -f xhtml -l en testfiles/example2.xml > doc/output/examples/example2.html"
+  ruby "-Ilib bin/xmlresume2x -d data/xmlresume2x -f latex-europecv -l en testfiles/example1.xml | latex"
+  sh "dvipdf texput.dvi doc/output/examples/example1.pdf"
+  ruby "-Ilib bin/xmlresume2x -d data/xmlresume2x -f latex-europecv -l en testfiles/example2.xml | latex"
+  sh "dvipdf texput.dvi doc/output/examples/example2.pdf"
+  sh "cp testfiles/example*.xml doc/output/examples"
+end
+
+rd = Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'doc/output/rdoc'
+  rdoc.title    = PKG_NAME
+  rdoc.options << '--line-numbers' << '--inline-source' << '-m README'
+  rdoc.rdoc_files.include( 'README' )
+  rdoc.rdoc_files.include( 'lib/**/*.rb' )
+end
+
+# Developer tasks ##############################################################
+
+PKG_FILES = FileList.new( [
+                            'setup.rb',
+                            'TODO',
+                            'COPYING',
+                            'README',
+                            'Rakefile',
+                            'ChangeLog',
+                            'VERSION',
+                            'install.rb',
+                            'bin/**/*',
+                            'lib/**/*.rb',
+                            'doc/**/*',
+                            'test/**/*',
+                            'data/**/*'
+                          ]) do |fl|
+  fl.exclude( /\bsvn\b/ )
+  fl.exclude( 'doc/output' )
+end
+
+task :package => [:gen_files] do
+  chdir 'pkg' do
+    sh "rpaadmin packport #{PKG_NAME}-#{PKG_VERSION}"
+  end
+end
+
+task :gen_changelog do
+  sh "svn log -r HEAD:1 -v > ChangeLog"
+end
+
+task :gen_version do
+  puts "Generating VERSION file"
+  File.open( 'VERSION', 'w+' ) do |file| file.write( PKG_VERSION + "\n" ) end
+end
+
+task :gen_installrb do
+  puts "Generating install.rb file"
+  File.open( 'install.rb', 'w+' ) do |file|
+    file.write "
+require 'rpa/install'
+
+class Install_#{PKG_NAME} < RPA::Install::FullInstaller
+  name '#{PKG_NAME}'
+  version '#{PKG_VERSION}-1'
+  classification Application
+  build do
+    installdocs %w[COPYING ChangeLog TODO]
+    installdocs 'docs'
+    installrdoc %w[README] + Dir['lib/**/*.rb']
+    installdata
+  end
+  description <<-EOF
+#{PKG_SUMMARY}
+
+#{PKG_DESCRIPTION}
+  EOF
+end
+"
+    end
+end
+
+task :gen_files => [:gen_changelog, :gen_version, :gen_installrb]
+CLOBBER << "ChangeLog" << "VERSION" << "install.rb"
+
+Rake::PackageTask.new( PKG_NAME, PKG_VERSION ) do |p|
+  p.need_tar = true
+  p.need_zip = true
+  p.package_files = PKG_FILES
+end
+
+if defined? Gem
+  spec = Gem::Specification.new do |s|
+
+    #### Basic information
+
+    s.name = PKG_NAME
+    s.version = PKG_VERSION
+    s.summary = PKG_SUMMARY
+    s.description = PKG_DESCRIPTION
+
+    #### Dependencies, requirements and files
+
+    s.files = PKG_FILES.to_a
+
+    s.require_path = 'lib'
+    s.autorequire = nil
+    s.executables = ['xmlresume2x']
+    s.default_executable = 'xmlresume2x'
+
+    #### Documentation
+
+    s.has_rdoc = true
+    s.extra_rdoc_files = rd.rdoc_files.reject do |fn| fn =~ /\.rb$/ end.to_a
+    s.rdoc_options = ['--line-numbers', '-m README']
+
+    #### Author and project details
+
+    s.author = "Thomas Leitner"
+    s.email = "t_leitner@gmx.at"
+    s.homepage = "xmlresume2x.rubyforge.org"
+    s.rubyforge_project = "xmlresume2x"
+  end
+
+  Rake::GemPackageTask.new( spec ) do |pkg|
+    pkg.need_zip = true
+    pkg.need_tar = true
+  end
+end
+
+
+desc "Creates a tag in the repository"
+task :tag do
+  repositoryPath = File.dirname( $1 ) if `svn info` =~ /^URL: (.*)$/
+  fail "Tag already created in repository " if /#{PKG_FULLNAME}/ =~ `svn ls #{repositoryPath}/versions`
+  sh "svn cp -m 'Created version #{PKG_FULLNAME}' #{repositoryPath}/trunk #{repositoryPath}/versions/#{PKG_FULLNAME}"
+end
+
+desc "Upload documentation to homepage"
+task :uploaddoc => [:doc] do
+  Dir.chdir('doc/output')
+  sh "scp -r * gettalong@rubyforge.org:/var/www/gforge-projects/#{PKG_NAME}/"
+end
+
+
+# Misc tasks ###################################################################
+
+
+def count_lines( filename )
+  lines = 0
+  codelines = 0
+  open( filename ) do |f|
+    f.each do |line|
+      lines += 1
+      next if line =~ /^\s*$/
+      next if line =~ /^\s*#/
+      codelines += 1
+    end
+  end
+  [lines, codelines]
+end
+
+
+def show_line( msg, lines, loc )
+  printf "%6s %6s   %s\n", lines.to_s, loc.to_s, msg
+end
+
+desc "Show statistics"
+task :statistics do
+  total_lines = 0
+  total_code = 0
+  show_line( "File Name", "Lines", "LOC" )
+  SRC_RB.each do |fn|
+    lines, codelines = count_lines fn
+    show_line( fn, lines, codelines )
+    total_lines += lines
+    total_code  += codelines
+  end
+  show_line( "Total", total_lines, total_code )
+end
+
+
+desc "Show unprocessed elements"
+task :missing do
+  require 'set'
+  elements = File.read( 'misc/dtd/resume.dtd' ).scan( /^(<!ELEMENT\s)(\w+)\s(?!\(#PCDATA\))/ ).collect {|i| i[1]}.to_set
+  Dir['data/xmlresume2x/format/*.cfg'].each do |file|
+    processor = XMLResume2x::ResumeProcessor.new( 'en' )
+    processor.load_config( File.read( file ) )
+    processed = processor.assignments.keys
+    e = elements.dup
+    e.subtract( processed )
+    puts "Missing elements for format file #{file}:"
+    puts e.to_a.sort.join( ", " )
+  end
+end

data/TODO

@@ -0,0 +1,37 @@
+* add some css files to distribution
+* add TOC-menu to xhtml format
+* generalize formating of publications, look at pub.xsl
+* add support for multiple pubs, memberships, ...???
+* most words in lang files should be lowercase, config files should capitalize words correctly
+* add Spanish and Esperanto language support
+* add output filter for text (use Text::Format)
+
+---- FINISHED ----
+
+* add OptionParser for reading in template and xml file
+* add 'calculated' stub
+* add basic ERB functionality so that the template can be translated
+* combine Element2Latex and Text2Latex as they process text parts (%inlines; or #PCDATA)
+* combine Text2Latex and CalculatedEntries and use uniform interface
+* refactor Text2Latex (ev. use subclasses, ie. base class Element, then AddressElement, LocationElement, ...)
+* think about moving the formatting of the calculated parts to a YAML file
+* add calculated items for period, periodOrDate
+* add more element processors to configuration file (move most of the processing to the configuration file)
+* add more blocks to the template file
+* BUG: whitespace should be squeezed sometimes and sometimes not (ie. always in para, not in address...)
+* externalize strings for i18n
+* change name of program to xmlresume2x
+* make a list of all processed and not processed elements (put it into Rakefile)
+* add processors for the rest of the xml resume dtd
+* add "free form" output for addresses (i.e. convert \n to \newline{} but only here, not everywhere!)
+* BUG: list for membership, referees, awards,...
+* BUG: two history sections result in two "Employment History" captions, same with academics, pubs,...
+* BUG: latex output has to be in latin1 format, how to convert?
+* finish LaTeX output
+* incorporate changed install.rb for RPA from Mauricio
+* add French
+* make RubyGems version by using information/code supplied at ruby-talk by Mauricio
+* provide Array#separate_by( normal, last ) for use with major/minor list
+* provide sample output on homepage for test r�sum�s
+* BUG: iconv not available on windows -> use other tool (eventually #pack and #unpack)
+* add output filter for HTML

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/bin/xmlresume2x

@@ -0,0 +1,57 @@
+#!/usr/bin/env ruby
+#
+# $Id: xmlresume2europecv.rb 6 2004-10-14 10:36:22Z thomas $
+#
+# xmlresume2europecv: converts an xml resume to a europecv LaTeX file
+# Copyright (C) 2004 Thomas Leitner
+#
+# This program is free software; you can redistribute it and/or modify it under the terms of the GNU
+# General Public License as published by the Free Software Foundation; either version 2 of the
+# License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
+# even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+# General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along with this program; if not,
+# write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+#
+
+require 'optparse'
+require 'ostruct'
+require 'xmlresume2x/converter'
+
+converter = XMLResume2x::Converter.new
+
+# Try to parse data dir independently to show correct help messages
+begin
+  OptionParser.new do |opt|
+    opt.on( "-d", "--data-dir DATADIR" ) {|converter.data_dir|}
+    opt.on( "-h", "--help" ) {}
+    opt.on( "-v", "--version" ) {}
+  end.permute( ARGV )
+rescue OptionParser::ParseError
+end
+
+options = OpenStruct.new
+
+opt = OptionParser.new do |opt|
+  opt.banner = "Usage: xmlresume2x [options] RESUME.XML "
+  opt.separator "Options:"
+  opt.separator ""
+  opt.on( "-f", "--format FORMAT", converter.available_formats, "Use FORMAT as the output format (#{converter.available_formats.join(', ')})" ) {|options.format|}
+  opt.on( "-l", "--lang LANG", converter.available_langs, "Use LANG as the resume language (#{converter.available_langs.join(', ')})" ) {|options.language|}
+  opt.on( "-c", "--config CONFIG", "Use CONFIG as additional configuration file (can be used to override default behaviour)" ) {|options.userconfig|}
+  opt.on( "-d", "--data-dir DATADIR", "Use the directory DATADIR as data directory" ) {|converter.data_dir|}
+  opt.on( "-h", "--help" ) { puts opt; exit 1}
+end
+
+files = opt.permute( ARGV )
+raise OptionParser::NeedlessArgument.new( *files[1..-1] ) if files.length > 1
+if options.format.nil? || options.language.nil?
+  $stderr.puts "Error: You need to specify the FORMAT and the LANGUAGE!!!"
+  $stderr.puts opt;
+  exit 1
+end
+converter.load_config( options.format, options.language, options.userconfig )
+puts converter.convert( files[0] )

data/data/xmlresume2x/common/common.cfg

@@ -0,0 +1,154 @@
+# Common configuration for the resume converter -*- ruby -*-
+# - Includes assignments for simple processors
+# - Includes common processors for
+#   - name, location, present, date, from, to, period, birth
+#   - address
+#   - contact
+
+#####################################################
+# Assignments for simple processors
+
+add_processor 'DefaultProcessor' do |element|
+  element.process_children!
+end
+
+processor ['description', 'note', 'misc', 'legalnotice', 'objective'] => 'SubParaProcessor'
+
+processor ['achievement', 'artTitle', 'bookTitle', 'employer', 'institution',
+           'organization', 'para', 'publisher', 'skill'] => 'DefaultProcessor'
+
+
+#####################################################
+# Name, location, ... processors
+
+processor 'name' => 'NameProcessor' do |n|
+  [n.title, n.firstname, (n.middlenames.join(' ') if n.middlenames), n.surname, n.suffix].compact.join( ' ' )
+end
+
+processor 'location' => 'LocationProcessor' do |l|
+  [l.city, l.state, l.province, l.county, l.country].compact.join( ', ' )
+end
+
+processor 'present' => 'PresentProcessor' do |present|
+  keyword( :Present )
+end
+
+processor 'date' => 'DateProcessor' do |date|
+  day = (date.dayOfMonth.nil? ? '' :  "#{date.dayOfMonth}. ")
+  month = (date.month.nil? ? '' : "#{date.month} ")
+  "#{day}#{month}#{date.year}"
+end
+
+processor ['from', 'to'] => 'FromToProcessor' do |element|
+  [element.date, element.present].compact.join( '' )
+end
+
+processor 'birth' => 'BirthProcessor' do |birth|
+  birth.date
+end
+
+
+#####################################################
+# Address processor and help methods
+#
+# !You have to define the newline method before using this address processor!
+
+def cityDivision( address )
+  address.suburb || address.ward
+end
+
+def adminDivision( address )
+  address.state || address.province || address.county
+end
+
+def postCode( address )
+  address.zip || address.postalCode
+end
+
+def formatStandardAddress( address )
+  arr = []
+  arr << address.street.join( newline ) << newline if address.street
+  arr << cityDivision( address ).to_s << newline if cityDivision( address )
+  arr << address.city.to_s
+  arr << ", #{adminDivision( address )}" if adminDivision( address )
+  arr << " #{postCode( address )}" if postCode( address )
+  arr << newline
+  arr << address.country.to_s
+  arr
+end
+
+def formatEuropeanAddress( address )
+  arr = []
+  arr << address.street.join( newline ) << newline if address.street
+  arr << cityDivision( address ).to_s << newline if cityDivision( address )
+  arr << "#{postCode( address )} " if postCode( address )
+  arr << address.city.to_s
+  arr << newline << adminDivision( address ).to_s if adminDivision( address )
+  arr << newline
+  arr << address.country.to_s
+  arr
+end
+
+def formatItalianAddress( address )
+  arr = []
+  arr << address.street.join( newline ) << newline if address.street
+  arr << "#{address.postalCode} " if address.postalCode
+  arr << address.city.to_s
+  arr << " (#{address.province})" if address.province
+  arr << newline
+  arr << address.country.to_s
+  arr
+end
+
+processor 'address' => 'AddressProcessor' do |address|
+  if address.__element.has_elements?
+    format = address._format.nil? ? 'standard' : address._format
+    send( "format#{format.capitalize}Address", address )
+  else
+    get_children_value( address, :verbatim => true )
+  end
+end
+
+
+#####################################################
+# Contact processor and help methods
+
+def phone_location( location )
+  case location
+  when 'home' then keyword( :Phone_Home )
+  when 'work' then keyword( :Phone_Work )
+  when 'mobile' then keyword( :Phone_Mobile )
+  else location.nil? ? keyword( :Phone ) : location
+  end
+end
+
+def fax_location( location )
+  case location
+  when 'home' then keyword( :Fax_Home )
+  when 'work' then keyword( :Fax_Work )
+  else location.nil? ? keyword( :Fax ) : location
+  end
+end
+
+def im_service( service )
+  case service
+  when 'aim' then keyword( :IM_Aim )
+  when 'icq' then keyword( :IM_Icq )
+  when 'irc' then keyword( :IM_Irc )
+  when 'jabber' then keyword( :IM_Jabber )
+  when 'msn' then keyword( :IM_Msn )
+  when 'yahoo' then keyword( :IM_Yahoo )
+  else service.nil? ? '' : service
+  end
+end
+
+processor 'contact' => 'ContactProcessor' do |contact|
+  arr = []
+  arr << contact.phone.collect {|phone| ["#{phone_location(phone._location)}: ", phone] }.join( newline ) if contact.phone
+  arr << newline << contact.fax.collect {|fax| ["#{fax_location(fax._location)}: ", fax] }.join( newline ) if contact.fax
+  arr << newline << contact.pager.collect {|pager| ["#{keyword(:Pager)}: ", pager] }.join( newline ) if contact.pager
+  arr << newline << contact.email.collect {|email| ["#{keyword(:Email)}: ", email] }.join( newline ) if contact.email
+  arr << newline << contact.url.collect {|url| ["#{keyword(:Url)}: ", url] }.join( newline ) if contact.url
+  arr << newline << contact.instantMessage.collect {|im| ["#{im_service(im._service)}: ", im] }.join( newline ) if contact.instantMessage
+  arr
+end