Merge pull request #10 from MCStreetguy/pending-major

Snippet handling changed to UID

Author: Maximilian Schmidt

CHANGELOG.md

@@ -3,6 +3,30 @@
 
 ----------------
 
+## v1.0.0
+**Stable release**
+#### Features
+- Snippet class:
+  - Title
+  - Tags *(not used currently)*
+  - Content
+  - Language
+  - UID
+  - Version
+- Automated snippet migration to newer version
+#### Improvements
+- Performance
+- `LICENSE.md` / `README.md`
+- Icon styling
+- Delete prompt with list
+#### Patches
+- UID generation
+- Storage fixes for new snippet conventions
+- Version comparison
+- Delete prompt styling
+
+---
+
 ## v0.1.0 ~ v1.0.0
 **Early Development**
 #### Features
@@ -30,3 +54,5 @@
 - JSON error on snippet saving
 - Error with different path dividers on different OSs
 - Icon update when searching prompt list
+
+---

lib/icon-helper.js

@@ -13,11 +13,9 @@ export default {
 
   activate(state) {
     this.storage = new Storage({dir: '/storage/snippet-injector/snippets/'});
-    console.log(this.storage);
+    this.storage.migrate();
 
-    // Events subscribed to in atom's system can be easily cleaned up with a CompositeDisposable
     this.subscriptions = new CompositeDisposable();
-    // Register command that toggles this view
     this.subscriptions.add(atom.commands.add('atom-workspace', {
       'snippet-injector:create': () => this.create(),
       'snippet-injector:insert': () => this.insert(),
@@ -39,17 +37,26 @@ export default {
     var selection = atom.workspace.getActiveTextEditor().getSelectedText();
     var grammar = atom.workspace.getActiveTextEditor().getGrammar().name;
     var storage = this.storage;
+    var uid = Util.generateUID({
+      unique: true,
+      tester: storage.testFile,
+      timeout: 100,
+      length: 20,
+      prefix: 'sn',
+      insertstring: 'SNIPPET'
+    });
     const inputPrompt = Util.promptUser({
       placeholder: 'Enter snippet title',
       btnconfirm: 'Save snippet',
       btncancel: 'Cancel'
     },function(text){
-      if(text !== null) {
+      if(Util.isset(text,'string')) {
         var result = storage.store(new Snippet({
           title: text,
           tags: new Array(),
           content: selection,
-          lang: grammar
+          lang: grammar,
+          uid: uid
         }));
         if(result) {
           atom.notifications.addSuccess('Snippet "'+text+'" was saved successfully.', null);
@@ -64,13 +71,11 @@ export default {
     var storage = this.storage;
     var filenames = storage.retrieveFiles();
     if(filenames.length > 0) {
-      var snippets = new Array();
       var listitems = new Array();
       var icons = new Array();
       filenames.forEach(function(currentValue) {
-        var elem = new Snippet(JSON.parse(storage.retrieveFile(currentValue.replace('.snippet.json',''))));
-        snippets.push(elem);
-        listitems.push(elem.getTitle());
+        var elem = new Snippet(JSON.parse(storage.retrieveFile(currentValue.replace('.json',''))));
+        listitems.push(elem.getUID());
         icons.push(elem.getLang());
       });
 
@@ -82,7 +87,7 @@ export default {
         nothingfound: 'No Snippets found that match you search.',
         icons: icons
       },function(element) {
-        if(element !== null) {
+        if(Util.isset(element,'string')) {
           var snippet = new Snippet(JSON.parse(storage.retrieveFile(element)));
           atom.workspace.getActiveTextEditor().insertText(snippet.getContent(),{
             select: true,
@@ -91,7 +96,7 @@ export default {
             autoDecreaseIndent: true,
             normalizeLineEndings: true
           });
-          atom.notifications.addInfo('Snippet \''+element+'\' was successfully inserted.', null);
+          atom.notifications.addSuccess('Snippet \''+snippet.getTitle()+'\' was successfully inserted.', null);
         }
       });
     } else {
@@ -101,20 +106,35 @@ export default {
 
   delete() {
     var storage = this.storage;
-    const deletePrompt = Util.promptDelete({
-      title: 'Delete a snippet',
-      placeholder: 'Title of the snippet that shall be deleted',
-      btnconfirm: 'Delete',
-      btncancel: 'Cancel',
-      suremsg: 'Sure?'
-    },function(element) {
-      if(element !== null) {
-        if(storage.deleteFile(element)) {
-          atom.notifications.addSuccess('Snippet \''+element+'\' was successfully deleted.', null);
-        } else {
-          atom.notifications.addWarning('Snippet \''+element+'\' could not be found. Is it spelled right?', null);
+    var fileNames = storage.retrieveFiles();
+    if(fileNames.length > 0) {
+      var items = new Array();
+      fileNames.forEach(function(current) {
+        var snippet = new Snippet(JSON.parse(storage.retrieveFile(current.replace('.json',''))));
+        items.push({
+          value: snippet.getUID(),
+          title: snippet.getTitle()
+        });
+      });
+      const deletePrompt = Util.promptDelete({
+        title: 'Delete a snippet',
+        placeholder: 'Please choose a snippet...',
+        btnconfirm: 'Delete',
+        btncancel: 'Cancel',
+        suremsg: 'Are you sure?',
+        items: items
+      },function(element) {
+        if(Util.isset(element,'string')) {
+          var snippet = new Snippet(JSON.parse(storage.retrieveFile(element)));
+          if(storage.deleteFile(snippet.getUID())) {
+            atom.notifications.addSuccess('Snippet \''+snippet.getTitle()+'\' was successfully deleted.', null);
+          } else {
+            atom.notifications.addWarning('Snippet \''+snippet.getTitle()+'\' could not be found in the local storage.', null);
+          }
         }
-      }
-    });
+      });
+    } else {
+      atom.notifications.addWarning('No snippets found in the local storage directory.', null);
+    }
   }
 };

lib/snippet-injector.js

@@ -1,33 +1,48 @@
 'use babel';
 
+import Util from './util.js';
+
 export default class Snippet {
 
   content = '';
   title = '';
   tags = new Array();
   lang = '';
+  uid = Date.now().toString();
+  version = undefined;
 
   constructor(state) {
-    if(state !== undefined && state !== null && typeof state === 'object') {
-      this.title = state.title;
-      this.tags = state.tags;
-      this.content = state.content;
-      this.lang = state.lang;
-    } else {
-      this.title = "";
-      this.tags = new Array();
-      this.content = "";
-      tis.lang = "";
+    if(typeof state === 'object') {
+      if(Util.isset(state.title,'string')) {
+        this.title = state.title;
+      }
+      if(Util.isset(state.tags,'object')) {
+        this.tags = state.tags;
+      }
+      if(Util.isset(state.content,'string')) {
+        this.content = state.content;
+      }
+      if(Util.isset(state.lang,'string')) {
+        this.lang = state.lang;
+      }
+      if(Util.isset(state.uid,'string')) {
+        this.uid = state.uid;
+      }
+      if(Util.isset(state.version,'string')) {
+        this.version = state.version;
+      }
     }
   }
 
   // Returns an object that can be retrieved when package is activated
   serialize() {
     return {
-      'title':this.title,
-      'tags':this.tags,
-      'content':this.content,
-      'lang':this.lang
+      'title':this.getTitle(),
+      'tags':this.getTags(),
+      'content':this.getContent(),
+      'lang':this.getLang(),
+      'uid':this.getUID(),
+      'version':this.getVersion()
     };
   }
 
@@ -50,4 +65,36 @@ export default class Snippet {
   getLang() {
     return this.lang;
   }
+
+  getUID() {
+    return this.uid;
+  }
+
+  getVersion() {
+    return this.version;
+  }
+
+  setTitle(newtitle) {
+    this.title = newtitle;
+  }
+
+  setContent(newcontent) {
+    this.content = newcontent;
+  }
+
+  setTags(newtags) {
+    this.tags = newtags;
+  }
+
+  setLang(newlang) {
+    this.lang = newlang;
+  }
+
+  setVersion(newversion) {
+    this.version = newversion;
+  }
+
+  setUID(newuid) {
+    this.uid = newuid;
+  }
 }