🎁 Creates a sample CSV importing template file #1077
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
laritakr
force-pushed
the
create-sample-csv-service
branch
from
dd6591a to
4713fa6
Compare
This file can be used as a template for creating imports.
laritakr
added
enhancement
laritakr
force-pushed
the
create-sample-csv-service
branch
4 times, most recently
from
6412b8e to
6084196
Compare
laritakr
force-pushed
the
create-sample-csv-service
branch
2 times, most recently
from
218adfe to
629610f
Compare
Call in controller is temporary, so pull out the code it uses since it will be removed later. Complete logic in csv service.
Rake task doesn't work any more.
laritakr
force-pushed
the
create-sample-csv-service
branch
from
75e67b8 to
8332b79
Compare
WIP - not all have specs yet
Simple form bootstrap configuration was overriding the stylies.
laritakr
force-pushed
the
create-sample-csv-service
branch
from
5513b32 to
df68a31
Compare
There was a problem hiding this comment.
Pull request overview
This PR introduces a new SampleCsvService that generates tenant-specific CSV import templates for Bulkrax. The service creates sample CSV files with appropriate headers, field descriptions, and example values based on the repository's work types and field mappings, supporting both ActiveFedora and Valkyrie models.
Changes:
- Adds a modular
SampleCsvServicewith 12 supporting classes that analyze schemas, build columns/rows, and generate CSV templates - Implements a "Generate CSV Import Template" button in the importer creation UI with corresponding controller action and route
- Removes the deprecated
generate_test_csvsrake task that created fake test data
Reviewed changes
Copilot reviewed 30 out of 31 changed files in this pull request and generated 14 comments.
Show a summary per file
| File | Description |
|---|---|
| app/services/bulkrax/sample_csv_service.rb | Main orchestrator service that coordinates CSV generation through specialized components |
| app/services/bulkrax/sample_csv_service/*.rb | Supporting classes for model loading, field analysis, column/row building, and CSV output |
| app/controllers/bulkrax/importers_controller.rb | Adds sample_csv_file action to generate and download CSV template |
| app/views/bulkrax/importers/new.html.erb | Adds "Generate CSV Import Template" button and updates submit button styling |
| app/views/bulkrax/exporters/new.html.erb | Updates submit button styling for consistency |
| config/routes.rb | Adds POST route for sample_csv_file action |
| config/locales/bulkrax.en.yml | Adds translation for "Generate Sample CSV" action |
| lib/tasks/bulkrax_tasks.rake | Removes deprecated generate_test_csvs rake task |
| spec/services/bulkrax/sample_csv_service/*.rb | Test coverage for service classes (some files are empty stubs) |
| app/assets/stylesheets/bulkrax/import_export.scss | Minor whitespace cleanup |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
spec/services/bulkrax/sample_csv_service/explanation_builder_spec.rb
Outdated
Show resolved
Hide resolved
laritakr
commented
Jan 27, 2026
ShanaLMoore
reviewed
Jan 27, 2026
ShanaLMoore
reviewed
Jan 27, 2026
| @@ -14,108 +14,6 @@ namespace :bulkrax do | |||
| end | |||
| end | |||
|
|
|||
Contributor
There was a problem hiding this comment.
ooo I didn't know we had a rake task for this. Is it no longer valid? 👀
Contributor
Author
There was a problem hiding this comment.
I didn't know either! It was set up to create test data of some sort I believe, but it was very out of date and did not work when I tried it. I decided it was probably best to remove it - keeping it felt misleading. I could be persuaded otherwise if there's any valid reason to keep it around.
ShanaLMoore
reviewed
Jan 27, 2026
ShanaLMoore
reviewed
Jan 27, 2026
Contributor
ShanaLMoore
left a comment
ShanaLMoore
left a comment
There was a problem hiding this comment.
I appreciate all the specs added to Bulkrax! 👏🏿
There is some longstanding code in lib/bulkrax.rb that Rubocop began complaining about. This commit addresses those offenses.
laritakr
changed the title
The sample CSV generation only works if Hyrax is defined in the application, so the button should only appear if Hyrax is defined as well.
orangewolf
reviewed
Jan 28, 2026
ShanaLMoore
approved these changes
Jan 28, 2026
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Creates a service which generates a sample CSV file to be used as a template for creating imports. This is Hyku tenant-specific because Hyku stores the Bulkrax field mappings at a tenant level, and should work for current Hyku with both flexible metadata
falseandtrueSample File & Caveats
Sample CSV created by service
bulkrax_template_20260127_015533.csv
Note
Using the schema's form definition to determine which terms to include may allow us to remove the ignore list. However while we are attempting to support (with no guarantee that it will work) ActiveFedora's defined models, this wouldn't work, so the ignored properties in CsvBuilder class remain for now.