diff --git a/.gitlab-ci-modules.yml b/.gitlab-ci-modules.yml index c49dae06a2..5747d63c45 100644 --- a/.gitlab-ci-modules.yml +++ b/.gitlab-ci-modules.yml @@ -2723,6 +2723,23 @@ test-modules-sale_promotion_coupon_payment-postgresql: PACKAGE: modules/sale_promotion_coupon_payment TAG_PATTERN: '/^sale_promotion_coupon_payment-.*/' +check-doc-modules-sale_rental: + extends: .check-doc + variables: + PACKAGE: modules/sale_rental + +test-modules-sale_rental-sqlite: + extends: .test-sqlite + variables: + PACKAGE: modules/sale_rental + TAG_PATTERN: '/^sale_rental-.*/' + +test-modules-sale_rental-postgresql: + extends: .test-postgresql + variables: + PACKAGE: modules/sale_rental + TAG_PATTERN: '/^sale_rental-.*/' + check-doc-modules-sale_secondary_unit: extends: .check-doc variables: diff --git a/doc/index.rst b/doc/index.rst index 76c457218a..f485af9086 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -65,6 +65,9 @@ Operational :ref:`Sale Point ` Point of Sales. +:ref:`Sale Rental ` + Rents assets and services. + :ref:`Sale Subscription ` Subscribes to recurring service. diff --git a/doc/sale_rental.rst b/doc/sale_rental.rst new file mode 100644 index 0000000000..104a376444 --- /dev/null +++ b/doc/sale_rental.rst @@ -0,0 +1,9 @@ +:orphan: + +.. _index-sale-rental: + +Sale Rental +=========== + +:doc:`Rental ` + Fundamentals to manage rental sales. diff --git a/modules/sale_history/sale.py b/modules/sale_history/sale.py index 79e27195d0..40922fbc80 100644 --- a/modules/sale_history/sale.py +++ b/modules/sale_history/sale.py @@ -73,3 +73,5 @@ class Subscription(RevisionMixin, metaclass=PoolMeta): class SubscriptionLine(metaclass=PoolMeta): __name__ = 'sale.subscription.line' _history = True + +# TODO: add rental diff --git a/modules/sale_rental/.readthedocs.yaml b/modules/sale_rental/.readthedocs.yaml new file mode 100644 index 0000000000..72203f28f5 --- /dev/null +++ b/modules/sale_rental/.readthedocs.yaml @@ -0,0 +1,10 @@ +version: 2 +build: + os: ubuntu-22.04 + tools: + python: "3" +python: + install: + - requirements: modules/sale_rental/doc/requirements-doc.txt +sphinx: + configuration: modules/sale_rental/doc/conf.py diff --git a/modules/sale_rental/CHANGELOG b/modules/sale_rental/CHANGELOG new file mode 100644 index 0000000000..e69de29bb2 diff --git a/modules/sale_rental/COPYRIGHT b/modules/sale_rental/COPYRIGHT new file mode 100644 index 0000000000..f8f170606e --- /dev/null +++ b/modules/sale_rental/COPYRIGHT @@ -0,0 +1,15 @@ +Copyright (C) 2022 B2CK +Copyright (C) 2022 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/modules/sale_rental/LICENSE b/modules/sale_rental/LICENSE new file mode 100644 index 0000000000..94a9ed024d --- /dev/null +++ b/modules/sale_rental/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/modules/sale_rental/MANIFEST.in b/modules/sale_rental/MANIFEST.in new file mode 100644 index 0000000000..f7e7aaa36b --- /dev/null +++ b/modules/sale_rental/MANIFEST.in @@ -0,0 +1,6 @@ +include CHANGELOG +include COPYRIGHT +include LICENSE +include README.rst +include icons/LICENSE +graft doc diff --git a/modules/sale_rental/README.rst b/modules/sale_rental/README.rst new file mode 120000 index 0000000000..176d9c2695 --- /dev/null +++ b/modules/sale_rental/README.rst @@ -0,0 +1 @@ +doc/index.rst \ No newline at end of file diff --git a/modules/sale_rental/__init__.py b/modules/sale_rental/__init__.py new file mode 100644 index 0000000000..15b7b3e99c --- /dev/null +++ b/modules/sale_rental/__init__.py @@ -0,0 +1,11 @@ +# This file is part of Tryton. The COPYRIGHT file at the top level of +# this repository contains the full copyright notices and license terms. + +__all__ = ['to_date', 'to_datetime'] + + +def __getattr__(name): + if name in {'to_date', 'to_datetime'}: + from . import sale + return getattr(sale, name) + raise AttributeError(f"module {__name__!r} has no attribute {name!r}") diff --git a/modules/sale_rental/account.py b/modules/sale_rental/account.py new file mode 100644 index 0000000000..8705c4c8c3 --- /dev/null +++ b/modules/sale_rental/account.py @@ -0,0 +1,88 @@ +# 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 fields +from trytond.pool import Pool, PoolMeta +from trytond.report import Report +from trytond.tools import cached_property + + +class Invoice(metaclass=PoolMeta): + __name__ = 'account.invoice' + + sale_rentals = fields.Function(fields.Many2Many( + 'sale.rental', None, None, "Rentals"), + 'get_sale_rentals', searcher='search_sale_rentals') + + def get_sale_rentals(self, name): + pool = Pool() + RentalLine = pool.get('sale.rental.line') + rentals = set() + for line in self.lines: + if isinstance(line.origin, RentalLine): + rentals.add(line.origin.rental.id) + return list(rentals) + + @classmethod + def search_sale_rentals(cls, name, clause): + return [ + ('lines.origin.rental' + clause[0][len(name):], + *clause[1:3], 'sale.rental.line', *clause[3:]), + ] + + +class InvoiceLine(metaclass=PoolMeta): + __name__ = 'account.invoice.line' + + @fields.depends('product', 'origin') + def on_change_product(self): + pool = Pool() + RentalLine = pool.get('sale.rental.line') + super().on_change_product() + if self.product and isinstance(self.origin, RentalLine): + # Prevent warning from Invoice._check_taxes + self.taxes = self.origin.taxes + + @cached_property + def product_name(self): + pool = Pool() + RentalLine = pool.get('sale.rental.line') + Lang = pool.get('ir.lang') + lang = Lang.get() + name = super().product_name + if isinstance(self.origin, RentalLine): + converter = RentalLine.duration.converter + duration = Report.format_timedelta( + self.origin.duration_invoice, converter=converter, lang=lang) + start = lang.strftime(self.origin.start_invoice) + end = lang.strftime(self.origin.end_invoice) + name = f'[{start} -- {end}] {duration} × {name}' + return name + + @property + def origin_name(self): + pool = Pool() + RentalLine = pool.get('sale.rental.line') + name = super().origin_name + if isinstance(self.origin, RentalLine): + name = self.origin.rental.rec_name + return name + + @classmethod + def _get_origin(cls): + models = super()._get_origin() + models.append('sale.rental.line') + return models + + +class InvoiceLine_Asset(metaclass=PoolMeta): + __name__ = 'account.invoice.line' + + @fields.depends('origin') + def on_change_with_is_assets_depreciable(self, name=None): + pool = Pool() + RentalLine = pool.get('sale.rental.line') + depreciable = super().on_change_with_is_assets_depreciable(name=name) + if depreciable and isinstance(self.origin, RentalLine): + depreciable = False + return depreciable diff --git a/modules/sale_rental/account.xml b/modules/sale_rental/account.xml new file mode 100644 index 0000000000..5fdc22ffef --- /dev/null +++ b/modules/sale_rental/account.xml @@ -0,0 +1,20 @@ + + + + + + Invoices + account.invoice + + + + form_relate + sale.rental,-1 + + + + diff --git a/modules/sale_rental/doc/conf.py b/modules/sale_rental/doc/conf.py new file mode 100644 index 0000000000..3c0a9f8750 --- /dev/null +++ b/modules/sale_rental/doc/conf.py @@ -0,0 +1,106 @@ +# 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 os + +base_url = os.environ.get('DOC_BASE_URL') +if base_url: + modules_url = base_url + '/modules-{module}/' + trytond_url = base_url + '/server/' +else: + modules_url = ( + 'https://docs.tryton.org/{series}/modules-{module}/') + trytond_url = 'https://docs.tryton.org/{series}/server/' + + +def get_info(): + import configparser + 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', '--description'], + stdout=subprocess.PIPE, check=True, cwd=module_dir) + info['name'], info['description'] = ( + result.stdout.decode('utf-8').strip().splitlines()) + + result = subprocess.run( + [sys.executable, 'setup.py', '--version'], + stdout=subprocess.PIPE, check=True, cwd=module_dir) + version = result.stdout.decode('utf-8').strip() + major_version, minor_version, _ = version.split('.', 2) + major_version = int(major_version) + minor_version = int(minor_version) + if minor_version % 2: + info['series'] = 'latest' + info['branch'] = 'branch/default' + else: + info['series'] = '.'.join(version.split('.', 2)[:2]) + info['branch'] = 'branch/' + info['series'] + + 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() + +html_theme = 'sphinx_book_theme' +html_theme_options = { + 'logo': { + 'alt_text': "Tryton Documentation", + 'image_light': 'https://docs.tryton.org/logo-light.svg', + 'image_dark': 'https://docs.tryton.org/logo-dark.svg', + 'link': base_url, + }, + 'home_page_in_toc': True, + 'repository_provider': 'gitlab', + 'repository_url': 'https://code.tryton.org/tryton', + 'repository_branch': info['branch'], + 'use_source_button': True, + 'use_edit_page_button': True, + 'use_repository_button': True, + 'use_download_button': False, + 'path_to_docs': 'modules/sale_rental/doc', + } +html_title = info['description'] +master_doc = 'index' +project = info['name'] +release = version = info['series'] +default_role = 'ref' +highlight_language = 'none' +exclude_patterns = ['**/*.inc.rst'] +extensions = [ + 'sphinx_copybutton', + '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'] + }) +linkcheck_ignore = [r'/.*', r'https://demo.tryton.org/*'] + +try: + with open(os.path.join( + os.path.dirname(__file__), + 'linkcheck_ignore.json'), 'r') as f: + import json + linkcheck_ignore.extend(json.load(f)) + del json +except FileNotFoundError: + pass + +del get_info, info, base_url, modules_url, trytond_url diff --git a/modules/sale_rental/doc/design.rst b/modules/sale_rental/doc/design.rst new file mode 100644 index 0000000000..376eedb8df --- /dev/null +++ b/modules/sale_rental/doc/design.rst @@ -0,0 +1,137 @@ +****** +Design +****** + +The *Sale Rental Module* introduces and extends the following concepts. + +.. _concept-product: + +Product +======= + +The *Product* concept is extended to store properties when they can be rented +such as a rental `Unit ` and prices. + +The rental price is calculated using the first :guilabel:`Rental Prices` that +matches the criteria such as the duration. + +.. seealso:: + + The `Product ` concept is introduced by the + :doc:`Product Module `. + +.. _model-product.category: + +Product Category +================ + +The *Sale Rental Module* adds some properties to accounting categories when the +`Product ` is rent such as `Account +` and `Taxes `. + +.. seealso:: + + The accounting `Product Category ` + concept is introduced by the :doc:`Account Product Module + `. + +.. _model-sale.rental: + +Rental +====== + +The *Rental* concept is used to manage the renting process of assets or +services. +Each rental, at any time, can be in one of several different states. +A rental progresses through these states until it is either done or gets +cancelled. +When some of these state changes happen the `Employee +` that triggered the state change is also +recorded. + +Each rental contains details about the `Party ` +renting, included details such as the party's preferred `Contact Method +`, and what `Address +` the invoices must be sent to. + +A rental is identified by a unique number that is generated automatically from +the `configured sequence `. +It also has other general information like the rental dates, description, and +reference used by the customer. + +The rental is made up from one, or more, rental lines. +These lines can be arranged into a particularorder, if required. +The lines provide information about which quantity of `Products +` is rented. + +The total, untaxed and tax amounts for a rental are derived from the duration, +quantity, prices and `Taxes ` of the rental's lines. + +Once confirmed, the rental lines must be picked up to register the start date, +and then returned to register the end date. +If the rented product is an asset, `Stock Moves ` are +created to record the outgoing and incoming transaction in the `Warehouse +`. + +`Invoices ` can be generated for the +returned products. +A final invoice is generated when the last product is returned. + +.. seealso:: + + Rentals are found by opening the main menu item: + + |Sales --> Rentals|__ + + .. |Sales --> Rentals| replace:: :menuselection:`Sales --> Rentals` + __ https://demo.tryton.org/model/sale.rental + +Wizards +------- + +.. _wizard-sale.rental.pickup: + +Pickup +^^^^^^ + +The *Pickup* wizard is used to register product pickups on a specified date. + +.. _wizard-sale.rental.return: + +Return +^^^^^^ + +The *Return* wizard is used to register the return of products on a specified +date. + +.. _model-sale.configuration: + +Configuration +============= + +The *Sale Configuration* concept is extended to store the `Sequence +` used to number the `Rental `. + +.. seealso:: + + The `Sale Configuration ` concept is + introduced by the :doc:`Sale Module `. + +.. _model-stock.location: + +Location +======== + +.. _concept-stock.location.warehouse: + +Warehouse +--------- + +When the *Sale Rental Module* is activated, the warehouses gain some extra +properties to store rental locations such as the rental , picking and return +locations. + +.. seealso:: + + The `Warehouse ` concept is + introduced by the :doc:`Stock Module `. diff --git a/modules/sale_rental/doc/index.rst b/modules/sale_rental/doc/index.rst new file mode 100644 index 0000000000..a09f99ff4a --- /dev/null +++ b/modules/sale_rental/doc/index.rst @@ -0,0 +1,12 @@ +################## +Sale Rental Module +################## + +The *Sale Rental Module* manages rental order. + +.. toctree:: + :maxdepth: 2 + + usage/index + design + releases diff --git a/modules/sale_rental/doc/releases.rst b/modules/sale_rental/doc/releases.rst new file mode 100644 index 0000000000..21b13c4745 --- /dev/null +++ b/modules/sale_rental/doc/releases.rst @@ -0,0 +1,7 @@ +.. _releases-index: + +============= +Release notes +============= + +.. include:: ../CHANGELOG diff --git a/modules/sale_rental/doc/requirements-doc.txt b/modules/sale_rental/doc/requirements-doc.txt new file mode 100644 index 0000000000..fee3b273bd --- /dev/null +++ b/modules/sale_rental/doc/requirements-doc.txt @@ -0,0 +1,2 @@ +sphinx_book_theme +sphinx_copybutton diff --git a/modules/sale_rental/doc/usage/index.rst b/modules/sale_rental/doc/usage/index.rst new file mode 100644 index 0000000000..b66859bf19 --- /dev/null +++ b/modules/sale_rental/doc/usage/index.rst @@ -0,0 +1,9 @@ +***** +Usage +***** + +Configuration and management tasks relating to rentals can be found under the +[:menuselection:`Sales`] main menu item. + +.. include:: presales.inc.rst +.. include:: process.inc.rst diff --git a/modules/sale_rental/doc/usage/presales.inc.rst b/modules/sale_rental/doc/usage/presales.inc.rst new file mode 100644 index 0000000000..5b28c2e02f --- /dev/null +++ b/modules/sale_rental/doc/usage/presales.inc.rst @@ -0,0 +1,12 @@ +.. _Making products rentable: + +Making products rentable +======================== + +Before you can add a `Product ` to a `Rental +` it must be marked as rentable. +Only the types assets or service can be marked. +When you do this you will also be able to set some additional properties such +as the `Rental Unit ` and the prices the product is +normally rented at. +You can also specify if the rental duration is per day or not. diff --git a/modules/sale_rental/doc/usage/process.inc.rst b/modules/sale_rental/doc/usage/process.inc.rst new file mode 100644 index 0000000000..a4cef8d4f0 --- /dev/null +++ b/modules/sale_rental/doc/usage/process.inc.rst @@ -0,0 +1,66 @@ +.. _Creating a rentals order: + +Creating a rentals order +======================== + +Creating a new rental order is simply a matter of creating a new `Rental +` and adding the lines for the rented `Products +`. +Most of the fields are optional or have sensible default values. + +.. tip:: + + The rental's reference field is intended to be used to keep track of the + customers reference for the rental. + This can be filled in at any time even when the rental is done. + +.. _Changing a rentals order: + +Changing a rentals order +======================== + +The `Rental ` needs to be in draft state in order to change +the values in most of the fields. + +There are also few fields, such as the `Party ` and +`Currency `, which become read-only when any +lines are added to the order. + +.. _Making a quotation: + +Making a quotation +================== + +A draft `Rental ` can be set to a quotation state waiting to +be confirmed. + +.. note:: + The rented products are reserved by creating draft `Stock Moves + `. + +.. _Pickup products: + +Pickup products +=============== + +Any products that are rent must be picked up to start its rental period. +To pickup products, you must launch the `Pickup wizard +` and set the picked quantity for each product. + +.. _Return products: + +Return products +=============== + +Any picked products must be returned to be invoiced. +To return products, you must launch the `Return wizard +` and set the returned quantity for each product. + +.. _Invoicing a rental: + +Invoicing a rental +================== + +Once products have been returned, you can generate an invoice by clicking on +:guilabel:`Invoice` button. +When the last product is return, the last invoice is generated automatically. diff --git a/modules/sale_rental/icons/LICENSE b/modules/sale_rental/icons/LICENSE new file mode 100644 index 0000000000..7a4a3ea242 --- /dev/null +++ b/modules/sale_rental/icons/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. \ No newline at end of file diff --git a/modules/sale_rental/icons/tryton-sale-rental.svg b/modules/sale_rental/icons/tryton-sale-rental.svg new file mode 100644 index 0000000000..1ccc20dd4c --- /dev/null +++ b/modules/sale_rental/icons/tryton-sale-rental.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/modules/sale_rental/message.xml b/modules/sale_rental/message.xml new file mode 100644 index 0000000000..50bad656aa --- /dev/null +++ b/modules/sale_rental/message.xml @@ -0,0 +1,31 @@ + + + + + + You cannot erase party "%(party)s" while they have pending rentals with company "%(company)s". + + + To delete line "%(line)s" you must cancel or reset to draft rental "%(rental)s". + + + A tax can be added only once to a rental line. + + + The rental line "%(line)s" can be picked only once. + + + The picked quantity "%(picked)s" can not be greater than the quantity "%(quantity)s" for the rental line "%(line)s". + + + The rental line "%(line)s" can be returned only once. + + + The returned quantity "%(picked)s" can not be greater than the quantity "%(quantity)s" for the rental line "%(line)s". + + + The quantity of move "%(move)s" is different from its rental lines "%(quantity)s". + + + diff --git a/modules/sale_rental/party.py b/modules/sale_rental/party.py new file mode 100644 index 0000000000..b79af58d72 --- /dev/null +++ b/modules/sale_rental/party.py @@ -0,0 +1,36 @@ +# This file is part of Tryton. The COPYRIGHT file at the top level of +# this repository contains the full copyright notices and license terms. +from trytond.i18n import gettext +from trytond.modules.party.exceptions import EraseError +from trytond.pool import Pool, PoolMeta + + +class Replace(metaclass=PoolMeta): + __name__ = 'party.replace' + + @classmethod + def fields_to_replace(cls): + return super().fields_to_replace() + [ + ('sale.rental', 'party'), + ] + + +class Erase(metaclass=PoolMeta): + __name__ = 'party.erase' + + def check_erase_company(self, party, company): + pool = Pool() + Rental = pool.get('sale.rental') + super().check_erase_company(party, company) + + rentals = Rental.search([ + ('party', '=', party.id), + ('company', '=', company.id), + ('state', 'not in', ['done', 'cancelled']), + ]) + if rentals: + raise EraseError( + gettext('sale_rental' + '.msg_erase_party_pending_rental', + party=party.rec_name, + company=company.rec_name)) diff --git a/modules/sale_rental/party.xml b/modules/sale_rental/party.xml new file mode 100644 index 0000000000..e5c6732c93 --- /dev/null +++ b/modules/sale_rental/party.xml @@ -0,0 +1,12 @@ + + + + + + party.party + + party_form + + + diff --git a/modules/sale_rental/product.py b/modules/sale_rental/product.py new file mode 100644 index 0000000000..ef397f4727 --- /dev/null +++ b/modules/sale_rental/product.py @@ -0,0 +1,363 @@ +# 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 datetime as dt +from decimal import Decimal +from itertools import chain + +from trytond.i18n import gettext +from trytond.model import ( + MatchMixin, ModelSQL, ModelView, fields, sequence_ordered) +from trytond.modules.account_product.exceptions import TaxError +from trytond.modules.account_product.product import ( + account_used, template_property) +from trytond.modules.currency.fields import Monetary +from trytond.modules.product import price_digits, round_price +from trytond.pool import Pool, PoolMeta +from trytond.pyson import Eval, Id, If, TimeDelta +from trytond.transaction import Transaction + + +class Category(metaclass=PoolMeta): + __name__ = 'product.category' + + account_rental = fields.MultiValue(fields.Many2One( + 'account.account', "Account Rental", + domain=[ + ('closed', '!=', True), + ('type.revenue', '=', True), + ('company', '=', Eval('context', {}).get('company', -1)), + ], + states={ + 'invisible': ( + ~Eval('context', {}).get('company', -1) + | Eval('account_parent', True) + | ~Eval('accounting', False)), + })) + customer_rental_taxes = fields.Many2Many( + 'product.category-customer_rental-account.tax', + 'category', 'tax', "Customer Rental Taxes", + order=[('tax.sequence', 'ASC'), ('tax.id', 'ASC')], + domain=[ + ('parent', '=', None), + ['OR', + ('group', '=', None), + ('group.kind', 'in', ['sale', 'both']), + ], + ], + states={ + 'invisible': ( + ~Eval('context', {}).get('company') + | Eval('taxes_parent', False) + | ~Eval('accounting', False)), + }, + help="The taxes to apply when renting goods or services " + "of this category.") + customer_rental_taxes_used = fields.Function( + fields.Many2Many( + 'account.tax', None, None, "Customer Rental Taxes Used"), + 'get_taxes') + + @classmethod + def multivalue_model(cls, field): + pool = Pool() + if field == 'account_rental': + return pool.get('product.category.account') + return super().multivalue_model(field) + + @property + @account_used('account_rental') + def account_rental_used(self): + pass + + +class CategoryAccount(metaclass=PoolMeta): + __name__ = 'product.category.account' + + account_rental = fields.Many2One( + 'account.account', "Account Rental", + domain=[ + ('closed', '!=', True), + ('type.revenue', '=', True), + ('company', '=', Eval('company', -1)), + ]) + + +class CategoryCustomerRentalTax(ModelSQL): + "Category - Customer Rental Tax" + __name__ = 'product.category-customer_rental-account.tax' + category = fields.Many2One( + 'product.category', "Category", ondelete='CASCADE', required=True) + tax = fields.Many2One( + 'account.tax', "Tax", ondelete='RESTRICT', required=True) + + @classmethod + def __setup__(cls): + super().__setup__() + cls.__access__.add('tax') + + +class Template(metaclass=PoolMeta): + __name__ = 'product.template' + + rentable = fields.Boolean( + "Rentable", + states={ + 'invisible': ~Eval('type').in_(['assets', 'service']), + }) + rental_unit = fields.Many2One( + 'product.uom', "Rental Unit", + domain=[ + ('category', '=', Id('product', 'uom_cat_time')), + ], + states={ + 'invisible': ~Eval('rentable', False), + 'required': Eval('rentable', False), + }) + rental_per_day = fields.Boolean( + "Rental per Day", + states={ + 'invisible': ~Eval('rentable', False), + }) + rental_prices = fields.One2Many( + 'product.rental.price', 'template', "Rental Prices", + states={ + 'invisible': ~Eval('rentable', False), + }) + + @classmethod + def default_rental_per_day(cls): + return False + + @property + @fields.depends('account_category', methods=['get_account']) + @account_used('account_rental', 'account_category') + def account_rental_used(self): + pass + + @property + @fields.depends(methods=['get_taxes', 'account_rental_used']) + def customer_rental_taxes_used(self): + taxes = self.get_taxes('customer_rental_taxes_used') + if taxes is None: + account = self.account_rental_used + if account: + taxes = account.taxes + if taxes is None: + # Allow empty values on on_change + if Transaction().readonly: + taxes = [] + else: + raise TaxError( + gettext('account_product.msg_missing_taxes', + name=self.rec_name)) + return taxes + + @classmethod + def view_attributes(cls): + return super().view_attributes() + [ + ('//page[@id="rental"]', 'states', { + 'invisible': ~Eval('rentable', False), + })] + + @classmethod + def copy(cls, templates, default=None): + pool = Pool() + RentalPrice = pool.get('product.rental.price') + default = default.copy() if default is not None else {} + + copy_rental_prices = 'rental_prices' not in default + default.setdefault('rental_prices', None) + new_templates = super().copy(templates, default=default) + if copy_rental_prices: + old2new = {} + to_copy = [] + for template, new_template in zip(templates, new_templates): + to_copy.extend( + rp for rp in template.rental_prices if not rp.product) + old2new[template.id] = new_template.id + if to_copy: + RentalPrice.copy(to_copy, { + 'template': lambda d: old2new[d['template']], + }) + return new_templates + + +class Product(metaclass=PoolMeta): + __name__ = 'product.product' + + rental_prices = fields.One2Many( + 'product.rental.price', 'product', "Rental Prices", + domain=[ + ('template', '=', Eval('template', -1)), + ], + states={ + 'invisible': ~Eval('rentable', False), + }) + rental_price_uom = fields.Function( + Monetary("Rental Price", digits=price_digits), + 'get_rental_price_uom') + account_rental_used = template_property('account_rental_used') + customer_rental_taxes_used = template_property( + 'customer_rental_taxes_used') + + @classmethod + def get_rental_price_uom(cls, products, name): + context = Transaction().context + quantity = context.get('quantity') or 0 + duration = context.get('duration') or dt.timedelta() + return cls.get_rental_price( + products, quantity=quantity, duration=duration) + + @classmethod + def get_rental_price(cls, products, quantity=0, duration=None): + """ + Return the rental price for products, quantity and duration. + It uses if set in the context: + uom: the unit of measure or the sale uom of the product + currency: the currency id for the returned price + """ + pool = Pool() + Currency = pool.get('currency.currency') + Date = pool.get('ir.date') + UoM = pool.get('product.uom') + User = pool.get('res.user') + + transaction = Transaction() + context = transaction.context + today = Date.today() + prices = {} + + assert len(products) == len(set(products)) + + uom = None + if context.get('uom'): + uom = UoM(context['uom']) + currency = None + if context.get('currency'): + currency = Currency(context['currency']) + user = User(transaction.user) + date = context.get('rental_date') or today + + for product in products: + unit_price = product._get_rental_unit_price( + quantity=quantity, duration=duration, company=user.company.id) + if unit_price is not None: + if uom and product.default_uom.category == uom.category: + unit_price = UoM.compute_price( + product.default_uom, unit_price, uom) + if currency and user.company: + if user.company.currency != currency: + with transaction.set_context(date=date): + unit_price = Currency.compute( + user.company.currency, unit_price, + currency, round=False) + unit_price = round_price(unit_price) + prices[product.id] = unit_price + return prices + + def _get_rental_unit_price(self, quantity=0, duration=None, **pattern): + for price in chain(self.rental_prices, self.template.rental_prices): + if price.match(quantity, duration, pattern): + return price.get_unit_price(self.rental_unit) + + @classmethod + def copy(cls, products, default=None): + pool = Pool() + RentalPrice = pool.get('product.rental.price') + default = default.copy() if default is not None else {} + + copy_rental_prices = 'rental_prices' not in default + if 'template' in default: + default.setdefault('rental_prices', None) + new_products = super().copy(products, default=default) + if 'template' in default and copy_rental_prices: + template2new = {} + product2new = {} + to_copy = [] + for product, new_product in zip(products, new_products): + if product.rental_prices: + to_copy.extend(product.rental_prices) + template2new[product.template.id] = new_product.template.id + product2new[product.id] = new_product.id + if to_copy: + RentalPrice.copy(to_copy, { + 'product': lambda d: product2new[d['product']], + 'template': lambda d: template2new[d['template']], + }) + return new_products + + +class RentalPrice(sequence_ordered(), ModelSQL, ModelView, MatchMixin): + __name__ = 'product.rental.price' + + template = fields.Many2One( + 'product.template', "Product", required=True, ondelete='CASCADE', + domain=[ + If(Eval('product'), + ('products', '=', Eval('product', -1)), + ()), + ], + context={ + 'company': Eval('company', -1), + }, + depends=['company']) + product = fields.Many2One( + 'product.product', "Variant", + domain=[ + If(Eval('template'), + ('template', '=', Eval('template', -1)), + ()), + ], + context={ + 'company': Eval('company', -1), + }, + depends=['company']) + company = fields.Many2One( + 'company.company', "Company", required=True, ondelete='CASCADE') + duration = fields.TimeDelta( + "Duration", required=True, + domain=[ + ('duration', '>', TimeDelta()), + ], + help="The minimal duration to apply the price.") + price = Monetary( + "Price", currency='currency', digits=price_digits, required=True) + + currency = fields.Function( + fields.Many2One('currency.currency', "Currency"), + 'on_change_with_currency') + + @classmethod + def __setup__(cls): + super().__setup__() + cls.__access__.add('template') + cls._order.insert(0, ('company', 'ASC')) + + @classmethod + def default_company(cls): + return Transaction().context.get('company') + + @fields.depends('product', '_parent_product.template') + def on_change_product(self): + if self.product: + self.template = self.product.template + + @fields.depends('company') + def on_change_with_currency(self, name=None): + if self.company: + return self.company.currency.id + + def match(self, quantity, duration, pattern, match_none=False): + if self.duration > duration: + return False + return super().match(pattern, match_none=match_none) + + def get_unit_price(self, unit): + pool = Pool() + UoM = pool.get('product.uom') + Data = pool.get('ir.model.data') + hour = UoM(Data.get_id('product', 'uom_hour')) + unit_price = ( + self.price / Decimal(self.duration.total_seconds() / 60 / 60)) + return UoM.compute_price(hour, unit_price, unit) diff --git a/modules/sale_rental/product.xml b/modules/sale_rental/product.xml new file mode 100644 index 0000000000..71634867b7 --- /dev/null +++ b/modules/sale_rental/product.xml @@ -0,0 +1,63 @@ + + + + + + product.category + + product_category_form + + + + product.template + + product_template_list + + + + product.template + + product_template_form + + + + product.product + tree + + product_product_list_sale_rental_line + + + + product.rental.price + tree + product_rental_price_list + + + + product.rental.price + tree + + product_rental_price_list_sequence + + + + product.rental.price + form + product_rental_price_form + + + + User in companies + product.rental.price + + + + + + + + diff --git a/modules/sale_rental/sale.py b/modules/sale_rental/sale.py new file mode 100644 index 0000000000..7fa5a7b00e --- /dev/null +++ b/modules/sale_rental/sale.py @@ -0,0 +1,1785 @@ +# 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 datetime as dt +from decimal import Decimal +from functools import partial + +from trytond.i18n import gettext +from trytond.ir.attachment import AttachmentCopyMixin +from trytond.ir.note import NoteCopyMixin +from trytond.model import ( + Index, ModelSQL, ModelView, Unique, Workflow, dualmethod, fields, + sequence_ordered) +from trytond.model.exceptions import AccessError, ValidationError +from trytond.model.fields.date import FormatMixin +from trytond.modules.account.tax import TaxableMixin +from trytond.modules.company.model import ( + employee_field, reset_employee, set_employee) +from trytond.modules.currency.fields import Monetary +from trytond.modules.product import price_digits, round_price +from trytond.pool import Pool, PoolMeta +from trytond.pyson import Date, DateTime, Eval, Id, If +from trytond.report import Report +from trytond.tools import timezone as tz +from trytond.transaction import Transaction +from trytond.wizard import Button, StateTransition, StateView, Wizard + +_datetime_format = '%H:%M' +_time_min = dt.datetime.strptime( + dt.time.min.strftime(_datetime_format), _datetime_format).time() +_time_max = dt.datetime.strptime( + dt.time.max.strftime(_datetime_format), _datetime_format).time() + + +class DateOrDateTime(FormatMixin, fields.Date): + + def __init__(self, *args, **kwargs): + self.format = kwargs.pop('format') + super().__init__(*args, **kwargs) + + def definition(self, model, language): + definition = super().definition(model, language) + definition['type'] = 'datetime' + return definition + + +def to_datetime(value, company=None, time=None): + if isinstance(value, dt.date) and not isinstance(value, dt.datetime): + if time is None: + time = _time_min + if company and company.timezone: + timezone = tz.ZoneInfo(company.timezone) + else: + timezone = None + value = (dt.datetime.combine(value, time, timezone) + .astimezone(tz.UTC) + .replace(tzinfo=None)) + return value + + +def to_date(value, company=None): + if isinstance(value, dt.datetime): + if company and company.timezone: + timezone = tz.ZoneInfo(company.timezone) + else: + timezone = None + value = (value + .replace(tzinfo=tz.UTC) + .astimezone(timezone) + .replace(tzinfo=None) + .date()) + return value + + +class Configuration(metaclass=PoolMeta): + __name__ = 'sale.configuration' + + rental_sequence = fields.MultiValue(fields.Many2One( + 'ir.sequence', "Rental Sequence", required=True, + domain=[ + ('company', 'in', + [Eval('context', {}).get('company', -1), None]), + ('sequence_type', '=', + Id('sale_rental', 'sequence_type_rental')), + ])) + + @classmethod + def multivalue_model(cls, field): + pool = Pool() + if field == 'rental_sequence': + return pool.get('sale.configuration.sequence') + return super().multivalue_model(field) + + @classmethod + def default_rental_sequence(cls, **pattern): + return cls.multivalue_model( + 'rental_sequence').default_rental_sequence() + + +class ConfigurationSequence(metaclass=PoolMeta): + __name__ = 'sale.configuration.sequence' + + rental_sequence = fields.Many2One( + 'ir.sequence', "Rental Sequence", required=True, + domain=[ + ('company', 'in', [Eval('company', -1), None]), + ('sequence_type', '=', + Id('sale_rental', 'sequence_type_rental')), + ]) + + @classmethod + def default_rental_sequence(cls): + pool = Pool() + ModelData = pool.get('ir.model.data') + try: + return ModelData.get_id( + 'sale_rental', 'sequence_rental') + except KeyError: + return None + + +class Rental( + Workflow, ModelSQL, ModelView, TaxableMixin, + AttachmentCopyMixin, NoteCopyMixin): + __name__ = 'sale.rental' + _rec_name = 'number' + + company = fields.Many2One( + 'company.company', "Company", required=True, + states={ + 'readonly': (Eval('state') != 'draft') | Eval('party', True), + }, + help="Make the sale rental belong to the company.") + + number = fields.Char( + "Number", readonly=True, + help="The main identification of the sale rental.") + reference = fields.Char( + "Reference", + help="The identification of an external origin.") + description = fields.Char( + "Description", + states={ + 'readonly': Eval('state') != 'draft', + }) + + party = fields.Many2One( + 'party.party', "Party", required=True, + states={ + 'readonly': ( + (Eval('state') != 'draft') + | (Eval('lines', [0]) & Eval('party'))), + }, + context={ + 'company': Eval('company', -1), + }, + depends=['company'], + help="The party who is renting.") + contact = fields.Many2One( + 'party.contact_mechanism', "Contact", + context={ + 'company': Eval('company', -1), + }, + search_context={ + 'related_party': Eval('party'), + }, + depends={'company', 'party'}) + invoice_party = fields.Many2One('party.party', "Invoice Party", + states={ + 'readonly': ((Eval('state') != 'draft') + | Eval('lines', [0])), + }, + context={ + 'company': Eval('company', -1), + }, + search_context={ + 'related_party': Eval('party'), + }, + depends={'company', 'party'}) + invoice_address = fields.Many2One( + 'party.address', "Invoice Address", + domain=[ + ('party', '=', If(Eval('invoice_party'), + Eval('invoice_party', -1), Eval('party', -1))), + ], + states={ + 'readonly': Eval('state') != 'draft', + 'required': ~Eval('state').in_(['draft', 'cancelled']), + }) + payment_term = fields.Many2One( + 'account.invoice.payment_term', "Payment Term", + states={ + 'readonly': Eval('state') != 'draft', + }) + + warehouse = fields.Many2One( + 'stock.location', "Warehouse", + domain=[ + ('type', '=', 'warehouse'), + ], + states={ + 'readonly': Eval('state') != 'draft', + 'required': ~Eval('state').in_(['draft', 'cancelled']), + }) + currency = fields.Many2One( + 'currency.currency', "Currency", required=True, + states={ + 'readonly': ((Eval('state') != 'draft') + | (Eval('lines', [0]) & Eval('currency', 0))), + }) + + start = fields.Function( + DateOrDateTime("Start", format=_datetime_format), + 'on_change_with_start') + end = fields.Function( + DateOrDateTime("End", format=_datetime_format), + 'on_change_with_end') + lines = fields.One2Many( + 'sale.rental.line', 'rental', "Lines", + states={ + 'readonly': Eval('state') != 'draft', + }, + depends=['start', 'end']) + + outgoing_moves = fields.One2Many( + 'stock.move', 'origin', "Outgoing Moves", readonly=True, + filter=[ + ('to_location.type', '=', 'rental'), + ]) + incoming_moves = fields.One2Many( + 'stock.move', 'origin', "Incoming Moves", readonly=True, + filter=[ + ('from_location.type', '=', 'rental'), + ]) + + has_returnable_lines = fields.Function( + fields.Boolean("Has Returnable Lines"), + 'get_has_returnable_lines') + has_lines_to_invoice = fields.Function( + fields.Boolean("Has Lines to Invoice"), + 'get_has_lines_to_invoice') + + untaxed_amount = fields.Function( + Monetary("Untaxed", digits='currency', currency='currency'), + 'get_amount') + untaxed_amount_cache = fields.Numeric( + "Untaxed Cache", digits='currency', readonly=True) + tax_amount = fields.Function( + Monetary("Tax", digits='currency', currency='currency'), + 'get_amount') + tax_amount_cache = fields.Numeric( + "Tax Cache", digits='currency', readonly=True) + total_amount = fields.Function( + Monetary("Total", digits='currency', currency='currency'), + 'get_amount') + total_amount_cache = fields.Numeric( + "Total Cache", digits='currency', readonly=True) + + quoted_by = employee_field( + "Quoted By", states=['quotation', 'confirmed', 'done', 'cancelled']) + confirmed_by = employee_field( + "Confirmed By", states=['confirmed', 'done', 'cancelled']) + state = fields.Selection([ + ('draft', "Draft"), + ('quotation', "Quotation"), + ('confirmed', "Confirmed"), + ('picked up', "Picked up"), + ('done', "Done"), + ('cancelled', "Cancelled"), + ], "State", readonly=True, required=True, sort=False, + help="The current state of the sale subscription.") + + @classmethod + def __setup__(cls): + cls.number.search_unaccented = False + cls.reference.search_unaccented = False + super().__setup__() + t = cls.__table__() + cls._sql_indexes.update({ + Index(t, (t.reference, Index.Similarity())), + Index(t, (t.party, Index.Equality())), + Index( + t, + (t.state, Index.Equality()), + where=t.state.in_([ + 'draft', 'quotation', 'confirmed', 'picked up'])), + }) + cls._transitions |= { + ('draft', 'quotation'), + ('draft', 'cancelled'), + ('quotation', 'confirmed'), + ('quotation', 'draft'), + ('quotation', 'cancelled'), + ('confirmed', 'picked up'), + ('confirmed', 'draft'), + ('picked up', 'done'), + ('picked up', 'draft'), + ('cancelled', 'draft'), + } + cls._buttons.update({ + 'cancel': { + 'invisible': ~Eval('state').in_(['draft', 'quotation']), + 'icon': 'tryton-cancel', + 'depends': ['state'], + }, + 'draft': { + 'invisible': ~Eval('state').in_( + ['quotation', 'confirmed', 'picked up', 'cancelled']), + 'icon': If(Eval('state') == 'cancelled', + 'tryton-undo', 'tryton-back'), + 'depends': ['state'], + }, + 'quote': { + 'invisible': Eval('state') != 'draft', + 'readonly': ~Eval('lines', []), + 'icon': 'tryton-forward', + 'depends': ['state'], + }, + 'confirm': { + 'invisible': Eval('state') != 'quotation', + 'icon': 'tryton-forward', + 'depends': ['state'], + }, + 'pickup': { + 'invisible': Eval('state') != 'confirmed', + 'icon': 'tryton-shipment-out', + 'depends': ['state'], + }, + 'return_': { + 'invisible': ( + Eval('state').in_(['draft', 'quote']) + | ~Eval('has_returnable_lines')), + 'icon': 'tryton-shipment-in', + 'depends': ['state', 'has_returnable_lines'], + }, + 'invoice': { + 'invisible': ( + Eval('state').in_(['draft', 'quote']) + | ~Eval('has_lines_to_invoice')), + 'icon': 'tryton-invoice', + 'depends': ['has_lines_to_invoice'], + }, + }) + cls._states_cached = {'confirmed', 'picked up', 'done', 'cancelled'} + + @classmethod + def default_company(cls): + return Transaction().context.get('company') + + @classmethod + def default_warehouse(cls): + Location = Pool().get('stock.location') + return Location.get_default_warehouse() + + @classmethod + def default_currency(cls, **pattern): + pool = Pool() + Company = pool.get('company.company') + company = pattern.get('company') + if not company: + company = cls.default_company() + if company: + return Company(company).currency.id + + @classmethod + def default_state(cls): + return 'draft' + + @fields.depends('company', 'party', 'invoice_party', 'currency', 'lines') + def on_change_party(self): + if not self.invoice_party: + self.invoice_address = None + if not self.lines: + self.currency = self.default_currency( + company=self.company.id if self.company else None) + if self.party: + if not self.invoice_party: + self.invoice_address = self.party.address_get(type='invoice') + self.payment_term = self.party.customer_payment_term + if not self.lines and self.party.customer_currency: + self.currency = self.party.customer_currency + + @fields.depends('party', 'invoice_party') + def on_change_invoice_party(self): + if self.invoice_party: + self.invoice_address = self.invoice_party.address_get( + type='invoice') + elif self.party: + self.invoice_address = self.party.address_get(type='invoice') + + @classmethod + def default_start(cls): + now = dt.datetime.now().replace(second=0, microsecond=0) + now += dt.timedelta(minutes=30 - now.minute % 30) + return now + + @fields.depends('company', 'lines') + def on_change_with_start(self, name=None): + return min(map(partial(to_datetime, company=self.company), filter( + None, + (getattr(l, 'start', None) for l in (self.lines or [])))), + default=self.default_start()) + + @fields.depends('company', 'lines') + def on_change_with_end(self, name=None): + return max(map(partial( + to_datetime, company=self.company, time=_time_max), + filter( + None, + (getattr(l, 'end', None) for l in (self.lines or [])))), + default=None) + + @fields.depends('lines', 'currency', methods=['get_tax_amount']) + def on_change_lines(self): + self.untaxed_amount = Decimal(0) + self.tax_amount = Decimal(0) + self.total_amount = Decimal(0) + + for line in self.lines or []: + self.untaxed_amount += getattr(line, 'amount', None) or 0 + self.tax_amount = self.get_tax_amount() + + if self.currency: + self.untaxed_amount = self.currency.round(self.untaxed_amount) + self.tax_amount = self.currency.round(self.tax_amount) + self.total_amount = self.untaxed_amount + self.tax_amount + if self.currency: + self.total_amount = self.currency.round(self.total_amount) + + def get_has_returnable_lines(self, name): + return any(l.rental_state == 'picked up' for l in self.lines) + + def get_has_lines_to_invoice(self, name): + return any(l.to_invoice for l in self.lines) + + @fields.depends(methods=['_get_taxes']) + def get_tax_amount(self): + return sum( + (t.amount for t in self._get_taxes().values()), Decimal(0)) + + @property + def taxable_lines(self): + taxable_lines = [] + for line in self.lines: + taxable_lines.extend(line.taxable_lines) + return taxable_lines + + @fields.depends('party', 'company') + def _get_tax_context(self): + context = {} + if self.party and self.party.lang: + context['language'] = self.party.lang.code + if self.company: + context['company'] = self.company.id + return context + + @classmethod + def get_amount(cls, rentals, names): + untaxed_amount = {} + tax_amount = {} + total_amount = {} + + if {'tax_amount', 'total_amount'} & set(names): + compute_taxes = True + else: + compute_taxes = False + # Sort cached first and re-instanciate to optimize cache management + rentals = sorted( + rentals, key=lambda s: s.state in cls._states_cached, reverse=True) + for rental in cls.browse(rentals): + if (rental.state in cls._states_cached + and rental.untaxed_amount_cache is not None + and rental.tax_amount_cache is not None + and rental.total_amount_cache is not None): + untaxed_amount[rental.id] = rental.untaxed_amount_cache + if compute_taxes: + tax_amount[rental.id] = rental.tax_amount_cache + total_amount[rental.id] = rental.total_amount_cache + else: + untaxed_amount[rental.id] = sum( + (line.amount for line in rental.lines), Decimal(0)) + if compute_taxes: + tax_amount[rental.id] = rental.get_tax_amount() + total_amount[rental.id] = ( + untaxed_amount[rental.id] + tax_amount[rental.id]) + + amounts = {} + if 'untaxed_amount' in names: + amounts['untaxed_amount'] = untaxed_amount + if 'tax_amount' in names: + amounts['tax_amount'] = tax_amount + if 'total_amount' in names: + amounts['total_amount'] = total_amount + return amounts + + @classmethod + def set_number(cls, rentals): + pool = Pool() + Config = pool.get('sale.configuration') + + config = Config(1) + for rental in rentals: + if rental.number: + continue + rental.number = config.get_multivalue( + 'rental_sequence', + company=rental.company.id).get() + cls.save(rentals) + + @classmethod + def set_moves(cls, rentals): + pool = Pool() + Line = pool.get('sale.rental.line') + Move = pool.get('stock.move') + + lines, moves = [], set() + for rental in rentals: + for line in rental.lines: + line.outgoing_moves = line.get_moves('out') + moves.update(line.outgoing_moves) + line.incoming_moves = line.get_moves('in') + moves.update(line.incoming_moves) + lines.append(line) + Move.save(moves) + Line.save(lines) + + @classmethod + def delete_moves(cls, rentals, all_=False): + pool = Pool() + Line = pool.get('sale.rental.line') + Move = pool.get('stock.move') + + lines, moves = [], set() + for rental in rentals: + for line in rental.lines: + moves.update(line.outgoing_moves) + line.outgoing_moves = [] + moves.update(line.incoming_moves) + line.incoming_moves = [] + lines.append(line) + Line.save(lines) + moves = Move.browse(moves) + Move.draft(moves) + Move.delete([ + m for m in moves if all_ or m.state in {'draft', 'cancelled'}]) + + @classmethod + def store_cache(cls, rentals): + for rental in rentals: + rental.untaxed_amount_cache = rental.untaxed_amount + rental.tax_amount_cache = rental.tax_amount + rental.total_amount_cache = rental.total_amount + cls.save(rentals) + + def create_invoice(self): + invoice_lines = [] + + for line in self.lines: + if line.to_invoice: + invoice_lines.extend(line.get_invoice_lines()) + if not invoice_lines: + return + + invoice = self._get_invoice() + if getattr(invoice, 'lines', None): + invoice_lines = list(invoice.lines) + invoice_lines + invoice.lines = invoice_lines + return invoice + + def _get_invoice(self): + pool = Pool() + Invoice = pool.get('account.invoice') + party = self.invoice_party or self.party + invoice = Invoice( + company=self.company, + type='out', + party=party, + invoice_address=self.invoice_address, + currency=self.currency, + account=party.account_receivable_used, + ) + invoice.set_journal() + invoice.payment_term = self.payment_term + return invoice + + def get_rec_name(self, name): + items = [] + if self.number: + items.append(self.number) + if self.reference: + items.append('[%s]' % self.reference) + if not items: + items.append('(%s)' % self.id) + return ' '.join(items) + + @classmethod + def search_rec_name(cls, name, clause): + _, operator, value = clause + if operator.startswith('!') or operator.startswith('not '): + bool_op = 'AND' + else: + bool_op = 'OR' + domain = [bool_op, + ('number', operator, value), + ('reference', operator, value), + ] + return domain + + @classmethod + def copy(cls, rentals, default=None): + default = default.copy() if default is not None else {} + default.setdefault('number', None) + default.setdefault('quoted_by') + default.setdefault('confirmed_by') + default.setdefault('lines.outgoing_moves', None) + default.setdefault('lines.incoming_moves', None) + return super().copy(rentals, default=default) + + @classmethod + def view_attributes(cls): + return super().view_attributes() + [ + ('/tree', 'visual', + If(Eval('state') == 'cancelled', 'muted', '')), + ] + + @classmethod + @ModelView.button + @Workflow.transition('cancelled') + def cancel(cls, rentals): + cls.delete_moves(rentals, all_=True) + + @classmethod + @ModelView.button + @Workflow.transition('draft') + @reset_employee('quoted_by', 'confirmed_by') + def draft(cls, rentals): + pool = Pool() + Line = pool.get('sale.rental.line') + + # Set actual period as planned period + lines = [] + for rental in rentals: + for line in rental.lines: + if line.per_day: + if line.actual_start: + line.planned_start_day = to_date( + line.actual_start, line.company) + if line.actual_end: + line.planned_end_day = to_date( + line.actual_end, line.company) + if line.planned_end_day < line.planned_start_day: + line.planned_end_day = line.planned_start_day + else: + if line.actual_start: + line.planned_start = line.actual_start + if line.actual_end: + line.planned_end = line.actual_end + if line.planned_end < line.planned_start: + line.planned_end = line.planned_start + lines.append(line) + Line.save(lines) + cls.delete_moves(rentals) + + @classmethod + @ModelView.button + @Workflow.transition('quotation') + @set_employee('quoted_by') + def quote(cls, rentals): + cls.set_number(rentals) + cls.set_moves(rentals) + + @classmethod + @ModelView.button + @Workflow.transition('confirmed') + @set_employee('confirmed_by') + def confirm(cls, rentals): + cls.store_cache(rentals) + cls.write(rentals, {'state': 'confirmed'}) + cls.try_picked_up(rentals) + + @classmethod + @ModelView.button_action('sale_rental.wizard_sale_rental_pickup') + def pickup(cls, rentals): + pass + + @dualmethod + def try_picked_up(cls, rentals): + to_picked_up = [] + for rental in rentals: + if all( + l.rental_state in {'picked up', 'done'} + for l in rental.lines): + to_picked_up.append(rental) + if to_picked_up: + cls.picked_up(to_picked_up) + + @classmethod + @Workflow.transition('picked up') + def picked_up(cls, rentals): + cls.write(rentals, {'state': 'picked up'}) + cls.try_done(rentals) + + @classmethod + @ModelView.button_action('sale_rental.wizard_sale_rental_return') + def return_(cls, rentals): + pass + + @classmethod + @ModelView.button + def invoice(cls, rentals): + pool = Pool() + Invoice = pool.get('account.invoice') + + invoices = {} + for rental in rentals: + invoice = rental.create_invoice() + if invoice: + invoices[rental] = invoice + + Invoice.save(invoices.values()) + Invoice.update_taxes(invoices.values()) + for sale, invoice in invoices.items(): + sale.copy_resources_to(invoice) + + @dualmethod + def try_done(cls, rentals): + to_do = [] + for rental in rentals: + if all(l.rental_state == 'done' for l in rental.lines): + to_do.append(rental) + if to_do: + cls.do(to_do) + + @classmethod + @Workflow.transition('done') + def do(cls, rentals): + cls.invoice(rentals) + + +class RentalLine(sequence_ordered(), ModelSQL, ModelView, TaxableMixin): + __name__ = 'sale.rental.line' + + rental = fields.Many2One( + 'sale.rental', "Rental", required=True, ondelete='CASCADE', + states={ + 'readonly': ( + (Eval('rental_state') != 'draft') + & Eval('rental')), + }, + help="Add the line below the rental.") + + product = fields.Many2One( + 'product.product', "Product", required=True, ondelete='RESTRICT', + domain=[ + ('type', 'in', ['assets', 'service']), + ('rentable', '=', True), + ], + states={ + 'readonly': Eval('rental_state') != 'draft', + }, + context={ + 'company': Eval('company', -1), + }, + search_context={ + 'locations': If(Eval('_parent_rental', {}).get('warehouse'), + [Eval('_parent_rental', {}).get('warehouse', -1)], []), + 'stock_date_end': Date(start=Eval('start', DateTime())), + 'stock_skip_warehouse': True, + 'rental_date': Date(start=Eval('start', DateTime())), + 'currency': Eval('_parent_rental', {}).get('currency', -1), + 'customer': Eval('_parent_rental', {}).get('party', -1), + 'uom': Eval('unit', -1), + 'taxes': Eval('taxes', []), + 'quantity': Eval('quantity', 0), + 'duration': Eval('duration', None), + }, + depends=['company']) + per_day = fields.Boolean( + "Per Day", + states={ + 'readonly': Eval('rental_state') != 'draft', + }) + quantity = fields.Float( + "Quantity", digits='unit', required=True, + domain=[ + If(Eval('quantity'), + ('quantity', '>=', 0), + ()), + ], + states={ + 'readonly': Eval('rental_state') != 'draft', + }) + unit = fields.Many2One( + 'product.uom', "Unit", required=True, + states={ + 'readonly': Eval('rental_state') != 'draft', + }, + domain=[ + If(Eval('product_uom_category'), + ('category', '=', Eval('product_uom_category', -1)), + ('category', '=', -1)), + ]) + + planned_start_day = fields.Date( + "Planned Start", + domain=[ + If(Eval('planned_start_day') & Eval('planned_end_day'), + ('planned_start_day', '<=', Eval('planned_end_day', None)), + ()), + If(~Eval('per_day'), + ('planned_start_day', '=', None), + ()), + ], + states={ + 'required': Eval('per_day', False), + 'invisible': ~Eval('per_day'), + 'readonly': Eval('rental_state') != 'draft', + }) + planned_end_day = fields.Date( + "Planned End", + domain=[ + If(Eval('planned_start_day') & Eval('planned_end_day'), + ('planned_end_day', '>=', Eval('planned_start_day', None)), + ()), + If(~Eval('per_day'), + ('planned_end_day', '=', None), + ()), + ], + states={ + 'required': Eval('per_day', False), + 'invisible': ~Eval('per_day'), + 'readonly': Eval('rental_state') != 'draft', + }) + planned_start = fields.DateTime( + "Planned Start", format=_datetime_format, + domain=[ + If(Eval('planned_start') & Eval('planned_end'), + ('planned_start', '<=', Eval('planned_end')), + ()), + If(Eval('per_day', False), + ('planned_start', '=', None), + ()), + ], + states={ + 'required': ~Eval('per_day'), + 'invisible': Eval('per_day', False), + 'readonly': Eval('rental_state') != 'draft', + }) + planned_end = fields.DateTime( + "Planned End", format=_datetime_format, + domain=[ + If(Eval('planned_start') & Eval('planned_end'), + ('planned_end', '>=', Eval('planned_start')), + ()), + If(Eval('per_day', False), + ('planned_end', '=', None), + ()), + ], + states={ + 'required': ~Eval('per_day'), + 'invisible': Eval('per_day', False), + 'readonly': Eval('rental_state') != 'draft', + }) + planned_duration = fields.Function( + fields.TimeDelta( + "Planned Duration", + states={ + 'invisible': ~Eval('planned_duration'), + }), + 'on_change_with_planned_duration') + + actual_start = fields.DateTime( + "Actual Start", format=_datetime_format, readonly=True, + domain=[ + If(Eval('actual_start') & Eval('actual_end'), + ('actual_start', '<=', Eval('actual_end')), + ()), + ], + states={ + 'invisible': ~Eval('actual_start'), + 'required': Eval('rental_state').in_(['picked up', 'done']), + }) + actual_end = fields.DateTime( + "Actual End", format=_datetime_format, readonly=True, + domain=[ + If(Eval('actual_start') & Eval('actual_end'), + ('actual_end', '>=', Eval('actual_start')), + ()), + ], + states={ + 'invisible': ~Eval('actual_end'), + 'required': Eval('rental_state') == 'done', + }) + + start = fields.Function( + DateOrDateTime("Start", format=_datetime_format), + 'on_change_with_start') + end = fields.Function( + DateOrDateTime("End", format=_datetime_format), + 'on_change_with_end') + duration = fields.Function( + fields.TimeDelta( + "Duration", + states={ + 'invisible': ~Eval('duration'), + }), + 'on_change_with_duration') + + unit_price = Monetary( + "Unit Price", currency='currency', digits=price_digits, required=True, + states={ + 'readonly': Eval('rental_state') != 'draft', + }) + unit_price_unit = fields.Many2One( + 'product.uom', "Unit Price Unit", required=True, + domain=[ + ('category', '=', Id('product', 'uom_cat_time')), + ], + states={ + 'readonly': Eval('rental_state') != 'draft', + }) + taxes = fields.Many2Many( + 'sale.rental.line-account.tax', 'line', 'tax', "Taxes", + order=[('tax.sequence', 'ASC'), ('tax.id', 'ASC')], + domain=[ + ('parent', '=', None), + ['OR', + ('group', '=', None), + ('group.kind', 'in', ['sale', 'both'])], + ('company', '=', Eval('company', -1)), + ], + states={ + 'readonly': Eval('rental_state') != 'draft', + }) + planned_amount = fields.Function( + Monetary( + "Planned Amount", digits='currency', currency='currency', + states={ + 'invisible': ~Eval('planned_duration'), + }), + 'on_change_with_planned_amount') + amount = fields.Function( + Monetary( + "Amount", digits='currency', currency='currency', + states={ + 'invisible': ~Eval('duration'), + }), + 'on_change_with_amount') + + outgoing_moves = fields.Many2Many( + 'sale.rental.line-outgoing-stock.move', 'line', 'move', + "Outgoing Moves", + states={ + 'readonly': True, + }) + incoming_moves = fields.Many2Many( + 'sale.rental.line-incoming-stock.move', 'line', 'move', + "Incoming Moves", + states={ + 'readonly': True, + }) + + invoice_lines = fields.One2Many( + 'account.invoice.line', 'origin', "Invoice Lines", readonly=True) + + rental_state = fields.Function( + fields.Selection('get_rental_states', "Rental State"), + 'on_change_with_rental_state') + company = fields.Function( + fields.Many2One('company.company', "Company"), + 'on_change_with_company') + currency = fields.Function( + fields.Many2One('currency.currency', "Currency"), + 'on_change_with_currency') + product_uom_category = fields.Function( + fields.Many2One('product.uom.category', "Product UoM Category"), + 'on_change_with_product_uom_category') + + @classmethod + def __setup__(cls): + super().__setup__() + cls.__access__.add('rental') + + @fields.depends( + 'rental', 'per_day', '_parent_rental.company', + '_parent_rental.start', '_parent_rental.end', + 'planned_start_day', 'planned_end_day', + 'planned_start', 'planned_end', + methods=['on_change_with_duration']) + def _set_planned(self): + if self.rental: + if self.per_day: + if not self.planned_start_day: + self.planned_start_day = to_date( + self.rental.start, self.rental.company) + if not self.planned_end_day: + self.planned_end_day = to_date( + self.rental.end, self.rental.company) + self.planned_start = self.planned_end = None + else: + self.planned_start_day = self.planned_end_day = None + if not self.planned_start: + self.planned_start = to_datetime( + self.rental.start, self.rental.company) + if not self.planned_end: + self.planned_end = to_datetime( + self.rental.end, self.rental.company, _time_max) + self.duration = self.on_change_with_duration() + + @fields.depends( + 'product', 'unit', + methods=[ + 'compute_taxes', 'compute_unit_price', 'on_change_with_amount', + '_set_planned']) + def on_change_product(self): + if not self.product: + return + self.per_day = self.product.rental_per_day + + self._set_planned() + + self.taxes = self.compute_taxes() + + if (not self.unit + or self.unit.category != self.product.default_uom.category): + self.unit = self.product.default_uom + + self.unit_price_unit = self.product.rental_unit + self.unit_price = self.compute_unit_price() + self.amount = self.on_change_with_amount() + + @fields.depends( + 'product', + 'rental', '_parent_rental.invoice_party', '_parent_rental.party', + methods=['_get_tax_rule_pattern']) + def compute_taxes(self): + party = None + if self.rental: + party = self.rental.invoice_party or self.rental.party + + taxes = set() + pattern = self._get_tax_rule_pattern() + for tax in self.product.customer_rental_taxes_used: + if party and party.customer_tax_rule: + tax_ids = party.customer_tax_rule.apply(tax, pattern) + if tax_ids: + taxes.update(tax_ids) + continue + taxes.add(tax.id) + if party and party.customer_tax_rule: + tax_ids = party.customer_tax_rule.apply(None, pattern) + if tax_ids: + taxes.update(tax_ids) + return list(taxes) + + def _get_tax_rule_pattern(self): + return {} + + @property + def taxable_lines(self): + # In case we're called from an on_change + # we have to use some sensible defaults + return [( + getattr(self, 'taxes', None) or [], + getattr(self, 'unit_price', None) or Decimal(0), + (getattr(self, 'quantity', None) or 0) + * (getattr(self, 'duration_unit', None) or 0), + None, + )] + + def _get_tax_context(self): + return self.rental._get_tax_context() + + @fields.depends( + 'product', 'quantity', 'unit_price_unit', + methods=['on_change_with_duration', '_get_context_rental_price']) + def compute_unit_price(self): + pool = Pool() + Product = pool.get('product.product') + UoM = pool.get('product.uom') + + if not self.product: + return + + duration = self.on_change_with_duration() + + with Transaction().set_context(self._get_context_rental_price()): + unit_price = Product.get_rental_price( + [self.product], + quantity=self.quantity or 0, + duration=duration or dt.timedelta())[self.product.id] + if unit_price is not None: + if self.unit_price_unit: + unit_price = UoM.compute_price( + self.product.rental_unit, unit_price, + self.unit_price_unit) + unit_price = round_price(unit_price) + return unit_price + + @fields.depends( + 'rental', '_parent_rental.currency', '_parent_rental.party', + 'start', 'company', 'unit', 'product', 'taxes') + def _get_context_rental_price(self): + context = {} + if self.rental: + if self.rental.currency: + context['currency'] = self.rental.currency.id + if self.rental.party: + context['customer'] = self.rental.party.id + if self.start: + context['rental_date'] = self.start + if self.company: + context['company'] = self.company.id + if self.unit: + context['uom'] = self.unit.id + elif self.product: + context['uom'] = self.product.default_uom.id + context['taxes'] = [t.id for t in self.taxes or []] + return context + + @fields.depends(methods=['compute_unit_price', 'on_change_with_amount']) + def on_change_quantity(self): + self.unit_price = self.compute_unit_price() + self.amount = self.on_change_with_amount() + + @fields.depends(methods=['on_change_quantity']) + def on_change_unit(self): + self.on_change_quantity() + + @fields.depends(methods=['compute_unit_price', 'on_change_with_amount']) + def _on_change_planned(self): + self.unit_price = self.compute_unit_price() + self.amount = self.on_change_with_amount() + + @fields.depends(methods=['_on_change_planned']) + def on_change_planned_start_day(self): + self._on_change_planned() + + @fields.depends(methods=['_on_change_planned']) + def on_change_planned_end_day(self): + self._on_change_planned() + + @fields.depends(methods=['_on_change_planned']) + def on_change_planned_start(self): + self._on_change_planned() + + @fields.depends(methods=['_on_change_planned']) + def on_change_planned_end(self): + self._on_change_planned() + + @fields.depends( + 'per_day', + 'planned_start_day', 'planned_end_day', + 'planned_start', 'planned_end') + def on_change_with_planned_duration(self, name=None): + if self.per_day: + if self.planned_start_day and self.planned_end_day: + return self.planned_end_day - self.planned_start_day + else: + if self.planned_start and self.planned_end: + return self.planned_end - self.planned_start + + @property + @fields.depends('planned_duration', 'unit_price_unit') + def planned_duration_unit(self): + pool = Pool() + UoM = pool.get('product.uom') + Data = pool.get('ir.model.data') + hour = UoM(Data.get_id('product', 'uom_hour')) + + if self.planned_duration: + duration = self.planned_duration.total_seconds() / 60 / 60 + else: + duration = 0 + if self.unit_price_unit: + duration = UoM.compute_qty( + hour, duration, self.unit_price_unit, round=False) + return duration + + @fields.depends( + 'per_day', 'company', + 'actual_start', 'planned_start_day', 'planned_start') + def on_change_with_start(self, name=None): + if self.per_day: + return ( + to_date(self.actual_start, self.company) + or self.planned_start_day) + else: + return self.actual_start or self.planned_start + + @fields.depends( + 'per_day', 'company', + 'actual_end', 'planned_end_day', 'planned_end') + def on_change_with_end(self, name=None): + if self.per_day: + return ( + to_date(self.actual_end, self.company) or self.planned_end_day) + else: + return self.actual_end or self.planned_end + + @fields.depends(methods=['on_change_with_start', 'on_change_with_end']) + def on_change_with_duration(self, name=None): + start = self.on_change_with_start() + end = self.on_change_with_end() + if start and end: + return end - start + + @property + @fields.depends('duration', 'unit_price_unit') + def duration_unit(self): + pool = Pool() + UoM = pool.get('product.uom') + Data = pool.get('ir.model.data') + hour = UoM(Data.get_id('product', 'uom_hour')) + + if self.duration: + duration = self.duration.total_seconds() / 60 / 60 + else: + duration = 0 + if self.unit_price_unit: + duration = UoM.compute_qty( + hour, duration, self.unit_price_unit, round=False) + return duration + + @fields.depends( + 'quantity', 'unit_price', 'currency', + methods=['on_change_with_planned_duration', 'planned_duration_unit']) + def on_change_with_planned_amount(self, name=None): + self.planned_duration = self.on_change_with_planned_duration() + if self.quantity is not None and self.unit_price is not None: + amount = ( + Decimal(self.quantity) + * Decimal(self.planned_duration_unit) + * self.unit_price) + if self.currency: + amount = self.currency.round(amount) + return amount + + @fields.depends( + 'quantity', 'unit_price', 'currency', + methods=['on_change_with_duration', 'duration_unit']) + def on_change_with_amount(self, name=None): + self.duration = self.on_change_with_duration() + if self.quantity is not None and self.unit_price is not None: + amount = ( + Decimal(self.quantity) + * Decimal(self.duration_unit) + * self.unit_price) + if self.currency: + amount = self.currency.round(amount) + return amount + + @classmethod + def get_rental_states(cls): + pool = Pool() + Rental = pool.get('sale.rental') + return Rental.fields_get(['state'])['state']['selection'] + + @fields.depends( + 'rental', '_parent_rental.state', 'actual_start', 'actual_end') + def on_change_with_rental_state(self, name=None): + if self.actual_end: + return 'done' + elif self.actual_start: + return 'picked up' + elif self.rental: + return self.rental.state + + @fields.depends('rental', '_parent_rental.company') + def on_change_with_company(self, name=None): + if self.rental and self.rental.company: + return self.rental.company.id + + @fields.depends('rental', '_parent_rental.currency') + def on_change_with_currency(self, name=None): + if self.rental and self.rental.currency: + return self.rental.currency.id + + @fields.depends('product') + def on_change_with_product_uom_category(self, name=None): + if self.product: + return self.product.default_uom_category.id + + @property + def picking_location(self): + return ( + self.rental.warehouse.rental_picking_location + or self.rental.warehouse.storage_location) + + @property + def return_location(self): + return ( + self.rental.warehouse.rental_return_location + or self.rental.warehouse.storage_location) + + @property + def rental_location(self): + return self.rental.warehouse.rental_location + + def get_moves(self, type): + + if self.product.type == 'service': + return [] + + if type == 'out' and self.outgoing_moves: + return self.outgoing_moves + elif type == 'in' and self.incoming_moves: + return self.incoming_moves + + move = self.get_move(type) + move.quantity = self.quantity + move.unit = self.unit + return [move] + + def get_move(self, type): + pool = Pool() + Move = pool.get('stock.move') + + move = Move() + move.product = self.product + if type == 'out': + move.from_location = self.picking_location + move.to_location = self.rental_location + move.planned_date = to_date(self.start, self.company) + elif type == 'in': + move.from_location = self.rental_location + move.to_location = self.return_location + move.planned_date = to_date(self.end, self.company) + move.state = 'draft' + move.company = self.rental.company + if move.on_change_with_unit_price_required(): + move.unit_price = self.unit_price * self.duration_unit + move.currency = self.rental.currency + move.origin = self.rental + return move + + @property + def to_invoice(self): + return self.rental_state == 'done' and not self.invoice_lines + + @property + def start_invoice(self): + return self.start + + @property + def end_invoice(self): + return self.end + + @property + def duration_invoice(self): + return self.duration + + @property + def duration_unit_invoice(self): + pool = Pool() + UoM = pool.get('product.uom') + Data = pool.get('ir.model.data') + hour = UoM(Data.get_id('product', 'uom_hour')) + + if duration := self.duration_invoice: + duration = duration.total_seconds() / 60 / 60 + else: + duration = 0 + if self.unit_price_unit: + duration = UoM.compute_qty( + hour, duration, self.unit_price_unit, round=False) + return duration + + def get_invoice_lines(self): + pool = Pool() + InvoiceLine = pool.get('account.invoice.line') + + if self.rental_state != 'done' or self.invoice_lines: + return [] + + invoice_line = InvoiceLine(invoice_type='out', type='line') + invoice_line.currency = self.rental.currency + invoice_line.company = self.rental.company + invoice_line.origin = self + invoice_line.quantity = self.quantity + invoice_line.unit = self.unit + invoice_line.product = self.product + invoice_line.unit_price = round_price( + self.unit_price * Decimal(self.duration_unit_invoice)) + invoice_line.taxes = self.taxes + invoice_line.account = self.product.account_rental_used + return [invoice_line] + + def get_rec_name(self, name): + pool = Pool() + Lang = pool.get('ir.lang') + lang = Lang.get() + converter = self.__class__.duration.converter + quantity = lang.format_number_symbol( + self.quantity, self.unit, digits=self.unit.digits) + duration = Report.format_timedelta( + self.duration, converter=converter, lang=lang) + product = self.product.rec_name + rental = self.rental.rec_name + return f'{duration} × {quantity} {product} @ {rental}' + + @classmethod + def search_rec_name(cls, name, clause): + _, operator, value = clause + if operator.startswith('!') or operator.startswith('not '): + bool_op = 'AND' + else: + bool_op = 'OR' + return [bool_op, + ('rental.rec_name', *clause[1:]), + ('product.rec_name', *clause[1:]), + ] + + @classmethod + def copy(cls, lines, default=None): + default = default.copy() if default is not None else {} + default.setdefault('actual_start') + default.setdefault('actual_end') + default.setdefault('invoice_lines') + return super().copy(lines, default=default) + + @classmethod + def check_modification(cls, mode, lines, values=None, external=False): + super().check_modification( + mode, lines, values=values, external=external) + if mode == 'delete': + for line in lines: + if line.rental_state not in {'cancelled', 'draft'}: + raise AccessError(gettext( + 'sale_rental.msg_rental_line_delete_cancel_draft', + line=line.rec_name, + rental=line.rental.rec_name)) + + +class RentalLine_Tax(ModelSQL): + __name__ = 'sale.rental.line-account.tax' + + line = fields.Many2One( + 'sale.rental.line', "Rental Line", ondelete='CASCADE', required=True) + tax = fields.Many2One( + 'account.tax', "Tax", ondelete='RESTRICT', required=True) + + @classmethod + def __setup__(cls): + super().__setup__() + t = cls.__table__() + cls._sql_constraints += [ + ('line_tax_unique', Unique(t, t.line, t.tax), + 'sale_rental.msg_rental_line_tax_unique'), + ] + + +class RentalLine_Outgoing_Move(ModelSQL): + __name__ = 'sale.rental.line-outgoing-stock.move' + + line = fields.Many2One( + 'sale.rental.line', "Rental Line", ondelete='CASCADE', required=True) + move = fields.Many2One( + 'stock.move', "Move", ondelete='RESTRICT', required=True, + domain=[ + ('origin', 'like', 'sale.rental,%'), + ('to_location.type', '=', 'rental'), + ]) + + +class RentalLine_Incoming_Move(ModelSQL): + __name__ = 'sale.rental.line-incoming-stock.move' + + line = fields.Many2One( + 'sale.rental.line', "Rental Line", ondelete='CASCADE', required=True) + move = fields.Many2One( + 'stock.move', "Move", ondelete='RESTRICT', required=True, + domain=[ + ('origin', 'like', 'sale.rental,%'), + ('from_location.type', '=', 'rental'), + ]) + + +class _RentalShowLine(ModelView): + + rental_line = fields.Many2One( + 'sale.rental.line', "Rental Line", readonly=True) + product = fields.Function( + fields.Many2One('product.product', "Product"), + 'on_change_with_product') + quantity = fields.Function( + fields.Float("Quantity", digits='unit'), + 'on_change_with_quantity') + unit = fields.Function( + fields.Many2One('product.uom', "Unit"), + 'on_change_with_unit') + + @classmethod + def get(cls, rental_line): + line = cls() + line.rental_line = rental_line + line.product = line.on_change_with_product() + line.quantity = line.on_change_with_quantity() + line.unit = line.on_change_with_unit() + return line + + @fields.depends('rental_line') + def on_change_with_product(self, name=None): + if self.rental_line and self.rental_line.product: + return self.rental_line.product.id + + @fields.depends('rental_line') + def on_change_with_quantity(self, name=None): + if self.rental_line: + return self.rental_line.quantity + + @fields.depends('rental_line') + def on_change_with_unit(self, name=None): + if self.rental_line and self.rental_line.unit: + return self.rental_line.unit.id + + def get_moves(self, type, date=None): + if self.rental_line.product.type == 'service': + return [] + + move = self.rental_line.get_move(type) + move.unit = self.unit + move.effective_date = date + return [move] + + +class RentalPickup(Wizard): + __name__ = 'sale.rental.pickup' + + start = StateTransition() + show = StateView('sale.rental.pickup.show', + 'sale_rental.sale_rental_pickup_show_view_form', [ + Button("Cancel", 'end', 'tryton-cancel'), + Button("Pickup", 'pickup', 'tryton-ok', default=True), + ]) + pickup = StateTransition() + + @property + def rental_lines(self): + for line in self.record.lines: + if line.rental_state == 'confirmed': + yield line + + def transition_start(self): + if any(self.rental_lines): + return 'show' + else: + self.record.try_picked_up() + return 'end' + + def default_show(self, fields): + pool = Pool() + Line = pool.get('sale.rental.pickup.show.line') + + defaults = {} + if 'start' in fields: + defaults['start'] = min( + map(partial(to_datetime, company=self.record.company), + (l.planned_start or l.planned_start_day + for l in self.rental_lines)), + default=dt.datetime.now()) + if 'lines' in fields: + defaults['lines'] = lines = [] + for rental_line in self.rental_lines: + lines.append(Line.get(rental_line)._changed_values()) + return defaults + + def transition_pickup(self): + pool = Pool() + Lang = pool.get('ir.lang') + Line = pool.get('sale.rental.line') + Move = pool.get('stock.move') + + lang = Lang.get() + rental_lines = [] + moves_to_delete = [] + outgoing_moves, incoming_moves = [], [] + for line in self.show.lines: + rental_line = line.rental_line + if rental_line in rental_lines: + raise ValidationError(gettext( + 'sale_rental.msg_rental_pickup_once', + line=rental_line.rec_name)) + rental_lines.append(rental_line) + quantity = line.quantity_picked + unit = rental_line.unit + if not quantity: + continue + if not (0 <= quantity <= rental_line.quantity): + raise ValidationError(gettext( + 'sale_rental.msg_rental_pickup_quantity', + line=rental_line.rec_name, + quantity=lang.format_number_symbol( + rental_line.quantity, unit), + picked=lang.format_number_symbol(quantity, unit))) + + remaining = unit.round(rental_line.quantity - quantity) + if remaining: + with Transaction().set_context(_sale_rental_line_split=True): + Line.copy([rental_line], default={ + 'quantity': remaining, + 'outgoing_moves': None, + 'incoming_moves': None, + }) + + rental_line.actual_start = self.show.start + rental_line.quantity = quantity + + moves_to_delete.extend(rental_line.outgoing_moves) + rental_line.outgoing_moves = line.get_moves( + 'out', date=self.show.start.date()) + outgoing_moves.extend(rental_line.outgoing_moves) + moves_to_delete.extend(rental_line.incoming_moves) + rental_line.incoming_moves = line.get_moves('in') + incoming_moves.extend(rental_line.incoming_moves) + + Move.save(outgoing_moves + incoming_moves) + Line.save(rental_lines) + Move.delete(moves_to_delete) + self.model.set_moves([self.record]) + Move.do(outgoing_moves) + return 'end' + + +class RentalPickupShow(ModelView): + __name__ = 'sale.rental.pickup.show' + + start = fields.DateTime("Start", format=_datetime_format, required=True) + lines = fields.One2Many('sale.rental.pickup.show.line', 'parent', "Lines") + + +class RentalPickupShowLine(_RentalShowLine): + __name__ = 'sale.rental.pickup.show.line' + + parent = fields.Many2One( + 'sale.rental.pickup.show', "Parent", readonly=True) + + quantity_picked = fields.Float( + "Quantity Picked", digits='unit', required=True, + domain=[ + ('quantity_picked', '<=', Eval('quantity')), + ('quantity_picked', '>=', 0), + ]) + + @classmethod + def get(cls, rental_line): + line = super().get(rental_line) + line.quantity_picked = 0 + return line + + def get_moves(self, type, date=None): + moves = super().get_moves(type, date=date) + for move in moves: + move.quantity = self.quantity_picked + return moves + + +class RentalReturn(Wizard): + __name__ = 'sale.rental.return' + + start = StateTransition() + show = StateView('sale.rental.return.show', + 'sale_rental.sale_rental_return_show_view_form', [ + Button("Cancel", 'end', 'tryton-cancel'), + Button("Return", 'return_', 'tryton-ok', default=True), + ]) + return_ = StateTransition() + + @property + def rental_lines(self): + for line in self.record.lines: + if line.rental_state == 'picked up': + yield line + + def transition_start(self): + if any(self.rental_lines): + return 'show' + else: + self.record.try_done() + return 'end' + + def default_show(self, fields): + pool = Pool() + Line = pool.get('sale.rental.return.show.line') + + defaults = {} + if 'end' in fields: + defaults['end'] = max( + map(partial( + to_datetime, company=self.record.company, + time=_time_max), + (l.planned_end or l.planned_end_day + for l in self.rental_lines)), + default=dt.datetime.now()) + if 'lines' in fields: + defaults['lines'] = lines = [] + for rental_line in self.rental_lines: + lines.append(Line.get(rental_line)._changed_values()) + return defaults + + def transition_return_(self): + pool = Pool() + Lang = pool.get('ir.lang') + Line = pool.get('sale.rental.line') + Move = pool.get('stock.move') + + lang = Lang.get() + rental_lines = [] + moves_to_delete = [] + incoming_moves = [] + for line in self.show.lines: + rental_line = line.rental_line + if rental_line in rental_lines: + raise ValidationError(gettext( + 'sale_rental.msg_rental_return_once', + line=rental_line.rec_name)) + rental_lines.append(rental_line) + quantity = line.quantity_returned + unit = rental_line.unit + if not quantity: + continue + if not (0 <= quantity <= rental_line.quantity): + raise ValidationError(gettext( + 'sale_rental.msg_rental_return_quantity', + line=rental_line.rec_name, + quantity=lang.format_number_symbol( + rental_line.quantity, unit), + returned=lang.format_number_symbol(quantity, unit))) + + remaining = unit.round(rental_line.quantity - quantity) + if remaining: + with Transaction().set_context(_sale_rental_line_split=True): + Line.copy([rental_line], default={ + 'quantity': remaining, + 'actual_start': rental_line.actual_start, + 'incoming_moves': None, + }) + + rental_line.actual_end = self.show.end + rental_line.quantity = quantity + + moves_to_delete.extend(rental_line.incoming_moves) + rental_line.incoming_moves = line.get_moves( + 'in', date=self.show.end.date()) + incoming_moves.extend(rental_line.incoming_moves) + + Move.save(incoming_moves) + Line.save(rental_lines) + Move.delete(moves_to_delete) + self.model.set_moves([self.record]) + Move.do(incoming_moves) + return 'end' + + +class RentalReturnShow(ModelView): + __name__ = 'sale.rental.return.show' + + end = fields.DateTime("End", format=_datetime_format, required=True) + lines = fields.One2Many('sale.rental.return.show.line', 'parent', "Lines") + + +class RentalReturnShowLine(_RentalShowLine): + __name__ = 'sale.rental.return.show.line' + + parent = fields.Many2One( + 'sale.rental.return.show', "Parent", readonly=True) + + quantity_returned = fields.Float( + "Quantity Returned", digits='unit', required=True, + domain=[ + ('quantity_returned', '<=', Eval('quantity')), + ('quantity_returned', '>=', 0), + ]) + + @classmethod + def get(cls, rental_line): + line = super().get(rental_line) + line.quantity_returned = 0 + return line + + def get_moves(self, type, date=None): + moves = super().get_moves(type, date=date) + for move in moves: + move.quantity = self.quantity_returned + return moves diff --git a/modules/sale_rental/sale.xml b/modules/sale_rental/sale.xml new file mode 100644 index 0000000000..4ecbf54418 --- /dev/null +++ b/modules/sale_rental/sale.xml @@ -0,0 +1,260 @@ + + + + + + Rental + + + + + + + + + + + + Rental + + + + + sale.configuration + + sale_configuration_form + + + + tryton-sale-rental + icons/tryton-sale-rental.svg + + + + sale.rental + tree + sale_rental_list + + + + sale.rental + form + sale_rental_form + + + + Rentals + sale.rental + + + + + + + + + + + + + Draft + + + + + + + Quotation + + + + + + + Confirmed + + + + + + + Picked up + + + + + + + All + + + + + + + + + + + + Rentals + sale.rental + + + + + form_relate + party.party,-1 + + + + + User in companies + sale.rental + + + + + + + + + sale.rental + + + + + + + sale.rental + + + + + + + + + sale.rental + draft + Draft + + + + sale.rental + quote + Quote + + + + sale.rental + confirm + Confirm + + + + sale.rental + pickup + Pickup + + + + + + + + + + + + sale.rental + return_ + Return + + + + + + + + + + + + sale.rental + invoice + Invoice + + + + sale.rental + cancel + Cancel + + + + sale.rental.line + form + sale_rental_line_form + + + + sale.rental.line + tree + + sale_rental_line_list + + + + sale.rental.line + tree + + sale_rental_line_list_sequence + + + + Pickup Rental + sale.rental.pickup + sale.rental + + + + sale.rental.pickup.show + form + sale_rental_pickup_show_form + + + + sale.rental.pickup.show.line + tree + sale_rental_pickup_show_line_list + + + + Return Rental + sale.rental.return + sale.rental + + + + sale.rental.return.show + form + sale_rental_return_show_form + + + + sale.rental.return.show.line + tree + sale_rental_return_show_line_list + + + diff --git a/modules/sale_rental/setup.py b/modules/sale_rental/setup.py new file mode 100755 index 0000000000..2d5e807f9d --- /dev/null +++ b/modules/sale_rental/setup.py @@ -0,0 +1,137 @@ +#!/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 find_packages, setup + + +def read(fname): + content = io.open( + os.path.join(os.path.dirname(__file__), fname), + 'r', encoding='utf-8').read() + content = re.sub( + r'(?m)^\.\. toctree::\r?\n((^$|^\s.*$)\r?\n)*', '', content) + return content + + +def get_require_version(name): + 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_sale_rental' + +if minor_version % 2: + download_url = '' +else: + download_url = 'http://downloads.tryton.org/%s.%s/' % ( + major_version, minor_version) + +requires = [] +for dep in info.get('depends', []): + if not re.match(r'(ir|res)(\W|$)', dep): + requires.append(get_require_version('trytond_%s' % dep)) +requires.append(get_require_version('trytond')) + +tests_require = [ + get_require_version('proteus'), + get_require_version('trytond_account_asset'), + ] + +setup(name=name, + version=version, + description='Tryton module for sale rental', + long_description=read('README.rst'), + author='Tryton', + author_email='foundation@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-sale-rental'), + "Forum": 'https://www.tryton.org/forum', + "Source Code": 'https://code.tryton.org/tryton', + }, + keywords='tryton sale rental', + package_dir={'trytond.modules.sale_rental': '.'}, + packages=( + ['trytond.modules.sale_rental'] + + ['trytond.modules.sale_rental.%s' % p + for p in find_packages()] + ), + package_data={ + 'trytond.modules.sale_rental': (info.get('xml', []) + + ['tryton.cfg', 'view/*.xml', 'locale/*.po', '*.fodt', + 'icons/*.svg', 'tests/*.rst', 'tests/*.json']), + }, + classifiers=[ + 'Development Status :: 5 - Production/Stable', + 'Environment :: Plugins', + 'Framework :: Tryton', + 'Intended Audience :: Developers', + 'Intended Audience :: Financial and Insurance Industry', + 'Intended Audience :: Legal Industry', + 'License :: OSI Approved :: ' + 'GNU General Public License v3 or later (GPLv3+)', + 'Natural Language :: Bulgarian', + 'Natural Language :: Catalan', + 'Natural Language :: Chinese (Simplified)', + 'Natural Language :: Czech', + 'Natural Language :: Dutch', + 'Natural Language :: English', + 'Natural Language :: Finnish', + 'Natural Language :: French', + 'Natural Language :: German', + 'Natural Language :: Hungarian', + 'Natural Language :: Indonesian', + 'Natural Language :: Italian', + 'Natural Language :: Persian', + 'Natural Language :: Polish', + 'Natural Language :: Portuguese (Brazilian)', + 'Natural Language :: Romanian', + 'Natural Language :: Russian', + 'Natural Language :: Slovenian', + 'Natural Language :: Spanish', + 'Natural Language :: Turkish', + 'Natural Language :: Ukrainian', + 'Operating System :: OS Independent', + 'Programming Language :: Python :: 3', + 'Programming Language :: Python :: 3.9', + 'Programming Language :: Python :: 3.10', + 'Programming Language :: Python :: 3.11', + 'Programming Language :: Python :: 3.12', + 'Programming Language :: Python :: 3.13', + 'Programming Language :: Python :: Implementation :: CPython', + 'Topic :: Office/Business', + 'Topic :: Office/Business :: Financial :: Accounting', + ], + license='GPL-3', + python_requires='>=3.9', + install_requires=requires, + extras_require={ + 'test': tests_require, + }, + zip_safe=False, + entry_points=""" + [trytond.modules] + sale_rental = trytond.modules.sale_rental + """, # noqa: E501 + ) diff --git a/modules/sale_rental/stock.py b/modules/sale_rental/stock.py new file mode 100644 index 0000000000..9f4f64833c --- /dev/null +++ b/modules/sale_rental/stock.py @@ -0,0 +1,131 @@ +# This file is part of Tryton. The COPYRIGHT file at the top level of +# this repository contains the full copyright notices and license terms. + +from trytond.i18n import gettext +from trytond.model import ModelView, Workflow, fields +from trytond.modules.stock.exceptions import MoveValidationError +from trytond.pool import Pool, PoolMeta +from trytond.pyson import Eval + + +class Location(metaclass=PoolMeta): + __name__ = 'stock.location' + + rental_location = fields.Many2One( + 'stock.location', "Rental", + states={ + 'invisible': Eval('type') != 'warehouse', + 'required': Eval('type') == 'warehouse', + }, + domain=[ + ('type', '=', 'rental'), + ], + help="The destination location for stock rent.") + rental_picking_location = fields.Many2One( + 'stock.location', "Rental Picking", + states={ + 'invisible': Eval('type') != 'warehouse', + }, + domain=[ + ('type', '=', 'storage'), + ('parent', 'child_of', [Eval('id', -1)]), + ], + help="Where the rented assets are picked from.\n" + "Leave empty to use the warehouse storage location.") + rental_return_location = fields.Many2One( + 'stock.location', "Rental Return", + states={ + 'invisible': Eval('type') != 'warehouse', + }, + domain=[ + ('type', '=', 'storage'), + ('parent', 'child_of', [Eval('id', -1)]), + ], + help="Where the rented assets are returned to.\n" + "Leave empty to use the warehouse storage location.") + + +class Move(metaclass=PoolMeta): + __name__ = 'stock.move' + + sale_rental_lines_outgoing = fields.Many2Many( + 'sale.rental.line-outgoing-stock.move', 'move', 'line', + "Outgoing Rental Lines", readonly=True, + states={ + 'invisible': ~Eval('sale_rental_lines_outgoing'), + }) + sale_rental_lines_incoming = fields.Many2Many( + 'sale.rental.line-incoming-stock.move', 'move', 'line', + "Incoming Rental Lines", readonly=True, + states={ + 'invisible': ~Eval('sale_rental_lines_incoming'), + }) + + @classmethod + def _get_origin(cls): + return super()._get_origin() + ['sale.rental'] + + @classmethod + def view_attributes(cls): + return super().view_attributes() + [ + ('//page[@id="sale_rental"]', 'states', { + 'invisible': ( + ~Eval('sale_rental_lines_outgoing') + & ~Eval('sale_rental_lines_incoming')), + }), + ] + + @classmethod + @ModelView.button + @Workflow.transition('done') + def do(cls, moves): + pool = Pool() + SaleRental = pool.get('sale.rental') + super().do(moves) + sale_rentals = { + m.origin for m in moves if isinstance(m.origin, SaleRental)} + if sale_rentals: + sale_rentals = SaleRental.browse(list(sale_rentals)) + SaleRental.try_picked_up(sale_rentals) + SaleRental.try_done(sale_rentals) + + @classmethod + def validate_fields(cls, moves, field_names): + super().validate_fields(moves, field_names) + cls.check_rental_quantities(moves, field_names) + + @classmethod + def check_rental_quantities(cls, moves, field_names): + pool = Pool() + Lang = pool.get('ir.lang') + SaleRental = pool.get('sale.rental') + SaleRentalLine = pool.get('sale.rental.line') + UoM = pool.get('product.uom') + + if field_names and not (field_names & { + 'state', 'origin', 'quantity', 'unit'}): + return + + sale_rental_lines = set() + for move in moves: + if move.state != 'done' or not isinstance(move.origin, SaleRental): + continue + for lines in filter(None, [ + move.sale_rental_lines_outgoing, + move.sale_rental_lines_incoming]): + sale_rental_lines.update(lines) + quantity = move.unit.round(sum( + UoM.compute_qty( + l.unit, l.quantity, move.unit, round=False) + for l in lines)) + if quantity != move.quantity: + lang = Lang.get() + raise MoveValidationError(gettext( + 'sale_rental.msg_stock_move_rental_lines_quantity', + move=move.rec_name, + quantity=lang.format_number_symbol( + quantity, move.unit))) + if sale_rental_lines: + sale_rental_lines = SaleRentalLine.browse(list(sale_rental_lines)) + SaleRentalLine._validate( + sale_rental_lines, ['actual_start', 'actual_end']) diff --git a/modules/sale_rental/stock.xml b/modules/sale_rental/stock.xml new file mode 100644 index 0000000000..d98180a27b --- /dev/null +++ b/modules/sale_rental/stock.xml @@ -0,0 +1,43 @@ + + + + + + stock.location + + stock_location_form + + + + stock.move + + stock_move_form + + + + Stock Moves + stock.move + + + + form_relate + sale.rental,-1 + + + + + + Rental + RENT + rental + + + + + + + diff --git a/modules/sale_rental/tests/__init__.py b/modules/sale_rental/tests/__init__.py new file mode 100644 index 0000000000..4effdfa4a2 --- /dev/null +++ b/modules/sale_rental/tests/__init__.py @@ -0,0 +1,2 @@ +# This file is part of Tryton. The COPYRIGHT file at the top level of +# this repository contains the full copyright notices and license terms. diff --git a/modules/sale_rental/tests/scenario_sale_rental.rst b/modules/sale_rental/tests/scenario_sale_rental.rst new file mode 100644 index 0000000000..69852eb880 --- /dev/null +++ b/modules/sale_rental/tests/scenario_sale_rental.rst @@ -0,0 +1,238 @@ +==================== +Sale Rental Scenario +==================== + +Imports:: + + >>> import datetime as dt + >>> from decimal import Decimal + + >>> from proteus import Model + >>> from trytond.modules.account.tests.tools import ( + ... create_chart, create_tax, get_accounts) + >>> from trytond.modules.company.tests.tools import create_company + >>> from trytond.tests.tools import activate_modules, assertEqual + + >>> today = dt.date.today() - dt.timedelta(days=20) + >>> now = dt.datetime.combine(today, dt.time(8)) + +Activate modules:: + + >>> config = activate_modules('sale_rental', create_company, create_chart) + + >>> Invoice = Model.get('account.invoice') + >>> Party = Model.get('party.party') + >>> ProductCategory = Model.get('product.category') + >>> ProductTemplate = Model.get('product.template') + >>> ProductUom = Model.get('product.uom') + >>> Rental = Model.get('sale.rental') + +Get accounts:: + + >>> accounts = get_accounts() + +Create tax:: + + >>> tax = create_tax(Decimal('.10')) + >>> tax.save() + +Create account category:: + + >>> account_category = ProductCategory(name="Account") + >>> account_category.accounting = True + >>> account_category.account_rental = accounts['revenue'] + >>> account_category.customer_rental_taxes.append(tax) + >>> account_category.save() + +Create a rentable asset:: + + >>> unit, = ProductUom.find([('name', '=', "Unit")]) + >>> day, = ProductUom.find([('name', '=', "Day")]) + >>> hour, = ProductUom.find([('name', '=', "Hour")]) + + >>> template = ProductTemplate() + >>> template.name = "Machine" + >>> template.type = 'assets' + >>> template.default_uom = unit + >>> template.account_category = account_category + >>> template.rentable = True + >>> template.rental_per_day = True + >>> template.rental_unit = day + >>> rental_price = template.rental_prices.new() + >>> rental_price.duration = dt.timedelta(days=7) + >>> rental_price.price = Decimal('840.0000') + >>> rental_price = template.rental_prices.new() + >>> rental_price.duration = dt.timedelta(days=1) + >>> rental_price.price = Decimal('180.0000') + >>> template.save() + >>> machine, = template.products + +Create a rentable service:: + + >>> template = ProductTemplate() + >>> template.name = "Service" + >>> template.type = 'service' + >>> template.default_uom = unit + >>> template.account_category = account_category + >>> template.rentable = True + >>> template.rental_unit = hour + >>> rental_price = template.rental_prices.new() + >>> rental_price.duration = dt.timedelta(hours=1) + >>> rental_price.price = Decimal('20.0000') + >>> template.save() + >>> service, = template.products + +Create customer:: + + >>> customer = Party(name="Customer") + >>> customer.save() + +Rent 5 assets and 1 service:: + + >>> rental = Rental() + >>> rental.party = customer + >>> line = rental.lines.new() + >>> line.product = machine + >>> line.per_day + True + >>> line.quantity = 5 + >>> line.planned_start_day = today + >>> line.planned_end_day = today + dt.timedelta(days=10) + >>> line.unit_price + Decimal('120.0000') + >>> assertEqual(line.unit_price_unit, day) + >>> line.planned_amount + Decimal('6000.00') + >>> line.amount + Decimal('6000.00') + >>> rental.untaxed_amount + Decimal('6000.00') + >>> rental.tax_amount + Decimal('600.00') + >>> rental.total_amount + Decimal('6600.00') + + >>> line = rental.lines.new() + >>> line.product = service + >>> line.quantity = 1 + >>> line.planned_start = now + >>> line.planned_end = now + dt.timedelta(hours=5) + >>> line.unit_price + Decimal('20.0000') + >>> assertEqual(line.unit_price_unit, hour) + + >>> rental.save() + >>> rental.untaxed_amount + Decimal('6100.00') + >>> rental.tax_amount + Decimal('610.00') + >>> rental.total_amount + Decimal('6710.00') + +Quote the rental:: + + >>> rental.click('quote') + >>> rental.state + 'quotation' + >>> line_machine, line_service = rental.lines + >>> outgoing_move, = line_machine.outgoing_moves + >>> outgoing_move.state + 'draft' + >>> outgoing_move.quantity + 5.0 + >>> assertEqual(outgoing_move.planned_date, line_machine.start) + >>> incoming_move, = line_machine.incoming_moves + >>> outgoing_move.state + 'draft' + >>> outgoing_move.quantity + 5.0 + >>> line_service.outgoing_moves + [] + >>> line_service.incoming_moves + [] + +Go back to draft:: + + >>> rental.click('draft') + >>> rental.state + 'draft' + +Confirm the rental:: + + >>> rental.click('quote') + >>> rental.click('confirm') + >>> rental.state + 'confirmed' + +Pickup some:: + + >>> pickup = rental.click('pickup') + >>> assertEqual(pickup.form.start, rental.start) + >>> line_machine, line_service = pickup.form.lines + >>> line_machine.quantity_picked = 2 + >>> line_service.quantity_picked = 1 + >>> pickup.execute('pickup') + + >>> len(rental.lines) + 3 + + >>> late_line, = [l for l in rental.lines if l.rental_state == 'confirmed'] + >>> late_line.quantity + 3.0 + +Pickup remaining later:: + + >>> pickup = rental.click('pickup') + >>> pickup.form.start = now + dt.timedelta(days=1) + >>> line, = pickup.form.lines + >>> line.quantity_picked = 3 + >>> pickup.execute('pickup') + + >>> rental.state + 'picked up' + +Partially return earlier:: + + >>> return_ = rental.click('return_') + >>> return_.form.end = rental.end - dt.timedelta(days=1) + >>> line = return_.form.lines[0] + >>> line.quantity_returned = 1 + >>> return_.execute('return_') + + >>> len(rental.lines) + 4 + +Partially invoice:: + + >>> rental.has_lines_to_invoice + True + >>> rental.click('invoice') + >>> rental.has_lines_to_invoice + False + + >>> invoice, = Invoice.find([]) + >>> len(invoice.lines) + 1 + >>> invoice.total_amount + Decimal('1188.00') + +Return remaining:: + + >>> return_ = rental.click('return_') + >>> assertEqual(return_.form.end, rental.end) + >>> len(return_.form.lines) + 3 + >>> for line in return_.form.lines: + ... line.quantity_returned = line.quantity + >>> return_.execute('return_') + + >>> rental.state + 'done' + >>> rental.has_lines_to_invoice + False + + >>> invoices = Invoice.find([]) + >>> len(invoices) + 2 + >>> sum(i.total_amount for i in invoices) + Decimal('11879.64') diff --git a/modules/sale_rental/tests/scenario_sale_rental_copy_rental_prices.rst b/modules/sale_rental/tests/scenario_sale_rental_copy_rental_prices.rst new file mode 100644 index 0000000000..9c889683ce --- /dev/null +++ b/modules/sale_rental/tests/scenario_sale_rental_copy_rental_prices.rst @@ -0,0 +1,50 @@ +================================ +Sale Copy Rental Prices Scenario +================================ + +Imports:: + + >>> import datetime as dt + >>> from decimal import Decimal + + >>> from proteus import Model + >>> from trytond.modules.company.tests.tools import create_company + >>> from trytond.tests.tools import activate_modules, assertEqual + +Activate modules:: + + >>> config = activate_modules('sale_rental', create_company) + + >>> ProductTemplate = Model.get('product.template') + >>> UoM = Model.get('product.uom') + +Create a rentable asset:: + + >>> unit, = UoM.find([('name', '=', "Unit")]) + >>> day, = UoM.find([('name', '=', "Day")]) + + >>> template = ProductTemplate() + >>> template.name = "Product" + >>> template.type = 'assets' + >>> template.default_uom = unit + >>> template.rentable = True + >>> template.rental_unit = day + >>> rental_price = template.rental_prices.new() + >>> rental_price.duration = dt.timedelta(days=1) + >>> rental_price.price = Decimal('10.0000') + >>> template.save() + >>> product, = template.products + >>> rental_price = product.rental_prices.new() + >>> rental_price.duration = dt.timedelta(days=7) + >>> rental_price.price = Decimal('50.0000') + >>> assertEqual(rental_price.template, template) + >>> product.save() + +Rental prices are copied when copying the template:: + + >>> template_copy, = template.duplicate() + >>> product_copy, = template_copy.products + >>> len(template_copy.rental_prices) + 2 + >>> len(product_copy.rental_prices) + 1 diff --git a/modules/sale_rental/tests/test_module.py b/modules/sale_rental/tests/test_module.py new file mode 100644 index 0000000000..17529e7dc8 --- /dev/null +++ b/modules/sale_rental/tests/test_module.py @@ -0,0 +1,16 @@ +# 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.modules.company.tests import ( + CompanyTestMixin, PartyCompanyCheckEraseMixin) +from trytond.tests.test_tryton import ModuleTestCase + + +class SaleRentalTestCase( + PartyCompanyCheckEraseMixin, CompanyTestMixin, ModuleTestCase): + "Test Sale Rental module" + module = 'sale_rental' + extras = ['account_asset'] + + +del ModuleTestCase diff --git a/modules/sale_rental/tests/test_scenario.py b/modules/sale_rental/tests/test_scenario.py new file mode 100644 index 0000000000..dc1d23e7e5 --- /dev/null +++ b/modules/sale_rental/tests/test_scenario.py @@ -0,0 +1,8 @@ +# 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.tests.test_tryton import load_doc_tests + + +def load_tests(*args, **kwargs): + return load_doc_tests(__name__, __file__, *args, **kwargs) diff --git a/modules/sale_rental/tox.ini b/modules/sale_rental/tox.ini new file mode 100644 index 0000000000..53e3ce4cf0 --- /dev/null +++ b/modules/sale_rental/tox.ini @@ -0,0 +1,21 @@ +[tox] +envlist = {py39,py310,py311,py312,py313}-{sqlite,postgresql} + +[testenv] +usedevelop = true +extras = test +commands = + coverage run --omit=*/tests/* -m xmlrunner discover -s tests {posargs} +commands_post = + coverage report + coverage xml +deps = + coverage + unittest-xml-reporting + postgresql: psycopg2 >= 2.7.0 +passenv = * +setenv = + sqlite: TRYTOND_DATABASE_URI={env:SQLITE_URI:sqlite://} + postgresql: TRYTOND_DATABASE_URI={env:POSTGRESQL_URI:postgresql://} + sqlite: DB_NAME={env:DB_NAME::memory:} + postgresql: DB_NAME={env:DB_NAME:test} diff --git a/modules/sale_rental/tryton.cfg b/modules/sale_rental/tryton.cfg new file mode 100644 index 0000000000..8533ab1a88 --- /dev/null +++ b/modules/sale_rental/tryton.cfg @@ -0,0 +1,55 @@ +[tryton] +version=7.7.0 +depends: + account + account_product + account_invoice + company + currency + ir + party + product + sale + stock +extras_depend: + account_asset +xml: + party.xml + product.xml + account.xml + sale.xml + stock.xml + message.xml + +[register] +model: + product.Category + product.CategoryAccount + product.CategoryCustomerRentalTax + product.Template + product.Product + product.RentalPrice + sale.Configuration + sale.ConfigurationSequence + sale.Rental + sale.RentalLine + sale.RentalLine_Tax + sale.RentalLine_Outgoing_Move + sale.RentalLine_Incoming_Move + sale.RentalPickupShow + sale.RentalPickupShowLine + sale.RentalReturnShow + sale.RentalReturnShowLine + stock.Location + stock.Move + account.Invoice + account.InvoiceLine +wizard: + sale.RentalPickup + sale.RentalReturn + party.Replace + party.Erase + +[register account_asset] +model: + account.InvoiceLine_Asset diff --git a/modules/sale_rental/view/party_form.xml b/modules/sale_rental/view/party_form.xml new file mode 100644 index 0000000000..7b4150a7b3 --- /dev/null +++ b/modules/sale_rental/view/party_form.xml @@ -0,0 +1,8 @@ + + + + + + + diff --git a/modules/sale_rental/view/product_category_form.xml b/modules/sale_rental/view/product_category_form.xml new file mode 100644 index 0000000000..e40c65bf9c --- /dev/null +++ b/modules/sale_rental/view/product_category_form.xml @@ -0,0 +1,14 @@ + + + + + + + + + + diff --git a/modules/sale_rental/view/product_product_list_sale_rental_line.xml b/modules/sale_rental/view/product_product_list_sale_rental_line.xml new file mode 100644 index 0000000000..6a0d0da6e3 --- /dev/null +++ b/modules/sale_rental/view/product_product_list_sale_rental_line.xml @@ -0,0 +1,10 @@ + + + + + + + + + diff --git a/modules/sale_rental/view/product_rental_price_form.xml b/modules/sale_rental/view/product_rental_price_form.xml new file mode 100644 index 0000000000..90d0d10780 --- /dev/null +++ b/modules/sale_rental/view/product_rental_price_form.xml @@ -0,0 +1,20 @@ + + +
+