[ruby-list:33173] Re: [ANN] Ruby/zlib 0.5.0-pre1

In article <[e-mail]>,
  UENO Katsuhiro <[e-mail]> writes:

>   * クラス名の変更。全てのクラスと定数は Zlib 以下に移しました。
>     後方互換性のため古い名前も残してはいます。
> 
>       + Deflate -> Zlib::Deflate
>       + Inflate -> Zlib::Inflate
>       + Zlib::Gzip -> Zlib::GzipFile
>       + GzipReader -> Zlib::GzipReader
>       + GzipWriter -> Zlib::GzipWriter
>       + などなど…

ドキュメント中の例に古い名前の参照が残っています。

                  zstream = Deflate.new(level)
                  zstream = Inflate.new
        gz = GzipReader.new(f)
        gz = GzipWriter.new(f)

>   * Ruby 自体の制限のため、GzipWriter オブジェクトは明示的に
>     クローズしなければならないようになりました。

ドキュメントには GzipWriter.open と GzipWriter.new にブロックを与えた
場合には自動的にクローズすると書いてあるんですが、そうなっていません。

% ruby -rzlib -e 'Zlib::GzipWriter.open("a.gz") {|gz| gz.write "xxjklfds\n"}'
-e:1: warning: Zlib::GzipWriter object must be closed explicitly.
% zcat a.gz    

gzcat: a.gz: unexpected end of file
% ruby -rzlib -e 'Zlib::GzipWriter.new(STDOUT) {|gz| gz.write "xxjklfds\n"}' > z.gz
-e:1: warning: Zlib::GzipWriter object must be closed explicitly.
% zcat a.gz

gzcat: a.gz: unexpected end of file

> 1.7 への対応は、とりあえず 1.6 で安定してから、と考えています。
> # 単に 1.7 がどうなっているかを知らないだけだったりもする(汗;

個人的にはすでに 1.7 に移行してしまっているので、1.7 に install しまし
た。最小限の変更で済ますなら、NORETURN を消して str2cstr を
rb_str2cstr に変えるだけで済むようです。

> あと、Ruby/zlib を 1.7 にマージする話があったと思うのですが、
> マージするのであれば、このバージョンを元にしたいと思っています。
> そういった観点からの API のレビュー等もお願いしたいです。

ドキュメントを一通り読んだのですが、悪くないと思います。ぜひぜひマージ
して欲しいと思います。

ただ、Zlib::GzipReader.new と Zlib::GzipWriter.new に文字列を与えたら
ファイル名と解釈してくれてもいいかも知れないと思いました。でも、
String#read や String#write を定義する可能性を潰しちゃうことになるから
うまくないかも。

あと、

* 例を出すならまずブロックを使った例を出すほうが良いのではないか。
  (クローズし忘れる可能性を減らせるし。)
