@polyv/utils 1.6.0 → 2.0.0-beta.2

package/src/querystring.js

@@ -1,121 +0,0 @@
-/**
- * 本模块提供 URL 查询字符串的操作方法。
- * @module querystring
- */
-
-import { hasOwnProp } from './lang';
-
-/**
- * 把查询字符串反序列化为键值对集合。
- * @author luoliquan
- * @param {string} str 查询字符串。
- * @return {Object} 键值对集合。
- * @example
- * parse('a=1&%E9%94%AE=%E5%80%BC'); // { a: 1, '键': '值' }
- * parse('a=1&a=2&b=3'); // { a: [1, 2], b: 3 }
- */
-export function parse(str) {
-  if (typeof str !== 'string') {
-    throw new Error('The str argument must be a string type');
-  }
-
-  const result = {};
-
-  str.split('&').forEach(function(pair) {
-    if (!pair) { return; }
-    pair = pair.split('=');
-    const key = decodeURIComponent(pair[0]);
-    const value = decodeURIComponent(pair[1] || '');
-
-    if (hasOwnProp(result, key)) {
-      // 出现重复 key 值时解析为数组
-      if (!Array.isArray(result[key])) {
-        result[key] = [result[key]];
-      }
-      result[key].push(value);
-    } else {
-      result[key] = value;
-    }
-  });
-
-  return result;
-}
-
-/**
- * 把键值对集合序列化为查询字符串。
- * @author luoliquan
- * @param {Object} data 键值对集合。
- * @param {Object} [options] 参数。
- *   @param {Boolean} [options.ignoreEmpty=false] 是否忽略空值（包括null、undefined、空字符串）。
- * @return {string} 序列化结果。
- * @example
- * stringify({ a: 1, '键': '值' }); // 'a=1&%E9%94%AE=%E5%80%BC'
- * stringify({ a: [1, 2], b: 3 }); // 'a=1&a=2&b=3'
- */
-export function stringify(data, options) {
-  options = options || {};
-
-  const result = [];
-  function addToResult(key, value) {
-    if (value == null) { value = ''; }
-    // 忽略空值的情况
-    if (value === '' && options.ignoreEmpty) { return; }
-
-    result.push(encodeURIComponent(key) + '=' + encodeURIComponent(value));
-  }
-
-  let key, value;
-
-  // 避免在循环中生成匿名函数，提到循环外
-  function loopItem(item) { addToResult(key, item); }
-
-  for (key in data) {
-    if (hasOwnProp(data, key)) {
-      value = data[key];
-      if (Array.isArray(value)) {
-        value.forEach(loopItem);
-      } else {
-        addToResult(key, value);
-      }
-    }
-  }
-
-  return result.join('&');
-}
-
-/**
- * 把键值对集合序列化为查询字符串后拼接到指定URL。
- * @author luoliquan
- * @param {string} url 指定URL。
- * @param {Object|string} data 键值对集合。
- * @param {Object} [options] 参数。
- *   @param {Boolean} [options.ignoreEmpty] 序列化时是否忽略空值（包括null、undefined、空字符串）。
- * @return {String} 处理后的URL。
- * @example
- * append('http://abc.com?a=1', { b: 2, c: 3 }); // 'http://abc.com?a=1&b=2&c=3'
- * append('http://abc.com', { a: 1, b: 2 }); // 'http://abc.com?a=1&b=2'
- */
-export function append(url, data, options) {
-  if (url == null) { return url; }
-  url = String(url);
-
-  // 如果url中包含hash，要先剪出来
-  const temp = url.indexOf('#');
-  let hash = '';
-  if (temp !== -1) {
-    hash = url.substring(temp, url.length);
-    url = url.substring(0, temp);
-  }
-
-  // 移除位于末尾的?和&，方便拼接
-  url = url.replace(/[?&]$/, '');
-
-  if (typeof data !== 'string') {
-    data = stringify(data, options);
-  } else {
-    // 移除位于开头的?和&，方便拼接
-    data = data.replace(/^[?&]/, '');
-  }
-
-  return url + (url.indexOf('?') !== -1 ? '&' : '?') + data + hash;
-}

package/src/storage.js

