rabbit-slide-znz-SapporoRubyKaigi2012 2012.09.15

data/.rabbit

@@ -0,0 +1 @@
+nadoka-m17n.rab

data/README.rd

@@ -0,0 +1,24 @@
+= nadoka さんの m17n 対応のベストプラクティス
+
+IRCnet の日本語チャンネルでは iso-2022-jp が使われていて、 iso-2022-jp は ascii compatible ではありません。 そのことが様々な問題を引き起こします。 その問題をどう解決したのか、 nadoka さんでの m17n 対応の最善の方法は何なのか、 ということについて話をする予定です。
+
+== 作者向け
+
+=== 表示
+
+  rake
+
+=== 公開
+
+  rake publish
+
+== 閲覧者向け
+
+=== インストール
+
+  gem install rabbit-slide--SapporoRubyKaigi2012
+
+=== 表示
+
+  rabbit rabbit-slide--SapporoRubyKaigi2012.gem
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "rabbit/task/slide"
+
+# Edit ./config.yaml to customize meta data
+
+Rabbit::Task::Slide.new do |task|
+  # task.spec.licenses = ["CC BY-SA 3.0"]
+  # task.spec.files += Dir.glob("doc/**/*.*")
+  # task.spec.files -= Dir.glob("private/**/*.*")
+  # task.spec.add_runtime_dependency("YOUR THEME")
+end

data/config.yaml

@@ -0,0 +1,17 @@
+---
+id: SapporoRubyKaigi2012
+base_name: nadoka-m17n
+tags:
+- nadoka
+- m17n
+- ruby1.9
+presentation_date: 2012/09/15
+version: 2012.09.15
+licenses: []
+author:
+  markup_language: :rd
+  name: Kazuhiro NISHIYAMA
+  email: zn@mbf.nifty.com
+  rubygems_user: znz
+  slideshare_user: znzjp
+  speaker_deck_user: 

data/nadoka-m17n.rab

