Alorel / ngforage / 421

pending completion

Build # 421

Build Type

push

travis-ci

Committed by

Alorel

Commit Message

<a href="https://github.com/Alorel/ngforage/commit/<a class=hub.com/Alorel/ngforage/commit/<a class="double-link" href="https://git"><a class=hub.com/Alorel/ngforage/commit/<a class="double-link" href="https://git"><a class=hub.com/Alorel/ngforage/commit/<a class="double-link" href="https://git"><a class=hub.com/Alorel/ngforage/commit/<a class="double-link" href="https://git"><a class=hub.com/Alorel/ngforage/commit/74da1022f22b11d4512e1b3f84b2d9632c15478d">74da1022f<a href="https://github.com/Alorel/ngforage/commit/74da1022f22b11d4512e1b3f84b2d9632c15478d">&lt;a href=&quot;https://github.com/Alorel/ngforage/commit/74da1022f22b11d4512e1b3f84b2d9632c15478d">&lt;a href=&quot;https://github.com/Alorel/ngforage/commit/74da1022f22b11d4512e1b3f84b2d9632c15478d&quot;&gt;&amp;lt;a href=&amp;quot;https://github.com/Alorel/ngforage/commit/74da1022f22b11d4512e1b3f84b2d9632c15478d&amp;quot;&amp;gt;&amp;amp;lt;a href=&amp;amp;quot;https://github.com/Alorel/ngforage/commit/74da1022f22b11d4512e1b3f84b2d9632c15478d&amp;amp;quot;&amp;amp;gt;&amp;amp;amp;quot;&amp;amp;gt;Squashed commit of the following:

commit &amp;amp;lt;/a&amp;amp;gt;&amp;amp;lt;a class=&amp;amp;quot;double-link&amp;amp;quot; href=&amp;amp;quot;https://github.com/Alorel/ngforage/commit/&amp;amp;lt;a class=&amp;amp;quot;double-link&amp;amp;quot; href=&amp;amp;quot;https://github.com/Alorel/ngforage/commit/323b1daf2ca06977713d300455db98fec98745f1&amp;amp;quot;&amp;amp;gt;323b1daf2&amp;amp;lt;/a&amp;amp;gt;&amp;amp;quot;&amp;amp;gt;323b1daf2&amp;amp;lt;/a&amp;amp;gt;&amp;lt;a href=&amp;quot;https://github.com/Alorel/ngforage/commit/74da1022f22b11d4512e1b3f84b2d9632c15478d&amp;quot;&amp;gt;
Author: Arturas Molcanovas &amp;amp;lt;a.molcanovas@gmail.com&amp;amp;gt;
Date:   Tue Apr 3 21:24:40 2018 +0100

    fix package descriptions

commit &amp;lt;/a&amp;gt;&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://github.com/Alorel/ngforage/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://github.com/Alorel/ngforage/commit/8433b0cbbdea342dcb4a3450cdcb5a5a1eaded6b&amp;quot;&amp;gt;8433b0cbb&amp;lt;/a&amp;gt;&amp;quot;&amp;gt;8433b0cbb&lt;/a&gt;&lt;a href=&quot;https://github.com/Alorel/ngforage/commit/74da1022f22b11d4512e1b3f84b2d9632c15478d&quot;&gt;
Author: Arturas Molcanovas &amp;lt;a.molcanovas@gmail.com&amp;gt;
Date:   Tue Apr 3 21:20:56 2018 +0100

    ng6 packaging

commit &lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/Alorel/ngforage/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/Alorel/ngforage/commit/b4d3f42c7be5c81e062311311db8b10c6850900f&quot;&gt;b4d3f42c7&lt;/a&gt;&quot;&gt;b4d3f42c7&lt;/a&gt;&lt;a href=&quot;https://github.com/Alorel/ngforage/commit/74da1022f22b11d4512e1b3f84b2d9632c15478d&quot;&gt;
Merge: 28c8ee2 636df7c
Author: Arturas Molcanovas &lt;a.molcanovas@gmail.com&gt;
Date:   Tue Apr 3 21:03:10 2018 +0100

    Merge branch &#39;ng5&#39; into angular-6

