Complete transition from Units terminology to Traits.

Renaming RxSwift/Units to RxSwift/Traits and RxCocoa/CocoaUnits to RxCocoa/Traits.
GetToSet · Apr 4, 2017 · a87a6c5 · a87a6c5
1 parent 6e18903
commit a87a6c5
Show file tree

Hide file tree

Showing 41 changed files with 59 additions and 57 deletions.
diff --git a/.jazzy.yml b/.jazzy.yml
@@ -179,30 +179,10 @@ custom_categories:
  - ReplaySubject
  - SubjectType
  - Variable
-- name: RxSwift/Units
+- name: RxSwift/Traits
  children:
  - PrimitiveSequence+Zip+arity
  - PrimitiveSequence
-- name: RxCocoa/CocoaUnits
- children:
- - ControlEvent
- - ControlProperty
- - UIBindingObserver
-- name: RxCocoa/CocoaUnits/Driver
- children:
- - ControlEvent+Driver
- - ControlProperty+Driver
- - Driver+Subscription
- - Driver
- - ObservableConvertibleType+Driver
- - Variable+Driver
-- name: RxCocoa/CocoaUnits/SharedSequence
- children:
- - ObservableConvertibleType+SharedSequence
- - SharedSequence+Operators+arity
- - SharedSequence+Operators
- - SharedSequence
- - Variable+SharedSequence
 - name: RxCocoa/Common
  children:
  - ControlTarget
@@ -301,3 +281,23 @@ custom_categories:
 - name: RxCocoa/Platform
  children:
  - DispatchQueue+Extensions
+- name: RxCocoa/Traits
+ children:
+ - ControlEvent
+ - ControlProperty
+ - UIBindingObserver
+- name: RxCocoa/Traits/Driver
+ children:
+ - ControlEvent+Driver
+ - ControlProperty+Driver
+ - Driver+Subscription
+ - Driver
+ - ObservableConvertibleType+Driver
+ - Variable+Driver
+- name: RxCocoa/Traits/SharedSequence
+ children:
+ - ObservableConvertibleType+SharedSequence
+ - SharedSequence+Operators+arity
+ - SharedSequence+Operators
+ - SharedSequence
+ - Variable+SharedSequence
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,7 @@ All notable changes to this project will be documented in this file.
 
 ## Master
 
