Fix #150: Add support for naming patterns

Author: jyapayne

command_line.py

@@ -144,6 +144,83 @@ def project_name(self):
         return (self._project_name or
                 os.path.basename(os.path.abspath(self.project_dir())))
 
+    def sub_output_pattern(self, pattern):
+        """
+        Substitute patterns for setting values
+        """
+        byte_pattern = bytearray(pattern.encode())
+
+        val_dict = self.get_tag_value_dict()
+
+        start = 0
+        end = 0
+
+        in_sub = False
+
+        i = 0
+
+        while i < len(byte_pattern):
+            char = chr(byte_pattern[i])
+            next_char = None
+            if i != len(byte_pattern) - 1:
+                next_char = chr(byte_pattern[i+1])
+
+            if char == '%':
+                if next_char == '(':
+                    start = i
+                    in_sub = True
+
+            if in_sub:
+                end = i
+
+            if char == ')':
+                in_sub = False
+                old_string = str(byte_pattern[start:end+1], 'utf-8')
+                sub = val_dict.get(old_string)
+
+                if sub is not None:
+                    sub = str(sub)
+                    byte_pattern[start:end+1] = sub.encode()
+                    i = i + (len(sub)-len(old_string))
+
+            i += 1
+
+        return str(byte_pattern, 'utf-8').replace('/', '_').replace('\\', '_')
+
+
+    def get_tag_dict(self):
+        """
+        Gets the tag dictionary used to populate the
+        auto completion of the output name pattern field
+
+        Returns:
+            A dict object containing the mapping between friendly names
+            and setting names.
+        """
+        tag_dict = {}
+        for setting_group in (self.settings['setting_groups'] +
+                              [self.settings['export_settings']] +
+                              [self.settings['compression']]):
+            for key in setting_group.keys():
+                setting = setting_group[key]
+                tag_dict[setting.display_name] = '%('+key+')'
+
+        return tag_dict
+
+    def get_tag_value_dict(self):
+        """
+        Gets the tag to value dictionary to substitute values
+        """
+        tag_dict = {}
+        for setting_group in (self.settings['setting_groups'] +
+                              [self.settings['export_settings']] +
+                              [self.settings['compression']]):
+            for key in setting_group.keys():
+                setting = setting_group[key]
+                tag_dict['%('+key+')'] = setting.value
+
+        return tag_dict
+
     def get_setting(self, name):
         """Get a setting by name
 
@@ -153,19 +230,13 @@ def get_setting(self, name):
         Returns:
             A setting object or None
         """
-        # Check for alternate names in the settings
-        # due to nw.js changing some names in newer versions
-        name_no_underscores = name.replace('_', '-')
 
         for setting_group in (self.settings['setting_groups'] +
                               [self.settings['export_settings']] +
                               [self.settings['compression']]):
             if name in setting_group:
                 setting = setting_group[name]
                 return setting
-            elif name_no_underscores in setting_group:
-                setting = setting_group[name_no_underscores]
-                return setting
 
     def get_settings_type(self, type):
         """Get all settings with a specific type"""
