diff --git a/.clippy.toml b/.clippy.toml new file mode 100644 index 0000000..429501f --- /dev/null +++ b/.clippy.toml @@ -0,0 +1,5 @@ +# List of lints: +# https://rust-lang.github.io/rust-clippy/master/index.html + +# Don't warn for functions with too many arguments. Default: 7 +too-many-arguments-threshold = 10 diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..30c5192 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,34 @@ +--- +name: Bug report +about: Create a report +title: '' +labels: 'bug' +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Context (please complete the following information):** + - OS/Distro + Version: + - Linux: `lsb_release -a` + - Apple: `sw_vers -productVersion` + - Output of `cargo --version`: + - This crate version: + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..58d6729 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea +title: '' +labels: 'feature-request' +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..ec1ed8a --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,8 @@ + + +This PR fixes/closes issue #N + +It changes the following: diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..f62126b --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,17 @@ +# Auto-update dependencies. +# last updated 2024-03-04 +# demo: https://github.com/dependabot/demo/blob/main/.github/dependabot.yml +--- +version: 2 +updates: + # look for updates to github actions every week + - package-ecosystem: "github-actions" + directory: "/" + schedule: + interval: "weekly" + # look for updates to Cargo.toml dependencies every week + # docs: https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#package-ecosystem + - package-ecosystem: cargo + directory: "/" + schedule: + interval: "weekly" diff --git a/.github/settings.yml b/.github/settings.yml new file mode 100644 index 0000000..7ca27ab --- /dev/null +++ b/.github/settings.yml @@ -0,0 +1,43 @@ +# These settings are synced to GitHub by https://probot.github.io/apps/settings/ +# Requires sign up, and allowing Probot to manage your repos. + +repository: + # name: ronkathon # sets the repo name + description: ronkathon + # homepage: docs.rs/ronkathon + private: false + has_issues: true + has_projects: false + has_wiki: false + has_downloads: false + default_branch: main + allow_squash_merge: true + allow_merge_commit: false + allow_rebase_merge: false + +# # Labels: define labels for Issues and Pull Requests +# labels: +# - name: bug +# color: CC0000 +# - name: feature +# color: 336699 +# - name: first-timers-only +# # include the old name to rename and existing label +# oldname: Help Wanted + +# # Collaborators: give specific users access to this repository. +# collaborators: +# - username: bkeepers +# # Note: Only valid on organization-owned repositories. +# # The permission to grant the collaborator. Can be one of: +# # * `pull` - can pull, but not push to or administer this repository. +# # * `push` - can pull and push, but not administer this repository. +# # * `admin` - can pull, push and administer this repository. +# permission: push + +# - username: hubot +# permission: pull +# - username: +# permission: pull + + diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..d063fba --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,53 @@ +# Rust template: https://github.com/actions/starter-workflows/blob/main/ci/rust.yml +# Resources: https://docs.github.com/en/actions +# Examples: https://github.com/actions/starter-workflows +# Process: make small changes, push them, check the Actions tab on github +# also see templates https://github.com/rust-github/template/tree/main/.github/workflows +name: Rust +on: + push: + branches: [ "main" ] + pull_request: + branches: [ "main" ] + +env: + CARGO_TERM_COLOR: always # pretty colors + +jobs: + lint: + name: lint project + runs-on: ubuntu-latest + strategy: + matrix: + toolchain: + - nightly + steps: + - uses: actions/checkout@v4 + - run: rustup update ${{ matrix.toolchain }} && rustup default ${{ matrix.toolchain }} + - run: rustup component add clippy + - run: cargo clippy -- -Dwarnings + test: + name: test project + runs-on: ubuntu-latest + strategy: + matrix: + toolchain: + - nightly + steps: + - uses: actions/checkout@v4 + - run: rustup update ${{ matrix.toolchain }} && rustup default ${{ matrix.toolchain }} + - run: cargo test --all-features --verbose + + fmt: + name: fmt project + runs-on: ubuntu-latest + strategy: + matrix: + toolchain: + - nightly + steps: + - uses: actions/checkout@v4 + - run: rustup update ${{ matrix.toolchain }} && rustup default ${{ matrix.toolchain }} + - run: rustup component add rustfmt + - run: cargo fmt --all -- --check + diff --git a/.github/workflows/dependabot_automerge.yml b/.github/workflows/dependabot_automerge.yml new file mode 100644 index 0000000..0fd990a --- /dev/null +++ b/.github/workflows/dependabot_automerge.yml @@ -0,0 +1,27 @@ +# Set permissions to auto-merge updates. +# set 2024-03-04 +# https://docs.github.com/en/code-security/dependabot/working-with-dependabot/automating-dependabot-with-github-actions#enable-auto-merge-on-a-pull-request + +name: Dependabot auto-merge +on: pull_request + +permissions: + contents: write + pull-requests: write + +jobs: + dependabot: + runs-on: ubuntu-latest + if: github.actor == 'dependabot[bot]' + steps: + - name: Dependabot metadata + id: metadata + uses: dependabot/fetch-metadata@v1 + with: + github-token: "${{ secrets.GITHUB_TOKEN }}" + - name: Enable auto-merge for Dependabot PRs + if: steps.metadata.outputs.update-type == 'version-update:semver-patch' + run: gh pr merge --auto --merge "$PR_URL" + env: + PR_URL: ${{github.event.pull_request.html_url}} + GH_TOKEN: ${{secrets.GITHUB_TOKEN}} diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..1785abb --- /dev/null +++ b/.gitignore @@ -0,0 +1,27 @@ +### Rust ### +# ref: https://github.com/github/gitignore/blob/main/Rust.gitignore +cgt* # ignore instatiations of my test template + +# don't leak secret env vars +.env + +# exclude compiled files and binaries +debug/ +target/ + +# Remove Cargo.lock from gitignore if creating an executable, leave it for libraries +Cargo.lock + +.vscode +.viscode + +# These are backup files generated by rustfmt +**/*.rs.bk +# MSVC Windows builds of rustc generate these, which store debugging information +*.pdb + +dump + +### VIM ### +*.swp +*.swo diff --git a/.rustfmt.toml b/.rustfmt.toml new file mode 100644 index 0000000..a6271c6 --- /dev/null +++ b/.rustfmt.toml @@ -0,0 +1,44 @@ +# Opinionated whitespace and tabs. The most important of these are imports and width settings. +# Others may want to borrow or change these to their own liking. +# https://rust-lang.github.io/rustfmt + +# version-related +edition = "2021" # redundant, fmt will read Cargo.toml for editor edition year +unstable_features = true +use_try_shorthand = true # replace any `try!` (2015 Rust) with `?` + +# misc formatting +condense_wildcard_suffixes = true # replace: (a,b,_,_)=(1, 2, 3, 4); -> (a,b,..)=(1, 2, 3, 4); +format_code_in_doc_comments = true # format code blocks in doc comments +format_macro_matchers = true # $a: ident -> $a:ident +format_strings = true # break and insert newlines for long string literals +match_block_trailing_comma = true # include comma in match blocks after '}' +normalize_comments = true # convert /*..*/ to //.. where possible +reorder_impl_items = true # move `type` and `const` declarations to top of impl block +struct_field_align_threshold = 20 # align struct arguments' types vertically +use_field_init_shorthand = true # struct initialization short {x: x} -> {x} + +# reduce whitespace +blank_lines_upper_bound = 1 # default: 1. Sometimes useful to change to 0 to condense a file. +brace_style = "PreferSameLine" # prefer starting `{` without inserting extra \n +fn_single_line = true # if it's a short 1-liner, let it be a short 1-liner +match_arm_blocks = false # remove unnecessary {} in match arms +newline_style = "Unix" # not auto, we won the culture war. \n over \r\n +overflow_delimited_expr = true # prefer ]); to ]\n); +where_single_line = true # put where on a single line if possible + +# imports preferences +group_imports = "StdExternalCrate" # create import groupings for std, external libs, and internal deps +imports_granularity = "Crate" # aggressively group imports + +# width settings: everything to 100 +comment_width = 100 # default: 80 +inline_attribute_width = 60 # inlines #[cfg(test)]\nmod test -> #[cfg(test)] mod test +max_width = 100 # default: 100 +use_small_heuristics = "Max" # don't ever newline short of `max_width`. +wrap_comments = true # wrap comments at `comment_width` +# format_strings = true # wrap strings at `max_length` + +# tabs and spaces +hard_tabs = false # (def: false) use spaces over tabs +tab_spaces = 2 # 2 > 4, it's just math. diff --git a/.taplo.toml b/.taplo.toml new file mode 100644 index 0000000..e88b1f4 --- /dev/null +++ b/.taplo.toml @@ -0,0 +1,20 @@ +# .toml file formatting settings for `taplo` +# https://taplo.tamasfe.dev/configuration/formatter-options.html + +[formatting] +# align entries vertically +align_entries = true +# allow up to 1 consecutive empty line (default: 2) +allowed_blank_lines = 1 +# collapse arrays into one line if they fit +array_auto_collapse = true +# default: 80 +column_width = 100 +# remove whitespace around '=' +compact_entries = true +# alphabetically sort entries not separated by line breaks +reorder_keys = false +# align entries vertically (default: true) +# align_comments =false +# expand arrays into multiple lines (default: true) +# array_auto_expand =false diff --git a/APACHE2 b/APACHE2 new file mode 100644 index 0000000..074e069 --- /dev/null +++ b/APACHE2 @@ -0,0 +1,203 @@ + + 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 + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2024 Pluto Authors + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + diff --git a/Cargo.toml b/Cargo.toml new file mode 100644 index 0000000..5ae5527 --- /dev/null +++ b/Cargo.toml @@ -0,0 +1,11 @@ +[package] +authors =["Pluto Authors"] +description="""ronkathon""" +edition ="2021" +license ="Apache2.0 OR MIT" +name ="ronkathon" +repository ="https://github.com/thor314/ronkathon" +version ="0.1.0" + +[dependencies] +anyhow ="1.0" diff --git a/LICENSE-MIT b/LICENSE-MIT new file mode 100644 index 0000000..5db671b --- /dev/null +++ b/LICENSE-MIT @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2024 Pluto authors + +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 4829a0b..156e0d2 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,26 @@ -# ronkathon -Plonkathon, but in Rust +