@@ -1,106 +0,0 @@
-/**
- * 本模块提供本地存储相关方法的封装。
- * @module storage
- */
-
-import { tryParseJSON } from './lang';
-
-/**
- * 本地存储调用封装。
- * @author luoliquan
- * @param {Object} storageType 存储类型。
- */
-export class StorageWrap {
-  constructor(storageType) {
-    this._storageType = storageType || {
-      getItem() { return null; },
-      setItem() {},
-      removeItem() {}
-    };
-  }
-
-  /**
-   * 获取指定存储项的值。
-   * @param {string} key 存储项键名。
-   * @return {string} 存储项的值。
-   */
-  get(key) {
-    return this._storageType.getItem(key);
-  }
-
-  /**
-   * 获取指定存储项的值并解析为 JSON。
-   * @param {string} key 存储项键名。
-   * @return {Any} 解析结果。
-   */
-  getAsJSON(key) {
-    return tryParseJSON(this.get(key));
-  }
-
-  /**
-   * 写入指定存储项的值。
-   * @param {string} key 存储项键名。
-   * @param {Any} value 存储项的值。
-   * @return {boolean} 写入是否成功。
-   */
-  set(key, value) {
-    // 在浏览器的隐私模式下 setItem 会抛出异常
-    // 但 getItem 和 removeItem 都不会
-    try {
-      this._storageType.setItem(key, value);
-      return true;
-    } catch (e) {
-      return false;
-    }
-  }
-
-  /**
-   * 把指定值序列化为 JSON 字符串后写入到指定存储项。
-   * @param {string} key 存储项键名。
-   * @param {Any} value 存储项的值。
-   * @return {boolean} 写入是否成功。
-   */
-  setAsJSON(key, value) {
-    return this.set(key, JSON.stringify(value));
-  }
-
-  /**
-   * 移除存储项。
-   * @param {string} key 存储项键名。
-   */
-  remove(key) {
-    this._storageType.removeItem(key);
-  }
-}
-
-
-let sessionStorage, localStorage;
-if (typeof window !== 'undefined') {
-  // Chrome 隐私模式，跨域 iframe 内访问本地存储的相关对象会抛出异常
-  try {
-    sessionStorage = window.sessionStorage;
-    localStorage = window.localStorage;
-  } catch (e) {
-  }
-}
-
-/**
- * sessionStorage 存取方法（通过 StorageWrap 包装了 sessionStorage）。
- * @example
- * const user = { name: 'Tom', pet: 'cat' };
- * session.setAsJSON('user', user);
- * typeof session.get('user'); // 'string'
- * typeof session.getAsJSON('user'); // 'object'
- */
-export const session = new StorageWrap(sessionStorage);
-
-/**
- * localStorage 存取方法（通过 StorageWrap 包装了 localStorage）。
- * @example
- * const user = { name: 'Tom', pet: 'cat' };
- * local.setAsJSON('user', user);
- * local.getAsJSON('user');
- * typeof local.get('user'); // 'string'
- * typeof local.getAsJSON('user'); // 'object'
- */
-export const local = new StorageWrap(localStorage);

package/src/string.js

