Merge pull request #63 from collective/ale/pre-commit

Ale/pre commit

Author: ale-rt

.editorconfig

@@ -0,0 +1,56 @@
+# Generated from:
+# https://github.com/plone/meta/tree/2.x/src/plone/meta/default
+# See the inline comments on how to expand/tweak this configuration file
+#
+# EditorConfig Configuration file, for more details see:
+# http://EditorConfig.org
+# EditorConfig is a convention description, that could be interpreted
+# by multiple editors to enforce common coding conventions for specific
+# file types
+
+# top-most EditorConfig file:
+# Will ignore other EditorConfig files in Home directory or upper tree level.
+root = true
+
+
+[*]
+# Default settings for all files.
+# Unix-style newlines with a newline ending every file
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+# Set default charset
+charset = utf-8
+# Indent style default
+indent_style = space
+# Max Line Length - a hard line wrap, should be disabled
+max_line_length = off
+
+[*.{py,cfg,ini}]
+# 4 space indentation
+indent_size = 4
+
+[*.{yml,zpt,pt,dtml,zcml,html,xml}]
+# 2 space indentation
+indent_size = 2
+
+[*.{json,jsonl,js,jsx,ts,tsx,css,less,scss}]
+# Frontend development
+# 2 space indentation
+indent_size = 2
+max_line_length = 80
+
+[{Makefile,.gitmodules}]
+# Tab indentation (no size specified, but view as 4 spaces)
+indent_style = tab
+indent_size = unset
+tab_width = unset
+
+
+##
+# Add extra configuration options in .meta.toml:
+#  [editorconfig]
+#  extra_lines = """
+#  _your own configuration lines_
+#  """
+##

.flake8

@@ -0,0 +1,22 @@
+# Generated from:
+# https://github.com/plone/meta/tree/2.x/src/plone/meta/default
+# See the inline comments on how to expand/tweak this configuration file
+[flake8]
+doctests = 1
+ignore =
+    # black takes care of line length
+    E501,
+    # black takes care of where to break lines
+    W503,
+    # black takes care of spaces within slicing (list[:])
+    E203,
+    # black takes care of spaces after commas
+    E231,
+
+##
+# Add extra configuration options in .meta.toml:
+#  [flake8]
+#  extra_lines = """
+#  _your own configuration lines_
+#  """
+##

.pre-commit-config.yaml

@@ -0,0 +1,80 @@
+# Generated from:
+# https://github.com/plone/meta/tree/2.x/src/plone/meta/default
+# See the inline comments on how to expand/tweak this configuration file
+ci:
+    autofix_prs: false
+    autoupdate_schedule: monthly
+
+repos:
+-   repo: https://github.com/asottile/pyupgrade
+    rev: v3.21.2
+    hooks:
+    -   id: pyupgrade
+        args: [--py310-plus]
+-   repo: https://github.com/pycqa/isort
+    rev: 8.0.1
+    hooks:
+    -   id: isort
+-   repo: https://github.com/psf/black-pre-commit-mirror
+    rev: 26.3.1
+    hooks:
+    -   id: black
+-   repo: https://github.com/collective/zpretty
+    rev: 3.1.1
+    hooks:
+    -   id: zpretty
+
+##
+# Add extra configuration options in .meta.toml:
+#  [pre_commit]
+#  zpretty_extra_lines = """
+#  _your own configuration lines_
+#  """
+##
+-   repo: https://github.com/PyCQA/flake8
+    rev: 7.3.0
+    hooks:
+    -   id: flake8
+
+##
+# Add extra configuration options in .meta.toml:
+#  [pre_commit]
+#  flake8_extra_lines = """
+#  _your own configuration lines_
+#  """
+##
+-   repo: https://github.com/codespell-project/codespell
+    rev: v2.4.2
+    hooks:
+    -   id: codespell
+        additional_dependencies:
+          - tomli
+
+##
+# Add extra configuration options in .meta.toml:
+#  [pre_commit]
+#  codespell_extra_lines = """
+#  _your own configuration lines_
+#  """
+##
+-   repo: https://github.com/mgedmin/check-manifest
+    rev: "0.51"
+    hooks:
+    -   id: check-manifest
+-   repo: https://github.com/regebro/pyroma
+    rev: "5.0.1"
+    hooks:
+    -   id: pyroma
+-   repo: https://github.com/mgedmin/check-python-versions
+    rev: "0.24.0"
+    hooks:
+    -   id: check-python-versions
+        args: ['--only', 'setup.py,tox.ini']
+
+##
+# Add extra configuration options in .meta.toml:
+#  [pre_commit]
+#  extra_lines = """
+#  _your own configuration lines_
+#  """
+##

pyproject.toml

