From 4942b8ff62dcd425c29b3320d5a4ccdd1d552391 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?C=C3=A9dric=20Krier?= Date: Tue, 7 Feb 2012 18:37:40 +0100 Subject: [PATCH] Initial commit of purchase_shipment_cost module --- COPYRIGHT | 17 + INSTALL | 32 + LICENSE | 674 ++++++++++++++++++ MANIFEST.in | 10 + README | 36 + __init__.py | 5 + __tryton__.py | 28 + carrier.py | 16 + carrier.xml | 45 ++ doc/index.rst | 21 + setup.py | 81 +++ stock.py | 204 ++++++ stock.xml | 28 + tests/__init__.py | 4 + tests/scenario_purchase_shipment_cost.rst | 156 ++++ ...chase_shipment_cost_with_account_stock.rst | 248 +++++++ tests/test_purchase_shipment_cost.py | 65 ++ 17 files changed, 1670 insertions(+) create mode 100644 COPYRIGHT create mode 100644 INSTALL create mode 100644 LICENSE create mode 100644 MANIFEST.in create mode 100644 README create mode 100644 __init__.py create mode 100644 __tryton__.py create mode 100644 carrier.py create mode 100644 carrier.xml create mode 100644 doc/index.rst create mode 100644 setup.py create mode 100644 stock.py create mode 100644 stock.xml create mode 100644 tests/__init__.py create mode 100644 tests/scenario_purchase_shipment_cost.rst create mode 100644 tests/scenario_purchase_shipment_cost_with_account_stock.rst create mode 100644 tests/test_purchase_shipment_cost.py diff --git a/COPYRIGHT b/COPYRIGHT new file mode 100644 index 0000000000..2e03509ddd --- /dev/null +++ b/COPYRIGHT @@ -0,0 +1,17 @@ +Copyright (C) 2011 Cédric Krier. +Copyright (C) 2011 Bertrand Chenal. +Copyright (C) 2011 Nicolas Évrard. +Copyright (C) 2011 B2CK SPRL. + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see . diff --git a/INSTALL b/INSTALL new file mode 100644 index 0000000000..618c72a001 --- /dev/null +++ b/INSTALL @@ -0,0 +1,32 @@ +Installing trytond_purchase_shipment_cost +========================================= + +Prerequisites +------------- + + * Python 2.6 or later (http://www.python.org/) + * trytond (http://www.tryton.org/) + * trytond_carrier (http://www.tryton.org/) + * trytond_currency (http://www.tryton.org/) + * trytond_stock (http://www.tryton.org/) + +Installation +------------ + +Once you've downloaded and unpacked the trytond_purchase_shipment_cost source release, enter the +directory where the archive was unpacked, and run: + + python setup.py install + +Note that you may need administrator/root privileges for this step, as +this command will by default attempt to install module to the Python +site-packages directory on your system. + +For advanced options, please refer to the easy_install and/or the distutils +documentation: + + http://peak.telecommunity.com/DevCenter/EasyInstall + http://docs.python.org/inst/inst.html + +To use without installation, extract the archive into ``trytond/modules`` with +the directory name purchase_shipment_cost. 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..32879dffb2 --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1,10 @@ +include INSTALL +include README +include TODO +include COPYRIGHT +include CHANGELOG +include LICENSE +include *.xml +include *.odt +include locale/*.po +include doc/* diff --git a/README b/README new file mode 100644 index 0000000000..29c3e9d0e1 --- /dev/null +++ b/README @@ -0,0 +1,36 @@ +trytond_purchase_shipment_cost +============================== + +The purchase_shipment_cost module of the Tryton application platform. +See __tryton__.py + +Installing +---------- + +See INSTALL + +Support +------- + +If you encounter any problems with Tryton, please don't hesitate to ask +questions on the Tryton bug tracker, mailing list, wiki or IRC channel: + + http://bugs.tryton.org/ + http://groups.tryton.org/ + http://wiki.tryton.org/ + irc://irc.freenode.net/tryton + +License +------- + +See LICENSE + +Copyright +--------- + +See COPYRIGHT + + +For more information please visit the Tryton web site: + + http://www.tryton.org/ diff --git a/__init__.py b/__init__.py new file mode 100644 index 0000000000..ca348199cb --- /dev/null +++ b/__init__.py @@ -0,0 +1,5 @@ +#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 stock import * +from carrier import * diff --git a/__tryton__.py b/__tryton__.py new file mode 100644 index 0000000000..078b813b50 --- /dev/null +++ b/__tryton__.py @@ -0,0 +1,28 @@ +# -*- coding: utf-8 -*- +#This file is part of Tryton. The COPYRIGHT file at the top level of +#this repository contains the full copyright notices and license terms. +{ + 'name' : 'Purchase Shipment Cost', + 'version' : '2.3.0', + 'author' : 'B2CK', + 'email': 'info@b2ck.com', + 'website': 'http://www.tryton.org/', + 'description': 'Add purchase shipment cost', + 'depends' : [ + 'ir', + 'res', + 'carrier', + 'currency', + 'stock', + ], + 'extras_depend': [ + 'account_stock_continental', + 'account_product', + ], + 'xml' : [ + 'stock.xml', + 'carrier.xml', + ], + 'translation': [ + ], +} diff --git a/carrier.py b/carrier.py new file mode 100644 index 0000000000..299101f0e0 --- /dev/null +++ b/carrier.py @@ -0,0 +1,16 @@ +#This file is part of Tryton. The COPYRIGHT file at the top level of +#this repository contains the full copyright notices and license terms. +from trytond.model import Model, fields + + +class Carrier(Model): + _name = 'carrier' + + carrier_cost_allocation_method = fields.Selection([ + ('value', 'By Value'), + ], 'Carrier Cost Allocation Method', required=True) + + def default_carrier_cost_allocation_method(self): + return 'value' + +Carrier() diff --git a/carrier.xml b/carrier.xml new file mode 100644 index 0000000000..fc3f6a12b5 --- /dev/null +++ b/carrier.xml @@ -0,0 +1,45 @@ + + + + + + carrier + + + + + + + + ]]> + + + + + carrier + form + + + + + + + + ]]> + + + + diff --git a/doc/index.rst b/doc/index.rst new file mode 100644 index 0000000000..8b9900c142 --- /dev/null +++ b/doc/index.rst @@ -0,0 +1,21 @@ +Purchase Shipment Cost Module +############################# + +The purchase_shipment_cost module adds shipment cost to *Supplier Shipment*. + +One field is added to *Carrier*: + +- *Carrier Cost Allocation Method*: The method used to allocate the cost on + each lines of the shipment. + + - *By Value*: The cost will be allocated according to the value of each + line. (The value is: *Quantity* * *Unit Price*) + +Three new fields are added to *Supplier Shipment*: + +- *Carrier*: The carrier used for the shipment. +- *Cost*: The cost of the shipment. +- *Cost Currency*: The currency of the cost. + +At the reception of the shipment, the unit price of each incoming moves will be +updated according to the allocation of the cost. diff --git a/setup.py b/setup.py new file mode 100644 index 0000000000..986600bd8d --- /dev/null +++ b/setup.py @@ -0,0 +1,81 @@ +#!/usr/bin/env python +#This file is part of Tryton. The COPYRIGHT file at the top level of +#this repository contains the full copyright notices and license terms. + +from setuptools import setup +import re + +info = eval(open('__tryton__.py').read()) +major_version, minor_version, _ = info.get('version', '0.0.1').split('.', 2) +major_version = int(major_version) +minor_version = int(minor_version) + +requires = [] +for dep in info.get('depends', []): + if not re.match(r'(ir|res|workflow|webdav)(\W|$)', dep): + requires.append('trytond_%s >= %s.%s, < %s.%s' % + (dep, major_version, minor_version, major_version, + minor_version + 1)) +requires.append('trytond >= %s.%s, < %s.%s' % + (major_version, minor_version, major_version, minor_version + 1)) + +extras_require = {} +for dep in info.get('extras_depend', []): + if not re.match(r'(ir|res|workflow|webdav)(\W|$)', dep): + extras_require[dep] = ('trytond_%s >= %s.%s, < %s.%s' % + (dep, major_version, minor_version, major_version, + minor_version + 1)) + +tests_require = ['proteus >= %s.%s, < %s.%s' % + (major_version, minor_version, major_version, minor_version + 1)] + +setup(name='trytond_purchase_shipment_cost', + version=info.get('version', '0.0.1'), + description=info.get('description', ''), + author=info.get('author', ''), + author_email=info.get('email', ''), + url=info.get('website', ''), + download_url="http://downloads.tryton.org/" + \ + info.get('version', '0.0.1').rsplit('.', 1)[0] + '/', + package_dir={'trytond.modules.purchase_shipment_cost': '.'}, + packages=[ + 'trytond.modules.purchase_shipment_cost', + 'trytond.modules.purchase_shipment_cost.tests', + ], + package_data={ + 'trytond.modules.purchase_shipment_cost': info.get('xml', []) \ + + info.get('translation', []), + }, + classifiers=[ + 'Development Status :: 5 - Production/Stable', + 'Environment :: Plugins', + 'Intended Audience :: Developers', + 'Intended Audience :: Financial and Insurance Industry', + 'Intended Audience :: Legal Industry', + 'Intended Audience :: Manufacturing', + 'License :: OSI Approved :: GNU General Public License (GPL)', + 'Natural Language :: Bulgarian', + 'Natural Language :: Czech', + 'Natural Language :: Dutch', + 'Natural Language :: English', + 'Natural Language :: French', + 'Natural Language :: German', + 'Natural Language :: Russian', + 'Natural Language :: Spanish', + 'Operating System :: OS Independent', + 'Programming Language :: Python :: 2.6', + 'Programming Language :: Python :: 2.7', + 'Topic :: Office/Business', + ], + license='GPL-3', + install_requires=requires, + extras_require=extras_require, + zip_safe=False, + entry_points=""" + [trytond.modules] + purchase_shipment_cost = trytond.modules.purchase_shipment_cost + """, + 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..a0a2982151 --- /dev/null +++ b/stock.py @@ -0,0 +1,204 @@ +#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 copy +from decimal import Decimal, ROUND_DOWN, ROUND_HALF_EVEN +from operator import itemgetter + +from trytond.model import Model, fields +from trytond.pyson import Eval, Bool +from trytond.pool import Pool +from trytond.transaction import Transaction + + +class ShipmentIn(Model): + _name = 'stock.shipment.in' + + carrier = fields.Many2One('carrier', 'Carrier', states={ + 'readonly': Eval('state') != 'draft', + }, on_change=['carrier', 'incoming_moves'], + depends=['state']) + cost_currency = fields.Many2One('currency.currency', 'Cost Currency', + states={ + 'required': Bool(Eval('cost')), + 'readonly': ~Eval('state').in_(['draft', 'assigned', 'packed']), + }, depends=['cost', 'state']) + cost_currency_digits = fields.Function(fields.Integer( + 'Cost Currency Digits', on_change_with=['currency']), + 'get_cost_currency_digits') + cost = fields.Numeric('Cost', digits=(16, Eval('cost_currency_digits', 2)), + states={ + 'readonly': ~Eval('state').in_(['draft', 'assigned', 'packed']), + }, depends=['carrier', 'state', 'cost_currency_digits']) + + def __init__(self): + super(ShipmentIn, self).__init__() + self.incoming_moves = copy.copy(self.incoming_moves) + if not self.incoming_moves.on_change: + self.incoming_moves.on_change = [] + else: + self.incoming_moves.on_change = copy.copy( + self.incoming_moves.on_change) + for fname in ('carrier', 'incoming_moves'): + if fname not in self.incoming_moves.on_change: + self.incoming_moves.on_change.append(fname) + self._rpc.setdefault('on_change_incoming_moves', False) + self.carrier = copy.copy(self.carrier) + self.carrier.on_change = copy.copy(self.carrier.on_change) + for fname in self.incoming_moves.on_change: + if fname not in self.carrier.on_change: + self.carrier.on_change.append(fname) + self._reset_columns() + + def on_change_with_cost_currency_digits(self, values): + currency_obj = Pool().get('currency.currency') + if values.get('currency'): + currency = currency_obj.browse(values['currency']) + return currency.digits + return 2 + + def get_cost_currency_digits(self, ids, name): + ''' + Return the number of digits of the cost currency + ''' + result = {} + for shipment in self.browse(ids): + if shipment.cost_currency: + result[shipment.id] = shipment.cost_currency.digits + else: + result[shipment.id] = 2 + return result + + def _get_carrier_context(self, values): + return {} + + def on_change_carrier(self, values): + return self.on_change_incoming_moves(values) + + def on_change_incoming_moves(self, values): + pool = Pool() + carrier_obj = pool.get('carrier') + currency_obj = pool.get('currency.currency') + + try: + result = super(ShipmentIn, self).on_change_incoming_moves(values) + except AttributeError: + result = {} + if not values.get('carrier'): + return result + carrier = carrier_obj.browse(values['carrier']) + with Transaction().set_context( + self._get_carrier_context(values)): + cost, currency_id = carrier_obj.get_purchase_price(carrier) + result['cost'] = cost + result['cost_currency'] = currency_id + if currency_id: + currency = currency_obj.browse(currency_id) + result['cost_currency_digits'] = currency.digits + else: + result['cost_currency_digits'] = 2 + return result + + def allocate_cost_by_value(self, shipment): + currency_obj = Pool().get('currency.currency') + move_obj = Pool().get('stock.move') + + if not shipment.cost: + return + + cost = currency_obj.compute(shipment.cost_currency, shipment.cost, + shipment.company.currency, round=False) + moves = [m for m in shipment.incoming_moves + if m.state not in ('done', 'cancel')] + + sum_value = 0 + unit_prices = {} + for move in moves: + unit_price = currency_obj.compute(move.currency, move.unit_price, + shipment.company.currency, round=False) + unit_prices[move.id] = unit_price + sum_value += unit_price * Decimal(str(move.quantity)) + + costs = [] + digit = move_obj.unit_price.digits[1] + exp = Decimal(str(10.0**-digit)) + difference = cost + for move in moves: + quantity = Decimal(str(move.quantity)) + move_cost = cost * quantity * unit_prices[move.id] / sum_value + unit_shipment_cost = (move_cost / quantity).quantize(exp, + rounding=ROUND_DOWN) + costs.append({ + 'unit_shipment_cost': unit_shipment_cost, + 'difference': move_cost - (unit_shipment_cost * quantity), + 'move': move, + }) + difference -= unit_shipment_cost * quantity + costs.sort(key=itemgetter('difference')) + for cost in costs: + move = cost['move'] + quantity = Decimal(str(move.quantity)) + if exp * quantity < difference: + cost['unit_shipment_cost'] = unit_shipment_cost + exp + difference -= exp * quantity + if difference < exp: + break + + for cost in costs: + move = cost['move'] + unit_shipment_cost = currency_obj.compute(shipment.company.currency, + cost['unit_shipment_cost'], move.currency, round=False) + unit_shipment_cost = unit_shipment_cost.quantize(exp, rounding=ROUND_HALF_EVEN) + move_obj.write(move.id, { + 'unit_price': move.unit_price + cost['unit_shipment_cost'], + 'unit_shipment_cost': cost['unit_shipment_cost'], + }) + + def wkf_received(self, shipment): + carrier_obj = Pool().get('carrier') + + if shipment.carrier: + allocation_method = shipment.carrier.carrier_cost_allocation_method + else: + allocation_method = carrier_obj.default_carrier_cost_method() + getattr(self, 'allocate_cost_by_%s' % allocation_method)(shipment) + super(ShipmentIn, self).wkf_received(shipment) + +ShipmentIn() + + +class Move(Model): + _name = 'stock.move' + + unit_shipment_cost = fields.Numeric('Unit Shipment Cost', digits=(16, 4), + readonly=True) + + # Split the shipment cost if account_stock_continental is installed + def _get_account_stock_move_lines(self, move, type_): + currency_obj = Pool().get('currency.currency') + move_lines = super(Move, self)._get_account_stock_move_lines(move, + type_) + if (type_.startswith('in_') + and move.unit_shipment_cost + and move.shipment_in + and move.shipment_in.carrier): + shipment_cost = currency_obj.round(move.company.currency, + Decimal(str(move.quantity)) * move.unit_shipment_cost) + shipment_cost_account = \ + move.shipment_in.carrier.carrier_product.account_expense_used + account_id = move.product.account_stock_supplier_used.id + for move_line in move_lines: + if move_line['account'] == account_id: + move_line['credit'] -= shipment_cost + shipment_cost_line = { + 'name': move.rec_name, + 'debit': Decimal('0'), + 'credit': shipment_cost, + 'account': shipment_cost_account, + } + move_lines.append(shipment_cost_line) + break + else: + raise AssertionError('missing account_stock_supplier') + return move_lines + +Move() diff --git a/stock.xml b/stock.xml new file mode 100644 index 0000000000..7ca4b8e962 --- /dev/null +++ b/stock.xml @@ -0,0 +1,28 @@ + + + + + + stock.shipment.in + form + + + + + + + ]]> + + + + diff --git a/tests/__init__.py b/tests/__init__.py new file mode 100644 index 0000000000..2dc8b82f16 --- /dev/null +++ b/tests/__init__.py @@ -0,0 +1,4 @@ +#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 test_purchase_shipment_cost import suite diff --git a/tests/scenario_purchase_shipment_cost.rst b/tests/scenario_purchase_shipment_cost.rst new file mode 100644 index 0000000000..c139339b07 --- /dev/null +++ b/tests/scenario_purchase_shipment_cost.rst @@ -0,0 +1,156 @@ +=============================== +Purchase Shipment Cost Scenario +=============================== + +============= +General Setup +============= + +Imports:: + + >>> import datetime + >>> from dateutil.relativedelta import relativedelta + >>> from decimal import Decimal + >>> from proteus import config, Model, Wizard + >>> today = datetime.date.today() + +Create database:: + + >>> config = config.set_trytond() + >>> config.pool.test = True + +Install purchase_shipment_cost:: + + >>> Module = Model.get('ir.module.module') + >>> modules = Module.find([ + ... ('name', '=', 'purchase_shipment_cost'), + ... ]) + >>> Module.button_install([x.id for x in modules], config.context) + >>> Wizard('ir.module.module.install_upgrade').execute('upgrade') + +Create company:: + + >>> Currency = Model.get('currency.currency') + >>> CurrencyRate = Model.get('currency.currency.rate') + >>> Company = Model.get('company.company') + >>> company_config = Wizard('company.company.config') + >>> company_config.execute('company') + >>> company = company_config.form + >>> company.name = 'B2CK' + >>> currencies = Currency.find([('code', '=', 'EUR')]) + >>> if not currencies: + ... currency = Currency(name='Euro', symbol=u'€', code='EUR', + ... rounding=Decimal('0.01'), mon_grouping='[3, 3, 0]', + ... mon_decimal_point=',') + ... currency.save() + ... CurrencyRate(date=today + relativedelta(month=1, day=1), + ... rate=Decimal('1.0'), currency=currency).save() + ... else: + ... currency, = currencies + >>> company.currency = currency + >>> company_config.execute('add') + >>> company, = Company.find() + +Reload the context:: + + >>> User = Model.get('res.user') + >>> config._context = User.get_preferences(True, config.context) + +Create supplier:: + + >>> Party = Model.get('party.party') + >>> supplier = Party(name='Supplier') + >>> supplier.save() + +Create category:: + + >>> ProductCategory = Model.get('product.category') + >>> category = ProductCategory(name='Category') + >>> category.save() + +Create products:: + + >>> ProductUom = Model.get('product.uom') + >>> Product = Model.get('product.product') + >>> unit, = ProductUom.find([('name', '=', 'Unit')]) + >>> product = Product() + >>> product.name = 'Product' + >>> product.category = category + >>> product.default_uom = unit + >>> product.type = 'stockable' + >>> product.list_price = Decimal('20') + >>> product.cost_price = Decimal('8') + >>> product.save() + >>> carrier_product = Product() + >>> carrier_product.name = 'Carrier Product' + >>> carrier_product.category = category + >>> carrier_product.default_uom = unit + >>> carrier_product.type = 'service' + >>> carrier_product.list_price = Decimal('5') + >>> carrier_product.cost_price = Decimal('3') + >>> carrier_product.save() + +Create carrier:: + + >>> Carrier = Model.get('carrier') + >>> carrier = Carrier() + >>> carrier.name = 'Carrier' + >>> carrier.carrier_product = carrier_product + >>> carrier.save() + +Receive a single product line:: + + >>> ShipmentIn = Model.get('stock.shipment.in') + >>> Move = Model.get('stock.move') + >>> Location = Model.get('stock.location') + >>> supplier_location, = Location.find([ + ... ('code', '=', 'SUP'), + ... ]) + >>> shipment = ShipmentIn() + >>> shipment.supplier = supplier + >>> move = Move() + >>> shipment.incoming_moves.append(move) + >>> move.from_location = supplier_location + >>> move.to_location = shipment.warehouse.input_location + >>> move.product = product + >>> move.quantity = 50 + >>> move.unit_price == Decimal('8') + True + >>> shipment.carrier = carrier + >>> shipment.cost == Decimal('3') + True + >>> shipment.cost_currency == currency + True + >>> shipment.save() + >>> ShipmentIn.workflow_trigger_validate(shipment.id, 'received', + ... config.context) + >>> shipment.reload() + >>> shipment.state + u'received' + >>> move, = shipment.incoming_moves + >>> move.unit_price == Decimal('8.0600') + True + +Receive many product lines:: + + >>> shipment = ShipmentIn() + >>> shipment.supplier = supplier + >>> for quantity in (1, 3, 5): + ... move = Move() + ... shipment.incoming_moves.append(move) + ... move.from_location = supplier_location + ... move.to_location = shipment.warehouse.input_location + ... move.product = product + ... move.quantity = quantity + >>> shipment.carrier = carrier + >>> shipment.cost == Decimal('3') + True + >>> shipment.save() + >>> ShipmentIn.workflow_trigger_validate(shipment.id, 'received', + ... config.context) + >>> shipment.reload() + >>> shipment.state + u'received' + >>> [move.unit_price for move in shipment.incoming_moves] == \ + ... [Decimal('8.3333'), Decimal('8.3333'), Decimal('8.3334')] + True diff --git a/tests/scenario_purchase_shipment_cost_with_account_stock.rst b/tests/scenario_purchase_shipment_cost_with_account_stock.rst new file mode 100644 index 0000000000..12c3369193 --- /dev/null +++ b/tests/scenario_purchase_shipment_cost_with_account_stock.rst @@ -0,0 +1,248 @@ +================================================== +Purchase Shipment Cost with Account Stock Scenario +================================================== + +============= +General Setup +============= + +Imports:: + + >>> import datetime + >>> from dateutil.relativedelta import relativedelta + >>> from decimal import Decimal + >>> from proteus import config, Model, Wizard + >>> today = datetime.date.today() + +Create database:: + + >>> config = config.set_trytond() + >>> config.pool.test = True + +Install purchase_shipment_cost:: + + >>> Module = Model.get('ir.module.module') + >>> modules = Module.find([ + ... ('name', 'in', ['purchase_shipment_cost', + ... 'account_stock_continental']), + ... ]) + >>> Module.button_install([x.id for x in modules], config.context) + >>> Wizard('ir.module.module.install_upgrade').execute('upgrade') + +Create company:: + + >>> Currency = Model.get('currency.currency') + >>> CurrencyRate = Model.get('currency.currency.rate') + >>> Company = Model.get('company.company') + >>> company_config = Wizard('company.company.config') + >>> company_config.execute('company') + >>> company = company_config.form + >>> company.name = 'B2CK' + >>> currencies = Currency.find([('code', '=', 'EUR')]) + >>> if not currencies: + ... currency = Currency(name='Euro', symbol=u'€', code='EUR', + ... rounding=Decimal('0.01'), mon_grouping='[3, 3, 0]', + ... mon_decimal_point=',') + ... currency.save() + ... CurrencyRate(date=today + relativedelta(month=1, day=1), + ... rate=Decimal('1.0'), currency=currency).save() + ... else: + ... currency, = currencies + >>> company.currency = currency + >>> company_config.execute('add') + >>> company, = Company.find() + +Reload the context:: + + >>> User = Model.get('res.user') + >>> config._context = User.get_preferences(True, config.context) + +Create fiscal year:: + + >>> FiscalYear = Model.get('account.fiscalyear') + >>> Sequence = Model.get('ir.sequence') + >>> SequenceStrict = Model.get('ir.sequence.strict') + >>> fiscalyear = FiscalYear(name='%s' % today.year) + >>> fiscalyear.start_date = today + relativedelta(month=1, day=1) + >>> fiscalyear.end_date = today + relativedelta(month=12, day=31) + >>> fiscalyear.company = company + >>> post_move_sequence = Sequence(name='%s' % today.year, + ... code='account.move', + ... company=company) + >>> post_move_sequence.save() + >>> fiscalyear.post_move_sequence = post_move_sequence + >>> fiscalyear.save() + >>> FiscalYear.create_period([fiscalyear.id], config.context) + True + +Create chart of accounts:: + + >>> AccountTemplate = Model.get('account.account.template') + >>> Account = Model.get('account.account') + >>> AccountJournal = Model.get('account.journal') + >>> account_template, = AccountTemplate.find([('parent', '=', False)]) + >>> create_chart = Wizard('account.create_chart') + >>> create_chart.execute('account') + >>> create_chart.form.account_template = account_template + >>> create_chart.form.company = company + >>> create_chart.execute('create_account') + >>> receivable, = Account.find([ + ... ('kind', '=', 'receivable'), + ... ('company', '=', company.id), + ... ]) + >>> payable, = Account.find([ + ... ('kind', '=', 'payable'), + ... ('company', '=', company.id), + ... ]) + >>> revenue, = Account.find([ + ... ('kind', '=', 'revenue'), + ... ('company', '=', company.id), + ... ]) + >>> expense, = Account.find([ + ... ('kind', '=', 'expense'), + ... ('company', '=', company.id), + ... ]) + >>> stock, stock_supplier, stock_lost_found, stock_customer = Account.find([ + ... ('kind', '=', 'other'), + ... ('company', '=', company.id), + ... ('name', 'like', 'Stock%'), + ... ], order=[('name', 'ASC')]) + >>> create_chart.form.account_receivable = receivable + >>> create_chart.form.account_payable = payable + >>> create_chart.execute('create_properties') + >>> stock_journal, = AccountJournal.find([('code', '=', 'STO')]) + +Create supplier:: + + >>> Party = Model.get('party.party') + >>> supplier = Party(name='Supplier') + >>> supplier.save() + +Create category:: + + >>> ProductCategory = Model.get('product.category') + >>> category = ProductCategory(name='Category') + >>> category.save() + +Create products:: + + >>> ProductUom = Model.get('product.uom') + >>> Product = Model.get('product.product') + >>> unit, = ProductUom.find([('name', '=', 'Unit')]) + >>> product = Product() + >>> product.name = 'Product' + >>> product.category = category + >>> product.default_uom = unit + >>> product.type = 'stockable' + >>> product.list_price = Decimal('20') + >>> product.cost_price = Decimal('8') + >>> product.account_expense = expense + >>> product.account_revenue = revenue + >>> product.account_stock = stock + >>> product.account_stock_supplier = stock_supplier + >>> product.account_stock_customer = stock_customer + >>> product.account_stock_lost_found = stock_lost_found + >>> product.account_journal_stock_supplier = stock_journal + >>> product.account_journal_stock_customer = stock_journal + >>> product.account_journal_stock_lost_found = stock_journal + >>> product.save() + + >>> carrier_product = Product() + >>> carrier_product.name = 'Carrier Product' + >>> carrier_product.category = category + >>> carrier_product.default_uom = unit + >>> carrier_product.type = 'service' + >>> carrier_product.list_price = Decimal('5') + >>> carrier_product.cost_price = Decimal('3') + >>> carrier_product.account_expense = expense + >>> carrier_product.account_revenue = revenue + >>> carrier_product.save() + +Create carrier:: + + >>> Carrier = Model.get('carrier') + >>> carrier = Carrier() + >>> carrier.name = 'Carrier' + >>> carrier.carrier_product = carrier_product + >>> carrier.save() + +Receive a single product line:: + + >>> ShipmentIn = Model.get('stock.shipment.in') + >>> Move = Model.get('stock.move') + >>> Location = Model.get('stock.location') + >>> supplier_location, = Location.find([ + ... ('code', '=', 'SUP'), + ... ]) + >>> shipment = ShipmentIn() + >>> shipment.supplier = supplier + >>> move = Move() + >>> shipment.incoming_moves.append(move) + >>> move.from_location = supplier_location + >>> move.to_location = shipment.warehouse.input_location + >>> move.product = product + >>> move.quantity = 50 + >>> move.unit_price == Decimal('8') + True + >>> shipment.carrier = carrier + >>> shipment.cost == Decimal('3') + True + >>> shipment.cost_currency == currency + True + >>> shipment.save() + >>> ShipmentIn.workflow_trigger_validate(shipment.id, 'received', + ... config.context) + >>> shipment.reload() + >>> shipment.state + u'received' + >>> move, = shipment.incoming_moves + >>> move.unit_price == Decimal('8.0600') + True + >>> stock_supplier.reload() + >>> (stock_supplier.debit, stock_supplier.credit) == \ + ... (Decimal('0.00'), Decimal('400.00')) + True + >>> expense.reload() + >>> (expense.debit, expense.credit) == \ + ... (Decimal('0.00'), Decimal('3.00')) + True + >>> stock.reload() + >>> (stock.debit, stock.credit) == \ + ... (Decimal('403.00'), Decimal('0.00')) + True + +Receive many product lines:: + + >>> shipment = ShipmentIn() + >>> shipment.supplier = supplier + >>> for quantity in (1, 3, 5): + ... move = Move() + ... shipment.incoming_moves.append(move) + ... move.from_location = supplier_location + ... move.to_location = shipment.warehouse.input_location + ... move.product = product + ... move.quantity = quantity + >>> shipment.carrier = carrier + >>> shipment.cost == Decimal('3') + True + >>> shipment.save() + >>> ShipmentIn.workflow_trigger_validate(shipment.id, 'received', + ... config.context) + >>> shipment.reload() + >>> shipment.state + u'received' + >>> [move.unit_price for move in shipment.incoming_moves] == \ + ... [Decimal('8.3333'), Decimal('8.3333'), Decimal('8.3334')] + True + >>> stock_supplier.reload() + >>> (stock_supplier.debit, stock_supplier.credit) == \ + ... (Decimal('0.00'), Decimal('472.00')) + True + >>> expense.reload() + >>> (expense.debit, expense.credit) == \ + ... (Decimal('0.00'), Decimal('6.00')) + True + >>> stock.reload() + >>> (stock.debit, stock.credit) == \ + ... (Decimal('478.00'), Decimal('0.00')) + True diff --git a/tests/test_purchase_shipment_cost.py b/tests/test_purchase_shipment_cost.py new file mode 100644 index 0000000000..0a91327195 --- /dev/null +++ b/tests/test_purchase_shipment_cost.py @@ -0,0 +1,65 @@ +#!/usr/bin/env python +#This file is part of Tryton. The COPYRIGHT file at the top level of +#this repository contains the full copyright notices and license terms. +import sys, os +DIR = os.path.abspath(os.path.normpath(os.path.join(__file__, + '..', '..', '..', '..', '..', 'trytond'))) +if os.path.isdir(DIR): + sys.path.insert(0, os.path.dirname(DIR)) + +import unittest +import doctest +import trytond.tests.test_tryton +from trytond.tests.test_tryton import test_view, test_depends +from trytond.backend.sqlite.database import Database as SQLiteDatabase + + +class PurchaseShipmentCostTestCase(unittest.TestCase): + ''' + Test Purchase Shipment Cost module. + ''' + + def setUp(self): + trytond.tests.test_tryton.install_module('purchase_shipment_cost') + + def test0005views(self): + ''' + Test views. + ''' + test_view('purchase_shipment_cost') + + def test0006depends(self): + ''' + Test depends. + ''' + test_depends() + + +def doctest_dropdb(test): + ''' + Remove sqlite memory database + ''' + database = SQLiteDatabase().connect() + cursor = database.cursor(autocommit=True) + try: + database.drop(cursor, ':memory:') + cursor.commit() + finally: + cursor.close() + + +def suite(): + suite = trytond.tests.test_tryton.suite() + suite.addTests(unittest.TestLoader().loadTestsFromTestCase( + PurchaseShipmentCostTestCase)) + suite.addTests(doctest.DocFileSuite('scenario_purchase_shipment_cost.rst', + setUp=doctest_dropdb, tearDown=doctest_dropdb, encoding='utf-8', + optionflags=doctest.REPORT_ONLY_FIRST_FAILURE)) + suite.addTests(doctest.DocFileSuite( + 'scenario_purchase_shipment_cost_with_account_stock.rst', + setUp=doctest_dropdb, tearDown=doctest_dropdb, encoding='utf-8', + optionflags=doctest.REPORT_ONLY_FIRST_FAILURE)) + return suite + +if __name__ == '__main__': + unittest.TextTestRunner(verbosity=2).run(suite())