commit 8c3d7b5b05e180b4eec0a5d8ba8cee09d2eaa4f7 Author: Cédric Krier Date: Sun Mar 21 12:52:58 2021 +0100 Add stock_quantity_issue module issue9944 review339291003 diff --git a/.drone.yml b/.drone.yml new file mode 100644 index 0000000000..5cc4cd360a --- /dev/null +++ b/.drone.yml @@ -0,0 +1,56 @@ +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 + +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 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..bfa62ebab9 --- /dev/null +++ b/COPYRIGHT @@ -0,0 +1,14 @@ +Copyright (C) 2020 Cédric Krier + +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..2d5247262c --- /dev/null +++ b/__init__.py @@ -0,0 +1,24 @@ +# 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 + +__all__ = ['register'] + +from . import ir +from . import stock + + +def register(): + Pool.register( + ir.Cron, + stock.QuantityIssue, + stock.QuantityIssueProduct, + stock.QuantityIssueGenerateStart, + module='stock_quantity_issue', type_='model') + Pool.register( + stock.QuantityIssueGenerate, + module='stock_quantity_issue', type_='wizard') + Pool.register( + stock.QuantityIssueProduction, + module='stock_quantity_issue', type_='model', depends=['production']) diff --git a/doc/conf.py b/doc/conf.py new file mode 100644 index 0000000000..8513b72dd2 --- /dev/null +++ b/doc/conf.py @@ -0,0 +1,61 @@ +# This file is part of Tryton. The COPYRIGHT file at the top level of +# this repository contains the full copyright notices and license terms. + +modules_url = 'https://docs.tryton.org/projects/modules-{module}/en/{series}/' +trytond_url = 'https://docs.tryton.org/projects/server/en/{series}/' + + +def get_info(): + import configparser + import os + import subprocess + import sys + + module_dir = os.path.dirname(os.path.dirname(__file__)) + + config = configparser.ConfigParser() + config.read_file(open(os.path.join(module_dir, 'tryton.cfg'))) + info = dict(config.items('tryton')) + + result = subprocess.run( + [sys.executable, 'setup.py', '--name'], + stdout=subprocess.PIPE, check=True, cwd=module_dir) + info['name'] = result.stdout.decode('utf-8').strip() + + result = subprocess.run( + [sys.executable, 'setup.py', '--version'], + stdout=subprocess.PIPE, check=True, cwd=module_dir) + version = result.stdout.decode('utf-8').strip() + if 'dev' in version: + info['series'] = 'latest' + else: + info['series'] = '.'.join(version.split('.', 2)[:2]) + + for key in {'depends', 'extras_depend'}: + info[key] = info.get(key, '').strip().splitlines() + info['modules'] = set(info['depends'] + info['extras_depend']) + info['modules'] -= {'ir', 'res'} + + return info + + +info = get_info() + +master_doc = 'index' +project = info['name'] +release = version = info['series'] +default_role = 'ref' +highlight_language = 'none' +extensions = [ + 'sphinx.ext.intersphinx', + ] +intersphinx_mapping = { + 'trytond': (trytond_url.format(series=version), None), + } +intersphinx_mapping.update({ + m: (modules_url.format( + module=m.replace('_', '-'), series=version), None) + for m in info['modules'] + }) + +del get_info, info, modules_url, trytond_url diff --git a/doc/design.rst b/doc/design.rst new file mode 100644 index 0000000000..04cfa31cb4 --- /dev/null +++ b/doc/design.rst @@ -0,0 +1,51 @@ +****** +Design +****** + +The *Stock Quantity Issue Module* introduces the following concepts: + +.. _model-stock.quantity.issue: + +Stock Quantity Issue +==================== + +*Quantity Issues* are generated by a `Scheduled Task `. +They represent planning issues regarding the quantity of stock available for +future `Shipments ` or `Productions +`. + +A best planned date is calculated for each issue. +Applying this date updates the shipment's, or production's, planned date. +The issue also lists the `Products ` for which there +is a quantity issue. + +The `Employee ` who processes or solves the +issue is recorded. + +.. seealso:: + + Quantity Issues can be found by opening the main menu item: + + |Inventory & Stock --> Quantity Issues|__ + + .. |Inventory & Stock --> Quantity Issues| replace:: :menuselection:`Inventory & Stock --> Quantity Issues` + __ https://demo.tryton.org/model/stock.quantity.issue + +Wizards +------- + +.. _wizard-stock.quantity.issue.generate: + +Generate Stock Quantity Issues +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The *Generate Stock Quantity Issues* wizard creates for each warehouse the +`Stock Quantity Issues ` if there are any. +When running it deletes any open issues, updates the processing issues with the +new products and creates new issues. + +.. seealso:: + + The wizard can be launched by opening: + + :menuselection:`Inventory & Stock --> Quantity Issues --> Generate Stock Quantity Issues` diff --git a/doc/index.rst b/doc/index.rst new file mode 100644 index 0000000000..84a504ce4d --- /dev/null +++ b/doc/index.rst @@ -0,0 +1,12 @@ +########################### +Stock Quantity Issue Module +########################### + +The *Stock Quantity Issue Module* helps to solve stock quantity issues. + + +.. toctree:: + :maxdepth: 2 + + usage + design diff --git a/doc/usage.rst b/doc/usage.rst new file mode 100644 index 0000000000..11db3d0113 --- /dev/null +++ b/doc/usage.rst @@ -0,0 +1,12 @@ +***** +Usage +***** + +.. _Generate stock quantity issues: + +Generate stock quantity issues +============================== + +You can define a `Scheduled Action ` to generate the `Stock +Quantity Issues ` periodically like the `Generate +Stock Quantity Issues ` wizard does. diff --git a/exceptions.py b/exceptions.py new file mode 100644 index 0000000000..0e963e4d72 --- /dev/null +++ b/exceptions.py @@ -0,0 +1,7 @@ +# 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.exceptions import UserError + + +class QuantityIssueError(UserError): + pass diff --git a/ir.py b/ir.py new file mode 100644 index 0000000000..f40cad60a3 --- /dev/null +++ b/ir.py @@ -0,0 +1,15 @@ +# 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 PoolMeta + + +class Cron(metaclass=PoolMeta): + __name__ = 'ir.cron' + + @classmethod + def __setup__(cls): + super().__setup__() + cls.method.selection.extend([ + ('stock.quantity.issue|generate_issues', + "Generate Stock Quantity Issues"), + ]) diff --git a/message.xml b/message.xml new file mode 100644 index 0000000000..aca594f1ad --- /dev/null +++ b/message.xml @@ -0,0 +1,10 @@ + + + + + + You cannot solve the stock quantity issue "%(issue)s" because product "%(product)s" has still a negative forecast. + + + diff --git a/product.xml b/product.xml new file mode 100644 index 0000000000..8216d09597 --- /dev/null +++ b/product.xml @@ -0,0 +1,13 @@ + + + + + + product.product + tree + + product_list + + + diff --git a/setup.py b/setup.py new file mode 100755 index 0000000000..33682a400c --- /dev/null +++ b/setup.py @@ -0,0 +1,157 @@ +#!/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, slice=None): + content = io.open( + os.path.join(os.path.dirname(__file__), fname), + 'r', encoding='utf-8').read() + if slice: + content = '\n'.join(content.splitlines()[slice]) + 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_stock_quantity_issue' + +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 = [ + 'dateutil', + get_require_version('proteus'), + get_require_version('trytond_production'), + ] +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 quantity issue with stock', + 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-stock-quantity-issue/'), + "Forum": 'https://www.tryton.org/forum', + "Source Code": 'https://hg.tryton.org/modules/stock_quantity_issue', + }, + keywords='tryton stock quantity issue shipment production', + package_dir={'trytond.modules.stock_quantity_issue': '.'}, + packages=( + ['trytond.modules.stock_quantity_issue'] + + ['trytond.modules.stock_quantity_issue.%s' % p + for p in find_packages()] + ), + package_data={ + 'trytond.modules.stock_quantity_issue': (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', + 'Intended Audience :: Manufacturing', + '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 :: 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] + stock_quantity_issue = trytond.modules.stock_quantity_issue + """, # 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..648bc51a7d --- /dev/null +++ b/stock.py @@ -0,0 +1,396 @@ +# 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 itertools import groupby + +from trytond.i18n import gettext +from trytond.model import ( + Model, ModelSQL, ModelView, Workflow, sequence_ordered, fields) +from trytond.pool import Pool, PoolMeta +from trytond.pyson import Eval +from trytond.transaction import Transaction +from trytond.wizard import Wizard, StateView, StateAction, Button + +from trytond.modules.company.model import ( + set_employee, reset_employee, employee_field) + +from .exceptions import QuantityIssueError + + +class QuantityIssue( + sequence_ordered('priority', "Priority", "ASC NULLS LAST"), + Workflow, ModelSQL, ModelView): + "Stock Quantity Issue" + __name__ = 'stock.quantity.issue' + + company = fields.Many2One( + 'company.company', "Company", required=True, select=True) + origin = fields.Reference( + "Origin", 'get_origins', required=True, + domain=[ + ('company', '=', Eval('company', -1)), + ], + depends=['company']) + planned_date = fields.Function( + fields.Date("Planned Date"), + 'on_change_with_planned_date') + best_planned_date = fields.Function( + fields.Date("Best Planned Date"), + 'get_best_planned_date') + warehouse = fields.Function( + fields.Many2One('stock.location', "Warehouse"), + 'on_change_with_warehouse') + + issue_products = fields.One2Many( + 'stock.quantity.issue.product', 'issue', "Issue Products", + readonly=True) + products = fields.Many2Many( + 'stock.quantity.issue.product', 'issue', 'product', "Products", + readonly=True, + context={ + 'company': Eval('company'), + 'locations': [Eval('warehouse')], + 'stock_skip_warehouse': False, + 'stock_date_end': Eval('planned_date'), + }, + depends=['company', 'warehouse', 'planned_date']) + + processed_by = employee_field("Processed by", states=['processing']) + solved_by = employee_field("Solved by", states=['solved']) + + state = fields.Selection([ + ('open', "Open"), + ('processing', "Processing"), + ('solved', "Solved"), + ], "State", required=True, select=True, readonly=True) + + @classmethod + def __setup__(cls): + super().__setup__() + cls.priority.readonly = True + cls._transitions |= { + ('open', 'processing'), + ('processing', 'solved'), + ('processing', 'open'), + } + cls._buttons.update({ + 'open': { + 'invisible': Eval('state') != 'processing', + 'depends': ['state'], + }, + 'process': { + 'invisible': Eval('state') != 'open', + 'depends': ['state'], + }, + 'apply_best_planned_date': { + 'invisible': Eval('state') != 'processing', + 'readonly': ~Eval('best_planned_date'), + 'depends': ['state', 'best_planned_date'], + }, + 'solve': { + 'invisible': Eval('state') != 'processing', + 'depends': ['state'], + }, + }) + + @classmethod + def default_company(cls): + return Transaction().context.get('company') + + @classmethod + def get_origins(cls): + pool = Pool() + Model = pool.get('ir.model') + get_name = Model.get_name + models = cls._get_origins() + return [(m, get_name(m)) for m in models] + + @classmethod + def _get_origins(cls): + "Return a list of Model names for origin Reference" + return [ + 'stock.shipment.out', + 'stock.shipment.in.return', + 'stock.shipment.internal', + ] + + @fields.depends('origin') + def on_change_with_planned_date(self, name=None): + if (isinstance(self.origin, Model) + and self.origin.id >= 0 + and hasattr(self.origin, 'planned_date')): + return self.origin.planned_date + + def get_best_planned_date(self, name): + return max( + (p.best_planned_date for p in self.issue_products + if p.best_planned_date), default=None) + + @classmethod + def default_warehouse(cls): + pool = Pool() + Location = pool.get('stock.location') + return Location.get_default_warehouse() + + @fields.depends('origin') + def on_change_with_warehouse(self, name=None): + if (isinstance(self.origin, Model) and self.origin.id >= 0 + and getattr(self.origin, 'warehouse', None)): + return self.origin.warehouse.id + + @classmethod + def default_state(cls): + return 'open' + + def get_rec_name(self, name): + return (self.origin.rec_name if isinstance(self.origin, Model) + else '(%s)' % self.id) + + @classmethod + @ModelView.button + @Workflow.transition('open') + @reset_employee('processed_by') + def open(cls, issues): + pass + + @classmethod + @ModelView.button + @Workflow.transition('processing') + @set_employee('processed_by') + def process(cls, issues): + pass + + @classmethod + @ModelView.button + def apply_best_planned_date(cls, issues): + origins = defaultdict(list) + for issue in issues: + origin = issue.origin + if hasattr(origin, 'planned_date'): + origins[origin.__class__].append(origin) + origin.planned_date = issue.best_planned_date + for klass, records in origins.items(): + klass.save(records) + + @classmethod + @ModelView.button + @Workflow.transition('solved') + @set_employee('solved_by') + def solve(cls, issues): + for issue in issues: + for product in issue.products: + if product.forecast_quantity < 0: + raise QuantityIssueError( + gettext('stock_quantity_issue.' + 'msg_issue_solve_product_forecast_quantity', + issue=issue.rec_name, + product=product.rec_name)) + + @classmethod + def generate_issues(cls, warehouses=None, company=None): + """ + For each product check each stock forecast quantity and for each + negative day, it creates an issue for each origin on that day. + + If warehouses is specified it checks the stock only for them. + """ + pool = Pool() + Company = pool.get('company.company') + Date = pool.get('ir.date') + Location = pool.get('stock.location') + Move = pool.get('stock.move') + Product = pool.get('product.product') + ProductQuantitiesByWarehouse = pool.get( + 'stock.product_quantities_warehouse') + + transaction = Transaction() + today = Date.today() + if warehouses is None: + warehouses = Location.search([ + ('type', '=', 'warehouse'), + ]) + if company is None: + company = Company(transaction.context.get('company')) + + # Do not keep former open issues as they may no more be valid + opens = cls.search([ + ('company', '=', company.id), + ('state', '=', 'open'), + ]) + opens = [i for i in opens if i.warehouse in warehouses] + cls.delete(opens) + + issues = {} + for issue in cls.search([ + ('company', '=', company.id), + ('state', '=', 'processing'), + ]): + if issue.warehouse not in warehouses: + continue + # Remove products from processing issues + # as they may no more be valid + issue.issue_products = [] + issues[issue.origin] = issue + + # Order by id to speedup reduce_ids + products = Product.search([ + ('type', 'in', ['goods', 'assets']), + ('consumable', '=', False), + ], + order=[('id', 'ASC')]) + + for product in products: + for warehouse in warehouses: + with transaction.set_context( + product=product.id, + warehouse=warehouse.id, + stock_skip_warehouse=False, + ): + product_quantities = ProductQuantitiesByWarehouse.search([ + ('date', '>=', today), + ('company', '=', company.id), + ]) + issue_products = [] + for product_quantity in product_quantities: + if product_quantity.quantity < 0: + moves = Move.search([ + ('planned_date', '=', product_quantity.date), + ('from_location', 'child_of', + [warehouse.id], 'parent'), + ('to_location', 'not child_of', + [warehouse.id], 'parent'), + ('company', '=', company.id), + ]) + for move in moves: + issue_products.append(cls._add(move, issues)) + else: + for issue_product in issue_products: + issue_product.best_planned_date = ( + product_quantity.date) + issue_products.clear() + cls.save(issues.values()) + + @classmethod + def _get_origin(cls, move): + if move.shipment and move.shipment.__name__ in cls._get_origins(): + return move.shipment + + @classmethod + def _add(cls, move, issues): + pool = Pool() + Date = pool.get('ir.date') + IssueProduct = pool.get('stock.quantity.issue.product') + + origin = cls._get_origin(move) + + if origin in issues: + issue = issues[origin] + else: + issue = issues[origin] = cls( + company=origin.company, + origin=origin) + issue_products = list(getattr(issue, 'issue_products', [])) + issue_product = IssueProduct.get_from_move(move) + issue_products.append(issue_product) + issue.issue_products = issue_products + planned_date = issue.on_change_with_planned_date() + if planned_date: + issue.priority = (planned_date - Date.today()).days + else: + issue.priority = None + return issue_product + + +class QuantityIssueProduction(metaclass=PoolMeta): + __name__ = 'stock.quantity.issue' + + @classmethod + def _get_origins(cls): + return super()._get_origins() + ['production'] + + @classmethod + def _get_origin(cls, move): + origin = super()._get_origin(move) + if not origin: + origin = move.production_input + return origin + + +class QuantityIssueProduct(ModelSQL): + "Stock Quantity Issue Product" + __name__ = 'stock.quantity.issue.product' + + issue = fields.Many2One( + 'stock.quantity.issue', "Issue", + required=True, select=True, ondelete='CASCADE') + product = fields.Many2One( + 'product.product', "Product", + required=True, ondelete='CASCADE', + domain=[ + ('type', '!=', 'service'), + ]) + best_planned_date = fields.Date("Best Planned Date") + forecast_quantity = fields.Function( + fields.Float( + "Forecast Quantity", + help="The amount of stock expected to be in the warehouse."), + 'get_forecast_quantity') + + @classmethod + def get_forecast_quantity(cls, records): + quantities = {} + + def key(record): + return record.warehouse, record.issue.planned_date + items = cls.browse(sorted(records, key=key)) + for (warehouse, date), items in groupby(items, key=key): + with Transaction().set_context( + location=[warehouse.id], + stock_skip_warehouse=True, + stock_start_end=date): + for item in cls.browse(items): + quantities[item.id] = item.product.forecast_quantity + return quantities + + def get_rec_name(self, name): + return self.product.rec_name + + @classmethod + def get_from_move(cls, move): + return cls(product=move.product) + + +class QuantityIssueGenerate(Wizard): + "Stock Quantity Issue Generate" + __name__ = 'stock.quantity.issue.generate' + start = StateView( + 'stock.quantity.issue.generate.start', + 'stock_quantity_issue.quantity_issue_generate_start_view_form', [ + Button("Cancel", 'end', 'tryton-cancel'), + Button("Generate", 'generate', 'tryton-ok', default=True), + ]) + generate = StateAction('stock_quantity_issue.act_quantity_issue_form') + + def transition_generate(self): + pool = Pool() + QuantityIssue = pool.get('stock.quantity.issue') + QuantityIssue.generate_issues(warehouses=self.start.warehouses) + return 'end' + + +class QuantityIssueGenerateStart(ModelView): + "Stock Quantity Issue Generate" + __name__ = 'stock.quantity.issue.generate.start' + warehouses = fields.Many2Many( + 'stock.location', None, None, "Warehouses", + domain=[ + ('type', '=', 'warehouse'), + ]) + + @classmethod + def default_warehouses(cls): + pool = Pool() + Location = pool.get('stock.location') + warehouse = Location.get_default_warehouse() + if warehouse: + return [warehouse] diff --git a/stock.xml b/stock.xml new file mode 100644 index 0000000000..2237477ebb --- /dev/null +++ b/stock.xml @@ -0,0 +1,124 @@ + + + + + + stock.quantity.issue + form + quantity_issue_form + + + + stock.quantity.issue + tree + quantity_issue_list + + + + Quantity Issues + stock.quantity.issue + + + + + + + + + + + + + Open + + + + + + + Processing + + + + + + + All + + + + + + + + + + + + + + + + + + + + + + + + + open + Reset to Open + + + + + process + Process + + + + + apply_best_planned_date + Apply Best Planned Date + + + + + solve + Solve + + + + + Generate Stock Quantity Issues + stock.quantity.issue.generate + + + + + + + + + + + + + + stock.quantity.issue.generate.start + form + quantity_issue_generate_start_form + + + diff --git a/tests/__init__.py b/tests/__init__.py new file mode 100644 index 0000000000..6e511751db --- /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.stock_quantity_issue.tests.test_stock_quantity_issue import suite # noqa: E501 +except ImportError: + from .test_stock_quantity_issue import suite + +__all__ = ['suite'] diff --git a/tests/scenario_stock_quantity_issue.rst b/tests/scenario_stock_quantity_issue.rst new file mode 100644 index 0000000000..1ffcfccaaf --- /dev/null +++ b/tests/scenario_stock_quantity_issue.rst @@ -0,0 +1,151 @@ +============================= +Stock Quantity Issue Scenario +============================= + +Imports:: + + >>> from decimal import Decimal + + >>> import datetime as dt + >>> from dateutil.relativedelta import relativedelta + + >>> from proteus import Model, Wizard + >>> from trytond.tests.tools import activate_modules + >>> from trytond.modules.company.tests.tools import ( + ... create_company, get_company) + + >>> today = dt.date.today() + >>> week1 = today + relativedelta(weeks=1) + >>> week2 = today + relativedelta(weeks=2) + >>> week3 = today + relativedelta(weeks=3) + +Activate modules:: + + >>> config = activate_modules('stock_quantity_issue') + + >>> Company = Model.get('company.company') + >>> Cron = Model.get('ir.cron') + >>> Location = Model.get('stock.location') + >>> Move = Model.get('stock.move') + >>> Party = Model.get('party.party') + >>> ProductTemplate = Model.get('product.template') + >>> ProductUom = Model.get('product.uom') + >>> QuantityIssue = Model.get('stock.quantity.issue') + >>> ShipmentOut = Model.get('stock.shipment.out') + +Create company:: + + >>> _ = create_company() + >>> company = get_company() + +Create parties:: + + >>> customer = Party(name="Customer") + >>> customer.save() + +Create product:: + + >>> unit, = ProductUom.find([('name', '=', 'Unit')]) + >>> template = ProductTemplate() + >>> template.name = "Product" + >>> template.default_uom = unit + >>> template.type = 'goods' + >>> template.list_price = Decimal('20') + >>> template.save() + >>> product, = template.products + +Get stock locations:: + + >>> supplier_loc, = Location.find([('code', '=', 'SUP')]) + >>> customer_loc, = Location.find([('code', '=', 'CUS')]) + >>> input_loc, = Location.find([('code', '=', 'IN')]) + >>> output_loc, = Location.find([('code', '=', 'OUT')]) + +Plan receiving some products tomorrow and in 2 week:: + + >>> move = Move() + >>> move.product = product + >>> move.quantity = 6 + >>> move.from_location = supplier_loc + >>> move.to_location = input_loc + >>> move.unit_price = Decimal('5') + >>> move.planned_date = today + >>> move.save() + + >>> move, = Move.duplicate( + ... [move], default={ + ... 'quantity': 14, + ... 'planned_date': week2, + ... }) + +Plan to ship some products in 1 week:: + + >>> shipment_out1 = ShipmentOut() + >>> shipment_out1.planned_date = week1 + >>> shipment_out1.customer = customer + >>> move = shipment_out1.outgoing_moves.new() + >>> move.product = product + >>> move.quantity = 6 + >>> move.from_location = output_loc + >>> move.to_location = customer_loc + >>> move.unit_price = Decimal('20') + >>> shipment_out1.save() + + >>> shipment_out2, = ShipmentOut.duplicate([shipment_out1]) + >>> shipment_out3, = ShipmentOut.duplicate( + ... [shipment_out1], default={'planned_date': week3}) + + >>> ShipmentOut.click( + ... [shipment_out1, shipment_out2, shipment_out3], 'wait') + +Generate quantity issues:: + + >>> cron_generate_issues = Cron(method='stock.quantity.issue|generate_issues') + >>> cron_generate_issues.interval_number = 1 + >>> cron_generate_issues.interval_type = 'days' + >>> cron_generate_issues.click('run_once') + +Check quantity issues:: + + >>> issues = QuantityIssue.find([('state', '=', 'open')]) + >>> len(issues) + 2 + >>> issue1, = [i for i in issues if i.origin == shipment_out1] + >>> issue2, = [i for i in issues if i.origin == shipment_out2] + + >>> issue1.priority + 7 + >>> issue2.priority + 7 + + >>> product, = issue1.products + >>> product.quantity, product.forecast_quantity + (0.0, -6.0) + + >>> issue1.best_planned_date == week2 + True + +Apply best planned date to first shipment:: + + >>> issue1.click('process') + >>> issue1.click('solve') #doctest: +IGNORE_EXCEPTION_DETAIL + Traceback (most recent call last): + ... + QuantityIssueError: ... + + >>> issue1.click('apply_best_planned_date') + >>> issue1.click('solve') + +Second shipment does not need to be updated:: + + >>> product, = issue2.products + >>> product.quantity, product.forecast_quantity + (0.0, 0.0) + +Regenerate quantity issues:: + + >>> cron_generate_issues.click('run_once') + + >>> issues = QuantityIssue.find([('state', '=', 'open')]) + >>> len(issues) + 0 diff --git a/tests/test_stock_quantity_issue.py b/tests/test_stock_quantity_issue.py new file mode 100644 index 0000000000..1ccca588a7 --- /dev/null +++ b/tests/test_stock_quantity_issue.py @@ -0,0 +1,29 @@ +# 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 StockQuantityIssueTestCase(ModuleTestCase): + 'Test Stock Quantity Issue module' + module = 'stock_quantity_issue' + extras = ['production'] + + +def suite(): + suite = test_suite() + suite.addTests(unittest.TestLoader().loadTestsFromTestCase( + StockQuantityIssueTestCase)) + suite.addTests(doctest.DocFileSuite( + 'scenario_stock_quantity_issue.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..9597acb907 --- /dev/null +++ b/tox.ini @@ -0,0 +1,15 @@ +[tox] +envlist = {py36,py37,py38}-{sqlite,postgresql},pypy3-{sqlite,postgresql} + +[testenv] +commands = {envpython} setup.py test +deps = + {py36,py37,py38}-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..270de8227f --- /dev/null +++ b/tryton.cfg @@ -0,0 +1,13 @@ +[tryton] +version=5.9.0 +depends: + company + ir + product + stock +extras_depend: + production +xml: + product.xml + stock.xml + message.xml diff --git a/view/product_list.xml b/view/product_list.xml new file mode 100644 index 0000000000..0f49e20128 --- /dev/null +++ b/view/product_list.xml @@ -0,0 +1,9 @@ + + + + + + + + diff --git a/view/quantity_issue_form.xml b/view/quantity_issue_form.xml new file mode 100644 index 0000000000..2a872d248b --- /dev/null +++ b/view/quantity_issue_form.xml @@ -0,0 +1,40 @@ + + +
+