Skip to content

Commit c93bb75

Browse files
authored
Breaking: Rename "Iterable" to "Collection" (immutable-js#1139)
* Remove Collection from prototype * s/Iterable/Collection/ * s/ESIterable/Iterable/
1 parent 0752961 commit c93bb75

34 files changed

+2319
-2976
lines changed

__tests__/IterableSeq.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
declare var Symbol: any;
44
import { Seq } from '../';
55

6-
describe('IterableSequence', () => {
6+
describe('Sequence', () => {
77

88
it('creates a sequence from an iterable', () => {
99
let i = new SimpleIterable();
@@ -74,8 +74,8 @@ describe('IterableSequence', () => {
7474
});
7575

7676
it('can be updated', () => {
77-
function sum(collection) {
78-
return collection.reduce((s, v) => s + v, 0);
77+
function sum(seq) {
78+
return seq.reduce((s, v) => s + v, 0);
7979
}
8080
let total = Seq([1, 2, 3])
8181
.filter(x => x % 2 === 1)

__tests__/List.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ describe('List', () => {
4242
it('does not accept a scalar', () => {
4343
expect(() => {
4444
List(3 as any);
45-
}).toThrow('Expected Array or iterable object of values: 3');
45+
}).toThrow('Expected Array or collection object of values: 3');
4646
});
4747

4848
it('accepts an array', () => {
@@ -57,7 +57,7 @@ describe('List', () => {
5757
expect(v.toArray()).toEqual([undefined, 'b', undefined]);
5858
});
5959

60-
it('accepts any array-like iterable, including strings', () => {
60+
it('accepts any array-like collection, including strings', () => {
6161
let v = List('abc');
6262
expect(v.get(1)).toBe('b');
6363
expect(v.toArray()).toEqual(['a', 'b', 'c']);

__tests__/Map.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -62,10 +62,10 @@ describe('Map', () => {
6262
it('does not accept a scalar', () => {
6363
expect(() => {
6464
Map(3 as any);
65-
}).toThrow('Expected Array or iterable object of [k, v] entries, or keyed object: 3');
65+
}).toThrow('Expected Array or collection object of [k, v] entries, or keyed object: 3');
6666
});
6767

68-
it('does not accept strings (iterable, but scalar)', () => {
68+
it('does not accept strings (collection, but scalar)', () => {
6969
expect(() => {
7070
Map('abc');
7171
}).toThrow();
@@ -77,7 +77,7 @@ describe('Map', () => {
7777
}).toThrow('Expected [K, V] tuple: 1');
7878
});
7979

80-
it('accepts non-iterable array-like objects as keyed collections', () => {
80+
it('accepts non-collection array-like objects as keyed collections', () => {
8181
let m = Map({ length: 3, 1: 'one' });
8282
expect(m.get('length')).toBe(3);
8383
expect(m.get('1')).toBe('one');

__tests__/MultiRequire.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ describe('MultiRequire', () => {
1414
it('detects sequences', () => {
1515
const x = Immutable1.Map({ a: 1 });
1616
const y = Immutable2.Map({ a: 1 });
17-
expect(Immutable1.Iterable.isIterable(y)).toBe(true);
18-
expect(Immutable2.Iterable.isIterable(x)).toBe(true);
17+
expect(Immutable1.isCollection(y)).toBe(true);
18+
expect(Immutable2.isCollection(x)).toBe(true);
1919
});
2020

2121
it('detects records', () => {

__tests__/Seq.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
///<reference path='../resources/jest.d.ts'/>
22

3-
import { Iterable, Seq } from '../';
3+
import { isCollection, isIndexed, Seq } from '../';
44

55
describe('Seq', () => {
66

@@ -16,7 +16,7 @@ describe('Seq', () => {
1616
expect(Seq({a: 1, b: 2, c: 3}).size).toBe(3);
1717
});
1818

19-
it('accepts an iterable string', () => {
19+
it('accepts an collection string', () => {
2020
expect(Seq('foo').size).toBe(3);
2121
});
2222

@@ -47,21 +47,21 @@ describe('Seq', () => {
4747
it('accepts an array-like', () => {
4848
let alike: any = { length: 2, 0: 'a', 1: 'b' };
4949
let seq = Seq(alike);
50-
expect(Iterable.isIndexed(seq)).toBe(true);
50+
expect(isIndexed(seq)).toBe(true);
5151
expect(seq.size).toBe(2);
5252
expect(seq.get(1)).toBe('b');
5353
});
5454

5555
it('does not accept a scalar', () => {
5656
expect(() => {
5757
Seq(3 as any);
58-
}).toThrow('Expected Array or iterable object of values, or keyed object: 3');
58+
}).toThrow('Expected Array or collection object of values, or keyed object: 3');
5959
});
6060

6161
it('detects sequences', () => {
6262
let seq = Seq.of(1, 2, 3);
6363
expect(Seq.isSeq(seq)).toBe(true);
64-
expect(Iterable.isIterable(seq)).toBe(true);
64+
expect(isCollection(seq)).toBe(true);
6565
});
6666

6767
it('Does not infinite loop when sliced with NaN', () => {

__tests__/Set.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ describe('Set', () => {
4141
expect(s.has(1)).toBe(false);
4242
});
4343

44-
it('accepts string, an array-like iterable', () => {
44+
it('accepts string, an array-like collection', () => {
4545
let s = Set('abc');
4646
expect(s.size).toBe(3);
4747
expect(s.has('a')).toBe(true);
@@ -154,7 +154,7 @@ describe('Set', () => {
154154
expect(s3).toBe(s2);
155155
});
156156

157-
it('unions a set and an iterable and returns a set', () => {
157+
it('unions a set and another collection and returns a set', () => {
158158
let s1 = Set([1, 2, 3]);
159159
let emptySet = Set();
160160
let l = List([1, 2, 3]);

__tests__/flatten.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
import * as jasmineCheck from 'jasmine-check';
44
jasmineCheck.install();
55

6-
import { fromJS, Iterable, List, Range, Seq } from '../';
6+
import { Collection, fromJS, List, Range, Seq } from '../';
77

8-
type SeqType = number | number[] | Iterable<number, number>;
8+
type SeqType = number | number[] | Collection<number, number>;
99

1010
describe('flatten', () => {
1111

@@ -123,8 +123,8 @@ describe('flatten', () => {
123123

124124
it('maps to sequenceables, not only Sequences.', () => {
125125
let numbers = Range(97, 100);
126-
// the map function returns an Array, rather than an Iterable.
127-
// Array is sequenceable, so this works just fine.
126+
// the map function returns an Array, rather than an Collection.
127+
// Array is iterable, so this works just fine.
128128
let letters = numbers.flatMap(v => [
129129
String.fromCharCode(v),
130130
String.fromCharCode(v).toUpperCase(),

__tests__/groupBy.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
///<reference path='../resources/jest.d.ts'/>
22

3-
import { Iterable, Map, Seq } from '../';
3+
import { Collection, Map, Seq } from '../';
44

55
describe('groupBy', () => {
66

@@ -51,14 +51,14 @@ describe('groupBy', () => {
5151

5252
it('returns an ordered map from an ordered collection', () => {
5353
let seq = Seq.of('Z', 'Y', 'X', 'Z', 'Y', 'X');
54-
expect(Iterable.isOrdered(seq)).toBe(true);
54+
expect(Collection.isOrdered(seq)).toBe(true);
5555
let seqGroups = seq.groupBy(x => x);
56-
expect(Iterable.isOrdered(seqGroups)).toBe(true);
56+
expect(Collection.isOrdered(seqGroups)).toBe(true);
5757

5858
let map = Map({ x: 1, y: 2 });
59-
expect(Iterable.isOrdered(map)).toBe(false);
59+
expect(Collection.isOrdered(map)).toBe(false);
6060
let mapGroups = map.groupBy(x => x);
61-
expect(Iterable.isOrdered(mapGroups)).toBe(false);
61+
expect(Collection.isOrdered(mapGroups)).toBe(false);
6262
});
6363

6464
});

__tests__/updateIn.ts

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,13 @@ describe('updateIn', () => {
1818
// need to cast these as TypeScript first prevents us from such clownery.
1919
expect(() =>
2020
Map().getIn(<any> undefined),
21-
).toThrow('Invalid keyPath: expected Ordered Iterable or Array: undefined');
21+
).toThrow('Invalid keyPath: expected Ordered Collection or Array: undefined');
2222
expect(() =>
2323
Map().getIn(<any> { a: 1, b: 2 }),
24-
).toThrow('Invalid keyPath: expected Ordered Iterable or Array: [object Object]');
24+
).toThrow('Invalid keyPath: expected Ordered Collection or Array: [object Object]');
2525
expect(() =>
2626
Map().getIn(<any> 'abc'),
27-
).toThrow('Invalid keyPath: expected Ordered Iterable or Array: abc');
27+
).toThrow('Invalid keyPath: expected Ordered Collection or Array: abc');
2828
});
2929

3030
it('deep get throws if non-readable path', () => {
@@ -45,13 +45,13 @@ describe('updateIn', () => {
4545
// need to cast these as TypeScript first prevents us from such clownery.
4646
expect(() =>
4747
Map().hasIn(<any> undefined),
48-
).toThrow('Invalid keyPath: expected Ordered Iterable or Array: undefined');
48+
).toThrow('Invalid keyPath: expected Ordered Collection or Array: undefined');
4949
expect(() =>
5050
Map().hasIn(<any> { a: 1, b: 2 }),
51-
).toThrow('Invalid keyPath: expected Ordered Iterable or Array: [object Object]');
51+
).toThrow('Invalid keyPath: expected Ordered Collection or Array: [object Object]');
5252
expect(() =>
5353
Map().hasIn(<any> 'abc'),
54-
).toThrow('Invalid keyPath: expected Ordered Iterable or Array: abc');
54+
).toThrow('Invalid keyPath: expected Ordered Collection or Array: abc');
5555
});
5656

5757
it('deep get returns not found if path does not match', () => {
@@ -81,13 +81,13 @@ describe('updateIn', () => {
8181
// need to cast these as TypeScript first prevents us from such clownery.
8282
expect(() =>
8383
Map().updateIn(<any> undefined, x => x),
84-
).toThrow('Invalid keyPath: expected Ordered Iterable or Array: undefined');
84+
).toThrow('Invalid keyPath: expected Ordered Collection or Array: undefined');
8585
expect(() =>
8686
Map().updateIn(<any> { a: 1, b: 2 }, x => x),
87-
).toThrow('Invalid keyPath: expected Ordered Iterable or Array: [object Object]');
87+
).toThrow('Invalid keyPath: expected Ordered Collection or Array: [object Object]');
8888
expect(() =>
8989
Map().updateIn(<any> 'abc', x => x),
90-
).toThrow('Invalid keyPath: expected Ordered Iterable or Array: abc');
90+
).toThrow('Invalid keyPath: expected Ordered Collection or Array: abc');
9191
});
9292

9393
it('deep edit throws if non-editable path', () => {

__tests__/zip.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
import * as jasmineCheck from 'jasmine-check';
44
jasmineCheck.install();
55

6-
import { Iterable, List, Range, Seq } from '../';
6+
import { Collection, List, Range, Seq } from '../';
77

88
describe('zip', () => {
99

@@ -91,7 +91,7 @@ describe('zip', () => {
9191
});
9292

9393
it('with infinite lists', () => {
94-
let r: Iterable.Indexed<any> = Range();
94+
let r: Collection.Indexed<any> = Range();
9595
let i = r.interleave(Seq.of('A', 'B', 'C'));
9696
expect(i.size).toBe(6);
9797
expect(i.toArray()).toEqual(

0 commit comments

Comments
 (0)