First complete feature set

Author: ankurk91

.babelrc

@@ -0,0 +1,35 @@
+{
+  "presets": [
+    [
+      "env",
+      {
+        "modules": false,
+        "targets": {
+          "browsers": [
+            "> 2%",
+            "last 2 versions",
+            "ie 11"
+          ],
+          "uglify": true
+        }
+      }
+    ]
+  ],
+  "plugins": [
+    "transform-object-assign"
+  ],
+  "env": {
+    "test": {
+      "presets": [
+        [
+          "env",
+          {
+            "targets": {
+              "node": "current"
+            }
+          }
+        ]
+      ]
+    }
+  }
+}

.gitignore

@@ -69,4 +69,5 @@ composer.phar
 *.tgz
 /docs/
 /dist/
+/coverage
 

.npmignore

@@ -0,0 +1,22 @@
+# Don't publish these files and folders
+/.idea/
+/.github/
+/examples/
+/docs/
+/test/
+/__test__/
+/coverage/
+
+.babelrc
+.editorconfig
+.gitattributes
+/.gitignore
+.npmignore
+.travis.yml
+
+npm-shrinkwrap.json
+package-lock.json
+yarn.lock
+
+webpack.config.dev.js
+webpack.config.js

.travis.yml

@@ -0,0 +1,36 @@
+# Config file for https://travis-ci.org/
+# Validate this file here - http://lint.travis-ci.org/
+
+language: node_js
+node_js:
+  - "6"
+
+# Speed up git clones
+git:
+  depth: 10
+  submodules: false
+
+# Install custom version
+before_install:
+  - curl -o- -L https://yarnpkg.com/install.sh | bash -s -- --version 1.3.2
+  - export PATH="$HOME/.yarn/bin:$PATH"
+
+install:
+  - yarn install --non-interactive
+
+script:
+  - yarn test -- --verbose
+  - yarn run build
+
+after_success:
+  - bash <(curl -s https://codecov.io/bash) -e TRAVIS_NODE_VERSION
+
+# Tell Travis CI to monitor only these branches
+branches:
+  only:
+  - master
+  - dev
+
+# $HOME/.cache/yarn
+cache:
+  yarn: true

LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Ankur Kumar
+
+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

@@ -0,0 +1,99 @@
+# Vue-web-storage
+
+[![vue-js](https://img.shields.io/badge/vue.js-2.x-brightgreen.svg?maxAge=604800)](https://vuejs.org/)
+[![downloads](https://img.shields.io/npm/dt/vue-web-storage.svg)](http://npm-stats.com/~packages/vue-web-storage)
+[![npm-version](https://img.shields.io/npm/v/vue-web-storage.svg)](https://www.npmjs.com/package/vue-web-storage)
+[![github-tag](https://img.shields.io/github/tag/ankurk91/vue-web-storage.svg?maxAge=1800)](https://github.com/ankurk91/vue-web-storage/)
+[![license](https://img.shields.io/github/license/ankurk91/vue-web-storage.svg?maxAge=1800)](https://yarnpkg.com/en/package/vue-web-storage)
+[![build-status](https://travis-ci.org/ankurk91/vue-web-storage.svg?branch=master)](https://travis-ci.org/ankurk91/vue-web-storage)
+[![codecov](https://codecov.io/gh/ankurk91/vue-web-storage/branch/master/graph/badge.svg)](https://codecov.io/gh/ankurk91/vue-web-storage)
+
+Vue.js v2.x plugin for web storage
+
+## Features
+* Choose between `localStorage` or `sessionStorage`
+* Prefix all of your stored keys
+* Auto `JSON.stringify` and `JSON.parse`
+
+## Installation
+```bash
+# npm
+npm install vue-web-storage --save
+
+# Yarn
+yarn add vue-web-storage
+```
+
+## Usage
+```js
+import Vue from 'vue';
+import Storage from 'vue-web-storage';  
+Vue.use(Storage);  
+```
+
+## Configuration
+```js
+Vue.use(Storage, {
+  prefix: 'your_app_name',// default `app_`
+  driver: 'session', // default 'local'
+})
+```
+
+### Methods
+#### `set(key,value)`
+```js
+Vue.$storage.set('name', 'john')
+Vue.$storage.set('isAdmin', true)
+Vue.$storage.set('roles', ['admin', 'sub-admin'])
+Vue.$storage.set('permission', {id: 2, slug: 'edit_post'})
+```
+#### `get(key)`
+```js
+Vue.$storage.get('name')
+```
+#### `remove(key)`
+```js
+Vue.$storage.remove('name')
+```
+#### `clear()`
+```js
+Vue.$storage.clear()
+```
+#### `keys(withPrefix)`
+```js
+Vue.$storage.keys()
+```
+#### `hasKey(key)`
+```js
+Vue.$storage.hasKey('name')
+```
+#### `length()`
+```js
+Vue.$storage.length()
+```
+
+## Install in non-module environments (without webpack)
+* Include required files
+```html
+<!-- Vue js -->
+<script src="https://unpkg.com/vue@2.5/dist/vue.min.js"></script>
+<!-- Lastly add this package -->
+<script src="https://unpkg.com/vue-web-storage"></script>
+```
+* Initialize
+```js
+Vue.use(VueWebStorage)
+```
+
+## Testing
+* This package is using [Jest](https://github.com/facebook/jest) for testing
+* Tests can be found in `__test__` folder.
+* Execute tests with this command `yarn test`
+
+## Resources
+* [Web Storage API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Storage_API)
+* [Browser support status](https://caniuse.com/#feat=namevalue-storage), [Chrome](https://www.chromestatus.com/feature/5345825534246912), [Edge](https://developer.microsoft.com/en-us/microsoft-edge/platform/status/webstorage/)
+* [Web Storage Quota](https://www.html5rocks.com/en/tutorials/offline/quota-research/)
+
+## License
+[MIT](LICENSE.txt) License

__test__/storage.test.js

@@ -0,0 +1,112 @@
+import Storage from '../src/storage';
+
+describe('Storage class', () => {
+
+  let ls;
+
+  beforeEach(() => {
+    ls = new Storage({
+      prefix: 'app_',
+      driver: 'local'
+    });
+  });
+
+  afterEach(() => {
+    ls.clear();
+  });
+
+  test('accepts prefix', () => {
+    expect(ls.prefix).toBe('app_');
+  });
+
+  test('can store strings', () => {
+    let key = 'name';
+    let value = 'john';
+
+    ls.set(key, value);
+    expect(ls.get(key)).toBe(value)
+  });
+
+  test('can store boolean', () => {
+    let key = 'flag';
+    let value = true;
+
+    ls.set(key, value);
+    expect(ls.get(key)).toBe(value)
+  });
+
+  test('can store objects', () => {
+    let key = 'cat';
+    let value = {id: 12, name: 'kitten'};
+
+    ls.set(key, value);
+    expect(ls.get(key)).toEqual(value)
+  });
+
+
+  test('can store arrays', () => {
+    let key = 'ids';
+    let value = [123, 456, 789];
+
+    ls.set(key, value);
+    expect(ls.get(key)).toEqual(value)
+  });
+
+  test('can store array of objects', () => {
+    let key = 'cats';
+    let value = [{id: 1, name: 'kitten'}, {id: 2, name: 'mum'}];
+
+    ls.set(key, value);
+    expect(ls.get(key)).toEqual(value)
+  });
+
+  test('can store null', () => {
+    let key = 'nullable';
+    let value = null;
+
+    ls.set(key, value);
+    expect(ls.get(key)).toBe(value)
+  });
+
+  test('can store numbers', () => {
+    let key = 'age';
+    let value = 26;
+
+    ls.set(key, value);
+    expect(ls.get(key)).toBe(value)
+  });
+
+  test('can remove stored key', () => {
+    let key = 'age';
+    let value = 26;
+
+    ls.set(key, value);
+    ls.remove(key);
+    expect(ls.get(key)).toBe(null)
+  });
+
+  test('can empty storage', () => {
+    ls.set('name', 'jest');
+    ls.set('age', 26);
+    ls.clear();
+
+    expect(ls.get('age')).toBe(null);
+    expect(ls.get('name')).toBe(null);
+    expect(ls.length()).toEqual(0)
+  });
+
+  test('can get stored key names', () => {
+    ls.set('name', 'jest');
+    ls.set('age', 26);
+
+    expect(ls.keys()).toEqual(['name', 'age'])
+  });
+
+  test('can check if key exits', () => {
+    ls.set('name', 'jest');
+
+    expect(ls.hasKey('name')).toBe(true);
+    expect(ls.hasKey('unknown')).toBe(false)
+  });
+
+});

__test__/vue-storage.test.js

@@ -0,0 +1,30 @@
+import {Storage, Plugin as VueWebStorage} from '../src/index';
+// Lets import full build
+import Vue from 'vue/dist/vue.common';
+
+Vue.config.productionTip = false;
+
+describe('Vue Storage plugin', () => {
+
+
+  test('Vue.$storage', () => {
+    Vue.use(VueWebStorage);
+
+    expect(Vue.$storage instanceof Storage).toBe(true);
+  });
+
+  test('localVue.$storage', () => {
+    let localVue = Vue.extend();
+    localVue.use(VueWebStorage);
+
+    expect(localVue.$storage instanceof Storage).toBe(true);
+  });
+
+  test('parameters', () => {
+    let localVue = Vue.extend();
+    localVue.use(VueWebStorage, {prefix: 'vue_'});
+
+    expect(localVue.$storage.prefix).toEqual('vue_');
+  });
+
+});