+ ronkathon +

+ +

+ ronkathon +

+ +
+ + + + + + +
+ +## License +Licensed under your option of either: +- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0) +- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT) + +## Contribution +Unless you explicitly state otherwise, any contribution intentionally submitted +for inclusion in the work by you, as defined in the Apache-2.0 license, shall be +dual licensed as above, without any additional terms or conditions. diff --git a/rust-toolchain.toml b/rust-toolchain.toml new file mode 100644 index 0000000..5579319 --- /dev/null +++ b/rust-toolchain.toml @@ -0,0 +1,24 @@ +# rustup toolchain config. We typically use nightly to enable better formatting and async support. +# https://rust-lang.github.io/rustup/overrides.html + +[toolchain] +# what toolchain to use. +channel="nightly" + +# option to specify a date to pin to a particular release +# date = "2024-03-19" + +# profiles are groups of components to download when installing a toolchain. +# https://rust-lang.github.io/rustup/concepts/profiles.html +# "minimal" includes only the compiler, package manager, and standard lib. +# "default" further includes the formatter, linter, and documentation generator. +profile="default" + +# Components are additional toolchain utilities. Typically not used unless working with low-level unsafe or compiler-related code. +# List: https://rust-lang.github.io/rustup/concepts/components.html +# components=["miri"] + +# targets are additional platforms to support. Most commonly used for WASM or cross-compiling. +# cross compilation docs: https://rust-lang.github.io/rustup/cross-compilation.html +# list of platforms: https://doc.rust-lang.org/nightly/rustc/platform-support.html +# targets = [ "wasm32-unknown-unknown"] diff --git a/src/lib.rs b/src/lib.rs new file mode 100644 index 0000000..f6e899f --- /dev/null +++ b/src/lib.rs @@ -0,0 +1,7 @@ +#![allow(unused_imports)] +#![allow(unused_variables)] +#![allow(dead_code)] +#![allow(unreachable_code)] +#![allow(non_snake_case)] +#![allow(clippy::clone_on_copy)] +#![allow(unused_mut)]