Merge lp:~mtrovo/pomodoro-indicator/translation into lp:~marcosvanetta/pomodoro-indicator/master

[Moises Trovo]

Fixed bugs
#844079 - Pause menu button was starting another timer instead of pausing the existing one.
#842118 - Localisation with gettext added to project and a translation for Portuguese (Brazil) was added.

To test the code with a specific locale please set the LANGUAGE variable before running the pomodoro-indicator

$ LANGUAGE=pt_BR:pt
$ bin/pomodoro-indicator

To configure the project as translatable within launchpad please refer to this tutorial https://help.launchpad.net/Translations/YourProject.

If you need any help with the fixes or the project setup please contact me.

Regards.

[malev (marcosvanetta)]

I like it!

review: Approve (i18n)

[lp:~mtrovo/pomodoro-indicator/translation]

19. By Moises Trovo on 2011-09-24

merged with ~mtrovo/main branch

[Moises Trovo (mtrovo)]

This merge is available on trunk but I will need to change the directory structure so it works with Launchpad Translations.

=== added file '.bzrignore'
--- .bzrignore	1970-01-01 00:00:00 +0000
+++ .bzrignore	2011-09-24 16:35:25 +0000
@@ -0,0 +1,2 @@
+build
+.ninjaproject

=== removed file '.gitignore'
--- .gitignore	2011-08-14 23:09:33 +0000
+++ .gitignore	1970-01-01 00:00:00 +0000
@@ -1,6 +0,0 @@
-*.deb
-*.pyc
-*.mo
-*.po~
-debian/
-

