forked from helpers/handlebars-helpers
-
Notifications
You must be signed in to change notification settings - Fork 14
/
string.js
829 lines (749 loc) · 18.6 KB
/
string.js
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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
'use strict';
var util = require('handlebars-utils');
var utils = require('./utils');
var helpers = module.exports;
let lorem = require('./lorem.js');
/**
* Append the specified `suffix` to the given string.
*
* ```handlebars
* <!-- given that 'item.stem' is 'foo' -->
* {{append item.stem '.html'}}
* <!-- results in: 'foo.html' -->
* ```
* @param {String} `str`
* @param {String} `suffix`
* @return {String}
* @api public
* @example {{append 'index' '.html'}} -> index.html
*/
helpers.append = function(str, suffix) {
if (typeof str === 'string' && typeof suffix === 'string') {
return str + suffix;
}
return str;
};
/**
* camelCase the characters in the given `string`.
*
* ```handlebars
* {{camelcase 'foo bar baz'}};
* <!-- results in: 'fooBarBaz' -->
* ```
* @param {String} `string` The string to camelcase.
* @return {String}
* @api public
* @example {{camelcase 'foo bar baz'}} -> fooBarBaz
*/
helpers.camelcase = function(str) {
if (typeof(str) !== 'string') return '';
return utils.changecase(str, function(ch) {
return ch.toUpperCase();
});
};
/**
* Capitalize the first word in a sentence.
*
* ```handlebars
* {{capitalize 'foo bar baz'}}
* <!-- results in: 'Foo bar baz' -->
* ```
* @param {String} `str`
* @return {String}
* @api public
* @example {{capitalize 'foo bar baz'}} -> Foo bar baz
*/
helpers.capitalize = function(str) {
if (typeof(str) !== 'string') return '';
return str.charAt(0).toUpperCase() + str.slice(1);
};
/**
* Capitalize all words in a string.
*
* ```handlebars
* {{capitalizeAll 'foo bar baz'}}
* <!-- results in: 'Foo Bar Baz' -->
* ```
* @param {String} `str`
* @return {String}
* @api public
* @example {{ capitalizeAll 'foo bar baz'}} -> Foo Bar Baz
*/
helpers.capitalizeAll = function(str) {
if (typeof(str) !== 'string') return '';
if (util.isString(str)) {
return str.replace(/\w\S*/g, function(word) {
return helpers.capitalize(word);
});
}
};
/**
* Center a string using non-breaking spaces
*
* @param {String} `str`
* @param {String} `spaces`
* @return {String}
* @api public
* @example {{ center 'test' 1}} -> ' test '
*/
helpers.center = function(str, spaces) {
if (typeof(str) !== 'string') return '';
var space = '';
var i = 0;
while (i < spaces) {
space += ' ';
i++;
}
return space + str + space;
};
/**
* Like trim, but removes both extraneous whitespace **and
* non-word characters** from the beginning and end of a string.
*
* ```handlebars
* {{chop '_ABC_'}}
* <!-- results in: 'ABC' -->
*
* {{chop '-ABC-'}}
* <!-- results in: 'ABC' -->
*
* {{chop ' ABC '}}
* <!-- results in: 'ABC' -->
* ```
* @param {String} `string` The string to chop.
* @return {String}
* @api public
* @example {{ chop ' ABC '}} -> ABC
*/
helpers.chop = function(str) {
if (typeof(str) !== 'string') return '';
return utils.chop(str);
};
/**
* dash-case the characters in `string`. Replaces non-word
* characters and periods with hyphens.
*
* ```handlebars
* {{dashcase 'a-b-c d_e'}}
* <!-- results in: 'a-b-c-d-e' -->
* ```
* @param {String} `string`
* @return {String}
* @api public
* @example {{dashcase 'a-b-c d_e'}} -> a-b-c-d-e
*/
helpers.dashcase = function(str) {
if (typeof(str) !== 'string') return '';
return utils.changecase(str, function(ch) {
return '-' + ch;
});
};
/**
* dot.case the characters in `string`.
*
* ```handlebars
* {{dotcase 'a-b-c d_e'}}
* <!-- results in: 'a.b.c.d.e' -->
* ```
* @param {String} `string`
* @return {String}
* @api public
* @example {{dotcase 'a-b-c d_e'}} -> a.b.c.d.e
*/
helpers.dotcase = function(str) {
if (typeof(str) !== 'string') return '';
return utils.changecase(str, function(ch) {
return '.' + ch;
});
};
/**
* Lowercase all of the characters in the given string. Alias for [lowercase](#lowercase).
*
* ```handlebars
* {{downcase 'aBcDeF'}}
* <!-- results in: 'abcdef' -->
* ```
* @param {String} `string`
* @return {String}
* @alias lowercase
* @api public
* @example {{downcase 'aBcDeF'}} -> abcdef
*/
helpers.downcase = function() {
return helpers.lowercase.apply(this, arguments);
};
/**
* Truncates a string to the specified `length`, and appends
* it with an elipsis, `…`.
*
* ```handlebars
* {{ellipsis (sanitize '<span>foo bar baz</span>'), 7}}
* <!-- results in: 'foo bar…' -->
* {{ellipsis 'foo bar baz', 7}}
* <!-- results in: 'foo bar…' -->
* ```
* @param {String} `str`
* @param {Number} `length` The desired length of the returned string.
* @return {String} The truncated string.
* @api public
* @example {{ellipsis 'foo bar baz' 7}} -> foo bar…
*/
helpers.ellipsis = function(str, limit) {
if (util.isString(str)) {
if (str.length <= limit) {
return str;
}
return helpers.truncate(str, limit) + '…';
}
};
/**
* Replace spaces in a string with hyphens.
*
* ```handlebars
* {{hyphenate 'foo bar baz qux'}}
* <!-- results in: 'foo-bar-baz-qux' -->
* ```
* @param {String} `str`
* @return {String}
* @api public
* @example {{hyphenate 'foo bar baz qux'}} -> foo-bar-baz-qux
*/
helpers.hyphenate = function(str) {
if (typeof(str) !== 'string') return '';
return str.split(' ').join('-');
};
/**
* Return true if `value` is a string.
*
* ```handlebars
* {{isString 'foo'}}
* <!-- results in: 'true' -->
* ```
* @param {String} `value`
* @return {Boolean}
* @api public
* @example {{isString 'foo'}} -> true
*/
helpers.isString = function(value) {
return typeof value === 'string';
};
/**
* Lowercase all characters in the given string.
*
* ```handlebars
* {{lowercase 'Foo BAR baZ'}}
* <!-- results in: 'foo bar baz' -->
* ```
* @param {String} `str`
* @return {String}
* @api public
* @example {{lowercase 'Foo BAR baZ'}} -> foo bar baz
*/
helpers.lowercase = function(str) {
if (util.isObject(str) && str.fn) {
return str.fn(this).toLowerCase();
}
if (typeof(str) !== 'string') return '';
return str.toLowerCase();
};
/**
* Return the number of occurrences of `substring` within the
* given `string`.
*
* ```handlebars
* {{occurrences 'foo bar foo bar baz' 'foo'}}
* <!-- results in: 2 -->
* ```
* @param {String} `str`
* @param {String} `substring`
* @return {Number} Number of occurrences
* @api public
* @example {{occurrences 'foo bar foo bar baz' 'foo'}} -> 2
*/
helpers.occurrences = function(str, substring) {
if (typeof(str) !== 'string') return '';
var len = substring.length;
var pos = 0;
var n = 0;
while ((pos = str.indexOf(substring, pos)) > -1) {
n++;
pos += len;
}
return n;
};
/**
* PascalCase the characters in `string`.
*
* ```handlebars
* {{pascalcase 'foo bar baz'}}
* <!-- results in: 'FooBarBaz' -->
* ```
* @param {String} `string`
* @return {String}
* @api public
* @example {{pascalcase 'foo bar baz'}} -> FooBarBaz
*/
helpers.pascalcase = function(str) {
if (typeof(str) !== 'string') return '';
str = utils.changecase(str, function(ch) {
return ch.toUpperCase();
});
return str.charAt(0).toUpperCase() + str.slice(1);
};
/**
* path/case the characters in `string`.
*
* ```handlebars
* {{pathcase 'a-b-c d_e'}}
* <!-- results in: 'a/b/c/d/e' -->
* ```
* @param {String} `string`
* @return {String}
* @api public
* @example {{pathcase 'a-b-c d_e'}} -> a/b/c/d/e
*/
helpers.pathcase = function(str) {
if (typeof(str) !== 'string') return '';
return utils.changecase(str, function(ch) {
return '/' + ch;
});
};
/**
* Replace spaces in the given string with pluses.
*
* ```handlebars
* {{plusify 'foo bar baz'}}
* <!-- results in: 'foo+bar+baz' -->
* ```
* @param {String} `str` The input string
* @return {String} Input string with spaces replaced by plus signs
* @source Stephen Way <https://github.com/stephenway>
* @api public
* @example {{plusify 'foo bar baz'}} -> foo+bar+baz
*/
helpers.plusify = function(str, ch) {
if (typeof(str) !== 'string') return '';
if (!util.isString(ch)) ch = ' ';
return str.split(ch).join('+');
};
/**
* Prepends the given `string` with the specified `prefix`.
*
* ```handlebars
* <!-- given that 'val' is 'bar' -->
* {{prepend val 'foo-'}}
* <!-- results in: 'foo-bar' -->
* ```
* @param {String} `str`
* @param {String} `prefix`
* @return {String}
* @api public
* @example {{prepend 'bar' 'foo-'}} -> foo-bar
*/
helpers.prepend = function(str, prefix) {
return typeof str === 'string' && typeof prefix === 'string'
? (prefix + str)
: str;
};
/**
* Render a block without processing mustache templates inside the block.
*
* ```handlebars
* {{{{raw}}}}
* {{foo}}
* {{{{/raw}}}}
* <!-- results in: '{{foo}}' -->
* ```
*
* @param {Object} `options`
* @return {String}
* @block
* @api public
* @example {{{{raw}}}}{{foo}}{{{{/raw}}}} -> \{{foo}}
*/
helpers.raw = function(options) {
var str = options.fn();
var opts = util.options(this, options);
if (opts.escape !== false) {
var idx = 0;
while (((idx = str.indexOf('{{', idx)) !== -1)) {
if (str[idx - 1] !== '\\') {
str = str.slice(0, idx) + '\\' + str.slice(idx);
}
idx += 3;
}
}
return str;
};
/**
* Remove all occurrences of `substring` from the given `str`.
*
* ```handlebars
* {{remove 'a b a b a b' 'a '}}
* <!-- results in: 'b b b' -->
* ```
* @param {String} `str`
* @param {String} `substring`
* @return {String}
* @api public
* @example {{remove 'a b a b a b' 'a '}} -> b b b
*/
helpers.remove = function(str, ch) {
if (typeof(str) !== 'string') return '';
if (!util.isString(ch)) return str;
return str.split(ch).join('');
};
/**
* Remove the first occurrence of `substring` from the given `str`.
*
* ```handlebars
* {{remove 'a b a b a b' 'a'}}
* <!-- results in: ' b a b a b' -->
* ```
* @param {String} `str`
* @param {String} `substring`
* @return {String}
* @api public
* @example {{removeFirst 'a b a b a b' 'a'}} -> ' b a b a b'
*/
helpers.removeFirst = function(str, ch) {
if (typeof(str) !== 'string') return '';
if (!util.isString(ch)) return str;
return str.replace(ch, '');
};
/**
* Replace all occurrences of substring `a` with substring `b`.
*
* ```handlebars
* {{replace 'a b a b a b' 'a' 'z'}}
* <!-- results in: 'z b z b z b' -->
* ```
* @param {String} `str`
* @param {String} `a`
* @param {String} `b`
* @return {String}
* @api public
* @example {{replace 'a b a b a b' 'a' 'z'}} -> z b z b z b
*/
helpers.replace = function(str, a, b) {
if (typeof(str) !== 'string') return '';
if (!util.isString(a)) return str;
if (!util.isString(b)) b = '';
return str.split(a).join(b);
};
/**
* Replace the first occurrence of substring `a` with substring `b`.
*
* ```handlebars
* {{replace 'a b a b a b' 'a' 'z'}}
* <!-- results in: 'z b a b a b' -->
* ```
* @param {String} `str`
* @param {String} `a`
* @param {String} `b`
* @return {String}
* @api public
* @example {{replaceFirst 'a b a b a b' 'a' 'z'}} -> z b a b a b
*/
helpers.replaceFirst = function(str, a, b) {
if (typeof(str) !== 'string') return '';
if (!util.isString(a)) return str;
if (!util.isString(b)) b = '';
return str.replace(a, b);
};
/**
* Reverse a string.
*
* ```handlebars
* {{reverse 'abcde'}}
* <!-- results in: 'edcba' -->
* ```
* @param {String} `str`
* @return {String}
* @api public
* @example {{reverse 'abcde'}} -> edcba
*/
helpers.reverse = require('./array').reverse;
/**
* Sentence case the given string
*
* ```handlebars
* {{sentence 'hello world. goodbye world.'}}
* <!-- results in: 'Hello world. Goodbye world.' -->
* ```
* @param {String} `str`
* @return {String}
* @api public
* @example {{sentence 'hello world. goodbye world.'}} -> Hello world. Goodbye world.
*/
helpers.sentence = function(str) {
if (typeof(str) !== 'string') return '';
return str.replace(/((?:\S[^\.\?\!]*)[\.\?\!]*)/g, function(txt) {
return txt.charAt(0).toUpperCase() + txt.substr(1).toLowerCase();
});
};
/**
* snake_case the characters in the given `string`.
*
* ```handlebars
* {{snakecase 'a-b-c d_e'}}
* <!-- results in: 'a_b_c_d_e' -->
* ```
* @param {String} `string`
* @return {String}
* @api public
* @example {{snakecase 'a-b-c d_e'}} -> a_b_c_d_e
*/
helpers.snakecase = function(str) {
if (typeof(str) !== 'string') return '';
return utils.changecase(str, function(ch) {
return '_' + ch;
});
};
/**
* Split `string` by the given `character`.
*
* ```handlebars
* {{split 'a,b,c' ','}}
* <!-- results in: ['a', 'b', 'c'] -->
* ```
* @param {String} `string` The string to split.
* @return {String} `character` Default is an empty string.
* @api public
* @example {{split 'a,b,c'}} -> ['a', 'b', 'c']
*/
helpers.split = function(str, ch) {
if (typeof(str) !== 'string') return '';
if (!util.isString(ch)) ch = ',';
return str.split(ch);
};
/**
* Tests whether a string begins with the given prefix.
*
* ```handlebars
* {{#startsWith 'Goodbye' 'Hello, world!'}}
* Whoops
* {{else}}
* Bro, do you even hello world?
* {{/startsWith}}
* ```
* @contributor Dan Fox <http://github.com/iamdanfox>
* @param {String} `prefix`
* @param {String} `testString`
* @param {String} `options`
* @return {String}
* @block
* @api public
* @example {{#startsWith 'Goodbye' 'Hello, world!'}}Yep{{else}}Nope{{/startsWith}} -> Nope
*/
helpers.startsWith = function(prefix, str, options) {
var args = [].slice.call(arguments);
options = args.pop();
if (util.isString(str) && str.indexOf(prefix) === 0) {
return options.fn(this);
}
if (typeof options.inverse === 'function') {
return options.inverse(this);
}
return '';
};
/**
* Title case the given string.
*
* ```handlebars
* {{titleize 'this is title case'}}
* <!-- results in: 'This Is Title Case' -->
* ```
* @param {String} `str`
* @return {String}
* @api public
* @example {{titleize 'this is title case' }} -> This Is Title Case
*/
helpers.titleize = function(str) {
if (typeof(str) !== 'string') return '';
var title = str.replace(/[- _]+/g, ' ');
var words = title.split(' ');
var len = words.length;
var res = [];
var i = 0;
while (len--) {
var word = words[i++];
res.push(exports.capitalize(word));
}
return res.join(' ');
};
/**
* Removes extraneous whitespace from the beginning and end
* of a string.
*
* ```handlebars
* {{trim ' ABC '}}
* <!-- results in: 'ABC' -->
* ```
* @param {String} `string` The string to trim.
* @return {String}
* @api public
* @example {{trim ' ABC ' }} -> ABC
*/
helpers.trim = function(str) {
return typeof str === 'string' ? str.trim() : '';
};
/**
* Removes extraneous whitespace from the beginning of a string.
*
* ```handlebars
* {{trim ' ABC '}}
* <!-- results in: 'ABC ' -->
* ```
* @param {String} `string` The string to trim.
* @return {String}
* @api public
* @example {{trimLeft ' ABC ' }} -> 'ABC '
*/
helpers.trimLeft = function(str) {
if (util.isString(str)) {
return str.replace(/^\s+/, '');
}
};
/**
* Removes extraneous whitespace from the end of a string.
*
* ```handlebars
* {{trimRight ' ABC '}}
* <!-- results in: ' ABC' -->
* ```
* @param {String} `string` The string to trim.
* @return {String}
* @api public
* @example {{trimRight ' ABC ' }} -> ' ABC'
*/
helpers.trimRight = function(str) {
if (util.isString(str)) {
return str.replace(/\s+$/, '');
}
};
/**
* Truncate a string to the specified `length`. Also see [ellipsis](#ellipsis).
*
* ```handlebars
* truncate('foo bar baz', 7);
* <!-- results in: 'foo bar' -->
* truncate(sanitize('<span>foo bar baz</span>', 7));
* <!-- results in: 'foo bar' -->
* ```
* @param {String} `str`
* @param {Number} `limit` The desired length of the returned string.
* @param {String} `suffix` Optionally supply a string to use as a suffix to
* denote when the string has been truncated. Otherwise an ellipsis (`…`) will be used.
* @return {String} The truncated string.
* @api public
* @example {{truncate 'foo bar baz' 7 }} -> foo bar
*/
helpers.truncate = function(str, limit, suffix) {
if (util.isString(str)) {
if (typeof suffix !== 'string') {
suffix = '';
}
if (str.length > limit) {
return str.slice(0, limit - suffix.length) + suffix;
}
return str;
}
};
/**
* Truncate a string to have the specified number of words.
* Also see [truncate](#truncate).
*
* ```handlebars
* truncateWords('foo bar baz', 1);
* <!-- results in: 'foo…' -->
* truncateWords('foo bar baz', 2);
* <!-- results in: 'foo bar…' -->
* truncateWords('foo bar baz', 3);
* <!-- results in: 'foo bar baz' -->
* ```
* @param {String} `str`
* @param {Number} `limit` The desired length of the returned string.
* @param {String} `suffix` Optionally supply a string to use as a suffix to
* denote when the string has been truncated.
* @return {String} The truncated string.
* @api public
* @example {{truncateWords 'foo bar baz' 1 }} -> foo…
*/
helpers.truncateWords = function(str, count, suffix) {
if (util.isString(str) && !isNaN(count)) {
if (typeof suffix !== 'string') {
suffix = '…';
}
var num = Number(count);
var arr = str.split(/[ \t]/);
if (num >= arr.length) {
return str;
}
arr = arr.slice(0, num);
var val = arr.join(' ').trim();
return val + suffix;
}
};
/**
* Uppercase all of the characters in the given string. Alias for [uppercase](#uppercase).
*
* ```handlebars
* {{upcase 'aBcDeF'}}
* <!-- results in: 'ABCDEF' -->
* ```
* @param {String} `string`
* @return {String}
* @alias uppercase
* @api public
* @example {{upcase 'aBcDef'}} -> ABCDEF
*/
helpers.upcase = function() {
return helpers.uppercase.apply(this, arguments);
};
/**
* Uppercase all of the characters in the given string. If used as a
* block helper it will uppercase the entire block. This helper
* does not support inverse blocks.
*
* ```handlebars
* {{uppercase 'aBcDeF'}}
* <!-- results in: 'ABCDEF' -->
* ```
* @related capitalize capitalizeAll
* @param {String} `str` The string to uppercase
* @param {Object} `options` Handlebars options object
* @return {String}
* @block
* @inline
* @api public
* @example {{uppercase 'aBcDef'}} -> ABCDEF
*/
helpers.uppercase = function(str) {
if (util.isObject(str) && str.fn) {
return str.fn(this).toUpperCase();
}
if (typeof(str) !== 'string') return '';
return str.toUpperCase();
};
/**
* Takes a number and returns that many charaters of Lorem Ipsum
*
* ```handlebars
* {{lorem 11}}
* <!-- results in: 'Lorem Ipsum' -->
* ```
* @param {Number} `num` The string to uppercase
* @return {String}
* @block
* @inline
* @api public
* @example {{lorem 11}} -> Lorem ipsum
*/
helpers.lorem = function(num) {
// Sad Path - Not a number, or not greater than 1, or not truthy
if (isNaN(num) || num < 1 || !num) {
num = 11;
}
return lorem.substring(0, num);
};