Merge lp:~mvo/software-center/display-price-property into lp:software-center

[Michael Vogt]

This is another branch for the unity people, it will include the currency
in the "price" property. In addition there is a new "raw_price" property
that can be used as a sort key and that will not include currency data.

[Gary Lasker (gary-lasker)]

This looks fine. Thanks for the unit test!

review: Approve

=== modified file 'softwarecenter/db/application.py'
--- softwarecenter/db/application.py	2012-08-15 14:11:19 +0000
+++ softwarecenter/db/application.py	2012-08-17 09:01:23 +0000
@@ -531,7 +531,7 @@
                           u"current software sources.")) % utf8(self.pkgname)
                     return PkgStates.NOT_FOUND
             else:
-                if self.price:
+                if self.raw_price:
                     return PkgStates.NEEDS_PURCHASE
                 if (self.purchase_date and
                     self._doc.get_value(XapianValues.ARCHIVE_DEB_LINE)):
@@ -568,15 +568,35 @@
 
     @property
     def currency(self):
-        if self.price:
+        """ Get the currency for the price """
+        if self.raw_price:
             # this is hardcoded to US dollar for now, but if the server
             # ever changes that we are prepared
             return "US$"
 
     @property
+    def raw_price(self):
+        """ The raw price, useful for e.g. sort-by """
+        if self._doc:
+            return self._doc.get_value(XapianValues.PRICE)
+
+    @property
     def price(self):
-        if self._doc:
-            return self._doc.get_value(XapianValues.PRICE)
+        """ The price and the currency ready to display to the user """
+        raw_price = self.raw_price
+        currency = self.currency
+        if raw_price and currency:
+            # FIXME:  need to determine the currency dynamically once we can
+            #         get that info from the software-center-agent/payments
+            #         service.
+            # NOTE:  the currency string for this label is purposely not
+            #        translatable when hardcoded, since it (currently)
+            #        won't vary based on locale and as such we don't want
+            #        it translated
+            # FIXME: if we support different currencies eventually we need
+            #        to format them here differently too, e.g. 
+            #        "US$ 1" but "1EUR"
+            return "%s %s" % (currency, raw_price)
 
     @property
     def supported_distros(self):
 
=== modified file 'softwarecenter/ui/gtk3/models/appstore2.py'
--- softwarecenter/ui/gtk3/models/appstore2.py	2012-08-15 14:11:19 +0000
+++ softwarecenter/ui/gtk3/models/appstore2.py	2012-08-17 09:01:23 +0000
@@ -213,13 +213,10 @@
                  GObject.markup_escape_text(appname),
                  GObject.markup_escape_text(summary))
 
-    def get_price(self, doc):
-        return doc.get_value(XapianValues.PRICE)
-
-    def get_currency(self, doc):
+    def get_display_price(self, doc):
         app = self.db.get_application(doc)
         details = app.get_details(self.db)
-        return details.currency
+        return details.price
 
     def get_icon(self, doc):
         try:
 
=== modified file 'softwarecenter/ui/gtk3/views/appdetailsview.py'
--- softwarecenter/ui/gtk3/views/appdetailsview.py	2012-08-16 14:44:29 +0000
+++ softwarecenter/ui/gtk3/views/appdetailsview.py	2012-08-17 09:01:23 +0000
@@ -365,14 +365,7 @@
             elif state == PkgStates.INSTALLED:
                 self.set_button_label(_('Remove'))
         elif state == PkgStates.NEEDS_PURCHASE:
-            # FIXME:  need to determine the currency dynamically once we can
-            #         get that info from the software-center-agent/payments
-            #         service.
-            # NOTE:  the currency string for this label is purposely not
-            #        translatable when hardcoded, since it (currently)
-            #        won't vary based on locale and as such we don't want
-            #        it translated
-            self.set_label("%s %s" % (app_details.currency, app_details.price))
+            self.set_label("%s" % (app_details.price))
             if (app_details.hardware_requirements_satisfied and
                 app_details.region_requirements_satisfied):
                 self.set_button_label(_(u'Buy\u2026'))
 
=== modified file 'softwarecenter/ui/gtk3/widgets/cellrenderers.py'
--- softwarecenter/ui/gtk3/widgets/cellrenderers.py	2012-08-15 14:11:19 +0000
+++ softwarecenter/ui/gtk3/widgets/cellrenderers.py	2012-08-17 09:01:23 +0000
@@ -123,8 +123,7 @@
 
     def _render_price(self, context, cr, app, layout, cell_area, xpad, ypad,
         is_rtl):
-        layout.set_markup("%s %s" % (
-                self.model.get_currency(app), self.model.get_price(app)), -1)
+        layout.set_markup("%s" % self.model.get_display_price(app))
 
         if is_rtl:
             x = cell_area.x + xpad
 
=== modified file 'tests/gtk3/test_appdetailsview.py'
--- tests/gtk3/test_appdetailsview.py	2012-08-17 08:06:50 +0000
+++ tests/gtk3/test_appdetailsview.py	2012-08-17 09:01:23 +0000
@@ -82,8 +82,8 @@
         # create mock app
         self.set_mock_app_and_details(
             app_name="abiword", purchase_date="2011-11-20 17:45:01",
-            _error_not_found="error not found", price="1.00",
-            currency="US$", pkgname="abiword", error="error-text")
+            _error_not_found="error not found", price="US$ 1.00",
+            pkgname="abiword", error="error-text")
         mock_app = self.view.app
         mock_details = self.view.app_details
 
 
=== added file 'tests/test_application.py'
--- tests/test_application.py	1970-01-01 00:00:00 +0000
+++ tests/test_application.py	2012-08-17 09:01:23 +0000
@@ -0,0 +1,42 @@
+import unittest
+
+from mock import (
+    patch,
+    Mock,
+    )
+
+from tests.utils import (
+    setup_test_env,
+    get_test_db,
+)
+setup_test_env()
+from softwarecenter.db.application import (
+    Application,
+    AppDetails,
+    )
+
+
+# FIXME: move application/appdetails tests from test_database.py
+#        into this file for better structure
+class ApplicationTestCase(unittest.TestCase):
+
+    def test_application_name(self):
+        app1 = Application(appname="The AppName", pkgname="pkgapp")
+        self.assertEqual(app1.name, "The AppName")
+        app2 = Application(appname="", pkgname="pkgapp2")
+        self.assertEqual(app2.name, "pkgapp2")
+
+    def test_appdetails(self):
+        app = Application("Foo app", "dpkg")
+        db = get_test_db()
+        appdetails = app.get_details(db)
+        # patching properties is a bit cumbersome
+        with patch.object(AppDetails, "raw_price") as mock_price:
+            with patch.object(AppDetails, "currency") as mock_currency:
+                mock_price.__get__ = Mock(return_value="2.99")
+                mock_currency.__get__ = Mock(return_value="USD")
+                self.assertEqual("USD 2.99", appdetails.price)
+
+
+if __name__ == "__main__":
+    unittest.main()