+* Rename Units as Traits and update the documentation for Single, Completable & Maybe.
 * Deprecates `bindTo` in favor of `bind(to:)`.
 * Adds [`materialize()`](http://reactivex.io/documentation/operators/materialize-dematerialize.html) operator
 

diff --git a/Documentation/GettingStarted.md b/Documentation/GettingStarted.md
@@ -21,7 +21,8 @@ This project tries to be consistent with [ReactiveX.io](http://reactivex.io/). T
 1. [UI layer tips](#ui-layer-tips)
 1. [Making HTTP requests](#making-http-requests)
 1. [RxDataSources](#rxdatasources)
-1. [Driver](Units.md#driver-unit)
+1. [Driver](Traits.md#driver)
+1. [Traits: Driver, Single, Maybe, Completable](Traits.md)
 1. [Examples](Examples.md)
 
 # Observables aka Sequences

diff --git a/Rx.xcodeproj/project.pbxproj b/Rx.xcodeproj/project.pbxproj
@@ -2220,7 +2220,7 @@
  C8093CB41B8A72BE0088E94D /* Schedulers */,
  C8093CBD1B8A72BE0088E94D /* Subjects */,
  C85106851C2D54B70075150C /* Extensions */,
- C81A09851E6C701700900B3B /* Units */,
+ C81A09851E6C701700900B3B /* Traits */,
  C8093C661B8A72BE0088E94D /* Info.plist */,
  C81A09801E6C6B2400900B3B /* Deprecated.swift */,
  );
@@ -2407,7 +2407,7 @@
  C89AB2781DAACE490065FBE6 /* RxCocoa.h */,
  C89AB2261DAAC33F0065FBE6 /* RxCocoa.swift */,
  C8A81C9E1E05E82C0008DEF4 /* Platform */,
- C89AB1AA1DAAC3350065FBE6 /* CocoaUnits */,
+ C89AB1AA1DAAC3350065FBE6 /* Traits */,
  C8093E811B8A732E0088E94D /* Common */,
  C89AB1BC1DAAC3350065FBE6 /* Foundation */,
  C88253EE1B8A752B00B02D69 /* iOS */,
@@ -2450,14 +2450,14 @@
  path = RxBlocking;
  sourceTree = "<group>";
  };
- C81A09851E6C701700900B3B /* Units */ = {
+ C81A09851E6C701700900B3B /* Traits */ = {
  isa = PBXGroup;
  children = (
  C81A09861E6C702700900B3B /* PrimitiveSequence.swift */,
  C89814751E75A18A0035949C /* PrimitiveSequence+Zip+arity.tt */,
  C89814771E75A7D70035949C /* PrimitiveSequence+Zip+arity.swift */,
  );
- path = Units;
+ path = Traits;
  sourceTree = "<group>";
  };
  C81B6AA71DB2C15C0047CF86 /* Platform */ = {
@@ -2829,7 +2829,7 @@
  path = Proxies;
  sourceTree = "<group>";
  };
- C89AB1AA1DAAC3350065FBE6 /* CocoaUnits */ = {
+ C89AB1AA1DAAC3350065FBE6 /* Traits */ = {
  isa = PBXGroup;
  children = (
  C89AB1AB1DAAC3350065FBE6 /* ControlEvent.swift */,
@@ -2838,7 +2838,7 @@
  C89AB1B41DAAC3350065FBE6 /* SharedSequence */,
  C89AB1BB1DAAC3350065FBE6 /* UIBindingObserver.swift */,
  );
- path = CocoaUnits;
+ path = Traits;
  sourceTree = "<group>";
  };
  C89AB1AD1DAAC3350065FBE6 /* Driver */ = {

diff --git a/Rx.xcworkspace/contents.xcworkspacedata b/Rx.xcworkspace/contents.xcworkspacedata
diff --git a/RxCocoa.podspec b/RxCocoa.podspec
@@ -19,7 +19,7 @@ Pod::Spec.new do |s|
  s.watchos.deployment_target = '2.0'
  s.tvos.deployment_target = '9.0'
 
- s.source_files = 'RxCocoa/RxCocoa.h', 'RxCocoa/RxCocoa.swift', 'RxCocoa/Common/**/*.{swift,h,m}', 'RxCocoa/CocoaUnits/**/*.{swift,h,m}', 'RxCocoa/Foundation/**/*.{swift,h,m}', 'RxCocoa/Runtime/**/*.{swift,h,m}', 'Platform/**/*.swift'
+ s.source_files = 'RxCocoa/RxCocoa.h', 'RxCocoa/RxCocoa.swift', 'RxCocoa/Common/**/*.{swift,h,m}', 'RxCocoa/Traits/**/*.{swift,h,m}', 'RxCocoa/Foundation/**/*.{swift,h,m}', 'RxCocoa/Runtime/**/*.{swift,h,m}', 'Platform/**/*.swift'
  s.exclude_files = 'RxCocoa/Platform/**/*.swift'
 
  s.ios.source_files = 'RxCocoa/iOS/**/*.swift'

diff --git a/RxCocoa/CocoaUnits/ControlEvent.swift → RxCocoa/Traits/ControlEvent.swift b/RxCocoa/CocoaUnits/ControlEvent.swift → RxCocoa/Traits/ControlEvent.swift
@@ -18,7 +18,7 @@ public protocol ControlEventType : ObservableType {
 }
 
 /**
- Unit for `Observable`/`ObservableType` that represents event on UI element.
+ Trait for `Observable`/`ObservableType` that represents event on UI element.
 
  It's properties are:
 
@@ -33,7 +33,7 @@ public protocol ControlEventType : ObservableType {
 
  **It is implementor's responsibility to make sure that that all other properties enumerated above are satisfied.**
 
- **If they aren't, then using this unit communicates wrong properties and could potentially break someone's code.**
+ **If they aren't, then using this trait communicates wrong properties and could potentially break someone's code.**
 
  **In case `events` observable sequence that is being passed into initializer doesn't satisfy all enumerated
  properties, please don't use this unit.**

diff --git a/RxCocoa/CocoaUnits/ControlProperty.swift → RxCocoa/Traits/ControlProperty.swift b/RxCocoa/CocoaUnits/ControlProperty.swift → RxCocoa/Traits/ControlProperty.swift
@@ -18,7 +18,7 @@ public protocol ControlPropertyType : ObservableType, ObserverType {
 }
 
 /**
- Unit for `Observable`/`ObservableType` that represents property of UI element.
+ Trait for `Observable`/`ObservableType` that represents property of UI element.
  
  Sequence of values only represents initial control value and user initiated value changes.
  Programatic value changes won't be reported.
@@ -37,7 +37,7 @@ public protocol ControlPropertyType : ObservableType, ObserverType {
 
  **It is implementor's responsibility to make sure that that all other properties enumerated above are satisfied.**
 
- **If they aren't, then using this unit communicates wrong properties and could potentially break someone's code.**
+ **If they aren't, then using this trait communicates wrong properties and could potentially break someone's code.**
 
  **In case `values` observable sequence that is being passed into initializer doesn't satisfy all enumerated
  properties, please don't use this unit.**

diff --git a/...coaUnits/Driver/ControlEvent+Driver.swift → ...a/Traits/Driver/ControlEvent+Driver.swift b/...coaUnits/Driver/ControlEvent+Driver.swift → ...a/Traits/Driver/ControlEvent+Driver.swift
@@ -11,7 +11,7 @@ import RxSwift
 #endif
 
 extension ControlEvent {
- /// Converts `ControlEvent` to `Driver` unit.
+ /// Converts `ControlEvent` to `Driver` trait.
  ///
  /// `ControlEvent` already can't fail, so no special case needs to be handled.
  public func asDriver() -> Driver<E> {

diff --git a/...Units/Driver/ControlProperty+Driver.swift → ...raits/Driver/ControlProperty+Driver.swift b/...Units/Driver/ControlProperty+Driver.swift → ...raits/Driver/ControlProperty+Driver.swift
@@ -11,7 +11,7 @@ import RxSwift
 #endif
 
 extension ControlProperty {
- /// Converts `ControlProperty` to `Driver` unit.
+ /// Converts `ControlProperty` to `Driver` trait.
  ///
  /// `ControlProperty` already can't fail, so no special case needs to be handled.
  public func asDriver() -> Driver<E> {

diff --git a/...coaUnits/Driver/Driver+Subscription.swift → ...a/Traits/Driver/Driver+Subscription.swift b/...coaUnits/Driver/Driver+Subscription.swift → ...a/Traits/Driver/Driver+Subscription.swift
diff --git a/RxCocoa/CocoaUnits/Driver/Driver.swift → RxCocoa/Traits/Driver/Driver.swift b/RxCocoa/CocoaUnits/Driver/Driver.swift → RxCocoa/Traits/Driver/Driver.swift
@@ -12,7 +12,7 @@
 
 
 /**
- Unit that represents observable sequence with following properties:
+ Trait that represents observable sequence with following properties:
 
  - it never fails
  - it delivers events on `MainScheduler.instance`
@@ -32,7 +32,7 @@
  If `drive*`, `subscribe*` and `bind*` are called from background thread, it is possible that initial replay
  will happen on background thread, and subsequent events will arrive on main thread.
 
- To find out more about units and how to use them, please visit `Documentation/Units.md`.
+ To find out more about traits and how to use them, please visit `Documentation/Traits.md`.
  */
 public typealias Driver<E> = SharedSequence<DriverSharingStrategy, E>
 

diff --git a/...er/ObservableConvertibleType+Driver.swift → ...er/ObservableConvertibleType+Driver.swift b/...er/ObservableConvertibleType+Driver.swift → ...er/ObservableConvertibleType+Driver.swift
diff --git a/...a/CocoaUnits/Driver/Variable+Driver.swift → RxCocoa/Traits/Driver/Variable+Driver.swift b/...a/CocoaUnits/Driver/Variable+Driver.swift → RxCocoa/Traits/Driver/Variable+Driver.swift
diff --git a/...vableConvertibleType+SharedSequence.swift → ...vableConvertibleType+SharedSequence.swift b/...vableConvertibleType+SharedSequence.swift → ...vableConvertibleType+SharedSequence.swift
diff --git a/...ence/SharedSequence+Operators+arity.swift → ...ence/SharedSequence+Operators+arity.swift b/...ence/SharedSequence+Operators+arity.swift → ...ence/SharedSequence+Operators+arity.swift
diff --git a/...equence/SharedSequence+Operators+arity.tt → ...equence/SharedSequence+Operators+arity.tt b/...equence/SharedSequence+Operators+arity.tt → ...equence/SharedSequence+Operators+arity.tt
diff --git a/...edSequence/SharedSequence+Operators.swift → ...edSequence/SharedSequence+Operators.swift b/...edSequence/SharedSequence+Operators.swift → ...edSequence/SharedSequence+Operators.swift
diff --git a/...Units/SharedSequence/SharedSequence.swift → ...raits/SharedSequence/SharedSequence.swift b/...Units/SharedSequence/SharedSequence.swift → ...raits/SharedSequence/SharedSequence.swift
@@ -11,15 +11,15 @@
 #endif
 
 /**
- Unit that represents observable sequence that shares computation resources with following properties:
+ Trait that represents observable sequence that shares computation resources with following properties:
 
  - it never fails
  - it delivers events on `SharingStrategy.scheduler`
  - sharing strategy is customizable using `SharingStrategy.share` behavior
 
  `SharedSequence<Element>` can be considered a builder pattern for observable sequences that share computation resources.
 
- To find out more about units and how to use them, please visit `Documentation/Units.md`.
+ To find out more about units and how to use them, please visit `Documentation/Traits.md`.
 */
 public struct SharedSequence<S: SharingStrategyProtocol, Element> : SharedSequenceConvertibleType {
  public typealias E = Element

diff --git a/...redSequence/Variable+SharedSequence.swift → ...redSequence/Variable+SharedSequence.swift b/...redSequence/Variable+SharedSequence.swift → ...redSequence/Variable+SharedSequence.swift
diff --git a/RxCocoa/CocoaUnits/UIBindingObserver.swift → RxCocoa/Traits/UIBindingObserver.swift b/RxCocoa/CocoaUnits/UIBindingObserver.swift → RxCocoa/Traits/UIBindingObserver.swift
diff --git a/...t/Units/PrimitiveSequence+Zip+arity.swift → .../Traits/PrimitiveSequence+Zip+arity.swift b/...t/Units/PrimitiveSequence+Zip+arity.swift → .../Traits/PrimitiveSequence+Zip+arity.swift
diff --git a/RxSwift/Units/PrimitiveSequence+Zip+arity.tt → ...ift/Traits/PrimitiveSequence+Zip+arity.tt b/RxSwift/Units/PrimitiveSequence+Zip+arity.tt → ...ift/Traits/PrimitiveSequence+Zip+arity.tt
diff --git a/RxSwift/Units/PrimitiveSequence.swift → RxSwift/Traits/PrimitiveSequence.swift b/RxSwift/Units/PrimitiveSequence.swift → RxSwift/Traits/PrimitiveSequence.swift
diff --git a/Sources/RxCocoa/ControlEvent+Driver.swift b/Sources/RxCocoa/ControlEvent+Driver.swift
@@ -1 +1 @@
-../../RxCocoa/CocoaUnits/Driver/ControlEvent+Driver.swift
+../../RxCocoa/Traits/Driver/ControlEvent+Driver.swift
diff --git a/Sources/RxCocoa/ControlEvent.swift b/Sources/RxCocoa/ControlEvent.swift
@@ -1 +1 @@
-../../RxCocoa/CocoaUnits/ControlEvent.swift
+../../RxCocoa/Traits/ControlEvent.swift
diff --git a/Sources/RxCocoa/ControlProperty+Driver.swift b/Sources/RxCocoa/ControlProperty+Driver.swift
@@ -1 +1 @@
-../../RxCocoa/CocoaUnits/Driver/ControlProperty+Driver.swift
+../../RxCocoa/Traits/Driver/ControlProperty+Driver.swift
diff --git a/Sources/RxCocoa/ControlProperty.swift b/Sources/RxCocoa/ControlProperty.swift
@@ -1 +1 @@
-../../RxCocoa/CocoaUnits/ControlProperty.swift
+../../RxCocoa/Traits/ControlProperty.swift
diff --git a/Sources/RxCocoa/Driver+Subscription.swift b/Sources/RxCocoa/Driver+Subscription.swift
@@ -1 +1 @@
-../../RxCocoa/CocoaUnits/Driver/Driver+Subscription.swift
+../../RxCocoa/Traits/Driver/Driver+Subscription.swift
diff --git a/Sources/RxCocoa/Driver.swift b/Sources/RxCocoa/Driver.swift
@@ -1 +1 @@
-../../RxCocoa/CocoaUnits/Driver/Driver.swift
+../../RxCocoa/Traits/Driver/Driver.swift
diff --git a/Sources/RxCocoa/ObservableConvertibleType+Driver.swift b/Sources/RxCocoa/ObservableConvertibleType+Driver.swift
@@ -1 +1 @@
-../../RxCocoa/CocoaUnits/Driver/ObservableConvertibleType+Driver.swift
+../../RxCocoa/Traits/Driver/ObservableConvertibleType+Driver.swift
diff --git a/Sources/RxCocoa/ObservableConvertibleType+SharedSequence.swift b/Sources/RxCocoa/ObservableConvertibleType+SharedSequence.swift
@@ -1 +1 @@
-../../RxCocoa/CocoaUnits/SharedSequence/ObservableConvertibleType+SharedSequence.swift
+../../RxCocoa/Traits/SharedSequence/ObservableConvertibleType+SharedSequence.swift
diff --git a/Sources/RxCocoa/SharedSequence+Operators+arity.swift b/Sources/RxCocoa/SharedSequence+Operators+arity.swift
@@ -1 +1 @@
-../../RxCocoa/CocoaUnits/SharedSequence/SharedSequence+Operators+arity.swift
+../../RxCocoa/Traits/SharedSequence/SharedSequence+Operators+arity.swift
diff --git a/Sources/RxCocoa/SharedSequence+Operators.swift b/Sources/RxCocoa/SharedSequence+Operators.swift
@@ -1 +1 @@
-../../RxCocoa/CocoaUnits/SharedSequence/SharedSequence+Operators.swift
+../../RxCocoa/Traits/SharedSequence/SharedSequence+Operators.swift
diff --git a/Sources/RxCocoa/SharedSequence.swift b/Sources/RxCocoa/SharedSequence.swift
@@ -1 +1 @@
-../../RxCocoa/CocoaUnits/SharedSequence/SharedSequence.swift
+../../RxCocoa/Traits/SharedSequence/SharedSequence.swift
diff --git a/Sources/RxCocoa/UIBindingObserver.swift b/Sources/RxCocoa/UIBindingObserver.swift
@@ -1 +1 @@
-../../RxCocoa/CocoaUnits/UIBindingObserver.swift
+../../RxCocoa/Traits/UIBindingObserver.swift
diff --git a/Sources/RxCocoa/Variable+Driver.swift b/Sources/RxCocoa/Variable+Driver.swift
@@ -1 +1 @@
-../../RxCocoa/CocoaUnits/Driver/Variable+Driver.swift
+../../RxCocoa/Traits/Driver/Variable+Driver.swift
diff --git a/Sources/RxCocoa/Variable+SharedSequence.swift b/Sources/RxCocoa/Variable+SharedSequence.swift
@@ -1 +1 @@
-../../RxCocoa/CocoaUnits/SharedSequence/Variable+SharedSequence.swift
+../../RxCocoa/Traits/SharedSequence/Variable+SharedSequence.swift
diff --git a/Sources/RxSwift/PrimitiveSequence+Zip+arity.swift b/Sources/RxSwift/PrimitiveSequence+Zip+arity.swift
@@ -1 +1 @@
-../../RxSwift/Units/PrimitiveSequence+Zip+arity.swift
+../../RxSwift/Traits/PrimitiveSequence+Zip+arity.swift
diff --git a/Sources/RxSwift/PrimitiveSequence.swift b/Sources/RxSwift/PrimitiveSequence.swift
@@ -1 +1 @@
-../../RxSwift/Units/PrimitiveSequence.swift
+../../RxSwift/Traits/PrimitiveSequence.swift
diff --git a/scripts/package-spm.swift b/scripts/package-spm.swift
@@ -266,7 +266,7 @@ try packageRelativePath(["RxSwift"], targetDirName: "RxSwift")
 
 try packageRelativePath([
  "RxCocoa/RxCocoa.swift",
- "RxCocoa/CocoaUnits",
+ "RxCocoa/Traits",
  "RxCocoa/Common",
  "RxCocoa/Foundation",
  "RxCocoa/iOS",