Merge branch 'develop'

Author: ArtOfCode-

.circleci/config.yml

@@ -1,10 +1,12 @@
 version: 2.1
+orbs:
+  codecov: codecov/codecov@5
 jobs:
-  test-ruby27:
+  test-ruby31:
     docker:
-      - image: cimg/ruby:2.7-node
+      - image: cimg/ruby:3.1-node
       - image: cimg/mysql:8.0
-        command: [--default-authentication-plugin=mysql_native_password]
+        command: [ --default-authentication-plugin=mysql_native_password ]
         environment:
           MYSQL_ROOT_HOST: '%'
           MYSQL_ROOT_PASSWORD: 'root'
@@ -22,8 +24,8 @@ jobs:
       - checkout
       - restore_cache:
           keys:
-            - qpixel-ruby27-{{ checksum "Gemfile.lock" }}
-            - qpixel-ruby27-
+            - qpixel-ruby31-{{ checksum "Gemfile.lock" }}
+            - qpixel-ruby31-
       - run:
           name: Install Bundler & gems
           command: |
@@ -34,7 +36,7 @@ jobs:
           command: |
             bundle clean --force
       - save_cache:
-          key: qpixel-ruby27-{{ checksum "Gemfile.lock" }}
+          key: qpixel-ruby31-{{ checksum "Gemfile.lock" }}
           paths:
             - ~/gems
       - run:
@@ -56,21 +58,19 @@ jobs:
           name: Current revision
           command: |
             git rev-parse $(git rev-parse --abbrev-ref HEAD)
-      - run:
-          name: Coveralls token
-          command: |
-            if [ -z "$COVERALLS_REPO_TOKEN" ]; then echo "Skipping coveralls"; else echo "repo_token: $COVERALLS_REPO_TOKEN" > .coveralls.yml; fi
       - run:
           name: Test
+          environment:
+            RAILS_ENV: test
           command: |
             bundle exec rails test
       - store_test_results:
           path: "~/qpixel/test/reports"
-  system-test-ruby27:
+  system-test-ruby31:
     docker:
-      - image: cimg/ruby:2.7-browsers
+      - image: cimg/ruby:3.1-browsers
       - image: cimg/mysql:8.0
-        command: [--default-authentication-plugin=mysql_native_password]
+        command: [ --default-authentication-plugin=mysql_native_password ]
         environment:
           MYSQL_ROOT_HOST: '%'
           MYSQL_ROOT_PASSWORD: 'root'
@@ -88,8 +88,8 @@ jobs:
       - checkout
       - restore_cache:
           keys:
-            - qpixel-ruby27-{{ checksum "Gemfile.lock" }}
-            - qpixel-ruby27-
+            - qpixel-ruby31-{{ checksum "Gemfile.lock" }}
+            - qpixel-ruby31-
       - run:
           name: Install Bundler & gems
           command: |
@@ -100,7 +100,7 @@ jobs:
           command: |
             bundle clean --force
       - save_cache:
-          key: qpixel-ruby27-{{ checksum "Gemfile.lock" }}
+          key: qpixel-ruby31-{{ checksum "Gemfile.lock" }}
           paths:
             - ~/gems
       - run:
@@ -124,6 +124,8 @@ jobs:
             git rev-parse $(git rev-parse --abbrev-ref HEAD)
       - run:
           name: Test
+          environment:
+            RAILS_ENV: test
           command: |
             bundle exec rails test:system
       - store_test_results:
@@ -132,9 +134,9 @@ jobs:
           path: "~/qpixel/tmp/screenshots"
           when: on_fail
 
-  test-ruby31:
+  test-ruby32:
     docker:
-      - image: cimg/ruby:3.1-node
+      - image: cimg/ruby:3.2-node
       - image: cimg/mysql:8.0
         command: [ --default-authentication-plugin=mysql_native_password ]
         environment:
@@ -154,8 +156,8 @@ jobs:
       - checkout
       - restore_cache:
           keys:
-            - qpixel-ruby31-{{ checksum "Gemfile.lock" }}
-            - qpixel-ruby31-
+            - qpixel-ruby32-{{ checksum "Gemfile.lock" }}
+            - qpixel-ruby32-
       - run:
           name: Install Bundler & gems
           command: |
@@ -166,7 +168,7 @@ jobs:
           command: |
             bundle clean --force
       - save_cache:
-          key: qpixel-ruby31-{{ checksum "Gemfile.lock" }}
+          key: qpixel-ruby32-{{ checksum "Gemfile.lock" }}
           paths:
             - ~/gems
       - run:
