aboutsummaryrefslogtreecommitdiff
path: root/node_modules/montage/core/converter/trim-converter.js
blob: 2675b3e7553c33c2ed4169f553036fefe1dfbb5c (plain)
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
/* <copyright>
 This file contains proprietary software owned by Motorola Mobility, Inc.<br/>
 No rights, expressed or implied, whatsoever to this software are provided by Motorola Mobility, Inc. hereunder.<br/>
 (c) Copyright 2011 Motorola Mobility, Inc.  All Rights Reserved.
 </copyright> */
/**
	@module montage/core/converter/trim-converter
    @requires montage/core/core
    @requires montage/core/converter/converter
*/
var Montage = require("montage").Montage;
var Converter = require('core/converter/converter').Converter;


/**
    Trims a string of any leading or trailing white space.
    @memberof module:montage/core/converter#
    @function
    @param {String} str String to be trimmed.
    @returns {String} The trimmed string.
 */
var trim = exports.trim = function(str) {
    // from Google Closure library
    // Since IE doesn't include non-breaking-space (0xa0) in their \s character
    // class (as required by section 7.2 of the ECMAScript spec), we explicitly
    // include it in the regexp to enforce consistent cross-browser behavior.
    return str.replace(/^[\s\xa0]+|[\s\xa0]+$/g, '');
};
/**
    @class module:montage/core/converter/trim-converter.TrimConverter
    @classdesc Trims a string of white space.
    @example
    <caption>Removes leading and trailing white space from a string.</caption>
    var Converter= require("core/converter/converter").Converter,
    TrimConverter = require("core/converter/converter").TrimConverter;
    var str = "      Hello World     ";
    var trimConverter = TrimConverter.create();
    console.log("After trim: " + trimConverter.convert(str));
    // After trim: Hello World
*/
exports.TrimConverter = Montage.create(Converter, /** @lends module:montage/core/converter/trim-converter.TrimConverter# */ {
    /**
     @private
     */
    _convert: {
        value: function(v) {
            if (v && typeof v === 'string') {
                return trim(v);
            }
        }
    },

    /**
     Trims the provided string and returns the new string.
     @function
     @param {String} v The string to trim.
     @returns this._convert(v)
     */
    convert: {value: function(v) {
        return this._convert(v);
    }},
    /**
     Reverts the conversion.
     @function
     @param {String} v The string to revert.
     @returns this._convert(v)
     */
    revert: {value: function(v) {
        return this._convert(v);
    }}
});