feat: introduce spm (#45)

* feat: introduce spm

.github/workflows/build.yaml

@@ -7,22 +7,52 @@ name: Buid iOS app
 on:
   workflow_call:
 
+env:
+  spm_dir: './SPM'
+  cocoapods_dir: './CocoaPods'
+  platform: 'iOS Simulator'
+  device_name: 'iPhone 14'
+  ios_version: '16.4'
+
 # clear out default permissions
 permissions: {}
 
 jobs:
-  build:
-    name: Buid iOS app
+  build-spm:
+    name: Buid iOS app - SPM
     permissions:
       contents: read
-    runs-on: macos-latest
+    runs-on: macos-13
+    defaults:
+      run:
+        working-directory: ${{ env.spm_dir }}
     steps:
       - uses: actions/checkout@v3
 
+      - name: Build iOS app
+        run: >
+          xcodebuild
+          -project 'TomTomSDKExamples.xcodeproj'
+          -scheme 'TomTomSDKExamples'
+          -destination 'platform=${{ env.platform }},name=${{ env.device_name }},OS=${{ env.ios_version }}'
+
+  build-cocoapods:
+    name: Buid iOS app - CocoaPods
+    permissions:
+      contents: read
+    runs-on: macos-13
+    defaults:
+      run:
+        working-directory:  ${{ env.cocoapods_dir }}
+    steps:
+      - uses: actions/checkout@v4
+
       - name: Setup Ruby
         uses: ruby/setup-ruby@v1
         with:
           bundler-cache: true
+        env:
+          BUNDLE_GEMFILE: '${{ env.cocoapods_dir }}/Gemfile'
 
       - name: Add Cocoapods repository
         # Ensure we have repos dir created
@@ -39,4 +69,4 @@ jobs:
           xcodebuild
           -workspace 'TomTomSDKExamples.xcworkspace'
           -scheme 'TomTomSDKExamples'
-          -destination 'platform=iOS Simulator,name=iPhone 14'
+          -destination 'platform=${{ env.platform }},name=${{ env.device_name }},OS=${{ env.ios_version }}'

.gitignore

@@ -93,7 +93,4 @@ iOSInjectionProject/
 *.DS_Store
 
 # Bundle gems 
-**/bundle
-
-## Offline Map files #
-Map/
+**/bundle

Gemfile → CocoaPods/Gemfile

@@ -1,4 +1,4 @@
 source 'https://rubygems.org'
-ruby "~>#{File.read(File.join(__dir__, ".ruby-version")).strip}"
+ruby "~>#{File.read(File.join(__dir__, "../.ruby-version")).strip}"
 gem "cocoapods", "1.11.3"
 gem "cocoapods-art"

CocoaPods/README.md

@@ -0,0 +1,55 @@
+## Development setup
+
+Once you have gained access, set up the development environment by following:
+
+1. We recommend using `rbenv` to handle `ruby` selection/installation.
+   1. Install `rbenv`
+   ```zsh
+   brew install rbenv
+   ```
+   2. Clone the [tomtom-navigation-ios-examples] repository
+   ```zsh
+   git clone [email protected]:tomtom-international/tomtom-navigation-ios-examples.git
+   ```   
+   3. Change directory to the related folder of the recently cloned repository and install `ruby` via `rbenv`
+   ```zsh
+   cd tomtom-navigation-ios-examples/CocoaPods
+   rbenv install
+   ```
+   4. Load `rbenv` to your shell
+   ```zsh
+   echo 'eval "$(rbenv init - zsh)"' >> ~/.zshrc
+   ```
+   Above command assumes that `zsh` is being used. If a different shell is being used, then you can find 
+   commands for most common shells in [rbenv documentation].
+
+   5. Update `bundler`
+   ```zsh
+   gem install bundler
+   ```
+   6. ***reload*** your shell so the `rbenv` can extend `PATH` accordingly.
+
+2. Install project's `gem` dependencies via `bundler`
+   ```zsh
+   bundle install
+   ```
+
+3. Add a reference to the [CocoaPods] private repository:
+   ```zsh
+   bundle exec pod repo-art add tomtom-sdk-cocoapods "https://repositories.tomtom.com/artifactory/api/pods/cocoapods"
+   ```
+
+4. Install the dependencies by executing the following command in **the project folder**.
+    ```zsh
+    bundle exec pod install
+    ```
+
+5. To update the SDK version, run the command:
+    ```zsh
+    bundle exec pod repo-art update tomtom-sdk-cocoapods
+    ```
+6. Open the project’s `xcworkspace` and start developing your awesome application.
+
+[CocoaPods]: (https://guides.cocoapods.org/using/getting-started.html)
+[rbenv documentation]: https://github.com/rbenv/rbenv#readme
+[tomtom-navigation-ios-examples]: https://github.com/tomtom-international/tomtom-navigation-ios-examples

README.md

@@ -10,57 +10,11 @@ Hello and welcome to this repository with examples showcasing the [TomTom Naviga
 
 ## Development setup
 
-Once you have gained access, set up the development environment by following:
+Before beginning, make sure you have Xcode 13 or 14 installed.
 
-1. Install Xcode if you don't already have it. Supported versions of Xcode are 13 to 14, inclusive.
-
-2. We recommend using `rbenv` to handle `ruby` selection/installation.
-   1. Install `rbenv`
-   ```zsh
-   brew install rbenv
-   ```
-   2. Clone the [tomtom-navigation-ios-examples] repository
-   ```zsh
-   git clone https://github.com/tomtom-international/tomtom-navigation-ios-examples.git
-   ```   
-   3. Change directory to the recently cloned repository and install `ruby` via `rbenv`
-   ```zsh
-   cd tomtom-navigation-ios-examples
-   rbenv install
-   ```
-   4. Load `rbenv` to your shell
-   ```zsh
-   echo 'eval "$(rbenv init - zsh)"' >> ~/.zshrc
-   ```
-   Above command assumes that `zsh` is being used. If a different shell is being used, then you can find 
-   commands for most common shells in [rbenv documentation].
-
-   5. Update `bundler`
-   ```zsh
-   gem install bundler
-   ```
-   6. Ensure you ***reload*** your shell so the `rbenv` can extend `PATH` accordingly.
-
-3. Install project's `gem` dependencies via `bundler`
-   ```zsh
-   bundle install
-   ```
-
-4. Add a reference to the [Cocoapods] private repository:
-   ```zsh
-   bundle exec pod repo-art add tomtom-sdk-cocoapods "https://repositories.tomtom.com/artifactory/api/pods/cocoapods"
-   ```
-
-5. Install the dependencies by executing the following command in **the project folder**.
-    ```
-    bundle exec pod install
-    ```
-
-6. To update the SDK version, run the command:
-    ```
-    bundle exec pod repo-art update tomtom-sdk-cocoapods
-    ```
-7. Open the project’s `xcworkspace` and start developing your awesome application.
+SPM or CocoaPods can be used to install the Navigation SDK. Both configurations are available in the examples. Please navigate to the related directory and find the project setup configuration.
+- [Project setup for SPM]
+- [Project setup for CocoaPods]
 
 ## API Keys
 
@@ -86,13 +40,10 @@ If you have a **black screen** when launching the Basic driving app, please foll
 - Check that your `API key` is valid for the requested features
 - Check your internet connection
 
----
-
-[Cocoapods]: (https://guides.cocoapods.org/using/getting-started.html)
 [contact us]: https://developer.tomtom.com/tomtom-sdk-for-ios/request-access
 [How to get a TomTom API Key]: https://developer.tomtom.com/how-to-get-tomtom-api-key
-[rbenv documentation]: https://github.com/rbenv/rbenv#readme
 [register]: https://developer.tomtom.com/user/register
-[tomtom-navigation-ios-examples]: https://github.com/tomtom-international/tomtom-navigation-ios-examples
 [TomTom Navigation SDK for iOS]: https://developer.tomtom.com/ios/navigation/documentation/overview/introduction
-[TomTom Developer Portal]: https://developer.tomtom.com/user/me/apps
+[TomTom Developer Portal]: https://developer.tomtom.com/user/me/apps
+[Project setup for SPM]: /SPM
+[Project setup for CocoaPods]: /CocoaPods

SPM/README.md

@@ -0,0 +1,11 @@
+## Development setup
+
+Once you have gained access, set up the development environment by following:
+
+1. Clone the [tomtom-navigation-ios-examples] repository
+   ```zsh
+   git clone [email protected]:tomtom-international/tomtom-navigation-ios-examples.git
+   ```   
+2. Open the project’s `xcodeproj` in the `SPM` folder and start developing your awesome application.
+
+[tomtom-navigation-ios-examples]: https://github.com/tomtom-international/tomtom-navigation-ios-examples