Skip to content

Commit

Permalink
Merge branch 'dannsam-1238-robust-iobservablefactory-assignment'
Browse files Browse the repository at this point in the history
  • Loading branch information
@mweststrate
mweststrate committed Dec 4, 2017
2 parents c6bd40c + 2eb7a45 commit afee132
Show file tree
Hide file tree
Showing 2 changed files with 49 additions and 49 deletions.
97 changes: 49 additions & 48 deletions src/api/observable.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -68,37 +68,66 @@ export interface IObservableFactory {
<T>(value: T): IObservableValue<T>
}

export class IObservableFactories {
export interface IObservableFactories {
box<T>(value?: T, name?: string): IObservableValue<T>
shallowBox<T>(value?: T, name?: string): IObservableValue<T>
array<T>(initialValues?: T[], name?: string): IObservableArray<T>
shallowArray<T>(initialValues?: T[], name?: string): IObservableArray<T>
map<T>(initialValues?: IObservableMapInitialValues<T>, name?: string): ObservableMap<T>
shallowMap<T>(initialValues?: IObservableMapInitialValues<T>, name?: string): ObservableMap<T>
object<T>(props: T, name?: string): T & IObservableObject
shallowObject<T>(props: T, name?: string): T & IObservableObject

/**
* Decorator that creates an observable that only observes the references, but doesn't try to turn the assigned value into an observable.ts.
*/
ref(target: Object, property: string, descriptor?: PropertyDescriptor): any
ref<T>(initialValue: T): T;

/**
* Decorator that creates an observable converts its value (objects, maps or arrays) into a shallow observable structure
*/
shallow(target: Object, property: string, descriptor?: PropertyDescriptor): any
shallow<T>(initialValues: T[]): IObservableArray<T>
shallow<T>(initialValues: IMap<string | number | boolean, T>): ObservableMap<T>
shallow<T extends Object>(value: T): T

deep(target: Object, property: string, descriptor?: PropertyDescriptor): any
deep<T>(initialValues: T[]): IObservableArray<T>
deep<T>(initialValues: IMap<string | number | boolean, T>): ObservableMap<T>
deep<T>(initialValue: T): T

struct(target: Object, property: string, descriptor?: PropertyDescriptor): any
struct<T>(initialValues: T[]): IObservableArray<T>
struct<T>(initialValues: IMap<string | number | boolean, T>): ObservableMap<T>
struct<T>(initialValue: T): T
}

const observableFactories: IObservableFactories = {
box<T>(value?: T, name?: string): IObservableValue<T> {
if (arguments.length > 2) incorrectlyUsedAsDecorator("box")
return new ObservableValue(value, deepEnhancer, name)
}

},
shallowBox<T>(value?: T, name?: string): IObservableValue<T> {
if (arguments.length > 2) incorrectlyUsedAsDecorator("shallowBox")
return new ObservableValue(value, referenceEnhancer, name)
}

},
array<T>(initialValues?: T[], name?: string): IObservableArray<T> {
if (arguments.length > 2) incorrectlyUsedAsDecorator("array")
return new ObservableArray(initialValues, deepEnhancer, name) as any
}

},
shallowArray<T>(initialValues?: T[], name?: string): IObservableArray<T> {
if (arguments.length > 2) incorrectlyUsedAsDecorator("shallowArray")
return new ObservableArray(initialValues, referenceEnhancer, name) as any
}

},
map<T>(initialValues?: IObservableMapInitialValues<T>, name?: string): ObservableMap<T> {
if (arguments.length > 2) incorrectlyUsedAsDecorator("map")
return new ObservableMap(initialValues, deepEnhancer, name)
}

},
shallowMap<T>(initialValues?: IObservableMapInitialValues<T>, name?: string): ObservableMap<T> {
if (arguments.length > 2) incorrectlyUsedAsDecorator("shallowMap")
return new ObservableMap(initialValues, referenceEnhancer, name)
}

},
object<T>(props: T, name?: string): T & IObservableObject {
if (arguments.length > 2) incorrectlyUsedAsDecorator("object")
const res = {}
Expand All @@ -107,21 +136,14 @@ export class IObservableFactories {
// add properties
extendObservable(res, props)
return res as any
}

},
shallowObject<T>(props: T, name?: string): T & IObservableObject {
if (arguments.length > 2) incorrectlyUsedAsDecorator("shallowObject")
const res = {}
asObservableObject(res, name)
extendShallowObservable(res, props)
return res as any
}

/**
* Decorator that creates an observable that only observes the references, but doesn't try to turn the assigned value into an observable.ts.
*/
ref(target: Object, property: string, descriptor?: PropertyDescriptor): any
ref<T>(initialValue: T): T
},
ref() {
if (arguments.length < 2) {
// although ref creates actually a modifier descriptor, the type of the resultig properties
Expand All @@ -130,15 +152,7 @@ export class IObservableFactories {
} else {
return refDecorator.apply(null, arguments)
}
}

/**
* Decorator that creates an observable converts its value (objects, maps or arrays) into a shallow observable structure
*/
shallow(target: Object, property: string, descriptor?: PropertyDescriptor): any
shallow<T>(initialValues: T[]): IObservableArray<T>
shallow<T>(initialValues: IMap<string | number | boolean, T>): ObservableMap<T>
shallow<T extends Object>(value: T): T
},
shallow() {
if (arguments.length < 2) {
// although ref creates actually a modifier descriptor, the type of the resultig properties
Expand All @@ -147,12 +161,7 @@ export class IObservableFactories {
} else {
return shallowDecorator.apply(null, arguments)
}
}

deep(target: Object, property: string, descriptor?: PropertyDescriptor): any
deep<T>(initialValues: T[]): IObservableArray<T>
deep<T>(initialValues: IMap<string | number | boolean, T>): ObservableMap<T>
deep<T>(initialValue: T): T
},
deep() {
if (arguments.length < 2) {
// although ref creates actually a modifier descriptor, the type of the resultig properties
Expand All @@ -161,12 +170,7 @@ export class IObservableFactories {
} else {
return deepDecorator.apply(null, arguments)
}
}

struct(target: Object, property: string, descriptor?: PropertyDescriptor): any
struct<T>(initialValues: T[]): IObservableArray<T>
struct<T>(initialValues: IMap<string | number | boolean, T>): ObservableMap<T>
struct<T>(initialValue: T): T
},
struct() {
if (arguments.length < 2) {
// although ref creates actually a modifier descriptor, the type of the resultig properties
Expand All @@ -176,7 +180,7 @@ export class IObservableFactories {
return deepStructDecorator.apply(null, arguments)
}
}
}
} as any

export const observable: IObservableFactory &
IObservableFactories & {
Expand All @@ -189,10 +193,7 @@ export const observable: IObservableFactory &
} = createObservable as any

// weird trick to keep our typings nicely with our funcs, and still extend the observable function
// ES6 class methods aren't enumerable, can't use Object.keys
Object.getOwnPropertyNames(IObservableFactories.prototype)
.filter(name => name !== "constructor")
.forEach(name => (observable[name] = IObservableFactories.prototype[name]))
Object.keys(observableFactories).forEach(name => (observable[name] = observableFactories[name]))

observable.deep.struct = observable.struct
observable.ref.struct = function() {
Expand Down
1 change: 0 additions & 1 deletion test/api.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ test("correct api should be exposed", function(t) {
"Atom",
"BaseAtom", // TODO: remove somehow
"IDerivationState",
"IObservableFactories",
"ObservableMap",
"Reaction",
"action",
Expand Down

0 comments on commit afee132

Please sign in to comment.