Hungry Hungry Hippo (H3)

Development

Requirements

• docker & docker compose
• tmux (installation instructions)
• overmind (installed automatically via bundler)

Running locally

Spin up containers and the app, and then set up the application and solid-* databases:

docker compose up -d
bin/rails db:prepare
bin/dev

Then browse to http://localhost:3000 to see the running application.

Debugging locally

1. Add a debugger statement in the code.
2. Connect to the process (for example, bin/overmind connect web).

See overmind documentation for more about how to control processes.

Completing accessioning workflow

accessionWF steps can be completed with:

bin/rake "development:accession[druid:dh414dd1590]"

System tests

Javascript

By default, system tests will use headless Chrome, which supports javascript.

If your test doesn't use javascript, consider using Rack, as it is much faster:

RSpec.describe 'Create a work draft', :rack_test do

Cyperful

Cyperful is a visual debugger for system tests. To run a system test, prepend CYPERFUL=1. For example:

CYPERFUL=1 bundle exec rspec spec/system/create_work_draft_spec.rb

Adding a new field

1. Add the field to the appropriate form object (e.g., app/forms/work_form.rb), including validation.
2. Add the field to the form view (e.g., app/views/works/form.html.erb), including adding strings to config/locales/en.yml.
3. Permit the parameters in app/controllers/works_controller.
4. Map the field from cocina to work form in app/services/to_work_form/mapper.rb.
5. Map the field from work form to cocina in app/services/to_cocina/mapper.rb (or sub-mapper).
6. Add the field to the work form and cocina fixtures in spec/support/mapping_fixtures.rb.
7. Test serialization of the field in spec/serializers/work_form_serializer_spec.rb.
8. Test adding the field in spec/system/create_work_deposit_spec.rb.
9. Test editing the field in spec/system/edit_work_spec.rb.
10. Add the field to the work show (app/views/works/show.html.erb).
11. Test display of the field in spec/system/show_work_spec.rb.