From b46172da9b00d224a327da64b2168e648b4a0717 Mon Sep 17 00:00:00 2001
From: Victor Shnayder <victor@mitx.mit.edu>
Date: Fri, 3 Aug 2012 11:36:54 -0400
Subject: [PATCH] Rename module.name and descriptor.name to url_name

* update templates and code references
* also a display_name property that defaults to cleaned url_name
---
 cms/djangoapps/contentstore/views.py          |  2 +-
 cms/templates/unit.html                       |  2 +-
 cms/templates/widgets/navigation.html         |  4 ++--
 cms/templates/widgets/sequence-edit.html      |  2 +-
 common/lib/xmodule/xmodule/html_module.py     |  4 ++--
 .../lib/xmodule/xmodule/modulestore/search.py |  4 ++--
 common/lib/xmodule/xmodule/video_module.py    |  9 ++++----
 common/lib/xmodule/xmodule/x_module.py        | 22 +++++++++++++++++--
 common/lib/xmodule/xmodule/xml_module.py      |  6 ++---
 lms/djangoapps/courseware/courses.py          |  2 +-
 lms/templates/video.html                      |  2 +-
 11 files changed, 39 insertions(+), 20 deletions(-)

diff --git a/cms/djangoapps/contentstore/views.py b/cms/djangoapps/contentstore/views.py
index 0447254cfb..0305795e52 100644
--- a/cms/djangoapps/contentstore/views.py
+++ b/cms/djangoapps/contentstore/views.py
@@ -108,7 +108,7 @@ def edit_item(request):
         'contents': item.get_html(),
         'js_module': item.js_module_name,
         'category': item.category,
-        'name': item.name,
+        'url_name': item.url_name,
         'previews': get_module_previews(request, item),
     })
 
diff --git a/cms/templates/unit.html b/cms/templates/unit.html
index 6aa780d42a..828f95ed47 100644
--- a/cms/templates/unit.html
+++ b/cms/templates/unit.html
@@ -1,7 +1,7 @@
 <section id="unit-wrapper">
   <header>
     <section>
-      <h1 class="editable">${name}</h1>
+      <h1 class="editable">${url_name}</h1>
       <p class="${category}"><a href="#">${category}</a></p>
     </section>
 
diff --git a/cms/templates/widgets/navigation.html b/cms/templates/widgets/navigation.html
index 9f9b37d571..ce18e867bd 100644
--- a/cms/templates/widgets/navigation.html
+++ b/cms/templates/widgets/navigation.html
@@ -41,7 +41,7 @@
     % for week in weeks:
     <li class="week" data-id="${week.location.url()}">
       <header>
-        <h1><a href="#" class="week-edit">${week.name}</a></h1>
+        <h1><a href="#" class="week-edit">${week.url_name}</a></h1>
         <ul>
           % if 'goals' in week.metadata:
             % for goal in week.metadata['goals']:
@@ -60,7 +60,7 @@
             data-type="${module.js_module_name}"
             data-preview-type="${module.module_class.js_module_name}">
 
-            <a href="#" class="module-edit">${module.name}</a>
+            <a href="#" class="module-edit">${module.url_name}</a>
             <a href="#" class="draggable">handle</a>
         </li>
         % endfor
diff --git a/cms/templates/widgets/sequence-edit.html b/cms/templates/widgets/sequence-edit.html
index f7108e366e..c623eb4ec2 100644
--- a/cms/templates/widgets/sequence-edit.html
+++ b/cms/templates/widgets/sequence-edit.html
@@ -39,7 +39,7 @@
               <a href="#" class="module-edit"
                  data-id="${child.location.url()}"
                  data-type="${child.js_module_name}"
-                 data-preview-type="${child.module_class.js_module_name}">${child.name}</a>
+                 data-preview-type="${child.module_class.js_module_name}">${child.url_name}</a>
               <a href="#" class="draggable">handle</a>
             </li>
             %endfor
diff --git a/common/lib/xmodule/xmodule/html_module.py b/common/lib/xmodule/xmodule/html_module.py
index 7c3456e5ad..7a09004e33 100644
--- a/common/lib/xmodule/xmodule/html_module.py
+++ b/common/lib/xmodule/xmodule/html_module.py
@@ -121,13 +121,13 @@ class HtmlDescriptor(XmlDescriptor, EditingDescriptor):
 
         # Not proper format.  Write html to file, return an empty tag
         filepath = u'{category}/{name}.html'.format(category=self.category,
-                                                    name=self.name)
+                                                    name=self.url_name)
 
         resource_fs.makedir(os.path.dirname(filepath), allow_recreate=True)
         with resource_fs.open(filepath, 'w') as file:
             file.write(self.definition['data'])
 
         elt = etree.Element('html')
-        elt.set("filename", self.name)
+        elt.set("filename", self.url_name)
         return elt
 
diff --git a/common/lib/xmodule/xmodule/modulestore/search.py b/common/lib/xmodule/xmodule/modulestore/search.py
index a383b3f8ec..b3eae64fcc 100644
--- a/common/lib/xmodule/xmodule/modulestore/search.py
+++ b/common/lib/xmodule/xmodule/modulestore/search.py
@@ -87,8 +87,8 @@ def path_to_location(modulestore, location, course_name=None):
 
     n = len(path)
     course_id = CourseDescriptor.location_to_id(path[0])
-    chapter = path[1].name if n > 1 else None
-    section = path[2].name if n > 2 else None
+    chapter = path[1].url_name if n > 1 else None
+    section = path[2].url_name if n > 2 else None
 
     # TODO (vshnayder): not handling position at all yet...
     position = None
