├── LICENSE ├── README.components.md ├── README.environments.md ├── README.install-a-new-macbook.md ├── README.md ├── README.meta.md └── README.tricks.md /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.components.md: -------------------------------------------------------------------------------- 1 | # New components 2 | 3 | - Git Flow 4 | - Error, decline, success (statuscodes) 5 | - App Platform 6 | - Automated tests (in platform) 7 | - Cronjob (only 1 instance + app.update.js replacement) 8 | 9 | # Always use 10 | 11 | - Sentry 12 | -------------------------------------------------------------------------------- /README.environments.md: -------------------------------------------------------------------------------- 1 | # Naming convention environments 2 | 3 | ### Production environment 4 | 5 | - Branch: master 6 | - Domain: [https://randomcompanyname.nl] 7 | - Database: [wl-rcn-production] 8 | 9 | ### Release environment 10 | 11 | - Branch: release 12 | - Domain: [https://release.randomcompanyname.nl] 13 | - Database: [wl-rcn-production] 14 | 15 | ### Develop environment 16 | 17 | - Branch: develop 18 | - Domain: [https://develop.randomcompanyname.nl] 19 | - Database: [wl-rcn-develop] 20 | 21 | ### Develop environment (localhost) 22 | 23 | - Branch: develop / goal-branch 24 | - Domain: [https://develop.localhost:4200] 25 | - Database [wl-rcn-develop] 26 | 27 | # Naming motivation 28 | 29 | - Branch name: _based upon naming in git flow_ 30 | - Domain: _given by organisation, environments match subdomain_ 31 | - Database: _`wl-rcn` can be custom per organisation, database name matches environment label_ 32 | 33 | 57 | -------------------------------------------------------------------------------- /README.install-a-new-macbook.md: -------------------------------------------------------------------------------- 1 | # Programming 2 | 3 | ```bash 4 | /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" 5 | brew install --cask iterm2 6 | xcode-select --install 7 | 8 | # Terminal should be silent 9 | touch .hushlogin # No timestamp on startup 10 | 11 | # Oh My Zsh 12 | sh -c "$(curl -fsSL https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh)" # Oh my ZSH! 13 | git clone https://github.com/zsh-users/zsh-autosuggestions ${ZSH_CUSTOM:-~/.oh-my-zsh/custom}/plugins/zsh-autosuggestions 14 | sed -i '.bak' 's/(git)/(git zsh-autosuggestions)/g' ~/.zshrc 15 | # (echo 'ZSH_DISABLE_COMPFIX=true' && cat ~/.zshrc) > ~/.zshrc-tmp && mv ~/.zshrc-tmp ~/.zshrc 16 | # echo 'ssh-add -q -K ~/.ssh/id_rsa' >> ~/.zshrc 17 | 18 | # NodeJS 19 | curl -fsSL https://fnm.vercel.app/install | bash 20 | fnm install 14.15.1 21 | 22 | # Visual studio code 23 | brew install --cask visual-studio-code 24 | 25 | # Database 26 | # (2020-12-12 - Rosetta 2) 27 | brew install --cask robo-3t 28 | brew tap mongodb/brew 29 | brew install mongodb-community 30 | echo '# Replication' >> /opt/homebrew/etc/mongod.conf 31 | echo 'replication:' >> /opt/homebrew/etc/mongod.conf 32 | echo ' replSetName: rs01' >> /opt/homebrew/etc/mongod.conf 33 | brew services stop mongodb/brew/mongodb-community 34 | brew services start mongodb/brew/mongodb-community 35 | mongosh 36 | rs.initiate() 37 | db.disableFreeMonitoring() 38 | 39 | # Git 40 | # (2020-12-12 - Rosetta 2) 41 | brew install git-flow 42 | 43 | # Digital Ocean 44 | brew install doctl 45 | doctl auth init 46 | 47 | 48 | ``` 49 | 50 | ### Extra steps in Visual Studio code 51 | 52 | 1. Press `CMD + p` and run `ext install esbenp.prettier-vscode` 53 | 1. Press `CMD + p` and run `ext install angular.ng-template` 54 | 1. Press `CMD + SHIFT + P` and run `Settings JSON` 55 | 1. Copy and paste following: 56 | 57 | ```json 58 | { 59 | "telemetry.enableTelemetry": false, 60 | "workbench.statusBar.visible": false, 61 | "workbench.activityBar.visible": false, 62 | "editor.defaultFormatter": "esbenp.prettier-vscode", 63 | "editor.formatOnSave": true, 64 | "explorer.confirmDelete": false, 65 | "window.zoomLevel": 0, 66 | "files.exclude": { 67 | "node_modules/": true, 68 | "dist/": true, 69 | "dist-new/": true, 70 | "e2e/": true 71 | }, 72 | "explorer.confirmDragAndDrop": false 73 | } 74 | ``` 75 | 76 | # Brew applications must haves 77 | 78 | ```bash 79 | brew install --cask google-chrome # If Cypress user, install Chrome Dev (different icon) 80 | brew install --cask spotify 81 | brew install --cask private-internet-access 82 | brew install --cask brave-browser 83 | brew install --cask qbittorrent 84 | brew install --cask vlc 85 | brew install --cask whatsapp 86 | brew install --cask telegram 87 | brew install --cask caffeine 88 | brew install --cask basecamp 89 | brew install nmap 90 | brew install thefuck # Correct small mistakes 91 | ``` 92 | 93 | # Settings 94 | 95 | - Drag with three fingers enable 96 | - Spotlight don’t look for files or web 97 | - Keyboard use as F1 keys 98 | - Finder / Advanced / Keep folders on top 99 | - Auto-hide top bar 100 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Node.js Mongoose Style Guide 2 | 3 | This is a guide for writing consistent and aesthetically pleasing mongoose models. 4 | It is inspired by what is popular within the community, and flavored with some 5 | personal opinions. 6 | 7 | The style-guide style is largely based on [this style-guide](https://github.com/felixge/node-style-guide) and assumes knowledge of it. 8 | 9 | This guide was created by [Woodland](https://woodl.nl/) and is 10 | licensed under the [CC BY-SA 3.0](https://creativecommons.org/licenses/by-sa/3.0/) 11 | license. You are encouraged to fork this repository and make adjustments 12 | according to your preferences. 13 | 14 | ![Creative Commons License](https://i.creativecommons.org/l/by-sa/3.0/88x31.png) 15 | 16 | ## Table of contents 17 | 18 | ### Mongoose basics 19 | 20 | - [Standards](#standards) 21 | - [Folder structure](#folder-structure) 22 | - [Schema structure](#schema-structure) 23 | - [Schema grouping](#schema-grouping) 24 | - [Motivation for singular form](#motivation-for-singular-form) 25 | 26 | ### Mongoose flat versus structured 27 | 28 | - [Tradeof: Flat versus structured](#camelcase-versus-object) 29 | 30 | ### Mongoose population 31 | 32 | - [Populateable guide](#populateable-guide) 33 | 34 | ### Mongoose stable patterns 35 | 36 | To be added, we will discuss some often repeating patterns and how to name these 37 | 38 | - [Storing history](#history) 39 | - [Storing history](#history) 40 | 41 | - Always store \_id when storing history, this way you can revert to a certain stage. 42 | 43 | ## Mongoose basics 44 | 45 | ### Standards 46 | 47 | - Use American spelling 48 | 49 | ### Folder structure 50 | 51 | Make sure to have a seperate folder for most _Mongoose_ or _MongoDB_ related. 52 | 53 | 1. Root file where you combine all models and export them ([example](#schema-grouping)) 54 | 2. Group files related to a model together, use singular form 55 | 3. Always use index.js for the root schema ([example](#basics)) 56 | 4. Create a shared folder which contains reusable schemas 57 | 58 | ```bash 59 | |-- models 60 | |-- index.js # (1) 61 | |-- user # (2) 62 | |-- index.js # (3) 63 | |-- email.js 64 | |-- company 65 | |-- product 66 | |-- shared # (4) 67 | |-- count.js 68 | |-- name.js 69 | |-- amount.js 70 | |-- duration.js 71 | 72 | ``` 73 | 74 | ### Schema structure 75 | 76 | Basic structure of an exported schema. Avoid specifying more than one schema per file. 77 | 78 | ```js 79 | // (0) Requires 80 | let Schema = require("mongoose").Schema; 81 | let SchemaObjectId = Schema.Types.ObjectId; 82 | 83 | // (1) Define object 84 | let SchemaMain = new Schema({ 85 | // Schema 86 | }); 87 | 88 | // (2) Pre/post hooks 89 | SchemaMain.pre("save", function (next) { 90 | next(); 91 | }); 92 | 93 | // (3) Methods 94 | SchemaMain.methods.logThis = function () { 95 | console.log("This is a reference to the instance", this); 96 | }; 97 | 98 | // (4) Statics 99 | SchemaMain.statics.logModel = function () { 100 | console.log("This is a reference to the model", this); 101 | }; 102 | 103 | // (5) Export 104 | module.exports = SchemaMain; 105 | ``` 106 | 107 | ### Schema grouping 108 | 109 | Your schemas are grouped in another file. You can require these models in another folder but since in a lot of projects communication with the database is so commonplace that we suggest storing them in a global variable. 110 | 111 | As you can see in the following example, we leave the Schema, folder and model property names in singular form a motivation is found in the next chapter. 112 | 113 | ```js 114 | let model = require("mongoose").model; 115 | 116 | let SchemaUser = require(root + "/path/to/models/user/"); 117 | let SchemaProduct = require(root + "/path/to/models/product/"); 118 | let SchemaCompany = require(root + "/path/to/models/company/"); 119 | 120 | module.exports = { 121 | User: model("user", SchemaUser), 122 | Company: model("company", SchemaCompany), 123 | Product: model("product", SchemaProduct), 124 | }; 125 | ``` 126 | 127 | **User** is a class so it is UpperCamelCased 128 | 129 | **user** is a collection name in MongoDB which by convention are lowercase 130 | 131 | ### Motivation for singular form 132 | 133 | I am not saying you should ban plural from your programming alltogether, there are 134 | 135 | 0. It does not give extra insight. 136 | 137 | ```js 138 | 139 | ``` 140 | 141 | 1. The English language has [rather confusing plurals](https://en.wikipedia.org/wiki/English_plurals) 142 | 2. Plural (often) makes the word longer 143 | 144 | | Singular | Plural | Character gain | Comment | 145 | | :--------- | :--------- | -------------: | ------------------ | 146 | | User | Users | +25% | | 147 | | Life | Lives | +25% | | 148 | | Dish | Dishes | +50% | | 149 | | Mouse | Mice | -20% | Shorter! | 150 | | Radius | Radii | -17% | Shorter! | 151 | | Staff | Staffs | +20% | | 152 | | Staff | Staves | +20% | Alternative plural | 153 | | Child | Children | 60% | | 154 | | Bison | Bison | +0% | | 155 | | Company | Companies | +29% | | 156 | | Product | Products | +14% | | 157 | | Statistics | Statistics | +0% | Plural singular | 158 | 159 | 3. Object creation is slightly less readable in plural form 160 | 161 | ```js 162 | let model = require(root + "/path/to/models/"); 163 | 164 | // Singular - good boy example 165 | let user = new model.User(); 166 | let userQuery = model.User.find(); 167 | 168 | // Plural - bad boy example 169 | let user = new model.Users(); 170 | let userQuery = model.Users.find(); 171 | ``` 172 | 173 | ### Property naming 174 | 175 | For property names always use camelCase. Try to order parts of the word from more to lesser important. If we want to have a property that stores data of an profile picture we suggest naming that property: "pictureProfile". 176 | 177 | This might seem counterintuitive but this standardised way of property naming has several advantages: 178 | 179 | 1. Easy refactoring to new namespace 180 | 2. Readable 181 | 3. Consistent, which makes it easy to guess variable names 182 | 183 | TLDR; tips when naming properties: 184 | 185 | 1. Use camelCase 186 | 2. Order camelCase parts from most to least important 187 | (_do:_ nameFirst, _don't_: firstName) 188 | 3. Don't restate the current model name 189 | 4. Be descriptive, even though MongoDB favours short property names 190 | 5. Watch for reserved words 191 | 192 | _Note: After this example we suggest an alternative way for storing username_ 193 | 194 | ```js 195 | // Good boy example 196 | let user = { 197 | nameFirst: "Tim", 198 | nameMiddle: null, 199 | nameLast: "L", 200 | email: "user@example.com", 201 | emailSettings: {}, 202 | 203 | pictureProfile: "/url/to/profile.jpg", 204 | pictureBanner: "/url/to/banner.jpg", 205 | active: true, 206 | }; 207 | 208 | // Bad boy example 209 | let user = { 210 | name_first: "Tim", // (1) Not using camelCase 211 | middleName: null, // (2) Wrong order of elements 212 | userNameLast: "L", // (3) Restated name of model 213 | e: "user@example.com", // (4) Not descriptive 214 | options: {}, // (5) Using reserved property names 215 | 216 | picture_profile: "/url/to/profile.jpg", // (1) Not using camelCase 217 | banner_picture: "/url/to/profile.jpg", // (2) Wrong order of elements 218 | userActive: true, // (3) Restated name of model 219 | }; 220 | ``` 221 | 222 | **Exception 0 - When properties need numbers** 223 | 224 | Sometimes 225 | it is however [allowed](https://www.w3resource.com/slides/json-style-guide.php) to use numbers as a key when defining a map. 226 | 227 | ```js 228 | // True camelCase example 229 | let image = { 230 | icon32: SchemaImage, 231 | icon64: SchemaImage, 232 | }; 233 | 234 | // Intermediate option 235 | let image = { 236 | icon: { 237 | 32: SchemaImage, 238 | 64: SchemaImage, 239 | }, 240 | }; 241 | 242 | // Allowed for readability 243 | let image = { 244 | icon_32: SchemaImage, 245 | icon_64: SchemaImage, 246 | }; 247 | 248 | // Renaming, but you'll lose information and will run out of names quick 249 | // [xs, sm, md, lg, xl] 250 | let image = { 251 | icon_xs: SchemaImage, 252 | icon_xl: SchemaImage, 253 | }; 254 | ``` 255 | 256 | ### CamelCase versus object structuring 257 | 258 | Often you are confronted with a tradeof between _flat_ and _structured_ JSON. Consider the following two representations: 259 | 260 | ```js 261 | // Flat JSON 262 | let user = { 263 | nameFirst: "", 264 | nameMiddle: "", 265 | nameLast: "", 266 | }; 267 | ``` 268 | 269 | ```js 270 | // Structured JSON (stringified 43 characters 271 | let user = { 272 | name: { 273 | first: "", 274 | middle: "", 275 | last: "", 276 | }, 277 | }; 278 | ``` 279 | 280 | Flat structure seems more concise (please note that for a computer it is more lengthy!) and is usually advised: 281 | Structured JSON seems more verbose however it gives us several advantages: 282 | 283 | - Clear grouping of properties 284 | - Extra advantage: shorter select objects 285 | - Extra advantage: keep properties together (MongoDB does not preserve key order) 286 | - Easy to export and reuse 287 | 288 | We therefore suggest to **avoid all camelCase for these kinds of situations** where there is a clear parent-child relation. 289 | 290 | **Exception 0 - Intermediate properties are not used, and never will be used** 291 | 292 | In rare cases where you want to be very descriptive and are not interested in using the intermediate fields using camelCase can be useful. 293 | 294 | ```js 295 | // Before 296 | let user = { 297 | ageVerificationPictureUploadCompleted: true, 298 | }; 299 | 300 | // After de-camelCase-ization 301 | let user = { 302 | age: { 303 | verification: { 304 | picture: { 305 | upload: { 306 | completed: true, 307 | }, 308 | }, 309 | }, 310 | }, 311 | }; 312 | ``` 313 | 314 | _Note: in this example it is very unlikely you would not want to use any of the intermediate properties (e.g. we might a place to store the picture path `age.verification.picture.path`)_ 315 | 316 | **Exception 1 - Intermediate property makes no sense** 317 | 318 | In cases where you want to be very descriptive and are not interested in using the intermediate fields using camelCase can be useful. 319 | 320 | ```js 321 | // Before 322 | let user = { 323 | livingroomTelevisionCount: 1, 324 | twoPersonSofaCount: 1, 325 | }; 326 | 327 | // After de-camelCase-ization 328 | let user = { 329 | living: { 330 | room: { 331 | television: { 332 | count: 1, 333 | }, 334 | }, 335 | }, 336 | two: { person: { Sofa: { count: 1 } } }, 337 | }; 338 | ``` 339 | 340 | **Exception 2 - Reserved names** 341 | 342 | Often we like to store when, and by whom an property is edited: 343 | 344 | ```js 345 | // Before 346 | let user = { 347 | pincode: { 348 | value: '1234', 349 | setOn: '' 350 | setBy: '' 351 | } 352 | } 353 | 354 | // After de-camelCase-ization 355 | let user = { 356 | pincode: { 357 | value: '1234', 358 | set: { 359 | on: '', 360 | by: '' 361 | } 362 | } 363 | } 364 | ``` 365 | 366 | With this splitting we use two reserved words; **on** and **set**. Other reserved property names: 367 | 368 | ```js 369 | let notAllowed = [ 370 | "on", 371 | "get", 372 | "set", 373 | "init", 374 | "emit", 375 | "_events", 376 | "db", 377 | "isNew", 378 | "errors", 379 | "schema", 380 | "options", 381 | "modelName", 382 | "collection", 383 | "_pres", 384 | "_posts", 385 | "toObject", 386 | ]; 387 | let notAllowedWithAlternatives = { 388 | on: ["moment", "at"], 389 | emit: [], 390 | _events: [], 391 | db: [], 392 | get: ["receive"], 393 | set: ["put", "made"], 394 | init: ["create"], 395 | isNew: [], 396 | errors: [], 397 | schema: [], 398 | options: [], 399 | modelName: [], 400 | collection: [], 401 | _pres: [], 402 | _posts: [], 403 | toObject: [], 404 | }; 405 | ``` 406 | 407 | _Note: we suggest avoiding these words even as a part of your property names since later splitting will cause problems (the example with setOn and setBy could be improved by using putAt and putBy)_ 408 | 409 | Javascript JSON [asks](https://www.w3resource.com/slides/json-style-guide.php) you to refrain from using these at the root of your JSON Object: 410 | 411 | ```js 412 | kind, 413 | fields, 414 | etag, 415 | id, 416 | lang, 417 | updated, 418 | deleted, 419 | currentItemCount, 420 | itemsPerPage, 421 | startIndex, 422 | totalItems, 423 | pageIndex, 424 | totalPages, 425 | pageLinkTemplate, 426 | next, 427 | nextLink, 428 | previous, 429 | previousLink, 430 | self, 431 | selfLink, 432 | edit, 433 | editLink; 434 | ``` 435 | 436 | ### Flat vs structured 437 | 438 | ```js 439 | // Please add me 440 | ``` 441 | 442 | ### Populateable guide 443 | 444 | Mongoose offers a very powerful function namely `populate`. It enables you to easily find linked models. Consider an typical N:N example with `users` that can do `transactions`. We'd easily want to do the following: 445 | 446 | 1. Add a transaction 447 | 2. Find all transactions that belong to a user 448 | 3. Find all users belonging to a transaction 449 | 450 | Therefore a user and a transaction might have the following structure 451 | 452 | ```js 453 | // User 454 | let user = { 455 | _id: ObjectId, 456 | name: String, 457 | transaction: [ 458 | { 459 | type: ObjectId, 460 | ref: "transaction", 461 | }, 462 | ], 463 | }; 464 | 465 | let transaction = { 466 | _id: ObjectId, 467 | amount: Number, 468 | user: [ 469 | { 470 | type: ObjectId, 471 | ref: "user", 472 | }, 473 | ], 474 | }; 475 | ``` 476 | 477 | This would enable us to do the following: 478 | 479 | ```js 480 | let find = {} 481 | let populate = { path: 'transaction' } 482 | let query = Model.User.find(find).populate(populate) 483 | 484 | // Result is a single object which combines transactions and users: 485 | { 486 | _id: 0, 487 | name: 'Bob', 488 | transaction: [{ 489 | _id: 1000, 490 | amount: 5, 491 | users: [0, 1] 492 | }, { 493 | _id: 1001 494 | amount: 6, 495 | users: [0, 3] 496 | }] 497 | } 498 | ``` 499 | 500 | Without the use of population we need to do the following steps for the same result: 501 | 502 | 1. Find users 503 | 2. Make a list of all their transaction ids 504 | 3. Find all those transactions 505 | 4. Combine the user object with the found transactions 506 | 507 | Population does come with a downside: there is uncertainty in the object structure. In situations where you do not populate the object structure is different. People also might forget that it is in fact a populated field: 508 | 509 | ```js 510 | // Result when not populated 511 | { 512 | _id: 0, 513 | name: 'Bob', 514 | transaction: [1000,1001] // List of transaction _id's 515 | } 516 | 517 | // Result when populated 518 | { 519 | _id: 10, 520 | name 'Bob', 521 | transaction: [{ _id: 1000, amount: 5 }, { _id: 1001, amount: 6 }] 522 | } 523 | ``` 524 | 525 | This is a clear source of errors, if at a certain time we decide that a specific route will have the populated version all old uses of that route that need the transaction \_id will break. 526 | 527 | We therefore suggest the following pattern whenever you make references: 528 | 529 | ```js 530 | // V0 531 | let SchemaTransactionRef = new Schema({ 532 | item: { type: ObjectId, ref: "transaction" }, 533 | itemId: { type: ObjectId }, 534 | }); 535 | 536 | // V1 537 | let SchemaTransactionRef = new Schema({ 538 | transaction: { type: ObjectId, ref: "transaction" }, 539 | transactionId: { type: ObjectId }, 540 | }); 541 | 542 | // User 543 | let SchemaUser = new Schema({ 544 | _id: ObjectId, 545 | name: String, 546 | transaction: [SchemaTransactionRef], 547 | }); 548 | ``` 549 | 550 | This way we can safely use the identifier without the risk of it being populated: 551 | 552 | - V0 -`transactionRef[0].itemId` 553 | - V1 -`transactionRef[0].transactionId` 554 | 555 | Please note that V1 might seem a little verbose but especially in situations like the following it is usefull: 556 | 557 | ```js 558 | // 0 559 | // - Makes clear that it is a reference 560 | user.transactionRef.forEach((ref) => { 561 | const transaction = ref.item; 562 | const transactionId = ref.itemId; 563 | }); 564 | 565 | // 1 566 | // - In shorthand loops it is clear 567 | user.transactionRef.forEach((ref) => { 568 | const transaction = ref.transaction; 569 | const transactionId = ref.transactionId; 570 | }); 571 | user.transactionRef.map((ref) => ref.transaction.price); 572 | 573 | // 2 574 | user.transactionRef.forEach((transactionRef) => { 575 | const transaction = transactionRef.item; 576 | const transactionId = transactionRef.itemId; 577 | }); 578 | 579 | // 3 580 | // user.transactionRef.forEach(item => { 581 | // const transaction = item.item 582 | // const transactionId = item.itemId 583 | // }) 584 | ``` 585 | 586 | ### Path/route guide 587 | 588 | In many modern webapplications your backend 589 | 590 | /:idUser/update 591 | 592 | workorderRef: [{ 593 | item: 594 | itemId: 595 | }] 596 | 597 | workorder: [{ 598 | workorderId: 599 | workorder: 600 | .... 601 | }] 602 | 603 | ## API Response style 604 | 605 | The API should embrace a small set of statuscodes. It is cumbersome to check these and some might trigger behaviour of the client (often a browser). Therefore we've chosen to only use the following: 606 | 607 | **5XX ERROR** connection failures 608 | 609 | **404 NOT FOUND** failure, used for routes that do not exist 610 | 611 | **401 UNAUTHORIZED** not logged in 612 | 613 | **200 SUCCESS** for all other requests since the request completed succesfully 614 | 615 | In a functioning application, only the 200 & 500 statuscode is expected. All the other codes are a sign of a failing application. 616 | 617 | ### Reponse data 618 | 619 | Whenever a statuscode 200 is read this does not mean the request is succesful. We only know the real status after parsing it's content JSON. 620 | 621 | The state of a response is specified by it's properties. The properties _data_ and _warning_ are used to confirm succesful actions. The properties _error_ and _failure_ convey problems after which you shouldn't continue. 622 | 623 | The message added is only for the programmer. It is the clients responsibility to create a proper message. 624 | 625 | ### Situational examples 626 | 627 | **failures** 628 | 629 | - Cannot connect to database 630 | - Object 'user' does not exist 631 | - Property X does not exist on Y 632 | - This \_id is not unique (when unexpected) 633 | 634 | **errors** 635 | 636 | - Password is incorrect 637 | 638 | **warning** 639 | 640 | - Request took 5 seconds 641 | 642 | **success** 643 | 644 | - We found this user 645 | - We found these events 646 | 647 | **cannot read property x of y** response with failure. This should never happen, application should break down. 648 | **incorrect password** error 649 | 650 | ### Response example 651 | 652 | ```javascript 653 | const response = { 654 | // Optional extra information for developer 655 | message: String, 656 | 657 | // Success, continue 658 | data: 659 | [] || 660 | { 661 | // warning? 662 | }, 663 | 664 | // Error, do not continue 665 | // (e.g. insufficient funds) 666 | error: { 667 | // Used to differentiate between errors 668 | reason: "insufficientFunds", 669 | 670 | name: "", // DEV => Err.name 671 | code: 400, // DEV => 672 | stack: "", // DEV => Err.stack 673 | }, 674 | 675 | // Extra information about request 676 | meta: {}, 677 | }; 678 | ``` 679 | 680 | GET `/event/:id/guest` 681 | POST `/event/` 682 | PATCH `/event/:id/guest/:guestId/arrived` 683 | REMOVE `/event/:id/guest` 684 | 685 | AUTH = post 686 | 687 | transactionService() { 688 | 689 | } 690 | 691 | transactionService.get() 692 | 693 | transaction = { 694 | get: 695 | remove: 696 | } 697 | 698 | transactionGet() { 699 | 700 | } 701 | transactionremove() { 702 | 703 | } 704 | 705 | ## Where to do what? 706 | 707 | Where does which format get relevant? 708 | -------------------------------------------------------------------------------- /README.meta.md: -------------------------------------------------------------------------------- 1 | ### Creating reusable meta structure 2 | 3 | To keep code dry it is usefull to think about what unites your models. We mention returning patterns shortly. 4 | In this chapter we will discuss the creation of a `meta` pattern. A definition of `meta` in the technical sense: 5 | 6 | > Technical metadata properties include file types, size, creation date and time, and type of compression. 7 | > Technical metadata is often used for digital object management and interoperability. 8 | 9 | Source: [lifewire.com](https://www.lifewire.com/metadata-definition-and-examples-1019177) 10 | 11 | We aim to store the following fields in our meta object: 12 | 13 | 1. Created 14 | 2. Updated 15 | 3. Deleted 16 | 4. Restored 17 | 18 | Obviously we are going for a `soft-delete` pattern. A hard delete will not leave any record in the database. 19 | 20 | #### Goals 21 | 22 | 1. Make it the default to only query fields that are not `deleted`. 23 | 2. Make it eas to sort by `newest` versus `oldest` and `recently edited` 24 | 3. If you have a system with users; log which user did create, update or restore. 25 | 26 | 27 | #### V0 - root 28 | 29 | ``` 30 | const eventSchema = new Schema({ 31 | // ... 32 | createdAt: Date, 33 | createdBy: ObjectId, 34 | 35 | updatedAt: Date, 36 | updatedBy: ObjectId, 37 | 38 | deletedAt: Date, 39 | deletedBy: ObjectId, 40 | }) 41 | ``` 42 | 43 | - (+) Implementation - [exists](https://www.npmjs.com/package/mongoose-delete) therefore easy 44 | - (-) Mongoose select - hard to leave out or select meta, causes large selects 45 | - (-) Blame - we cannot see a full history 46 | - (+) Size - very small and no risk of growing too large 47 | 48 | #### V1 - meta 49 | 50 | ``` 51 | const eventSchema = new Schema({ 52 | // ... 53 | meta: { 54 | createdAt: Date, 55 | createdBy: ObjectId, 56 | 57 | updatedAt: Date, 58 | updatedBy: ObjectId, 59 | 60 | deletedAt: Date, 61 | deletedBy: ObjectId, 62 | } 63 | }) 64 | ``` 65 | 66 | - (-) Implementation - does not exist so has to be created by hand 67 | - (+) Mongoose select - easy to leave out meta by default and select when needed 68 | - (-) Blame - we cannot see a full history 69 | - (+) Size - very small and no risk of growing too large 70 | 71 | #### V2 - meta + history 72 | 73 | ``` 74 | const eventSchema = new Schema({ 75 | // ... 76 | meta: { 77 | created: { type: Boolean, default: true }, 78 | updated: { type: Boolean, default: true }, 79 | deleted: { type: Boolean, default: false }, 80 | history: [{ 81 | state: String, 82 | put: { 83 | at: Date, 84 | by: ObjectId, 85 | } 86 | }] 87 | } 88 | }) 89 | ``` 90 | 91 | - (-) Implementation - does not exist so has to be created by hand 92 | - (+) Mongoose select - easy to leave out meta by default and select when needed 93 | - (+) Blame - we can see a full history 94 | - (-) Size - can grow to be a large part of size 95 | 96 | -------------------------------------------------------------------------------- /README.tricks.md: -------------------------------------------------------------------------------- 1 | ### Quicly clean all your files with prettier 2 | 3 | ``` 4 | # 5 | npm install prettier 6 | npx prettier --write ./server/**/*.js 7 | npx prettier --write ./src/app/**/*.ts 8 | npx prettier --write ./src/app/**/*.html 9 | npx prettier --write ./src/app/**/*.scss 10 | ``` 11 | 12 | # MongoDB 13 | 14 | ### List all collections and their sizes 15 | 16 | ```js 17 | var collectionNames = db.getCollectionNames(); 18 | var stats = []; 19 | 20 | collectionNames.forEach((n) => stats.push(db[n].stats())); 21 | var statsSorted = stats.sort((a, b) => a.size < b.size); 22 | 23 | for (var c in statsSorted) { 24 | const gbRaw = stats[c]["size"] / 1024 / 1024 / 1024; 25 | const gb = gbRaw.toFixed(2); 26 | print(stats[c]["ns"] + " - " + stats[c]["count"] + " items"); 27 | print(gb + " Gb"); 28 | print(""); 29 | } 30 | ``` 31 | --------------------------------------------------------------------------------