changeset 10afe35948b5 in modules/account_statement_rule:default
details:
https://hg.tryton.org/modules/account_statement_rule?cmd=changeset;node=10afe35948b5
description:
Initial commit
issue7925
review45851002
diffstat:
.drone.yml | 51 ++
COPYRIGHT | 14 +
INSTALL | 29 +
LICENSE | 674 ++++++++++++++++++++++++++++++
MANIFEST.in | 6 +
README | 32 +
__init__.py | 20 +
account.py | 384 +++++++++++++++++
account.xml | 153 ++++++
doc/index.rst | 54 ++
setup.py | 123 +++++
tests/__init__.py | 9 +
tests/scenario_account_statement_rule.rst | 104 ++++
tests/test_account_statement_rule.py | 27 +
tox.ini | 15 +
tryton.cfg | 13 +
view/rule_form.xml | 31 +
view/rule_information_form.xml | 32 +
view/rule_information_list.xml | 7 +
view/rule_line_form.xml | 18 +
view/rule_line_list.xml | 9 +
view/rule_list.xml | 6 +
view/statement_form.xml | 8 +
view/statement_tree.xml | 8 +
24 files changed, 1827 insertions(+), 0 deletions(-)
diffs (1923 lines):
diff -r 000000000000 -r 10afe35948b5 .drone.yml
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/.drone.yml Thu Jan 17 17:32:53 2019 +0100
@@ -0,0 +1,51 @@
+clone:
+ hg:
+ image: plugins/hg
+
+pipeline:
+ tox:
+ image: ${IMAGE}
+ environment:
+ - CFLAGS=-O0
+ - DB_CACHE=/cache
+ - TOX_TESTENV_PASSENV=CFLAGS DB_CACHE
+ - POSTGRESQL_URI=postgresql://postgres@postgresql:5432/
+ commands:
+ - pip install tox
+ - tox -e "${TOXENV}-${DATABASE}"
+ volumes:
+ - cache:/root/.cache
+
+services:
+ postgresql:
+ image: postgres
+ when:
+ matrix:
+ DATABASE: postgresql
+
+matrix:
+ include:
+ - IMAGE: python:3.4
+ TOXENV: py34
+ DATABASE: sqlite
+ - IMAGE: python:3.4
+ TOXENV: py34
+ DATABASE: postgresql
+ - IMAGE: python:3.5
+ TOXENV: py35
+ DATABASE: sqlite
+ - IMAGE: python:3.5
+ TOXENV: py35
+ DATABASE: postgresql
+ - 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
diff -r 000000000000 -r 10afe35948b5 COPYRIGHT
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/COPYRIGHT Thu Jan 17 17:32:53 2019 +0100
@@ -0,0 +1,14 @@
+Copyright (C) 2018 Cédric Krier
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program. If not, see <http://www.gnu.org/licenses/>.
diff -r 000000000000 -r 10afe35948b5 INSTALL
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/INSTALL Thu Jan 17 17:32:53 2019 +0100
@@ -0,0 +1,29 @@
+Installing trytond_account_statement_rule
+=========================================
+
+Prerequisites
+-------------
+
+ * Python 3.4 or later (http://www.python.org/)
+ * trytond (http://www.tryton.org/)
+
+Installation
+------------
+
+Once you've downloaded and unpacked the trytond_account_statement_rule 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://setuptools.readthedocs.io/en/latest/easy_install.html
+ http://docs.python.org/inst/inst.html
+
+To use without installation, extract the archive into ``trytond/modules`` with
+the directory name account_statement_rule.
diff -r 000000000000 -r 10afe35948b5 LICENSE
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/LICENSE Thu Jan 17 17:32:53 2019 +0100
@@ -0,0 +1,674 @@
+ GNU GENERAL PUBLIC LICENSE
+ Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ 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.
+
+ <one line to give the program's name and a brief idea of what it does.>
+ Copyright (C) <year> <name of author>
+
+ 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 <http://www.gnu.org/licenses/>.
+
+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:
+
+ <program> Copyright (C) <year> <name of author>
+ 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
+<http://www.gnu.org/licenses/>.
+
+ 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
+<http://www.gnu.org/philosophy/why-not-lgpl.html>.
diff -r 000000000000 -r 10afe35948b5 MANIFEST.in
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/MANIFEST.in Thu Jan 17 17:32:53 2019 +0100
@@ -0,0 +1,6 @@
+include INSTALL
+include README
+include COPYRIGHT
+include CHANGELOG
+include LICENSE
+include doc/*
diff -r 000000000000 -r 10afe35948b5 README
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/README Thu Jan 17 17:32:53 2019 +0100
@@ -0,0 +1,32 @@
+trytond_account_statement_rule
+==============================
+
+The account_statement_rule module of the Tryton application platform.
+
+Installing
+----------
+
+See INSTALL
+
+Support
+-------
+
+If you encounter any problems with Tryton, please don't hesitate to ask
+questions on the Tryton forum or IRC channel:
+
+ http://www.tryton.org/forum
+
+License
+-------
+
+See LICENSE
+
+Copyright
+---------
+
+See COPYRIGHT
+
+
+For more information please visit the Tryton web site:
+
+ http://www.tryton.org/
diff -r 000000000000 -r 10afe35948b5 __init__.py
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/__init__.py Thu Jan 17 17:32:53 2019 +0100
@@ -0,0 +1,20 @@
+# 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 account
+
+__all__ = ['register']
+
+
+def register():
+ Pool.register(
+ account.Statement,
+ account.StatementRule,
+ account.StatementRuleInformation,
+ account.StatementRuleLine,
+ module='account_statement_rule', type_='model')
+ Pool.register(
+ module='account_statement_rule', type_='wizard')
+ Pool.register(
+ module='account_statement_rule', type_='report')
diff -r 000000000000 -r 10afe35948b5 account.py
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/account.py Thu Jan 17 17:32:53 2019 +0100
@@ -0,0 +1,384 @@
+# 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 json
+import re
+from decimal import Decimal
+
+from simpleeval import simple_eval
+
+from trytond.model import ModelSQL, ModelView, sequence_ordered, fields
+from trytond.pool import Pool, PoolMeta
+from trytond.pyson import If, Eval
+from trytond.tools import decistmt
+from trytond.transaction import Transaction
+
+
+class Statement(metaclass=PoolMeta):
+ __name__ = 'account.statement'
+
+ @classmethod
+ def __setup__(cls):
+ super().__setup__()
+ cls._buttons.update(
+ apply_rules={
+ 'invisible': Eval('state') != 'draft',
+ 'depends': ['state'],
+ },
+ )
+
+ @classmethod
+ @ModelView.button
+ def apply_rules(cls, statements):
+ pool = Pool()
+ Rule = pool.get('account.statement.rule')
+ Line = pool.get('account.statement.line')
+
+ lines = []
+ rules = Rule.search([])
+ for statement in statements:
+ lines.extend(statement._apply_rules(rules))
+ Line.save(lines)
+
+ def _apply_rules(self, rules):
+ for origin in self.origins:
+ if origin.lines:
+ continue
+ for rule in rules:
+ keywords = rule.match(origin)
+ if keywords:
+ yield from rule.apply(origin, keywords)
+
+
+class StatementRule(sequence_ordered(), ModelSQL, ModelView):
+ "Account Statement Rule"
+ __name__ = 'account.statement.rule'
+
+ name = fields.Char("Name")
+
+ company = fields.Many2One('company.company', "Company")
+ journal = fields.Many2One(
+ 'account.statement.journal', "Journal",
+ domain=[
+ If(Eval('company'),
+ ('company', '=', Eval('company')),
+ ()),
+ ],
+ depends=['company'])
+ amount_low = fields.Numeric(
+ "Amount Low",
+ digits=(16, Eval('currency_digits', 2)),
+ domain=[If(Eval('amount_high'),
+ ['OR',
+ ('amount_low', '=', None),
+ ('amount_low', '<=', Eval('amount_high')),
+ ],
+ [])],
+ depends=['currency_digits', 'amount_high'])
+ amount_high = fields.Numeric(
+ "Amount High",
+ digits=(16, Eval('currency_digits', 2)),
+ domain=[If(Eval('amount_low'),
+ ['OR',
+ ('amount_high', '=', None),
+ ('amount_high', '>=', Eval('amount_low')),
+ ],
+ [])],
+ depends=['currency_digits', 'amount_low'])
+ description = fields.Char("Description",
+ help="The regular expression the description is searched with.\n"
+ "It may define the groups named:\n"
+ "'party', 'bank_account', 'invoice'.")
+ information_rules = fields.One2Many(
+ 'account.statement.rule.information', 'rule', "Information Rules")
+
+ lines = fields.One2Many(
+ 'account.statement.rule.line', 'rule', "Lines")
+
+ currency_digits = fields.Function(
+ fields.Integer("Currency Digits"),
+ 'on_change_with_currency_digits')
+
+ @fields.depends('journal')
+ def on_change_with_currency_digits(self, name=None):
+ if self.journal:
+ return self.journal.currency.digits
+ return None
+
+ def match(self, origin):
+ keywords = {}
+ if self.company and self.company != origin.company:
+ return False
+ if self.journal and self.journal != origin.statement.journal:
+ return False
+ if self.amount_low is not None and self.amount_low > origin.amount:
+ return False
+ if self.amount_high is not None and self.amount_high < origin.amount:
+ return False
+ if self.information_rules:
+ for irule in self.information_rules:
+ result = irule.match(origin)
+ if isinstance(result, dict):
+ keywords.update(result)
+ elif not result:
+ return False
+ if self.description:
+ result = re.search(self.description, origin.description or '')
+ if not result:
+ return False
+ keywords.update(result.groupdict())
+ keywords.update(amount=origin.amount, pending=origin.amount)
+ return keywords
+
+ def apply(self, origin, keywords):
+ keywords = keywords.copy()
+ for rule_line in self.lines:
+ line = rule_line.get_line(origin, keywords)
+ if not line:
+ return
+ keywords['pending'] -= line.amount
+ yield line
+
+
+class StatementRuleInformation(sequence_ordered(), ModelSQL, ModelView):
+ "Account Statement Rule Information"
+ __name__ = 'account.statement.rule.information'
+
+ rule = fields.Many2One(
+ 'account.statement.rule', "Rule", required=True, ondelete='CASCADE')
+ key = fields.Many2One(
+ 'account.statement.origin.information', "Key", required=True,
+ domain=[
+ ('type_', 'in', [
+ 'boolean', 'integer', 'float', 'number', 'char',
+ 'selection']),
+ ])
+
+ boolean = fields.Boolean("Boolean",
+ states={
+ 'invisible': Eval('key_type') != 'boolean',
+ },
+ depends=['key_type'])
+ char = fields.Char("Char",
+ states={
+ 'invisible': Eval('key_type') != 'char',
+ },
+ depends=['key_type'],
+ help="The regular expression the key information is searched with.\n"
+ "It may define the groups named:\n"
+ "party, bank_account, invoice.")
+ selection = fields.Selection(
+ 'get_selections', "Selection",
+ states={
+ 'invisible': Eval('key_type') != 'selection',
+ },
+ depends=['key_type'])
+
+ key_type = fields.Function(
+ fields.Selection('get_key_types', "Key Type"),
+ 'on_change_with_key_type')
+
+ @classmethod
+ def get_key_types(cls):
+ pool = Pool()
+ OriginInformation = pool.get('account.statement.origin.information')
+ return OriginInformation.fields_get(['type_'])['type_']['selection']
+
+ @fields.depends('key')
+ def on_change_with_key_type(self, name=None):
+ if self.key:
+ return self.key.type_
+
+ @fields.depends('key')
+ def get_selections(self):
+ if self.key and self.key.type == 'selection':
+ return json.loads(self.key.selection_json)
+ return [(None, '')]
+
+ @classmethod
+ def view_attributes(cls):
+ return [
+ ('//group[@id="%s"]' % type_, 'states', {
+ 'invisible': Eval('key_type') != type_,
+ }) for type_ in ['integer', 'float', 'number']]
+
+ def match(self, origin):
+ return getattr(self, '_match_%s' % self.key_type)(
+ origin, origin.information or {})
+
+ def _match_boolean(self, origin, information):
+ return self.boolean == information.get(self.key.name, False)
+
+ def _match_range(self, origin, information):
+ low = getattr(self, '%s_low' % self.key_type)
+ high = getattr(self, '%_high' % self.key_type)
+ amount = information.get(self.key.name)
+ if amount is None:
+ return False
+ if low is not None and low > amount:
+ return False
+ if high is not None and high < amount:
+ return False
+ _match_integer = _match_range
+ _match_float = _match_range
+ _match_number = _match_range
+
+ def _match_char(self, origin, information):
+ result = re.search(
+ self.char, information.get(self.key.name, ''))
+ if not result:
+ return False
+ return result.groupdict()
+
+ def _match_selection(self, origin, information):
+ return self.selection == information.get(self.key.name)
+
+
+def _add_range(cls, name, type_, string):
+ low_name = '%s_low' % name
+ high_name = '%s_high' % name
+ setattr(cls, low_name,
+ type_("%s Low" % string,
+ domain=[If(Eval(high_name),
+ ['OR',
+ (low_name, '=', None),
+ (low_name, '<=', Eval(high_name)),
+ ],
+ [])],
+ states={
+ 'invisible': Eval('key_type') != name,
+ },
+ depends=['key_type', high_name]))
+ setattr(cls, high_name,
+ type_("%s High" % string,
+ domain=[If(Eval(low_name),
+ ['OR',
+ (high_name, '=', None),
+ (high_name, '<=', Eval(low_name)),
+ ],
+ [])],
+ states={
+ 'invisible': Eval('key_type') != name,
+ },
+ depends=['key_type', low_name]))
+
+
+_add_range(StatementRuleInformation, 'integer', fields.Integer, "Integer")
+_add_range(StatementRuleInformation, 'float', fields.Float, "Float")
+_add_range(StatementRuleInformation, 'number', fields.Numeric, "Numeric")
+
+
+class StatementRuleLine(sequence_ordered(), ModelSQL, ModelView):
+ "Account Statement Rule Line"
+ __name__ = 'account.statement.rule.line'
+
+ rule = fields.Many2One(
+ 'account.statement.rule', "Rule", required=True, ondelete='CASCADE')
+ amount = fields.Char(
+ "Amount", required=True,
+ help="A Python expression evaluated with 'amount' and 'pending'.")
+ party = fields.Many2One(
+ 'party.party', "Party",
+ help="Leave empty to use the group named 'party' "
+ "from the regular expressions.")
+ account = fields.Many2One(
+ 'account.account', "Account",
+ domain=[
+ ('company', '=', Eval('company')),
+ ('kind', '!=', 'view'),
+ ],
+ states={
+ 'readonly': ~Eval('company'),
+ },
+ depends=['company'],
+ help="Leave empty to use the party's receivable or payable account.\n"
+ "The rule must have a company to use this field.")
+
+ company = fields.Function(
+ fields.Many2One('company.company', "Company"),
+ 'on_change_with_company')
+
+ @fields.depends('rule')
+ def on_change_with_company(self, name=None):
+ if self.rule and self.rule.company:
+ return self.rule.company.id
+
+ def get_line(self, origin, keywords, **context):
+ pool = Pool()
+ Line = pool.get('account.statement.line')
+ context.setdefault('functions', {})['Decimal'] = Decimal
+ context.setdefault('names', {}).update(keywords)
+
+ currency = origin.statement.journal.currency
+ amount = currency.round(simple_eval(decistmt(self.amount), **context))
+ party = self._get_party(origin, keywords)
+ invoice = self._get_invoice(origin, keywords)
+
+ if invoice and party and invoice.party != party:
+ return
+ if invoice and not party:
+ party = invoice.party
+
+ account = self.account
+ if not account:
+ if invoice:
+ account = invoice.account
+ elif party:
+ with Transaction().set_context(date=origin.date):
+ if amount > Decimal('0.0'):
+ account = party.account_receivable_used
+ else:
+ account = party.account_payable_used
+
+ if not account:
+ return
+ if account.party_required and not party:
+ return
+ if not account.party_required:
+ party = None
+
+ line = Line()
+ line.statement = origin.statement
+ line.origin = origin
+ line.amount = amount
+ line.date = origin.date
+ line.party = party
+ line.account = account
+ line.invoice = invoice
+ return line
+
+ def _get_party(self, origin, keywords):
+ pool = Pool()
+ Party = pool.get('party.party')
+ try:
+ AccountNumber = pool.get('bank.account.number')
+ except KeyError:
+ AccountNumber = None
+
+ party = self.party
+ if not party:
+ if keywords.get('bank_account') and AccountNumber:
+ bank_account = keywords['bank_account']
+ numbers = AccountNumber.search(['OR',
+ ('number', '=', bank_account),
+ ('number_compact', '=', bank_account),
+ ])
+ if len(numbers) == 1:
+ number, = numbers
+ if number.account.owners:
+ party = number.account.owners[0]
+ elif keywords.get('party'):
+ parties = Party.search(
+ [('rec_name', 'ilike', keywords['party'])])
+ if len(parties) == 1:
+ party, = parties
+ return party
+
+ def _get_invoice(self, origin, keywords):
+ pool = Pool()
+ Invoice = pool.get('account.invoice')
+ if keywords.get('invoice'):
+ invoices = Invoice.search([('rec_name', '=', keywords['invoice'])])
+ if len(invoices) == 1:
+ invoice, = invoices
+ return invoice
diff -r 000000000000 -r 10afe35948b5 account.xml
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/account.xml Thu Jan 17 17:32:53 2019 +0100
@@ -0,0 +1,153 @@
+<?xml version="1.0"?>
+<!-- This file is part of Tryton. The COPYRIGHT file at the top level of
+this repository contains the full copyright notices and license terms. -->
+<tryton>
+ <data>
+ <record model="ir.ui.view" id="statement_view_form">
+ <field name="model">account.statement</field>
+ <field name="inherit" ref="account_statement.statement_view_form"/>
+ <field name="name">statement_form</field>
+ </record>
+
+ <record model="ir.ui.view" id="statement_view_tree">
+ <field name="model">account.statement</field>
+ <field name="inherit" ref="account_statement.statement_view_tree"/>
+ <field name="name">statement_tree</field>
+ </record>
+
+ <record model="ir.model.button" id="statement_apply_rules_button">
+ <field name="name">apply_rules</field>
+ <field name="string">Apply Rules</field>
+ <field name="model" search="[('model', '=',
'account.statement')]"/>
+ </record>
+
+ <record model="ir.ui.view" id="rule_view_form">
+ <field name="model">account.statement.rule</field>
+ <field name="type">form</field>
+ <field name="name">rule_form</field>
+ </record>
+
+ <record model="ir.ui.view" id="rule_view_list">
+ <field name="model">account.statement.rule</field>
+ <field name="type">tree</field>
+ <field name="name">rule_list</field>
+ </record>
+
+ <record model="ir.action.act_window" id="act_rule_form">
+ <field name="name">Rules</field>
+ <field name="res_model">account.statement.rule</field>
+ </record>
+ <record model="ir.action.act_window.view" id="act_rule_form_view1">
+ <field name="sequence" eval="10"/>
+ <field name="view" ref="rule_view_list"/>
+ <field name="act_window" ref="act_rule_form"/>
+ </record>
+ <record model="ir.action.act_window.view" id="act_rule_form_view2">
+ <field name="sequence" eval="20"/>
+ <field name="view" ref="rule_view_form"/>
+ <field name="act_window" ref="act_rule_form"/>
+ </record>
+
+ <menuitem
+ parent="account_statement.menu_statement_configuration"
+ sequence="20"
+ action="act_rule_form"
+ id="menu_rule_form"/>
+
+ <record model="ir.model.access" id="access_rule">
+ <field name="model" search="[('model', '=',
'account.statement.rule')]"/>
+ <field name="perm_read" eval="False"/>
+ <field name="perm_write" eval="False"/>
+ <field name="perm_create" eval="False"/>
+ <field name="perm_delete" eval="False"/>
+ </record>
+ <record model="ir.model.access" id="access_rule_account_admin">
+ <field name="model" search="[('model', '=',
'account.statement.rule')]"/>
+ <field name="group" ref="account.group_account_admin"/>
+ <field name="perm_read" eval="True"/>
+ <field name="perm_write" eval="True"/>
+ <field name="perm_create" eval="True"/>
+ <field name="perm_delete" eval="True"/>
+ </record>
+ <record model="ir.model.access" id="access_rule_statement">
+ <field name="model" search="[('model', '=',
'account.statement.rule')]"/>
+ <field name="group" ref="account_statement.group_statement"/>
+ <field name="perm_read" eval="True"/>
+ <field name="perm_write" eval="False"/>
+ <field name="perm_create" eval="False"/>
+ <field name="perm_delete" eval="False"/>
+ </record>
+
+ <record model="ir.ui.view" id="rule_information_view_form">
+ <field name="model">account.statement.rule.information</field>
+ <field name="type">form</field>
+ <field name="name">rule_information_form</field>
+ </record>
+
+ <record model="ir.ui.view" id="rule_information_view_list">
+ <field name="model">account.statement.rule.information</field>
+ <field name="type">tree</field>
+ <field name="name">rule_information_list</field>
+ </record>
+
+ <record model="ir.model.access" id="access_rule_information">
+ <field name="model" search="[('model', '=',
'account.statement.rule.information')]"/>
+ <field name="perm_read" eval="False"/>
+ <field name="perm_write" eval="False"/>
+ <field name="perm_create" eval="False"/>
+ <field name="perm_delete" eval="False"/>
+ </record>
+ <record model="ir.model.access"
id="access_rule_information_account_admin">
+ <field name="model" search="[('model', '=',
'account.statement.rule.information')]"/>
+ <field name="group" ref="account.group_account_admin"/>
+ <field name="perm_read" eval="True"/>
+ <field name="perm_write" eval="True"/>
+ <field name="perm_create" eval="True"/>
+ <field name="perm_delete" eval="True"/>
+ </record>
+ <record model="ir.model.access" id="access_rule_information_statement">
+ <field name="model" search="[('model', '=',
'account.statement.rule.information')]"/>
+ <field name="group" ref="account_statement.group_statement"/>
+ <field name="perm_read" eval="True"/>
+ <field name="perm_write" eval="False"/>
+ <field name="perm_create" eval="False"/>
+ <field name="perm_delete" eval="False"/>
+ </record>
+
+ <record model="ir.ui.view" id="rule_line_view_form">
+ <field name="model">account.statement.rule.line</field>
+ <field name="type">form</field>
+ <field name="name">rule_line_form</field>
+ </record>
+
+ <record model="ir.ui.view" id="rule_line_view_list">
+ <field name="model">account.statement.rule.line</field>
+ <field name="type">tree</field>
+ <field name="name">rule_line_list</field>
+ </record>
+
+ <record model="ir.model.access" id="access_rule_line">
+ <field name="model" search="[('model', '=',
'account.statement.rule.line')]"/>
+ <field name="perm_read" eval="False"/>
+ <field name="perm_write" eval="False"/>
+ <field name="perm_create" eval="False"/>
+ <field name="perm_delete" eval="False"/>
+ </record>
+ <record model="ir.model.access" id="access_rule_line_account_admin">
+ <field name="model" search="[('model', '=',
'account.statement.rule.line')]"/>
+ <field name="group" ref="account.group_account_admin"/>
+ <field name="perm_read" eval="True"/>
+ <field name="perm_write" eval="True"/>
+ <field name="perm_create" eval="True"/>
+ <field name="perm_delete" eval="True"/>
+ </record>
+ <record model="ir.model.access" id="access_rule_line_statement">
+ <field name="model" search="[('model', '=',
'account.statement.rule.line')]"/>
+ <field name="group" ref="account_statement.group_statement"/>
+ <field name="perm_read" eval="True"/>
+ <field name="perm_write" eval="False"/>
+ <field name="perm_create" eval="False"/>
+ <field name="perm_delete" eval="False"/>
+ </record>
+ </data>
+</tryton>
diff -r 000000000000 -r 10afe35948b5 doc/index.rst
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/index.rst Thu Jan 17 17:32:53 2019 +0100
@@ -0,0 +1,54 @@
+Account Statement Rule Module
+#############################
+
+The account_statement_rule module allows rules to be defined to complete
+statement lines from imported files.
+When the "Apply Rule" button is clicked on a statement, each rule is tested in
+order against each origin that does not have any lines until one is found that
+matches. Then the rule found is used to create the statement lines linked to
+the origin.
+
+Rule
+****
+
+A rule is composed of two parts: matching criteria and lines.
+
+Criteria
+--------
+
+The criteria are matched with each origin of the statement:
+
+ * Company
+ * Journal
+ * Amount: Check if the amount is between two values
+ * Description: `A regular expression
+ <https://docs.python.org/library/re.html#regular-expression-syntax>`_ to
+ search for a match in the origin description.
+ * Information rules:
+
+ * Key: the statement information key on which the rule applies
+ * The matching value depending of the type of the key:
+
+ * Boolean
+ * Numeric: A range of value.
+ * Char: A regular expression.
+ * Selection
+
+The regular expression can register the group names `party`, `bank_account` and
+`invoice` which are later used to search for a party and an invoice.
+
+Lines
+-----
+
+They define how to create the statement lines from the matching origin:
+
+ * Amount: A Python expression evaluated with:
+ * `amount`: the amount of the origin.
+ * `pending`: the amount from which previous lines have been deducted.
+ * Party
+ * Account
+
+If the party is not filled in, one will be searched for using the
+`bank_account` or the `party` group names from the regular expressions.
+If the `invoice` group name appears in a regular expression, it will be used to
+find an invoice to link with.
diff -r 000000000000 -r 10afe35948b5 setup.py
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/setup.py Thu Jan 17 17:32:53 2019 +0100
@@ -0,0 +1,123 @@
+#!/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):
+ return io.open(
+ os.path.join(os.path.dirname(__file__), fname),
+ 'r', encoding='utf-8').read()
+
+
+def get_require_version(name):
+ if minor_version % 2:
+ require = '%s >= %s.%s.dev0, < %s.%s'
+ else:
+ require = '%s >= %s.%s, < %s.%s'
+ require %= (name, major_version, minor_version,
+ major_version, minor_version + 1)
+ return require
+
+
+config = ConfigParser()
+config.read_file(open('tryton.cfg'))
+info = dict(config.items('tryton'))
+for key in ('depends', 'extras_depend', 'xml'):
+ if key in info:
+ info[key] = info[key].strip().splitlines()
+version = info.get('version', '0.0.1')
+major_version, minor_version, _ = version.split('.', 2)
+major_version = int(major_version)
+minor_version = int(minor_version)
+name = 'trytond_account_statement_rule'
+
+download_url = 'http://downloads.tryton.org/%s.%s/' % (
+ major_version, minor_version)
+if minor_version % 2:
+ version = '%s.%s.dev0' % (major_version, minor_version)
+ download_url = (
+ 'hg+http://hg.tryton.org/modules/%s#egg=%s-%s' % (
+ name[8:], name, version))
+
+requires = []
+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/')
+
+setup(name=name,
+ version=version,
+ description='Tryton module to automate statement import with rules',
+ long_description=read('README'),
+ author='Tryton',
+ author_email='[email protected]',
+ url='http://www.tryton.org/',
+ download_url=download_url,
+ keywords='tryton statement import rule',
+ package_dir={'trytond.modules.account_statement_rule': '.'},
+ packages=(
+ ['trytond.modules.account_statement_rule'] +
+ ['trytond.modules.account_statement_rule.%s' % p for p in
find_packages()]
+ ),
+ package_data={
+ 'trytond.modules.account_statement_rule': (info.get('xml', [])
+ + ['tryton.cfg', 'view/*.xml', 'locale/*.po', '*.fodt',
+ 'icons/*.svg', 'tests/*.rst']),
+ },
+ classifiers=[
+ 'Development Status :: 5 - Production/Stable',
+ 'Environment :: Plugins',
+ 'Framework :: Tryton',
+ 'Intended Audience :: Developers',
+ 'Intended Audience :: Financial and Insurance Industry',
+ 'Intended Audience :: Legal Industry',
+ 'License :: OSI Approved :: GNU General Public License v3 or later
(GPLv3+)',
+ 'Natural Language :: Bulgarian',
+ 'Natural Language :: Catalan',
+ 'Natural Language :: Chinese (Simplified)',
+ 'Natural Language :: Czech',
+ 'Natural Language :: Dutch',
+ 'Natural Language :: English',
+ 'Natural Language :: French',
+ 'Natural Language :: German',
+ 'Natural Language :: Hungarian',
+ 'Natural Language :: Italian',
+ 'Natural Language :: Persian',
+ 'Natural Language :: Polish',
+ 'Natural Language :: Portuguese (Brazilian)',
+ 'Natural Language :: Russian',
+ 'Natural Language :: Slovenian',
+ 'Natural Language :: Spanish',
+ 'Operating System :: OS Independent',
+ 'Programming Language :: Python :: 3.4',
+ 'Programming Language :: Python :: 3.5',
+ 'Programming Language :: Python :: 3.6',
+ 'Programming Language :: Python :: 3.7',
+ 'Programming Language :: Python :: Implementation :: CPython',
+ 'Programming Language :: Python :: Implementation :: PyPy',
+ 'Topic :: Office/Business',
+ ],
+ license='GPL-3',
+ python_requires='>=3.4',
+ install_requires=requires,
+ dependency_links=dependency_links,
+ zip_safe=False,
+ entry_points="""
+ [trytond.modules]
+ account_statement_rule = trytond.modules.account_statement_rule
+ """,
+ test_suite='tests',
+ test_loader='trytond.test_loader:Loader',
+ tests_require=tests_require,
+ )
diff -r 000000000000 -r 10afe35948b5 tests/__init__.py
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/tests/__init__.py Thu Jan 17 17:32:53 2019 +0100
@@ -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.account_statement_rule.tests.test_account_statement_rule import
suite
+except ImportError:
+ from .test_account_statement_rule import suite
+
+__all__ = ['suite']
diff -r 000000000000 -r 10afe35948b5 tests/scenario_account_statement_rule.rst
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/tests/scenario_account_statement_rule.rst Thu Jan 17 17:32:53 2019 +0100
@@ -0,0 +1,104 @@
+===============================
+Account Statement Rule Scenario
+===============================
+
+Imports::
+
+ >>> import datetime
+ >>> 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
+ >>> today = datetime.date.today()
+
+Install account_statement_rule::
+
+ >>> config = activate_modules('account_statement_rule')
+
+Create company::
+
+ >>> _ = create_company()
+ >>> company = get_company()
+
+Create chart of accounts::
+
+ >>> _ = create_chart(company)
+ >>> accounts = get_accounts(company)
+ >>> receivable = accounts['receivable']
+ >>> cash = accounts['cash']
+ >>> tax = accounts['tax']
+
+Create parties::
+
+ >>> Party = Model.get('party.party')
+ >>> customer = Party(name="Customer")
+ >>> customer.save()
+
+Create Account Journal::
+
+ >>> Sequence = Model.get('ir.sequence')
+ >>> AccountJournal = Model.get('account.journal')
+
+ >>> sequence = Sequence(name="Satement",
+ ... code='account.journal',
+ ... company=company,
+ ... )
+ >>> sequence.save()
+ >>> account_journal = AccountJournal(name="Statement",
+ ... type='statement',
+ ... sequence=sequence,
+ ... )
+ >>> account_journal.save()
+
+Create statement rules::
+
+ >>> Rule = Model.get('account.statement.rule')
+
+ >>> rule1 = Rule(name="Rule 1")
+ >>> rule1.company = company
+ >>> rule1.amount_low = Decimal('10')
+ >>> rule1.description = r"Party: *(?P<party>.*)"
+ >>> line1 = rule1.lines.new()
+ >>> line1.amount = "amount * 0.1"
+ >>> line1.account = tax
+ >>> line2 = rule1.lines.new()
+ >>> line2.amount = "pending"
+ >>> line2.account = receivable
+ >>> rule1.save()
+
+Create a statement with origins::
+
+ >>> StatementJournal = Model.get('account.statement.journal')
+ >>> Statement = Model.get('account.statement')
+ >>> journal_number = StatementJournal(name="Number",
+ ... journal=account_journal,
+ ... account=cash,
+ ... validation='number_of_lines',
+ ... )
+ >>> journal_number.save()
+
+ >>> statement = Statement(name="number origins")
+ >>> statement.journal = journal_number
+ >>> statement.number_of_lines = 1
+ >>> origin = statement.origins.new()
+ >>> origin.date = today
+ >>> origin.amount = Decimal('50.00')
+ >>> origin.description = "Party: %s" % customer.code
+ >>> statement.save()
+ >>> len(statement.lines)
+ 0
+
+Apply rules on statement::
+
+ >>> statement.click('apply_rules')
+ >>> len(statement.lines)
+ 2
+ >>> sorted([l.amount for l in statement.lines])
+ [Decimal('5.00'), Decimal('45.00')]
+ >>> {l.account for l in statement.lines} == {tax, receivable}
+ True
+ >>> {l.party for l in statement.lines} == {None, customer}
+ True
diff -r 000000000000 -r 10afe35948b5 tests/test_account_statement_rule.py
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/tests/test_account_statement_rule.py Thu Jan 17 17:32:53 2019 +0100
@@ -0,0 +1,27 @@
+# This file is part of Tryton. The COPYRIGHT file at the top level of
+# this repository contains the full copyright notices and license terms.
+
+import unittest
+import doctest
+
+from trytond.tests.test_tryton import ModuleTestCase
+from trytond.tests.test_tryton import suite as test_suite
+from trytond.tests.test_tryton import doctest_teardown
+from trytond.tests.test_tryton import doctest_checker
+
+
+class AccountStatementRuleTestCase(ModuleTestCase):
+ 'Test Account Statement Rule module'
+ module = 'account_statement_rule'
+
+
+def suite():
+ suite = test_suite()
+ suite.addTests(unittest.TestLoader().loadTestsFromTestCase(
+ AccountStatementRuleTestCase))
+ suite.addTests(doctest.DocFileSuite(
+ 'scenario_account_statement_rule.rst',
+ tearDown=doctest_teardown, encoding='utf-8',
+ checker=doctest_checker,
+ optionflags=doctest.REPORT_ONLY_FIRST_FAILURE))
+ return suite
diff -r 000000000000 -r 10afe35948b5 tox.ini
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/tox.ini Thu Jan 17 17:32:53 2019 +0100
@@ -0,0 +1,15 @@
+[tox]
+envlist = {py34,py35,py36,py37}-{sqlite,postgresql},pypy3-{sqlite,postgresql}
+
+[testenv]
+commands = {envpython} setup.py test
+deps =
+ {py34,py35,py36,py37}-postgresql: psycopg2 >= 2.5
+ pypy3-postgresql: psycopg2cffi >= 2.5
+ {py34,py35,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 --process-dependency-links {opts}
{packages}
diff -r 000000000000 -r 10afe35948b5 tryton.cfg
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/tryton.cfg Thu Jan 17 17:32:53 2019 +0100
@@ -0,0 +1,13 @@
+[tryton]
+version=5.1.0
+depends:
+ account
+ account_invoice
+ account_statement
+ company
+ ir
+ party
+extras_depend:
+ bank
+xml:
+ account.xml
diff -r 000000000000 -r 10afe35948b5 view/rule_form.xml
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/view/rule_form.xml Thu Jan 17 17:32:53 2019 +0100
@@ -0,0 +1,31 @@
+<?xml version="1.0"?>
+<!-- This file is part of Tryton. The COPYRIGHT file at the top level of
+this repository contains the full copyright notices and license terms. -->
+<form>
+ <label name="name"/>
+ <field name="name"/>
+
+ <notebook>
+ <page string="Criteria" id="criteria">
+ <label name="company"/>
+ <field name="company"/>
+ <label name="journal"/>
+ <field name="journal"/>
+
+ <label id="between" string="Between"/>
+ <group id="range" col="-1" colspan="3">
+ <field name="amount_low" xexpand="0"/>
+ <label id="and" string="-"/>
+ <field name="amount_high" xexpand="0"/>
+ </group>
+
+ <label name="description"/>
+ <field name="description" colspan="3"/>
+
+ <field name="information_rules" colspan="4"/>
+ </page>
+ <page name="lines">
+ <field name="lines" colspan="4"/>
+ </page>
+ </notebook>
+</form>
diff -r 000000000000 -r 10afe35948b5 view/rule_information_form.xml
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/view/rule_information_form.xml Thu Jan 17 17:32:53 2019 +0100
@@ -0,0 +1,32 @@
+<?xml version="1.0"?>
+<!-- This file is part of Tryton. The COPYRIGHT file at the top level of
+this repository contains the full copyright notices and license terms. -->
+<form cursor="key">
+ <label name="rule"/>
+ <field name="rule"/>
+ <label name="sequence"/>
+ <field name="sequence"/>
+
+ <label name="key"/>
+ <field name="key"/>
+ <group id="values" col="-1" colspan="2">
+ <field name="boolean"/>
+ <group id="integer" col="-1">
+ <field name="integer_low"/>
+ <label id="and" string="-"/>
+ <field name="integer_high"/>
+ </group>
+ <group id="float" col="-1">
+ <field name="float_low"/>
+ <label id="and" string="-"/>
+ <field name="float_high"/>
+ </group>
+ <group id="number" col="-1">
+ <field name="number_low"/>
+ <label id="and" string="-"/>
+ <field name="number_high"/>
+ </group>
+ <field name="char"/>
+ <field name="selection"/>
+ </group>
+</form>
diff -r 000000000000 -r 10afe35948b5 view/rule_information_list.xml
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/view/rule_information_list.xml Thu Jan 17 17:32:53 2019 +0100
@@ -0,0 +1,7 @@
+<?xml version="1.0"?>
+<!-- This file is part of Tryton. The COPYRIGHT file at the top level of
+this repository contains the full copyright notices and license terms. -->
+<tree sequence="sequence">
+ <field name="rule"/>
+ <field name="key"/>
+</tree>
diff -r 000000000000 -r 10afe35948b5 view/rule_line_form.xml
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/view/rule_line_form.xml Thu Jan 17 17:32:53 2019 +0100
@@ -0,0 +1,18 @@
+<?xml version="1.0"?>
+<!-- This file is part of Tryton. The COPYRIGHT file at the top level of
+this repository contains the full copyright notices and license terms. -->
+<form cursor="amount">
+ <label name="rule"/>
+ <field name="rule"/>
+ <label name="sequence"/>
+ <field name="sequence"/>
+
+ <label name="amount"/>
+ <field name="amount"/>
+ <newline/>
+
+ <label name="party"/>
+ <field name="party"/>
+ <label name="account"/>
+ <field name="account"/>
+</form>
diff -r 000000000000 -r 10afe35948b5 view/rule_line_list.xml
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/view/rule_line_list.xml Thu Jan 17 17:32:53 2019 +0100
@@ -0,0 +1,9 @@
+<?xml version="1.0"?>
+<!-- This file is part of Tryton. The COPYRIGHT file at the top level of
+this repository contains the full copyright notices and license terms. -->
+<tree sequence="sequence">
+ <field name="rule"/>
+ <field name="amount"/>
+ <field name="party"/>
+ <field name="account"/>
+</tree>
diff -r 000000000000 -r 10afe35948b5 view/rule_list.xml
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/view/rule_list.xml Thu Jan 17 17:32:53 2019 +0100
@@ -0,0 +1,6 @@
+<?xml version="1.0"?>
+<!-- This file is part of Tryton. The COPYRIGHT file at the top level of
+this repository contains the full copyright notices and license terms. -->
+<tree sequence="sequence">
+ <field name="name"/>
+</tree>
diff -r 000000000000 -r 10afe35948b5 view/statement_form.xml
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/view/statement_form.xml Thu Jan 17 17:32:53 2019 +0100
@@ -0,0 +1,8 @@
+<?xml version="1.0"?>
+<!-- This file is part of Tryton. The COPYRIGHT file at the top level of
+this repository contains the full copyright notices and license terms. -->
+<data>
+ <xpath expr="//group[@id='buttons']/button[@name='draft']"
position="after">
+ <button name="apply_rules"/>
+ </xpath>
+</data>
diff -r 000000000000 -r 10afe35948b5 view/statement_tree.xml
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/view/statement_tree.xml Thu Jan 17 17:32:53 2019 +0100
@@ -0,0 +1,8 @@
+<?xml version="1.0"?>
+<!-- This file is part of Tryton. The COPYRIGHT file at the top level of
+this repository contains the full copyright notices and license terms. -->
+<data>
+ <xpath expr="//field[@name='state']" position="before">
+ <button name="apply_rules"/>
+ </xpath>
+</data>