stringify-authors/test.js at master · jonschlinkert/stringify-authors · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
/*!
 * stringify-authors <https://github.com/jonschlinkert/stringify-authors>
 *
 * Copyright (c) 2015 Jon Schlinkert.
 * Licensed under the MIT License
 */

'use strict';

require('mocha');
var should = require('should');
var toString = require('./');

// easier to test this way
function stringify(authors, opts) {
  var res = toString(authors, opts);
  return res.join(', ');
}

describe('options:', function () {
  it('should throw an error in strict mode:', function () {
    (function () {
      stringify(undefined, {strict: true})
    }).should.throw('stringify-authors expects an object or array.');
  });

  it('should omit the given properties:', function () {
    var authors = [{name: 'Jon Schlinkert', email: 'jon.schlinkert@sellside.com', url: 'https://github.com/jonschlinkert'}, {name: 'Brian Woodward', url: 'https://github.com/doowb', email: 'brian.woodward@sellside.com'}];

    stringify(authors, {omit: ['email', 'url']}).should.equal('Jon Schlinkert, Brian Woodward');
    stringify(authors, {omit: ['email', 'name']}).should.equal('(https://github.com/jonschlinkert), (https://github.com/doowb)');
    stringify(authors, {omit: ['email']}).should.equal('Jon Schlinkert (https://github.com/jonschlinkert), Brian Woodward (https://github.com/doowb)');
  });
});

describe('array: multiple authors:', function () {
  it('should stringify name:', function () {
    var authors = [{name: 'Jon Schlinkert'}, {name: 'Brian Woodward'}];
    stringify(authors).should.equal('Jon Schlinkert, Brian Woodward');
  });

  it('should stringify email:', function () {
    var authors = [{email: 'jon.schlinkert@sellside.com'}, {email: 'brian.woodward@sellside.com'}];
    stringify(authors).should.equal('<jon.schlinkert@sellside.com>, <brian.woodward@sellside.com>');
  });

  it('should stringify url:', function () {
    var authors = [{url: 'https://github.com/jonschlinkert'}, {url: 'https://github.com/doowb'}];
    stringify(authors).should.equal('(https://github.com/jonschlinkert), (https://github.com/doowb)');
  });

  it('should stringify name and url:', function () {
    var authors = [{name: 'Jon Schlinkert', url: 'https://github.com/jonschlinkert'}, {name: 'Brian Woodward', url: 'https://github.com/doowb'}];
    stringify(authors).should.equal('Jon Schlinkert (https://github.com/jonschlinkert), Brian Woodward (https://github.com/doowb)');
  });

  it('should stringify name and email:', function () {
    var authors = [{name: 'Jon Schlinkert', email: 'jon.schlinkert@sellside.com'}, {name: 'Brian Woodward', email: 'brian.woodward@sellside.com'}];
    stringify(authors).should.equal('Jon Schlinkert <jon.schlinkert@sellside.com>, Brian Woodward <brian.woodward@sellside.com>');
  });

  it('should stringify email and url:', function () {
    var authors = [{email: 'jon.schlinkert@sellside.com', url: 'https://github.com/jonschlinkert'}, {url: 'https://github.com/doowb', email: 'brian.woodward@sellside.com'}];
    stringify(authors).should.equal('<jon.schlinkert@sellside.com> (https://github.com/jonschlinkert), <brian.woodward@sellside.com> (https://github.com/doowb)');
  });

  it('should stringify name, email and url:', function () {
    var authors = [{name: 'Jon Schlinkert', email: 'jon.schlinkert@sellside.com', url: 'https://github.com/jonschlinkert'}, {name: 'Brian Woodward', url: 'https://github.com/doowb', email: 'brian.woodward@sellside.com'}];
    stringify(authors).should.equal('Jon Schlinkert <jon.schlinkert@sellside.com> (https://github.com/jonschlinkert), Brian Woodward <brian.woodward@sellside.com> (https://github.com/doowb)');
  });
});

describe('array: one author:', function () {
  it('should stringify name:', function () {
    var authors = [{name: 'Jon Schlinkert'}];
    stringify(authors).should.equal('Jon Schlinkert');
  });

  it('should stringify email:', function () {
    var authors = [{email: 'jon.schlinkert@sellside.com'}];
    stringify(authors).should.equal('<jon.schlinkert@sellside.com>');
  });

  it('should stringify url:', function () {
    var authors = [{url: 'https://github.com/jonschlinkert'}];
    stringify(authors).should.equal('(https://github.com/jonschlinkert)');
  });

  it('should stringify name and url:', function () {
    var authors = [{name: 'Jon Schlinkert', url: 'https://github.com/jonschlinkert'}];
    stringify(authors).should.equal('Jon Schlinkert (https://github.com/jonschlinkert)');
  });

  it('should stringify name and email:', function () {
    var authors = [{name: 'Jon Schlinkert', email: 'jon.schlinkert@sellside.com'}];
    stringify(authors).should.equal('Jon Schlinkert <jon.schlinkert@sellside.com>');
  });

  it('should stringify email and url:', function () {
    var authors = [{email: 'jon.schlinkert@sellside.com', url: 'https://github.com/jonschlinkert'}];
    stringify(authors).should.equal('<jon.schlinkert@sellside.com> (https://github.com/jonschlinkert)');
  });

  it('should stringify name, email and url:', function () {
    var authors = [{name: 'Jon Schlinkert', email: 'jon.schlinkert@sellside.com', url: 'https://github.com/jonschlinkert'}];
    stringify(authors).should.equal('Jon Schlinkert <jon.schlinkert@sellside.com> (https://github.com/jonschlinkert)');
  });
});

describe('object', function () {
  it('should stringify name:', function () {
    var author = {name: 'Jon Schlinkert'};
    stringify(author).should.equal('Jon Schlinkert');
  });

  it('should stringify email:', function () {
    var author = {email: 'jon.schlinkert@sellside.com'};
    stringify(author).should.equal('<jon.schlinkert@sellside.com>');
  });

  it('should stringify url:', function () {
    var author = {url: 'https://github.com/jonschlinkert'};
    stringify(author).should.equal('(https://github.com/jonschlinkert)');
  });

  it('should stringify name and url:', function () {
    var author = {name: 'Jon Schlinkert', url: 'https://github.com/jonschlinkert'};
    stringify(author).should.equal('Jon Schlinkert (https://github.com/jonschlinkert)');
  });

  it('should stringify name and email:', function () {
    var author = {name: 'Jon Schlinkert', email: 'jon.schlinkert@sellside.com'};
    stringify(author).should.equal('Jon Schlinkert <jon.schlinkert@sellside.com>');
  });

  it('should stringify email and url:', function () {
    var author = {email: 'jon.schlinkert@sellside.com', url: 'https://github.com/jonschlinkert'};
    stringify(author).should.equal('<jon.schlinkert@sellside.com> (https://github.com/jonschlinkert)');
  });

  it('should stringify name, email and url:', function () {
    var author = {name: 'Jon Schlinkert', email: 'jon.schlinkert@sellside.com', url: 'https://github.com/jonschlinkert'};
    stringify(author).should.equal('Jon Schlinkert <jon.schlinkert@sellside.com> (https://github.com/jonschlinkert)');
  });
});