=== added file 'msgfmt.py'
--- msgfmt.py	1970-01-01 00:00:00 +0000
+++ msgfmt.py	2011-09-24 16:35:25 +0000
@@ -0,0 +1,221 @@
+#! /usr/bin/env python
+# -*- coding: iso-8859-1 -*-
+# Written by Martin v. Löwis <[e-mail]>
+
+"""Generate binary message catalog from textual translation description.
+
+This program converts a textual Uniforum-style message catalog (.po file) into
+a binary GNU catalog (.mo file).  This is essentially the same function as the
+GNU msgfmt program, however, it is a simpler implementation.
+
+Usage: msgfmt.py [OPTIONS] filename.po
+
+Options:
+    -o file
+    --output-file=file
+        Specify the output file to write to.  If omitted, output will go to a
+        file named filename.mo (based off the input file name).
+
+    -h
+    --help
+        Print this message and exit.
+
+    -V
+    --version
+        Display version information and exit.
+"""
+
+import sys
+import os
+import getopt
+import struct
+import array
+
+__version__ = "1.1"
+
+MESSAGES = {}
+
+
+def usage(code, msg=''):
+    print >> sys.stderr, __doc__
+    if msg:
+        print >> sys.stderr, msg
+    sys.exit(code)
+
+
+def add(id, str, fuzzy):
+    "Add a non-fuzzy translation to the dictionary."
+    global MESSAGES
+    if not fuzzy and str:
+        MESSAGES[id] = str
+
+
+def generate():
+    "Return the generated output."
+    global MESSAGES
+    keys = MESSAGES.keys()
+    # the keys are sorted in the .mo file
+    keys.sort()
+    offsets = []
+    ids = strs = ''
+    for id in keys:
+        # For each string, we need size and file offset.  Each string is NUL
+        # terminated; the NUL does not count into the size.
+        offsets.append((len(ids), len(id), len(strs), len(MESSAGES[id])))
+        ids += id + '\0'
+        strs += MESSAGES[id] + '\0'
+    output = ''
+    # The header is 7 32-bit unsigned integers.  We don't use hash tables, so
+    # the keys start right after the index tables.
+    # translated string.
+    keystart = 7*4+16*len(keys)
+    # and the values start after the keys
+    valuestart = keystart + len(ids)
+    koffsets = []
+    voffsets = []
+    # The string table first has the list of keys, then the list of values.
+    # Each entry has first the size of the string, then the file offset.
+    for o1, l1, o2, l2 in offsets:
+        koffsets += [l1, o1+keystart]
+        voffsets += [l2, o2+valuestart]
+    offsets = koffsets + voffsets
+    output = struct.pack("Iiiiiii",
+                         0x950412deL,       # Magic
+                         0,                 # Version
+                         len(keys),         # # of entries
+                         7*4,               # start of key index
+                         7*4+len(keys)*8,   # start of value index
+                         0, 0)              # size and offset of hash table
+    output += array.array("i", offsets).tostring()
+    output += ids
+    output += strs
+    return output
+
+def make(filename, outfile):
+    ID = 1
+    STR = 2
+
+    # Compute .mo name from .po name and arguments
+    if filename.endswith('.po'):
+        infile = filename
+    else:
+        infile = filename + '.po'
+    if outfile is None:
+        outfile = os.path.splitext(infile)[0] + '.mo'
+
+    try:
+        lines = open(infile).readlines()
+    except IOError, msg:
+        print >> sys.stderr, msg
+        sys.exit(1)
+
+    section = None
+    fuzzy = 0
+
+    # Parse the catalog
+    lno = 0
+    for l in lines:
+        lno += 1
+        # If we get a comment line after a msgstr, this is a new entry
+        if l[0] == '#' and section == STR:
+            add(msgid, msgstr, fuzzy)
+            section = None
+            fuzzy = 0
+        # Record a fuzzy mark
+        if l[:2] == '#,' and 'fuzzy' in l:
+            fuzzy = 1
+        # Skip comments
+        if l[0] == '#':
+            continue
+        # Now we are in a msgid section, output previous section
+        if l.startswith('msgid') and not l.startswith('msgid_plural'):
+            if section == STR:
+                add(msgid, msgstr, fuzzy)
+            section = ID
+            l = l[5:]
+            msgid = msgstr = ''
+            is_plural = False
+        # This is a message with plural forms
+        elif l.startswith('msgid_plural'):
+            if section != ID:
+                print >> sys.stderr, 'msgid_plural not preceeded by msgid on %s:%d' %\
+                    (infile, lno)
+                sys.exit(1)
+            l = l[12:]
+            msgid += '\0' # separator of singular and plural
+            is_plural = True
+        # Now we are in a msgstr section
+        elif l.startswith('msgstr'):
+            section = STR
+            if l.startswith('msgstr['):
+                if not is_plural:
+                    print >> sys.stderr, 'plural without msgid_plural on %s:%d' %\
+                        (infile, lno)
+                    sys.exit(1)
+                l = l.split(']', 1)[1]
+                if msgstr:
+                    msgstr += '\0' # Separator of the various plural forms
+            else:
+                if is_plural:
+                    print >> sys.stderr, 'indexed msgstr required for plural on  %s:%d' %\
+                        (infile, lno)
+                    sys.exit(1)
+                l = l[6:]
+        # Skip empty lines
+        l = l.strip()
+        if not l:
+            continue
+        # XXX: Does this always follow Python escape semantics?
+        l = eval(l)
+        if section == ID:
+            msgid += l
+        elif section == STR:
+            msgstr += l
+        else:
+            print >> sys.stderr, 'Syntax error on %s:%d' % (infile, lno), \
+                  'before:'
+            print >> sys.stderr, l
+            sys.exit(1)
+    # Add last entry
+    if section == STR:
+        add(msgid, msgstr, fuzzy)
+
+    # Compute output
+    output = generate()
+
+    try:
+        open(outfile,"wb").write(output)
+    except IOError,msg:
+        print >> sys.stderr, msg
+
+
+def main():
+    try:
+        opts, args = getopt.getopt(sys.argv[1:], 'hVo:',
+                                   ['help', 'version', 'output-file='])
+    except getopt.error, msg:
+        usage(1, msg)
+
+    outfile = None
+    # parse options
+    for opt, arg in opts:
+        if opt in ('-h', '--help'):
+            usage(0)
+        elif opt in ('-V', '--version'):
+            print >> sys.stderr, "msgfmt.py", __version__
+            sys.exit(0)
+        elif opt in ('-o', '--output-file'):
+            outfile = arg
+    # do it
+    if not args:
+        print >> sys.stderr, 'No input file given'
+        print >> sys.stderr, "Try `msgfmt --help' for more information."
+        return
+
+    for filename in args:
+        make(filename, outfile)
+
+
+if __name__ == '__main__':
+    main()
+

