Merge lp:~thomas-e-zander/exaile/artist_strip into lp:exaile/0.3.3

[Thomas Zander]

Let users customize the list of "the"-like words they want to remove for artist sorting/grouping. The default list is now localizable.

[Johannes Sasongko (sjohannes)]

Rather than

+ default_list = ["el", "l'", "la", "le", "les", "los", "the"]
+ try:
+ (loc, enc) = getlocale()
+ if loc is None:
+ (loc, enc) = getdefaultlocale()
+ #TRANSLATORS: Alter default_list to appropriate content
+ if loc == 'de_DE':
+ default_list.extend(["der", "die", "das"])

I'd prefer it to be a translatable string that translators can override completely. Something like

  #TRANSLATORS: ...
  default_list = _("the ")

A translator can then translate that, e.g.

  "the" --> "le ;l';les "

This way, on locales where this kind of stripping doesn't make sense at all, it can be translated as

  "the" --> ""

review: Needs Fixing

[Johannes Sasongko (sjohannes)]

Sorry, the last two snippets should be:

  "the " --> "le ;l';les "

and

  "the " --> ""

[Thomas Zander (thomas-e-zander)]

On Tue, Sep 22, 2009 at 18:59, Johannes Sasongko <email address hidden> wrote:
> Sorry, the last two snippets should be:
>
>  "the " --> "le ;l';les "
>
> and
>
>  "the " --> ""

While an empty list is no problem in any implementation, your
suggestion of using a translatable string saves the
if-else-locale-compare tree. Nice!
I'll look into that. Thanks for the useful review.

[Johannes Sasongko (sjohannes)]

Approved. Thanks, Thomas.

review: Approve

=== added file 'data/ui/collection_prefs_pane.glade'
--- data/ui/collection_prefs_pane.glade	1970-01-01 00:00:00 +0000
+++ data/ui/collection_prefs_pane.glade	2009-10-04 12:45:21 +0000
@@ -0,0 +1,70 @@
+<?xml version="1.0"?>
+<interface>
+  <requires lib="gtk+" version="2.16"/>
+  <!-- interface-naming-policy project-wide -->
+  <object class="GtkWindow" id="prefs_window">
+    <child>
+      <object class="GtkVBox" id="prefs_pane">
+        <property name="visible">True</property>
+        <property name="border_width">3</property>
+        <child>
+          <object class="GtkHBox" id="box1">
+          <property name="visible">True</property>
+          <property name="border_width">0</property>
+          <child>
+            <object class="GtkLabel" id="strip_list_label">
+              <property name="label" translatable="yes">Strip these words from the beginnng of the artist tag (space separated):</property>
+              <property name="receives_default">False</property>
+              <property name="wrap">True</property>
+            </object>
+            <packing>
+              <property name="expand">False</property>
+              <property name="fill">False</property>
+              <property name="position">0</property>
+            </packing>
+          </child>
+          </object>
+          <packing>
+            <property name="expand">False</property>
+            <property name="fill">False</property>
+            <property name="position">0</property>
+          </packing>
+        </child>
+        <child>
+          <object class="GtkEntry" id="collection/strip_list">
+            <property name="receives_default">False</property>
+          </object>
+          <packing>
+            <property name="expand">False</property>
+            <property name="fill">False</property>
+            <property name="position">1</property>
+          </packing>
+        </child>
+        <child>
+          <object class="GtkLabel" id="collection/strip_list_label2">
+            <property name="label" translatable="yes">(Right click for reset to defaults)</property>
+            <property name="receives_default">False</property>
+          </object>
+          <packing>
+            <property name="expand">False</property>
+            <property name="fill">False</property>
+            <property name="position">2</property>
+          </packing>
+        </child>
+        <child>
+          <object class="GtkCheckButton" id="collection/file_based_compilations">
+            <property name="label" translatable="yes">Use file based compilation detection</property>
+            <property name="visible">True</property>
+            <property name="can_focus">True</property>
+            <property name="receives_default">False</property>
+          </object>
+          <packing>
+            <property name="expand">False</property>
+            <property name="fill">False</property>
+            <property name="position">3</property>
+          </packing>
+        </child>
+      </object>
+    </child>
+  </object>
+</interface>

=== modified file 'po/de.po'
--- po/de.po	2009-09-24 16:42:31 +0000
+++ po/de.po	2009-10-04 12:45:21 +0000
@@ -1160,6 +1160,10 @@
 msgid "Shortcut"
 msgstr "Tastenkürzel"
 
