Merge lp:~quickly-committers/quickly/ide into lp:quickly

[Tony Byrne]

Quickly uses the same editor for editing project (many files open) and for read_input (open a single file and react to editor close down). In order to do both tasks quickly uses a particular property of gedit which allows both usages simultaneously. It would be nice to use a different program for editing files (an IDE) and for reading input. Also different IDEs for different languages.

Proposal: quickly reads a preference file e.g. ~.config/quickly/preferences containing something like

[vala-ubuntu-application]
ide = valide

[ubuntu-application]
ide = geany

[java-ubuntu-application]
ide = eclipse

[kubuntu-application]
ide = kdevelop

and uses the ide for quickly edit. Automatically creates ~.config/quickly/preferences and adds a command $ quickly preferences to allow editing this file

The bad news: running trunk/quickly$ test/run.sh doesn't work for me still so I cannot test it :(

[lp:~quickly-committers/quickly/ide]

621. By Tony Byrne <email address hidden> on 2011-05-17

removed some junk

[Michael Terry (mterry)]

I dig moving the functions to templatetools to be shared. But why create a preference system for the ide issue? Isn't that already handled via environment variables?

[Tony Byrne (tony-badwolf)]

Having an environment variable for each template would be unwieldy.
Also the environment variables are effectively
export PARAMETER=value in the ~/.bashrc file
while
parameter=value in the ~/.config/quickly/preferences file allows a
$quickly preferences command to edit them and apply instantly without
requiring a terminal restart.

Actually moving get_quickly_editors() was a side effect of searching
for get_quickly_editors() so I could be sure to consider every call,
then noticing the almost duplicate code and that it is not specific to
a template anyway. But the location of get_quickly_editors() inside
the template also hints that different editors for each template is a
good idea anyway.

I'm also working on enhancing the add command so that you could call,
for instance,
$quickly add company_logo where company_logo would reside in a
directory and .bashrc (or preferences) would contain
plugins=/my/plugin/directory.

In effect the more choices we give to the developer the more
parameters=value statements, with sensible defaults, are needed.

There is a gap in configuration
projects have .quickly
quickly has .bashrc
templates have nothing

quickly can edit part of .quickly ($quickly dependencies)
but does not provide editing .bashrc, neither does .bashrc have sections.

On 18/05/2011, Michael Terry <email address hidden> wrote:
> I dig moving the functions to templatetools to be shared. But why create a
> preference system for the ide issue? Isn't that already handled via
> environment variables?
> --
> https://code.launchpad.net/~tony-badwolf/quickly/ide/+merge/61326
> You are the owner of lp:~tony-badwolf/quickly/ide.
>

Unmerged revisions

621. By Tony Byrne <email address hidden> on 2011-05-17

removed some junk

620. By Tony Byrne <email address hidden> on 2011-05-17

allow preferences to be edited outside project
removed quickly configure preferences
added quickly preferences
moved read_input from templates/ubuntu-application/quicklyutils.py
to quickly/templatetools.py

619. By Tony Byrne <email address hidden> on 2011-05-16

added command configure preferences

618. By Tony Byrne <email address hidden> on 2011-05-16

moved get_quickly_editors() into templatetools: same code for all templates
use a config file to allow developer use an ide for editing project keeping gedit for read_input()

=== modified file 'data/templates/ubuntu-application/configure.py'
--- data/templates/ubuntu-application/configure.py	2010-10-18 18:39:04 +0000
+++ data/templates/ubuntu-application/configure.py	2011-05-17 22:51:41 +0000
@@ -82,7 +82,7 @@
     if len(argv) > 2:
         project_name = argv[2]
     else:
-        project_name = quicklyutils.read_input()
+        project_name = templatetools.read_input()
     # need to try and get the original project name if it exists.  We'll need this
     # to replace any existing settings
     if not configurationhandler.project_config:
@@ -158,7 +158,7 @@
         dependencies = [elem.strip() for elem in configurationhandler.project_config['dependencies'].split(',') if elem]
     except KeyError:
         dependencies = []
-    userinput = quicklyutils.read_input('\n'.join(dependencies))
+    userinput = templatetools.read_input('\n'.join(dependencies))
     dependencies = []
     for depends in userinput.split('\n'):
         dependencies.extend([elem.strip() for elem in depends.split(',') if elem])
