Sync flutter_libs - add iOS support

Author: vaind

sync_flutter_libs/ios/.gitignore

@@ -0,0 +1,3 @@
+# NOTE: comment out before publishing - the binaries need to be uploaded
+Carthage
+*.zip

sync_flutter_libs/ios/Classes/ObjectBoxFlutterPlugin.h

@@ -0,0 +1,4 @@
+#import <Flutter/Flutter.h>
+
+@interface ObjectBoxFlutterPlugin : NSObject<FlutterPlugin>
+@end

sync_flutter_libs/ios/Classes/ObjectBoxFlutterPlugin.m

@@ -0,0 +1,15 @@
+#import "ObjectBoxFlutterPlugin.h"
+#if __has_include(<objectbox_sync_flutter_libs/objectbox_sync_flutter_libs-Swift.h>)
+#import <objectbox_sync_flutter_libs/objectbox_sync_flutter_libs-Swift.h>
+#else
+// Support project import fallback if the generated compatibility header
+// is not copied when this plugin is created as a library.
+// https://forums.swift.org/t/swift-static-libraries-dont-copy-generated-objective-c-header/19816
+#import "objectbox_sync_flutter_libs-Swift.h"
+#endif
+
+@implementation ObjectBoxFlutterPlugin
++ (void)registerWithRegistrar:(NSObject<FlutterPluginRegistrar>*)registrar {
+  [SwiftObjectBoxFlutterPlugin registerWithRegistrar:registrar];
+}
+@end

sync_flutter_libs/ios/Classes/SwiftObjectboxPlugin.swift

@@ -0,0 +1,14 @@
+import Flutter
+import UIKit
+
+public class SwiftObjectBoxFlutterPlugin: NSObject, FlutterPlugin {
+  public static func register(with registrar: FlutterPluginRegistrar) {
+    let channel = FlutterMethodChannel(name: "objectbox_sync_flutter_libs", binaryMessenger: registrar.messenger())
+    let instance = SwiftObjectBoxFlutterPlugin()
+    registrar.addMethodCallDelegate(instance, channel: channel)
+  }
+
+  public func handle(_ call: FlutterMethodCall, result: @escaping FlutterResult) {
+    result("iOS " + UIDevice.current.systemVersion)
+  }
+}

sync_flutter_libs/ios/README.md

@@ -0,0 +1,16 @@
+Contents of this folder is based on `flutter create --template=plugin`.
+It was reduced to the minimum that works for library inclusion by client apps.
+
+Notably, the package depends on `ObjectBox.framework` from ObjectBox Swift distribution, downloading
+a released `ObjectBox-framework-X.Y.Z.zip` archive. 
+
+## Current limitations/TODOs
+There's currently an [issue](https://github.com/flutter/flutter/issues/45778) with Flutter tooling and/or its integration 
+with Cocoapods. In short, an "http" source in the podspec doesn't work - the file has to be available locally.
+ 
+To circumvent this, we're currently including the extracted `ObjectBox.framework` for iOS in the package when publishing 
+to pub.dev. Therefore, you need to run ./ios/download-framework.sh before publishing the package.
+This has the benefit of a "no-setup" iOS support for the ObjectBox users - it works out of the box.
+Also notably, we're only including the bare minimum from the ObjectBox Swift release which means smaller final app size.    
+ 
+Note for contributors: you need to run the above-mentioned script as well to be able to test ObjectBox on iOS.

sync_flutter_libs/ios/download-framework.sh

@@ -0,0 +1,22 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+# NOTE: run this script before publishing
+
+# https://github.com/objectbox/objectbox-swift/releases/
+obxSwiftVersion="1.4.0"
+
+dir=$(dirname "$0")
+
+url="https://github.com/objectbox/objectbox-swift/releases/download/v${obxSwiftVersion}/ObjectBox-framework-${obxSwiftVersion}.zip"
+zip="${dir}/fw.zip"
+
+curl --location --fail --output "${zip}" "${url}"
+
+rm -rf "${dir}/Carthage"
+unzip "${zip}" -d "${dir}" \
+  "Carthage/Build/iOS/ObjectBox.framework/Headers/*" \
+  "Carthage/Build/iOS/ObjectBox.framework/ObjectBox" \
+  "Carthage/Build/iOS/ObjectBox.framework/Info.plist"
+
+rm "${zip}"

sync_flutter_libs/ios/objectbox_sync_flutter_libs.podspec

@@ -0,0 +1,29 @@
+# Provides the compiled framework as released in objectbox-swift. No dart-related sources.
+# Run `pod lib lint objectbox_sync_flutter_libs.podspec' to validate before publishing.
+# This package is not distributed as a CocoaPod, rather it's automatically used by Flutter when creating
+#  ios/{app}.podspec in client applications using objectbox-dart as a dependency.
+# Some of the lines from the original podspec are commented out but left for future reference, in case it stops working.
+Pod::Spec.new do |s|
+  s.name             = 'objectbox_sync_flutter_libs'
+  s.version          = '0.0.1' # not used anywhere - official flutter plugins use the same
+  s.summary          = 'ObjectBox is a super-fast NoSQL ACID compliant object database.'
+  s.homepage         = 'https://objectbox.io'
+  s.license          = 'Apache 2.0, ObjectBox Binary License'
+  s.author           = 'ObjectBox'
+  s.platform         = :ios, '8.0'
+
+  s.source = { :path => '.' }
+  s.source_files = 'Classes/**/*'
+
+  s.dependency 'Flutter'
+
+  # Flutter.framework does not contain a i386 slice. Only x86_64 simulators are supported.
+  s.pod_target_xcconfig = { 'DEFINES_MODULE' => 'YES', 'VALID_ARCHS[sdk=iphonesimulator*]' => 'x86_64' }
+  s.swift_version = '5.0'
+
+  # Get the ObjectBoxC.framework from the objectbox-swift release (see README.md)
+  s.ios.vendored_frameworks = 'Carthage/Build/iOS/ObjectBox.framework'
+
+  # Fail early during build instead of not finding the library during runtime
+  s.xcconfig = { 'OTHER_LDFLAGS' => '-framework ObjectBox' }
+end

sync_flutter_libs/pubspec.yaml

@@ -19,3 +19,5 @@ flutter:
       android:
         package: io.objectbox.flutter
         pluginClass: ObjectBoxFlutterPlugin
+      ios:
+        pluginClass: ObjectBoxFlutterPlugin