diff --git a/common/lib/xmodule/xmodule/video_module.py b/common/lib/xmodule/xmodule/video_module.py
index da10e4bc91..fb68ba982b 100644
--- a/common/lib/xmodule/xmodule/video_module.py
+++ b/common/lib/xmodule/xmodule/video_module.py
@@ -23,11 +23,12 @@ class VideoModule(XModule):
     css = {'scss': [resource_string(__name__, 'css/video/display.scss')]}
     js_module_name = "Video"
 
-    def __init__(self, system, location, definition, instance_state=None, shared_state=None, **kwargs):
-        XModule.__init__(self, system, location, definition, instance_state, shared_state, **kwargs)
+    def __init__(self, system, location, definition,
+                 instance_state=None, shared_state=None, **kwargs):
+        XModule.__init__(self, system, location, definition,
+                         instance_state, shared_state, **kwargs)
         xmltree = etree.fromstring(self.definition['data'])
         self.youtube = xmltree.get('youtube')
-        self.name = xmltree.get('name')
         self.position = 0
 
         if instance_state is not None:
@@ -71,7 +72,7 @@ class VideoModule(XModule):
             'streams': self.video_list(),
             'id': self.location.html_id(),
             'position': self.position,
-            'name': self.name,
+            'display_name': self.display_name,
             # TODO (cpennington): This won't work when we move to data that isn't on the filesystem
             'data_dir': self.metadata['data_dir'],
         })
diff --git a/common/lib/xmodule/xmodule/x_module.py b/common/lib/xmodule/xmodule/x_module.py
index 1d16849d67..f6a43f2612 100644
--- a/common/lib/xmodule/xmodule/x_module.py
+++ b/common/lib/xmodule/xmodule/x_module.py
@@ -191,11 +191,20 @@ class XModule(HTMLSnippet):
         self.instance_state = instance_state
         self.shared_state = shared_state
         self.id = self.location.url()
-        self.name = self.location.name
+        self.url_name = self.location.name
         self.category = self.location.category
         self.metadata = kwargs.get('metadata', {})
         self._loaded_children = None
 
+    @property
+    def display_name(self):
+        '''
+        Return a display name for the module: use display_name if defined in
+        metadata, otherwise convert the url name.
+        '''
+        return self.metadata.get('display_name',
+                                 self.url_name.replace('_', ' '))
+
     def get_children(self):
         '''
         Return module instances for all the children of this module.
@@ -355,13 +364,22 @@ class XModuleDescriptor(Plugin, HTMLSnippet):
         self.metadata = kwargs.get('metadata', {})
         self.definition = definition if definition is not None else {}
         self.location = Location(kwargs.get('location'))
-        self.name = self.location.name
+        self.url_name = self.location.name
         self.category = self.location.category
         self.shared_state_key = kwargs.get('shared_state_key')
 
         self._child_instances = None
         self._inherited_metadata = set()
 
+    @property
+    def display_name(self):
+        '''
+        Return a display name for the module: use display_name if defined in
+        metadata, otherwise convert the url name.
+        '''
+        return self.metadata.get('display_name',
+                                 self.url_name.replace('_', ' '))
+
     @property
     def own_metadata(self):
         """
diff --git a/common/lib/xmodule/xmodule/xml_module.py b/common/lib/xmodule/xmodule/xml_module.py
index ea13bc2640..b0a289d149 100644
--- a/common/lib/xmodule/xmodule/xml_module.py
+++ b/common/lib/xmodule/xmodule/xml_module.py
@@ -225,7 +225,7 @@ class XmlDescriptor(XModuleDescriptor):
         # Write it to a file if necessary
         if self.split_to_file(xml_object):
             # Put this object in its own file
-            filepath = self.__class__._format_filepath(self.category, self.name)
+            filepath = self.__class__._format_filepath(self.category, self.url_name)
             resource_fs.makedir(os.path.dirname(filepath), allow_recreate=True)
             with resource_fs.open(filepath, 'w') as file:
                 file.write(etree.tostring(xml_object, pretty_print=True))
@@ -238,10 +238,10 @@ class XmlDescriptor(XModuleDescriptor):
             xml_object.tail = ''
 
 
-            xml_object.set('filename', self.name)
+            xml_object.set('filename', self.url_name)
 
         # Add the metadata
-        xml_object.set('url_name', self.name)
+        xml_object.set('url_name', self.url_name)
         for attr in self.metadata_attributes:
             attr_map = self.xml_attribute_map.get(attr, AttrMap(attr))
             metadata_key = attr_map.metadata_key
diff --git a/lms/djangoapps/courseware/courses.py b/lms/djangoapps/courseware/courses.py
index cfda6497d5..19eef3ee80 100644
--- a/lms/djangoapps/courseware/courses.py
+++ b/lms/djangoapps/courseware/courses.py
@@ -83,7 +83,7 @@ def get_course_about_section(course, section_key):
             log.warning("Missing about section {key} in course {url}".format(key=section_key, url=course.location.url()))
             return None
     elif section_key == "title":
-        return course.metadata.get('display_name', course.name)
+        return course.metadata.get('display_name', course.url_name)
     elif section_key == "university":
         return course.location.org
     elif section_key == "number":
diff --git a/lms/templates/video.html b/lms/templates/video.html
index 65ff44e8fa..93273ddb87 100644
--- a/lms/templates/video.html
+++ b/lms/templates/video.html
@@ -1,5 +1,5 @@
 % if name is not UNDEFINED and name is not None:
-  <h1> ${name} </h1>
+  <h1> ${display_name} </h1>
 % endif
 
 <div id="video_${id}" class="video" data-streams="${streams}" data-caption-data-dir="${data_dir}">