Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/freenowtech/sensor
A fresh look at iOS development
https://github.com/freenowtech/sensor
architecture cocoapods ios mobile mobile-development mytaxi reactive rxswift swift swift-package-manager
Last synced: 10 days ago
JSON representation
A fresh look at iOS development
- Host: GitHub
- URL: https://github.com/freenowtech/sensor
- Owner: freenowtech
- License: apache-2.0
- Created: 2018-11-30T15:45:03.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2022-08-19T13:00:04.000Z (over 2 years ago)
- Last Synced: 2024-11-18T05:33:25.652Z (about 1 month ago)
- Topics: architecture, cocoapods, ios, mobile, mobile-development, mytaxi, reactive, rxswift, swift, swift-package-manager
- Language: Swift
- Homepage:
- Size: 41 MB
- Stars: 39
- Watchers: 14
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Sensor
Nowadays, mobile applications become increasingly powerful and complex, rich of features that try to improve the user's experience. But power is nothing without control: the more powerful (and complex) the app is, the highest the chance it can end up in an inconsistent state.
The good news is our **Sensor Architecture**: an elegant and a good way to organise your code when working with complex applications.
With the ability to define all the possible states, of each feature of a mobile application, the chances to end up in an inconsistent state are most unlikely. Thanks to the concept of the State Machine and its deterministic behaviour, we can be sure that all the transitions from a state to another state are regulated by a finite set of events that can happen.
The **Sensor** framework comes with batteries included so you can start writing safe apps straight away.
The **SensorTest** framework includes some goodies to help you write unit tests in a breeze.
## Learn more
**[Read the docs](Docs/sensor.md)**
[Video with a presentation of this architecture](https://www.youtube.com/watch?v=Dp2LQo2DOcg&t=15s)
[Presentation used on the video](https://github.com/freenowtech/Sensor/blob/master/CodingTestableAppsOnSteroids.pdf)
[How to contribute to Sensor](CONTRIBUTING.md)
## Setup
### Cocoapods
To use the **Sensor** framework, add the following line to the target of your app on your Podfile:
`pod 'Sensor', '0.1.1'`
In your app, add the following import:
`import Sensor`
To use the **SensorTest** framework, add the following line to the test target on your Podfile:
`pod 'SensorTest', '0.1.1'`
In your tests, add the following import:
`import SensorTest`
### Swift Package Manager
Add the following line to your package dependencies:
`.package(url: "https://github.com/freenowtech/Sensor.git", from: "0.1.1"),`
Add `Sensor` to your main target dependencies. Add `SensorTest` to your test target dependencies.
The minimum macOS version is 10.13.
Example `Package.swift` file:
```swift
// swift-tools-version:5.0
// The swift-tools-version declares the minimum version of Swift required to build this package.
import PackageDescription
let package = Package(
name: "Package",
platforms: [
.macOS(.v10_13),
],
dependencies: [
.package(url: "https://github.com/freenowtech/Sensor.git", from: "0.1.1"),
],
targets: [
.target(
name: "Target",
dependencies: ["Sensor"]),
.testTarget(
name: "TestTarget",
dependencies: ["Target", "SensorTest"]),
]
)
```
## Contributors
* Stefan Bieschewski
* David Cortés [
](https://github.com/davebcn87)
* Fabio Cuomo
* Mounir Dellagi
* Lluís Gómez [](https://github.com/lluisgh28)
* Carlos Nuñez
* Ferran Pujol [](https://github.com/ferranpujolcamins) [
](https://twitter.com/ferranpujolca)
* Adrian Zdanowicz
Project milestones:
* David Cortés & Stefan Bieschewski
* First version of a reactive state management without feedback loop.
* Stefan Bieschewski
* First version of Driver+Reducible using RxFeedback.
* Mounir Dellagi
* First example using Sensor with a login app.
* Stefan Bieschewski
* Added Context and TriggerableEffects as enums to make the reducer testable.
* Lluís Gómez
* Preparing examples with a real app feature.
* David Cortés
* Make SensorTest show a diff for unequal values.
* Ferran Pujol
* SensorTest improvements and Sensor unit tests.
* Ferran Pujol
* Add unique ID to effects so they can be triggered more than once.
* Ferran Pujol
* Sensor DSL & Sensor 0.2.0 changes.