From 029fc4ec4e3e2754e523c957b33a1771eade187c Mon Sep 17 00:00:00 2001 From: Marty30 Date: Wed, 21 Jun 2017 16:41:04 +0200 Subject: [PATCH] Refactor the code smells that were present according to SonarQube --- .../petclinic/PetClinicApplication.java | 4 +-- .../samples/petclinic/owner/Owner.java | 6 ++--- .../petclinic/owner/OwnerController.java | 6 ++--- .../petclinic/system/CrashController.java | 3 +-- .../petclinic/system/ExampleException.java | 15 +++++++++++ .../samples/petclinic/vet/VetController.java | 8 +++--- .../samples/petclinic/vet/VetRepository.java | 3 +-- .../samples/petclinic/vet/Vets.java | 8 +++--- .../petclinic/visit/VisitRepository.java | 3 +-- .../nl/utwente/bpsd/selenium/FailingIT.java | 26 ------------------- 10 files changed, 34 insertions(+), 48 deletions(-) create mode 100644 src/main/java/org/springframework/samples/petclinic/system/ExampleException.java delete mode 100644 src/test/java/nl/utwente/bpsd/selenium/FailingIT.java diff --git a/src/main/java/org/springframework/samples/petclinic/PetClinicApplication.java b/src/main/java/org/springframework/samples/petclinic/PetClinicApplication.java index 224c326c7..5265770dc 100644 --- a/src/main/java/org/springframework/samples/petclinic/PetClinicApplication.java +++ b/src/main/java/org/springframework/samples/petclinic/PetClinicApplication.java @@ -21,14 +21,14 @@ import org.springframework.boot.autoconfigure.SpringBootApplication; /** * PetClinic Spring Boot Application. - * + * * @author Dave Syer * */ @SpringBootApplication public class PetClinicApplication { - public static void main(String[] args) throws Exception { + public static void main(String[] args) { SpringApplication.run(PetClinicApplication.class, args); } diff --git a/src/main/java/org/springframework/samples/petclinic/owner/Owner.java b/src/main/java/org/springframework/samples/petclinic/owner/Owner.java index f6fcae7ac..e471b5c8a 100644 --- a/src/main/java/org/springframework/samples/petclinic/owner/Owner.java +++ b/src/main/java/org/springframework/samples/petclinic/owner/Owner.java @@ -126,13 +126,13 @@ public class Owner extends Person { * @param name to test * @return true if pet name is already in use */ - public Pet getPet(String name, boolean ignoreNew) { - name = name.toLowerCase(); + public Pet getPet(final String name, final boolean ignoreNew) { + String lowerCaseName = name.toLowerCase(); for (Pet pet : getPetsInternal()) { if (!ignoreNew || !pet.isNew()) { String compName = pet.getName(); compName = compName.toLowerCase(); - if (compName.equals(name)) { + if (compName.equals(lowerCaseName)) { return pet; } } diff --git a/src/main/java/org/springframework/samples/petclinic/owner/OwnerController.java b/src/main/java/org/springframework/samples/petclinic/owner/OwnerController.java index ef3169b70..58be460a0 100644 --- a/src/main/java/org/springframework/samples/petclinic/owner/OwnerController.java +++ b/src/main/java/org/springframework/samples/petclinic/owner/OwnerController.java @@ -78,7 +78,7 @@ class OwnerController { } @RequestMapping(value = "/owners", method = RequestMethod.GET) - public String processFindForm(Owner owner, BindingResult result, Map model) { + public String processFindForm(final Owner owner, final BindingResult result, final Map model) { // allow parameterless GET request for /owners to return all records if (owner.getLastName() == null) { @@ -93,8 +93,8 @@ class OwnerController { return "owners/findOwners"; } else if (results.size() == 1) { // 1 owner found - owner = results.iterator().next(); - return "redirect:/owners/" + owner.getId(); + Owner founndOwner = results.iterator().next(); + return "redirect:/owners/" + founndOwner.getId(); } else { // multiple owners found model.put("selections", results); diff --git a/src/main/java/org/springframework/samples/petclinic/system/CrashController.java b/src/main/java/org/springframework/samples/petclinic/system/CrashController.java index a702cfc8f..5fe9a3294 100644 --- a/src/main/java/org/springframework/samples/petclinic/system/CrashController.java +++ b/src/main/java/org/springframework/samples/petclinic/system/CrashController.java @@ -31,8 +31,7 @@ class CrashController { @RequestMapping(value = "/oups", method = RequestMethod.GET) public String triggerException() { - throw new RuntimeException( - "Expected: controller used to showcase what " + "happens when an exception is thrown"); + throw new ExampleException("Expected: controller used to showcase what happens when an exception is thrown"); } } diff --git a/src/main/java/org/springframework/samples/petclinic/system/ExampleException.java b/src/main/java/org/springframework/samples/petclinic/system/ExampleException.java new file mode 100644 index 000000000..bcf5e2bdd --- /dev/null +++ b/src/main/java/org/springframework/samples/petclinic/system/ExampleException.java @@ -0,0 +1,15 @@ +package org.springframework.samples.petclinic.system; + +/** + * @author Martijn + * @since 21-6-2017. + */ +public class ExampleException extends RuntimeException { + public ExampleException(String message) { + super(ExampleException.class.getSimpleName() + ": " + message); + } + + protected ExampleException(String message, Throwable cause, boolean enableSuppression, boolean writableStackTrace) { + super(ExampleException.class.getSimpleName() + ": " + message, cause, enableSuppression, writableStackTrace); + } +} diff --git a/src/main/java/org/springframework/samples/petclinic/vet/VetController.java b/src/main/java/org/springframework/samples/petclinic/vet/VetController.java index 8ddcca60a..7911aa702 100644 --- a/src/main/java/org/springframework/samples/petclinic/vet/VetController.java +++ b/src/main/java/org/springframework/samples/petclinic/vet/VetController.java @@ -31,11 +31,11 @@ import org.springframework.web.bind.annotation.ResponseBody; @Controller class VetController { - private final VetRepository vets; + private final VetRepository vetRepository; @Autowired public VetController(VetRepository clinicService) { - this.vets = clinicService; + this.vetRepository = clinicService; } @RequestMapping(value = { "/vets.html" }) @@ -43,7 +43,7 @@ class VetController { // Here we are returning an object of type 'Vets' rather than a collection of Vet // objects so it is simpler for Object-Xml mapping Vets vets = new Vets(); - vets.getVetList().addAll(this.vets.findAll()); + vets.getVetList().addAll(this.vetRepository.findAll()); model.put("vets", vets); return "vets/vetList"; } @@ -53,7 +53,7 @@ class VetController { // Here we are returning an object of type 'Vets' rather than a collection of Vet // objects so it is simpler for JSon/Object mapping Vets vets = new Vets(); - vets.getVetList().addAll(this.vets.findAll()); + vets.getVetList().addAll(this.vetRepository.findAll()); return vets; } diff --git a/src/main/java/org/springframework/samples/petclinic/vet/VetRepository.java b/src/main/java/org/springframework/samples/petclinic/vet/VetRepository.java index 20863ce76..15c4bf9ac 100644 --- a/src/main/java/org/springframework/samples/petclinic/vet/VetRepository.java +++ b/src/main/java/org/springframework/samples/petclinic/vet/VetRepository.java @@ -18,7 +18,6 @@ package org.springframework.samples.petclinic.vet; import java.util.Collection; import org.springframework.cache.annotation.Cacheable; -import org.springframework.dao.DataAccessException; import org.springframework.data.repository.Repository; import org.springframework.transaction.annotation.Transactional; @@ -40,7 +39,7 @@ public interface VetRepository extends Repository { */ @Transactional(readOnly = true) @Cacheable("vets") - Collection findAll() throws DataAccessException; + Collection findAll(); } diff --git a/src/main/java/org/springframework/samples/petclinic/vet/Vets.java b/src/main/java/org/springframework/samples/petclinic/vet/Vets.java index f5b24c3fc..152fa560e 100644 --- a/src/main/java/org/springframework/samples/petclinic/vet/Vets.java +++ b/src/main/java/org/springframework/samples/petclinic/vet/Vets.java @@ -30,14 +30,14 @@ import javax.xml.bind.annotation.XmlRootElement; @XmlRootElement public class Vets { - private List vets; + private List vetList; @XmlElement public List getVetList() { - if (vets == null) { - vets = new ArrayList<>(); + if (vetList == null) { + vetList = new ArrayList<>(); } - return vets; + return vetList; } } diff --git a/src/main/java/org/springframework/samples/petclinic/visit/VisitRepository.java b/src/main/java/org/springframework/samples/petclinic/visit/VisitRepository.java index c7853d170..122599886 100644 --- a/src/main/java/org/springframework/samples/petclinic/visit/VisitRepository.java +++ b/src/main/java/org/springframework/samples/petclinic/visit/VisitRepository.java @@ -17,7 +17,6 @@ package org.springframework.samples.petclinic.visit; import java.util.List; -import org.springframework.dao.DataAccessException; import org.springframework.data.repository.Repository; import org.springframework.samples.petclinic.model.BaseEntity; @@ -38,7 +37,7 @@ public interface VisitRepository extends Repository { * @param visit the Visit to save * @see BaseEntity#isNew */ - void save(Visit visit) throws DataAccessException; + void save(Visit visit); List findByPetId(Integer petId); diff --git a/src/test/java/nl/utwente/bpsd/selenium/FailingIT.java b/src/test/java/nl/utwente/bpsd/selenium/FailingIT.java deleted file mode 100644 index 87a26e3ad..000000000 --- a/src/test/java/nl/utwente/bpsd/selenium/FailingIT.java +++ /dev/null @@ -1,26 +0,0 @@ -package nl.utwente.bpsd.selenium; - -import org.junit.Assert; -import org.junit.Ignore; -import org.junit.Test; -import org.junit.experimental.categories.Category; - -import java.net.MalformedURLException; - -/** - * @author Martijn - * @since 21-6-2017. - */ -public class FailingIT extends SeleniumBaseIT { - public FailingIT() throws MalformedURLException { - super(); - } - - @Test - @Category(SeleniumBaseIT.class) - @Ignore - public void failIT() { - Assert.fail(); - } - -}