From 5619b9c1e5ceab91c8bceae989ecaf90b61e6d34 Mon Sep 17 00:00:00 2001 From: Simon Brooke Date: Mon, 13 May 2019 21:46:43 +0100 Subject: [PATCH] Merchant route selection: very basic stuff works Tests pass. --- CHANGELOG.md | 24 + LICENSE | 469 +++++++----------- README.md | 4 +- doc/intro.md | 3 + project.clj | 12 + src/the_great_game/core.clj | 6 + src/the_great_game/merchants/merchants.clj | 156 ++++++ src/the_great_game/merchants/strategy.clj | 0 src/the_great_game/utils.clj | 17 + src/the_great_game/world/routes.clj | 46 ++ src/the_great_game/world/world.clj | 184 +++++++ .../merchants/merchants_test.clj | 23 + test/the_great_game/utils_test.clj | 12 + test/the_great_game/world/routes_test.clj | 33 ++ test/the_great_game/world/world_test.clj | 4 + 15 files changed, 694 insertions(+), 299 deletions(-) create mode 100644 CHANGELOG.md create mode 100644 doc/intro.md create mode 100644 project.clj create mode 100644 src/the_great_game/core.clj create mode 100644 src/the_great_game/merchants/merchants.clj create mode 100644 src/the_great_game/merchants/strategy.clj create mode 100644 src/the_great_game/utils.clj create mode 100644 src/the_great_game/world/routes.clj create mode 100644 src/the_great_game/world/world.clj create mode 100644 test/the_great_game/merchants/merchants_test.clj create mode 100644 test/the_great_game/utils_test.clj create mode 100644 test/the_great_game/world/routes_test.clj create mode 100644 test/the_great_game/world/world_test.clj diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..2f6c8be --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,24 @@ +# Change Log +All notable changes to this project will be documented in this file. This change log follows the conventions of [keepachangelog.com](http://keepachangelog.com/). + +## [Unreleased] +### Changed +- Add a new arity to `make-widget-async` to provide a different widget shape. + +## [0.1.1] - 2019-05-13 +### Changed +- Documentation on how to make the widgets. + +### Removed +- `make-widget-sync` - we're all async, all the time. + +### Fixed +- Fixed widget maker to keep working when daylight savings switches over. + +## 0.1.0 - 2019-05-13 +### Added +- Files from the new template. +- Widget maker public API - `make-widget-sync`. + +[Unreleased]: https://github.com/your-name/the-great-game/compare/0.1.1...HEAD +[0.1.1]: https://github.com/your-name/the-great-game/compare/0.1.0...0.1.1 diff --git a/LICENSE b/LICENSE index d159169..d921d3d 100644 --- a/LICENSE +++ b/LICENSE @@ -1,339 +1,214 @@ - GNU GENERAL PUBLIC LICENSE - Version 2, June 1991 +THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE PUBLIC +LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM +CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT. - Copyright (C) 1989, 1991 Free Software Foundation, Inc., - 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. +1. DEFINITIONS - Preamble +"Contribution" means: - The licenses for most software are designed to take away your -freedom to share and change it. By contrast, the GNU General Public -License is intended to guarantee your freedom to share and change free -software--to make sure the software is free for all its users. This -General Public License applies to most of the Free Software -Foundation's software and to any other program whose authors commit to -using it. (Some other Free Software Foundation software is covered by -the GNU Lesser General Public License instead.) You can apply it to -your programs, too. +a) in the case of the initial Contributor, the initial code and +documentation distributed under this Agreement, and - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -this service if you wish), that you receive source code or can get it -if you want it, that you can change the software or use pieces of it -in new free programs; and that you know you can do these things. +b) in the case of each subsequent Contributor: - To protect your rights, we need to make restrictions that forbid -anyone to deny you these rights or to ask you to surrender the rights. -These restrictions translate to certain responsibilities for you if you -distribute copies of the software, or if you modify it. +i) changes to the Program, and - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must give the recipients all the rights that -you have. You must make sure that they, too, receive or can get the -source code. And you must show them these terms so they know their -rights. +ii) additions to the Program; - We protect your rights with two steps: (1) copyright the software, and -(2) offer you this license which gives you legal permission to copy, -distribute and/or modify the software. +where such changes and/or additions to the Program originate from and are +distributed by that particular Contributor. A Contribution 'originates' from +a Contributor if it was added to the Program by such Contributor itself or +anyone acting on such Contributor's behalf. Contributions do not include +additions to the Program which: (i) are separate modules of software +distributed in conjunction with the Program under their own license +agreement, and (ii) are not derivative works of the Program. - Also, for each author's protection and ours, we want to make certain -that everyone understands that there is no warranty for this free -software. If the software is modified by someone else and passed on, we -want its recipients to know that what they have is not the original, so -that any problems introduced by others will not reflect on the original -authors' reputations. +"Contributor" means any person or entity that distributes the Program. - Finally, any free program is threatened constantly by software -patents. We wish to avoid the danger that redistributors of a free -program will individually obtain patent licenses, in effect making the -program proprietary. To prevent this, we have made it clear that any -patent must be licensed for everyone's free use or not licensed at all. +"Licensed Patents" mean patent claims licensable by a Contributor which are +necessarily infringed by the use or sale of its Contribution alone or when +combined with the Program. - The precise terms and conditions for copying, distribution and -modification follow. +"Program" means the Contributions distributed in accordance with this +Agreement. - GNU GENERAL PUBLIC LICENSE - TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION +"Recipient" means anyone who receives the Program under this Agreement, +including all Contributors. - 0. This License applies to any program or other work which contains -a notice placed by the copyright holder saying it may be distributed -under the terms of this General Public License. The "Program", below, -refers to any such program or work, and a "work based on the Program" -means either the Program or any derivative work under copyright law: -that is to say, a work containing the Program or a portion of it, -either verbatim or with modifications and/or translated into another -language. (Hereinafter, translation is included without limitation in -the term "modification".) Each licensee is addressed as "you". +2. GRANT OF RIGHTS -Activities other than copying, distribution and modification are not -covered by this License; they are outside its scope. The act of -running the Program is not restricted, and the output from the Program -is covered only if its contents constitute a work based on the -Program (independent of having been made by running the Program). -Whether that is true depends on what the Program does. +a) Subject to the terms of this Agreement, each Contributor hereby grants +Recipient a non-exclusive, worldwide, royalty-free copyright license to +reproduce, prepare derivative works of, publicly display, publicly perform, +distribute and sublicense the Contribution of such Contributor, if any, and +such derivative works, in source code and object code form. - 1. You may copy and distribute verbatim copies of the Program's -source code as you receive it, in any medium, provided that you -conspicuously and appropriately publish on each copy an appropriate -copyright notice and disclaimer of warranty; keep intact all the -notices that refer to this License and to the absence of any warranty; -and give any other recipients of the Program a copy of this License -along with the Program. +b) Subject to the terms of this Agreement, each Contributor hereby grants +Recipient a non-exclusive, worldwide, royalty-free patent license under +Licensed Patents to make, use, sell, offer to sell, import and otherwise +transfer the Contribution of such Contributor, if any, in source code and +object code form. This patent license shall apply to the combination of the +Contribution and the Program if, at the time the Contribution is added by the +Contributor, such addition of the Contribution causes such combination to be +covered by the Licensed Patents. The patent license shall not apply to any +other combinations which include the Contribution. No hardware per se is +licensed hereunder. -You may charge a fee for the physical act of transferring a copy, and -you may at your option offer warranty protection in exchange for a fee. +c) Recipient understands that although each Contributor grants the licenses +to its Contributions set forth herein, no assurances are provided by any +Contributor that the Program does not infringe the patent or other +intellectual property rights of any other entity. Each Contributor disclaims +any liability to Recipient for claims brought by any other entity based on +infringement of intellectual property rights or otherwise. As a condition to +exercising the rights and licenses granted hereunder, each Recipient hereby +assumes sole responsibility to secure any other intellectual property rights +needed, if any. For example, if a third party patent license is required to +allow Recipient to distribute the Program, it is Recipient's responsibility +to acquire that license before distributing the Program. - 2. You may modify your copy or copies of the Program or any portion -of it, thus forming a work based on the Program, and copy and -distribute such modifications or work under the terms of Section 1 -above, provided that you also meet all of these conditions: +d) Each Contributor represents that to its knowledge it has sufficient +copyright rights in its Contribution, if any, to grant the copyright license +set forth in this Agreement. - a) You must cause the modified files to carry prominent notices - stating that you changed the files and the date of any change. +3. REQUIREMENTS - b) You must cause any work that you distribute or publish, that in - whole or in part contains or is derived from the Program or any - part thereof, to be licensed as a whole at no charge to all third - parties under the terms of this License. +A Contributor may choose to distribute the Program in object code form under +its own license agreement, provided that: - c) If the modified program normally reads commands interactively - when run, you must cause it, when started running for such - interactive use in the most ordinary way, to print or display an - announcement including an appropriate copyright notice and a - notice that there is no warranty (or else, saying that you provide - a warranty) and that users may redistribute the program under - these conditions, and telling the user how to view a copy of this - License. (Exception: if the Program itself is interactive but - does not normally print such an announcement, your work based on - the Program is not required to print an announcement.) +a) it complies with the terms and conditions of this Agreement; and -These requirements apply to the modified work as a whole. If -identifiable sections of that work are not derived from the Program, -and can be reasonably considered independent and separate works in -themselves, then this License, and its terms, do not apply to those -sections when you distribute them as separate works. But when you -distribute the same sections as part of a whole which is a work based -on the Program, the distribution of the whole must be on the terms of -this License, whose permissions for other licensees extend to the -entire whole, and thus to each and every part regardless of who wrote it. +b) its license agreement: -Thus, it is not the intent of this section to claim rights or contest -your rights to work written entirely by you; rather, the intent is to -exercise the right to control the distribution of derivative or -collective works based on the Program. +i) effectively disclaims on behalf of all Contributors all warranties and +conditions, express and implied, including warranties or conditions of title +and non-infringement, and implied warranties or conditions of merchantability +and fitness for a particular purpose; -In addition, mere aggregation of another work not based on the Program -with the Program (or with a work based on the Program) on a volume of -a storage or distribution medium does not bring the other work under -the scope of this License. +ii) effectively excludes on behalf of all Contributors all liability for +damages, including direct, indirect, special, incidental and consequential +damages, such as lost profits; - 3. You may copy and distribute the Program (or a work based on it, -under Section 2) in object code or executable form under the terms of -Sections 1 and 2 above provided that you also do one of the following: +iii) states that any provisions which differ from this Agreement are offered +by that Contributor alone and not by any other party; and - a) Accompany it with the complete corresponding machine-readable - source code, which must be distributed under the terms of Sections - 1 and 2 above on a medium customarily used for software interchange; or, +iv) states that source code for the Program is available from such +Contributor, and informs licensees how to obtain it in a reasonable manner on +or through a medium customarily used for software exchange. - b) Accompany it with a written offer, valid for at least three - years, to give any third party, for a charge no more than your - cost of physically performing source distribution, a complete - machine-readable copy of the corresponding source code, to be - distributed under the terms of Sections 1 and 2 above on a medium - customarily used for software interchange; or, +When the Program is made available in source code form: - c) Accompany it with the information you received as to the offer - to distribute corresponding source code. (This alternative is - allowed only for noncommercial distribution and only if you - received the program in object code or executable form with such - an offer, in accord with Subsection b above.) +a) it must be made available under this Agreement; and -The source code for a work means the preferred form of the work for -making modifications to it. For an executable work, complete source -code means all the source code for all modules it contains, plus any -associated interface definition files, plus the scripts used to -control compilation and installation of the executable. However, as a -special exception, the source code distributed need not include -anything that is normally distributed (in either source or binary -form) with the major components (compiler, kernel, and so on) of the -operating system on which the executable runs, unless that component -itself accompanies the executable. +b) a copy of this Agreement must be included with each copy of the Program. -If distribution of executable or object code is made by offering -access to copy from a designated place, then offering equivalent -access to copy the source code from the same place counts as -distribution of the source code, even though third parties are not -compelled to copy the source along with the object code. +Contributors may not remove or alter any copyright notices contained within +the Program. - 4. You may not copy, modify, sublicense, or distribute the Program -except as expressly provided under this License. Any attempt -otherwise to copy, modify, sublicense or distribute the Program is -void, and will automatically terminate your rights under this License. -However, parties who have received copies, or rights, from you under -this License will not have their licenses terminated so long as such -parties remain in full compliance. +Each Contributor must identify itself as the originator of its Contribution, +if any, in a manner that reasonably allows subsequent Recipients to identify +the originator of the Contribution. - 5. You are not required to accept this License, since you have not -signed it. However, nothing else grants you permission to modify or -distribute the Program or its derivative works. These actions are -prohibited by law if you do not accept this License. Therefore, by -modifying or distributing the Program (or any work based on the -Program), you indicate your acceptance of this License to do so, and -all its terms and conditions for copying, distributing or modifying -the Program or works based on it. +4. COMMERCIAL DISTRIBUTION - 6. Each time you redistribute the Program (or any work based on the -Program), the recipient automatically receives a license from the -original licensor to copy, distribute or modify the Program subject to -these terms and conditions. You may not impose any further -restrictions on the recipients' exercise of the rights granted herein. -You are not responsible for enforcing compliance by third parties to -this License. +Commercial distributors of software may accept certain responsibilities with +respect to end users, business partners and the like. While this license is +intended to facilitate the commercial use of the Program, the Contributor who +includes the Program in a commercial product offering should do so in a +manner which does not create potential liability for other Contributors. +Therefore, if a Contributor includes the Program in a commercial product +offering, such Contributor ("Commercial Contributor") hereby agrees to defend +and indemnify every other Contributor ("Indemnified Contributor") against any +losses, damages and costs (collectively "Losses") arising from claims, +lawsuits and other legal actions brought by a third party against the +Indemnified Contributor to the extent caused by the acts or omissions of such +Commercial Contributor in connection with its distribution of the Program in +a commercial product offering. The obligations in this section do not apply +to any claims or Losses relating to any actual or alleged intellectual +property infringement. In order to qualify, an Indemnified Contributor must: +a) promptly notify the Commercial Contributor in writing of such claim, and +b) allow the Commercial Contributor to control, and cooperate with the +Commercial Contributor in, the defense and any related settlement +negotiations. The Indemnified Contributor may participate in any such claim +at its own expense. - 7. If, as a consequence of a court judgment or allegation of patent -infringement or for any other reason (not limited to patent issues), -conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot -distribute so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you -may not distribute the Program at all. For example, if a patent -license would not permit royalty-free redistribution of the Program by -all those who receive copies directly or indirectly through you, then -the only way you could satisfy both it and this License would be to -refrain entirely from distribution of the Program. +For example, a Contributor might include the Program in a commercial product +offering, Product X. That Contributor is then a Commercial Contributor. If +that Commercial Contributor then makes performance claims, or offers +warranties related to Product X, those performance claims and warranties are +such Commercial Contributor's responsibility alone. Under this section, the +Commercial Contributor would have to defend claims against the other +Contributors related to those performance claims and warranties, and if a +court requires any other Contributor to pay any damages as a result, the +Commercial Contributor must pay those damages. -If any portion of this section is held invalid or unenforceable under -any particular circumstance, the balance of the section is intended to -apply and the section as a whole is intended to apply in other -circumstances. +5. NO WARRANTY -It is not the purpose of this section to induce you to infringe any -patents or other property right claims or to contest validity of any -such claims; this section has the sole purpose of protecting the -integrity of the free software distribution system, which is -implemented by public license practices. Many people have made -generous contributions to the wide range of software distributed -through that system in reliance on consistent application of that -system; it is up to the author/donor to decide if he or she is willing -to distribute software through any other system and a licensee cannot -impose that choice. +EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON +AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER +EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR +CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A +PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the +appropriateness of using and distributing the Program and assumes all risks +associated with its exercise of rights under this Agreement , including but +not limited to the risks and costs of program errors, compliance with +applicable laws, damage to or loss of data, programs or equipment, and +unavailability or interruption of operations. -This section is intended to make thoroughly clear what is believed to -be a consequence of the rest of this License. +6. DISCLAIMER OF LIABILITY - 8. If the distribution and/or use of the Program is restricted in -certain countries either by patents or by copyrighted interfaces, the -original copyright holder who places the Program under this License -may add an explicit geographical distribution limitation excluding -those countries, so that distribution is permitted only in or among -countries not thus excluded. In such case, this License incorporates -the limitation as if written in the body of this License. +EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY +CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, +SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION +LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE +EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY +OF SUCH DAMAGES. - 9. The Free Software Foundation may publish revised and/or new versions -of the General Public License from time to time. Such new versions will -be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. +7. GENERAL -Each version is given a distinguishing version number. If the Program -specifies a version number of this License which applies to it and "any -later version", you have the option of following the terms and conditions -either of that version or of any later version published by the Free -Software Foundation. If the Program does not specify a version number of -this License, you may choose any version ever published by the Free Software -Foundation. +If any provision of this Agreement is invalid or unenforceable under +applicable law, it shall not affect the validity or enforceability of the +remainder of the terms of this Agreement, and without further action by the +parties hereto, such provision shall be reformed to the minimum extent +necessary to make such provision valid and enforceable. - 10. If you wish to incorporate parts of the Program into other free -programs whose distribution conditions are different, write to the author -to ask for permission. For software which is copyrighted by the Free -Software Foundation, write to the Free Software Foundation; we sometimes -make exceptions for this. Our decision will be guided by the two goals -of preserving the free status of all derivatives of our free software and -of promoting the sharing and reuse of software generally. +If Recipient institutes patent litigation against any entity (including a +cross-claim or counterclaim in a lawsuit) alleging that the Program itself +(excluding combinations of the Program with other software or hardware) +infringes such Recipient's patent(s), then such Recipient's rights granted +under Section 2(b) shall terminate as of the date such litigation is filed. - NO WARRANTY +All Recipient's rights under this Agreement shall terminate if it fails to +comply with any of the material terms or conditions of this Agreement and +does not cure such failure in a reasonable period of time after becoming +aware of such noncompliance. If all Recipient's rights under this Agreement +terminate, Recipient agrees to cease use and distribution of the Program as +soon as reasonably practicable. However, Recipient's obligations under this +Agreement and any licenses granted by Recipient relating to the Program shall +continue and survive. - 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY -FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN -OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES -PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED -OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF -MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS -TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE -PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, -REPAIR OR CORRECTION. +Everyone is permitted to copy and distribute copies of this Agreement, but in +order to avoid inconsistency the Agreement is copyrighted and may only be +modified in the following manner. The Agreement Steward reserves the right to +publish new versions (including revisions) of this Agreement from time to +time. No one other than the Agreement Steward has the right to modify this +Agreement. The Eclipse Foundation is the initial Agreement Steward. The +Eclipse Foundation may assign the responsibility to serve as the Agreement +Steward to a suitable separate entity. Each new version of the Agreement will +be given a distinguishing version number. The Program (including +Contributions) may always be distributed subject to the version of the +Agreement under which it was received. In addition, after a new version of +the Agreement is published, Contributor may elect to distribute the Program +(including its Contributions) under the new version. Except as expressly +stated in Sections 2(a) and 2(b) above, Recipient receives no rights or +licenses to the intellectual property of any Contributor under this +Agreement, whether expressly, by implication, estoppel or otherwise. All +rights in the Program not expressly granted under this Agreement are +reserved. - 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR -REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, -INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING -OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED -TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY -YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER -PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE -POSSIBILITY OF SUCH DAMAGES. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -convey the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - - Copyright (C) - - This program is free software; you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation; either version 2 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License along - with this program; if not, write to the Free Software Foundation, Inc., - 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. - -Also add information on how to contact you by electronic and paper mail. - -If the program is interactive, make it output a short notice like this -when it starts in an interactive mode: - - Gnomovision version 69, Copyright (C) year name of author - Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. - This is free software, and you are welcome to redistribute it - under certain conditions; type `show c' for details. - -The hypothetical commands `show w' and `show c' should show the appropriate -parts of the General Public License. Of course, the commands you use may -be called something other than `show w' and `show c'; they could even be -mouse-clicks or menu items--whatever suits your program. - -You should also get your employer (if you work as a programmer) or your -school, if any, to sign a "copyright disclaimer" for the program, if -necessary. Here is a sample; alter the names: - - Yoyodyne, Inc., hereby disclaims all copyright interest in the program - `Gnomovision' (which makes passes at compilers) written by James Hacker. - - , 1 April 1989 - Ty Coon, President of Vice - -This General Public License does not permit incorporating your program into -proprietary programs. If your program is a subroutine library, you may -consider it more useful to permit linking proprietary applications with the -library. If this is what you want to do, use the GNU Lesser General -Public License instead of this License. +This Agreement is governed by the laws of the State of New York and the +intellectual property laws of the United States of America. No party to this +Agreement will bring a legal action under this Agreement more than one year +after the cause of action arose. Each party waives its rights to a jury trial +in any resulting litigation. diff --git a/README.md b/README.md index e32ee0f..42d0897 100644 --- a/README.md +++ b/README.md @@ -136,8 +136,8 @@ thousands of user-contributed add-on 'mods', mostly stories and quests, for Neverwinter Nights, of which I wrote several - and I greatly enjoyed doing so. -Later on, with Carrol Dufault and others (including -[wonderful original music by James Semple](https://www.youtube.com/watch?v=1afAIojPZ1w)), I went on to write a [new story for The Witcher](https://www.moddb.com/mods/birth-virgins) which won CD Project's prize for best mod. +Later on, with Carrol Dufault and others (including James Semple who wrote +[wonderful original music](https://www.youtube.com/watch?v=1afAIojPZ1w)), I went on to write a [new story for The Witcher](https://www.moddb.com/mods/birth-virgins) which won CD Project's prize for best mod. For me, writing story is every bit as compelling an activity as playing it, and I know I'm not alone in that. So I feel strongly that if **The Great Game** diff --git a/doc/intro.md b/doc/intro.md new file mode 100644 index 0000000..d054201 --- /dev/null +++ b/doc/intro.md @@ -0,0 +1,3 @@ +# Introduction to the-great-game + +TODO: write [great documentation](http://jacobian.org/writing/what-to-write/) diff --git a/project.clj b/project.clj new file mode 100644 index 0000000..2bc9bcc --- /dev/null +++ b/project.clj @@ -0,0 +1,12 @@ +(defproject the-great-game "0.1.0-SNAPSHOT" + :codox {:metadata {:doc "**TODO**: write docs" + :doc/format :markdown} + :output-path "docs" + :source-uri "https://github.com/simon-brooke/the-great-game/blob/master/{filepath}#L{line}"} + :dependencies [[org.clojure/clojure "1.8.0"]] + :description "Prototype code towards the great game I've been writing about for ten years, and know I will never finish." + :license {:name "GNU General Public License,version 2.0 or (at your option) any later version" + :url "https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html"} + :plugins [[lein-codox "0.10.3"]] + :url "https://github.com/simon-brooke/the-great-game" + ) diff --git a/src/the_great_game/core.clj b/src/the_great_game/core.clj new file mode 100644 index 0000000..7a102ed --- /dev/null +++ b/src/the_great_game/core.clj @@ -0,0 +1,6 @@ +(ns the-great-game.core) + +(defn foo + "I don't do a whole lot." + [x] + (println x "Hello, World!")) diff --git a/src/the_great_game/merchants/merchants.clj b/src/the_great_game/merchants/merchants.clj new file mode 100644 index 0000000..0eb7598 --- /dev/null +++ b/src/the_great_game/merchants/merchants.clj @@ -0,0 +1,156 @@ +(ns the-great-game.merchants.merchants + "Trade planning for merchants, primarily." + (:require [the-great-game.world.routes :refer [find-routes]] + [the-great-game.world.world :refer [actual-price]])) + + +(defn expected-price + "Find the price anticipated, given this `world`, by this `merchant` for + this `commodity` in this `city`. If no information, assume 1. + `merchant` should be passed as a map, `commodity` and `city` should be passed as keywords." + [merchant commodity city] + (or + (:price + (last + (sort-by + :date + (-> merchant :known-prices city commodity)))) + 1)) + + +(defn burden + "The total weight of the current cargo carried by this `merchant` in this + `world`." + [merchant world] + (let [m (cond + (keyword? merchant) + (-> world :merchants merchant) + (map? merchant) + merchant) + cargo (-> m :stock)] + (reduce + + + 0 + (map + #(* (cargo %) (-> world :commodities % :weight)) + (keys cargo))))) + + +(defn find-trade-plan + "Find the best destination in this `world` for this `commodity` given this + `merchant` and this `origin`. If two cities are anticipated to offer the + same price, the nearer should be preferred; if two are equally distant, the + ones nearer to the merchant's home should be preferred. + `merchant` may be passed as a map or a keyword; `commodity` should be + passed as a keyword. + + The returned plan is a map with keys: + + # :merchant - the id of the `merchant` for whom the plan was created; + # :origin - the city from which the trade starts; + # :destination - the city to which the trade is planned; + # :commodity - the `commodity` to be carried; + # :buy-price - the price at which that `commodity` can be bought; + # :expected-price - the price at which the `merchant` anticipates + that `commodity` can be sold; + # :distance - the number of stages in the planned journey + # :dist-to-home - the distance from `destination` to the `merchant`'s + home city." + [merchant world commodity] + (let [m (cond + (keyword? merchant) + (-> world :merchants merchant) + (map? merchant) + merchant) + origin (-> m :location) + destinations (remove #(= % origin) (keys (-> world :cities))) + plans (map + #(hash-map + :merchant (-> m :id) + :origin origin + :destination % + :commodity commodity + :buy-price (actual-price world commodity origin) + :expected-price (expected-price + merchant + commodity + %) + :distance (count + (first + (find-routes (:routes world) origin %))) + :dist-to-home (count + (first + (find-routes + (:routes world) + (-> world :merchants merchant :home) + %))) + ) + destinations) + best-price (apply min (filter number? (map :expected-price plans))) + nearest (apply min (map :distance plans))] + (first + (sort + #(compare (:dist-to-home %1) (:dist-to-home %2)) + (filter + #(and + (= (:expected-price %) best-price) + (= (:distance %) nearest)) + plans))))) + + +(defn augment-plan + "Augment this `plan` constructed in this `world` for this `merchant` with + the `:quantity` of goods which should be bought and the `:expected-profit` + of the trade. + + Returns the augmented plan." + [merchant world plan] + (let [m (cond + (keyword? merchant) + (-> world :merchants merchant) + (map? merchant) + merchant) + available (-> world :cities (:origin plan) :stock (:commodity plan)) + can-carry (quot + (- (-> m :capacity) (burden m world)) + (-> world :commodities (:commodity plan) :weight)) + can-afford (quot + (-> merchant :cash) + (-> world :commodities (:commodity plan) :weight)) + q (min available can-carry can-afford) + p (* q (- (:expected-price plan) (:buy-price plan)))] + (assoc plan :quantity q :expected-profit p))) + + +(defn select-cargo + "A `merchant`, in a given location in a `world`, will choose to buy a cargo + within the limit they are capable of carrying, which they can anticipate + selling for a profit at a destination." + [merchant world] + (let [m (cond + (keyword? merchant) + (-> world :merchants merchant) + (map? merchant) + merchant) + origin (-> m :location) + available (-> world :cities origin :stock) + plans (map + #(augment-plan + m + world + (find-trade-plan m world %)) + (filter + #(let [q (-> world :cities origin :stock %)] + (and (number? q) (> q 0))) + (keys available))) + best-profit (apply min (filter number? (map :expected-profit plans))) + nearest (apply min (map :distance plans))] + (first + (sort + #(compare (:dist-to-home %1) (:dist-to-home %2)) + (filter + #(and + (= (:expected-profit %) best-profit) + (= (:distance %) nearest)) + plans))) )) + diff --git a/src/the_great_game/merchants/strategy.clj b/src/the_great_game/merchants/strategy.clj new file mode 100644 index 0000000..e69de29 diff --git a/src/the_great_game/utils.clj b/src/the_great_game/utils.clj new file mode 100644 index 0000000..ed6247b --- /dev/null +++ b/src/the_great_game/utils.clj @@ -0,0 +1,17 @@ +(ns the-great-game.utils) + + +(defn cyclic? + "True if two or more elements of `route` are identical" + [route] + (not (= (count route)(count (set route))))) + +(defn deep-merge + "Recursively merges maps. Stolen from + https://dnaeon.github.io/recursively-merging-maps-in-clojure/" + [& maps] + (letfn [(m [& xs] + (if (some #(and (map? %) (not (record? %))) xs) + (apply merge-with m xs) + (last xs)))] + (reduce m maps))) diff --git a/src/the_great_game/world/routes.clj b/src/the_great_game/world/routes.clj new file mode 100644 index 0000000..0bf2b3f --- /dev/null +++ b/src/the_great_game/world/routes.clj @@ -0,0 +1,46 @@ +(ns the-great-game.world.routes + "Conceptual (plan level) routes, represented as tuples of location ids." + (:require [the-great-game.utils :refer [cyclic?]])) + +(defn find-routes + "Find routes from among these `routes` from `from`; if `to` is supplied, + to `to`, by breadth-first search." + ([routes from] + (map + (fn [to] (cons from to)) + (remove + #(empty? %) + (map + (fn [route] + (filter + #(not (= from %)) + (if (some #(= % from) route) route))) + routes)))) + ([routes from to] + (let [steps (find-routes routes from) + found (filter + (fn [step] (if (some #(= to %) step) step)) + steps)] + (if + (empty? found) + (find-routes routes from to steps) + found))) + ([routes from to steps] + (if + (not (empty? steps)) + (let [paths (remove + cyclic? + (apply + concat + (map + (fn [path] + (map + (fn [x] (concat path (rest x))) + (find-routes routes (last path)))) + steps))) + found (filter + #(= (last %) to) paths)] + (if + (empty? found) + (find-routes routes from to paths) + found))))) diff --git a/src/the_great_game/world/world.clj b/src/the_great_game/world/world.clj new file mode 100644 index 0000000..32a639a --- /dev/null +++ b/src/the_great_game/world/world.clj @@ -0,0 +1,184 @@ +(ns the-great-game.world.world + "Access to data about the world") + +;;; The world has to work either as map or a database. Initially, and for +;;; unit tests, I'll use a map; later, there will be a database. But the +;;; API needs to be agnostic, so that heirarchies which interact with +;;; `world` don't have to know which they've got - as far as they're concerned +;;; it's just a handle. + +(def default-world + "A basic world for testing concepts" + {:cities + {:aberdeen + {:id :aberdeen + :supplies + ;; `supplies` is the quantity of each commodity added to the stock + ;; each game day. If the price in the market is lower than 1 (the + ;; cost of production of a unit) no goods will be added. + {:fish 10 + :leather 5} + :demands + ;; `stock` is the quantity of each commodity in the market at any + ;; given time. It is adjusted for production and consumption at + ;; the end of each game day. + {:iron 1 + :cloth 10 + :tobacco 10} + :port true + :prices + ;; `prices`: the current price (both buying and selling, for simplicity) + ;; of each commodity in the market. Updated each game day based on current + ;; stock. + {:cloth 1 + :fish 1 + :leather 1 + :iron 1 + :tobacco 1} + :stock + ;; `stock` is the quantity of each commodity in the market at any + ;; given time. It is adjusted for production and consumption at + ;; the end of each game day. + {:cloth 0 + :fish 0 + :leather 0 + :iron 0 + :tobacco 0} + :cash 100} + :buckie + {:id :buckie + :supplies + {:fish 20} + :demands + {:cloth 5 + :leather 3 + :tobacco 5 + :iron 1} + :port true + :prices {:cloth 1 + :fish 1 + :leather 1 + :iron 1 + :tobacco 1} + :stock {:cloth 0 + :fish 0 + :leather 0 + :iron 0 + :tobacco 0} + :cash 100} + :callander + {:id :callander + :supplies {:leather 20} + :demands + {:cloth 5 + :fish 3 + :tobacco 5 + :iron 1} + :prices {:cloth 1 + :fish 1 + :leather 1 + :iron 1 + :tobacco 1} + :stock {:cloth 0 + :fish 0 + :leather 0 + :iron 0 + :tobacco 0} + :cash 100} + :dundee {:id :dundee} + :edinburgh {:id :dundee} + :falkirk + {:id :falkirk + :supplies {:iron 10} + :demands + {:cloth 5 + :leather 3 + :tobacco 5 + :fish 10} + :port true + :prices {:cloth 1 + :fish 1 + :leather 1 + :iron 1 + :tobacco 1} + :stock {:cloth 0 + :fish 0 + :leather 0 + :iron 0 + :tobacco 0} + :cash 100} + :glasgow + {:id :glasgow + :supplies {:tobacco 10} + :demands + {:cloth 5 + :leather 3 + :iron 5 + :fish 10} + :port true + :prices {:cloth 1 + :fish 1 + :leather 1 + :iron 1 + :tobacco 1} + :stock {:cloth 0 + :fish 0 + :leather 0 + :iron 0 + :tobacco 0} + :cash 100}} + :merchants + {:archie {:id :archie + :home :aberdeen :location :aberdeen :cash 100 :capacity 10 + :known-prices {} + :stock {}} + :belinda {:id :belinda + :home :buckie :location :buckie :cash 100 :capacity 10 + :known-prices {} + :stock {}} + :callum {:id :callum + :home :callander :location :calander :cash 100 :capacity 10 + :known-prices {} + :stock {}} + :deirdre {:id :deidre + :home :dundee :location :dundee :cash 100 :capacity 10 + :known-prices {} + :stock {}} + :euan {:id :euan + :home :edinbirgh :location :edinburgh :cash 100 :capacity 10 + :known-prices {} + :stock {}} + :fiona {:id :fiona + :home :falkirk :location :falkirk :cash 100 :capacity 10 + :known-prices {} + :stock {}}} + :routes + ;; all routes can be traversed in either direction and are assumed to + ;; take the same amount of time. + [[:aberdeen :buckie] + [:aberdeen :dundee] + [:callander :glasgow] + [:dundee :callander] + [:dundee :edinburgh] + [:dundee :falkirk] + [:edinburgh :falkirk] + [:falkirk :glasgow]] + :commodities + ;; cost of commodities is expressed in person/days; + ;; weight in packhorse loads. Transport in this model + ;; is all overland; you don't take bulk cargoes overland + ;; in this period, it's too expensive. + {:cloth {:id :cloth :cost 1 :weight 0.25} + :fish {:id :fish :cost 1 :weight 1} + :leather {:id :leather :cost 1 :weight 0.5} + :tobacco {:id :tobacco :cost 1 :weight 0.1} + :iron {:id :iron :cost 1 :weight 10}}}) + +(defn actual-price + "Find the actual current price of this `commodity` in this `city` given + this `world`. **NOTE** that merchants can only know the actual prices in + the city in which they are currently located." + [world commodity city] + (-> world :cities city :prices commodity)) + + diff --git a/test/the_great_game/merchants/merchants_test.clj b/test/the_great_game/merchants/merchants_test.clj new file mode 100644 index 0000000..f4d7ed3 --- /dev/null +++ b/test/the_great_game/merchants/merchants_test.clj @@ -0,0 +1,23 @@ +(ns the-great-game.merchants.merchants-test + (:require [clojure.test :refer :all] + [the-great-game.utils :refer [deep-merge]] + [the-great-game.world.world :refer [default-world]] + [the-great-game.merchants.merchants :refer :all])) + +(deftest expected-price-test + (testing "Anticipated prices in markets" + (let [world (deep-merge + default-world + {:merchants + {:archie + {:known-prices + {:buckie + {:iron + [{:price 1.7 :date 1} + {:price 2 :date 0}]}}}}})] + (let [actual (expected-price (-> world :merchants :archie) :fish :edinburgh) + expected 1] ;; + (is (= actual expected) "if no information assume 1")) + (let [actual (expected-price (-> world :merchants :archie) :iron :buckie) + expected 1.7] ;; + (is (= actual expected) "if information select the most recent"))))) diff --git a/test/the_great_game/utils_test.clj b/test/the_great_game/utils_test.clj new file mode 100644 index 0000000..3181ea2 --- /dev/null +++ b/test/the_great_game/utils_test.clj @@ -0,0 +1,12 @@ +(ns the-great-game.utils-test + (:require [clojure.test :refer :all] + [the-great-game.utils :refer :all])) + +(deftest cyclic-tests + (testing "Detecting cyclic routes" + (let [actual (cyclic? '(:glasgow :edinburgh :glasgow)) + expected true] + (is (= actual expected))) + (let [actual (cyclic? '(:edinburgh :dundee :aberdeen :buckie)) + expected false] + (is (= actual expected))))) diff --git a/test/the_great_game/world/routes_test.clj b/test/the_great_game/world/routes_test.clj new file mode 100644 index 0000000..1c40151 --- /dev/null +++ b/test/the_great_game/world/routes_test.clj @@ -0,0 +1,33 @@ +(ns the-great-game.world.routes-test + (:require [clojure.test :refer :all] + [the-great-game.world.routes :refer :all] + [the-great-game.world.world :refer [default-world]])) + + +(deftest routing-test + (testing "Routing: possible route" + (let [origin :buckie + destination :glasgow + routes (find-routes (:routes default-world) origin destination)] + (is + (= (first (first routes)) origin) + "Routes should be from the specified origin") + (is + (= (last (first routes)) destination) + "Routes should be from the specified destination") + (is + (= (count (set (map first routes))) 1) + "All routes should have the same origin") + (is + (= (count (set (map last routes))) 1) + "All routes should have the same destination") + (is + (= (count (set (map count routes))) 1) + "All selected routes should have the same length") + )) + (testing "Impossible route" + (let [origin :buckie + destination :london ;; not present in the routing map + actual (find-routes (:routes default-world) origin destination)] + (is (nil? actual) "There should be no route returned.")))) + diff --git a/test/the_great_game/world/world_test.clj b/test/the_great_game/world/world_test.clj new file mode 100644 index 0000000..3770f9a --- /dev/null +++ b/test/the_great_game/world/world_test.clj @@ -0,0 +1,4 @@ +(ns the-great-game.world.world-test + (:require [clojure.test :refer :all] + [the-great-game.world.world :refer :all])) +