commit </a><a class="double-link" href="https://github.com/Alorel/ngforage/commit/<a class="double-link" href="https://github.com/Alorel/ngforage/commit/636df7c8eeb44b5d404330bb0f9980bf9c6e5a56">636df7c8e</a>">636df7c8e</a><a href="https://github.com/Alorel/ngforage/commit/74da1022f22b11d4512e1b3f84b2d9632c15478d">
Author: Arturas Molcanovas &lt;a.molcanovas@gmail.com&gt;
Date:   Tue Apr 3 21:02:36 2018 +0100

    add 1.0.4 to changelog

    (cherry picked from commit 28c8ee2)

commit </a><a class="double-link" href="https://github.com/Alorel/ngforage/commit/28c8ee219">28c8ee219
Author: Arturas Molcanovas <a.molcanovas@gmail.com>
Date:   Tue Apr 3 21:02:36 2018 +0100

    add 1.0.4 to changelog

c... (continued)

Run Details

52 of 53 branches covered (98.11%)

Branch coverage included in aggregate %.

233 of 234 relevant lines covered (99.57%)

37.59 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

100.0

/src/NgForage/config/NgForageConfig.service.ts

import {FactoryProvider, Injectable} from '@angular/core';
import 'localforage';
import {localForage as lf} from '../imports/localforage';
import {_driver} from '../session-storage';
import {addToStringTag} from '../util/addToStringTag';
import {BaseConfigurable} from './BaseConfigurable';
import {CacheConfigurable} from './CacheConfigurable';
import {NgForageOptions} from './NgForageOptions';

/** @internal */
let instance: NgForageConfig;

/** @internal */
const defaultConfig: NgForageOptions = {
  cacheTime: 300000,
  description: '',
  driver: [lf.INDEXEDDB, lf.WEBSQL, lf.LOCALSTORAGE],
  name: 'ngForage',
  size: 4980736,
  storeName: 'ng_forage',
  version: 1
};

/**
 * Global/default configuration
 */
@Injectable()
export class NgForageConfig implements BaseConfigurable, CacheConfigurable {

  /** The IndexedDB driver */
  public static readonly DRIVER_INDEXEDDB: string = lf.INDEXEDDB;
  /** The localStorage driver */
  public static readonly DRIVER_LOCALSTORAGE: string = lf.LOCALSTORAGE;
  /** The sessionStorage driver */
  public static readonly DRIVER_SESSIONSTORAGE: string = _driver;
  /** The WebSQL driver */
  public static readonly DRIVER_WEBSQL: string = lf.WEBSQL;
  /** @internal */
  public static readonly provider: FactoryProvider = {
    provide: NgForageConfig,
    useFactory: NgForageConfig.factory
  };

  /**
   * Cache time in milliseconds
   * @default 300000
   */
  public get cacheTime(): number {
    return defaultConfig.cacheTime;
  }

  public set cacheTime(t: number) {
    defaultConfig.cacheTime = t;
  }

  /**
   * Get the compiled configuration
   */
  public get config(): NgForageOptions {
    return {
      cacheTime: this.cacheTime,
      description: this.description,
      driver: this.driver,
      name: this.name,
      size: this.size,
      storeName: this.storeName,
      version: this.version
    };
  }

  /**
   * A description of the database, essentially for developer usage.
   * @default
   */
  public get description(): string {
    return defaultConfig.description;
  }

  public set description(v: string) {
    defaultConfig.description = v;
  }

  /**
   * The preferred driver(s) to use.
   * @see {@link NgForageConfig#DRIVER_INDEXEDDB}
   * @see {@link NgForageConfig#DRIVER_WEBSQL}
   * @see {@link NgForageConfig#DRIVER_LOCALSTORAGE}
   * @see {@link NgForageConfig#DRIVER_SESSIONSTORAGE}
   */
  public get driver(): string | string[] {
    if (typeof defaultConfig.driver === 'string') {
      return defaultConfig.driver;
    }

    return defaultConfig.driver.slice();
  }

  public set driver(v: string | string[]) {
    defaultConfig.driver = v;
  }

  /**
   * The name of the database. May appear during storage limit prompts. Useful to use the name of your app here.
   * In localStorage, this is used as a key prefix for all keys stored in localStorage.
   * @default ngForage
   */
  public get name(): string {
    return defaultConfig.name;
  }

  public set name(v: string) {
    defaultConfig.name = v;
  }

