v1.1.1

Author: greenrobot

.gitignore

@@ -35,3 +35,6 @@ Carthage/Checkouts
 
 #Other IDEs
 .idea/
+
+# ObjectBox model backups
+*.json.bak

Example/Podfile

@@ -1,11 +1,13 @@
+#source 'https://github.com/objectbox/objectbox-swift-spec-staging'
+
 use_frameworks!
 
 target 'NotesExample-iOS' do
   platform :ios, :deployment_target => '11.0'
-  pod 'ObjectBox', '1.1'
+  pod 'ObjectBox'
 end
 
 target 'NotesExample-macOS' do
   platform :osx, :deployment_target => '10.10'
-  pod 'ObjectBox', '1.1'
+  pod 'ObjectBox'
 end

Example/model-NotesExample-iOS.json

@@ -70,7 +70,7 @@
   "lastRelationId": "0:0",
   "lastSequenceId": "0:0",
   "modelVersion": 5,
-  "modelVersionParserMinimum": 5,
+  "modelVersionParserMinimum": 4,
   "retiredEntityUids": [],
   "retiredIndexUids": [],
   "retiredPropertyUids": [],

Example/model-NotesExample-macOS.json

@@ -70,7 +70,7 @@
   "lastRelationId": "0:0",
   "lastSequenceId": "0:0",
   "modelVersion": 5,
-  "modelVersionParserMinimum": 5,
+  "modelVersionParserMinimum": 4,
   "retiredEntityUids": [],
   "retiredIndexUids": [],
   "retiredPropertyUids": [],

Source/README.md

@@ -17,19 +17,15 @@ Repository Contents
 Setup
 -----
 
