1.4.0 collected changes

Author: greenrobot

Source/README.md

@@ -7,16 +7,14 @@ These Swift classes internally use [ObjectBox's C API](https://github.com/object
 
 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.
-- `download_dependencies.command`: Script for downloading libObjectBoxCore into `externals`. You must run this script before you can build the framework.
+- `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
   * 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))
@@ -79,7 +77,6 @@ This is essentially what comes for free with Carthage. Xcode 10 changed the buil
 
 Swift Framework Project Organization
 ------------------------------------
-
 You look at and build the framework itself via `ios-framework/ObjectBox.xcodeproj`.
 
 * `ObjectBox.xcproject` targets
@@ -98,14 +95,20 @@ You look at and build the framework itself via `ios-framework/ObjectBox.xcodepro
     * `ObjectBox-macOS` contains macOS-specific files, including the framework's Info.plist
     * `ObjectBox-iOS` contains iOS-specific files, including the framework's Info.plist
 
+Build notes
+-----------
+* Build phases; check Xcode project
+  * "Rename C Header": takes the standard C objectbox.h and augments it with some Swift specifics into ObjectBoxC.h
+    (TODO: Can we do this differently, e.g. use the standard objectbox.h and then have a second .h for Swift specifics?)
+* SwiftLint (macOS build only): calls `swiftlint lint --config .swiftlint-macOS.yml`
+  * Edit .swiftlint-macOS.yml file to customize (e.g. "id" is OK despite less than 3 chars)
+
 Caveats
 -------
-
 To make to-one relations and their backlinks work, the `Entity` protocol was extended to require (1) an `EntityType` typealias, and (2) an `_id` property. The former was needed to disambiguate which concrete entity we're talking about when all we have is the protocol type, and this in turn is needed to specify the generic type requirement of `Id<T>`. Since the `Entity` protocol itself is intended to be no more than a convenient code annotation (which Sourcery can filter on), it's advised to get rid of this as soon as possible and find a different way to get the data needed for associations in Swift, for example using an `IdGetter<T>` like we do in Java and injecting it into `EntityInfo` from generated code.
 
 How to Use the Framework
 ------------------------
-
 - The example project in this repository is a good starting point to see how to interact with the framework.
 - Have a look at the `ios-framework/CommonTests/Test Entities/RelatedEntities.swift` file to see how self-contained entity code & generated cursor code look. You should be able to copy and paste the contents into a test app if you want. This should also help in case you cannot get the code generator running in 2024 :)
 

Source/download_dependencies.command

@@ -0,0 +1,72 @@
+#!/usr/bin/env bash
+
+# Script that is used by CI to build the static libs, or by external users to download a build from
+# Github. Will do nothing if there already is a copy of the static libs in external.
+#
+# Adjust the 'version' variable as needed to get the right version for the current code.
+#
+
+set -e
+
+if [ "${1:-}" == "--verify-only" ]; then
+    verify_only=true
+    shift
+else
+    verify_only=false
+fi
+
+# macOS does not have realpath and readlink does not have -f option, so do this instead:
+my_dir=$( cd "$(dirname "$0")" ; pwd -P )
+
+cd "$my_dir"
+code_dir="${my_dir}/external/objectbox"
+dest_dir="${my_dir}/external/objectbox-static"
+
+if [ "$verify_only" = true ]; then
+  echo "Skipping fetch, only verifying"
+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
+    echo "Have repository, building."
+    "$code_dir/scripts/apple-build-static-libs.sh" "$dest_dir" release
+    exit
+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
+        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}"
+        unzip "${archive_path}"
+
+        if [ -d "${dest_dir}/build-artifacts/" ]; then
+            mv "${dest_dir}/build-artifacts/"* "${dest_dir}/"
+            rm -r "${dest_dir}/build-artifacts/"
+        fi
+
+        rm "${archive_path}"
+    fi
+fi
+fi # verify_only
+
+# 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"
+echo "Available libs in '$dest_dir':"
+cd ${dest_dir}
+for filename in ./*.a; do
+  echo ""
+  ls -lha "$filename"
+  # Match our version/date pattern like "2.6.1-2020-06-09"
+  obx_version=$(strings "$filename" | grep "[0-9]\.[0-9]\.[0-9]-[0-9][0-9][0-9][0-9]-[0-9][0-9]-[0-9][0-9]")
+  echo "  >> Version found: $obx_version"
+  obx_symbols=$(nm -gj "$filename" | grep -c obx_  || true)
+  obx_sync_symbols=$(nm -gj "$filename" | grep -c obx_sync_ || true)
+  echo "  >> Symbols found: $obx_symbols obx, $obx_sync_symbols obx_sync"
+done

Source/fetch_dependencies.command

@@ -10,3 +10,8 @@ disabled_rules:
     - trailing_whitespace
     - todo
     - vertical_whitespace
+identifier_name:
+    excluded:
+        - id
+        - ok
+        - tx