@@ -0,0 +1,84 @@
+# Generated from:
+# https://github.com/plone/meta/tree/2.x/src/plone/meta/default
+# See the inline comments on how to expand/tweak this configuration file
+[build-system]
+requires = ["setuptools>=68.2,<82", "wheel"]
+
+##
+# Add extra configuration options in .meta.toml:
+#  [pyproject]
+#  towncrier_extra_lines = """
+#  extra_configuration
+#  """
+##
+
+[tool.isort]
+profile = "plone"
+
+##
+# Add extra configuration options in .meta.toml:
+#  [pyproject]
+#  isort_extra_lines = """
+#  extra_configuration
+#  """
+##
+
+[tool.black]
+target-version = ["py310"]
+
+##
+# Add extra configuration options in .meta.toml:
+#  [pyproject]
+#  black_extra_lines = """
+#  extra_configuration
+#  """
+##
+
+[tool.codespell]
+ignore-words-list = "discreet,assertin,thet,thirdparty"
+skip = "*.po,"
+##
+# Add extra configuration options in .meta.toml:
+#  [pyproject]
+#  codespell_ignores = "foo,bar"
+#  codespell_skip = "*.po,*.map,package-lock.json"
+##
+
+[tool.check-manifest]
+ignore = [
+    ".editorconfig",
+    ".flake8",
+    ".meta.toml",
+    ".pre-commit-config.yaml",
+    "dependabot.yml",
+    "mx.ini",
+    "tox.ini",
+    ".gha.cfg",
+    "base.cfg",
+    "plone-6.0.x.cfg",
+    "plone-6.1.x.cfg",
+    "plone-6.2.x.cfg",
+]
+
+##
+# Add extra configuration options in .meta.toml:
+#  [pyproject]
+#  check_manifest_ignores = """
+#      "*.map.js",
+#      "*.pyc",
+#  """
+#  check_manifest_extra_lines = """
+#  ignore-bad-ideas = [
+#      "some/test/file/PKG-INFO",
+#  ]
+#  """
+##
+
+
+##
+# Add extra configuration options in .meta.toml:
+#  [pyproject]
+#  extra_lines = """
+#  _your own configuration lines_
+#  """
+##

setup.cfg

@@ -1,4 +1,5 @@
-from setuptools import setup, find_packages
+from setuptools import find_packages
+from setuptools import setup
 
 version = "4.0.0.dev0"
 
@@ -20,6 +21,7 @@
     # Get more strings from
     # https://pypi.org/classifiers/
     classifiers=[
+        "Development Status :: 5 - Production/Stable",
         "Environment :: Web Environment",
         "Framework :: Plone",
         "Framework :: Plone :: Addon",
@@ -38,12 +40,13 @@
     ],
     keywords="plone workspace collaboration",
     author="David Glick",
-    author_email="",
+    author_email="collective@plone.org",
     url="https://github.com/collective/collective.workspace",
     license="gpl",
     packages=find_packages("src"),
     package_dir={"": "src"},
-    namespace_packages=["collective",],
+    python_requires=">=3.9",
+    namespace_packages=["collective"],
     include_package_data=True,
     zip_safe=False,
     install_requires=[
@@ -53,8 +56,13 @@
         # -*- Extra requirements: -*-
     ],
     extras_require={
-        "test": ["plone.app.robotframework[debug,reload]", "plone.app.testing",],
-        "develop": ["zest.releaser",],
+        "test": [
+            "plone.app.robotframework[debug,reload]",
+            "plone.app.testing",
+        ],
+        "develop": [
+            "zest.releaser",
+        ],
     },
     entry_points="""
       # -*- Entry points: -*-

setup.py

@@ -1,2 +1 @@
-# coding=utf-8
 __import__("pkg_resources").declare_namespace(__name__)

src/collective/__init__.py

@@ -1,10 +1,8 @@
-# -*- coding: utf-8 -*-
 from AccessControl.Permissions import add_user_folders
 from collective.workspace import pas
 from Products.PluggableAuthService import registerMultiPlugin
 from zope.i18nmessageid import MessageFactory
 
-
 workspaceMessageFactory = MessageFactory("collective.workspace")
 
 

src/collective/workspace/__init__.py

@@ -1,4 +1,3 @@
-# coding=utf-8
 from collective.workspace.interfaces import IHasWorkspace
 from plone import api
 from plone.app.dexterity.permissions import DXFieldPermissionChecker
@@ -8,7 +7,7 @@
 @adapter(IHasWorkspace)
 class WorkspaceFieldPermissionChecker(DXFieldPermissionChecker):
     def validate(self, field_name, vocabulary_name=None):
-        """ Override the permission checker to allow querying the users
+        """Override the permission checker to allow querying the users
         vocabulary even if there is no user field in this context
         """
         if (
@@ -19,6 +18,4 @@ def validate(self, field_name, vocabulary_name=None):
             )
         ):
             return True
-        return super(WorkspaceFieldPermissionChecker, self).validate(
-            field_name, vocabulary_name
-        )
+        return super().validate(field_name, vocabulary_name)