Merge pull request #33 from 4brunu/feature/mutable-observable

Migrate to Observable and MutableObservable

Example/Observable/Views/CollectionView.swift

@@ -4,8 +4,9 @@ import Observable
 
 class CollectionView: UICollectionView {
 
-    @Observable private var sPercentage:Float = 0
+    @MutableObservable private var sPercentage:Float = 0
 
+    var scrollPercentage: Observable<Float> {
     var scrollPercentage: ImmutableObservable<Float> {
         return _sPercentage
     }

Example/Observable/Views/Slider.swift

@@ -4,9 +4,9 @@ import Observable
 
 class Slider: UISlider {
 
-    @Observable private var positionValue:CGFloat = 0
+    @MutableObservable private var positionValue:CGFloat = 0
 
-    var position:ImmutableObservable<CGFloat> {
+    var position:Observable<CGFloat> {
         return _positionValue
     }
 

Observable/Classes/Observable.swift

@@ -1,6 +1,6 @@
 import Foundation
 
-public class ImmutableObservable<T> {
+public class Observable<T> {
 
     public typealias Observer = (T, T?) -> Void
 
@@ -61,12 +61,18 @@ public class ImmutableObservable<T> {
         observers.removeAll()
     }
 
-    public func asImmutable() -> ImmutableObservable<T> {
+    @available(*, deprecated, renamed: "asObservable")
+    public func asImmutable() -> Observable<T> {
+        return self
+    }
+
+    public func asObservable() -> Observable<T> {
         return self
     }
 }
+
 @propertyWrapper
-public class Observable<T>: ImmutableObservable<T> {
+public class MutableObservable<T>: Observable<T> {
 
     override public var wrappedValue: T {
         get {

README.md

@@ -5,27 +5,20 @@
 **Observable** is the easiest way to observe values in Swift.
 
 ## How to
-
-### Create an Observable 
-
-```swift
-var position = Observable(CGPoint.zero)
-```
-
-### Create an ImmutableObservable 
-Using `ImmutableObservable` we can create an "readonly"-Observable, in order to avoid side-effects on our internal API. 
-
+### Create an Observable and MutableObservable 
+Using `MutableObservable` you can create and observe event.
+Using `Observable` you can observe event, in order to avoid side-effects on our internal API. 
 ```swift
 class SomeViewModel {
     /// Public property, that can be read / observed by external classes (e.g. view controller), but not changed.
-    var position: ImmutableObservable<CGPoint> = {
+    var position: Observable<CGPoint> = {
         return positionSubject
     }
-    // Or use the helper method Observable.asImmutable()
-    // lazy var position = positionSubject.asImmutable()
+    // Or use the helper method Observable.asObservable()
+    // lazy var position = positionSubject.asObservable()
 
     /// Private property, that can be changed / observed inside this view model.
-    private let positionSubject = Observable(CGPoint.zero)
+    private let positionSubject = MutableObservable(CGPoint.zero)
 }
 ```