Changeset 441 for trunk/grails-app/services

Timestamp:

Mar 16, 2010, 12:00:04 PM (15 years ago)

Author:

gav

Message:

Add CostCode and InventoryItemPurchase domain classes with import features.
Includes some fixes to inventory imports, where manufacturer and supplier were crossed.

Location:

trunk/grails-app/services

Files:

• CreateDataService.groovy (modified) (4 diffs)
• InventoryCsvService.groovy (modified) (15 diffs)
• InventoryItemService.groovy (modified) (3 diffs)
• InventoryPurchaseService.groovy (added)

trunk/grails-app/services/CreateDataService.groovy

@@ -62 +62 @@
         createBaseAddressTypes()
         createBaseContactTypes()
+        createBaseInventoryItemPurchaseTypes()
 
         // Tasks
@@ -113 +114 @@
         createDemoManufacturers()
         createDemoProductionReference()
+        createDemoCostCodes()
 
         // Tasks
@@ -612 +614 @@
     }
 
+    def createBaseInventoryItemPurchaseTypes() {
+
+        // InventoryItemPurchaseType
+        def inventoryItemPurchaseTypeInstance
+
+        // InventoryItemPurchaseType #1
+        inventoryItemPurchaseTypeInstance = new InventoryItemPurchaseType(name: "Order Placed",
+                                                                                description: "Order has been placed.")
+        saveAndTest(inventoryItemPurchaseTypeInstance)
+
+        // InventoryItemPurchaseType #2
+        inventoryItemPurchaseTypeInstance = new InventoryItemPurchaseType(name: "Received B/order To Come",
+                                                                                description: "Order has been partially received.")
+        saveAndTest(inventoryItemPurchaseTypeInstance)
+        // InventoryItemPurchaseType #3
+        inventoryItemPurchaseTypeInstance = new InventoryItemPurchaseType(name: "Received Complete",
+                                                                                description: "Order has been partially received.")
+        saveAndTest(inventoryItemPurchaseTypeInstance)
+
+        // InventoryItemPurchaseType #4
+        inventoryItemPurchaseTypeInstance = new InventoryItemPurchaseType(name: "Invoice Approved",
+                                                                                description: "Invoice approved for payment.")
+        saveAndTest(inventoryItemPurchaseTypeInstance)
+    }
+
     def createDemoSuppliers() {
 
@@ -656 +683 @@
         productionReferenceInstance = new ProductionReference(name: "Tuesday Production")
         saveAndTest(productionReferenceInstance)
+    }
+
+    def createDemoCostCodes() {
+
+        // CostCode
+        def costCodeInstance
+
+        // CostCode #1
+        costCodeInstance = new CostCode(name: "RM Reelstand")
+        saveAndTest(costCodeInstance)
+
+        // CostCode #2
+        costCodeInstance = new CostCode(name: "CAPEX Reelstand")
+        saveAndTest(costCodeInstance)
     }
 

trunk/grails-app/services/InventoryCsvService.groovy

@@ -11 +11 @@
 
     boolean transactional = false
+
+    def dateUtilService
 
     def g = new org.codehaus.groovy.grails.plugins.web.taglib.ApplicationTagLib()
@@ -47 +49 @@
             if (multiPartFile.getSize() > fileMaxSize)
                 return fail(code: "default.file.over.max.size", args: [fileMaxSize/kByteMultiplier, "kB"])
-
-            //TODO: delete
-            def columnValue = ''
-            def columnIndex = 0
-            def numberOfColumns = 0
 
             def line = []
@@ -105 +102 @@
             def tempAlternateItems = []
 
-            def column = ''
-
             def nextLine = {
                     line = reader.readNext()
                     lineNumber ++
                     log.info "Processing line: " + lineNumber
-            }
-
-            def nextColumn = {
-
-                if( columnIndex < numberOfColumns ) {
-                        column = line[columnIndex].trim()
-                }
-                else {
-                    log.info "No more columns on line: " + lineNumber
-                    return false
-                }
-
-                columnIndex++
-                // Success.
-                return column
             }
 
