├── .Rbuildignore ├── .Rprofile ├── .gitignore ├── DESCRIPTION ├── LICENSE ├── LICENSE.md ├── NAMESPACE ├── R ├── aoc.R ├── create_aoc.R └── utils-usethis.R ├── README.Rmd ├── README.md ├── aoc.Rproj ├── inst └── templates │ ├── 01_start.R │ ├── 02_dev.R │ ├── data-solutions.R │ ├── day.R │ ├── input.txt │ └── solution.R ├── man ├── create_aoc.Rd ├── figures │ ├── README-pressure-1.png │ ├── hex-aoc2.hex │ ├── hex-aoc2.png │ ├── logo.png │ └── star.png └── use_day.Rd └── tests ├── testthat.R └── testthat └── test-year.R /.Rbuildignore: -------------------------------------------------------------------------------- 1 | ^aoc\.Rproj$ 2 | ^\.Rproj\.user$ 3 | ^LICENSE\.md$ 4 | ^README\.Rmd$ 5 | ^\.aoccookie$ 6 | -------------------------------------------------------------------------------- /.Rprofile: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tjmahr/aoc/5e42ba27dbb3733d59b78963c8e46e17f32b0757/.Rprofile -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .Rproj.user 2 | .Rhistory 3 | .RData 4 | .Ruserdata 5 | .aoccookie 6 | -------------------------------------------------------------------------------- /DESCRIPTION: -------------------------------------------------------------------------------- 1 | Package: aoc 2 | Title: What the Package Does (One Line, Title Case) 3 | Version: 0.0.0.9000 4 | Authors@R: 5 | c( 6 | person( 7 | given = "Tristan", 8 | family = "Mahr", 9 | role = c("aut", "cre"), 10 | email = "tristan.mahr@wisc.edu", 11 | comment = c(ORCID = "0000-0002-8890-5116") 12 | ), 13 | person( 14 | given = "Sam", 15 | family = "Parmar", 16 | role = c("ctb") 17 | ) 18 | ) 19 | Description: What the package does (one paragraph). 20 | License: GPL (>= 3) + file LICENSE 21 | Encoding: UTF-8 22 | Roxygen: list(markdown = TRUE) 23 | RoxygenNote: 7.2.1 24 | Suggests: 25 | testthat (>= 3.0.0), 26 | withr 27 | Config/testthat/edition: 3 28 | Imports: 29 | usethis, 30 | clipr, 31 | cli, 32 | clisymbols, 33 | crayon, 34 | curl, 35 | fs, 36 | glue, 37 | here, 38 | knitr, 39 | readr, 40 | rstudioapi, 41 | stringr, 42 | utils, 43 | xml2 44 | -------------------------------------------------------------------------------- /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 | -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 1 | GNU General Public License 2 | ========================== 3 | 4 | _Version 3, 29 June 2007_ 5 | _Copyright © 2007 Free Software Foundation, Inc. <>_ 6 | 7 | Everyone is permitted to copy and distribute verbatim copies of this license 8 | document, but changing it is not allowed. 9 | 10 | ## Preamble 11 | 12 | The GNU General Public License is a free, copyleft license for software and other 13 | kinds of works. 14 | 15 | The licenses for most software and other practical works are designed to take away 16 | your freedom to share and change the works. By contrast, the GNU General Public 17 | License is intended to guarantee your freedom to share and change all versions of a 18 | program--to make sure it remains free software for all its users. We, the Free 19 | Software Foundation, use the GNU General Public License for most of our software; it 20 | applies also to any other work released this way by its authors. You can apply it to 21 | your programs, too. 22 | 23 | When we speak of free software, we are referring to freedom, not price. Our General 24 | Public Licenses are designed to make sure that you have the freedom to distribute 25 | copies of free software (and charge for them if you wish), that you receive source 26 | code or can get it if you want it, that you can change the software or use pieces of 27 | it in new 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 these rights or 30 | asking you to surrender the rights. Therefore, you have certain responsibilities if 31 | you distribute copies of the software, or if you modify it: responsibilities to 32 | respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether gratis or for a fee, 35 | you must pass on to the recipients the same freedoms that you received. You must make 36 | sure that they, too, receive or can get the source code. And you must show them these 37 | terms so they know their rights. 38 | 39 | Developers that use the GNU GPL protect your rights with two steps: **(1)** assert 40 | copyright on the software, and **(2)** offer you this License giving you legal permission 41 | to copy, distribute and/or modify it. 42 | 43 | For the developers' and authors' protection, the GPL clearly explains that there is 44 | no warranty for this free software. For both users' and authors' sake, the GPL 45 | requires that modified versions be marked as changed, so that their problems will not 46 | be attributed erroneously to authors of previous versions. 47 | 48 | Some devices are designed to deny users access to install or run modified versions of 49 | the software inside them, although the manufacturer can do so. This is fundamentally 50 | incompatible with the aim of protecting users' freedom to change the software. The 51 | systematic pattern of such abuse occurs in the area of products for individuals to 52 | use, which is precisely where it is most unacceptable. Therefore, we have designed 53 | this version of the GPL to prohibit the practice for those products. If such problems 54 | arise substantially in other domains, we stand ready to extend this provision to 55 | those domains in future versions of the GPL, as needed to protect the freedom of 56 | users. 57 | 58 | Finally, every program is threatened constantly by software patents. States should 59 | not allow patents to restrict development and use of software on general-purpose 60 | computers, but in those that do, we wish to avoid the special danger that patents 61 | applied to a free program could make it effectively proprietary. To prevent this, the 62 | GPL assures that patents cannot be used to render the program non-free. 63 | 64 | The precise terms and conditions for copying, distribution and modification follow. 65 | 66 | ## TERMS AND CONDITIONS 67 | 68 | ### 0. Definitions 69 | 70 | “This License” refers to version 3 of the GNU General Public License. 71 | 72 | “Copyright” also means copyright-like laws that apply to other kinds of 73 | works, such as semiconductor masks. 74 | 75 | “The Program” refers to any copyrightable work licensed under this 76 | License. Each licensee is addressed as “you”. “Licensees” and 77 | “recipients” may be individuals or organizations. 78 | 79 | To “modify” a work means to copy from or adapt all or part of the work in 80 | a fashion requiring copyright permission, other than the making of an exact copy. The 81 | resulting work is called a “modified version” of the earlier work or a 82 | work “based on” the earlier work. 83 | 84 | A “covered work” means either the unmodified Program or a work based on 85 | the Program. 86 | 87 | To “propagate” a work means to do anything with it that, without 88 | permission, would make you directly or secondarily liable for infringement under 89 | applicable copyright law, except executing it on a computer or modifying a private 90 | copy. Propagation includes copying, distribution (with or without modification), 91 | making available to the public, and in some countries other activities as well. 92 | 93 | To “convey” a work means any kind of propagation that enables other 94 | parties to make or receive copies. Mere interaction with a user through a computer 95 | network, with no transfer of a copy, is not conveying. 96 | 97 | An interactive user interface displays “Appropriate Legal Notices” to the 98 | extent that it includes a convenient and prominently visible feature that **(1)** 99 | displays an appropriate copyright notice, and **(2)** tells the user that there is no 100 | warranty for the work (except to the extent that warranties are provided), that 101 | licensees may convey the work under this License, and how to view a copy of this 102 | License. If the interface presents a list of user commands or options, such as a 103 | menu, a prominent item in the list meets this criterion. 104 | 105 | ### 1. Source Code 106 | 107 | The “source code” for a work means the preferred form of the work for 108 | making modifications to it. “Object code” means any non-source form of a 109 | work. 110 | 111 | A “Standard Interface” means an interface that either is an official 112 | standard defined by a recognized standards body, or, in the case of interfaces 113 | specified for a particular programming language, one that is widely used among 114 | developers working in that language. 115 | 116 | The “System Libraries” of an executable work include anything, other than 117 | the work as a whole, that **(a)** is included in the normal form of packaging a Major 118 | Component, but which is not part of that Major Component, and **(b)** serves only to 119 | enable use of the work with that Major Component, or to implement a Standard 120 | Interface for which an implementation is available to the public in source code form. 121 | A “Major Component”, in this context, means a major essential component 122 | (kernel, window system, and so on) of the specific operating system (if any) on which 123 | the executable work runs, or a compiler used to produce the work, or an object code 124 | interpreter used to run it. 125 | 126 | The “Corresponding Source” for a work in object code form means all the 127 | source code needed to generate, install, and (for an executable work) run the object 128 | code and to modify the work, including scripts to control those activities. However, 129 | it does not include the work's System Libraries, or general-purpose tools or 130 | generally available free programs which are used unmodified in performing those 131 | activities but which are not part of the work. For example, Corresponding Source 132 | includes interface definition files associated with source files for the work, and 133 | the source code for shared libraries and dynamically linked subprograms that the work 134 | is specifically designed to require, such as by intimate data communication or 135 | control flow between those subprograms and other parts of the work. 136 | 137 | The Corresponding Source need not include anything that users can regenerate 138 | automatically from other parts of the Corresponding Source. 139 | 140 | The Corresponding Source for a work in source code form is that same work. 141 | 142 | ### 2. Basic Permissions 143 | 144 | All rights granted under this License are granted for the term of copyright on the 145 | Program, and are irrevocable provided the stated conditions are met. This License 146 | explicitly affirms your unlimited permission to run the unmodified Program. The 147 | output from running a covered work is covered by this License only if the output, 148 | given its content, constitutes a covered work. This License acknowledges your rights 149 | of fair use or other equivalent, as provided by copyright law. 150 | 151 | You may make, run and propagate covered works that you do not convey, without 152 | conditions so long as your license otherwise remains in force. You may convey covered 153 | works to others for the sole purpose of having them make modifications exclusively 154 | for you, or provide you with facilities for running those works, provided that you 155 | comply with the terms of this License in conveying all material for which you do not 156 | control copyright. Those thus making or running the covered works for you must do so 157 | exclusively on your behalf, under your direction and control, on terms that prohibit 158 | them from making any copies of your copyrighted material outside their relationship 159 | with you. 160 | 161 | Conveying under any other circumstances is permitted solely under the conditions 162 | stated below. Sublicensing is not allowed; section 10 makes it unnecessary. 163 | 164 | ### 3. Protecting Users' Legal Rights From Anti-Circumvention Law 165 | 166 | No covered work shall be deemed part of an effective technological measure under any 167 | applicable law fulfilling obligations under article 11 of the WIPO copyright treaty 168 | adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention 169 | of such measures. 170 | 171 | When you convey a covered work, you waive any legal power to forbid circumvention of 172 | technological measures to the extent such circumvention is effected by exercising 173 | rights under this License with respect to the covered work, and you disclaim any 174 | intention to limit operation or modification of the work as a means of enforcing, 175 | against the work's users, your or third parties' legal rights to forbid circumvention 176 | of technological measures. 177 | 178 | ### 4. Conveying Verbatim Copies 179 | 180 | You may convey verbatim copies of the Program's source code as you receive it, in any 181 | medium, provided that you conspicuously and appropriately publish on each copy an 182 | appropriate copyright notice; keep intact all notices stating that this License and 183 | any non-permissive terms added in accord with section 7 apply to the code; keep 184 | intact all notices of the absence of any warranty; and give all recipients a copy of 185 | this License along with the Program. 186 | 187 | You may charge any price or no price for each copy that you convey, and you may offer 188 | support or warranty protection for a fee. 189 | 190 | ### 5. Conveying Modified Source Versions 191 | 192 | You may convey a work based on the Program, or the modifications to produce it from 193 | the Program, in the form of source code under the terms of section 4, provided that 194 | you also meet all of these conditions: 195 | 196 | * **a)** The work must carry prominent notices stating that you modified it, and giving a 197 | relevant date. 198 | * **b)** The work must carry prominent notices stating that it is released under this 199 | License and any conditions added under section 7. This requirement modifies the 200 | requirement in section 4 to “keep intact all notices”. 201 | * **c)** You must license the entire work, as a whole, under this License to anyone who 202 | comes into possession of a copy. This License will therefore apply, along with any 203 | applicable section 7 additional terms, to the whole of the work, and all its parts, 204 | regardless of how they are packaged. This License gives no permission to license the 205 | work in any other way, but it does not invalidate such permission if you have 206 | separately received it. 207 | * **d)** If the work has interactive user interfaces, each must display Appropriate Legal 208 | Notices; however, if the Program has interactive interfaces that do not display 209 | Appropriate Legal Notices, your work need not make them do so. 210 | 211 | A compilation of a covered work with other separate and independent works, which are 212 | not by their nature extensions of the covered work, and which are not combined with 213 | it such as to form a larger program, in or on a volume of a storage or distribution 214 | medium, is called an “aggregate” if the compilation and its resulting 215 | copyright are not used to limit the access or legal rights of the compilation's users 216 | beyond what the individual works permit. Inclusion of a covered work in an aggregate 217 | does not cause this License to apply to the other parts of the aggregate. 218 | 219 | ### 6. Conveying Non-Source Forms 220 | 221 | You may convey a covered work in object code form under the terms of sections 4 and 222 | 5, provided that you also convey the machine-readable Corresponding Source under the 223 | terms of this License, in one of these ways: 224 | 225 | * **a)** Convey the object code in, or embodied in, a physical product (including a 226 | physical distribution medium), accompanied by the Corresponding Source fixed on a 227 | durable physical medium customarily used for software interchange. 228 | * **b)** Convey the object code in, or embodied in, a physical product (including a 229 | physical distribution medium), accompanied by a written offer, valid for at least 230 | three years and valid for as long as you offer spare parts or customer support for 231 | that product model, to give anyone who possesses the object code either **(1)** a copy of 232 | the Corresponding Source for all the software in the product that is covered by this 233 | License, on a durable physical medium customarily used for software interchange, for 234 | a price no more than your reasonable cost of physically performing this conveying of 235 | source, or **(2)** access to copy the Corresponding Source from a network server at no 236 | charge. 237 | * **c)** Convey individual copies of the object code with a copy of the written offer to 238 | provide the Corresponding Source. This alternative is allowed only occasionally and 239 | noncommercially, and only if you received the object code with such an offer, in 240 | accord with subsection 6b. 241 | * **d)** Convey the object code by offering access from a designated place (gratis or for 242 | a charge), and offer equivalent access to the Corresponding Source in the same way 243 | through the same place at no further charge. You need not require recipients to copy 244 | the Corresponding Source along with the object code. If the place to copy the object 245 | code is a network server, the Corresponding Source may be on a different server 246 | (operated by you or a third party) that supports equivalent copying facilities, 247 | provided you maintain clear directions next to the object code saying where to find 248 | the Corresponding Source. Regardless of what server hosts the Corresponding Source, 249 | you remain obligated to ensure that it is available for as long as needed to satisfy 250 | these requirements. 251 | * **e)** Convey the object code using peer-to-peer transmission, provided you inform 252 | other peers where the object code and Corresponding Source of the work are being 253 | offered to the general public at no charge under subsection 6d. 254 | 255 | A separable portion of the object code, whose source code is excluded from the 256 | Corresponding Source as a System Library, need not be included in conveying the 257 | object code work. 258 | 259 | A “User Product” is either **(1)** a “consumer product”, which 260 | means any tangible personal property which is normally used for personal, family, or 261 | household purposes, or **(2)** anything designed or sold for incorporation into a 262 | dwelling. In determining whether a product is a consumer product, doubtful cases 263 | shall be resolved in favor of coverage. For a particular product received by a 264 | particular user, “normally used” refers to a typical or common use of 265 | that class of product, regardless of the status of the particular user or of the way 266 | in which the particular user actually uses, or expects or is expected to use, the 267 | product. A product is a consumer product regardless of whether the product has 268 | substantial commercial, industrial or non-consumer uses, unless such uses represent 269 | the only significant mode of use of the product. 270 | 271 | “Installation Information” for a User Product means any methods, 272 | procedures, authorization keys, or other information required to install and execute 273 | modified versions of a covered work in that User Product from a modified version of 274 | its Corresponding Source. The information must suffice to ensure that the continued 275 | functioning of the modified object code is in no case prevented or interfered with 276 | solely because modification has been made. 277 | 278 | If you convey an object code work under this section in, or with, or specifically for 279 | use in, a User Product, and the conveying occurs as part of a transaction in which 280 | the right of possession and use of the User Product is transferred to the recipient 281 | in perpetuity or for a fixed term (regardless of how the transaction is 282 | characterized), the Corresponding Source conveyed under this section must be 283 | accompanied by the Installation Information. But this requirement does not apply if 284 | neither you nor any third party retains the ability to install modified object code 285 | on the User Product (for example, the work has been installed in ROM). 286 | 287 | The requirement to provide Installation Information does not include a requirement to 288 | continue to provide support service, warranty, or updates for a work that has been 289 | modified or installed by the recipient, or for the User Product in which it has been 290 | modified or installed. Access to a network may be denied when the modification itself 291 | materially and adversely affects the operation of the network or violates the rules 292 | and protocols for communication across the network. 293 | 294 | Corresponding Source conveyed, and Installation Information provided, in accord with 295 | this section must be in a format that is publicly documented (and with an 296 | implementation available to the public in source code form), and must require no 297 | special password or key for unpacking, reading or copying. 298 | 299 | ### 7. Additional Terms 300 | 301 | “Additional permissions” are terms that supplement the terms of this 302 | License by making exceptions from one or more of its conditions. Additional 303 | permissions that are applicable to the entire Program shall be treated as though they 304 | were included in this License, to the extent that they are valid under applicable 305 | law. If additional permissions apply only to part of the Program, that part may be 306 | used separately under those permissions, but the entire Program remains governed by 307 | this License without regard to the additional permissions. 308 | 309 | When you convey a copy of a covered work, you may at your option remove any 310 | additional permissions from that copy, or from any part of it. (Additional 311 | permissions may be written to require their own removal in certain cases when you 312 | modify the work.) You may place additional permissions on material, added by you to a 313 | covered work, for which you have or can give appropriate copyright permission. 314 | 315 | Notwithstanding any other provision of this License, for material you add to a 316 | covered work, you may (if authorized by the copyright holders of that material) 317 | supplement the terms of this License with terms: 318 | 319 | * **a)** Disclaiming warranty or limiting liability differently from the terms of 320 | sections 15 and 16 of this License; or 321 | * **b)** Requiring preservation of specified reasonable legal notices or author 322 | attributions in that material or in the Appropriate Legal Notices displayed by works 323 | containing it; or 324 | * **c)** Prohibiting misrepresentation of the origin of that material, or requiring that 325 | modified versions of such material be marked in reasonable ways as different from the 326 | original version; or 327 | * **d)** Limiting the use for publicity purposes of names of licensors or authors of the 328 | material; or 329 | * **e)** Declining to grant rights under trademark law for use of some trade names, 330 | trademarks, or service marks; or 331 | * **f)** Requiring indemnification of licensors and authors of that material by anyone 332 | who conveys the material (or modified versions of it) with contractual assumptions of 333 | liability to the recipient, for any liability that these contractual assumptions 334 | directly impose on those licensors and authors. 335 | 336 | All other non-permissive additional terms are considered “further 337 | restrictions” within the meaning of section 10. If the Program as you received 338 | it, or any part of it, contains a notice stating that it is governed by this License 339 | along with a term that is a further restriction, you may remove that term. If a 340 | license document contains a further restriction but permits relicensing or conveying 341 | under this License, you may add to a covered work material governed by the terms of 342 | that license document, provided that the further restriction does not survive such 343 | relicensing or conveying. 344 | 345 | If you add terms to a covered work in accord with this section, you must place, in 346 | the relevant source files, a statement of the additional terms that apply to those 347 | files, or a notice indicating where to find the applicable terms. 348 | 349 | Additional terms, permissive or non-permissive, may be stated in the form of a 350 | separately written license, or stated as exceptions; the above requirements apply 351 | either way. 352 | 353 | ### 8. Termination 354 | 355 | You may not propagate or modify a covered work except as expressly provided under 356 | this License. Any attempt otherwise to propagate or modify it is void, and will 357 | automatically terminate your rights under this License (including any patent licenses 358 | granted under the third paragraph of section 11). 359 | 360 | However, if you cease all violation of this License, then your license from a 361 | particular copyright holder is reinstated **(a)** provisionally, unless and until the 362 | copyright holder explicitly and finally terminates your license, and **(b)** permanently, 363 | if the copyright holder fails to notify you of the violation by some reasonable means 364 | prior to 60 days after the cessation. 365 | 366 | Moreover, your license from a particular copyright holder is reinstated permanently 367 | if the copyright holder notifies you of the violation by some reasonable means, this 368 | is the first time you have received notice of violation of this License (for any 369 | work) from that copyright holder, and you cure the violation prior to 30 days after 370 | your receipt of the notice. 371 | 372 | Termination of your rights under this section does not terminate the licenses of 373 | parties who have received copies or rights from you under this License. If your 374 | rights have been terminated and not permanently reinstated, you do not qualify to 375 | receive new licenses for the same material under section 10. 376 | 377 | ### 9. Acceptance Not Required for Having Copies 378 | 379 | You are not required to accept this License in order to receive or run a copy of the 380 | Program. Ancillary propagation of a covered work occurring solely as a consequence of 381 | using peer-to-peer transmission to receive a copy likewise does not require 382 | acceptance. However, nothing other than this License grants you permission to 383 | propagate or modify any covered work. These actions infringe copyright if you do not 384 | accept this License. Therefore, by modifying or propagating a covered work, you 385 | indicate your acceptance of this License to do so. 386 | 387 | ### 10. Automatic Licensing of Downstream Recipients 388 | 389 | Each time you convey a covered work, the recipient automatically receives a license 390 | from the original licensors, to run, modify and propagate that work, subject to this 391 | License. You are not responsible for enforcing compliance by third parties with this 392 | License. 393 | 394 | An “entity transaction” is a transaction transferring control of an 395 | organization, or substantially all assets of one, or subdividing an organization, or 396 | merging organizations. If propagation of a covered work results from an entity 397 | transaction, each party to that transaction who receives a copy of the work also 398 | receives whatever licenses to the work the party's predecessor in interest had or 399 | could give under the previous paragraph, plus a right to possession of the 400 | Corresponding Source of the work from the predecessor in interest, if the predecessor 401 | has it or can get it with reasonable efforts. 402 | 403 | You may not impose any further restrictions on the exercise of the rights granted or 404 | affirmed under this License. For example, you may not impose a license fee, royalty, 405 | or other charge for exercise of rights granted under this License, and you may not 406 | initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging 407 | that any patent claim is infringed by making, using, selling, offering for sale, or 408 | importing the Program or any portion of it. 409 | 410 | ### 11. Patents 411 | 412 | A “contributor” is a copyright holder who authorizes use under this 413 | License of the Program or a work on which the Program is based. The work thus 414 | licensed is called the contributor's “contributor version”. 415 | 416 | A contributor's “essential patent claims” are all patent claims owned or 417 | controlled by the contributor, whether already acquired or hereafter acquired, that 418 | would be infringed by some manner, permitted by this License, of making, using, or 419 | selling its contributor version, but do not include claims that would be infringed 420 | only as a consequence of further modification of the contributor version. For 421 | purposes of this definition, “control” includes the right to grant patent 422 | sublicenses in a manner consistent with the requirements of this License. 423 | 424 | Each contributor grants you a non-exclusive, worldwide, royalty-free patent license 425 | under the contributor's essential patent claims, to make, use, sell, offer for sale, 426 | import and otherwise run, modify and propagate the contents of its contributor 427 | version. 428 | 429 | In the following three paragraphs, a “patent license” is any express 430 | agreement or commitment, however denominated, not to enforce a patent (such as an 431 | express permission to practice a patent or covenant not to sue for patent 432 | infringement). To “grant” such a patent license to a party means to make 433 | such an agreement or commitment not to enforce a patent against the party. 434 | 435 | If you convey a covered work, knowingly relying on a patent license, and the 436 | Corresponding Source of the work is not available for anyone to copy, free of charge 437 | and under the terms of this License, through a publicly available network server or 438 | other readily accessible means, then you must either **(1)** cause the Corresponding 439 | Source to be so available, or **(2)** arrange to deprive yourself of the benefit of the 440 | patent license for this particular work, or **(3)** arrange, in a manner consistent with 441 | the requirements of this License, to extend the patent license to downstream 442 | recipients. “Knowingly relying” means you have actual knowledge that, but 443 | for the patent license, your conveying the covered work in a country, or your 444 | recipient's use of the covered work in a country, would infringe one or more 445 | identifiable patents in that country that you have reason to believe are valid. 446 | 447 | If, pursuant to or in connection with a single transaction or arrangement, you 448 | convey, or propagate by procuring conveyance of, a covered work, and grant a patent 449 | license to some of the parties receiving the covered work authorizing them to use, 450 | propagate, modify or convey a specific copy of the covered work, then the patent 451 | license you grant is automatically extended to all recipients of the covered work and 452 | works based on it. 453 | 454 | A patent license is “discriminatory” if it does not include within the 455 | scope of its coverage, prohibits the exercise of, or is conditioned on the 456 | non-exercise of one or more of the rights that are specifically granted under this 457 | License. You may not convey a covered work if you are a party to an arrangement with 458 | a third party that is in the business of distributing software, under which you make 459 | payment to the third party based on the extent of your activity of conveying the 460 | work, and under which the third party grants, to any of the parties who would receive 461 | the covered work from you, a discriminatory patent license **(a)** in connection with 462 | copies of the covered work conveyed by you (or copies made from those copies), or **(b)** 463 | primarily for and in connection with specific products or compilations that contain 464 | the covered work, unless you entered into that arrangement, or that patent license 465 | was granted, prior to 28 March 2007. 466 | 467 | Nothing in this License shall be construed as excluding or limiting any implied 468 | license or other defenses to infringement that may otherwise be available to you 469 | under applicable patent law. 470 | 471 | ### 12. No Surrender of Others' Freedom 472 | 473 | If conditions are imposed on you (whether by court order, agreement or otherwise) 474 | that contradict the conditions of this License, they do not excuse you from the 475 | conditions of this License. If you cannot convey a covered work so as to satisfy 476 | simultaneously your obligations under this License and any other pertinent 477 | obligations, then as a consequence you may not convey it at all. For example, if you 478 | agree to terms that obligate you to collect a royalty for further conveying from 479 | those to whom you convey the Program, the only way you could satisfy both those terms 480 | and this License would be to refrain entirely from conveying the Program. 481 | 482 | ### 13. Use with the GNU Affero General Public License 483 | 484 | Notwithstanding any other provision of this License, you have permission to link or 485 | combine any covered work with a work licensed under version 3 of the GNU Affero 486 | General Public License into a single combined work, and to convey the resulting work. 487 | The terms of this License will continue to apply to the part which is the covered 488 | work, but the special requirements of the GNU Affero General Public License, section 489 | 13, concerning interaction through a network will apply to the combination as such. 490 | 491 | ### 14. Revised Versions of this License 492 | 493 | The Free Software Foundation may publish revised and/or new versions of the GNU 494 | General Public License from time to time. Such new versions will be similar in spirit 495 | to the present version, but may differ in detail to address new problems or concerns. 496 | 497 | Each version is given a distinguishing version number. If the Program specifies that 498 | a certain numbered version of the GNU General Public License “or any later 499 | version” applies to it, you have the option of following the terms and 500 | conditions either of that numbered version or of any later version published by the 501 | Free Software Foundation. If the Program does not specify a version number of the GNU 502 | General Public License, you may choose any version ever published by the Free 503 | Software Foundation. 504 | 505 | If the Program specifies that a proxy can decide which future versions of the GNU 506 | General Public License can be used, that proxy's public statement of acceptance of a 507 | version permanently authorizes you to choose that version for the Program. 508 | 509 | Later license versions may give you additional or different permissions. However, no 510 | additional obligations are imposed on any author or copyright holder as a result of 511 | your choosing to follow a later version. 512 | 513 | ### 15. Disclaimer of Warranty 514 | 515 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. 516 | EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES 517 | PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER 518 | EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 519 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE 520 | QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE 521 | DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 522 | 523 | ### 16. Limitation of Liability 524 | 525 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY 526 | COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS 527 | PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, 528 | INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE 529 | PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE 530 | OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE 531 | WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE 532 | POSSIBILITY OF SUCH DAMAGES. 533 | 534 | ### 17. Interpretation of Sections 15 and 16 535 | 536 | If the disclaimer of warranty and limitation of liability provided above cannot be 537 | given local legal effect according to their terms, reviewing courts shall apply local 538 | law that most closely approximates an absolute waiver of all civil liability in 539 | connection with the Program, unless a warranty or assumption of liability accompanies 540 | a copy of the Program in return for a fee. 541 | 542 | _END OF TERMS AND CONDITIONS_ 543 | 544 | ## How to Apply These Terms to Your New Programs 545 | 546 | If you develop a new program, and you want it to be of the greatest possible use to 547 | the public, the best way to achieve this is to make it free software which everyone 548 | can redistribute and change under these terms. 549 | 550 | To do so, attach the following notices to the program. It is safest to attach them 551 | to the start of each source file to most effectively state the exclusion of warranty; 552 | and each file should have at least the “copyright” line and a pointer to 553 | where the full notice is found. 554 | 555 | 556 | Copyright (C) 557 | 558 | This program is free software: you can redistribute it and/or modify 559 | it under the terms of the GNU General Public License as published by 560 | the Free Software Foundation, either version 3 of the License, or 561 | (at your option) any later version. 562 | 563 | This program is distributed in the hope that it will be useful, 564 | but WITHOUT ANY WARRANTY; without even the implied warranty of 565 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 566 | GNU General Public License for more details. 567 | 568 | You should have received a copy of the GNU General Public License 569 | along with this program. If not, see . 570 | 571 | Also add information on how to contact you by electronic and paper mail. 572 | 573 | If the program does terminal interaction, make it output a short notice like this 574 | when it starts in an interactive mode: 575 | 576 | Copyright (C) 577 | This program comes with ABSOLUTELY NO WARRANTY; for details type 'show w'. 578 | This is free software, and you are welcome to redistribute it 579 | under certain conditions; type 'show c' for details. 580 | 581 | The hypothetical commands `show w` and `show c` should show the appropriate parts of 582 | the General Public License. Of course, your program's commands might be different; 583 | for a GUI interface, you would use an “about box”. 584 | 585 | You should also get your employer (if you work as a programmer) or school, if any, to 586 | sign a “copyright disclaimer” for the program, if necessary. For more 587 | information on this, and how to apply and follow the GNU GPL, see 588 | <>. 589 | 590 | The GNU General Public License does not permit incorporating your program into 591 | proprietary programs. If your program is a subroutine library, you may consider it 592 | more useful to permit linking proprietary applications with the library. If this is 593 | what you want to do, use the GNU Lesser General Public License instead of this 594 | License. But first, please read 595 | <>. 596 | -------------------------------------------------------------------------------- /NAMESPACE: -------------------------------------------------------------------------------- 1 | # Generated by roxygen2: do not edit by hand 2 | 3 | export(convert_clipboard_html_to_roxygen_md) 4 | export(create_aoc) 5 | export(download_part2_to_roxygen_md) 6 | export(use_day) 7 | importFrom(cli,cat_bullet) 8 | -------------------------------------------------------------------------------- /R/aoc.R: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tjmahr/aoc/5e42ba27dbb3733d59b78963c8e46e17f32b0757/R/aoc.R -------------------------------------------------------------------------------- /R/create_aoc.R: -------------------------------------------------------------------------------- 1 | #' Create package for Advent of Code work 2 | #' 3 | #' @param path Name of the folder to create the package in. 4 | #' This will also be used as the package name. 5 | #' @param check_name Should we check that the package name is 6 | #' correct according to CRAN requirements. 7 | #' @param open Boolean. Open the created project? 8 | #' @param overwrite Boolean. Should the already existing project be overwritten? 9 | #' @param package_name Package name to use. By default uses 10 | #' `basename(path)`. If `path == '.'` & `package_name` is 11 | #' not explicitly set, then `basename(getwd())` will be used. 12 | #' 13 | #' @details 14 | #' 15 | #' Creates a package skeleton to work on Advent of Code. 16 | #' 17 | #' See `aoc::use_day()` function details (`?aoc::use_day()`) for more info on 18 | #' primary package function. Function based on `golem::create_golem()` 19 | #' (https://github.com/ThinkR-open/golem). 20 | #' @export 21 | 22 | create_aoc <- function( 23 | path, 24 | check_name = TRUE, 25 | open = TRUE, 26 | overwrite = FALSE, 27 | package_name = basename(path) 28 | ) { 29 | path_to_aoc <- normalizePath( 30 | path, 31 | mustWork = FALSE 32 | ) 33 | 34 | if (check_name) { 35 | cli::cat_rule("Checking package name") 36 | utils::getFromNamespace("check_package_name", "usethis")(package_name) 37 | cat_green_tick("Valid package name") 38 | } 39 | 40 | if (fs::dir_exists(path_to_aoc)) { 41 | if (!isTRUE(overwrite)) { 42 | stop( 43 | paste( 44 | "Project directory already exists. \n", 45 | "Set `create_aoc(overwrite = TRUE)` to overwrite anyway.\n", 46 | "Be careful this will restore a brand new aoc project. \n", 47 | "You might be at risk of losing your work!" 48 | ), 49 | call. = FALSE 50 | ) 51 | } else { 52 | cat_red_bullet("Overwriting existing project.") 53 | } 54 | } else { 55 | cli::cat_rule("Creating package dir") 56 | usethis::create_package( 57 | path = path_to_aoc, 58 | open = FALSE 59 | ) 60 | here::set_here(path_to_aoc) 61 | cat_green_tick("Created package directory") 62 | } 63 | 64 | cli::cat_rule("Copying package skeleton") 65 | from <- pkg_sys("") 66 | 67 | # Copy over dev folder files 68 | fs::dir_create( 69 | path = file.path(path_to_aoc, "dev") 70 | ) 71 | 72 | fs::file_copy( 73 | path = file.path(from, "templates", "01_start.R"), 74 | new_path = file.path(path_to_aoc, "dev","01_start.R"), 75 | overwrite = overwrite 76 | ) 77 | 78 | fs::file_copy( 79 | path = file.path(from, "templates", "02_dev.R"), 80 | new_path = file.path(path_to_aoc, "dev","02_dev.R"), 81 | overwrite = overwrite 82 | ) 83 | 84 | cat_green_tick("Copied app skeleton") 85 | 86 | cli::cat_rule("Done") 87 | 88 | cli::cat_line( 89 | paste0( 90 | "New aoc package named ", 91 | package_name, 92 | " was created at ", 93 | path_to_aoc, 94 | " .\n", 95 | "To continue working on your app, start editing the dev/01_start.R file." 96 | ) 97 | ) 98 | 99 | if (isTRUE(open)) { 100 | if (rstudioapi::isAvailable() & rstudioapi::hasFun("openProject")) { 101 | rstudioapi::openProject(path = path) 102 | } else { 103 | setwd(path) 104 | } 105 | } 106 | 107 | return( 108 | invisible( 109 | path_to_aoc 110 | ) 111 | ) 112 | } 113 | 114 | #' @importFrom cli cat_bullet 115 | cat_green_tick <- function(...) { 116 | cli::cat_bullet( 117 | ..., 118 | bullet = "tick", 119 | bullet_col = "green" 120 | ) 121 | } 122 | 123 | #' @importFrom cli cat_bullet 124 | cat_red_bullet <- function(...) { 125 | cli::cat_bullet( 126 | ..., 127 | bullet = "bullet", 128 | bullet_col = "red" 129 | ) 130 | } 131 | 132 | pkg_sys <- function( 133 | ..., 134 | lib.loc = NULL, 135 | mustWork = FALSE, 136 | package = "aoc" 137 | ) { 138 | system.file( 139 | ..., 140 | package = package, 141 | lib.loc = lib.loc, 142 | mustWork = mustWork 143 | ) 144 | } 145 | -------------------------------------------------------------------------------- /R/utils-usethis.R: -------------------------------------------------------------------------------- 1 | #' Create the files for an Advent of Code day 2 | #' 3 | #' @param day integer giving the day 4 | #' @param year year of Advent of Code containing the day. Defaults to 5 | #' `getOption("aoc.year")` and then current year. 6 | #' @param open whether to open the created files. Defaults to `TRUE` in an 7 | #' interactive R session. 8 | #' @param cookie whether to try to download personalized page results using an 9 | #' Advent of Code cookie 10 | #' @param package name of the package for the Advent of Code project. Defaults 11 | #' to `getOption("aoc.package")` then `adventofcodeXX` where `XX` are the last 12 | #' two digits of the current year. 13 | #' @return `use_day()` returns `NULL`. `convert_clipboard_html_to_roxygen_md()` 14 | #' invisibly returns the Roxygen markdown block. It also copies Roxygen 15 | #' markdown block onto the clipboard. 16 | #' @rdname use_day 17 | #' 18 | #' @details 19 | #' 20 | #' Creates a file for writing the functions to solve the problem: `R/dayxx.R`. 21 | #' The text of the challenge is downloaded and inserted into the roxygen block. 22 | #' One caveat is that you will have to manually add the markdown text for Part 23 | #' Two yourself. You can use `convert_clipboard_html_to_roxygen_md()` to make 24 | #' this easier. Once you can read the description, view the page source, copy 25 | #' the html for that part of the problem. Run this function to create a Roxygen 26 | #' version of the HTML. 27 | #' 28 | #' Also, creates a placeholder file for the problem input: `inst/inputxx.txt`. 29 | #' Paste your input here. 30 | #' 31 | #' Also, creates a file for unit tests: `tests/testthat/test-dayxx.R`. This is 32 | #' good place to test that the examples in the problem description work. 33 | #' 34 | #' Finally, creates a solution file: `inst/run-dayxx.R`. You should download 35 | #' your personalized challenge input as `inst/inputxx.txt`. Your solution file 36 | #' should read in this file and apply your functions to it. Once your solution 37 | #' passes on the site, store it in `R/data-solutions.R`. Then the solution file 38 | #' can load in your previous answer, rerun your solution, and check whether your 39 | #' code no longer obtains the same solution. 40 | #' @export 41 | use_day <- function(day, year = NULL, open = interactive(), cookie = NULL, package = NULL) { 42 | 43 | if (is.null(year)) { 44 | year <- getOption("aoc.year", substr(Sys.Date(), 0, 4)) 45 | } 46 | year_short <- substr(year, 3, 4) 47 | 48 | if (is.null(package)) { 49 | this_package <- getOption( 50 | "aoc.package", 51 | paste0("adventofcode", year_short) 52 | ) 53 | } else { 54 | this_package <- package 55 | } 56 | 57 | if (is.null(cookie)) { 58 | cookie <- file.exists(".aoccookie") 59 | } else { 60 | cookie <- file.exists(".aoccookie") && cookie 61 | } 62 | 63 | url <- sprintf("https://adventofcode.com/%s/day/%s", year, day) 64 | 65 | data <- list( 66 | dd_number = sprintf("%02.f", day), 67 | url = url, 68 | title = NA, 69 | part_1 = NA, 70 | year = year, 71 | package = this_package 72 | ) 73 | 74 | if (!file.exists("R/data-solutions.R")) { 75 | usethis::use_template( 76 | "data-solutions.R", 77 | save_as = "R/data-solutions.R", 78 | package = "aoc", 79 | data = data, 80 | open = open 81 | ) 82 | } 83 | 84 | 85 | files <- get_day_files(day) 86 | test_name <- sprintf("day%s", data$dd_number) 87 | page <- get_aoc_html(url) 88 | 89 | article <- xml2::xml_find_first(page, "/html/body/main/article") 90 | 91 | title <- xml2::xml_find_first(page, "/html/body/main/article/h2") 92 | title <- unlist(xml2::as_list(title)) 93 | title <- stringr::str_replace(title, "--- Day \\d+: ", "") 94 | title <- stringr::str_replace(title, " ---", "") 95 | data$title <- title 96 | 97 | temp <- tempfile(fileext = ".html") 98 | xml2::write_html(article, temp) 99 | z <- knitr::pandoc(temp, "markdown") 100 | lines <- readr::read_lines(z) 101 | lines <- lines[-c(1, 2)] 102 | lines <- paste0("#' ", lines, collapse = "\n") 103 | data$part_1 <- lines 104 | 105 | usethis::use_template( 106 | "day.R", 107 | save_as = files$main, 108 | package = "aoc", 109 | data = data, 110 | open = open 111 | ) 112 | todo("Write your solution code here") 113 | todo( 114 | "Once you unlock Part Two, update the Roxygen block with the description" 115 | ) 116 | 117 | usethis::use_directory("inst") 118 | input_data <- get_aoc_input(day, year, cookie) 119 | usethis::use_template( 120 | "input.txt", 121 | save_as = files$input, 122 | package = "aoc", 123 | data = list(x = input_data), 124 | open = open 125 | ) 126 | todo("Copy your problem input into this file") 127 | 128 | usethis::use_test( 129 | name = test_name, 130 | open = open 131 | ) 132 | todo("Write unit tests using the examples from the problem description") 133 | 134 | usethis::use_template( 135 | "solution.R", 136 | save_as = files$solution, 137 | package = "aoc", 138 | data = data, 139 | open = open 140 | ) 141 | todo("Run your solution on the input here. Once it works, update R/data-solutions.R") 142 | 143 | invisible(NULL) 144 | } 145 | 146 | get_aoc_year <- function(year = NULL) { 147 | if (is.null(year)) { 148 | year <- getOption("aoc.year", substr(Sys.Date(), 0, 4)) 149 | } else { 150 | year 151 | } 152 | } 153 | 154 | get_aoc_html <- function(url, cookie = TRUE) { 155 | if (file.exists(".aoccookie") && cookie) { 156 | message("downloading puzzle html using .aoccookie") 157 | usethis::use_git_ignore(".aoccookie") 158 | usethis::use_build_ignore(".aoccookie") 159 | cookie <- readLines(".aoccookie") 160 | h <- curl::new_handle() 161 | h <- curl::handle_setheaders(h, Cookie = cookie) 162 | r <- curl::curl_fetch_memory(url, handle = h) 163 | page <- xml2::read_html(r$content) 164 | } else { 165 | page <- xml2::read_html(url) 166 | } 167 | page 168 | } 169 | 170 | 171 | get_aoc_input <- function(day, year = NULL, cookie = TRUE) { 172 | year <- get_aoc_year(year) 173 | url <- sprintf("https://adventofcode.com/%s/day/%s/%s", year, day, "input") 174 | 175 | if (file.exists(".aoccookie") && cookie) { 176 | message("downloading puzzle input using .aoccookie") 177 | cookie <- readLines(".aoccookie") 178 | h <- curl::new_handle() 179 | h <- curl::handle_setheaders(h, Cookie = cookie) 180 | r <- curl::curl_fetch_memory(url, handle = h) 181 | result <- rawToChar(r$content) 182 | } else { 183 | result <- "\n" 184 | } 185 | 186 | result 187 | } 188 | 189 | 190 | #' @rdname use_day 191 | #' @param clip For `download_part2_to_roxygen_md()`, whether to paste the puzzle 192 | #' description to the user clipboard. 193 | #' @export 194 | download_part2_to_roxygen_md <- function(day, year = NULL, cookie = TRUE, clip = TRUE) { 195 | year <- get_aoc_year(year) 196 | 197 | url <- sprintf("https://adventofcode.com/%s/day/%s", year, day) 198 | page <- get_aoc_html(url, cookie = cookie) 199 | 200 | article <- xml2::xml_find_all(page, "/html/body/main/article")[[2]] 201 | 202 | temp <- tempfile(fileext = ".html") 203 | xml2::write_html(article, temp) 204 | z <- knitr::pandoc(temp, "markdown") 205 | lines <- readr::read_lines(z, skip = 1) 206 | lines[1] <- "**Part Two**" 207 | lines <- paste0("#' ", lines, collapse = "\n") 208 | if (clip) { 209 | clipr::write_clip(lines) 210 | usethis::ui_done("Roxygen markdown block is on the clipboard") 211 | } 212 | cat(paste(lines, "\n")) 213 | invisible(lines) 214 | } 215 | 216 | 217 | #' @rdname use_day 218 | #' @export 219 | #' @param input html code copied from the Advent of Code website 220 | convert_clipboard_html_to_roxygen_md <- function(input = clipr::read_clip()) { 221 | temp <- tempfile(fileext = ".html") 222 | writeLines(input, temp) 223 | z <- knitr::pandoc(temp, "markdown") 224 | lines <- readr::read_lines(z) 225 | lines <- paste0("#' ", lines, collapse = "\n") 226 | clipr::write_clip(lines) 227 | usethis::ui_done("Roxygen markdown block is on the clipboard") 228 | invisible(lines) 229 | } 230 | 231 | remove_day <- function(day) { 232 | file.remove(unlist(get_day_files(day))) 233 | } 234 | 235 | get_day_files <- function(day) { 236 | dd_number <- sprintf("%02.f", day) 237 | list( 238 | main = sprintf("R/day%s.R", dd_number), 239 | solution = sprintf("inst/run-day%s.R", dd_number), 240 | test = sprintf("tests/testthat/test-day%s.R", dd_number), 241 | input = sprintf("inst/input%s.txt", dd_number) 242 | ) 243 | } 244 | 245 | 246 | # These are all copied from usethis in order to match that package's style 247 | 248 | todo <- function(..., .envir = parent.frame()) { 249 | out <- glue::glue(..., .envir = .envir) 250 | cat_line(bulletize(out, bullet = todo_bullet())) 251 | } 252 | 253 | todo_bullet <- function () crayon::red(clisymbols::symbol$bullet) 254 | 255 | done <- function (..., .envir = parent.frame()) { 256 | out <- glue::glue(..., .envir = .envir) 257 | cat_line(bulletize(out, bullet = done_bullet())) 258 | } 259 | 260 | done_bullet <- function () crayon::green(clisymbols::symbol$tick) 261 | 262 | bulletize <- function(line, bullet = clisymbols::symbol$bullet) { 263 | paste0(bullet, " ", line) 264 | } 265 | 266 | cat_line <- function(..., quiet = getOption("usethis.quiet", default = FALSE)) { 267 | if (quiet) return(invisible()) 268 | cat(..., "\n", sep = "") 269 | } 270 | 271 | -------------------------------------------------------------------------------- /README.Rmd: -------------------------------------------------------------------------------- 1 | --- 2 | output: github_document 3 | --- 4 | 5 | 6 | 7 | ```{r, include = FALSE} 8 | knitr::opts_chunk$set( 9 | collapse = TRUE, 10 | comment = "#>", 11 | fig.path = "man/figures/README-", 12 | out.width = "100%" 13 | ) 14 | file.remove(list.files("R", pattern = "day.*", full.names = TRUE)) 15 | file.remove(list.files("inst", pattern = "input.*", full.names = TRUE)) 16 | file.remove(list.files("inst", pattern = "run.*", full.names = TRUE)) 17 | file.remove(list.files("tests/testthat", pattern = "test.day*", full.names = TRUE)) 18 | file.remove("R/data-solutions.R") 19 | file.rename(".aoccookie", ".xaoccookie") 20 | aoc::use_day(01, 2020, open = FALSE) 21 | ``` 22 | 23 | # aoc 24 | 25 | 26 | 27 | 28 | aoc provides [usethis](https://usethis.r-lib.org/)-style functions for [Advent 29 | of Code](https://adventofcode.com) puzzles. This package only downloads content 30 | from the Advent of Code site. 31 | 32 | ## Installation 33 | 34 | You can install the development version of aoc from [GitHub](https://github.com/) with: 35 | 36 | ``` r 37 | # install.packages("devtools") 38 | remotes::install_github("tjmahr/aoc") 39 | ``` 40 | 41 | ## Preliminaries 42 | 43 | aoc assumes that we are organizing our R code using an R package. Therefore, it 44 | requires a minimal package infrastructure in order to work. In RStudio, using 45 | 46 | - File \> New Project... \> New Directory \> R Package 47 | - Setting the package name to `adventofcode21` \> Create Project 48 | 49 | should create enough of an R package setup for aoc to work. 50 | 51 | Alternatively, you can just use `aoc::create_aoc()`, specifying you package 52 | path as an argument in the function. This will create your aoc package for 53 | you and create a dev folder with scripts to help you start working on your 54 | aoc problems. 55 | 56 | ## Functionality 57 | 58 | aoc assumes that you are working inside an R package. By default, it assumes the 59 | package is named `adventofcodeXX` where XX are the last two digits of the year. 60 | For example, `adventofcode20` would be the package for 2020. 61 | 62 | From this setup, aoc will automate a number of tasks. `use_day()` is a 63 | [usethis](https://usethis.r-lib.org/)-style function to create placeholder files 64 | for each day. 65 | 66 | `use_day(day = 1)` does the following tasks: 67 | 68 | - on first run, creates `R/data-solutions.R` 69 | - a file for storing solutions 70 | 71 | - creates `R/day01.R` 72 | - puts the puzzle description into a roxygen documentation block 73 | - creates placeholder functions for the solutions to day 1 74 | 75 | - creates `tests/testthat/test-day01.R` 76 | - a unit test for day (useful for the example in the puzzle 77 | description) in `tests/testthat/test-day01.R` 78 | 79 | - creates `inst/input01.txt` 80 | - a file to hold the input for day 1 81 | 82 | - creates `inst/run-day01.R` 83 | - a file to contain the solution for day 1 84 | 85 | ```{r, eval = FALSE} 86 | aoc::use_day(1, year = 2020) 87 | #> ✔ Writing 'R/data-solutions.R' 88 | #> • Modify 'R/data-solutions.R' 89 | #> downloading puzzle html using .aoccookie 90 | #> Executing: pandoc -t markdown -o 91 | #> "C:\Users\trist\AppData\Local\Temp\RtmpK8sv2r\file228c54056ded.markdown" 92 | #> "C:\Users\trist\AppData\Local\Temp\RtmpK8sv2r\file228c54056ded.html" 93 | #> ✔ Writing 'R/day01.R' 94 | #> ● Write your solution code here 95 | #> ● Once you unlock Part Two, update the Roxygen block with the description 96 | #> ✔ Writing 'inst/input01.txt' 97 | #> ● Copy your problem input into this file 98 | #> ✔ Writing 'tests/testthat/test-day01.R' 99 | #> • Edit 'tests/testthat/test-day01.R' 100 | #> ● Write unit tests using the examples from the problem description 101 | #> ✔ Writing 'inst/run-day01.R' 102 | #> ● Run your solution on the input here. Once it works, update R/data-solutions.R 103 | ``` 104 | 105 | `R/data-solutions.R` is where we store our solutions: 106 | 107 | ```{r, echo = FALSE} 108 | preview_lines <- function(path, lines = 10) { 109 | # path <- "R/utils-usethis.R" 110 | l <- readLines(path) 111 | if (lines * 2 < length(l)) { 112 | show <- c(head(l, lines), "[... truncated ...]") 113 | } else { 114 | show <- l 115 | } 116 | writeLines(show) 117 | } 118 | ``` 119 | 120 | 121 | ```{r, echo = FALSE, comment = ""} 122 | preview_lines("R/data-solutions.R", 20) 123 | ``` 124 | 125 | `inst/input01.txt` is an empty file for our input data. We have to paste in our 126 | puzzle input here. 127 | 128 | The R script for `R/day01.R` provides the puzzle description for part 1, 129 | function stubs for part 1 `f01a()` and part 2 `f01b()`. I also like to make the 130 | example data into a function for unit tests or code examples, so there is a stub 131 | for `example_data_01()`. 132 | 133 | ```{r, echo = FALSE, comment = ""} 134 | preview_lines("R/day01.R", 200) 135 | ``` 136 | 137 | `tests/testthat/test-day01.R` is a placeholder for file unit tests. It's a good 138 | place work through the examples in the puzzle description. 139 | 140 | ```{r, echo = FALSE, comment = ""} 141 | preview_lines("tests/testthat/test-day01.R") 142 | ``` 143 | 144 | Once we have developed a solution for the example input, we can test our 145 | official input by running the code in `inst/run-day01.R`. The final two lines 146 | provide code to validate the solutions that we store in `R/data-solutions.R`. 147 | 148 | ```{r, echo = FALSE, comment = ""} 149 | preview_lines("inst/run-day01.R") 150 | ``` 151 | 152 | 153 | 154 | ### Default values for `use_day()` 155 | 156 | We can tell aoc which year to use by using `options()`. 157 | 158 | ```{r, eval = TRUE} 159 | options(aoc.year = 2017) 160 | aoc::use_day(3) 161 | ``` 162 | 163 | If we look at the first lines of `R/day03.R`, we can see the correct URL used. 164 | 165 | ```{r, echo = FALSE, comment = ""} 166 | preview_lines("R/day03.R") 167 | ``` 168 | 169 | We can also tell aoc which package name to use for our project using 170 | `options()`. 171 | 172 | ```{r, eval = TRUE} 173 | options(aoc.package = "awesomeadvent2017") 174 | aoc::use_day(4) 175 | ``` 176 | 177 | And here the correct name appears in the `library()` call. 178 | 179 | ```{r, echo = FALSE, comment = ""} 180 | preview_lines("inst/run-day04.R") 181 | ``` 182 | 183 | We can set these permanently for an Advent of Code package by editing the 184 | package's `.Rprofile`: 185 | 186 | ```{r, eval = FALSE} 187 | usethis::edit_r_profile(scope = "project") 188 | # add in things like `options(aoc.year = 2017)` 189 | ``` 190 | 191 | ### Advanced: Using a user cookie 192 | 193 | If you know how to retrieve the cookie for your Advent of Code user, you can use 194 | this cookie to download your puzzle input. Store the cookie in file named 195 | `.aoccookie`. Then `use_day()` will automatically use this cookie when 196 | downloading puzzle input. 197 | 198 | For these demos, I hid my cookie by renaming the file. If I unrename the file 199 | and download the day 7 files, I can preview the lines of the input file. 200 | 201 | ```{r} 202 | file.rename(".xaoccookie", ".aoccookie") 203 | 204 | aoc::use_day(7) 205 | 206 | # this is a function i defined in a hidden code block 🤫 207 | preview_lines("inst/input07.txt") 208 | ``` 209 | 210 | The other advantage of a user cookie is that after solving part 1 of a day, we 211 | can download part 2 as a roxygen2 block. By default, this block is copied to the 212 | clipboard, but for this demo, I have to disable it. 213 | 214 | ```{r, comment = ""} 215 | aoc::download_part2_to_roxygen_md(day = 7, clip = FALSE) 216 | ``` 217 | 218 | 219 | ```{r, include = FALSE} 220 | file.remove(list.files("R", pattern = "day.*", full.names = TRUE)) 221 | file.remove(list.files("inst", pattern = "input.*", full.names = TRUE)) 222 | file.remove(list.files("inst", pattern = "run.*", full.names = TRUE)) 223 | file.remove(list.files("tests/testthat", pattern = "test.day*", full.names = TRUE)) 224 | file.remove("R/data-solutions.R") 225 | ``` 226 | 227 | ## Credit 228 | 229 | Thanks to [{golem}](https://github.com/ThinkR-open/golem) for their implementation of dev files to support 230 | package development. `aoc::create_aoc()` is inspired by and based on `golem::create_golem()`. 231 | 232 | Hex icon created using the [hexmake 233 | app](https://connect.thinkr.fr/hexmake/) from 234 | [ColinFay](https://github.com/ColinFay/hexmake). 235 | 236 | Star icons created by Freepik - Flaticon 237 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | # aoc 5 | 6 | 7 | 8 | 9 | aoc provides [usethis](https://usethis.r-lib.org/)-style functions for 10 | [Advent of Code](https://adventofcode.com) puzzles. This package only 11 | downloads content from the Advent of Code site. 12 | 13 | ## Installation 14 | 15 | You can install the development version of aoc from 16 | [GitHub](https://github.com/) with: 17 | 18 | ``` r 19 | # install.packages("devtools") 20 | remotes::install_github("tjmahr/aoc") 21 | ``` 22 | 23 | ## Preliminaries 24 | 25 | aoc assumes that we are organizing our R code using an R package. 26 | Therefore, it requires a minimal package infrastructure in order to 27 | work. In RStudio, using 28 | 29 | - File \> New Project… \> New Directory \> R Package 30 | - Setting the package name to `adventofcode21` \> Create Project 31 | 32 | should create enough of an R package setup for aoc to work. 33 | 34 | Alternatively, you can just use `aoc::create_aoc()`, specifying you 35 | package path as an argument in the function. This will create your aoc 36 | package for you and create a dev folder with scripts to help you start 37 | working on your aoc problems. 38 | 39 | ## Functionality 40 | 41 | aoc assumes that you are working inside an R package. By default, it 42 | assumes the package is named `adventofcodeXX` where XX are the last two 43 | digits of the year. For example, `adventofcode20` would be the package 44 | for 2020. 45 | 46 | From this setup, aoc will automate a number of tasks. `use_day()` is a 47 | [usethis](https://usethis.r-lib.org/)-style function to create 48 | placeholder files for each day. 49 | 50 | `use_day(day = 1)` does the following tasks: 51 | 52 | - on first run, creates `R/data-solutions.R` 53 | - a file for storing solutions 54 | - creates `R/day01.R` 55 | - puts the puzzle description into a roxygen documentation block 56 | - creates placeholder functions for the solutions to day 1 57 | - creates `tests/testthat/test-day01.R` 58 | - a unit test for day (useful for the example in the puzzle 59 | description) in `tests/testthat/test-day01.R` 60 | - creates `inst/input01.txt` 61 | - a file to hold the input for day 1 62 | - creates `inst/run-day01.R` 63 | - a file to contain the solution for day 1 64 | 65 | ``` r 66 | aoc::use_day(1, year = 2020) 67 | #> ✔ Writing 'R/data-solutions.R' 68 | #> • Modify 'R/data-solutions.R' 69 | #> downloading puzzle html using .aoccookie 70 | #> Executing: pandoc -t markdown -o 71 | #> "C:\Users\trist\AppData\Local\Temp\RtmpK8sv2r\file228c54056ded.markdown" 72 | #> "C:\Users\trist\AppData\Local\Temp\RtmpK8sv2r\file228c54056ded.html" 73 | #> ✔ Writing 'R/day01.R' 74 | #> ● Write your solution code here 75 | #> ● Once you unlock Part Two, update the Roxygen block with the description 76 | #> ✔ Writing 'inst/input01.txt' 77 | #> ● Copy your problem input into this file 78 | #> ✔ Writing 'tests/testthat/test-day01.R' 79 | #> • Edit 'tests/testthat/test-day01.R' 80 | #> ● Write unit tests using the examples from the problem description 81 | #> ✔ Writing 'inst/run-day01.R' 82 | #> ● Run your solution on the input here. Once it works, update R/data-solutions.R 83 | ``` 84 | 85 | `R/data-solutions.R` is where we store our solutions: 86 | 87 | #' Advent of Code 2020 solutions 88 | #' @export 89 | aoc_solutions <- list( 90 | day01a = NA, 91 | day01b = NA, 92 | day02a = NA, 93 | day02b = NA, 94 | day03a = NA, 95 | day03b = NA, 96 | day04a = NA, 97 | day04b = NA, 98 | day05a = NA, 99 | day05b = NA, 100 | day06a = NA, 101 | day06b = NA, 102 | day07a = NA, 103 | day07b = NA, 104 | day08a = NA, 105 | day08b = NA, 106 | day09a = NA, 107 | [... truncated ...] 108 | 109 | `inst/input01.txt` is an empty file for our input data. We have to paste 110 | in our puzzle input here. 111 | 112 | The R script for `R/day01.R` provides the puzzle description for part 1, 113 | function stubs for part 1 `f01a()` and part 2 `f01b()`. I also like to 114 | make the example data into a function for unit tests or code examples, 115 | so there is a stub for `example_data_01()`. 116 | 117 | #' Day 01: Report Repair 118 | #' 119 | #' [Report Repair](https://adventofcode.com/2020/day/1) 120 | #' 121 | #' @name day01 122 | #' @rdname day01 123 | #' @details 124 | #' 125 | #' **Part One** 126 | #' 127 | #' After saving Christmas [five years in a row](/events), you\'ve decided 128 | #' to take a vacation at a nice resort on a tropical island. 129 | #' [Surely]{title="WHAT COULD GO WRONG"}, Christmas will go on without you. 130 | #' 131 | #' The tropical island has its own currency and is entirely cash-only. The 132 | #' gold coins used there have a little picture of a starfish; the locals 133 | #' just call them *stars*. None of the currency exchanges seem to have 134 | #' heard of them, but somehow, you\'ll need to find fifty of these coins by 135 | #' the time you arrive so you can pay the deposit on your room. 136 | #' 137 | #' To save your vacation, you need to get all *fifty stars* by December 138 | #' 25th. 139 | #' 140 | #' Collect stars by solving puzzles. Two puzzles will be made available on 141 | #' each day in the Advent calendar; the second puzzle is unlocked when you 142 | #' complete the first. Each puzzle grants *one star*. Good luck! 143 | #' 144 | #' Before you leave, the Elves in accounting just need you to fix your 145 | #' *expense report* (your puzzle input); apparently, something isn\'t quite 146 | #' adding up. 147 | #' 148 | #' Specifically, they need you to *find the two entries that sum to `2020`* 149 | #' and then multiply those two numbers together. 150 | #' 151 | #' For example, suppose your expense report contained the following: 152 | #' 153 | #' 1721 154 | #' 979 155 | #' 366 156 | #' 299 157 | #' 675 158 | #' 1456 159 | #' 160 | #' In this list, the two entries that sum to `2020` are `1721` and `299`. 161 | #' Multiplying them together produces `1721 * 299 = 514579`, so the correct 162 | #' answer is *`514579`*. 163 | #' 164 | #' Of course, your expense report is much larger. *Find the two entries 165 | #' that sum to `2020`; what do you get if you multiply them together?* 166 | #' 167 | #' **Part Two** 168 | #' 169 | #' *(Use have to manually add this yourself.)* 170 | #' 171 | #' *(Try using `convert_clipboard_html_to_roxygen_md()`)* 172 | #' 173 | #' @param x some data 174 | #' @return For Part One, `f01a(x)` returns .... For Part Two, 175 | #' `f01b(x)` returns .... 176 | #' @export 177 | #' @examples 178 | #' f01a(example_data_01()) 179 | #' f01b() 180 | f01a <- function(x) { 181 | 182 | } 183 | 184 | 185 | #' @rdname day01 186 | #' @export 187 | f01b <- function(x) { 188 | 189 | } 190 | 191 | 192 | f01_helper <- function(x) { 193 | 194 | } 195 | 196 | 197 | #' @param example Which example data to use (by position or name). Defaults to 198 | #' 1. 199 | #' @rdname day01 200 | #' @export 201 | example_data_01 <- function(example = 1) { 202 | l <- list( 203 | a = c( 204 | 205 | ) 206 | ) 207 | l[[example]] 208 | } 209 | 210 | `tests/testthat/test-day01.R` is a placeholder for file unit tests. It’s 211 | a good place work through the examples in the puzzle description. 212 | 213 | test_that("multiplication works", { 214 | expect_equal(2 * 2, 4) 215 | }) 216 | 217 | Once we have developed a solution for the example input, we can test our 218 | official input by running the code in `inst/run-day01.R`. The final two 219 | lines provide code to validate the solutions that we store in 220 | `R/data-solutions.R`. 221 | 222 | library(adventofcode20) 223 | x <- readLines("./inst/input01.txt") 224 | 225 | p1 <- f01a(x) 226 | p2 <- f01b(x) 227 | 228 | stopifnot(p1 == aoc_solutions$day01a) 229 | stopifnot(p2 == aoc_solutions$day01b) 230 | 231 | ### Default values for `use_day()` 232 | 233 | We can tell aoc which year to use by using `options()`. 234 | 235 | ``` r 236 | options(aoc.year = 2017) 237 | aoc::use_day(3) 238 | #> Executing: pandoc -t markdown -o "C:\Users\trist\AppData\Local\Temp\RtmpCYEhnm\file49483da20fa.markdown" "C:\Users\trist\AppData\Local\Temp\RtmpCYEhnm\file49483da20fa.html" 239 | #> ✔ Writing 'R/day03.R' 240 | #> ● Write your solution code here 241 | #> ● Once you unlock Part Two, update the Roxygen block with the description 242 | #> ✔ Writing 'inst/input03.txt' 243 | #> ● Copy your problem input into this file 244 | #> ✔ Writing 'tests/testthat/test-day03.R' 245 | #> • Edit 'tests/testthat/test-day03.R' 246 | #> ● Write unit tests using the examples from the problem description 247 | #> ✔ Writing 'inst/run-day03.R' 248 | #> ● Run your solution on the input here. Once it works, update R/data-solutions.R 249 | ``` 250 | 251 | If we look at the first lines of `R/day03.R`, we can see the correct URL 252 | used. 253 | 254 | #' Day 03: Spiral Memory 255 | #' 256 | #' [Spiral Memory](https://adventofcode.com/2017/day/3) 257 | #' 258 | #' @name day03 259 | #' @rdname day03 260 | #' @details 261 | #' 262 | #' **Part One** 263 | #' 264 | [... truncated ...] 265 | 266 | We can also tell aoc which package name to use for our project using 267 | `options()`. 268 | 269 | ``` r 270 | options(aoc.package = "awesomeadvent2017") 271 | aoc::use_day(4) 272 | #> Executing: pandoc -t markdown -o "C:\Users\trist\AppData\Local\Temp\RtmpCYEhnm\file494890a25ab.markdown" "C:\Users\trist\AppData\Local\Temp\RtmpCYEhnm\file494890a25ab.html" 273 | #> ✔ Writing 'R/day04.R' 274 | #> ● Write your solution code here 275 | #> ● Once you unlock Part Two, update the Roxygen block with the description 276 | #> ✔ Writing 'inst/input04.txt' 277 | #> ● Copy your problem input into this file 278 | #> ✔ Writing 'tests/testthat/test-day04.R' 279 | #> • Edit 'tests/testthat/test-day04.R' 280 | #> ● Write unit tests using the examples from the problem description 281 | #> ✔ Writing 'inst/run-day04.R' 282 | #> ● Run your solution on the input here. Once it works, update R/data-solutions.R 283 | ``` 284 | 285 | And here the correct name appears in the `library()` call. 286 | 287 | library(awesomeadvent2017) 288 | x <- readLines("./inst/input04.txt") 289 | 290 | p1 <- f04a(x) 291 | p2 <- f04b(x) 292 | 293 | stopifnot(p1 == aoc_solutions$day04a) 294 | stopifnot(p2 == aoc_solutions$day04b) 295 | 296 | We can set these permanently for an Advent of Code package by editing 297 | the package’s `.Rprofile`: 298 | 299 | ``` r 300 | usethis::edit_r_profile(scope = "project") 301 | # add in things like `options(aoc.year = 2017)` 302 | ``` 303 | 304 | ### Advanced: Using a user cookie 305 | 306 | If you know how to retrieve the cookie for your Advent of Code user, you 307 | can use this cookie to download your puzzle input. Store the cookie in 308 | file named `.aoccookie`. Then `use_day()` will automatically use this 309 | cookie when downloading puzzle input. 310 | 311 | For these demos, I hid my cookie by renaming the file. If I unrename the 312 | file and download the day 7 files, I can preview the lines of the input 313 | file. 314 | 315 | ``` r 316 | file.rename(".xaoccookie", ".aoccookie") 317 | #> [1] TRUE 318 | 319 | aoc::use_day(7) 320 | #> downloading puzzle html using .aoccookie 321 | #> Executing: pandoc -t markdown -o "C:\Users\trist\AppData\Local\Temp\RtmpCYEhnm\file49485df03093.markdown" "C:\Users\trist\AppData\Local\Temp\RtmpCYEhnm\file49485df03093.html" 322 | #> ✔ Writing 'R/day07.R' 323 | #> ● Write your solution code here 324 | #> ● Once you unlock Part Two, update the Roxygen block with the description 325 | #> downloading puzzle input using .aoccookie 326 | #> ✔ Writing 'inst/input07.txt' 327 | #> ● Copy your problem input into this file 328 | #> ✔ Writing 'tests/testthat/test-day07.R' 329 | #> • Edit 'tests/testthat/test-day07.R' 330 | #> ● Write unit tests using the examples from the problem description 331 | #> ✔ Writing 'inst/run-day07.R' 332 | #> ● Run your solution on the input here. Once it works, update R/data-solutions.R 333 | 334 | # this is a function i defined in a hidden code block 🤫 335 | preview_lines("inst/input07.txt") 336 | #> uglvj (99) -> ymfjt, gkpgf 337 | #> vvwrg (51) 338 | #> qrpgt (5) 339 | #> qhqbqj (55) 340 | #> taxdaf (23) 341 | #> zbbdyc (81) 342 | #> xhymdo (185) -> errip, lsppdni, mxukll 343 | #> qlrcubm (81) 344 | #> ukgzz (7) 345 | #> ubvvr (288) -> hrpzu, msjeeks, ozizlok 346 | #> [... truncated ...] 347 | ``` 348 | 349 | The other advantage of a user cookie is that after solving part 1 of a 350 | day, we can download part 2 as a roxygen2 block. By default, this block 351 | is copied to the clipboard, but for this demo, I have to disable it. 352 | 353 | ``` r 354 | aoc::download_part2_to_roxygen_md(day = 7, clip = FALSE) 355 | downloading puzzle html using .aoccookie 356 | Executing: pandoc -t markdown -o "C:\Users\trist\AppData\Local\Temp\RtmpCYEhnm\file494853b95982.markdown" "C:\Users\trist\AppData\Local\Temp\RtmpCYEhnm\file494853b95982.html" 357 | #' **Part Two** 358 | #' The programs explain the situation: they can\'t get down. Rather, they 359 | #' *could* get down, if they weren\'t expending all of their energy trying 360 | #' to keep the tower balanced. Apparently, one program has the *wrong 361 | #' weight*, and until it\'s fixed, they\'re stuck here. 362 | #' 363 | #' For any program holding a disc, each program standing on that disc forms 364 | #' a sub-tower. Each of those sub-towers are supposed to be the same 365 | #' weight, or the disc itself isn\'t balanced. The weight of a tower is the 366 | #' sum of the weights of the programs in that tower. 367 | #' 368 | #' In the example above, this means that for `ugml`\'s disc to be balanced, 369 | #' `gyxo`, `ebii`, and `jptl` must all have the same weight, and they do: 370 | #' `61`. 371 | #' 372 | #' However, for `tknk` to be balanced, each of the programs standing on its 373 | #' disc *and all programs above it* must each match. This means that the 374 | #' following sums must all be the same: 375 | #' 376 | #' - `ugml` + (`gyxo` + `ebii` + `jptl`) = 68 + (61 + 61 + 61) = 251 377 | #' - `padx` + (`pbga` + `havc` + `qoyq`) = 45 + (66 + 66 + 66) = 243 378 | #' - `fwft` + (`ktlj` + `cntj` + `xhth`) = 72 + (57 + 57 + 57) = 243 379 | #' 380 | #' As you can see, `tknk`\'s disc is unbalanced: `ugml`\'s stack is heavier 381 | #' than the other two. Even though the nodes above `ugml` are balanced, 382 | #' `ugml` itself is too heavy: it needs to be `8` units lighter for its 383 | #' stack to weigh `243` and keep the towers balanced. If this change were 384 | #' made, its weight would be `60`. 385 | #' 386 | #' Given that exactly one program is the wrong weight, *what would its 387 | #' weight need to be* to balance the entire tower? 388 | ``` 389 | 390 | ## Credit 391 | 392 | Thanks to [{golem}](https://github.com/ThinkR-open/golem) for their 393 | implementation of dev files to support package development. 394 | `aoc::create_aoc()` is inspired by and based on `golem::create_golem()`. 395 | 396 | Hex icon created using the [hexmake 397 | app](https://connect.thinkr.fr/hexmake/) from 398 | [ColinFay](https://github.com/ColinFay/hexmake). 399 | 400 | Star 401 | icons created by Freepik - Flaticon 402 | -------------------------------------------------------------------------------- /aoc.Rproj: -------------------------------------------------------------------------------- 1 | Version: 1.0 2 | 3 | RestoreWorkspace: No 4 | SaveWorkspace: No 5 | AlwaysSaveHistory: Default 6 | 7 | EnableCodeIndexing: Yes 8 | UseSpacesForTab: Yes 9 | NumSpacesForTab: 2 10 | Encoding: UTF-8 11 | 12 | RnwWeave: Sweave 13 | LaTeX: pdfLaTeX 14 | 15 | AutoAppendNewline: Yes 16 | StripTrailingWhitespace: Yes 17 | LineEndingConversion: Posix 18 | 19 | BuildType: Package 20 | PackageUseDevtools: Yes 21 | PackageInstallArgs: --no-multiarch --with-keep.source 22 | PackageRoxygenize: rd,collate,namespace 23 | -------------------------------------------------------------------------------- /inst/templates/01_start.R: -------------------------------------------------------------------------------- 1 | # Build an aoc package to work through your solutions 2 | # 3 | # README: each step of the dev files is optional, and you don't have to 4 | # fill every dev script before getting started. 5 | # 01_start.R should be filled at start. 6 | # 02_dev.R should be used to keep track of your development during the project. 7 | # Dev file templates based on golem package dev files 8 | # (https://github.com/ThinkR-open/golem). 9 | # 10 | ######################################## 11 | #### CURRENT FILE: ON START SCRIPT ##### 12 | ######################################## 13 | 14 | ## Set {aoc} options --- 15 | ## Tell the aoc package which defaults to use 16 | ## aoc is a usethis-style functions for Advent of Code puzzles 17 | ## (see dev/02_dev.R for dependencies) 18 | # Edit .RProfile and add options lines 19 | usethis::edit_r_profile(scope = "project") 20 | # example: options(aoc.year = 2017, aoc.package = "awesomeadvent2017") 21 | 22 | ## Create Common Files ---- 23 | ## See ?usethis for more information 24 | usethis::use_gpl_license(version = 3) # You can set another license here 25 | usethis::use_readme_rmd( open = FALSE ) 26 | 27 | ## Use git ---- 28 | usethis::use_git() 29 | 30 | # You're now set! ---- 31 | 32 | # go to dev/02_dev.R 33 | rstudioapi::navigateToFile( "dev/02_dev.R" ) 34 | -------------------------------------------------------------------------------- /inst/templates/02_dev.R: -------------------------------------------------------------------------------- 1 | # Build an aoc package to work through your solutions 2 | # 3 | # README: each step of the dev files is optional, and you don't have to 4 | # fill every dev script before getting started. 5 | # 01_start.R should be filled at start. 6 | # 02_dev.R should be used to keep track of your development during the project. 7 | # Dev file templates based on golem package dev files 8 | # (https://github.com/ThinkR-open/golem). 9 | # 10 | ######################################## 11 | #### CURRENT FILE: ON DEV SCRIPT ##### 12 | ######################################## 13 | 14 | ## Dependencies ---- 15 | ## Add one line by package you want to add as dependency 16 | # usethis::use_package( "dplyr" ) 17 | # usethis::use_package( "readr" ) 18 | 19 | # Use pipe ---- 20 | usethis::use_pipe(export = TRUE) 21 | 22 | ## Use cookie file ---- 23 | ## Store your aoc cookie in a file named .aoccookie 24 | ## use_day() will automatically use this cookie to download your puzzle input. 25 | # add .aoccookie file to your gitignore dotfile 26 | fs::file_create(".aoccookie") 27 | rstudioapi::navigateToFile(".aoccookie") 28 | # add string object named session to .aoccokie 29 | # session=[...] where [...] is whatever the key is 30 | # find your key using your preferred browser devtools 31 | usethis::use_git_ignore(".aoccookie") 32 | 33 | ## Setup each aoc day as you work ---- 34 | ## aoc::use_day(1) creates R/day01.R, tests/testthat/test-day01.R, 35 | ## inst/input01.txt, and inst/run-day01.R 36 | aoc::use_day(1) 37 | 38 | # Enter each day's solutions ---- 39 | rstudioapi::navigateToFile( "R/data-solutions.R" ) 40 | 41 | # Document your progress in your README.Rmd ---- 42 | rstudioapi::navigateToFile( "README.Rmd" ) 43 | 44 | # Setup Github ---- 45 | usethis::use_github() 46 | -------------------------------------------------------------------------------- /inst/templates/data-solutions.R: -------------------------------------------------------------------------------- 1 | #' Advent of Code {{ year }} solutions 2 | #' @export 3 | aoc_solutions <- list( 4 | day01a = NA, 5 | day01b = NA, 6 | day02a = NA, 7 | day02b = NA, 8 | day03a = NA, 9 | day03b = NA, 10 | day04a = NA, 11 | day04b = NA, 12 | day05a = NA, 13 | day05b = NA, 14 | day06a = NA, 15 | day06b = NA, 16 | day07a = NA, 17 | day07b = NA, 18 | day08a = NA, 19 | day08b = NA, 20 | day09a = NA, 21 | day09b = NA, 22 | day10a = NA, 23 | day10b = NA, 24 | day11a = NA, 25 | day11b = NA, 26 | day12a = NA, 27 | day12b = NA, 28 | day13a = NA, 29 | day13b = NA, 30 | day14a = NA, 31 | day14b = NA, 32 | day15a = NA, 33 | day15b = NA, 34 | day16a = NA, 35 | day16b = NA, 36 | day17a = NA, 37 | day17b = NA, 38 | day18a = NA, 39 | day18b = NA, 40 | day19a = NA, 41 | day19b = NA, 42 | day20a = NA, 43 | day20b = NA, 44 | day21a = NA, 45 | day21b = NA, 46 | day22a = NA, 47 | day22b = NA, 48 | day23a = NA, 49 | day23b = NA, 50 | day24a = NA, 51 | day24b = NA, 52 | day25a = NA, 53 | day25b = NA 54 | ) 55 | -------------------------------------------------------------------------------- /inst/templates/day.R: -------------------------------------------------------------------------------- 1 | #' Day {{{ dd_number }}}: {{{ title }}} 2 | #' 3 | #' [{{{ title }}}]({{{ url }}}) 4 | #' 5 | #' @name day{{{ dd_number }}} 6 | #' @rdname day{{{ dd_number }}} 7 | #' @details 8 | #' 9 | #' **Part One** 10 | #' 11 | {{{ part_1 }}} 12 | #' 13 | #' **Part Two** 14 | #' 15 | #' *(Use have to manually add this yourself.)* 16 | #' 17 | #' *(Try using `convert_clipboard_html_to_roxygen_md()`)* 18 | #' 19 | #' @param x some data 20 | #' @return For Part One, `f{{{ dd_number }}}a(x)` returns .... For Part Two, 21 | #' `f{{{ dd_number }}}b(x)` returns .... 22 | #' @export 23 | #' @examples 24 | #' f{{{ dd_number }}}a(example_data_{{{ dd_number }}}()) 25 | #' f{{{ dd_number }}}b() 26 | f{{{ dd_number }}}a <- function(x) { 27 | 28 | } 29 | 30 | 31 | #' @rdname day{{{ dd_number }}} 32 | #' @export 33 | f{{{ dd_number }}}b <- function(x) { 34 | 35 | } 36 | 37 | 38 | f{{{ dd_number }}}_helper <- function(x) { 39 | 40 | } 41 | 42 | 43 | #' @param example Which example data to use (by position or name). Defaults to 44 | #' 1. 45 | #' @rdname day{{{ dd_number }}} 46 | #' @export 47 | example_data_{{{ dd_number }}} <- function(example = 1) { 48 | l <- list( 49 | a = c( 50 | 51 | 52 | ) 53 | ) 54 | l[[example]] 55 | } 56 | 57 | -------------------------------------------------------------------------------- /inst/templates/input.txt: -------------------------------------------------------------------------------- 1 | {{{ x }}} 2 | -------------------------------------------------------------------------------- /inst/templates/solution.R: -------------------------------------------------------------------------------- 1 | library({{ package }}) 2 | x <- readLines("./inst/input{{{ dd_number }}}.txt") 3 | 4 | p1 <- f{{{ dd_number }}}a(x) 5 | p2 <- f{{{ dd_number }}}b(x) 6 | 7 | stopifnot(p1 == aoc_solutions$day{{{ dd_number }}}a) 8 | stopifnot(p2 == aoc_solutions$day{{{ dd_number }}}b) 9 | -------------------------------------------------------------------------------- /man/create_aoc.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/create_aoc.R 3 | \name{create_aoc} 4 | \alias{create_aoc} 5 | \title{Create package for Advent of Code work} 6 | \usage{ 7 | create_aoc( 8 | path, 9 | check_name = TRUE, 10 | open = TRUE, 11 | overwrite = FALSE, 12 | package_name = basename(path) 13 | ) 14 | } 15 | \arguments{ 16 | \item{path}{Name of the folder to create the package in. 17 | This will also be used as the package name.} 18 | 19 | \item{check_name}{Should we check that the package name is 20 | correct according to CRAN requirements.} 21 | 22 | \item{open}{Boolean. Open the created project?} 23 | 24 | \item{overwrite}{Boolean. Should the already existing project be overwritten?} 25 | 26 | \item{package_name}{Package name to use. By default uses 27 | \code{basename(path)}. If \code{path == '.'} & \code{package_name} is 28 | not explicitly set, then \code{basename(getwd())} will be used.} 29 | } 30 | \description{ 31 | Create package for Advent of Code work 32 | } 33 | \details{ 34 | Creates a package skeleton to work on Advent of Code. 35 | 36 | See \code{aoc::use_day()} function details (\code{?aoc::use_day()}) for more info on 37 | primary package function. Function based on \code{golem::create_golem()} 38 | (https://github.com/ThinkR-open/golem). 39 | } 40 | -------------------------------------------------------------------------------- /man/figures/README-pressure-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tjmahr/aoc/5e42ba27dbb3733d59b78963c8e46e17f32b0757/man/figures/README-pressure-1.png -------------------------------------------------------------------------------- /man/figures/hex-aoc2.hex: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tjmahr/aoc/5e42ba27dbb3733d59b78963c8e46e17f32b0757/man/figures/hex-aoc2.hex -------------------------------------------------------------------------------- /man/figures/hex-aoc2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tjmahr/aoc/5e42ba27dbb3733d59b78963c8e46e17f32b0757/man/figures/hex-aoc2.png -------------------------------------------------------------------------------- /man/figures/logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tjmahr/aoc/5e42ba27dbb3733d59b78963c8e46e17f32b0757/man/figures/logo.png -------------------------------------------------------------------------------- /man/figures/star.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tjmahr/aoc/5e42ba27dbb3733d59b78963c8e46e17f32b0757/man/figures/star.png -------------------------------------------------------------------------------- /man/use_day.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/utils-usethis.R 3 | \name{use_day} 4 | \alias{use_day} 5 | \alias{download_part2_to_roxygen_md} 6 | \alias{convert_clipboard_html_to_roxygen_md} 7 | \title{Create the files for an Advent of Code day} 8 | \usage{ 9 | use_day(day, year = NULL, open = interactive(), cookie = NULL, package = NULL) 10 | 11 | download_part2_to_roxygen_md(day, year = NULL, cookie = TRUE, clip = TRUE) 12 | 13 | convert_clipboard_html_to_roxygen_md(input = clipr::read_clip()) 14 | } 15 | \arguments{ 16 | \item{day}{integer giving the day} 17 | 18 | \item{year}{year of Advent of Code containing the day. Defaults to 19 | \code{getOption("aoc.year")} and then current year.} 20 | 21 | \item{open}{whether to open the created files. Defaults to \code{TRUE} in an 22 | interactive R session.} 23 | 24 | \item{cookie}{whether to try to download personalized page results using an 25 | Advent of Code cookie} 26 | 27 | \item{package}{name of the package for the Advent of Code project. Defaults 28 | to \code{getOption("aoc.package")} then \code{adventofcodeXX} where \code{XX} are the last 29 | two digits of the current year.} 30 | 31 | \item{clip}{For \code{download_part2_to_roxygen_md()}, whether to paste the puzzle 32 | description to the user clipboard.} 33 | 34 | \item{input}{html code copied from the Advent of Code website} 35 | } 36 | \value{ 37 | \code{use_day()} returns \code{NULL}. \code{convert_clipboard_html_to_roxygen_md()} 38 | invisibly returns the Roxygen markdown block. It also copies Roxygen 39 | markdown block onto the clipboard. 40 | } 41 | \description{ 42 | Create the files for an Advent of Code day 43 | } 44 | \details{ 45 | Creates a file for writing the functions to solve the problem: \code{R/dayxx.R}. 46 | The text of the challenge is downloaded and inserted into the roxygen block. 47 | One caveat is that you will have to manually add the markdown text for Part 48 | Two yourself. You can use \code{convert_clipboard_html_to_roxygen_md()} to make 49 | this easier. Once you can read the description, view the page source, copy 50 | the html for that part of the problem. Run this function to create a Roxygen 51 | version of the HTML. 52 | 53 | Also, creates a placeholder file for the problem input: \code{inst/inputxx.txt}. 54 | Paste your input here. 55 | 56 | Also, creates a file for unit tests: \code{tests/testthat/test-dayxx.R}. This is 57 | good place to test that the examples in the problem description work. 58 | 59 | Finally, creates a solution file: \code{inst/run-dayxx.R}. You should download 60 | your personalized challenge input as \code{inst/inputxx.txt}. Your solution file 61 | should read in this file and apply your functions to it. Once your solution 62 | passes on the site, store it in \code{R/data-solutions.R}. Then the solution file 63 | can load in your previous answer, rerun your solution, and check whether your 64 | code no longer obtains the same solution. 65 | } 66 | -------------------------------------------------------------------------------- /tests/testthat.R: -------------------------------------------------------------------------------- 1 | library(testthat) 2 | library(aoc) 3 | 4 | test_check("aoc") 5 | -------------------------------------------------------------------------------- /tests/testthat/test-year.R: -------------------------------------------------------------------------------- 1 | test_that("get_aoc_year() works", { 2 | withr::local_options(list(aoc.year = 2019)) 3 | expect_equal(get_aoc_year(), 2019) 4 | }) 5 | --------------------------------------------------------------------------------