All-CASA patch notes page: convert patch_notes.js to Stimulus or Turbo Frames

Open
#7,316 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Refactor
Clarity
Mostly clear
Activity status
Active
Tech stack
javascript, jquery, rails, ruby
Domain
frontend

Research direction

Start with app/javascript/src/all_casa_admin/patch_notes.js and the view app/views/all_casa_admins/patch_notes/index.html.erb, then see how app/javascript/all_casa_admin.js requires the script. The button_classes helper on the server should supply the button classes. Run spec/system/all_casa_admins/patch_notes/index_spec.rb to confirm create, edit, cancel and delete still work. Done means the jQuery file and its require are gone, and that spec passes without the raw Selenium handle. Agree on a Stimulus or Turbo Frames approach in a comment first.

Written by the indexing model from the issue text.

Description

Difficulty: Advanced Help Wanted javascript

What

The All-CASA-admin patch notes page (app/views/all_casa_admins/patch_notes/index.html.erb) is driven by app/javascript/src/all_casa_admin/patch_notes.js. It's about 500 lines of jQuery that create, edit and delete patch notes inline with $.ajax, and it hand-copies the button_classes strings into JS. Convert it to Stimulus with fetch. A good alternative is plain Rails forms in Turbo Frames, which could remove most of the JS.

This is the biggest legacy script. Open a short plan comment before you start.

Checklist

  • Create, edit, cancel-edit and delete all still work without a full page reload (or with Turbo Frames)
  • Buttons come from the button_classes helper on the server, not hard-coded class strings in JS
  • Delete patch_notes.js and its require in app/javascript/all_casa_admin.js
  • bundle exec rspec spec/system/all_casa_admins/patch_notes/index_spec.rb passes. That spec also still reads a raw Selenium handle (see design-todo.md), which you can clean up here

Before you start

  • Comment here to be assigned. Setup is bin/setup, then bin/dev. Logins are in the README.
  • JS tests: npm run test. Lint: bin/lint.
  • Part of #7301 (removing jQuery). Keep this PR to just this file.
Dominant language
Ruby
Stars
384
Forks
558
Avg merge
1d 7h
Merged PRs (30d)
63

Getting set up

Open in Codespaces

Starts the project's dev container in your browser, under your own GitHub account.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from rubyforgood/casa

All issues in rubyforgood/casa

Similar issues

More Ruby issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.