Bump version to 0.11.0, update CHANGELOG.md

Author: MaxDesiatov

CHANGELOG.md

@@ -1,3 +1,45 @@
+# 0.11.0 (30 May 2020)
+
+This is a feature release that enables compatibility with [CryptoOffice](https://github.com/CoreOffice/CryptoOffice) for decrypting spreadsheets. Additionally, with 0.11.0 you can easily get worksheet names with a new `parseWorksheetPathsAndNames` function on `XLSXFile` and get rich text values from cells with a new `richStringValue` function on `Cell`.
+
+Due to technical issues, Swift 5.0 CI job for Linux has been removed, so compatibility with Swift 5.0 on Linux can no longer be guaranteed. While CoreXLSX may continue to work with Swift 5.0 on Linux, please update to Swift 5.1 or later to avoid unexpected issues.
+
+Thanks to [@kobylyanets](https://github.com/kobylyanets) and
+[@duodo2412](https://github.com/duodo2412) for their contributions to this release!
+
+**New APIs:**
+
+- `XLSXFile` now provides a new initializer that takes an argument of `Data` type. This allows opening in-memory documents, the primary example being spreadsheets decrypted with [CryptoOffice](https://github.com/CoreOffice/CryptoOffice).
+
+- `XLSXFile` now has a new `parseWorksheetPathsAndNames` function that returns an array of
+  worksheet names and their paths in a given workbook, while previously you had to use
+  `parseWorksheetPaths` and match paths manually with results of the `parseWorkbooks` function.
+
+- `Cell` now has a `richStringValue` function that takes a result of
+  `XLSXFile.parseSharedStrings` function and produces an array of `RichText` values. This
+  makes it easier to query rich text content from cells, while previously you had to match
+  cell values against `SharedStrings` manually.
+
+**Breaking change:**
+
+Due to the introduction of the new `XLSXFile.init(data:)` initializer, the `filepath`
+property on `XLSXFile` no longer makes sense. This property was not used internally
+in any way and in-memory files don't have any filepaths. If you need to refer to a
+filepath of an `.xlsx` file after you've parsed from your filesystem, you should
+retain it manually and process it separately as you see fit.
+
+**Closed issues:**
+
+- API for matching sheet names to sheet paths ([#105](https://github.com/CoreOffice/CoreXLSX/issues/105))
+
+**Merged pull requests:**
+
+- Bump XMLCoder dependency to 0.11.1 ([#112](https://github.com/CoreOffice/CoreXLSX/pull/112)) via [@MaxDesiatov](https://github.com/MaxDesiatov)
+- Add data XLSXFile.init, remove filepath property ([#111](https://github.com/CoreOffice/CoreXLSX/pull/111)) via [@MaxDesiatov](https://github.com/MaxDesiatov)
+- Add func parseWorksheetPathsAndNames on XLSXFile ([#109](https://github.com/CoreOffice/CoreXLSX/pull/109)) via [@MaxDesiatov](https://github.com/MaxDesiatov)
+- Drop support for Swift 5.0 on Linux ([#110](https://github.com/CoreOffice/CoreXLSX/pull/110)) via [@MaxDesiatov](https://github.com/MaxDesiatov)
+- Add ability to get cell value as RichText ([#106](https://github.com/CoreOffice/CoreXLSX/pull/106)) via [@kobylyanets](https://github.com/kobylyanets)
+
 # 0.10.0 (6 April 2020)
 
 This is a release with bugfixes and a few improvements to usability of
@@ -64,7 +106,7 @@ compatibility with some spreadsheet files. Thanks to
 **Fixed bugs:**
 
 - Cannot initialize SchemaType from invalid String value
-[\#87](https://github.com/MaxDesiatov/CoreXLSX/issues/87)
+  [\#87](https://github.com/MaxDesiatov/CoreXLSX/issues/87)
 
 **Merged pull requests:**
 
@@ -188,11 +230,11 @@ compatibility with files containing formulas and varied shared string formats.
 
 Specifically:
 
-* new `struct Formula` added with a corresponding property on `struct Cell`
-* property `color` on `struct Properties` became optional
-* `properties` on `struct RichText` became optional
-* new `chartsheet` case added to `enum Relationship`
-* `richText` on `struct SharedStrings` became an array, not optional
+- new `struct Formula` added with a corresponding property on `struct Cell`
+- property `color` on `struct Properties` became optional
+- `properties` on `struct RichText` became optional
+- new `chartsheet` case added to `enum Relationship`
+- `richText` on `struct SharedStrings` became an array, not optional
 
 **Closed issues:**
 
@@ -260,42 +302,42 @@ who provided bug reports and contributions that made this release possible!
 
 **Breaking changes:**
 
-* A few properties on the model types were added with cleaner names and better
-fitting types. Most of the old versions of those properties were kept as
-deprecated, but you might get some breakage with optionality, where we
-couldn't find a good deprecation path.
+- A few properties on the model types were added with cleaner names and better
+  fitting types. Most of the old versions of those properties were kept as
+  deprecated, but you might get some breakage with optionality, where we
+  couldn't find a good deprecation path.
 
 **Additions:**
 
-* New `parseSharedStrings` function on `XLSXFile` allows you get values of
-cells with shared string value. Quite frequently those strings are
-unavailable and are only referenced in the original model types you get with
-`parseWorksheet`.
-
-* Previously when addressing cells and columns you had to use a stringly-typed
-API. It was also not very convenient for specifying a range of columns. This
-is now fixed with the new type-safe [`ColumnReference`
-struct](https://github.com/MaxDesiatov/CoreXLSX/blob/cf0c7f44e8bf80fdd60fa12b3aa27a15cc79ef86/Tests/CoreXLSXTests/CellReference.swift#L61),
-which conforms to `Comparable` and `Strideable`.
-
-* Following the addition of [an error context to
-`XMLCoder`](https://github.com/MaxDesiatov/XMLCoder/pull/46), which is the main
-dependency of `CoreXLSX`, it is now exposed on `struct XLSXFile`. Pass a
-non-zero value to `errorContextLength` argument (default is `0`) of `XLSXFile`
-initializer and you'll get a snippet of XML that failed to parse in the debug
-description of the error value.
-
-* Additional optional argument `bufferSize` was added to `XLSXFile` initializer as
-a response to [previous
-reports](https://github.com/MaxDesiatov/CoreXLSX/issues/27) about problems [with
-zip file extraction](https://github.com/MaxDesiatov/CoreXLSX/issues/26). The
-default value is 10 MiB, which seems to be enough in most cases, but you can
-still try passing a larger value for bigger files if you see that an XML file
-stops abruptly in the middle of the file. Unfortunately, we haven't found a good
-way to adjust this value dynamically based on the file size, but a sufficiently
-large value should work for all files, which is the default.
-
-* Support for Carthage was added as well as support for tvOS and watchOS.
+- New `parseSharedStrings` function on `XLSXFile` allows you get values of
+  cells with shared string value. Quite frequently those strings are
+  unavailable and are only referenced in the original model types you get with
+  `parseWorksheet`.
+
+- Previously when addressing cells and columns you had to use a stringly-typed
+  API. It was also not very convenient for specifying a range of columns. This
+  is now fixed with the new type-safe [`ColumnReference`
+  struct](https://github.com/MaxDesiatov/CoreXLSX/blob/cf0c7f44e8bf80fdd60fa12b3aa27a15cc79ef86/Tests/CoreXLSXTests/CellReference.swift#L61),
+  which conforms to `Comparable` and `Strideable`.
+
+- Following the addition of [an error context to
+  `XMLCoder`](https://github.com/MaxDesiatov/XMLCoder/pull/46), which is the main
+  dependency of `CoreXLSX`, it is now exposed on `struct XLSXFile`. Pass a
+  non-zero value to `errorContextLength` argument (default is `0`) of `XLSXFile`
+  initializer and you'll get a snippet of XML that failed to parse in the debug
+  description of the error value.
+
+- Additional optional argument `bufferSize` was added to `XLSXFile` initializer as
+  a response to [previous
+  reports](https://github.com/MaxDesiatov/CoreXLSX/issues/27) about problems [with
+  zip file extraction](https://github.com/MaxDesiatov/CoreXLSX/issues/26). The
+  default value is 10 MiB, which seems to be enough in most cases, but you can
+  still try passing a larger value for bigger files if you see that an XML file
+  stops abruptly in the middle of the file. Unfortunately, we haven't found a good
+  way to adjust this value dynamically based on the file size, but a sufficiently
+  large value should work for all files, which is the default.
+
+- Support for Carthage was added as well as support for tvOS and watchOS.
 
 **Bugfixes:**
 
@@ -304,106 +346,105 @@ thanks to fixes in optionality and more properties added to the model types.
 
 **All changes:**
 
-* Set global version in project file, bump to 0.4.0 ([#39](https://github.com/MaxDesiatov/CoreXLSX/pull/39))
-([MaxDesiatov](https://github.com/MaxDesiatov))
-* Update README.md ([#40](https://github.com/MaxDesiatov/CoreXLSX/pull/40))
-[@chriseidhof](https://github.com/chriseidhof)
-* Expose `errorContextLength` on `struct XLSXFile` ([#38](https://github.com/MaxDesiatov/CoreXLSX/pull/38))
-([MaxDesiatov](https://github.com/MaxDesiatov))
-* Add `customProperties` relationship ([#34](https://github.com/MaxDesiatov/CoreXLSX/pull/34))
-([NSMutableString](https://github.com/NSMutableString))
-* Update XMLCoder and ZIPFoundation dependencies ([#36](https://github.com/MaxDesiatov/CoreXLSX/pull/36))
-([MaxDesiatov](https://github.com/MaxDesiatov))
-* Update requirements in README.md
-([MaxDesiatov](https://github.com/MaxDesiatov))
-* Add extra relationship metadataThumbnail ([#33](https://github.com/MaxDesiatov/CoreXLSX/pull/33))
-([NSMutableString](https://github.com/NSMutableString))
-* Refactor Worksheet and Pane values to optional ([#31](https://github.com/MaxDesiatov/CoreXLSX/pull/31))
-([hodovani](https://github.com/hodovani))
-* Add bufferSize parameter to init ([#30](https://github.com/MaxDesiatov/CoreXLSX/pull/30))
-([hodovani](https://github.com/hodovani))
-* Add more cases to `Relationship.SchemaType` ([#25](https://github.com/MaxDesiatov/CoreXLSX/pull/25))
-([MaxDesiatov](https://github.com/MaxDesiatov))
-* Add `public func parseDocumentRelationships` ([#23](https://github.com/MaxDesiatov/CoreXLSX/pull/23))
-([MaxDesiatov](https://github.com/MaxDesiatov))
-* Make Relationships public, add parseRelationships ([#22](https://github.com/MaxDesiatov/CoreXLSX/pull/22))
-([MaxDesiatov](https://github.com/MaxDesiatov))
-* Add SharedStrings model, parse sharedStrings.xml ([#8](https://github.com/MaxDesiatov/CoreXLSX/pull/8))
-([MaxDesiatov](https://github.com/MaxDesiatov))
-* Paste XML snippet into WorksheetTests as is
-([MaxDesiatov](https://github.com/MaxDesiatov))
-* Add a second XML snippet to WorksheetTests
-([MaxDesiatov](https://github.com/MaxDesiatov))
-* Clarify issue reporting in README.md
-([MaxDesiatov](https://github.com/MaxDesiatov))
-* Test newspaces in attributes in WorksheetTests
-([MaxDesiatov](https://github.com/MaxDesiatov))
-* More XML with newlines in WorksheetTests
-([MaxDesiatov](https://github.com/MaxDesiatov))
-* Add newline characters test to WorksheetTests
-([MaxDesiatov](https://github.com/MaxDesiatov))
-* Add cell with a single attribute to WorksheetTests
-([MaxDesiatov](https://github.com/MaxDesiatov))
-* Add rows and cells to WorksheetTests
-([MaxDesiatov](https://github.com/MaxDesiatov))
-* Update names and types of properties on Worksheet ([#18](https://github.com/MaxDesiatov/CoreXLSX/pull/18))
-([MaxDesiatov](https://github.com/MaxDesiatov))
-* Rename sheetData on Worksheet and make it optional ([#17](https://github.com/MaxDesiatov/CoreXLSX/pull/17))
-([MaxDesiatov](https://github.com/MaxDesiatov))
-* Add simple `Workbook` model with tests (#16)
-([MaxDesiatov](https://github.com/MaxDesiatov))
-* Make `columns` property optional on `Worksheet` ([#14](https://github.com/MaxDesiatov/CoreXLSX/pull/14))
-([MaxDesiatov](https://github.com/MaxDesiatov))
-* Fix example project after new files were added ([#13](https://github.com/MaxDesiatov/CoreXLSX/pull/13))
-([MaxDesiatov](https://github.com/MaxDesiatov))
-* Remove `worksheetCache` private property as unused ([#11](https://github.com/MaxDesiatov/CoreXLSX/pull/11))
-([MaxDesiatov](https://github.com/MaxDesiatov))
-* Clarify platform setting for CocoaPods in README
-([MaxDesiatov](https://github.com/MaxDesiatov))
-* Clarify Carthage instructions in README.md
-([MaxDesiatov](https://github.com/MaxDesiatov))
-* Add API for filtering cells by rows and columns ([#7](https://github.com/MaxDesiatov/CoreXLSX/pull/7))
-([MaxDesiatov](https://github.com/MaxDesiatov))
-* Add Carthage and support for tvOS and watchOS ([#6](https://github.com/MaxDesiatov/CoreXLSX/pull/6))
-([MaxDesiatov](https://github.com/MaxDesiatov))
-* Implement `Strideable` on `ColumnReference` ([#5](https://github.com/MaxDesiatov/CoreXLSX/pull/5))
-([MaxDesiatov](https://github.com/MaxDesiatov))
-* Add ColumnReference type with new API ([#3](https://github.com/MaxDesiatov/CoreXLSX/pull/3))
-([MaxDesiatov](https://github.com/MaxDesiatov))
-
+- Set global version in project file, bump to 0.4.0 ([#39](https://github.com/MaxDesiatov/CoreXLSX/pull/39))
+  ([MaxDesiatov](https://github.com/MaxDesiatov))
+- Update README.md ([#40](https://github.com/MaxDesiatov/CoreXLSX/pull/40))
+  [@chriseidhof](https://github.com/chriseidhof)
+- Expose `errorContextLength` on `struct XLSXFile` ([#38](https://github.com/MaxDesiatov/CoreXLSX/pull/38))
+  ([MaxDesiatov](https://github.com/MaxDesiatov))
+- Add `customProperties` relationship ([#34](https://github.com/MaxDesiatov/CoreXLSX/pull/34))
+  ([NSMutableString](https://github.com/NSMutableString))
+- Update XMLCoder and ZIPFoundation dependencies ([#36](https://github.com/MaxDesiatov/CoreXLSX/pull/36))
+  ([MaxDesiatov](https://github.com/MaxDesiatov))
+- Update requirements in README.md
+  ([MaxDesiatov](https://github.com/MaxDesiatov))
+- Add extra relationship metadataThumbnail ([#33](https://github.com/MaxDesiatov/CoreXLSX/pull/33))
+  ([NSMutableString](https://github.com/NSMutableString))
+- Refactor Worksheet and Pane values to optional ([#31](https://github.com/MaxDesiatov/CoreXLSX/pull/31))
+  ([hodovani](https://github.com/hodovani))
+- Add bufferSize parameter to init ([#30](https://github.com/MaxDesiatov/CoreXLSX/pull/30))
+  ([hodovani](https://github.com/hodovani))
+- Add more cases to `Relationship.SchemaType` ([#25](https://github.com/MaxDesiatov/CoreXLSX/pull/25))
+  ([MaxDesiatov](https://github.com/MaxDesiatov))
+- Add `public func parseDocumentRelationships` ([#23](https://github.com/MaxDesiatov/CoreXLSX/pull/23))
+  ([MaxDesiatov](https://github.com/MaxDesiatov))
+- Make Relationships public, add parseRelationships ([#22](https://github.com/MaxDesiatov/CoreXLSX/pull/22))
+  ([MaxDesiatov](https://github.com/MaxDesiatov))
+- Add SharedStrings model, parse sharedStrings.xml ([#8](https://github.com/MaxDesiatov/CoreXLSX/pull/8))
+  ([MaxDesiatov](https://github.com/MaxDesiatov))
+- Paste XML snippet into WorksheetTests as is
+  ([MaxDesiatov](https://github.com/MaxDesiatov))
+- Add a second XML snippet to WorksheetTests
+  ([MaxDesiatov](https://github.com/MaxDesiatov))
+- Clarify issue reporting in README.md
+  ([MaxDesiatov](https://github.com/MaxDesiatov))
+- Test newspaces in attributes in WorksheetTests
+  ([MaxDesiatov](https://github.com/MaxDesiatov))
+- More XML with newlines in WorksheetTests
+  ([MaxDesiatov](https://github.com/MaxDesiatov))
+- Add newline characters test to WorksheetTests
+  ([MaxDesiatov](https://github.com/MaxDesiatov))
+- Add cell with a single attribute to WorksheetTests
+  ([MaxDesiatov](https://github.com/MaxDesiatov))
+- Add rows and cells to WorksheetTests
+  ([MaxDesiatov](https://github.com/MaxDesiatov))
+- Update names and types of properties on Worksheet ([#18](https://github.com/MaxDesiatov/CoreXLSX/pull/18))
+  ([MaxDesiatov](https://github.com/MaxDesiatov))
+- Rename sheetData on Worksheet and make it optional ([#17](https://github.com/MaxDesiatov/CoreXLSX/pull/17))
+  ([MaxDesiatov](https://github.com/MaxDesiatov))
+- Add simple `Workbook` model with tests (#16)
+  ([MaxDesiatov](https://github.com/MaxDesiatov))
+- Make `columns` property optional on `Worksheet` ([#14](https://github.com/MaxDesiatov/CoreXLSX/pull/14))
+  ([MaxDesiatov](https://github.com/MaxDesiatov))
+- Fix example project after new files were added ([#13](https://github.com/MaxDesiatov/CoreXLSX/pull/13))
+  ([MaxDesiatov](https://github.com/MaxDesiatov))
+- Remove `worksheetCache` private property as unused ([#11](https://github.com/MaxDesiatov/CoreXLSX/pull/11))
+  ([MaxDesiatov](https://github.com/MaxDesiatov))
+- Clarify platform setting for CocoaPods in README
+  ([MaxDesiatov](https://github.com/MaxDesiatov))
+- Clarify Carthage instructions in README.md
+  ([MaxDesiatov](https://github.com/MaxDesiatov))
+- Add API for filtering cells by rows and columns ([#7](https://github.com/MaxDesiatov/CoreXLSX/pull/7))
+  ([MaxDesiatov](https://github.com/MaxDesiatov))
+- Add Carthage and support for tvOS and watchOS ([#6](https://github.com/MaxDesiatov/CoreXLSX/pull/6))
+  ([MaxDesiatov](https://github.com/MaxDesiatov))
+- Implement `Strideable` on `ColumnReference` ([#5](https://github.com/MaxDesiatov/CoreXLSX/pull/5))
+  ([MaxDesiatov](https://github.com/MaxDesiatov))
+- Add ColumnReference type with new API ([#3](https://github.com/MaxDesiatov/CoreXLSX/pull/3))
+  ([MaxDesiatov](https://github.com/MaxDesiatov))
 
 # 0.3.0 (13 November 2018)
 
-* Improve `Worksheet` model property naming ([#2](https://github.com/MaxDesiatov/CoreXLSX/pull/2)).
-Some properties on `Worksheet` and its descendants had obscure names, most of that is
-fixed now with old names marked as deprecated.
+- Improve `Worksheet` model property naming ([#2](https://github.com/MaxDesiatov/CoreXLSX/pull/2)).
+  Some properties on `Worksheet` and its descendants had obscure names, most of that is
+  fixed now with old names marked as deprecated.
 
 # 0.2.3 (12 November 2018)
 
-* Refine README.md to include implementation details.
+- Refine README.md to include implementation details.
 
 # 0.2.2 (11 November 2018)
 
-* Refine code comments and links in README.md
+- Refine code comments and links in README.md
 
 # 0.2.1 (11 November 2018)
 
-* Update README.md with instructions for Swift Package Manager.
+- Update README.md with instructions for Swift Package Manager.
 
 # 0.2.0 (11 November 2018)
 
-* Cell by row/column filtering API with `worksheetCache` ([#1](https://github.com/MaxDesiatov/CoreXLSX/pull/1))
-This new API allows users to filter all cells by a row or column reference. To avoid
-re-parsing of worksheets, a new private `worksheetCache` property is added on `XLSXFile`.
+- Cell by row/column filtering API with `worksheetCache` ([#1](https://github.com/MaxDesiatov/CoreXLSX/pull/1))
+  This new API allows users to filter all cells by a row or column reference. To avoid
+  re-parsing of worksheets, a new private `worksheetCache` property is added on `XLSXFile`.
 
 # 0.1.2 (10 November 2018)
 
-* Added macOS 10.11 deployment target to the podspec
+- Added macOS 10.11 deployment target to the podspec
 
 # 0.1.1 (10 November 2018)
 
-* Improved README, fixed podspec
+- Improved README, fixed podspec
 
 # 0.1.0 (10 November 2018)
 
-* First release with reading support for basic .xlsx files
+- First release with reading support for basic .xlsx files

CoreXLSX.podspec

@@ -20,7 +20,7 @@ Pod::Spec.new do |s|
   s.swift_versions    = ['4.2', '5.0', '5.1', '5.2']
   s.description      = <<-DESC
 Excel spreadsheet (XLSX) format support in pure Swift.
-                       DESC
+DESC
 
   s.homepage         = 'https://github.com/CoreOffice/CoreXLSX'
   # s.screenshots     = 'www.example.com/screenshots_1', 'www.example.com/screenshots_2'
@@ -35,12 +35,6 @@ Excel spreadsheet (XLSX) format support in pure Swift.
 
   s.source_files = 'Sources/CoreXLSX/**/*.swift'
 
-  # s.resource_bundles = {
-  #   'CoreXLSX.pod' => ['CoreXLSX.pod/Assets/*.png']
-  # }
-
-  # s.public_header_files = 'Pod/Classes/**/*.h'
-  # s.frameworks = 'UIKit', 'MapKit'
   s.dependency 'ZIPFoundation', '~> 0.9.11'
   s.dependency 'XMLCoder', '~> 0.11.1'
 end