Created proper byExample in VehicleInspeection and in template and added test

Author: johnlpage

memex/README.md

@@ -392,24 +392,23 @@ classes for an Entity including all the new
 derived classes by running the maven goal. This adds a Generic flexible model.
 
 ```shell
- mvn generate-sources -Pgenerate-entity -Dentity=MyEntity -Dplural=entities -DidFieldName=entityId -DidFieldType=Long
+ mvn generate-sources -Pgenerate-entity -Dentity=Customer -Dplural=customers -DidFieldName=customerId -DidFieldType=Long
 ```
 
 You can delete it with
 
 ```shell
- mvn generate-sources -Pgenerate-entity -Dentity=MyEntity -DidType=Long -Ddelete
+ mvn generate-sources -Pgenerate-entity -Dentity=Customer -DidType=Long -Ddelete
 ```
 
 # Model Generation
 
 You can also Generate a data specific model from a JSON file using the maven
-goal below. customId shodu lmap to the id
-field in the JSON
+goal below. customId should be the name of the id field in the JSON and entity
 
 ```shell
 
- mvn generate-sources -Pgenerate-models-from-json   -DjsonFile=../DataGen/mot.json  -DbasePackage=com.johnlpage.memex  -Dentity=MyEntity  -DidFieldName=myentityId
+ mvn generate-sources -Pgenerate-models-from-json   -DjsonFile=../DataGen/mot.json  -DbasePackage=com.johnlpage.memex  -Dentity=Customer  -DidFieldName=customerId
 
 ```
 

memex/src/main/java/com/johnlpage/memex/VehicleInspection/controller/VehicleInspectionController.java

@@ -131,6 +131,7 @@ public ResponseEntity<VehicleInspection> getById(@PathVariable Long id) {
                 .orElse(ResponseEntity.notFound().build());
     }
 
