Initial commit

.gitignore

@@ -1,3 +1,9 @@
+# IDE
+.idea
+
+# OS X
+.DS_Store
+
 # Logs
 logs
 *.log
@@ -13,6 +19,7 @@ lib-cov
 
 # Coverage directory used by tools like istanbul
 coverage
+.nyc_output
 
 # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
 .grunt

.travis.yml

@@ -0,0 +1,6 @@
+language: node_js
+node_js:
+  - "4"
+  - "5"
+after_success:
+  - npm run coveralls

README.md

@@ -1,2 +1,51 @@
+[![Build Status](https://travis-ci.org/telemark/tfk-saksbehandling-elev-varsel-templates.svg?branch=master)](https://travis-ci.org/telemark/tfk-saksbehandling-elev-varsel-templates)
+[![Coverage Status](https://coveralls.io/repos/telemark/tfk-saksbehandling-elev-varsel-templates/badge.svg?branch=master&service=github)](https://coveralls.io/github/telemark/tfk-saksbehandling-elev-varsel-templates?branch=master)
+[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](https://github.com/feross/standard)
 # tfk-saksbehandling-elev-varsel-templates
-Templates for the tfk-saksbehandling-elev-varsel ecosystem
+Maler for tfk-saksbehandling-elev-varsel økosystemet.
+
+Oversikt over alle malene og koder for de ulike ligger [her](docs/templates.md)
+
+## Installasjon
+
+Fra npm
+
+```sh
+$ npm install --save tfk-saksbehandling-elev-varsel-templates
+```
+
+Fra GitHub
+
+```sh
+$ git clone git@github.com:telemark/tfk-saksbehandling-elev-varsel-templates.git
+```
+
+Deretter går du inn i mappen og kjører setup
+
+```sh
+$ npm run setup
+```
+
+## Bruk
+
+Send inn id på malen du skal benytte og få fullstendig filbane i retur.
+
+Maler
+- atferd
+- fag
+- foresatte
+- hemmelig-adresse
+- orden
+
+```javascript
+'use strict'
+
+var getTemplatePath = require('tfk-saksbehandling-elev-varsel-templates')
+
+console.log(getTemplatePath('orden'))
+
+//=> path/to/template/orden.docx
+```
+
+## Lisens
+[MIT](LICENSE)

docs/templates.md

@@ -0,0 +1,73 @@
+# Maler
+
+Modulen inneholder 3 maler for varsel og 2 for interne notater dersom det skal distribueres varsel til elever med hemmelig adresse eller
+elever hvor man ikke har fått foresattes adresse fra folkeregisteret.
+
+Varselmalene er [atferd](../templates/atferd.docx), [fag](../templates/fag.docx) og [orden](../templates/orden.docx).
+
+Notatmalene er [hemmelig-adresse](../templates/hemmelig-adresse.docx) og [foresatte](../templates/foresatte.docx)
+
+## Atferd
+Denne malen benyttes dersom det er fare for nedsatt karakter i oppførsel.
+
+Koder som benyttes:
+
+- ```{navnElev}``` Elevens fulle navn
+- ```{navnAvsender}``` Navn på den som sender varselet
+- ```{navnSkole}``` Skolens navn
+- ```{tlfSkole}``` Skolens telefonnummer
+- ```{dato}``` Dato for produksjon av varselet på formatet dd.mm.åååå
+- ```{Arsak}``` Årsak(er) til at varselet sendes. Kan inneholde flere linjer adskilt med ```\n```
+
+## Fag
+Denne malen benyttes dersom det er fare for nedsatt karakter i ett eller flere fag.
+
+Koder som benyttes:
+
+- ```{navnElev}``` Elevens fulle navn
+- ```{navnAvsender}``` Navn på den som sender varselet
+- ```{navnSkole}``` Skolens navn
+- ```{tlfSkole}``` Skolens telefonnummer
+- ```{dato}``` Dato for produksjon av varselet på formatet dd.mm.åååå
+- ```{Arsak}``` Årsak(er) til at varselet sendes. Kan inneholde flere linjer adskilt med ```\n```
+- ```{fag}``` Fag varselet omfatter. Kan inneholde flere linjer adskilt med ```\n```
+
+## Orden
+Denne malen benyttes dersom det er fare for nedsatt karakter i orden.
+
+Koder som benyttes:
+
+- ```{navnElev}``` Elevens fulle navn
+- ```{navnAvsender}``` Navn på den som sender varselet
+- ```{navnSkole}``` Skolens navn
+- ```{tlfSkole}``` Skolens telefonnummer
+- ```{dato}``` Dato for produksjon av varselet på formatet dd.mm.åååå
+- ```{Arsak}``` Årsak(er) til at varselet sendes. Kan inneholde flere linjer adskilt med ```\n```
+
+## Hemmelig adresse
+Denne malen benyttes dersom varselet skal distribueres til elever med hemmelig adresse.
+
+I slike tilfeller vil det produseres og arkiveres et varsel som vanlig, men det sendes et internt notat via sak/arkiv-systemet til elevens skole.
+Deretter vil varselet bli skrevet ut og distribuert etter gjeldende avtale for den enkelte elev.
+
+Koder som benyttes:
+
+- ```{dato}``` Dato for produksjon av notatet på formatet dd.mm.åååå
+- ```{navnElev}``` Elevens fulle navn
+- ```{klasseElev}``` Elevens klasse
+- ```{navnAvsender}``` Navn på den som sender varselet
+- ```{navnSkole}``` Skolen som skal distribuere varselet
+
+## Ikke lik folkeregistrert adresse
+Denne malen benyttes dersom varselet skal distribueres til foresatte og ingen av de man fant på dsf har lik adresse som eleven.
+
+I slike tilfeller vil det produseres og arkiveres et varsel som vanlig, men det sendes et internt notat via sak/arkiv-systemet til elevens skole.
+Deretter vil varselet bli skrevet ut og distribuert etter gjeldende avtale for den enkelte elev.
+
+Koder som benyttes:
+
+- ```{dato}``` Dato for produksjon av notatet på formatet dd.mm.åååå
+- ```{navnElev}``` Elevens fulle navn
+- ```{klasseElev}``` Elevens klasse
+- ```{navnAvsender}``` Navn på den som sender varselet
+- ```{navnSkole}``` Skolen som skal distribuere varselet

example.js

@@ -0,0 +1,5 @@
+'use strict'
+
+var getTemplatePath = require('./index')
+
+console.log(getTemplatePath('orden'))

index.js

@@ -0,0 +1,20 @@
+'use strict'
+
+var path = require('path')
+var templates = require('./templates/templates.json')
+
+function getTemplatePath (id) {
+  if (!id) {
+    throw new Error('Missing required input: template id')
+  }
+
+  var doc = templates[id]
+
+  if (!doc) {
+    throw new Error('Template not found')
+  } else {
+    return path.join(__dirname, 'templates', doc)
+  }
+}
+
+module.exports = getTemplatePath

package.json

@@ -0,0 +1,40 @@
+{
+  "name": "tfk-saksbehandling-elev-varsel-templates",
+  "version": "1.0.0",
+  "description": "Templates for the tfk-saksbehandling-elev-varsel ecosystem",
+  "license": "MIT",
+  "author": {
+    "name": "Geir Gåsodden",
+    "email": "geir.gasodden@pythonia.no",
+    "url": "https://github.com/zrrrzzt"
+  },
+  "main": "index.js",
+  "engines": {
+    "node": ">=4.3.0"
+  },
+  "scripts": {
+    "test": "standard && tap --reporter=spec test/*.js",
+    "coverage": "tap test/*.js --coverage",
+    "coveralls": "tap --cov --coverage-report=lcov test/*.js && cat coverage/lcov.info | coveralls",
+    "setup": "npm install && node setup.js"
+  },
+  "keywords": [
+    "Tfk",
+    "Telemark fylkeskommune",
+    "Saksbehandling",
+    "Varselbrev elever",
+    "Maler"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "http://github.com/telemark/tfk-saksbehandling-elev-varsel-templates.git"
+  },
+  "bugs": {
+    "url": "http://github.com/telemark/tfk-saksbehandling-elev-varsel-templates/issues"
+  },
+  "devDependencies": {
+    "coveralls": "^2.11.6",
+    "standard": "^6.0.4",
+    "tap": "^5.4.3"
+  }
+}

setup.js

@@ -0,0 +1,3 @@
+'use strict'
+
+console.log('Everything\'s shiny, Cap\'n. Not to fret.')

templates/templates.json

@@ -0,0 +1,7 @@
+{
+  "atferd": "atferd.docx",
+  "fag": "fag.docx",
+  "foresatte": "foresatte.docx",
+  "hemmelig-adresse": "hemmelig-adresse.docx",
+  "orden": "orden.docx"
+}

test/get-templates-path-test.js

@@ -0,0 +1,22 @@
+'use strict'
+
+var tap = require('tap')
+var getTemplatePath = require('../index')
+
+tap.ok(getTemplatePath('orden'), 'It returns path if template exists')
+
+tap.throws(
+  function () {
+    getTemplatePath()
+  },
+  {message: 'Missing required input: template id'},
+  'Throws if template id not supplied'
+)
+
+tap.throws(
+  function () {
+    getTemplatePath('finnes-ikke')
+  },
+  {message: 'Template not found'},
+  'Throws if template does not exist'
+)