Merge lp:~numerigraphe/openobject-addons/trunk-extra-city into lp:openobject-addons/extra-trunk

[Numérigraphe]

This branch contains a bit of refactoring to the city module:
- rename "zipcode" to "zip" and "location" to "city_id" for consistency
- bump version number to 2.0 to reflect the migration work needed
- use xpath for view inheritance

This branch also re-introduces changes I made to city in v5.0 & 6.0
- usable in countries without states
- uses "related" fields

[Numérigraphe (numerigraphe)]

I'm merging this myself, fault of any negative review.

=== modified file 'city/__openerp__.py'
--- city/__openerp__.py	2011-02-18 20:19:20 +0000
+++ city/__openerp__.py	2011-11-23 17:28:12 +0000
@@ -21,13 +21,13 @@
 #
 ##############################################################################
 {
-    "name" : "City-Helps to keep Homogenous address data in the Database",
-    "version" : "1.0",
+    "name" : "City-Helps to keep Homogeneous address data in the Database",
+    "version" : "2.0",
     "author" : "Pablo Rocandio",
-    "category" : "Generic Modules/Base",
+    "category" : "Hidden",
     "description": """Creates a model for storing cities
 Zip code, city, state and country fields are replaced with a location field in partner and partner contact forms.
-This module helps to keep homogenous address data in the database.""",
+This module helps to keep homogeneous address data in the database.""",
     "depends" : ["base"],
     "init_xml" : [],
     "update_xml" : [

=== modified file 'city/city.py'
--- city/city.py	2011-03-28 05:05:51 +0000
+++ city/city.py	2011-11-23 17:28:12 +0000
@@ -31,11 +31,15 @@
         if not len(ids):
             return []
         res = []
-        for line in self.browse(cr, uid, ids):
-            state = line.state_id.name
-            country = line.state_id.country_id.name
-            location = "%s %s, %s, %s" %(line.zipcode, line.name, state, country)
-            res.append((line['id'], location))
+        for line in self.browse(cr, uid, ids, context=context):
+            name = line.name
+            if line.zip:
+                name = "%s %s" % (line.zip, name)
+            if line.state_id:
+                name = "%s, %s" % (name, line.state_id.name)
+            if line.country_id:
+                name = "%s, %s" % (name, line.country_id.name)
+            res.append((line['id'], name))
         return res
 
     def name_search(self, cr, uid, name, args=None, operator='ilike', context=None, limit=100):
@@ -45,7 +49,7 @@
             context = {}
         ids = []
         if name:
-            ids = self.search(cr, uid, [('zipcode', 'ilike', name)]+ args, limit=limit)
+            ids = self.search(cr, uid, [('zip', 'ilike', name)]+ args, limit=limit)
         if not ids:
             ids = self.search(cr, uid, [('name', operator, name)]+ args, limit=limit)
         return self.name_get(cr, uid, ids, context=context)
@@ -53,9 +57,13 @@
     _name = 'city.city'
     _description = 'City'
     _columns = {
-        'state_id': fields.many2one('res.country.state', 'State', required=True, select=1),
+        'state_id': fields.many2one('res.country.state', 'State',
+            domain="[('country_id','=',country_id)]", select=1),
         'name': fields.char('City', size=64, required=True, select=1),
-        'zipcode': fields.char('ZIP', size=64, required=True, select=1),
+        'zip': fields.char('ZIP', size=64, required=True, select=1),
+        'country_id': fields.many2one('res.country', 'Country', select=1),
+        'code': fields.char('City Code', size=64,
+            help="The official code for the city"),
     }
 city()
 
@@ -70,117 +78,17 @@
 
 class res_partner_address(osv.osv):
     _inherit = "res.partner.address"
-
-    def _get_zip(self, cr, uid, ids, field_name, arg, context):
-        res={}
-        for obj in self.browse(cr,uid,ids):
-            if obj.location:
-                res[obj.id] = obj.location.zipcode
-            else:
-                res[obj.id] = ""
-        return res
-
-    def _zip_search(self, cr, uid, obj, name, args, context):
-        if not len(args):
-            return []
-        new_args = []
-        for argument in args:
-            operator = argument[1]
-            value = argument[2]
-            ids = self.pool.get('city.city').search(cr, uid, [('zipcode',operator,value)], context=context)
-            new_args.append( ('location','in',ids) )
-        if new_args:
-            # We need to ensure that locatio is NOT NULL. Otherwise all addresses
-            # that have no location will 'match' current search pattern.
-            new_args.append( ('location','!=',False) )
-        return new_args
-
-    def _get_city(self, cr, uid, ids, field_name, arg, context):
-        res={}
-        for obj in self.browse(cr,uid,ids):
-            if obj.location:
-                res[obj.id] = obj.location.name
-            else:
-                res[obj.id] = ""
-        return res
-
-    def _city_search(self, cr, uid, obj, name, args, context):
-        if not len(args):
-            return []
-        new_args = []
-        for argument in args:
-            operator = argument[1]
-            value = argument[2]
-            ids = self.pool.get('city.city').search(cr, uid, [('name',operator,value)], context=context)
-            new_args.append( ('location','in',ids) )
-        if new_args:
-            # We need to ensure that locatio is NOT NULL. Otherwise all addresses
-            # that have no location will 'match' current search pattern.
-            new_args.append( ('location','!=',False) )
-        return new_args
-
-    def _get_state(self, cr, uid, ids, field_name, arg, context):
-        res={}
-        for obj in self.browse(cr,uid,ids):
-            if obj.location:
-                res[obj.id] = [obj.location.state_id.id, obj.location.state_id.name]
-            else:
-                res[obj.id] = False
-        return res
-
-    def _state_id_search(self, cr, uid, obj, name, args, context):
-        if not len(args):
-            return []
-        new_args = []
-        for argument in args:
-            operator = argument[1]
-            value = argument[2]
-            ids = self.pool.get('city.city').search(cr, uid, [('state_id',operator,value)], context=context)
-            new_args.append( ('location','in',ids) )
-        if new_args:
-            # We need to ensure that locatio is NOT NULL. Otherwise all addresses
-            # that have no location will 'match' current search pattern.
-            new_args.append( ('location','!=',False) )
-        return new_args
-
-    def _get_country(self, cr, uid, ids, field_name, arg, context):
-        res={}
-        for obj in self.browse(cr,uid,ids):
-            if obj.location:
-                res[obj.id] = [obj.location.state_id.country_id.id, obj.location.state_id.country_id.name]
-            else:
-                res[obj.id] = False
-        return res
-
-    def _country_id_search(self, cr, uid, obj, name, args, context):
-        if not len(args):
-            return []
-        new_args = []
-        for argument in args:
-            operator = argument[1]
-            value = argument[2]
-            ids = self.pool.get('res.country.state').search(cr, uid, [('country_id',operator,value)], context=context)
-            address_ids = []
-            for country in self.pool.get('res.country.state').browse(cr, uid, ids, context):
-                ids += [city.id for city in country.city_ids]
-            new_args.append( ('location','in',tuple(ids)) )
-        if new_args:
-            # We need to ensure that locatio is NOT NULL. Otherwise all addresses
-            # that have no location will 'match' current search pattern.
-            new_args.append( ('location','!=',False) )
-        return new_args
-
     _columns = {
-        'location': fields.many2one('city.city', 'Location'),
-        'zip': fields.function(_get_zip, fnct_search=_zip_search, method=True, type="char", string='Zip', size=24),
-        'city': fields.function(_get_city, fnct_search=_city_search, method=True, type="char", string='City', size=128),
-        'state_id': fields.function(_get_state, fnct_search=_state_id_search, obj="res.country.state", method=True, type="many2one", string='State'),
-        'country_id': fields.function(_get_country, fnct_search=_country_id_search, obj="res.country" ,method=True, type="many2one", string='Country'),
+        'city_id': fields.many2one('city.city', 'Location', select=1),
+        'zip': fields.related('city_id', 'zip', type="char", string="Zip",
+                               store=False),
+        'city': fields.related('city_id', 'name', type="char", string="City",
+                               store=False),
+        'state_id': fields.related('city_id', 'state_id', type="many2one",
+                                   relation="res.country.state", string="State",
+                                   store=False),
+        'country_id': fields.related('city_id', 'country_id', type="many2one",
+                                     relation="res.country", string="Country",
+                                     store=False),
     }
 res_partner_address()
-
-
-
-
-
-

=== modified file 'city/city_view.xml'
--- city/city_view.xml	2011-02-18 20:19:20 +0000
+++ city/city_view.xml	2011-11-23 17:28:12 +0000
@@ -2,146 +2,58 @@
 <openerp>
     <data>
 
-<!-- Partner -->
-    <record model="ir.ui.view" id="partners_form_add_location">
-        <field name="name">partners_form_add_location</field>
-        <field name="model">res.partner</field>
-        <field name="inherit_id" ref="base.view_partner_form"/>
-        <field name="arch" type="xml">
-            <field name="country_id" position="replace">
-                <field name="location" colspan="4" />
-            </field>
-        </field>
-    </record>
-
-    <record model="ir.ui.view" id="partners_form_del_city">
-        <field name="name">partners_form_del_city</field>
-        <field name="model">res.partner</field>
-        <field name="inherit_id" ref="base.view_partner_form"/>
-        <field name="arch" type="xml">
-            <field name="city" position="replace"/>
-        </field>
-    </record>
-
-    <!-- We need to city replaces to remove it -->
-    <record model="ir.ui.view" id="partners_form_del_citycity">
-        <field name="name">partners_form_del_citycity</field>
-        <field name="model">res.partner</field>
-        <field name="inherit_id" ref="base.view_partner_form"/>
-        <field name="arch" type="xml">
-            <field name="city" position="replace"/>
-        </field>
-    </record>
-
-    <record model="ir.ui.view" id="partners_form_del_zip">
-        <field name="name">partners_form_del_zip</field>
-        <field name="model">res.partner</field>
-        <field name="inherit_id" ref="base.view_partner_form"/>
-        <field name="arch" type="xml">
-            <field name="zip" position="replace"/>
-        </field>
-    </record>
-
-    <record model="ir.ui.view" id="partners_form_del_state">
-        <field name="name">partners_form_del_state</field>
-        <field name="model">res.partner</field>
-        <field name="inherit_id" ref="base.view_partner_form"/>
-        <field name="arch" type="xml">
-            <field name="state_id" position="replace"/>
-        </field>
-    </record>
-
-
-<!-- Partner Address 1 -->
-    <record model="ir.ui.view" id="partners_form_add_location1">
-        <field name="name">partners_form_add_location1</field>
-        <field name="model">res.partner.address</field>
-        <field name="inherit_id" ref="base.view_partner_address_form1"/>
-        <field name="arch" type="xml">
-            <field name="state_id" position="replace">
-                <field name="location" colspan="4" />
-            </field>
-        </field>
-    </record>
-
-    <record model="ir.ui.view" id="partners_form_del_city1">
-        <field name="name">partners_form_del_city1</field>
-        <field name="model">res.partner.address</field>
-        <field name="inherit_id" ref="base.view_partner_address_form1"/>
-        <field name="arch" type="xml">
-            <field name="city" position="replace">
-            </field>
-        </field>
-    </record>
-
-    <record model="ir.ui.view" id="partners_form_del_zip1">
-        <field name="name">partners_form_del_zip1</field>
-        <field name="model">res.partner.address</field>
-        <field name="inherit_id" ref="base.view_partner_address_form1"/>
-        <field name="arch" type="xml">
-            <field name="zip" position="replace">
-            </field>
-        </field>
-    </record>
-
-    <record model="ir.ui.view" id="partners_form_del_country1">
-        <field name="name">partners_form_del_country1</field>
-        <field name="model">res.partner.address</field>
-        <field name="inherit_id" ref="base.view_partner_address_form1"/>
-        <field name="arch" type="xml">
-            <field name="country_id" position="replace">
-            </field>
-        </field>
-    </record>
-
-
-<!-- Partner Address 2 -->
-    <record model="ir.ui.view" id="partners_form_add_location2">
-        <field name="name">partners_form_add_location2</field>
-        <field name="model">res.partner.address</field>
-        <field name="inherit_id" ref="base.view_partner_address_form2"/>
-        <field name="arch" type="xml">
-            <field name="state_id" position="replace">
-                <field name="location" colspan="4" />
-            </field>
-        </field>
-    </record>
-
-    <record model="ir.ui.view" id="partners_form_del_city2">
-        <field name="name">partners_form_del_city2</field>
-        <field name="model">res.partner.address</field>
-        <field name="inherit_id" ref="base.view_partner_address_form2"/>
-        <field name="arch" type="xml">
-            <field name="city" position="replace">
-            </field>
-        </field>
-    </record>
-
-    <record model="ir.ui.view" id="partners_form_del_zip2">
-        <field name="name">partners_form_del_zip2</field>
-        <field name="model">res.partner.address</field>
-        <field name="inherit_id" ref="base.view_partner_address_form2"/>
-        <field name="arch" type="xml">
-            <field name="zip" position="replace">
-            </field>
-        </field>
-    </record>
-
-    <record model="ir.ui.view" id="partners_form_del_country2">
-        <field name="name">partners_form_del_country2</field>
-        <field name="model">res.partner.address</field>
-        <field name="inherit_id" ref="base.view_partner_address_form2"/>
-        <field name="arch" type="xml">
-            <field name="country_id" position="replace">
-            </field>
-        </field>
-    </record>
-
-
-        <!--
-        State
-        -->
-
+    <!-- Add location to the Partner form -->
+    <record model="ir.ui.view" id="view_partner_form_city">
+        <field name="name">res.partner.form.city</field>
+        <field name="model">res.partner</field>
+        <field name="inherit_id" ref="base.view_partner_form"/>
+        <field name="arch" type="xml">
+            <data>
+                <xpath expr="//field[@name='address']//field[@name='city']" position="replace">
+                    <field name="city_id" colspan="4" />
+                </xpath>
+                <xpath expr="//field[@name='address']//field[@name='country_id']" position="replace"/>
+                <xpath expr="//field[@name='address']//field[@name='zip']" position="replace"/>
+                <xpath expr="//field[@name='address']//field[@name='state_id']" position="replace"/>
+            </data>
+        </field>
+    </record>
+
+    <!-- Add location to the Partner Address form 1 -->
+    <record model="ir.ui.view" id="view_partner_address_form1_city">
+        <field name="name">res.partner.address.form1.city</field>
+        <field name="model">res.partner.address</field>
+        <field name="inherit_id" ref="base.view_partner_address_form1"/>
+        <field name="arch" type="xml">
+            <data>
+                <xpath expr="//field[@name='city']" position="replace">
+                    <field name="city_id" colspan="4" />
+                </xpath>
+                <xpath expr="//field[@name='country_id']" position="replace"/>
+                <xpath expr="//field[@name='zip']" position="replace"/>
+                <xpath expr="//field[@name='state_id']" position="replace"/>
+            </data>
+        </field>
+    </record>
+
+    <!-- Add location to the Partner Address form 2 -->
+    <record model="ir.ui.view" id="view_partner_address_form2_city">
+        <field name="name">res.partner.address.form2.city</field>
+        <field name="model">res.partner.address</field>
+        <field name="inherit_id" ref="base.view_partner_address_form2"/>
+        <field name="arch" type="xml">
+            <data>
+                <xpath expr="//field[@name='city']" position="replace">
+                    <field name="city_id" colspan="4" />
+                </xpath>
+                <xpath expr="//field[@name='country_id']" position="replace"/>
+                <xpath expr="//field[@name='zip']" position="replace"/>
+                <xpath expr="//field[@name='state_id']" position="replace"/>
+            </data>
+        </field>
+    </record>
+
+    <!-- Add cities to the State form -->
     <record model="ir.ui.view" id="view_country_state_form2">
         <field name="name">view_country_state_form2</field>
         <field name="model">res.country.state</field>
@@ -153,20 +65,17 @@
         </field>
     </record>
 
-
-        <!--
-        City
-        -->
-
+    <!-- City -->
     <record model="ir.ui.view" id="view_city_tree">
         <field name="name">city.city.tree</field>
         <field name="model">city.city</field>
         <field name="type">tree</field>
         <field name="arch" type="xml">
             <tree string="City">
-                <field name="zipcode"/>
+                <field name="zip"/>
                 <field name="name"/>
                 <field name="state_id"/>
+                <field name="country_id"/>
             </tree>
         </field>
     </record>
@@ -177,9 +86,11 @@
         <field name="type">form</field>
         <field name="arch" type="xml">
             <form string="City">
-                <field name="zipcode" select="1"/>
+                <field name="zip" select="1"/>
                 <field name="name" select="1"/>
+                <field name="country_id" />
                 <field name="state_id" select="1"/>
+                <field name="code" select="2"/>
             </form>
         </field>
     </record>

=== modified file 'city/i18n/bg.po'
--- city/i18n/bg.po	2011-11-10 05:13:15 +0000
+++ city/i18n/bg.po	2011-11-23 17:28:12 +0000
@@ -72,7 +72,7 @@
 msgstr "Име на град"
 
 #. module: city
-#: field:res.partner.address,location:0
+#: field:res.partner.address,city_id:0
 msgid "Location"
 msgstr "Местоположение"
 

=== modified file 'city/i18n/ca.po'
--- city/i18n/ca.po	2011-11-10 05:13:15 +0000
+++ city/i18n/ca.po	2011-11-23 17:28:12 +0000
@@ -39,7 +39,7 @@
 "especial !"
 
 #. module: city
-#: field:city.city,zipcode:0
+#: field:city.city,zip:0
 msgid "ZIP"
 msgstr "Codi postal"
 
@@ -78,7 +78,7 @@
 msgstr "Nom de la ciutat"
 
 #. module: city
-#: field:res.partner.address,location:0
+#: field:res.partner.address,city_id:0
 msgid "Location"
 msgstr "Ubicació"
 

=== modified file 'city/i18n/city.pot'
--- city/i18n/city.pot	2010-07-06 05:10:58 +0000
+++ city/i18n/city.pot	2011-11-23 17:28:12 +0000
@@ -34,7 +34,7 @@
 msgstr ""
 
 #. module: city
-#: field:city.city,zipcode:0
+#: field:city.city,zip:0
 msgid "ZIP"
 msgstr ""
 
@@ -66,7 +66,7 @@
 msgstr ""
 
 #. module: city
-#: field:res.partner.address,location:0
+#: field:res.partner.address,city_id:0
 msgid "Location"
 msgstr ""
 

=== modified file 'city/i18n/es.po'
--- city/i18n/es.po	2011-11-10 05:13:15 +0000
+++ city/i18n/es.po	2011-11-23 17:28:12 +0000
@@ -78,7 +78,7 @@
 msgstr "Nombre de la ciudad"
 
 #. module: city
-#: field:res.partner.address,location:0
+#: field:res.partner.address,city_id:0
 msgid "Location"
 msgstr "Ubicación"
 

=== modified file 'city/i18n/fi.po'
--- city/i18n/fi.po	2011-11-10 05:13:15 +0000
+++ city/i18n/fi.po	2011-11-23 17:28:12 +0000
@@ -72,7 +72,7 @@
 msgstr "Kaupungin nimi"
 
 #. module: city
-#: field:res.partner.address,location:0
+#: field:res.partner.address,city_id:0
 msgid "Location"
 msgstr "Sijainti"
 

=== modified file 'city/i18n/fr.po'
--- city/i18n/fr.po	2011-11-10 05:13:15 +0000
+++ city/i18n/fr.po	2011-11-23 17:28:12 +0000
@@ -38,7 +38,7 @@
 "spéciaux !"
 
 #. module: city
-#: field:city.city,zipcode:0
+#: field:city.city,zip:0
 msgid "ZIP"
 msgstr "Code postal"
 
@@ -77,7 +77,7 @@
 msgstr "Nom de la ville"
 
 #. module: city
-#: field:res.partner.address,location:0
+#: field:res.partner.address,city_id:0
 msgid "Location"
 msgstr "Localisation"
 

=== modified file 'city/i18n/fr_BE.po'
--- city/i18n/fr_BE.po	2010-07-06 05:10:58 +0000
+++ city/i18n/fr_BE.po	2011-11-23 17:28:12 +0000
@@ -34,7 +34,7 @@
 msgstr "Le nom de l'objet doit commencer avec x_ et ne pas contenir de charactères spéciaux !"
 
 #. module: city
-#: field:city.city,zipcode:0
+#: field:city.city,zip:0
 msgid "ZIP"
 msgstr "Code postal"
 
@@ -68,7 +68,7 @@
 msgstr "Nom de la ville"
 
 #. module: city
-#: field:res.partner.address,location:0
+#: field:res.partner.address,city_id:0
 msgid "Location"
 msgstr "Localisation"
 

=== modified file 'city/i18n/ru.po'
--- city/i18n/ru.po	2011-11-10 05:13:15 +0000
+++ city/i18n/ru.po	2011-11-23 17:28:12 +0000
@@ -39,7 +39,7 @@
 "символов!"
 
 #. module: city
-#: field:city.city,zipcode:0
+#: field:city.city,zip:0
 msgid "ZIP"
 msgstr "Почтовый индекс"
 
@@ -73,7 +73,7 @@
 msgstr "Название города"
 
 #. module: city
-#: field:res.partner.address,location:0
+#: field:res.partner.address,city_id:0
 msgid "Location"
 msgstr "Расположение"
 

=== modified file 'city/i18n/sv.po'
--- city/i18n/sv.po	2011-11-10 05:13:15 +0000
+++ city/i18n/sv.po	2011-11-23 17:28:12 +0000
@@ -36,7 +36,7 @@
 msgstr ""
 
 #. module: city
-#: field:city.city,zipcode:0
+#: field:city.city,zip:0
 msgid "ZIP"
 msgstr "Postnummer"
 
@@ -70,7 +70,7 @@
 msgstr "Stadens namn"
 
 #. module: city
-#: field:res.partner.address,location:0
+#: field:res.partner.address,city_id:0
 msgid "Location"
 msgstr "Plats"
 

=== modified file 'city/i18n/vi.po'
--- city/i18n/vi.po	2011-11-10 05:13:15 +0000
+++ city/i18n/vi.po	2011-11-23 17:28:12 +0000
@@ -39,7 +39,7 @@
 "nào!"
 
 #. module: city
-#: field:city.city,zipcode:0
+#: field:city.city,zip:0
 msgid "ZIP"
 msgstr "Mã bưu chính"
 
@@ -73,7 +73,7 @@
 msgstr "Tên Thành phố"
 
 #. module: city
-#: field:res.partner.address,location:0
+#: field:res.partner.address,city_id:0
 msgid "Location"
 msgstr "Địa điểm"