From a63c5b7dc9d681a8ec6bcf60b3f7a034e75d2f2f Mon Sep 17 00:00:00 2001 From: "Karl O. Pinc" Date: Fri, 20 Nov 2020 12:38:56 -0600 Subject: [PATCH] Initial commit --- .coveragerc | 7 + .gitignore | 11 + LICENSE.txt | 661 +++++++++++++++++++++++++++ MANIFEST.in | 10 + Makefile | 25 + Makefile_pgwui.mk | 229 ++++++++++ README.rst | 123 +++++ help.mk | 21 + setup.cfg | 3 + setup.py | 171 +++++++ src/pgwui_menu/VERSION | 1 + src/pgwui_menu/__init__.py | 22 + src/pgwui_menu/pgwui_menu.py | 49 ++ src/pgwui_menu/static/pgwui_menu.css | 27 ++ src/pgwui_menu/templates/menu.mak | 72 +++ src/pgwui_menu/views/__init__.py | 0 src/pgwui_menu/views/menu.py | 55 +++ tests/test_menu.py | 116 +++++ tests/test_pgwui_menu.py | 70 +++ tox.ini | 36 ++ 20 files changed, 1709 insertions(+) create mode 100644 .coveragerc create mode 100644 .gitignore create mode 100644 LICENSE.txt create mode 100644 MANIFEST.in create mode 100644 Makefile create mode 100644 Makefile_pgwui.mk create mode 100644 README.rst create mode 100644 help.mk create mode 100644 setup.cfg create mode 100644 setup.py create mode 100644 src/pgwui_menu/VERSION create mode 100644 src/pgwui_menu/__init__.py create mode 100644 src/pgwui_menu/pgwui_menu.py create mode 100644 src/pgwui_menu/static/pgwui_menu.css create mode 100644 src/pgwui_menu/templates/menu.mak create mode 100644 src/pgwui_menu/views/__init__.py create mode 100644 src/pgwui_menu/views/menu.py create mode 100644 tests/test_menu.py create mode 100644 tests/test_pgwui_menu.py create mode 100644 tox.ini diff --git a/.coveragerc b/.coveragerc new file mode 100644 index 0000000..626d99b --- /dev/null +++ b/.coveragerc @@ -0,0 +1,7 @@ +[run] +branch = True +source = + pgwui_menu + +[report] +show_missing = True diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..599ef10 --- /dev/null +++ b/.gitignore @@ -0,0 +1,11 @@ +__pycache__/ +.pytest_cache/ +.cache/ +.coverage +.tox/ +build/ +devel/ +dist/ +docs/build/ +README.html +src/pgwui_menu.egg-info/ diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..dba13ed --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + 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 +them 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. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey 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; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If 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 convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero 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 that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + 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. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +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. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + 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 +state 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 Affero General Public License as published by + the Free Software Foundation, either version 3 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 Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +. diff --git a/MANIFEST.in b/MANIFEST.in new file mode 100644 index 0000000..2fd4c0b --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1,10 @@ +recursive-include tests *.py +# Include Makefile includes +include *.mk +include .coveragerc +include LICENSE.txt +include Makefile +include src/pgwui_menu/static/*.css +include src/pgwui_menu/templates/*.mak +include src/pgwui_menu/VERSION +include tox.ini diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..592dbd2 --- /dev/null +++ b/Makefile @@ -0,0 +1,25 @@ +# Copyright (C) 2016, 2017, 2018, 2019, 2020 The Meme Factory, Inc. +# http://www.karlpinc.com/ + +# This file is part of PGWUI_Menu. +# +# This program is free software: you can redistribute it and/or +# modify it under the terms of the GNU Affero General Public License +# as published by the Free Software Foundation, either version 3 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 +# Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public +# License along with this program. If not, see +# . +# + +# Karl O. Pinc + +PGWUI_NAME := menu + +include Makefile_pgwui.mk diff --git a/Makefile_pgwui.mk b/Makefile_pgwui.mk new file mode 100644 index 0000000..f0604ed --- /dev/null +++ b/Makefile_pgwui.mk @@ -0,0 +1,229 @@ +# Copyright (C) 2016, 2017, 2018, 2019 The Meme Factory, Inc. +# http://www.karlpinc.com/ + +# This file is part of PGWUI. +# +# This program is free software: you can redistribute it and/or +# modify it under the terms of the GNU Affero General Public License +# as published by the Free Software Foundation, either version 3 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 +# Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public +# License along with this program. If not, see +# . +# + +# Karl O. Pinc + +# +# Common Makefile for PGWUI projects +# + +# Variables to customize: +# PGWUI_NAME := example + + +# This works on debian... +PYTHON_EXE=python3 +VIRTUALENV=virtualenv -p ${PYTHON_EXE} + +TARGETS = +EXTRA_TARGETS = README.html +SETUPTOOLS_STUFF = build dist src/pgwui_${PGWUI_NAME}.egg-info +PYTEST_STUFF = .cache \ + src/pgwui_${PGWUI_NAME}/__pycache__ \ + src/pgwui_${PGWUI_NAME}/views/__pycache__ \ + tests/__pycache__ tests/views/__pycache__ +COVERAGE_STUFF = .coverage +TOX_STUFF = .tox + +include help.mk + +all: ${TARGETS} + +## +## Usage: make TARGET +## +## TARGET is one of: +# + +## README.html Make html version of README.rst +README.html: README.rst + rst2html --strict README.rst > README.html + +## publish Update all public-facing info +## ("check-manifest" + "upload" + "push") +.PHONY: publish +publish: check-manifest upload push + +## run_tests Run regression tests +.PHONY: run_tests +run_tests: devel/testenv + devel/testenv/bin/tox --skip-missing-interpreters + +## dist Create sdist Python package in ./dist +.PHONY: dist +dist: + rm -rf dist + ${PYTHON_EXE} setup.py sdist + + +# Expected targets + +## clean Removed generated data +.PHONY: clean +clean: + #$(MAKE) -C docs clean + rm -rf ${TARGETS} ${EXTRA_TARGETS} ${SETUPTOOLS_STUFF} \ + ${PYTEST_STUFF} ${COVERAGE_STUFF} ${TOX_STUFF} devel + +## +## Less used TARGETS are: +# + + +# Useless targets + +## register_test Register project at pypi test site +.PHONY: register_test +register_test: + ${PYTHON_EXE} setup.py register -r https://testpypi.python.org/pypi + +## register Register project at pypi live site +.PHONY: register +register: + ${PYTHON_EXE} setup.py register + + +# Not so useless targets, used by the package owners for package management + +## upload_test Upload project to pypi test site +.PHONY: upload_test +upload_test: + ${PYTHON_EXE} setup.py sdist upload -r https://testpypi.python.org/pypi + +## upload Upload project to pypi live site +.PHONY: upload +upload: + ${PYTHON_EXE} setup.py sdist upload + +## push Push repo changes to public repo +## (Hooks at bitbucket update readthedocs) +.PHONY: push + git push + +## check Quick run of all regression tests, +## only with the default python +.PHONY: check +check: devel/pytest + devel/pytest/bin/flake8 . + devel/pytest/bin/py.test --cov=pgwui_${PGWUI_NAME} tests + +## check-unit Quick run of unit regression tests, +## only with the default python +.PHONY: check-unit +check-unit: devel/pytest + devel/pytest/bin/flake8 . + devel/pytest/bin/py.test -m unittest --cov=pgwui_${PGWUI_NAME} tests + +## check-integration Quick run of integration regression tests, +## only with the default python +.PHONY: check-integration +check-integration: devel/pytest + devel/pytest/bin/flake8 . + devel/pytest/bin/py.test -m integrationtest \ + --cov=pgwui_${PGWUI_NAME} tests + +## pudb Run the python pudb debugger +.PHONY: pudb +pudb: devel/pudb + # echo 'import pudb; pu.db' | devel/pudb/bin/python + devel/pudb/bin/python + +## devel/check-manifest +## Create a check-manifest venv +devel/check-manifest: devel + [ -d devel/check-manifest ] \ + || ( ${VIRTUALENV} devel/check-manifest ; \ + devel/check-manifest/bin/pip install --upgrade pip ; \ + devel/check-manifest/bin/pip install --upgrade setuptools ; \ + devel/check-manifest/bin/pip install check-manifest ) + +## check-manifest Run check-manifest +check-manifest: devel/check-manifest + devel/check-manifest/bin/check-manifest + +## update_check-manifest +## Upgrade check-manifest venv to latest +## versions +update_check-manifest: devel/check-manifest + devel/check-manifest/bin/pip -U + +## update_testenv Upgrade test venv to latest versions +update_testenv: devel/testenv + devel/testenv/bin/pip -U + +## help Show this help +## +## This Makefile does not work with the docs. See: +## cd docs; make help + + +# Development related targets + +# Re-create development environment when setup.py changes +devel: setup.py + rm -rf devel ${TOX_STUFF} + mkdir devel + +# virtualenv for development +devel/testenv: devel + [ -d devel/testenv ] \ + || ( ${VIRTUALENV} devel/testenv ; \ + devel/testenv/bin/pip install --upgrade pip ; \ + devel/testenv/bin/pip install --upgrade setuptools ; \ + devel/testenv/bin/pip install tox ; \ + devel/testenv/bin/pip install -e '.[testing]' ; \ + ) + +# virtualenv for pytest +devel/pytest: devel dist + if [ ! -d devel/pytest ] ; then \ + ( ${VIRTUALENV} devel/pytest ; \ + devel/pytest/bin/pip install --upgrade pip ; \ + devel/pytest/bin/pip install --upgrade setuptools ; \ + devel/pytest/bin/pip install --upgrade wheel ; \ + devel/pytest/bin/pip install dist/pgwui_${PGWUI_NAME}-*.tar.gz ; \ + devel/pytest/bin/pip install flake8 ; \ + devel/pytest/bin/pip install pytest-cov ; \ + devel/pytest/bin/pip install -e '.[testing]' ; \ + ) \ + else \ + ( devel/pytest/bin/pip uninstall -y pgwui_${PGWUI_NAME} ; \ + devel/pytest/bin/pip install dist/pgwui_${PGWUI_NAME}-*.tar.gz ; \ + devel/pytest/bin/pip install -e '.[testing]' ; \ + ) ; \ + fi + +# virtualenv for pudb +devel/pudb: devel dist + if [ ! -d devel/pudb ] ; then \ + ( ${VIRTUALENV} devel/pudb ; \ + devel/pudb/bin/pip install --upgrade pip ; \ + devel/pudb/bin/pip install --upgrade setuptools ; \ + devel/pudb/bin/pip install --upgrade wheel ; \ + devel/pudb/bin/pip install dist/pgwui_${PGWUI_NAME}-*.tar.gz ; \ + devel/pudb/bin/pip install -e '.[testing]' ; \ + devel/pudb/bin/pip install pudb ; \ + ) \ + else \ + ( devel/pudb/bin/pip uninstall -y pgwui_${PGWUI_NAME} ; \ + devel/pudb/bin/pip install -e '.[testing]' ; \ + devel/pudb/bin/pip install dist/pgwui_${PGWUI_NAME}-*.tar.gz \ + ) ; \ + fi diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..bda52b5 --- /dev/null +++ b/README.rst @@ -0,0 +1,123 @@ +.. Copyright (C) 2018, 2020 The Meme Factory, Inc. http://www.karlpinc.com/ + + + This file is part of PGWUI_Menu. + + This program is free software: you can redistribute it and/or + modify it under the terms of the GNU Affero General Public License + as published by the Free Software Foundation, either version 3 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 + Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public + License along with this program. If not, see + . + + Karl O. Pinc + +.. #End Of Copyright Marker# + +PGWUI_Menu +========== + +Short Documentation +------------------- + +PGWUI_Menu stands for `PostgreSQL`_ Web User Interface, Menu. + +Provides a menu for the web interfaces which are a part of the PGWUI +package suite. + +The PGWUI package suite is a Python framework for creating +`PostgreSQL`_ web user interfaces, and a collection of user interfaces +built using the framework. The focus is on interfaces supporting +bulk data upload or download, on execution of batches of arbitrary +SQL, and on transactions. A distinguishing feature is an emphasis on +discovering and reporting as many errors as is possible per bulk +interaction with the database. + +PGWUI_Menu provides: + + * Extendable web forms with automatically generated menu items for + installed PGWUI components. These forms are rendered using + `Pyramid`_ views. + +The official PGWUI components based on PGWUI_Menu are highly +configurable. The web page templates used to generate HTML files, the +CSS files, the static HTML files, and the location of the web pages +within the "URL space" can all be altered without programming. + +It is relatively easy to create alternate "skins" for the user +interface. Naturally some exposure to HTML, CSS, and URL concepts are +helpful. Extensive alterations to error presentation may require some +experience with the Mako HTML templating system and/or the Python +programming language. + + +Usage +----- + +PGWUI components can be automatically added to the menu. Every +component must have a 'pgwui.components' entry point. The name of the +component's entry point is used to look up its menu properties; the +name of the configuration directive which configures the pgwui +component is the component name itself. E.g. To configure the +pgwui_upload component's menu item, "pgwui_upload" is the +configuration directive. This configuration directive is a map and +must contain the following elements:: menu_label The label of the menu +item + +An example configuration directive for PGWUI_Upload:: + + pgwui.pgwui_upload = + menu_label = upload -- Upload File Into Database + + +See the PGWUI_Common documentation if you wish to write your +own `Pyramid`_ application or wish more control and want to +configure using Python code. + + +Development Status +------------------ + +Although in use in production systems, and suitable for production +use, PGWUI_Menu must be considered Beta code. There is a reasonable +likelihood that it may undergo some change before final Production +release. Install a specific version of PGWUI_Menu to ensure a +backwards incompatible change does not break your code. + + +Complete Documentation +---------------------- + +The complete documentation set can be found on the PGWUI_Menu home page at +http://pgwui_menu.readthedocs.io/. + + +License +------- + +Except for files otherwise marked, distributed WITHOUT ANY WARRANTY +under the terms of the GNU Affero General Public License, version 3 or +a later version at your option. See the copyright notices at the top +of each file and the LICENSE.txt file for details. + + +Acknowledgments +--------------- + +The PGWUI_Menu code is based on the GMI_Pyramid sub-system created for +the `Gombe Mother Infant Database Project +`_. Support for extracting PGWUI_Core +from GMI_Pyramid, its Python packaging, and further enhancement was +provided by `The Dian Fossey Gorilla Fund +`_. + + +.. _PostgreSQL: https://www.postgresql.org/ +.. _Pyramid: https://trypyramid.com/ diff --git a/help.mk b/help.mk new file mode 100644 index 0000000..9893c10 --- /dev/null +++ b/help.mk @@ -0,0 +1,21 @@ +# Generate help summary from Makefile content +# Copyright (C) 2019 The Meme Factory, Inc. www.karlpinc.com +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 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 Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . + +# Use this by putting the following line into your Makefile: +# include help.mk + +help: + @grep -Eh '^##($$| )' $(MAKEFILE_LIST) | sed -E 's/^##($$| )//' diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 0000000..24eff81 --- /dev/null +++ b/setup.cfg @@ -0,0 +1,3 @@ +[bdist_wheel] +# Work with both python 2 and 3. +universal=1 diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..e6c218c --- /dev/null +++ b/setup.py @@ -0,0 +1,171 @@ +"""A setuptools based setup module. + +Copied from: +https://github.com/pypa/sampleproject +It's license applies to this file. +""" +# Copyright (c) 2016 The Python Packaging Authority (PyPA) +# +# Permission is hereby granted, free of charge, to any person obtaining a +# copy of this software and associated documentation files (the "Software"), +# to deal in the Software without restriction, including without limitation +# the rights to use, copy, modify, merge, publish, distribute, sublicense, +# and/or sell copies of the Software, and to permit persons to whom the +# Software is furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +# DEALINGS IN THE SOFTWARE. + + +# Always prefer setuptools over distutils +from setuptools import setup, find_packages +# To use a consistent encoding +from codecs import open +from os import path + + +# Get the long description from the README file +def filter_readme(): + '''Return README content with copyright at top removed''' + lines = [] + past_copyright = False + with open(path.join(here, 'README.rst'), encoding='utf-8') as f: + for line in f: + if past_copyright: + lines.append(line) + else: + if line == '.. #End Of Copyright Marker#\n': + past_copyright = True + return ''.join(lines) + + +here = path.abspath(path.dirname(__file__)) + +# Get program version +with open(path.join(here, 'src', 'pgwui_menu', 'VERSION'), + encoding='utf-8') as version_file: + version = version_file.read().strip() + +# Get the long description from the README file +long_description = filter_readme() + +# Pyramid testing requirements +tests_require = [ + 'pgwui_testing==' + version, + 'WebTest >= 1.3.1', # py3 compat + 'pytest>=3.7.4', + 'pytest-cov', +] + +setup( + name='pgwui_menu', + + # Versioning is major.minor.fixes. Major releases change (after 1.0.0) + # when backward incompatibility is introduced. Minor releases introduce + # new features. Fix releases introduce fixes. + version=version, + + description='Shared files for PGWUI Postgres web interfaces.', + long_description=long_description, + long_description_content_type='text/x-rst', + + # The project's main homepage. + url='http://pgwui_menu.readthedocs.io/', + + # Author details + author='Karl O. Pinc', + author_email='kop@karlpinc.com', + + # Choose your license + license='AGPLv3+', + + # See https://pypi.python.org/pypi?%3Aaction=list_classifiers + classifiers=[ + # How mature is this project? Common values are + # 3 - Alpha + # 4 - Beta + # 5 - Production/Stable + 'Development Status :: 4 - Beta', + + # Indicate who your project is intended for + 'Environment :: Web Environment', + 'Framework :: Pyramid', + 'Intended Audience :: End Users/Desktop', + 'Intended Audience :: Information Technology', + 'Intended Audience :: Science/Research', + 'Intended Audience :: System Administrators', + 'Topic :: Database :: Front-Ends', + 'Topic :: Internet :: WWW/HTTP', + 'Topic :: Scientific/Engineering', + 'Topic :: Utilities', + + # Pick your license as you wish (should match "license" above) + ('License :: OSI Approved ' + ':: GNU Affero General Public License v3 or later (AGPLv3+)'), + + # Specify the Python versions you support here. In particular, ensure + # that you indicate whether you support Python 2, Python 3 or both. + 'Programming Language :: Python :: 3', + 'Programming Language :: Python :: 3.4', + 'Programming Language :: Python :: 3.5', + 'Programming Language :: Python :: 3.6', + 'Programming Language :: Python :: 3.7', + ], + + # What does your project relate to? + keywords=[ + 'database front end', + 'interface', + 'Postgres', + 'Postgres user interface', + 'Postgres web interface', + 'PostgreSQL', + 'Postgres front end', + 'user interface', + 'web', + 'web front end', + ], + + # You can just specify the packages manually here if your project is + # simple. Or you can use find_packages(). + packages=find_packages('src'), + package_dir={'': 'src'}, + + # Run-time dependencies. + install_requires=[ + 'pgwui_common==' + version, + 'pgwui_core==' + version, + 'pyramid', + 'pyramid_beaker', + 'pyramid_mako', + ], + + # List additional groups of dependencies here (e.g. development + # dependencies). You can install these using the following syntax, + # for example: + # $ pip install -e .[testing] + extras_require={ + 'testing': tests_require, + }, + + # If there are data files included in your packages that need to be + # installed, specify them here. + package_data={ + 'pgwui_menu': [ + 'static/*.css', + 'templates/*.mak', + 'VERSION', + ], + }, + + # Setup an entry point to support PGWUI autoconfigure discovery. + entry_points={'pgwui.components': '.pgwui_menu = pgwui_menu'} +) diff --git a/src/pgwui_menu/VERSION b/src/pgwui_menu/VERSION new file mode 100644 index 0000000..8f0916f --- /dev/null +++ b/src/pgwui_menu/VERSION @@ -0,0 +1 @@ +0.5.0 diff --git a/src/pgwui_menu/__init__.py b/src/pgwui_menu/__init__.py new file mode 100644 index 0000000..4174053 --- /dev/null +++ b/src/pgwui_menu/__init__.py @@ -0,0 +1,22 @@ +# Copyright (C) 2018, 2020 The Meme Factory, Inc. http://www.karlpinc.com/ + +# This file is part of PGWUI_Menu. +# +# This program is free software: you can redistribute it and/or +# modify it under the terms of the GNU Affero General Public License +# as published by the Free Software Foundation, either version 3 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 +# Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public +# License along with this program. If not, see +# . +# + +# Karl O. Pinc + +from .pgwui_menu import includeme # noqa: F401 diff --git a/src/pgwui_menu/pgwui_menu.py b/src/pgwui_menu/pgwui_menu.py new file mode 100644 index 0000000..fe7a9ba --- /dev/null +++ b/src/pgwui_menu/pgwui_menu.py @@ -0,0 +1,49 @@ +# Copyright (C) 2018, 2020 The Meme Factory, Inc. http://www.karlpinc.com/ + +# This file is part of PGWUI_Menu. +# +# This program is free software: you can redistribute it and/or +# modify it under the terms of the GNU Affero General Public License +# as published by the Free Software Foundation, either version 3 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 +# Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public +# License along with this program. If not, see +# . +# + +# Karl O. Pinc + +'''Provide a way to configure a menu of PGWUI, or other, components. +''' + +PGWUI_COMPONENT = 'pgwui_menu' +DEFAULT_MENU_ROUTE = '/' +DEFAULT_MENU_MENU_LABEL = 'PGWUI Menu -- Main Menu' + + +def init_menu(config): + '''Add default menu information into settings when they are not present + ''' + settings = config.get_settings() + pgwui = settings.setdefault('pgwui', dict()) + pgwui.setdefault(PGWUI_COMPONENT, dict()) + pgwui[PGWUI_COMPONENT].setdefault( + 'menu_label', DEFAULT_MENU_MENU_LABEL) + + +def includeme(config): + '''Pyramid configuration for PGWUI_Menu + ''' + init_menu(config) + config.add_static_view( + f'static/{PGWUI_COMPONENT}', + 'pgwui_menu:static/', + cache_max_age=3600) + config.add_route(PGWUI_COMPONENT, DEFAULT_MENU_ROUTE) + config.scan() diff --git a/src/pgwui_menu/static/pgwui_menu.css b/src/pgwui_menu/static/pgwui_menu.css new file mode 100644 index 0000000..26952be --- /dev/null +++ b/src/pgwui_menu/static/pgwui_menu.css @@ -0,0 +1,27 @@ +/* Copyright (C) 2012, 2020 The Meme Factory, Inc. http://www.karlpinc.com/ + * Copyright (C) 2006, 2008, Karl O. Pinc + * + * This file is part of PGWUI_Common. + * + * This program is free software: you can redistribute it and/or + * modify it under the terms of the GNU Affero General Public License + * as published by the Free Software Foundation, either version 3 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 + * Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public + * License along with this program. If not, see + * . + * + * Style sheet for PGWUI_Menu. + * + * Karl O. Pinc + */ + + +/* indent the menu */ +ul { margin-left: 10%; } diff --git a/src/pgwui_menu/templates/menu.mak b/src/pgwui_menu/templates/menu.mak new file mode 100644 index 0000000..c71ba47 --- /dev/null +++ b/src/pgwui_menu/templates/menu.mak @@ -0,0 +1,72 @@ + +<%doc> + Copyright (C) 2020 The Meme Factory, Inc. http://www.karlpinc.com/ + + This file is part of PGWUI_Menu. + + This program is free software: you can redistribute it and/or + modify it under the terms of the GNU Affero General Public License + as published by the Free Software Foundation, either version 3 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 + Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public + License along with this program. If not, see + . + + Template providing menu elements for PGWUI components. + + Karl O. Pinc + + This template uses the following variables in its context: + + menu_items A list of (name, url, label) tuples: + name The name of the pgwui_component + url The url of the menu item, or None if no route exists + conf The component's menu configuration, a dict with the keys: + menu_label The label of the menu item + + pgwui_menu A dict of the pgwui_menu configuration settings. + + + +<%! + from pgwui_common.path import asset_abspath + + base_mak = asset_abspath('pgwui_common:templates/base.mak') +%> +<% + # Sort menu items by pgwui component name, for lack of anything better + # at present. + menu_items.sort(key=lambda tup: tup[0]) +%> + +<%inherit file="${base_mak}" /> +<%block name="title">${pgwui_menu['menu_label']} +<%block name="stylesheet_links"> + ${parent.stylesheet_links()} + + + +<%def name="navbar()"> +

