[Navigator] Introducing NavigationRouteStack.
Summary: Introducing the data structure NavigationRouteStack that focused on managing navigation routes stack. The goal is to make <Navigatior /> thinner by moving stack management logic into its own class and make sure it's well-tested. Teh next step will be cleaning up <Navigatior /> and add `NavigationRouteStack` to `NavigationContext`.
This commit is contained in:
Hedger Wang
parent
bb07817023
commit
21b98b23c9
|
|
@ -0,0 +1,150 @@
|
|||
/**
|
||||
* Copyright 2004-present Facebook. All Rights Reserved.
|
||||
*
|
||||
* @providesModule NavigationRouteStack
|
||||
*/
|
||||
'use strict';
|
||||
|
||||
var immutable = require('immutable');
|
||||
var invariant = require('invariant');
|
||||
|
||||
var {List} = immutable;
|
||||
|
||||
/**
|
||||
* The immutable routes stack.
|
||||
*/
|
||||
class RouteStack {
|
||||
_index: number;
|
||||
|
||||
_routes: List;
|
||||
|
||||
constructor(index: number, routes: List) {
|
||||
invariant(
|
||||
routes.size > 0,
|
||||
'size must not be empty'
|
||||
);
|
||||
|
||||
invariant(
|
||||
index > -1 && index <= routes.size - 1,
|
||||
'index out of bound'
|
||||
);
|
||||
|
||||
this._routes = routes;
|
||||
this._index = index;
|
||||
}
|
||||
|
||||
get size(): number {
|
||||
return this._routes.size;
|
||||
}
|
||||
|
||||
get index(): number {
|
||||
return this._index;
|
||||
}
|
||||
|
||||
toArray(): Array {
|
||||
return this._routes.toJS();
|
||||
}
|
||||
|
||||
get(index: number): any {
|
||||
if (index < 0 || index > this._routes.size - 1) {
|
||||
return null;
|
||||
}
|
||||
return this._routes.get(index);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a new stack with the provided route appended,
|
||||
* starting at this stack size.
|
||||
*/
|
||||
push(route: any): RouteStack {
|
||||
invariant(
|
||||
route === 0 ||
|
||||
route === false ||
|
||||
!!route,
|
||||
'Must supply route to push'
|
||||
);
|
||||
|
||||
invariant(this._routes.indexOf(route) === -1, 'route must be unique');
|
||||
|
||||
// When pushing, removes the rest of the routes past the current index.
|
||||
var routes = this._routes.withMutations((list: List) => {
|
||||
list.slice(0, this._index + 1).push(route);
|
||||
});
|
||||
|
||||
return new RouteStack(routes.size - 1, routes);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a new stack a size ones less than this stack,
|
||||
* excluding the last index in this stack.
|
||||
*/
|
||||
pop(): RouteStack {
|
||||
invariant(this._routes.size > 1, 'shoud not pop routes stack to empty');
|
||||
|
||||
// When popping, removes the rest of the routes past the current index.
|
||||
var routes = this._routes.slice(0, this._index);
|
||||
return new RouteStack(routes.size - 1, routes);
|
||||
}
|
||||
|
||||
jumpToIndex(index: number): RouteStack {
|
||||
invariant(
|
||||
index > -1 && index < this._routes.size,
|
||||
'index out of bound'
|
||||
);
|
||||
|
||||
if (index === this._index) {
|
||||
return this;
|
||||
}
|
||||
|
||||
return new RouteStack(index, this._routes);
|
||||
}
|
||||
|
||||
/**
|
||||
* Replace a route in the navigation stack.
|
||||
*
|
||||
* `index` specifies the route in the stack that should be replaced.
|
||||
* If it's negative, it counts from the back.
|
||||
*/
|
||||
replaceAtIndex(index: number, route: any): RouteStack {
|
||||
invariant(
|
||||
route === 0 ||
|
||||
route === false ||
|
||||
!!route,
|
||||
'Must supply route to replace'
|
||||
);
|
||||
|
||||
if (this.get(index) === route) {
|
||||
return this;
|
||||
}
|
||||
|
||||
invariant(this._routes.indexOf(route) === -1, 'route must be unique');
|
||||
|
||||
if (index < 0) {
|
||||
index += this._routes.size;
|
||||
}
|
||||
|
||||
invariant(
|
||||
index > -1 && index < this._routes.size,
|
||||
'index out of bound'
|
||||
);
|
||||
|
||||
var routes = this._routes.set(index, route);
|
||||
return new RouteStack(this._index, routes);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* The first class data structure for NavigationContext to manage the navigation
|
||||
* stack of routes.
|
||||
*/
|
||||
class NavigationRouteStack extends RouteStack {
|
||||
constructor(index: number, routes: Array) {
|
||||
// For now, `RouteStack` internally, uses an immutable `List` to keep
|
||||
// track of routes. Since using `List` is really just the implementation
|
||||
// detail, we don't want to accept `routes` as `list` from constructor
|
||||
// for developer.
|
||||
super(index, new List(routes));
|
||||
}
|
||||
}
|
||||
|
||||
module.exports = NavigationRouteStack;
|
||||
|
|
@ -0,0 +1,188 @@
|
|||
/**
|
||||
* Copyright (c) 2015, Facebook, Inc. All rights reserved.
|
||||
*
|
||||
* Facebook, Inc. (“Facebook”) owns all right, title and interest, including
|
||||
* all intellectual property and other proprietary rights, in and to the React
|
||||
* Native CustomComponents software (the “Software”). Subject to your
|
||||
* compliance with these terms, you are hereby granted a non-exclusive,
|
||||
* worldwide, royalty-free copyright license to (1) use and copy the Software;
|
||||
* and (2) reproduce and distribute the Software as part of your own software
|
||||
* (“Your Software”). Facebook reserves all rights not expressly granted to
|
||||
* you in this license agreement.
|
||||
*
|
||||
* THE SOFTWARE AND DOCUMENTATION, IF ANY, ARE PROVIDED "AS IS" AND ANY EXPRESS
|
||||
* OR IMPLIED WARRANTIES (INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
||||
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE) ARE DISCLAIMED.
|
||||
* IN NO EVENT SHALL FACEBOOK OR ITS AFFILIATES, OFFICERS, DIRECTORS OR
|
||||
* EMPLOYEES BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
|
||||
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
|
||||
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
|
||||
* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
|
||||
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
|
||||
* OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THE SOFTWARE, EVEN IF
|
||||
* ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
*/
|
||||
'use strict';
|
||||
|
||||
jest
|
||||
.dontMock('NavigationRouteStack')
|
||||
.dontMock('clamp')
|
||||
.dontMock('invariant')
|
||||
.dontMock('immutable');
|
||||
|
||||
var NavigationRouteStack = require('NavigationRouteStack');
|
||||
|
||||
describe('NavigationRouteStack:', () => {
|
||||
// Basic
|
||||
it('gets index', () => {
|
||||
var stack = new NavigationRouteStack(1, ['a', 'b', 'c']);
|
||||
expect(stack.index).toEqual(1);
|
||||
});
|
||||
|
||||
it('gets size', () => {
|
||||
var stack = new NavigationRouteStack(1, ['a', 'b', 'c']);
|
||||
expect(stack.size).toEqual(3);
|
||||
});
|
||||
|
||||
it('gets route', () => {
|
||||
var stack = new NavigationRouteStack(0, ['a', 'b', 'c']);
|
||||
expect(stack.get(2)).toEqual('c');
|
||||
});
|
||||
|
||||
it('converts to an array', () => {
|
||||
var stack = new NavigationRouteStack(0, ['a', 'b']);
|
||||
expect(stack.toArray()).toEqual(['a', 'b']);
|
||||
});
|
||||
|
||||
it('creates a new stack after mutation', () => {
|
||||
var stack1 = new NavigationRouteStack(0, ['a', 'b']);
|
||||
var stack2 = stack1.push('c');
|
||||
expect(stack1).not.toEqual(stack2);
|
||||
});
|
||||
|
||||
it('throws at index out of bound', () => {
|
||||
expect(() => {
|
||||
new NavigationRouteStack(-1, ['a', 'b']);
|
||||
}).toThrow();
|
||||
|
||||
expect(() => {
|
||||
new NavigationRouteStack(100, ['a', 'b']);
|
||||
}).toThrow();
|
||||
});
|
||||
|
||||
// Push
|
||||
it('pushes route', () => {
|
||||
var stack1 = new NavigationRouteStack(1, ['a', 'b']);
|
||||
var stack2 = stack1.push('c');
|
||||
|
||||
expect(stack2).not.toEqual(stack1);
|
||||
expect(stack2.toArray()).toEqual(['a', 'b', 'c']);
|
||||
expect(stack2.index).toEqual(2);
|
||||
expect(stack2.size).toEqual(3);
|
||||
});
|
||||
|
||||
it('throws when pushing empty route', () => {
|
||||
expect(() => {
|
||||
var stack = new NavigationRouteStack(1, ['a', 'b']);
|
||||
stack.push(null);
|
||||
}).toThrow();
|
||||
|
||||
expect(() => {
|
||||
var stack = new NavigationRouteStack(1, ['a', 'b']);
|
||||
stack.push('');
|
||||
}).toThrow();
|
||||
|
||||
expect(() => {
|
||||
var stack = new NavigationRouteStack(1, ['a', 'b']);
|
||||
stack.push(undefined);
|
||||
}).toThrow();
|
||||
});
|
||||
|
||||
it('replaces routes on push', () => {
|
||||
var stack1 = new NavigationRouteStack(1, ['a', 'b', 'c']);
|
||||
var stack2 = stack1.push('d');
|
||||
expect(stack2).not.toEqual(stack1);
|
||||
expect(stack2.toArray()).toEqual(['a', 'b', 'd']);
|
||||
expect(stack2.index).toEqual(2);
|
||||
});
|
||||
|
||||
// Pop
|
||||
it('pops route', () => {
|
||||
var stack1 = new NavigationRouteStack(2, ['a', 'b', 'c']);
|
||||
var stack2 = stack1.pop();
|
||||
expect(stack2).not.toEqual(stack1);
|
||||
expect(stack2.toArray()).toEqual(['a', 'b']);
|
||||
expect(stack2.index).toEqual(1);
|
||||
expect(stack2.size).toEqual(2);
|
||||
});
|
||||
|
||||
it('replaces routes on pop', () => {
|
||||
var stack1 = new NavigationRouteStack(1, ['a', 'b', 'c']);
|
||||
var stack2 = stack1.pop();
|
||||
expect(stack2).not.toEqual(stack1);
|
||||
expect(stack2.toArray()).toEqual(['a']);
|
||||
expect(stack2.index).toEqual(0);
|
||||
});
|
||||
|
||||
it('throws when popping to empty stack', () => {
|
||||
expect(() => {
|
||||
var stack = new NavigationRouteStack(0, ['a']);
|
||||
stack.pop();
|
||||
}).toThrow();
|
||||
});
|
||||
|
||||
// Jump
|
||||
it('jumps to index', () => {
|
||||
var stack1 = new NavigationRouteStack(0, ['a', 'b', 'c']);
|
||||
var stack2 = stack1.jumpToIndex(2);
|
||||
|
||||
expect(stack2).not.toEqual(stack1);
|
||||
expect(stack2.index).toEqual(2);
|
||||
});
|
||||
|
||||
it('throws then jumping to index out of bound', () => {
|
||||
expect(() => {
|
||||
var stack = new NavigationRouteStack(1, ['a', 'b']);
|
||||
stack.jumpToIndex(2);
|
||||
}).toThrow();
|
||||
|
||||
expect(() => {
|
||||
var stack = new NavigationRouteStack(1, ['a', 'b']);
|
||||
stack.jumpToIndex(-1);
|
||||
}).toThrow();
|
||||
});
|
||||
|
||||
// Replace
|
||||
it('replaces route at index', () => {
|
||||
var stack1 = new NavigationRouteStack(1, ['a', 'b']);
|
||||
var stack2 = stack1.replaceAtIndex(0, 'x');
|
||||
|
||||
expect(stack2).not.toEqual(stack1);
|
||||
expect(stack2.toArray()).toEqual(['x', 'b']);
|
||||
expect(stack2.index).toEqual(1);
|
||||
});
|
||||
|
||||
it('replaces route at negative index', () => {
|
||||
var stack1 = new NavigationRouteStack(1, ['a', 'b']);
|
||||
var stack2 = stack1.replaceAtIndex(-1, 'x');
|
||||
|
||||
expect(stack2).not.toEqual(stack1);
|
||||
expect(stack2.toArray()).toEqual(['a', 'x']);
|
||||
expect(stack2.index).toEqual(1);
|
||||
});
|
||||
|
||||
|
||||
it('throws when replacing empty route', () => {
|
||||
expect(() => {
|
||||
var stack = new NavigationRouteStack(1, ['a', 'b']);
|
||||
stack.replaceAtIndex(1, null);
|
||||
}).toThrow();
|
||||
});
|
||||
|
||||
it('throws when replacing at index out of bound', () => {
|
||||
expect(() => {
|
||||
var stack = new NavigationRouteStack(1, ['a', 'b']);
|
||||
stack.replaceAtIndex(100, 'x');
|
||||
}).toThrow();
|
||||
});
|
||||
});
|
||||
Loading…
Reference in New Issue