Merge lp:~tony-badwolf/quickly/modular_add into lp:quickly

[Tony Byrne]

Modular version of add which makes it easier to add files to a template. Added test for unknown parameter i.e. quickly add foo reports failure.

[Michael Terry (mterry)]

Neat, thanks Tony! This does seem easier to work with for the future.

77 + help_list = ['Add something to your project\n']
78 + for module in addable:
79 + try:
80 + help_list.append(getattr(store, module).help_text)
81 + except AttributeError:
82 + # ignore files in store that have no help for us
83 + pass
84 + help_text = ''.join(help_list)
85 + print _(help_text)

I would make this '\n\n\n'.join(help_list) and remove the surrounding endlines from the help strings in the store. This is more 'defensive' because it doesn't rely on the cooperation of items from the store.

Also, the translation call _() should go around the source strings (including the ones in the store), not the final "print help_text". Like so:
help_list = [_('Add something to your project')]

204 + templatetools.usage_error(_('Cannot add %s: it is not in the store' % argv[1]), cmd=cmd, template='ubuntu-application')

I would make this a little more user-friendly, like "Did not recognize %s" or something. A user isn't going to know what the store is.

23 +from store import *

Do you need this line?

24 +import store

It feels a bit odd using the store directory for this. What do you think about a new directory/submodule called 'add' or 'add_items' or something?

255 +abs_template_path = templatetools.get_template_path_from_project()

This line causes an error when I do this in the toplevel of the quickly branch due to loadConfig() eventually being called with can_stop=True:
PATH=./bin:$PATH quickly help ubuntu-application add

review: Needs Fixing

[lp:~tony-badwolf/quickly/modular_add]

553. By Tony Byrne <email address hidden> on 2010-11-12

Fixed translation calls and clarified help message. Prevented
quickly help ubuntu-application add triggering a call to
templatetools.get_template_path_from_project() which causes an error.

[Tony Byrne (tony-badwolf)]

Hi Michael
 I think my last email might have disappeared because it doesn't show
in my sent mail so here is a summary.

Applied '\n\n'.join(...) fix in help. Applied your suggestions for the
translation code.

from store import *
import store
I need both, I'm aware its weird so I'll give it some thought.

abs_template_path = templatetools.get_template_path_from_project()
This call appears in the original add.py , I tried everything with it
but it always errors for me. The variable abs_template_path is used
inside the store.<module>.add(...) command so I moved this command
inside the add(...) function where quickly help ubuntu-application add
does not trigger it. The help command works now but I cannot tell if
the add.py script/module needs to contain this variable for
introspection.

Using store like this is similar to a debian repository where the
install script is bundled with the source code.

I submitted code yesterday with
quickly add
# ERROR: Cannot add, no plugin name provided.

quickly add foo
# ERROR: Cannot add, did not recognize plugin name: foo

I now think addon is better than plugin. If we don't use the
repository analogy the install scripts can go into addons directory.

On 11/9/10, Michael Terry <email address hidden> wrote:
> Review: Needs Fixing
> Neat, thanks Tony! This does seem easier to work with for the future.
>
> 77 + help_list = ['Add something to your project\n']
> 78 + for module in addable:
> 79 + try:
> 80 + help_list.append(getattr(store, module).help_text)
> 81 + except AttributeError:
> 82 + # ignore files in store that have no help for us
> 83 + pass
> 84 + help_text = ''.join(help_list)
> 85 + print _(help_text)
>
> I would make this '\n\n\n'.join(help_list) and remove the surrounding
> endlines from the help strings in the store. This is more 'defensive'
> because it doesn't rely on the cooperation of items from the store.
>
> Also, the translation call _() should go around the source strings
> (including the ones in the store), not the final "print help_text". Like
> so:
> help_list = [_('Add something to your project')]
>
> 204 + templatetools.usage_error(_('Cannot add %s: it is not in the store' %
> argv[1]), cmd=cmd, template='ubuntu-application')
>
> I would make this a little more user-friendly, like "Did not recognize %s"
> or something. A user isn't going to know what the store is.
>
> 23 +from store import *
>
> Do you need this line?
>
> 24 +import store
>
> It feels a bit odd using the store directory for this. What do you think
> about a new directory/submodule called 'add' or 'add_items' or something?
>
> 255 +abs_template_path = templatetools.get_template_path_from_project()
>
> This line causes an error when I do this in the toplevel of the quickly
> branch due to loadConfig() eventually being called with can_stop=True:
> PATH=./bin:$PATH quickly help ubuntu-application add
> --
> https://code.launchpad.net/~tony-badwolf/quickly/modular_add/+merge/40387
> You are the owner of lp:~tony-badwolf/quickly/modular_add.
>

=== modified file 'data/templates/ubuntu-application/add.py'
--- data/templates/ubuntu-application/add.py	2010-10-18 18:39:04 +0000
+++ data/templates/ubuntu-application/add.py	2010-11-12 00:33:04 +0000
@@ -16,10 +16,8 @@
 #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 os
 import sys
-import internal.quicklyutils as quicklyutils
-from quickly import configurationhandler, templatetools, commands
+from quickly import templatetools, commands
 
 import gettext
 from gettext import gettext as _
@@ -27,49 +25,34 @@
 gettext.textdomain('quickly')
 
 argv = sys.argv
-options = {'dialog': _('quickly add dialog <dialog-name>'),
-           'indicator': 'quickly add indicator'}
+
+from store import *
+import store
+
+addable = [x for x in dir(store) if x[0] != '_']
+
+options = {}
+for module in addable:
+    try:
+        options[module] = getattr(store, module).option
+    except AttributeError:
+        # ignore files in store that have no option for us
+        pass
 
 def usage():
     templatetools.print_usage(options.values())
+
 def help():
-    print _("""Add something to your project
-
-
-$ quickly add dialog <dialog-name>
-
-Here, dialog-name is one or more words separated with dash
-
-For instance $ quickly add dialog dialog-name will create:
-1. A subclass of gtk.Dialog called DialogNameDialog in the module
-   DialogNameDialog.py
-2. A glade file called DialogNameDialog.ui in the ui directory
-3. A catalog file called dialog_name_dialog.xml also in the ui directory
-
-To edit the UI for the dialog, run:
-$ quickly design
-
-To edit the behavior, run:
-$ quickly edit
-
-To use the dialog you have to invoke it from another python file:
-1. Import the dialog
-import DialogNameDialog
-
-2. Create an instance of the dialog
-dialog = DialogNameDialog.NewDialogNameDialog()
-
-3. Run the dialog and hide the dialog
-result = dialog.run()
-dialog.hide()
-
-
-$ quickly add indicator
-
-This will add support for Ubuntu Application Indicator to you quickly project.
-Next time you run your app, the Indicator will show up in the panel on top right.
-You can add/remove/modify items from the indicator menu by editing indicator.py
-""")
+    help_list = [_('Add something to your project\n')]
+    for module in addable:
+        try:
+            help_list.append(getattr(store, module).help_text)
+        except AttributeError:
+            # ignore files in store that have no help for us
+            pass
+    help_text = '\n\n'.join(help_list)
+    print help_text
+
 def shell_completion(argv):
     ''' Complete args '''
     # option completion
@@ -81,109 +64,13 @@
         print ' '.join(rv)
 templatetools.handle_additional_parameters(sys.argv, help, shell_completion, usage=usage)
 
-abs_template_path = templatetools.get_template_path_from_project()
-abs_command_path = os.path.abspath(os.path.dirname(sys.argv[0]))
-
-
 if len(sys.argv) < 2:
     cmd = commands.get_command('add', 'ubuntu-application')
