commit 977c196f479149293573b181d304502abafb129d Author: Lance Edgar Date: Fri Jul 12 00:17:15 2024 -0500 feat: basic support for WSGI app, views, templates also docs + tests for what we have so far diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..e28459b --- /dev/null +++ b/.gitignore @@ -0,0 +1,7 @@ +*~ +*.pyc +.coverage +dist/ +docs/_build/ +.tox/ +wuttaweb.egg-info/ diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..16f5755 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,7 @@ + +# Changelog +All notable changes to wuttaweb will be documented in this file. + +The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) +and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html). + diff --git a/COPYING.txt b/COPYING.txt new file mode 100644 index 0000000..94a9ed0 --- /dev/null +++ b/COPYING.txt @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 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 General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is 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. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. 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 +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. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. 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. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + 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 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. Use with the GNU Affero General Public License. + + 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 Affero 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 special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU 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 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 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 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 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 General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program 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, your program's commands +might be different; for a GUI interface, you would use an "about box". + + 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 GPL, see +. + + The GNU 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. But first, please read +. diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..4ba2a5f --- /dev/null +++ b/README.rst @@ -0,0 +1,8 @@ + +========== + wuttaweb +========== + +Web app for Wutta Framework + +See docs at https://rattailproject.org/docs/wuttaweb/ diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..d4bb2cb --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line, and also +# from the environment for the first two. +SPHINXOPTS ?= +SPHINXBUILD ?= sphinx-build +SOURCEDIR = . +BUILDDIR = _build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/_static/.keepme b/docs/_static/.keepme new file mode 100644 index 0000000..e69de29 diff --git a/docs/api/index.rst b/docs/api/index.rst new file mode 100644 index 0000000..975027b --- /dev/null +++ b/docs/api/index.rst @@ -0,0 +1,10 @@ + +Package API +=========== + +This is the "raw" API documentation for the ``wuttaweb`` package. + +.. toctree:: + :maxdepth: 2 + + wuttaweb/index diff --git a/docs/api/wuttaweb/app.rst b/docs/api/wuttaweb/app.rst new file mode 100644 index 0000000..96980e9 --- /dev/null +++ b/docs/api/wuttaweb/app.rst @@ -0,0 +1,6 @@ + +``wuttaweb.app`` +================ + +.. automodule:: wuttaweb.app + :members: diff --git a/docs/api/wuttaweb/helpers.rst b/docs/api/wuttaweb/helpers.rst new file mode 100644 index 0000000..88ce582 --- /dev/null +++ b/docs/api/wuttaweb/helpers.rst @@ -0,0 +1,6 @@ + +``wuttaweb.helpers`` +==================== + +.. automodule:: wuttaweb.helpers + :members: diff --git a/docs/api/wuttaweb/index.rst b/docs/api/wuttaweb/index.rst new file mode 100644 index 0000000..b64846b --- /dev/null +++ b/docs/api/wuttaweb/index.rst @@ -0,0 +1,17 @@ + +``wuttaweb`` +============ + +.. automodule:: wuttaweb + +.. toctree:: + :maxdepth: 1 + + app + helpers + static + subscribers + util + views + views.base + views.common diff --git a/docs/api/wuttaweb/static.rst b/docs/api/wuttaweb/static.rst new file mode 100644 index 0000000..8935d80 --- /dev/null +++ b/docs/api/wuttaweb/static.rst @@ -0,0 +1,6 @@ + +``wuttaweb.static`` +=================== + +.. automodule:: wuttaweb.static + :members: diff --git a/docs/api/wuttaweb/subscribers.rst b/docs/api/wuttaweb/subscribers.rst new file mode 100644 index 0000000..8338d1f --- /dev/null +++ b/docs/api/wuttaweb/subscribers.rst @@ -0,0 +1,6 @@ + +``wuttaweb.subscribers`` +======================== + +.. automodule:: wuttaweb.subscribers + :members: diff --git a/docs/api/wuttaweb/util.rst b/docs/api/wuttaweb/util.rst new file mode 100644 index 0000000..d291579 --- /dev/null +++ b/docs/api/wuttaweb/util.rst @@ -0,0 +1,6 @@ + +``wuttaweb.util`` +================= + +.. automodule:: wuttaweb.util + :members: diff --git a/docs/api/wuttaweb/views.base.rst b/docs/api/wuttaweb/views.base.rst new file mode 100644 index 0000000..9672586 --- /dev/null +++ b/docs/api/wuttaweb/views.base.rst @@ -0,0 +1,6 @@ + +``wuttaweb.views.base`` +======================= + +.. automodule:: wuttaweb.views.base + :members: diff --git a/docs/api/wuttaweb/views.common.rst b/docs/api/wuttaweb/views.common.rst new file mode 100644 index 0000000..b63f761 --- /dev/null +++ b/docs/api/wuttaweb/views.common.rst @@ -0,0 +1,6 @@ + +``wuttaweb.views.common`` +========================= + +.. automodule:: wuttaweb.views.common + :members: diff --git a/docs/api/wuttaweb/views.rst b/docs/api/wuttaweb/views.rst new file mode 100644 index 0000000..e1ec918 --- /dev/null +++ b/docs/api/wuttaweb/views.rst @@ -0,0 +1,6 @@ + +``wuttaweb.views`` +================== + +.. automodule:: wuttaweb.views + :members: diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..3955a96 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,40 @@ +# Configuration file for the Sphinx documentation builder. +# +# For the full list of built-in configuration values, see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html + +# -- Project information ----------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information + +from importlib.metadata import version as get_version + +project = 'WuttaWeb' +copyright = '2024, Lance Edgar' +author = 'Lance Edgar' +release = get_version('WuttaWeb') + +# -- General configuration --------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration + +extensions = [ + 'sphinx.ext.autodoc', + 'sphinx.ext.intersphinx', + 'sphinx.ext.viewcode', +] + +templates_path = ['_templates'] +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] + +intersphinx_mapping = { + 'pyramid': ('https://docs.pylonsproject.org/projects/pyramid/en/latest/', None), + 'python': ('https://docs.python.org/3/', None), + 'webhelpers2': ('https://webhelpers2.readthedocs.io/en/latest/', None), + 'wuttjamaican': ('https://rattailproject.org/docs/wuttjamaican/', None), +} + + +# -- Options for HTML output ------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output + +html_theme = 'furo' +html_static_path = ['_static'] diff --git a/docs/glossary.rst b/docs/glossary.rst new file mode 100644 index 0000000..0621e51 --- /dev/null +++ b/docs/glossary.rst @@ -0,0 +1,10 @@ +.. _glossary: + +Glossary +======== + +.. glossary:: + :sorted: + + view + TODO diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..b012584 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,23 @@ + +WuttaWeb +======== + +This package provides a "web layer" for custom apps. + +It uses traditional server-side rendering with VueJS on the front-end. + +.. toctree:: + :maxdepth: 3 + :caption: Contents: + + glossary + narr/index + api/index + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 0000000..32bb245 --- /dev/null +++ b/docs/make.bat @@ -0,0 +1,35 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=. +set BUILDDIR=_build + +%SPHINXBUILD% >NUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.https://www.sphinx-doc.org/ + exit /b 1 +) + +if "%1" == "" goto help + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% + +:end +popd diff --git a/docs/narr/index.rst b/docs/narr/index.rst new file mode 100644 index 0000000..20f3a85 --- /dev/null +++ b/docs/narr/index.rst @@ -0,0 +1,16 @@ + +Documentation +============= + +TODO + +.. + .. toctree:: + :maxdepth: 2 + + install/index + config/index + cli/index + handlers/index + providers/index + db/index diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..c23546f --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,66 @@ + +[build-system] +requires = ["hatchling"] +build-backend = "hatchling.build" + + +[project] +name = "WuttaWeb" +version = "0.1.0" +description = "Web App for Wutta Framework" +readme = "README.rst" +authors = [{name = "Lance Edgar", email = "lance@edbob.org"}] +license = {text = "GNU GPL v3+"} +classifiers = [ + "Development Status :: 4 - Beta", + "Environment :: Web Environment", + "Framework :: Pyramid", + "Intended Audience :: Developers", + "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)", + "Natural Language :: English", + "Operating System :: OS Independent", + "Programming Language :: Python", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.8", + "Programming Language :: Python :: 3.9", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + "Topic :: Internet :: WWW/HTTP", + "Topic :: Software Development :: Libraries :: Python Modules", +] +requires-python = ">= 3.8" +dependencies = [ + "pyramid>=2", + "pyramid_beaker", + "pyramid_mako", + "waitress", + "WebHelpers2", + "WuttJamaican[db]", +] + + +[project.optional-dependencies] +docs = ["Sphinx", "furo"] +tests = ["pytest-cov", "tox"] + + +[project.entry-points."paste.app_factory"] +main = "wuttaweb.app:main" + + +[project.urls] +Homepage = "https://rattailproject.org/" +Repository = "https://kallithea.rattailproject.org/rattail-project/wuttaweb" +Changelog = "https://kallithea.rattailproject.org/rattail-project/wuttaweb/files/master/CHANGELOG.md" + + +[tool.commitizen] +version_provider = "pep621" +tag_format = "v$version" +update_changelog_on_bump = true + + +[tool.hatch.build.targets.sdist] +exclude = [ + "htmlcov/", +] diff --git a/src/wuttaweb/__init__.py b/src/wuttaweb/__init__.py new file mode 100644 index 0000000..5674b5e --- /dev/null +++ b/src/wuttaweb/__init__.py @@ -0,0 +1,27 @@ +# -*- coding: utf-8; -*- +################################################################################ +# +# wuttaweb -- Web App for Wutta Framework +# Copyright © 2024 Lance Edgar +# +# This file is part of Wutta Framework. +# +# Wutta Framework 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 3 of the License, or (at your option) any +# later version. +# +# Wutta Framework 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 +# Wutta Framework. If not, see . +# +################################################################################ +""" +wuttaweb - base package for web app +""" + +from ._version import __version__ diff --git a/src/wuttaweb/_version.py b/src/wuttaweb/_version.py new file mode 100644 index 0000000..27aaeb4 --- /dev/null +++ b/src/wuttaweb/_version.py @@ -0,0 +1,6 @@ +# -*- coding: utf-8; -*- + +from importlib.metadata import version + + +__version__ = version('wuttaweb') diff --git a/src/wuttaweb/app.py b/src/wuttaweb/app.py new file mode 100644 index 0000000..0970710 --- /dev/null +++ b/src/wuttaweb/app.py @@ -0,0 +1,113 @@ +# -*- coding: utf-8; -*- +################################################################################ +# +# wuttaweb -- Web App for Wutta Framework +# Copyright © 2024 Lance Edgar +# +# This file is part of Wutta Framework. +# +# Wutta Framework 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 3 of the License, or (at your option) any +# later version. +# +# Wutta Framework 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 +# Wutta Framework. If not, see . +# +################################################################################ +""" +Application +""" + +import os + +from wuttjamaican.conf import make_config + +from pyramid.config import Configurator + + +def make_wutta_config(settings): + """ + Make a WuttaConfig object from the given settings. + + Note that ``settings`` dict will (typically) correspond to the + ``[app:main]`` section of your config file. + + Regardless, the ``settings`` must contain a special key/value + which is needed to identify the location of the config file. + Assuming the typical scenario then, your config file should have + an entry like this: + + .. code-block:: ini + + [app:main] + wutta.config = %(__file__)s + + The ``%(__file__)s`` is auto-replaced with the config file path, + so ultimately ``settings`` would contain something like (at + minimum):: + + {'wutta.config': '/path/to/config/file'} + + If this config file path cannot be discovered, an error is raised. + """ + # initialize config and embed in settings dict, to make + # available for web requests later + path = settings.get('wutta.config') + if not path or not os.path.exists(path): + raise ValueError("Please set 'wutta.config' in [app:main] " + "section of config to the path of your " + "config file. Lame, but necessary.") + + wutta_config = make_config(path) + + settings['wutta_config'] = wutta_config + return wutta_config + + +def make_pyramid_config(settings): + """ + Make and return a Pyramid config object from the given settings. + + The config is initialized with certain features deemed useful for + all apps. + """ + pyramid_config = Configurator(settings=settings) + + pyramid_config.include('pyramid_beaker') + pyramid_config.include('pyramid_mako') + + return pyramid_config + + +def main(global_config, **settings): + """ + This function returns a Pyramid WSGI application. + + Typically there is no need to call this function directly, but it + may be configured as the web app entry point like so: + + .. code-block:: ini + + [app:main] + use = egg:wuttaweb + + The app returned by this function is quite minimal, so most apps + will need to define their own ``main()`` function, and use that + instead. + """ + settings.setdefault('mako.directories', ['wuttaweb:templates']) + + wutta_config = make_wutta_config(settings) + pyramid_config = make_pyramid_config(settings) + + pyramid_config.include('wuttaweb.static') + pyramid_config.include('wuttaweb.subscribers') + pyramid_config.include('wuttaweb.views') + + return pyramid_config.make_wsgi_app() diff --git a/src/wuttaweb/helpers.py b/src/wuttaweb/helpers.py new file mode 100644 index 0000000..c80c62f --- /dev/null +++ b/src/wuttaweb/helpers.py @@ -0,0 +1,49 @@ +# -*- coding: utf-8; -*- +################################################################################ +# +# wuttaweb -- Web App for Wutta Framework +# Copyright © 2024 Lance Edgar +# +# This file is part of Wutta Framework. +# +# Wutta Framework 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 3 of the License, or (at your option) any +# later version. +# +# Wutta Framework 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 +# Wutta Framework. If not, see . +# +################################################################################ +""" +Template Context Helpers + +This module serves as a collection of various things deemed useful for +all template renderers. It is made available as simply ``h`` within +the template context. + +You can access anything provided by ``h`` within a template then, for +instance: + +.. code-block:: mako + + ${h.link_to('python', 'https://www.python.org')} + +(Note that ``link_to()`` comes from ``webhelpers2.html.tags``.) + +This module contains the following references: + +* :func:`~wuttaweb.util.get_liburl()` +* all names from :mod:`webhelpers2:webhelpers2.html` +* all names from :mod:`webhelpers2:webhelpers2.html.tags` +""" + +from webhelpers2.html import * +from webhelpers2.html.tags import * + +from wuttaweb.util import get_liburl diff --git a/src/wuttaweb/static/__init__.py b/src/wuttaweb/static/__init__.py new file mode 100644 index 0000000..a2e7012 --- /dev/null +++ b/src/wuttaweb/static/__init__.py @@ -0,0 +1,37 @@ +# -*- coding: utf-8; -*- +################################################################################ +# +# wuttaweb -- Web App for Wutta Framework +# Copyright © 2024 Lance Edgar +# +# This file is part of Wutta Framework. +# +# Wutta Framework 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 3 of the License, or (at your option) any +# later version. +# +# Wutta Framework 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 +# Wutta Framework. If not, see . +# +################################################################################ +""" +Static Assets + +It is assumed that all (i.e. even custom) apps will include this +module somewhere during startup. For instance this happens within +:func:`~wuttaweb.app.main()`:: + + pyramid_config.include('wuttaweb.static') + +This allows for certain common assets to be available for all apps. +""" + + +def includeme(config): + config.add_static_view('wuttaweb', 'wuttaweb:static') diff --git a/src/wuttaweb/static/img/testing.png b/src/wuttaweb/static/img/testing.png new file mode 100644 index 0000000..7228b33 Binary files /dev/null and b/src/wuttaweb/static/img/testing.png differ diff --git a/src/wuttaweb/subscribers.py b/src/wuttaweb/subscribers.py new file mode 100644 index 0000000..2777caa --- /dev/null +++ b/src/wuttaweb/subscribers.py @@ -0,0 +1,140 @@ +# -*- coding: utf-8; -*- +################################################################################ +# +# wuttaweb -- Web App for Wutta Framework +# Copyright © 2024 Lance Edgar +# +# This file is part of Wutta Framework. +# +# Wutta Framework 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 3 of the License, or (at your option) any +# later version. +# +# Wutta Framework 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 +# Wutta Framework. If not, see . +# +################################################################################ +""" +Event Subscribers + +It is assumed that most apps will include this module somewhere during +startup. For instance this happens within +:func:`~wuttaweb.app.main()`:: + + pyramid_config.include('wuttaweb.subscribers') + +This allows for certain common logic to be available for all apps. + +However some custom apps may need to supplement or replace the event +hooks contained here, depending on the circumstance. +""" + +import json + +from pyramid import threadlocal + +from wuttaweb import helpers + + +def new_request(event): + """ + Event hook called when processing a new request. + + The hook is auto-registered if this module is "included" by + Pyramid config object. Or you can explicitly register it:: + + pyramid_config.add_subscriber('wuttaweb.subscribers.new_request', + 'pyramid.events.NewRequest') + + This will add some things to the request object: + + .. attribute:: request.wutta_config + + Reference to the app :term:`config object`. + + .. attribute:: request.use_oruga + + Flag indicating whether the frontend should be displayed using + Vue 3 + Oruga (if ``True``), or else Vue 2 + Buefy (if + ``False``). + """ + request = event.request + config = request.registry.settings['wutta_config'] + app = config.get_app() + + request.wutta_config = config + + def use_oruga(request): + spec = config.get('wuttaweb.oruga_detector.spec') + if spec: + func = app.load_object(spec) + return func(request) + return False + + request.set_property(use_oruga, reify=True) + + +def before_render(event): + """ + Event hook called just before rendering a template. + + The hook is auto-registered if this module is "included" by + Pyramid config object. Or you can explicitly register it:: + + pyramid_config.add_subscriber('wuttaweb.subscribers.before_render', + 'pyramid.events.BeforeRender') + + This will add some things to the template context dict. Each of + these may be used "directly" in a template then, e.g.: + + .. code-block:: mako + + ${app.get_title()} + + Here are the keys added to context dict by this hook: + + .. data:: 'app' + + Reference to the :term:`app handler`. + + .. data:: 'config' + + Reference to the app :term:`config object`. + + .. data:: 'h' + + Reference to the helper module, :mod:`wuttaweb.helpers`. + + .. data:: 'json' + + Reference to the built-in module, :mod:`python:json`. + + .. data:: 'url' + + Reference to the request method, + :meth:`~pyramid:pyramid.request.Request.route_url()`. + """ + request = event.get('request') or threadlocal.get_current_request() + config = request.wutta_config + app = config.get_app() + + context = event + context['app'] = app + context['config'] = config + context['h'] = helpers + context['url'] = request.route_url + context['json'] = json + + # TODO + context['menus'] = [] + + +def includeme(config): + config.add_subscriber(new_request, 'pyramid.events.NewRequest') + config.add_subscriber(before_render, 'pyramid.events.BeforeRender') diff --git a/src/wuttaweb/templates/base.mako b/src/wuttaweb/templates/base.mako new file mode 100644 index 0000000..9b6d82e --- /dev/null +++ b/src/wuttaweb/templates/base.mako @@ -0,0 +1,391 @@ +## -*- coding: utf-8; -*- +<%namespace name="base_meta" file="/base_meta.mako" /> + + + + + ${base_meta.global_title()} » ${capture(self.title)|n} + ${base_meta.favicon()} + ${self.header_core()} + ${self.head_tags()} + + +
+ +
+ + ## content body from derived/child template + ${self.body()} + + ## Vue app + ${self.make_whole_page_component()} + ${self.make_whole_page_app()} + + + +<%def name="title()"> + +<%def name="content_title()">${self.title()} + +<%def name="header_core()"> + ${self.core_javascript()} + ${self.extra_javascript()} + ${self.core_styles()} + ${self.extra_styles()} + + +<%def name="core_javascript()"> + ${self.vuejs()} + ${self.buefy()} + ${self.fontawesome()} + + + + +<%def name="vuejs()"> + ${h.javascript_link(h.get_liburl(request, 'vue'))} + ${h.javascript_link(h.get_liburl(request, 'vue_resource'))} + + +<%def name="buefy()"> + ${h.javascript_link(h.get_liburl(request, 'buefy'))} + + +<%def name="fontawesome()"> + + + +<%def name="extra_javascript()"> + +<%def name="core_styles()"> + ${self.buefy_styles()} + + + + +<%def name="buefy_styles()"> + ${h.stylesheet_link(h.get_liburl(request, 'buefy.css'))} + + +<%def name="extra_styles()"> + ${base_meta.extra_styles()} + + +<%def name="head_tags()"> + +<%def name="render_whole_page_template()"> + + + +<%def name="render_this_page_component()"> + + + +<%def name="render_navbar_end()"> +
+ ${self.render_user_menu()} +
+ + +<%def name="render_user_menu()"> + +<%def name="render_instance_header_title_extras()"> + +<%def name="render_instance_header_buttons()"> + ${self.render_crud_header_buttons()} + ${self.render_prevnext_header_buttons()} + + +<%def name="render_crud_header_buttons()"> + +<%def name="render_prevnext_header_buttons()"> + +<%def name="declare_whole_page_vars()"> + + + +<%def name="modify_whole_page_vars()"> + +<%def name="finalize_whole_page_vars()"> + +<%def name="make_whole_page_component()"> + ${self.render_whole_page_template()} + ${self.declare_whole_page_vars()} + ${self.modify_whole_page_vars()} + ${self.finalize_whole_page_vars()} + + + + +<%def name="make_whole_page_app()"> + + diff --git a/src/wuttaweb/templates/base_meta.mako b/src/wuttaweb/templates/base_meta.mako new file mode 100644 index 0000000..7aa2901 --- /dev/null +++ b/src/wuttaweb/templates/base_meta.mako @@ -0,0 +1,21 @@ +## -*- coding: utf-8; -*- + +<%def name="app_title()">${app.get_title()} + +<%def name="global_title()">${self.app_title()} + +<%def name="extra_styles()"> + +<%def name="favicon()"> + ## + + +<%def name="header_logo()"> + ## ${h.image(config.get('wuttaweb.header_image_url', default=request.static_url('wuttaweb:static/img/logo.png')), "Header Logo", style="height: 49px;")} + + +<%def name="footer()"> +

+ powered by ${h.link_to("Wutta Framework", 'https://pypi.org/project/WuttJamaican/', target='_blank')} +

+ diff --git a/src/wuttaweb/templates/home.mako b/src/wuttaweb/templates/home.mako new file mode 100644 index 0000000..61a4eb2 --- /dev/null +++ b/src/wuttaweb/templates/home.mako @@ -0,0 +1,21 @@ +## -*- coding: utf-8; -*- +<%inherit file="/page.mako" /> +<%namespace name="base_meta" file="/base_meta.mako" /> + +<%def name="title()">Home + +<%def name="render_this_page()"> + ${self.page_content()} + + +<%def name="page_content()"> +
+ +
+ + + +${parent.body()} diff --git a/src/wuttaweb/templates/page.mako b/src/wuttaweb/templates/page.mako new file mode 100644 index 0000000..c014e06 --- /dev/null +++ b/src/wuttaweb/templates/page.mako @@ -0,0 +1,81 @@ +## -*- coding: utf-8; -*- +<%inherit file="/base.mako" /> + +<%def name="context_menu_items()"> + % if context_menu_list_items is not Undefined: + % for item in context_menu_list_items: +
  • ${item}
    • + % endfor + % endif + + +<%def name="page_content()"> + +<%def name="render_this_page()"> +
    + +
    + ${self.page_content()} +
    + +
      + ${self.context_menu_items()} +
    + +
    + + +<%def name="render_this_page_template()"> + + + +<%def name="declare_this_page_vars()"> + + + +<%def name="modify_this_page_vars()"> + +<%def name="finalize_this_page_vars()"> + +<%def name="make_this_page_component()"> + ${self.declare_this_page_vars()} + ${self.modify_this_page_vars()} + ${self.finalize_this_page_vars()} + + + + + +${self.render_this_page_template()} +${self.make_this_page_component()} diff --git a/src/wuttaweb/util.py b/src/wuttaweb/util.py new file mode 100644 index 0000000..3275301 --- /dev/null +++ b/src/wuttaweb/util.py @@ -0,0 +1,238 @@ +# -*- coding: utf-8; -*- +################################################################################ +# +# wuttaweb -- Web App for Wutta Framework +# Copyright © 2024 Lance Edgar +# +# This file is part of Wutta Framework. +# +# Wutta Framework 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 3 of the License, or (at your option) any +# later version. +# +# Wutta Framework 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 +# Wutta Framework. If not, see . +# +################################################################################ +""" +Utilities +""" + +import importlib + + +def get_libver( + request, + key, + default_only=False, + prefix='wuttaweb', +): + """ + Return the appropriate version string for the web resource library + identified by ``key``. + + WuttaWeb makes certain assumptions about which libraries would be + used on the frontend, and which versions for each would be used by + default. But it should also be possible to customize which + versions are used, hence this function. + + Each library has a built-in default version but your config can + override them, e.g.: + + .. code-block:: ini + + [wuttaweb] + libver.bb_vue = 3.4.29 + + :param request: Current request. + + :param key: Unique key for the library, as string. Possibilities + are the same as for :func:`get_liburl()`. + + :param default_only: If this flag is ``True``, the logic will + *not* look for a "configured" version but rather will *only* + return the "default" version regardless of config. + + If the flag is ``False`` (which it is by default) then the + config value will be used if present, and a default version is + used only if the config does not have a value. + + :param prefix: If specified, will override the prefix used for + config lookups. + + .. warning:: + + This ``prefix`` param is for backward compatibility and may + be removed in the future. + + :returns: The appropriate version string, e.g. ``'1.2.3'`` or + ``'latest'`` etc. + """ + config = request.wutta_config + + # nb. we prefer a setting to be named like: wuttaweb.libver.vue + # but for back-compat this also can work: wuttaweb.vue_version + # however that compat only works for some of the settings... + + if not default_only: + # nb. new/preferred setting + version = config.get(f'{prefix}.libver.{key}') + if version: + return version + + if key == 'buefy': + if not default_only: + # nb. old/legacy setting + version = config.get(f'{prefix}.buefy_version') + if version: + return version + return 'latest' + + elif key == 'buefy.css': + # nb. this always returns something + return get_libver(request, 'buefy', default_only=default_only) + + elif key == 'vue': + if not default_only: + # nb. old/legacy setting + version = config.get(f'{prefix}.vue_version') + if version: + return version + return '2.6.14' + + elif key == 'vue_resource': + return 'latest' + + elif key == 'fontawesome': + return '5.3.1' + + elif key == 'bb_vue': + return '3.4.31' + + elif key == 'bb_oruga': + return '0.8.12' + + elif key in ('bb_oruga_bulma', 'bb_oruga_bulma_css'): + return '0.3.0' + + elif key == 'bb_fontawesome_svg_core': + return '6.5.2' + + elif key == 'bb_free_solid_svg_icons': + return '6.5.2' + + elif key == 'bb_vue_fontawesome': + return '3.0.6' + + +def get_liburl( + request, + key, + prefix='wuttaweb', +): + """ + Return the appropriate URL for the web resource library identified + by ``key``. + + WuttaWeb makes certain assumptions about which libraries would be + used on the frontend, and which versions for each would be used by + default. But ultimately a URL must be determined for each, hence + this function. + + Each library has a built-in default URL which references a public + Internet (i.e. CDN) resource, but your config can override the + final URL in two ways: + + The simplest way is to just override the *version* but otherwise + let the default logic construct the URL. See :func:`get_libver()` + for more on that approach. + + The most flexible way is to override the URL explicitly, e.g.: + + .. code-block:: ini + + [wuttaweb] + liburl.bb_vue = https://example.com/cache/vue-3.4.31.js + + :param request: Current request. + + :param key: Unique key for the library, as string. Possibilities + are: + + Vue 2 + Buefy + + * ``vue`` + * ``vue_resource`` + * ``buefy`` + * ``buefy.css`` + * ``fontawesome`` + + Vue 3 + Oruga + + * ``bb_vue`` + * ``bb_oruga`` + * ``bb_oruga_bulma`` + * ``bb_oruga_bulma_css`` + * ``bb_fontawesome_svg_core`` + * ``bb_free_solid_svg_icons`` + * ``bb_vue_fontawesome`` + + :param prefix: If specified, will override the prefix used for + config lookups. + + .. warning:: + + This ``prefix`` param is for backward compatibility and may + be removed in the future. + + :returns: The appropriate URL as string. + """ + config = request.wutta_config + + url = config.get(f'{prefix}.liburl.{key}') + if url: + return url + + version = get_libver(request, key, prefix=prefix) + + if key == 'buefy': + return f'https://unpkg.com/buefy@{version}/dist/buefy.min.js' + + elif key == 'buefy.css': + return f'https://unpkg.com/buefy@{version}/dist/buefy.min.css' + + elif key == 'vue': + return f'https://unpkg.com/vue@{version}/dist/vue.min.js' + + elif key == 'vue_resource': + return f'https://cdn.jsdelivr.net/npm/vue-resource@{version}' + + elif key == 'fontawesome': + return f'https://use.fontawesome.com/releases/v{version}/js/all.js' + + elif key == 'bb_vue': + return f'https://unpkg.com/vue@{version}/dist/vue.esm-browser.prod.js' + + elif key == 'bb_oruga': + return f'https://unpkg.com/@oruga-ui/oruga-next@{version}/dist/oruga.mjs' + + elif key == 'bb_oruga_bulma': + return f'https://unpkg.com/@oruga-ui/theme-bulma@{version}/dist/bulma.mjs' + + elif key == 'bb_oruga_bulma_css': + return f'https://unpkg.com/@oruga-ui/theme-bulma@{version}/dist/bulma.css' + + elif key == 'bb_fontawesome_svg_core': + return f'https://cdn.jsdelivr.net/npm/@fortawesome/fontawesome-svg-core@{version}/+esm' + + elif key == 'bb_free_solid_svg_icons': + return f'https://cdn.jsdelivr.net/npm/@fortawesome/free-solid-svg-icons@{version}/+esm' + + elif key == 'bb_vue_fontawesome': + return f'https://cdn.jsdelivr.net/npm/@fortawesome/vue-fontawesome@{version}/+esm' diff --git a/src/wuttaweb/views/__init__.py b/src/wuttaweb/views/__init__.py new file mode 100644 index 0000000..0b62a83 --- /dev/null +++ b/src/wuttaweb/views/__init__.py @@ -0,0 +1,36 @@ +# -*- coding: utf-8; -*- +################################################################################ +# +# wuttaweb -- Web App for Wutta Framework +# Copyright © 2024 Lance Edgar +# +# This file is part of Wutta Framework. +# +# Wutta Framework 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 3 of the License, or (at your option) any +# later version. +# +# Wutta Framework 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 +# Wutta Framework. If not, see . +# +################################################################################ +""" +Web Views + +For convenience, from this ``wuttaweb.views`` namespace you can access +the following: + +* :class:`~wuttaweb.views.base.View` +""" + +from .base import View + + +def includeme(config): + config.include('wuttaweb.views.common') diff --git a/src/wuttaweb/views/base.py b/src/wuttaweb/views/base.py new file mode 100644 index 0000000..3906c0b --- /dev/null +++ b/src/wuttaweb/views/base.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8; -*- +################################################################################ +# +# wuttaweb -- Web App for Wutta Framework +# Copyright © 2024 Lance Edgar +# +# This file is part of Wutta Framework. +# +# Wutta Framework 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 3 of the License, or (at your option) any +# later version. +# +# Wutta Framework 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 +# Wutta Framework. If not, see . +# +################################################################################ +""" +Base Logic for Views +""" + + +class View: + """ + Base class for all class-based views. + + Instances of this class (or rather, a subclass) are created by + Pyramid when processing a request. They will have the following + attributes: + + .. attribute:: request + + Reference to the current + :class:`pyramid:pyramid.request.Request` object. + + .. attribute:: app + + Reference to the :term:`app handler`. + + .. attribute:: config + + Reference to the app :term:`config object`. + """ + + def __init__(self, request, context=None): + self.request = request + self.config = self.request.wutta_config + self.app = self.config.get_app() diff --git a/src/wuttaweb/views/common.py b/src/wuttaweb/views/common.py new file mode 100644 index 0000000..153bc5c --- /dev/null +++ b/src/wuttaweb/views/common.py @@ -0,0 +1,71 @@ +# -*- coding: utf-8; -*- +################################################################################ +# +# wuttaweb -- Web App for Wutta Framework +# Copyright © 2024 Lance Edgar +# +# This file is part of Wutta Framework. +# +# Wutta Framework 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 3 of the License, or (at your option) any +# later version. +# +# Wutta Framework 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 +# Wutta Framework. If not, see . +# +################################################################################ +""" +Common Views +""" + +from wuttaweb.views import View + + +class CommonView(View): + """ + Common views shared by all apps. + """ + + def home(self): + """ + Home page view. + + Template: ``/home.mako`` + + This is normally the view shown when a user navigates to the + root URL for the web app. + + """ + return { + 'index_title': self.app.get_title(), + } + + @classmethod + def defaults(cls, config): + cls._defaults(config) + + @classmethod + def _defaults(cls, config): + + # home + config.add_route('home', '/') + config.add_view(cls, attr='home', + route_name='home', + renderer='/home.mako') + + +def defaults(config, **kwargs): + base = globals() + + CommonView = kwargs.get('CommonView', base['CommonView']) + CommonView.defaults(config) + + +def includeme(config): + defaults(config) diff --git a/tasks.py b/tasks.py new file mode 100644 index 0000000..b6084de --- /dev/null +++ b/tasks.py @@ -0,0 +1,28 @@ +# -*- coding: utf-8; -*- +""" +Tasks for wuttaweb +""" + +import os +import shutil + +from invoke import task + + +@task +def release(c, skip_tests=False): + """ + Release a new version of WuttJamaican + """ + if not skip_tests: + c.run('tox') + + # rebuild pkg + if os.path.exists('dist'): + shutil.rmtree('dist') + if os.path.exists('WuttJamaican.egg-info'): + shutil.rmtree('WuttJamaican.egg-info') + c.run('python -m build --sdist') + + # upload + c.run('twine upload dist/*') diff --git a/tests/__init__.py b/tests/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/tests/test_app.py b/tests/test_app.py new file mode 100644 index 0000000..2d5307e --- /dev/null +++ b/tests/test_app.py @@ -0,0 +1,50 @@ +# -*- coding: utf-8; -*- + +from unittest import TestCase + +from wuttjamaican.testing import FileConfigTestCase + +from pyramid.config import Configurator +from pyramid.router import Router + +from wuttaweb import app as mod + + +class TestMakeWuttaConfig(FileConfigTestCase): + + def test_config_path_required(self): + + # settings must define config path, else error + settings = {} + self.assertRaises(ValueError, mod.make_wutta_config, settings) + + def test_basic(self): + + # mock path to config file + myconf = self.write_file('my.conf', '') + settings = {'wutta.config': myconf} + + # can make a config okay + config = mod.make_wutta_config(settings) + + # and that config is also stored in settings + self.assertIn('wutta_config', settings) + self.assertIs(settings['wutta_config'], config) + + +class TestMakePyramidConfig(TestCase): + + def test_basic(self): + settings = {} + config = mod.make_pyramid_config(settings) + self.assertIsInstance(config, Configurator) + + +class TestMain(FileConfigTestCase): + + def test_basic(self): + global_config = None + myconf = self.write_file('my.conf', '') + settings = {'wutta.config': myconf} + app = mod.main(global_config, **settings) + self.assertIsInstance(app, Router) diff --git a/tests/test_helpers.py b/tests/test_helpers.py new file mode 100644 index 0000000..721c576 --- /dev/null +++ b/tests/test_helpers.py @@ -0,0 +1,4 @@ +# -*- coding: utf-8; -*- + +# nb. nothing to test yet! +from wuttaweb import helpers diff --git a/tests/test_static.py b/tests/test_static.py new file mode 100644 index 0000000..12da3f9 --- /dev/null +++ b/tests/test_static.py @@ -0,0 +1,14 @@ +# -*- coding: utf-8; -*- + +from unittest import TestCase + +from pyramid import testing + + +class TestIncludeMe(TestCase): + + def test_basic(self): + with testing.testConfig() as pyramid_config: + + # just ensure no error happens when included.. + pyramid_config.include('wuttaweb.static') diff --git a/tests/test_subscribers.py b/tests/test_subscribers.py new file mode 100644 index 0000000..804eb1a --- /dev/null +++ b/tests/test_subscribers.py @@ -0,0 +1,100 @@ +# -*- coding: utf-8; -*- + +import json +from unittest import TestCase +from unittest.mock import MagicMock + +from wuttjamaican.conf import WuttaConfig + +from pyramid import testing + +from wuttaweb import subscribers +from wuttaweb import helpers + + +class TestNewRequest(TestCase): + + def setUp(self): + self.config = WuttaConfig() + + def make_request(self): + request = testing.DummyRequest() + request.registry.settings = {'wutta_config': self.config} + return request + + def test_wutta_config(self): + request = self.make_request() + event = MagicMock(request=request) + + # request gets a new attr + self.assertFalse(hasattr(request, 'wutta_config')) + subscribers.new_request(event) + self.assertTrue(hasattr(request, 'wutta_config')) + self.assertIs(request.wutta_config, self.config) + + def test_use_oruga_default(self): + request = self.make_request() + event = MagicMock(request=request) + + # request gets a new attr, false by default + self.assertFalse(hasattr(request, 'use_oruga')) + subscribers.new_request(event) + self.assertFalse(request.use_oruga) + + def test_use_oruga_custom(self): + self.config.setdefault('wuttaweb.oruga_detector.spec', 'tests.test_subscribers:custom_oruga_detector') + request = self.make_request() + event = MagicMock(request=request) + + # request gets a new attr, which should be true + self.assertFalse(hasattr(request, 'use_oruga')) + subscribers.new_request(event) + self.assertTrue(request.use_oruga) + + +def custom_oruga_detector(request): + return True + + +class TestBeforeRender(TestCase): + + def setUp(self): + self.config = WuttaConfig() + + def make_request(self): + request = testing.DummyRequest() + request.registry.settings = {'wutta_config': self.config} + request.wutta_config = self.config + return request + + def test_basic(self): + request = self.make_request() + event = {'request': request} + + # event dict will get populated with more context + subscribers.before_render(event) + + self.assertIn('config', event) + self.assertIs(event['config'], self.config) + + self.assertIn('app', event) + self.assertIs(event['app'], self.config.get_app()) + + self.assertIn('h', event) + self.assertIs(event['h'], helpers) + + self.assertIn('url', event) + # TODO: not sure how to test this? + # self.assertIs(event['url'], request.route_url) + + self.assertIn('json', event) + self.assertIs(event['json'], json) + + +class TestIncludeMe(TestCase): + + def test_basic(self): + with testing.testConfig() as pyramid_config: + + # just ensure no error happens when included.. + pyramid_config.include('wuttaweb.subscribers') diff --git a/tests/test_util.py b/tests/test_util.py new file mode 100644 index 0000000..d492943 --- /dev/null +++ b/tests/test_util.py @@ -0,0 +1,265 @@ +# -*- coding: utf-8; -*- + +from unittest import TestCase + +from pyramid import testing + +from wuttjamaican.conf import WuttaConfig +from wuttaweb import util + + +class TestGetLibVer(TestCase): + + def setUp(self): + self.config = WuttaConfig() + self.request = testing.DummyRequest() + self.request.wutta_config = self.config + + def test_buefy_default(self): + version = util.get_libver(self.request, 'buefy') + self.assertEqual(version, 'latest') + + def test_buefy_custom_old(self): + self.config.setdefault('wuttaweb.buefy_version', '0.9.29') + version = util.get_libver(self.request, 'buefy') + self.assertEqual(version, '0.9.29') + + def test_buefy_custom_new(self): + self.config.setdefault('wuttaweb.libver.buefy', '0.9.29') + version = util.get_libver(self.request, 'buefy') + self.assertEqual(version, '0.9.29') + + def test_buefy_default_only(self): + self.config.setdefault('wuttaweb.libver.buefy', '0.9.29') + version = util.get_libver(self.request, 'buefy', default_only=True) + self.assertEqual(version, 'latest') + + def test_buefy_css_default(self): + version = util.get_libver(self.request, 'buefy.css') + self.assertEqual(version, 'latest') + + def test_buefy_css_custom_old(self): + # nb. this uses same setting as buefy (js) + self.config.setdefault('wuttaweb.buefy_version', '0.9.29') + version = util.get_libver(self.request, 'buefy.css') + self.assertEqual(version, '0.9.29') + + def test_buefy_css_custom_new(self): + # nb. this uses same setting as buefy (js) + self.config.setdefault('wuttaweb.libver.buefy', '0.9.29') + version = util.get_libver(self.request, 'buefy.css') + self.assertEqual(version, '0.9.29') + + def test_buefy_css_default_only(self): + self.config.setdefault('wuttaweb.libver.buefy', '0.9.29') + version = util.get_libver(self.request, 'buefy.css', default_only=True) + self.assertEqual(version, 'latest') + + def test_vue_default(self): + version = util.get_libver(self.request, 'vue') + self.assertEqual(version, '2.6.14') + + def test_vue_custom_old(self): + self.config.setdefault('wuttaweb.vue_version', '3.4.31') + version = util.get_libver(self.request, 'vue') + self.assertEqual(version, '3.4.31') + + def test_vue_custom_new(self): + self.config.setdefault('wuttaweb.libver.vue', '3.4.31') + version = util.get_libver(self.request, 'vue') + self.assertEqual(version, '3.4.31') + + def test_vue_default_only(self): + self.config.setdefault('wuttaweb.libver.vue', '3.4.31') + version = util.get_libver(self.request, 'vue', default_only=True) + self.assertEqual(version, '2.6.14') + + def test_vue_resource_default(self): + version = util.get_libver(self.request, 'vue_resource') + self.assertEqual(version, 'latest') + + def test_vue_resource_custom(self): + self.config.setdefault('wuttaweb.libver.vue_resource', '1.5.3') + version = util.get_libver(self.request, 'vue_resource') + self.assertEqual(version, '1.5.3') + + def test_fontawesome_default(self): + version = util.get_libver(self.request, 'fontawesome') + self.assertEqual(version, '5.3.1') + + def test_fontawesome_custom(self): + self.config.setdefault('wuttaweb.libver.fontawesome', '5.6.3') + version = util.get_libver(self.request, 'fontawesome') + self.assertEqual(version, '5.6.3') + + def test_bb_vue_default(self): + version = util.get_libver(self.request, 'bb_vue') + self.assertEqual(version, '3.4.31') + + def test_bb_vue_custom(self): + self.config.setdefault('wuttaweb.libver.bb_vue', '3.4.30') + version = util.get_libver(self.request, 'bb_vue') + self.assertEqual(version, '3.4.30') + + def test_bb_oruga_default(self): + version = util.get_libver(self.request, 'bb_oruga') + self.assertEqual(version, '0.8.12') + + def test_bb_oruga_custom(self): + self.config.setdefault('wuttaweb.libver.bb_oruga', '0.8.11') + version = util.get_libver(self.request, 'bb_oruga') + self.assertEqual(version, '0.8.11') + + def test_bb_oruga_bulma_default(self): + version = util.get_libver(self.request, 'bb_oruga_bulma') + self.assertEqual(version, '0.3.0') + version = util.get_libver(self.request, 'bb_oruga_bulma_css') + self.assertEqual(version, '0.3.0') + + def test_bb_oruga_bulma_custom(self): + self.config.setdefault('wuttaweb.libver.bb_oruga_bulma', '0.2.11') + version = util.get_libver(self.request, 'bb_oruga_bulma') + self.assertEqual(version, '0.2.11') + + def test_bb_fontawesome_svg_core_default(self): + version = util.get_libver(self.request, 'bb_fontawesome_svg_core') + self.assertEqual(version, '6.5.2') + + def test_bb_fontawesome_svg_core_custom(self): + self.config.setdefault('wuttaweb.libver.bb_fontawesome_svg_core', '6.5.1') + version = util.get_libver(self.request, 'bb_fontawesome_svg_core') + self.assertEqual(version, '6.5.1') + + def test_bb_free_solid_svg_icons_default(self): + version = util.get_libver(self.request, 'bb_free_solid_svg_icons') + self.assertEqual(version, '6.5.2') + + def test_bb_free_solid_svg_icons_custom(self): + self.config.setdefault('wuttaweb.libver.bb_free_solid_svg_icons', '6.5.1') + version = util.get_libver(self.request, 'bb_free_solid_svg_icons') + self.assertEqual(version, '6.5.1') + + def test_bb_vue_fontawesome_default(self): + version = util.get_libver(self.request, 'bb_vue_fontawesome') + self.assertEqual(version, '3.0.6') + + def test_bb_vue_fontawesome_custom(self): + self.config.setdefault('wuttaweb.libver.bb_vue_fontawesome', '3.0.8') + version = util.get_libver(self.request, 'bb_vue_fontawesome') + self.assertEqual(version, '3.0.8') + + +class TestGetLibUrl(TestCase): + + def setUp(self): + self.config = WuttaConfig() + self.request = testing.DummyRequest() + self.request.wutta_config = self.config + + def test_buefy_default(self): + url = util.get_liburl(self.request, 'buefy') + self.assertEqual(url, 'https://unpkg.com/buefy@latest/dist/buefy.min.js') + + def test_buefy_custom(self): + self.config.setdefault('wuttaweb.liburl.buefy', '/lib/buefy.js') + url = util.get_liburl(self.request, 'buefy') + self.assertEqual(url, '/lib/buefy.js') + + def test_buefy_css_default(self): + url = util.get_liburl(self.request, 'buefy.css') + self.assertEqual(url, 'https://unpkg.com/buefy@latest/dist/buefy.min.css') + + def test_buefy_css_custom(self): + self.config.setdefault('wuttaweb.liburl.buefy.css', '/lib/buefy.css') + url = util.get_liburl(self.request, 'buefy.css') + self.assertEqual(url, '/lib/buefy.css') + + def test_vue_default(self): + url = util.get_liburl(self.request, 'vue') + self.assertEqual(url, 'https://unpkg.com/vue@2.6.14/dist/vue.min.js') + + def test_vue_custom(self): + self.config.setdefault('wuttaweb.liburl.vue', '/lib/vue.js') + url = util.get_liburl(self.request, 'vue') + self.assertEqual(url, '/lib/vue.js') + + def test_vue_resource_default(self): + url = util.get_liburl(self.request, 'vue_resource') + self.assertEqual(url, 'https://cdn.jsdelivr.net/npm/vue-resource@latest') + + def test_vue_resource_custom(self): + self.config.setdefault('wuttaweb.liburl.vue_resource', '/lib/vue-resource.js') + url = util.get_liburl(self.request, 'vue_resource') + self.assertEqual(url, '/lib/vue-resource.js') + + def test_fontawesome_default(self): + url = util.get_liburl(self.request, 'fontawesome') + self.assertEqual(url, 'https://use.fontawesome.com/releases/v5.3.1/js/all.js') + + def test_fontawesome_custom(self): + self.config.setdefault('wuttaweb.liburl.fontawesome', '/lib/fontawesome.js') + url = util.get_liburl(self.request, 'fontawesome') + self.assertEqual(url, '/lib/fontawesome.js') + + def test_bb_vue_default(self): + url = util.get_liburl(self.request, 'bb_vue') + self.assertEqual(url, 'https://unpkg.com/vue@3.4.31/dist/vue.esm-browser.prod.js') + + def test_bb_vue_custom(self): + self.config.setdefault('wuttaweb.liburl.bb_vue', '/lib/vue.js') + url = util.get_liburl(self.request, 'bb_vue') + self.assertEqual(url, '/lib/vue.js') + + def test_bb_oruga_default(self): + url = util.get_liburl(self.request, 'bb_oruga') + self.assertEqual(url, 'https://unpkg.com/@oruga-ui/oruga-next@0.8.12/dist/oruga.mjs') + + def test_bb_oruga_custom(self): + self.config.setdefault('wuttaweb.liburl.bb_oruga', '/lib/oruga.js') + url = util.get_liburl(self.request, 'bb_oruga') + self.assertEqual(url, '/lib/oruga.js') + + def test_bb_oruga_bulma_default(self): + url = util.get_liburl(self.request, 'bb_oruga_bulma') + self.assertEqual(url, 'https://unpkg.com/@oruga-ui/theme-bulma@0.3.0/dist/bulma.mjs') + + def test_bb_oruga_bulma_custom(self): + self.config.setdefault('wuttaweb.liburl.bb_oruga_bulma', '/lib/oruga_bulma.js') + url = util.get_liburl(self.request, 'bb_oruga_bulma') + self.assertEqual(url, '/lib/oruga_bulma.js') + + def test_bb_oruga_bulma_css_default(self): + url = util.get_liburl(self.request, 'bb_oruga_bulma_css') + self.assertEqual(url, 'https://unpkg.com/@oruga-ui/theme-bulma@0.3.0/dist/bulma.css') + + def test_bb_oruga_bulma_css_custom(self): + self.config.setdefault('wuttaweb.liburl.bb_oruga_bulma_css', '/lib/oruga-bulma.css') + url = util.get_liburl(self.request, 'bb_oruga_bulma_css') + self.assertEqual(url, '/lib/oruga-bulma.css') + + def test_bb_fontawesome_svg_core_default(self): + url = util.get_liburl(self.request, 'bb_fontawesome_svg_core') + self.assertEqual(url, 'https://cdn.jsdelivr.net/npm/@fortawesome/fontawesome-svg-core@6.5.2/+esm') + + def test_bb_fontawesome_svg_core_custom(self): + self.config.setdefault('wuttaweb.liburl.bb_fontawesome_svg_core', '/lib/fontawesome-svg-core.js') + url = util.get_liburl(self.request, 'bb_fontawesome_svg_core') + self.assertEqual(url, '/lib/fontawesome-svg-core.js') + + def test_bb_free_solid_svg_icons_default(self): + url = util.get_liburl(self.request, 'bb_free_solid_svg_icons') + self.assertEqual(url, 'https://cdn.jsdelivr.net/npm/@fortawesome/free-solid-svg-icons@6.5.2/+esm') + + def test_bb_free_solid_svg_icons_custom(self): + self.config.setdefault('wuttaweb.liburl.bb_free_solid_svg_icons', '/lib/free-solid-svg-icons.js') + url = util.get_liburl(self.request, 'bb_free_solid_svg_icons') + self.assertEqual(url, '/lib/free-solid-svg-icons.js') + + def test_bb_vue_fontawesome_default(self): + url = util.get_liburl(self.request, 'bb_vue_fontawesome') + self.assertEqual(url, 'https://cdn.jsdelivr.net/npm/@fortawesome/vue-fontawesome@3.0.6/+esm') + + def test_bb_vue_fontawesome_custom(self): + self.config.setdefault('wuttaweb.liburl.bb_vue_fontawesome', '/lib/vue-fontawesome.js') + url = util.get_liburl(self.request, 'bb_vue_fontawesome') + self.assertEqual(url, '/lib/vue-fontawesome.js') diff --git a/tests/views/__init__.py b/tests/views/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/tests/views/test___init__.py b/tests/views/test___init__.py new file mode 100644 index 0000000..0132cff --- /dev/null +++ b/tests/views/test___init__.py @@ -0,0 +1,14 @@ +# -*- coding: utf-8; -*- + +from unittest import TestCase + +from pyramid import testing + + +class TestIncludeMe(TestCase): + + def test_basic(self): + with testing.testConfig() as pyramid_config: + + # just ensure no error happens when included.. + pyramid_config.include('wuttaweb.views') diff --git a/tests/views/test_base.py b/tests/views/test_base.py new file mode 100644 index 0000000..ef78251 --- /dev/null +++ b/tests/views/test_base.py @@ -0,0 +1,21 @@ +# -*- coding: utf-8; -*- + +from unittest import TestCase + +from pyramid import testing + +from wuttjamaican.conf import WuttaConfig +from wuttaweb.views import base + + +class TestView(TestCase): + + def test_basic(self): + config = WuttaConfig() + request = testing.DummyRequest() + request.wutta_config = config + + view = base.View(request) + self.assertIs(view.request, request) + self.assertIs(view.config, config) + self.assertIs(view.app, config.get_app()) diff --git a/tests/views/test_common.py b/tests/views/test_common.py new file mode 100644 index 0000000..2b1607b --- /dev/null +++ b/tests/views/test_common.py @@ -0,0 +1,27 @@ +# -*- coding: utf-8; -*- + +from unittest import TestCase + +from pyramid import testing + +from wuttjamaican.conf import WuttaConfig +from wuttaweb.views import common + + +class TestCommonView(TestCase): + + def setUp(self): + self.config = WuttaConfig() + self.app = self.config.get_app() + self.request = testing.DummyRequest() + self.request.wutta_config = self.config + self.pyramid_config = testing.setUp(request=self.request) + self.pyramid_config.include('wuttaweb.views.common') + + def tearDown(self): + testing.tearDown() + + def test_home(self): + view = common.CommonView(self.request) + context = view.home() + self.assertEqual(context['index_title'], self.app.get_title()) diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000..9fb3728 --- /dev/null +++ b/tox.ini @@ -0,0 +1,17 @@ + +[tox] +envlist = py38, py39, py310, py311 + +[testenv] +extras = tests +commands = pytest {posargs} + +[testenv:coverage] +basepython = python3.11 +commands = pytest --cov=wuttjamaican --cov-report=html --cov-fail-under=100 + +[testenv:docs] +basepython = python3.11 +extras = docs +changedir = docs +commands = sphinx-build -b html -d {envtmpdir}/doctrees -W -T . {envtmpdir}/docs