@@ -174,4 +174,3 @@
         configurationhandler.loadConfig()
     configurationhandler.project_config["target_distribution"] = argv[2]
     configurationhandler.saveConfig()
-

=== modified file 'data/templates/ubuntu-application/edit.py'
--- data/templates/ubuntu-application/edit.py	2011-04-27 15:02:41 +0000
+++ data/templates/ubuntu-application/edit.py	2011-05-17 22:51:41 +0000
@@ -65,7 +65,8 @@
 # add helpfile sources
 filelist.extend(glob.glob('help/C/*.page'))
 
-editor = quicklyutils.get_quickly_editors()
+editor = templatetools.get_ide(configurationhandler.project_config['template'])
+
 if templatetools.in_verbose_mode():
     instance = subprocess.Popen([editor] + filelist)
 else:

=== modified file 'data/templates/ubuntu-application/internal/quicklyutils.py'
--- data/templates/ubuntu-application/internal/quicklyutils.py	2011-03-02 15:04:44 +0000
+++ data/templates/ubuntu-application/internal/quicklyutils.py	2011-05-17 22:51:41 +0000
@@ -229,44 +229,6 @@
             buffered_message +=' %s' % line
     return(changelog)
 
-
-def get_quickly_editors():
-    '''Return prefered editor for ubuntu-application template'''
-
-    default_editor = os.environ.get("QUICKLY_EDITOR")
-    if not default_editor:
-        default_editor = os.environ.get("EDITOR")
-    if not default_editor:
-        default_editor = os.environ.get("SELECTED_EDITOR")
-    if default_editor:
-        editor = default_editor
-    elif templatetools.is_X_display():
-        editor = "gedit"
-    else:
-        editor = "nano"
-    return editor
-
-def read_input(start=''):
-    depfile_name = tempfile.mkstemp()[1]
-    open(depfile_name,'w').write(start)
-
-    # Run the editor with a new tmpdir.  This is because gedit uses tmpdir
-    # to find other instances of gedit, and we don't want that.  If we allowed
-    # that, gedit would return immediately and open a new tab in the other
-    # gedit.  This makes it difficult to tell when user is done editing (how
-    # to detect that vs nano opening and closing without the user saving it?).
-    editor = get_quickly_editors()
-    subenv = dict(os.environ)
-    subenv['TMPDIR'] = tempfile.mkdtemp()
-    subprocess.call([editor, depfile_name], stdout=subprocess.PIPE, env=subenv)
-    os.rmdir(subenv['TMPDIR'])
-
-    # Grab file contents
-    rv = file(depfile_name, 'r').read().strip()
-    os.remove(depfile_name)
-
-    return rv
-
 def take_email_from_string(value):
     '''Try to take an email from a string'''
 

=== modified file 'data/templates/ubuntu-flash-game/internal/quicklyutils.py'
--- data/templates/ubuntu-flash-game/internal/quicklyutils.py	2011-01-03 15:07:28 +0000
+++ data/templates/ubuntu-flash-game/internal/quicklyutils.py	2011-05-17 22:51:41 +0000
@@ -209,19 +209,6 @@
             buffered_message +=' %s' % line
     return(changelog)
 
-
-def get_quickly_editors():
-    '''Return prefered editor for ubuntu-application template'''
-
-    editor = "gedit"
-    default_editor = os.environ.get("EDITOR")
-    if not default_editor:
-        default_editor = os.environ.get("SELECTED_EDITOR")
-    if default_editor:
-       editor = default_editor
-    return editor
-
-
 def take_email_from_string(value):
     '''Try to take an email from a string'''
 

=== modified file 'quickly/builtincommands.py'
--- quickly/builtincommands.py	2010-11-29 15:18:46 +0000
+++ quickly/builtincommands.py	2011-05-17 22:51:41 +0000
@@ -15,8 +15,10 @@
 #You should have received a copy of the GNU General Public License along 
 #with this program.  If not, see <http://www.gnu.org/licenses/>.
 
+import ConfigParser
 import os
 import shutil
+import StringIO
 import sys
 
 import configurationhandler
@@ -211,7 +213,36 @@
         os.rename(filedest.name, commandsconfig_path)
     return 0
 