@@ -280 +260 @@
                         // Manufacturer Type.
                         if(tempPreferredManufacturerItemAndType.size == 2) {
-                            tempPreferredManufacturerType = WordUtils.capitalizeFully(tempPreferredManufacturerItemAndType[1])
+                            tempPreferredManufacturerType = WordUtils.capitalize(tempPreferredManufacturerItemAndType[1])
                             manufacturerTypeInstance = ManufacturerType.findByName(tempPreferredManufacturerType)
                         }
@@ -291 +271 @@
 
                         preferredManufacturerInstance = new Manufacturer(name: tempPreferredManufacturerItem,
-                                                                                                            supplierType: manufacturerTypeInstance)
+                                                                                                            manufacturerType: manufacturerTypeInstance)
                         if(!preferredManufacturerInstance.save()) {
                             log.error "Failed to create preferred manufacturer on line: " + lineNumber
@@ -302 +282 @@
 
                 // Alternate Manufacturers.
-                tempAlternateManufacturers = parseInputList(inventoryParams.manufacturers)
-                inventoryParams.manufacturers = []
+                tempAlternateManufacturers = parseInputList(inventoryParams.alternateManufacturers)
+                inventoryParams.alternateManufacturers = []
 
                 for(tempManufacturer in tempAlternateManufacturers) {
@@ -309 +289 @@
                     tempManufacturerItem = WordUtils.capitalizeFully(tempManufacturerItemAndType[0])
 
-                    manufacturerInstance = Manufacturer.findByName(tempManufacturerItem)
-                    if(!manufacturerInstance) {
+                    alternateManufacturerInstance = Manufacturer.findByName(tempManufacturerItem)
+                    if(!alternateManufacturerInstance) {
 
                         // ManufacturerType.
                         if(tempManufacturerItemAndType.size == 2) {
-                            tempManufacturerType = WordUtils.capitalizeFully(tempManufacturerItemAndType[1])
+                            tempManufacturerType = WordUtils.capitalize(tempManufacturerItemAndType[1])
                             manufacturerTypeInstance = ManufacturerType.findByName(tempManufacturerType)
                         }
@@ -324 +304 @@
                         }
 
-                        manufacturerInstance = new Manufacturer(name: tempManufacturerItem,
+                        alternateManufacturerInstance = new Manufacturer(name: tempManufacturerItem,
                                                                                                 manufacturerType: manufacturerTypeInstance)
-                        if(!manufacturerInstance.save()) {
+                        if(!alternateManufacturerInstance.save()) {
                             log.error "Failed to create manufacturers on line: " + lineNumber
                             return fail(code: "inventory.import.failure", args: [lineNumber, logFileLink])
@@ -332 +312 @@
                     }
 
-                    inventoryParams.manufacturers.add(manufacturerInstance)
+                    inventoryParams.alternateManufacturers.add(alternateManufacturerInstance)
                 }
 
@@ -345 +325 @@
                         // SupplierType.
                         if(tempPreferredSupplierItemAndType.size == 2) {
-                            tempPreferredSupplierType = WordUtils.capitalizeFully(tempPreferredSupplierItemAndType[1])
+                            tempPreferredSupplierType = WordUtils.capitalize(tempPreferredSupplierItemAndType[1])
                             supplierTypeInstance = SupplierType.findByName(tempPreferredSupplierType)
                         }
@@ -379 +359 @@
                         // SupplierType.
                         if(tempSupplierItemAndType.size == 2) {
-                            tempSupplierType = WordUtils.capitalizeFully(tempSupplierItemAndType[1])
+                            tempSupplierType = WordUtils.capitalize(tempSupplierItemAndType[1])
                             supplierTypeInstance = SupplierType.findByName(tempSupplierType)
                         }
@@ -397 +377 @@
                     }
 
-                    inventoryParams.suppliers.add(alternateSupplierInstance)
+                    inventoryParams.alternateSuppliers.add(alternateSupplierInstance)
                 }
 
@@ -475 +455 @@
                 // Save inventoryItem.
                 if(inventoryItemInstance.hasErrors() || !inventoryItemInstance.save()) {
-                    log.error "Failed to create item on line: " + column + "(" + lineNumber + ")"
+                    log.error "Failed to create item on line: " + lineNumber
                     log.debug inventoryItemInstance.errors
                     return fail(code: "inventory.import.failure", args: [lineNumber, logFileLink])
@@ -641 +621 @@
         writer.close()
         return sw.toString()
-    } // end buildInventory
+    } // end buildInventory()
+
+    /**
+    * Import inventoryItemPurchases creating items as required.
+    */
+    def importInventoryItemPurchases(request) {
+        InventoryItemPurchase.withTransaction { status ->
+            def result = [:]
+
+            def kByteMultiplier = 1000
+            def fileMaxSize = 800 * kByteMultiplier
+            def logFileLink = g.link(controller: "appCore", action: "appLog") {"log"}
+
+            def multiPartFile = request.getFile('file')
+
+            InputStreamReader sr = new InputStreamReader(multiPartFile.inputStream)
+            CSVReader reader = new CSVReader(sr)
+
+            def fail = { Map m ->
+                status.setRollbackOnly()
+                reader.close()
+                result.error = [ code: m.code, args: m.args ]
+                return result
+            }
+
+            if(!multiPartFile || multiPartFile.isEmpty())
+                return fail(code: "default.file.not.supplied")
+
+            if (multiPartFile.getSize() > fileMaxSize)
+                return fail(code: "default.file.over.max.size", args: [fileMaxSize/kByteMultiplier, "kB"])
+
+            def line = []
+            def lineNumber = 0
+            def maxNumberOfColumns = 10
+            def inventoryItemPurchaseParams = [:]
+            def inventoryItemPurchaseProperties = ["inventoryItem", "purchaseOrderNumber", "quantity",
+                                                                                "inventoryItemPurchaseType",
+                                                                                "costCode", "enteredBy", "dateEntered",
+                                                                                "orderValueAmount", "orderValueCurrency", "invoiceNumber"]
+
+            def personInstance
+            def costCodeInstance
+            def inventoryItemInstance
+            def inventoryItemPurchaseInstance
+            def inventoryItemPurchaseTypeInstance
+
+            def nextLine = {
+                    line = reader.readNext()
+                    lineNumber ++
+                    log.info "Processing line: " + lineNumber
+            }
+
+            def parseInputDate = {
+                if( (it == null) || (it.trim() == '') ) {
+                    log.error "Failed to find any date on line: " + lineNumber
+                    return fail(code: "inventoryItemPurchase.import.failure", args: [lineNumber, logFileLink])
+                }
+
+                def d = it.split("/").collect{it.trim()}
+                if(d.size() != 3) {
+                    log.error "Failed to find full date on line: " + lineNumber
+                    return fail(code: "inventoryItemPurchase.import.failure", args: [lineNumber, logFileLink])
+                }
+                dateUtilService.makeDate(d[0], d[1], d[2])
+            }
+
+            // Get first line.
+            nextLine()
+
+            // Check for header line 1.
+            if(line != purchasesTemplateHeaderLine1) {
+                log.error "Failed to find header line 1. "
+                log.error "Required: " + purchasesTemplateHeaderLine1.toString()
+                log.error "Supplied: " + line.toString()
+                return fail(code: "default.file.no.header")
+            }
+
+            log.info "Header line found."
+
+            // Prepare the first body line.
+            nextLine()
+
+            // Primary loop.
+            while(line) {
+
+                if(line.size() > maxNumberOfColumns) {
+                    log.error "Too many columns on line: " + lineNumber
+                    return fail(code: "inventoryItemPurchase.import.failure", args: [lineNumber, logFileLink])
+                }
+
+                // Ignore comment lines.
+                if(line.toString().toLowerCase().contains("comment")) {
+                    log.info "Comment line found."
+                    nextLine()
+                    continue
+                }
+
+                // Ignore example lines.
+                if(line.toString().toLowerCase().contains("example")) {
+                    log.info "Example line found."
+                    nextLine()
+                    continue
+                }
+
+                // Parse the line into the params map.
+                inventoryItemPurchaseParams = [:]
+                line.eachWithIndex { it, j ->
+                    inventoryItemPurchaseParams."${inventoryItemPurchaseProperties[j]}" = it.trim()
+                }
+
+                // Debug
+                log.debug " Supplied params: "
+                log.debug inventoryItemPurchaseParams
+
+                // Ignore blank lines.
+                if(inventoryItemPurchaseParams.inventoryItem == '') {
+                    log.info "No inventory item name found."
+                    nextLine()
+                    continue
+                }
+
+                // Inventory Item.
+                inventoryItemPurchaseParams.inventoryItem = WordUtils.capitalize(inventoryItemPurchaseParams.inventoryItem)
+                inventoryItemInstance = InventoryItem.findByName(inventoryItemPurchaseParams.inventoryItem)
+                if(!inventoryItemInstance) {
+                    log.error "Inventory item not found on line: " + lineNumber
+                    return fail(code: "inventoryItemPurchase.import.failure", args: [lineNumber, logFileLink])
+                }
+                inventoryItemPurchaseParams.inventoryItem = inventoryItemInstance
+
+                // Quantity.
+                if(inventoryItemPurchaseParams.quantity.isInteger())
+                    inventoryItemPurchaseParams.quantity = inventoryItemPurchaseParams.quantity.toInteger()
+                else {
+                    log.error "Quantity is not a valid number on line: " + lineNumber
+                    return fail(code: "inventoryItemPurchase.import.failure", args: [lineNumber, logFileLink])
+                }
+
+                // InventoryItemPurchaseType.
+                inventoryItemPurchaseParams.inventoryItemPurchaseType = WordUtils.capitalizeFully(inventoryItemPurchaseParams.inventoryItemPurchaseType)
+                inventoryItemPurchaseTypeInstance = InventoryItemPurchaseType.findByName(inventoryItemPurchaseParams.inventoryItemPurchaseType)
+                if(!inventoryItemPurchaseTypeInstance) {
+                    log.error "Inventory item purchase type not found on line: " + lineNumber
+                    log.debug inventoryItemPurchaseParams.inventoryItemPurchaseType
+                    return fail(code: "inventoryItemPurchase.import.failure", args: [lineNumber, logFileLink])
+                }
+                inventoryItemPurchaseParams.inventoryItemPurchaseType = inventoryItemPurchaseTypeInstance
+
+                // CostCode.
+                if(inventoryItemPurchaseParams.costCode != '') {
+                    inventoryItemPurchaseParams.costCode = WordUtils.capitalizeFully(inventoryItemPurchaseParams.costCode)
+                    costCodeInstance = CostCode.findByName(inventoryItemPurchaseParams.costCode)
+                    if(!costCodeInstance) {
+                        costCodeInstance = new CostCode(name: inventoryItemPurchaseParams.costCode)
+                        if(!costCodeInstance.save()) {
+                            log.error "Failed to create cost code on line: " + lineNumber
+                            return fail(code: "inventoryItemPurchase.import.failure", args: [lineNumber, logFileLink])
+                        }
+                    }
+                    inventoryItemPurchaseParams.costCode = costCodeInstance
+                }
+
+                // Entered By.
+                inventoryItemPurchaseParams.enteredBy = inventoryItemPurchaseParams.enteredBy.toLowerCase()
+                personInstance = Person.findByLoginName(inventoryItemPurchaseParams.enteredBy)
+                if(!personInstance) {
+                    log.error "Entered by person not found on line: " + lineNumber
+                    return fail(code: "inventoryItemPurchase.import.failure", args: [lineNumber, logFileLink])
+                }
+                inventoryItemPurchaseParams.enteredBy = personInstance
+
+                // Date Entered.
+                inventoryItemPurchaseParams.dateEntered = parseInputDate(inventoryItemPurchaseParams.dateEntered)
+
+                // Debug
+                log.debug "InventoryItemPurchaseParams: "
+                log.debug inventoryItemPurchaseParams
+
+                // Save inventoryItem.
+                log.info "Creating new purchase."
+                inventoryItemPurchaseInstance = new InventoryItemPurchase(inventoryItemPurchaseParams)
+
+                if(inventoryItemPurchaseInstance.hasErrors() || !inventoryItemPurchaseInstance.save()) {
+                    log.error "Failed to create item on line: " + lineNumber
+                    log.debug inventoryItemPurchaseInstance.errors
+                    return fail(code: "inventoryItemPurchase.import.failure", args: [lineNumber, logFileLink])
+                }
+
+                if(lineNumber % 100 == 0)
+                    cleanUpGorm()
+
+                if(!result.error) nextLine()
+            } //while(line)
+
+            // Success.
+            log.info "End of file."
+            reader.close()
+            return result
+
+
+         } //end withTransaction
+    } // end importInventoryItemPurchases()
 
     private getTemplateHeaderLine1() {
@@ -648 +829 @@
             "Average Delivery Time", "Average Delivery Period", "Supplier's Part Number", "Preferred Supplier", "Alternate Suppliers",
             "Manufacturer's Part Number", "Preferred Manufacturer", "Alternate Manufacturers", "Alternate Item", "Spare For"]
+    }
+
+    private getPurchasesTemplateHeaderLine1() {
+            ["Inventory Item*", "Purchase Order Number", "Quantity*", "Purchase Type*", "Cost Code*", "Entered By*",
+            "Date Entered*", "Order Value", "Currency", "Invoice Number"]
     }
 

