Prepare for test release

tsolomko · Oct 1, 2017 · 9d2852c · 9d2852c
1 parent 635af0a
commit 9d2852c
Show file tree

Hide file tree

Showing 104 changed files with 2,998 additions and 674 deletions.
diff --git a/.jazzy.yaml b/.jazzy.yaml
@@ -3,11 +3,11 @@ clean: true
 exclude: Tests/
 author: Timofey Solomko
 module: SWCompression
-module_version: 3.3.1
+module_version: 3.4.0-test
 copyright: '© 2017 Timofey Solomko'
 readme: README.md
 github_url: https://github.com/tsolomko/SWCompression
-github_file_prefix: https://github.com/tsolomko/SWCompression/tree/v3.3.1
+github_file_prefix: https://github.com/tsolomko/SWCompression/tree/v3.4.0-test
 theme: fullwidth
 
 custom_categories:

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,11 @@
 # Changelog
 
+## 3.4.0-test
+
+- Added BZip2 compression.
+- Added `CompressionAlgorithm` protocol.
+- Deflate now conforms to `CompressionAlgorithm` protocol.
+
 ## 3.3.1
 
 - Fixed out of range index crash in BitReader.

diff --git a/SWCompression.podspec b/SWCompression.podspec
@@ -1,7 +1,7 @@
 Pod::Spec.new do |s|
 
   s.name         = "SWCompression"
-  s.version      = "3.3.1"
+  s.version      = "3.4.0-test"
   s.summary      = "Framework with implementations in Swift of different (de)compression algorithms"
 
   s.description  = <<-DESC

diff --git a/Sources/Service/Info.plist b/Sources/Service/Info.plist
@@ -15,7 +15,7 @@
 	<key>CFBundlePackageType</key>
 	<string>FMWK</string>
 	<key>CFBundleShortVersionString</key>
-	<string>3.3.1</string>
+	<string>3.4.0-test</string>
 	<key>CFBundleVersion</key>
 	<string>$(CURRENT_PROJECT_VERSION)</string>
 	<key>NSHumanReadableCopyright</key>

diff --git a/docs/Archives.html b/docs/Archives.html
@@ -22,7 +22,7 @@
         <a class="header-link" href="index.html">
           SWCompression Docs
         </a>
-         (100% documented)
+         (96% documented)
       </p>
 
       <p class="header-col--secondary">
@@ -55,6 +55,9 @@
               <li class="nav-group-task">
                 <a class="nav-group-task-link" href="Classes/BZip2.html">BZip2</a>
               </li>
+              <li class="nav-group-task">
+                <a class="nav-group-task-link" href="Classes/BZip2/BlockSize.html">– BlockSize</a>
+              </li>
               <li class="nav-group-task">
                 <a class="nav-group-task-link" href="Classes/Deflate.html">Deflate</a>
               </li>
@@ -189,6 +192,9 @@
               <li class="nav-group-task">
                 <a class="nav-group-task-link" href="Protocols/DecompressionAlgorithm.html">DecompressionAlgorithm</a>
               </li>
+              <li class="nav-group-task">
+                <a class="nav-group-task-link" href="Protocols/CompressionAlgorithm.html">CompressionAlgorithm</a>
+              </li>
             </ul>
           </li>
         </ul>
@@ -232,7 +238,7 @@ <h4>Declaration</h4>
                         </div>
                       </div>
                       <div class="slightly-smaller">
-                        <a href="https://github.com/tsolomko/SWCompression/tree/v3.3.1/Sources/GzipArchive.swift#L9-L208">Show on GitHub</a>
+                        <a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0-test/Sources/GzipArchive.swift#L9-L208">Show on GitHub</a>
                       </div>
                     </section>
                   </div>
@@ -267,7 +273,7 @@ <h4>Declaration</h4>
                         </div>
                       </div>
                       <div class="slightly-smaller">
-                        <a href="https://github.com/tsolomko/SWCompression/tree/v3.3.1/Sources/GzipHeader.swift#L9-L163">Show on GitHub</a>
+                        <a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0-test/Sources/GzipHeader.swift#L9-L163">Show on GitHub</a>
                       </div>
                     </section>
                   </div>
@@ -302,7 +308,7 @@ <h4>Declaration</h4>
                         </div>
                       </div>
                       <div class="slightly-smaller">
-                        <a href="https://github.com/tsolomko/SWCompression/tree/v3.3.1/Sources/XZArchive.swift#L9-L341">Show on GitHub</a>
+                        <a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0-test/Sources/XZArchive.swift#L9-L341">Show on GitHub</a>
                       </div>
                     </section>
                   </div>
@@ -337,7 +343,7 @@ <h4>Declaration</h4>
                         </div>
                       </div>
                       <div class="slightly-smaller">
-                        <a href="https://github.com/tsolomko/SWCompression/tree/v3.3.1/Sources/ZlibArchive.swift#L9-L75">Show on GitHub</a>
+                        <a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0-test/Sources/ZlibArchive.swift#L9-L73">Show on GitHub</a>
                       </div>
                     </section>
                   </div>
@@ -372,7 +378,7 @@ <h4>Declaration</h4>
                         </div>
                       </div>
                       <div class="slightly-smaller">
-                        <a href="https://github.com/tsolomko/SWCompression/tree/v3.3.1/Sources/ZlibHeader.swift#L9-L93">Show on GitHub</a>
+                        <a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0-test/Sources/ZlibHeader.swift#L9-L93">Show on GitHub</a>
                       </div>
                     </section>
                   </div>

diff --git a/docs/Classes/BZip2.html b/docs/Classes/BZip2.html
@@ -23,7 +23,7 @@
         <a class="header-link" href="../index.html">
           SWCompression Docs
         </a>
