diff --git a/.eslintrc b/.eslintrc index fb7b984..028ba73 100644 --- a/.eslintrc +++ b/.eslintrc @@ -49,6 +49,13 @@ "prefer-const": "error", "no-trailing-spaces": "error", "react/prop-types": 0, - "max-len": [1, {"ignoreStrings": true}] + "max-len": [ + 1, + { + "ignoreStrings": true, + "ignoreComments": true, + "ignoreTemplateLiterals": true + } + ] } } \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..61d1860 --- /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 +. \ No newline at end of file diff --git a/README.md b/README.md index a2662ae..a186717 100644 --- a/README.md +++ b/README.md @@ -4,10 +4,7 @@ A menstrual cycle tracking app that's open-source and leaves your data on your p ## Development setup -1. - -a) Start a virtual device in Android Studio (or make sure it's already running, you should see a phone on your screen) -b) Set your physical device like your phone up to run the app. +1. Either start a virtual device in Android Studio (or make sure it's already running, you should see a phone on your screen) or set your physical device like your phone up to run the app. 2. Clone this repository: diff --git a/components/app.js b/components/app.js index b0924aa..dbd3cfb 100644 --- a/components/app.js +++ b/components/app.js @@ -19,28 +19,27 @@ export default class App extends Component { this.state = { currentPage: 'Home' } - - const handleBackButtonPress = function() { - if (this.state.currentPage === 'Home') return false - if (isSymptomView(this.state.currentPage)) { - this.navigate('CycleDay', {cycleDay: this.state.currentProps.cycleDay}) - } else { - this.navigate('Home') - } - return true - }.bind(this) - - this.backHandler = BackHandler.addEventListener('hardwareBackPress', handleBackButtonPress) + this.backHandler = BackHandler.addEventListener('hardwareBackPress', this.handleBackButtonPress) } componentWillUnmount() { this.backHandler.remove() } - navigate(pageName, props) { + navigate = (pageName, props) => { this.setState({currentPage: pageName, currentProps: props}) } + handleBackButtonPress = () => { + if (this.state.currentPage === 'Home') return false + if (isSymptomView(this.state.currentPage)) { + this.navigate('CycleDay', { cycleDay: this.state.currentProps.cycleDay }) + } else { + this.navigate('Home') + } + return true + } + render() { const page = { Home, Calendar, CycleDay, Chart, Settings, Stats, ...symptomViews @@ -51,12 +50,12 @@ export default class App extends Component { {this.state.currentPage != 'CycleDay' &&
} {React.createElement(page, { - navigate: this.navigate.bind(this), + navigate: this.navigate, ...this.state.currentProps })} {!isSymptomView(this.state.currentPage) && - + } ) diff --git a/components/calendar.js b/components/calendar.js index 2e70c4a..d579c31 100644 --- a/components/calendar.js +++ b/components/calendar.js @@ -29,7 +29,7 @@ export default class CalendarView extends Component { bleedingDaysSortedByDate.removeListener(this.setStateWithCalFormattedDays) } - passDateToDayView(result) { + passDateToDayView = (result) => { const cycleDay = getOrCreateCycleDay(result.dateString) const navigate = this.props.navigate navigate('CycleDay', { cycleDay }) diff --git a/components/chart/chart.js b/components/chart/chart.js index c9c2b1d..0248979 100644 --- a/components/chart/chart.js +++ b/components/chart/chart.js @@ -1,51 +1,123 @@ import React, { Component } from 'react' -import { View, FlatList, ScrollView } from 'react-native' +import { View, FlatList, Text } from 'react-native' import range from 'date-range' import { LocalDate } from 'js-joda' -import { yAxis, normalizeToScale, horizontalGrid } from './y-axis' -import setUpFertilityStatusFunc from './nfp-lines' +import { makeYAxisLabels, normalizeToScale, makeHorizontalGrid } from './y-axis' +import nfpLines from './nfp-lines' import DayColumn from './day-column' import { getCycleDay, cycleDaysSortedByDate, getAmountOfCycleDays } from '../../db' import styles from './styles' - -const yAxisView = {yAxis.labels} +import { scaleObservable } from '../../local-storage' +import config from '../../config' export default class CycleChart extends Component { constructor(props) { super(props) - this.state = { - columns: makeColumnInfo(setUpFertilityStatusFunc()), - } + this.state = {} this.renderColumn = ({item, index}) => { return ( ) } + } - this.reCalculateChartInfo = (function(Chart) { - return function() { - Chart.setState({columns: makeColumnInfo(setUpFertilityStatusFunc())}) - } - })(this) + onLayout = ({ nativeEvent }) => { + if (this.state.chartHeight) return + + const height = nativeEvent.layout.height + this.setState({ chartHeight: height }) + this.reCalculateChartInfo = () => { + this.setState({ columns: this.makeColumnInfo(nfpLines(height)) }) + } cycleDaysSortedByDate.addListener(this.reCalculateChartInfo) + this.removeObvListener = scaleObservable(this.reCalculateChartInfo, false) } componentWillUnmount() { cycleDaysSortedByDate.removeListener(this.reCalculateChartInfo) + this.removeObvListener() + } + + makeColumnInfo(getFhmAndLtlInfo) { + let amountOfCycleDays = getAmountOfCycleDays() + // if there's not much data yet, we want to show at least 30 days on the chart + if (amountOfCycleDays < 30) { + amountOfCycleDays = 30 + } else { + // we don't want the chart to end abruptly before the first data day + amountOfCycleDays += 5 + } + const jsDates = getTodayAndPreviousDays(amountOfCycleDays) + const xAxisDates = jsDates.map(jsDate => { + return LocalDate.of( + jsDate.getFullYear(), + jsDate.getMonth() + 1, + jsDate.getDate() + ).toString() + }) + + const columns = xAxisDates.map(dateString => { + const cycleDay = getCycleDay(dateString) + const symptoms = ['temperature', 'mucus', 'bleeding'].reduce((acc, symptom) => { + acc[symptom] = cycleDay && cycleDay[symptom] && cycleDay[symptom].value + acc[`${symptom}Exclude`] = cycleDay && cycleDay[symptom] && cycleDay[symptom].exclude + return acc + }, {}) + + const temp = symptoms.temperature + const columnHeight = this.state.chartHeight * config.columnHeightPercentage + return { + dateString, + y: temp ? normalizeToScale(temp, columnHeight) : null, + ...symptoms, + ...getFhmAndLtlInfo(dateString, temp) + } + }) + + return columns.map((col, i) => { + const info = getInfoForNeighborColumns(i, columns) + return Object.assign(col, info) + }) } render() { + let columnHeight + let symptomRowHeight + if (this.state.chartHeight) { + columnHeight = this.state.chartHeight * config.columnHeightPercentage + symptomRowHeight = this.state.chartHeight * config.symptomRowHeightPercentage + } return ( - - - {yAxisView} - {horizontalGrid} - { + {!this.state.chartLoaded && + + Loading... + + } + + {this.state.chartHeight && this.state.chartLoaded && + + {makeYAxisLabels(columnHeight)} + } + + {this.state.chartHeight && this.state.chartLoaded && makeHorizontalGrid(columnHeight, symptomRowHeight)} + + {this.state.chartHeight && + item.dateString} initialNumToRender={15} maxToRenderPerBatch={5} - > - } - - + onLayout={() => this.setState({chartLoaded: true})} + /> + } + ) } } -function makeColumnInfo(getFhmAndLtlInfo) { - let amountOfCycleDays = getAmountOfCycleDays() - // if there's not much data yet, we want to show at least 30 days on the chart - if (amountOfCycleDays < 30) { - amountOfCycleDays = 30 - } else { - // we don't want the chart to end abruptly before the first data day - amountOfCycleDays += 5 - } - const xAxisDates = getTodayAndPreviousDays(amountOfCycleDays).map(jsDate => { - return LocalDate.of( - jsDate.getFullYear(), - jsDate.getMonth() + 1, - jsDate.getDate() - ).toString() - }) - - const columns = xAxisDates.map(dateString => { - const cycleDay = getCycleDay(dateString) - const symptoms = ['temperature', 'mucus', 'bleeding'].reduce((acc, symptom) => { - acc[symptom] = cycleDay && cycleDay[symptom] && cycleDay[symptom].value - acc[`${symptom}Exclude`] = cycleDay && cycleDay[symptom] && cycleDay[symptom].exclude - return acc - }, {}) - - return { - dateString, - y: symptoms.temperature ? normalizeToScale(symptoms.temperature) : null, - ...symptoms, - ...getFhmAndLtlInfo(dateString, symptoms.temperature) - } - }) - - return columns.map((col, i) => { - const info = getInfoForNeighborColumns(i, columns) - return Object.assign(col, info) - }) -} function getTodayAndPreviousDays(n) { const today = new Date() diff --git a/components/chart/config.js b/components/chart/config.js deleted file mode 100644 index ec3509e..0000000 --- a/components/chart/config.js +++ /dev/null @@ -1,16 +0,0 @@ -const config = { - chartHeight: 350, - columnWidth: 25, - temperatureScale: { - low: 35, - high: 38, - units: 0.1 - } -} - -const margin = 3 -config.columnMiddle = config.columnWidth / 2, -config.dateRowY = config.chartHeight - 15 - margin -config.cycleDayNumberRowY = config.chartHeight - margin - -export default config \ No newline at end of file diff --git a/components/chart/day-column.js b/components/chart/day-column.js index a7ccfb1..268df06 100644 --- a/components/chart/day-column.js +++ b/components/chart/day-column.js @@ -4,7 +4,7 @@ import { } from 'react-native' import Icon from 'react-native-vector-icons/Entypo' import styles from './styles' -import config from './config' +import config from '../../config' import { getOrCreateCycleDay } from '../../db' import cycleModule from '../../lib/cycle' import DotAndLine from './dot-and-line' @@ -34,48 +34,15 @@ export default class DayColumn extends Component { rightY, rightTemperatureExclude, leftY, - leftTemperatureExclude + leftTemperatureExclude, + chartHeight } = this.props + const columnHeight = chartHeight * config.columnHeightPercentage + const xAxisHeight = chartHeight * config.xAxisHeightPercentage + const symptomHeight = chartHeight * config.symptomRowHeightPercentage + const columnElements = [] - if (typeof bleeding === 'number') { - columnElements.push( - - ) - } - - if (typeof mucus === 'number') { - const mucusIcon = ( - - ) - columnElements.push(mucusIcon) - } - - if(drawFhmLine) { - const fhmLine = () - columnElements.push(fhmLine) - } if(drawLtlAt) { const ltlLine = ( + {cycleDayNumber} ) const dateLabel = ( - + {shortDate} ) - columnElements.push( - - {cycleDayLabel} - {dateLabel} - - ) - return React.createElement( + // we merge the colors here instead of from the stylesheet because of a RN + // bug that doesn't apply borderLeftColor otherwise + const customStyle = { + height: columnHeight, + borderLeftColor: 'grey', + borderRightColor: 'grey' + } + + if (drawFhmLine) { + customStyle.borderLeftColor = styles.nfpLine.borderColor + customStyle.borderLeftWidth = 3 + } + const column = React.createElement( TouchableOpacity, { - style: styles.column.rect, + style: [styles.column.rect, customStyle], key: this.props.index.toString(), onPress: () => { this.passDateToDayView(dateString) @@ -132,5 +105,34 @@ export default class DayColumn extends Component { }, columnElements ) + + return ( + + + {typeof mucus === 'number' && + + } + {typeof bleeding === 'number' && + + } + + + {column} + + + {cycleDayLabel} + {dateLabel} + + + ) } } \ No newline at end of file diff --git a/components/chart/dot-and-line.js b/components/chart/dot-and-line.js index 626cf02..418457f 100644 --- a/components/chart/dot-and-line.js +++ b/components/chart/dot-and-line.js @@ -1,7 +1,7 @@ import React, { Component } from 'react' import { View } from 'react-native' import styles from './styles' -import config from './config' +import config from '../../config' export default class DotAndLine extends Component { shouldComponentUpdate(newProps) { diff --git a/components/chart/nfp-lines.js b/components/chart/nfp-lines.js index d9f4507..ded95e8 100644 --- a/components/chart/nfp-lines.js +++ b/components/chart/nfp-lines.js @@ -1,7 +1,7 @@ import { getCycleStatusForDay } from '../../lib/sympto-adapter' import { normalizeToScale } from './y-axis' -export default function () { +export default function (chartHeight) { const cycle = { status: null } @@ -71,7 +71,7 @@ export default function () { dateIsInPeriOrPostPhase(dateString) && isInTempMeasuringPhase(temperature, dateString) ) { - ret.drawLtlAt = normalizeToScale(tempShift.ltl) + ret.drawLtlAt = normalizeToScale(tempShift.ltl, chartHeight) } } diff --git a/components/chart/styles.js b/components/chart/styles.js index c018eb1..d7ab484 100644 --- a/components/chart/styles.js +++ b/components/chart/styles.js @@ -1,4 +1,4 @@ -import config from './config' +import config from '../../config' const styles = { curve: { @@ -38,10 +38,9 @@ const styles = { }, rect: { width: config.columnWidth, - height: config.chartHeight, borderStyle: 'solid', - borderColor: 'grey', - borderWidth: 0.5 + borderLeftWidth: 0.5, + borderRightWidth: 0.5, } }, bleedingIcon: { @@ -63,7 +62,6 @@ const styles = { '#993299' ], yAxis: { - height: config.chartHeight, width: config.columnWidth, borderRightWidth: 0.5, borderColor: 'lightgrey', @@ -88,6 +86,10 @@ const styles = { borderColor: '#00b159', borderWidth: 2, borderStyle: 'solid' + }, + symptomRow: { + alignItems: 'center', + justifyContent: 'center' } } diff --git a/components/chart/y-axis.js b/components/chart/y-axis.js index ccc9404..27d1411 100644 --- a/components/chart/y-axis.js +++ b/components/chart/y-axis.js @@ -1,53 +1,68 @@ import React from 'react' import { Text, View } from 'react-native' -import config from './config' +import config from '../../config' import styles from './styles' +import { scaleObservable } from '../../local-storage' -function makeYAxis() { - const scale = config.temperatureScale - const scaleMin = scale.low - const scaleMax = scale.high - const numberOfTicks = (scaleMax - scaleMin) * (1 / scale.units) - const tickDistance = config.chartHeight / numberOfTicks +export function makeYAxisLabels(columnHeight) { + const units = config.temperatureScale.units + const scaleMax = scaleObservable.value.max + const style = styles.yAxisLabel - const tickPositions = [] - const labels = [] - // for style reasons, we don't want the first and last tick - for (let i = 1; i < numberOfTicks - 1; i++) { - const y = tickDistance * i - const style = styles.yAxisLabel + return getTickPositions(columnHeight).map((y, i) => { // this eyeballing is sadly necessary because RN does not // support percentage values for transforms, which we'd need // to reliably place the label vertically centered to the grid - style.top = y - 8 - labels.push( + if (scaleMax - i * units === 37) console.log(y) + return ( - {scaleMax - i * scale.units} + {scaleMax - i * units} ) - tickPositions.push(y) - } - - return {labels, tickPositions} + }) } -export const yAxis = makeYAxis() +export function makeHorizontalGrid(columnHeight, symptomRowHeight) { + return getTickPositions(columnHeight).map(tick => { + return ( + + ) + }) +} -export const horizontalGrid = yAxis.tickPositions.map(tick => { - return ( - - ) -}) +function getTickPositions(columnHeight) { + const units = config.temperatureScale.units + const scaleMin = scaleObservable.value.min + const scaleMax = scaleObservable.value.max + const numberOfTicks = (scaleMax - scaleMin) * (1 / units) + 1 + const tickDistance = 1 / (numberOfTicks - 1) + + const tickPositions = [] + for (let i = 0; i < numberOfTicks; i++) { + const position = getAbsoluteValue(tickDistance * i, columnHeight) + tickPositions.push(position) + } + return tickPositions +} + +export function normalizeToScale(temp, columnHeight) { + const scale = scaleObservable.value + const valueRelativeToScale = (scale.max - temp) / (scale.max - scale.min) + return getAbsoluteValue(valueRelativeToScale, columnHeight) +} + +function getAbsoluteValue(relative, columnHeight) { + // we add some height to have some breathing room + const verticalPadding = columnHeight * config.temperatureScale.verticalPadding + const scaleHeight = columnHeight - 2 * verticalPadding + console.log(scaleHeight) + console.log(columnHeight) + return scaleHeight * relative + verticalPadding -export function normalizeToScale(temp) { - const scale = config.temperatureScale - const valueRelativeToScale = (scale.high - temp) / (scale.high - scale.low) - const scaleHeight = config.chartHeight - return scaleHeight * valueRelativeToScale } \ No newline at end of file diff --git a/components/cycle-day/cycle-day-overview.js b/components/cycle-day/cycle-day-overview.js index 168954f..85e8d48 100644 --- a/components/cycle-day/cycle-day-overview.js +++ b/components/cycle-day/cycle-day-overview.js @@ -31,7 +31,7 @@ export default class CycleDayOverView extends Component { } } - goToCycleDay(target) { + goToCycleDay = (target) => { const localDate = LocalDate.parse(this.state.cycleDay.date) const targetDate = target === 'before' ? localDate.minusDays(1).toString() : @@ -55,7 +55,7 @@ export default class CycleDayOverView extends Component { isCycleDayOverView={true} cycleDayNumber={cycleDayNumber} date={cycleDay.date} - goToCycleDay={this.goToCycleDay.bind(this)} + goToCycleDay={this.goToCycleDay} /> @@ -134,7 +134,10 @@ function getLabel(symptomName, symptom) { cervix: cervix => { let cervixLabel = [] if (cervix.opening > -1 && cervix.firmness > -1) { - cervixLabel.push(openingLabels[cervix.opening], firmnessLabels[cervix.firmness]) + cervixLabel.push( + openingLabels[cervix.opening], + firmnessLabels[cervix.firmness] + ) if (cervix.position > -1) { cervixLabel.push(positionLabels[cervix.position]) } diff --git a/components/cycle-day/labels/labels.js b/components/cycle-day/labels/labels.js index fba3197..6650e33 100644 --- a/components/cycle-day/labels/labels.js +++ b/components/cycle-day/labels/labels.js @@ -26,3 +26,9 @@ export const fertilityStatus = { fertileUntilEvening: 'Fertile phase ends in the evening', unknown: 'We cannot show any cycle information because no menses has been entered' } + +export const temperature = { + outOfRangeWarning: 'This temperature value is out of the current range for the temperature chart. You can change the range in the settings.', + outOfAbsoluteRangeWarning: 'This temperature value is too high or low to be shown on the temperature chart.', + saveAnyway: 'Save anyway' +} diff --git a/components/cycle-day/symptoms/action-button-footer.js b/components/cycle-day/symptoms/action-button-footer.js index a153496..dac39a6 100644 --- a/components/cycle-day/symptoms/action-button-footer.js +++ b/components/cycle-day/symptoms/action-button-footer.js @@ -8,7 +8,14 @@ import styles, {iconStyles} from '../../../styles' export default class ActionButtonFooter extends Component { render() { - const { symptom, cycleDay, saveAction, saveDisabled, navigate} = this.props + const { + symptom, + cycleDay, + saveAction, + saveDisabled, + navigate, + autoShowDayView = true} + = this.props const navigateToOverView = () => navigate('CycleDay', {cycleDay}) const buttons = [ { @@ -28,7 +35,7 @@ export default class ActionButtonFooter extends Component { title: 'Save', action: () => { saveAction() - navigateToOverView() + if (autoShowDayView) navigateToOverView() }, disabledCondition: saveDisabled, icon: 'content-save-outline' diff --git a/components/cycle-day/symptoms/temperature.js b/components/cycle-day/symptoms/temperature.js index 629f5b2..11ee7da 100644 --- a/components/cycle-day/symptoms/temperature.js +++ b/components/cycle-day/symptoms/temperature.js @@ -5,6 +5,7 @@ import { TextInput, Switch, Keyboard, + Alert, ScrollView } from 'react-native' import DateTimePicker from 'react-native-modal-datetime-picker-nevo' @@ -12,35 +13,84 @@ import DateTimePicker from 'react-native-modal-datetime-picker-nevo' import { getPreviousTemperature, saveSymptom } from '../../../db' import styles from '../../../styles' import { LocalTime, ChronoUnit } from 'js-joda' +import { temperature as tempLabels } from '../labels/labels' +import { scaleObservable } from '../../../local-storage' +import { shared } from '../../labels' import ActionButtonFooter from './action-button-footer' +import config from '../../../config' -const MINUTES = ChronoUnit.MINUTES +const minutes = ChronoUnit.MINUTES export default class Temp extends Component { constructor(props) { super(props) this.cycleDay = props.cycleDay this.makeActionButtons = props.makeActionButtons - let initialValue const temp = this.cycleDay.temperature - if (temp) { - initialValue = temp.value.toString() - this.time = temp.time - } else { - const prevTemp = getPreviousTemperature(this.cycleDay) - initialValue = prevTemp ? prevTemp.toString() : '' + this.state = { + exclude: temp ? temp.exclude : false, + time: temp ? temp.time : LocalTime.now().truncatedTo(minutes).toString(), + isTimePickerVisible: false, + outOfRange: null } - this.state = { - currentValue: initialValue, - exclude: temp ? temp.exclude : false, - time: this.time || LocalTime.now().truncatedTo(MINUTES).toString(), - isTimePickerVisible: false + if (temp) { + this.state.temperature = temp.value.toString() + if (temp.value === Math.floor(temp.value)) { + this.state.temperature = `${this.state.temperature}.0` + } + } else { + const prevTemp = getPreviousTemperature(this.cycleDay) + if (prevTemp) { + this.state.temperature = prevTemp.toString() + this.state.isSuggestion = true + } } } + saveTemperature = () => { + const dataToSave = { + value: Number(this.state.temperature), + exclude: this.state.exclude, + time: this.state.time + } + saveSymptom('temperature', this.cycleDay, dataToSave) + this.props.navigate('CycleDay', {cycleDay: this.cycleDay}) + } + + checkRangeAndSave = () => { + const value = Number(this.state.temperature) + + const absolute = { + min: config.temperatureScale.min, + max: config.temperatureScale.max + } + const scale = scaleObservable.value + let warningMsg + if (value < absolute.min || value > absolute.max) { + warningMsg = tempLabels.outOfAbsoluteRangeWarning + } else if (value < scale.min || value > scale.max) { + warningMsg = tempLabels.outOfRangeWarning + } + + if (warningMsg) { + Alert.alert( + shared.warning, + warningMsg, + [ + { text: shared.cancel }, + { text: shared.save, onPress: this.saveTemperature} + ] + ) + } else { + this.saveTemperature() + } + + } + + render() { return ( @@ -48,14 +98,10 @@ export default class Temp extends Component { Temperature (°C) - { - this.setState({ currentValue: val }) - }} - keyboardType='numeric' - value={this.state.currentValue} + this.setState(val)} + isSuggestion={this.state.isSuggestion} /> @@ -94,22 +140,42 @@ export default class Temp extends Component { { - const dataToSave = { - value: Number(this.state.currentValue), - exclude: this.state.exclude, - time: this.state.time - } - saveSymptom('temperature', this.props.cycleDay, dataToSave) - }} - saveDisabled={this.state.currentValue === '' || isInvalidTime(this.state.time)} + saveAction={() => this.checkRangeAndSave()} + saveDisabled={ + this.state.temperature === '' || + isNaN(Number(this.state.temperature)) || + isInvalidTime(this.state.time) + } navigate={this.props.navigate} + autoShowDayView={false} /> ) } } +class TempInput extends Component { + render() { + const style = [styles.temperatureTextInput] + if (this.props.isSuggestion) { + style.push(styles.temperatureTextInputSuggestion) + } + return ( + { + if (isNaN(Number(val))) return + this.props.setState({ temperature: val, isSuggestion: false }) + }} + keyboardType='numeric' + value={this.props.value} + onBlur={this.checkRange} + autoFocus={true} + /> + ) + } +} + function isInvalidTime(timeString) { try { LocalTime.parse(timeString) diff --git a/components/labels.js b/components/labels.js index 96cdcf2..c439176 100644 --- a/components/labels.js +++ b/components/labels.js @@ -1,9 +1,12 @@ +export const shared = { + cancel: 'Cancel', + save: 'Save', + errorTitle: 'Error', + successTitle: 'Success', + warning: 'Warning' +} + export const settings = { - shared: { - cancel: 'Cancel', - errorTitle: 'Error', - successTitle: 'Success' - }, export: { errors: { noData: 'There is no data to export', @@ -13,6 +16,7 @@ export const settings = { title: 'My Drip data export', subject: 'My Drip data export', button: 'Export data', + segmentExplainer: 'Export data in CSV format for backup or so you can use it elsewhere' }, import: { button: 'Import data', @@ -28,7 +32,16 @@ export const settings = { }, success: { message: 'Data successfully imported' - } + }, + segmentExplainer: 'Import data in CSV format' + }, + tempScale: { + segmentTitle: 'Temperature scale', + segmentExplainer: 'Change the minimum and maximum value for the temperature chart', + min: 'Min', + max: 'Max', + loadError: 'Could not load saved temperature scale settings', + saveError: 'Could not save temperature scale settings' } } diff --git a/components/menu.js b/components/menu.js index 8a55187..737203b 100644 --- a/components/menu.js +++ b/components/menu.js @@ -8,7 +8,7 @@ import styles, { iconStyles } from '../styles' import Icon from 'react-native-vector-icons/MaterialCommunityIcons' export default class Menu extends Component { - makeMenuItem({ title, icon, onPress}, i) { + makeMenuItem = ({ title, icon, onPress}, i) => { return ( this.goTo('Chart') }, { title: 'Stats', icon: 'chart-pie', onPress: () => this.goTo('Stats') }, { title: 'Settings', icon: 'settings', onPress: () => this.goTo('Settings') }, - ].map(this.makeMenuItem.bind(this))} + ].map(this.makeMenuItem)} ) } diff --git a/components/settings.js b/components/settings.js index 97907b1..f03aec9 100644 --- a/components/settings.js +++ b/components/settings.js @@ -1,80 +1,161 @@ import React, { Component } from 'react' import { View, - Button, + TouchableOpacity, ScrollView, - Alert + Alert, + Text } from 'react-native' - +import Slider from '@ptomasroos/react-native-multi-slider' import Share from 'react-native-share' import { DocumentPicker, DocumentPickerUtil } from 'react-native-document-picker' import rnfs from 'react-native-fs' -import styles from '../styles/index' -import { settings as labels } from './labels' +import styles, { secondaryColor } from '../styles/index' +import config from '../config' +import { settings as settingsLabels, shared as sharedLabels } from './labels' import getDataAsCsvDataUri from '../lib/import-export/export-to-csv' import importCsv from '../lib/import-export/import-from-csv' +import { scaleObservable, saveTempScale } from '../local-storage' export default class Settings extends Component { render() { return ( - - - - - - - + + + {settingsLabels.tempScale.segmentTitle} + + {settingsLabels.tempScale.segmentExplainer} + + + + + {settingsLabels.export.button} + + {settingsLabels.export.segmentExplainer} + + + {settingsLabels.export.button} + + + + + + {settingsLabels.import.button} + + {settingsLabels.import.segmentExplainer} + + + {settingsLabels.import.button} + + ) } } +class TempSlider extends Component { + constructor(props) { + super(props) + this.state = Object.assign({}, scaleObservable.value) + } + + onValuesChange = (values) => { + this.setState({ + min: values[0], + max: values[1] + }) + } + + onValuesChangeFinish = (values) => { + this.setState({ + min: values[0], + max: values[1] + }) + try { + saveTempScale(this.state) + } catch(err) { + alertError(settingsLabels.tempScale.saveError) + } + } + + render() { + return ( + + {`${settingsLabels.tempScale.min} ${this.state.min}`} + {`${settingsLabels.tempScale.max} ${this.state.max}`} + + + ) + } +} + async function openShareDialogAndExport() { let data try { data = getDataAsCsvDataUri() if (!data) { - return alertError(labels.errors.noData) + return alertError(settingsLabels.errors.noData) } } catch (err) { console.error(err) - return alertError(labels.errors.couldNotConvert) + return alertError(settingsLabels.errors.couldNotConvert) } try { await Share.open({ - title: labels.export.title, + title: settingsLabels.export.title, url: data, - subject: labels.export.subject, + subject: settingsLabels.export.subject, type: 'text/csv', showAppsToView: true }) } catch (err) { console.error(err) - return alertError(labels.export.errors.problemSharing) + return alertError(settingsLabels.export.errors.problemSharing) } } function openImportDialogAndImport() { Alert.alert( - labels.import.title, - labels.import.message, + settingsLabels.import.title, + settingsLabels.import.message, [{ - text: labels.import.replaceOption, + text: settingsLabels.import.replaceOption, onPress: () => getFileContentAndImport({ deleteExisting: false }) }, { - text: labels.import.deleteOption, + text: settingsLabels.import.deleteOption, onPress: () => getFileContentAndImport({ deleteExisting: true }) }, { - text: labels.shared.cancel, style: 'cancel', onPress: () => { } + text: sharedLabels.cancel, style: 'cancel', onPress: () => { } }] ) } @@ -99,22 +180,22 @@ async function getFileContentAndImport({ deleteExisting }) { try { fileContent = await rnfs.readFile(fileInfo.uri, 'utf8') } catch (err) { - return importError(labels.import.errors.couldNotOpenFile) + return importError(settingsLabels.import.errors.couldNotOpenFile) } try { await importCsv(fileContent, deleteExisting) - Alert.alert(labels.import.success.title, labels.import.success.message) + Alert.alert(sharedLabels.successTitle, settingsLabels.import.success.message) } catch(err) { importError(err.message) } } function alertError(msg) { - Alert.alert(labels.shared.errorTitle, msg) + Alert.alert(sharedLabels.errorTitle, msg) } function importError(msg) { - const postFixed = `${msg}\n\n${labels.import.errors.postFix}` + const postFixed = `${msg}\n\n${settingsLabels.import.errors.postFix}` alertError(postFixed) -} \ No newline at end of file +} diff --git a/config.js b/config.js new file mode 100644 index 0000000..772e828 --- /dev/null +++ b/config.js @@ -0,0 +1,18 @@ +const config = { + columnWidth: 25, + columnHeightPercentage: 0.84, + xAxisHeightPercentage: 0.08, + symptomRowHeightPercentage: 0.08, + temperatureScale: { + defaultLow: 35, + defaultHigh: 38, + min: 34, + max: 40, + units: 0.1, + verticalPadding: 0.03 + } +} + +config.columnMiddle = config.columnWidth / 2 + +export default config \ No newline at end of file diff --git a/local-storage/index.js b/local-storage/index.js new file mode 100644 index 0000000..50d886f --- /dev/null +++ b/local-storage/index.js @@ -0,0 +1,26 @@ +import { AsyncStorage } from 'react-native' +import Observable from 'obv' +import config from '../config' + +export const scaleObservable = Observable() +setTempScaleInitially() + +async function setTempScaleInitially() { + const result = await AsyncStorage.getItem('tempScale') + let value + if (result) { + value = JSON.parse(result) + } else { + value = { + min: config.temperatureScale.defaultLow, + max: config.temperatureScale.defaultHigh + } + } + scaleObservable.set(value) +} + +export async function saveTempScale(scale) { + await AsyncStorage.setItem('tempScale', JSON.stringify(scale)) + scaleObservable.set(scale) +} + diff --git a/package-lock.json b/package-lock.json index 3ab223e..11aa75a 100644 --- a/package-lock.json +++ b/package-lock.json @@ -723,6 +723,11 @@ } } }, + "@ptomasroos/react-native-multi-slider": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/@ptomasroos/react-native-multi-slider/-/react-native-multi-slider-1.0.0.tgz", + "integrity": "sha512-NpX22rQLArg9widwMzGf7XsInTDf6mfY/D1XaDVjglNkVphj3NSN37+nF6MofArCxC++1P+jHv0SGWbmJQwy4g==" + }, "abbrev": { "version": "1.1.1", "resolved": "https://registry.npmjs.org/abbrev/-/abbrev-1.1.1.tgz", @@ -3745,11 +3750,13 @@ }, "balanced-match": { "version": "1.0.0", - "bundled": true + "bundled": true, + "optional": true }, "brace-expansion": { "version": "1.1.11", "bundled": true, + "optional": true, "requires": { "balanced-match": "1.0.0", "concat-map": "0.0.1" @@ -3762,15 +3769,18 @@ }, "code-point-at": { "version": "1.1.0", - "bundled": true + "bundled": true, + "optional": true }, "concat-map": { "version": "0.0.1", - "bundled": true + "bundled": true, + "optional": true }, "console-control-strings": { "version": "1.1.0", - "bundled": true + "bundled": true, + "optional": true }, "core-util-is": { "version": "1.0.2", @@ -3873,7 +3883,8 @@ }, "inherits": { "version": "2.0.3", - "bundled": true + "bundled": true, + "optional": true }, "ini": { "version": "1.3.5", @@ -3883,6 +3894,7 @@ "is-fullwidth-code-point": { "version": "1.0.0", "bundled": true, + "optional": true, "requires": { "number-is-nan": "1.0.1" } @@ -3895,17 +3907,20 @@ "minimatch": { "version": "3.0.4", "bundled": true, + "optional": true, "requires": { "brace-expansion": "1.1.11" } }, "minimist": { "version": "0.0.8", - "bundled": true + "bundled": true, + "optional": true }, "minipass": { "version": "2.2.4", "bundled": true, + "optional": true, "requires": { "safe-buffer": "5.1.1", "yallist": "3.0.2" @@ -3922,6 +3937,7 @@ "mkdirp": { "version": "0.5.1", "bundled": true, + "optional": true, "requires": { "minimist": "0.0.8" } @@ -3994,7 +4010,8 @@ }, "number-is-nan": { "version": "1.0.1", - "bundled": true + "bundled": true, + "optional": true }, "object-assign": { "version": "4.1.1", @@ -4004,6 +4021,7 @@ "once": { "version": "1.4.0", "bundled": true, + "optional": true, "requires": { "wrappy": "1.0.2" } @@ -4109,6 +4127,7 @@ "string-width": { "version": "1.0.2", "bundled": true, + "optional": true, "requires": { "code-point-at": "1.1.0", "is-fullwidth-code-point": "1.0.0", @@ -6009,6 +6028,11 @@ } } }, + "obv": { + "version": "0.0.1", + "resolved": "https://registry.npmjs.org/obv/-/obv-0.0.1.tgz", + "integrity": "sha1-yyNhBjQVNvDaxIFeBnCCIcrX+14=" + }, "on-finished": { "version": "2.3.0", "resolved": "https://registry.npmjs.org/on-finished/-/on-finished-2.3.0.tgz", diff --git a/package.json b/package.json index 6ff1901..2c492c5 100644 --- a/package.json +++ b/package.json @@ -8,13 +8,14 @@ ], "scripts": { "start": "node node_modules/react-native/local-cli/cli.js start", - "android": "./node_modules/.bin/react-native run-android", - "log": "./node_modules/.bin/react-native log-android | grep -v 'Warning: isMounted(...) is deprecated'", + "android": "react-native run-android", + "log": "react-native log-android", "test": "mocha --recursive --require @babel/register test && npm run lint", "test-watch": "mocha --recursive --require @babel/register --watch test", "lint": "eslint components lib test" }, "dependencies": { + "@ptomasroos/react-native-multi-slider": "^1.0.0", "assert": "^1.4.1", "csvtojson": "^2.0.8", "date-range": "0.0.2", @@ -23,6 +24,7 @@ "js-joda": "^1.8.2", "moment": "^2.22.1", "object-path": "^0.11.4", + "obv": "0.0.1", "react": "16.4.1", "react-native": "^0.56.0", "react-native-calendars": "^1.19.3", @@ -46,5 +48,25 @@ "eslint-plugin-react": "^7.8.2", "mocha": "^5.2.0", "react-test-renderer": "16.3.1" - } + }, + "description": "A menstrual cycle tracking app that's open-source and leaves your data on your phone. Use it to track your menstrual cycle or for fertility awareness!", + "main": "index.js", + "directories": { + "lib": "lib", + "test": "test" + }, + "repository": { + "type": "git", + "url": "git+ssh://git@gitlab.com/bloodyhealth/drip.git" + }, + "keywords": [ + "cycle-tracking", + "symptothermal" + ], + "author": "", + "license": "GPL-3.0-or-later", + "bugs": { + "url": "https://gitlab.com/bloodyhealth/drip/issues" + }, + "homepage": "https://gitlab.com/bloodyhealth/drip#README" } diff --git a/styles/index.js b/styles/index.js index 6e14c9f..406de7a 100644 --- a/styles/index.js +++ b/styles/index.js @@ -92,16 +92,17 @@ export default StyleSheet.create({ }, header: { backgroundColor: primaryColor, - paddingVertical: 18, paddingHorizontal: 15, alignItems: 'center', - justifyContent: 'center' + justifyContent: 'center', + height: '10%' }, menu: { backgroundColor: primaryColor, alignItems: 'center', justifyContent: 'space-between', - flexDirection: 'row' + flexDirection: 'row', + height: '12%' }, menuItem: { alignItems: 'center', @@ -116,7 +117,8 @@ export default StyleSheet.create({ }, headerCycleDay: { flexDirection: 'row', - justifyContent: 'space-between' + justifyContent: 'space-between', + height: '15%' }, navigationArrow: { fontSize: 60, @@ -129,9 +131,11 @@ export default StyleSheet.create({ marginBottom: 15 }, temperatureTextInput: { - width: 80, - textAlign: 'center', - fontSize: 20 + fontSize: 20, + color: 'black' + }, + temperatureTextInputSuggestion: { + color: '#939393' }, actionButtonRow: { flexDirection: 'row', @@ -152,6 +156,23 @@ export default StyleSheet.create({ textAlign: 'left', textAlignVertical: 'center' }, + settingsSegment: { + backgroundColor: 'lightgrey', + padding: 10, + marginBottom: 10, + }, + settingsSegmentTitle: { + fontWeight: 'bold' + }, + settingsButton: { + backgroundColor: secondaryColor, + padding: 10, + alignItems: 'center', + margin: 10 + }, + settingsButtonText: { + color: fontOnPrimaryColor + }, statsRow: { flexDirection: 'row', width: '100%' diff --git a/test/cycle-length.spec.js b/test/cycle-length.spec.js index 3714337..fc0d451 100644 --- a/test/cycle-length.spec.js +++ b/test/cycle-length.spec.js @@ -17,7 +17,7 @@ describe('getCycleLengthStats', () => { stdDeviation: 53.06 } expect(result).to.eql(expectedResult) - }) + }), it('works for a simple even-numbered array', () => { const cycleLengths = [4, 1, 15, 2, 20, 5] @@ -30,7 +30,8 @@ describe('getCycleLengthStats', () => { stdDeviation: 7.78 } expect(result).to.eql(expectedResult) - }) + }), + it('works for an one-element array', () => { const cycleLengths = [42] const result = cycleInfo(cycleLengths) @@ -42,20 +43,60 @@ describe('getCycleLengthStats', () => { stdDeviation: null } expect(result).to.eql(expectedResult) + }), + + describe('works for more realistic examples', () => { + it('1 day difference between shortest and longest period', () => { + const cycleLengths = [28, 29, 28, 28, 28, 29, 28, 28, 28, 29, 29, 28] + const result = cycleInfo(cycleLengths) + const expectedResult = { + minimum: 28, + maximum: 29, + mean: 28.33, + median: 28, + stdDeviation: 0.49 + } + expect(result).to.eql(expectedResult) + }), + it('3 days difference between shortest and longest period', () => { + const cycleLengths = [28, 29, 28, 28, 27, 30, 28, 27, 28, 28, 29, 27] + const result = cycleInfo(cycleLengths) + const expectedResult = { + minimum: 27, + maximum: 30, + mean: 28.08, + median: 28, + stdDeviation: 0.90 + } + expect(result).to.eql(expectedResult) + }), + it('8 days difference between shortest and longest period', () => { + const cycleLengths = [28, 32, 29, 27, 28, 26, 33, 28, 29, 34, 27, 29] + const result = cycleInfo(cycleLengths) + const expectedResult = { + minimum: 26, + maximum: 34, + mean: 29.17, + median: 28.5, + stdDeviation: 2.52 + } + expect(result).to.eql(expectedResult) + }) }) + describe('when args are wrong', () => { it('throws when arg object is an empty array', () => { const cycleLengths = [] expect(() => cycleInfo(cycleLengths).to.throw(AssertionError)) - }) + }), it('throws when arg object is not in right format', () => { const wrongObject = { hello: 'world' } expect(() => cycleInfo(wrongObject).to.throw(AssertionError)) - }) + }), it('throws when arg array contains a string', () => { const wrongElement = [4, 1, 15, '2', 20, 5] expect(() => cycleInfo(wrongElement).to.throw(AssertionError)) - }) + }), it('throws when arg array contains a NaN', () => { const wrongElement = [4, 1, 15, NaN, 20, 5] expect(() => cycleInfo(wrongElement).to.throw(AssertionError)) diff --git a/test/cycle.spec.js b/test/cycle.spec.js index 2cbbab9..c73b757 100644 --- a/test/cycle.spec.js +++ b/test/cycle.spec.js @@ -583,4 +583,83 @@ describe('getPredictedMenses', () => { expect(result).to.eql(expectedResult) }) }) +}) + +describe('getAllMensesStart', () => { + it('works for one cycle start', () => { + const cycleDaysSortedByDate = [ + { + date: '2018-05-01', + bleeding: { value: 1 } + } + ] + + const { getAllMensesStarts } = cycleModule({ + cycleDaysSortedByDate, + bleedingDaysSortedByDate: cycleDaysSortedByDate.filter(d => d.bleeding) + }) + const result = getAllMensesStarts() + expect(result.length).to.eql(1) + expect(result).to.eql(['2018-05-01']) + }), + it('works for two cycle starts', () => { + const cycleDaysSortedByDate = [ + { + date: '2018-06-02', + bleeding: { value: 2 } + }, + { + date: '2018-06-01', + bleeding: { value: 2 } + }, + { + date: '2018-05-01', + bleeding: { value: 2 } + } + ] + + const { getAllMensesStarts } = cycleModule({ + cycleDaysSortedByDate, + bleedingDaysSortedByDate: cycleDaysSortedByDate.filter(d => d.bleeding) + }) + const result = getAllMensesStarts() + expect(result.length).to.eql(2) + expect(result).to.eql(['2018-06-01', '2018-05-01']) + }), + it('works for two cycle starts with excluded data', () => { + const cycleDaysSortedByDate = [ + { + date: '2018-06-01', + bleeding: { value: 2 } + }, + { + date: '2018-05-01', + bleeding: { value: 2 } + }, + { + date: '2018-04-31', + bleeding: { value: 2 , exclude: true} + }, + ] + + const { getAllMensesStarts } = cycleModule({ + cycleDaysSortedByDate, + bleedingDaysSortedByDate: cycleDaysSortedByDate.filter(d => d.bleeding) + }) + const result = getAllMensesStarts() + expect(result.length).to.eql(2) + expect(result).to.eql(['2018-06-01', '2018-05-01']) + }), + it('returns an empty array if no bleeding days are given', () => { + const cycleDaysSortedByDate = [ {} ] + + const { getAllMensesStarts } = cycleModule({ + cycleDaysSortedByDate, + bleedingDaysSortedByDate: cycleDaysSortedByDate.filter(d => d.bleeding) + }) + const result = getAllMensesStarts() + expect(result.length).to.eql(0) + expect(result).to.eql([]) +>>>>>>> test/cycle.spec.js + }) }) \ No newline at end of file