squib 0.18.0 → 0.19.0a

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e5921a89334684b7770be1b6d85ef150fd02f5c1b305ae795c0b349ac3e8a6d
-  data.tar.gz: bd29c5c8b101957a1ade535d14a128137185c002195d832d349e51c0aff9fcf4
+  metadata.gz: 6c46d078189e6f5437a524b7750d7db5c9cba2e13874a84a4efa7e9bc5e6814d
+  data.tar.gz: 1998b40afc95370a3d46424f435f6bf69386e53a85ed65baa3837e16b23c647e
 SHA512:
-  metadata.gz: 021b8f98bab301f65e300523447fb4fc172cc12df0d7436da200e716e6dfd87d843b11ac3e07bd8496319eaa62803c59ad1a5ed88d9dc830e8858f99c4288366
-  data.tar.gz: 8c3d7a1b44ac551ce24716ab6da853e1bfcacac55c5ce8ba13a847990c863860cb5bc186832812d8b14aacc774ee96bf3d41057cd65ee966cbad1dda130681e7
+  metadata.gz: ba58529d91f3f59313373fbb6e85652ace3c09e96efc96fec72e0276c1ed4413d651bc0af4ae801ac47b280d8a6712198bca90191e11856442f34446ffb09154
+  data.tar.gz: c6dae28717bb6e2d3e818b8f4ae1d3aa7b7e12a2e0b7b1354c3f3b8136d1a90d18cacd25d5a032e27810f7e9a4108d064d1a62de48ec25bbea6c04afd8c05869

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,39 +1,39 @@
----
-name: Bug report
-about: Report something that seems wrong
-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. My code looks like this...
-2. When I run it like this...
-3. I see this error...
-
-**Expected behavior**
-A clear and concise description of what you expected to happen.
-
-**Screenshots**
-We love screenshots!
-  * Windows: `Print Screen` key and then `ctrl+v` directly into GitHub issues here.
-  * Shift + Command + 3, then `command+v` directly into GitHub issues here.
-
-**Environment**
- - OS: (e.g. Windows 11)
- - Ruby version (e.g. 2.7, 3.0)
-
-**Additional context**
-Add any other context about the problem here.
-
-**Check the following:**
-
-- [ ] I have updated Squib to the latest version.
-- [ ] I have checked the Squib issues backlog for something similar
-- [ ] I have attempted to make a minimal script demonstrating my problem
-- [ ] I have reviewed the [Squib Docs](https://squib.readthedocs.io/) and there's still a problem
+---
+name: Bug report
+about: Report something that seems wrong
+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. My code looks like this...
+2. When I run it like this...
+3. I see this error...
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+We love screenshots!
+  * Windows: `Print Screen` key and then `ctrl+v` directly into GitHub issues here.
+  * Shift + Command + 3, then `command+v` directly into GitHub issues here.
+
+**Environment**
+ - OS: (e.g. Windows 11)
+ - Ruby version (e.g. 2.7, 3.0)
+
+**Additional context**
+Add any other context about the problem here.
+
+**Check the following:**
+
+- [ ] I have updated Squib to the latest version.
+- [ ] I have checked the Squib issues backlog for something similar
+- [ ] I have attempted to make a minimal script demonstrating my problem
+- [ ] I have reviewed the [Squib Docs](https://squib.readthedocs.io/) and there's still a problem

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,22 +1,22 @@
----
-name: Feature request
-about: Suggest an idea for this project
-title: ''
-labels: enhancement
-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. Make an example of what you want the syntax to look like.
-
-**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.
-
- - [ ] I might be interested in implementing this myself
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+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. Make an example of what you want the syntax to look like.
+
+**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.
+
+ - [ ] I might be interested in implementing this myself

data/.github/ISSUE_TEMPLATE/help-wanted.md

@@ -1,13 +1,13 @@
----
-name: Help Wanted - USE GITHUB DISCUSSIONS INSTEAD
-about: Need help doing something in Squib? We prefer you use the (new!) Discussions tab
-title: Help Wanted - USE GITHUB DISCUSSIONS INSTEAD
-labels: help wanted
-assignees: andymeneely
----
-
-Need help doing something in Squib? We prefer you use the (new!) Discussions tab
-
-We prefer that GitHub issues be used for features or bugs.
-
-
+---
+name: Help Wanted - USE GITHUB DISCUSSIONS INSTEAD
+about: Need help doing something in Squib? We prefer you use the (new!) Discussions tab
+title: Help Wanted - USE GITHUB DISCUSSIONS INSTEAD
+labels: help wanted
+assignees: andymeneely
+---
+
+Need help doing something in Squib? We prefer you use the (new!) Discussions tab
+
+We prefer that GitHub issues be used for features or bugs.
+
+

data/.github/ISSUE_TEMPLATE/release-todo.md

@@ -1,34 +1,46 @@
----
-name: Release TODO list
-about: Use this checklist when we release
-title: Release v0.XYZ
-labels: release
-assignees: andymeneely
----
-
-Be sure to remember to do the following for releases.
-
- - [ ] CHANGELOG is written for all new changes
- - [ ] README is updated
- - [ ] Samples are updated
- - [ ] Are all the dependencies up to date?
- - [ ] Check `sample_regression_spec.rb` regression tests are all enabled (i.e. `overwrite_sample` is commented out)
- - [ ] Bump version.rb
- - [ ] Bump docs/conf.py versions
- - [ ] Do a full rake locally
- - [ ] `rake sanity`, and check visually
- - [ ] GitHub Actions is passing on dev branch
- - [ ] Merge master branch
- - [ ] Merge release branch
- - [ ] Push master and release branches
- - [ ] Create GitHub release tag
- - [ ] `gem push pkg/squib-x.y.z.gem`
- - [ ] Github milestone closed
- - [ ] Activate version on squib.readthedocs.org (Versions)
- - [ ] Set default version on squib.readthedocs.org (Advanced Settings)
- - [ ] Bump version.rb to the next alpha
- - [ ] Publish on BoardGameGeek thread
- - [ ] Check Docker build on Dockerhub: https://hub.docker.com/repository/docker/andymeneely/squib
- - [ ] Check Docker docker pull: docker pull andymeneely/squib:latest
- - [ ] Check Docker build locally in samples: docker run --rm -v "%cd%":/usr/src/app andymeneely/squib:latest ruby basic
+---
+name: Release TODO list
+about: Use this checklist when we release
+title: Release v0.XYZ
+labels: release
+assignees: andymeneely
+---
+
+Be sure to remember to do the following for releases.
+
+ - [ ] CHANGELOG is written for all new changes
+ - [ ] README is updated
+ - [ ] Samples are updated
+ - [ ] Are all the dependencies up to date?
+ - [ ] Check `sample_regression_spec.rb` regression tests are all enabled (i.e. `overwrite_sample` is commented out)
+ - [ ] Bump version.rb
+ - [ ] Bump docs/conf.py versions
+ - [ ] Do a full rake locally
+ - [ ] `rake sanity`, and check visually
+ - [ ] GitHub Actions is passing on dev branch
+ - [ ] Merge master branch
+ - [ ] Merge release branch
+ - [ ] Push master and release branches
+ - [ ] Create GitHub release tag
+ - [ ] `gem push pkg/squib-x.y.z.gem`
+ - [ ] Github milestone closed
+ - [ ] Activate version on squib.readthedocs.org (Versions)
+ - [ ] Set default version on squib.readthedocs.org (Advanced Settings)
+ - [ ] Bump version.rb to the next alpha
+ - [ ] Publish on BoardGameGeek thread
+ - [ ] Anything else to add to this checklist?
+
+ # Docker
+ - [ ] Check Dockerfile for updates
+ - [ ] `docker build .`
+ - [ ] `docker tag XYZ andymeneely/squib:latest`
+ - [ ] `docker tag XYZ andymeneely/squib:version-0.XYZ.0`
+ - [ ] `docker push andymeneely/squib:latest`
+ - [ ] `docker push andymeneely/squib:version-0.XYZ.0`
+ - [ ] Check Docker build on Dockerhub: https://hub.docker.com/repository/docker/andymeneely/squib
+ - [ ] Check Docker docker pull: docker pull andymeneely/squib:latest
+ - [ ] Check Docker build locally in samples:
+  * Delete `samples/_output/basic_*.png`
+  * `docker run --rm -v c:\code\squib\samples:/usr/src/app -w /usr/src/app andymeneely/squib:latest ruby basic.rb`
+  * Check that the files were made
  - [ ] Anything else to add to this checklist?

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -1,13 +1,13 @@
-### Motivation
-
-*Replace this line with why you are making this change.*
-
-### Have you...
-
-  - [ ] Written a sample in `_samples`?
-  - [ ] Updated documentation in the `docs/` folder?
-  - [ ] Linked this PR to an issue?
-  - [ ] Written any automated tests?
-  - [ ] Refactored your code to be maintainable?
-
-The above things are not required, but appreciated.
+### Motivation
+
+*Replace this line with why you are making this change.*
+
+### Have you...
+
+  - [ ] Written a sample in `_samples`?
+  - [ ] Updated documentation in the `docs/` folder?
+  - [ ] Linked this PR to an issue?
+  - [ ] Written any automated tests?
+  - [ ] Refactored your code to be maintainable?
+
+The above things are not required, but appreciated.

data/.github/workflows/tests.yml

@@ -1,22 +1,22 @@
-name: Squib Unit Tests
-
-on: [push, pull_request]
-
-jobs:
-  test:
-    strategy:
-      fail-fast: false
-      matrix:
-        os: [ubuntu, macos]
-        ruby: [2.7, 3.0, head]
-    runs-on: ${{ matrix.os }}-latest
-    continue-on-error: ${{ endsWith(matrix.ruby, 'head') || (matrix.ruby == '3.0' && matrix.os == 'macos')}}
-    steps:
-    - uses: actions/checkout@v2
-    - uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{ matrix.ruby }}
-        # bundler-cache: true # runs 'bundle install' and caches installed gems automatically
-    - run: ruby --version # explicitly show the ruby version
-    - run: bundle install
-    - run: bundle exec rake
+name: Squib Unit Tests
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu, macos]
+        ruby: [2.7, 3.0, head]
+    runs-on: ${{ matrix.os }}-latest
+    continue-on-error: ${{ endsWith(matrix.ruby, 'head') || (matrix.ruby == '3.0' && matrix.os == 'macos')}}
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        # bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - run: ruby --version # explicitly show the ruby version
+    - run: bundle install
+    - run: bundle exec rake

