approvals / approvals/ApprovalTests.Ruby

Split Up gem and release Writers separately

Open
#275 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Ruby
Stars
231
Forks
45
PR merge metrics
No merged PRs in 30d

Description

Different writers have different dependencies. For example the HTML writer depends on nokogiri.
Not every project uses all writers. By configuring on start up, which writers are used the writer gems could be loaded (dependency injection).

The current approvals gem would be the "front-end", which offers the API and orchestrates the flows.

The nokogiri gem had a lot of security vulnerabilities in the past, which led to an increased maintenance effort.
This effort could be reduced, with the split up of the gem and only bundling those writers, which are really needed in a project.

Contributor guide

No contributing guide indexed for this repository

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.

Research direction

The issue names no files, tests, or entry points. Start by mapping the current approvals gem, its writers, and their dependencies, especially the HTML writer's nokogiri dependency. Done means the front-end API can load writer gems selectively and those gems can be released separately.

Written by the indexing model from the issue text.

Assessment

Tech stack
ruby
Domain
build-system, release
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.