=== added directory 'po'
=== added file 'po/pomodoro-indicator.pot'
--- po/pomodoro-indicator.pot	1970-01-01 00:00:00 +0000
+++ po/pomodoro-indicator.pot	2011-09-24 16:35:25 +0000
@@ -0,0 +1,65 @@
+# SOME DESCRIPTIVE TITLE.
+# Copyright (C) YEAR ORGANIZATION
+# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: PACKAGE VERSION\n"
+"POT-Creation-Date: 2011-09-08 15:25+BRT\n"
+"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language-Team: LANGUAGE <[e-mail]>\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=CHARSET\n"
+"Content-Transfer-Encoding: ENCODING\n"
+"Generated-By: pygettext.py 1.5\n"
+
+
+#: ../visual.py:49 ../visual.py:106
+msgid "Waiting"
+msgstr ""
+
+#: ../visual.py:50
+msgid "Working"
+msgstr ""
+
+#: ../visual.py:51
+msgid "Resting"
+msgstr ""
+
+#: ../visual.py:52
+msgid "Paused"
+msgstr ""
+
+#: ../visual.py:67
+msgid "Pomodoro"
+msgstr ""
+
+#: ../visual.py:75
+msgid "You should start working."
+msgstr ""
+
+#: ../visual.py:77
+msgid "You can take a break now."
+msgstr ""
+
+#: ../visual.py:110
+msgid "Start"
+msgstr ""
+
+#: ../visual.py:111
+msgid "Pause"
+msgstr ""
+
+#: ../visual.py:112
+msgid "Resume"
+msgstr ""
+
+#: ../visual.py:113
+msgid "Stop"
+msgstr ""
+
+#: ../visual.py:114
+msgid "Quit"
+msgstr ""
+

=== added directory 'po/pt_BR'
=== added file 'po/pt_BR.po'
--- po/pt_BR.po	1970-01-01 00:00:00 +0000
+++ po/pt_BR.po	2011-09-24 16:35:25 +0000
@@ -0,0 +1,66 @@
+# English translations for PACKAGE package.
+# Copyright (C) 2011 ORGANIZATION
+# Moises Trovo <[e-mail]>, 2011.
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: PACKAGE VERSION\n"
+"POT-Creation-Date: 2011-09-08 15:25+BRT\n"
+"PO-Revision-Date: 2011-09-08 15:26-0300\n"
+"Last-Translator: Moises Trovo <[e-mail]>\n"
+"Language-Team: English\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Generated-By: pygettext.py 1.5\n"
+"Language: en_US\n"
+"Plural-Forms: nplurals=2; plural=(n != 1);\n"
+
+#: ../visual.py:49 ../visual.py:106
+msgid "Waiting"
+msgstr "Aguardando"
+
+#: ../visual.py:50
+msgid "Working"
+msgstr "Trabalhando"
+
+#: ../visual.py:51
+msgid "Resting"
+msgstr "Descansando"
+
+#: ../visual.py:52
+msgid "Paused"
+msgstr "Pausado"
+
+#: ../visual.py:67
+msgid "Pomodoro"
+msgstr "Pomodoro"
+
+#: ../visual.py:75
+msgid "You should start working."
+msgstr "Você deve voltar a trabalhar."
+
+#: ../visual.py:77
+msgid "You can take a break now."
+msgstr "Você pode dar um intervalo agora."
+
+#: ../visual.py:110
+msgid "Start"
+msgstr "Iniciar"
+
+#: ../visual.py:111
+msgid "Pause"
+msgstr "Pausar"
+
+#: ../visual.py:112
+msgid "Resume"
+msgstr "Continuar"
+
+#: ../visual.py:113
+msgid "Stop"
+msgstr "Parar"
+
+#: ../visual.py:114
+msgid "Quit"
+msgstr "Sair"
+

=== added directory 'po/pt_BR/LC_MESSAGES'
=== added file 'po/pt_BR/LC_MESSAGES/pomodoro.mo'
Binary files po/pt_BR/LC_MESSAGES/pomodoro.mo	1970-01-01 00:00:00 +0000 and po/pt_BR/LC_MESSAGES/pomodoro.mo	2011-09-24 16:35:25 +0000 differ
=== modified file 'pomodoro/configuration.py'
--- pomodoro/configuration.py	2011-08-27 21:28:03 +0000
+++ pomodoro/configuration.py	2011-09-24 16:35:25 +0000
@@ -29,6 +29,7 @@
 """
 
 import os
+import gettext
 
 def base_directory():
     """Returns the base directory"""
@@ -40,3 +41,4 @@
 
 if __name__ == "__main__":
     print __doc__
+

=== modified file 'pomodoro/pomodoro_state.py'
--- pomodoro/pomodoro_state.py	2011-08-29 03:06:07 +0000
+++ pomodoro/pomodoro_state.py	2011-09-24 16:35:25 +0000
@@ -237,3 +237,4 @@
 
 if __name__ == "__main__":
     print __doc__
+

=== modified file 'pomodoro/visual.py'
--- pomodoro/visual.py	2011-08-29 03:06:07 +0000
+++ pomodoro/visual.py	2011-09-24 16:35:25 +0000
@@ -31,6 +31,13 @@
 import sys
 import pomodoro_state
 import configuration
+import gettext
+
+from gettext import gettext as _
+
+PROJECTNAME='pomodoro-indicator'
+gettext.bindtextdomain(PROJECTNAME)
+gettext.textdomain(PROJECTNAME)
 
 """
 Pomodoro's indicator
