INRIA/spoon

Feature(CtPackage): Implement null object for CtPackage

Open

#3,705 opened on Nov 19, 2020

View on GitHubContributor guide
 (9 comments) (0 reactions) (0 assignees)Java (383 forks)github user discovery
featuregood first issuerefactor

Repository metrics

Stars
 (1,933 stars)
PR merge metrics
 (Avg merge 19d 11h) (49 merged PRs in 30d)

Description

Problem

Sometimes code elements have no package and getPackage return nulls. This introduces null checks and surprises for new developers. https://github.com/INRIA/spoon/commit/84c84e16163ff18611f82c69d5246d642e3fed86 as seen here, package can be null.

Solution

A null object[0],[1] could improve code quality. A comparable implementation is NoSourcePosition. NoSourcePosition removed all null checks for positions and improves the code quality.

Your task

Design a null object and refactor old code. Find a solution for getSimpleName() as the empty String is reserved for default package. The PR should include:

  • Design a null object for CtPackage
  • Improve already existing test code and remove unnecessary null checks

It's a good starter issue, feel free to give it a try and ping if you need help for some design decisions.

Literatur/Links

[0] https://en.wikipedia.org/wiki/Null_object_pattern [1] https://www.baeldung.com/java-null-object-pattern

Contributor guide

Research direction
Study the existing NoSourcePosition implementation in the repository. Design a similar null object for CtPackage, handling getSimpleName() by perhaps returning an empty string or a special sentinel. Refactor code that checks for null packages to use the null object.
Tech stack
java
Domain
backend
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Java
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65