plone.browserlayer 2.2.4__tar.gz → 3.0.1__tar.gz

{plone.browserlayer-2.2.4 → plone.browserlayer-3.0.1}/CHANGES.rst

@@ -8,6 +8,32 @@ Changelog
 
 .. towncrier release notes start
 
+3.0.1 (2023-03-14)
+------------------
+
+Internal:
+
+
+- Update configuration files.
+  [plone devs] (ba6bcc29)
+
+
+3.0.0 (2022-11-14)
+------------------
+
+Breaking changes:
+
+
+- Drop support for Plone 5 and Python 2.  [maurits] (#600)
+
+
+Bug fixes:
+
+
+- Fix 'KeyError: file' in browser tests on Python 3.11.
+  [maurits] (#3663)
+
+
 2.2.4 (2020-09-07)
 ------------------
 
@@ -95,7 +121,7 @@ Fixes:
 2.1.2 (2012-10-03)
 ------------------
 
-- Add support for calling many times remove in export (ie:even when no corresponding layer is registred, remove option should not throw exception).
+- Add support for calling many times remove in export (ie:even when no corresponding layer is registered, remove option should not throw exception).
   [toutpt]
 
 2.1.1 (2011-11-24)

plone.browserlayer-3.0.1/PKG-INFO

@@ -0,0 +1,288 @@
+Metadata-Version: 2.1
+Name: plone.browserlayer
+Version: 3.0.1
+Summary: Browser layer management for Zope applications
+Home-page: https://github.com/plone/plone.browserlayer
+Author: Plone Foundation
+Author-email: plone-developers@lists.sourceforge.net
+License: GPL version 2
+Keywords: plone browser layer
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Web Environment
+Classifier: Framework :: Plone
+Classifier: Framework :: Plone :: 6.0
+Classifier: Framework :: Plone :: Core
+Classifier: Framework :: Zope :: 5
+Classifier: License :: OSI Approved :: GNU General Public License v2 (GPLv2)
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Python: >=3.8
+Provides-Extra: test
+
+Introduction
+============
+
+This package aims to make it easier to register visual components (e.g. views
+and viewlets) so that they only show up in a Plone site where they have been
+explicitly installed.
+
+Basic usage
+-----------
+
+To use this feature, you should:
+
+- declare plone.browserlayer as a dependency, e.g. in setup.py::
+
+   install_requires=[
+         'plone.browserlayer',
+     ],
+
+- ensure that its ZCML is loaded, e.g. with an include from your own package::
+
+   <include package="plone.browserlayer" />
+
+- create a layer marker interface unique to your product::
+
+   from zope.interface import Interface
+   class IMyProductLayer(Interface):
+       """A layer specific to my product
+       """
+
+- register this with GenericSetup, in a browserlayer.xml file::
+
+   <layers>
+       <layer name="my.product"
+              interface="my.product.interfaces.IMyProductLayer" />
+   </layers>
+
+- register visual components in ZCML for this layer, e.g.::
+
+   <browser:page
+       name="my-view"
+       for="*"
+       layer=".interfaces.IMyProductLayer"
+       permission="zope.Public"
+       template="my-view.pt"
+       />
+
+Changelog
+=========
+
+.. You should *NOT* be adding new change log entries to this file.
+   You should create a file in the news directory instead.
+   For helpful instructions, please see:
+   https://github.com/plone/plone.releaser/blob/master/ADD-A-NEWS-ITEM.rst
+
+.. towncrier release notes start
+
+3.0.1 (2023-03-14)
+------------------
+
+Internal:
+
+
+- Update configuration files.
+  [plone devs] (ba6bcc29)
+
+
+3.0.0 (2022-11-14)
+------------------
+
+Breaking changes:
+
+
+- Drop support for Plone 5 and Python 2.  [maurits] (#600)
+
+
+Bug fixes:
+
+
+- Fix 'KeyError: file' in browser tests on Python 3.11.
+  [maurits] (#3663)
+
+
+2.2.4 (2020-09-07)
+------------------
+
+Bug fixes:
+
+
+- Fixed deprecation warning for ``zope.component.interfaces.IComponentRegistry``.
+  [maurits] (#3130)
+
+
+2.2.3 (2020-04-20)
+------------------
+
+Bug fixes:
+
+
+- Minor packaging updates. (#1)
+
+
+2.2.2 (2018-09-28)
+------------------
+
+Bug fixes:
+
+- Fix tests for py3
+  [pbauer]
+
+
+2.2.1 (2018-02-02)
+------------------
+
+Bug fixes:
+
+- Add Python 2 / 3 compatibility
+  [pbauer]
+
+
+2.2.0 (2017-02-12)
+------------------
+
+Bug fixes:
+
+- Fixed test when using Zope 4.  [maurits]
+
+
+2.1.7 (2016-11-01)
+------------------
+
+Fixes:
+
+- Removed ZopeTestCase.  We were importing from it but not using it...
+  [ivanteoh, maurits]
+
+
+2.1.6 (2015-10-27)
+------------------
+
+Fixes:
+
+- Minor cleanup in order to follow plone code style conventions.
+  [jensens]
+
+
+2.1.5 (2015-04-29)
+------------------
+
+- Rerelease for clarity, because 2.1.4 got released twice.
+  [maurits]
+
+
+2.1.4 (2015-04-29)
+------------------
+
+- Move tests to plone.app.testing.
+  [sdelcourt,timo]
+
+
+2.1.3 (2014-02-25)
+------------------
+
+- Fix tests with diazo.
+  [davisagli]
+
+
+2.1.2 (2012-10-03)
+------------------
+
+- Add support for calling many times remove in export (ie:even when no corresponding layer is registered, remove option should not throw exception).
+  [toutpt]
+
+2.1.1 (2011-11-24)
+------------------
+
+- Added uninstall support to browserlayer.xml with the 'remove' option.
+  [maurits]
+
+- GS export xml is now repeatable. Before two consecutive exports could
+  yield differently ordered results.
+  [do3cc]
+
+
+2.1 - 2011-05-12
+----------------
+
+- Update import of BeforeTraverseEvent to come from zope.traversing instead
+  of zope.app.publication.
+  [davisagli]
+
+- Add MANIFEST.in
+  [WouterVH]
+
+
+2.0.1 - 2010-09-21
+------------------
+
+- Make sure the layers don't get applied twice if the site is traversed more
+  than once (such as in a vhosting URL).
+  [davisagli]
+
+
+2.0 - 2010-07-18
+----------------
+
+- Update license to GPL version 2 only.
+  [hannosch]
+
+- Package metadata cleanup, require Zope2 distribution.
+  [hannosch]
+
+
+1.0.1 - 2009-09-09
+------------------
+
+- Be more robust against broken layer registrations. These can occur when
+  packages with registered layers are removed.
+  [wichert]
+
+- Clarified license and copyright.
+  [hannosch]
+
+- Register ourselves for the more generic ISiteRoot from CMFCore and not
+  IPloneSiteRoot.
+  [hannosch]
+
+- Declare test dependencies in an extra.
+  [hannosch]
+
+- Specify package dependencies.
+  [hannosch]
+
+
+1.0.0 - 2008-04-20
+------------------
+
+- Unchanged from 1.0rc4
+
+
+1.0rc4 - 2008-04-13
+-------------------
+
+- Register the GenericSetup import and export steps using zcml. This means you
+  will no longer need to install this package manually.
+  [wichert]
+
+
+1.0rc3 - 2008-03-09
+-------------------
+
+- Include README.txt and HISTORY.txt in the package's long description.
+  [wichert]
+
+- Add metadata.xml to the GenericSetup profile. This fixes a deprecation
+  warning for Plone 3.1 and later.
+  [wichert]
+
+
+1.0b1 - 2007-09-23
+------------------
+
+- Initial package structure.
+  [zopeskel]

plone.browserlayer-3.0.1/plone/__init__.py

@@ -0,0 +1 @@
+__import__("pkg_resources").declare_namespace(__name__)

{plone.browserlayer-2.2.4 → plone.browserlayer-3.0.1}/plone/browserlayer/README.rst

@@ -11,20 +11,22 @@ Before the product is installed, we cannot view this:
     >>> IMyProductLayer in utils.registered_layers()
     False
 
-    >>> from plone.testing import z2
-
-    >>> from plone.testing.z2 import Browser
+    >>> from plone.testing.zope import Browser
     >>> browser = Browser(layer['app'])
+    >>> browser.handleErrors = False
+    >>> browser.raiseHttpErrors = False
+    >>> browser.open(layer['portal'].absolute_url())
     >>> browser.open(layer['portal'].absolute_url() + '/@@layer-test-view')
     Traceback (most recent call last):
     ...
-    urllib.error.HTTPError: HTTP Error 404: Not Found
+    zExceptions.NotFound: http://nohost/plone/@@layer-test-view
 
 We can view a view registered for the default layer, though:
 
     >>> browser.open(layer['portal'].absolute_url() + '/@@standard-test-view')
     >>> print(browser.contents)
     A standard view
+    <BLANKLINE>
 
 However, if we install the product the interface is registered in the local
 site manager. Here we use the utility method directly, though we could also
@@ -61,7 +63,7 @@ It is also possible to uninstall a layer:
     >>> browser.open(layer['portal'].absolute_url() + '/@@layer-test-view')
     Traceback (most recent call last):
     ...
-    urllib.error.HTTPError: HTTP Error 404: Not Found
+    zExceptions.NotFound: http://nohost/plone/@@layer-test-view
 
 GenericSetup support
 --------------------
@@ -148,7 +150,7 @@ as expected:
     >>> browser.open(layer['portal'].absolute_url() + '/@@layer-test-view')
     Traceback (most recent call last):
     ...
-    urllib.error.HTTPError: HTTP Error 404: Not Found
+    zExceptions.NotFound: http://nohost/plone/@@layer-test-view
 
     >>> browser.open(layer['portal'].absolute_url() + '/@@standard-test-view')
     >>> print(browser.contents)

plone.browserlayer-3.0.1/plone/browserlayer/configure.zcml

@@ -0,0 +1,34 @@
+<configure
+    xmlns="http://namespaces.zope.org/zope"
+    xmlns:genericsetup="http://namespaces.zope.org/genericsetup"
+    i18n_domain="plone.browserlayer"
+    >
+
+  <genericsetup:importStep
+      name="browserlayer"
+      title="Package browser layers"
+      description="Enables use of skin layers for installed products."
+      handler="plone.browserlayer.exportimport.importLayers"
+      >
+    <depends name="componentregistry" />
+  </genericsetup:importStep>
+
+  <genericsetup:exportStep
+      name="browserlayer"
+      title="Package browser layers"
+      description="Export package browser layers"
+      handler="plone.browserlayer.exportimport.exportLayers"
+      />
+
+  <subscriber
+      for="Products.CMFCore.interfaces.ISiteRoot
+           zope.traversing.interfaces.IBeforeTraverseEvent"
+      handler=".layer.mark_layer"
+      />
+
+  <adapter
+      factory=".exportimport.BrowserLayerXMLAdapter"
+      name="plone.browserlayer"
+      />
+
+</configure>

{plone.browserlayer-2.2.4 → plone.browserlayer-3.0.1}/plone/browserlayer/exportimport.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 from plone.browserlayer.interfaces import ILocalBrowserLayerType
 from plone.browserlayer.utils import register_layer
 from plone.browserlayer.utils import unregister_layer
@@ -15,36 +14,35 @@ from zope.interface.interfaces import IComponentRegistry
 
 
 def dummyGetId():
-    return ''
+    return ""
 
 
 @implementer(IBody)
 @adapter(IComponentRegistry, ISetupEnviron)
 class BrowserLayerXMLAdapter(XMLAdapterBase):
-    """Im- and exporter for local browser layers
-    """
+    """Im- and exporter for local browser layers"""
 
-    name = 'browserlayer'
-    _LOGGER_ID = 'browserlayer'
+    name = "browserlayer"
+    _LOGGER_ID = "browserlayer"
 
     def _exportNode(self):
         # hack around an issue where _getObjectNode expects to have the context
         # a meta_type and a getId method, which isn't the case for a component
         # registry
         if IComponentRegistry.providedBy(self.context):
-            self.context.meta_type = 'ComponentRegistry'
+            self.context.meta_type = "ComponentRegistry"
             self.context.getId = dummyGetId
-        node = self._getObjectNode('layers')
+        node = self._getObjectNode("layers")
         if IComponentRegistry.providedBy(self.context):
-            del(self.context.meta_type)
-            del(self.context.getId)
+            del self.context.meta_type
+            del self.context.getId
         node.appendChild(self._extractLayers())
-        self._logger.info('Browser layers exported')
+        self._logger.info("Browser layers exported")
         return node
 
     def _importNode(self, node):
         self._initProvider(node)
-        self._logger.info('Browser layers imported')
+        self._logger.info("Browser layers imported")
 
     def _initProvider(self, node):
         if self.environ.shouldPurge():
@@ -52,54 +50,58 @@ class BrowserLayerXMLAdapter(XMLAdapterBase):
         self._initLayers(node)
 
     def _purgeLayers(self):
-        registeredLayers = [r.name for r in self.context.registeredUtilities()
-                            if r.provided == ILocalBrowserLayerType]
+        registeredLayers = [
+            r.name
+            for r in self.context.registeredUtilities()
+            if r.provided == ILocalBrowserLayerType
+        ]
         for name in registeredLayers:
             unregister_layer(name, site_manager=self.context)
 
     def _initLayers(self, node):
         for child in node.childNodes:
-            if child.nodeName.lower() == 'layer':
-                name = child.getAttribute('name')
-                if child.getAttribute('remove'):
+            if child.nodeName.lower() == "layer":
+                name = child.getAttribute("name")
+                if child.getAttribute("remove"):
                     try:
                         unregister_layer(name, site_manager=self.context)
                     except KeyError as e:
                         self._logger.info(e)
                     continue
-                interface = _resolveDottedName(child.getAttribute('interface'))
+                interface = _resolveDottedName(child.getAttribute("interface"))
                 register_layer(interface, name, site_manager=self.context)
 
     def _extractLayers(self):
         fragment = self._doc.createDocumentFragment()
 
-        registrations = [r for r in self.context.registeredUtilities()
-                         if r.provided == ILocalBrowserLayerType]
+        registrations = [
+            r
+            for r in self.context.registeredUtilities()
+            if r.provided == ILocalBrowserLayerType
+        ]
 
         registrations.sort()
 
         for r in registrations:
-            child = self._doc.createElement('layer')
-            child.setAttribute('name', r.name)
-            child.setAttribute('interface', _getDottedName(r.component))
+            child = self._doc.createElement("layer")
+            child.setAttribute("name", r.name)
+            child.setAttribute("interface", _getDottedName(r.component))
             fragment.appendChild(child)
 
         return fragment
 
 
 def importLayers(context):
-    """Import local browser layers
-    """
+    """Import local browser layers"""
     sm = getSiteManager(context.getSite())
     if sm is None or not IComponentRegistry.providedBy(sm):
-        logger = context.getLogger('browserlayer')
+        logger = context.getLogger("browserlayer")
         logger.info("Can not register components - no site manager found.")
         return
 
-    importer = queryMultiAdapter((sm, context), IBody,
-                                 name=u'plone.browserlayer')
+    importer = queryMultiAdapter((sm, context), IBody, name="plone.browserlayer")
     if importer is not None:
-        filename = '%s%s' % (importer.name, importer.suffix)
+        filename = f"{importer.name}{importer.suffix}"
         body = context.readDataFile(filename)
         if body is not None:
             importer.filename = filename  # for error reporting
@@ -107,18 +109,16 @@ def importLayers(context):
 
 
 def exportLayers(context):
-    """Export local browser layers
-    """
+    """Export local browser layers"""
     sm = getSiteManager(context.getSite())
     if sm is None or not IComponentRegistry.providedBy(sm):
-        logger = context.getLogger('browserlayer')
+        logger = context.getLogger("browserlayer")
         logger.info("Can not register components - no site manager found.")
         return
 
-    exporter = queryMultiAdapter((sm, context), IBody,
-                                 name=u'plone.browserlayer')
+    exporter = queryMultiAdapter((sm, context), IBody, name="plone.browserlayer")
     if exporter is not None:
-        filename = '%s%s' % (exporter.name, exporter.suffix)
+        filename = f"{exporter.name}{exporter.suffix}"
         body = exporter.body
         if body is not None:
             context.writeDataFile(filename, body, exporter.mime_type)

{plone.browserlayer-2.2.4 → plone.browserlayer-3.0.1}/plone/browserlayer/interfaces.py

@@ -1,7 +1,5 @@
-# -*- coding: utf-8 -*-
 from zope.interface import Interface
 
 
 class ILocalBrowserLayerType(Interface):
-    """Describes the type of interface an ILocalBrowserLayer is.
-    """
+    """Describes the type of interface an ILocalBrowserLayer is."""

{plone.browserlayer-2.2.4 → plone.browserlayer-3.0.1}/plone/browserlayer/layer.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 from plone.browserlayer.interfaces import ILocalBrowserLayerType
 from zope.component import getAllUtilitiesRegisteredFor
 from zope.interface import directlyProvidedBy
@@ -7,8 +6,7 @@ from zope.interface import Interface
 
 
 def mark_layer(site, event):
-    """Mark the request with all installed layers.
-    """
+    """Mark the request with all installed layers."""
     if getattr(event.request, "_plonebrowserlayer_", False):
         return
     event.request._plonebrowserlayer_ = True

{plone.browserlayer-2.2.4 → plone.browserlayer-3.0.1}/plone/browserlayer/testing.py

@@ -1,14 +1,13 @@
-# -*- coding: utf-8 -*-
 from plone.app.testing import PloneSandboxLayer
 from plone.app.testing.layers import FunctionalTesting
 
 
 class PloneBrowserlayerLayer(PloneSandboxLayer):
-
     def setUpZope(self, app, configurationContext):
         import plone.browserlayer.tests
+
         self.debug_mode = True
-        self.loadZCML('tests/testing.zcml', package=plone.browserlayer)
+        self.loadZCML("tests/testing.zcml", package=plone.browserlayer)
         self.loadZCML(package=plone.browserlayer)
         self.debug_mode = False
 
@@ -16,6 +15,5 @@ class PloneBrowserlayerLayer(PloneSandboxLayer):
 PLONEBROWSERLAYER_FIXTURE = PloneBrowserlayerLayer()
 
 PLONEBROWSERLAYER_FUNCTIONAL_TESTING = FunctionalTesting(
-    bases=(PLONEBROWSERLAYER_FIXTURE,),
-    name="PloneBrowserlayer:Functional"
+    bases=(PLONEBROWSERLAYER_FIXTURE,), name="PloneBrowserlayer:Functional"
 )

{plone.browserlayer-2.2.4 → plone.browserlayer-3.0.1}/plone/browserlayer/tests/interfaces.py

@@ -1,7 +1,5 @@
-# -*- coding: utf-8 -*-
 from zope.interface import Interface
 
 
 class IMyProductLayer(Interface):
-    """A layer unique to this product.
-    """
+    """A layer unique to this product."""

plone.browserlayer-3.0.1/plone/browserlayer/tests/local.pt

@@ -0,0 +1,3 @@
+<tal:block define="
+             dummy python:request.response.setHeader('Content-Type', 'text/plain');
+           " />A local view

plone.browserlayer-3.0.1/plone/browserlayer/tests/profiles/testing/browserlayer.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="utf-8"?>
+<layers>
+  <layer interface="plone.browserlayer.tests.interfaces.IMyProductLayer"
+         name="plone.browserlayer.tests"
+  />
+</layers>

plone.browserlayer-3.0.1/plone/browserlayer/tests/profiles/uninstall/browserlayer.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="utf-8"?>
+<layers>
+  <layer name="plone.browserlayer.tests"
+         remove="true"
+  />
+  <!-- remove not existing should not doing more than a log -->
+  <layer name="plone.browserlayer.tests.notexisting"
+         remove="true"
+  />
+</layers>

plone.browserlayer-3.0.1/plone/browserlayer/tests/standard.pt

@@ -0,0 +1,3 @@
+<tal:block define="
+             dummy python:request.response.setHeader('Content-Type', 'text/plain');
+           " />A standard view

plone.browserlayer-3.0.1/plone/browserlayer/tests/test_doctest.py

@@ -0,0 +1,24 @@
+from plone.browserlayer.testing import PLONEBROWSERLAYER_FUNCTIONAL_TESTING
+from plone.testing import layered
+
+import doctest
+import unittest
+
+
+def test_suite():
+    return unittest.TestSuite(
+        [
+            layered(
+                doctest.DocFileSuite(
+                    "README.rst",
+                    package="plone.browserlayer",
+                    optionflags=(
+                        doctest.ELLIPSIS
+                        | doctest.REPORT_ONLY_FIRST_FAILURE
+                        | doctest.NORMALIZE_WHITESPACE
+                    ),
+                ),
+                layer=PLONEBROWSERLAYER_FUNCTIONAL_TESTING,
+            )
+        ]
+    )