@@ -0,0 +1,196 @@
+= nadoka の ruby 1.9 対応
+
+# : subtitle
+#    サブタイトル
+: author
+   西山和広
+# : institution
+#    所属
+# : content-source
+#    イベント名
+: date
+   2012/09/15
+: allotted-time
+   5m
+# : theme
+#    default
+: theme
+   lightning-simple
+
+= 自己紹介
+
+  * CRuby のコミッターのひとり
+  * https://github.com/nadoka のメンバー
+  * 大阪から来ました
+    * 札幌は涼しいかと思いきや...
+
+= IRC とは?
+
+  * インターネット経由の複数人での((*チャット*))
+    * 1対1ではない
+  * IRC = Internet Relay Chat
+  * 古くからあるのでいろいろな環境で使える
+  * Ruby の開発でも使われている
+    * IRCnet の #ruby-ja (日本語)
+    * freenode の #ruby-core (英語)
+
+= nadoka とは?
+
+  * 正式名称は nadoka さん
+  * IRC Client Server Program
+    * ((*proxy のようなもの*))
+#   * IRCサーバのクライアントプログラム(って何?)ではない
+  * plugins (bot) 対応
+
+  # image
+  # src = nadoka-safari.png
+  # relative_height = 150
+
+== blockdiag
+ {
+   Server <-> nadoka <-> Clients;
+   group {
+     orientation = portrait
+     nadoka <-> plugins
+   }
+ }
+
+= plugins (bot) の例
+
+  * 自動応答系
+    * Google 検索
+    * ((*URL からタイトル取得*))
+    * 天気情報取得
+    * 人工無能
+  * 自動発言系
+    * RSS の情報通知
+    * ((*挨拶*))
+    * 時報
+
+= ruby 1.9 での問題
+
+  * 発言がみえなかった
+  * 発言ができなかった
+  * など
+
+= ここから本題
+
+= 使用 encoding
+
+  * 日本語圏では主に以下の encoding を使用
+    * ((*IRCnet : いわゆる JIS コード (ISO-2022-JP)*))
+    * freenode : UTF-8
+  * 問題
+    * ((*valid (valid_encoding? が真) とは限らない*))
+    * クライアントの設定ミス
+    * いわゆる半角カナの扱い
+# * FULLWIDTH TILDE / WAVE DASH 問題
+# * BACKSLASH / YEN SIGN 問題
+
+= nadoka 本体への入出力
+
+  * server や client との送受信
+#   * valid な encoding とは仮定できない
+    * invalid なものもそのまま通したい
+      * ((*エラー処理は server や client に任せたい*))
+      * 文字化けの原因になりたくない
+  * 内部処理や plugins との入出力
+    * 元のバイト列そのまま
+    * ((*必要なら plugins で変換*))
+
+= nadoka 本体での扱い
+
+  * 方針 : nadoka 本体では ASCII-8BIT で扱う
+  * force_encoding(Encoding::ASCII_8BIT) で((*バイナリ文字列扱い*))
+  * 文字列の内容は((*変換しない*))
+    * ruby 1.8 との互換性も考慮したため
+
+== ログの encoding
+
+  * ログは元のバイト列そのまま保存する
+    * 無難な対応
+      * どの encoding にするのか悩まなくてすむ
+    * 問題があったときに調査しやすい
+      * どこが文字化けの原因か調べやすい
+    * 文字化けしていた時になんとかなる
+      * 設定ミスしたクライアントからの発言も (nkf とかで) がんばれば読める
+
+= plugins の encoding 問題
+
+  * encoding の扱いが
+    * plugin によってバラバラ
+    * ruby 1.8 では((*適当でも動いた*))
+  * ruby 1.9 では
+    * Encoding::CompatibilityError ((*例外頻出*))
+  * たとえば
+    * 複数回 nkf を通していたり
+    * ISO-2022-JP と正規表現マッチしていたり
+
+= plugins の encoding 方針
+
+  * ((*受信時に*))
+    * ((*一回だけ UTF-8 に変換*))
+  * ((*内部処理*))
+    * ((*UTF-8 で統一*))
+    * EUC-JP や Shift_JIS で扱っていた plugin も変更
+      * /re/e や /re/s で混在していた
+  * ((*送信時に*))
+    * ((*一回だけ server encoding に変換*))
+#   * 変換の指定方法はバラバラなまま...
+
+= 問題例 (1)
+
+  * String#force_encoding(enc) を((*定義*))
+    * self を返すだけ
+  * ruby 1.8 + 別のライブラリ (nokogiri-1.5.2) の内部で((*謎のエラー*))
+    * uninitialized constant Nokogiri::XML::Node::Encoding
+    * 実は ::Encoding を参照しようとしていた
+  * respond_to?(:force_encoding) で((*確認してから使うように変更*))
+
+= 問題例 (2)
+
+  * nadoka 本体
+    * サーバーへ送信する文字列を作成する部分
+  * チャンネル名 (ASCII-8BIT) + 発言内容 (JIS)
+    * ruby 1.8 だと気にせず結合できていた
+    * ruby 1.9 だと((*両方 ASCII only でも例外*)) Encoding::CompatibilityError
+      * ISO-2022-JP が ascii_compatible? ではないため
+  * 発言内容を force_encoding して解決
+#   * チャンネル名が ASCII only だと気付きにくい問題も事前に防げた
+
+= 問題例 (3)
+
+  * plugin からの発言例
+    * bot 名: "hello bot: "
+    * 発言内容: "こんにちは"
+  * bot名 (UTF-8) + 発言内容 (JIS)
+    * 発言内容生成時に tojis で変換済み
+    * ((*結合時に例外*)) Encoding::CompatibilityError
+    * 結合後にも tojis で変換
+      * ruby 1.8 だと nkf の自動認識で問題なし
+      * ruby 1.9 だと結合後の tojis まで来ない
+
+= 問題例 (3) の解決方法
+
+  * bot名 (UTF-8) + 発言内容 (UTF-8)
+    * 発言内容生成時には((*変換しない*))
+    * tojis で((*全体を変換*))
+    * nadoka 本体に渡す直前で((*一度だけ*))変換すべき
+
+= まとめ
+
+  * String#force_encoding を定義して((*手抜き*)) 1.8/1.9 両対応は((*不幸の元*))
+  * ISO-2022-JP が US-ASCII 互換ではないのでバグが発見できた
+  * 無駄に複数回変換しない
+  * それぞれの((*入力、出力部分だけ*))で変換すべき
+  * nkf 便利
+
+= おまけ
+
+  * trunk で動かしたら問題発生
+
+= ruby 2.0 対応
+
+  * ((*iconv*)) がなくなっている
+  * 1.8 も考慮して nkf で置き換える?
+  * String#encode にするかどうかは未定

data/nadoka.svg