-         (100% documented)
+         (96% documented)
       </p>
 
       <p class="header-col--secondary">
@@ -56,6 +56,9 @@
               <li class="nav-group-task">
                 <a class="nav-group-task-link" href="../Classes/BZip2.html">BZip2</a>
               </li>
+              <li class="nav-group-task">
+                <a class="nav-group-task-link" href="../Classes/BZip2/BlockSize.html">– BlockSize</a>
+              </li>
               <li class="nav-group-task">
                 <a class="nav-group-task-link" href="../Classes/Deflate.html">Deflate</a>
               </li>
@@ -190,6 +193,9 @@
               <li class="nav-group-task">
                 <a class="nav-group-task-link" href="../Protocols/DecompressionAlgorithm.html">DecompressionAlgorithm</a>
               </li>
+              <li class="nav-group-task">
+                <a class="nav-group-task-link" href="../Protocols/CompressionAlgorithm.html">CompressionAlgorithm</a>
+              </li>
             </ul>
           </li>
         </ul>
@@ -270,7 +276,105 @@ <h4>Return Value</h4>
                         <p>Decompressed data.</p>
                       </div>
                       <div class="slightly-smaller">
-                        <a href="https://github.com/tsolomko/SWCompression/tree/v3.3.1/Sources/BZip2.swift#L23-L27">Show on GitHub</a>
+                        <a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0-test/Sources/BZip2.swift#L23-L27">Show on GitHub</a>
+                      </div>
+                    </section>
+                  </div>
+                </li>
+              </ul>
+            </div>
+            <div class="task-group">
+              <ul class="item-container">
+                <li class="item">
+                  <div>
+                    <code>
+                    <a name="/s:13SWCompression20CompressionAlgorithmP8compress10Foundation4DataVAG4data_tKFZ"></a>
+                    <a name="//apple_ref/swift/Method/compress(data:)" class="dashAnchor"></a>
+                    <a class="token" href="#/s:13SWCompression20CompressionAlgorithmP8compress10Foundation4DataVAG4data_tKFZ">compress(data:)</a>
+                    </code>
+                  </div>
+                  <div class="height-container">
+                    <div class="pointer-container"></div>
+                    <section class="section">
+                      <div class="pointer"></div>
+                      <div class="abstract">
+
+                      </div>
+                      <div class="declaration">
+                        <h4>Declaration</h4>
+                        <div class="language">
+                          <p class="aside-title">Swift</p>
+                          <pre class="highlight"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">compress</span><span class="p">(</span><span class="nv">data</span><span class="p">:</span> <span class="kt">Data</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Data</span></code></pre>
+
+                        </div>
+                      </div>
+                      <div class="slightly-smaller">
+                        <a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0-test/Sources/BZip2+Compress.swift#L10-L12">Show on GitHub</a>
+                      </div>
+                    </section>
+                  </div>
+                </li>
+                <li class="item">
+                  <div>
+                    <code>
+                    <a name="/s:13SWCompression5BZip2C8compress10Foundation4DataVAG4data_AC9BlockSizeO05blockH0tFZ"></a>
+                    <a name="//apple_ref/swift/Method/compress(data:blockSize:)" class="dashAnchor"></a>
+                    <a class="token" href="#/s:13SWCompression5BZip2C8compress10Foundation4DataVAG4data_AC9BlockSizeO05blockH0tFZ">compress(data:blockSize:)</a>
+                    </code>
+                  </div>
+                  <div class="height-container">
+                    <div class="pointer-container"></div>
+                    <section class="section">
+                      <div class="pointer"></div>
+                      <div class="abstract">
+                        <p>Undocumented</p>
+
+                      </div>
+                      <div class="declaration">
+                        <h4>Declaration</h4>
+                        <div class="language">
+                          <p class="aside-title">Swift</p>
+                          <pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">BZip2</span><span class="p">:</span> <span class="kt"><a href="../Protocols/DecompressionAlgorithm.html">DecompressionAlgorithm</a></span></code></pre>
+
+                        </div>
+                      </div>
+                      <div class="slightly-smaller">
+                        <a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0-test/Sources/BZip2+Compress.swift#L14-L44">Show on GitHub</a>
+                      </div>
+                    </section>
+                  </div>
+                </li>
+              </ul>
+            </div>
+            <div class="task-group">
+              <ul class="item-container">
+                <li class="item">
+                  <div>
+                    <code>
+                    <a name="/s:13SWCompression5BZip2C9BlockSizeO"></a>
+                    <a name="//apple_ref/swift/Enum/BlockSize" class="dashAnchor"></a>
+                    <a class="token" href="#/s:13SWCompression5BZip2C9BlockSizeO">BlockSize</a>
+                    </code>
+                  </div>
+                  <div class="height-container">
+                    <div class="pointer-container"></div>
+                    <section class="section">
+                      <div class="pointer"></div>
+                      <div class="abstract">
+                        <p>Undocumented</p>
+
+                        <a href="../Classes/BZip2/BlockSize.html" class="slightly-smaller">See more</a>
+                      </div>
+                      <div class="declaration">
+                        <h4>Declaration</h4>
+                        <div class="language">
+                          <p class="aside-title">Swift</p>
+                          <pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">BZip2</span><span class="p">:</span> <span class="kt"><a href="../Protocols/DecompressionAlgorithm.html">DecompressionAlgorithm</a></span></code></pre>
+
+                        </div>
+                      </div>
+                      <div class="slightly-smaller">
+                        <a href="https://github.com/tsolomko/SWCompression/tree/v3.4.0-test/Sources/BZip2+BlockSize.swift#L10-L20">Show on GitHub</a>
                       </div>
                     </section>
                   </div>