Skip to content

Commit

Permalink
refactor: rename to singular
Browse files Browse the repository at this point in the history
To be consistent with other controller names.

RISDEV-3994
  • Loading branch information
andreasphil committed May 23, 2024
1 parent 414186e commit 90918db
Show file tree
Hide file tree
Showing 5 changed files with 27 additions and 27 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
import static org.springframework.http.MediaType.APPLICATION_JSON_VALUE;
import static org.springframework.http.MediaType.TEXT_HTML_VALUE;

import de.bund.digitalservice.ris.norms.adapter.input.restapi.mapper.ElementsResponseMapper;
import de.bund.digitalservice.ris.norms.adapter.input.restapi.mapper.ElementResponseMapper;
import de.bund.digitalservice.ris.norms.adapter.input.restapi.schema.ElementsResponseEntrySchema;
import de.bund.digitalservice.ris.norms.application.port.input.ApplyPassiveModificationsUseCase;
import de.bund.digitalservice.ris.norms.application.port.input.LoadNormUseCase;
Expand Down Expand Up @@ -34,18 +34,18 @@
* convention of UPPERCASE enums in Java code.
*/
@Component
class LowercaseEnumConverter implements Converter<String, ElementsController.ElementType> {
class LowercaseEnumConverter implements Converter<String, ElementController.ElementType> {
@Override
public ElementsController.ElementType convert(String value) {
return ElementsController.ElementType.valueOf(value.toUpperCase());
public ElementController.ElementType convert(String value) {
return ElementController.ElementType.valueOf(value.toUpperCase());
}
}

/** Controller for retrieving a norm's elements. */
@RestController
@RequestMapping(
"/api/v1/norms/eli/bund/{agent}/{year}/{naturalIdentifier}/{pointInTime}/{version}/{language}/{subtype}/elements")
public class ElementsController {
public class ElementController {

/** The types of elements that can be retrieved. */
public enum ElementType {
Expand All @@ -67,7 +67,7 @@ public enum ElementType {
private final TransformLegalDocMlToHtmlUseCase transformLegalDocMlToHtmlUseCase;
private final ApplyPassiveModificationsUseCase applyPassiveModificationsUseCase;

public ElementsController(
public ElementController(
LoadNormUseCase loadNormUseCase,
TransformLegalDocMlToHtmlUseCase transformLegalDocMlToHtmlUseCase,
ApplyPassiveModificationsUseCase applyPassiveModificationsUseCase) {
Expand Down Expand Up @@ -197,7 +197,7 @@ public ResponseEntity<ElementsResponseEntrySchema> getElementInfo(
var elementXpath = String.format("//*[@eId='%s']", eid);
return NodeParser.getNodeFromExpression(elementXpath, norm.getDocument());
})
.map(ElementsResponseMapper::fromElementNode)
.map(ElementResponseMapper::fromElementNode)
.map(ResponseEntity::ok)
.orElse(ResponseEntity.notFound().build());
}
Expand Down Expand Up @@ -246,7 +246,7 @@ public ResponseEntity<List<ElementsResponseEntrySchema>> getList(
// get elements and return
return ResponseEntity.ok(
getElements(type, amendedBy, targetNorm.get(), eli).stream()
.map(ElementsResponseMapper::fromElementNode)
.map(ElementResponseMapper::fromElementNode)
.toList());
}

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
package de.bund.digitalservice.ris.norms.adapter.input.restapi.mapper;

import de.bund.digitalservice.ris.norms.adapter.input.restapi.controller.ElementsController;
import de.bund.digitalservice.ris.norms.adapter.input.restapi.controller.ElementController;
import de.bund.digitalservice.ris.norms.adapter.input.restapi.schema.ElementsResponseEntrySchema;
import de.bund.digitalservice.ris.norms.utils.NodeParser;
import java.util.Map;
Expand All @@ -10,17 +10,17 @@
* Mapper class for converting between {@link Node} and {@link
* de.bund.digitalservice.ris.norms.adapter.input.restapi.schema.ElementsResponseEntrySchema}.
*/
public class ElementsResponseMapper {
public class ElementResponseMapper {
// Private constructor to hide the implicit public one and prevent instantiation
private ElementsResponseMapper() {}
private ElementResponseMapper() {}

// TODO: Is this referring to enums from the controller allowed?
// Will be moved to service either way I guess
private static final Map<String, String> staticNodeTitles =
Map.ofEntries(
Map.entry(ElementsController.ElementType.PREFACE.name(), "Dokumentenkopf"),
Map.entry(ElementsController.ElementType.PREAMBLE.name(), "Eingangsformel"),
Map.entry(ElementsController.ElementType.CONCLUSIONS.name(), "Schlussteil"));
Map.entry(ElementController.ElementType.PREFACE.name(), "Dokumentenkopf"),
Map.entry(ElementController.ElementType.PREAMBLE.name(), "Eingangsformel"),
Map.entry(ElementController.ElementType.CONCLUSIONS.name(), "Schlussteil"));

private static String getNodeType(Node node) {
return node.getNodeName().replace("akn:", "");
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@
* Not using SpringBootTest annotation to avoid needing a database connection. Using @Import to load
* the {@link SecurityConfig} in order to avoid http 401 Unauthorised
*/
@WebMvcTest(ElementsController.class)
@WebMvcTest(ElementController.class)
@Import(SecurityConfig.class)
class ElementsControllerTest {
class ElementControllerTest {

@Autowired private MockMvc mockMvc;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
import de.bund.digitalservice.ris.norms.utils.XmlMapper;
import org.junit.jupiter.api.Test;

public class ElementsResponseMapperTest {
public class ElementResponseMapperTest {
@Test
void convertsAnArticleNode() {
// Given
Expand All @@ -26,7 +26,7 @@ void convertsAnArticleNode() {
""");

// When
var output = ElementsResponseMapper.fromElementNode(node);
var output = ElementResponseMapper.fromElementNode(node);

// Then
assertThat(output.getTitle()).isEqualTo("§ 1 Überschrift des Artikels");
Expand All @@ -49,7 +49,7 @@ void convertsAnArticleWithMissingMarkerToNode() {
""");

// When
var output = ElementsResponseMapper.fromElementNode(node);
var output = ElementResponseMapper.fromElementNode(node);

// Then
assertThat(output.getTitle()).isEqualTo("Überschrift des Artikels");
Expand All @@ -73,7 +73,7 @@ void convertsAnArticleWithMissingHeadingToNode() {
""");

// When
var output = ElementsResponseMapper.fromElementNode(node);
var output = ElementResponseMapper.fromElementNode(node);

// Then
assertThat(output.getTitle()).isEqualTo("§ 1");
Expand All @@ -93,7 +93,7 @@ void convertsAnArticleWithoutTitleToNode() {
""");

// When
var output = ElementsResponseMapper.fromElementNode(node);
var output = ElementResponseMapper.fromElementNode(node);

// Then
assertThat(output.getTitle()).isEqualTo("");
Expand All @@ -114,7 +114,7 @@ void convertsAPrefaceNode() {
""");

// When
var output = ElementsResponseMapper.fromElementNode(node);
var output = ElementResponseMapper.fromElementNode(node);

// Then
assertThat(output.getTitle()).isEqualTo("Dokumentenkopf");
Expand All @@ -134,7 +134,7 @@ void convertsAPreambleNode() {
""");

// When
var output = ElementsResponseMapper.fromElementNode(node);
var output = ElementResponseMapper.fromElementNode(node);

// Then
assertThat(output.getTitle()).isEqualTo("Eingangsformel");
Expand All @@ -155,7 +155,7 @@ void convertsAConclusionsNode() {
""");

// When
var output = ElementsResponseMapper.fromElementNode(node);
var output = ElementResponseMapper.fromElementNode(node);

// Then
assertThat(output.getTitle()).isEqualTo("Schlussteil");
Expand All @@ -174,7 +174,7 @@ void convertsAnArbitraryNode() {
""");

// When
var output = ElementsResponseMapper.fromElementNode(node);
var output = ElementResponseMapper.fromElementNode(node);

// Then
assertThat(output.getTitle()).isEqualTo("");
Expand All @@ -195,6 +195,6 @@ void throwsWhenConvertingANodeWithoutEid() {
""");

// When
assertThatThrownBy(() -> ElementsResponseMapper.fromElementNode(node));
assertThatThrownBy(() -> ElementResponseMapper.fromElementNode(node));
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
import org.springframework.http.MediaType;
import org.springframework.test.web.servlet.MockMvc;

class ElementsControllerIntegrationTest extends BaseIntegrationTest {
class ElementControllerIntegrationTest extends BaseIntegrationTest {

@Autowired private MockMvc mockMvc;
@Autowired private NormRepository normRepository;
Expand Down

0 comments on commit 90918db

Please sign in to comment.