Merge branch 'dev'

MCStreetguy · MCStreetguy · commit ae6616a96a75 · 2017-07-29T02:23:30.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,10 +7,12 @@
 #### Features
 - Snippet tag functionalities
 - Edit option for snippets
-- IMEX module *(Export option)*
+- IMEX module: *(Import & Export)*
+  - CSV ~ *Simple spreadsheet format* `importable`
 #### Improvements
 - Quick Start Guide enhanced
 - `README.md`
+- IMEX module configuration
 #### Patches
 - Debug output
 - Available debug commands reduced
diff --git a/README.md b/README.md
@@ -15,7 +15,8 @@ Happy Coding :)
 ## Reference
 
 #### Commands
-There are basically three commands snippet-injector ships with:
+The following commands are registered by Snippet Injector and can be accessed via the command palette.
+If stated, the commands can also be called through menus or via hotkey.
 
 ##### **snippet-injector:create**
 This command creates a new snippet from the current selection in the current editor.
@@ -27,6 +28,7 @@ You will be prompted for a snippet title.
 *Predefined Hotkey:*
 > "Ctrl + Alt + O"
 
+---
 
 ##### **snippet-injector:update**
 This command updates an existing snippet's content to the current selection in the current editor.
@@ -35,6 +37,7 @@ You will be prompted for choosing an existing snippet.
 *Name in menus:*
 > "Update existing snippet"
 
+---
 
 ##### **snippet-injector:insert**
 This command injects a snippet to the current marker position(s).
@@ -46,6 +49,7 @@ You will be prompted to choose a snippet from a list.
 *Predefined Hotkey:*
 > "Ctrl + Alt + I"
 
+---
 
 ##### **snippet-injector:delete**
 This command deletes a snippet from the local storage.
@@ -54,6 +58,7 @@ You will be prompted for the snippet name to delete.
 *Name in menus:*
 > "Delete snippet"
 
+---
 
 ##### **snippet-injector:toggledebug**
 This command toggles all debugging options for the package.
