all files / postcss-filter-gradient/ index.js

100% Statements 140/140
100% Branches 56/56
100% Functions 15/15
100% Lines 139/139
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   70× 70×   70×       66×       66×                                         66×   66× 66×             66×   66×       62× 62× 62× 62× 62× 62× 62×     62×   62× 130×           62×             33× 33×           33×   33×     33× 33× 33× 33×   33×   33× 33×   33× 28× 10× 18× 11×       33×   33× 15× 15×         33×       62× 62× 62×   62× 29×   29× 29×       25×                     29×   29×           33× 33×     62×     66×     66×           62× 62× 62× 62× 62× 62× 62×     62× 25× 25× 25×     62×   62× 62×               58×                 72×   76×       73× 73× 72× 72×   72× 70× 70×   70×             73×     34× 34× 34× 34×   32× 16×     34× 33× 73× 73×   73×     73×               69×     69×     66×     66×     58×     56×       54× 18×       54×            
var postcss = require('postcss');
var list = postcss.list;
var filterGradient = require('filter-gradient');
var DECL_FILTER = /^background(-image)?$/;
 
function hasFilter(rule) {
    var has = false;
    rule.walkDecls(/(-ms-)?filter/, function () {
        has = true;
    });
    return has;
}
 
function parseGradient(input) {
    // match 0 and any number with unit
    var rAngle = /((?:[+-]?\d*\.?\d+)(deg|grad|rad|turn)|0)/i;
    // match side and any corner, in browser,
    // `top right` and `right top` are the same,
    // so we should put this situation into consideration
    var rSideCorner = new RegExp(
      '(' + // 1
          '(?:to\\s+)?' +
          '(?:' +
              '(?:left|right|top|bottom)' +
              '|' +
              '(?:' +
                  '(?:' + // left top, left bottom, right top, right bottom
                      '(?:left|right)\\s+(?:top|bottom)' +
                  ')' +
                  '|' +
                  '(?:' + // top left, top right, bottom left, bottom right
                      '(?:top|bottom)\\s+(?:left|right)' +
                  ')' +
              ')' +
          ')' +
      ')' + // end 1
      '(?=\\s*,)'
    );
 
    // match color stops, the color format is not very precise
    var rColorStops = /(#[0-9a-f]{3,6}|(?:hsl|rgb)a?\(.+?\)|\w+)(?:\s+((?:[+-]?\d*\.?\d+)(?:%|[a-z]+)?))?/gi;
    // the final gradient line regexp
    var rGradientLine = new RegExp(rAngle.source + '|' + rSideCorner.source, 'i');
    var rGradient = new RegExp(
        'linear-gradient\\(\\s*' +
            '(?:(' + rGradientLine.source + ')\\s*,\\s*)?' + // match gradient line
            '(' + rColorStops.source + '(?:\\s*,\\s*' + rColorStops.source + ')+)' + // match color stops
        '\\s*\\)',
    'i');
 
    var gradientMatch = rGradient.exec(input);
 
    if (!gradientMatch) {
        return null;
    }
 
    // remove `linear-gradient(` and `)`
    var gradientStr = gradientMatch[0].slice(16, -1).trim();
    var position = gradientStr.match('^' + rGradientLine.source, 'i') || ['', null, 'deg', 'to bottom'];
    var angle = position[1];
    var sideCorner = position[3];
    var unit = position[2];
    var stops = [];
    var stop;
 
    // remove the gradient line
    var str = gradientStr.slice(position[0].length);
 
    while (stop = rColorStops.exec(str)) { // eslint-disable-line
        stops.push({
            color: stop[1],
            position: stop[2]
        });
    }
 
    return {
        angle: { value: angle, unit: unit },
        sideCorner: sideCorner,
        colorStops: stops
    };
}
 
function normalizeAngle(value, unit) {
    var num = parseFloat(value);
    var fullMap = {
        grad: 400,
        rad: 2,
        turn: 1,
        deg: 360
    };
    unit = (unit || 'deg').toLowerCase();
 
    return num / fullMap[unit] * 360;
}
 
function angleToDirection(angle) {
    var result = {};
    var direction;
    var isFallback;
    var count;
 
    isFallback = angle % 90 !== 0;
    // handle the negtive value
    angle = (angle % 360 + 360) % 360;
    count = angle / 45;
 
    if (count <= 1) {
        direction = 'top';
    } else if (count <= 3) {
        direction = 'right';
    } else if (count <= 5) {
        direction = 'bottom';
    } else if (count <= 7) {
        direction = 'left';
    } else {
        direction = 'top';
    }
 
    result.direction = direction;
 
    if (isFallback) {
        result.isFallback = true;
        result.message =
            'IE filter doesn\'t support angular gradient, ' +
            'we use the closest side as the fallback.';
    }
 
    return result;
}
 
// Get the gradient direction: left, right, top or bottom
function getDirection(gradient) {
    var segs;
    var angle;
    var result = {};
 
    if (gradient.sideCorner) {
        segs = gradient.sideCorner.split(/\s+/);
 
        var to = segs[0] === 'to';
        if (to) {
            // sideCorner starts with "to" so we shift it off since we don't
            // need this element anymore, and continue with generating the
            // gradient in the normal direction.
            segs.shift();
        } else {
            // sideCorner does not start with "to", so we need to reverse the
            // direction.
            var reverseDirections = {
                top: 'bottom',
                bottom: 'top',
                left: 'right',
                right: 'left'
            };
            segs[0] = reverseDirections[segs[0]];
        }
 
        result.direction = segs[0];
        // side corner is  `top right` or `bottom left` etc.
        if (segs.length > 1) {
            // fallback to one direction
            result.isFallback = true;
            result.message =
                'IE filter doesn\'t support side corner gradient, ' +
                'we use the first side of the side corner as fallback.';
        }
    } else {
        angle = normalizeAngle(gradient.angle.value, gradient.angle.unit);
        result = angleToDirection(angle);
    }
 
    return result;
}
 
function gradientToFilter(gradient) {
    var obj = parseGradient(gradient);
 
    // The gradient value is not valid
    if (!obj) {
        return {
            success: false,
            message: '`' + gradient + '` is not a valid linear gradient value.'
        };
    }
 
    var startColor = obj.colorStops[0].color;
    var endColor = obj.colorStops.slice(-1)[0].color;
    var result = getDirection(obj);
    var direction = result.direction;
    var type;
    var tmp;
    var filterString;
 
    // Swap color if needed;
    if (/top|left/i.test(direction)) {
        tmp = startColor;
        startColor = endColor;
        endColor = tmp;
    }
    // 0: vertical, 1:horizontal
    type = /top|bottom/i.test(direction) ? 0 : 1;
 
    try {
        filterString = filterGradient(startColor, endColor, type);
    } catch (e) {
        // The color format is not valid
        return {
            success: false,
            message: e.message + ' in `' + gradient + '`'
        };
    }
 
    return {
        success: true,
        string: filterString,
        isMultiColor: obj.colorStops.length > 2,
        isFallback: result.isFallback,
        message: result.message
    };
}
 
function getGradientsFromDecl(decl) {
    return list.comma(decl.value).filter(function (seg) {
        // Only support the standard linear-gradient syntax
        return seg.indexOf('linear-gradient') === 0;
    });
}
 
function getGradientFromRule(rule) {
    var gradient = {};
    rule.walkDecls(DECL_FILTER, function (decl) {
        var gradients =  getGradientsFromDecl(decl);
        var len = gradients.length;
        // Only select the first gradienat if there more than one gradients
        if (len) {
            gradient.value = gradients[0].trim();
            gradient.decl = decl;
 
            if (len > 1) {
                gradient.warnings =
                    'IE filter doesn\'t support multiple gradients, ' +
                    'we pick the first as fallback.';
            }
        }
    });
 
    return gradient;
}
 
module.exports = postcss.plugin('postcss-filter-gradient', function (opts) {
    opts = opts || {};
    opts.angleFallback = opts.angleFallback !== false;
    opts.skipMultiColor = opts.skipMultiColor === true;
    opts.skipWarnings = opts.skipWarnings === true;
 
    function warn(target, result, message) {
        if (opts.skipWarnings) return;
        target.warn(result, message);
    }
 
    return function (root, result) {
        root.walkRules(function (rule) {
            var gradient;
            var filter;
 
            gradient = getGradientFromRule(rule);
 
            // if linear-gradient and `filter` both exist, warn users
            if (gradient.value && hasFilter(rule)) {
                warn(
                    rule,
                    result,
                    'The `filter` declaration already exists, we have skipped this rule.'
                );
                return;
            }
 
 
            if (gradient.warnings) {
                warn(gradient.decl, result, gradient.warnings);
            }
 
            if (!gradient.value) {
                return;
            }
 
            filter = gradientToFilter(gradient.value);
 
            // warn users when the gradient value is not valid.
            if (!filter.success) {
                warn(gradient.decl, result, filter.message);
                return;
            }
 
            if (opts.skipMultiColor && filter.isMultiColor) {
                return;
            }
 
            if (!opts.angleFallback && filter.isFallback) {
                return;
            }
 
            // warn developer when `filter.message` is not empty
            if (filter.message) {
                warn(gradient.decl, result, filter.message);
            }
 
            // append filter string
            gradient.decl.cloneAfter({
                prop: 'filter', value: filter.string
            });
        });
    };
});