@@ -0,0 +1,40 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.0//EN" "http://www.w3.org/TR/2001/REC-SVG-20010904/DTD/svg10.dtd">
+<svg viewBox="0 0 640 200" xmlns="http://www.w3.org/2000/svg" xmlns:inkspace="http://www.inkscape.org/namespaces/inkscape" xmlns:xlink="http://www.w3.org/1999/xlink">
+  <defs id="defs_block">
+    <filter height="1.504" id="filter_blur" inkspace:collect="always" width="1.1575" x="-0.07875" y="-0.252">
+      <feGaussianBlur id="feGaussianBlur3780" inkspace:collect="always" stdDeviation="4.2" />
+    </filter>
+  </defs>
+  <title>blockdiag</title>
+  <desc>{
+  Server &lt;-&gt; nadoka &lt;-&gt; Clients;
+  group {
+    orientation = portrait
+    nadoka &lt;-&gt; plugins
+  }
+}
+</desc>
+  <rect fill="rgb(243,152,0)" height="140" style="filter:url(#filter_blur)" width="144" x="248" y="30" />
+  <rect fill="rgb(0,0,0)" height="40" stroke="rgb(0,0,0)" style="filter:url(#filter_blur);opacity:0.7;fill-opacity:1" width="128" x="67" y="46" />
+  <rect fill="rgb(0,0,0)" height="40" stroke="rgb(0,0,0)" style="filter:url(#filter_blur);opacity:0.7;fill-opacity:1" width="128" x="259" y="46" />
+  <rect fill="rgb(0,0,0)" height="40" stroke="rgb(0,0,0)" style="filter:url(#filter_blur);opacity:0.7;fill-opacity:1" width="128" x="259" y="126" />
+  <rect fill="rgb(0,0,0)" height="40" stroke="rgb(0,0,0)" style="filter:url(#filter_blur);opacity:0.7;fill-opacity:1" width="128" x="451" y="46" />
+  <rect fill="rgb(255,255,255)" height="40" stroke="rgb(0,0,0)" width="128" x="64" y="40" />
+  <text fill="rgb(0,0,0)" font-family="sansserif" font-size="11" font-style="normal" font-weight="normal" x="110" y="66">Server</text>
+  <rect fill="rgb(255,255,255)" height="40" stroke="rgb(0,0,0)" width="128" x="256" y="40" />
+  <text fill="rgb(0,0,0)" font-family="sansserif" font-size="11" font-style="normal" font-weight="normal" x="302" y="66">nadoka</text>
+  <rect fill="rgb(255,255,255)" height="40" stroke="rgb(0,0,0)" width="128" x="256" y="120" />
+  <text fill="rgb(0,0,0)" font-family="sansserif" font-size="11" font-style="normal" font-weight="normal" x="299" y="146">plugins</text>
+  <rect fill="rgb(255,255,255)" height="40" stroke="rgb(0,0,0)" width="128" x="448" y="40" />
+  <text fill="rgb(0,0,0)" font-family="sansserif" font-size="11" font-style="normal" font-weight="normal" x="491" y="66">Clients</text>
+  <path d="M 200 60 L 248 60" fill="none" stroke="rgb(0,0,0)" />
+  <polygon fill="rgb(0,0,0)" points="193,60 200,56 200,64 193,60" stroke="rgb(0,0,0)" />
+  <polygon fill="rgb(0,0,0)" points="255,60 248,56 248,64 255,60" stroke="rgb(0,0,0)" />
+  <path d="M 320 88 L 320 112" fill="none" stroke="rgb(0,0,0)" />
+  <polygon fill="rgb(0,0,0)" points="320,81 316,88 324,88 320,81" stroke="rgb(0,0,0)" />
+  <polygon fill="rgb(0,0,0)" points="320,119 316,112 324,112 320,119" stroke="rgb(0,0,0)" />
+  <path d="M 392 60 L 440 60" fill="none" stroke="rgb(0,0,0)" />
+  <polygon fill="rgb(0,0,0)" points="385,60 392,56 392,64 385,60" stroke="rgb(0,0,0)" />
+  <polygon fill="rgb(0,0,0)" points="447,60 440,56 440,64 447,60" stroke="rgb(0,0,0)" />
+</svg>

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: rabbit-slide-znz-SapporoRubyKaigi2012
+version: !ruby/object:Gem::Version
+  version: 2012.09.15
+  prerelease: 
+platform: ruby
+authors:
+- Kazuhiro NISHIYAMA
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rabbit
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+description: IRCnet の日本語チャンネルでは iso-2022-jp が使われていて、 iso-2022-jp は ascii compatible
+  ではありません。 そのことが様々な問題を引き起こします。 その問題をどう解決したのか、 nadoka さんでの m17n 対応の最善の方法は何なのか、 ということについて話をする予定です。
+email:
+- zn@mbf.nifty.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .rabbit
+- config.yaml
+- Rakefile
+- README.rd
+- nadoka.svg
+- nadoka-safari.png
+- nadoka.png
+- nadoka-m17n.rab
+- pdf/SapporoRubyKaigi2012-nadoka-m17n.pdf
+homepage: http://slide.rabbit-shocker.org/authors/znz/SapporoRubyKaigi2012/
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: nadoka さんの m17n 対応のベストプラクティス
+test_files: []