update

Author: axetroy

.travis.yml

@@ -1,7 +1,7 @@
 language: node_js
 sudo: false
 node_js:
-  - '6.6.0'
+  - '7.10.0'
 
 cache:
   yarn: true

README.md

@@ -1 +1,73 @@
-## TODO 
+## stone.js
+
+[![Build Status](https://travis-ci.org/axetroy/stone.svg?branch=master)](https://travis-ci.org/axetroy/stone)
+[![Dependency](https://david-dm.org/axetroy/stone.svg)](https://david-dm.org/axetroy/stone)
+![License](https://img.shields.io/badge/license-MIT-green.svg)
+[![Prettier](https://img.shields.io/badge/Code%20Style-Prettier-green.svg)](https://github.com/prettier/prettier)
+![Node](https://img.shields.io/badge/node-%3E=6.0-blue.svg?style=flat-square)
+[![npm version](https://badge.fury.io/js/stone.svg)](https://badge.fury.io/js/stone)
+ 
+build data stuck like a stone, Sturdy!
+ 
+## Usage
+
+```bash
+ npm install @axetroy/stone
+```
+ 
+```javascript
+import Stone from '@axetroy/stone';
+
+const userInfo = new Stone({username:'axetroy'});
+
+// back
+userInfo.username = 'admin'; // it will throw an error.
+
+// good
+userInfo.set('username', 'admin');  // this is ok.
+
+console.log(userInfo.username);   // print "admin"
+```
+
+## API
+
+### .set(key:string,value:any):this
+
+set a value.
+
+### .remove(key:string):this
+
+remove a key
+
+### .subscribe(func:Function):Function
+
+subscribe the stone change
+
+### .watch(key:string,func:Function):Function
+
+watch specify key change, base on ``.subscribe``
+
+### .keys():string[]
+
+return the keys list you set
+
+### .values():any[]
+
+return the values list you set
+
+- stringify():string
+
+convert to string, base on ``JSON.stringify()``
+
+## Contributing
+
+```bash
+git clone https://github.com/axetroy/stone.git
+cd ./stone
+yarn
+yarn run dev
+```
+
+## License
+
+The [MIT License](https://github.com/axetroy/stone/blob/master/LICENSE)

index.js

@@ -3,11 +3,17 @@ export default class Stone {
     this.subscriber = [];
     this.state = { ...{}, ...obj };
 
-    Object.defineProperty(this, 'state', { enumerable: false });
-    Object.defineProperty(this, 'subscriber', { enumerable: false });
+    Object.defineProperty(this, 'state', {
+      enumerable: false,
+      configurable: false
+    });
+    Object.defineProperty(this, 'subscriber', {
+      enumerable: false,
+      configurable: false
+    });
     Object.defineProperty(this, 'length', {
+      configurable: true,
       enumerable: false,
-      configurable: false,
       get() {
         return this.keys().length;
       }
@@ -28,7 +34,7 @@ export default class Stone {
     if (!Object.getOwnPropertyDescriptor(this, key)) {
       Object.defineProperty(this, key, {
         enumerable: true,
-        configurable: false,
+        configurable: true,
         get() {
           return this.state[key];
         },
@@ -54,8 +60,24 @@ export default class Stone {
   }
 
   subscribe(func) {
+    func.__id__ = Math.random().toFixed(5);
     this.subscriber.push(func);
-    return this;
+    return () => {
+      const index = this.subscriber.findIndex(handler => {
+        return handler.__id__ && handler.__id__ === func.__id__;
+      });
+      if (index >= 0) {
+        this.subscriber.splice(index, 1);
+      }
+    };
+  }
+
+  watch(key, callback) {
+    return this.subscribe((_key, oldValue, newValue) => {
+      if (key === _key) {
+        callback.call(this, oldValue, newValue);
+      }
+    });
   }
 
   // Object method
@@ -64,10 +86,20 @@ export default class Stone {
   }
 
   values() {
-    return Object.values(this.state);
+    let values = [];
+    for (let key in this.state) {
+      if (this.state.hasOwnProperty(key)) {
+        values.push(this.state[key]);
+      }
+    }
+    return values;
   }
 
   toString() {
     return this.state.toString();
   }
+
+  stringify() {
+    return JSON.stringify(this.state);
+  }
 }

test/unit/stone.test.js

@@ -25,9 +25,117 @@ test('basic', t => {
   });
 });
 
-test('set an prototype property', t => {
+test('set an prototype property, like length', t => {
   stone.set('length', 333); // can't cover the private property
   t.is(stone.length, 2);
   t.is(Object.keys(stone.state).length, 2);
   t.deepEqual(Object.keys(stone), ['username']);
 });
+
+test('.remove(), delete a property', t => {
+  stone.remove('username');
+  t.is(Object.keys(stone).length, 0);
+  t.deepEqual(stone.username, void 0);
+  t.pass();
+});
+
+test('.keys(), get the keys of stone', t => {
+  t.is(Object.keys(stone).length, 1);
+  stone.set('age', 18);
+  t.is(Object.keys(stone).length, 2);
+  t.pass();
+});
+
+test('.values(), get the values of stone', t => {
+  t.is(stone.values().length, 1);
+  t.deepEqual(stone.values(), ['axetroy']);
+  t.pass();
+});
+
+test('.stringify(), get the string of this stone', t => {
+  t.deepEqual(stone.stringify(), JSON.stringify({ username: 'axetroy' }));
+  t.pass();
+});
+
+test('.toString(), covert the object to string, cover native method', t => {
+  t.deepEqual(stone.toString(), '[object Object]');
+  t.pass();
+});
+
+test('.subscribe(), subscribe the stone change', t => {
+  stone.subscribe((key, oldValue, newValue) => {
+    t.deepEqual(key, 'age');
+    t.deepEqual(oldValue, void 0);
+    t.deepEqual(newValue, 18);
+  });
+  stone.set('age', 18);
+  t.pass();
+});
+
+test('.subscribe(), trigger the handler like expect', t => {
+  let invokeTimes = 0;
+  stone.subscribe((key, oldValue, newValue) => {
+    invokeTimes++;
+  });
+  t.deepEqual(invokeTimes, 0);
+  stone.set('age', 18);
+  t.deepEqual(invokeTimes, 1);
+  stone.set('username', 'hello world');
+  t.deepEqual(invokeTimes, 2);
+  t.pass();
+});
+
+test('.subscribe(), it should return a function the cancel subscribe', t => {
+  let invokeTimes = 0;
+  let cancelSubscribe = stone.subscribe((key, oldValue, newValue) => {
+    invokeTimes++;
+  });
+  t.deepEqual(invokeTimes, 0);
+  stone.set('age', 18);
+  t.deepEqual(invokeTimes, 1);
+  cancelSubscribe();
+  stone.set('age', 11);
+  stone.set('age', 12);
+  stone.set('age', 13);
+  stone.set('age', 14);
+  t.deepEqual(invokeTimes, 1); // will not call function again
+  t.pass();
+});
+
+test('.watch(key), watch specify key change, base on .subscribe()', t => {
+  let usernameWatcherCallTimes = 0;
+  const cancel = stone.watch('username', () => {
+    usernameWatcherCallTimes = usernameWatcherCallTimes + 1;
+  });
+  t.deepEqual(usernameWatcherCallTimes, 0);
+  stone.set('age', 18);
+  t.deepEqual(usernameWatcherCallTimes, 0);
+  stone.set('username', 'hello world');
+  t.deepEqual(usernameWatcherCallTimes, 1);
+
+  // cancel the watcher
+  cancel();
+
+  stone.set('username', 'a');
+  stone.set('username', 'b');
+  stone.set('username', 'c');
+  t.deepEqual(usernameWatcherCallTimes, 1);
+  t.deepEqual(stone.username, 'c');
+  t.pass();
+});
+
+test('.set(), set a property', t => {
+  stone.set('age', 18);
+  t.is(Object.keys(stone).length, 2);
+  t.deepEqual(stone.username, 'axetroy');
+  t.deepEqual(stone.age, 18);
+
+  // can't reset the value
+  t.throws(() => {
+    stone.age = 22; // it should throw an error
+  });
+
+  t.deepEqual(stone.age, 18);
+
+  t.pass();
+});