diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index ed3eac4..2814a9b 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -23,6 +23,7 @@ jobs: steps: - uses: actions/checkout@v6 - uses: dtolnay/rust-toolchain@nightly + - uses: Swatinem/rust-cache@v2 - name: Run tests run: cargo test @@ -32,6 +33,7 @@ jobs: steps: - uses: actions/checkout@v6 - uses: dtolnay/rust-toolchain@stable + - uses: Swatinem/rust-cache@v2 - name: Run tests run: cargo test @@ -54,6 +56,7 @@ jobs: - uses: dtolnay/rust-toolchain@stable with: components: clippy + - uses: Swatinem/rust-cache@v2 - name: Linting run: cargo clippy -- -D warnings diff --git a/.github/workflows/post-merge.yml b/.github/workflows/post-merge.yml index cd4c334..18de054 100644 --- a/.github/workflows/post-merge.yml +++ b/.github/workflows/post-merge.yml @@ -25,6 +25,7 @@ jobs: - &install-rust name: Install Rust toolchain uses: dtolnay/rust-toolchain@stable + - uses: Swatinem/rust-cache@v2 - name: Run release-plz uses: release-plz/action@v0.5 with: @@ -46,6 +47,7 @@ jobs: fetch-depth: 0 - name: Install Rust toolchain uses: dtolnay/rust-toolchain@stable + - uses: Swatinem/rust-cache@v2 - name: Run release-plz uses: release-plz/action@v0.5 with: @@ -60,6 +62,7 @@ jobs: - name: Checkout repository uses: actions/checkout@v6 - uses: dtolnay/rust-toolchain@stable + - uses: Swatinem/rust-cache@v2 - name: Install cargo-llvm-cov run: cargo install cargo-llvm-cov - name: Generate code coverage diff --git a/Cargo.lock b/Cargo.lock index 22d8667..c882184 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -4,9 +4,9 @@ version = 4 [[package]] name = "anyhow" -version = "1.0.101" +version = "1.0.102" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "5f0e0fee31ef5ed1ba1316088939cea399010ed7731dba877ed44aeb407a75ea" +checksum = "7f202df86484c868dbad7eaa557ef785d5c66295e41b460ef922eca0723b842c" [[package]] name = "autocfg" @@ -535,18 +535,18 @@ checksum = "7da8b5736845d9f2fcb837ea5d9e2628564b3b043a70948a3f0b778838c5fb4f" [[package]] name = "strum" -version = "0.27.2" +version = "0.28.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "af23d6f6c1a224baef9d3f61e287d2761385a5b88fdab4eb4c6f11aeb54c4bcf" +checksum = "9628de9b8791db39ceda2b119bbe13134770b56c138ec1d3af810d045c04f9bd" dependencies = [ "strum_macros", ] [[package]] name = "strum_macros" -version = "0.27.2" +version = "0.28.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "7695ce3845ea4b33927c055a39dc438a45b059f7c1b3d91d38d10355fb8cbca7" +checksum = "ab85eea0270ee17587ed4156089e10b9e6880ee688791d45a905f5b1ca36f664" dependencies = [ "heck", "proc-macro2", @@ -556,9 +556,9 @@ dependencies = [ [[package]] name = "syn" -version = "2.0.115" +version = "2.0.117" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "6e614ed320ac28113fa64972c4262d5dbc89deacdfd00c34a3e4cea073243c12" +checksum = "e665b8803e7b1d2a727f4023456bbbbe74da67099c585258af0ad9c5013b9b99" dependencies = [ "proc-macro2", "quote", @@ -606,9 +606,9 @@ checksum = "eaea85b334db583fe3274d12b4cd1880032beab409c0d774be044d4480ab9a94" [[package]] name = "unicode-ident" -version = "1.0.23" +version = "1.0.24" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "537dd038a89878be9b64dd4bd1b260315c1bb94f4d784956b81e27a088d9a09e" +checksum = "e6e4313cd5fcd3dad5cafa179702e2b244f760991f45397d14d4ebf38247da75" [[package]] name = "unicode-xid" diff --git a/Cargo.toml b/Cargo.toml index 7f863e6..fd639d1 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -7,7 +7,7 @@ categories = ["game-development"] description = "A generic library for card games and related topics" documentation = "https://docs.rs/shuftlib" keywords = ["cards", "card_games"] -license = "MIT OR Apache-2.0" +license = "AGPL-3.0-only" readme = "README.md" repository = "https://github.com/shuftle/shuftlib" @@ -15,11 +15,11 @@ repository = "https://github.com/shuftle/shuftlib" path = "src/lib.rs" [dependencies] -anyhow = "1.0.101" +anyhow = "1.0.102" bon = "3.9.0" num-rational = "0.4.2" rand="0.10" -strum = {version="0.27", default-features=false, features=["derive"]} +strum = {version="0.28", default-features=false, features=["derive"]} thiserror = "2.0" [features] diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..be3f7b2 --- /dev/null +++ b/LICENSE @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +. diff --git a/LICENSE-APACHE b/LICENSE-APACHE deleted file mode 100644 index d9a10c0..0000000 --- a/LICENSE-APACHE +++ /dev/null @@ -1,176 +0,0 @@ - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - 1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) 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. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - - END OF TERMS AND CONDITIONS diff --git a/LICENSE-MIT b/LICENSE-MIT deleted file mode 100644 index 9cf1062..0000000 --- a/LICENSE-MIT +++ /dev/null @@ -1,19 +0,0 @@ -MIT License - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. diff --git a/README.md b/README.md index 0950454..cf86ecd 100644 --- a/README.md +++ b/README.md @@ -26,4 +26,6 @@ Documentation is at [docs.rs/shuftlib](https://docs.rs/shuftlib). ## License -Licensed under either the MIT License or the Apache License 2.0. +Licensed under the GNU Affero General Public License v3.0 (AGPL-3.0-only). + +See the [LICENSE](LICENSE) file for details. diff --git a/deny.toml b/deny.toml index 5749a51..abe7c29 100644 --- a/deny.toml +++ b/deny.toml @@ -89,6 +89,7 @@ ignore = [ # See https://spdx.org/licenses/ for list of possible licenses # [possible values: any SPDX 3.11 short identifier (+ optional exception)]. allow = [ + "AGPL-3.0-only", "MIT", "Apache-2.0", "Apache-2.0 WITH LLVM-exception", diff --git a/flake.lock b/flake.lock index 5985718..a897283 100644 --- a/flake.lock +++ b/flake.lock @@ -20,11 +20,11 @@ }, "nixpkgs": { "locked": { - "lastModified": 1765186076, - "narHash": "sha256-hM20uyap1a0M9d344I692r+ik4gTMyj60cQWO+hAYP8=", + "lastModified": 1771369470, + "narHash": "sha256-0NBlEBKkN3lufyvFegY4TYv5mCNHbi5OmBDrzihbBMQ=", "owner": "NixOS", "repo": "nixpkgs", - "rev": "addf7cf5f383a3101ecfba091b98d0a1263dc9b8", + "rev": "0182a361324364ae3f436a63005877674cf45efb", "type": "github" }, "original": { @@ -62,11 +62,11 @@ "nixpkgs": "nixpkgs_2" }, "locked": { - "lastModified": 1765507345, - "narHash": "sha256-fq34mBLvAgv93EuZjGp7cVV633pxnph9AVuB/Ql5y5Q=", + "lastModified": 1771729765, + "narHash": "sha256-HNsDSR5bhLSrIpi9bTb2uTK1qnPo1xFSBxs6YmFyprk=", "owner": "oxalica", "repo": "rust-overlay", - "rev": "a9471b23bf656d69ceb2d5ddccdc5082d51fc0e3", + "rev": "be926cb1a76e8450ab2b92121b2e88d09fa4d41c", "type": "github" }, "original": { diff --git a/flake.nix b/flake.nix index 603a4be..d0a15f0 100644 --- a/flake.nix +++ b/flake.nix @@ -30,6 +30,7 @@ cargo-machete cargo-deny cargo-edit + cargo-semver-checks rust-analyzer rust-bin.stable.latest.default ]; diff --git a/src/core/deck.rs b/src/core/deck.rs index 0f0ddf4..b30ab5c 100644 --- a/src/core/deck.rs +++ b/src/core/deck.rs @@ -456,7 +456,7 @@ mod tests { proptest! { #[test] fn shuffle_preserves_cards( - mut deck in deck_strategy(0..=39) + mut deck in deck_strategy(0..40) ) { let original: Vec = deck.as_slice().to_vec(); deck.shuffle(); @@ -473,7 +473,7 @@ mod tests { #[test] fn draw_all_cards_yields_unique( - mut deck in deck_strategy(0..=39) + mut deck in deck_strategy(0..40) ) { let mut seen = std::collections::HashSet::new(); while let Some(card) = deck.draw() { @@ -494,7 +494,7 @@ mod tests { #[test] fn shuffle_card_inserts_card( card in (italian_rank_strategy(), suit_strategy()), - mut deck in deck_strategy(0..=39) + mut deck in deck_strategy(0..40) ) { let card = ItalianCard::new(card.0, card.1); let old_len: usize = deck.len(); @@ -505,7 +505,7 @@ mod tests { #[test] fn shuffle_card_never_inserts_at_top_or_bottom_for_large_deck( - mut deck in deck_strategy(2..=40), + mut deck in deck_strategy(2..40), card in (italian_rank_strategy(), suit_strategy()) ) { let card = ItalianCard::new(card.0, card.1); @@ -521,15 +521,15 @@ mod tests { /// Test utilities for the deck module. #[cfg(test)] pub mod test_utils { + use std::ops::Range; + use super::*; use crate::core::Suit; use crate::core::italian::{ItalianCard, ItalianRank}; use proptest::prelude::*; /// Generates a Deck with unique cards, of size in the given range. - pub fn deck_strategy( - size: std::ops::RangeInclusive, - ) -> impl Strategy> { + pub fn deck_strategy(size: Range) -> impl Strategy> { // All possible unique cards let all_cards: Vec = [ ItalianRank::Ace, diff --git a/src/core/italian.rs b/src/core/italian.rs index dae7baa..1d928f8 100644 --- a/src/core/italian.rs +++ b/src/core/italian.rs @@ -103,4 +103,18 @@ pub mod test_utils { Just(ItalianRank::King), ] } + + /// Generates a random Italian card strategy for property testing. + pub fn italian_card_strategy() -> impl Strategy { + ( + italian_rank_strategy(), + prop_oneof![ + Just(super::super::Suit::Hearts), + Just(super::super::Suit::Clubs), + Just(super::super::Suit::Spades), + Just(super::super::Suit::Diamonds), + ], + ) + .prop_map(|(rank, suit)| super::ItalianCard::new(rank, suit)) + } } diff --git a/src/tressette/game.rs b/src/tressette/game.rs index 7f35c24..95ed47c 100644 --- a/src/tressette/game.rs +++ b/src/tressette/game.rs @@ -1,9 +1,12 @@ //! High-level game state management for Tressette. -use crate::core::{ - Suit, - deck::Deck, - trick_taking::{Hand, OngoingHand, OngoingTrick, PLAYERS, PlayerId, TrickTakingGame}, +use crate::{ + core::{ + Suit, + deck::Deck, + trick_taking::{Hand, OngoingHand, OngoingTrick, PLAYERS, PlayerId, TrickTakingGame}, + }, + trick_taking::Player, }; use super::{TressetteCard, TressetteRules}; @@ -41,8 +44,8 @@ pub enum Status { Ongoing, /// The game is finished. Finished { - /// The winning team, or `None` if it's a draw (which doesn't happen in Tressette). - winner: Option, + /// The winning team (team_0_2 or team_1_3). + winner: u8, }, } @@ -58,8 +61,10 @@ pub enum Error { player: PlayerId, }, /// The player must follow suit but did not. - #[error("Must follow suit: {required_suit}")] + #[error("Must follow suit: played {suit} but {required_suit} is required")] MustFollowSuit { + /// Attempted Suit. + suit: Suit, /// The suit that must be followed. required_suit: Suit, }, @@ -78,12 +83,12 @@ pub enum Error { /// This includes the players' hands, the current trick, scores, history, and other game state. #[derive(Debug, Clone, bon::Builder)] pub struct Game { - hands: [Vec; PLAYERS], + deck: Deck, + players: [Player; PLAYERS], current_hand: OngoingHand, - next_to_play: PlayerId, - trick_leader: PlayerId, + /// The player who is dealing the current hand. + dealing_player: PlayerId, score: (u8, u8), - hands_completed: usize, completed_hands: Vec>, history: Vec<(TressetteCard, MoveEffect)>, } @@ -99,17 +104,30 @@ impl Game { /// let game = Game::new(); /// assert_eq!(game.score(), (0, 0)); /// ``` + #[allow(clippy::expect_used)] + /// # Panics + /// + /// Panics if the random number generator produces a value outside the valid range for PlayerID. + /// This should never happen in practice. pub fn new() -> Self { + let dealing_player = PlayerId::try_from(rand::random_range(0..3)) + .expect("Failed to create random PlayerID. This is a bug."); let mut game = Self { - hands: [vec![], vec![], vec![], vec![]], + players: [ + Player::new(PlayerId::PLAYER_0), + Player::new(PlayerId::PLAYER_1), + Player::new(PlayerId::PLAYER_2), + Player::new(PlayerId::PLAYER_3), + ], current_hand: OngoingHand::new(), - next_to_play: PlayerId::PLAYER_0, - trick_leader: PlayerId::PLAYER_0, score: (0, 0), - hands_completed: 0, completed_hands: Vec::new(), history: Vec::new(), + dealing_player, + deck: TressetteRules::deck(), }; + game.initialize_new_hand(); + game.deck.shuffle(); game.deal(); game } @@ -124,8 +142,16 @@ impl Game { /// let game = Game::new(); /// let player = game.current_player(); /// ``` + /// # Panics + /// + /// Panics if the current trick is not initialized. This indicates a bug in the game logic. + #[allow(clippy::expect_used)] pub fn current_player(&self) -> PlayerId { - self.next_to_play + self.current_hand + .current_trick() + .as_ref() + .expect("Current trick was not initialized. This is a bug.") + .next_to_play() } /// Returns the current scores: (team_0_2_score, team_1_3_score). @@ -144,6 +170,10 @@ impl Game { /// Returns the current status of the game. /// + /// # Panics + /// + /// It can only panic in case of a bug. + /// /// # Examples /// /// ``` @@ -152,14 +182,17 @@ impl Game { /// let game = Game::new(); /// assert_eq!(game.status(), Status::Ongoing); /// ``` + #[allow(clippy::expect_used)] pub fn status(&self) -> Status { - if TressetteRules::is_completed(self.score) { + if TressetteRules::is_game_over(self.score) { let winner = if self.score.0 > self.score.1 { - Some(0) + 0 } else if self.score.1 > self.score.0 { - Some(1) + 1 } else { - None + unreachable!( + "The score of the teams is the same, but the game is completed. This is a bug" + ); }; Status::Finished { winner } } else { @@ -180,7 +213,7 @@ impl Game { /// assert_eq!(hand.len(), 10); /// ``` pub fn hand(&self, player: PlayerId) -> &[TressetteCard] { - &self.hands[player.as_usize()] + self.players[player.as_usize()].hand() } /// Returns the cards currently played in the ongoing trick. @@ -210,13 +243,21 @@ impl Game { /// /// ``` /// use shuftlib::tressette::Game; - /// use shuftlib::trick_taking::PlayerId; + /// use shuftlib::trick_taking::{PlayerId, PLAYERS}; /// /// let game = Game::new(); - /// assert_eq!(game.trick_leader(), PlayerId::PLAYER_0); + /// assert!(game.trick_leader().as_usize() < PLAYERS); /// ``` + /// # Panics + /// + /// Panics if the current trick is not initialized. This indicates a bug in the game logic. + #[allow(clippy::expect_used)] pub fn trick_leader(&self) -> PlayerId { - self.trick_leader + self.current_hand + .current_trick() + .as_ref() + .expect("Current trick was not initialized. This is a bug.") + .first_to_play() } /// Returns the number of tricks completed in the current hand. @@ -248,7 +289,7 @@ impl Game { /// assert_eq!(game.hands_completed(), 0); /// ``` pub fn hands_completed(&self) -> usize { - self.hands_completed + self.completed_hands.len() } /// Returns all legal cards for the current player. @@ -269,7 +310,7 @@ impl Game { return vec![]; } - let hand = &self.hands[self.next_to_play.as_usize()]; + let hand = self.players[self.current_player().as_usize()].hand(); let leading_suit = self .current_hand @@ -279,14 +320,18 @@ impl Game { match leading_suit { Some(suit) => { - let same_suit: Vec<_> = hand.iter().filter(|c| c.suit() == suit).copied().collect(); + let same_suit: Vec<_> = hand + .iter() + .filter(|&&c| c.suit() == suit) + .copied() + .collect(); if same_suit.is_empty() { - hand.clone() + hand.to_vec() } else { same_suit } } - None => hand.clone(), + None => hand.to_vec(), } } @@ -329,6 +374,10 @@ impl Game { /// - The card is not in the current player's hand ([`Error::CardNotInHand`]). /// - The player must follow suit but didn't ([`Error::MustFollowSuit`]). /// - Internal state is inconsistent ([`Error::InternalError`]). + /// # Panics + /// + /// Panics if a card that was validated to be in the player's hand cannot be found. + /// This indicates a bug in the validation logic. pub fn play_card(&mut self, card: TressetteCard) -> Result { // Check game not over if matches!(self.status(), Status::Finished { .. }) { @@ -337,29 +386,37 @@ impl Game { // Validate card if !self.is_legal_card(card) { - let hand = &self.hands[self.next_to_play.as_usize()]; + let hand = self.players[self.current_player().as_usize()].hand(); if !hand.contains(&card) { return Err(Error::CardNotInHand { card, - player: self.next_to_play, + player: self.current_player(), }); } else { // Compute required suit let required_suit = self .leading_suit() .ok_or(Error::InternalError("No leading suit".to_string()))?; - return Err(Error::MustFollowSuit { required_suit }); + return Err(Error::MustFollowSuit { + required_suit, + suit: card.suit(), + }); } } // Apply move - let player_idx = self.next_to_play.as_usize(); - self.hands[player_idx].retain(|&c| c != card); + let player = &mut self.players[self.current_player().as_usize()]; + #[allow(clippy::expect_used)] + let card_idx = player + .hand() + .iter() + .position(|&c| c == card) + .expect("Card should be in hand"); + player.remove_card(card_idx); // Add to trick if let Some(ot) = self.current_hand.current_trick_mut().as_mut() { ot.play(card); - self.next_to_play = ot.next_to_play(); } else { // Should not happen return Err(Error::InternalError("No current trick".to_string())); @@ -460,16 +517,12 @@ impl Game { .ok_or_else(|| Error::InternalError("No space for trick".to_string()))?; self.current_hand.add(trick, trick_index); - // Update state - self.trick_leader = winner; - self.next_to_play = winner; - // Start new trick self.current_hand .set_current_trick(Some(OngoingTrick::new(winner))); // Check if hand is complete (all cards played) - if self.hands.iter().all(|h| h.is_empty()) { + if self.players.iter().all(|p| p.hand().is_empty()) { self.complete_hand(winner) } else { Ok(MoveEffect::TrickCompleted { winner }) @@ -478,61 +531,70 @@ impl Game { fn complete_hand(&mut self, last_trick_winner: PlayerId) -> Result { // Finish the current hand - let hand = std::mem::take(&mut self.current_hand) + let hand = self + .current_hand + // TODO: is it possible to remove this clone? + .clone() .finish() .ok_or_else(|| Error::InternalError("Hand not complete".to_string()))?; - // Compute and update scores - let rules = TressetteRules {}; - let (score_0, score_1) = rules.score_hand(&hand); - self.score.0 += score_0; - self.score.1 += score_1; + let (team1, team2) = TressetteRules::score_hand(&hand); + self.score.0 += team1; + self.score.1 += team2; // Store completed hand self.completed_hands.push(hand); - self.hands_completed += 1; + // Store cards back into the deck + self.collect_cards(); // Check if game is over - let rules = TressetteRules {}; - if rules.is_game_over(self.score) { + if TressetteRules::is_game_over(self.score) { Ok(MoveEffect::GameOver { trick_winner: last_trick_winner, final_score: self.score, }) } else { - let score = self.score; - // Auto-deal next hand + self.initialize_new_hand(); self.deal(); Ok(MoveEffect::HandComplete { trick_winner: last_trick_winner, - score, + score: self.score, }) } } - fn deal(&mut self) { - // Clear hands - for hand in &mut self.hands { - hand.clear(); + /// Collects all cards from the last completed hand back into the deck. + fn collect_cards(&mut self) { + if let Some(last_hand) = self.completed_hands.last() { + last_hand + .tricks() + .iter() + .flat_map(|t| t.cards().iter()) + .for_each(|&c| self.deck.push(c)); } + } - // Shuffle and deal - let mut deck = Deck::italian(); - deck.shuffle(); - - let rules = TressetteRules {}; - let hand_size = rules.hand_size(); - let total_cards = PLAYERS * hand_size; + /// Deals cards to all players. + fn deal(&mut self) { + let mut to_deal_to = self.dealing_player + 1; - for (i, card) in deck.iter().take(total_cards).cloned().enumerate() { - self.hands[i % PLAYERS].push(TressetteCard::from(card)); + while !self.deck.is_empty() { + if let Some(cards) = self.deck.draw_n(5) { + for card in cards { + self.players[to_deal_to.as_usize()].give(card); + } + to_deal_to.inc(); + } } + } - // Reset hand state + /// Resets the hand state and prepares for a new hand. + fn initialize_new_hand(&mut self) { self.current_hand = OngoingHand::new(); + self.dealing_player.inc(); self.current_hand - .set_current_trick(Some(OngoingTrick::new(self.trick_leader))); + .set_current_trick(Some(OngoingTrick::new(self.dealing_player + 1))); } } @@ -586,11 +648,11 @@ mod tests { let hearts_ace = TressetteCard::new(ItalianRank::Ace, Suit::Hearts); let spades_two = TressetteCard::new(ItalianRank::Two, Suit::Spades); - game.hands[1] = vec![hearts_ace, spades_two]; + game.players[1].give(hearts_ace); + game.players[1].give(spades_two); let mut ongoing_trick = OngoingTrick::new(PlayerId::PLAYER_0); - ongoing_trick.set_card(PlayerId::PLAYER_0, hearts_ace); + ongoing_trick.play(hearts_ace); game.current_hand.set_current_trick(Some(ongoing_trick)); - game.next_to_play = PlayerId::PLAYER_1; // Player has hearts, must play hearts let result = game.play_card(spades_two); @@ -635,11 +697,11 @@ mod tests { prop_assert!(game.score().1 <= 50); let mut total_hand_size = 0; - for player in 0..PLAYERS { + for (player, prev_size) in prev_hand_sizes.iter_mut().enumerate().take(PLAYERS) { let hand_len = game.hand(PlayerId::try_from(player).unwrap()).len(); // Hand size should decrease every time. - prop_assert!(hand_len <= prev_hand_sizes[player]); - prev_hand_sizes[player] = hand_len; + prop_assert!(hand_len <= *prev_size); + *prev_size = hand_len; total_hand_size += hand_len; } // Making sure new cards don't come out of oblivion diff --git a/src/tressette/rules.rs b/src/tressette/rules.rs index 6112902..0815f7a 100644 --- a/src/tressette/rules.rs +++ b/src/tressette/rules.rs @@ -1,5 +1,6 @@ use crate::core::{ Suit, + deck::Deck, trick_taking::{Hand, OngoingTrick, PLAYERS, Player, PlayerId, TrickTakingGame}, }; use num_rational::Rational32; @@ -67,8 +68,8 @@ impl TrickTakingGame for TressetteRules { /// TressetteCard::new(ItalianRank::Four, Suit::Hearts), /// ]; /// - /// let taker = TressetteRules::determine_taker(&cards, PlayerId::try_from(2).unwrap()); - /// assert_eq!(taker, PlayerId::try_from(2).unwrap()); + /// let taker = TressetteRules::determine_taker(&cards, PlayerId::PLAYER_2); + /// assert_eq!(taker, PlayerId::PLAYER_2); /// ``` #[allow(clippy::expect_used)] fn determine_taker(cards: &[TressetteCard; PLAYERS], first_to_play: PlayerId) -> PlayerId { @@ -83,14 +84,44 @@ impl TrickTakingGame for TressetteRules { PlayerId::try_from(taker).expect("Initialization of a new PlayerId failed. This shouldn't have happened, since the input usize was computed starting from a fixed length slice.") } - fn score_hand(&self, hand: &Hand) -> (u8, u8) { - let mut score = (0, 0); - Self::compute_score(hand, &mut score); + fn is_game_over(scores: (u8, u8)) -> bool { + (scores.0 >= SCORE_TO_WIN && scores.0 > scores.1) + || (scores.1 >= SCORE_TO_WIN && scores.1 > scores.0) + } + + fn score_hand(hand: &Hand) -> (u8, u8) { + let mut tmp_score = (Rational32::new(0, 3), Rational32::new(0, 3)); + + let mut taker = 0; + for trick in hand.tricks() { + taker = trick.taker().as_usize(); + if taker == 0 || taker == 2 { + tmp_score.0 += trick.cards().iter().map(|c| c.value()).sum::(); + } else { + tmp_score.1 += trick.cards().iter().map(|c| c.value()).sum::(); + } + } + + let mut score = ( + tmp_score.0.to_integer() as u8, + tmp_score.1.to_integer() as u8, + ); + + // The game awards 1 extra point to the taker of the last trick. + if taker == 0 || taker == 2 { + score.0 += 1; + } else { + score.1 += 1; + } + score } - fn is_game_over(&self, scores: (u8, u8)) -> bool { - Self::is_completed(scores) + fn deck() -> Deck { + Deck::italian() + .into_iter() + .map(TressetteCard::from) + .collect() } } @@ -100,12 +131,6 @@ pub const SCORE_TO_WIN: u8 = 31; impl TressetteRules { /// Number of cards dealt to each player at the start of a Tressette hand. pub const HAND_SIZE: usize = 10; - /// Determines if a team won the game. A team wins the game when its score is - /// greater than 31 and has a higher score than the other team. - pub fn is_completed(score: (u8, u8)) -> bool { - (score.0 >= SCORE_TO_WIN && score.0 > score.1) - || (score.1 >= SCORE_TO_WIN && score.1 > score.0) - } /// Returns playable cards along with their indices in the player's hand. /// @@ -229,31 +254,6 @@ impl TressetteRules { ongoing_trick.play(card); Ok(card) } - - /// Computes the score for a hand of the tressette game. - /// Score is always a maximum of 11 points. - pub fn compute_score(hand: &Hand, score: &mut (u8, u8)) { - let mut tmp_score = (Rational32::new(0, 3), Rational32::new(0, 3)); - - let mut taker = 0; - for trick in hand.tricks() { - taker = trick.taker().as_usize(); - if taker == 0 || taker == 2 { - tmp_score.0 += trick.cards().iter().map(|c| c.value()).sum::(); - } else { - tmp_score.1 += trick.cards().iter().map(|c| c.value()).sum::(); - } - } - - score.0 += tmp_score.0.to_integer() as u8; - score.1 += tmp_score.1.to_integer() as u8; - - if taker == 0 || taker == 2 { - score.0 += 1; - } else { - score.1 += 1; - } - } } #[cfg(test)] @@ -316,39 +316,39 @@ mod test_utils { mod tests { use proptest::prelude::*; - use crate::core::Suit; use crate::trick_taking::PlayerId; + use crate::{core::Suit, trick_taking::TrickTakingGame}; use super::{SCORE_TO_WIN, TressetteRules}; proptest! { #[test] fn a_team_won_with_both_below(team1_score in 0u8..SCORE_TO_WIN, team2_score in 0u8..SCORE_TO_WIN) { - let result = TressetteRules::is_completed((team1_score, team2_score)); + let result = TressetteRules::is_game_over((team1_score, team2_score)); assert!(!result); } #[test] fn a_team_won_with_both_above_and_same(score in SCORE_TO_WIN..u8::MAX) { - let result = TressetteRules::is_completed((score, score)); + let result = TressetteRules::is_game_over((score, score)); assert!(!result); } #[test] fn a_team_won_with_both_above_and_different(score in SCORE_TO_WIN..u8::MAX) { - let result = TressetteRules::is_completed((score, score + 1)); + let result = TressetteRules::is_game_over((score, score + 1)); assert!(result); } #[test] fn a_team_won_with_team1_above(team1_score in 0u8..SCORE_TO_WIN, team2_score in SCORE_TO_WIN..u8::MAX) { - let result = TressetteRules::is_completed((team1_score, team2_score)); + let result = TressetteRules::is_game_over((team1_score, team2_score)); assert!(result); } #[test] fn a_team_won_with_team2_above(team1_score in SCORE_TO_WIN..u8::MAX, team2_score in 0u8..SCORE_TO_WIN ) { - let result = TressetteRules::is_completed((team1_score, team2_score)); + let result = TressetteRules::is_game_over((team1_score, team2_score)); assert!(result); } diff --git a/src/trick_taking.rs b/src/trick_taking.rs index be3d80c..2696435 100644 --- a/src/trick_taking.rs +++ b/src/trick_taking.rs @@ -6,7 +6,7 @@ //! - Hand completion and scoring mechanics //! - Core trait for implementing different trick-taking games -use crate::core::Card; +use crate::core::{Card, deck::Deck}; /// Number of tricks in all games. pub const TRICKS: usize = 10; @@ -28,27 +28,24 @@ pub trait TrickTakingGame { /// /// Returns the updated scores for both teams: (team_0_2_score, team_1_3_score). /// Default implementation returns unchanged scores. - fn score_hand(&self, _hand: &Hand) -> (u8, u8) + fn score_hand(hand: &Hand) -> (u8, u8) where - Self: Sized, - { - (0, 0) - } + Self: Sized; /// Check if the game is over based on current scores. /// /// Returns true if the game should end with the given scores. /// Default implementation never ends the game. - fn is_game_over(&self, _scores: (u8, u8)) -> bool { - false - } - + fn is_game_over(scores: (u8, u8)) -> bool; /// Get the number of cards dealt to each player at the start of a hand. /// /// Default is 10 cards (standard for Tressette). fn hand_size(&self) -> usize { 10 } + + /// Get a deck as per the rules of the game. + fn deck() -> Deck; } /// Generic player management and identification. diff --git a/src/trick_taking/hand.rs b/src/trick_taking/hand.rs index 9be8e34..ca84077 100644 --- a/src/trick_taking/hand.rs +++ b/src/trick_taking/hand.rs @@ -77,7 +77,6 @@ where G: TrickTakingGame, { current_trick: Option>, - index: usize, tricks: [Option>; TRICKS], } @@ -115,21 +114,6 @@ where &self.tricks } - /// Returns the index of this [`OngoingHand`]. - /// - /// # Examples - /// - /// ``` - /// use shuftlib::trick_taking::OngoingHand; - /// use shuftlib::tressette::TressetteRules; - /// - /// let hand = OngoingHand::::new(); - /// assert_eq!(hand.index(), 0); - /// ``` - pub fn index(&self) -> usize { - self.index - } - /// Transforms an `OngoingHand` into a `Hand`, a read-only data structure /// used to just store the information related to a hand that has been played. /// @@ -144,14 +128,9 @@ where /// use shuftlib::tressette::{TressetteRules, TressetteCard}; /// /// let mut ongoing_hand = OngoingHand::::new(); - /// // Add tricks... - /// // let finished = ongoing_hand.finish(); // Would be None if incomplete + /// assert!(ongoing_hand.finish().is_none()); /// ``` pub fn finish(self) -> Option> { - if self.tricks.iter().any(|t| t.is_none()) { - return None; - } - let tricks: [Trick; TRICKS] = self .tricks .into_iter() @@ -173,7 +152,6 @@ where /// /// let ongoing_hand = OngoingHand::::new(); /// - /// assert_eq!(ongoing_hand.index(), 0); /// assert!(ongoing_hand.current_trick().is_none()); /// ongoing_hand.tricks().iter().for_each(|t| assert!(t.is_none())); /// ``` @@ -181,7 +159,6 @@ where Self { tricks: [const { None }; TRICKS], current_trick: None, - index: 0, } } diff --git a/src/trick_taking/player.rs b/src/trick_taking/player.rs index d35f8d8..fb0a189 100644 --- a/src/trick_taking/player.rs +++ b/src/trick_taking/player.rs @@ -1,4 +1,4 @@ -use std::fmt::Display; +use std::{fmt::Display, ops::Add}; use anyhow::bail; @@ -208,6 +208,15 @@ impl PlayerId { } } +impl Add for PlayerId { + type Output = Self; + + fn add(self, rhs: usize) -> Self::Output { + let sum = self.0 + rhs; + PlayerId(sum % PLAYERS) + } +} + impl TryFrom for PlayerId { type Error = anyhow::Error; @@ -216,7 +225,7 @@ impl TryFrom for PlayerId { Ok(PlayerId(value)) } else { bail!( - "Tried to convert {} into a PlayerId, but acceptable values are in range 0..PLAYERS", + "Tried to convert {} into a PlayerId, but acceptable values are in range 0..{PLAYERS}", value ) } @@ -228,3 +237,29 @@ impl Display for PlayerId { write!(f, "{}", self.0) } } + +#[cfg(test)] +mod test_utils { + use proptest::prelude::Strategy; + + use crate::trick_taking::{PLAYERS, PlayerId}; + + pub(crate) fn player_id_strategy() -> impl Strategy { + (0..PLAYERS).prop_map(|id| PlayerId::try_from(id).unwrap()) + } +} + +#[cfg(test)] +mod tests { + use proptest::prelude::*; + + use crate::trick_taking::{PLAYERS, player::test_utils::player_id_strategy}; + proptest! { + #[test] + fn sum_always_gives_valid_playerid(p_id in player_id_strategy(), rhs: usize) { + let sum = p_id + rhs; + + assert!(sum.0 impl Strategy { - ( - prop_oneof![ - Just(ItalianRank::Ace), - Just(ItalianRank::Two), - Just(ItalianRank::Three), - Just(ItalianRank::Four), - Just(ItalianRank::Five), - Just(ItalianRank::Six), - Just(ItalianRank::Seven), - Just(ItalianRank::Jack), - Just(ItalianRank::Knight), - Just(ItalianRank::King), - ], - prop_oneof![ - Just(Suit::Hearts), - Just(Suit::Clubs), - Just(Suit::Spades), - Just(Suit::Diamonds), - ], - ) - .prop_map(|(rank, suit)| ItalianCard::new(rank, suit)) - } + use crate::core::deck::Deck; + pub use crate::core::italian::test_utils::italian_card_strategy; + use crate::trick_taking::{Hand, OngoingTrick, PlayerId, TrickTakingGame}; + use crate::{core::italian::ItalianCard, trick_taking::PLAYERS}; + /// A minimal test implementation of TrickTakingGame for testing purposes. + /// + /// This implementation always determines PLAYER_0 as the trick taker. #[derive(Clone, Copy, Debug)] pub struct TestGame {} @@ -347,17 +318,32 @@ mod test_utils { type CardType = ItalianCard; fn determine_taker( - _cards: &[Self::CardType; super::super::PLAYERS], - _first_to_play: super::super::PlayerId, + _cards: &[Self::CardType; PLAYERS], + _first_to_play: PlayerId, ) -> super::super::PlayerId { PlayerId::PLAYER_0 } + + fn deck() -> Deck { + Deck::italian() + } + + fn score_hand(_hand: &Hand) -> (u8, u8) + where + Self: Sized, + { + (0, 0) + } + + fn is_game_over(_scores: (u8, u8)) -> bool { + true + } } /// Strategy to create an `OngoingTrick` filled with random cards. pub fn ongoing_trick_strategy() -> impl Strategy> { - hash_set(italian_card_strategy(), super::super::PLAYERS).prop_map(|hash_set| { - let mut cards = [None; super::super::PLAYERS]; + hash_set(italian_card_strategy(), PLAYERS).prop_map(|hash_set| { + let mut cards = [None; PLAYERS]; hash_set .iter() .enumerate() diff --git a/tests/tressette.rs b/tests/tressette.rs index eb157f6..2912760 100644 --- a/tests/tressette.rs +++ b/tests/tressette.rs @@ -1,7 +1,7 @@ #![allow(missing_docs)] #![allow(clippy::expect_used)] -use shuftlib::tressette::{Game, MoveEffect, Status}; +use shuftlib::tressette::{Game, MoveEffect, SCORE_TO_WIN, Status}; #[test] fn tressette_works() { @@ -14,7 +14,6 @@ fn tressette_works() { "Should always have legal cards when game is ongoing" ); - // Always pick the first legal card (simple strategy for testing) let chosen_card = legal_cards[0]; let effect = game .play_card(chosen_card) @@ -45,16 +44,8 @@ fn tressette_works() { // Game is over assert_eq!((final_score.0 + final_score.1) % 11, 0); assert_ne!(final_score.0, final_score.1); - assert!( - final_score.0 >= shuftlib::tressette::SCORE_TO_WIN - || final_score.1 >= shuftlib::tressette::SCORE_TO_WIN - ); + assert!(final_score.0 >= SCORE_TO_WIN || final_score.1 >= SCORE_TO_WIN); } } } - - // Verify final state - if let Status::Finished { winner } = game.status() { - assert!(winner.is_some(), "Tressette should never end in a draw"); - } }