add shell function to indesign

Author: bastieneichenberger

lib/helper/config/all_helper_modules.jsx

@@ -6,6 +6,8 @@
 
 //@include "../log/log.jsx"
 
+//@include "../shell/shell.jsx"
+
 //@include "../ui/ui.jsx"
 
 //@include "../utils/array.jsx"

lib/helper/shell/shell.jsx

@@ -0,0 +1,57 @@
+/**
+ * Module with Utils functions
+ * @namespace Utils
+ * @memberOf H
+ * @author Bastien Eichenberger
+ */
+H.Shell = (function (my) {
+
+
+    /**
+     * Function to execute a shell string
+     * @supported for the moment this function works only on mac with InDesign
+     * @todo add support for windows, Photoshop, Illustrator using batch files
+     * @param shell_function
+     * @returns {*|null}
+     */
+    my.execute = function (shell_function) {
+        var result, apple_script;
+
+        if ($.os.contains('Windows')) {
+            throw {
+                name: 'UnimplementedMethodError',
+                message: 'this function do not work on Windows',
+                fileName: $.fileName,
+                line: $.line
+            };
+        }
+
+        if (app.name.indexOf('InDesign') > -1) {
+            apple_script = 'do shell script "' + shell_function + '"';
+            try {
+                result = app.doScript(apple_script, ScriptLanguage.applescriptLanguage);
+            }
+            catch (ex) {
+                throw {
+                    name: 'Error',
+                    message: 'the shell function '+ shell_function + ' contains an error: ' + ex.message,
+                    fileName: $.fileName,
+                    line: $.line
+                };
+            }
+        }
+        else {
+            throw {
+                name: 'UnimplementedMethodError',
+                message: 'this function works only with InDesign',
+                fileName: $.fileName,
+                line: $.line
+            };
+        }
+
+        return result || null;
+    }
+
+    return my;
+
+})(H.Shell || {});

tests/Gruntfile.js

@@ -94,33 +94,22 @@ module.exports = function (grunt) {
                     args: [path.resolve('test/results')]
                 },
                 src: 'test/fixtures/indesign/document/test_document.jsx'
-            }
-        },
-
-        illustrator: {
-            test_log: {
-                options: {
-                    args: [path.resolve('test/log')]
-                },
-                src: 'test/fixtures/helper/log/test_log.jsx'
             },
-            test_gateway: {
+            test_grep: {
                 options: {
-                    args: [path.resolve('test/results/tests.xml')]
+                    args: [path.resolve('test/results')]
                 },
-                src: 'test/fixtures/helper/gateway/test_gateway.jsx'
+                src: 'test/fixtures/indesign/document/test_grep.jsx'
             },
-            test_array: {
+            test_shell: {
                 options: {
-                    args: [path.resolve('test/results/tests.xml')]
+                    args: [path.resolve('test/results/tests.xml'), path.resolve('test/results')]
                 },
-                src: ['test/fixtures/helper/utils/test_array.jsx']
+                src: ['test/fixtures/helper/shell/test_shell.jsx']
             }
         },
 
-        /**
-         * @todo it would be better to write a function to execute a jsx file in all apps
-        all_apps: {
+        illustrator: {
             test_log: {
                 options: {
                     args: [path.resolve('test/log')]
@@ -139,7 +128,7 @@ module.exports = function (grunt) {
                 },
                 src: ['test/fixtures/helper/utils/test_array.jsx']
             }
-        },*/
+        },
 
         // Units tests.
         nodeunit: {

tests/test/fixtures/helper/shell/test_shell.jsx

@@ -0,0 +1,20 @@
+(function (xml_file_path, results_folder) {
+
+    try {
+        //@include "../../../../../lib/helper/helper-lib.jsx"
+        H.Config.init();
+
+        // shell string to build a ZIP zip -r output.zip source
+        var shell_string = 'zip -r %s %s';
+        shell_string = shell_string.printf(results_folder + '/output.zip', results_folder);
+
+        H.Shell.execute(shell_string);
+
+
+    }
+    catch (ex) {
+        alert('file: ' + ex.fileName + '\n message: ' + ex.message + '\n line: ' + ex.line);
+    }
+
+
+}).apply(this, [].slice.apply(this.arguments));

tests/test/fixtures/indesign/document/test_grep.jsx

@@ -64,6 +64,16 @@ exports.indesign_lib = {
         var is_export_as_jpg = grunt.file.exists('test/results/test_jpg_indesign.jpg');
         test.ok(is_export_as_jpg);
         test.done();
+    },
+    save_indesign_document: function (test) {
+        var is_export_as_indd = grunt.file.exists('test/results/document_result.indd');
+        test.ok(is_export_as_indd);
+        test.done();
+    },
+    zip_with_shell: function (test) {
+        var is_zip_shell = grunt.file.exists('test/results/output.zip');
+        test.ok(is_zip_shell);
+        test.done();
     }
 };