Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/JensRavens/Interstellar
Simple and lightweight Functional Reactive Coding in Swift for the rest of us
https://github.com/JensRavens/Interstellar
Last synced: about 1 month ago
JSON representation
Simple and lightweight Functional Reactive Coding in Swift for the rest of us
- Host: GitHub
- URL: https://github.com/JensRavens/Interstellar
- Owner: JensRavens
- License: mit
- Archived: true
- Created: 2015-05-17T21:33:35.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2019-04-23T15:48:10.000Z (over 5 years ago)
- Last Synced: 2024-07-18T17:42:39.569Z (2 months ago)
- Language: Swift
- Size: 218 KB
- Stars: 1,079
- Watchers: 26
- Forks: 136
- Open Issues: 8
-
Metadata Files:
- Readme: Readme.md
- License: LICENSE
Awesome Lists containing this project
- awesome-functional-programming - **Interstellar** - Simple and lightweight Functional Reactive Coding in Swift for the rest of us
- awesome-functional-programming - **Interstellar** - Simple and lightweight Functional Reactive Coding in Swift for the rest of us
- awesome-ios-star - Interstellar - Simple and lightweight Functional Reactive Coding in Swift for the rest of us. (Reactive Programming / Prototyping)
- awesome-ios - Interstellar - Simple and lightweight Functional Reactive Coding in Swift for the rest of us. (Reactive Programming / Prototyping)
README
[](https://travis-ci.org/JensRavens/Interstellar)
[](https://cocoapods.org/pods/Interstellar)
[](https://cocoapods.org/pods/Interstellar)
[](https://github.com/Carthage/Carthage)
The simplest `Observable` implementation for Functional Reactive Programming you will ever find.
> This library does not use the term FRP (Functional Reactive Programming) in the way it was
> defined by Conal Elliot, but as a paradigm that is both functional and reactive. Read more
> about the difference at [Why I cannot say FRP but I just did](https://medium.com/@andrestaltz/why-i-cannot-say-frp-but-i-just-did-d5ffaa23973b).
## Features
- [x] Lightweight, simple, cross plattform FRP
- [x] Multithreading with GCD becomes a breeze
- [x] Most of your methods will conform to the needed syntax anyway.
- [x] Swift 3 and 4 compatibility
- [x] Multithreading with GCD becomes a breeze via WarpDrive
- [x] Supports Linux and `swift build`
- [x] BYOR™-technology (Bring Your Own `Result`)
## Requirements
- iOS 7.0+ / Mac OS X 10.10+ / Ubuntu 14.10
- Xcode 8
---
## Usage
> For a full guide on how this implementation works see the series of blog posts about
> [Functional Reactive Programming in Swift](http://jensravens.de/series/functional-reactive-programming-in-swift/)
> or the talk at UIKonf 2015 [How to use Functional Reactive Programming without Black Magic](http://jensravens.de/uikonf-talk/).
### Creating and updating a signal
``` swift
let text = Observable()
text.subscribe { string in
print("Hello \(string)")
}
text.update("World")
```
### Mapping and transforming observables
``` swift
let text = Observable()
let greeting = text.map { subject in
return "Hello \(subject)"
}
greeting.subscribe { text in
print(text)
}
text.update("World")
```
### Use functions as transforms
``` swift
let text = Observable()
let greet: (String)->String = { subject in
return "Hello \(subject)"
}
text
.map(greet)
.subscribe { text in
print(text)
}
text.update("World")
```
### Handle errors in sequences of functions
``` swift
let text = Observable()
func greetMaybe(subject: String) throws -> String {
if subject.characters.count % 2 == 0 {
return "Hello \(subject)"
} else {
throw NSError(domain: "Don't feel like greeting you.", code: 401, userInfo: nil)
}
}
text
.map(greetMaybe)
.then { text in
print(text)
}
.error { error in
print("There was a greeting error")
}
text.update("World")
```
### This also works for asynchronous functions
``` swift
let text = Observable()
func greetMaybe(subject: String) -> Observable> {
if subject.characters.count % 2 == 0 {
return Observable(.success("Hello \(subject)"))
} else {
let error = NSError(domain: "Don't feel like greeting you.", code: 401, userInfo: nil)
return Observable(.error(error))
}
}
text
.flatMap(greetMaybe)
.then { text in
print(text)
}
.error { _ in
print("There was a greeting error")
}
text.update(.success("World"))
```
## Flatmap is also available on observables
```swift
let baseCost = Observable()
let total = baseCost
.flatMap { base in
// Marks up the price
return Observable(base * 2)
}
.map { amount in
// Adds sales tax
return Double(amount) * 1.09
}
total.subscribe { total in
print("Your total is: \(total)")
}
baseCost.update(10) // prints "Your total is: 21.8"
baseCost.update(122) // prints "Your total is: 265.96"
```
---
## Communication
- If you **found a bug**, open an issue.
- If you **have a feature request**, open an issue.
- If you **want to contribute**, open an issue or submit a pull request.
## Installation
> **Dynamic frameworks on iOS require a minimum deployment target of iOS 8 or later.**
> To use Interstellar with a project targeting iOS 7, you must include all Swift files directly in your project.
### CocoaPods
[CocoaPods](http://cocoapods.org) is a dependency manager for Cocoa projects. You can install it with the following command:
``` bash
$ gem install cocoapods
```
To integrate Interstellar into your Xcode project using CocoaPods, specify it in your `Podfile`:
``` ruby
source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '8.0'
use_frameworks!
pod 'Interstellar'
```
Then, run the following command:
``` bash
$ pod install
```
### swift build
Add Interstellar to your `Package.swift`:
```swift
import PackageDescription
let package = Package(
name: "Your Awesome App",
targets: [],
dependencies: [
.Package(url: "https://github.com/jensravens/interstellar.git", majorVersion: 2),
]
)
```
### Carthage
[Carthage](https://github.com/Carthage/Carthage) is a decentralized dependency manager that automates the process of adding frameworks to your Cocoa application.
You can install Carthage with [Homebrew](http://brew.sh/) using the following command:
``` bash
$ brew update
$ brew install carthage
```
To integrate Interstellar into your Xcode project using Carthage, specify it in your `Cartfile`:
``` ogdl
github "JensRavens/Interstellar"
```
---
## FAQ
### Why use Interstellar instead of [insert your favorite FRP framework here]?
Interstellar is meant to be lightweight. There are no UIKit bindings, no heavy constructs - just a simple `Observable`. Therefore it's easy to understand and portable (there is no dependency except Foundation).
Also Interstellar is supporting BYOR (bring your own `Result`). Due to its protocol based implementation you can use result types from other frameworks directly with Interstellar methods.
* * *
## Credits
Interstellar is owned and maintained by [Jens Ravens](http://jensravens.de).
## Changelog
- *1.1* added compability with Swift 2. Also renamed bind to flatMap to be consistent with `Optional` and `Array`.
- *1.2* `Thread` was moved to a new project called [WarpDrive](https://github.com/jensravens/warpdrive)
- *1.3* WarpDrive has been merged into Interstellar. Also Interstellar is now divided into subspecs via cocoapods to make it easy to just select the needed components. The basic signal library is now "Interstellar/Core".
- *1.4* Support `swift build` and the new Swift package manager, including support for Linux. Also removed deprecated bind methods.
- *2* Introducing `Observable`, the successor of Signal. Use the `observable` property on signals to migrate your code from `Signal`. Also adding Linux support for Warpdrive and introduce BYOR™-technology (Bring Your Own `Result`).
- *2.1* Update to Swift 3.2 to make it compatible with Swift 4.
- 2.2 Update to Swift 4.1, fixing build warnings on Xcode 9.3 (Maintains backwards compatibility with Swift 3.3 projects).
## License
Interstellar is released under the MIT license. See LICENSE for details.