* flag という名前よりは内容を表す名前のほうが意味をとりやすい。
  (とくに Zlib::GzipWriter#close では本文に説明がないし。)

と思いました。

--- ruby-zlib-0.5.0-pre1/zlib.rd.src	Sun Jan  6 01:19:15 2002
+++ ruby-zlib-0.5.0-pre1+/zlib.rd.src	Sun Jan  6 04:38:26 2002
@@ -324,7 +324,7 @@
         en|    This method is almostly equivalant to the following code:
 
                 def deflate(string, level)
-                  zstream = Deflate.new(level)
+                  zstream = Zlib::Deflate.new(level)
                   zstream << string
                   buf = zstream.finish
                   zstream.close
@@ -445,7 +445,7 @@
         en|    This method is almostly equivalant to the following code:
 
                 def inflate(string)
-                  zstream = Inflate.new
+                  zstream = Zlib::Inflate.new
                   buf = zstream.inflate(string)
                   zstream.finish
                   zstream.close
@@ -569,13 +569,13 @@
         #|
         en|    Same as IO.
 
---- Zlib::GzipFile#close([flag])
-        ja| GzipFile オブジェクトをクローズします。((|flag|)) が省略されている
-        ja| 時や ((|flag|)) が真でない時、関連付けられている IO オブジェクトの
+--- Zlib::GzipFile#close([dont_close_io])
+        ja| GzipFile オブジェクトをクローズします。((|dont_close_io|)) が省略されている
+        ja| 時や ((|dont_close_io|)) が真でない時、関連付けられている IO オブジェクトの
         ja| close メソッドを呼び出します。
         ja| 関連付けられている IO オブジェクトを返します。
         #|
-        en|    Closes the GzipReader object. If ((|flag|)) is ommited or
+        en|    Closes the GzipReader object. If ((|dont_close_io|)) is ommited or
         en|    not true, close method of the associated IO object is called.
         en|    Returns the associated IO object.
 
@@ -673,8 +673,12 @@
 en|    associating an instance of IO class (or an object which has the same
 en|    methods as IO has).
 
+	Zlib::GzipReader.open('hoge.gz') {|gz|
+	  print gz.read
+	}
+
         f = File.open('hoge.gz')
-        gz = GzipReader.new(f)
+        gz = Zlib::GzipReader.new(f)
         print gz.read
         gz.close
 
@@ -689,6 +693,7 @@
 === クラスメソッド:
 
 --- Zlib::GzipReader.new(io)
+--- Zlib::GzipReader.new(io) {|gz| ...}
         ja| ((|io|)) と関連付けられた GzipReader オブジェクトを作成します。
         ja| GzipReader オブジェクトは ((|io|)) からデータを逐次リードして
         ja| 解析/展開を行います。((|io|)) には少なくとも、IO#read と
@@ -719,6 +724,7 @@
         en|    ((<Zlib::GzipFile#close>)) method with an argument in the block.
 
 --- Zlib::GzipReader.open(filename)
+--- Zlib::GzipReader.open(filename) {|gz| ... }
         ja| ((|filename|)) で指定されるファイルを gzip ファイルとして
         ja| オープンします。GzipReader オブジェクトを返します。
         ja| その他詳細は ((<Zlib::GzipReader.new>)) と同じです。
@@ -824,8 +830,12 @@
 en|    associate with an instance of IO class (or an object which has
 en|    the same methods as IO has).
 
+	Zlib::GzipWriter.open('hoge.gz') {|gz|
+	  gz.write 'jugemu jugemu gokou no surikire...'
+	}
+
         f = File.open('hoge.gz', 'w')
-        gz = GzipWriter.new(f)
+        gz = Zlib::GzipWriter.new(f)
         gz.write 'jugemu jugemu gokou no surikire...'
         gz.close
 
@@ -843,6 +853,7 @@
 === クラスメソッド:
 
 --- Zlib::GzipWriter.new(io[, level[, strategy]])
+--- Zlib::GzipWriter.new(io[, level[, strategy]]) {|gz| ... }
         ja| ((|io|)) と関連付けられた GzipWriter オブジェクトを作成します。
         ja| ((|level|)), ((|strategy|)) は ((<Zlib::Deflate.new>)) と同じです。
         ja| GzipWriter オブジェクトは ((|io|)) に gzip 形式のデータを
@@ -872,6 +883,7 @@
         en|    in the block explicitly.
 
 --- Zlib::GzipWriter.open(filename[, level[, strategy]])
+--- Zlib::GzipWriter.open(filename[, level[, strategy]]) {|gz| ... }
         ja| ((|filename|)) で指定されるファイルを gzip 圧縮データの
         ja| 書き出し用にオープンします。GzipWriter オブジェクトを返します。
         ja| その他詳細は ((<Zlib::GzipWriter.new>)) と同じです。
@@ -883,7 +895,7 @@
 
 === メソッド:
 
---- Zlib::GzipWriter#close([flag])
+--- Zlib::GzipWriter#close([dont_close_io])
         ja| フッターを書き出し、GzipWriter オブジェクトをクローズします。
         #|
         en|    Writes the gzip file footer and closes the GzipWriter object.
-- 
[田中 哲][たなか あきら][Tanaka Akira]
「ふえろ! わかめちゃん作戦です$(C⊇」(Little Worker, 桂遊生丸)