  /**
   * The size of the database in bytes. Used only in WebSQL for now.
   * @default 4980736
   */
  public get size(): number {
    return defaultConfig.size;
  }

  public set size(v: number) {
    defaultConfig.size = v;
  }

  /**
   * The name of the datastore.
   * In IndexedDB this is the dataStore,
   * in WebSQL this is the name of the key/value table in the database.
   * Must be alphanumeric, with underscores.
   * Any non-alphanumeric characters will be converted to underscores.
   * @default ng_forage
   */
  public get storeName(): string {
    return defaultConfig.storeName;
  }

  public set storeName(v: string) {
    defaultConfig.storeName = v;
  }

  /**
   * The version of your database. May be used for upgrades in the future; currently unused.
   * @default 1.0
   */
  public get version(): number {
    return defaultConfig.version;
  }

  public set version(v: number) {
    defaultConfig.version = v;
  }

  public static factory(): NgForageConfig {
    if (!instance) {
      instance = new NgForageConfig();
    }

    return instance;
  }

  /**
   * Bulk-set configuration options
   * @param opts The configuration
   */
  public configure(opts: NgForageOptions): this {
    opts = opts || {};

    if ('driver' in opts && opts.driver.slice) {
      opts.driver = opts.driver.slice();
    }

    Object.assign(defaultConfig, opts);

    return this;
  }

  /**
   * Define a driver
   *
   * You’ll want to make sure you accept a callback argument and that you pass the same arguments to callbacks as the
   * default drivers do. You’ll also want to resolve or reject promises.
   * Check any of the {@link https://github.com/mozilla/localForage/tree/master/src/drivers default drivers}
   * for an idea of how to implement your own, custom driver.
   * @param spec Driver spec
   */
  public defineDriver(spec: LocalForageDriver): Promise<void> {
    return lf.defineDriver(spec);
  }

  /** @internal */
  public toJSON(): NgForageOptions {
    return this.config;
  }
}

Object.freeze(NgForageConfig.provider);
addToStringTag(NgForageConfig, 'NgForageConfig');