@@ -188,19 +190,18 @@ jobs:
           name: Current revision
           command: |
             git rev-parse $(git rev-parse --abbrev-ref HEAD)
-      - run:
-          name: Coveralls token
-          command: |
-            if [ -z "$COVERALLS_REPO_TOKEN" ]; then echo "Skipping coveralls"; else echo "repo_token: $COVERALLS_REPO_TOKEN" > .coveralls.yml; fi
       - run:
           name: Test
+          environment:
+            RAILS_ENV: test
           command: |
             bundle exec rails test
       - store_test_results:
           path: "~/qpixel/test/reports"
-  system-test-ruby31:
+      - codecov/upload
+  system-test-ruby32:
     docker:
-      - image: cimg/ruby:3.1-browsers
+      - image: cimg/ruby:3.2-browsers
       - image: cimg/mysql:8.0
         command: [ --default-authentication-plugin=mysql_native_password ]
         environment:
@@ -220,8 +221,8 @@ jobs:
       - checkout
       - restore_cache:
           keys:
-            - qpixel-ruby31-{{ checksum "Gemfile.lock" }}
-            - qpixel-ruby31-
+            - qpixel-ruby32-{{ checksum "Gemfile.lock" }}
+            - qpixel-ruby32-
       - run:
           name: Install Bundler & gems
           command: |
@@ -232,7 +233,7 @@ jobs:
           command: |
             bundle clean --force
       - save_cache:
-          key: qpixel-ruby31-{{ checksum "Gemfile.lock" }}
+          key: qpixel-ruby32-{{ checksum "Gemfile.lock" }}
           paths:
             - ~/gems
       - run:
@@ -256,6 +257,8 @@ jobs:
             git rev-parse $(git rev-parse --abbrev-ref HEAD)
       - run:
           name: Test
+          environment:
+            RAILS_ENV: test
           command: |
             bundle exec rails test:system
       - store_test_results:
@@ -266,7 +269,7 @@ jobs:
 
   rubocop:
     docker:
-      - image: cimg/ruby:3.1-node
+      - image: cimg/ruby:3.2-node
 
     working_directory: ~/qpixel
 
@@ -279,8 +282,8 @@ jobs:
       - checkout
       - restore_cache:
           keys:
-            - qpixel-ruby31-{{ checksum "Gemfile.lock" }}
-            - qpixel-ruby31-
+            - qpixel-ruby32-{{ checksum "Gemfile.lock" }}
+            - qpixel-ruby32-
       - run:
           name: Install Bundler & gems
           command: |
@@ -291,7 +294,7 @@ jobs:
           command: |
             bundle clean --force
       - save_cache:
-          key: qpixel-ruby31-{{ checksum "Gemfile.lock" }}
+          key: qpixel-ruby32-{{ checksum "Gemfile.lock" }}
           paths:
             - ~/gems
       - run:
@@ -301,7 +304,7 @@ jobs:
 
   deploy:
     docker:
-      - image: cimg/ruby:3.1-node
+      - image: cimg/ruby:3.2-node
 
     working_directory: ~/qpixel
 
@@ -319,17 +322,15 @@ jobs:
 workflows:
   test_lint:
     jobs:
-      - test-ruby27
       - test-ruby31
-      - system-test-ruby27
       - system-test-ruby31
+      - test-ruby32
+      - system-test-ruby32
       - rubocop
       - deploy:
           requires:
-            - test-ruby27
-            - test-ruby31
-            - system-test-ruby27
-            - system-test-ruby31
+            - test-ruby32
+            - system-test-ruby32
             - rubocop
           filters:
             branches:

.github/.codecov.yml

