From 34daad743338bd75aa45dcaeb4c5356205f52a72 Mon Sep 17 00:00:00 2001 From: Gauthier Bastien Date: Thu, 21 Mar 2013 10:43:44 +0100 Subject: [PATCH] Initial import --- CHANGES.rst | 10 + CONTRIBUTORS.rst | 5 + MANIFEST.in | 3 + README.rst | 32 ++ bootstrap.py | 165 +++++++++ buildout.cfg | 2 + buildout.d/base.cfg | 19 + buildout.d/checkouts.cfg | 3 + buildout.d/development.cfg | 30 ++ buildout.d/jenkins.cfg | 24 ++ buildout.d/sources.cfg | 7 + buildout.d/travis.cfg | 27 ++ buildout.d/versions.cfg | 13 + docs/LICENSE.GPL | 339 ++++++++++++++++++ docs/LICENSE.rst | 17 + setup.py | 59 +++ src/collective/__init__.py | 1 + src/collective/z3cform/__init__.py | 1 + src/collective/z3cform/rolefield/__init__.py | 1 + .../z3cform/rolefield/configure.zcml | 9 + src/collective/z3cform/rolefield/field.py | 98 +++++ .../rolefield/profiles/testing/metadata.xml | 7 + src/collective/z3cform/rolefield/testing.py | 23 ++ src/collective/z3cform/rolefield/testing.zcml | 16 + src/collective/z3cform/rolefield/tests.py | 83 +++++ 25 files changed, 994 insertions(+) create mode 100644 CHANGES.rst create mode 100644 CONTRIBUTORS.rst create mode 100644 MANIFEST.in create mode 100644 README.rst create mode 100644 bootstrap.py create mode 100644 buildout.cfg create mode 100644 buildout.d/base.cfg create mode 100644 buildout.d/checkouts.cfg create mode 100644 buildout.d/development.cfg create mode 100644 buildout.d/jenkins.cfg create mode 100644 buildout.d/sources.cfg create mode 100644 buildout.d/travis.cfg create mode 100644 buildout.d/versions.cfg create mode 100644 docs/LICENSE.GPL create mode 100644 docs/LICENSE.rst create mode 100644 setup.py create mode 100644 src/collective/__init__.py create mode 100644 src/collective/z3cform/__init__.py create mode 100644 src/collective/z3cform/rolefield/__init__.py create mode 100644 src/collective/z3cform/rolefield/configure.zcml create mode 100644 src/collective/z3cform/rolefield/field.py create mode 100644 src/collective/z3cform/rolefield/profiles/testing/metadata.xml create mode 100644 src/collective/z3cform/rolefield/testing.py create mode 100644 src/collective/z3cform/rolefield/testing.zcml create mode 100644 src/collective/z3cform/rolefield/tests.py diff --git a/CHANGES.rst b/CHANGES.rst new file mode 100644 index 0000000..d8bb34c --- /dev/null +++ b/CHANGES.rst @@ -0,0 +1,10 @@ +Changelog +========= + + +0.1 (unreleased) +---------------- + +- Initial release. + [gbastien] + diff --git a/CONTRIBUTORS.rst b/CONTRIBUTORS.rst new file mode 100644 index 0000000..fc8ef7c --- /dev/null +++ b/CONTRIBUTORS.rst @@ -0,0 +1,5 @@ +- Gauthier Bastien, IMIO +- Stéphan Geulette, IMIO +- Vincent Fretin, Ecreall +- Cédric Messiant, Ecreall +- Frédéric Peters, Entr'ouvert diff --git a/MANIFEST.in b/MANIFEST.in new file mode 100644 index 0000000..c7260fa --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1,3 @@ +graft src/ +graft docs/ +include *.cfg *.rst *.in diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..d4863aa --- /dev/null +++ b/README.rst @@ -0,0 +1,32 @@ +.. contents:: + +Introduction +============ + +A z3cform field that manage local roles. This give the ability to assign local roles to selected element (that are by default Plone groups) + +How-to +====== + + +Installation +============ + +* Add collective.z3cform.rolefield to your eggs. +* Re-run buildout. +* Done. + +Tests +===== + +This add-on is tested using Travis CI. The current status of the add-on is : + +.. image:: https://secure.travis-ci.org/collective/collective.z3cform.rolefield.png + :target: http://travis-ci.org/collective/collective.z3cform.rolefield + +Credits +======= + +Have an idea? Found a bug? Let us know by `opening a ticket`_. + +.. _`opening a ticket`: https://github.com/collective/collective.z3cform.rolefield/issues diff --git a/bootstrap.py b/bootstrap.py new file mode 100644 index 0000000..ec3757a --- /dev/null +++ b/bootstrap.py @@ -0,0 +1,165 @@ +############################################################################## +# +# Copyright (c) 2006 Zope Foundation and Contributors. +# All Rights Reserved. +# +# This software is subject to the provisions of the Zope Public License, +# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution. +# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED +# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS +# FOR A PARTICULAR PURPOSE. +# +############################################################################## +"""Bootstrap a buildout-based project + +Simply run this script in a directory containing a buildout.cfg. +The script accepts buildout command-line options, so you can +use the -c option to specify an alternate configuration file. +""" + +import os, shutil, sys, tempfile +from optparse import OptionParser + +tmpeggs = tempfile.mkdtemp() + +usage = '''\ +[DESIRED PYTHON FOR BUILDOUT] bootstrap.py [options] + +Bootstraps a buildout-based project. + +Simply run this script in a directory containing a buildout.cfg, using the +Python that you want bin/buildout to use. + +Note that by using --setup-source and --download-base to point to +local resources, you can keep this script from going over the network. +''' + +parser = OptionParser(usage=usage) +parser.add_option("-v", "--version", help="use a specific zc.buildout version") + +parser.add_option("-t", "--accept-buildout-test-releases", + dest='accept_buildout_test_releases', + action="store_true", default=False, + help=("Normally, if you do not specify a --version, the " + "bootstrap script and buildout gets the newest " + "*final* versions of zc.buildout and its recipes and " + "extensions for you. If you use this flag, " + "bootstrap and buildout will get the newest releases " + "even if they are alphas or betas.")) +parser.add_option("-c", "--config-file", + help=("Specify the path to the buildout configuration " + "file to be used.")) +parser.add_option("-f", "--find-links", + help=("Specify a URL to search for buildout releases")) + + +options, args = parser.parse_args() + +###################################################################### +# load/install distribute + +to_reload = False +try: + import pkg_resources, setuptools + if not hasattr(pkg_resources, '_distribute'): + to_reload = True + raise ImportError +except ImportError: + ez = {} + + try: + from urllib.request import urlopen + except ImportError: + from urllib2 import urlopen + + exec(urlopen('http://python-distribute.org/distribute_setup.py').read(), ez) + setup_args = dict(to_dir=tmpeggs, download_delay=0, no_fake=True) + ez['use_setuptools'](**setup_args) + + if to_reload: + reload(pkg_resources) + import pkg_resources + # This does not (always?) update the default working set. We will + # do it. + for path in sys.path: + if path not in pkg_resources.working_set.entries: + pkg_resources.working_set.add_entry(path) + +###################################################################### +# Install buildout + +ws = pkg_resources.working_set + +cmd = [sys.executable, '-c', + 'from setuptools.command.easy_install import main; main()', + '-mZqNxd', tmpeggs] + +find_links = os.environ.get( + 'bootstrap-testing-find-links', + options.find_links or + ('http://downloads.buildout.org/' + if options.accept_buildout_test_releases else None) + ) +if find_links: + cmd.extend(['-f', find_links]) + +distribute_path = ws.find( + pkg_resources.Requirement.parse('distribute')).location + +requirement = 'zc.buildout' +version = options.version +if version is None and not options.accept_buildout_test_releases: + # Figure out the most recent final version of zc.buildout. + import setuptools.package_index + _final_parts = '*final-', '*final' + def _final_version(parsed_version): + for part in parsed_version: + if (part[:1] == '*') and (part not in _final_parts): + return False + return True + index = setuptools.package_index.PackageIndex( + search_path=[distribute_path]) + if find_links: + index.add_find_links((find_links,)) + req = pkg_resources.Requirement.parse(requirement) + if index.obtain(req) is not None: + best = [] + bestv = None + for dist in index[req.project_name]: + distv = dist.parsed_version + if _final_version(distv): + if bestv is None or distv > bestv: + best = [dist] + bestv = distv + elif distv == bestv: + best.append(dist) + if best: + best.sort() + version = best[-1].version +if version: + requirement = '=='.join((requirement, version)) +cmd.append(requirement) + +import subprocess +if subprocess.call(cmd, env=dict(os.environ, PYTHONPATH=distribute_path)) != 0: + raise Exception( + "Failed to execute command:\n%s", + repr(cmd)[1:-1]) + +###################################################################### +# Import and run buildout + +ws.add_entry(tmpeggs) +ws.require(requirement) +import zc.buildout.buildout + +if not [a for a in args if '=' not in a]: + args.append('bootstrap') + +# if -c was provided, we push it back into args for buildout' main function +if options.config_file is not None: + args[0:0] = ['-c', options.config_file] + +zc.buildout.buildout.main(args) +shutil.rmtree(tmpeggs) diff --git a/buildout.cfg b/buildout.cfg new file mode 100644 index 0000000..3def417 --- /dev/null +++ b/buildout.cfg @@ -0,0 +1,2 @@ +[buildout] +extends = buildout.d/development.cfg diff --git a/buildout.d/base.cfg b/buildout.d/base.cfg new file mode 100644 index 0000000..7666a8f --- /dev/null +++ b/buildout.d/base.cfg @@ -0,0 +1,19 @@ +[buildout] +package-name = collective.z3cform.rolefield +package-extras = [test] + +show-picked-versions = true +allow-picked-versions = false + +extends = + https://raw.github.com/collective/buildout.plonetest/master/plone-4.2.x.cfg + https://raw.github.com/plone/buildout.dexterity/master/sources.cfg + checkouts.cfg + sources.cfg + versions.cfg + +develop = . + +eggs += + Pillow + ipdb diff --git a/buildout.d/checkouts.cfg b/buildout.d/checkouts.cfg new file mode 100644 index 0000000..d5798b1 --- /dev/null +++ b/buildout.d/checkouts.cfg @@ -0,0 +1,3 @@ +[buildout] +always-checkout = force +auto-checkout += diff --git a/buildout.d/development.cfg b/buildout.d/development.cfg new file mode 100644 index 0000000..5ee5895 --- /dev/null +++ b/buildout.d/development.cfg @@ -0,0 +1,30 @@ +[buildout] +extends = + base.cfg + +eggs += + plone.reload + Products.PDBDebugMode + Products.DocFinderTab + aws.zope2zcmldoc + collective.profiler + +extensions += + mr.developer + +parts += + omelette + test + +allow-picked-versions = true + +[omelette] +recipe = collective.recipe.omelette +eggs = ${test:eggs} + +[test] +recipe = zc.recipe.testrunner +eggs = + ${buildout:eggs} + ${buildout:package-name} ${buildout:package-extras} +defaults = ['-s', '${buildout:package-name}', '--auto-color', '--auto-progress'] diff --git a/buildout.d/jenkins.cfg b/buildout.d/jenkins.cfg new file mode 100644 index 0000000..d30c4d2 --- /dev/null +++ b/buildout.d/jenkins.cfg @@ -0,0 +1,24 @@ +[buildout] +extends = + base.cfg + https://raw.github.com/plone/buildout.jenkins/master/jenkins.cfg + https://raw.github.com/plone/buildout.jenkins/master/jenkins-code-analysis.cfg + +jenkins-test-eggs = ${buildout:package-name} ${buildout:package-extras} +jenkins-test-directories = src/collective.contact/plonegroup + +parts += pylint + +[pylint] +recipe = zc.recipe.egg +eggs = pylint + ${buildout:eggs} +scripts = pylint +entry-points = pylint=pylint.lint:Run +arguments = [ + '--output-format=parseable', + '--zope=y', + '--reports=y', + '--disable=E0611,F0401,W0232,E1101,C0103,C0111,R0201,W0201,R0911,R0904,F0220,E1103,R0901,E0211,E0213,E1002,W0622,C0301,W0212,R0903', + '--generated-members=objects', + ] + (sys.argv[1:] or ["${buildout:jenkins-test-directories}"]) diff --git a/buildout.d/sources.cfg b/buildout.d/sources.cfg new file mode 100644 index 0000000..d253567 --- /dev/null +++ b/buildout.d/sources.cfg @@ -0,0 +1,7 @@ +[remotes] +collective = git://github.com/collective +collective_push = git@github.com:collective +plone = git://github.com/plone +plone_push = git@github.com:plone + +[sources] diff --git a/buildout.d/travis.cfg b/buildout.d/travis.cfg new file mode 100644 index 0000000..2416d47 --- /dev/null +++ b/buildout.d/travis.cfg @@ -0,0 +1,27 @@ +[buildout] +extends = + base.cfg + +parts = + download + install + test + +# network speedup +eggs-directory = buildout-cache/eggs +download-cache = buildout-cache/downloads + +socket-timeout = 3 + +allow-hosts = + *.python.org + launchpad.net + +[download] +recipe = hexagonit.recipe.download +url = https://launchpad.net/plone/4.2/4.2.3/+download/Plone-4.2.3-UnifiedInstaller.tgz + +[install] +recipe = collective.recipe.cmd +on_install = true +cmds = tar jxvf ${download:location}/Plone-4.2.3-UnifiedInstaller/packages/buildout-cache.tar.bz2 1>/dev/null diff --git a/buildout.d/versions.cfg b/buildout.d/versions.cfg new file mode 100644 index 0000000..915225c --- /dev/null +++ b/buildout.d/versions.cfg @@ -0,0 +1,13 @@ +[versions] +Pillow = 1.7.8 +Products.DocFinderTab = 1.0.5 +Products.PDBDebugMode = 1.3.1 +aws.zope2zcmldoc = 1.1.0 +collective.profiler = 0.3 +ecreall.helpers.testing = 1.3 +ipdb = 0.7 +ipython = 0.13.1 + +# Required by: +# collective.profiler==0.3 +profilehooks = 1.6 diff --git a/docs/LICENSE.GPL b/docs/LICENSE.GPL new file mode 100644 index 0000000..d159169 --- /dev/null +++ b/docs/LICENSE.GPL @@ -0,0 +1,339 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License along + with this program; if not, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + , 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. diff --git a/docs/LICENSE.rst b/docs/LICENSE.rst new file mode 100644 index 0000000..2bb9fce --- /dev/null +++ b/docs/LICENSE.rst @@ -0,0 +1,17 @@ +bobtemplates.ecreall Copyright 2013, "Cédric Messiant" + +This program is free software; you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation; either version 2 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program; if not, write to the Free Software +Foundation, Inc., 59 Temple Place, Suite 330, Boston, +MA 02111-1307 USA. + diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..8b5a1b7 --- /dev/null +++ b/setup.py @@ -0,0 +1,59 @@ +# -*- coding: utf-8 -*- +"""Installer for the collective.contact.plonegroup package.""" + +from setuptools import find_packages +from setuptools import setup + + +long_description = ( + open('README.rst').read() + + '\n' + + 'Contributors\n' + '============\n' + + '\n' + + open('CONTRIBUTORS.rst').read() + + '\n' + + open('CHANGES.rst').read() + + '\n') + + +setup( + name='collective.contact.plonegroup', + version='0.1', + description="Organizations and functions combinations to create plone groups", + long_description=long_description, + # Get more from http://pypi.python.org/pypi?%3Aaction=list_classifiers + classifiers=[ + "Environment :: Web Environment", + "Framework :: Plone", + "Framework :: Plone :: 4.2", + "Programming Language :: Python", + "Programming Language :: Python :: 2.7", + ], + keywords='', + author='Ecreall, Entrouvert, IMIO', + author_email='s.geulette@imio.be', + url='http://pypi.python.org/pypi/collective.contact.plonegroup', + license='GPL', + packages=find_packages('src', exclude=['ez_setup']), + namespace_packages=['collective', 'collective.contact'], + package_dir={'': 'src'}, + include_package_data=True, + zip_safe=False, + install_requires=[ + 'five.grok', + 'plone.api', + 'setuptools', + 'collective.contact.core', + ], + extras_require={ + 'test': [ + 'ecreall.helpers.testing', + 'plone.app.testing', + ], + }, + entry_points=""" + [z3c.autoinclude.plugin] + target = plone + """, +) diff --git a/src/collective/__init__.py b/src/collective/__init__.py new file mode 100644 index 0000000..de40ea7 --- /dev/null +++ b/src/collective/__init__.py @@ -0,0 +1 @@ +__import__('pkg_resources').declare_namespace(__name__) diff --git a/src/collective/z3cform/__init__.py b/src/collective/z3cform/__init__.py new file mode 100644 index 0000000..de40ea7 --- /dev/null +++ b/src/collective/z3cform/__init__.py @@ -0,0 +1 @@ +__import__('pkg_resources').declare_namespace(__name__) diff --git a/src/collective/z3cform/rolefield/__init__.py b/src/collective/z3cform/rolefield/__init__.py new file mode 100644 index 0000000..40a96af --- /dev/null +++ b/src/collective/z3cform/rolefield/__init__.py @@ -0,0 +1 @@ +# -*- coding: utf-8 -*- diff --git a/src/collective/z3cform/rolefield/configure.zcml b/src/collective/z3cform/rolefield/configure.zcml new file mode 100644 index 0000000..4318cb7 --- /dev/null +++ b/src/collective/z3cform/rolefield/configure.zcml @@ -0,0 +1,9 @@ + + + + + diff --git a/src/collective/z3cform/rolefield/field.py b/src/collective/z3cform/rolefield/field.py new file mode 100644 index 0000000..7f02f9b --- /dev/null +++ b/src/collective/z3cform/rolefield/field.py @@ -0,0 +1,98 @@ +# -*- coding: utf-8 -*- +from zope.component import adapts +from zope.interface import implementer +from zope.interface import Interface + +from zope.schema.interfaces import IList +from zope.schema import List, Tuple +from zope.interface import Invalid + +from z3c.form.datamanager import AttributeField + +import logging +logger = logging.getLogger('collective.z3cform.rolefield') + + +class ILocalRolesToPrincipals(IList): + """Field that list principals depending on a vocabulary (by default list every available groups) + and that assign local roles defined in the roles_to_assign attribute.""" + + # this attribute will contains a tuple of principal to assign when the value is set + roles_to_assign = Tuple( + title=u"Roles to assign", + description=u"""\ + Roles that will be automatically assigned as local roles to selected principals. + """, + required=True) + + +@implementer(ILocalRolesToPrincipals) +class LocalRolesToPrincipals(List): + """Field that list principals depending on a vocabulary (by default list every available groups) + and that assign local roles defined in the roles_to_assign attribute.""" + + def __init__(self, roles_to_assign=(), **kw): + self.roles_to_assign = roles_to_assign + super(LocalRolesToPrincipals, self).__init__(**kw) + + def validate(self, value): + """Check that we have roles to assign, this is mendatory and + that roles we want to assign actually exist.""" + super(LocalRolesToPrincipals, self)._validate(value) + + # the field must specify some roles to assign as this is a required value + if not self.roles_to_assign: + raise Invalid(u'The field is not configured correctly, roles_to_assign is required. " \ + "Contact system administrator!') + + # check that roles we want to assign actually exist + existingRoles = [role for role in self.context.acl_users.portal_role_manager.listRoleIds()] + for role_to_assign in self.roles_to_assign: + if not role_to_assign in existingRoles: + raise Invalid(u'The field is not configured correctly, the defined role \'%s\' does not exist. " \ + "Contact system administrator!' % role_to_assign) + + +class LocalRolesToPrincipalsDataManager(AttributeField): + """A data manager which set local roles when saving the field.""" + adapts(Interface, ILocalRolesToPrincipals) + + def set(self, value): + """See z3c.form.interfaces.IDataManager""" + # set local roles before setting the value so we still have access to the old value + roles_to_assign = self.field.roles_to_assign + # ---1 --- first find assigned roles to remove + # it is not that easy to remove local roles because no helper method exists for removing + # some specific local roles, only a method for removing every local roles for a list of principals... + old_value = self.field.get(self.context) or () + # now check between old_value and value (new value) what is missing + removed_principals = set(old_value).difference(set(value)) + # remove local_roles for removed_principals + for local_role in self.context.get_local_roles(): + # a local_role is like ('Administrators', (u'Contributor', u'Reviewer')) + principal = local_role[0] + if principal in removed_principals: + cleaned_local_roles = list(local_role[1]) + for role_to_assign in roles_to_assign: + try: + cleaned_local_roles.remove(role_to_assign) + except ValueError: + # if a role to remove was already removed (???) pass + logger.warn("Failed to remove role '%s' for principal '%s' on object '%s'" \ + % (role_to_assign, principal, '/'.join(self.context.getPhysicalPath()))) + # if there are still some local_roles, use manage_setLocalRoles + if cleaned_local_roles: + self.context.manage_setLocalRoles(principal, cleaned_local_roles) + else: + # either use manage_delLocalRoles + self.context.manage_delLocalRoles((principal,)) + # ---2 --- now add new local roles + added_principals = set(value).difference(set(old_value)) + for added_principal in added_principals: + self.context.manage_addLocalRoles(added_principal, roles_to_assign) + # finally set the value + super(LocalRolesToPrincipalsDataManager, self).set(value) + +import plone.supermodel.exportimport + +LocalRolesToPrincipalsHandler = plone.supermodel.exportimport.BaseHandler(LocalRolesToPrincipals) diff --git a/src/collective/z3cform/rolefield/profiles/testing/metadata.xml b/src/collective/z3cform/rolefield/profiles/testing/metadata.xml new file mode 100644 index 0000000..91193e3 --- /dev/null +++ b/src/collective/z3cform/rolefield/profiles/testing/metadata.xml @@ -0,0 +1,7 @@ + + + 1 + + profile-collective.contact.plonegroup:default + + \ No newline at end of file diff --git a/src/collective/z3cform/rolefield/testing.py b/src/collective/z3cform/rolefield/testing.py new file mode 100644 index 0000000..62fbc4c --- /dev/null +++ b/src/collective/z3cform/rolefield/testing.py @@ -0,0 +1,23 @@ +# -*- coding: utf-8 -*- +from plone.testing import z2, zca +from plone.app.testing import PloneWithPackageLayer +from plone.app.testing import FunctionalTesting +import collective.z3cform.rolefield + + +ROLEFIELD_ZCML = zca.ZCMLSandbox(filename="testing.zcml", + package=collective.z3cform.rolefield, + name='ROLEFIELD_ZCML') + +ROLEFIELD_Z2 = z2.IntegrationTesting(bases=(z2.STARTUP, ROLEFIELD_ZCML), + name='ROLEFIELD_Z2') + +ROLEFIELD = PloneWithPackageLayer( + zcml_filename="testing.zcml", + zcml_package=collective.z3cform.rolefield, + additional_z2_products=(), + gs_profile_id='collective.z3cform.rolefield:testing', + name="WS4ROLEFIELD") + +ROLEFIELD_PROFILE_FUNCTIONAL = FunctionalTesting( + bases=(ROLEFIELD,), name="ROLEFIELD_PROFILE_FUNCTIONAL") diff --git a/src/collective/z3cform/rolefield/testing.zcml b/src/collective/z3cform/rolefield/testing.zcml new file mode 100644 index 0000000..764bde6 --- /dev/null +++ b/src/collective/z3cform/rolefield/testing.zcml @@ -0,0 +1,16 @@ + + + + + + + diff --git a/src/collective/z3cform/rolefield/tests.py b/src/collective/z3cform/rolefield/tests.py new file mode 100644 index 0000000..3200ad8 --- /dev/null +++ b/src/collective/z3cform/rolefield/tests.py @@ -0,0 +1,83 @@ +# -*- coding: utf8 -*- + +import unittest2 as unittest + +from zope.interface import Invalid + +from plone.app.testing.helpers import setRoles + +from ecreall.helpers.testing.base import BaseTest + +from collective.z3cform.rolefield.testing import ROLEFIELD_PROFILE_FUNCTIONAL +from collective.z3cform.rolefield.field import LocalRolesToPrincipalsDataManager + + +class TestFields(unittest.TestCase, BaseTest): + """Tests adapters""" + + layer = ROLEFIELD_PROFILE_FUNCTIONAL + + def setUp(self): + super(TestFields, self).setUp() + self.portal = self.layer['portal'] + + def _getTargetClass(self): + from collective.dms.basecontent._field import LocalRolesToPrincipals + return LocalRolesToPrincipals + + def _makeOne(self, *args, **kw): + field = self._getTargetClass()(*args, **kw) + # this is needed to initialize the vocabulary + return field.bind(self.portal) + + def test_roles_to_assign_attribute(self): + """If the field is not correctly configured, it fails upon validation.""" + field = self._makeOne() + # the roles_to_assign attribute is required, if empty, validate fails + self.assertEquals(field.roles_to_assign, ()) + self.assertRaises(Invalid, field.validate, []) + # if we want to assign role but one does not exist, validate fails too + field = self._makeOne(roles_to_assign=('Editor', 'WrongRole',)) + self.assertRaises(Invalid, field.validate, []) + # if we have valid values, it works like a charm ;-) + field = self._makeOne(roles_to_assign=('Editor', 'Reader',)) + field.validate([]) + + def test_datamanager(self): + """Test the local_roles assignment mechanism managed by the datamanager.""" + testingfield = self.portal.portal_types.testingtype.lookupSchema()['testingField'] + testingfield.roles_to_assign = ('Editor', 'Contributor',) + # first create a sample object + # make the default user a Manager + member = self.portal.portal_membership.getAuthenticatedMember() + setRoles(self.portal, member.getId(), ('Manager',)) + # create an object + self.portal.invokeFactory('testingtype', id='testingobj') + testingobj = getattr(self.portal, 'testingobj') + datamanager = LocalRolesToPrincipalsDataManager(testingobj, testingfield) + self.failIf('Administrators' in testingobj.__ac_local_roles__.keys()) + datamanager.set(('Administrators',)) + # now we have local_roles for 'Administrators' + self.failUnless('Administrators' in testingobj.__ac_local_roles__.keys()) + # moreover, local_roles for 'Administrators' are ('Editor', 'Contributor',) + self.assertEquals(tuple(testingobj.__ac_local_roles__['Administrators']), testingfield.roles_to_assign) + # add a principal, test that local_roles are adapted + self.failIf('Reviewers' in testingobj.__ac_local_roles__.keys()) + # the value is now ('Administrators', 'Reviewers',) + datamanager.set(('Administrators', 'Reviewers',)) + self.failUnless('Reviewers' in testingobj.__ac_local_roles__.keys()) + self.assertEquals(tuple(testingobj.__ac_local_roles__['Reviewers']), testingfield.roles_to_assign) + # remove a group, check managed roles + # removing a group is made by passing new value where an existing group is no more present + self.failUnless('Administrators' in testingobj.__ac_local_roles__.keys()) + datamanager.set(('Reviewers',)) + self.failIf('Administrators' in testingobj.__ac_local_roles__.keys()) + # if an external manipulation added a local_role not managed by the field, it is kept + # add a local_role for 'Reviewers' not managed by our field + self.assertEquals(tuple(testingobj.__ac_local_roles__['Reviewers']), testingfield.roles_to_assign) + testingobj.manage_addLocalRoles('Reviewers', ('Reader',)) + self.assertEquals(tuple(testingobj.__ac_local_roles__['Reviewers']), testingfield.roles_to_assign + ('Reader',)) + # remove the 'Reviewers' local_roles + datamanager.set(()) + # not managed local_roles are kepts + self.assertEquals(tuple(testingobj.__ac_local_roles__['Reviewers']), ('Reader',))