Merge branch 'hotfix-4.5.11'

Author: tsolomko

.jazzy.yaml

@@ -1,13 +1,13 @@
 # Run: sourcekitten doc --spm --module-name SWCompression > docs.json
 sourcekitten_sourcefile: docs.json
-clean: true
+clean: false
 author: Timofey Solomko
 module: SWCompression
-module_version: 4.5.10
+module_version: 4.5.11
 copyright: '© 2021 Timofey Solomko'
 readme: README.md
 github_url: https://github.com/tsolomko/SWCompression
-github_file_prefix: https://github.com/tsolomko/SWCompression/tree/4.5.10
+github_file_prefix: https://github.com/tsolomko/SWCompression/tree/4.5.11
 theme: fullwidth
 
 custom_categories:

.travis.yml

@@ -3,112 +3,7 @@ git:
   depth: 1
   submodules: false
 jobs:
-  allow_failures:
-    # There is an issue with Swift 5.4 on Linux which fails the build. See https://bugs.swift.org/browse/SR-14594.
-    env:
-      - SWIFT_VERSION=5.4
   include:
-    # We test only building using SPM with Swift 4.2 on macos since Carthage doesn't support multiple Swift language versions.
-    - stage: test
-      language: swift
-      os: osx
-      osx_image: xcode10.1 # Swift 4.2
-      script:
-      - swift --version
-      - swift build
-      - swift build -c release
-    - stage: test
-      language: swift
-      os: osx
-      osx_image: xcode10.3 # Swift 5.0
-      env:
-      - HOMEBREW_NO_INSTALL_CLEANUP=1
-      - WATCHOS_ACTIONS='clean build'
-      - WATCHOS_SIMULATOR='Apple Watch Series 4 - 44mm'
-      before_install:
-      - brew update
-      install:
-      - ./utils.py ci install-macos
-      before_script:
-      - ./utils.py prepare-workspace macos
-      script:
-      - ./utils.py ci script-macos
-    - stage: test
-      language: swift
-      os: osx
-      osx_image: xcode11.3 # Swift 5.1
-      env:
-      - HOMEBREW_NO_INSTALL_CLEANUP=1
-      - WATCHOS_ACTIONS='clean build'
-      - WATCHOS_SIMULATOR='Apple Watch Series 4 - 44mm'
-      before_install:
-      - brew update
-      install:
-      - ./utils.py ci install-macos
-      before_script:
-      - ./utils.py prepare-workspace macos
-      script:
-      - ./utils.py ci script-macos
-    - stage: test
-      language: swift
-      os: osx
-      osx_image: xcode11.4 # Swift 5.2
-      env:
-      - HOMEBREW_NO_INSTALL_CLEANUP=1
-      - WATCHOS_ACTIONS='clean build'
-      - WATCHOS_SIMULATOR='Apple Watch Series 4 - 44mm'
-      before_install:
-      - brew update
-      install:
-      - ./utils.py ci install-macos
-      before_script:
-      - ./utils.py prepare-workspace macos
-      script:
-      - ./utils.py ci script-macos
-    - stage: test
-      # TODO: Remove this stage when the non-xcf installation method with Carthage is no longer supported.
-      language: swift
-      os: osx
-      osx_image: xcode12 # Swift 5.3
-      env:
-      - HOMEBREW_NO_INSTALL_CLEANUP=1
-      - WATCHOS_ACTIONS='clean build'
-      - WATCHOS_SIMULATOR='Apple Watch Series 6 - 44mm'
-      before_install:
-      - brew update
-      install:
-      - ./utils.py ci install-macos
-      before_script:
-      - xcconfig=$(mktemp /tmp/static.xcconfig.XXXXXX)
-      - trap 'rm -f "$xcconfig"' INT TERM HUP EXIT
-      - echo 'EXCLUDED_ARCHS__EFFECTIVE_PLATFORM_SUFFIX_simulator__NATIVE_ARCH_64_BIT_x86_64__XCODE_1200 = arm64 arm64e armv7 armv7s armv6 armv8' >> $xcconfig
-      - echo 'EXCLUDED_ARCHS = $(inherited) $(EXCLUDED_ARCHS__EFFECTIVE_PLATFORM_SUFFIX_$(EFFECTIVE_PLATFORM_SUFFIX)__NATIVE_ARCH_64_BIT_$(NATIVE_ARCH_64_BIT)__XCODE_$(XCODE_VERSION_MAJOR))' >> $xcconfig
-      - export XCODE_XCCONFIG_FILE="$xcconfig"
-      - carthage bootstrap
-      - git submodule update --init --recursive
-      - cp "Tests/Test Files/gitattributes-copy" "Tests/Test Files/.gitattributes"
-      - cd "Tests/Test Files/"
-      - git lfs pull
-      - git lfs checkout
-      - cd -
-      script:
-      - ./utils.py ci script-macos
-    - stage: test
-      language: swift
-      os: osx
-      osx_image: xcode12.4 # Swift 5.3.2
-      env:
-      - HOMEBREW_NO_INSTALL_CLEANUP=1
-      - WATCHOS_ACTIONS='clean build'
-      - WATCHOS_SIMULATOR='Apple Watch Series 6 - 44mm'
-      before_install:
-      - brew update
-      install:
-      - ./utils.py ci install-macos
-      before_script:
-      - ./utils.py prepare-workspace macos --xcf
-      script:
-      - ./utils.py ci script-macos
     - stage: test
       language: swift
       os: osx
