nDiki : プリティプリンタ

第1回 社内 Perl 勉強会

この間教材として選定した「初めてのPerl 第3版」を使って第1回目の社内 Perl 勉強会を実施した。

プログラミングのクラスなんて大学(および TA)以来なので、進め方は手探りである。 まずは以下の様にしてみた。

目的

Perl プログラミング、および一般的なプログラミング・開発のスキルアップを目指す。

進め方

• 私が進行役。
• 自由参加 (私の指定プロジェクトメンバは必須)。プログラマでも、コンテンツデザイナーでも。
• 書籍「初めての Perl 第3版」を教材とする。
  • 本は社内に1冊ある。ケンカしないでうまく回して読むように。
• 1週間に1章ずつ進める (最初の回は1・2章)。
• 各自事前に独習すること。業務の支障にならない範囲でうまく進めること。
• 章末の練習問題を課題とし、勉強会の前に解答を作成してみること (書籍末に回答があるが見ないようにすること)。
• 独習の上でわからない点は適宜、誰かに質問してできるだけ解決をはかること。

勉強会

• 毎週金曜日に勉強会を 16:00 - 17:00 で開催。
• 練習問題の解答ピアレビューを中心に行う。その場で本読みはしない。
• 課題がプログラムの場合は、プリントアウトして持参すること (あまりに長い場合はのぞく)。
• 参加希望者は事前に 社内 WikiPage に、参加意思を表明すること。
• 練習問題別に、チェック項目や補足情報を追加した資料を開始時に配付。

実施

第1回は私を含めて6人による勉強会となった。

プログラミングを学ぶのはやはり実践が一番であるので、事前に練習問題に取り組むというスタイルにしてみた。勉強会では他人のコードを見たり意見交換したりすることで理解を深め新しい発見ができればと考えている。

皆それぞれの業務を抱えているので、忙がしい人については事前の課題取り組みについては厳しのではとの不安もあったが、初級者・中級者にかかわらず全員準備してきていた。 びっくりするとともに嬉しかった。 参加者は皆それぞれチャレンジ心を持ち、何かを得ようとという熱意があるようで素晴しい限りである。

今回は練習問題も簡単だということもあり、全員解答できたようである。 今回気がついた点:

• プログラムのプリントアウトについては以下のようにするのが望ましい。
  • プログラム毎にプリントアウトを分ける (1枚に複数のプログラムを掲載しているとレビューしにくい)。
  • フォントは適度な大きさで (小さいと見づらい)。
  • 今後プログラムが長くなってきた時のために、行番号を入れるのが望ましい。
  • 可能ならばプリティプリンティグを (皆にツールを紹介する必要あり)。
  • 今回は皆1セットづつしかプリントアウトしてこなかったが、これだと皆でレビューしにくい。人数分プリントアウトしてしまった方が効果的ではないだろうか。他人のプログラムで興味深いものは持ち帰りたいし。その場合はプログラムの先頭にコメントで問題番号と作成者を書いてもらうのが良いだろう。
• そういえば書籍末の正解の確認をしなかった。今後問題が難しくなってきたら確認した方がいいかもしれない。
• 教材の本は予算で買った1冊とスタッフ私物の1冊で現在2冊。ちょっと足りないかな。もう1冊ぐらいあった方が良いかもしれない。

1時間の予定であったが10分オーバーで70分。 時間的にはこれぐらいか。90分ぐらいあった方がいいのかもしれないけれど、業務とのかねあいもあるし。

本社

そういえば今回は東京オフィスで希望者向けのものだったので特に本社には連絡しなかったんだけれど、1名ここ(nDiki)の記事を見て羨しがっていたらしい。

リモートでの参加までは考えていなかったので今回は準備できなかったけれど、希望があるならなんか方法を考えていきたい。

また来週

さて、本格的にプログラミングっぽくなってくる次回からが楽しみである。 目指せ総 Perl プログラマ化。

Emacs でお好きな言語のソースコードを色付き HTML テキストに変換

今日の Perl 勉強会向けに、自分の書いたコードをプリントアウトする。 どうせなら見易くなるように、色付けして出したいな。 でも、Perl のプリティプリンタって何があるのだろう?

調べている時間もあまり無いしどうしようかな。 あ、そういえば昔 emacs-wiki でソースコードを埋めこむ際に何か外部プリティプリンタを呼び出していたっけか。

とうことで emacs-wiki を調べてみる。するとどうも最近の emacs-wiki は htmlize.el を使って直接 HTML テキストを生成してしまっているらしい。*1

htmlize.el

ということで htmlize.el がロードされている状態で、Perl ソースコードを開いているバッファで以下を実行。

 M-x htmlize-buffer

すると新しいバッファに HTML テキストが生成される。 お、お手軽。 行番号も入れたかったのだが、残念ながらその方法は見つからず。

ソースコードに限らずハイライトされているバッファなら、その色付けでマークアップされた HTML テキストを生成できるようだ。

便利。ちょっとした時に使えそうなので覚えておこう。

Perl プリティプリンタの定番 perltidy

一昨日は時間がなかったので、Perl プログラムの色付きプリントアウト作成に Emacs の htmlize.el を使用したのだが、残念ながらこれだと Emacs を使っていない人には薦めることができない。

ということで調べたところどうやら perltidy が定番の様子。 Perl Best Practices でも紹介されているらしい。

HTML テキスト出力

ソースコードをハイライトして行番号付きの HTML テキストを生成する場合は

 perltidy -html -nnn --nohtml-entities source.pl

とする。

Emacs からの perltidy の呼び出し

perltidy の真価はソースのリフォーマットにある。 これを使用するとソースコードを統一のとれたスタイルに整えることができる。

Emacs からはリージョン選択して

 M-1 M-| perltidy

するか、http://www.emacswiki.org/.../CPerlMode で紹介されている

 (defun perltidy-region ()
   "Run perltidy on the current region."
   (interactive)
   (save-excursion
     (shell-command-on-region (point) (mark) "perltidy -q" nil t)))
 (defun perltidy-defun ()
   "Run perltidy on the current defun."
   (interactive)
   (save-excursion (mark-defun)
                   (perltidy-region)))

を .emacs などに書いておいて M-x perltidy-region することで整形することができる。

今までは CPerl mode 頼りだったけれど、これからはリポジトリにコミットする前に perltidy を通すようにしようかな。

まずは自分好みにあわせた、.perltidyrc を作成せねば。