Skip to content

Commit

Permalink
Rename cone.app.model.registerNodeInfo to ``cone.app.model.regist…
Browse files Browse the repository at this point in the history
…er_node_info``. B/C import avaiable as of ``cone.app`` 1.1. Rename ``cone.app.model.getNodeInfo`` to ``cone.app.model.get_node_info``. B/C import avaiable as of ``cone.app`` 1.1.
  • Loading branch information
rnixx committed Aug 19, 2014
1 parent fa18207 commit 06090fc
Show file tree
Hide file tree
Showing 8 changed files with 44 additions and 29 deletions.
9 changes: 9 additions & 0 deletions README.rst
Expand Up @@ -73,6 +73,15 @@ Changes
1.0.dev0 (unreleased)
---------------------

- Rename ``cone.app.model.registerNodeInfo`` to
``cone.app.model.register_node_info``. B/C import avaiable as of ``cone.app``
1.1.
[rnix, 2014-08-19]

- Rename ``cone.app.model.getNodeInfo`` to ``cone.app.model.get_node_info``.
B/C import avaiable as of ``cone.app`` 1.1.
[rnix, 2014-08-19]

- Modify ``class_add`` instead of ``class`` property in
``cone.app.browser.form.Form.prepare_ajax``.
[rnix, 2014-08-16]
Expand Down
8 changes: 4 additions & 4 deletions docs/source/model.rst
Expand Up @@ -248,20 +248,20 @@ for authoring purposes.::

>>> from cone.app.model import (
... NodeInfo,
... registerNodeInfo,
... register_node_info,
... )
>>> info = NodeInfo()
>>> info.title = 'Node meta title'
>>> info.description = 'Node meta description'
>>> info.node = SomeNode
>>> info.addables = ['node_info_name_b', 'node_info_name_c']
>>> registerNodeInfo('node_info_name_a', info)
>>> register_node_info('node_info_name_a', info)

The refering application model node must provide ``node_info_name`` attribute,
which is used to lookup the related NodeInfo instance.::

>>> from cone.app.model import getNodeInfo
>>> info = getNodeInfo('node_info_name_a')
>>> from cone.app.model import get_node_info
>>> info = get_node_info('node_info_name_a')

See forms documentation for more details.

Expand Down
4 changes: 2 additions & 2 deletions src/cone/app/browser/actions.rst
Expand Up @@ -464,13 +464,13 @@ ActionAdd

>>> from cone.app.model import (
... NodeInfo,
... registerNodeInfo,
... register_node_info,
... )

>>> info = NodeInfo()
>>> info.title = 'Addable'
>>> info.addables = ['addable']
>>> registerNodeInfo('addable', info)
>>> register_node_info('addable', info)

