updated to v0.7.0

frsyuki · frsyuki · commit b3cae6b8a1cb · 2015-10-29T10:17:09.000-07:00
diff --git a/Array.html b/Array.html
@@ -209,7 +209,7 @@ <h3 class="signature first" id="to_msgpack-instance_method">
 </div>
 
     <div id="footer">
-  Generated on Fri Oct 23 11:52:28 2015 by
+  Generated on Thu Oct 29 10:16:06 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.2.2).
 </div>
diff --git a/Bignum.html b/Bignum.html
@@ -212,7 +212,7 @@ <h3 class="signature first" id="to_msgpack-instance_method">
 </div>
 
     <div id="footer">
-  Generated on Fri Oct 23 11:52:28 2015 by
+  Generated on Thu Oct 29 10:16:06 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.2.2).
 </div>
diff --git a/FalseClass.html b/FalseClass.html
@@ -209,7 +209,7 @@ <h3 class="signature first" id="to_msgpack-instance_method">
 </div>
 
     <div id="footer">
-  Generated on Fri Oct 23 11:52:28 2015 by
+  Generated on Thu Oct 29 10:16:06 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.2.2).
 </div>
diff --git a/Fixnum.html b/Fixnum.html
@@ -212,7 +212,7 @@ <h3 class="signature first" id="to_msgpack-instance_method">
 </div>
 
     <div id="footer">
-  Generated on Fri Oct 23 11:52:28 2015 by
+  Generated on Thu Oct 29 10:16:06 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.2.2).
 </div>
diff --git a/Float.html b/Float.html
@@ -212,7 +212,7 @@ <h3 class="signature first" id="to_msgpack-instance_method">
 </div>
 
     <div id="footer">
-  Generated on Fri Oct 23 11:52:28 2015 by
+  Generated on Thu Oct 29 10:16:06 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.2.2).
 </div>
diff --git a/Hash.html b/Hash.html
@@ -209,7 +209,7 @@ <h3 class="signature first" id="to_msgpack-instance_method">
 </div>
 
     <div id="footer">
-  Generated on Fri Oct 23 11:52:28 2015 by
+  Generated on Thu Oct 29 10:16:06 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.2.2).
 </div>
diff --git a/MessagePack.html b/MessagePack.html
@@ -104,7 +104,28 @@ <h2>Constant Summary</h2>
         <dt id="VERSION-constant" class="">VERSION =
           
         </dt>
-        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>0.6.2</span><span class='tstring_end'>&quot;</span></span></pre></dd>
+        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>0.7.0</span><span class='tstring_end'>&quot;</span></span></pre></dd>
+      
+        <dt id="DefaultFactory-constant" class="">DefaultFactory =
+          <div class="docstring">
+  <div class="discussion">
+    
+<p>An instance of Factory class. DefaultFactory is also used by global
+pack/unpack methods such as MessagePack.dump/load, Hash#to_msgpack, and
+other to_msgpack methods.</p>
+
+<p>Calling DefaultFactory.register_type lets you add an extension type
+globally.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div>
+        </dt>
+        <dd><pre class="code"><span class='const'>Factory</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span></pre></dd>
       
     </dl>
   
@@ -931,7 +952,7 @@ <h3 class="signature " id="unpack-class_method">
 </div>
 
     <div id="footer">
-  Generated on Fri Oct 23 11:52:28 2015 by
+  Generated on Thu Oct 29 10:16:06 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.2.2).
 </div>
diff --git a/MessagePack/Buffer.html b/MessagePack/Buffer.html
@@ -1826,7 +1826,7 @@ <h3 class="signature " id="write_to-instance_method">
 </div>
 
     <div id="footer">
-  Generated on Fri Oct 23 11:52:28 2015 by
+  Generated on Thu Oct 29 10:16:06 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.2.2).
 </div>
diff --git a/MessagePack/ExtensionValue.html b/MessagePack/ExtensionValue.html
@@ -313,7 +313,7 @@ <h3 class="signature " id="type-instance_method">
 </div>
 
     <div id="footer">
-  Generated on Fri Oct 23 11:52:29 2015 by
+  Generated on Thu Oct 29 10:16:06 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.2.2).
 </div>