@@ -749,7 +820,10 @@ def process_export_setting(self, ex_setting, output_dir,
 
     def make_output_dirs(self, write_json=True):
         """Create the output directories for the application to be copied"""
-        output_dir = utils.path_join(self.output_dir(), self.project_name())
+
+        output_name = self.sub_pattern() or self.project_name()
+
+        output_dir = utils.path_join(self.output_dir(), output_name)
         temp_dir = utils.path_join(config.TEMP_DIR, 'webexectemp')
 
         self.progress_text = 'Making new directories...\n'
@@ -770,6 +844,10 @@ def make_output_dirs(self, write_json=True):
             self.process_export_setting(ex_setting, output_dir, temp_dir,
                                         app_loc, uncompressed)
 
+    def sub_pattern(self):
+        """Returns the output pattern substitution or an empty string"""
+        setting = self.get_setting('output_pattern')
+        return self.sub_output_pattern(setting.value)
 
     def try_make_output_dirs(self):
         """Try to create the output directories if they don't exist"""

files/settings.cfg

@@ -113,12 +113,21 @@ linux_64_dir_prefix = 'nwjs-v{}-linux-x64'
 
     [[web2exe_settings]]
         [[[export_dir]]]
+            display_name='Output Directory'
             default_value=''
             type='string'
+            description='The output directory relative to the project directory.'
         [[[custom_script]]]
+            display_name='Execute Script'
             default_value=''
             copy=False
             type='file'
+            description='The script to execute after a project was successfully exported.'
+        [[[output_pattern]]]
+            display_name='Output Name Pattern'
+            default_value=''
+            type='string'
+            description='Instead of using the App Name for the output directory, this field can\nbe used to reference different settings of the package.json to name the output folder.'
 
     [[window_settings]]
         [[[id]]]
@@ -228,8 +237,8 @@ linux_64_dir_prefix = 'nwjs-v{}-linux-x64'
 
     [[download_settings]]
         [[[nw_version]]]
-            display_name='Node-webkit version'
-            default_value='0.12.0'
+            display_name='NW.js version'
+            default_value='0.16.0'
             values=[]
             type='list'
             button='Update'

main.py

@@ -1,5 +1,6 @@
 import os
 import glob
+import re
 import sys
 import codecs
 import platform
@@ -13,11 +14,12 @@
 
 from util_classes import ExistingProjectDialog
 from util_classes import BackgroundThread, Validator
+from util_classes import CompleterLineEdit, TagsCompleter
 
 from PySide import QtGui, QtCore
 from PySide.QtGui import (QApplication, QHBoxLayout, QVBoxLayout)
 from PySide.QtNetwork import QHttp
-from PySide.QtCore import QUrl, QFile, QIODevice, QCoreApplication
+from PySide.QtCore import Qt, QUrl, QFile, QIODevice, QCoreApplication
 
 from image_utils.pycns import pngs_from_icns
 
@@ -46,6 +48,7 @@ def __init__(self, width, height, app, parent=None):
 
         self.script_line = None
         self.output_line = None
+        self.output_name_line = None
 
         self.download_bar_widget = None
         self.app_settings_widget = None
@@ -814,6 +817,12 @@ def load_project(self, directory):
         script_setting = self.get_setting('custom_script')
         self.script_line.setText(script_setting.value)
 
+        output_name_setting = self.get_setting('output_pattern')
+        self.output_name_line.setText(output_name_setting.value)
+
+        self.output_name_line.textChanged.connect(self.output_name_line.text_changed)
+        self.output_name_line.textChanged.connect(self.completer.update)
+
         self.set_window_icon()
         self.open_export_button.setEnabled(True)
         self.update_json = True
@@ -906,25 +915,62 @@ def create_setting(self, name):
 
     def create_window_settings(self):
         group_box = QtGui.QWidget()
-        vlayout = self.create_layout(self.settings['order']['window_setting_order'], cols=3)
+        win_setting_order = self.settings['order']['window_setting_order']
+        vlayout = self.create_layout(win_setting_order, cols=3)
 
         group_box.setLayout(vlayout)
         return group_box
 
     def create_export_settings(self):
         group_box = QtGui.QWidget()
-        vlayout = self.create_layout(self.settings['order']['export_setting_order'], cols=4)
+
+        ex_setting_order = self.settings['order']['export_setting_order']
+
+        vlayout = self.create_layout(ex_setting_order, cols=4)
+
+
+        output_name_layout = QtGui.QHBoxLayout()
+
+        output_name_setting = self.get_setting('output_pattern')
+        output_name_label = QtGui.QLabel(output_name_setting.display_name+':')
+        output_name_label.setMinimumWidth(155)
+
+        tag_dict = self.get_tag_dict()
+        self.output_name_line = CompleterLineEdit(tag_dict)
+
+        completer = TagsCompleter(self.output_name_line, tag_dict)
+        completer.setCaseSensitivity(Qt.CaseInsensitive)
+
+        completer.activated.connect(self.output_name_line.complete_text)
+        self.completer = completer
+        self.completer.setWidget(self.output_name_line)
+
+        self.output_name_line.textChanged.connect(
+            self.call_with_object('setting_changed',
+                                  self.output_name_line,
+                                  output_name_setting)
+        )
+
+        self.output_name_line.setStatusTip(output_name_setting.description)
+
+        output_name_layout.addWidget(output_name_label)
+        output_name_layout.addWidget(self.output_name_line)
 
         output_layout = QtGui.QHBoxLayout()
 
-        output_label = QtGui.QLabel('Output Directory:')
-        output_label.setMinimumWidth(150)
+        ex_dir_setting = self.get_setting('export_dir')
+        output_label = QtGui.QLabel(ex_dir_setting.display_name+':')
+        output_label.setMinimumWidth(155)
         self.output_line = QtGui.QLineEdit()
-        self.output_line.textChanged.connect(self.call_with_object('setting_changed',
-                                                                   self.output_line,
-                                                                   self.get_setting('export_dir')))
+
+        self.output_line.textChanged.connect(
+            self.call_with_object('setting_changed',
+                                  self.output_line,
+                                  ex_dir_setting)
+        )
+
         self.output_line.textChanged.connect(self.project_path_changed)
-        self.output_line.setStatusTip('The output directory relative to the project directory.')
+        self.output_line.setStatusTip(ex_dir_setting.description)
         output_button = QtGui.QPushButton('...')
         output_button.clicked.connect(self.browse_out_dir)
 
@@ -934,19 +980,20 @@ def create_export_settings(self):
 
         script_layout = QtGui.QHBoxLayout()
 
-        script_label = QtGui.QLabel('Execute Script:')
-        script_label.setMinimumWidth(150)
+        script_setting = self.get_setting('custom_script')
+        script_label = QtGui.QLabel(script_setting.display_name+':')
+        script_label.setMinimumWidth(155)
 
         self.script_line = QtGui.QLineEdit()
 
-        script_setting = self.get_setting('custom_script')
         self.script_line.setObjectName(script_setting.name)
 
-        self.script_line.textChanged.connect(self.call_with_object('setting_changed',
-                                                                   self.script_line,
-                                                                   script_setting))
-        self.script_line.setStatusTip('The script to execute after a '
-                                      'project was successfully exported.')
+        self.script_line.textChanged.connect(
+            self.call_with_object('setting_changed',
+                                  self.script_line,
+                                  script_setting)
+        )
+        self.script_line.setStatusTip(script_setting.description)
         script_button = QtGui.QPushButton('...')
 
         file_types = ['*.py']
@@ -956,15 +1003,20 @@ def create_export_settings(self):
         else:
             file_types.append('*.bash')
 
-        script_button.clicked.connect(self.call_with_object('get_file_reg',
-                                                            self.script_line, script_setting,
-                                                            ' '.join(file_types)))
+        script_button.clicked.connect(
+            self.call_with_object('get_file_reg',
+                                  self.script_line,
+                                  script_setting,
+                                  ' '.join(file_types))
+        )
+
         script_layout.addWidget(script_label)
         script_layout.addWidget(self.script_line)
         script_layout.addWidget(script_button)
 
         vbox = QtGui.QVBoxLayout()
         vbox.addLayout(vlayout)
+        vbox.addLayout(output_name_layout)
         vbox.addLayout(output_layout)
         vbox.addLayout(script_layout)
 
@@ -1321,7 +1373,7 @@ def show_and_raise(self):
         self.existing_dialog.raise_()
 
 
-if __name__ == '__main__':
+def main():
     app = QApplication(sys.argv)
 
     QCoreApplication.setApplicationName("Web2Executable")
@@ -1333,3 +1385,6 @@ def show_and_raise(self):
     frame.show_and_raise()
 
     sys.exit(app.exec_())
+
+if __name__ == '__main__':
+    main()

util_classes.py

@@ -237,3 +237,54 @@ def __repr__(self):
                  self.required,
                  self.type,
                  url)