-* Install Xcode 11.2+ (Swift 5.1+) with command line tools prepared to build from the shell
-* Run `git submodule update --init --recursive` to get external dependencies
-* Run `make build_swiftlint` to build the build SwiftLint from source into its `external/SwiftLint/.build` directory.
-* The Sourcery submodule contains a `_build.command` script that you can double-click to build a release-ready version of the code generator.
-* Build the framework using the `ObjectBox.xcodeproj`
+* Install latest Xcode (Swift 5.1+) with command line tools prepared to build from the shell
+* Ensure you have homebrew (e.g. setup.sh uses it to install [Carthage](https://github.com/Carthage/Carthage))
+* Run `./setup.sh` (see the [setup.sh](setup.sh) file for more comments if you want)
+* Open Xcode project in ios-framework/ObjectBox.xcodeproj
 
 To build the project for release:
 
-* Install [Carthage][], e.g. using Homebrew: `brew install carthage`
 * Run `cd ios-framework/; make all` to build the frameworks from source with Carthage
-* The `ios-framework/cocoapod/make_podspec_and_zip.command` script can be double-clicked to build a release-ready archive and Podspec file.
-
-[Carthage]: https://github.com/Carthage/Carthage
+* The `ios-framework/cocoapod/make-release.command` script can be double-clicked to build a release-ready archive and Podspec file.
 
 ### Generate the Documentation
 
@@ -46,7 +42,7 @@ 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_podspec_and_zip.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
@@ -103,7 +99,7 @@ You look at and build the framework itself via `ios-framework/ObjectBox.xcodepro
 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 `EntityId<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.
+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
 ------------------------
@@ -117,7 +113,7 @@ Define entities:
 
     import ObjectBox
     final class Person: Entity {
-        var id: Id = 0
+        var id: Id<Person> = 0
         var age: Int
         var name: String
         var birthdate: Date
@@ -136,7 +132,7 @@ Run the code generator. This will configure a `ModelBuilder` and get the `Data`
 Create and set up the ObjectBox types:
 
     let directory: String = "/path/to/the/store"
-    let store: Store = try Store(directoryPath: directory)
+    let store: Store = try! Store(directoryPath: directory)
     let personBox: Box<Person> = store.box(for: Person.self)
 
 This will call into the the generated (!) initializer that uses the private model builder's `modelBytes()` automatically.
@@ -150,10 +146,10 @@ Then you're all set to use entities with ObjectBox:
     assert(person.id == personId) // ID is set after put
 
     // Get by ID
-    assert(try personBox.get(personId) != nil)
+    assert(personBox.get(personId) != nil)
 
     // Get collections of entities
-    _ = try personBox.all()
-    _ = try personBox.query({ Person.name == "Fry" }).build().find()
+    _ = personBox.all()
+    _ = personBox.query({ Person.name == "Fry" }).build().find()
 
 That's it, it works now!

Source/download_dependencies.command

@@ -8,25 +8,27 @@
 
 set -e
 
-version=1.1
-core_version=0.7.2
+# macOS does not have realpath and readlink does not have -f option, so do this instead:
+my_dir=$( cd "$(dirname "$0")" ; pwd -P )
 
-my_dir=`dirname "$0"`
-my_dir=`realpath "${my_dir}"`
-
-cd $my_dir
+cd "$my_dir"
 code_dir="${my_dir}/external/objectbox/"
 dest_dir="${my_dir}/external/objectbox-static/"
-archive_path="${my_dir}/external/objectbox-static.zip"
-OBXLIB_URL_apple_static="https://github.com/objectbox/objectbox-swift/releases/download/v${version}/ObjectBoxCore-static-${core_version}.zip"
 
+# Build?
 if [ -d "$code_dir" ]; then
     echo "Have repository, building."
     "$code_dir/xcode/build_objectbox_core.command" "$dest_dir" release 
     exit
 fi
 
+# Nothing to build, so download instead
 if [ ! -d "${dest_dir}" ] || [ ! -e "${dest_dir}/libObjectBoxCore-iOS.a" ]; then
+    version=1.1
+    core_version=0.7.2
+    archive_path="${my_dir}/external/objectbox-static.zip"
+    OBXLIB_URL_apple_static="https://github.com/objectbox/objectbox-swift/releases/download/v${version}/ObjectBoxCore-static-${core_version}.zip"
+
     mkdir -p "${dest_dir}"
 
     curl -L --fail "${OBXLIB_URL_apple_static}" --output "${archive_path}"

Source/ios-framework/CodeGenTests/ConvertToolTests.sh

@@ -1,15 +1,12 @@
 #!/bin/bash
 
-#  RunToolTests.sh
-#  ObjectBox Swift
-#
-#  Created by Uli Kusterer on 07.12.18.
-#  
-
 echo -n "note: Starting tests at "
 date
 
-mydir=`dirname "$0"`
+# macOS does not have realpath and readlink does not have -f option, so do this instead:
+mydir=$( cd "$(dirname "$0")" ; pwd -P )
+cd "${mydir}"
+
 itestdir="$mydir/../IntegrationTests/"
 
 test_target_num () {

Source/ios-framework/CommonSource/Combine.swift

@@ -133,7 +133,8 @@ extension BoxPublisher {
 extension Query {
     /// Return a Combine publisher for this query that you can subscribe to.
     public var publisher: QueryPublisher<EntityType> {
-        return store.lazyAttachedObject(key: "QueryPublisher<\(EntityType.self)>\(Unmanaged.passUnretained(self).toOpaque())") {
+        let keyString = "QueryPublisher<\(EntityType.self)>\(Unmanaged.passUnretained(self).toOpaque())"
+        return store.lazyAttachedObject(key: keyString) {
             return QueryPublisher<EntityType>(query: self)
         }
     }

Source/ios-framework/Makefile

@@ -23,8 +23,9 @@ integration_tests: download_statics
 	../external/objectbox-swift-generator/_build.command
 	xcodebuild $(XCOPTIONS) build -project ObjectBox.xcodeproj -scheme CodeGenTests -destination 'platform=OS X,arch=x86_64'
 
+# Note: If ObjectBox core repo is present, it won't download but build it instead
 download_statics:
-	@echo "$(BLUE)Downloading static libraries...$(NC)"
+	@echo "$(BLUE)Building/Downloading static libraries...$(NC)"
 	@../download_dependencies.command
 
 build_framework: download_statics

Source/ios-framework/ObjectBox.xcodeproj/project.pbxproj

@@ -771,6 +771,7 @@
 			hasScannedForEncodings = 0;
 			knownRegions = (
 				en,
+				Base,
 			);
 			mainGroup = CB3B3F2720AB4B4B00418618;
 			productRefGroup = CB3B3F3220AB4B4B00418618 /* Products */;