diff --git a/.eslintrc.yml b/.eslintrc.yml index 569f5aaf..43d9228e 100644 --- a/.eslintrc.yml +++ b/.eslintrc.yml @@ -5,25 +5,27 @@ env: node: true browser: true -ecmaFeatures: - modules: false - globals: loot: false should: false extends: - "eslint:recommended" - - "airbnb/base" + - "airbnb-base" rules: - strict: - - 2 - - global + strict: off no-param-reassign: - - 2 + - error - props: false - max-len: 1 + max-len: warn + linebreak-style: off + no-underscore-dangle: off + arrow-parens: off + no-undef: warn + no-mixed-operators: + - error + - allowSamePrecedence: true plugins: - eslint-plugin-html diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..94a9ed02 --- /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/README.md b/README.md index 01f5aae6..eebfaec7 100644 --- a/README.md +++ b/README.md @@ -25,17 +25,19 @@ For example `LOOT v0.7.0-alpha-2-10-gf6d7e80_dev.7z` was built using the revisio ## Building LOOT -LOOT's build process uses [CMake](https://cmake.org). Most of LOOT's C++ dependencies are managed by CMake, but the following must be obtained manually: +### Windows -* [Boost](http://www.boost.org) v1.55+ +Refer to `appveyor.yml` for the build process. The Appveyor configuration assumes that [CMake](https://cmake.org) and [Node.js](https://nodejs.org/) are already installed. -Building LOOT's GUI also uses [Node.js](https://nodejs.org/). With it installed, run `npm install` then `node_modules/.bin/bower install` from the repository root to install the additional tools and dependencies required. +### Linux -The GUI's HTML file is automatically built when building the LOOT GUI binary, but it can also be built by running `node scripts/vulcanize.js` from the repository root. +Refer to `.travis.yml` for the build process. If starting from a freshly-installed instance of Ubuntu Server 12.04, first run the steps in the `scripts/linux/prepare_ubuntu_precise.sh` to install some additional packages Travis instances have pre-installed. -Platform-specific instructions for building Windows binaries using Microsoft Visual Studio are given in [docs/BUILD.MSVC.md](docs/BUILD.MSVC.md), and instructions for building Linux binaries using GCC are given in [docs/BUILD.LINUX.md](docs/BUILD.LINUX.md). +Not all LOOT's features have been implemented for Linux builds. Issues labelled +`linux` on LOOT's issue tracker cover such missing features where they can be +implemented. -#### CMake Variables +### CMake Variables LOOT uses the following CMake variables to set build parameters: @@ -46,6 +48,10 @@ Parameter | Values | Default |Description You may also need to set `BOOST_ROOT` if CMake cannot find Boost. +### Rebuilding the HTML UI + +The GUI's HTML file is automatically built when building the LOOT GUI binary, but it can also be built by running `node scripts/vulcanize.js` from the repository root. + ## Building The API Documentation The API documentation is built using [Doxygen](http://www.stack.nl/~dimitri/doxygen/), [Breathe](https://breathe.readthedocs.io/en/latest/) and [Sphinx](http://www.sphinx-doc.org/en/stable/). On Windows, install Doxygen and [Python](https://www.python.org) 2.7, add Doxygen's binary path, `C:\Python27` and `C:\Python27\Scripts` (or wherever you installed Python to) to your `%PATH%`, then: diff --git a/docs/BUILD.LINUX.md b/docs/BUILD.LINUX.md deleted file mode 100644 index ee0259d1..00000000 --- a/docs/BUILD.LINUX.md +++ /dev/null @@ -1,44 +0,0 @@ -# Build Instructions using GCC - -Linux binaries can be built for LOOT, and these instructions are for doing so on -Ubuntu 12.04, though they may also apply to other versions and -distributions. - -## Building - -Most of the procedure for building the API, tests and metadata validator can be -found in the `.travis.yml` file, which is the configuration file for LOOT's -Travis CI instance. However, Travis instances have a few more libraries and -utilities by default than Ubuntu 12.04 does, so installation of them will be -covered here. - -Linux builds of the GUI application should be considered officially -**unsupported and unmaintained**, though contributions are welcome. - -## Installing Missing Dependencies - -### Base Dependencies - -``` -sudo apt-get install python-software-properties git build-essential libcurl4-openssl-dev -``` - -### UI Dependencies - -``` -sudo apt-key adv --keyserver keyserver.ubuntu.com --recv 68576280 -sudo apt-add-repository 'deb https://deb.nodesource.com/node_4.x precise main' -sudo apt-get update -sudo apt-get install nodejs -``` - -## Runtime Differences - -Not all LOOT's features have been implemented for Linux builds. Issues labelled -`linux` on LOOT's issue tracker cover such missing features where they can be -implemented. Unavoidable platform differences are documented here: - -* On Windows, LOOT can detect game installs using their Registry entries. On - Linux this is obviously not possible, so either game paths will have to be - entered manually in LOOT's settings dialog when it is run, or LOOT will need - to be installed beside a game's Data folder for that game to be detected. diff --git a/docs/BUILD.MSVC.md b/docs/BUILD.MSVC.md deleted file mode 100644 index da7b9b4d..00000000 --- a/docs/BUILD.MSVC.md +++ /dev/null @@ -1,19 +0,0 @@ -# Build Instructions using Microsoft Visual C++ - -These instructions were used to build LOOT using Microsoft Visual Studio 2015 Community, though they should apply to other versions of MSVC. - -#### Boost - -``` -bootstrap.bat -b2 toolset=msvc threadapi=win32 link=static runtime-link=static variant=release address-model=32 --with-log --with-date_time --with-thread --with-filesystem --with-locale --with-regex --with-system --with-iostreams -``` - -`link`, `runtime-link` and `address-model` can all be modified if shared linking or 64 bit builds are desired. LOOT uses statically-linked Boost libraries by default: to change this, edit [CMakeLists.txt](../CMakeLists.txt). - -#### LOOT - -1. Set CMake up so that it builds the binaries in the `build` subdirectory of the LOOT folder. -2. Define any necessary parameters. -3. Configure CMake, then generate a build system for Visual Studio. -4. Open the generated solution file, and build it. diff --git a/package.json b/package.json index 710aaefc..bf83e264 100644 --- a/package.json +++ b/package.json @@ -12,21 +12,24 @@ }, "homepage": "https://github.com/loot/loot", "private": true, + "dependencies": { + "fs-extra": "^0.30.0", + "vulcanize": "^1.14.5" + }, "devDependencies": { "bower": "^1.7.1", - "eslint": "^2.4.0", - "eslint-config-airbnb": "^6.1.0", - "eslint-plugin-html": "^1.3.0", - "fs-extra": "^0.26.2", - "grunt": "^0.4.5", + "eslint": "^3.5.0", + "eslint-config-airbnb-base": "^7.1.0", + "eslint-plugin-import": "^1.15.0", + "eslint-plugin-html": "^1.5.0", + "grunt": "^1.0.1", "grunt-cli": "^1.2.0", "grunt-contrib-connect": "^1.0.0", "grunt-contrib-watch": "^1.0.0", - "grunt-saucelabs": "^8.6.2", + "grunt-saucelabs": "^9.0.0", "mkdirp": "^0.5.1", - "mocha": "^2.3.4", - "should": "^8.0.1", - "vulcanize": "^1.14.5" + "mocha": "^3.0.1", + "should": "^11.1.0" }, "scripts": { "test": "grunt test" diff --git a/resources/l10n/template.pot b/resources/l10n/template.pot index 1f3f707d..ccf5347b 100644 --- a/resources/l10n/template.pot +++ b/resources/l10n/template.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: LOOT 0.9.2\n" "Report-Msgid-Bugs-To: https://github.com/loot/loot/issues\n" -"POT-Creation-Date: 2016-09-10 10:52+0100\n" +"POT-Creation-Date: 2016-09-14 18:51+0100\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -17,64 +17,64 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: src/gui/html/js/events.js:16 +#: src/gui/html/js/events.js:18 msgid "Identifying conflicting plugins..." msgstr "" -#: src/gui/html/js/events.js:96 +#: src/gui/html/js/events.js:100 msgid "No masterlist update was necessary." msgstr "" -#: src/gui/html/js/events.js:146 +#: src/gui/html/js/events.js:150 msgid "Sorting made no changes to the load order." msgstr "" -#: src/gui/html/js/events.js:178 +#: src/gui/html/js/events.js:182 msgid "Redate Plugins?" msgstr "" -#: src/gui/html/js/events.js:178 +#: src/gui/html/js/events.js:182 msgid "" "This feature is provided so that modders using the Creation Kit may set the " "load order it uses. A side-effect is that any subscribed Steam Workshop mods " "will be re-downloaded by Steam. Do you wish to continue?" msgstr "" -#: src/gui/html/js/events.js:178 +#: src/gui/html/js/events.js:182 msgid "Redate" msgstr "" -#: src/gui/html/js/events.js:187 +#: src/gui/html/js/events.js:191 msgid "" "Are you sure you want to clear all existing user-added metadata from all " "plugins?" msgstr "" -#: src/gui/html/js/events.js:187 src/gui/html/js/events.js:395 +#: src/gui/html/js/events.js:191 src/gui/html/js/events.js:401 msgid "Clear" msgstr "" -#: src/gui/html/js/events.js:198 +#: src/gui/html/js/events.js:202 msgid "All user-added metadata has been cleared." msgstr "" -#: src/gui/html/js/events.js:221 +#: src/gui/html/js/events.js:225 msgid "LOOT's content has been copied to the clipboard." msgstr "" -#: src/gui/html/js/events.js:232 +#: src/gui/html/js/events.js:236 msgid "The load order has been copied to the clipboard." msgstr "" -#: src/gui/html/js/events.js:263 src/gui/html/js/translateStaticText.js:195 +#: src/gui/html/js/events.js:267 src/gui/html/js/translateStaticText.js:195 msgid "Quit" msgstr "" -#: src/gui/html/js/events.js:275 +#: src/gui/html/js/events.js:279 msgid "sorted load order" msgstr "" -#: src/gui/html/js/events.js:277 +#: src/gui/html/js/events.js:281 msgid "metadata edits" msgstr "" @@ -584,32 +584,18 @@ msgid "" "can be accessed through the main menu." msgstr "" -#: src/gui/query_handler.cpp:133 +#: src/gui/query/get_game_data_query.h:45 msgid "Parsing, merging and evaluating metadata..." msgstr "" -#: src/gui/query_handler.cpp:191 src/gui/query_handler.cpp:194 -msgid "Failed to change game. Details: %1%" -msgstr "" - -#: src/gui/query_handler.cpp:208 src/gui/query_handler.cpp:211 -#: src/gui/query_handler.cpp:289 src/gui/query_handler.cpp:292 -#: src/gui/query_handler.cpp:320 src/gui/query_handler.cpp:323 -msgid "Failed to copy plugin metadata. Details: %1%" -msgstr "" - -#: src/gui/query_handler.cpp:229 src/gui/query_handler.cpp:239 -msgid "Failed to apply plugin metadata. Details: %1%" -msgstr "" - -#: src/gui/query_handler.cpp:592 +#: src/gui/query/get_game_data_query.h:80 msgid "" "An error occurred while parsing the masterlist: %1%. This probably happened " "because an update to LOOT changed its metadata syntax support. Try updating " "your masterlist to resolve the error." msgstr "" -#: src/gui/query_handler.cpp:607 +#: src/gui/query/get_game_data_query.h:94 msgid "" "An error occurred while parsing the userlist: %1%. This probably happened " "because an update to LOOT changed its metadata syntax support. Your user " @@ -625,36 +611,24 @@ msgid "" "[LOOT's website](https://loot.github.io/)." msgstr "" -#: src/gui/query_handler.cpp:712 src/gui/query_handler.cpp:715 -msgid "Failed to get game data. Details: %1%" -msgstr "" - -#: src/gui/query_handler.cpp:797 src/gui/query_handler.cpp:800 -msgid "Failed to update the masterlist. Details: %1%" -msgstr "" - -#: src/gui/query_handler.cpp:839 -msgid "Loading plugin contents..." -msgstr "" - -#: src/gui/query_handler.cpp:843 -msgid "Sorting load order..." -msgstr "" - -#: src/gui/query_handler.cpp:900 -msgid "Failed to sort plugins. Details: %1%" -msgstr "" - -#: src/gui/query_handler.cpp:931 +#: src/gui/query/metadata_query.h:94 msgid "" "A global message contains a condition that could not be evaluated. Details: " "%1%" msgstr "" -#: src/gui/query_handler.cpp:963 src/backend/plugin/plugin_sorter.cpp:217 +#: src/gui/query/metadata_query.h:120 src/backend/plugin/plugin_sorter.cpp:217 msgid "\"%1%\" contains a condition that could not be evaluated. Details: %2%" msgstr "" +#: src/gui/query/sort_plugins_query.h:46 +msgid "Loading plugin contents..." +msgstr "" + +#: src/gui/query/sort_plugins_query.h:66 +msgid "Sorting load order..." +msgstr "" + #: src/backend/app/loot_paths.cpp:85 msgid "Failed to get %LOCALAPPDATA% path." msgstr "" @@ -831,7 +805,7 @@ msgstr "" msgid "This plugin is incompatible with \"%1%\", but both are present." msgstr "" -#: src/backend/plugin/plugin_sorter.cpp:81 +#: src/backend/plugin/plugin_sorter.cpp:82 msgid "" "Cyclic interaction detected between plugins \"%1%\" and \"%2%\". Back cycle: " "%3%" diff --git a/scripts/appveyor/install_boost.ps1 b/scripts/appveyor/install_boost.ps1 index 586bf6d1..587f89a4 100644 --- a/scripts/appveyor/install_boost.ps1 +++ b/scripts/appveyor/install_boost.ps1 @@ -1,3 +1,6 @@ +# Assumes that 'C:\projects' exists and that 7-zip is installed and 7z.exe is +# available on the PATH. + Add-Type -AssemblyName System.IO.Compression.FileSystem $boostUrl = 'https://downloads.sourceforge.net/project/boost/boost/1.61.0/boost_1_61_0.7z?r=https%3A%2F%2Fsourceforge.net%2Fprojects%2Fboost%2Ffiles%2Fboost%2F1.61.0%2F&ts=1468862599&use_mirror=ncu' diff --git a/scripts/linux/prepare_ubuntu_precise.sh b/scripts/linux/prepare_ubuntu_precise.sh new file mode 100644 index 00000000..6510189b --- /dev/null +++ b/scripts/linux/prepare_ubuntu_precise.sh @@ -0,0 +1,13 @@ +#!/bin/bash +# This script prepares a fresh install of Ubuntu Server 12.04 so that the steps +# in .travis.yml can then be run. + +sudo rm -rf /var/lib/apt/lists/* +sudo apt-get update + +sudo apt-get install -y python-software-properties git build-essential libcurl4-openssl-dev + +sudo apt-key adv --keyserver keyserver.ubuntu.com --recv 68576280 +sudo apt-add-repository -y 'deb https://deb.nodesource.com/node_4.x precise main' +sudo apt-get update +sudo apt-get install -y nodejs diff --git a/scripts/potomo.js b/scripts/potomo.js index 14472808..f76a03d0 100644 --- a/scripts/potomo.js +++ b/scripts/potomo.js @@ -1,4 +1,6 @@ /* Convert .po files to .mo files. */ +/* eslint-disable no-unused-vars */ + 'use strict'; const childProcess = require('child_process'); const fs = require('fs'); @@ -12,7 +14,7 @@ function getMsgfmtPath() { path.join('/', 'usr', 'bin', 'msgfmt'), ]; - for (let i = 0; i < paths.length; ++i) { + for (let i = 0; i < paths.length; i += 1) { if (helpers.fileExists(paths[i])) { return paths[i]; } diff --git a/scripts/vulcanize.js b/scripts/vulcanize.js index 650351d6..60895f7c 100755 --- a/scripts/vulcanize.js +++ b/scripts/vulcanize.js @@ -1,6 +1,8 @@ #!/usr/bin/env node // Build the UI's index.html file. Takes one argument, which is the path to the // repository's root. + +/* eslint-disable no-unused-vars */ 'use strict'; const path = require('path'); const fs = require('fs'); diff --git a/src/api/api.cpp b/src/api/api.cpp index 433f3e10..fd584fd5 100644 --- a/src/api/api.cpp +++ b/src/api/api.cpp @@ -31,7 +31,16 @@ #include "loot/error.h" #include "backend/app/loot_paths.h" +namespace fs = boost::filesystem; + namespace loot { +std::string ResolvePath(const std::string& path) { + if (path.empty() || !fs::is_symlink(path)) + return path; + + return fs::read_symlink(path).string(); +} + LOOT_API bool IsCompatible(const unsigned int versionMajor, const unsigned int versionMinor, const unsigned int versionPatch) { if (versionMajor > 0) return versionMajor == loot::LootVersion::major; @@ -48,12 +57,14 @@ LOOT_API std::shared_ptr CreateDatabase(const GameType game, boost::log::core::get()->set_logging_enabled(false); // Check for valid paths. - if (!gamePath.empty() && !boost::filesystem::is_directory(gamePath)) - throw loot::Error(Error::Code::invalid_args, "Given game path \"" + std::string(gamePath) + "\" is not a valid directory."); + const std::string resolvedGamePath = ResolvePath(gamePath); + if (!gamePath.empty() && !fs::is_directory(resolvedGamePath)) + throw Error(Error::Code::invalid_args, "Given game path \"" + gamePath + "\" does not resolve to a valid directory."); - if (!gameLocalPath.empty() && !boost::filesystem::is_directory(gameLocalPath)) - throw loot::Error(Error::Code::invalid_args, "Given local data path \"" + std::string(gameLocalPath) + "\" is not a valid directory."); + const std::string resolvedGameLocalPath = ResolvePath(gameLocalPath); + if (!gameLocalPath.empty() && !fs::is_directory(resolvedGameLocalPath)) + throw Error(Error::Code::invalid_args, "Given local data path \"" + gameLocalPath + "\" does not resolve to a valid directory."); - return std::make_shared(game, gamePath, gameLocalPath); + return std::make_shared(game, resolvedGamePath, resolvedGameLocalPath); } } diff --git a/src/backend/helpers/git_helper.cpp b/src/backend/helpers/git_helper.cpp index ed227e1e..d72a89cc 100644 --- a/src/backend/helpers/git_helper.cpp +++ b/src/backend/helpers/git_helper.cpp @@ -146,10 +146,7 @@ void GitHelper::Clone(const boost::filesystem::path& path, const std::string& ur // Clone the remote repository. BOOST_LOG_TRIVIAL(info) << "Repository doesn't exist, cloning the remote repository."; - fs::path tempPath = fs::temp_directory_path() / fs::unique_path(); - - // Create the temporary parent folder in case it doesn't already exist. - fs::create_directories(tempPath.parent_path()); + fs::path tempPath = path.parent_path() / fs::unique_path(); //Delete temporary folder in case it already exists. fs::remove_all(tempPath); diff --git a/src/gui/html/js/dom.js b/src/gui/html/js/dom.js index 0b7809c6..815671ed 100644 --- a/src/gui/html/js/dom.js +++ b/src/gui/html/js/dom.js @@ -87,7 +87,7 @@ /* Also disable deletion of the game's row in the settings dialog. */ const table = document.getElementById('gameTable'); - for (let i = 0; i < table.tBodies[0].rows.length; ++i) { + for (let i = 0; i < table.tBodies[0].rows.length; i += 1) { const folderElements = table.tBodies[0].rows[i].getElementsByClassName('folder'); if (folderElements.length === 1) { table.setReadOnly(table.tBodies[0].rows[i], @@ -99,7 +99,7 @@ static updateEnabledGames(installedGames) { const gameMenuItems = document.getElementById('gameMenu').children; - for (let i = 0; i < gameMenuItems.length; ++i) { + for (let i = 0; i < gameMenuItems.length; i += 1) { DOM.enable(gameMenuItems[i], installedGames.indexOf(gameMenuItems[i].getAttribute('value')) !== -1); } diff --git a/src/gui/html/js/events.js b/src/gui/html/js/events.js index 47f6a92f..54cb8b43 100644 --- a/src/gui/html/js/events.js +++ b/src/gui/html/js/events.js @@ -1,3 +1,5 @@ +/* eslint-disable no-unused-vars */ + 'use strict'; function onSidebarFilterToggle(evt) { loot.filters[evt.target.id] = evt.target.checked; @@ -313,13 +315,15 @@ function onCloseSettingsDialog(evt) { loot.query('closeSettings', settings).then(JSON.parse).then((installedGames) => { loot.installedGames = installedGames; loot.DOM.updateEnabledGames(installedGames); - }).catch(loot.handlePromiseError).then(() => { + }).catch(loot.handlePromiseError) + .then(() => { loot.settings = settings; loot.DOM.updateSettingsDialog(loot.settings); loot.DOM.setGameMenuItems(loot.settings.games); loot.DOM.updateEnabledGames(loot.installedGames); loot.DOM.updateSelectedGame(loot.game.folder); - }).catch(loot.handlePromiseError); + }) + .catch(loot.handlePromiseError); } function onEditorOpen(evt) { /* Set the editor data. */ @@ -334,7 +338,7 @@ function onEditorOpen(evt) { /* Set up drag 'n' drop event handlers. */ const elements = document.getElementById('cardsNav').getElementsByTagName('loot-plugin-item'); - for (let i = 0; i < elements.length; ++i) { + for (let i = 0; i < elements.length; i += 1) { elements[i].draggable = true; elements[i].addEventListener('dragstart', elements[i].onDragStart); } @@ -380,7 +384,7 @@ function onEditorClose(evt) { /* Remove drag 'n' drop event handlers. */ const elements = document.getElementById('cardsNav').getElementsByTagName('loot-plugin-item'); - for (let i = 0; i < elements.length; ++i) { + for (let i = 0; i < elements.length; i += 1) { elements[i].removeAttribute('draggable'); elements[i].removeEventListener('dragstart', elements[i].onDragStart); } @@ -449,7 +453,7 @@ function onSearchEnd(evt) { function onFolderChange(evt) { loot.DOM.updateSelectedGame(evt.detail.folder); /* Enable/disable the redate plugins option. */ - let gameSettings = undefined; + let gameSettings; if (loot.settings && loot.settings.games) { gameSettings = loot.settings.games.find(game => game.folder === evt.detail.folder); } diff --git a/src/gui/html/js/filters.js b/src/gui/html/js/filters.js index 2a672465..e49c5b52 100644 --- a/src/gui/html/js/filters.js +++ b/src/gui/html/js/filters.js @@ -126,7 +126,7 @@ document.getElementById('pluginCardList').items = filteredPlugins; const pluginCards = document.getElementById('pluginCardList').children; - for (let i = 0; i < pluginCards.length; ++i) { + for (let i = 0; i < pluginCards.length; i += 1) { if (pluginCards[i].data) { pluginCards[i].updateContent(true); } diff --git a/src/gui/html/js/game.js b/src/gui/html/js/game.js index 450f4c36..f5c4c319 100644 --- a/src/gui/html/js/game.js +++ b/src/gui/html/js/game.js @@ -53,9 +53,9 @@ oldTotal = this._globalMessages.length; this._globalMessages.forEach((message) => { if (message.type === 'warn') { - ++oldWarns; + oldWarns += 1; } else if (message.type === 'error') { - ++oldErrs; + oldErrs += 1; } }); } @@ -65,9 +65,9 @@ globalMessages.forEach((message) => { if (message.type === 'warn') { - ++newWarns; + newWarns += 1; } else if (message.type === 'error') { - ++newErrs; + newErrs += 1; } }); } @@ -134,27 +134,27 @@ totalMessageNo = this.globalMessages.length; this.globalMessages.forEach((message) => { if (message.type === 'warn') { - ++warnMessageNo; + warnMessageNo += 1; } else if (message.type === 'error') { - ++errorMessageNo; + errorMessageNo += 1; } }); } plugins.forEach((plugin) => { if (plugin.isActive) { - ++activePluginNo; + activePluginNo += 1; } if (plugin.isDirty) { - ++dirtyPluginNo; + dirtyPluginNo += 1; } if (plugin.messages) { totalMessageNo += plugin.messages.length; plugin.messages.forEach((message) => { if (message.type === 'warn') { - ++warnMessageNo; + warnMessageNo += 1; } else if (message.type === 'error') { - ++errorMessageNo; + errorMessageNo += 1; } }); } @@ -183,18 +183,18 @@ let dirtyChange = 0; if (plugin.isActive) { - ++activeChange; + activeChange += 1; } if (plugin.isDirty) { - ++dirtyChange; + dirtyChange += 1; } if (plugin.messages) { totalChange += plugin.messages.length; plugin.messages.forEach((message) => { if (message.type === 'warn') { - ++warnChange; + warnChange += 1; } else if (message.type === 'error') { - ++errorChange; + errorChange += 1; } }); } @@ -222,18 +222,18 @@ let dirtyChange = 0; if (this._plugins[index].isActive) { - --activeChange; + activeChange -= 1; } if (this._plugins[index].isDirty) { - --dirtyChange; + dirtyChange -= 1; } if (this._plugins[index].messages) { totalChange -= this._plugins[index].messages.length; this._plugins[index].messages.forEach((message) => { if (message.type === 'warn') { - --warnChange; + warnChange -= 1; } else if (message.type === 'error') { - --errorChange; + errorChange -= 1; } }); } diff --git a/src/gui/html/js/plugin.js b/src/gui/html/js/plugin.js index 42a40b58..b3315b85 100644 --- a/src/gui/html/js/plugin.js +++ b/src/gui/html/js/plugin.js @@ -102,7 +102,7 @@ const tagsRemoved = []; if (this._tags) { - for (let i = 0; i < this._tags.length; ++i) { + for (let i = 0; i < this._tags.length; i += 1) { if (this._tags[i].name[0] === '-') { tagsRemoved.push(this._tags[i].name.substr(1)); } else { @@ -112,12 +112,12 @@ } /* Now make sure that the same tag doesn't appear in both arrays. Prefer the removed list. */ - for (let i = 0; i < tagsAdded.length; ++i) { - for (let j = 0; j < tagsRemoved.length; ++j) { + for (let i = 0; i < tagsAdded.length; i += 1) { + for (let j = 0; j < tagsRemoved.length; j += 1) { if (tagsRemoved[j].toLowerCase() === tagsAdded[i].toLowerCase()) { /* Remove tag from the tagsAdded array. */ tagsAdded.splice(i, 1); - --i; + i -= 1; } } } @@ -149,7 +149,7 @@ return true; } - for (let i = 0; i < this.messages.length; ++i) { + for (let i = 0; i < this.messages.length; i += 1) { if (this.messages[i].text.toLowerCase().indexOf(needle) !== -1) { return true; } @@ -208,7 +208,9 @@ } static tagFromRowData(rowData) { - if (rowData.condition === undefined || rowData.name === undefined || rowData.type === undefined) { + if (rowData.condition === undefined + || rowData.name === undefined + || rowData.type === undefined) { throw new TypeError('Row data members are undefined'); } const tag = { @@ -284,9 +286,9 @@ this._messages.forEach((message) => { if (message.type === 'warn') { - ++oldWarns; + oldWarns += 1; } else if (message.type === 'error') { - ++oldErrs; + oldErrs += 1; } }); @@ -294,9 +296,9 @@ messages.forEach((message) => { if (message.type === 'warn') { - ++newWarns; + newWarns += 1; } else if (message.type === 'error') { - ++newErrs; + newErrs += 1; } }); diff --git a/src/gui/html/js/translator.js b/src/gui/html/js/translator.js index 63f210cb..44021996 100644 --- a/src/gui/html/js/translator.js +++ b/src/gui/html/js/translator.js @@ -71,7 +71,6 @@ if (this.jed === undefined) { return text; } - const func = this.jed.translate(text); - return func.fetch.apply(func, substitutions); + return this.jed.translate(text).fetch(...substitutions); } })); diff --git a/src/tests/api/create_database_test.h b/src/tests/api/create_database_test.h index b1a3fdf9..f1f996ae 100644 --- a/src/tests/api/create_database_test.h +++ b/src/tests/api/create_database_test.h @@ -35,17 +35,29 @@ namespace loot { namespace test { class CreateDatabaseTest : public CommonGameTestFixture { protected: - CreateDatabaseTest() : db_(nullptr) {} + CreateDatabaseTest() : + db_(nullptr), + gamePathSymlink(dataPath.parent_path().string() + "symlink"), + localPathSymlink(localPath.string() + "symlink") {} void SetUp() { CommonGameTestFixture::SetUp(); + + boost::filesystem::create_directory_symlink(dataPath.parent_path(), gamePathSymlink); + boost::filesystem::create_directory_symlink(localPath, localPathSymlink); } void TearDown() { CommonGameTestFixture::TearDown(); + + boost::filesystem::remove(gamePathSymlink); + boost::filesystem::remove(localPathSymlink); } std::shared_ptr db_; + + const boost::filesystem::path gamePathSymlink; + const boost::filesystem::path localPathSymlink; }; // Pass an empty first argument, as it's a prefix for the test instantation, @@ -86,6 +98,11 @@ TEST_P(CreateDatabaseTest, shouldReturnOkIfPassedAnEmptyLocalPathString) { EXPECT_NE(nullptr, db_); } #endif + +TEST_P(CreateDatabaseTest, shouldReturnOkIfPassedGameAndLocalPathSymlinks) { + EXPECT_NO_THROW(db_ = CreateDatabase(GetParam(), gamePathSymlink.string(), localPathSymlink.string())); + EXPECT_NE(nullptr, db_); +} } } diff --git a/src/tests/gui/html/js/mock_dom.js b/src/tests/gui/html/js/mock_dom.js index 864fdbb9..d857ff74 100644 --- a/src/tests/gui/html/js/mock_dom.js +++ b/src/tests/gui/html/js/mock_dom.js @@ -13,11 +13,3 @@ loot.DOM = { this.elementEnabledStates.set(elementId, enableElement); }, }; - -function getShown(elementId) { - return loot.DOM.elementShownStates.get(elementId); -} - -function getEnabled(elementId) { - return loot.DOM.elementEnabledStates.get(elementId); -} diff --git a/src/tests/gui/html/js/test_filters.js b/src/tests/gui/html/js/test_filters.js index a7f7bdc2..8d81f164 100644 --- a/src/tests/gui/html/js/test_filters.js +++ b/src/tests/gui/html/js/test_filters.js @@ -3,7 +3,7 @@ describe('Filters', () => { /* Mock the Translator class. */ class Translator { - translate(text) { + translate(text) { // eslint-disable-line class-methods-use-this return text; } } @@ -68,7 +68,7 @@ describe('Filters', () => { return this._messages; } - containsText(text) { + containsText(text) { // eslint-disable-line class-methods-use-this return text === 'found text'; } } diff --git a/src/tests/gui/html/js/test_game.js b/src/tests/gui/html/js/test_game.js index 93335755..64e46c21 100644 --- a/src/tests/gui/html/js/test_game.js +++ b/src/tests/gui/html/js/test_game.js @@ -3,7 +3,7 @@ describe('Game', () => { /* Mock the Translator class. */ class Translator { - translate(text) { + translate(text) { // eslint-disable-line class-methods-use-this return text; } } diff --git a/src/tests/gui/html/js/test_query.js b/src/tests/gui/html/js/test_query.js index 3859100b..15dfc5c2 100644 --- a/src/tests/gui/html/js/test_query.js +++ b/src/tests/gui/html/js/test_query.js @@ -18,22 +18,22 @@ describe('query()', () => { loot.query('test').should.be.a.Promise(); // eslint-disable-line new-cap }); - it('should succeed if a request name is passed', () => { - return loot.query('test').should.be.fulfilledWith('{"name":"test","args":[]}'); - }); + it('should succeed if a request name is passed', () => + loot.query('test').should.be.fulfilledWith('{"name":"test","args":[]}') + ); - it('should succeed if a request name and arguments are passed', () => { - return loot.query('test', 1, false, ['a']).should.be.fulfilledWith(JSON.stringify({ + it('should succeed if a request name and arguments are passed', () => + loot.query('test', 1, false, ['a']).should.be.fulfilledWith(JSON.stringify({ name: 'test', args: [ 1, false, ['a'], ], - })); - }); + })) + ); - it('should fail with an Error object when an error occurs', () => { - return loot.query('fail').should.be.rejectedWith(Error, { message: 'Error code: -1; {"name":"fail","args":[]}' }); - }); + it('should fail with an Error object when an error occurs', () => + loot.query('fail').should.be.rejectedWith(Error, { message: 'Error code: -1; {"name":"fail","args":[]}' }) + ); }); diff --git a/src/tests/gui/html/js/test_state.js b/src/tests/gui/html/js/test_state.js index 7f53075c..ca8b8fc9 100644 --- a/src/tests/gui/html/js/test_state.js +++ b/src/tests/gui/html/js/test_state.js @@ -1,5 +1,13 @@ 'use strict'; +function getShown(elementId) { + return loot.DOM.elementShownStates.get(elementId); +} + +function getEnabled(elementId) { + return loot.DOM.elementEnabledStates.get(elementId); +} + beforeEach(() => { loot.DOM.elementShownStates.clear(); loot.DOM.elementEnabledStates.clear(); diff --git a/src/tests/gui/html/js/test_translator.js b/src/tests/gui/html/js/test_translator.js index 461b8694..ca865cdf 100644 --- a/src/tests/gui/html/js/test_translator.js +++ b/src/tests/gui/html/js/test_translator.js @@ -41,33 +41,33 @@ describe('Translator', () => { l10n.translate('foo').should.equal('foo'); }); - it('should return an empty string if nothing is passed', () => { - return l10n.load().then(() => { + it('should return an empty string if nothing is passed', () => + l10n.load().then(() => { l10n.translate().should.equal(''); - }); - }); + }) + ); - it('should return the input string if the current locale is "en"', () => { - return l10n.load().then(() => { + it('should return the input string if the current locale is "en"', () => + l10n.load().then(() => { l10n.translate('foo').should.equal('foo'); - }); - }); + }) + ); it('should return the translated string if locale data has been loaded', () => { /* Since loading data doesn't work in the browser, hack it by setting some data manually. */ l10n.jed = new window.Jed({ - 'locale_data': { - 'messages': { + locale_data: { + messages: { '': { - 'domain': 'messages', - 'lang': 'en', - 'plural_forms': 'nplurals=2; plural=(n != 1);', + domain: 'messages', + lang: 'en', + plural_forms: 'nplurals=2; plural=(n != 1);', }, - 'foo': ['bar'], + foo: ['bar'], }, }, - 'domain': 'messages', + domain: 'messages', }); l10n.translate('foo').should.equal('bar'); @@ -77,17 +77,17 @@ describe('Translator', () => { /* Since loading data doesn't work in the browser, hack it by setting some data manually. */ l10n.jed = new window.Jed({ - 'locale_data': { - 'messages': { + locale_data: { + messages: { '': { - 'domain': 'messages', - 'lang': 'en', - 'plural_forms': 'nplurals=2; plural=(n != 1);', + domain: 'messages', + lang: 'en', + plural_forms: 'nplurals=2; plural=(n != 1);', }, 'foo %1$s %2$s': ['%2$s is bar'], }, }, - 'domain': 'messages', + domain: 'messages', }); l10n.translate('foo %1$s %2$s', 'is not', 'bar').should.equal('bar is bar');