diff --git a/MessagePack/Factory.html b/MessagePack/Factory.html
@@ -711,7 +711,7 @@ <h3 class="signature " id="unpacker-instance_method">
 </div>
 
     <div id="footer">
-  Generated on Fri Oct 23 11:52:28 2015 by
+  Generated on Thu Oct 29 10:16:06 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.2.2).
 </div>
diff --git a/MessagePack/MalformedFormatError.html b/MessagePack/MalformedFormatError.html
@@ -122,7 +122,7 @@
 </div>
 
     <div id="footer">
-  Generated on Fri Oct 23 11:52:28 2015 by
+  Generated on Thu Oct 29 10:16:06 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.2.2).
 </div>
diff --git a/MessagePack/Packer.html b/MessagePack/Packer.html
@@ -1736,7 +1736,7 @@ <h3 class="signature " id="write_to-instance_method">
 </div>
 
     <div id="footer">
-  Generated on Fri Oct 23 11:52:28 2015 by
+  Generated on Thu Oct 29 10:16:06 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.2.2).
 </div>
diff --git a/MessagePack/StackError.html b/MessagePack/StackError.html
@@ -122,7 +122,7 @@
 </div>
 
     <div id="footer">
-  Generated on Fri Oct 23 11:52:28 2015 by
+  Generated on Thu Oct 29 10:16:06 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.2.2).
 </div>
diff --git a/MessagePack/UnexpectedTypeError.html b/MessagePack/UnexpectedTypeError.html
@@ -127,7 +127,7 @@
 </div>
 
     <div id="footer">
-  Generated on Fri Oct 23 11:52:28 2015 by
+  Generated on Thu Oct 29 10:16:06 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.2.2).
 </div>
diff --git a/MessagePack/UnknownExtTypeError.html b/MessagePack/UnknownExtTypeError.html
@@ -127,7 +127,7 @@
 </div>
 
     <div id="footer">
-  Generated on Fri Oct 23 11:52:28 2015 by
+  Generated on Thu Oct 29 10:16:06 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.2.2).
 </div>
diff --git a/MessagePack/UnpackError.html b/MessagePack/UnpackError.html
@@ -118,7 +118,7 @@ <h2>Direct Known Subclasses</h2>
 </div>
 
     <div id="footer">
-  Generated on Fri Oct 23 11:52:28 2015 by
+  Generated on Thu Oct 29 10:16:06 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.2.2).
 </div>
diff --git a/MessagePack/Unpacker.html b/MessagePack/Unpacker.html
@@ -1642,7 +1642,7 @@ <h3 class="signature " id="type_registered?-instance_method">
 </div>
 
     <div id="footer">
-  Generated on Fri Oct 23 11:52:29 2015 by
+  Generated on Thu Oct 29 10:16:06 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.2.2).
 </div>
diff --git a/NilClass.html b/NilClass.html
@@ -209,7 +209,7 @@ <h3 class="signature first" id="to_msgpack-instance_method">
 </div>
 
     <div id="footer">
-  Generated on Fri Oct 23 11:52:28 2015 by
+  Generated on Thu Oct 29 10:16:06 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.2.2).
 </div>
diff --git a/String.html b/String.html
@@ -209,7 +209,7 @@ <h3 class="signature first" id="to_msgpack-instance_method">
 </div>
 
     <div id="footer">
-  Generated on Fri Oct 23 11:52:28 2015 by
+  Generated on Thu Oct 29 10:16:06 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.2.2).
 </div>
diff --git a/Symbol.html b/Symbol.html
@@ -209,7 +209,7 @@ <h3 class="signature first" id="to_msgpack-instance_method">
 </div>
 
     <div id="footer">
-  Generated on Fri Oct 23 11:52:28 2015 by
+  Generated on Thu Oct 29 10:16:06 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.2.2).
 </div>
diff --git a/TrueClass.html b/TrueClass.html
@@ -209,7 +209,7 @@ <h3 class="signature first" id="to_msgpack-instance_method">
 </div>
 
     <div id="footer">
-  Generated on Fri Oct 23 11:52:28 2015 by
+  Generated on Thu Oct 29 10:16:06 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.2.2).
 </div>
