[Refactoring proposal] Test app structure refactoring
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 45/100
- Issue type
- Refactor
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- rails, ruby
- Domain
- developer-experience, testing
Research direction
Start by reading test/fixtures/active_record.rb and test_helper.rb to map the schema, models, controllers, resources, routes, configurations, and monkey-patches they contain. Extract each component type into the proposed test files and include them from test_helper.rb. Done means the test app retains its behavior while its structure matches the proposed layout.
Written by the indexing model from the issue text.
Description
This issue is a (choose one):
- Problem/bug report.
- Feature request.
- Refactor proposal
- Request for support. Note: Please try to avoid submitting issues for support requests. Use Gitter instead.
Checklist before submitting:
- I've searched for an existing issue.
- I've asked my question on Gitter and have not received a satisfactory answer.
- I've included a complete bug report template. This step helps us and allows us to see the bug without trying to reproduce the problem from your description. It helps you because you will frequently detect if it's a problem specific to your project.
- The feature I'm asking for is compliant with the JSON:API spec.
Description
Currently, we put all kind of components of our test app in side test/fixtures/active_record.rb. It contains schema, models, controllers and resources. The file’s name is quite misleading since it contains more than active_record related stuffs. And it’s a 2000 lines file, a little bit too long.
And in the meantime, test_helper.rb has the routes, test configurations, monkey-patches and test app configurations.
As a new contributor, I need to spend more time to figure out the test setup under this structure.
So I suggest we can do a small refactoring, to extract and put different types of components into their own files. Like:
test
|——— schema.rb # for schema
|——— models.rb # for models
|——— controllers.rb # for controllers
|——— resources.rb # for resources
|——— routes.rb # for routes
|——— app.rb # for app configs
|——— test_helper.rb # test configs, monkey-patchings and requires
Now we can just include these component files inside test_helper.rb and it’ll be more easier for new contributors to understand the test app.
- Dominant language
- Ruby
- Stars
- 2.3k
- Forks
- 546
- PR merge metrics
- No merged PRs in 30d
Getting set up
We have not checked this project's setup files yet. Start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from JSONAPI-Resources/jsonapi-resources
-
Difficulty 1/5 Under an hour Newbie friendliness 85/100
-
Difficulty 3/5 1-2 days Newbie friendliness 50/100
JSONAPI-Resources/jsonapi-resources#1488 · 1 comment ·
-
Difficulty 4/5 3-5 days Newbie friendliness 42/100
JSONAPI-Resources/jsonapi-resources#1479 · 2 comments ·
-
Difficulty 4/5 3-5 days Newbie friendliness 30/100
JSONAPI-Resources/jsonapi-resources#1477 · 3 comments · 1 reaction ·
-
Difficulty 3/5 1-2 days Newbie friendliness 45/100
All issues in JSONAPI-Resources/jsonapi-resources
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100
TheOdinProject/curriculum#31423 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
oxidize-rb/rb-sys#807 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
Maintainers usually reply within 1 day