commit ee032dc66aa23b3407f9d56a9cc3b1d2a31cbc59 Author: Cédric Krier Date: Mon Oct 11 23:55:41 2021 +0200 Add sale_point module issue8737 review21391002 diff --git a/.drone.yml b/.drone.yml new file mode 100644 index 0000000000..2049d30a49 --- /dev/null +++ b/.drone.yml @@ -0,0 +1,68 @@ +clone: + hg: + image: plugins/hg + environment: + - HG_SHARE_POOL=/root/.cache/hg + volumes: + - cache:/root/.cache + +pipeline: + tox: + image: ${IMAGE} + environment: + - CFLAGS=-O0 + - DB_CACHE=/cache + - TOX_TESTENV_PASSENV=CFLAGS DB_CACHE CI_BUILD_NUMBER CI_JOB_NUMBER CI_JOB_ID + - POSTGRESQL_URI=postgresql://postgres@postgresql:5432/ + commands: + - echo "[extensions]" >> /root/.hgrc + - echo "hgext.share =" >> /root/.hgrc + - echo "[share]" >> /root/.hgrc + - echo "pool = /root/.cache/hg" >> /root/.hgrc + - pip install tox + - tox -e "${TOXENV}-${DATABASE}" + volumes: + - cache:/root/.cache + check_dist: + image: ${IMAGE} + commands: + - pip install twine + - python setup.py sdist + - twine check dist/* + +services: + postgresql: + image: postgres + environment: + - POSTGRES_HOST_AUTH_METHOD=trust + command: "-c fsync=off -c synchronous_commit=off -c full_page_writes=off" + when: + matrix: + DATABASE: postgresql + +matrix: + include: + - IMAGE: python:3.6 + TOXENV: py36 + DATABASE: sqlite + - IMAGE: python:3.6 + TOXENV: py36 + DATABASE: postgresql + - IMAGE: python:3.7 + TOXENV: py37 + DATABASE: sqlite + - IMAGE: python:3.7 + TOXENV: py37 + DATABASE: postgresql + - IMAGE: python:3.8 + TOXENV: py38 + DATABASE: sqlite + - IMAGE: python:3.8 + TOXENV: py38 + DATABASE: postgresql + - IMAGE: python:3.9 + TOXENV: py39 + DATABASE: sqlite + - IMAGE: python:3.9 + TOXENV: py39 + DATABASE: postgresql diff --git a/.flake8 b/.flake8 new file mode 100644 index 0000000000..bb03d08a82 --- /dev/null +++ b/.flake8 @@ -0,0 +1,2 @@ +[flake8] +ignore=E123,E124,E126,E128,W503 diff --git a/COPYRIGHT b/COPYRIGHT new file mode 100644 index 0000000000..52f75fe00c --- /dev/null +++ b/COPYRIGHT @@ -0,0 +1,15 @@ +Copyright (C) 2015-2020 Cédric Krier. +Copyright (C) 2015-2020 B2CK SPRL. + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see . diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000000..94a9ed024d --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/MANIFEST.in b/MANIFEST.in new file mode 100644 index 0000000000..e88b2348a3 --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1,5 @@ +include CHANGELOG +include COPYRIGHT +include LICENSE +include README.rst +include doc/* diff --git a/README.rst b/README.rst new file mode 120000 index 0000000000..176d9c2695 --- /dev/null +++ b/README.rst @@ -0,0 +1 @@ +doc/index.rst \ No newline at end of file diff --git a/__init__.py b/__init__.py new file mode 100644 index 0000000000..fbdafb4efd --- /dev/null +++ b/__init__.py @@ -0,0 +1,31 @@ +# This file is part of Tryton. The COPYRIGHT file at the top level of +# this repository contains the full copyright notices and license terms. + +from trytond.pool import Pool +from . import sale +from . import product +from . import stock +from . import account + + +def register(): + Pool.register( + sale.POS, + sale.POSSale, + sale.POSSaleLine, + sale.POSCashSession, + sale.POSCashSessionRelation, + sale.POSPayment, + sale.POSPaymentMethod, + sale.POSCashTransfer, + sale.POSCashTransferType, + product.Template, + product.Product, + product.GrossPrice, + stock.Move, + account.Move, + account.MoveLine, + module='sale_point', type_='model') + Pool.register( + sale.POSPay, + module='sale_point', type_='wizard') diff --git a/account.py b/account.py new file mode 100644 index 0000000000..128bbcda64 --- /dev/null +++ b/account.py @@ -0,0 +1,21 @@ +# This file is part of Tryton. The COPYRIGHT file at the top level of +# this repository contains the full copyright notices and license terms. +from trytond.pool import PoolMeta + + +class Move(metaclass=PoolMeta): + __name__ = 'account.move' + + @classmethod + def _get_origin(cls): + return super()._get_origin() + [ + 'sale.point.sale', 'sale.point.cash.transfer'] + + +class MoveLine(metaclass=PoolMeta): + __name__ = 'account.move.line' + + @classmethod + def _get_origin(cls): + return super()._get_origin() + [ + 'sale.point.sale.line', 'sale.point.payment'] diff --git a/doc/conf.py b/doc/conf.py new file mode 100644 index 0000000000..8513b72dd2 --- /dev/null +++ b/doc/conf.py @@ -0,0 +1,61 @@ +# This file is part of Tryton. The COPYRIGHT file at the top level of +# this repository contains the full copyright notices and license terms. + +modules_url = 'https://docs.tryton.org/projects/modules-{module}/en/{series}/' +trytond_url = 'https://docs.tryton.org/projects/server/en/{series}/' + + +def get_info(): + import configparser + import os + import subprocess + import sys + + module_dir = os.path.dirname(os.path.dirname(__file__)) + + config = configparser.ConfigParser() + config.read_file(open(os.path.join(module_dir, 'tryton.cfg'))) + info = dict(config.items('tryton')) + + result = subprocess.run( + [sys.executable, 'setup.py', '--name'], + stdout=subprocess.PIPE, check=True, cwd=module_dir) + info['name'] = result.stdout.decode('utf-8').strip() + + result = subprocess.run( + [sys.executable, 'setup.py', '--version'], + stdout=subprocess.PIPE, check=True, cwd=module_dir) + version = result.stdout.decode('utf-8').strip() + if 'dev' in version: + info['series'] = 'latest' + else: + info['series'] = '.'.join(version.split('.', 2)[:2]) + + for key in {'depends', 'extras_depend'}: + info[key] = info.get(key, '').strip().splitlines() + info['modules'] = set(info['depends'] + info['extras_depend']) + info['modules'] -= {'ir', 'res'} + + return info + + +info = get_info() + +master_doc = 'index' +project = info['name'] +release = version = info['series'] +default_role = 'ref' +highlight_language = 'none' +extensions = [ + 'sphinx.ext.intersphinx', + ] +intersphinx_mapping = { + 'trytond': (trytond_url.format(series=version), None), + } +intersphinx_mapping.update({ + m: (modules_url.format( + module=m.replace('_', '-'), series=version), None) + for m in info['modules'] + }) + +del get_info, info, modules_url, trytond_url diff --git a/doc/design.rst b/doc/design.rst new file mode 100644 index 0000000000..53034970cf --- /dev/null +++ b/doc/design.rst @@ -0,0 +1,130 @@ +****** +Design +****** + +The *Sale Point Module* introduces the concepts that are required to manage +retail sales. + +.. _model-sale.point: + +Point of Sale +============= + +The *Point of Sale* concept is used to configure the point where sales happen. + +.. seealso:: + + The Point of Sale configuration is found by opening the main menu item: + + |Sales --> Configuration --> Points of Sale|__ + + .. |Sales --> Configuration --> Points of Sale| replace:: :menuselection:`Sales --> Configuration --> Points of Sale` + __ https://demo.tryton.org/model/sale.point + +.. _model-sale.point.sale: + +Sale +==== + +The *Sale* concept registers what quantity of products are sold or returned and +how the customer paid for them. +Each sale, at any time, can be in one of several different states. +A sale progress though these states until it is posted. + +Each sale is linked to a `Point ` where it takes place. + +A sale is identified by a unique number that is generated automatically from +the configured `Sequence ` for the sale Point. +It also has other general information like the date and the `Employee +` who creates the order. + +The sale is made up from one, or more, sales lines. +These lines provide information about which `Products +` and what quantities are included in the sale. + +The total and tax amounts for a sale are derived from the prices and `Taxes +` of the line's Products. + +The amount paid or reimbursed is registered using the `Payment Method +`. +Once the amount to paid reaches zero, the sale is done. + +On posting the sale it generates the corresponding `Stock Moves +` for the goods and posts the corresponding `Account +Move `. + +.. seealso:: + + Sales are found by opening the main menu item: + + |Sales --> POS Sales|__ + + .. |Sales --> POS Sales| replace:: :menuselection:`Sales --> POS Sales` + __ https://demo.tryton.org/model/sale.point.sale + +Wizards +------- + +.. _wizard-sale.point.sale.pay: + +Pay Sale +^^^^^^^^ + +The *Pay Sale* wizard allows payments to be registered against the sale. +If the sale is overpaid the wizard calculates the amount to return. +Once the sale is fully paid the sale state is automatically set to done. + +.. _model-sale.point.cash.session: + +Cash Session +============ + +The *Cash Session* groups the cash payments and the transfers of a `Point of +Sale ` over a period. +The sessions of a point of sale are a chained list that tracks the cash amount +between each closure. + +.. seealso:: + + The Cash Sessions are found by opening the main menu item: + + |Sales --> POS Cash Sessions|__ + + .. |Sales --> POS Cash Sessions| replace:: :menuselection:`Sales --> POS Cash Sessions` + __ https://demo.tryton.org/model/sale.point.cash.session +.. _model-sale.point.payment.method: + +Payment Method +============== + +The *Payment Method* defines the available options for paying a `Sale +`. + +A method can be set to *cash* so it will be used to return change. +Only one method per company can be set to cash. + +.. seealso:: + + Payment Methods are found by opening the main menu item: + + |Sales --> Configuration --> POS Payment Methods|__ + + .. |Sales --> Configuration --> POS Payment Methods| replace:: :menuselection:`Sales --> Configuration --> POS Payment Methods` + __ https://demo.tryton.org/model/sale.point.payment.method + +.. _model-sale.point.cash.transfer.type: + +Cash Transfer Type +================== + +The *Transfer Type* defines the available options for transferring cash of a +`Point of Sale `. + +.. seealso:: + + Cash Transfer Types are found by opening the main menu item: + + |Sales --> Configuration --> POS Cash Transfer Types|__ + + .. |Sales --> Configuration --> POS Cash Transfer Types| replace:: :menuselection:`Sales --> Configuration --> POS Cash Transfer Types` + __ https://demo.tryton.org/model/sale.point.cash.transfer.type diff --git a/doc/index.rst b/doc/index.rst new file mode 100644 index 0000000000..8e4a6ab28e --- /dev/null +++ b/doc/index.rst @@ -0,0 +1,10 @@ +################# +Sale Point Module +################# + +The *Sale Point Module* allows retail sales to be handled and recorded. + +.. toctree:: + :maxdepth: 2 + + design diff --git a/exceptions.py b/exceptions.py new file mode 100644 index 0000000000..c7087547fc --- /dev/null +++ b/exceptions.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. +from trytond.model.exceptions import ValidationError + + +class SaleValidationError(ValidationError): + pass + + +class SessionValidationError(ValidationError): + pass diff --git a/message.xml b/message.xml new file mode 100644 index 0000000000..28356836f7 --- /dev/null +++ b/message.xml @@ -0,0 +1,46 @@ + + + + + + You cannot change the point of sale's tax included flag because it has sales. + + + You cannot delete sale "%(sale)s" because it has a number. + + + The sale "%(sale)s" is done so cannot have an amount to pay. + + + The sale "%(sale)s" is cancelled so cannot have amount paid. + + + To delete payment "%(payment)s" you must re-open session "%(session)s". + + + To delete payment "%(payment)s" you must re-open sale "%(sale)s". + + + Each company can only have one cash payment method. + + + Each point of sale can only have one session open. + + + A session can be used as previous only once. + + + To close session "%(session)s" you must change end amount to have %(amount)s instead of %(end_amount)s + + + To delete session "%(session)s" you must re-open it. + + + You cannot delete transfer "%(transfer)s" because it is posted. + + + To delete transfer "%(transfer)s" you must re-open session "%(session)s". + + + diff --git a/product.py b/product.py new file mode 100644 index 0000000000..79991e32d2 --- /dev/null +++ b/product.py @@ -0,0 +1,56 @@ +# This file is part of Tryton. The COPYRIGHT file at the top level of +# this repository contains the full copyright notices and license terms. +from decimal import Decimal + +from trytond.pool import PoolMeta, Pool +from trytond.model import ModelSQL, fields +from trytond.pyson import Eval + +from trytond.modules.product import price_digits +from trytond.modules.company.model import CompanyValueMixin + + +class Template(metaclass=PoolMeta): + __name__ = 'product.template' + + gross_price = fields.MultiValue(fields.Numeric( + "Gross Price", digits=price_digits, + states={ + 'invisible': ~Eval('salable', False), + 'readonly': ~Eval('active', True), + }, + depends=['salable', 'active'], + help="The price with default tax included.")) + gross_prices = fields.One2Many( + 'product.gross_price', 'template', "Gross Prices") + + @classmethod + def multivalue_model(cls, field): + pool = Pool() + if field == 'gross_price': + return pool.get('product.gross_price') + return super(Template, cls).multivalue_model(field) + + @fields.depends('gross_price', 'account_category') + def on_change_gross_price(self): + pool = Pool() + Tax = pool.get('account.tax') + if self.gross_price is None or not self.account_category: + return + self.list_price = Tax.reverse_compute( + self.gross_price, + self.customer_taxes_used).quantize( + Decimal(1) + / 10 ** self.__class__.list_price.digits[1]) + + +class Product(metaclass=PoolMeta): + __name__ = 'product.product' + + +class GrossPrice(ModelSQL, CompanyValueMixin): + "Product Gross Price" + __name__ = 'product.gross_price' + template = fields.Many2One( + 'product.template', "Template", ondelete='CASCADE', select=True) + gross_price = fields.Numeric("Gross Price", digits=price_digits) diff --git a/product.xml b/product.xml new file mode 100644 index 0000000000..9812d0879e --- /dev/null +++ b/product.xml @@ -0,0 +1,18 @@ + + + + + + product.template + + template_form + + + + product.template + + template_tree + + + diff --git a/sale.py b/sale.py new file mode 100644 index 0000000000..4c739f104b --- /dev/null +++ b/sale.py @@ -0,0 +1,1362 @@ +# This file is part of Tryton. The COPYRIGHT file at the top level of +# this repository contains the full copyright notices and license terms. +from collections import defaultdict +from decimal import Decimal + +from sql import Literal, Union +from sql.aggregate import Sum +from sql.conditionals import Coalesce +from sql.operators import Equal +from trytond.i18n import gettext +from trytond.model import (DeactivableMixin, Exclude, ModelSQL, ModelView, + Workflow, fields) +from trytond.model.exceptions import AccessError +from trytond.modules.account.tax import TaxableMixin +from trytond.modules.currency.fields import Monetary +from trytond.modules.product import price_digits +from trytond.pool import Pool +from trytond.pyson import Bool, Eval, Id, If +from trytond.tools import grouped_slice, reduce_ids +from trytond.transaction import Transaction +from trytond.wizard import Button, StateTransition, StateView, Wizard + +from .exceptions import SaleValidationError, SessionValidationError + + +class POS(ModelSQL, ModelView): + "Point of Sale" + __name__ = 'sale.point' + name = fields.Char("Name", required=True, select=True) + company = fields.Many2One('company.company', "Company", required=True) + tax_included = fields.Boolean( + "Tax Included", + help="Check if unit Price includes tax.") + sequence = fields.Many2One( + 'ir.sequence.strict', "Sequence", required=True, + domain=[ + ('company', '=', Eval('company', -1)), + ('sequence_type', '=', Id('sale_point', 'sequence_type_sale')), + ], + depends=['company']) + + storage_location = fields.Many2One( + 'stock.location', "Storage Location", required=True, + domain=[('type', '=', 'storage')], + help="The location from where goods are taken when sold.") + return_location = fields.Many2One( + 'stock.location', "Return Location", + domain=[('type', '=', 'storage')], + help="The location where goods are put when returned.\n" + "If empty the storage location is used.") + customer_location = fields.Many2One( + 'stock.location', "To Location", required=True, + domain=[('type', '=', 'customer')], + help="The location where goods are put when sold.") + + journal = fields.Many2One( + 'account.journal', "Journal", required=True, + domain=[ + ('type', '=', 'revenue'), + ]) + + @classmethod + def default_company(cls): + return Transaction().context.get('company') + + @classmethod + def default_tax_included(cls): + return True + + @classmethod + def write(cls, *args): + pool = Pool() + Sale = pool.get('sale.point.sale') + transaction = Transaction() + if (transaction.user != 0 + and transaction.context.get('_check_access')): + actions = iter(args) + for points, values in zip(actions, actions): + if 'tax_included' in values: + for sub_points in grouped_slice(points): + if Sale.search([ + ('points', 'in', + list(map(int, sub_points))), + ], + limit=1, order=[]): + raise AccessError(gettext( + 'sale_point.msg_point_change_tax_included') + ) + super().write(*args) + + +class POSSale(Workflow, ModelSQL, ModelView, TaxableMixin): + "POS Sale" + __name__ = 'sale.point.sale' + _rec_name = 'number' + + _states = { + 'readonly': Eval('state') != 'open', + } + _depends = ['state'] + + company = fields.Many2One( + 'company.company', "Company", required=True, + states=_states, depends=_depends) + employee = fields.Many2One( + 'company.employee', "Employee", + domain=[ + ('company', '=', Eval('company', -1)), + ], + states=_states, + depends=['company'] + _depends) + point = fields.Many2One( + 'sale.point', "Point", required=True, ondelete='RESTRICT', + states={ + 'readonly': ((Eval('id', 0) > 0) + | Bool(Eval('lines', [0])) + | _states['readonly']), + }, + domain=[ + ('company', '=', Eval('company', -1)), + ], + depends=['company'] + _depends) + number = fields.Char( + "Number", readonly=True, select=True, + states={ + 'required': Eval('state').in_(['done', 'posted']), + }, + depends=['state']) + date = fields.Date("Date", required=True, states=_states, depends=_depends) + lines = fields.One2Many( + 'sale.point.sale.line', 'sale', "Lines", + states={ + 'readonly': (~Eval('point') + | _states['readonly']), + }, + depends=['point'] + _depends) + payments = fields.One2Many( + 'sale.point.payment', 'sale', "Payments", + states=_states, depends=_depends) + total_tax = fields.Function(Monetary( + "Total Tax", currency='currency', digits='currency'), + 'on_change_with_total_tax') + total = fields.Function(Monetary( + "Total", currency='currency', digits='currency'), + 'on_change_with_total') + amount_paid = fields.Function(Monetary( + "Paid", currency='currency', digits='currency'), + 'on_change_with_amount_paid') + amount_to_pay = fields.Function(Monetary( + "To Pay", currency='currency', digits='currency'), + 'on_change_with_amount_to_pay') + state = fields.Selection([ + ('open', "Open"), + ('done', "Done"), + ('posted', "Posted"), + ('cancelled', "Cancelled"), + ], "State", readonly=True, select=True) + + move = fields.Many2One( + 'account.move', "Move", readonly=True, + states={ + 'invisible': ~Eval('move'), + }) + + currency = fields.Function(fields.Many2One( + 'currency.currency', "Currency"), 'on_change_with_currency') + + del _states, _depends + + @classmethod + def __setup__(cls): + super().__setup__() + cls._transitions |= { + ('open', 'done'), + ('done', 'posted'), + ('done', 'open'), + ('open', 'cancelled'), + ('cancelled', 'open'), + } + cls._buttons.update( + pay={ + 'invisible': Eval('state') != 'open', + 'readonly': ~Eval('amount_to_pay'), + 'depends': ['amount_to_pay'], + }, + cancel={ + 'invisible': Eval('state') != 'open', + 'depends': ['state'], + }, + open={ + 'invisible': ~Eval('state').in_(['done', 'cancelled']), + 'depends': ['state'], + }, + process={ + 'invisible': Eval('state') != 'open', + 'readonly': ( + Bool(Eval('amount_to_pay', 0)) + | ~Eval('lines', [-1])), + 'depends': ['state', 'amount_to_pay'], + }, + post={ + 'invisible': Eval('state') != 'done', + 'depends': ['state'], + }, + ) + + @classmethod + def default_company(cls): + return Transaction().context.get('company') + + @classmethod + def default_employee(cls): + User = Pool().get('res.user') + + if Transaction().context.get('employee'): + return Transaction().context['employee'] + else: + user = User(Transaction().user) + if user.employee: + return user.employee.id + + @classmethod + def default_date(cls): + return Pool().get('ir.date').today() + + @classmethod + def default_state(cls): + return 'open' + + @fields.depends('company') + def on_change_with_currency(self, name=None): + if self.company and self.company.currency: + return self.company.currency.id + + @fields.depends('lines') + def on_change_with_total_tax(self, name=None): + return sum(line.tax_amount for line in self.lines) + + @fields.depends('company', 'lines') + def on_change_with_total(self, name=None): + return sum(line.gross_amount for line in self.lines) + + @fields.depends('payments') + def on_change_with_amount_paid(self, name=None): + return sum(p.amount or Decimal('0') for p in self.payments) + + @fields.depends(methods=[ + 'on_change_with_total', 'on_change_with_amount_paid']) + def on_change_with_amount_to_pay(self, name=None): + return (self.on_change_with_total() + - self.on_change_with_amount_paid()) + + def get_rec_name(self, name): + if self.number: + return self.number + else: + return '(%s)' % self.id + + @classmethod + def copy(cls, sales, default=None): + if default is None: + default = {} + else: + default = default.copy() + default.setdefault('employee') + default.setdefault('number') + default.setdefault('payments') + return super().copy(sales, default=default) + + @classmethod + def delete(cls, sales): + for sale in sales: + if sale.number: + raise AccessError( + gettext('sale_point.msg_sale_delete_numbered', + sale=sale.rec_name)) + super().delete(sales) + + @classmethod + def validate(cls, sales): + super().validate(sales) + for sale in sales: + if sale.state in {'done', 'posted'}: + if sale.amount_to_pay: + raise SaleValidationError(gettext( + 'sale_point.msg_sale_amount_to_pay_done_posted', + sale=sale.rec_name)) + elif sale.state == 'cancelled': + if sale.amount_paid: + raise SaleValidationError(gettext( + 'sale_point.msg_sale_amount_paid_cancelled', + sale=sale.rec_name)) + + @classmethod + @ModelView.button_action('sale_point.wizard_pay') + def pay(cls, sales): + pass + + @classmethod + @ModelView.button + @Workflow.transition('cancelled') + def cancel(cls, sales): + pass + + @classmethod + @ModelView.button + def open(cls, sales): + pass + + @classmethod + @ModelView.button + def process(cls, sales): + cls.do([sale for sale in sales if not sale.amount_to_pay]) + + @classmethod + @Workflow.transition('done') + def do(cls, sales): + for sale in sales: + sale.number = sale.point.sequence.get() + cls.save(sales) + + @classmethod + @Workflow.transition('posted') + def post(cls, sales): + pool = Pool() + StockMove = pool.get('stock.move') + AccountMove = pool.get('account.move') + + stock_moves = [] + account_moves = [] + for sale in sales: + assert not sale.move + for line in sale.lines: + move = line.get_stock_move() + if move: + stock_moves.append(move) + account_move = sale.get_account_move() + sale.move = account_move + account_moves.append(account_move) + if stock_moves: + StockMove.save(stock_moves) + StockMove.do(stock_moves) + if account_moves: + AccountMove.save(account_moves) + AccountMove.post(account_moves) + cls.save(sales) + + def get_account_move(self): + 'Return account move' + pool = Pool() + Move = pool.get('account.move') + Period = pool.get('account.period') + + period_id = Period.find(self.company.id, date=self.date) + lines = [] + for line in self.lines: + move_lines = line.get_account_move_lines() + if move_lines: + lines.extend(move_lines) + + move_lines = self.get_tax_move_lines() + if move_lines: + lines.extend(move_lines) + + for payment in self.payments: + move_lines = payment.get_account_move_lines() + if move_lines: + lines.extend(move_lines) + + move = Move() + move.journal = self.point.journal + move.period = period_id + move.date = self.date + move.origin = self + move.company = self.company + move.lines = lines + return move + + def get_tax_move_lines(self): + "Return account move lines for taxes" + pool = Pool() + Line = pool.get('account.move.line') + TaxLine = pool.get('account.tax.line') + + lines = [] + taxes = self._get_taxes() + + # Distribute rounding error from tax computation + tax_amount = sum(t['amount'] for t in taxes) + difference = self.total_tax - tax_amount + if difference: + remaining = difference + for tax in taxes: + if tax['amount']: + if tax_amount: + ratio = tax['amount'] / tax_amount + else: + ratio = 1 / len(taxes) + value = self.currency.round(difference * ratio) + tax['amount'] += value + remaining -= value + # Add remaining rounding error to the first tax + if remaining: + for tax in taxes: + if tax['amount']: + tax['amount'] += remaining + break + + for tax in taxes: + amount = tax['amount'] + if not amount: + continue + line = Line() + line.description = tax['description'] + if amount >= 0: + line.debit, line.credit = Decimal(0), amount + else: + line.debit, line.credit = -amount, 0 + line.account = tax['account'] + if tax['tax']: + tax_line = TaxLine() + tax_line.amount = amount + tax_line.type = 'tax' + tax_line.tax = tax['tax'] + line.tax_lines = [tax_line] + lines.append(line) + return lines + + @property + def taxable_lines(self): + return sum((line.taxable_lines for line in self.lines), []) + + @property + def tax_date(self): + return self.date + + +class POSSaleLine(ModelSQL, ModelView, TaxableMixin): + "POS Sale Line" + __name__ = 'sale.point.sale.line' + + _states = { + 'readonly': Eval('sale_state') != 'open', + } + _depends = ['sale_state'] + + sale = fields.Many2One( + 'sale.point.sale', "Sale", required=True, ondelete='CASCADE', + states=_states, depends=_depends) + product = fields.Many2One( + 'product.product', "Product", required=True, + domain=[ + ('salable', '=', True), + ], + context={ + 'company': Eval('company'), + }, + states=_states, depends=_depends + ['company']) + quantity = fields.Float( + "Quantity", digits=(16, Eval('unit_digits', 2)), + required=True, states=_states, depends=['unit_digits'] + _depends) + unit = fields.Function( + fields.Many2One('product.uom', "Unit"), 'on_change_with_unit') + unit_list_price = fields.Numeric( + "Unit List Price", digits=price_digits, required=True, + states={ + 'readonly': True, # Allow client to sent value + }) + unit_gross_price = fields.Numeric( + "Unit Gross Price", digits=price_digits, required=True, + states={ + 'readonly': True, # Allow client to sent value + }) + unit_price = fields.Function(fields.Numeric( + "Unit Price", digits=price_digits, + depends=['unit_list_price', 'unit_gross_price']), + 'on_change_with_unit_price') + amount = fields.Function(Monetary( + "Amount", currency='currency', digits='currency'), + 'on_change_with_amount') + + moves = fields.One2Many( + 'stock.move', 'origin', 'Moves', readonly=True, + states={ + 'invisible': ~Eval('moves', []), + }) + + unit_digits = fields.Function( + fields.Integer("Unit Digits"), 'on_change_with_unit_digits') + sale_state = fields.Function(fields.Selection( + 'get_sale_states', "Sale State"), 'on_change_with_sale_state') + company = fields.Function( + fields.Many2One('company.company', "Company"), + 'on_change_with_company', searcher='search_company') + currency = fields.Function( + fields.Many2One('currency.currency', "Currency"), + 'on_change_with_currency') + + del _states, _depends + + @classmethod + def __setup__(cls): + super().__setup__() + cls.__access__.add('sale') + + @fields.depends('product') + def on_change_with_unit(self, name=None): + # TODO packaging UOM + if self.product: + return self.product.sale_uom.id + + @fields.depends('unit') + def on_change_with_unit_digits(self, name=None): + if self.unit: + return self.unit.digits + return 2 + + @classmethod + def get_sale_states(cls): + pool = Pool() + Sale = pool.get('sale.point.sale') + return Sale.fields_get(['state'])['state']['selection'] + + @fields.depends('sale', '_parent_sale.state') + def on_change_with_sale_state(self, name=None): + if self.sale: + return self.sale.state + + @fields.depends( + 'product', 'sale', '_parent_sale.point', '_parent_sale.date', + methods=['on_change_with_unit_price', 'on_change_with_amount']) + def on_change_product(self): + pool = Pool() + Tax = pool.get('account.tax') + if self.product and self.sale and self.sale.point: + if (self.sale.point.tax_included + and self.product.gross_price is not None): + self.unit_gross_price = self.product.gross_price + self.unit_list_price = Tax.reverse_compute( + self.unit_gross_price, self.taxes, + date=self.sale.date).quantize( + Decimal(1) + / 10 ** self.__class__.unit_list_price.digits[1]) + else: + self.unit_list_price = self.product.list_price + taxes = Tax.compute( + self.taxes, self.unit_list_price, 1, + date=self.sale.date) + tax_amount = sum(t['amount'] for t in taxes) + self.unit_gross_price = ( + self.unit_list_price + tax_amount).quantize( + Decimal(1) + / 10 ** self.__class__.unit_gross_price.digits[1]) + else: + self.unit_gross_price = None + self.unit_list_price = None + self.unit_price = self.on_change_with_unit_price() + self.amount = self.on_change_with_amount() + + @fields.depends('unit_list_price', 'unit_gross_price', + 'sale', '_parent_sale.point') + def on_change_with_unit_price(self, name=None): + if self.sale and self.sale.point: + if self.sale.point.tax_included: + return self.unit_gross_price + else: + return self.unit_list_price + else: + return + + @fields.depends('currency', 'quantity', 'unit_price') + def on_change_with_amount(self, name=None): + amount = (Decimal(str(self.quantity or 0)) + * (self.unit_price or Decimal('0'))) + if self.currency: + return self.currency.round(amount) + return amount + + @fields.depends('sale', '_parent_sale.company') + def on_change_with_company(self, name=None): + if self.sale and self.sale.company: + return self.sale.company.id + + @classmethod + def search_company(cls, name, clause): + return [('sale.company',) + tuple(clause[1:])] + + @fields.depends('sale', '_parent_sale.currency') + def on_change_with_currency(self, name=None): + if self.sale and self.sale.currency: + return self.sale.currency.id + + @property + def untax_amount(self): + amount = (Decimal(str(self.quantity or 0)) + * (self.unit_list_price or Decimal('0'))) + if getattr(self, 'currency', None): + amount = self.currency.round(amount) + return amount + + @property + def tax_amount(self): + amount = self.gross_amount - self.untax_amount + if getattr(self, 'currency', None): + amount = self.currency.round(amount) + return amount + + @property + def gross_amount(self): + amount = (Decimal(str(self.quantity or 0)) + * (self.unit_gross_price or Decimal('0'))) + if getattr(self, 'currency', None): + amount = self.currency.round(amount) + return amount + + def get_rec_name(self, name): + return '%s @ %s' % (self.product.rec_name, self.sale.rec_name) + + @classmethod + def search_rec_name(cls, name, clause): + return ['OR', + ('sale.rec_name',) + tuple(clause[1:]), + ('product.rec_name',) + tuple(clause[1:]), + ] + + @classmethod + def copy(cls, lines, default=None): + if default is None: + default = {} + else: + default = default.copy() + default.setdefault('moves') + return super().copy(lines, default=default) + + def get_stock_move(self): + 'Return stock move' + pool = Pool() + Move = pool.get('stock.move') + + if self.product.type == 'service': + return + + move = Move() + move.quantity = abs(self.quantity) + move.uom = self.unit + move.product = self.product + move.from_location = self.from_location + move.to_location = self.to_location + move.company = self.company + move.unit_price = self.unit_list_price + move.currency = self.currency + move.effective_date = self.sale.date + move.origin = self + return move + + @property + def from_location(self): + if self.quantity >= 0: + return self.sale.point.storage_location + else: + return self.sale.point.customer_location + + @property + def to_location(self): + if self.quantity >= 0: + return self.sale.point.customer_location + else: + return self.sale.point.return_location + + def get_account_move_lines(self): + "Return account move lines" + pool = Pool() + Line = pool.get('account.move.line') + TaxLine = pool.get('account.tax.line') + + line = Line() + if self.quantity >= 0: + line.debit, line.credit = Decimal(0), self.untax_amount + else: + line.debit, line.credit = -self.untax_amount, Decimal(0) + with Transaction().set_context(company=self.company.id): + line.account = self.product.account_revenue_used + line.origin = self + + tax_lines = [] + for tax in self._get_taxes(): + tax_line = TaxLine() + tax_line.amount = tax['base'] + tax_line.type = 'base' + tax_line.tax = tax['tax'] + tax_lines.append(tax_line) + line.tax_lines = tax_lines + return [line] + + @property + def taxes(self): + pool = Pool() + Product = pool.get('product.product') + with Transaction().set_context(company=self.company.id): + return Product(self.product).customer_taxes_used + + @property + def taxable_lines(self): + return [ + (self.taxes, self.unit_list_price, self.quantity, self.tax_date)] + + @property + def tax_type(self): + if self.quantity >= 0: + return 'invoice' + else: + return 'credit_note' + + @property + def tax_date(self): + return self.sale.date + + +class POSCashSession(Workflow, ModelSQL, ModelView): + "POS Cash Session" + __name__ = 'sale.point.cash.session' + + point = fields.Many2One( + 'sale.point', "Point", required=True, ondelete='CASCADE') + previous_session = fields.Many2One( + 'sale.point.cash.session', "Previous Session", + readonly=True, ondelete='RESTRICT', + domain=[ + ('point', '=', Eval('point', -1)), + ], + depends=['point']) + next_session = fields.One2One( + 'sale.point.cash.session.relation', 'previous', 'next', "Next Session", + readonly=True, + domain=[ + ('point', '=', Eval('point', -1)), + ], + depends=['point']) + payments = fields.One2Many( + 'sale.point.payment', 'session', "Payments", readonly=True, + domain=[ + ('sale.point', '=', Eval('point', -1)), + ], + depends=['point']) + transfers = fields.One2Many( + 'sale.point.cash.transfer', 'session', "Transfers", + domain=[ + ('point', '=', Eval('point', -1)), + ], + states={ + 'readonly': ~Eval('point'), + }, + depends=['point']) + start_amount = fields.Function( + Monetary("Start Amount", currency='currency', digits='currency'), + 'get_start_amount') + balance = fields.Function(Monetary( + "Balance", currency='currency', digits='currency'), + 'get_balance') + end_amount = Monetary( + "End Amount", currency='currency', digits='currency', required=True, + states={ + 'required': Eval('state').in_(['closed', 'posted']), + }, + depends=['state']) + state = fields.Selection([ + ('open', "Open"), + ('closed', "Closed"), + ('posted', "Posted"), + ], "State", readonly=True, required=True) + + currency = fields.Function(fields.Many2One( + 'currency.currency', "Currency"), + 'on_change_with_currency') + + @classmethod + def __setup__(cls): + super().__setup__() + t = cls.__table__() + cls._sql_constraints = [ + ('point_cash_session_open_unique', + Exclude(t, (t.point, Equal), + where=t.state == 'open'), + 'sale_point.msg_point_cash_session_open_unique'), + ('previous_session_unique', + Exclude(t, (Coalesce(t.previous_session, -1), Equal)), + 'sale_point.msg_cash_session_previous_unique'), + ] + cls._transitions |= { + ('open', 'closed'), + ('closed', 'open'), + ('closed', 'posted'), + } + cls._buttons.update( + open={ + 'invisible': Eval('state') != 'closed', + 'depends': ['state'], + }, + close={ + 'pre_validate': [ + ('end_amount', '!=', None), + ], + 'invisible': Eval('state') != 'open', + 'depends': ['state'], + }, + post={ + 'invisible': Eval('state') != 'closed', + 'depends': ['state'], + }, + ) + + @classmethod + def default_state(cls): + return 'open' + + @fields.depends('point') + def on_change_point(self): + if self.point: + last = self.__class__.search([ + ('point', '=', self.point.id), + ('next_session', '=', None), + ], limit=1) + if last: + self.previous_session, = last + + def get_start_amount(self, name): + if self.previous_session: + return self.previous_session.end_amount + else: + return Decimal(0) + + @classmethod + def get_balance(cls, sessions, name): + pool = Pool() + Payment = pool.get('sale.point.payment') + Transfer = pool.get('sale.point.cash.transfer') + payment = Payment.__table__() + transfer = Transfer.__table__() + cursor = Transaction().connection.cursor() + balances = defaultdict(Decimal) + for sub_sessions in grouped_slice(sessions): + sub_ids = [s.id for s in sub_sessions] + query = Union( + payment.select( + payment.session.as_('session'), + Sum(payment.amount).as_('amount'), + where=reduce_ids(payment.session, sub_ids), + group_by=[payment.session]), + transfer.select( + transfer.session.as_('session'), + Sum(transfer.amount).as_('amount'), + where=reduce_ids(transfer.session, sub_ids), + group_by=[transfer.session]), + all_=True) + query = query.select( + query.session, Sum(query.amount), + group_by=[query.session]) + cursor.execute(*query) + for session_id, balance in cursor: + if not isinstance(balance, Decimal): + balance = Decimal(str(balance)) + balances[session_id] = balance + for session in sessions: + balances[session.id] = session.currency.round(balances[session.id]) + return balances + + @classmethod + def default_end_amount(cls): + return Decimal(0) + + @fields.depends('point') + def on_change_with_currency(self, name=None): + if self.point: + return self.point.company.currency.id + + @classmethod + @Workflow.transition('open') + def open(cls, sessions): + pass + + @classmethod + @Workflow.transition('closed') + def close(cls, sessions): + pool = Pool() + Lang = pool.get('ir.lang') + for session in sessions: + if session.end_amount - session.start_amount != session.balance: + lang = Lang.get() + raise SessionValidationError(gettext( + 'sale_point.msg_cash_session_wrong_end_amount', + session=session.rec_name, + end_amount=lang.currency( + session.end_amount, session.currency), + amount=lang.currency( + session.start_amount + session.balance, + session.currency))) + + @classmethod + def delete(cls, sessions): + cls.open(sessions) + for session in sessions: + if session.state != 'open': + raise AccessError( + gettext('sale_point.msg_cash_session_delete_open', + session=session.rec_name)) + super().delete(sessions) + + @classmethod + @Workflow.transition('posted') + def post(cls, sessions): + pool = Pool() + Transfer = pool.get('sale.point.cash.transfer') + Transfer.post(sum((s.transfers for s in sessions), ())) + + @classmethod + def get_current(cls, point): + sessions = cls.search([ + ('point', '=', point.id), + ('state', '=', 'open'), + ], limit=1) + if sessions: + session, = sessions + else: + cls.lock() + last = cls.search([ + ('point', '=', point.id), + ('next_session', '=', None), + ], limit=1) + if last: + last, = last + else: + last = None + session = cls(point=point, previous_session=last) + session.save() + return session + + +class POSCashSessionRelation(ModelSQL): + "POS Session Relation" + __name__ = 'sale.point.cash.session.relation' + + previous = fields.Many2One('sale.point.cash.session', "Previous") + next = fields.Many2One('sale.point.cash.session', "Next") + + @classmethod + def table_query(cls): + pool = Pool() + Session = pool.get('sale.point.cash.session') + session = Session.__table__() + return session.select( + session.id.as_('id'), + session.create_date.as_('create_date'), + session.create_uid.as_('create_uid'), + session.write_date.as_('write_date'), + session.write_uid.as_('write_uid'), + session.previous_session.as_('previous'), + session.id.as_('next')) + + +class POSPayment(ModelSQL, ModelView): + "POS Payment" + __name__ = 'sale.point.payment' + + _states = { + 'readonly': Eval('sale_state') != 'open', + } + _depends = ['sale_state'] + + sale = fields.Many2One( + 'sale.point.sale', "Sale", required=True, ondelete='CASCADE', + states=_states, depends=_depends) + method = fields.Many2One( + 'sale.point.payment.method', "Method", required=True, + domain=[ + ('company', '=', Eval('company')), + If(Eval('amount', 0) < 0, + ('cash', '=', True), + ()), + ], + states=_states, + depends=['company', 'amount'] + _depends) + amount = Monetary( + "Amount", currency='currency', digits='currency', + states=_states, depends=_depends) + session = fields.Many2One( + 'sale.point.cash.session', "Session", + ondelete='RESTRICT', readonly=True, + domain=[ + ('point', '=', Eval('point', -1)), + ], + states={ + 'invisible': ~Eval('cash'), + 'required': Eval('cash', False), + }, + depends=['point', 'cash']) + + currency = fields.Function(fields.Many2One( + 'currency.currency', "Currency"), 'on_change_with_currency') + company = fields.Function( + fields.Many2One('company.company', "Company"), + 'on_change_with_company', searcher='search_company') + sale_state = fields.Function(fields.Selection( + 'get_sale_states', "Sale State"), 'on_change_with_sale_state') + point = fields.Function(fields.Many2One( + 'sale.point', "Point"), 'on_change_with_point') + cash = fields.Function(fields.Boolean("Cash"), 'on_change_with_cash') + + del _states, _depends + + @classmethod + def __setup__(cls): + super().__setup__() + cls.__access__.add('sale') + + @fields.depends('sale', '_parent_sale.amount_to_pay') + def on_change_sale(self): + if self.sale: + self.amount = self.sale.amount_to_pay + + @fields.depends('company') + def on_change_with_currency(self, name=None): + if self.company and self.company.currency: + return self.company.currency.id + + @fields.depends('sale', '_parent_sale.company') + def on_change_with_company(self, name=None): + if self.sale and self.sale.company: + return self.sale.company.id + + @classmethod + def search_company(cls, name, clause): + return [('sale.company',) + tuple(clause[1:])] + + @classmethod + def get_sale_states(cls): + pool = Pool() + Sale = pool.get('sale.point.sale') + return Sale.fields_get(['state'])['state']['selection'] + + @fields.depends('sale', '_parent_sale.state') + def on_change_with_sale_state(self, name=None): + if self.sale: + return self.sale.state + + @fields.depends('sale', '_parent_sale.point') + def on_change_with_point(self, name=None): + if self.sale and self.sale.point: + return self.sale.point.id + + @fields.depends('method') + def on_change_with_cash(self, name=None): + if self.method: + return self.method.cash + + @classmethod + def create(cls, vlist): + pool = Pool() + Method = pool.get('sale.point.payment.method') + Sale = pool.get('sale.point.sale') + Session = pool.get('sale.point.cash.session') + vlist = [v.copy() for v in vlist] + for values in vlist: + if values.get('method') and values.get('sale'): + method = Method(values['method']) + if method.cash: + sale = Sale(values['sale']) + values['session'] = Session.get_current(sale.point) + return super().create(vlist) + + @classmethod + def delete(cls, payments): + for payment in payments: + if payment.sale.state != 'open': + raise AccessError( + gettext('sale_point.msg_payment_delete_sale_open', + payment=payment.rec_name, + sale=payment.sale.rec_name)) + if payment.session and payment.session.state != 'open': + raise AccessError( + gettext('sale_point.msg_payment_delete_session_open', + payment=payment.rec_name, + session=payment.session.rec_name)) + super().delete(payments) + + def get_account_move_lines(self): + "Return account move lines" + pool = Pool() + Line = pool.get('account.move.line') + + line = Line() + if self.amount >= 0: + line.debit, line.credit = self.amount, Decimal(0) + else: + line.debit, line.credit = Decimal(0), -self.amount + line.account = self.method.account + line.origin = self + return [line] + + +class POSPaymentMethod(DeactivableMixin, ModelSQL, ModelView): + "POS Payment Method" + __name__ = 'sale.point.payment.method' + company = fields.Many2One('company.company', "Company", required=True) + name = fields.Char("Name", required=True, translate=True) + account = fields.Many2One( + 'account.account', "Account", required=True, + domain=[ + ('type', '!=', None), + ('closed', '!=', True), + ('company', '=', Eval('company')), + ], + depends=['company']) + cash = fields.Boolean("Cash") + + @classmethod + def __setup__(cls): + super().__setup__() + t = cls.__table__() + cls._sql_constraints = [ + ('cash_company_unique', + Exclude(t, (t.company, Equal), + where=(t.active == Literal(True)) + & (t.cash == Literal(True))), + 'sale_point.msg_payment_method_cash_unique'), + ] + cls._order.insert(0, ('name', 'ASC')) + + @classmethod + def default_company(cls): + return Transaction().context.get('company') + + +class POSPay(Wizard): + "POS Pay" + __name__ = 'sale.point.sale.pay' + start_state = 'payment' + payment = StateView( + 'sale.point.payment', + 'sale_point.payment_view_form_wizard', [ + Button("Cancel", 'end', 'tryton-cancel'), + Button("OK", 'pay', 'tryton-ok', default=True), + ]) + pay = StateTransition() + + @classmethod + def __setup__(cls): + super().__setup__() + cls.__rpc__['create'].fresh_session = True + + def default_payment(self, fields): + pool = Pool() + PaymentMethod = pool.get('sale.point.payment.method') + default = { + 'sale': self.record.id, + 'amount': self.record.amount_to_pay, + } + if default['amount'] < 0: + methods = PaymentMethod.search([ + ('company', '=', self.record.company.id), + ('cash', '=', True), + ]) + if methods: + method, = methods + default['method'] = method.id + return default + + def transition_pay(self): + self.payment.sale = self.record + self.payment.save() + if self.record.amount_to_pay: + return 'payment' + else: + self.model.process([self.record]) + return 'end' + + +class POSCashTransfer(Workflow, ModelSQL, ModelView): + "POS Cash Transfer" + __name__ = 'sale.point.cash.transfer' + + _states = { + 'readonly': Eval('state') == 'done', + } + _depends = ['state'] + + point = fields.Many2One( + 'sale.point', "Point", required=True, states=_states, depends=_depends) + session = fields.Many2One( + 'sale.point.cash.session', "Session", required=True, + domain=[ + ('point', '=', Eval('point', -1)), + If(Eval('state') == 'draft', + ('state', '=', 'open'), + ()), + ], + states={ + 'required': Eval('id', -1) >= 0, + 'readonly': _states['readonly'], + 'invisible': ~Eval('point'), + }, + depends=['point', 'state'] + _depends) + type = fields.Many2One( + 'sale.point.cash.transfer.type', "Type", required=True, + domain=[ + ('company', '=', Eval('company', -1)), + ], + depends=['company']) + amount = Monetary( + "Amount", currency='currency', digits='currency', + states=_states, depends=_depends) + date = fields.Date("Date", required=True) + state = fields.Selection([ + ('draft', "Draft"), + ('posted', "Posted"), + ], "State", readonly=True, required=True) + + move = fields.Many2One( + 'account.move', "Move", readonly=True, + states={ + 'invisible': ~Eval('move'), + }) + + company = fields.Function(fields.Many2One( + 'company.company', "Company"), + 'on_change_with_company') + currency = fields.Function(fields.Many2One( + 'currency.currency', "Currency"), + 'on_change_with_currency') + + del _states, _depends + + @classmethod + def __setup__(cls): + super().__setup__() + cls._transitions |= { + ('draft', 'posted'), + } + cls._buttons.update( + post={ + 'invisible': Eval('state') != 'draft', + 'depends': ['state'], + }, + ) + + @classmethod + def default_state(cls): + return 'draft' + + @classmethod + def default_date(cls): + return Pool().get('ir.date').today() + + @fields.depends('point') + def on_change_with_company(self, name=None): + if self.point: + return self.point.company.id + + @fields.depends('point') + def on_change_with_currency(self, name=None): + if self.point: + return self.point.company.currency.id + + @classmethod + def delete(cls, transfers): + for transfer in transfers: + if transfer.state == 'posted': + raise AccessError( + gettext('sale_point.msg_transfer_delete_posted', + transfer=transfer.rec_name)) + if transfer.session.state != 'open': + raise AccessError( + gettext('sale_point.msg_transfer_delete_session_open', + transfer=transfer.rec_name, + session=transfer.session.rec_name)) + super().delete(transfers) + + @classmethod + @ModelView.button + @Workflow.transition('posted') + def post(cls, transfers): + pool = Pool() + Move = pool.get('account.move') + PaymentMethod = pool.get('sale.point.payment.method') + + methods = PaymentMethod.search([('cash', '=', True)]) + company2account = {m.company: m.account for m in methods} + + moves = [] + for transfer in transfers: + assert not transfer.move + move = transfer.get_move( + account=company2account.get(transfer.company)) + transfer.move = move + moves.append(move) + Move.save(moves) + cls.save(transfers) + + def get_move(self, account): + pool = Pool() + Line = pool.get('account.move.line') + Move = pool.get('account.move') + Period = pool.get('account.period') + + period_id = Period.find(self.company.id, date=self.date) + line = Line() + if self.amount >= 0: + line.debit, line.credit = self.amount, Decimal(0) + else: + line.debit, line.credit = Decimal(0), -self.amount + line.account = account + counterpart = Line() + counterpart.debit, counterpart.credit = line.credit, line.debit + counterpart.account = self.type.account + + move = Move() + move.journal = self.type.journal + move.period = period_id + move.date = self.date + move.origin = self + move.company = self.company + move.lines = [line, counterpart] + return move + + @classmethod + def create(cls, vlist): + pool = Pool() + Point = pool.get('sale.point') + Session = pool.get('sale.point.cash.session') + vlist = [v.copy() for v in vlist] + for values in vlist: + if values.get('point') and not values.get('session'): + point = Point(values['point']) + values['session'] = Session.get_current(point) + return super().create(vlist) + + +class POSCashTransferType(ModelSQL, ModelView): + "POS Cash Transfer Type" + __name__ = 'sale.point.cash.transfer.type' + + company = fields.Many2One('company.company', "Company", required=True) + name = fields.Char("Name", required=True, translate=True) + journal = fields.Many2One( + 'account.journal', "Journal", required=True, + context={ + 'company': Eval('company', -1), + }, + depends=['company']) + account = fields.Many2One( + 'account.account', "Account", required=True, + domain=[ + ('type', '!=', None), + ('closed', '!=', True), + ('company', '=', Eval('company', -1)), + ], + depends=['company']) + + @classmethod + def default_company(cls): + return Transaction().context.get('company') + +# TODO: wizard to create an invoice from sale diff --git a/sale.xml b/sale.xml new file mode 100644 index 0000000000..bfdeeec543 --- /dev/null +++ b/sale.xml @@ -0,0 +1,529 @@ + + + + + + POS + + + + + + + + POS Posting + + + + + + + + POS + + + + + + + + + + + + sale.point + form + point_form + + + sale.point + tree + point_list + + + + Points of Sale + sale.point + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + User in companies + + + + + + + + + + sale.point.sale + form + sale_form + + + sale.point.sale + tree + sale_list + + + + POS Sales + sale.point.sale + + + + + + + + + + + + + Opened + + + + + + Done + + + + + + All + + + + + + + + + + + + + + + + + + + + + + + + + + + + + pay + Pay + + + + + cancel + Cancel + + + + + open + Re-Open + + + + + process + Process + + + + + post + Post + Are you sure you want to post the sales? + + + + + + + + + User in companies + + + + + + + + + + sale.point.sale.line + form + sale_line_form + + + sale.point.sale.line + tree + sale_line_list + + + + sale.point.cash.session + form + cash_session_form + + + + sale.point.cash.session + tree + cash_session_list + + + + POS Cash Sessions + sale.point.cash.session + + + + + + + + + + + + + Opened + + + + + + Closed + + + + + + All + + + + + + + + + + + + + + + + + + + + + + + + + open + Re-Open + + + + + close + Close + + + + + post + Post + Are you sure you want to post the sessions? + + + + + + + + + User in companies + + + + + + + + + + sale.point.payment.method + form + payment_method_form + + + sale.point.payment.method + tree + payment_method_list + + + + POS Payment Methods + sale.point.payment.method + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + User in companies + + + + + + + + + + sale.point.payment + form + payment_form + + + sale.point.payment + form + + payment_form_wizard + + + sale.point.payment + tree + payment_list + + + + Pay POS Sale + sale.point.sale.pay + sale.point.sale + + + + sale.point.cash.transfer + form + cash_transfer_form + + + + sale.point.cash.transfer + tree + cash_transfer_list + + + + + + + + + + + + + + + + + + + + post + Post + Are you sure you want to post the transfer? + + + + + + + + + User in companies + + + + + + + + + + sale.point.cash.transfer.type + form + cash_transfer_type_form + + + + sale.point.cash.transfer.type + tree + cash_transfer_type_list + + + + POS Cash Transfer Types + sale.point.cash.transfer.type + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + User in companies + + + + + + + + + diff --git a/setup.py b/setup.py new file mode 100644 index 0000000000..69f183135e --- /dev/null +++ b/setup.py @@ -0,0 +1,155 @@ +#!/usr/bin/env python3 +# This file is part of Tryton. The COPYRIGHT file at the top level of +# this repository contains the full copyright notices and license terms. + +import io +import os +import re +from configparser import ConfigParser +from setuptools import setup, find_packages + + +def read(fname): + content = io.open( + os.path.join(os.path.dirname(__file__), fname), + 'r', encoding='utf-8').read() + content = re.sub( + r'(?m)^\.\. toctree::\r?\n((^$|^\s.*$)\r?\n)*', '', content) + return content + + +def get_require_version(name): + if minor_version % 2: + require = '%s >= %s.%s.dev0, < %s.%s' + else: + require = '%s >= %s.%s, < %s.%s' + require %= (name, major_version, minor_version, + major_version, minor_version + 1) + return require + + +config = ConfigParser() +config.read_file(open(os.path.join(os.path.dirname(__file__), 'tryton.cfg'))) +info = dict(config.items('tryton')) +for key in ('depends', 'extras_depend', 'xml'): + if key in info: + info[key] = info[key].strip().splitlines() +version = info.get('version', '0.0.1') +major_version, minor_version, _ = version.split('.', 2) +major_version = int(major_version) +minor_version = int(minor_version) +name = 'trytond_sale_point' + +download_url = 'http://downloads.tryton.org/%s.%s/' % ( + major_version, minor_version) +if minor_version % 2: + version = '%s.%s.dev0' % (major_version, minor_version) + download_url = ( + 'hg+http://hg.tryton.org/modules/%s#egg=%s-%s' % ( + name[8:], name, version)) +local_version = [] +if os.environ.get('CI_JOB_ID'): + local_version.append(os.environ['CI_JOB_ID']) +else: + for build in ['CI_BUILD_NUMBER', 'CI_JOB_NUMBER']: + if os.environ.get(build): + local_version.append(os.environ[build]) + else: + local_version = [] + break +if local_version: + version += '+' + '.'.join(local_version) + + +requires = ['python-sql'] +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')] +dependency_links = [] +if minor_version % 2: + dependency_links.append( + 'https://trydevpi.tryton.org/?local_version=' + + '.'.join(local_version)) + +setup(name=name, + version=version, + description='Tryton module for Point of Sales', + long_description=read('README.rst'), + author='Tryton', + author_email='bugs@tryton.org', + url='http://www.tryton.org/', + download_url=download_url, + project_urls={ + "Bug Tracker": 'https://bugs.tryton.org/', + "Documentation": ( + 'https://docs.tryton.org/projects/modules-sale-point/'), + "Forum": 'https://www.tryton.org/forum', + "Source Code": 'https://hg.tryton.org/modules/sale_point', + }, + keywords='tryton POS sale', + package_dir={'trytond.modules.sale_point': '.'}, + packages=( + ['trytond.modules.sale_point'] + + ['trytond.modules.sale_point.%s' % p for p in find_packages()] + ), + package_data={ + 'trytond.modules.sale_point': (info.get('xml', []) + + ['tryton.cfg', 'view/*.xml', 'locale/*.po', '*.fodt', + 'tests/*.rst', 'icons/*.svg']), + }, + 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', + 'Operating System :: OS Independent', + 'Programming Language :: Python :: 3', + 'Programming Language :: Python :: 3.6', + 'Programming Language :: Python :: 3.7', + 'Programming Language :: Python :: 3.8', + 'Programming Language :: Python :: 3.9', + 'Programming Language :: Python :: Implementation :: CPython', + 'Programming Language :: Python :: Implementation :: PyPy', + 'Topic :: Office/Business', + 'Topic :: Office/Business :: Financial :: Accounting', + ], + license='GPL-3', + python_requires='>=3.6', + install_requires=requires, + dependency_links=dependency_links, + zip_safe=False, + entry_points=""" + [trytond.modules] + sale_point = trytond.modules.sale_point + """, + test_suite='tests', + test_loader='trytond.test_loader:Loader', + tests_require=tests_require, + ) diff --git a/stock.py b/stock.py new file mode 100644 index 0000000000..498dd35364 --- /dev/null +++ b/stock.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. +from trytond.pool import PoolMeta + + +class Move(metaclass=PoolMeta): + __name__ = 'stock.move' + + @classmethod + def _get_origin(cls): + return super(Move, cls)._get_origin() + ['sale.point.sale.line'] diff --git a/tests/__init__.py b/tests/__init__.py new file mode 100644 index 0000000000..f4d7253b86 --- /dev/null +++ b/tests/__init__.py @@ -0,0 +1,9 @@ +# This file is part of Tryton. The COPYRIGHT file at the top level of +# this repository contains the full copyright notices and license terms. + +try: + from trytond.modules.sale_point.tests.test_sale_point import suite +except ImportError: + from .test_sale_point import suite + +__all__ = ['suite'] diff --git a/tests/scenario_sale_point.rst b/tests/scenario_sale_point.rst new file mode 100644 index 0000000000..2f5c2c002d --- /dev/null +++ b/tests/scenario_sale_point.rst @@ -0,0 +1,215 @@ +============ +POS Scenario +============ + +Imports:: + + >>> from decimal import Decimal + + >>> from proteus import Model, Wizard + >>> from trytond.tests.tools import activate_modules + >>> from trytond.modules.company.tests.tools import ( + ... create_company, get_company) + >>> from trytond.modules.account.tests.tools import ( + ... create_fiscalyear, create_chart, get_accounts, create_tax) + >>> from trytond.modules.account_invoice.tests.tools import ( + ... set_fiscalyear_invoice_sequences) + +Activate modules:: + + >>> config = activate_modules('sale_point') + + >>> Journal = Model.get('account.journal') + >>> Location = Model.get('stock.location') + >>> POS = Model.get('sale.point') + >>> PaymentMethod = Model.get('sale.point.payment.method') + >>> ProductCategory = Model.get('product.category') + >>> ProductTemplate = Model.get('product.template') + >>> ProductUom = Model.get('product.uom') + >>> Sale = Model.get('sale.point.sale') + >>> SequenceStrict = Model.get('ir.sequence.strict') + >>> SequenceType = Model.get('ir.sequence.type') + >>> StockMove = Model.get('stock.move') + +Create company:: + + >>> _ = create_company() + >>> company = get_company() + +Create fiscal year:: + + >>> fiscalyear = set_fiscalyear_invoice_sequences( + ... create_fiscalyear(company)) + >>> fiscalyear.click('create_period') + +Create chart of accounts:: + + >>> _ = create_chart(company) + >>> accounts = get_accounts(company) + +Create tax:: + + >>> tax = create_tax(Decimal('.21')) + >>> tax.save() + +Create account categories:: + + >>> account_category = ProductCategory(name="Account Category") + >>> account_category.accounting = True + >>> account_category.account_revenue = accounts['revenue'] + >>> account_category.customer_taxes.append(tax) + >>> account_category.save() + +Create product:: + + >>> unit, = ProductUom.find([('name', '=', 'Unit')]) + + >>> template = ProductTemplate() + >>> template.name = 'product' + >>> template.default_uom = unit + >>> template.type = 'goods' + >>> template.salable = True + >>> template.account_category = account_category + >>> template.gross_price = Decimal('12.0000') + >>> template.list_price + Decimal('9.9174') + >>> template.save() + >>> goods, = template.products + + >>> template = ProductTemplate() + >>> template.name = 'service' + >>> template.default_uom = unit + >>> template.type = 'service' + >>> template.salable = True + >>> template.account_category = account_category + >>> template.list_price = Decimal('29.7520') + >>> template.gross_price = Decimal('36.0000') + >>> template.save() + >>> service, = template.products + +Get journal:: + + >>> journal_revenue, = Journal.find([('type', '=', 'revenue')], limit=1) + +Get stock locations:: + + >>> storage_loc, = Location.find([('code', '=', 'STO')]) + >>> customer_loc, = Location.find([('code', '=', 'CUS')]) + +Create POS:: + + >>> pos = POS(name="POS") + >>> pos.journal = journal_revenue + >>> pos.sequence = SequenceStrict(name="POS", company=pos.company) + >>> pos.sequence.sequence_type, = SequenceType.find( + ... [('name', '=', "POS")], limit=1) + >>> pos.sequence.save() + >>> pos.storage_location = storage_loc + >>> pos.customer_location = customer_loc + >>> pos.save() + +Create 2 payment methods:: + + >>> cash_method = PaymentMethod(name="Cash") + >>> cash_method.account = accounts['cash'] + >>> cash_method.cash = True + >>> cash_method.save() + >>> terminal_method = PaymentMethod(name="Terminal") + >>> accounts['terminal'], = accounts['cash'].duplicate( + ... default={'name': "Terminal"}) + >>> terminal_method.account = accounts['terminal'] + >>> terminal_method.save() + +Make a sale:: + + >>> sale = Sale(point=pos) + + >>> line = sale.lines.new() + >>> line.product = goods + >>> line.unit_price + Decimal('12.0000') + >>> line.unit_list_price + Decimal('9.9174') + >>> line.unit_gross_price + Decimal('12.0000') + >>> line.quantity = 500 + >>> line.amount + Decimal('6000.00') + + >>> line = sale.lines.new() + >>> line.product = service + >>> line.quantity = 1 + + >>> sale.total + Decimal('6036.00') + >>> sale.total_tax + Decimal('1047.55') + + >>> sale.save() + >>> sale.state + 'open' + >>> sale.total + Decimal('6036.00') + >>> sale.total_tax + Decimal('1047.55') + +Overpay by terminal:: + + >>> payment = Wizard('sale.point.sale.pay', [sale]) + >>> payment.form.method = terminal_method + >>> payment.form.amount + Decimal('6036.00') + >>> payment.form.amount = Decimal('6100.00') + >>> payment.execute('pay') + + >>> payment.form.method == cash_method + True + >>> payment.form.amount + Decimal('-64.00') + >>> payment.execute('pay') + + >>> sale.state + 'done' + +Post the sale:: + + >>> sale.click('post') + >>> sale.state + 'posted' + +Check stock move:: + + >>> move, = StockMove.find([ + ... ('origin.sale', '=', sale.id, 'sale.point.sale.line') + ... ]) + >>> move.product == goods + True + >>> move.quantity + 500.0 + >>> move.from_location == storage_loc + True + >>> move.to_location == customer_loc + True + >>> move.state + 'done' + +Check account move:: + + >>> bool(sale.move) + True + + >>> accounts['revenue'].reload() + >>> accounts['revenue'].debit, accounts['revenue'].credit + (Decimal('0.00'), Decimal('4988.45')) + + >>> accounts['tax'].reload() + >>> accounts['tax'].debit, accounts['tax'].credit + (Decimal('0.00'), Decimal('1047.55')) + + >>> accounts['cash'].reload() + >>> accounts['cash'].debit, accounts['cash'].credit + (Decimal('0.00'), Decimal('64.00')) + + >>> accounts['terminal'].reload() + >>> accounts['terminal'].debit, accounts['terminal'].credit + (Decimal('6100.00'), Decimal('0.00')) diff --git a/tests/scenario_sale_point_return.rst b/tests/scenario_sale_point_return.rst new file mode 100644 index 0000000000..dac0b6d20c --- /dev/null +++ b/tests/scenario_sale_point_return.rst @@ -0,0 +1,170 @@ +=================== +POS Scenario Return +=================== + +Imports:: + + >>> from decimal import Decimal + + >>> from proteus import Model, Wizard, Report + >>> from trytond.tests.tools import activate_modules + >>> from trytond.modules.company.tests.tools import create_company, \ + ... get_company + >>> from trytond.modules.account.tests.tools import create_fiscalyear, \ + ... create_chart, get_accounts, create_tax + >>> from trytond.modules.account_invoice.tests.tools import \ + ... set_fiscalyear_invoice_sequences + +Activate modules:: + + >>> config = activate_modules('sale_point') + +Get models:: + + >>> Journal = Model.get('account.journal') + >>> Location = Model.get('stock.location') + >>> POS = Model.get('sale.point') + >>> PaymentMethod = Model.get('sale.point.payment.method') + >>> ProductCategory = Model.get('product.category') + >>> ProductTemplate = Model.get('product.template') + >>> ProductUom = Model.get('product.uom') + >>> Sale = Model.get('sale.point.sale') + >>> SequenceStrict = Model.get('ir.sequence.strict') + >>> SequenceType = Model.get('ir.sequence.type') + +Create company:: + + >>> _ = create_company() + >>> company = get_company() + +Create fiscal year:: + + >>> fiscalyear = set_fiscalyear_invoice_sequences( + ... create_fiscalyear(company)) + >>> fiscalyear.click('create_period') + +Create chart of accounts:: + + >>> _ = create_chart(company) + >>> accounts = get_accounts(company) + +Create tax:: + + >>> tax = create_tax(Decimal('.21')) + >>> tax.save() + +Create account categories:: + + >>> account_category = ProductCategory(name="Account Category") + >>> account_category.accounting = True + >>> account_category.account_revenue = accounts['revenue'] + >>> account_category.customer_taxes.append(tax) + >>> account_category.save() + +Create product:: + + >>> unit, = ProductUom.find([('name', '=', 'Unit')]) + + >>> template = ProductTemplate() + >>> template.name = 'product' + >>> template.default_uom = unit + >>> template.type = 'goods' + >>> template.salable = True + >>> template.account_category = account_category + >>> template.gross_price = Decimal('12.0000') + >>> template.list_price + Decimal('9.9174') + >>> template.save() + >>> goods, = template.products + +Get journal:: + + >>> journal_revenue, = Journal.find([('type', '=', 'revenue')], limit=1) + +Get stock locations:: + + >>> storage_loc, = Location.find([('code', '=', 'STO')]) + >>> input_loc, = Location.find([('code', '=', 'IN')]) + >>> customer_loc, = Location.find([('code', '=', 'CUS')]) + +Create POS:: + + >>> pos = POS(name="POS") + >>> pos.journal = journal_revenue + >>> pos.sequence = SequenceStrict(name="POS", company=pos.company) + >>> pos.sequence.sequence_type, = SequenceType.find( + ... [('name', '=', "POS")], limit=1) + >>> pos.sequence.save() + >>> pos.storage_location = storage_loc + >>> pos.return_location = input_loc + >>> pos.customer_location = customer_loc + >>> pos.save() + +Create payment method:: + + >>> cash_method = PaymentMethod(name="Cash") + >>> cash_method.account = accounts['cash'] + >>> cash_method.cash = True + >>> cash_method.save() + +Make a sale:: + + >>> sale = Sale(point=pos) + + >>> line = sale.lines.new() + >>> line.product = goods + >>> line.quantity = -1 + + >>> sale.save() + >>> sale.total + Decimal('-12.00') + +Add payment:: + + >>> payment = sale.payments.new() + >>> payment.method = cash_method + >>> payment.amount + Decimal('-12.00') + >>> sale.save() + >>> sale.amount_to_pay + Decimal('0.00') + + >>> sale.click('process') + >>> sale.state + 'done' + +Post the sale:: + + >>> sale.click('post') + >>> sale.state + 'posted' + +Check stock move:: + + >>> line, = sale.lines + >>> move, = line.moves + >>> move.product == goods + True + >>> move.from_location == customer_loc + True + >>> move.to_location == input_loc + True + >>> move.state + 'done' + +Check account move:: + + >>> bool(sale.move) + True + + >>> accounts['revenue'].reload() + >>> accounts['revenue'].debit, accounts['revenue'].credit + (Decimal('9.92'), Decimal('0.00')) + + >>> accounts['tax'].reload() + >>> accounts['tax'].debit, accounts['tax'].credit + (Decimal('2.08'), Decimal('0.00')) + + >>> accounts['cash'].reload() + >>> accounts['cash'].debit, accounts['cash'].credit + (Decimal('0.00'), Decimal('12.00')) diff --git a/tests/scenario_sale_point_session.rst b/tests/scenario_sale_point_session.rst new file mode 100644 index 0000000000..72a2661d9a --- /dev/null +++ b/tests/scenario_sale_point_session.rst @@ -0,0 +1,180 @@ +==================== +POS Session Scenario +==================== + +Imports:: + + >>> from decimal import Decimal + + >>> from proteus import Model, Wizard + >>> from trytond.tests.tools import activate_modules + >>> from trytond.modules.company.tests.tools import ( + ... create_company, get_company) + >>> from trytond.modules.account.tests.tools import ( + ... create_fiscalyear, create_chart, get_accounts, create_tax) + >>> from trytond.modules.account_invoice.tests.tools import ( + ... set_fiscalyear_invoice_sequences) + +Activate modules:: + + >>> config = activate_modules('sale_point') + + >>> Journal = Model.get('account.journal') + >>> Location = Model.get('stock.location') + >>> POS = Model.get('sale.point') + >>> PaymentMethod = Model.get('sale.point.payment.method') + >>> ProductCategory = Model.get('product.category') + >>> ProductTemplate = Model.get('product.template') + >>> ProductUom = Model.get('product.uom') + >>> Sale = Model.get('sale.point.sale') + >>> SequenceStrict = Model.get('ir.sequence.strict') + >>> SequenceType = Model.get('ir.sequence.type') + >>> Session = Model.get('sale.point.cash.session') + >>> TransferType = Model.get('sale.point.cash.transfer.type') + +Create company:: + + >>> _ = create_company() + >>> company = get_company() + +Create fiscal year:: + + >>> fiscalyear = set_fiscalyear_invoice_sequences( + ... create_fiscalyear(company)) + >>> fiscalyear.click('create_period') + +Create chart of accounts:: + + >>> _ = create_chart(company) + >>> accounts = get_accounts(company) + +Create account categories:: + + >>> account_category = ProductCategory(name="Account Category") + >>> account_category.accounting = True + >>> account_category.account_revenue = accounts['revenue'] + >>> account_category.save() + +Create product:: + + >>> unit, = ProductUom.find([('name', '=', 'Unit')]) + + >>> template = ProductTemplate() + >>> template.name = 'product' + >>> template.default_uom = unit + >>> template.salable = True + >>> template.account_category = account_category + >>> template.gross_price = Decimal('20.0000') + >>> template.save() + >>> product, = template.products + +Get journal:: + + >>> journal_revenue, = Journal.find([('type', '=', 'revenue')], limit=1) + +Get stock locations:: + + >>> storage_loc, = Location.find([('code', '=', 'STO')]) + >>> customer_loc, = Location.find([('code', '=', 'CUS')]) + +Create POS:: + + >>> pos = POS(name="POS") + >>> pos.journal = journal_revenue + >>> pos.sequence = SequenceStrict(name="POS", company=pos.company) + >>> pos.sequence.sequence_type, = SequenceType.find( + ... [('name', '=', "POS")], limit=1) + >>> pos.sequence.save() + >>> pos.storage_location = storage_loc + >>> pos.customer_location = customer_loc + >>> pos.save() + +Create cash payment method:: + + >>> cash_method = PaymentMethod(name="Cash") + >>> cash_method.account = accounts['cash'] + >>> cash_method.cash = True + >>> cash_method.save() + +Create transfer type:: + + >>> transfer_type = TransferType(name="Bank") + >>> transfer_type.journal, = Journal.find([('type', '=', 'cash')], limit=1) + >>> accounts['bank'], = accounts['cash'].duplicate(default={'name': "Bank"}) + >>> transfer_type.account = accounts['bank'] + >>> transfer_type.save() + +Create an initial cash session:: + + >>> session = Session(point=pos) + >>> transfer = session.transfers.new(point=pos) + >>> transfer.type = transfer_type + >>> transfer.amount = Decimal('100.00') + >>> session.end_amount = Decimal('100.00') + >>> session.save() + >>> session.start_amount + Decimal('0') + >>> session.balance + Decimal('100.00') + >>> session.end_amount + Decimal('100.00') + + >>> session.click('close') + >>> session.state + 'closed' + >>> session.click('post') + >>> session.state + 'posted' + + >>> transfer, = session.transfers + >>> transfer.state + 'posted' + >>> bool(transfer.move) + True + >>> accounts['bank'].reload() + >>> accounts['bank'].balance + Decimal('-100.00') + +Make a sale:: + + >>> sale = Sale(point=pos) + >>> line = sale.lines.new() + >>> line.product = product + >>> line.quantity = 1 + >>> sale.save() + >>> sale.total + Decimal('20.00') + +Pay by cash:: + + >>> payment = Wizard('sale.point.sale.pay', [sale]) + >>> payment.form.method = cash_method + >>> payment.form.amount + Decimal('20.00') + >>> payment.execute('pay') + + >>> sale.state + 'done' + >>> payment, = sale.payments + +Check the new session:: + + >>> session = payment.session + >>> session.state + 'open' + >>> session.start_amount + Decimal('100.00') + >>> session.balance + Decimal('20.00') + +Try to close:: + + >>> session.click('close') # doctest: +IGNORE_EXCEPTION_DETAIL + Traceback (most recent call last): + ... + SessionValidationError: ... + + >>> session.end_amount = Decimal('120.00') + >>> session.click('close') + >>> session.state + 'closed' diff --git a/tests/scenario_sale_point_tax_excluded.rst b/tests/scenario_sale_point_tax_excluded.rst new file mode 100644 index 0000000000..10f587bd7c --- /dev/null +++ b/tests/scenario_sale_point_tax_excluded.rst @@ -0,0 +1,152 @@ +============ +POS Scenario +============ + +Imports:: + + >>> from decimal import Decimal + + >>> from proteus import Model, Wizard, Report + >>> from trytond.tests.tools import activate_modules + >>> from trytond.modules.company.tests.tools import create_company, \ + ... get_company + >>> from trytond.modules.account.tests.tools import create_fiscalyear, \ + ... create_chart, get_accounts, create_tax + >>> from trytond.modules.account_invoice.tests.tools import \ + ... set_fiscalyear_invoice_sequences + +Activate modules:: + + >>> config = activate_modules('sale_point') + +Get models:: + + >>> Journal = Model.get('account.journal') + >>> Location = Model.get('stock.location') + >>> POS = Model.get('sale.point') + >>> PaymentMethod = Model.get('sale.point.payment.method') + >>> ProductCategory = Model.get('product.category') + >>> ProductTemplate = Model.get('product.template') + >>> ProductUom = Model.get('product.uom') + >>> Sale = Model.get('sale.point.sale') + >>> SequenceStrict = Model.get('ir.sequence.strict') + >>> SequenceType = Model.get('ir.sequence.type') + +Create company:: + + >>> _ = create_company() + >>> company = get_company() + +Create fiscal year:: + + >>> fiscalyear = set_fiscalyear_invoice_sequences( + ... create_fiscalyear(company)) + >>> fiscalyear.click('create_period') + +Create chart of accounts:: + + >>> _ = create_chart(company) + >>> accounts = get_accounts(company) + +Create tax:: + + >>> tax = create_tax(Decimal('.21')) + >>> tax.save() + +Create account categories:: + + >>> account_category = ProductCategory(name="Account Category") + >>> account_category.accounting = True + >>> account_category.account_revenue = accounts['revenue'] + >>> account_category.customer_taxes.append(tax) + >>> account_category.save() + +Create product:: + + >>> unit, = ProductUom.find([('name', '=', 'Unit')]) + + >>> template = ProductTemplate() + >>> template.name = 'product' + >>> template.default_uom = unit + >>> template.type = 'goods' + >>> template.salable = True + >>> template.list_price = Decimal('10.0000') + >>> template.account_category = account_category + >>> template.save() + >>> goods, = template.products + +Get journal:: + + >>> journal_revenue, = Journal.find([('type', '=', 'revenue')], limit=1) + +Get stock locations:: + + >>> storage_loc, = Location.find([('code', '=', 'STO')]) + >>> customer_loc, = Location.find([('code', '=', 'CUS')]) + +Create POS:: + + >>> pos = POS(name="POS") + >>> pos.tax_included = False + >>> pos.journal = journal_revenue + >>> pos.sequence = SequenceStrict(name="POS", company=pos.company) + >>> pos.sequence.sequence_type, = SequenceType.find( + ... [('name', '=', "POS")], limit=1) + >>> pos.sequence.save() + >>> pos.storage_location = storage_loc + >>> pos.customer_location = customer_loc + >>> pos.save() + +Create payment method:: + + >>> cash_method = PaymentMethod(name="Cash") + >>> cash_method.account = accounts['cash'] + >>> cash_method.cash = True + >>> cash_method.save() + +Make a sale:: + + >>> sale = Sale(point=pos) + + >>> line = sale.lines.new() + >>> line.product = goods + >>> line.unit_price + Decimal('10.0000') + >>> line.unit_list_price + Decimal('10.0000') + >>> line.unit_gross_price + Decimal('12.1000') + >>> line.quantity = 5 + >>> line.amount + Decimal('50.00') + + >>> sale.total + Decimal('60.50') + >>> sale.total_tax + Decimal('10.50') + + >>> sale.save() + >>> sale.state + 'open' + >>> sale.total + Decimal('60.50') + >>> sale.total_tax + Decimal('10.50') + +Add payment:: + + >>> payment = sale.payments.new() + >>> payment.method = cash_method + >>> sale.save() + >>> sale.amount_to_pay + Decimal('0.00') + + >>> sale.click('process') + >>> sale.state + 'done' + +Post the sale:: + + >>> sale.click('post') + >>> sale.state + 'posted' diff --git a/tests/test_sale_point.py b/tests/test_sale_point.py new file mode 100644 index 0000000000..e9dbd484fe --- /dev/null +++ b/tests/test_sale_point.py @@ -0,0 +1,34 @@ +# This file is part of Tryton. The COPYRIGHT file at the top level of +# this repository contains the full copyright notices and license terms. +import unittest +import doctest +import trytond.tests.test_tryton +from trytond.tests.test_tryton import ModuleTestCase +from trytond.tests.test_tryton import doctest_teardown, doctest_checker + + +class POSTestCase(ModuleTestCase): + "Test POS module" + module = 'sale_point' + + +def suite(): + suite = trytond.tests.test_tryton.suite() + suite.addTests(unittest.TestLoader().loadTestsFromTestCase(POSTestCase)) + suite.addTests(doctest.DocFileSuite('scenario_sale_point.rst', + tearDown=doctest_teardown, encoding='utf-8', + optionflags=doctest.REPORT_ONLY_FIRST_FAILURE, + checker=doctest_checker)) + suite.addTests(doctest.DocFileSuite('scenario_sale_point_tax_excluded.rst', + tearDown=doctest_teardown, encoding='utf-8', + optionflags=doctest.REPORT_ONLY_FIRST_FAILURE, + checker=doctest_checker)) + suite.addTests(doctest.DocFileSuite('scenario_sale_point_return.rst', + tearDown=doctest_teardown, encoding='utf-8', + optionflags=doctest.REPORT_ONLY_FIRST_FAILURE, + checker=doctest_checker)) + suite.addTests(doctest.DocFileSuite('scenario_sale_point_session.rst', + tearDown=doctest_teardown, encoding='utf-8', + optionflags=doctest.REPORT_ONLY_FIRST_FAILURE, + checker=doctest_checker)) + return suite diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000000..1ba170c1e6 --- /dev/null +++ b/tox.ini @@ -0,0 +1,15 @@ +[tox] +envlist = {py36,py37,py38,py39}-{sqlite,postgresql},pypy3-{sqlite,postgresql} + +[testenv] +commands = {envpython} setup.py test +deps = + {py36,py37,py38,py39}-postgresql: psycopg2 >= 2.5 + pypy3-postgresql: psycopg2cffi >= 2.5 + py36-sqlite: sqlitebck +setenv = + sqlite: TRYTOND_DATABASE_URI={env:SQLITE_URI:sqlite://} + postgresql: TRYTOND_DATABASE_URI={env:POSTGRESQL_URI:postgresql://} + sqlite: DB_NAME={env:SQLITE_NAME::memory:} + postgresql: DB_NAME={env:POSTGRESQL_NAME:test} +install_command = pip install --pre --find-links https://trydevpi.tryton.org/?local_version={env:CI_JOB_ID:{env:CI_BUILD_NUMBER:}.{env:CI_JOB_NUMBER:}} {opts} {packages} diff --git a/tryton.cfg b/tryton.cfg new file mode 100644 index 0000000000..968c530513 --- /dev/null +++ b/tryton.cfg @@ -0,0 +1,16 @@ +[tryton] +version=6.1.0 +depends: + account + account_product + company + ir + party + product + res + sale + stock +xml: + sale.xml + product.xml + message.xml diff --git a/view/cash_session_form.xml b/view/cash_session_form.xml new file mode 100644 index 0000000000..df3bc09459 --- /dev/null +++ b/view/cash_session_form.xml @@ -0,0 +1,29 @@ + + +
+