data/.gitignore

@@ -1,41 +1,41 @@
-.DS_Store
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-.inch
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-docs/_build*
-doc/
-docs/_build
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-*.bundle
-*.so
-*.o
-*.a
-mkmf.log
-_img
-samples/_img
-samples/_output/*.png
-samples/_output/*.pdf
-samples/_output/foo
-samples/**/_output/*
-rubocop.txt
-benchmarks/_output/*.png
-benchmarks/_output/*.pdf
-benchmarks/_output/
-samples/_output/*.svg
-*.sublime-workspace
-spec/samples/sanity.html
-spec/samples/_diffs/*.png
-.byebug_history
+.DS_Store
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.inch
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+docs/_build*
+doc/
+docs/_build
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+_img
+samples/_img
+samples/_output/*.png
+samples/_output/*.pdf
+samples/_output/foo
+samples/**/_output/*
+rubocop.txt
+benchmarks/_output/*.png
+benchmarks/_output/*.pdf
+benchmarks/_output/
+samples/_output/*.svg
+*.sublime-workspace
+spec/samples/sanity.html
+spec/samples/_diffs/*.png
+.byebug_history

data/.vscode/settings.json

@@ -1,4 +1,5 @@
-{
-  "restructuredtext.confPath": "${workspaceFolder}\\docs",
-  "restructuredtext.linter.disabled": true
+{
+  "restructuredtext.confPath": "${workspaceFolder}\\docs",
+  "restructuredtext.linter.disabled": true,
+  "esbonio.sphinx.confDir": "${workspaceFolder}\\docs"
 }