>>> from cone.app.browser.actions import ActionAdd
>>> action = ActionAdd()
Expand Down
10 changes: 5 additions & 5 deletions src/cone/app/browser/authoring.py
Expand Up @@ -18,7 +18,7 @@
render_template,
)
from ..model import (
getNodeInfo,
get_node_info,
Properties,
BaseNode,
AdapterNode,
Expand Down Expand Up @@ -230,7 +230,7 @@ def items(self):
if not addables:
return ret
for addable in addables:
info = getNodeInfo(addable)
info = get_node_info(addable)
if not info:
continue
query = make_query(factory=addable)
Expand Down Expand Up @@ -278,7 +278,7 @@ def info(self):
allowed = self.model.nodeinfo.addables
if not factory or not allowed or not factory in allowed:
return None
return getNodeInfo(factory)
return get_node_info(factory)


class AddFactoryProxy(Behavior):
Expand All @@ -304,7 +304,7 @@ class AddFormHeading(FormHeading):
def form_heading(self):
localizer = get_localizer(self.request)
title = localizer.translate(
getNodeInfo(self.model.node_info_name).title)
get_node_info(self.model.node_info_name).title)
heading = localizer.translate(
_('add_form_heading',
default='Add: ${title}',
Expand Down Expand Up @@ -371,7 +371,7 @@ class EditFormHeading(FormHeading):
@default
@property
def form_heading(self):
info = getNodeInfo(self.model.node_info_name)
info = get_node_info(self.model.node_info_name)
if info is None:
return _('edit', default='Edit')
localizer = get_localizer(self.request)
Expand Down
16 changes: 8 additions & 8 deletions src/cone/app/browser/authoring.rst
Expand Up @@ -31,21 +31,21 @@ Provide a node interface needed for different node style binding to test form::
Create dummy node::

>>> from cone.app.model import BaseNode
>>> from cone.app.model import getNodeInfo
>>> from cone.app.model import get_node_info

>>> @implementer(ITestAddingNode)
... class MyNode(BaseNode):
... node_info_name = 'mynode'

Provide NodeInfo for our Application node::

>>> from cone.app.model import NodeInfo, registerNodeInfo
>>> from cone.app.model import NodeInfo, register_node_info
>>> mynodeinfo = NodeInfo()
>>> mynodeinfo.title = 'My Node'
>>> mynodeinfo.description = 'This is My node.'
>>> mynodeinfo.node = MyNode
>>> mynodeinfo.addables = ['mynode'] # self containment
>>> registerNodeInfo('mynode', mynodeinfo)
>>> register_node_info('mynode', mynodeinfo)

Create another dummy node inheriting from AdapterNode::

Expand All @@ -60,7 +60,7 @@ Create another dummy node inheriting from AdapterNode::
>>> myadapternodeinfo.description = 'This is My adapter node.'
>>> myadapternodeinfo.node = MyAdapterNode
>>> myadapternodeinfo.addables = ['myadapternode'] # self containment
>>> registerNodeInfo('myadapternode', myadapternodeinfo)
>>> register_node_info('myadapternode', myadapternodeinfo)

Create and register an ``addform`` named form tile::

Expand Down Expand Up @@ -425,8 +425,8 @@ Allow another node type as child::
>>> nodeinfo.description = 'This is another node.'
>>> nodeinfo.node = BaseNode
>>> nodeinfo.addables = []
>>> registerNodeInfo('anothernode', nodeinfo)
>>> getNodeInfo('mynode').addables = ['mynode', 'anothernode']
>>> register_node_info('anothernode', nodeinfo)
>>> get_node_info('mynode').addables = ['mynode', 'anothernode']
>>> rendered = render_tile(root['somechild'], request, 'add_dropdown')

Non JS links to add form::
Expand Down Expand Up @@ -460,7 +460,7 @@ XXX: discuss whether to hide entire widget if no items::
>>> nodeinfo.description = 'This is a no child containing node.'
>>> nodeinfo.node = NoChildAddingNode
>>> nodeinfo.addables = []
>>> registerNodeInfo('nochildaddingnode', nodeinfo)
>>> register_node_info('nochildaddingnode', nodeinfo)
>>> rendered = render_tile(NoChildAddingNode(), request, 'add_dropdown')
>>> rendered
Expand All @@ -485,7 +485,7 @@ XXX: discuss whether to hide entire widget if no items::
>>> nodeinfo.description = 'This is a node with an invalid child node info.'
>>> nodeinfo.node = InvalidChildNodeInfoNode
>>> nodeinfo.addables = ['invalid']
>>> registerNodeInfo('invalidchildnodeinfo', nodeinfo)
>>> register_node_info('invalidchildnodeinfo', nodeinfo)
>>> rendered = render_tile(InvalidChildNodeInfoNode(),
... request,
... 'add_dropdown')
Expand Down
6 changes: 3 additions & 3 deletions src/cone/app/browser/copysupport.rst
Expand Up @@ -3,22 +3,22 @@ Copysupport::
>>> from cone.app.testing.mock import CopySupportNode
>>> from cone.app.model import (
... NodeInfo,
... registerNodeInfo,
... register_node_info,
... )

>>> class CopySupportNodeA(CopySupportNode):
... node_info_name = 'copy_support_node_a'
>>> info = NodeInfo()
>>> info.title = 'CopySupportNodeA'
>>> info.addables = ['copy_support_node_a', 'copy_support_node_b']
>>> registerNodeInfo('copy_support_node_a', info)
>>> register_node_info('copy_support_node_a', info)

>>> class CopySupportNodeB(CopySupportNode):
... node_info_name = 'copy_support_node_b'
>>> info = NodeInfo()
>>> info.title = 'CopySupportNodeB'
>>> info.addables = ['copy_support_node_b']
>>> registerNodeInfo('copy_support_node_b', info)
>>> register_node_info('copy_support_node_b', info)

>>> root = CopySupportNodeA()
>>> source = root['source'] = CopySupportNodeA()
Expand Down
14 changes: 10 additions & 4 deletions src/cone/app/model.py
Expand Up @@ -75,14 +75,20 @@
_node_info_registry = dict()


def registerNodeInfo(name, info):
def register_node_info(name, info):
_node_info_registry[name] = info

# B/C removed as of cone.app 1.1
registerNodeInfo = register_node_info

def getNodeInfo(name):

def get_node_info(name):
if name in _node_info_registry:
return _node_info_registry[name]

# B/C removed as of cone.app 1.1
getNodeInfo = get_node_info


class node_info(object):
"""Node info decorator.
Expand All @@ -105,7 +111,7 @@ def __call__(self, cls):
info.node = cls
info.addables = self.addables
info.icon = self.icon
registerNodeInfo(cls.node_info_name, info)
register_node_info(cls.node_info_name, info)
return cls


Expand Down Expand Up @@ -143,7 +149,7 @@ def metadata(self):
@default
@property
def nodeinfo(self):
info = getNodeInfo(self.node_info_name)
info = get_node_info(self.node_info_name)
if not info:
info = NodeInfo()
info.title = str(self.__class__)
Expand Down
6 changes: 3 additions & 3 deletions src/cone/app/model.rst
Expand Up @@ -259,12 +259,12 @@ node.::

Register node info.::

>>> from cone.app.model import registerNodeInfo, getNodeInfo
>>> registerNodeInfo('basenode', nodeinfo)
>>> from cone.app.model import register_node_info, get_node_info
>>> register_node_info('basenode', nodeinfo)

Lookup Node info.::

>>> nodeinfo = getNodeInfo('basenode')
>>> nodeinfo = get_node_info('basenode')
>>> nodeinfo.title
'Base Node'

Expand Down

0 comments on commit 06090fc

Please sign in to comment.