@@ -39,6 +46,7 @@
 # http://www.softicons.com/free-icons/food-drinks-icons/veggies-icons-by-icon-icon/tomato-icon
 
 class PomodoroOSDNotificator:
+
     def __init__(self):
         self.icon_directory = configuration.icon_directory()
 
@@ -52,7 +60,7 @@
         pynotify.init("icon-summary-body")
         message = self.generate_message(state)
         osd_box = pynotify.Notification(
-                "Pomodoro",
+                _("Pomodoro"),
                 message,
                 self.big_icon()
                 )
@@ -60,12 +68,17 @@
 
     def generate_message(self, status):
         if status == pomodoro_state.WORKING_STATE:
-            message = "You should start working."
+            message = _("You should start working.")
         elif status == pomodoro_state.RESTING_STATE:
-            message = "You can take a break now."
+            message = _("You can take a break now.")
         return message
 
 class PomodoroIndicator:
+    status_labels = {   pomodoro_state.WAITING_STATE: _('Waiting'),
+                        pomodoro_state.WORKING_STATE: _('Working'),
+                        pomodoro_state.RESTING_STATE: _('Resting'),
+                        pomodoro_state.PAUSED_STATE: _('Paused')}
+
     def __init__(self):
         self.pomodoro = pomodoro_state.PomodoroMachine()
         self.notificator = PomodoroOSDNotificator()
@@ -91,15 +104,15 @@
         self.menu = gtk.Menu()
         self.separator1 = gtk.SeparatorMenuItem()
         self.separator2 = gtk.SeparatorMenuItem()
-        self.current_state_item = gtk.MenuItem("Waiting")
+        self.current_state_item = gtk.MenuItem(_("Waiting"))
         self.timer_item = gtk.MenuItem("00:00")
 
         # Drawing buttons