-
+help_preferences = _("Edit developers preferences")
+usage_preferences = _("Usage: quickly preferences")
+def preferences(project_template, project_dir, command_args, shell_completion=False):
+    """Configure preferences"""
+
+    # We have nothing for this
+    if shell_completion:
+        return("")
+
+    preferences = templatetools.get_preferences()
+    
+    #convert preferences into editable contents
+    fp_current = StringIO.StringIO()
+    preferences.write(fp_current)
+    contents = fp_current.getvalue()
+    fp_current.close()
+
+    # ask developer to edit the contents
+    newcontents = templatetools.read_input(contents)
+
+    # convert the contents back into a ConfigParser object
+    newIO = StringIO.StringIO(newcontents)
+    new_preferences = ConfigParser.SafeConfigParser()
+    # an exception here reject bad edits
+    new_preferences.readfp(newIO)
+
+    templatetools.set_preferences(new_preferences)
+
+
+    return 0
 
 # here, special builtin commands properties (if nothing specified, commands can be launched inside and outside projects)
 launched_inside_project_only = []

=== modified file 'quickly/templatetools.py'
--- quickly/templatetools.py	2010-12-20 20:33:12 +0000
+++ quickly/templatetools.py	2011-05-17 22:51:41 +0000
@@ -15,15 +15,20 @@
 #You should have received a copy of the GNU General Public License along
 #with this program.  If not, see <http://www.gnu.org/licenses/>.
 
+import ConfigParser
 import os
 import stat
 import string
+import subprocess
 import sys
 import re
+import tempfile
 
 import gettext
 from gettext import gettext as _
 
+import glib
+
 import configurationhandler
 import tools
 import quicklyconfig
@@ -256,3 +261,79 @@
         print_command_candidates(template)
     sys.exit(4)
 
+def get_preferences():
+    'parse ~/.config/quickly/preferences for configuration'
+    template_names = commands.get_all_templates()
+    preferences = ConfigParser.SafeConfigParser()
+
+    for template_name in template_names:
+        preferences.add_section(template_name)
+
+    config_dir = os.path.join(glib.get_user_config_dir(), 'quickly')
+    config_file = os.path.join(config_dir, 'preferences')
+    preferences.read(config_file)
+
+    return preferences
+
+def set_preferences(new_preferences):
+    'write ~/.config/quickly/preferences'
+
+    config_dir = os.path.join(glib.get_user_config_dir(), 'quickly')
+    config_file = os.path.join(config_dir, 'preferences')
+
+    # ensure config_dir exists
+    if not os.path.isdir(config_dir):
+        os.makedirs(config_dir)
+
+    # write the preferences file
+    with open(config_file, 'w') as fp:
+        new_preferences.write(fp)
+
+def get_quickly_editors():
+    '''Return prefered editor for any template'''
+
+    default_editor = os.environ.get("QUICKLY_EDITOR")
+    if not default_editor:
+        default_editor = os.environ.get("EDITOR")
+    if not default_editor:
+        default_editor = os.environ.get("SELECTED_EDITOR")
+    if default_editor:
+        editor = default_editor
+    elif is_X_display():
+        editor = "gedit"
+    else:
+        editor = "nano"
+    return editor
+
+def read_input(start=''):
+    depfile_name = tempfile.mkstemp()[1]
+    open(depfile_name,'w').write(start)
+
+    # Run the editor with a new tmpdir.  This is because gedit uses tmpdir
+    # to find other instances of gedit, and we don't want that.  If we allowed
+    # that, gedit would return immediately and open a new tab in the other
+    # gedit.  This makes it difficult to tell when user is done editing (how
+    # to detect that vs nano opening and closing without the user saving it?).
+    editor = get_quickly_editors()
+    subenv = dict(os.environ)
+    subenv['TMPDIR'] = tempfile.mkdtemp()
+    subprocess.call([editor, depfile_name], stdout=subprocess.PIPE, env=subenv)
+    os.rmdir(subenv['TMPDIR'])
+
+    # Grab file contents
+    rv = file(depfile_name, 'r').read().strip()
+    os.remove(depfile_name)
+
+    return rv
+
+def get_ide(template):
+    '''Return prefered editor for specified template'''
+    preferences = get_preferences()
+    
+    if preferences.has_option(template, 'ide'):
+        return preferences.get(template, 'ide')
+    else:
+        return get_quickly_editors()
+
+
+