+ HOME + % if 'pgwui_logout' in pgwui['routes']: + | Logout + % endif +

+ + +
    + % for (name, url, conf) in menu_items: + % if name != 'pgwui_menu' and url: +
  • ${conf['menu_label']}
    • + % endif + % endfor +
diff --git a/src/pgwui_menu/views/__init__.py b/src/pgwui_menu/views/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/src/pgwui_menu/views/menu.py b/src/pgwui_menu/views/menu.py new file mode 100644 index 0000000..1e0052c --- /dev/null +++ b/src/pgwui_menu/views/menu.py @@ -0,0 +1,55 @@ +# Copyright (C) 2020 The Meme Factory, Inc. http://www.karlpinc.com/ + +# This file is part of PGWUI_Menu. +# +# This program is free software: you can redistribute it and/or +# modify it under the terms of the GNU Affero General Public License +# as published by the Free Software Foundation, either version 3 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 +# Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public +# License along with this program. If not, see +# . +# + +# Karl O. Pinc +# +# Bugs: + +from pyramid.view import view_config + +from pgwui_common.pgwui_common import base_view +from pgwui_common import plugin + + +def build_menu_items(request, components): + settings = request.registry.settings + + menu_items = [] + for component in components: + conf = settings['pgwui'].get(component) + if conf: + try: + route = request.route_url(component) + except KeyError: + route = None + menu_items.append((component, route, conf)) + + return menu_items + + +@view_config(route_name='pgwui_menu', + renderer='pgwui_menu:templates/menu.mak') +@base_view +def menu_view(request): + response = dict() + + components = plugin.find_pgwui_components() + response['menu_items'] = build_menu_items(request, components) + response['pgwui_menu'] = request.registry.settings['pgwui']['pgwui_menu'] + return response diff --git a/tests/test_menu.py b/tests/test_menu.py new file mode 100644 index 0000000..ed1c177 --- /dev/null +++ b/tests/test_menu.py @@ -0,0 +1,116 @@ +# Copyright (C) 2020 The Meme Factory, Inc. http://www.karlpinc.com/ + +# This file is part of PGWUI_Menu. +# +# This program is free software: you can redistribute it and/or +# modify it under the terms of the GNU Affero General Public License +# as published by the Free Software Foundation, either version 3 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 +# Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public +# License along with this program. If not, see +# . +# + +# Karl O. Pinc + +import pyramid.testing + +from pgwui_common import plugin, includeme +from pgwui_menu.views import menu + +from pgwui_testing import testing + +# Activiate our pytest plugin +pytest_plugins = ("pgwui",) + +mock_find_pgwui_components = testing.make_mock_fixture( + plugin, 'find_pgwui_components') +mock_route_url = testing.instance_method_mock_fixture('route_url') + + +# Unit tests + +# build_menu_items() + +def test_build_menu_items_component_with_route(mock_route_url): + '''When the plugin has a setting and a route the route is + returned with the label''' + test_route = '/test/route' + test_plugin = 'pgwui_plugin' + plugin_settings = {'key1': 'val1', 'key2': 'val2'} + test_settings = {'pgwui': {test_plugin: plugin_settings}} + + request = pyramid.testing.DummyRequest() + mocked_route_url = mock_route_url(request) + mocked_route_url.return_value = test_route + request.registry.settings = test_settings + + result = menu.build_menu_items(request, [test_plugin]) + + assert result == [(test_plugin, test_route, plugin_settings)] + + +def test_build_menu_items_component_no_route(mock_route_url): + '''When the plugin has a setting and no route, None is returned + as the the route with the label''' + test_route = None + test_plugin = 'pgwui_plugin' + plugin_settings = {'key1': 'val1', 'key2': 'val2'} + test_settings = {'pgwui': {test_plugin: plugin_settings}} + + request = pyramid.testing.DummyRequest() + mocked_route_url = mock_route_url(request) + mocked_route_url.side_effect = KeyError + request.registry.settings = test_settings + + result = menu.build_menu_items(request, [test_plugin]) + + assert result == [(test_plugin, test_route, plugin_settings)] + + +def test_build_menu_items_component_no_plugin_conf(): + '''When the plugin has no configuration it is not added to the + returned menu items''' + test_plugin = 'pgwui_plugin' + test_settings = {'pgwui': {}} + + request = pyramid.testing.DummyRequest() + request.registry.settings = test_settings + + result = menu.build_menu_items(request, [test_plugin]) + + assert result == [] + + +mock_build_menu_items = testing.make_mock_fixture( + menu, 'build_menu_items') + + +# menu_view() + +def test_menu_view(pyramid_config, + mock_find_pgwui_components, + mock_build_menu_items): + '''The menu items are in the request + ''' + test_menu_items = [('a', 'r1', 'l1'), ('b', 'r2', 'l2')] + test_pgwui_menu_settings = 'some value' + mock_build_menu_items.return_value = test_menu_items + + request = pyramid.testing.DummyRequest() + request.registry.settings['pgwui'] = {'pgwui_menu': + test_pgwui_menu_settings} + includeme(pyramid_config) + result = menu.menu_view(request) + + assert result['menu_items'] == test_menu_items + assert result['pgwui_menu'] == test_pgwui_menu_settings + + +# Integration tests diff --git a/tests/test_pgwui_menu.py b/tests/test_pgwui_menu.py new file mode 100644 index 0000000..3a4ef76 --- /dev/null +++ b/tests/test_pgwui_menu.py @@ -0,0 +1,70 @@ +# Copyright (C) 2020 The Meme Factory, Inc. http://www.karlpinc.com/ + +# This file is part of PGWUI_Menu. +# +# This program is free software: you can redistribute it and/or +# modify it under the terms of the GNU Affero General Public License +# as published by the Free Software Foundation, either version 3 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 +# Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public +# License along with this program. If not, see +# . +# + +# Karl O. Pinc + +import pyramid.config +import pgwui_menu.pgwui_menu as pgwui_menu + +from pgwui_testing import testing + + +# Unit tests + +# init_menu() + +def test_init_menu(): + '''A menu_label is set + ''' + with pyramid.testing.testConfig() as config: + pgwui_menu.init_menu(config) + assert config.get_settings()['pgwui']['pgwui_menu']['menu_label'] \ + == pgwui_menu.DEFAULT_MENU_MENU_LABEL + + +mock_init_menu = testing.make_mock_fixture(pgwui_menu, 'init_menu') + +# includeme() + +mock_add_static_view = testing.instance_method_mock_fixture('add_static_view') +mock_add_route = testing.instance_method_mock_fixture('add_route') +mock_scan = testing.instance_method_mock_fixture('scan') + + +def test_includeme( + mock_init_menu, mock_add_static_view, mock_add_route, mock_scan): + '''add_static_view, add_route, and scan are all called + ''' + with pyramid.testing.testConfig() as config: + mocked_add_static_view = mock_add_static_view(config) + mocked_add_route = mock_add_route(config) + mocked_scan = mock_scan(config) + + pgwui_menu.includeme(config) + + mocked_add_static_view.assert_called_once() + mocked_add_route.assert_called_once() + mocked_scan.assert_called_once() + + +# Integration tests + +def test_includeme_integration(): + config = pyramid.config.Configurator() + pgwui_menu.includeme(config) diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000..b7cc8c4 --- /dev/null +++ b/tox.ini @@ -0,0 +1,36 @@ +[tox] +envlist = py{34,35,36,37} + +[testenv] +basepython = + py34: python3.4 + py35: python3.5 + py36: python3.6 + py37: python3.7 +deps = + check-manifest + cmarkgfm + flake8 + pgwui_testing + pytest + pytest-cov + twine + # coverage +commands = + check-manifest + python setup.py sdist + twine check dist/* + flake8 . + py.test --cov=pgwui_menu tests/ + # coverage run --source src/pgwui_menu -m py.test + # coverage report + +[flake8] +exclude = .tox,*.egg,build,data,devel +select = E,W,F +ignore = W503 + +[pytest] +markers = + unittest + integrationtest -- 2.34.1