nsagora/bundle-info-versioning

Introduction

BundeInfoVersioning is a lightweight package that allows you to observe changes in the Info.plist file when there is an app update.

Requirements

• iOS 8.0+ / macOS 10.10+ / tvOS 9.0+ / watchOS 2.0+
• Xcode 11.0+
• Swift 5.1+

Installation

Swift Package Manager

You can use the [Swift Package Manager][url-swift-pm] to install BundeInfoVersioning by adding it to your Package.swift file:

import PackageDescription

let package = Package(
    name: "YOUR_PROJECT_NAME",
    targets: [],
    dependencies: [
        .Package(url: "https://github.com/nsagora/bundle-info-versioning", majorVersion: 1),
    ]
)

Manually

To manually add this library in your project, just drag the Sources folder into the project tree.

Usage examples

Check for CFBundleShortVersionString updates and show a What's new like screen each time the user updates the app:

import BundleInfoVersioning

let bundleInfoVersioning = BundleInfoVersioning()

bundleInfoVersioning.check(forKeyPath: "CFBundleShortVersionString") { (_ , newVersion: String?) in
    self.showWhatsNew(in: newVersion)
}

Check for CFBundleVersion updates and track in the analytics when the app is installed or updated:

import BundleInfoVersioning

let bundleInfoVersioning = BundleInfoVersioning(bundle: .main)

bundleInfoVersioning.check(forKeyPath: "CFBundleVersion") { (old: String?, new: String?) in
    if old == nil {
        Analytics.install(version: new)
    }
    else {
        Analytics.update(from: old, to: new)
    }
}

Check for a custom key path (e.g. NSAgora/DatabaseVersion) updates and execute the migration code for the data base.

import BundleInfoVersioning

let bundleInfoVersioning = BundleInfoVersioning()

bundleInfoVersioning.check(forKeyPath: "NSAgora/DatabaseVersion") { (_: Int?, _: Int?) in
    self.migrateDataBase()
}

Advanced usage

The BundeInfoVersioning class allows to specify the Bundle on which will be observing the Info.plist changes.

By default it is initialized with the .main bundle.

<details> <summary>Specify bundle</summary>

import BundleInfoVersioning

let bundleInfoVersioning = BundleInfoVersioning(bundle: .main)
bundleInfoVersioning.check(forKeyPath: "CFBundleVersion") { (old: String?, new: String?) in
    if old == nil {
        Analytics.install(version: new)
    }
    else {
        Analytics.update(from: old, to: new)
    }
}

</details>

The BundeInfoVersioning framework comes with a build-in storage system, implemented on top of UserDefaults.

However, if it doesn't fit the apps needs, you can implement a custom storage by conforming to the Storage protocol.

<details>

<summary>Custom storage</summary>

import BundleInfoVersioning

class MyStorage: Storage {
    func set<T>(value: T?, for key: String) {
        UserDefaults.standard.set(value, forKey: key)
    }
    
    func getValue<T>(for key: String) -> T? {
        return UserDefaults.standard.value(forKey: key) as? T
    }
}

let storage = MyStorage()
let bundleInfoVersioning = BundleInfoVersioning(bundle: .main, storage: storage)

bundleInfoVersioning.check(forKeyPath: "NSAgora/DatabaseVersion") { (old: Int?, new: Int?) in
     self.migrateDataBase()
}

</details>

Contribute

We would love you for the contribution to BundleInfoVersioning, check the [`LICENSE`][url-license-file] file for more info.

Meta

This project is developed and maintained by the members of [iOS NSAgora][url-twitter], the community of iOS Developers of Iași, Romania.

Distributed under the [MIT][url-license] license. See [`LICENSE`][url-license-file] for more information.

[https://github.com/nsagora/bundle-info-versioning]

[url-project]: https://github.com/nsagora/bundle-info-versioning [url-docs]: https://nsagora.github.io/bundle-info-versioning/

[url-carthage]: https://github.com/Carthage/Carthage [url-carthage-cartfile]: https://github.com/Carthage/Carthage/blob/master/Documentation/Artifacts.md#cartfile

[url-cocoapods]: https://cocoapods.org [url-cocoapods-podfile]: https://guides.cocoapods.org/syntax/podfile.html

[url-swift-pm]: https://swift.org/package-manager

[url-license]: http://choosealicense.com/licenses/mit/ [url-license-file]: https://github.com/nsagora/bundle-info-versioning/blob/develop/LICENSE [url-twitter]: https://twitter.com/nsagora [url-travis]: https://travis-ci.org/nsagora/bundle-info-versioning [url-codecov]: https://codecov.io/gh/nsagora/bundle-info-versioning [url-homebrew]: http://brew.sh/

[badge-license]: https://img.shields.io/badge/license-MIT-blue.svg?style=flat [badge-twitter]: https://img.shields.io/badge/twitter-%40nsgaora-blue.svg?style=flat [badge-travis]: https://travis-ci.org/nsagora/validation-toolkit.svg?branch=develop [badge-codecov]: https://codecov.io/gh/nsagora/validation-toolkit/branch/develop/graph/badge.svg [badge-swift-pm]: https://img.shields.io/badge/swift%20pm-compatible-4BC51D.svg?style=flat [badge-carthage]: https://img.shields.io/badge/carthage-compatible-4BC51D.svg?style=flat [badge-version]: https://img.shields.io/badge/version-0.1.0-blue.svg?style=flat [badge-docs]: https://img.shields.io/badge/docs-100%25-green.svg?style=flat

Package Metadata

Repository: nsagora/bundle-info-versioning

Default branch: master

README: README.md