+
+class CompleterLineEdit(QtGui.QLineEdit):
+
+    def __init__(self, tag_dict, *args):
+        QtGui.QLineEdit.__init__(self, *args)
+
+        self.pref = ''
+        self.tag_dict = tag_dict
+
+    def text_changed(self, text):
+        all_text = str(text)
+        text = all_text[:self.cursorPosition()]
+        prefix = re.split('[^%a-zA-Z)(_-]', text)[-1].strip()
+        self.pref = prefix
+        if prefix.strip() != prefix:
+            self.pref = ''
+
+    def complete_text(self, text):
+        cursor_pos = self.cursorPosition()
+        before_text = str(self.text())[:cursor_pos]
+        after_text = str(self.text())[cursor_pos:]
+        prefix_len = len(re.split('[^%a-zA-Z)(_-]', before_text)[-1].strip())
+        tag_text = self.tag_dict.get(text)
+
+        if tag_text is None:
+            tag_text = text
+
+        new_text = '{}{}{}'.format(before_text[:cursor_pos - prefix_len],
+                                   tag_text,
+                                   after_text)
+        self.setText(new_text)
+        self.setCursorPosition(len(new_text))
+
+class TagsCompleter(QtGui.QCompleter):
+
+    def __init__(self, parent, all_tags):
+        self.keys = sorted(all_tags.keys())
+        self.vals = sorted([val for val in all_tags.values()])
+        self.tags = list(sorted(self.vals+self.keys))
+        QtGui.QCompleter.__init__(self, self.tags, parent)
+        self.editor = parent
+
+    def update(self, text):
+        obj = self.editor
+        completion_prefix = obj.pref
+        model = QtGui.QStringListModel(self.tags, self)
+        self.setModel(model)
+
+        self.setCompletionPrefix(completion_prefix)
+        if completion_prefix.strip() != '':
+            self.complete()