diff --git a/lib/db/imex.json b/lib/db/imex.json
@@ -1,26 +1,54 @@
-{
-  "export": {
-    "csv": {
-      "labels": [
-        "Title",
-        "Author",
-        "Content",
-        "Language",
-        "Tags",
-        "created with version"
-      ],
-      "order": [
-        "title",
-        "author",
-        "content",
-        "lang",
-        "tags",
-        "version"
-      ],
-      "divider": {
-        "field": ";",
-        "line": "\n"
+[
+  {
+    "name": "csv",
+    "importable": true,
+    "dialogOptions": {
+      "name": "CSV File",
+      "extensions": ["csv"]
+    },
+    "labels": [
+      "Title",
+      "Author",
+      "Content",
+      "Language",
+      "Tags",
+      "created with version"
+    ],
+    "order": [
+      "title",
+      "author",
+      "content",
+      "lang",
+      "tags",
+      "version"
+    ],
+    "convert": [
+      {
+        "type": "replace",
+        "name": "content",
+        "search": "\n",
+        "replace": "[LF]"
+      },
+      {
+        "type": "replace",
+        "name": "content",
+        "search": "\r",
+        "replace": "[CR]"
+      },
+      {
+        "type": "replace",
+        "name": "content",
+        "search": ";",
+        "replace": "[SC]"
+      },
+      {
+        "type": "json",
+        "name": "tags"
       }
+    ],
+    "divider": {
+      "field": ";",
+      "line": "\n"
     }
   }
-}
+]
diff --git a/lib/imex.js b/lib/imex.js
@@ -41,51 +41,101 @@ export default class IMEX {
   }
 
   storage_import() {
+    var filters = new Array();
+    this.data.forEach(function(e) {
+      if(e.importable) {
+        filters.push({
+          name: e.dialogOptions.name,
+          extensions: e.dialogOptions.extensions
+        });
+      }
+    });
+    filters.push({name: 'Any File', extensions: ['*']});
+    var _this = this;
 
+    dialog.showOpenDialog({
+      buttonLabel: 'Import',
+      properties: ['openFile'],
+      filters: filters
+    },function(filenames) {
+      var filename = filenames[0];
+      if(Util.isset(filename,'string')) {
+        var temp = path.extname(filename).replace('.','').toLowerCase();
+        switch(temp) {
+          case 'csv':
+            _this._impcsv(filename);
+            return true;
+            break;
+          default:
+            return false;
+        }
+      }
+    });
   }
 
   // internal methods
 
   _expcsv() {
     var storage = this.store;
-    var proto = this.data.export.csv;
+    var config = this.data.filter(function(e) {
+      if(e.name === 'csv') {
+        return true;
+      } else {
+        return false;
+      }
+    })[0];
     var files = storage.retrieveFiles();
     var csv_string = '';
     if(files.length > 0) {
-      proto.labels.forEach(function(element,index,array) {
+      config.labels.forEach(function(element,index,array) {
         csv_string += element;
         if(index < array.length-1) {
-          csv_string += proto.divider.field;
+          csv_string += config.divider.field;
         } else {
-          csv_string += proto.divider.line;
+          csv_string += config.divider.line;
         }
       })
       files.forEach(function(element,index,array) {
         var snippet = new Snippet(JSON.parse(storage.retrieveFile(element.replace('.json',''))));
-        proto.order.forEach(function(element,index,array) {
-          if(element === 'content') {
-            csv_string += '"'+snippet._get(element).split('\n').join('[LF]').split('\r').join('[CR]').split(';').join('[SC]')+'"';
-          } else if(element === 'tags') {
-            csv_string += '"'+JSON.stringify(snippet._get(element))+'"';
-          } else {
-            csv_string += '"'+snippet._get(element)+'"';
+        config.order.forEach(function(e,i,a) {
+          var insert = snippet._get(e);
+          if(config.convert.length > 0) {
+            config.convert.filter(function(item) {
+              if(item.name === e) {
+                return true;
+              } else {
+                return false;
+              }
+            }).forEach(function(conversion) {
+              if(conversion.type === 'replace') {
+                insert = insert.split(conversion.search).join(conversion.replace);
+              } else if(conversion.type === 'json') {
+                insert = JSON.stringify(insert);
+              }
+            });
           }
+          csv_string += insert;
 
-          if(index < array.length-1) {
-            csv_string += proto.divider.field;
+          if(i < a.length-1) {
+            csv_string += config.divider.field;
           } else {
-            csv_string += proto.divider.line;
+            csv_string += config.divider.line;
           }
         });
       });
 
+      var filters = new Array();
+      this.data.forEach(function(e) {
+        filters.push({
+          name: e.dialogOptions.name,
+          extensions: e.dialogOptions.extensions
+        });
+      });
+      filters.push({name: 'Any File', extensions: ['*']});
+
       dialog.showSaveDialog({
-        title: 'Choose the location for your export',
         buttonLabel: 'Export',
-        filters: [
-          {name: 'CSV File', extensions: ['csv']},
-          {name: 'Any File', extensions: ['*']}
-        ]
+        filters: filters
       },function(filename) {
         if(Util.isset(filename,'string')) {
           fs.writeFileSync(filename,csv_string);
@@ -103,4 +153,58 @@ export default class IMEX {
       return false;
     }
   }
+
+  _impcsv(filename) {
+    var storage = this.store;
+    var config = this.data.filter(function(e) {
+      if(e.name === 'csv') {
+        return true;
+      } else {
+        return false;
+      }
+    })[0];
+
+    var count = 0;
+    var file = fs.readFileSync(filename).toString();
+    file.split(config.divider.line).forEach(function(e,i,a) {
+      var temp = (e !== '' && e !== ' ');
+      config.labels.forEach(function(label) {
+        if(e.indexOf(label) > -1) {
+          temp = false;
+        }
+      });
+      if(temp) {
+        var snippet = new Snippet();
+        e.split(config.divider.field).forEach(function(field,index) {
+          var type = config.order[index];
+          var insert = field;
+          if(config.convert.length > 0) {
+            config.convert.filter(function(item) {
+              if(item.name === type) {
+                return true;
+              } else {
+                return false;
+              }
+            }).forEach(function(conversion) {
+              if(conversion.type === 'replace') {
+                insert = insert.split(conversion.replace).join(conversion.search);
+              } else if(conversion.type === 'json') {
+                insert = JSON.parse(insert);
+              }
+            });
+          }
+          snippet._set(type,insert);
+        });
+        storage.store(snippet);
+        count++;
+      }
+    });
+    if(count < 1) {
+      atom.notifications.addWarning('No snippets have been imported.', null)
+    } else if(count == 1) {
+      atom.notifications.addSuccess('One snippet has been imported.', null);
+    } else {
+      atom.notifications.addSuccess(count+' snippets have been imported.', null);
+    }
+  }
 }
diff --git a/lib/snippet-injector.js b/lib/snippet-injector.js
@@ -55,7 +55,8 @@ export default {
     }));
     // IMEX commmands
     this.subscriptions.add(atom.commands.add('atom-workspace', {
-      'snippet-injector:export-to-csv': function() {_this.imex_module.storage_export('csv')}
+      'snippet-injector:export-to-csv': function() {_this.imex_module.storage_export('csv')},
+      'snippet-injector:import': function() {_this.imex_module.storage_import()}
     }));
 
     if(window.localStorage.getItem('snippet-injector-debug') === 'true') {
diff --git a/lib/snippet.js b/lib/snippet.js
@@ -154,6 +154,38 @@ export default class Snippet {
     }
   }
 
+  _set(attribute,value) {
+    if(Util.isset(attribute,'string')) {
+      switch (attribute.toLowerCase()) {
+        case 'content':
+          this.setContent(value);
+          break;
+        case 'title':
+          this.setTitle(value);
+          break;
+        case 'tags':
+          this.setTags(value);
+          break;
+        case 'lang':
+          this.setLang(value);
+          break;
+        case 'uid':
+          this.setUID(value);
+          break;
+        case 'version':
+          this.setVersion(value);
+          break;
+        case 'author':
+          this.setAuthor(value);
+          break;
+        default:
+          return undefined;
+      }
+    } else {
+      return undefined;
+    }
+  }
+
   static getLastUpdate() {
     return lastUpdate;
   }
diff --git a/menus/snippet-injector.json b/menus/snippet-injector.json
@@ -52,13 +52,17 @@
               "type": "separator"
             },
             {
-              "label": "Export",
+              "label": "Export Snippets",
               "submenu": [
                 {
                   "label": "CSV",
                   "command": "snippet-injector:export-to-csv"
                 }
               ]
+            },
+            {
+              "label": "Import Snippets",
+              "command": "snippet-injector:import"
             }
           ]
         }

Original file line number	Diff line number	Diff line change
`@@ -52,13 +52,17 @@`
`52`	`52`	`"type": "separator"`
`53`	`53`	`},`
`54`	`54`	`{`
`55`		`- "label": "Export",`
	`55`	`+ "label": "Export Snippets",`
`56`	`56`	`"submenu": [`
`57`	`57`	`{`
`58`	`58`	`"label": "CSV",`
`59`	`59`	`"command": "snippet-injector:export-to-csv"`
`60`	`60`	`}`
`61`	`61`	`]`
	`62`	`+ },`
	`63`	`+ {`
	`64`	`+ "label": "Import Snippets",`
	`65`	`+ "command": "snippet-injector:import"`
`62`	`66`	`}`
`63`	`67`	`]`
`64`	`68`	`}`