Commit c1e03791 by Chris Dodge

add docstring on StaticContent utility method

parent bffec584
...@@ -60,6 +60,13 @@ class StaticContent(object): ...@@ -60,6 +60,13 @@ class StaticContent(object):
@staticmethod @staticmethod
def get_static_path_from_location(location): def get_static_path_from_location(location):
"""
This utility static method will take a location identifier and create a 'durable' /static/.. URL representation of it.
This link is 'durable' as it can maintain integrity across cloning of courseware across course-ids, e.g. reruns of
courses.
In the LMS/CMS, we have runtime link-rewriting, so at render time, this /static/... format will get translated into
the actual /c4x/... path which the client needs to reference static content
"""
if location is not None: if location is not None:
return "/static/{name}".format(**location.dict()) return "/static/{name}".format(**location.dict())
else: else:
......
...@@ -98,7 +98,7 @@ describe 'HTMLEditingDescriptor', -> ...@@ -98,7 +98,7 @@ describe 'HTMLEditingDescriptor', ->
expect(visualEditorStub.isDirty()).toEqual(false) expect(visualEditorStub.isDirty()).toEqual(false)
expect(visualEditorStub.getContent()).toEqual('Advanced Editor Text') expect(visualEditorStub.getContent()).toEqual('Advanced Editor Text')
expect(visualEditorStub.startContent).toEqual('Advanced Editor Text') expect(visualEditorStub.startContent).toEqual('Advanced Editor Text')
it 'When switching to Advanced Editors links are rewritten to c4x format', -> it 'When switching to visual editor links are rewritten to c4x format', ->
loadFixtures 'html-edit-with-links.html' loadFixtures 'html-edit-with-links.html'
@descriptor = new HTMLEditingDescriptor($('.html-edit')) @descriptor = new HTMLEditingDescriptor($('.html-edit'))
@descriptor.base_asset_url = '/c4x/foo/bar/asset/' @descriptor.base_asset_url = '/c4x/foo/bar/asset/'
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment