commit 2a62a07188b571f0a984eb3e48bbd701091cf978 Author: Cédric Krier Date: Sat Apr 10 16:06:47 2021 +0200 Add product kit module issue9391 review321571002 diff --git a/.drone.yml b/.drone.yml new file mode 100644 index 0000000000..2049d30a49 --- /dev/null +++ b/.drone.yml @@ -0,0 +1,68 @@ +clone: + hg: + image: plugins/hg + environment: + - HG_SHARE_POOL=/root/.cache/hg + volumes: + - cache:/root/.cache + +pipeline: + tox: + image: ${IMAGE} + environment: + - CFLAGS=-O0 + - DB_CACHE=/cache + - TOX_TESTENV_PASSENV=CFLAGS DB_CACHE CI_BUILD_NUMBER CI_JOB_NUMBER CI_JOB_ID + - POSTGRESQL_URI=postgresql://postgres@postgresql:5432/ + commands: + - echo "[extensions]" >> /root/.hgrc + - echo "hgext.share =" >> /root/.hgrc + - echo "[share]" >> /root/.hgrc + - echo "pool = /root/.cache/hg" >> /root/.hgrc + - pip install tox + - tox -e "${TOXENV}-${DATABASE}" + volumes: + - cache:/root/.cache + check_dist: + image: ${IMAGE} + commands: + - pip install twine + - python setup.py sdist + - twine check dist/* + +services: + postgresql: + image: postgres + environment: + - POSTGRES_HOST_AUTH_METHOD=trust + command: "-c fsync=off -c synchronous_commit=off -c full_page_writes=off" + when: + matrix: + DATABASE: postgresql + +matrix: + include: + - IMAGE: python:3.6 + TOXENV: py36 + DATABASE: sqlite + - IMAGE: python:3.6 + TOXENV: py36 + DATABASE: postgresql + - IMAGE: python:3.7 + TOXENV: py37 + DATABASE: sqlite + - IMAGE: python:3.7 + TOXENV: py37 + DATABASE: postgresql + - IMAGE: python:3.8 + TOXENV: py38 + DATABASE: sqlite + - IMAGE: python:3.8 + TOXENV: py38 + DATABASE: postgresql + - IMAGE: python:3.9 + TOXENV: py39 + DATABASE: sqlite + - IMAGE: python:3.9 + TOXENV: py39 + DATABASE: postgresql diff --git a/.flake8 b/.flake8 new file mode 100644 index 0000000000..fa6b4f66d1 --- /dev/null +++ b/.flake8 @@ -0,0 +1,2 @@ +[flake8] +ignore=E123,E124,E126,E128,E741,W503 diff --git a/COPYRIGHT b/COPYRIGHT new file mode 100644 index 0000000000..700dfbfc12 --- /dev/null +++ b/COPYRIGHT @@ -0,0 +1,16 @@ +Copyright (C) 2020 B2CK +Copyright (C) 2020 Cédric Krier +Copyright (C) 2020 Sergi Almacellas Abellana + +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 . diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000000..94a9ed024d --- /dev/null +++ b/LICENSE @@ -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/MANIFEST.in b/MANIFEST.in new file mode 100644 index 0000000000..e88b2348a3 --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1,5 @@ +include CHANGELOG +include COPYRIGHT +include LICENSE +include README.rst +include doc/* diff --git a/README.rst b/README.rst new file mode 120000 index 0000000000..176d9c2695 --- /dev/null +++ b/README.rst @@ -0,0 +1 @@ +doc/index.rst \ No newline at end of file diff --git a/__init__.py b/__init__.py new file mode 100644 index 0000000000..6f72541846 --- /dev/null +++ b/__init__.py @@ -0,0 +1,56 @@ +# This file is part of Tryton. The COPYRIGHT file at the top level of +# this repository contains the full copyright notices and license terms. +from trytond.pool import Pool + +from . import product +from . import sale +from . import purchase +from . import stock +from . import account + +__all__ = ['register'] + + +def register(): + Pool.register( + product.Template, + product.Product, + product.Component, + module='product_kit', type_='model') + Pool.register( + account.Invoice, + account.InvoiceLine, + module='product_kit', type_='model', depends=['account_invoice_stock']) + Pool.register( + stock.Move, + module='product_kit', type_='model', depends=['stock']) + Pool.register( + sale.Sale, + sale.Line, + sale.LineComponent, + sale.LineComponentIgnoredMove, + sale.LineComponentRecreatedMove, + stock.MoveSale, + account.InvoiceLineSale, + module='product_kit', type_='model', depends=['sale']) + Pool.register( + sale.HandleShipmentException, + module='product_kit', type_='wizard', depends=['sale']) + Pool.register( + sale.AmendmentLine, + module='product_kit', type_='model', depends=['sale_amendment']) + Pool.register( + purchase.Purchase, + purchase.Line, + purchase.LineComponent, + purchase.LineComponentIgnoredMove, + purchase.LineComponentRecreatedMove, + stock.MovePurchase, + account.InvoiceLinePurchase, + module='product_kit', type_='model', depends=['purchase']) + Pool.register( + purchase.HandleShipmentException, + module='product_kit', type_='wizard', depends=['purchase']) + Pool.register( + purchase.AmendmentLine, + module='product_kit', type_='model', depends=['purchase_amendment']) diff --git a/account.py b/account.py new file mode 100644 index 0000000000..fa14c91cb8 --- /dev/null +++ b/account.py @@ -0,0 +1,56 @@ +# This file is part of Tryton. The COPYRIGHT file at the top level of +# this repository contains the full copyright notices and license terms. +from trytond.model import ModelView, Workflow +from trytond.pool import PoolMeta, Pool + + +class Invoice(metaclass=PoolMeta): + __name__ = 'account.invoice' + + @classmethod + @ModelView.button + @Workflow.transition('posted') + def post(cls, invoices): + pool = Pool() + Move = pool.get('stock.move') + super().post(invoices) + moves = sum( + (l.stock_component_moves for i in invoices for l in i.lines), []) + if moves: + Move.__queue__.update_unit_price(moves) + + +class InvoiceLine(metaclass=PoolMeta): + __name__ = 'account.invoice.line' + + @property + def stock_component_moves(self): + return [] + + +class InvoiceLineSale(metaclass=PoolMeta): + __name__ = 'account.invoice.line' + + @property + def stock_component_moves(self): + pool = Pool() + SaleLine = pool.get('sale.line') + moves = super().stock_component_moves + if isinstance(self.origin, SaleLine): + for component in self.origin.components: + moves.extend(component.moves) + return moves + + +class InvoiceLinePurchase(metaclass=PoolMeta): + __name__ = 'account.invoice.line' + + @property + def stock_component_moves(self): + pool = Pool() + PurchaseLine = pool.get('purchase.line') + moves = super().stock_component_moves + if isinstance(self.origin, PurchaseLine): + for component in self.origin.components: + moves.extend(component.moves) + return moves diff --git a/common.py b/common.py new file mode 100644 index 0000000000..3ae49f723a --- /dev/null +++ b/common.py @@ -0,0 +1,427 @@ +# This file is part of Tryton. The COPYRIGHT file at the top level of +# this repository contains the full copyright notices and license terms. +from collections import defaultdict +from decimal import Decimal +from functools import wraps + +from trytond.model import ModelStorage, ModelView, Workflow, fields +from trytond.pool import Pool +from trytond.pyson import Eval + + +def get_shipments_returns(model_name): + def _get_shipments_returns(func): + @wraps(func) + def wrapper(self, name): + pool = Pool() + Model = pool.get(model_name) + shipments = set(func(self, name)) + for line in self.lines: + for component in line.components: + for move in component.moves: + if isinstance(move.shipment, Model): + shipments.add(move.shipment.id) + return list(shipments) + return wrapper + return _get_shipments_returns + + +def search_shipments_returns(model_name): + def _search_shipments_returns(func): + @wraps(func) + def wrapper(cls, name, clause): + domain = func(cls, name, clause) + nested = clause[0].lstrip(name) + if nested: + return ['OR', + domain, + ('lines.components.moves.shipment' + nested,) + + tuple(clause[1:3]) + (model_name,) + tuple(clause[3:]), + ] + else: + if isinstance(clause[2], str): + target = 'rec_name' + else: + target = 'id' + return ['OR', + ('lines.components.moves.shipment.' + target,) + + tuple(clause[1:3]) + (model_name,)] + return wrapper + return _search_shipments_returns + + +def order_mixin(prefix): + class OrderMixin(ModelStorage): + + @classmethod + def copy(cls, records, default=None): + pool = Pool() + Line = pool.get(prefix + '.line') + if default is None: + default = {} + else: + default = default.copy() + default.setdefault( + 'lines.component_parent', + lambda data: data['component_parent']) + records = super().copy(records, default=default) + lines = [] + for record in records: + for line in record.lines: + if line.component_parent: + lines.append(line) + Line.delete(lines) + return records + + @classmethod + @ModelView.button + @Workflow.transition('draft') + def draft(cls, records): + pool = Pool() + Line = pool.get(prefix + '.line') + to_delete = [] + to_save = [] + for record in records: + for line in record.lines: + if line.component_parent: + to_delete.append(line) + elif line.components: + line.components = None + to_save.append(line) + Line.save(to_save) + super().draft(records) + Line.delete(to_delete) + + @classmethod + @ModelView.button + @Workflow.transition('quotation') + def quote(cls, records): + pool = Pool() + Line = pool.get(prefix + '.line') + removed = [] + for record in records: + removed.extend(record.set_components()) + Line.delete(removed) + cls.save(records) + super().quote(records) + + def set_components(self): + pool = Pool() + Component = pool.get(prefix + '.line.component') + removed = [] + lines = [] + sequence = 0 + for line in self.lines: + if line.component_parent: + removed.append(line) + continue + sequence += 1 + line.sequence = sequence + lines.append(line) + if line.product and line.product.components_used: + if line.product.type == 'kit': + components = [] + for component in line.product.components_used: + components.append(line.get_component(component)) + Component.set_price_ratio(components) + line.components = components + else: + for component in line.product.components_used: + order_line = line.get_component_order_line( + component) + sequence += 1 + order_line.sequence = sequence + order_line.component_parent = line + lines.append(order_line) + self.lines = lines + return removed + return OrderMixin + + +def order_line_mixin(prefix): + class OrderLineMixin(ModelStorage, ModelView): + + component_parent = fields.Many2One( + prefix + '.line', "Component Parent", + readonly=True, + states={ + 'invisible': ~Eval('component_parent'), + }) + component_children = fields.One2Many( + prefix + '.line', 'component_parent', "Component Children", + readonly=True, + states={ + 'invisible': ~Eval('component_children'), + }) + + components = fields.One2Many( + prefix + '.line.component', 'line', "Components", readonly=True, + states={ + 'invisible': ~Eval('components', []), + }) + + @classmethod + def view_attributes(cls): + return super().view_attributes() + [ + ('//page[@id="components"]', 'states', { + 'invisible': ( + ~Eval('components', []) + & ~Eval('component_children', [])), + }), + ] + + @classmethod + def copy(cls, lines, default=None): + if default is None: + default = {} + else: + default = default.copy() + default.setdefault('component_parent') + default.setdefault('component_children') + default.setdefault('components') + return super().copy(lines, default=default) + + def get_component(self, component, **kwargs): + pool = Pool() + Component = pool.get(prefix + '.line.component') + line = component.get_line( + Component, self.quantity, self.unit, **kwargs) + line.fixed = component.fixed + if not line.fixed: + line.quantity_ratio = component.quantity + return line + + def get_component_order_line(self, component, **values): + Line = self.__class__ + line = component.get_line( + Line, self.quantity, self.unit, **values) + line.type = 'line' + line.on_change_product() + return line + + def get_move(self, type_): + move = super().get_move(type_) + if self.components: + move = None + return move + + def get_move_done(self, name): + done = super().get_move_done(name) + if self.components: + done = all(c.move_done for c in self.components) + return done + + def get_move_exception(self, name): + exception = super().get_move_exception(name) + if self.components: + exception = any(c.move_exception for c in self.components) + return exception + + def _get_invoice_line_quantity(self): + quantity = super()._get_invoice_line_quantity() + if (getattr(self, prefix).invoice_method == 'shipment' + and self.components): + ratio = min(c.get_moved_ratio() for c in self.components) + quantity = self.unit.round(self.quantity * ratio) + return quantity + return OrderLineMixin + + +def order_line_component_mixin(prefix): + class OrderLineComponentMixin(ModelStorage): + + line = fields.Many2One( + prefix + '.line', "Line", required=True, ondelete='CASCADE', + domain=[ + ('product.type', '=', 'kit'), + ]) + moves = fields.One2Many('stock.move', 'origin', 'Moves', readonly=True) + moves_ignored = fields.Many2Many( + prefix + '.line.component-ignored-stock.move', + 'component', 'move', "Ignored Moves", readonly=True) + moves_recreated = fields.Many2Many( + prefix + '.line.component-recreated-stock.move', + 'component', 'move', "Recreated Moves", readonly=True) + move_done = fields.Function( + fields.Boolean('Moves Done'), 'get_move_done') + move_exception = fields.Function( + fields.Boolean('Moves Exception'), 'get_move_exception') + quantity_ratio = fields.Float( + "Quantity Ratio", readonly=True, + states={ + 'required': ~Eval('fixed', False), + }, + depends=['fixed']) + price_ratio = fields.Numeric( + "Price Ratio", readonly=True, required=True) + + @classmethod + def __setup__(cls): + super().__setup__() + cls.__access__.add('line') + + @fields.depends('line', '_parent_line.product') + def on_change_with_parent_type(self, name=None): + if self.line and self.line.product: + return self.line.product.type + + @classmethod + def set_price_ratio(cls, components): + "Set price ratio between components" + pool = Pool() + Uom = pool.get('product.uom') + list_prices = defaultdict(Decimal) + sum_ = 0 + for component in components: + product = component.product + list_price = Uom.compute_price( + product.default_uom, product.list_price, + component.unit) * Decimal(str(component.quantity)) + list_prices[component] = list_price + sum_ += list_price + + for component in components: + if sum_: + ratio = list_prices[component] / sum_ + else: + ratio = 1 / len(components) + component.price_ratio = ratio + + def get_move(self, type_): + raise NotImplementedError + + def _get_shipped_quantity(self, shipment_type): + 'Return the quantity already shipped' + pool = Pool() + Uom = pool.get('product.uom') + + quantity = 0 + skips = set(self.moves_recreated) + for move in self.moves: + if move not in skips: + quantity += Uom.compute_qty( + move.uom, move.quantity, self.unit) + return quantity + + @property + def _move_remaining_quantity(self): + "Compute the remaining quantity to ship" + pool = Pool() + Uom = pool.get('product.uom') + ignored = set(self.moves_ignored) + quantity = abs(self.quantity) + for move in self.moves: + if move.state == 'done' or move in ignored: + quantity -= Uom.compute_qty( + move.uom, move.quantity, self.unit) + return quantity + + def get_move_done(self, name): + quantity = self._move_remaining_quantity + if quantity is None: + return True + else: + return self.unit.round(quantity) <= 0 + + def get_move_exception(self, name): + skips = set(self.moves_ignored) + skips.update(self.moves_recreated) + for move in self.moves: + if move.state == 'cancelled' and move not in skips: + return True + return False + + def get_moved_ratio(self): + pool = Pool() + Uom = pool.get('product.uom') + + quantity = 0 + for move in self.moves: + if move.state != 'done': + continue + qty = Uom.compute_qty(move.uom, move.quantity, self.unit) + dest_type = self.line.to_location.type + if (move.to_location.type == dest_type + and move.from_location.type != dest_type): + quantity += qty + elif (move.from_location.type == dest_type + and move.to_location.type != dest_type): + quantity -= qty + if self.quantity < 0: + quantity *= -1 + return quantity / self.quantity + + def get_rec_name(self, name): + return super().get_rec_name(name) + ( + ' @ %s' % self.line.rec_name) + + @classmethod + def search_rec_name(cls, name, clause): + return super().search_rec_name(name, clause) + [ + ('line.rec_name',) + tuple(clause[1:]), + ] + return OrderLineComponentMixin + + +def handle_shipment_exception_mixin(prefix): + class HandleShipmentExceptionMixin: + def default_ask(self, fields): + values = super().default_ask(fields) + moves = values['domain_moves'] + for line in self.record.lines: + for component in line.components: + skips = set(component.moves_ignored) + skips.update(component.moves_recreated) + for move in component.moves: + if move.state == 'cancelled' and move not in skips: + moves.append(move.id) + return values + + def transition_handle(self): + pool = Pool() + Component = pool.get(prefix + '.line.component') + + result = super().transition_handle() + + to_write = [] + for line in self.record.lines: + for component in line.components: + moves_ignored = [] + moves_recreated = [] + skips = set(component.moves_ignored) + skips.update(component.moves_recreated) + for move in component.moves: + if move not in self.ask.domain_moves or move in skips: + continue + if move in self.ask.recreate_moves: + moves_recreated.append(move.id) + else: + moves_ignored.append(move.id) + + if moves_ignored or moves_recreated: + to_write.append([component]) + to_write.append({ + 'moves_ignored': [('add', moves_ignored)], + 'moves_recreated': [('add', moves_recreated)], + }) + if to_write: + Component.write(*to_write) + return result + return HandleShipmentExceptionMixin + + +class AmendmentLineMixin: + + def _apply_line(self, record, line): + pool = Pool() + Uom = pool.get('product.uom') + super()._apply_line(record, line) + if line.components: + quantity = Uom.compute_qty( + line.unit, line.quantity, + line.product.default_uom, round=False) + for component in line.components: + if not component.fixed: + component.quantity = component.unit.round( + quantity * component.quantity_ratio) + line.components = line.components diff --git a/doc/design.rst b/doc/design.rst new file mode 100644 index 0000000000..81d66668bd --- /dev/null +++ b/doc/design.rst @@ -0,0 +1,121 @@ +****** +Design +****** + +The *Product Kit Module* module introduces the following concepts: + +.. _concept-product: + +Product +======= + +When the *Product Kit Module* is activated, products gain some extra properties. +These include a new type "Kit" which corresponds to a product composed of other +goods defined by a list of `Components `. + +.. seealso:: + + The `Product ` concept is introduced by the + :doc:`Product Module `. + +.. _model-product.component: + +Product Component +================= + +The *Product Component* concept defines the quantity of a product that is part +of another product. + +.. _model-sale.sale: + +Sale +==== + +When the *Product Kit Module* is activated, components are added to sales when +the sale is quoted. + +For `Sale Lines ` with a kit `Product `, a +`Sale Line Component ` is created for each `Product +Component `. +These components are used as the origins for the `Stock Moves +` and the sale lines of the `Invoice Lines +`. +When the `Invoice ` method is on +shipment, the smallest ratio of shipped components is used to calculate the +quantity invoiced. + +For `Sale Lines ` with a non-kit product containing `Product +Components `, a sale line is created for each one. + +When the sale is reset to draft, all created components are deleted. + +.. _model-sale.line: + +Line +---- + +The sale lines gain a list of `Sale Line Components +` and a list of children which are created when the +`Sale ` is quoted. + +.. _model-sale.line.component: + +Line Component +-------------- + +The *Sale Line Component* concept defines for a `Sale Line +` the quantity of a `Product Component +` to be shipped instead of the kit. + +.. seealso:: + + The `Sale ` model is introduced by the :doc:`Sale + Module `. + + +.. _model-purchase.purchase: + +Purchase +======== + +When the *Product Kit Module* is activated, components are added to `Purchases +` when the purchase is quoted. + +For `Purchase Lines ` with a kit `Product +`, a `Purchase Line Component ` is +created for each `Product Component `. +These components are used as the origins for the `Stock Moves +` and the purchase lines of the `Invoice Lines +`. +When the `Invoice ` method is on +shipment, the smallest ratio of received components is used to calculate the +quantity invoiced. + +For `Purchase Lines ` with a non-kit product containing +`Product Components `, a purchase line is created for +each one. + +When the purchase is reset to draft, all created components are deleted. + +.. _model-purchase.line: + +Line +---- + +The purchase lines gain a list of `Purchase Line Components +` and a list of children which are created when +the `Purchase ` is quoted. + +.. _model-purchase.line.component: + +Line Component +-------------- + +The *Purchase Line Component* concept defines for a `Purchase Line +` the quantity of a `Product Component +` to be received instead of the kit. + +.. seealso:: + + The `Purchase ` model is introduced by the + :doc:`Purchase Module `. diff --git a/doc/index.rst b/doc/index.rst new file mode 100644 index 0000000000..c9e616a5b2 --- /dev/null +++ b/doc/index.rst @@ -0,0 +1,12 @@ +################## +Product Kit Module +################## + +The *Product Kit Module* adds kits and components to products. +This enables a defined set of products to be sold or purchased using a single +line. + +.. toctree:: + :maxdepth: 2 + + design diff --git a/product.py b/product.py new file mode 100644 index 0000000000..0ebec4fe54 --- /dev/null +++ b/product.py @@ -0,0 +1,221 @@ +# This file is part of Tryton. The COPYRIGHT file at the top level of +# this repository contains the full copyright notices and license terms. +from decimal import Decimal + +from trytond.model import ( + ModelView, ModelSQL, ModelStorage, sequence_ordered, fields) +from trytond.pyson import Eval, If, Bool +from trytond.pool import PoolMeta, Pool + +from trytond.modules.product import round_price + + +class Template(metaclass=PoolMeta): + __name__ = "product.template" + + components = fields.One2Many( + 'product.component', 'parent_template', "Components") + + @classmethod + def __setup__(cls): + super().__setup__() + cls.type.selection.append(('kit', "Kit")) + + @fields.depends('type', 'cost_price_method') + def on_change_type(self): + super().on_change_type() + if self.type == 'kit': + self.cost_price_method = 'fixed' + + +class Product(metaclass=PoolMeta): + __name__ = "product.product" + + components = fields.One2Many( + 'product.component', 'parent_product', "Components") + + def get_multivalue(self, name, **pattern): + pool = Pool() + Uom = pool.get('product.uom') + value = super().get_multivalue(name, **pattern) + if name == 'cost_price' and self.type == 'kit': + value = Decimal(0) + for component in self.components_used: + cost_price = component.product.get_multivalue( + 'cost_price', **pattern) + cost_price = Uom.compute_price( + component.product.default_uom, cost_price, component.unit) + value += cost_price * Decimal(str(component.quantity)) + value = round_price(value) + return value + + @property + def components_used(self): + return self.components or self.template.components + + @classmethod + def get_quantity(cls, products, name): + pool = Pool() + Uom = pool.get('product.uom') + kits = [p for p in products if p.type == 'kit'] + quantities = super().get_quantity(products, name) + for kit in kits: + qties = [] + for component in kit.components_used: + component_qty = Uom.compute_qty( + component.product.default_uom, + getattr(component.product, name), + component.unit, round=False) + if not component.fixed: + component_qty /= component.quantity + qties.append(component_qty) + quantities[kit.id] = kit.default_uom.floor(min(qties, default=0)) + return quantities + + +class ComponentMixin(sequence_ordered(), ModelStorage): + + parent_type = fields.Function(fields.Selection( + 'get_product_types', "Parent Type"), 'on_change_with_parent_type') + product = fields.Many2One( + 'product.product', "Product", required=True, + domain=[ + ('components', '=', None), + ('template.components', '=', None), + If(Eval('parent_type') == 'kit', + ('type', '=', 'goods'), + ()), + ], + depends=['parent_type']) + product_unit_category = fields.Function( + fields.Many2One('product.uom.category', "Product Unit Category"), + 'on_change_with_product_unit_category') + quantity = fields.Float( + "Quantity", required=True, + digits=(16, Eval('unit_digits', 2)), + depends=['unit_digits']) + unit = fields.Many2One('product.uom', "Unit", required=True, + domain=[ + If(Bool(Eval('product_unit_category')), + ('category', '=', Eval('product_unit_category')), + ('category', '!=', -1)), + ], + depends=['product', 'product_unit_category']) + unit_digits = fields.Function(fields.Integer('Unit Digits'), + 'on_change_with_unit_digits') + fixed = fields.Boolean("Fixed", + help="Check to make the quantity of the component independent " + "of the kit quantity") + + @classmethod + def get_product_types(cls): + pool = Pool() + Product = pool.get('product.product') + return Product.fields_get(['type'])['type']['selection'] + + def on_change_with_parent_type(self, name): + raise NotImplementedError + + @fields.depends('product', 'unit', 'quantity', + methods=['on_change_with_product_unit_category']) + def on_change_product(self): + if self.product: + self.product_unit_category = ( + self.on_change_with_product_unit_category()) + if (not self.unit + or self.unit.category != self.product_unit_category): + self.unit = self.product.default_uom + + @fields.depends('product') + def on_change_with_product_unit_category(self, name=None): + if self.product: + return self.product.default_uom.category.id + + @fields.depends('unit') + def on_change_with_unit_digits(self, name=None): + if self.unit: + return self.unit.digits + + def get_line(self, Line, quantity, unit, **values): + pool = Pool() + Uom = pool.get('product.uom') + line = Line(product=self.product, **values) + line.unit = self.unit + if self.fixed: + line.quantity = self.quantity + else: + quantity = Uom.compute_qty( + unit, quantity, self.product.default_uom, round=False) + line.quantity = self.unit.round(quantity * self.quantity) + return line + + def get_rec_name(self, name): + pool = Pool() + Lang = pool.get('ir.lang') + lang = Lang.get() + return (lang.format( + '%.*f', (self.unit.digits, self.quantity)) + + '%s %s' % ( + self.unit.symbol, self.product.rec_name)) + + @classmethod + def search_rec_name(cls, name, clause): + return ['OR', + ('product.rec_name',) + tuple(clause[1:]), + ] + + +class Component(ComponentMixin, ModelSQL, ModelView): + "Product Component" + __name__ = "product.component" + + parent_template = fields.Many2One( + 'product.template', "Parent Product", + required=True, ondelete='CASCADE', select=True, + domain=[ + If(Bool(Eval('parent_product')), + ('products', '=', Eval('parent_product')), + ()), + ], + depends=['parent_product']) + parent_product = fields.Many2One( + 'product.product', "Parent Variant", ondelete='CASCADE', select=True, + domain=[ + If(Bool(Eval('parent_template')), + ('template', '=', Eval('parent_template')), + ()), + ], + depends=['parent_template']) + + @classmethod + def __setup__(cls): + super().__setup__() + cls.__access__.update(['parent_template', 'parent_product']) + + @fields.depends( + 'parent_product', '_parent_parent_product.template') + def on_change_parent_product(self): + if self.parent_product: + self.parent_template = self.parent_product.template + + @fields.depends( + 'parent_template', '_parent_parent_template.type', + 'parent_product', '_parent_parent_product.type') + def on_change_with_parent_type(self, name=None): + if self.parent_product: + return self.parent_product.type + elif self.parent_template: + return self.parent_template.type + + def get_rec_name(self, name): + return super().get_rec_name(name) + ( + ' @ %s' % ( + self.parent_product.rec_name if self.parent_product + else self.parent_template.rec_name)) + + @classmethod + def search_rec_name(cls, name, clause): + return super().search_rec_name(name, clause) + [ + ('parent_product.rec_name',) + tuple(clause[1:]), + ('parent_template.rec_name',) + tuple(clause[1:]), + ] diff --git a/product.xml b/product.xml new file mode 100644 index 0000000000..9fc42e5d0b --- /dev/null +++ b/product.xml @@ -0,0 +1,26 @@ + + + + + + + product.template + + product_template_form + + + + product.component + tree + product_component_list + + + + product.component + form + product_component_form + + + + diff --git a/purchase.py b/purchase.py new file mode 100644 index 0000000000..0ccf9898d6 --- /dev/null +++ b/purchase.py @@ -0,0 +1,146 @@ +# This file is part of Tryton. The COPYRIGHT file at the top level of +# this repository contains the full copyright notices and license terms. +from trytond.i18n import gettext +from trytond.pool import PoolMeta, Pool +from trytond.model import ModelSQL, ModelView, fields + +from trytond.modules.product import round_price +from trytond.modules.purchase.exceptions import PartyLocationError + +from .product import ComponentMixin +from .common import order_mixin, order_line_mixin, order_line_component_mixin +from .common import get_shipments_returns, search_shipments_returns +from .common import handle_shipment_exception_mixin +from .common import AmendmentLineMixin + + +class Purchase(order_mixin('purchase'), metaclass=PoolMeta): + __name__ = 'purchase.purchase' + + def create_move(self, move_type): + pool = Pool() + Move = pool.get('stock.move') + moves = super().create_move(move_type) + for line in self.lines: + if line.components: + for component in line.components: + move = component.get_move(move_type) + if move: + moves.append(move) + Move.save(moves) + return moves + + @get_shipments_returns('stock.shipment.in') + def get_shipments(self, name): + return super().get_shipments(name) + + @get_shipments_returns('stock.shipment.in.return') + def get_shipment_returns(self, name): + return super().get_shipment_returns(name) + + @classmethod + @search_shipments_returns('stock.shipment.in') + def search_shipments(cls, name, clause): + return super().search_shipments(name, clause) + + @classmethod + @search_shipments_returns('stock.shipment.in.return') + def search_shipment_returns(cls, name, clause): + return super().search_shipments(name, clause) + + +class Line(order_line_mixin('purchase'), metaclass=PoolMeta): + __name__ = 'purchase.line' + + def get_component_order_line(self, component, **values): + values = values.copy() + values['purchase'] = self.purchase + return super().get_component_order_line(component, **values) + + +class LineComponent( + order_line_component_mixin('purchase'), ComponentMixin, + ModelSQL, ModelView): + "Purchase Line Component" + __name__ = 'purchase.line.component' + + def get_move(self, move_type): + pool = Pool() + Move = pool.get('stock.move') + Date = pool.get('ir.date') + + if (self.quantity >= 0) != (move_type == 'in'): + return + + quantity = ( + self._get_move_quantity(move_type) + - self._get_shipped_quantity(move_type)) + + quantity = self.unit.round(quantity) + if quantity <= 0: + return + + if not self.line.purchase.party.supplier_location: + raise PartyLocationError( + gettext('purchase.msg_purchase_supplier_location_required', + purchase=self.purchase.rec_name, + party=self.purchase.party.rec_name)) + + move = Move() + move.quantity = quantity + move.uom = self.unit + move.product = self.product + move.from_location = self.line.from_location + move.to_location = self.line.to_location + move.state = 'draft' + move.company = self.line.purchase.company + if move.on_change_with_unit_price_required(): + move.unit_price = round_price( + self.line.unit_price * self.price_ratio) + move.currency = self.line.purchase.currency + if self.moves: + # backorder can not be planned but shipping date could be used + # if set in the future + if (self.line.delivery_date + and self.line.delivery_date > Date.today()): + move.planned_date = self.line.shipping_date + else: + move.planned_date = None + else: + move.planned_date = self.line.delivery_date + move.origin = self + return move + + def _get_move_quantity(self, shipment_type): + 'Return the quantity that should be shipped' + return abs(self.quantity) + + +class LineComponentIgnoredMove(ModelSQL): + 'Purchase Line Component - Ignored Move' + __name__ = 'purchase.line.component-ignored-stock.move' + component = fields.Many2One( + 'purchase.line.component', "Component", + ondelete='CASCADE', select=True, required=True) + move = fields.Many2One( + 'stock.move', "Move", ondelete='RESTRICT', select=True, required=True) + + +class LineComponentRecreatedMove(ModelSQL): + 'Purchase Line Component - Recreated Move' + __name__ = 'purchase.line.component-recreated-stock.move' + component = fields.Many2One( + 'purchase.line.component', "Component", + ondelete='CASCADE', select=True, required=True) + move = fields.Many2One( + 'stock.move', "Move", ondelete='RESTRICT', select=True, required=True) + + +class HandleShipmentException( + handle_shipment_exception_mixin('purchase'), + metaclass=PoolMeta): + __name__ = 'purchase.handle.shipment.exception' + + +class AmendmentLine(AmendmentLineMixin, metaclass=PoolMeta): + __name__ = 'purchase.amendment.line' diff --git a/purchase.xml b/purchase.xml new file mode 100644 index 0000000000..35c8a21124 --- /dev/null +++ b/purchase.xml @@ -0,0 +1,26 @@ + + + + + + + purchase.line + + purchase_line_form + + + + purchase.line.component + tree + purchase_line_component_list + + + + purchase.line.component + form + purchase_line_component_form + + + + diff --git a/sale.py b/sale.py new file mode 100644 index 0000000000..ba8fd9179b --- /dev/null +++ b/sale.py @@ -0,0 +1,158 @@ +# This file is part of Tryton. The COPYRIGHT file at the top level of +# this repository contains the full copyright notices and license terms. +from trytond.i18n import gettext +from trytond.pool import PoolMeta, Pool +from trytond.model import ModelSQL, ModelView, fields + +from trytond.modules.product import round_price +from trytond.modules.sale.exceptions import PartyLocationError + +from .product import ComponentMixin +from .common import order_mixin, order_line_mixin, order_line_component_mixin +from .common import get_shipments_returns, search_shipments_returns +from .common import handle_shipment_exception_mixin +from .common import AmendmentLineMixin + + +class Sale(order_mixin('sale'), metaclass=PoolMeta): + __name__ = 'sale.sale' + + def _get_shipment_moves(self, shipment_type): + moves = super()._get_shipment_moves(shipment_type) + for line in self.lines: + if line.components: + for component in line.components: + move = component.get_move(shipment_type) + if move: + moves[component] = move + return moves + + @get_shipments_returns('stock.shipment.out') + def get_shipments(self, name): + return super().get_shipments(name) + + @get_shipments_returns('stock.shipment.out.return') + def get_shipment_returns(self, name): + return super().get_shipment_returns(name) + + @classmethod + @search_shipments_returns('stock.shipment.out') + def search_shipments(cls, name, clause): + return super().search_shipments(name, clause) + + @classmethod + @search_shipments_returns('stock.shipment.out.return') + def search_shipment_returns(cls, name, clause): + return super().search_shipments(name, clause) + + +class Line(order_line_mixin('sale'), metaclass=PoolMeta): + __name__ = 'sale.line' + + def get_component_order_line(self, component, **values): + values = values.copy() + values['sale'] = self.sale + return super().get_component_order_line(component, **values) + + +class LineComponent( + order_line_component_mixin('sale'), ComponentMixin, + ModelSQL, ModelView): + "Sale Line Component" + __name__ = 'sale.line.component' + + @property + def warehouse(self): + return self.line.warehouse + + def get_move(self, shipment_type): + pool = Pool() + Move = pool.get('stock.move') + Date = pool.get('ir.date') + if (shipment_type == 'out') != (self.quantity >= 0): + return + + quantity = ( + self._get_move_quantity(shipment_type) + - self._get_shipped_quantity(shipment_type)) + + quantity = self.unit.round(quantity) + if quantity <= 0: + return + + if not self.line.sale.party.customer_location: + raise PartyLocationError( + gettext('sale.msg_sale_customer_location_required', + sale=self.sale.rec_name, + party=self.sale.party.rec_name)) + + move = Move() + move.quantity = quantity + move.uom = self.unit + move.product = self.product + move.from_location = self.line.from_location + move.to_location = self.line.to_location + move.state = 'draft' + move.company = self.line.sale.company + if move.on_change_with_unit_price_required(): + move.unit_price = round_price( + self.line.unit_price * self.price_ratio) + move.currency = self.line.sale.currency + if self.moves: + # backorder can not be planned but shipping date could be used + # if set in the future + today = Date.today() + if self.line.shipping_date and self.line.shipping_date > today: + move.planned_date = self.line.shipping_date + else: + move.planned_date = today + else: + move.planned_date = self.line.shipping_date + move.origin = self + return move + + def _get_move_quantity(self, shipment_type): + 'Return the quantity that should be shipped' + pool = Pool() + Uom = pool.get('product.uom') + + if self.line.sale.shipment_method == 'order': + return abs(self.quantity) + elif self.line.sale.shipment_method == 'invoice': + quantity = 0.0 + for invoice_line in self.line.invoice_lines: + if (invoice_line.invoice + and invoice_line.invoice.state == 'paid'): + quantity += Uom.compute_qty(invoice_line.unit, + invoice_line.quantity, self.line.unit) + return self.quantity * quantity / self.line.quantity + + +class LineComponentIgnoredMove(ModelSQL): + 'Sale Line Component - Ignored Move' + __name__ = 'sale.line.component-ignored-stock.move' + component = fields.Many2One( + 'sale.line.component', "Component", + ondelete='CASCADE', select=True, required=True) + move = fields.Many2One( + 'stock.move', "Move", ondelete='RESTRICT', select=True, required=True) + + +class LineComponentRecreatedMove(ModelSQL): + 'Sale Line Component - Recreated Move' + __name__ = 'sale.line.component-recreated-stock.move' + component = fields.Many2One( + 'sale.line.component', "Sale Line Component", + ondelete='CASCADE', select=True, required=True) + move = fields.Many2One( + 'stock.move', "Move", ondelete='RESTRICT', select=True, required=True) + + +class HandleShipmentException( + handle_shipment_exception_mixin('sale'), + metaclass=PoolMeta): + __name__ = 'sale.handle.shipment.exception' + + +class AmendmentLine(AmendmentLineMixin, metaclass=PoolMeta): + __name__ = 'sale.amendment.line' diff --git a/sale.xml b/sale.xml new file mode 100644 index 0000000000..371b5a6ee8 --- /dev/null +++ b/sale.xml @@ -0,0 +1,26 @@ + + + + + + + sale.line + + sale_line_form + + + + sale.line.component + tree + sale_line_component_list + + + + sale.line.component + form + sale_line_component_form + + + + diff --git a/setup.py b/setup.py new file mode 100644 index 0000000000..8cba20eac9 --- /dev/null +++ b/setup.py @@ -0,0 +1,161 @@ +#!/usr/bin/env python3 +# This file is part of Tryton. The COPYRIGHT file at the top level of +# this repository contains the full copyright notices and license terms. + +import io +import os +import re +from configparser import ConfigParser +from setuptools import setup, find_packages + + +def read(fname): + content = io.open( + os.path.join(os.path.dirname(__file__), fname), + 'r', encoding='utf-8').read() + content = re.sub( + r'(?m)^\.\. toctree::\r?\n((^$|^\s.*$)\r?\n)*', '', content) + return content + + +def get_require_version(name): + if minor_version % 2: + require = '%s >= %s.%s.dev0, < %s.%s' + else: + require = '%s >= %s.%s, < %s.%s' + require %= (name, major_version, minor_version, + major_version, minor_version + 1) + return require + + +config = ConfigParser() +config.read_file(open(os.path.join(os.path.dirname(__file__), 'tryton.cfg'))) +info = dict(config.items('tryton')) +for key in ('depends', 'extras_depend', 'xml'): + if key in info: + info[key] = info[key].strip().splitlines() +version = info.get('version', '0.0.1') +major_version, minor_version, _ = version.split('.', 2) +major_version = int(major_version) +minor_version = int(minor_version) +name = 'trytond_product_kit' + +download_url = 'http://downloads.tryton.org/%s.%s/' % ( + major_version, minor_version) +if minor_version % 2: + version = '%s.%s.dev0' % (major_version, minor_version) + download_url = ( + 'hg+http://hg.tryton.org/modules/%s#egg=%s-%s' % ( + name[8:], name, version)) +local_version = [] +if os.environ.get('CI_JOB_ID'): + local_version.append(os.environ['CI_JOB_ID']) +else: + for build in ['CI_BUILD_NUMBER', 'CI_JOB_NUMBER']: + if os.environ.get(build): + local_version.append(os.environ[build]) + else: + local_version = [] + break +if local_version: + version += '+' + '.'.join(local_version) + +requires = [] +for dep in info.get('depends', []): + if not re.match(r'(ir|res)(\W|$)', dep): + requires.append(get_require_version('trytond_%s' % dep)) +requires.append(get_require_version('trytond')) + +tests_require = [ + get_require_version('proteus'), + get_require_version('trytond_account_invoice'), + get_require_version('trytond_account_invoice_stock'), + get_require_version('trytond_company'), + get_require_version('trytond_purchase'), + get_require_version('trytond_sale'), + get_require_version('trytond_stock'), + ] +dependency_links = [] +if minor_version % 2: + dependency_links.append( + 'https://trydevpi.tryton.org/?local_version=' + + '.'.join(local_version)) + +setup(name=name, + version=version, + description='Tryton module to manage product kits and components', + long_description=read('README.rst'), + author='Tryton', + author_email='bugs@tryton.org', + url='http://www.tryton.org/', + download_url=download_url, + project_urls={ + "Bug Tracker": 'https://bugs.tryton.org/', + "Documentation": ('https://docs.tryton.org/projects/' + 'modules-product-kit'), + "Forum": 'https://www.tryton.org/forum', + "Source Code": 'https://hg.tryton.org/modules/product_kit', + }, + keywords='', + package_dir={'trytond.modules.product_kit': '.'}, + packages=( + ['trytond.modules.product_kit'] + + ['trytond.modules.product_kit.%s' % p + for p in find_packages()] + ), + package_data={ + 'trytond.modules.product_kit': (info.get('xml', []) + + ['tryton.cfg', 'view/*.xml', 'locale/*.po', '*.fodt', + 'icons/*.svg', 'tests/*.rst']), + }, + classifiers=[ + 'Development Status :: 5 - Production/Stable', + 'Environment :: Plugins', + 'Framework :: Tryton', + 'Intended Audience :: Developers', + 'Intended Audience :: Financial and Insurance Industry', + 'Intended Audience :: Legal Industry', + 'License :: OSI Approved :: ' + 'GNU General Public License v3 or later (GPLv3+)', + 'Natural Language :: Bulgarian', + 'Natural Language :: Catalan', + 'Natural Language :: Chinese (Simplified)', + 'Natural Language :: Czech', + 'Natural Language :: Dutch', + 'Natural Language :: English', + 'Natural Language :: Finnish', + 'Natural Language :: French', + 'Natural Language :: German', + 'Natural Language :: Hungarian', + 'Natural Language :: Indonesian', + 'Natural Language :: Italian', + 'Natural Language :: Persian', + 'Natural Language :: Polish', + 'Natural Language :: Portuguese (Brazilian)', + 'Natural Language :: Russian', + 'Natural Language :: Slovenian', + 'Natural Language :: Spanish', + 'Natural Language :: Turkish', + 'Operating System :: OS Independent', + 'Programming Language :: Python :: 3', + 'Programming Language :: Python :: 3.6', + 'Programming Language :: Python :: 3.7', + 'Programming Language :: Python :: 3.8', + 'Programming Language :: Python :: 3.9', + 'Programming Language :: Python :: Implementation :: CPython', + 'Programming Language :: Python :: Implementation :: PyPy', + 'Topic :: Office/Business', + ], + license='GPL-3', + python_requires='>=3.6', + install_requires=requires, + dependency_links=dependency_links, + zip_safe=False, + entry_points=""" + [trytond.modules] + product_kit = trytond.modules.product_kit + """, # noqa: E501 + test_suite='tests', + test_loader='trytond.test_loader:Loader', + tests_require=tests_require, + ) diff --git a/stock.py b/stock.py new file mode 100644 index 0000000000..f29663f01b --- /dev/null +++ b/stock.py @@ -0,0 +1,165 @@ +# This file is part of Tryton. The COPYRIGHT file at the top level of +# this repository contains the full copyright notices and license terms. +from decimal import Decimal + +from trytond.model import fields +from trytond.pool import PoolMeta, Pool +from trytond.transaction import Transaction + +from trytond.modules.product import round_price + + +class Move(metaclass=PoolMeta): + __name__ = 'stock.move' + + def _compute_component_unit_price(self): + pool = Pool() + Currency = pool.get('currency.currency') + UoM = pool.get('product.uom') + amount, quantity = 0, 0 + for line in self.origin.line.invoice_lines: + if line.invoice and line.invoice.state in {'posted', 'paid'}: + with Transaction().set_context(date=self.effective_date): + amount += Currency.compute( + line.invoice.currency, line.amount, self.currency) + quantity = UoM.compute_qty( + line.unit, line.quantity, self.uom) + amount *= self.origin.price_ratio + if not quantity: + unit_price = self.unit_price + else: + unit_price = round_price(amount / Decimal(str(quantity))) + return unit_price + + +class MoveSale(metaclass=PoolMeta): + __name__ = 'stock.move' + + @classmethod + def _get_origin(cls): + return super()._get_origin() + ['sale.line.component'] + + def get_sale(self, name): + pool = Pool() + SaleLineComponent = pool.get('sale.line.component') + sale = super().get_sale(name) + if isinstance(self.origin, SaleLineComponent): + sale = self.origin.line.sale.id + return sale + + @classmethod + def search_sale(cls, name, clause): + return ['OR', + super().search_sale(name, clause), + ('origin.line.' + clause[0],) + tuple(clause[1:3]) + + ('sale.line.component',) + tuple(clause[3:])] + + @fields.depends('origin') + def on_change_with_product_uom_category(self, name=None): + pool = Pool() + SaleLineComponent = pool.get('sale.line.component') + category = super().on_change_with_product_uom_category(name=name) + # Enforce the same unit category as they are used to compute the + # remaining quantity to ship and the quantity to invoice. + # Use getattr as reference field can have negative id + if (isinstance(self.origin, SaleLineComponent) + and getattr(self.origin, 'unit', None)): + category = self.origin.unit.category.id + return category + + def get_cost_price(self, product_cost_price=None): + pool = Pool() + SaleLineComponent = pool.get('sale.line.component') + Sale = pool.get('sale.sale') + # For return sale's move use the cost price of the original sale + if (isinstance(self.origin, SaleLineComponent) + and self.origin.quantity < 0 + and self.from_location.type != 'storage' + and self.to_location.type == 'storage' + and isinstance(self.origin.line.origin, Sale)): + sale = self.origin.line.origin + cost = Decimal(0) + qty = Decimal(0) + for move in sale.moves: + if (move.state == 'done' + and move.from_location.type == 'storage' + and move.to_location.type == 'customer' + and move.product == self.product): + move_quantity = Decimal(str(move.internal_quantity)) + cost_price = move.get_cost_price( + product_cost_price=move.cost_price) + qty += move_quantity + cost += cost_price * move_quantity + if qty: + product_cost_price = round_price(cost / qty) + return super().get_cost_price(product_cost_price=product_cost_price) + + @property + def origin_name(self): + pool = Pool() + SaleLineComponent = pool.get('sale.line.component') + name = super().origin_name + if isinstance(self.origin, SaleLineComponent): + name = self.origin.line.sale.rec_name + return name + + def _compute_unit_price(self): + pool = Pool() + SaleLineComponent = pool.get('sale.line.component') + unit_price = super()._compute_unit_price() + if isinstance(self.origin, SaleLineComponent): + unit_price = self._compute_component_unit_price() + return unit_price + + +class MovePurchase(metaclass=PoolMeta): + __name__ = 'stock.move' + + @classmethod + def _get_origin(cls): + return super()._get_origin() + ['purchase.line.component'] + + def get_purchase(self, name): + pool = Pool() + PurchaseLineComponent = pool.get('purchase.line.component') + purchase = super().get_purchase(name) + if isinstance(self.origin, PurchaseLineComponent): + purchase = self.origin.line.purchase.id + return purchase + + @classmethod + def search_purchase(cls, name, clause): + return ['OR', + super().search_purchase(name, clause), + ('origin.line.' + clause[0],) + tuple(clause[1:3]) + + ('purchase.line.component',) + tuple(clause[3:])] + + @fields.depends('origin') + def on_change_with_product_uom_category(self, name=None): + pool = Pool() + PurchaseLineComponent = pool.get('purchase.line.component') + category = super().on_change_with_product_uom_category(name=name) + # Enforce the same unit category as they are used to compute the + # remaining quantity to ship and the quantity to invoice. + # Use getattr as reference field can have negative id + if (isinstance(self.origin, PurchaseLineComponent) + and getattr(self.origin, 'unit', None)): + category = self.origin.unit.category.id + return category + + @property + def origin_name(self): + pool = Pool() + PurchaseLineComponent = pool.get('purchase.line.component') + name = super().origin_name + if isinstance(self.origin, PurchaseLineComponent): + name = self.origin.line.sale.rec_name + return name + + def _compute_unit_price(self): + pool = Pool() + PurchaseLineComponent = pool.get('purchase.line.component') + unit_price = super()._compute_unit_price() + if isinstance(self.origin, PurchaseLineComponent): + unit_price = self._compute_component_unit_price() + return unit_price diff --git a/tests/__init__.py b/tests/__init__.py new file mode 100644 index 0000000000..6e5d96c083 --- /dev/null +++ b/tests/__init__.py @@ -0,0 +1,9 @@ +# This file is part of Tryton. The COPYRIGHT file at the top level of +# this repository contains the full copyright notices and license terms. + +try: + from trytond.modules.product_kit.tests.test_product_kit import suite # noqa: E501 +except ImportError: + from .test_product_kit import suite + +__all__ = ['suite'] diff --git a/tests/scenario_product_kit.rst b/tests/scenario_product_kit.rst new file mode 100644 index 0000000000..753fe67cf7 --- /dev/null +++ b/tests/scenario_product_kit.rst @@ -0,0 +1,150 @@ +==================== +Product Kit Scenario +==================== + +Imports:: + + >>> from decimal import Decimal + >>> from proteus import Model, Wizard + >>> from trytond.tests.tools import activate_modules + >>> from trytond.modules.company.tests.tools import create_company + +Activate product_kit and stock:: + + >>> config = activate_modules(['product_kit', 'stock']) + +Create company:: + + >>> _ = create_company() + +Create products:: + + >>> Uom = Model.get('product.uom') + >>> unit, = Uom.find([('name', '=', 'Unit')]) + >>> ProductTemplate = Model.get('product.template') + >>> Product = Model.get('product.product') + + >>> template = ProductTemplate() + >>> template.name = "Product 1" + >>> template.default_uom = unit + >>> template.type = 'goods' + >>> template.save() + >>> product1, = template.products + >>> product1.cost_price = Decimal('10.0000') + >>> product1.save() + + >>> template = ProductTemplate() + >>> template.name = "Product 2" + >>> template.default_uom = unit + >>> template.type = 'goods' + >>> template.save() + >>> product2, = template.products + >>> product2.cost_price = Decimal('20.0000') + >>> product2.save() + + >>> template = ProductTemplate() + >>> template.name = "Product 3" + >>> template.default_uom = unit + >>> template.type = 'goods' + >>> template.save() + >>> product3, = template.products + >>> product3.cost_price = Decimal('1.0000') + >>> product3.save() + + >>> template = ProductTemplate() + >>> template.name = "Service" + >>> template.default_uom = unit + >>> template.type = 'service' + >>> template.save() + >>> service, = template.products + >>> service.cost_price = Decimal('5.0000') + >>> service.save() + +Create composed product:: + + >>> template = ProductTemplate() + >>> template.name = "Composed Product" + >>> template.default_uom = unit + >>> template.type = 'goods' + >>> template.save() + >>> composed_product, = template.products + >>> composed_product.cost_price = Decimal('10.0000') + + >>> component = composed_product.components.new() + >>> component.product = product1 + >>> component.quantity = 2 + >>> component = composed_product.components.new() + >>> component.product = service + >>> component.quantity = 1 + >>> composed_product.save() + + >>> composed_product.cost_price + Decimal('10.0000') + +Create a kit:: + + >>> template = ProductTemplate() + >>> template.name = "Kit" + >>> template.default_uom = unit + >>> template.type = 'kit' + >>> template.save() + >>> kit, = template.products + + >>> component = template.components.new() + >>> component.product = product1 + >>> component.quantity = 1 + >>> component = template.components.new() + >>> component.product = product2 + >>> component.quantity = 2 + >>> component = template.components.new() + >>> component.product = product3 + >>> component.quantity = 1 + >>> component.fixed = True + >>> template.save() + + >>> kit.cost_price + Decimal('51.0000') + +Get stock locations:: + + >>> Location = Model.get('stock.location') + >>> supplier_loc, = Location.find([('code', '=', 'SUP')]) + >>> storage_loc, = Location.find([('code', '=', 'STO')]) + +Fill stock with some components:: + + >>> StockMove = Model.get('stock.move') + >>> moves = [] + + >>> move = StockMove() + >>> move.product = product1 + >>> move.quantity = 10 + >>> move.from_location = supplier_loc + >>> move.to_location = storage_loc + >>> move.unit_price = Decimal('10') + >>> moves.append(move) + + >>> move = StockMove() + >>> move.product = product2 + >>> move.quantity = 15 + >>> move.from_location = supplier_loc + >>> move.to_location = storage_loc + >>> move.unit_price = Decimal('20') + >>> moves.append(move) + + >>> move = StockMove() + >>> move.product = product3 + >>> move.quantity = 20 + >>> move.from_location = supplier_loc + >>> move.to_location = storage_loc + >>> move.unit_price = Decimal('1') + >>> moves.append(move) + + >>> StockMove.click(moves, 'do') + +Check kit quantity:: + + >>> with config.set_context(locations=[storage_loc.id]): + ... kit = Product(kit.id) + >>> kit.quantity + 7.0 diff --git a/tests/scenario_product_kit_purchase.rst b/tests/scenario_product_kit_purchase.rst new file mode 100644 index 0000000000..cc8cfeecc4 --- /dev/null +++ b/tests/scenario_product_kit_purchase.rst @@ -0,0 +1,271 @@ +============================= +Purchase Product Kit Scenario +============================= + +Imports:: + + >>> import datetime as dt + >>> from decimal import Decimal + >>> from proteus import Model, Wizard + >>> from trytond.tests.tools import activate_modules + >>> from trytond.modules.company.tests.tools import ( + ... create_company, get_company) + >>> from trytond.modules.account.tests.tools import ( + ... create_fiscalyear, create_chart, get_accounts) + >>> from trytond.modules.account_invoice.tests.tools import ( + ... set_fiscalyear_invoice_sequences) + >>> today = dt.date.today() + +Activate product_kit, purchase and account_invoice:: + + >>> config = activate_modules( + ... ['product_kit', 'purchase', 'account_invoice', + ... 'account_invoice_stock']) + +Create company:: + + >>> _ = create_company() + >>> company = get_company() + +Create fiscal year:: + + >>> fiscalyear = set_fiscalyear_invoice_sequences( + ... create_fiscalyear(company)) + >>> fiscalyear.click('create_period') + +Create chart of accounts:: + + >>> _ = create_chart(company) + >>> accounts = get_accounts(company) + +Create party:: + + >>> Party = Model.get('party.party') + >>> supplier = Party(name="Supplier") + >>> supplier.save() + +Create account categories:: + + >>> ProductCategory = Model.get('product.category') + >>> account_category = ProductCategory(name="Account Category") + >>> account_category.accounting = True + >>> account_category.account_expense = accounts['expense'] + >>> account_category.account_revenue = accounts['revenue'] + >>> account_category.save() + +Create products:: + + >>> ProductUom = Model.get('product.uom') + >>> unit, = ProductUom.find([('name', '=', 'Unit')]) + >>> ProductTemplate = Model.get('product.template') + + >>> template = ProductTemplate() + >>> template.name = "Product 1" + >>> template.default_uom = unit + >>> template.type = 'goods' + >>> template.purchasable = True + >>> template.list_price = Decimal('10') + >>> template.account_category = account_category + >>> template.save() + >>> product1, = template.products + >>> product1.cost_price = Decimal('5') + >>> product1.save() + + >>> template = ProductTemplate() + >>> template.name = "Product 2" + >>> template.default_uom = unit + >>> template.type = 'goods' + >>> template.list_price = Decimal('20') + >>> template.account_category = account_category + >>> template.save() + >>> product2, = template.products + >>> product2.cost_price = Decimal('8') + >>> product2.save() + + >>> template = ProductTemplate() + >>> template.name = "Product 3" + >>> template.default_uom = unit + >>> template.type = 'goods' + >>> template.list_price = Decimal('30') + >>> template.account_category = account_category + >>> template.save() + >>> product3, = template.products + >>> product3.cost_price = Decimal('10') + >>> product3.save() + + >>> template = ProductTemplate() + >>> template.name = "Service" + >>> template.default_uom = unit + >>> template.type = 'service' + >>> template.purchasable = True + >>> template.list_price = Decimal('30') + >>> template.account_category = account_category + >>> template.save() + >>> service, = template.products + >>> service.cost_price = Decimal('20') + >>> service.save() + +Create composed product:: + + >>> template = ProductTemplate() + >>> template.name = "Composed Product" + >>> template.default_uom = unit + >>> template.type = 'goods' + >>> template.purchasable = True + >>> template.list_price = Decimal('10') + >>> template.account_category = account_category + >>> template.save() + >>> composed_product, = template.products + >>> composed_product.cost_price = Decimal('5') + + >>> component = composed_product.components.new() + >>> component.product = product1 + >>> component.quantity = 1 + >>> component = composed_product.components.new() + >>> component.product = service + >>> component.quantity = 2 + >>> component.fixed = True + >>> composed_product.save() + +Create kit product:: + + >>> template = ProductTemplate() + >>> template.name = "Kit" + >>> template.default_uom = unit + >>> template.type = 'kit' + >>> template.purchasable = True + >>> template.list_price = Decimal('40') + >>> template.account_category = account_category + >>> template.save() + >>> kit, = template.products + + >>> component = kit.components.new() + >>> component.product = product2 + >>> component.quantity = 2 + >>> component = kit.components.new() + >>> component.product = product3 + >>> component.quantity = 1 + >>> component.fixed = True + >>> kit.save() + +Purchase composed and kit products:: + + >>> Purchase = Model.get('purchase.purchase') + >>> purchase = Purchase() + >>> purchase.party = supplier + >>> purchase.invoice_method = 'shipment' + >>> line = purchase.lines.new() + >>> line.product = composed_product + >>> line.quantity = 1 + >>> line = purchase.lines.new() + >>> line.product = kit + >>> line.quantity = 2 + >>> purchase.click('quote') + >>> len(purchase.lines) + 4 + >>> [l.quantity for l in purchase.lines] + [1.0, 1.0, 2.0, 2.0] + >>> line_kit, = [l for l in purchase.lines if l.product == kit] + >>> [c.quantity for c in line_kit.components] + [4.0, 1.0] + +Reset to draft remove components:: + + >>> purchase.click('draft') + >>> line_kit, = [l for l in purchase.lines if l.product == kit] + >>> bool(line_kit.components) + False + >>> purchase.click('quote') + +Process purchase:: + + >>> purchase.click('confirm') + >>> purchase.state + 'processing' + >>> len(purchase.shipments), len(purchase.invoices) + (0, 1) + +Check invoice:: + + >>> invoice, = purchase.invoices + >>> line, = invoice.lines + >>> line.product == service + True + +Check stock moves:: + + >>> len(purchase.moves) + 4 + >>> product2quantity = { + ... m.product: m.quantity for m in purchase.moves} + >>> product2quantity[composed_product] + 1.0 + >>> product2quantity[product1] + 1.0 + >>> product2quantity[product2] + 4.0 + >>> product2quantity[product3] + 1.0 + +Receive partial shipment:: + + >>> Move = Model.get('stock.move') + >>> ShipmentIn = Model.get('stock.shipment.in') + >>> shipment = ShipmentIn() + >>> shipment.supplier = supplier + >>> for move in purchase.moves: + ... incoming_move = Move(move.id) + ... shipment.incoming_moves.append(incoming_move) + >>> shipment.save() + + >>> product2move = { + ... m.product: m for m in shipment.incoming_moves} + >>> product2move[product2].quantity = 2.0 + >>> shipment.click('receive') + >>> shipment.click('done') + >>> shipment.state + 'done' + +Check new invoice:: + + >>> purchase.reload() + >>> _, invoice = purchase.invoices + >>> len(invoice.lines) + 3 + >>> product2quantity = {l.product: l.quantity for l in invoice.lines} + >>> product2quantity[composed_product] + 1.0 + >>> product2quantity[product1] + 1.0 + >>> product2quantity[kit] + 1.0 + +Post invoice:: + + >>> invoice.invoice_date = today + >>> invoice.click('post') + >>> invoice.state + 'posted' + +Check backorder moves:: + + >>> len(purchase.moves) + 5 + >>> backorder, = [m for m in purchase.moves if m.state == 'draft'] + +Cancel backorder:: + + >>> backorder.click('cancel') + >>> backorder.state + 'cancelled' + >>> purchase.reload() + >>> purchase.shipment_state + 'exception' + +Handle shipment exception:: + + >>> shipment_exception = Wizard('purchase.handle.shipment.exception', [purchase]) + >>> shipment_exception.execute('handle') + + >>> len(purchase.moves) + 6 diff --git a/tests/scenario_product_kit_sale.rst b/tests/scenario_product_kit_sale.rst new file mode 100644 index 0000000000..a47054fb09 --- /dev/null +++ b/tests/scenario_product_kit_sale.rst @@ -0,0 +1,265 @@ +========================= +Sale Product Kit Scenario +========================= + +Imports:: + + >>> from decimal import Decimal + >>> from proteus import Model, Wizard + >>> from trytond.tests.tools import activate_modules + >>> from trytond.modules.company.tests.tools import ( + ... create_company, get_company) + >>> from trytond.modules.account.tests.tools import ( + ... create_fiscalyear, create_chart, get_accounts) + >>> from trytond.modules.account_invoice.tests.tools import ( + ... set_fiscalyear_invoice_sequences) + +Activate product_kit, sale and account_invoice:: + + >>> config = activate_modules( + ... ['product_kit', 'sale', 'account_invoice', + ... 'account_invoice_stock']) + +Create company:: + + >>> _ = create_company() + >>> company = get_company() + +Create fiscal year:: + + >>> fiscalyear = set_fiscalyear_invoice_sequences( + ... create_fiscalyear(company)) + >>> fiscalyear.click('create_period') + +Create chart of accounts:: + + >>> _ = create_chart(company) + >>> accounts = get_accounts(company) + +Create party:: + + >>> Party = Model.get('party.party') + >>> customer = Party(name='Customer') + >>> customer.save() + +Create account categories:: + + >>> ProductCategory = Model.get('product.category') + >>> account_category = ProductCategory(name="Account Category") + >>> account_category.accounting = True + >>> account_category.account_expense = accounts['expense'] + >>> account_category.account_revenue = accounts['revenue'] + >>> account_category.save() + +Create products:: + + >>> ProductUom = Model.get('product.uom') + >>> unit, = ProductUom.find([('name', '=', 'Unit')]) + >>> ProductTemplate = Model.get('product.template') + + >>> template = ProductTemplate() + >>> template.name = "Product 1" + >>> template.default_uom = unit + >>> template.type = 'goods' + >>> template.salable = True + >>> template.list_price = Decimal('10') + >>> template.account_category = account_category + >>> template.save() + >>> product1, = template.products + + >>> template = ProductTemplate() + >>> template.name = "Product 2" + >>> template.default_uom = unit + >>> template.type = 'goods' + >>> template.list_price = Decimal('20') + >>> template.account_category = account_category + >>> template.save() + >>> product2, = template.products + + >>> template = ProductTemplate() + >>> template.name = "Product 3" + >>> template.default_uom = unit + >>> template.type = 'goods' + >>> template.list_price = Decimal('30') + >>> template.account_category = account_category + >>> template.save() + >>> product3, = template.products + + >>> template = ProductTemplate() + >>> template.name = "Service" + >>> template.default_uom = unit + >>> template.type = 'service' + >>> template.salable = True + >>> template.list_price = Decimal('30') + >>> template.account_category = account_category + >>> template.save() + >>> service, = template.products + +Create composed product:: + + >>> template = ProductTemplate() + >>> template.name = "Composed Product" + >>> template.default_uom = unit + >>> template.type = 'goods' + >>> template.salable = True + >>> template.list_price = Decimal('10') + >>> template.account_category = account_category + >>> template.save() + >>> composed_product, = template.products + + >>> component = composed_product.components.new() + >>> component.product = product1 + >>> component.quantity = 2 + >>> component = composed_product.components.new() + >>> component.product = service + >>> component.quantity = 1 + >>> component.fixed = True + >>> composed_product.save() + +Create kit product:: + + >>> template = ProductTemplate() + >>> template.name = "Kit" + >>> template.default_uom = unit + >>> template.type = 'kit' + >>> template.salable = True + >>> template.list_price = Decimal('40') + >>> template.account_category = account_category + >>> template.save() + >>> kit, = template.products + + >>> component = kit.components.new() + >>> component.product = product2 + >>> component.quantity = 1 + >>> component = kit.components.new() + >>> component.product = product3 + >>> component.quantity = 2 + >>> component.fixed = True + >>> kit.save() + +Sale composed and kit products:: + + >>> Sale = Model.get('sale.sale') + >>> sale = Sale() + >>> sale.party = customer + >>> sale.invoice_method = 'shipment' + >>> line = sale.lines.new() + >>> line.product = composed_product + >>> line.quantity = 2 + >>> line = sale.lines.new() + >>> line.product = kit + >>> line.quantity = 5 + >>> sale.click('quote') + >>> len(sale.lines) + 4 + >>> [l.quantity for l in sale.lines] + [2.0, 4.0, 1.0, 5.0] + >>> line_kit, = [l for l in sale.lines if l.product == kit] + >>> [c.quantity for c in line_kit.components] + [5.0, 2.0] + +Reset to draft remove components:: + + >>> sale.click('draft') + >>> line_kit, = [l for l in sale.lines if l.product == kit] + >>> bool(line_kit.components) + False + >>> sale.click('quote') + +Process sale:: + + >>> sale.click('confirm') + >>> sale.state + 'processing' + >>> len(sale.shipments), len(sale.invoices) + (1, 1) + +Check invoice:: + + >>> invoice, = sale.invoices + >>> line, = invoice.lines + >>> line.product == service + True + +Check shipment:: + + >>> shipment, = sale.shipments + >>> len(shipment.outgoing_moves) + 4 + >>> product2quantity = { + ... m.product: m.quantity for m in shipment.outgoing_moves} + >>> product2quantity[composed_product] + 2.0 + >>> product2quantity[product1] + 4.0 + >>> product2quantity[product2] + 5.0 + >>> product2quantity[product3] + 2.0 + +Ship partially:: + + >>> product2move = { + ... m.product: m for m in shipment.inventory_moves} + >>> product2move[product1].quantity = 2.0 + >>> product2move[product2].quantity = 3.0 + >>> shipment.click('assign_force') + >>> shipment.click('pick') + >>> shipment.click('pack') + >>> shipment.click('done') + >>> shipment.state + 'done' + +Check new invoice:: + + >>> sale.reload() + >>> _, invoice = sale.invoices + >>> len(invoice.lines) + 3 + >>> product2quantity = {l.product: l.quantity for l in invoice.lines} + >>> product2quantity[composed_product] + 2.0 + >>> product2quantity[product1] + 2.0 + >>> product2quantity[kit] + 3.0 + +Post invoice:: + + >>> invoice.click('post') + >>> invoice.state + 'posted' + +Check backorder:: + + >>> _, backorder = sale.shipments + >>> len(backorder.outgoing_moves) + 2 + >>> product2quantity = { + ... m.product: m.quantity for m in backorder.outgoing_moves} + >>> product2quantity[product1] + 2.0 + >>> product2quantity[product2] + 2.0 + +Cancel backorder:: + + >>> backorder.click('cancel') + >>> backorder.state + 'cancelled' + >>> sale.reload() + >>> sale.shipment_state + 'exception' + +Handle shipment exception:: + + >>> shipment_exception = Wizard('sale.handle.shipment.exception', [sale]) + >>> move, = [ + ... m for m in shipment_exception.form.recreate_moves + ... if m.product == product1] + >>> shipment_exception.form.recreate_moves.remove(move) + >>> shipment_exception.execute('handle') + + >>> _, _, shipment = sale.shipments + >>> len(shipment.outgoing_moves) + 1 diff --git a/tests/test_product_kit.py b/tests/test_product_kit.py new file mode 100644 index 0000000000..001610b168 --- /dev/null +++ b/tests/test_product_kit.py @@ -0,0 +1,37 @@ +# This file is part of Tryton. The COPYRIGHT file at the top level of +# this repository contains the full copyright notices and license terms. +import unittest +import doctest + +from trytond.tests.test_tryton import ModuleTestCase +from trytond.tests.test_tryton import suite as test_suite +from trytond.tests.test_tryton import doctest_teardown +from trytond.tests.test_tryton import doctest_checker + + +class ProductKitTestCase(ModuleTestCase): + 'Test Product Kit module' + module = 'product_kit' + extras = ['sale', 'purchase'] + + +def suite(): + suite = test_suite() + suite.addTests(unittest.TestLoader().loadTestsFromTestCase( + ProductKitTestCase)) + suite.addTests(doctest.DocFileSuite( + 'scenario_product_kit.rst', + tearDown=doctest_teardown, encoding='utf-8', + checker=doctest_checker, + optionflags=doctest.REPORT_ONLY_FIRST_FAILURE)) + suite.addTests(doctest.DocFileSuite( + 'scenario_product_kit_sale.rst', + tearDown=doctest_teardown, encoding='utf-8', + checker=doctest_checker, + optionflags=doctest.REPORT_ONLY_FIRST_FAILURE)) + suite.addTests(doctest.DocFileSuite( + 'scenario_product_kit_purchase.rst', + tearDown=doctest_teardown, encoding='utf-8', + checker=doctest_checker, + optionflags=doctest.REPORT_ONLY_FIRST_FAILURE)) + return suite diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000000..197496c0cb --- /dev/null +++ b/tox.ini @@ -0,0 +1,15 @@ +[tox] +envlist = {py36,py37,py38,py39}-{sqlite,postgresql},pypy3-{sqlite,postgresql} + +[testenv] +commands = {envpython} setup.py test +deps = + {py36,py37,py38,py39}-postgresql: psycopg2 >= 2.5 + pypy3-postgresql: psycopg2cffi >= 2.5 + py36-sqlite: sqlitebck +setenv = + sqlite: TRYTOND_DATABASE_URI={env:SQLITE_URI:sqlite://} + postgresql: TRYTOND_DATABASE_URI={env:POSTGRESQL_URI:postgresql://} + sqlite: DB_NAME={env:SQLITE_NAME::memory:} + postgresql: DB_NAME={env:POSTGRESQL_NAME:test} +install_command = pip install --pre --find-links https://trydevpi.tryton.org/?local_version={env:CI_JOB_ID:{env:CI_BUILD_NUMBER}.{env:CI_JOB_NUMBER}} {opts} {packages} diff --git a/tryton.cfg b/tryton.cfg new file mode 100644 index 0000000000..0b2a51e6c1 --- /dev/null +++ b/tryton.cfg @@ -0,0 +1,16 @@ +[tryton] +version=5.9.0 +depends: + ir + product +extras_depend: + account_invoice_stock + purchase + purchase_amendment + sale + sale_amendment + stock +xml: + product.xml + sale.xml + purchase.xml diff --git a/view/product_component_form.xml b/view/product_component_form.xml new file mode 100644 index 0000000000..f31bb1ba1b --- /dev/null +++ b/view/product_component_form.xml @@ -0,0 +1,23 @@ + + +
+ + +