commit 9637f477838c0d2a7f0807349fdcf593b2a1a568 Author: Cédric Krier Date: Sun Apr 2 10:37:33 2017 +0200 Initial commit issue5215 review24591002 diff --git a/.drone.yml b/.drone.yml new file mode 100644 index 0000000000..c4fd423e94 --- /dev/null +++ b/.drone.yml @@ -0,0 +1,9 @@ +image: python:all +env: + - POSTGRESQL_URI=postgresql://postgres@127.0.0.1:5432/ + - MYSQL_URI=mysql://root@127.0.0.1:3306/ +script: + - pip install tox + - tox -e "{py27,py33,py34,py35}-{sqlite,postgresql}" --skip-missing-interpreters +services: + - postgres diff --git a/COPYRIGHT b/COPYRIGHT new file mode 100644 index 0000000000..f7ed25ec01 --- /dev/null +++ b/COPYRIGHT @@ -0,0 +1,16 @@ +Copyright (C) 2015-2016 Nicolas Évrard. +Copyright (C) 2017 Cédric Krier. +Copyright (C) 2015-2017 B2CK SPRL. + +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/INSTALL b/INSTALL new file mode 100644 index 0000000000..845b593580 --- /dev/null +++ b/INSTALL @@ -0,0 +1,32 @@ +Installing trytond_sale_advance_payment +======================================= + +Prerequisites +------------- + + * Python 2.7 or later (http://www.python.org/) + * simpleeval (https://github.com/danthedeckie/simpleeval) + * trytond (http://www.tryton.org/) + * trytond_sale (http://www.tryton.org/) + * trytond_account_invoice (http://www.tryton.org/) + +Installation +------------ + +Once you've downloaded and unpacked the trytond_sale_advance_payment source +release, enter the directory where the archive was unpacked, and run: + + python setup.py install + +Note that you may need administrator/root privileges for this step, as +this command will by default attempt to install module to the Python +site-packages directory on your system. + +For advance options, please refer to the easy_install and/or the distutils +documentation: + + http://peak.telecommunity.com/DevCenter/EasyInstall + http://docs.python.org/inst/inst.html + +To use without installation, extract the archive into ``trytond/modules`` with +the directory name sale_advance_payment. 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..fb91042a77 --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1,13 @@ +include INSTALL +include README +include COPYRIGHT +include CHANGELOG +include LICENSE +include tryton.cfg +include *.xml +include view/*.xml +include *.odt +include locale/*.po +include doc/* +include icons/* +include tests/*.rst diff --git a/README b/README new file mode 100644 index 0000000000..d271fa0287 --- /dev/null +++ b/README @@ -0,0 +1,35 @@ +trytond_sale_advance_payment +============================ + +The sale_advance_payment module of the Tryton application platform. + +Installing +---------- + +See INSTALL + +Support +------- + +If you encounter any problems with Tryton, please don't hesitate to ask +questions on the Tryton bug tracker, mailing list, wiki or IRC channel: + + http://bugs.tryton.org/ + http://groups.tryton.org/ + http://wiki.tryton.org/ + irc://irc.freenode.net/tryton + +License +------- + +See LICENSE + +Copyright +--------- + +See COPYRIGHT + + +For more information please visit the Tryton web site: + + http://www.tryton.org/ diff --git a/__init__.py b/__init__.py new file mode 100644 index 0000000000..d564301704 --- /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 +from . import sale +from . import account +from . import stock + + +def register(): + Pool.register( + sale.AdvancePaymentTerm, + sale.AdvancePaymentTermLine, + sale.AdvancePaymentTermLineAccount, + sale.AdvancePaymentCondition, + sale.Sale, + sale.SaleLine, + account.Invoice, + account.InvoiceLine, + stock.ShipmentOut, + module='sale_advance_payment', type_='model') + Pool.register( + sale.HandleInvoiceException, + module='sale_advance_payment', type_='wizard') diff --git a/account.py b/account.py new file mode 100644 index 0000000000..a558227190 --- /dev/null +++ b/account.py @@ -0,0 +1,31 @@ +# 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, PoolMeta + +__all__ = ['Invoice', 'InvoiceLine'] + + +class Invoice: + __name__ = 'account.invoice' + __metaclass__ = PoolMeta + + def get_sales(self, name): + pool = Pool() + AdvancePaymentCondition = pool.get('sale.advance_payment.condition') + + sales = set(super(Invoice, self).get_sales(name)) + for line in self.lines: + if isinstance(line.origin, AdvancePaymentCondition): + sales.add(line.origin.sale.id) + return list(sales) + + +class InvoiceLine: + __name__ = 'account.invoice.line' + __metaclass__ = PoolMeta + + @classmethod + def _get_origin(cls): + return (super(InvoiceLine, cls)._get_origin() + + ['sale.advance_payment.condition']) diff --git a/doc/index.rst b/doc/index.rst new file mode 100644 index 0000000000..d1ddc27646 --- /dev/null +++ b/doc/index.rst @@ -0,0 +1,47 @@ +Sale Advance Payment Module +########################### + +The sale_advance_payment module adds support for advance payment management on +the sale. + +The module adds a new document: the Advance Payment Term that defines how the +shipment or the supply processes should be managed. Either process can be +completely delayed until the advance payments are paid. + +Two new fields are added to *Sale*: + +- *Advance Payment Term* +- *Advance Payment Conditions* + +The conditions are computed at the quotation of the sale if a payment term is +set. + +When the sale is processed the advance payment invoices are created, final +invoices will be generated when this advance payment invoices are paid. Those +invoices will take into the account the amount previously paid by the customer. + +.. warning:: + If an advance payment invoice is cancelled and not recreated when + processing the exception. The condition of the cancelled invoice will be + concidered as met. +.. + +Advance Payment Term +******************** + +It defines how advance payment invoices should be created and what they block +until they are paid. + +- Name: The name of the term. +- Lines: + + - Description: The description used for the invoice line. + - Account: The account used for the invoice line. If it has default taxes, + the taxes will be applied. + - Block Supply: If checked, it prevents the creation of any supply request + before the payment of the advance payment invoice. + - Block Shipping: If checked, the shipments can not be packed before the + payment of the advance payment invoice. + - Invoice Delay: The delay to apply on the sale date for the date of the + advance payment invoice. + - Formula: It computes the amount of the invoice line. diff --git a/sale.py b/sale.py new file mode 100644 index 0000000000..19831da5ae --- /dev/null +++ b/sale.py @@ -0,0 +1,494 @@ +# 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 simpleeval import simple_eval +from itertools import chain + +from trytond.pool import Pool, PoolMeta +from trytond.model import ModelSQL, ModelView, Workflow, fields +from trytond.pyson import Eval, Bool +from trytond.tools import decistmt +from trytond.transaction import Transaction +from trytond.modules.company.model import CompanyMultiValueMixin, CompanyValueMixin + +__all__ = [ + 'AdvancePaymentTerm', 'AdvancePaymentTermLine', + 'AdvancePaymentTermLineAccount', + 'AdvancePaymentCondition', 'Sale', 'SaleLine', + 'HandleInvoiceException'] + + +class AdvancePaymentTerm(ModelSQL, ModelView): + "Advance Payment Term" + __name__ = 'sale.advance_payment_term' + + name = fields.Char("Name", required=True, translate=True) + active = fields.Boolean("Active", select=True) + lines = fields.One2Many( + 'sale.advance_payment_term.line', 'advance_payment_term', "Lines") + + @staticmethod + def default_active(): + return True + + def get_advance_payment_context(self, sale): + return { + 'total_amount': sale.total_amount, + 'untaxed_amount': sale.untaxed_amount, + } + + def get_conditions(self, sale): + conditions = [] + term_context = self.get_advance_payment_context(sale) + for line in self.lines: + condition = line.get_condition(sale.currency, **term_context) + if condition.amount > 0: + conditions.append(condition) + return conditions + + +class AdvancePaymentTermLine(ModelView, ModelSQL, CompanyMultiValueMixin): + "Advance Payment Term Line" + __name__ = 'sale.advance_payment_term.line' + _rec_name = 'description' + + advance_payment_term = fields.Many2One( + 'sale.advance_payment_term', "Advance Payment Term", + required=True, ondelete='CASCADE', select=True) + description = fields.Char( + "Description", required=True, translate=True, + help="Used as description for the invoice line.") + account = fields.MultiValue( + fields.Many2One('account.account', "Account", required=True, + domain=[ + ('kind', '=', 'revenue'), + ], + help="Used for the line of advance payment invoice.")) + accounts = fields.One2Many( + 'sale.advance_payment_term.line.account', 'line', "Accounts") + block_supply = fields.Boolean( + "Block Supply", + help="Check to prevent any supply request before advance payment.") + block_shipping = fields.Boolean( + "Block Shipping", + help="Check to prevent the packing of the shipment " + "before advance payment.") + invoice_delay = fields.TimeDelta( + "Invoice Delay", + help="Delta to apply on the sale date for the date of " + "the advance payment invoice.") + formula = fields.Char('Formula', required=True, + help="A python expression used to compute the advance payment amount " + "that will be evaluated with:\n" + "- total_amount: The total amount of the sale.\n" + "- untaxed_amount: The total untaxed amount of the sale.") + + @classmethod + def __setup__(cls): + super(AdvancePaymentTermLine, cls).__setup__() + cls._error_messages.update({ + 'invalid_formula': ('Invalid formula "%(formula)s" with' + ' exception "%(exception)s".'), + }) + + @fields.depends('formula') + def pre_validate(self, **names): + super(AdvancePaymentTermLine, self).pre_validate() + names['total_amount'] = names['untaxed_amount'] = 0 + try: + if not isinstance(self.compute_amount(**names), Decimal): + raise Exception('The formula does not return a Decimal') + except Exception, exception: + self.raise_user_error('invalid_formula', { + 'formula': self.formula, + 'exception': exception, + }) + + def get_compute_amount_context(self, **names): + return { + 'names': names, + 'functions': { + 'Decimal': Decimal, + }, + } + + def compute_amount(self, **names): + context = self.get_compute_amount_context(**names) + return simple_eval(decistmt(self.formula), **context) + + def get_condition(self, currency, **context): + pool = Pool() + AdvancePaymentCondition = pool.get('sale.advance_payment.condition') + + return AdvancePaymentCondition( + block_supply=self.block_supply, + block_shipping=self.block_shipping, + amount=currency.round(self.compute_amount(**context)), + account=self.account, + invoice_delay=self.invoice_delay, + description=self.description) + + +class AdvancePaymentTermLineAccount(ModelSQL, CompanyValueMixin): + "Advance Payment Term Line Account" + __name__ = 'sale.advance_payment_term.line.account' + + line = fields.Many2One( + 'sale.advance_payment_term.line', 'Line', required=True, select=True, + ondelete='CASCADE') + account = fields.Many2One( + 'account.account', "Account", required=True, + domain=[ + ('company', '=', Eval('company', -1)), + ], + depends=['company']) + + +class AdvancePaymentCondition(ModelSQL, ModelView): + "Advance Payment Condition" + __name__ = 'sale.advance_payment.condition' + _rec_name = 'description' + + _states = { + 'readonly': Eval('sale_state') != 'draft', + } + _depends = ['sale_state'] + + sale = fields.Many2One('sale.sale', 'Sale', required=True, + ondelete='CASCADE', select=True, + states={ + 'readonly': ((Eval('sale_state') != 'draft') + & Bool(Eval('sale'))), + }, + depends=['sale_state']) + description = fields.Char( + "Description", required=True, states=_states, depends=_depends) + amount = fields.Numeric( + "Amount", + digits=(16, Eval('_parent_sale', {}).get('currency_digits', 2)), + states=_states, depends=_depends) + account = fields.Many2One( + 'account.account', "Account", required=True, + domain=[ + ('kind', '=', 'revenue'), + ('company', '=', Eval('sale_company')), + ], + states=_states, + depends=_depends + ['sale_company']) + block_supply = fields.Boolean( + "Block Supply", states=_states, depends=_depends) + block_shipping = fields.Boolean( + "Block Shipping", states=_states, depends=_depends) + invoice_delay = fields.TimeDelta( + "Invoice Delay", states=_states, depends=_depends) + + invoice_lines = fields.One2Many( + 'account.invoice.line', 'origin', "Invoice Lines", readonly=True) + completed = fields.Function(fields.Boolean("Completed"), 'get_completed') + + sale_state = fields.Function(fields.Selection( + 'get_sale_states', "Sale State"), 'on_change_with_sale_state') + sale_company = fields.Function(fields.Many2One( + 'company.company', "Company"), 'on_change_with_sale_company') + + del _states + del _depends + + @classmethod + def __setup__(cls): + super(AdvancePaymentCondition, cls).__setup__() + cls._order.insert(0, ('amount', 'ASC')) + + @classmethod + def get_sale_states(cls): + pool = Pool() + Sale = pool.get('sale.sale') + return Sale.fields_get(['state'])['state']['selection'] + + @fields.depends('sale', '_parent_sale.state') + def on_change_with_sale_state(self, name=None): + if self.sale: + return self.sale.state + + @fields.depends('sale', '_parent_sale.company') + def on_change_with_sale_company(self, name=None): + if self.sale and self.sale.company: + return self.sale.company.id + + @classmethod + def copy(cls, conditions, default=None): + if default is None: + default = {} + default['invoice_lines'] = [] + return super(AdvancePaymentCondition, cls).copy(conditions, default) + + def create_invoice(self): + pool = Pool() + Invoice = pool.get('account.invoice') + + invoice = self.sale._get_invoice_sale() + invoice.invoice_date = self.sale.sale_date + if self.invoice_delay: + invoice.invoice_date += self.invoice_delay + invoice.payment_term = None + + invoice_lines = self.get_invoice_advance_payment_lines(invoice) + if not invoice_lines: + return None + invoice.lines = invoice_lines + invoice.save() + + Invoice.update_taxes([invoice]) + return invoice + + def get_invoice_advance_payment_lines(self, invoice): + pool = Pool() + InvoiceLine = pool.get('account.invoice.line') + + advance_amount = self._get_advance_amount() + advance_amount += self._get_ignored_amount() + if advance_amount >= self.amount: + return [] + + invoice_line = InvoiceLine() + invoice_line.invoice = invoice + invoice_line.company = invoice.company + invoice_line.type = 'line' + invoice_line.quantity = 1 + invoice_line.account = self.account + invoice_line.unit_price = self.amount - advance_amount + invoice_line.description = self.description + invoice_line.origin = self + invoice_line.company = self.sale.company + # Set taxes + invoice_line.on_change_account() + return [invoice_line] + + def _get_advance_amount(self): + return sum(l.amount for l in self.invoice_lines + if l.invoice.state != 'cancel') + + def _get_ignored_amount(self): + skips = {l for i in self.sale.invoices_recreated for l in i.lines} + return sum(l.amount for l in self.invoice_lines + if l.invoice.state == 'cancel' and l not in skips) + + def get_completed(self, name): + advance_amount = 0 + lines_ignored = set(l for i in self.sale.invoices_ignored + for l in i.lines) + for l in self.invoice_lines: + if l.invoice.state == 'paid' or l in lines_ignored: + advance_amount += l.amount + return advance_amount >= self.amount + + +class Sale: + __name__ = 'sale.sale' + __metaclass__ = PoolMeta + + advance_payment_term = fields.Many2One('sale.advance_payment_term', + 'Advance Payment Term', + ondelete='RESTRICT', states={ + 'readonly': Eval('state') != 'draft', + }, + depends=['state']) + advance_payment_conditions = fields.One2Many( + 'sale.advance_payment.condition', 'sale', + 'Advance Payment Conditions', + states={ + 'readonly': Eval('state') != 'draft', + }, + depends=['state']) + advance_payment_invoices = fields.Function(fields.One2Many( + 'account.invoice', None, "Advance Payment Invoices"), + 'get_advance_payment_invoices', + searcher='search_advance_payment_invoices') + + @classmethod + @ModelView.button + @Workflow.transition('quotation') + def quote(cls, sales): + pool = Pool() + AdvancePaymentCondition = pool.get('sale.advance_payment.condition') + + super(Sale, cls).quote(sales) + + AdvancePaymentCondition.delete( + list(chain(*(s.advance_payment_conditions for s in sales)))) + + for sale in sales: + sale.set_advance_payment_term() + cls.save(sales) + + @classmethod + def copy(cls, sales, default=None): + if default is None: + default = {} + else: + default = default.copy() + default.setdefault('advance_payment_conditions') + return super(Sale, cls).copy(sales, default=default) + + def set_advance_payment_term(self): + pool = Pool() + AdvancePaymentTerm = pool.get('sale.advance_payment_term') + if self.advance_payment_term: + if self.party and self.party.lang: + with Transaction().set_context(language=self.party.lang.code): + advance_payment_term = AdvancePaymentTerm( + self.advance_payment_term.id) + else: + advance_payment_term = self.advance_payment_term + self.advance_payment_conditions = \ + advance_payment_term.get_conditions(self) + + def get_advance_payment_invoices(self, name): + invoices = set() + for condition in self.advance_payment_conditions: + for invoice_line in condition.invoice_lines: + if invoice_line.invoice: + invoices.add(invoice_line.invoice.id) + return list(invoices) + + @classmethod + def search_advance_payment_invoices(cls, name, clause): + return [('advance_payment_conditions.invoice_lines.invoice',) + + tuple(clause[1:])] + + def get_invoice_state(self): + state = super(Sale, self).get_invoice_state() + skip_ids = set(x.id for x in self.invoices_ignored) + skip_ids.update(x.id for x in self.invoices_recreated) + invoices = ( + i for i in self.advance_payment_invoices if i.id not in skip_ids) + if any(i.state == 'cancel' for i in invoices): + return 'exception' + return state + + def get_recall_lines(self, invoice): + pool = Pool() + InvoiceLine = pool.get('account.invoice.line') + + recall_lines = [] + advance_lines = InvoiceLine.search([ + ('origin', 'in', [str(c) + for c in self.advance_payment_conditions]), + ('invoice.state', '=', 'paid'), + ]) + for advance_line in advance_lines: + line = InvoiceLine( + invoice=invoice, + company=invoice.company, + type=advance_line.type, + quantity=advance_line.quantity, + account=advance_line.account, + unit_price=-advance_line.amount, + description=advance_line.description, + origin=advance_line, + taxes=advance_line.taxes, + ) + recall_lines.append(line) + + return recall_lines + + def create_invoice(self): + pool = Pool() + Invoice = pool.get('account.invoice') + InvoiceLine = pool.get('account.invoice.line') + + invoice = super(Sale, self).create_invoice() + + if self.advance_payment_eligible(): + if invoice is None and not self.advance_payment_completed: + for condition in self.advance_payment_conditions: + condition.create_invoice() + elif invoice is not None: + recall_lines = self.get_recall_lines(invoice) + if recall_lines: + for line in recall_lines: + line.invoice = invoice + InvoiceLine.save(recall_lines) + Invoice.update_taxes([invoice]) + + return invoice + + def advance_payment_eligible(self, shipment_type=None): + """ + Returns True when the shipment_type is eligible to further processing + of the sale's advance payment. + """ + return bool((shipment_type == 'out' or shipment_type is None) + and self.advance_payment_conditions) + + @property + def advance_payment_completed(self): + """ + Returns True when the advance payment process is completed + """ + return (bool(self.advance_payment_conditions) + and all(c.completed for c in self.advance_payment_conditions)) + + @property + def supply_blocked(self): + for condition in self.advance_payment_conditions: + if not condition.block_supply: + continue + if not condition.completed: + return True + return False + + @property + def shipping_blocked(self): + for condition in self.advance_payment_conditions: + if not condition.block_shipping: + continue + if not condition.completed: + return True + return False + + +class SaleLine: + __name__ = 'sale.line' + __metaclass__ = PoolMeta + + def get_move(self, shipment_type): + move = super(SaleLine, self).get_move(shipment_type) + if (self.sale.advance_payment_eligible(shipment_type) + and self.sale.supply_blocked): + return None + return move + + def get_purchase_request(self): + request = super(SaleLine, self).get_purchase_request() + if (self.sale.advance_payment_eligible() + and self.sale.supply_blocked): + return None + return request + + def get_invoice_line(self): + lines = super(SaleLine, self).get_invoice_line() + if (self.sale.advance_payment_eligible() + and not self.sale.advance_payment_completed): + return [] + return lines + + +class HandleInvoiceException: + __metaclass__ = PoolMeta + __name__ = 'sale.handle.invoice.exception' + + def default_ask(self, fields): + pool = Pool() + Sale = pool.get('sale.sale') + + default = super(HandleInvoiceException, self).default_ask(fields) + invoices = default['domain_invoices'] + + sale = Sale(Transaction().context['active_id']) + skips = set(sale.invoices_ignored) + skips.update(sale.invoices_recreated) + for invoice in sale.advance_payment_invoices: + if invoice.state == 'cancel' and invoice not in skips: + invoices.append(invoice.id) + return default diff --git a/sale.xml b/sale.xml new file mode 100644 index 0000000000..e59cdab803 --- /dev/null +++ b/sale.xml @@ -0,0 +1,140 @@ + + + + + + sale.sale + + sale_form + + + + Advance Invoices + account.invoice + + + + form_relate + sale.sale,-1 + + + + + sale.advance_payment.condition + form + advance_payment_condition_form + + + sale.advance_payment.condition + tree + advance_payment_condition_list + + + + sale.advance_payment_term + form + advance_payment_term_form + + + sale.advance_payment_term + tree + advance_payment_term_list + + + + Advance Payment Terms + sale.advance_payment_term + + + + + + + + + + + + + + + sale.advance_payment_term.line + form + advance_payment_term_line_form + + + sale.advance_payment_term.line + tree + advance_payment_term_line_list + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/setup.py b/setup.py new file mode 100644 index 0000000000..07a120e6e6 --- /dev/null +++ b/setup.py @@ -0,0 +1,127 @@ +#!/usr/bin/env python +# 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 setuptools import setup +import re +import os +import io +try: + from configparser import ConfigParser +except ImportError: + from ConfigParser import ConfigParser + + +def read(fname): + return io.open( + os.path.join(os.path.dirname(__file__), fname), + 'r', encoding='utf-8').read() + + +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.ConfigParser() +config.readfp(open('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_sale_advance_payment' + +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)) + +requires = ['simpleeval'] +for dep in info.get('depends', []): + if not re.match(r'(ir|res|webdav)(\W|$)', dep): + requires.append(get_require_version('trytond_%s' % dep)) +requires.append(get_require_version('trytond')) + +tests_require = [get_require_version('proteus')] +dependency_links = [] +if minor_version % 2: + # Add development index for testing with proteus + dependency_links.append('https://trydevpi.tryton.org/') + +setup(name=name, + version=version, + description='Tryton module for sale advance payment', + long_description=read('README'), + author='Tryton', + author_email='issue_tracker@tryton.org', + url='http://www.tryton.org/', + download_url=download_url, + keywords='tryton sale advance payment', + package_dir={'trytond.modules.sale_advance_payment': '.'}, + packages=[ + 'trytond.modules.sale_advance_payment', + 'trytond.modules.sale_advance_payment.tests', + ], + package_data={ + 'trytond.modules.sale_advance_payment': (info.get('xml', []) + + ['tryton.cfg', 'view/*.xml', 'locale/*.po', '*.odt', + '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 :: French', + 'Natural Language :: German', + 'Natural Language :: Hungarian', + 'Natural Language :: Italian', + 'Natural Language :: Polish', + 'Natural Language :: Portuguese (Brazilian)', + 'Natural Language :: Russian', + 'Natural Language :: Slovenian', + 'Natural Language :: Spanish', + 'Operating System :: OS Independent', + 'Programming Language :: Python :: 2.7', + 'Programming Language :: Python :: 3.3', + 'Programming Language :: Python :: 3.4', + 'Programming Language :: Python :: 3.5', + 'Programming Language :: Python :: Implementation :: CPython', + 'Programming Language :: Python :: Implementation :: PyPy', + 'Topic :: Office/Business', + 'Topic :: Office/Business :: Financial :: Accounting', + ], + license='GPL-3', + install_requires=requires, + dependency_links=dependency_links, + zip_safe=False, + entry_points=""" + [trytond.modules] + sale_advance_payment = trytond.modules.sale_advance_payment + """, + test_suite='tests', + test_loader='trytond.test_loader:Loader', + tests_require=tests_require, + use_2to3=True, + convert_2to_2_doctests=['tests/scenario_advance_payment.rst'], + ) diff --git a/stock.py b/stock.py new file mode 100644 index 0000000000..6ba9bb8736 --- /dev/null +++ b/stock.py @@ -0,0 +1,39 @@ +# 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 Pool, PoolMeta + +__all__ = ['ShipmentOut'] + + +class ShipmentOut: + __name__ = 'stock.shipment.out' + __metaclass__ = PoolMeta + + @classmethod + def __setup__(cls): + super(ShipmentOut, cls).__setup__() + cls._error_messages.update({ + 'advance_payment_not_paid': ('The customer has not paid the' + ' required advance payment amount for the sale' + ' "%(sale)s".'), + }) + + @classmethod + @ModelView.button + @Workflow.transition('packed') + def pack(cls, shipments): + pool = Pool() + Sale = pool.get('sale.sale') + SaleLine = pool.get('sale.line') + + sales = {move.origin.sale + for shipment in shipments for move in shipment.moves + if isinstance(move.origin, SaleLine)} + for sale in Sale.browse([s.id for s in sales]): + if sale.shipping_blocked: + cls.raise_user_error('advance_payment_not_paid', { + 'sale': sale.rec_name, + }) + super(ShipmentOut, cls).pack(shipments) diff --git a/tests/__init__.py b/tests/__init__.py new file mode 100644 index 0000000000..29bcbec317 --- /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.sale_advance_payment.tests.test_sale_advance_payment import suite +except ImportError: + from .test_sale_advance_payment import suite + +__all__ = ['suite'] diff --git a/tests/scenario_advance_payment.rst b/tests/scenario_advance_payment.rst new file mode 100644 index 0000000000..1357f218ce --- /dev/null +++ b/tests/scenario_advance_payment.rst @@ -0,0 +1,385 @@ +============================== +Sale Advance Payment 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, create_payment_term + >>> from trytond.modules.sale_advance_payment.tests.tools import \ + ... create_advance_payment_term + +Activate sale_advance_payment:: + + >>> config = activate_modules(['sale_advance_payment', 'sale_supply']) + +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) + >>> expense = accounts['expense'] + >>> revenue = accounts['revenue'] + >>> payable = accounts['payable'] + >>> cash = accounts['cash'] + + >>> Account = Model.get('account.account') + >>> advance_payment_account = Account( + ... name='Advance Payment', + ... type=payable.type, + ... kind='revenue', + ... company=company, + ... party_required=True, + ... reconcile=True, + ... ) + >>> advance_payment_account.save() + + >>> Journal = Model.get('account.journal') + >>> cash_journal, = Journal.find([('type', '=', 'cash')]) + >>> cash_journal.credit_account = cash + >>> cash_journal.debit_account = cash + >>> cash_journal.save() + +Create customer:: + + >>> Party = Model.get('party.party') + >>> customer = Party(name='Customer') + >>> customer.save() + +Create product:: + + >>> ProductUom = Model.get('product.uom') + >>> ProductTemplate = Model.get('product.template') + >>> Product = Model.get('product.product') + >>> unit, = ProductUom.find([('name', '=', 'Unit')]) + >>> product = Product() + >>> template = ProductTemplate() + >>> template.name = 'Product' + >>> template.default_uom = unit + >>> template.type = 'goods' + >>> template.salable = True + >>> template.delivery_time = 0 + >>> template.list_price = Decimal('20') + >>> template.cost_price = Decimal('8') + >>> template.account_revenue = revenue + >>> template.save() + >>> product.template = template + >>> product.save() + +Create payment term:: + + >>> payment_term = create_payment_term() + >>> payment_term.save() + +Create an inventory:: + + >>> Inventory = Model.get('stock.inventory') + >>> InventoryLine = Model.get('stock.inventory.line') + >>> Location = Model.get('stock.location') + >>> storage, = Location.find([ + ... ('code', '=', 'STO'), + ... ]) + >>> inventory = Inventory() + >>> inventory.location = storage + >>> inventory_line = inventory.lines.new() + >>> inventory_line.product = product + >>> inventory_line.quantity = 100.0 + >>> inventory_line.expected_quantity = 0.0 + >>> inventory.click('confirm') + >>> inventory.state + u'done' + +Create advance payment term preventing the creation of shipment:: + + >>> advance_payment_term = create_advance_payment_term( + ... 'Advance Payment', '0.1 * total_amount', advance_payment_account, + ... block_supply=True) + >>> advance_payment_term.save() + +Create a normal sale:: + + >>> Sale = Model.get('sale.sale') + >>> sale = Sale() + >>> sale.party = customer + >>> sale.payment_term = payment_term + >>> line = sale.lines.new() + >>> line.product = product + >>> line.quantity = 1 + >>> sale.save() + >>> sale.click('quote') + >>> sale.click('confirm') + >>> sale.click('process') + +As usual an invoice and a shipment has been created:: + + >>> invoice, = sale.invoices + >>> invoice_line, = invoice.lines + >>> invoice_line.account == revenue + True + >>> invoice.total_amount + Decimal('20.00') + >>> len(sale.shipments) + 1 + +Create a sale with advance payment:: + + >>> sale = Sale() + >>> sale.party = customer + >>> sale.payment_term = payment_term + >>> line = sale.lines.new() + >>> line.product = product + >>> line.quantity = 5 + >>> sale.advance_payment_term = advance_payment_term + >>> sale.click('quote') + >>> condition, = sale.advance_payment_conditions + >>> condition.amount + Decimal('10.00') + >>> sale.click('confirm') + >>> sale.click('process') + +The advance payment invoice has been created:: + + >>> invoice, = sale.advance_payment_invoices + >>> invoice_line, = invoice.lines + >>> invoice_line.account == advance_payment_account + True + >>> invoice.total_amount + Decimal('10.00') + + >>> invoice.click('post') + >>> sale.reload() + >>> len(sale.invoices) + 0 + >>> len(sale.shipments) + 0 + +Let's pay the advance payment invoice:: + + >>> pay = Wizard('account.invoice.pay', [invoice]) + >>> pay.form.journal = cash_journal + >>> pay.execute('choice') + + >>> sale.reload() + >>> len(sale.invoices) + 1 + >>> len(sale.shipments) + 1 + + >>> invoice, = sale.invoices + >>> invoice.total_amount + Decimal('90.00') + >>> len(invoice.lines) + 2 + >>> il1, il2 = sorted([il for il in invoice.lines], + ... key=lambda il: 1 if il.product else 0) + >>> il1.account == advance_payment_account + True + >>> il1.unit_price + Decimal('-10.00') + >>> il2.product == product + True + >>> il2.unit_price + Decimal('20.0000') + >>> il2.quantity + 5.0 + +Create another advance payment term preventing the packing stage:: + + >>> advance_payment_term_no_pack = create_advance_payment_term( + ... 'Advance Payment (blocked packing)', + ... '0.1 * total_amount', advance_payment_account, block_shipping=True) + >>> advance_payment_term_no_pack.save() + +Create a sale with advance payment:: + + >>> sale = Sale() + >>> sale.party = customer + >>> sale.payment_term = payment_term + >>> line = sale.lines.new() + >>> line.product = product + >>> line.quantity = 6 + >>> sale.advance_payment_term = advance_payment_term_no_pack + >>> sale.click('quote') + >>> condition, = sale.advance_payment_conditions + >>> condition.amount + Decimal('12.00') + >>> sale.click('confirm') + >>> sale.click('process') + +The shipment has been created:: + + >>> shipment, = sale.shipments + +Let's try to pack it:: + + >>> shipment.click('wait') + >>> shipment.click('assign_try') + True + >>> shipment.click('pack') # doctest: +IGNORE_EXCEPTION_DETAIL + Traceback (most recent call last): + ... + UserError: ... + +Let's pay the advance payment invoice:: + + >>> invoice, = sale.advance_payment_invoices + >>> invoice.click('post') + >>> pay = Wizard('account.invoice.pay', [invoice]) + >>> pay.form.journal = cash_journal + >>> pay.execute('choice') + +Packing the shipment is now allowed:: + + >>> shipment.click('pack') + >>> shipment.reload() + >>> shipment.state + u'packed' + +In case the product is to be supplied on sale +--------------------------------------------- + +Create the product:: + + >>> sos_product = Product() + >>> sos_template = ProductTemplate() + >>> sos_template.name = 'Supply On Sale product' + >>> sos_template.default_uom = unit + >>> sos_template.type = 'goods' + >>> sos_template.purchasable = True + >>> sos_template.salable = True + >>> sos_template.list_price = Decimal('10') + >>> sos_template.cost_price = Decimal('5') + >>> sos_template.account_expense = expense + >>> sos_template.account_revenue = revenue + >>> sos_template.supply_on_sale = True + >>> sos_template.save() + >>> sos_product.template = sos_template + >>> sos_product.save() + +Sell 10 of those products:: + + >>> Sale = Model.get('sale.sale') + >>> sale = Sale() + >>> sale.party = customer + >>> sale.payment_term = payment_term + >>> sale_line = sale.lines.new() + >>> sale_line.product = sos_product + >>> sale_line.quantity = 10 + >>> sale.advance_payment_term = advance_payment_term + >>> sale.click('quote') + >>> sale.click('confirm') + >>> sale.click('process') + +There is no purchase request created yet:: + + >>> PurchaseRequest = Model.get('purchase.request') + >>> PurchaseRequest.find() + [] + +The advance payment invoice has been created, now pay it:: + + >>> invoice, = sale.advance_payment_invoices + >>> invoice.click('post') + >>> pay = Wizard('account.invoice.pay', [invoice]) + >>> pay.form.journal = cash_journal + >>> pay.execute('choice') + +There is now a purchase request of the deisred quantity:: + + >>> purchase_request, = PurchaseRequest.find() + >>> purchase_request.quantity + 10.0 + +Testing advance payment conditions exception handling +----------------------------------------------------- + +Create a sale with this term:: + + >>> sale = Sale() + >>> sale.party = customer + >>> sale.payment_term = payment_term + >>> line = sale.lines.new() + >>> line.product = product + >>> line.quantity = 5 + >>> sale.advance_payment_term = advance_payment_term + >>> sale.click('quote') + >>> condition1, = sale.advance_payment_conditions + >>> condition1.amount + Decimal('10.00') + >>> sale.click('confirm') + >>> sale.click('process') + +Let's cancel the advance invoice:: + + >>> inv, = sale.advance_payment_invoices + >>> inv.click('cancel') + >>> sale.reload() + >>> sale.invoice_state + u'exception' + +Handle the exception on the sale level, not recreating the invoice will create +the final invoice with the remaining total:: + + >>> handle_exception = Wizard('sale.handle.invoice.exception', [sale]) + >>> _ = handle_exception.form.recreate_invoices.pop() + >>> handle_exception.execute('handle') + + >>> sale.reload() + >>> len(sale.advance_payment_invoices) + 1 + >>> last_invoice, = sale.invoices + >>> last_invoice.total_amount + Decimal('100.00') + +Let's now use the same scenario but recreating the invoice instead of ignoring +it:: + + >>> sale = Sale() + >>> sale.party = customer + >>> sale.payment_term = payment_term + >>> line = sale.lines.new() + >>> line.product = product + >>> line.quantity = 5 + >>> sale.advance_payment_term = advance_payment_term + >>> sale.save() + >>> sale.click('quote') + >>> sale.click('confirm') + >>> sale.click('process') + >>> inv, = sale.advance_payment_invoices + >>> inv.click('cancel') + >>> sale.reload() + >>> sale.invoice_state + u'exception' + + >>> handle_exception = Wizard('sale.handle.invoice.exception', [sale]) + >>> handle_exception.execute('handle') + >>> sale.reload() + >>> _, inv_recreated = sale.advance_payment_invoices + >>> inv_recreated.total_amount + Decimal('10.00') + + >>> inv_recreated.click('post') + >>> pay = Wizard('account.invoice.pay', [inv_recreated]) + >>> pay.form.journal = cash_journal + >>> pay.execute('choice') + >>> sale.reload() + >>> last_invoice, = sale.invoices + >>> last_invoice.total_amount + Decimal('90.00') diff --git a/tests/test_sale_advance_payment.py b/tests/test_sale_advance_payment.py new file mode 100644 index 0000000000..c1e4f44c1d --- /dev/null +++ b/tests/test_sale_advance_payment.py @@ -0,0 +1,23 @@ +# 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 suite as test_suite +from trytond.tests.test_tryton import ModuleTestCase +from trytond.tests.test_tryton import doctest_teardown, doctest_checker + + +class SaleAdvancePaymentTestCase(ModuleTestCase): + 'Test Sale Advance Payment module' + module = 'sale_advance_payment' + + +def suite(): + suite = test_suite() + suite.addTests(unittest.TestLoader().loadTestsFromTestCase( + SaleAdvancePaymentTestCase)) + suite.addTests(doctest.DocFileSuite('scenario_advance_payment.rst', + tearDown=doctest_teardown, encoding='utf-8', + checker=doctest_checker, + optionflags=doctest.REPORT_ONLY_FIRST_FAILURE)) + return suite diff --git a/tests/tools.py b/tests/tools.py new file mode 100644 index 0000000000..1b185db62e --- /dev/null +++ b/tests/tools.py @@ -0,0 +1,23 @@ +# 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 datetime import timedelta + +from proteus import Model + + +def create_advance_payment_term( + name, formula, account, block_supply=False, block_shipping=False, + delay=7, config=None): + "Create an advance payment term" + AdvancePaymentTerm = Model.get( + 'sale.advance_payment_term', config=config) + + advance_payment_term = AdvancePaymentTerm(name=name) + line = advance_payment_term.lines.new() + line.description = name + line.account = account + line.block_supply = block_supply + line.block_shipping = block_shipping + line.formula = formula + line.invoice_delay = timedelta(days=delay) + return advance_payment_term diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000000..08e43cf13a --- /dev/null +++ b/tox.ini @@ -0,0 +1,18 @@ +[tox] +envlist = {py27,py33,py34,py35}-{sqlite,postgresql,mysql},pypy-{sqlite,postgresql} + +[testenv] +commands = {envpython} setup.py test +deps = + {py27,py33,py34,py35}-postgresql: psycopg2 >= 2.5 + pypy-postgresql: psycopg2cffi >= 2.5 + mysql: MySQL-python + sqlite: sqlitebck +setenv = + sqlite: TRYTOND_DATABASE_URI={env:SQLITE_URI:sqlite://} + postgresql: TRYTOND_DATABASE_URI={env:POSTGRESQL_URI:postgresql://} + mysql: TRYTOND_DATABASE_URI={env:MYSQL_URI:mysql://} + sqlite: DB_NAME={env:SQLITE_NAME::memory:} + postgresql: DB_NAME={env:POSTGRESQL_NAME:test} + mysql: DB_NAME={env:MYSQL_NAME:test} +install_command = pip install --pre --find-links https://trydevpi.tryton.org/ {opts} {packages} diff --git a/tryton.cfg b/tryton.cfg new file mode 100644 index 0000000000..923bd8b7cf --- /dev/null +++ b/tryton.cfg @@ -0,0 +1,11 @@ +[tryton] +version = 4.3.0 +depends: + account_invoice + ir + res + sale +extras_depend: + sale_supply +xml: + sale.xml diff --git a/view/advance_payment_condition_form.xml b/view/advance_payment_condition_form.xml new file mode 100644 index 0000000000..921fd42c33 --- /dev/null +++ b/view/advance_payment_condition_form.xml @@ -0,0 +1,21 @@ + + +
+