@@ -1,190 +0,0 @@
-/**
- * 本模块提供字符串处理相关方法。
- * @module string
- */
-
-import { extend } from './lang';
-
-/**
- * 计算字符串长度（英文字符按 1 算，非英文字符可指定单位长度）。
- * @param {string} str 字符串。
- * @param {number} [nonEnLen=2] 非英文字符的单位长度。
- * @return {number} 字符串长度。
- * @example
- * strLen('abcde;'); // 6
- * strLen('abc测试；'); // 9
- * strLen('abc测试；', 1); // 6
- */
-/**
- * 计算字符串长度（可分别指定英文字符和非英文字符的单位长度）。
- * @param {string} str 字符串。
- * @param {number|Object} [options] 为数字时表示非英文字符单位长度（此时英文字符单位长度为 1）；为 Object 时表示选项。
- *   @param {number} [options.enLen=1] 英文字符单位长度。
- *   @param {number} [options.nonEnLen=2] 非英文字符单位长度。
- * @return {number} 字符串长度。
- * @example
- * strLen('abcde;'); // 6
- * strLen('abc测试；'); // 9
- * strLen('abc测试；', { enLen: 0.5, nonEnLen: 1 }); // 4.5
- */
-export function strLen(str, options) {
-  // 函数重载
-  if (options == null) { options = 2; }
-  if (typeof options === 'number') {
-    options = {
-      enLen: 1,
-      nonEnLen: options
-    };
-  } else {
-    options = extend({
-      enLen: 1,
-      nonEnLen: 2
-    }, options);
-  }
-
-  let result = 0;
-  for (let i = str.length - 1; i >= 0; i--) {
-    result += str.charCodeAt(i) > 255 ?
-      options.nonEnLen :
-      options.enLen;
-  }
-  return result;
-}
-
-/**
- * 如果目标字符串超出限制长度，则进行截断并拼接省略符号；否则返回目标字符串。
- * @param {string} str 目标字符串。
- * @param {number} length 限制的长度。
- * @param {Object} [options] 选项。
- *   @param {number} [options.mode=2] 非英文字符的单位长度。已废弃，请使用 nonEnLen。
- *   @param {number} [options.enLen=1] 英文字符的单位长度。
- *   @param {number} [options.nonEnLen=2] 非英文字符的单位长度。
- *   @param {string} [options.ellipsis='...'] 省略符号。
- * @return {string} 截断后的字符串。
- * @example
- * cutStr('测试一下', 5); // '测试...'
- * cutStr('测试一下', 8); // '测试一下'
- * curStr('1测试2测试3', 3.5, { enLen: 0.5, nonEnLen: 1 }); // 1测...
- */
-export function cutStr(str, length, options) {
-  options = extend({
-    ellipsis: '...',
-    enLen: 1
-  }, options);
-  if (options.nonEnLen == null) {
-    options.nonEnLen = options.mode == null ? 2 : options.mode;
-  }
-
-  str = String(str);
-  const len = strLen(str, options);
-
-  // 未超出长度，直接返回传入的字符串
-  if (len <= length) { return str; }
-
-  // 减去省略符长度
-  length -= strLen(options.ellipsis, options);
-
-  let result = '', i = -1;
-  while (length > 0 && ++i < len) {
-    length -= str.charCodeAt(i) > 255 ?
-      options.nonEnLen :
-      options.enLen;
-    if (length >= 0) { result += str.charAt(i); }
-  }
-
-  result += options.ellipsis;
-
-  return result;
-}
-
-/**
- * 把指定字符串中的 HTML 预留字符替换成 HTML 实体。
- * @param {string} str 指定字符串。
- * @return {string} 替换后的字符串。
- */
-export function escapeHTML(str) {
-  if (str == null) { return str; }
-  const map = {
-    '"': '&quot;',
-    '\'': '&#39;',
-    '&': '&amp;',
-    '<': '&lt;',
-    '>': '&gt;'
-  };
-  return String(str).replace(/["'&<>]/g, (match) => {
-    return map[match];
-  });
-}
-
-/**
- * 移除指定字符串中的 HTML 标签。
- * @param {string} str 指定字符串。
- * @return {string} 处理后的字符串。
- */
-export function removeTags(str) {
-  if (str == null) { return str; }
-  return String(str).replace(/<.+?>/g, '');
-}
-
-/**
- * 把指定字符串中的换行符替换成 &lt;br /&gt;。
- * @param {string} str 指定字符串。
- * @return {string} 替换后的字符串。
- */
-export function nl2br(str) {
-  if (str == null) { return str; }
-  return String(str).replace(/\r?\n/g, '<br />');
-}
-
-/**
- * 生成随机字符串。
- * @since 1.6.0
- * @param {number} length 字符串长度。
- * @param {string} [prefix] 字符串前缀（不计入长度）。
- * @returns {string} 生成的随机字符串。
- */
-export function randomStr(length, prefix) {
-  length = parseInt(length);
-  if (!length || length < 0) {
-    throw new Error('"length" must be a number greater than 0');
-  }
-
-  let result = '';
-  do {
-    result += Math.random().toString(36).substr(2);
-  } while (result.length < length);
-
-  // 拼接的长度可能大于指定长度，进行裁剪
-  result = result.substr(0, length);
-
-  if (prefix != null) { result = prefix + result; }
-
-  return result;
-}
-
-/**
- * 版本号对比。
- * @since 1.6.0
- * @param {string} versionA 待比较版本 A。
- * @param {string} versionB 待比较版本 B。
- * @return {number} 大于 0 时，表示版本 A 大于版本 B；
- *   小于 0 时，表示版本 B 大于版本 A；
- *   等于 0 时，表示两个版本号一致。
- */
-export function compareVersions(versionA, versionB) {
-  if (!versionA || !versionB) {
-    throw new Error('Please specify both version-a and verson-b');
-  }
-
-  // 去掉末尾的 .000
-  const reg = /(\.0+)+$/;
-  versionA = String(versionA).replace(reg, '').split('.');
-  versionB = String(versionB).replace(reg, '').split('.');
-
-  const len = Math.min(versionA.length, versionB.length);
-  for (let i = 0; i < len; i++) {
-    const diff = parseInt(versionA[i]) - parseInt(versionB[i]);
-    if (diff) { return diff; }
-  }
-  return versionA.length - versionB.length;
-}

package/src/validate.js

@@ -1,42 +0,0 @@
-/**
- * 本模块提供字符串格式验证方法。
- * @module validate
- */
-
-/**
- * 检查目标字符串是否手机号码。
- * @author liumin
- * @param {string} str 目标字符串。
- * @return {boolean} 目标字符串是否手机号码。
- * @example
- * isPhoneNO('13800138000'); // true
- * isPhoneNO('a13800138000c'); // false
- */
-export function isPhoneNO(str) {
-  return /^1[3-9]\d{9}$/.test(str);
-}
-
-/**
- * 检查目标字符串是否电子邮箱地址。
- * @author luoliquan
- * @param {string} str 目标字符串。
- * @return {boolean} 目标字符串是否电子邮箱地址。
- * @example
- * isEmail('me@polyv.net'); // true
- * isEmail('me@polyv_.net-'); // false
- */
-export function isEmail(str) {
-  let temp = /^[\w-]+(?:\.[\w-]+)*@[\w-]+(?:\.[\w-]+)*\.[a-zA-Z]{2,}$/.test(str);
-  if (temp) {
-    temp = str.replace('@', '.').split('.');
-    for (let i = temp.length - 1; i >= 0; i--) {
-      // 每一段的开头和结尾都不能是连字符或下划线
-      if (/^[-_]/.test(temp[i]) || /[_-]$/.test(temp[i])) {
-        return false;
-      }
-    }
-    return true;
-  } else {
-    return false;
-  }
-}