@@ -0,0 +1,37 @@
+codecov:
+  require_ci_to_pass: false
+  notify:
+    wait_for_ci: false
+coverage:
+  status:
+    project:
+      default:
+        target: auto
+        threshold: 1%
+        base: auto
+    patch:
+      default:
+        target: auto
+        threshold: 10%
+        base: auto
+comment:
+  layout: "condensed_header, condensed_files, components, condensed_footer"
+  hide_project_coverage: false
+component_management:
+  individual_components:
+    - component_id: module_controllers
+      name: controllers
+      paths:
+        - app/controllers/**
+    - component_id: module_helpers
+      name: helpers
+      paths:
+        - app/helpers/**
+    - component_id: module_jobs
+      name: jobs
+      paths:
+        - app/jobs/**
+    - component_id: module_models
+      name: models
+      paths:
+        - app/models/**

.github/workflows/mirror.yml

@@ -0,0 +1,24 @@
+name: Mirror to Codeberg
+
+on:
+  push:
+    branches:
+      - develop
+
+jobs:
+  mirror:
+    name: Mirror
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout repo
+      uses: actions/checkout@v3
+      with:
+        fetch-depth: 0
+    
+    - name: Mirror
+      uses: yesolutions/mirror-action@master
+      with:
+        REMOTE: '[email protected]:codidact/qpixel'
+        GIT_SSH_PRIVATE_KEY: ${{ secrets.GIT_SSH_PRIVATE_KEY }}
+        GIT_SSH_NO_VERIFY_HOST: "true"

.gitignore

@@ -63,3 +63,8 @@ dump.rdb
 # Ignore IRB files
 .irbrc
 .irb_history
+
+node_modules
+
+# YARD data
+.yardoc

CONTRIBUTING.md

@@ -2,12 +2,13 @@
 Contributing to QPixel follows broadly the same process as any other Codidact project.
 
 ## What needs doing?
-- We have a [roadmap](https://github.com/codidact/qpixel/projects/3) which lists tasks that we deem to be relatively
-  urgent. This roadmap has different phases and each links to issues that should be worked on during a phase.
+- We have a [roadmap](https://github.com/orgs/codidact/projects/6) which lists broad priorities and contains issues
+  which fall into each priority. Issue labels provide more information about what area, language, and difficulty each
+  issue involves.
 - Most bugs and change requests are [here on GitHub](https://github.com/codidact/qpixel/issues). Have a look at all
   open issues (additionally to the roadmap) to find something that needs doing.
 - Additional information may be found in the [feature request](https://meta.codidact.com/categories/3/tags/961) and
-  [bug](https://meta.codidact.com/categories/3/tags/394) tags of Codidact.Meta
+  [bug](https://meta.codidact.com/categories/3/tags/394) tags of Codidact Meta
 
 Once you've picked what you're going to work on, please **leave a comment** on the issue to indicate you're planning
 to work on it; this helps us reduce wasted effort. If there's not already an issue for the feature you want to work
@@ -24,18 +25,32 @@ issue and give it to someone else.
 - Once you've made your changes, submit a pull request targeting the `develop` branch.
 
 Keep in mind that **status checks are required to pass** and **at least one approving review** is required from the
-team before any pull request can be merged. If status checks don't pass, we won't be able to merge - there are no
-exceptions, so please fix the failures and commit again. You can always mark your pull request as a draft while
-you're still trying to make it work.
+team before any pull request can be merged. If status checks don't pass, we won't be able to merge. You can always mark
+your pull request as a draft while you're still trying to make it work.
 
-## What standards are there?
-We have a [code style and standards document](CODE-STANDARDS.md) with information for each applicable language.
-Please make sure you follow these if possible; if there's a good reason why not, please document it in your code,
-add a linter exception, and let us know why in your pull request.
+## What guidelines are there?
+When developing, please bear the following in mind:
 
-## Be nice; be respectful when contributing
-Always be constructive, especially when giving feedback. Always presume that others are acting with good intent.
+* **Avoid jQuery**. We are moving the project away from jQuery; some critical dependencies remain
+  which mean we haven't yet been able to remove it, but new code should use vanilla JS wherever practical.
+* **Follow existing styles**. Your code should be in line with the code style used throughout the project. Rubocop is
+  provided for Ruby code and your code should pass it. There is no linter for JS but style will be manually checked when
+  your pull request is reviewed.
+* **Test your code**. You should both test manually by trying any new/changed/updated functionality, and include 
+  automated tests with your PR. All tests must pass before your PR can be accepted. There is an automated status check
+  for pull requests which will fail if your code is not sufficiently covered by tests.
+* **Develop for accessibility**. Particularly when changing front-end code, develop with accessibility as a primary
+  concern. Content should adhere to WCAG wherever possible. This extends to your code as well - write code that is
+  accessible and clear for developers who come after you, including comments where necessary.
 
+Detailed style guidance for each language is available [here](CODE-STANDARDS.md).
 
+Developer documentation for the QPixel internal API is available [here](https://docs.dev.codidact.org/).
 
+If you're in doubt about how to approach or design something, leave a comment on the issue so that we can discuss your
+proposed changes - we'd rather have a discussion first than have to reject hard work you've already done.
 
+## Be nice; be respectful
+Always be constructive, especially when giving feedback. Always presume that others are acting with good intent.
+Contributors and contributions must abide by the
+[Codidact Code of Conduct](https://github.com/codidact/qpixel?tab=coc-ov-file#readme).