-        self.start_item = gtk.MenuItem("Start")
-        self.pause_item = gtk.MenuItem("Pause")
-        self.resume_item = gtk.MenuItem("Resume")
-        self.stop_item = gtk.MenuItem("Stop")
-        self.quit_item = gtk.MenuItem("Quit")
+        self.start_item = gtk.MenuItem(_("Start"))
+        self.pause_item = gtk.MenuItem(_("Pause"))
+        self.resume_item = gtk.MenuItem(_("Resume"))
+        self.stop_item = gtk.MenuItem(_("Stop"))
+        self.quit_item = gtk.MenuItem(_("Quit"))
 
         self.state_visible_menu_items = {
             pomodoro_state.WAITING_STATE : [self.start_item],
@@ -154,7 +167,7 @@
 
     def change_status_menu_item_label(self):
         label = self.current_state_item.child
-        label.set_text(self.pomodoro.current_state().capitalize())
+        label.set_text(self.status_labels[self.pomodoro.current_state()])
 
     def change_timer_menu_item_label(self, next_label):
         label = self.timer_item.child
@@ -187,12 +200,12 @@
         self.redraw_menu()
 
     def pause(self, widget, data=None):
-        self.start_timer()
-        self.pomodoro.start()
+        self.stop_timer()
+        self.pomodoro.pause()
         self.redraw_menu()
 
     def resume(self, widget, data=None):
-        self.stop_timer()
+        self.start_timer()
         self.pomodoro.resume()
         self.redraw_menu()
 
@@ -205,7 +218,8 @@
         self.timer_id = gobject.timeout_add(1000, self.update_timer)
 
     def stop_timer(self):
-        gobject.source_remove(self.timer_id)
+        if self.timer_id != None:
+            gobject.source_remove(self.timer_id)
         self.timer_id = None
 
     def main(self):
@@ -216,3 +230,4 @@
 
 if __name__ == "__main__":
     print __doc__
+

=== modified file 'setup.py'
--- setup.py	2011-08-30 00:04:20 +0000
+++ setup.py	2011-09-24 16:35:25 +0000
@@ -31,14 +31,62 @@
     python-gobject       2.28.3-1ubuntu1.1
     python-notify        0.1.1-2build4
     python-gtk2-dev      0.1.1-2build4
+
 """
 
 
-import os
+import os, sys
+import msgfmt
+
+import gettext
+# hack to get locale base dir of machine
+BASE_LOCALE_DIR=gettext._default_localedir
 
 from distutils.command.install import install
+from distutils.command.build import build
 from distutils.core import setup
 
+from glob import glob
+
+PROJECTNAME='pomodoro-indicator'
+
+def list_message_files(suffix=".po"):
+    """Return list of all found message files and their intallation paths"""
+    _files = glob("po/*" + suffix)
+    _list = []
+    for _file in _files:
+        # basename (without extension) is a locale name
+        _locale = os.path.splitext(os.path.basename(_file))[0]
+        _list.append((_file, os.path.join(
+            _locale, "LC_MESSAGES", "%s.mo" % PROJECTNAME)))
+    return _list
+
+def check_manifest():
+    """Check that the files listed in the MANIFEST are present when the
+    source is unpacked.
+    """
+    try:
+        f = open('MANIFEST')
+    except:
+        print '\n*** SOURCE WARNING: The MANIFEST file is missing!'
+        return
+    try:
+        manifest = [l.strip() for l in f.readlines() if l.strip().find('#') != 0]
+    finally:
+        f.close()
+    err = [line for line in manifest if not os.path.exists(line)]
+    err.sort()
+    # ignore auto-generated files
+    if err == ['roundup-admin', 'roundup-demo', 'roundup-gettext',
+            'roundup-mailgw', 'roundup-server']:
+        err = []
+    if err:
+        n = len(manifest)
+        print '\n*** SOURCE WARNING: There are files missing (%d/%d found)!'%(
+            n-len(err), n)
+        print 'Missing:', '\nMissing: '.join(err)
+
+
 
 class CustomInstall(install):
     """Custom installation class on package files.
@@ -81,22 +129,52 @@
         # save this custom data dir to later change the scripts
         self._custom_data_dir = data_dir
 
-
-setup(
-    name = 'pomodoro-indicator',
-    version = '0.0.1',
-    license = 'GPL-3',
-    author = 'Marcos Vanetta',
-    author_email = '[e-mail]',
-    description = 'Pomodoro technique app indicator.',
-    long_description = 'Pomodoro technique app indicator',
-    url = 'https://github.com/malev/pomodoro-indicator',
-
-    packages = ["pomodoro"],
-    package_data = {"pomodoro": ["images/*.png"]},
-    scripts = ["bin/pomodoro-indicator"],
-
-    cmdclass = {
-        'install': CustomInstall,
-    }
-)
+class BuildProject(build):
+
+    def build_message_files(self):
+        """For each po/*.po, build .mo file in target locale directory"""
+        for (_src, _dst) in list_message_files():
+            _build_dst = os.path.join("build", 'locale', _dst)
+            self.mkpath(os.path.dirname(_build_dst))
+            self.announce("Compiling %s -> %s" % (_src, _build_dst))
+            msgfmt.make(_src, _build_dst)
+
+    def run(self):
+        check_manifest()
+        self.build_message_files()
+        build.run(self)
+
+
+def main():
+
+    installdatafiles = []
+    # add message files
+    for (_dist_file, _mo_file) in list_message_files():
+        realdir = os.path.split(os.path.dirname(_mo_file))
+        installdatafiles.append((os.path.join(BASE_LOCALE_DIR, *realdir),
+            [os.path.join("build", "locale", _mo_file)]))
+
+    setup(
+        name = PROJECTNAME,
+        version = '0.0.1',
+        license = 'GPL-3',
+        author = 'Marcos Vanetta',
+        author_email = '[e-mail]',
+        description = 'Pomodoro technique app indicator.',
+        long_description = 'Pomodoro technique app indicator',
+        url = 'https://github.com/malev/pomodoro-indicator',
+
+        packages = ["pomodoro"],
+        package_data = {"pomodoro": ["images/*.png", ]},
+        data_files = installdatafiles,
+        scripts = ["bin/pomodoro-indicator"],
+
+        cmdclass = {
+            'install': CustomInstall,
+            'build': BuildProject
+        }
+    )
+
+if __name__ == '__main__':
+    sys.exit(main())
+