-    templatetools.usage_error(_("No action name provided."), cmd=cmd, template='ubuntu-application')
-
-if argv[1] == "dialog":
-    if len(argv) != 3:
-        templatetools.print_usage(options['dialog'])
-        sys.exit(4)
-    else:
-        try:
-            dialog_name = templatetools.quickly_name(argv[2])
-        except templatetools.bad_project_name, e:
-            print(e)
-            sys.exit(1)
-
-        path_and_project = sys.argv[0].split('/')
-
-        if not configurationhandler.project_config:
-            configurationhandler.loadConfig()
-        project_name = configurationhandler.project_config['project']
-
-        template_ui_dir = os.path.join(abs_template_path, 'store', 'data', 'ui')
-        template_python_dir = os.path.join(abs_template_path, 'store', 'python')
-        # take files from command directory if don't exist
-        origin_ui_file_list = [os.path.join(template_ui_dir,
-                                            'dialog_camel_case_nameDialog.ui'),
-                               os.path.join(template_ui_dir,
-                                            'dialog_python_name_dialog.xml')]
-        python_file = os.path.join(template_ui_dir,
-                                   'dialog_camel_case_nameDialog.py')
-        if len([file_exist for file_exist in origin_ui_file_list if
-                os.path.isfile(file_exist)]) != len(origin_ui_file_list):
-            template_ui_dir = os.path.join(abs_command_path, 'store', 'data',
-                                           'ui')
-        if not os.path.isfile(python_file):
-            template_python_dir = os.path.join(abs_command_path, 'store',
-                                               'python')
-
-        target_ui_dir = os.path.join('data', 'ui')
-        python_name = templatetools.python_name(project_name)
-        target_python_dir = python_name
-
-        dialog_python_name = templatetools.python_name(dialog_name)
-        dialog_sentence_name, dialog_camel_case_name = \
-            quicklyutils.conventional_names(dialog_name)
-        project_sentence_name, project_camel_case_name = \
-            quicklyutils.conventional_names(project_name)
-        dialog_name = dialog_name.replace('-','_')
-
-        substitutions = (("project_name",project_name),
-                         ("dialog_name",dialog_name),
-                         ("dialog_python_name",dialog_python_name),
-                         ("dialog_camel_case_name",dialog_camel_case_name),
-                         ("project_camel_case_name",project_camel_case_name),
-                         ("project_sentence_name",project_sentence_name),
-                         ("dialog_sentence_name",dialog_sentence_name),
-                         ("python_name",python_name))
-
-        quicklyutils.file_from_template(template_ui_dir, 
-                                        "dialog_camel_case_nameDialog.ui", 
-                                        target_ui_dir, 
-                                        substitutions)
-
-        quicklyutils.file_from_template(template_ui_dir, 
-                                        "dialog_python_name_dialog.xml", 
-                                        target_ui_dir,
-                                        substitutions)
-
-        quicklyutils.file_from_template(template_python_dir, 
-                                        "dialog_camel_case_nameDialog.py", 
-                                        target_python_dir, 
-                                        substitutions)
-
-if argv[1] == "indicator":
-    if len(argv) != 2:
-        templatetools.print_usage(options['indicator'])
-        sys.exit(4)
-    else:
-
-        if not configurationhandler.project_config:
-            configurationhandler.loadConfig()
-        project_name = configurationhandler.project_config['project']
-
-        template_python_dir = os.path.join(abs_template_path, 'store', 'python')
-        # take files from command directory if don't exist
-        python_file = os.path.join(template_python_dir,
-                                   'indicator.py')
-        python_name = templatetools.python_name(project_name)
-        target_python_dir = python_name
-
-        project_sentence_name, project_camel_case_name = \
-            quicklyutils.conventional_names(project_name)
-
-        substitutions = (("project_name",project_name),
-                        ( "python_name",python_name))
-
-        quicklyutils.file_from_template(template_python_dir, 
-                                        "indicator.py", 
-                                        target_python_dir, 
-                                        substitutions)
-
-
+    templatetools.usage_error(_("Cannot add, no plugin name provided."), cmd=cmd, template='ubuntu-application')
+
+if argv[1] in addable:
+    getattr(store, argv[1]).add(options)
+else:
+    cmd = commands.get_command('add', 'ubuntu-application')
+    templatetools.usage_error(_('Cannot add, did not recognize plugin name: %s' % argv[1]), cmd=cmd, template='ubuntu-application')
+    sys.exit(4)

=== added file 'data/templates/ubuntu-application/store/__init__.py'
--- data/templates/ubuntu-application/store/__init__.py	1970-01-01 00:00:00 +0000
+++ data/templates/ubuntu-application/store/__init__.py	2010-11-12 00:33:04 +0000
@@ -0,0 +1,15 @@
+# -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-
+### BEGIN LICENSE
+# This file is in the public domain
+### END LICENSE
+
+import glob as _glob
+import os as _os
+
+_here = _os.path.dirname(__file__)
+_paths = _glob.glob(_os.path.join(_here, '*.py'))
+_filenames = [_os.path.basename(_x) for _x in _paths if _os.path.basename(_x)[0] != '_']
+_no_ext = [_os.path.splitext(_x) for _x in _filenames]
+
+__all__ = [_x[0] for _x in _no_ext]
+

=== added file 'data/templates/ubuntu-application/store/dialog.py'
--- data/templates/ubuntu-application/store/dialog.py	1970-01-01 00:00:00 +0000
+++ data/templates/ubuntu-application/store/dialog.py	2010-11-12 00:33:04 +0000
@@ -0,0 +1,125 @@
+# -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-
+# Copyright 2009 Didier Roche
+#
+# This file is part of Quickly ubuntu-application template
+#
+#This program is free software: you can redistribute it and/or modify it 
+#under the terms of the GNU General Public License version 3, as published 
+#by the Free Software Foundation.
+
+#This program is distributed in the hope that it will be useful, but 
+#WITHOUT ANY WARRANTY; without even the implied warranties of 
+#MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR 
+#PURPOSE.  See the GNU General Public License for more details.
+
+#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 os
+import sys
+argv = sys.argv
+
+import gettext
+from gettext import gettext as _
+# set domain text
+gettext.textdomain('quickly')
+
+import internal.quicklyutils as quicklyutils
+from quickly import configurationhandler, templatetools, commands
+
+option = 'quickly add dialog <dialog-name>'
+
+help_text= _("""Here, dialog-name is one or more words separated with dash
+
+For instance $ quickly add dialog dialog-name will create:
+1. A subclass of gtk.Dialog called DialogNameDialog in the module
+   DialogNameDialog.py
+2. A glade file called DialogNameDialog.ui in the ui directory
+3. A catalog file called dialog_name_dialog.xml also in the ui directory
+
+To edit the UI for the dialog, run:
+$ quickly design
+
+To edit the behavior, run:
+$ quickly edit
+
+To use the dialog you have to invoke it from another python file:
+1. Import the dialog
+import DialogNameDialog
+
+2. Create an instance of the dialog
+dialog = DialogNameDialog.NewDialogNameDialog()
+
+3. Run the dialog and hide the dialog
+result = dialog.run()
+dialog.hide()""")
+
+def add(options):
+    if len(argv) != 3:
+        templatetools.print_usage(options['dialog'])
+        sys.exit(4)
+
+    try:
+        dialog_name = templatetools.quickly_name(argv[2])
+    except templatetools.bad_project_name, e:
+        print(e)
+        sys.exit(1)
+
+    abs_template_path = templatetools.get_template_path_from_project()
+    abs_command_path = os.path.abspath(os.path.dirname(sys.argv[0]))
+
+    if not configurationhandler.project_config:
+        configurationhandler.loadConfig()
+    project_name = configurationhandler.project_config['project']
+
+    template_ui_dir = os.path.join(abs_template_path, 'store', 'data', 'ui')
+    template_python_dir = os.path.join(abs_template_path, 'store', 'python')
+    # take files from command directory if don't exist
+    origin_ui_file_list = [os.path.join(template_ui_dir,
+                                        'dialog_camel_case_nameDialog.ui'),
+                           os.path.join(template_ui_dir,
+                                        'dialog_python_name_dialog.xml')]
+    python_file = os.path.join(template_ui_dir,
+                               'dialog_camel_case_nameDialog.py')
+    if len([file_exist for file_exist in origin_ui_file_list if
+            os.path.isfile(file_exist)]) != len(origin_ui_file_list):
+        template_ui_dir = os.path.join(abs_command_path, 'store', 'data',
+                                       'ui')
+    if not os.path.isfile(python_file):
+        template_python_dir = os.path.join(abs_command_path, 'store',
+                                           'python')
+
+    target_ui_dir = os.path.join('data', 'ui')
+    python_name = templatetools.python_name(project_name)
+    target_python_dir = python_name
+
+    dialog_python_name = templatetools.python_name(dialog_name)
+    dialog_sentence_name, dialog_camel_case_name = \
+        quicklyutils.conventional_names(dialog_name)
+    project_sentence_name, project_camel_case_name = \
+        quicklyutils.conventional_names(project_name)
+    dialog_name = dialog_name.replace('-','_')
+
+    substitutions = (("project_name",project_name),
+                     ("dialog_name",dialog_name),
+                     ("dialog_python_name",dialog_python_name),
+                     ("dialog_camel_case_name",dialog_camel_case_name),
+                     ("project_camel_case_name",project_camel_case_name),
+                     ("project_sentence_name",project_sentence_name),
+                     ("dialog_sentence_name",dialog_sentence_name),
+                     ("python_name",python_name))
+
+    quicklyutils.file_from_template(template_ui_dir, 
+                                    "dialog_camel_case_nameDialog.ui", 
+                                    target_ui_dir, 
+                                    substitutions)
+
+    quicklyutils.file_from_template(template_ui_dir, 
+                                    "dialog_python_name_dialog.xml", 
+                                    target_ui_dir,
+                                    substitutions)
+
+    quicklyutils.file_from_template(template_python_dir, 
+                                    "dialog_camel_case_nameDialog.py", 
+                                    target_python_dir, 
+                                    substitutions)

=== added file 'data/templates/ubuntu-application/store/indicator.py'
--- data/templates/ubuntu-application/store/indicator.py	1970-01-01 00:00:00 +0000
+++ data/templates/ubuntu-application/store/indicator.py	2010-11-12 00:33:04 +0000
@@ -0,0 +1,68 @@
+# -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-
+# Copyright 2009 Didier Roche
+#
+# This file is part of Quickly ubuntu-application template
+#
+#This program is free software: you can redistribute it and/or modify it 
+#under the terms of the GNU General Public License version 3, as published 
+#by the Free Software Foundation.
+
+#This program is distributed in the hope that it will be useful, but 
+#WITHOUT ANY WARRANTY; without even the implied warranties of 
+#MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR 
+#PURPOSE.  See the GNU General Public License for more details.
+
+#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 os
+import sys
+argv = sys.argv
+
+import gettext
+from gettext import gettext as _
+# set domain text
+gettext.textdomain('quickly')
+
+import internal.quicklyutils as quicklyutils
+from quickly import configurationhandler, templatetools, commands
+
+option = 'quickly add indicator'
+
+help_text=_("""
+$ quickly add indicator
+
+This will add support for Ubuntu Application Indicator to you quickly project.
+Next time you run your app, the Indicator will show up in the panel on top right.
+You can add/remove/modify items from the indicator menu by editing indicator.py
+""")
+
+def add(options):
+    if len(argv) != 2:
+        templatetools.print_usage(options['indicator'])
+        sys.exit(4)
+
+    abs_template_path = templatetools.get_template_path_from_project()
+    abs_command_path = os.path.abspath(os.path.dirname(sys.argv[0]))
+
+    if not configurationhandler.project_config:
+        configurationhandler.loadConfig()
+    project_name = configurationhandler.project_config['project']
+
+    template_python_dir = os.path.join(abs_template_path, 'store', 'python')
+    # take files from command directory if don't exist
+    python_file = os.path.join(template_python_dir,
+                               'indicator.py')
+    python_name = templatetools.python_name(project_name)
+    target_python_dir = python_name
+
+    project_sentence_name, project_camel_case_name = \
+        quicklyutils.conventional_names(project_name)
+
+    substitutions = (("project_name",project_name),
+                    ( "python_name",python_name))
+
+    quicklyutils.file_from_template(template_python_dir, 
+                                    "indicator.py", 
+                                    target_python_dir, 
+                                    substitutions)

=== modified file 'data/templates/ubuntu-application/test/add.sh'
--- data/templates/ubuntu-application/test/add.sh	2010-10-15 20:26:19 +0000
+++ data/templates/ubuntu-application/test/add.sh	2010-11-12 00:33:04 +0000
@@ -12,7 +12,13 @@
 cd test-project
 
 quickly add
-# ERROR: No action name provided.
+# ERROR: Cannot add, no plugin name provided.
+# Usage:
+#   quickly add dialog <dialog-name>
+#   quickly add indicator
+
+quickly add foo
+# ERROR: Cannot add, did not recognize plugin name: foo
 # Usage:
 #   quickly add dialog <dialog-name>
 #   quickly add indicator