Merge pull request #365 from leeyeh/next

v2.0.0

Author: leeyeh

.babelrc

@@ -1,5 +1,10 @@
 {
   "presets": [
     "es2015"
-  ]
+  ],
+  "env": {
+    "test": {
+      "plugins": ["istanbul"]
+    }
+  }
 }

.gitignore

@@ -2,9 +2,11 @@ node_modules/
 package/
 *tgz
 *.tar.gz
-release.sh
 coverage
 *.swp
 dist/js-sdk-api-docs
 npm-debug.log
 demo/test-es5.js
+.nyc_output
+dist
+docs

.jsdocrc.json

@@ -0,0 +1,6 @@
+{
+  "opts": {
+    "template": "node_modules/docdash",
+    "recurse": true
+  }
+}

.npmignore

@@ -3,11 +3,12 @@ demo
 node_modules
 src
 test
+script
 tools
 .babelrc
 .gitignore
 .travis.yml
 bower.json
 gulpfile.babel.js
 readme.txt
-.idea
+.nyc_output

.travis.yml

@@ -10,5 +10,10 @@ install:
   - npm install -g codecov
   - npm install
 script:
-  - npm test
-  - codecov
+  - npm test && codecov
+  - npm run build
+after_success:
+  - if [[ `node -v` == v4* ]] && [[ "$TRAVIS_BRANCH" == "next" ]] && [[ "${TRAVIS_PULL_REQUEST}" = "false" ]]; then
+      ./script/release.sh;
+      ./script/deploy.sh;
+    fi

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 LeanCloud
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -1,71 +1,75 @@
-# LeanCloud JavaScript SDK [![Build Status](https://travis-ci.org/leancloud/javascript-sdk.svg)](https://travis-ci.org/leancloud/javascript-sdk) [![codecov.io](https://codecov.io/github/leancloud/javascript-sdk/coverage.svg?branch=master)](https://codecov.io/github/leancloud/javascript-sdk?branch=master)
+LeanCloud JavaScript SDK
+====
+[![Build Status](https://img.shields.io/travis/leancloud/javascript-sdk.svg?style=flat-square)](https://travis-ci.org/leancloud/javascript-sdk)
+[![Codecov](https://img.shields.io/codecov/c/github/leancloud/javascript-sdk.svg?style=flat-square)](https://codecov.io/github/leancloud/javascript-sdk)
+[![David](https://img.shields.io/david/leancloud/javascript-sdk.svg?style=flat-square)](https://david-dm.org/leancloud/javascript-sdk)
+[![npm](https://img.shields.io/npm/v/leancloud-storage.svg?style=flat-square)](https://www.npmjs.com/package/leancloud-storage)
 
-JavaScript SDK for [LeanCloud](http://leancloud.cn/).
 
-## 使用方法请看 [官方文档](https://leancloud.cn/docs/leanstorage_guide-js.html)
+JavaScript SDK for [LeanCloud](http://leancloud.cn/).
 
 ## 安装
 
 ```
 // npm 安装
 npm install leancloud-storage --save
+// npm 安装 pre-release 版本
+npm install leancloud-storage@next --save
 
 // bower 安装
 bower install leancloud-storage --save
 ```
+文档
+----
+- [安装文档](https://leancloud.cn/docs/sdk_setup-js.html)
+- [使用文档](https://leancloud.cn/docs/leanstorage_guide-js.html)
+- [API 文档](https://leancloud.github.io/javascript-sdk/docs/)
+
+支持
+----
+* 如果你发现了新的 bug，或者有新的 feature request，请新建一个 issue
+* 在使用过程中遇到了问题时
+  * 如果你购买了技术支持服务，请新建一个 ticket。
+  * 也可以在 [论坛](https://forum.leancloud.cn/) 提问、讨论。
 
-## 贡献代码
+贡献
+----
+如果你希望为这个项目贡献代码，请按以下步骤进行：
 
 * `fork` 这个项目
 * `npm install` 安装相关依赖
 * 开发和调试
   * 浏览器环境执行 `gulp dev`，会自动启动 `demo` 目录，可在 `test-es6.js` 中修改和测试，`test-es5.js` 为自动生成的代码
   * Nodejs 环境同样在 `demo` 目录中，通过执行 `node test-es6.js` 开发与调试。推荐安装 `node inspector` 来调试，安装后执行 `node-debug test-es6.js`。每次修改代码后，如果开发代码引用的是 dist 目录中的代码，需要执行 `gulp release`
-* 确保测试全部通过 `gulp test`，浏览器环境打开 `test/test.html`
+* 确保测试全部通过 `npm run test`，浏览器环境打开 `test/test.html`
 * 提交并发起 `Pull Request`
-* 执行 `gulp release` 会生成全部版本的 SDK
 
 项目的目录结构说明如下：
 
 ```
-├── README.md                          // 说明文档
-├── demo                               // demo 目录中有一些代码片段，主要用于开发与调试
-├── changelog.md
 ├── dist                               // 编译之后生成的文件将会在此目录下
 │   ├── av-es6.js                      // 合并后的完整源码（ES6 版本）
 │   ├── av.js                          // 合并并编译后的完整源码（ES5 版本）
 │   ├── av-min.js                      // 合并、压缩并编译后的源码（ES5 版本）
 │   ├── node                           // 目录中为生成的 nodejs 版本代码
 │   └── ...
-├── gulpfile.babel.js
 ├── src
-│   ├── av.js                          // node.js 环境入口文件
+│   ├── index.js                          // node.js 环境入口文件
 │   ├── browserify-wrapper             // 目录中为针对 node.js 与浏览器环境之间差异的不同实现
 │   └── ...
-├── package.json
-├── readme.txt
-├── test                               // 单元测试
-│   └── ...
-└── tools                              // 构建中依赖的第三方工具
+└── test                               // 单元测试
 ```
 
-## 官方新版本发布流程
+## 发布流程
 
-* 修改版本号
+0. 遵循 semver 提升版本号
   * src/version.js
   * package.json
   * bower.json
-* 修改 Changelog
-* 打包（执行 `gulp release`）
-* 提交当前所有代码
-  * 版本号相关修改
-  * 对照 commit 历史写 change log
-  * dist/ 目录中的新代码
-* 提交代码，发 Pull Request
-* 通过 review，merge 代码
-* Github 生成 release 包（for bower）
-* 发布到 npm，需 npm 协作者身份（执行 `npm publish`）
-* 发布到 CDN，需要七牛权限（执行 `gulp upload`）
-* 提醒所有相关工程师完善文档
-  * 需修改文档中 JS SDK 的 CDN 地址
-
+0. 对照 commit 历史写 changelog
+0. 提交当前所有改动
+0. 等待持续集成 pass
+0. 使用 GitHub 基于 dist 分支发布一个 release（for bower）
+0. Fetch and checkout remote `dist` branch 并确认该提交的内容是即将发布的版本
+0. npm publish（`npm publish`，需 npm 协作者身份），如果是 pre-release 版本需要带 next tag
+0. 发布到 CDN，需要七牛权限（执行 `gulp upload`）

bower.json

@@ -12,6 +12,7 @@
     "src",
     "test",
     "tools",
+    "script",
     "README.md",
     "changelog.md",
     "gulpfile.babel.js",

changelog.md

@@ -1,3 +1,81 @@
+# 2.0.0-beta.0 (2016-9-27)
+### Breaking Changes
+* 移除了所有 Backbone callbacks 回调风格的参数，请使用 Promise 处理异步操作的结果：
+
+  ```javascript
+  // Backbone callback 回调风格的参数的用法
+  object.save(null, {
+    success: function(object) {},
+    error: function(error, object) {},
+  });
+
+  // 需要替换为
+  object.save().then(
+    function(object) {},
+    function(error) {}
+  );
+  ```
+
+* `AV.Promise` 现在是一个满足 Promises/A+ 标准的实现，所有非标准的方法已被移除，所有非标准的行为已被修正。关于标准 Promise 的更多信息推荐阅读 [《JavaScript Promise 迷你书》](http://liubin.org/promises-book/)。
+
+* 如果你 extend 的 `AV.Object` 子类重写了 `validate` 方法，当属性无效时现在需要 throw 一个 Error（之前是 return 一个 Error）。相应的，`AV.Object#set` 方法如果 set 的值无效，需要通过 try catch 捕获异常（之前通过检查返回值是 false）。
+
+  ```javascript
+  // 之前的用法
+  var Student = AV.Object.extend('Student', {
+    validate: function(attibutes) {
+      if (attributes.age < 0) return new Error('negative age set');
+    }
+  });
+  var tom = new Student();
+  if (tom.set('age', -1) === false) {
+    console.error('something wrong');
+  } else {
+    tom.save();
+  }
+
+  // 现在的用法
+  var Student = AV.Object.extend('Student', {
+    validate: function(attibutes) {
+      if (attributes.age < 0) throw new Error('negative age set');
+    }
+  });
+  var tom = new Student();
+  try {
+    tom.set('age', -1);
+  } catch (error) {
+    console.error(error.message);
+  }
+  tom.save();
+  ```
+
+* `AV.User#_linkWith` 的第二个参数中的 `options.authData` 字段提升为第二个参数。
+
+  ```javascript
+  // 之前的用法
+  user._linkWith('weixin', {
+    authData: {
+      access_token: 'access_token'
+    },
+  });
+
+  // 现在的用法
+  user._linkWith('weixin', {
+    access_token: 'access_token'
+  });
+  ```
+
+* 移除了 deprecated 的 API，包括：
+  - `AV.Object#existed`
+  - `AV.User.requestEmailVerfiy` (typo)
+  - `AV.useAVCloudCN`
+  - `AV.useAVCloudUS`
+  - `AV._ajax`
+  - `AV._request`
+
+### Bug Fixes
+* 修复了应用内社交模块的方法在未登录状态下传入了 sessionToken 仍然抛未登录异常的问题
+
 ## 1.4.0 (2016-9-1)
 相比于 v1.4.0-beta.0:
 * 修复了 `AV.File#save` 方法的 `onprogress` 参数失效的问题