1	import {FactoryProvider, Injectable} from '@angular/core';	2✔
2	import 'localforage';	2✔
3	import {localForage as lf} from '../imports/localforage';	2✔
4	import {_driver} from '../session-storage';	2✔
5	import {addToStringTag} from '../util/addToStringTag';	2✔
6	import {BaseConfigurable} from './BaseConfigurable';
7	import {CacheConfigurable} from './CacheConfigurable';
8	import {NgForageOptions} from './NgForageOptions';
9
10	/** @internal */
11	let instance: NgForageConfig;
12
13	/** @internal */
14	const defaultConfig: NgForageOptions = {	2✔
15	cacheTime: 300000,
16	description: '',
17	driver: [lf.INDEXEDDB, lf.WEBSQL, lf.LOCALSTORAGE],
18	name: 'ngForage',
19	size: 4980736,
20	storeName: 'ng_forage',
21	version: 1
22	};
23
24	/**
25	* Global/default configuration
26	*/
27	@Injectable()
28	export class NgForageConfig implements BaseConfigurable, CacheConfigurable {	2✔
29
30	/** The IndexedDB driver */
31	public static readonly DRIVER_INDEXEDDB: string = lf.INDEXEDDB;	2✔
32	/** The localStorage driver */
33	public static readonly DRIVER_LOCALSTORAGE: string = lf.LOCALSTORAGE;	2✔
34	/** The sessionStorage driver */
35	public static readonly DRIVER_SESSIONSTORAGE: string = _driver;	2✔
36	/** The WebSQL driver */
37	public static readonly DRIVER_WEBSQL: string = lf.WEBSQL;	2✔
38	/** @internal */
39	public static readonly provider: FactoryProvider = {	2✔
40	provide: NgForageConfig,
41	useFactory: NgForageConfig.factory
42	};
43
44	/**
45	* Cache time in milliseconds
46	* @default 300000
47	*/
48	public get cacheTime(): number {	2✔
49	return defaultConfig.cacheTime;	420✔
50	}
51
52	public set cacheTime(t: number) {
53	defaultConfig.cacheTime = t;	6✔
54	}
55
56	/**
57	* Get the compiled configuration
58	*/
59	public get config(): NgForageOptions {	2✔
60	return {	408✔
61	cacheTime: this.cacheTime,
62	description: this.description,
63	driver: this.driver,
64	name: this.name,
65	size: this.size,
66	storeName: this.storeName,
67	version: this.version
68	};
69	}
70
71	/**
72	* A description of the database, essentially for developer usage.
73	* @default
74	*/
75	public get description(): string {	2✔
76	return defaultConfig.description;	442✔
77	}
78
79	public set description(v: string) {
80	defaultConfig.description = v;	12✔
81	}
82
83	/**
84	* The preferred driver(s) to use.
85	* @see {@link NgForageConfig#DRIVER_INDEXEDDB}
86	* @see {@link NgForageConfig#DRIVER_WEBSQL}
87	* @see {@link NgForageConfig#DRIVER_LOCALSTORAGE}
88	* @see {@link NgForageConfig#DRIVER_SESSIONSTORAGE}
89	*/
90	public get driver(): string \| string[] {	2✔
91	if (typeof defaultConfig.driver === 'string') {	440✔
92	return defaultConfig.driver;	18✔
93	}
94
95	return defaultConfig.driver.slice();	422✔
96	}
97
98	public set driver(v: string \| string[]) {
99	defaultConfig.driver = v;	12✔
100	}
101
102	/**
103	* The name of the database. May appear during storage limit prompts. Useful to use the name of your app here.
104	* In localStorage, this is used as a key prefix for all keys stored in localStorage.
105	* @default ngForage
106	*/
107	public get name(): string {	2✔
108	return defaultConfig.name;	442✔
109	}
110
111	public set name(v: string) {
112	defaultConfig.name = v;	12✔
113	}
114
115	/**
116	* The size of the database in bytes. Used only in WebSQL for now.
117	* @default 4980736
118	*/
119	public get size(): number {	2✔
120	return defaultConfig.size;	442✔
121	}
122
123	public set size(v: number) {
124	defaultConfig.size = v;	12✔
125	}
126
127	/**
128	* The name of the datastore.
129	* In IndexedDB this is the dataStore,
130	* in WebSQL this is the name of the key/value table in the database.
131	* Must be alphanumeric, with underscores.
132	* Any non-alphanumeric characters will be converted to underscores.
133	* @default ng_forage
134	*/
135	public get storeName(): string {	2✔
136	return defaultConfig.storeName;	442✔
137	}
138
139	public set storeName(v: string) {
140	defaultConfig.storeName = v;	12✔
141	}
142
143	/**
144	* The version of your database. May be used for upgrades in the future; currently unused.
145	* @default 1.0
146	*/
147	public get version(): number {	2✔
148	return defaultConfig.version;	442✔
149	}
150
151	public set version(v: number) {
152	defaultConfig.version = v;	12✔
153	}
154
155	public static factory(): NgForageConfig {	2✔
156	if (!instance) {	228✔
157	instance = new NgForageConfig();	2✔
158	}
159
160	return instance;	228✔
161	}
162
163	/**
164	* Bulk-set configuration options
165	* @param opts The configuration
166	*/
167	public configure(opts: NgForageOptions): this {	2✔
168	opts = opts \|\| {};	200✔
169
170	if ('driver' in opts && opts.driver.slice) {	200✔
171	opts.driver = opts.driver.slice();	162✔
172	}
173
174	Object.assign(defaultConfig, opts);	200✔
175
176	return this;	200✔
177	}
178
179	/**
180	* Define a driver
181	*
182	* You’ll want to make sure you accept a callback argument and that you pass the same arguments to callbacks as the
183	* default drivers do. You’ll also want to resolve or reject promises.
184	* Check any of the {@link https://github.com/mozilla/localForage/tree/master/src/drivers default drivers}
185	* for an idea of how to implement your own, custom driver.
186	* @param spec Driver spec
187	*/
188	public defineDriver(spec: LocalForageDriver): Promise<void> {	2✔
189	return lf.defineDriver(spec);	2✔
190	}
191
192	/** @internal */
193	public toJSON(): NgForageOptions {	2✔
194	return this.config;	2✔
195	}
196	}	2✔
197
198	Object.freeze(NgForageConfig.provider);	2✔
199	addToStringTag(NgForageConfig, 'NgForageConfig');	2✔

Alorel / ngforage / 421

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous