Boostnote/browser/lib/Repository.js at be2897806abf21562feef22a6f386c83aaa3e136 · csseditor/Boostnote · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
const keygen = require('browser/lib/keygen')
const fs = require('fs')
const path = require('path')
const CSON = require('season')
const _ = require('lodash')
const consts = require('browser/lib/consts')

let repositories = []

/**
 * # Repository
 *
 * ## Life cycle
 *
 * ```js
 * // Add reposiotry
 * var repo = new Repository({name: 'test', path: '/Users/somebody/test'})
 * repo
 *   .mount()
 *   .then(() => repo.load())
 *
 * // Update Cached
 * repo.saveCache({name: 'renamed'})
 *
 * // Update JSON
 * repo.saveJSON({author: 'Other user'})
 *
 * // Remove repository
 * repo.unmount()
 * ```
 *
 * ## `this.cached`
 *
 * Information of a Repository. It stores in `repoStats` key of localStorage
 *
 * ```js
 * this.cached = {
 *   "key":"523280a789404d430ce571ab9148fdd1343336cb",
 *   "name":"test",
 *   "path":"/Users/dickchoi/test"
 * }
 * ```
 *
 * ## `this.json`
 *
 * Parsed object from `boostrepo.json`. See `boostrepo.json`.
 *
 * ## Repository file structure
 *
 * The root directory of a Repository. It has several files and folders.
 *
 * ```
 * root
 *  |- data
 *      |-note1.cson
 *      |-note2.cson
 *      |-note3.cson
 *  |- boostrepo.json
 * ```
 *
 * #### `boostrepo.json`
 *
 * ```js
 * {
 *   name: String,
 *   author: String, // Same convention of package.json, `John Doe <email@example.com> (http://example.com)`
 *   remotes: [{
 *     name: String,
 *     url: String, // url of git remote
 *     branch: String // if branch isn't set, it will try to use `master` branch.
 *   }],
 *   folders: [{
 *     key: String // Unique sha1 hash key to identify folder,
 *     name: String,
 *     color: String // All CSS color formats available.
 *   }]
 * }
 * ```
 *
 * #### `data` directory
 *
 * Every note will be saved here as a single CSON file to `git diff` efficiently.
 * > This is because CSON supports
8000
 Multiline string.
 * File name of each cson file will be used to identify note.
 * Commonly, Boostnote will automatically generate sha1 key and use it as a file name when creating a new note.
 *
 * ##### `note.cson`
 *
 * ```cson
 * name: String
 * tags: [String] // tags
 * folder: String // hash key of folder
 * mode: String // syntax mode
 * title: String
 * content: String
 * createdAt: Date
 * updatedAt: Date
 * ```
 *
 * ### Full data
 *
 * Full data of a Repository. It includes not only information also all data(notes). Redux will directly handle this data.
 *
 * ```js
 * var repo = Object.assign({}, repoJSON, notesData, cached, {status: 'READY'})
 *
 * // repo
 * {
 *   {...repoJSON}
 *   "key": "523280a789404d430ce571ab9148fdd1343336cb",
 *   "name": "test",
 *   "path": "/Users/dickchoi/test",
 *   "notes": [], // See `note.cson`
 *   "status": "READY" // If Boostnote failed to fetch data, It will be set `ERROR`
 * }
 * ```
 */

class Repository {
  constructor (cached) {
    this.cached = _.pick(cached, ['key', 'name', 'path'])
    this.status = 'IDLE'
    this.isMount = false
  }

  /**
   * Reload and set all data of a repository
   * @return {Promise} full data of a repository
   */
  load () {
    if (!_.isString(this.cached.key)) {
      console.warn('The key of this repository doesn\'t seem to be valid. You should input this data to Redux reducer after setting the key properly.')
    }
    let name = this.cached.name
    let targetPath = this.cached.path

    targetPath = path.join(targetPath)
    let dataPath = path.join(targetPath, 'data')

    let initializeRepository = () => {
      let resolveDataDirectory = this.constructor.resolveDirectory(path.join(targetPath, 'data'))
      let resolveBoostrepoJSON = this.constructor.resolveJSON(path.join(targetPath, 'boostrepo.json'), {name: name})
      return Promise.all([resolveDataDirectory, resolveBoostrepoJSON])
        .then((data) => {
          this.json = data[1]
          return true
        })
    }

    let fetchNotes = () => {
      let noteNames = fs.readdirSync(dataPath)
      let notes = noteNames
        .map((noteName) => {
          let notePath = path.join(dataPath, noteNames)

          return new Promise(function (resolve, reject) {
            CSON.readFile(notePath, function (err, obj) {
              if (err != null) {
                console.log(err)
                return resolve(null)
              }
              obj.key = path.basename(noteName, '.cson')
              return resolve(obj)
            })
          })
        })
        .filter((note) => note != null)

      return Promise.all(notes)
        .then((notes) => {
          this.notes = notes
          return true
        })
    }

    return this.constructor.resolveDirectory(targetPath)
      .then(initializeRepository)
      .then(fetchNotes)
      .then(() => {
        this.status = 'READY'

        return this.getData()
      })
      .catch((err) => {
        this.status = 'ERROR'
        this.error = err
        console.error(err)
        return this
      })
  }

  /**
   * Add repository to localStorage
   * If key doesn't exist, it will generate it.
   * If a cache having same key extists in localStorage, override it.
   *
   * @return {Promise} added cache data
   */
  mount () {
    let allCached = this.constructor.getAllCached()

    // If key is not set, generate new one.
    if (!_.isString(this.cached.key)) {
      this.cached.key = keygen()
      // Repeat utill generated key becomes unique.
      while (_.findIndex(allCached, {key: this.cached.key}) > -1) {
        this.cached.key = keygen()
      }
    }

    let targetCachedIndex = _.findIndex(allCached, {key: this.cached.key})
    if (targetCachedIndex > -1) {
      allCached.splice(targetCachedIndex, 1, this.cached)
    } else {
      allCached.push(this.cached)
    }
    this.constructor.saveAllCached(allCached)
    this.isMount = true

    // Put in `repositories` array if it isn't in.
    let targetIndex = _.findIndex(repositories, {cached: {key: this.cached.key}})
    if (targetIndex < 0) {
      repositories.push(this)
    }

    return Promise.resolve(this.cached)
  }

  /**
   * Remove repository from localStorage
   * @return {Promise} remoded cache data
   */
  unmount () {
    let allCached = this.constructor.getAllCached()

    let targetCachedIndex = _.findIndex(allCached, {key: this.cached.key})
    if (targetCachedIndex > -1) {
      allCached.splice(targetCachedIndex, 1)
    }
    this.constructor.saveAllCached(allCached)
    this.isMount = false

    // Discard from `repositories` array if it is in.
    let targetIndex = _.findIndex(repositories, {cached: {key: this.cached.key}})
    if (targetIndex > -1) {
      repositories.splice(targetIndex, 1)
    }

    return Promise.resolve(this.cached)
  }

  /**
   * Get all data of a repository
   *
   * If data is not ready, try to load it.
   *
   * @return {Promise} all data of a repository
   */
  getData () {
    function carbonCopy (obj) {
      return JSON.parse(JSON.stringify(obj))
    }
    if (this.status === 'IDLE') {
      return this.load()
    }

    if (this.status === 'ERROR') {
      return Promise.resolve(carbonCopy(Object.assign({}, this.json, this.cached, {
        status: this.status
      })))
    }

    return Promise.resolve(carbonCopy(Object.assign({}, this.json, this.cached, {
      status: this.status,
      notes: this.notes
    })))
  }

  /**
   * Save Cached
   * @param  {Object} newCached
   * @return {Promies} updated Cached
   */
  saveCached (newCached) {
    if (_.isObject(newCached)) {
      Object.assign(this.cached, _.pick(newCached, ['name', 'path']))
    }

    if (this.isMount) {
      this.mount()
    }

    return Promise.resolve(this.cached)
  }

  /**
   * Save JSON
   * @param  {Object}  newJSON
   * @return {Promise} updated JSON
   */
  saveJSON (newJSON) {
    let jsonPath = path.join(this.cached.path, 'boostrepo.json')
    if (_.isObject(newJSON)) {
      Object.assign(this.json, newJSON)
    }

    return new Promise((resolve, reject) => {
      CSON
        .writeFile(jsonPath, this.json, (err) => {
          if (err != null) return reject(err)
          resolve(this.json)
        })
    })
  }

  /**
   * Save both Cached and JSON
   * @return {Promise} resolve array have cached and JSON
   */
  save () {
    return Promise.all([this.saveCached(), this.saveJSON()])
  }

  /**
   * Add a folder
   * @param {Object} newFolder
   * @return {Promise} new folder
   */
  addFolder (newFolder) {
    let { folders } = this.json

    newFolder = _.pick(newFolder, ['color', 'name'])
    if (!_.isString(newFolder.name) || newFolder.name.trim().length === 0) newFolder.name = 'unnamed'
    else newFolder.name = newFolder.name.trim()

    if (!_.isString(newFolder.color)) newFolder.color = this.constructor.randomColor()

    newFolder.key = keygen()
    while (_.findIndex(folders, {key: newFolder.key}) > -1) {
      newFolder.key = keygen()
    }

    folders.push(newFolder)

    return this.saveJSON(this.json)
      .then(() => newFolder)
  }

  /**
   * Update a folder
   * @param  {String} folderKey [description]
   * @param  {Object} override   [description]
   * @return {[type]}           [description]
   */
  updateFolder (folderKey, override) {
    let { folders } = this.json

    let targetFolder = _.find(folders, {key: folderKey})
    if (targetFolder == null) {
      return this.addFolder(override)
    }
    if (_.isString(override.name) && override.name.trim().length > 0) targetFolder.name = override.name.trim()
    if (_.isString(override.color)) targetFolder.color = override.color

    return this.saveJSON(this.json)
      .then(() => targetFolder)
  }

  /**
   * Remove a folder
   * @param  {String} folderKey
   * @return {Promise} removed folder
   */
  removeFolder (folderKey) {
    let { folders } = this.json
    let targetFolder = null

    let targetIndex = _.findIndex(folders, {key: folderKey})
    if (targetIndex > -1) {
      targetFolder = folders.splice(targetIndex, 1)[0]
    }

    return this.saveJSON(null)
      .then(() => targetFolder)
  }

  addNote (newNote) {
    newNote = Object.assign({}, _.pick(newNote, ['content', 'tags', 'folder', 'mode', 'title']))

    if (!this.constructor.validateNote(newNote)) {
      return Promise.reject(new Error('Invalid input'))
    }

    newNote.key = keygen()
    while (_.find(this.notes, {key: newNote.key}) != null) {
      newNote.key = keygen()
    }
    newNote.createdAt = new Date()
    newNote.updatedAt = new Date()
    this.notes.push(newNote)

    return new Promise((resolve, reject) => {
      CSON.writeFile(path.join(this.cached.path, 'data', newNote.key + '.cson'), _.omit(newNote, ['key']), function (err) {
        if (err != null) return reject(err)
        resolve(newNote)
      })
    })
  }

  static validateNote (note) {
    if (!_.isString(note.title)) return false
    if (!_.isString(note.content)) return false
    if (!_.isArray(note.tags)) return false
    if (!note.tags.every((tag) => _.isString(tag))) return false
    if (!_.isString(note.folder)) return false
    if (!_.isString(note.mode)) return false
    return true
  }

  getNote (noteKey) {
    let note = _.find(this.notes, {key: noteKey})

    return Promise.resolve(note)
  }

  updateNote (noteKey, override) {
    let note = _.find(this.notes, {key: noteKey})
    let isNew = false
    if (note == null) {
      note = override
      isNew = true
    }

    if (!this.constructor.validateNote(note)) {
      return Promise.reject(new Error('Invalid input'))
    }

    if (isNew) this.notes.push(note)
    note.updatedAt = new Date()

    return new Promise((resolve, reject) => {
      CSON.writeFile(path.join(this.cached.path, 'data', note.key + '.cson'), _.omit(note, ['key']), function (err) {
        if (err != null) return reject(err)
        resolve(note)
      })
    })
  }

  removeNote (noteKey) {
    let noteIndex = _.findIndex(this.notes, {key: noteKey})

    if (noteIndex < 0) return Promise.resolve(null)

    let note = this.notes[noteIndex]
    this.notes.splice(noteIndex, 1)

    return new Promise((resolve, reject) => {
      fs.unlink(path.join(this.cached.path, 'data', noteKey + '.cson'), function (err) {
        if (err != null) return reject(err)
        resolve(note)
      })
    })
  }

  getAllNotes () {
    return Promise.resolve(this.notes)
  }

  /**
   * Static Methods
   */

  static generateDefaultJSON (override) {
    return Object.assign({
      name: 'unnamed',
      remotes: [],
      folders: [{
        key: keygen(),
        name: 'general',
        color: this.randomColor()
      }]
    }, override)
  }

  /**
   * # Resolve Repository JSON
   *
   * Fetch and parse JSON from given path.
   * If boostrepo.json doesn't exist, create new one.
   *
   * @param  {String} targetPath [description]
   * @param  {Object} defaultOverrides Overrided to default value of RepoJSON when creating new one.
   * @return {Promise} resolving parsed data
   */
  static resolveJSON (targetPath, defaultOverrides) {
    return (new Promise((resolve, reject) => {
      let writeNew = () => {
        let newRepoJSON = this.generateDefaultJSON(defaultOverrides)
        CSON.writeFile(targetPath, newRepoJSON, (err) => {
          if (err != null) return reject(err)
          resolve(newRepoJSON)
        })
      }
      // If JSON doesn't exist, make a new one.
      if (CSON.resolve(targetPath) == null) {
        writeNew()
      } else {
        CSON.readFile(targetPath, (err, obj) => {
          if (err != null) return reject(err)
          if (obj == null) {
            writeNew()
          } else {
            resolve(obj)
          }
        })
      }
    }))
  }

  /**
   * # Resolve directory.
   *
   * Make sure the directory exists.
   * If directory doesn't exist, it will try to make a new one.
   * If failed, it return rejected promise
   *
   * @param  {String} targetPath Target path of directory
   * @return {Promise} resolving targetPath
   */
  static resolveDirectory (targetPath) {
    return new Promise(function (resolve, reject) {
      // check the directory exists
      fs.stat(targetPath, function (err, stat) {
        // Reject errors except `ENOENT`
        if (err != null && err.code !== 'ENOENT') {
          return reject(err)
        }

        // Handle no suchfile error only
        // Make new Folder by given path
        if (err != null) {
          return fs.mkdir(targetPath, function (err, stat) {
            // If failed to make a new directory, reject it.
            if (err != null) {
              return reject(err)
            }
            resolve(targetPath)
          })
        }

        // Check the target is not a directory
        if (!stat.isDirectory()) {
          return reject(new Error(targetPath + ' path is not a directory'))
        }
        resolve(targetPath)
      })
    })
  }

  /**
   * Get all repository stats from localStorage
   * it is stored to `repositories` key.
   * if the data is corrupted, re-intialize it.
   *
   * @return {Array} registered repositories
   * ```
   * [{
   *   key: String,
   *   name: String,
   *   path: String // path of repository
   * }]
   * ```
   */
  static getAllCached () {
    let data
    try {
      data = JSON.parse(localStorage.getItem('repositories'))
      if (!_.isArray(data)) {
        throw new Error('Data is corrupted. it must be an array.')
      }
    } catch (err) {
      data = []
      this.saveAllCached(data)
    }
    return data
  }

  static saveAllCached (allCached) {
    localStorage.setItem('repositories', JSON.stringify(allCached))
  }

  static loadAll () {
    repositories = []
    return Promise.all(this.getAllCached().map((cached) => {
      let repo = new this(cached)
      repositories.push(repo)

      return repo.load()
    }))
  }

  static list () {
    return Promise.resolve(repositories)
  }

  static find (repoKey) {
    let repository = _.find(repositories, {cached: {key: repoKey}})
    return Promise.resolve(repository)
  }

  static randomColor () {
    return consts.FOLDER_COLORS[Math.floor(Math.random() * consts.FOLDER_COLORS.length)]
  }
}

export default Repository