Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/raginmari/ragversionnumber

Conveniently creates version numbers from different inputs and compares them in helpful ways.
https://github.com/raginmari/ragversionnumber

appstore ios swift3 versioning

Last synced: about 2 months ago
JSON representation

Conveniently creates version numbers from different inputs and compares them in helpful ways.

Host: GitHub
URL: https://github.com/raginmari/ragversionnumber
Owner: raginmari
License: mit
Archived: true
Created: 2017-10-24T21:56:18.000Z (about 7 years ago)
Default Branch: master
Last Pushed: 2019-11-20T07:59:23.000Z (about 5 years ago)
Last Synced: 2024-03-15T02:12:39.438Z (8 months ago)
Topics: appstore, ios, swift3, versioning
Language: Swift
Homepage:
Size: 69.3 KB
Stars: 0
Watchers: 3
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # RAGVersionNumber

[![CI Status](http://img.shields.io/travis/raginmari/RAGVersionNumber.svg?style=flat)](https://travis-ci.org/raginmari/RAGVersionNumber)

[![codecov](https://codecov.io/gh/raginmari/RAGVersionNumber/branch/master/graph/badge.svg)](https://codecov.io/gh/raginmari/RAGVersionNumber)

[![Version](https://img.shields.io/cocoapods/v/RAGVersionNumber.svg?style=flat)](http://cocoapods.org/pods/RAGVersionNumber)

[![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)

[![License](https://img.shields.io/cocoapods/l/RAGVersionNumber.svg?style=flat)](http://cocoapods.org/pods/RAGVersionNumber)

[![Platform](https://img.shields.io/cocoapods/p/RAGVersionNumber.svg?style=flat)](http://cocoapods.org/pods/RAGVersionNumber)

⛔️DEPRECATED

This repository has been deprecated and is (obviously) no longer in active development. The reason is that that version 1.0 had been released prematurely and I intend to set up a new project with proper version handling. The decision was influenced by the fact that the library has neither stars nor forks.

## Example

To run the example project, clone the repo, and run `pod install` from the Example directory first.

## Requirements

Written in Swift 3. Requires iOS 9 (deployment target).

## Installation

RAGVersionNumber is available through [CocoaPods](http://cocoapods.org). To install

it, simply add the following line to your Podfile:

```ruby

pod 'RAGVersionNumber'

```

## How to use

Install the pod and import the module `RAGVersionNumber`.

The **core feature** of the pod is the convenient representation of version numbers (consisting of major, minor and patch components) by the type `VersionNumber`. The type has a number of initializers which facilitate creation of version numbers from different sources:

- `init(major:minor:patch:)`

 Sets explicit component values. The parameters `minor` and `patch` default to 0.

- `init?(string:)`

 Parses the given version number string, e.g. "1.2.3" (resulting in version number 1.2.3).

- `init?(bundle:)`

 Fetches the string value of `CFBundleShortVersionString` from the given application bundle.

The type `VersionNumber` conforms to `Comparable`. Moreover, there are a couple of convenience methods which check if a given version number is a patch, minor or major successor of the receiver of the call:

- `isPatchSuccessor(of:)`

- `isMinorSuccessor(of:)`

- `isMajorSuccessor(of:)`

See the respective documentation for details.

#### App Store version number

An additional feature of the pod is the lookup of the version number of an app (identified by its bundle identifier) in the App Store. In order to do so, create an instance of the class `AppStoreVersionNumberLookup`. The default parameters of its single initializer should be used.

The class has a single public method `performLookup(withBundleIdentifier:appStoreCountryCode:completion:)` which performs an asynchronous App Store lookup using the iTunes lookup API and passes the result to the given completion. An internet connection is obviously required.

You have to provide the bundle identifier of the app to the first parameter. The App Store country code is optional (its default is "us" i.e. the US App Store). If the app is not available in the App Store in the given country, the method will fail.

The third parameter receives the result of the asynchronous call which is of type `AppStoreVersionNumberLookup.Result` and contains either the version number or an error. See the documentation for the kinds of error to expect.

## Author

raginmari, [email protected]

## License

RAGVersionNumber is available under the MIT license. See the LICENSE file for more info.