+
     /**
      * JPA Get By Example Query - Needs an Index to be efficient It still finds ALL the results each
      * time and returns a subset
@@ -141,15 +142,23 @@ public ResponseEntity<PageDto<VehicleInspection>> getInspectionsByModel(
             @RequestParam(name = "page", required = false, defaultValue = "0") int page,
             @RequestParam(name = "size", required = false, defaultValue = "10") int size) {
 
-        // This is where we are hard coding a query for this endpoint.
-        // By creating an example of the class, clumsy but works.
-        VehicleInspection example = new VehicleInspection();
-        Vehicle v = new Vehicle();
-        v.setModel(model);
-        example.setVehicle(v);
-
         // Use the line below for immutable model
         // VehicleInspection probe = VehicleInspection.builder().model(model).build();
+        Slice<VehicleInspection> returnPage = queryService.getByVehicleModel(model, page, size);
+        PageDto<VehicleInspection> entity = new PageDto<>(returnPage);
+        return ResponseEntity.ok(entity);
+    }
+
+    /**
+     * JPA Get By Example Query , pass in some fields get matching in pages
+     * Post as we are sending a body
+     */
+
+    @PostMapping("/inspections/byExample")
+    public ResponseEntity<PageDto<VehicleInspection>> getInspectionByExample(
+            @RequestBody VehicleInspection example,
+            @RequestParam(name = "page", required = false, defaultValue = "0") int page,
+            @RequestParam(name = "size", required = false, defaultValue = "10") int size) {
         Slice<VehicleInspection> returnPage = queryService.getByExample(example, page, size);
         PageDto<VehicleInspection> entity = new PageDto<>(returnPage);
         return ResponseEntity.ok(entity);

memex/src/main/java/com/johnlpage/memex/VehicleInspection/repository/VehicleInspectionRepository.java

@@ -10,6 +10,8 @@
 import java.util.stream.Stream;
 
 import org.bson.Document;
+import org.springframework.data.domain.PageRequest;
+import org.springframework.data.domain.Slice;
 import org.springframework.data.mongodb.repository.Aggregation;
 import org.springframework.data.mongodb.repository.MongoRepository;
 import org.springframework.data.mongodb.repository.Query;
@@ -35,6 +37,9 @@ public interface VehicleInspectionRepository
     // Derived Query with Boolean and
     List<VehicleInspection> findByVehicleColourAndVehicleModel(String colour, String model);
 
+    // Version that gets a page using Slice as Page is a lot slower due to counting
+    Slice<VehicleInspection> findByVehicleModel(String model, PageRequest page);
+
     // Annotation-based aggregation (Group By in this case) returning a Docuement as a generic type
     @Aggregation(
             pipeline = {
@@ -56,4 +61,6 @@ public interface VehicleInspectionRepository
 
     // Fetch whole collection as a stream.
     Stream<VehicleInspection> findAllBy();
+
+
 }

memex/src/main/java/com/johnlpage/memex/VehicleInspection/service/VehicleInspectionQueryService.java

@@ -48,8 +48,13 @@ public Optional<VehicleInspection> getById(Long id) {
     }
 
     public Slice<VehicleInspection> getByExample(VehicleInspection probe, int page, int size) {
+        //This line means null values in example do not need ot be null in database
         ExampleMatcher matcher = ExampleMatcher.matching().withIgnoreNullValues();
         Example<VehicleInspection> example = Example.of(probe, matcher);
         return repository.findAll(example, PageRequest.of(page, size));
     }
+
+    public Slice<VehicleInspection> getByVehicleModel(String model, int page, int size) {
+        return repository.findByVehicleModel(model,PageRequest.of(page,size));
+    }
 }

memex/src/main/resources/application.properties

@@ -19,7 +19,7 @@ memex.preflight.dropAllCollections=false
 #
 #If not in URI or other Auth Method
 logging.level.org.springframework.data.repository=INFO
-logging.level.org.springframework.data.mongodb.core=INFO
+logging.level.org.springframework.data.mongodb.core=DEBUG
 # This one is handy to see what is being done against MDB
 logging.level.org.mongodb.driver=INFO
 #debug=true

memex/src/test/resources/features/inspections.rest.crud.feature

@@ -76,6 +76,24 @@ Feature: Vehicle Inspection REST API - Core CRUD Operations
     Then the response status code should be 404
     And the response should be empty
 
+  @post @by_example @sunny_day
+  Scenario: Successfully fetch a page of result by example
+    Given the following vehicle inspections exist:
+      | vehicleinspection                                  |
+      | {"testid": 10001, "vehicle": {"model": "Corolla"}} |
+    When I send a POST request to "/api/inspections/byExample?page=0&size=10" with the payload:
+      """
+      {
+        "vehicle": {
+          "model": "Corolla"
+        }
+      }
+      """
+    Then the response status code should be 200
+    And the response should contain "content" with 1 items
+    And the response should contain "pageNumber": 0
+    And the response should contain "pageSize": 10
+
   @get @by_model @sunny_day
   Scenario Outline: Successfully retrieve vehicle inspections by model with pagination
     Given the following vehicle inspections exist:
@@ -106,3 +124,14 @@ Feature: Vehicle Inspection REST API - Core CRUD Operations
     And the response should contain "content" with 0 items
     And the response should contain "pageNumber": 0
     And the response should contain "pageSize": 10
+
+  @get @by_model @sunny_day
+  Scenario: Retrieve no vehicle inspections for a non-existent model
+    Given the following vehicle inspections do not exist:
+      | vehicleinspection                     |
+      | {"vehicle.model": "NonExistentModel"} |
+    When I send a GET request to "/api/inspections/model/NonExistentModel"
+    Then the response status code should be 200
+    And the response should contain "content" with 0 items
+    And the response should contain "pageNumber": 0
+    And the response should contain "pageSize": 10

memex/templates/controller/Controller.java.template

@@ -114,17 +114,15 @@ public class __className__Controller {
 
     /**
      * Get by example with pagination.
-     * TODO: Customize this endpoint for your specific query needs
+     * Don't forget to add indexes as required.
      */
-    @GetMapping("/__apiPath__/byExample")
+
+    @PostMapping("/__apiPath__/byExample")
     public ResponseEntity<PageDto<__className__>> getByExample(
+            @RequestBody __className__ example,
             @RequestParam(name = "page", required = false, defaultValue = "0") int page,
             @RequestParam(name = "size", required = false, defaultValue = "10") int size) {
 
-        // TODO: Build your example/probe object based on request parameters
-        __className__ example = new __className__();
-        // example.setSomeField(someValue);
-
         Slice<__className__> returnPage = queryService.getByExample(example, page, size);
         PageDto<__className__> entity = new PageDto<>(returnPage);
         return ResponseEntity.ok(entity);