1.4.1: C API 0.11, sync annotation, internal improvements

Author: greenrobot

Source/Gemfile.lock

@@ -2,20 +2,20 @@ GEM
   remote: https://rubygems.org/
   specs:
     CFPropertyList (3.0.2)
-    activesupport (4.2.11.1)
+    activesupport (4.2.11.3)
       i18n (~> 0.7)
       minitest (~> 5.1)
       thread_safe (~> 0.3, >= 0.3.4)
       tzinfo (~> 1.1)
-    algoliasearch (1.27.2)
+    algoliasearch (1.27.3)
       httpclient (~> 2.8, >= 2.8.3)
       json (>= 1.5.1)
     atomos (0.1.3)
     claide (1.0.3)
-    cocoapods (1.9.1)
+    cocoapods (1.9.3)
       activesupport (>= 4.0.2, < 5)
       claide (>= 1.0.2, < 2.0)
-      cocoapods-core (= 1.9.1)
+      cocoapods-core (= 1.9.3)
       cocoapods-deintegrate (>= 1.0.3, < 2.0)
       cocoapods-downloader (>= 1.2.2, < 2.0)
       cocoapods-plugins (>= 1.0.0, < 2.0)
@@ -31,7 +31,7 @@ GEM
       nap (~> 1.0)
       ruby-macho (~> 1.4)
       xcodeproj (>= 1.14.0, < 2.0)
-    cocoapods-core (1.9.1)
+    cocoapods-core (1.9.3)
       activesupport (>= 4.0.2, < 6)
       algoliasearch (~> 1.0)
       concurrent-ruby (~> 1.1)
@@ -40,7 +40,7 @@ GEM
       netrc (~> 0.11)
       typhoeus (~> 1.0)
     cocoapods-deintegrate (1.0.4)
-    cocoapods-downloader (1.3.0)
+    cocoapods-downloader (1.4.0)
     cocoapods-plugins (1.0.0)
       nap
     cocoapods-search (1.0.0)
@@ -50,18 +50,18 @@ GEM
       netrc (~> 0.11)
     cocoapods-try (1.2.0)
     colored2 (3.1.2)
-    concurrent-ruby (1.1.6)
+    concurrent-ruby (1.1.7)
     escape (0.0.4)
     ethon (0.12.0)
       ffi (>= 1.3.0)
-    ffi (1.12.2)
+    ffi (1.13.1)
     fourflusher (2.3.1)
     fuzzy_match (2.0.4)
     gh_inspector (1.1.3)
     httpclient (2.8.3)
     i18n (0.9.5)
       concurrent-ruby (~> 1.0)
-    jazzy (0.13.3)
+    jazzy (0.13.5)
       cocoapods (~> 1.5)
       mustache (~> 1.1)
       open4
@@ -70,19 +70,19 @@ GEM
       sassc (~> 2.1)
       sqlite3 (~> 1.3)
       xcinvoke (~> 0.3.0)
-    json (2.3.0)
+    json (2.3.1)
     liferaft (0.0.6)
-    minitest (5.14.0)
+    minitest (5.14.2)
     molinillo (0.6.6)
     mustache (1.1.1)
-    nanaimo (0.2.6)
+    nanaimo (0.3.0)
     nap (1.1.0)
     netrc (0.11.0)
     open4 (1.3.4)
     redcarpet (3.5.0)
-    rouge (3.18.0)
+    rouge (3.22.0)
     ruby-macho (1.4.0)
-    sassc (2.3.0)
+    sassc (2.4.0)
       ffi (~> 1.9)
     sqlite3 (1.4.2)
     thread_safe (0.3.6)
@@ -92,12 +92,12 @@ GEM
       thread_safe (~> 0.1)
     xcinvoke (0.3.0)
       liferaft (~> 0.0.6)
-    xcodeproj (1.16.0)
+    xcodeproj (1.18.0)
       CFPropertyList (>= 2.3.3, < 4.0)
       atomos (~> 0.1.3)
       claide (>= 1.0.2, < 2.0)
       colored2 (~> 3.1)
-      nanaimo (~> 0.2.6)
+      nanaimo (~> 0.3.0)
 
 PLATFORMS
   ruby

Source/README.md

@@ -1,6 +1,5 @@
 ObjectBox Swift Sources
 =======================
-
 This folder contains the Swift sources for ObjectBox. This is the API you primarily touch when working with ObjectBox.
 
 These Swift classes internally use [ObjectBox's C API](https://github.com/objectbox/objectbox-c), implemented by the libObjectBoxCore library. 
@@ -9,13 +8,15 @@ Repository Contents
 -------------------
 - `ios-framework/`: The Cocoa Swift framework.
     - `docs/swift_output/`: The generated framework documentation.
-- `external/`: git submodule and pre-built binary container. This contains the ObjectBoxCore static libraries and our code generator.
-- `fetch_dependencies.command`: Script for downloading libObjectBoxCore into `externals`. You must run this script before you can build the framework.
+- `external/`: git submodule and pre-built binary container.
+   This contains the ObjectBoxCore static libraries and our code generator.
+- `fetch_dependencies.command`: Script for downloading libObjectBoxCore into `externals`.
+   You must run this script before you can build the framework.
 - `docs/`: Documentation and discussion of concepts, ideas, and approaches to bring ObjectBox to Swift.
 
 Setup
 -----
-* Install latest Xcode (Swift 5.2+) with command line tools prepared to build from the shell
+* Install latest Xcode (Swift 5.3+) with command line tools prepared to build from the shell
   * Note: After Xcode updates, you may have to reinstall the CLI tools via `xcode-select --install`
 * Ensure you have homebrew (e.g. setup.sh uses it to install [Carthage](https://github.com/Carthage/Carthage))
 * Using homebrew, install basic build tools like cmake and ccache
@@ -42,7 +43,8 @@ Distributing the Framework
 
 Distribution of the framework as closed source works across these channels:
 
-- **CocoaPods**, by setting the `.podspec`'s `vendored_frameworks` to point to the build products of the macOS and iOS framework targets. (The `make-release.command` script takes care of this)
+- **CocoaPods**, by setting the `.podspec`'s `vendored_frameworks` to point to the build products of the macOS and iOS framework targets.
+  (The `make-release.command` script takes care of this)
 - **Carthage**, by uploading a `.zip` of the frameworks as binary attachments to a GitHub's release.
 
 ## Build with Carthage
@@ -51,19 +53,18 @@ The easiest way to build the framework is using the dependency manager [Carthage
 
     $ carthage build --no-skip-current
 
-In addition to building the dependencies (there are none), the `--no-skip-current` flag ensures the current project itself is built. That's what we'll be shipping with both Carthage and CocoaPods.
+In addition to building the dependencies (there are none), the `--no-skip-current` flag ensures the current project itself is built.
+That's what we'll be shipping with both Carthage and CocoaPods.
 
 To generate the Carthage-compatible release:
 
     $ carthage archive ObjectBox
 
 This will put all build products in a `.zip`. On client machines, Carthage downloads and unzips the contents into their local framework build directory next to other dependencies that may be built from source.
 
-Note that the build products built with Swift 4.2 will not be compatible with Swift 5 onward. So we have to ship updated binaries until Swift reaches ABI stability, lest the releases become useless.
-
 ## Build without Carthage
 
-You need a "fat" framework that works both on the iPhone Simulator on macOS (x86 architecture) and real devices (armv7 and arm64 architectures).
+You need a "fat" framework that works both on the iPhone Simulator on macOS (x64) and real devices (arm64).
 
 The `iOS-Fat-Framework` target compiles for both architectures and merges the results into a single build product: a single framework, and a single dSYM file.
 

Source/fetch_dependencies.command

@@ -27,23 +27,24 @@ if [ "$verify_only" = true ]; then
 else
 
 if [ -d "$code_dir" ]; then # Do we have an existing code repo?
-    cd "$code_dir"  # todo fix this workaround for building into cbuild dir in "our" objectbox-swift dir
+    pushd "$code_dir"  # todo fix this workaround for building into cbuild dir in "our" objectbox-swift dir
     echo "Have repository, building."
     "$code_dir/scripts/apple-build-static-libs.sh" "$dest_dir" release
-    exit
+    popd
 else # Download static public release and unzip into $dest
     if [ ! -d "${dest_dir}" ] || [ ! -e "${dest_dir}/libObjectBoxCore-iOS.a" ]; then
-        version=1.4.0
-        c_version=0.10.0
+        version=1.4.1
+        c_version=0.11.0
         archive_path="${my_dir}/external/objectbox-static.zip"
         OBXLIB_URL_apple_static="https://github.com/objectbox/objectbox-swift/releases/download/v${version}/ObjectBoxCore-static-${c_version}.zip"
 
         mkdir -p "${dest_dir}"
 
         curl -L --fail "${OBXLIB_URL_apple_static}" --output "${archive_path}"
 
-        cd "${dest_dir}"
+        pushd "${dest_dir}"
         unzip "${archive_path}"
+        popd
 
         if [ -d "${dest_dir}/build-artifacts/" ]; then
             mv "${dest_dir}/build-artifacts/"* "${dest_dir}/"
@@ -55,6 +56,9 @@ else # Download static public release and unzip into $dest
 fi
 fi # verify_only
 
+# Update the header file actually used by our Swift sources
+cp "$dest_dir/objectbox.h" "ios-framework/CommonSource/Internal/objectbox-c.h"
+
 # Print versions for allow verification of built libs (is it the one we expect?)
 echo "============================================================================================"
 echo "Please check that the found libs are available (macOS, iOS) and contain the expected symbols"

Source/ios-framework/.swiftlint-macOS.yml

@@ -14,4 +14,7 @@ identifier_name:
     excluded:
         - id
         - ok
-        - tx
+        - tx
+type_name:
+    excluded:
+        - Id