trunk/grails-app/services/InventoryItemService.groovy

@@ -28 +28 @@
     def show(params) {
         def result = [:]
+
         def fail = { Map m ->
             result.error = [ code: m.code, args: ["InventoryItem", params.id] ]
@@ -37 +38 @@
         if(!result.inventoryItemInstance)
             return fail(code:"default.not.found")
+
+        def p = [:]
+
+        if(params.paginate == "purchases") {
+            params.showTab = "showPurchasingTab"
+            p.max = Math.min(params.max?.toInteger() ?: 10, 100)
+            p.offset = params.offset?.toInteger() ?: 0
+            p.sort = params.sort ?: null
+            p.order = params.order ?: null
+        }
+        else {
+            p.max = 10
+            p.offset = 0
+        }
+
+        result.inventoryItemPurchasesTotal = InventoryItemPurchase.countByInventoryItem(result.inventoryItemInstance)
+
+        result.inventoryItemPurchases = InventoryItemPurchase.withCriteria {
+                eq("inventoryItem", result.inventoryItemInstance)
+                maxResults(p.max)
+                firstResult(p.offset)
+                // Sorting:
+                // Default is to sort by order number then id.
+                // When a sortable column is clicked then we sort by that.
+                // If the sortable column clicked is order number then we add id as the second sort.
+                if(p.sort && p.order) {
+                    order(p.sort, p.order)
+                    if(p.sort == "purchaseOrderNumber") order('id', 'asc')
+                }
+                else {
+                    order('purchaseOrderNumber', 'desc')
+                    order('id', 'asc')
+                }
+            }
 
         result.showTab = [:]
@@ -46 +81 @@
                 result.showTab.movement =  new String("true")
                 break
+            case "showPurchasingTab":
+                result.showTab.purchasing =  new String("true")
+                break
             default:
                 result.showTab.inventory = new String("true")
         }
 
-        def p = [:]
         p.max = result.inventoryMovementListMax = 10
+        p.offset = 0
         p.order = "desc"
         p.sort = "id"
         result.inventoryMovementList = InventoryMovement.findAllByInventoryItem(result.inventoryItemInstance, p)
         result.inventoryMovementListTotal = InventoryMovement.countByInventoryItem(result.inventoryItemInstance)
+
 
         // Success.