+#: ../xlgui/prefs/collection_prefs.py:27
+msgid "el l' la le les los the"
+msgstr "el l' la le les los the der die das"
+
 #: ../xlgui/tray.py:75
 msgid "Exaile Music Player"
 msgstr "Exaile Musikwiedergabe"

=== modified file 'xl/common.py'
--- xl/common.py	2009-09-08 18:29:32 +0000
+++ xl/common.py	2009-10-04 12:45:21 +0000
@@ -310,7 +310,10 @@
         sorting
     """
     lowered = field.lower()
-    for word in ("el ", "l'", "la ", "le ", "les ", "los ", "the "):
+    import settings
+    for word in settings.get_option('collection/strip_list', ''):
+        if not word.endswith("'"):
+            word += ' '
         if lowered.startswith(word):
             field = field[len(word):]
             break

=== modified file 'xlgui/prefs/__init__.py'
--- xlgui/prefs/__init__.py	2009-09-08 16:03:10 +0000
+++ xlgui/prefs/__init__.py	2009-10-04 12:45:21 +0000
@@ -33,7 +33,7 @@
 from xl import xdg
 from xl.settings import _SETTINGSMANAGER
 from xlgui.prefs.widgets import *
-from xlgui.prefs import playlists_prefs, osd_prefs
+from xlgui.prefs import playlists_prefs, osd_prefs, collection_prefs
 from xlgui.prefs import cover_prefs, playback_prefs, appearance_prefs
 from xlgui.prefs import plugin_prefs
 import logging, traceback, gobject
@@ -46,7 +46,7 @@
     """
 
     PAGES = (playlists_prefs, appearance_prefs, playback_prefs, 
-        osd_prefs, cover_prefs)
+        collection_prefs, osd_prefs, cover_prefs)
     PREFERENCES_DIALOG = None
 
     def __init__(self, parent, main):

=== added file 'xlgui/prefs/collection_prefs.py'
--- xlgui/prefs/collection_prefs.py	1970-01-01 00:00:00 +0000
+++ xlgui/prefs/collection_prefs.py	2009-10-04 12:45:21 +0000
@@ -0,0 +1,66 @@
+# Copyright (C) 2009 Thomas E. Zander
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 1, or (at your option)
+# any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY 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, write to the Free Software
+# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+
+from xlgui.prefs import widgets
+from xl import xdg
+from xl.nls import gettext as _
+from xlgui import commondialogs
+
+name = _('Collection')
+ui = xdg.get_data_path('ui/collection_prefs_pane.glade')
+
+def _get_default_strip_list():
+    #TRANSLATORS: Alter default_strip_list
+    default_strip_list = _("el l' la le les los the")
+    return [v.lower() for v in default_strip_list.split(' ') if v is not '']
+
+class CollectionStripArtistPreference(widgets.ListPrefsItem):
+    default = _get_default_strip_list()
+    name = 'collection/strip_list'
+
+    def __init__(self, prefs, widget):
+        widgets.ListPrefsItem.__init__(self, prefs, widget)
+        self.widget.connect('populate-popup', self._populate_popup_cb)
+
+    def _get_value(self):
+        """
+            Get the value, overrides the base class function
+            because we don't need shlex parsing. We actually
+            want values like "l'" here.
+        """
+        values = [v.lower() for v in self.widget.get_text().split(' ') if v is not '']
+        return values
+
+    def _populate_popup_cb(self, entry, menu):
+        import gtk
+        entry = gtk.MenuItem(_('Reset to defaults'))
+        entry.connect('activate', self._reset_to_defaults_cb)
+        entry.show()
+
+        sep = gtk.SeparatorMenuItem()
+        sep.show()
+
+        menu.attach(entry, 0, 1, 0, 1)
+        menu.attach(sep, 0, 1, 1, 2)
+
+    def _reset_to_defaults_cb(self, item):
+        self.widget.set_text(' '.join(_get_default_strip_list()))
+
+class FileBasedCompilationsPreference(widgets.CheckPrefsItem):
+    default = True
+    name = 'collection/file_based_compilations'
+
+# vim:ts=4 et sw=4

=== modified file 'xlgui/prefs/widgets.py'
--- xlgui/prefs/widgets.py	2009-09-06 17:55:16 +0000
+++ xlgui/prefs/widgets.py	2009-10-04 12:45:21 +0000
@@ -684,6 +684,7 @@
     def _get_value(self):
         # shlex is broken with unicode, so we feed it UTF-8 and decode
         # afterwards.
+        import shlex
         values = shlex.split(self.widget.get_text())
         values = [unicode(value, 'utf-8') for value in values]
         return values