@@ -125,90 +20,3 @@ jobs:
       - ./utils.py prepare-workspace macos --xcf
       script:
       - ./utils.py ci script-macos
-    - stage: test
-      language: generic
-      os: linux
-      dist: bionic
-      env:
-      - SWIFT_VERSION=4.2.3
-      install:
-      - ./utils.py ci install-linux
-      script:
-      - ./utils.py ci script-linux
-    - stage: test
-      language: generic
-      os: linux
-      dist: bionic
-      env:
-      - SWIFT_VERSION=5.0.3
-      install:
-      - ./utils.py ci install-linux
-      script:
-      - ./utils.py ci script-linux
-    - stage: test
-      language: generic
-      os: linux
-      dist: bionic
-      env:
-      - SWIFT_VERSION=5.1.5
-      install:
-      - ./utils.py ci install-linux
-      script:
-      - ./utils.py ci script-linux
-    - stage: test
-      language: generic
-      os: linux
-      dist: bionic
-      env:
-      - SWIFT_VERSION=5.2.5
-      install:
-      - ./utils.py ci install-linux
-      script:
-      - ./utils.py ci script-linux
-    - stage: test
-      language: generic
-      os: linux
-      dist: bionic
-      env:
-      - SWIFT_VERSION=5.3.3
-      install:
-      - ./utils.py ci install-linux
-      script:
-      - ./utils.py ci script-linux
-    - stage: test
-      language: generic
-      os: linux
-      dist: bionic
-      env:
-      - SWIFT_VERSION=5.4
-      install:
-      - ./utils.py ci install-linux
-      script:
-      - ./utils.py ci script-linux
-    - stage: deploy
-      # Don't deploy if it is a test release.
-      if: (tag IS present) AND (tag =~ /^\d+\.\d+\.\d+$/)
-      language: generic
-      os: osx
-      osx_image: xcode12
-      env:
-      - HOMEBREW_NO_INSTALL_CLEANUP=1
-      env:
-        secure: iavIkrus2Xd3b086nz2srMGl52yqzLuCdhyEAhMODVqkzqMQ17s10y1TNb+vkepd0HgxI9j57d5X7tfChjWuWDwE2hZKjr/Kx2DfiUr1AKQD6ymuGrq/0Vv6yL9dfPU8goFArcrsBcyVKczLtTuLCKL498ZqokkQc/3kGvzW74lv+z410MfHS9/tvToO/yXJckL6qJ2XBAiElfOO0rEkllTeCo6N3bjcHZ2o7PE0K+CHYxwNKj0TmPmuNWZ3U4fzoWzkk01re1C1l5cpSb20g+2aGyi0yYX+PomX7fIIqNq9vmmyoeNdr35yqoQv/0zFeFnps83NKmZLAjSUhiUdhlbuBLBE+w8544LOaZnMDlFmpDjgyaVnRrOh0NrBB1FwU48aGfX5ljRQmk/07FTEUjvwvGGoOpz8lrLZi148FMHEospL3Sf7d8K+Q9WdtLTGk7HCnbOVcxS6oB/SWF/Cj6n5wu+EI1floBaZEsNPR40Gd4eM/Ik/E3lDrZThGDCWQsao981wm7IfEDBR1nuMME8gpZINFANNS1+5miFaGdTnDTp4Yd5MGEFZm+K8x+TG1891NwNH1ZmKXlypJXiUzvSjbh2ViNJGekdQj9q2gj2ZFlCfHJ05adwJ4w9qRuF00HpAOD6At6EnsjDXFJeTZS5dj8fi2YsU9or8KfTFoNY=
-      addons:
-        homebrew:
-          packages:
-          - sourcekitten
-          update: true
-      install:
-      - gem install -N jazzy
-      - gem update -N cocoapods
-      before_deploy:
-      - ./utils.py ci before-deploy
-      deploy:
-      - provider: pages
-        github_token: $GITHUB_TOKEN
-        local_dir: docs
-        skip_cleanup: true
-        on:
-          tags: true

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 4.5.11
+
+- Fixed a crash when processing a truncated TAR file.
+- Added missing documentation for `LZMAProperties.init()`.
+- Windows is now supported.
+
 ## 4.5.10
 
 - Fixed compilation issues on Windows (PR #22 by @trametheka).

README.md

@@ -4,6 +4,7 @@
 [![Swift 5.X](https://img.shields.io/badge/Swift-5.X-blue.svg)](https://developer.apple.com/swift/)
 [![GitHub license](https://img.shields.io/badge/license-MIT-lightgrey.svg)](https://raw.githubusercontent.com/tsolomko/SWCompression/master/LICENSE)
 [![Build Status](https://travis-ci.com/tsolomko/SWCompression.svg?branch=develop)](https://travis-ci.com/tsolomko/SWCompression)
+[![Build Status](https://dev.azure.com/tsolomko/SWCompression/_apis/build/status/tsolomko.SWCompression?branchName=develop)](https://dev.azure.com/tsolomko/SWCompression/_build/latest?definitionId=3&branchName=develop)
 
 A framework with (de)compression algorithms and functions for working with various archives and containers.
 
@@ -15,7 +16,7 @@ SWCompression — is a framework with a collection of functions for:
 2. Reading (and sometimes writing) archives of different formats.
 3. Reading (and sometimes writing) containers such as ZIP, TAR and 7-Zip.
 
-It also works both on Apple platforms and __Linux__.
+It also works on Apple platforms, Linux, __and Windows__.
 
 All features are listed in the tables below. "TBD" means that feature is planned but not implemented (yet).
 
@@ -192,14 +193,12 @@ If you want to run tests on your computer, you need to do an additional step aft
 ```
 
 The argument of this function is an operating system that you're using. This command will download files used in tests,
-and on macOS it will also try to download BitByteData dependency, which requires having Carthage installed.
-
-Currently, the Carthage part of this procedure may fail when using Xcode 12 or later. In that case you should manually
-run `carthage update --use-xcframeworks --no-use-binaries` or use
-[xconfig workaround](https://github.com/Carthage/Carthage/blob/master/Documentation/Xcode12Workaround.md). Please also
-note that when on working on SWCompression in Xcode when building the project you may see ld warnings about a directory
-not being found. These are expected and harmless. Finally, you should keep in mind that support for non-xcframework method
-of installing dependencies is likely to be dropped in the future major update.
+and on macOS it will also try to download BitByteData dependency, which requires having Carthage installed. When using
+Xcode 12 or later, you should also pass the `--xcf` option, or use the
+[xconfig workaround](https://github.com/Carthage/Carthage/blob/master/Documentation/Xcode12Workaround.md).
+Please also note that when working on SWCompression in Xcode when building the project you may see ld warnings about a
+directory not being found. These are expected and harmless. Finally, you should keep in mind that support for non-xcframework
+method of installing dependencies is likely to be dropped in the future major update.
 
 Test files are stored in a [separate repository](https://github.com/tsolomko/SWCompression-Test-Files), using Git LFS.
 There are two reasons for this complicated setup. Firstly, some of these files can be quite big, and it would be
@@ -232,9 +231,6 @@ completely in Swift without Objective-C, it can also be used on __Linux__.
 
 ## Future plans
 
-See [5.0 Update](https://github.com/tsolomko/SWCompression/projects/2) Project for the list of planned API changes and
-new features.
-
 - Performance...
 - Better Deflate compression.
 - Something else...
@@ -248,7 +244,7 @@ new features.
 - [pyflate](http://www.paul.sladen.org/projects/pyflate/)
 - [Deflate specification](https://www.ietf.org/rfc/rfc1951.txt)
 - [GZip specification](https://www.ietf.org/rfc/rfc1952.txt)
-- [Zlib specfication](https://www.ietf.org/rfc/rfc1950.txt)
+- [Zlib specification](https://www.ietf.org/rfc/rfc1950.txt)
 - [LZMA SDK and specification](http://www.7-zip.org/sdk.html)
 - [XZ specification](http://tukaani.org/xz/xz-file-format-1.0.4.txt)
 - [Wikipedia article about LZMA](https://en.wikipedia.org/wiki/Lempel–Ziv–Markov_chain_algorithm)

SWCompression.podspec

@@ -1,7 +1,7 @@
 Pod::Spec.new do |s|
 
   s.name         = "SWCompression"
-  s.version      = "4.5.10"
+  s.version      = "4.5.11"
   s.summary      = "A framework with functions for working with compression, archives and containers."
 
   s.description  = "A framework with (de)compression algorithms and functions for processing various archives and containers."

SWCompression.xcodeproj/SWCompression.plist

@@ -15,9 +15,9 @@
 	<key>CFBundlePackageType</key>
 	<string>FMWK</string>
 	<key>CFBundleShortVersionString</key>
-	<string>4.5.10</string>
+	<string>4.5.11</string>
 	<key>CFBundleVersion</key>
-	<string>77</string>
+	<string>78</string>
 	<key>NSHumanReadableCopyright</key>
 	<string>Copyright © 2021 Timofey Solomko</string>
 </dict>

SWCompression.xcodeproj/TestSWCompression.plist

@@ -15,8 +15,8 @@
 	<key>CFBundlePackageType</key>
 	<string>BNDL</string>
 	<key>CFBundleShortVersionString</key>
-	<string>4.5.10</string>
+	<string>4.5.11</string>
 	<key>CFBundleVersion</key>
-	<string>77</string>
+	<string>78</string>
 </dict>
 </plist>

SWCompression.xcodeproj/project.pbxproj

@@ -1258,7 +1258,7 @@
 				CLANG_WARN_SUSPICIOUS_MOVE = YES;
 				CLANG_WARN_UNREACHABLE_CODE = YES;
 				CLANG_WARN__DUPLICATE_METHOD_MATCH = YES;
-				CURRENT_PROJECT_VERSION = 77;
+				CURRENT_PROJECT_VERSION = 78;
 				DEBUG_INFORMATION_FORMAT = dwarf;
 				ENABLE_STRICT_OBJC_MSGSEND = YES;
 				ENABLE_TESTABILITY = YES;
@@ -1339,7 +1339,7 @@
 				CLANG_WARN_SUSPICIOUS_MOVE = YES;
 				CLANG_WARN_UNREACHABLE_CODE = YES;
 				CLANG_WARN__DUPLICATE_METHOD_MATCH = YES;
-				CURRENT_PROJECT_VERSION = 77;
+				CURRENT_PROJECT_VERSION = 78;
 				DEBUG_INFORMATION_FORMAT = "dwarf-with-dsym";
 				ENABLE_STRICT_OBJC_MSGSEND = YES;
 				"FRAMEWORK_SEARCH_PATHS[sdk=appletvos*]" = (
@@ -1400,7 +1400,7 @@
 				APPLICATION_EXTENSION_API_ONLY = YES;
 				DEFINES_MODULE = YES;
 				DYLIB_COMPATIBILITY_VERSION = 1;
-				DYLIB_CURRENT_VERSION = 77;
+				DYLIB_CURRENT_VERSION = 78;
 				DYLIB_INSTALL_NAME_BASE = "@rpath";
 				INFOPLIST_FILE = SWCompression.xcodeproj/SWCompression.plist;
 				INSTALL_PATH = "$(LOCAL_LIBRARY_DIR)/Frameworks";
@@ -1427,7 +1427,7 @@
 				APPLICATION_EXTENSION_API_ONLY = YES;
 				DEFINES_MODULE = YES;
 				DYLIB_COMPATIBILITY_VERSION = 1;
-				DYLIB_CURRENT_VERSION = 77;
+				DYLIB_CURRENT_VERSION = 78;
 				DYLIB_INSTALL_NAME_BASE = "@rpath";
 				INFOPLIST_FILE = SWCompression.xcodeproj/SWCompression.plist;
 				INSTALL_PATH = "$(LOCAL_LIBRARY_DIR)/Frameworks";

Sources/LZMA/LZMAProperties.swift

@@ -43,6 +43,7 @@ public struct LZMAProperties {
         self.dictionarySize = dictionarySize
     }
 
+    /// Initializes LZMA properties with default values of lc, lp, pb, and dictionary size.
     public init() { }
 
     init(lzmaByte: UInt8, _ dictSize: Int) throws {