YAMLによる履歴書作成スクリプト

YAML形式で書かれたデータファイルと、YAMLもしくはテキストファイル形式で書かれたスタイルから履歴書PDFファイルを作成するRubyスクリプトです。

必要なライブラリ等

Prawn
IAPexフォント

Prawnから日本語を出力するためにIPAexフォントを使っています。スクリプトと同じ場所にfontsディレクトリを用意して、ここからフォントをダウンロードして以下のように配置してください。

├── fonts
│   ├── ipaexg.ttf
│   └── ipaexm.ttf
└── make_cv.rb

使い方

以下のように、-iに続けてデータファイル、-sに続けてスタイルファイル、-oに続けて出力ファイルを指定します。省略した場合のデフォルトはそれぞれdata.yaml、style.yaml、output.pdfです。

$ ruby make_cv -h
Usage: make_cv [options]
    -i, --input [datafile]
    -s, --style [stylefile]
    -o, --output [output]

YAML形式のデータファイル(例:data.yaml)とスタイルファイル(例:style.yaml)を用意し、スクリプトを以下のように実行します。

$ ruby make_cv -i data.yaml -s style.yaml -o output.pdf

添付のサンプルでは以下のような出力が得られます。

PDFファイル

また、スタイルファイルを変えることで、同じデータファイルから異なる出力を得られます。以下はアカデミックポスト向けのスタイルファイルacademic.txtを使った場合です。

$ ruby make_cv -i data.yaml -s academic.txt -o academic.pdf

PDFファイル

データの用意の仕方

データはYAML形式で用意します。

以下はサンプルのdata.yamlの一部です。

# 名前等
date: 2018年 6月 5日現在
name_kana: りれきしょ かくたろう
name: 履歴書 書太郎
birth_day: 1543年1月31日 (満 73 歳)
gender: 男
cell_phone: 090-1234-5678
email: hoge@hogehoge.org
photo: photo.jpg

# 住所
address_kana: とうきょうとちよだくちよだ
address: 東京都千代田区千代田1-1-1
address_zip: 100-0001
tel: 0120-000-XXX
fax: 0120-111-XXX
# 連絡先
address_kana2: ほっかいどう わっかないし そうやみさき
address2: 北海道稚内市宗谷岬
address_zip2: 098-6758
tel2: 0120-222-XXX
fax2: 0120-333-XXX

例えば、写真がphoto.jpgとして用意してある場合、

photo: photo.jpg

とすれば写真が貼られます。もし写真ファイルを指定しなかった場合、例えば

# photo: photo.jpg

としてコメントアウトすると、写真部分は

のような出力になります。

スタイルファイル(テキスト形式)

履歴書のスタイルファイルは、YAML形式とTXT形式の二種類があります。テキスト形式では、線は文字列などを、一行に一要素ずつ記述していきます。例えばacademic.txtは以下のような内容になっています。

# ヘッダー
string,5mm,247mm,履 歴 書,font_size=14,font_face=gothic
string,110mm,245mm,$date,font_size=9

# 住所・連絡先等
box,145mm,204mm,30mm,40mm,line_style=dashed
string,148mm,240mm,写真を貼る位置,font_size=9
string,147mm,233mm,1. 縦36〜40 mm,font_size=8
string,150mm,230mm,横24〜30 mm,font_size=8
string,147mm,227mm,2. 本人単身胸から上,font_size=8
string,147mm,224mm,3. 裏面にのりづけ,font_size=8
string,147mm,221mm,4. 裏面に氏名記入,font_size=8

一行目の

string,5mm,247mm,履 歴 書,font_size=14,font_face=gothic

は、(5mm,247mm)の位置に「履歴書」という文字を、フォントサイズ14で、フォントはゴシックで記述する命令です。このうち必須なのは座標と文字列ですが、その後にオプションとしてフォントサイズやフォントの指定ができます。

次の行の

string,110mm,245mm,$date,font_size=9

も同様に(110mm, 245mm)の位置に文字列を出力する命令ですが、出力する文字列が$dateとなっています。これは、データファイルのdata要素に置換されます。今、データファイルは

date: 2018年 6月 5日現在

とあるので、

string,110mm,245mm,$date,font_size=9

は

string,110mm,245mm,2018年 6月 5日現在,font_size=9

に展開されます。

テキスト形式の命令リストは以下の通りです。

命令	フォーマット	説明
string	string, x, y, value[,font options]	(x,y)に文字列valueを出力
line	line, x, y, dx, dy[,line options]	(x,y)から(x+dx, y+dy)に線を描画
box	box,x,y,width,height[,line options]	(x,y)に指定された幅と高さのボックスを描画
photo	photo, x, y, width, height	指定位置、サイズに写真ファイル`$photo`を描画
new_page	new_page	改ページ
textbox	textbox,x,y,width,height,value[,font options]	指定位置、サイズにテキストボックスを描画
multi_lines	multi_lines, x,y,dx,dy,num,sx,sy	(x,y)から、(dx,dy)方向に、毎回(sx,sy)だけ座標をずらしながらnum回線を引きます

特別な命令

history

年、月、内容をともなったデータを描画する命令です。

history, y, year_x, month_x, value_x, dy, value[,font options]

y: 描画を始めるy座標
year_x, month_x, value_x: それぞれ年、月、内容を書くx座標
dy: 改行時にどれだけ下に下げるか
value: 内容

history環境に使われるデータは以下のように指定します。

licences:
  -
    year: 19XX
    month: 11
    value: 普通自動車免許
  -
    year: 20XX
    month: 11
    value: 履歴書検定1級

yearやmonthは省略可能です(空白になります)。

education_experience

学歴、職歴を書く命令です。命令フォーマットは以下の通りです。

education_experience, y, year_x, month_x, value_x, dy, caption_x, ijo_x, [,font options]

y: 描画を始めるy座標
year_x, month_x, value_x: それぞれ年、月、内容を書くx座標
dy: 改行時にどれだけ下に下げるか
caption_x: 「学歴」や「職歴」の文字のx座標
ijo_x: 「以上」の文字のx座標

なお、学歴データは$educationが、職歴データは $experience$ が仮定されます。

lines

複数の線を書く命令です。履歴書によくある右上が凹んだボックスを書くために用意してあります。命令フォーマットは以下の通りです。

lines, num, x,y, dx, dy, ..., [,line options]

最初に「何個の点データがあるか」をnumで指定します。その後、始点、次の点の相対座標・・・と続け、最後に線のオプションを指定します。なお、この命令だけのオプションとして「close」というものがあります。これを指定すると最後に線を閉じます。

スタイルファイル(YAML形式)

スタイルファイルはYAML形式でも書くことができますが、実際やってみたら死ぬほど面倒だったので、通常は(そんな奇特な人がいるとしても)テキストで書くことになろうかと思います。テキスト形式のスタイルファイルはtxt2yaml.rbでYAML形式に変換できます。

例えば

string,5mm,247mm,履 歴 書,font_size=14,font_face=gothic
string,110mm,245mm,$date,font_size=9

をtxt2yaml.rbに食わせると、

---
- type: string
  x: 5mm
  y: 247mm
  value: 履 歴 書
  font_size: '14'
  font_face: gothic
- type: string
  x: 110mm
  y: 245mm
  value: "$date"
  font_size: '9'

が出力されます。同様にYAMLで書かれたスタイルファイルはyaml2txt.rbでテキスト形式に変換できます。

参考

このスクリプトは、PruneMazuiさんのresume-makerに影響されて開発したものです。

masa-kunikata / yaml_cv