DPL-110: Group arbitrary tubes

app/assets/stylesheets/limber/screen.scss

@@ -79,6 +79,13 @@ button#btnGroupInboxes, button#btnGroupRobots, button#btnGroupWip {
   @extend .btn-block;
 }
 
+#btnNewTubeRack {
+  @extend .btn;
+  @extend .btn-primary;
+  @extend .btn-lg;
+  @extend .btn-block;
+}
+
 #btnPipelinesOverview {
   @extend .btn;
   @extend .btn-primary;

app/javascript/multi-stamp-tubes/components/MultiStampTubes.spec.js

@@ -89,7 +89,7 @@ describe('MultiStampTubes', () => {
     wrapper.vm.updateTube(2, tube1)
     const validator = wrapper.vm.scanValidation[0]
     const validations = validator(tube1.labware)
-    
+
     expect(validations.valid).toEqual(true)
   })
 

app/javascript/multi-stamp-tubes/components/MultiStampTubes.vue

@@ -76,7 +76,8 @@ import devourApi from 'shared/devourApi'
 import resources from 'shared/resources'
 import { buildTubeObjs } from 'shared/tubeHelpers'
 import { transfersForTubes } from 'shared/transfersLayouts'
-import { checkDuplicates, validTubeScanMessage } from 'shared/components/tubeScanValidators'
+import { checkDuplicates } from 'shared/components/tubeScanValidators'
+import { validScanMessage } from 'shared/components/scanValidators'
 import { indexToName } from 'shared/wellHelpers'
 
 export default {
@@ -203,7 +204,7 @@ export default {
     scanValidation() {
       if (this.allowTubeDuplicates === 'true') {
         return [
-          validTubeScanMessage
+          validScanMessage
         ]
       }
       const currTubes = this.tubes.map(tubeItem => tubeItem.labware)

app/javascript/packs/application.js

@@ -14,6 +14,7 @@ require('qc-information')
 require('multi-stamp')
 require('multi-stamp-tubes')
 require('custom-tagged-plate')
+require('tubes-to-rack')
 
 // Load simple javscripts
 // Tag animations rotates the displayed tag Id in wells with multiple tags

app/javascript/shared/components/LabwareScan.spec.js

@@ -13,6 +13,19 @@ describe('LabwareScan', () => {
   const nullTube = { data: [] }
   const goodTube = jsonCollectionFactory('tube', [{ uuid: assetUuid }])
 
+  const wrapperFactoryPlate = function(api = mockApi()) {
+    return mount(LabwareScan, {
+      propsData: {
+        labwareType: 'plate',
+        label: 'My Plate',
+        description: 'Scan it in',
+        api: api.devour,
+        includes: '',
+        colourIndex: 3
+      },
+      localVue
+    })
+  }
 
   const wrapperFactoryTube = function(api = mockApi()) {
     return mount(LabwareScan, {
@@ -61,13 +74,50 @@ describe('LabwareScan', () => {
     expect(wrapper.find('.text-muted').text()).toEqual('Scan it in')
   })
 
+  it('renders the correct placeholder for a plate', () => {
+    const wrapper = wrapperFactoryPlate()
+
+    expect(wrapper.find('input').element.placeholder).toEqual('Scan plate')
+  })
+
+  it('renders the correct placeholder for a tube', () => {
+    const wrapper = wrapperFactoryTube()
+
+    expect(wrapper.find('input').element.placeholder).toEqual('Scan tube')
+  })
+
   it('renders disabled if the disabled prop is set true', () => {
     const wrapper = wrapperFactoryTubeDisabled()
 
     expect(wrapper.find('input').element.disabled).toBe(true)
   })
 
   it('is invalid if it can not find a plate', async () => {
+    const api = mockApi()
+    api.mockGet('plates', {
+      filter: { barcode: 'not a barcode' },
+      include: '',
+      fields: { plates: 'labware_barcode,uuid,number_of_rows,number_of_columns' }
+    }, nullTube)
+    const wrapper = wrapperFactoryPlate(api)
+
+    wrapper.find('input').setValue('not a barcode')
+    await wrapper.find('input').trigger('change')
+
+    expect(wrapper.find('.wait-plate').exists()).toBe(true)
+
+    await flushPromises()
+
+    expect(wrapper.find('.invalid-feedback').text()).toEqual('Could not find plate')
+    expect(wrapper.emitted()).toEqual({
+      change: [
+        [{ state: 'searching', plate: null }],
+        [{ state: 'invalid', plate: undefined }]
+      ]
+    })
+  })
+
+  it('is invalid if it can not find a tube', async () => {
     const api = mockApi()
     api.mockGet('tubes', {
       filter: { barcode: 'not a barcode' },
@@ -83,7 +133,7 @@ describe('LabwareScan', () => {
 
     await flushPromises()
 
-    expect(wrapper.find('.invalid-feedback').text()).toEqual('Could not find labware')
+    expect(wrapper.find('.invalid-feedback').text()).toEqual('Could not find tube')
     expect(wrapper.emitted()).toEqual({
       change: [
         [{ state: 'searching', labware: null }],

app/javascript/shared/components/LabwareScan.vue

@@ -2,11 +2,13 @@
   <div>
     <b-container>
       <b-row>
-        <b-col v-if="labwareType=='tube'"
+        <b-col
+          v-if="labwareType=='tube'"
           cols="1"
         >
           <div :class="['pool-colours']">
-            <div :id="'well_index_' + colourIndex"
+            <div
+              :id="'well_index_' + colourIndex"
               class="well"
             >
               <span :class="['aliquot', colourClass]" />
@@ -31,7 +33,7 @@
               type="text"
               :state="formState"
               size="lg"
-              placeholder="Scan labware"
+              :placeholder="'Scan ' + labwareType"
               :disabled="scanDisabled"
               @change="lookupLabware"
             />
@@ -44,7 +46,8 @@
 
 <script>
 
-import { checkSize, aggregate } from './plateScanValidators'
+import { checkSize } from './plateScanValidators'
+import { aggregate } from './scanValidators'
 
 // Incrementing counter to ensure all instances of LabwareScan
 // have a unique id. Ensures labels correctly match up with
@@ -152,7 +155,7 @@ export default {
       if (this.labware === null) {
         return { state: 'empty', message: '' }
       } else if (this.labware === undefined) {
-        return { state: 'invalid', message: 'Could not find labware' }
+        return { state: 'invalid', message: `Could not find ${this.labwareType}` }
       } else {
         const result = aggregate(this.computedValidators, this.labware)
         return { state: boolToString[result.valid], message: result.message }

app/javascript/shared/components/plateScanValidators.js

@@ -36,8 +36,10 @@
 //
 // Validating multiple criteria
 // Try and keep validators checking one thing only. It makes them easier to
-// test and reuse. The aggregate validator allows you to combine multiple
-// validators together.
+// test and reuse. Multiple validators can be combined together using the aggregate
+// function in scanValidators.js
+
+import { validScanMessage } from './scanValidators'
 
 // Returns a validator which ensures the plate is of a particular size.
 // For example, to validate your typical 12*8 96 well plate: checkSize(12,8)
@@ -50,7 +52,7 @@ const checkSize = (cols, rows) => {
       return { valid: false, message: `The plate should be ${cols}×${rows} wells in size` }
     }
     else {
-      return { valid: true, message: 'Great!' }
+      return validScanMessage()
     }
   }
 }
@@ -69,7 +71,7 @@ const checkDuplicates = (plateList) => {
       return { valid: false, message: 'Barcode has been scanned multiple times' }
     }
     else {
-      return { valid: true, message: 'Great!' }
+      return validScanMessage()
     }
   }
 }
@@ -92,7 +94,7 @@ const checkExcess = (excessTransfers) => {
       return { valid: false, message: 'Wells in excess: ' + excessWells.join(', ') }
     }
     else {
-      return { valid: true, message: 'Great!' }
+      return validScanMessage()
     }
   }
 }
@@ -106,7 +108,7 @@ const checkState = (allowedStatesList) => {
     if(!allowedStatesList.includes(plate.state)) {
       return { valid: false, message: 'Plate must have a state of: ' + allowedStatesList.join(' or ') }
     } else {
-      return { valid: true, message: 'Great!' }
+      return validScanMessage()
     }
   }
 }
@@ -123,21 +125,9 @@ const checkQCableWalkingBy = (allowedWalkingByList) => {
     if(!allowedWalkingByList.includes(qcable.lot.tag_layout_template.walking_by)) {
       return { valid: false, message: 'QCable layout must have a walking by of: ' + allowedWalkingByList.join(' or ') }
     } else {
-      return { valid: true, message: 'Great!' }
+      return validScanMessage()
     }
   }
 }
 
-// Receives an array of validators and calls them in the order they appear on
-// the array.
-// As a result, the smallest indexed failing validator will determine the
-// error message and the remaining validators will be skipped.
-// eg. aggregate([checkSize(12, 8), checkDuplicates(this.plates, 0)], plate)
-// will return a validator which checks first the size of the plate, then duplications.
-const aggregate = (validators, item) => {
-  return validators.reduce((aggregate, validator) => {
-    return aggregate.valid ? validator(item) : aggregate
-  }, { valid: true, message: 'Great!'})
-}
-
-export { checkSize, checkDuplicates, checkExcess, checkState, checkQCableWalkingBy, aggregate }
+export { checkSize, checkDuplicates, checkExcess, checkState, checkQCableWalkingBy }

app/javascript/shared/components/plateScanValidators.spec.js

@@ -1,18 +1,4 @@
-import { checkSize, checkDuplicates, checkExcess, checkState, checkQCableWalkingBy, aggregate } from 'shared/components/plateScanValidators'
-
-describe('aggregate', () => {
-  const validFunction = (_) => { return { valid: true, message: 'Good' } }
-  const invalidFunction = (_) => { return { valid: false, message: 'Bad' } }
-
-  it('is valid if all functions are valid', () => {
-    expect(aggregate([validFunction, validFunction], {})).toEqual({ valid: true, message: 'Good' })
-  })
-
-  it('is invalid if any functions are invalid', () => {
-    expect(aggregate([validFunction, invalidFunction], {})).toEqual({ valid: false, message: 'Bad' })
-    expect(aggregate([invalidFunction, validFunction], {})).toEqual({ valid: false, message: 'Bad' })
-  })
-})
+import { checkSize, checkDuplicates, checkExcess, checkState, checkQCableWalkingBy } from 'shared/components/plateScanValidators'
 
 describe('checkSize', () => {
   it('is valid if the plate is the correct size', () => {

app/javascript/shared/components/scanValidators.js

@@ -0,0 +1,18 @@
+// Receives an array of validators and calls them in the order they appear on
+// the array.
+// As a result, the smallest indexed failing validator will determine the
+// error message and the remaining validators will be skipped.
+const aggregate = (validators, item) => {
+  return validators.reduce((aggregate, validator) => {
+    return aggregate.valid ? validator(item) : aggregate
+  }, validScanMessage())
+}
+
+// Return object for a valid scan
+//
+// Returns an object with a scan validation message
+const validScanMessage = () => {
+  return { valid: true, message: 'Great!' }
+}
+
+export { aggregate, validScanMessage }

app/javascript/shared/components/scanValidators.spec.js

@@ -0,0 +1,21 @@
+import { aggregate, validScanMessage } from 'shared/components/scanValidators'
+
+describe('aggregate', () => {
+  const validFunction = (_) => { return { valid: true, message: 'Good' } }
+  const invalidFunction = (_) => { return { valid: false, message: 'Bad' } }
+
+  it('is valid if all functions are valid', () => {
+    expect(aggregate([validFunction, validFunction], {})).toEqual({ valid: true, message: 'Good' })
+  })
+
+  it('is invalid if any functions are invalid', () => {
+    expect(aggregate([validFunction, invalidFunction], {})).toEqual({ valid: false, message: 'Bad' })
+    expect(aggregate([invalidFunction, validFunction], {})).toEqual({ valid: false, message: 'Bad' })
+  })
+})
+
+describe('validScanMessage', () => {
+  it('provides a valid scan result object', () => {
+    expect(validScanMessage()).toEqual({ valid: true, message: 'Great!' })
+  })
+})

app/javascript/shared/components/tubeScanValidators.js

@@ -2,7 +2,7 @@
 // provide custom validation.
 //
 // A validator is a function which:
-// 1) Takes the result of the APi query (usually a tube) as a sole argument
+// 1) Takes the result of the API query (usually a tube) as a sole argument
 // 2) Returns javascript object with two properties:
 //    a) valid: A Boolean indicating if the tube is suitable or not
 //    b) message: A string which will be displayed to the user. Especially
@@ -35,9 +35,11 @@
 //}
 //
 // Validating multiple criteria
-// Try and keep validators checking one thing only. It makes them easier to
-// test and reuse. The aggregate validator allows you to combine multiple
-// validators together.
+// Try and keep validators checking one thing only. It makes them easier to test
+// and reuse. Multiple validators can be combined together using the aggregate
+// function in scanValidators.js
+
+import { validScanMessage } from './scanValidators'
 
 // Returns a validator that ensures that the scanned item does not appear
 // multiple times in the list (based on UUID).
@@ -53,16 +55,25 @@ const checkDuplicates = (tubeList) => {
       return { valid: false, message: 'Barcode has been scanned multiple times' }
     }
     else {
-      return validTubeScanMessage()
+      return validScanMessage()
     }
   }
 }
 
-// Renders a valid Tube scan
-// 
-// Returns an object with the right tube scan validation message
-const validTubeScanMessage = () => {
-  return { valid: true, message: 'Great!' }
+// Returns a validator that ensures the purpose namess of all the tubes match
+// the name for the one provided. Typically the one provided should be the one
+// of the purposes from the full set of tubes being validated.
+const checkMatchingPurposes = (purpose) => {
+  return (tube) => {
+    if (tube && purpose && tube.purpose.name !== purpose.name) {
+      return {
+        valid: false,
+        message: `Tube purpose '${tube.purpose.name}' doesn't match other tubes`
+      }
+    }
+
+    return validScanMessage()
+  }
 }
 
 // Returns a validator that ensures the tube has a state that matches to the
@@ -74,19 +85,9 @@ const checkState = (allowedStatesList) => {
     if(!allowedStatesList.includes(tube.state)) {
       return { valid: false, message: 'Tube must have a state of: ' + allowedStatesList.join(' or ') }
     } else {
-      return { valid: true, message: 'Great!' }
+      return validScanMessage()
     }
   }
 }
 
-// Receives an array of validators and calls them in the order they appear on
-// the array.
-// As a result, the smallest indexed failing validator will determine the
-// error message and the remaining validators will be skipped.
-const aggregate = (validators, item) => {
-  return validators.reduce((aggregate, validator) => {
-    return aggregate.valid ? validator(item) : aggregate
-  }, { valid: true, message: 'Great!'})
-}
-
-export { checkDuplicates, checkState, aggregate, validTubeScanMessage }
+export { checkDuplicates, checkMatchingPurposes, checkState }