diff --git a/_index.html b/_index.html
@@ -304,7 +304,7 @@ <h2>Namespace Listing A-Z</h2>
 </div>
 
     <div id="footer">
-  Generated on Fri Oct 23 11:52:28 2015 by
+  Generated on Thu Oct 29 10:16:06 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.2.2).
 </div>
diff --git a/file.README.html b/file.README.html
@@ -185,6 +185,43 @@ <h2 id="label-Streaming+deserialization">Streaming deserialization</h2>
 <p>See <a href="http://ruby.msgpack.org/MessagePack/Unpacker.html">API
 reference</a> for details.</p>
 
+<h1 id="label-Extension+Types">Extension Types</h1>
+
+<p>Packer and Unpacker support <a
+href="https://github.com/msgpack/msgpack/blob/master/spec.md#types-extension-type">Extension
+types of MessagePack</a>.</p>
+
+<pre class="code ruby"><code class="ruby"><span class='comment'># register how to serialize custom class at first
+</span><span class='id identifier rubyid_pk'>pk</span> <span class='op'>=</span> <span class='const'>MessagePack</span><span class='op'>::</span><span class='const'>Packer</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_io'>io</span><span class='rparen'>)</span>
+<span class='id identifier rubyid_pk'>pk</span><span class='period'>.</span><span class='id identifier rubyid_register_type'>register_type</span><span class='lparen'>(</span><span class='int'>0x01</span><span class='comma'>,</span> <span class='const'>MyClass1</span><span class='comma'>,</span> <span class='symbol'>:to_msgpack_ext</span><span class='rparen'>)</span> <span class='comment'># equal to pk.register_type(0x01, MyClass)
+</span><span class='id identifier rubyid_pk'>pk</span><span class='period'>.</span><span class='id identifier rubyid_register_type'>register_type</span><span class='lparen'>(</span><span class='int'>0x02</span><span class='comma'>,</span> <span class='const'>MyClass2</span><span class='rparen'>)</span><span class='lbrace'>{</span><span class='op'>|</span><span class='id identifier rubyid_obj'>obj</span><span class='op'>|</span> <span class='id identifier rubyid_obj'>obj</span><span class='period'>.</span><span class='id identifier rubyid_how_to_serialize'>how_to_serialize</span><span class='lparen'>(</span><span class='rparen'>)</span> <span class='rbrace'>}</span> <span class='comment'># blocks also available
+</span>
+<span class='comment'># almost same API for unpacker
+</span><span class='id identifier rubyid_uk'>uk</span> <span class='op'>=</span> <span class='const'>MessagePack</span><span class='op'>::</span><span class='const'>Unpacker</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='rparen'>)</span>
+<span class='id identifier rubyid_uk'>uk</span><span class='period'>.</span><span class='id identifier rubyid_register_type'>register_type</span><span class='lparen'>(</span><span class='int'>0x01</span><span class='comma'>,</span> <span class='const'>MyClass1</span><span class='comma'>,</span> <span class='symbol'>:from_msgpack_ext</span><span class='rparen'>)</span>
+<span class='id identifier rubyid_uk'>uk</span><span class='period'>.</span><span class='id identifier rubyid_register_type'>register_type</span><span class='lparen'>(</span><span class='int'>0x02</span><span class='rparen'>)</span><span class='lbrace'>{</span><span class='op'>|</span><span class='id identifier rubyid_data'>data</span><span class='op'>|</span> <span class='const'>MyClass2</span><span class='period'>.</span><span class='id identifier rubyid_create_from_serialized_data'>create_from_serialized_data</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
+</code></pre>
+
+<p>MessagePack::Factory is to create packer and unpacker which have same
+extention types.</p>
+
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_factory'>factory</span> <span class='op'>=</span> <span class='const'>MessagePack</span><span class='op'>::</span><span class='const'>Factory</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
+<span class='id identifier rubyid_factory'>factory</span><span class='period'>.</span><span class='id identifier rubyid_register_type'>register_type</span><span class='lparen'>(</span><span class='int'>0x01</span><span class='comma'>,</span> <span class='const'>MyClass1</span><span class='rparen'>)</span> <span class='comment'># same with next line
+</span><span class='id identifier rubyid_factory'>factory</span><span class='period'>.</span><span class='id identifier rubyid_register_type'>register_type</span><span class='lparen'>(</span><span class='int'>0x01</span><span class='comma'>,</span> <span class='const'>MyClass1</span><span class='comma'>,</span> <span class='label'>packer:</span> <span class='symbol'>:to_msgpack_ext</span><span class='comma'>,</span> <span class='label'>unpacker:</span> <span class='symbol'>:from_msgpack_ext</span><span class='rparen'>)</span>
+<span class='id identifier rubyid_pk'>pk</span> <span class='op'>=</span> <span class='id identifier rubyid_factory'>factory</span><span class='period'>.</span><span class='id identifier rubyid_packer'>packer</span><span class='lparen'>(</span><span class='id identifier rubyid_options_for_packer'>options_for_packer</span><span class='rparen'>)</span>
+<span class='id identifier rubyid_uk'>uk</span> <span class='op'>=</span> <span class='id identifier rubyid_factory'>factory</span><span class='period'>.</span><span class='id identifier rubyid_unpacker'>unpacker</span><span class='lparen'>(</span><span class='id identifier rubyid_options_for_unpacker'>options_for_unpacker</span><span class='rparen'>)</span>
+</code></pre>
+
+<p>For <strong>MessagePack.pack</strong> and
+<strong>MessagePack.unpack</strong>, default packer/unpacker refer
+<strong>MessagePack::DefaultFactory</strong>. Call
+<strong>MessagePack::DefaultFactory.register_type</strong> to enable types
+process globally.</p>
+
+<pre class="code ruby"><code class="ruby"><span class='const'>MessagePack</span><span class='op'>::</span><span class='const'>DefaultFactory</span><span class='period'>.</span><span class='id identifier rubyid_register_type'>register_type</span><span class='lparen'>(</span><span class='int'>0x03</span><span class='comma'>,</span> <span class='const'>MyClass3</span><span class='rparen'>)</span>
+<span class='const'>MessagePack</span><span class='period'>.</span><span class='id identifier rubyid_unpack'>unpack</span><span class='lparen'>(</span><span class='id identifier rubyid_data_with_ext_typeid_03'>data_with_ext_typeid_03</span><span class='rparen'>)</span> <span class='comment'>#=&gt; MyClass3 instance
+</span></code></pre>
+
 <h1 id="label-Buffer+API">Buffer API</h1>
 
 <p>MessagePack for Ruby provides a buffer API so that you can read or write
@@ -234,21 +271,31 @@ <h2 id="label-How+to+build+-mingw32+rubygems">How to build -mingw32 rubygems</h2
 <p>Once this step successes, target gems exist in
 pkg/msgpack-*-x86,x64-mingw32.gem.</p>
 
+<h2 id="label-Updating+documents">Updating documents</h2>
+
+<p>Online documents (<a href="http://ruby.msgpack.org">ruby.msgpack.org</a>)
+is generated from gh-pages branch. Following commands update documents in
+gh-pages branch:</p>
+
+<pre class="code ruby"><code class="ruby">bundle exec rake doc
+git checkout gh-pages
+cp doc/* ./ -a</code></pre>
+
 <h1 id="label-Copyright">Copyright</h1>
 <dl class="rdoc-list note-list"><dt>Author
 <dd>
 <p>Sadayuki Furuhashi &lt;frsyuki@gmail.com&gt;</p>
 </dd><dt>Copyright
 <dd>
-<p>Copyright © 2008-2013 Sadayuki Furuhashi</p>
+<p>Copyright © 2008-2015 Sadayuki Furuhashi</p>
 </dd><dt>License
 <dd>
 <p>Apache License, Version 2.0</p>
 </dd></dl>
 </div></div>
 
     <div id="footer">
-  Generated on Fri Oct 23 11:52:28 2015 by
+  Generated on Thu Oct 29 10:16:06 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.2.2).
 </div>
diff --git a/index.html b/index.html
diff --git a/top-level-namespace.html b/top-level-namespace.html
