backend merge requestshttps://gitlab.gwdg.de/subugoe/ahiqar/backend/-/merge_requests2021-01-12T08:53:49Zhttps://gitlab.gwdg.de/subugoe/ahiqar/backend/-/merge_requests/60fix: semantic errors2021-01-12T08:53:49ZMichelle Weidlingfix: semantic errors# Bug fix
## Summary
This MR provides fixes to minor syntax errors that lead to the app not being installed properly.
## Compliance to “Definition of Done”
* [x] Unit tests passed
* [x] Code reviewed
* [ ] Acceptance criteria met
* [...# Bug fix
## Summary
This MR provides fixes to minor syntax errors that lead to the app not being installed properly.
## Compliance to “Definition of Done”
* [x] Unit tests passed
* [x] Code reviewed
* [ ] Acceptance criteria met
* [ ] Functional tests passed
* [ ] Non-Functional requirements met
* [x] Product Owner accepts the User Story
### Closes
Closes #88.
## Changelog
* [x] I added a statement to the CHANGELOG.
## Version number
* [x] I bumped the version number in `build.properties`.
## Readme and general docs
* [x] I updated the README (if applicable) and kept the docs up to date.
/cc [Mathias Göbel](https://gitlab.gwdg.de/mgoebel), [Frank Schneider](https://gitlab.gwdg.de/schneider210), [Michelle Weidling](https://gitlab.gwdg.de/mrodzis)Mathias GoebelMathias Goebelhttps://gitlab.gwdg.de/subugoe/ahiqar/backend/-/merge_requests/59Feature/#51 remove sade2021-01-14T07:41:40ZMichelle WeidlingFeature/#51 remove sade# Feature
## Summary
With this MR Ahiqar no longer relies on SADE for the data transfer from TextGrid to exists, but switches to [TextGrid Connect Standalone](https://gitlab.gwdg.de/SADE/textgrid-connect-standalone) which improves the ...# Feature
## Summary
With this MR Ahiqar no longer relies on SADE for the data transfer from TextGrid to exists, but switches to [TextGrid Connect Standalone](https://gitlab.gwdg.de/SADE/textgrid-connect-standalone) which improves the startup performance of the app as well as the amount of space needed.
This step has the following consequences:
* SADE is removed from the build as well as all its accompanying applications (Code Viewer, SADE assets)
* TextGrid Connect Standalone is installed in SADE's stead
* data is now stored to `/db/data/textgrid` as is described in TextGrid Connect's [README](https://gitlab.gwdg.de/SADE/textgrid-connect-standalone/-/blob/develop/README.md)
* TextGrid Connect is a bit stricter when it comes to publishing data to the database. It will refuse invalid data or XML files that cannot be validated (i.e. files for which no Relax NG is available)
* the scholars will not be able to create SADE forks anymore
## Compliance to “Definition of Done”
* [x] Unit tests passed
* [x] Code reviewed
* [ ] Acceptance criteria met
* [x] Functional tests passed
* [ ] Non-Functional requirements met
* [x] Product Owner accepts the User Story
## Use Cases
See #51.
## Documentation
* [x] I updated the README (if applicable)
* [ ] I provided my functions with appropriate documentation
* [x] I updated existing documentation
## Tests
Are we able to test this new feature?
* [x] Yes, everything can be done via unit tests.
## Changelog
* [x] I added a statement to the CHANGELOG.
## Version number
* [x] I bumped the version number in `build.properties`.
## Related Tickets
Closes #51.
/cc [Mathias Göbel](https://gitlab.gwdg.de/mgoebel), [Frank Schneider](https://gitlab.gwdg.de/schneider210), [Michelle Weidling](https://gitlab.gwdg.de/mrodzis)Ahikar Version 0.14.0Mathias GoebelMathias Goebelhttps://gitlab.gwdg.de/subugoe/ahiqar/backend/-/merge_requests/58Resolve "Rename App"2021-01-13T13:31:41ZMichelle WeidlingResolve "Rename App"# Feature
## Summary
This MR provides an updated name of the application because the old one has been misleading.
## Compliance to “Definition of Done”
* [x] Unit tests passed
* [x] Code reviewed
* [ ] Acceptance criteria met
* [ ] F...# Feature
## Summary
This MR provides an updated name of the application because the old one has been misleading.
## Compliance to “Definition of Done”
* [x] Unit tests passed
* [x] Code reviewed
* [ ] Acceptance criteria met
* [ ] Functional tests passed
* [ ] Non-Functional requirements met
* [x] Product Owner accepts the User Story
## Documentation
* N/A
## Tests
Are we able to test this new feature?
* [x] Yes, you can test by following these steps:
1. build the app locally
2. start the eXist dashboard
3. recognize the app's name
## Changelog
* [x] I added a statement to the CHANGELOG.
## Version number
* [x] I bumped the version number in `build.properties`.
## Related Tickets
Closes #45
/cc [Mathias Göbel](https://gitlab.gwdg.de/mgoebel), [Frank Schneider](https://gitlab.gwdg.de/schneider210), [Michelle Weidling](https://gitlab.gwdg.de/mrodzis)Ahikar Version 0.14.0Mathias GoebelMathias Goebelhttps://gitlab.gwdg.de/subugoe/ahiqar/backend/-/merge_requests/56Resolve "Update viewer name"2020-12-03T06:51:16ZMichelle WeidlingResolve "Update viewer name"Closes #83Closes #83Ahikar Version 0.14.0Michelle WeidlingMichelle Weidlinghttps://gitlab.gwdg.de/subugoe/ahiqar/backend/-/merge_requests/55Feature/#52 annotationapi tests2021-01-13T12:53:14ZMichelle WeidlingFeature/#52 annotationapi tests# Feature
## Summary
This MR provides…
- extensive tests for the AnnotationAPI. For this, some minor changes several functions have been made and several minor bugs fixed.
- the annotation module has been split to `annotation.xqm` and...# Feature
## Summary
This MR provides…
- extensive tests for the AnnotationAPI. For this, some minor changes several functions have been made and several minor bugs fixed.
- the annotation module has been split to `annotation.xqm` and `annotation-rest.xqm`, the latter holding only the REST interface definitions. Both reside now in their own collection, `modules/AnnotationAPI`, which makes the app a bit more clear.
- a better structure of the modules by moving the fragment retrieval to `commons.xqm`. This way, `annotations.xqm` doesn't have to import `tapi-html.xqm` which makes no sense (the HTML creation is logically independent from the annotations).
- `test-runner.xq` which can be used for local unit testing now inherits from `test-trigger.xqm`, thus reducing duplications (DRY!). Cf. #62
- The output of the tests have been remodeled to be both human and machine readable which addresses #61.
- The sample files have been renamed for clarity and slightly altered/enhanced to better depict the project's data structure.
- The content of `repo.xml` has been shortened in order to avoid having version information on two places.
## Compliance to “Definition of Done”
* [x] Unit tests passed
* [x] Code reviewed
* [ ] Acceptance criteria met
* [ ] Functional tests passed
* [ ] Non-Functional requirements met
* [x] Product Owner accepts the User Story
## Documentation
* [x] I updated existing documentation
## Tests
Are we able to test this new feature?
* [x] Yes, everything can be done via unit tests.
## Changelog
* [x] I added a statement to the CHANGELOG.
## Version number
* [x] I bumped the version number in `build.properties`.
## Related Tickets
### Closes
Closes #52, #61, #62.
/cc [Mathias Göbel](https://gitlab.gwdg.de/mgoebel), [Frank Schneider](https://gitlab.gwdg.de/schneider210), [Michelle Weidling](https://gitlab.gwdg.de/mrodzis)Ahikar Version 0.13.0Mathias GoebelMathias Goebelhttps://gitlab.gwdg.de/subugoe/ahiqar/backend/-/merge_requests/54Feature/#74 tile2021-01-06T13:58:54ZMichelle WeidlingFeature/#74 tile# Feature
## Summary
This MR provides
* a new endpoint for getting image sections
* a mechanism that distinguishes whether a manifest has double pages or single pages and delivers the correct URL
## Compliance to “Definition of Done”...# Feature
## Summary
This MR provides
* a new endpoint for getting image sections
* a mechanism that distinguishes whether a manifest has double pages or single pages and delivers the correct URL
## Compliance to “Definition of Done”
* [x] Unit tests passed
* [x] Code reviewed
* [ ] Acceptance criteria met
* [ ] Functional tests passed
* [ ] Non-Functional requirements met
* [x] Product Owner accepts the User Story
## Documentation
* [x] I updated the README (if applicable)
* [x] I provided my functions with appropriate documentation
* [x] I updated existing documentation
## Tests
Are we able to test this new feature?
* [x] Yes, everything can be done via unit tests.
## Changelog
* [x] I added a statement to the CHANGELOG.
## Version number
* [x] I bumped the version number in `build.properties`.
## Related Tickets
### Closes
Closes #74.
## Logs and Screenshots
/cc [Mathias Göbel](https://gitlab.gwdg.de/mgoebel), [Frank Schneider](https://gitlab.gwdg.de/schneider210), [Michelle Weidling](https://gitlab.gwdg.de/mrodzis)Ahikar Version 0.13.0Mathias GoebelMathias Goebelhttps://gitlab.gwdg.de/subugoe/ahiqar/backend/-/merge_requests/53Bugfix/#68 wrong ids2020-11-13T07:58:20ZMathias GoebelBugfix/#68 wrong ids# Bug fix
## Summary
- Fix wrong IDs in annotationsPage.
- Adjust REST path for forthcoming structure at TextAPI and so solves #67
## Compliance to “Definition of Done”
* [x] Unit tests passed
* [ ] Code reviewed
* [ ] Acceptance cr...# Bug fix
## Summary
- Fix wrong IDs in annotationsPage.
- Adjust REST path for forthcoming structure at TextAPI and so solves #67
## Compliance to “Definition of Done”
* [x] Unit tests passed
* [ ] Code reviewed
* [ ] Acceptance criteria met
* [ ] Functional tests passed
* [ ] Non-Functional requirements met
* [x] Product Owner accepts the User Story
### Related
### Closes
Closes #68, closes #67
## Changelog
* [x] I added a statement to the CHANGELOG.
## Version number
* [x] I bumped the version number in `build.properties`. -> 2.1.0
## Readme and general docs
* [ ] I updated the README (if applicable) and kept the docs up to date.
/cc [Mathias Göbel](https://gitlab.gwdg.de/mgoebel), [Frank Schneider](https://gitlab.gwdg.de/schneider210), [Michelle Weidling](https://gitlab.gwdg.de/mrodzis)Mathias GoebelMichelle WeidlingMathias Goebelhttps://gitlab.gwdg.de/subugoe/ahiqar/backend/-/merge_requests/52Feature/#76 collation based on sections2021-01-05T13:40:56ZMichelle WeidlingFeature/#76 collation based on sections# Feature
## Summary
This MR provides plain texts according to the semantic divisions of a text which are indicated by `tei:milestone`.
Even if a manuscript doesn't provide a certain section, the corresponding TXT is created so that t...# Feature
## Summary
This MR provides plain texts according to the semantic divisions of a text which are indicated by `tei:milestone`.
Even if a manuscript doesn't provide a certain section, the corresponding TXT is created so that the collation results do not get distorted.
Each semantic division is stored in a separate *.txt at `/txt/` and provided as a ZIP at `content/ahikar-plain-text.zip`.
## Compliance to “Definition of Done”
* [x] Unit tests passed
* [x] Code reviewed
* [ ] Acceptance criteria met
* [ ] Functional tests passed
* [ ] Non-Functional requirements met
* [x] Product Owner accepts the User Story
## Use Cases
This feature is necessary for collating the text based on their semantic divisions. This allows for parallelizing the collation and thus speeding it ip.
## Documentation
* [ ] I updated the README (if applicable)
* [x] I provided my functions with appropriate documentation
* [x] I updated existing documentation
## Tests
Are we able to test this new feature?
* [x] Yes, everything can be done via unit tests.
* [x] Yes, you can test by following these steps:
0. eventually re-run a pipeline for this branch
1. `curl https://ahikar-test.sub.uni-goettingen.de/api/content/ahikar-plain-text.zip --output ahikar-plain-text.zip`
OR
1. Build the database locally
2. Load some Ahiqar data
3. Import `tapi-txt.xqm` to a new XQuery script and run `tapi-txt:main()`
4. See the results in SADE's `txt` collection
## Changelog
* [x] I added a statement to the CHANGELOG.
## Version number
* [x] I bumped the version number in `build.properties`.
## Related Tickets
### Closes
Closes #76.
/cc [Mathias Göbel](https://gitlab.gwdg.de/mgoebel), [Frank Schneider](https://gitlab.gwdg.de/schneider210), [Michelle Weidling](https://gitlab.gwdg.de/mrodzis)Ahikar Version 0.13.0Mathias GoebelMathias Goebelhttps://gitlab.gwdg.de/subugoe/ahiqar/backend/-/merge_requests/51feat: change endpoint of AnnotationAPI2020-11-09T10:16:36ZMichelle Weidlingfeat: change endpoint of AnnotationAPI# Feature
## Summary
This MR provides a new endpoint declaration of the AnnotationAPI which is now served at `/api/annotations` instead of `/api/textapi`.
## Compliance to “Definition of Done”
* [x] Unit tests passed
* [x] Code revie...# Feature
## Summary
This MR provides a new endpoint declaration of the AnnotationAPI which is now served at `/api/annotations` instead of `/api/textapi`.
## Compliance to “Definition of Done”
* [x] Unit tests passed
* [x] Code reviewed
* [ ] Acceptance criteria met
* [x] Functional tests passed
* [x] Non-Functional requirements met
* [x] Product Owner accepts the User Story
## Documentation
* [x] I updated existing documentation
## Tests
Are we able to test this new feature?
* [x] Yes, everything can be done via unit tests.
## Changelog
* [x] I added a statement to the CHANGELOG.
## Version number
* [x] I bumped the version number in `build.properties`.
## Related Tickets
### Closes
Closes #69.
/cc [Mathias Göbel](https://gitlab.gwdg.de/mgoebel), [Frank Schneider](https://gitlab.gwdg.de/schneider210), [Michelle Weidling](https://gitlab.gwdg.de/mrodzis)Ahikar Version 0.13.0Mathias GoebelMathias Goebelhttps://gitlab.gwdg.de/subugoe/ahiqar/backend/-/merge_requests/50fix: update pw on autodeploy stage2020-11-06T08:29:03ZMichelle Weidlingfix: update pw on autodeploy stage# Bug fix
## Summary
Apart from what is mentioned in the main ticket you are going to close with this
MR, tell us what you have done to achieve this goal.
## Compliance to “Definition of Done”
* [ ] Unit tests passed
* [x] Code revie...# Bug fix
## Summary
Apart from what is mentioned in the main ticket you are going to close with this
MR, tell us what you have done to achieve this goal.
## Compliance to “Definition of Done”
* [ ] Unit tests passed
* [x] Code reviewed
* [ ] Acceptance criteria met
* [ ] Functional tests passed
* [ ] Non-Functional requirements met
* [ ] Product Owner accepts the User Story
### Related
### Closes
## Changelog
* [x] I added a statement to the CHANGELOG.
Still the old entry.
## Version number
* [x] I bumped the version number in `build.properties`.
Still the old entry.
/cc [Mathias Göbel](https://gitlab.gwdg.de/mgoebel), [Frank Schneider](https://gitlab.gwdg.de/schneider210), [Michelle Weidling](https://gitlab.gwdg.de/mrodzis)Ahikar Version 0.13.0Michelle WeidlingMichelle Weidlinghttps://gitlab.gwdg.de/subugoe/ahiqar/backend/-/merge_requests/49Resolve "Unit tests are not executed"2020-11-06T11:37:24ZMichelle WeidlingResolve "Unit tests are not executed"# Bug fix
## Summary
Double imports of modules and the import of a no longer existing test module have been deleted.
Furthermore, the CI now checks 1. if the test API is available and 2. if the result XML which contains the unit test ...# Bug fix
## Summary
Double imports of modules and the import of a no longer existing test module have been deleted.
Furthermore, the CI now checks 1. if the test API is available and 2. if the result XML which contains the unit test results exists.
## Compliance to “Definition of Done”
* [ ] Unit tests passed
* [x] Code reviewed
* [ ] Acceptance criteria met
* [ ] Functional tests passed
* [ ] Non-Functional requirements met
* [ ] Product Owner accepts the User Story
### Related
### Closes
Closes #72.
## Changelog
* [x] I added a statement to the CHANGELOG.
## Version number
* [x] I bumped the version number in `build.properties`.
## Readme and general docs
* [ ] I updated the README (if applicable) and kept the docs up to date.
/cc [Mathias Göbel](https://gitlab.gwdg.de/mgoebel), [Frank Schneider](https://gitlab.gwdg.de/schneider210), [Michelle Weidling](https://gitlab.gwdg.de/mrodzis)Ahikar Version 0.13.0Mathias GoebelMathias Goebelhttps://gitlab.gwdg.de/subugoe/ahiqar/backend/-/merge_requests/47DiRtY ReLeAsE2020-10-14T07:28:33ZMathias GoebelDiRtY ReLeAsEThis MR is for testing the release workflow.
If it does not fail it should end up in a productive environment. It is immediately merged by its creator.
It takes over 210 commits to the `main` branch (formerly know as `master` branch).This MR is for testing the release workflow.
If it does not fail it should end up in a productive environment. It is immediately merged by its creator.
It takes over 210 commits to the `main` branch (formerly know as `master` branch).Ahikar Version 0.12.0Mathias GoebelMathias Goebelhttps://gitlab.gwdg.de/subugoe/ahiqar/backend/-/merge_requests/46Bugfix/#49 pw protection2020-10-15T05:41:51ZMathias GoebelBugfix/#49 pw protection# Bug fix
## Summary
After this MR a password for the `admin` user in the database is set in the post-installation phase. It reads from env vars provided by GitLab :fox: secret variables set as a docker env var. To support local develo...# Bug fix
## Summary
After this MR a password for the `admin` user in the database is set in the post-installation phase. It reads from env vars provided by GitLab :fox: secret variables set as a docker env var. To support local development without any change, the env var is parsed as string, so if the env var `EXIST_ADMIN_PW` is not present, the empty string is set - what should met the default setting.
## Compliance to “Definition of Done”
* [x] Unit tests passed
* [ ] Code reviewed
* [ ] Acceptance criteria met
* [ ] Functional tests passed
* [x] Non-Functional requirements met
* [x] Product Owner accepts the User Story
### Related
### Closes #49
## Changelog
* [x] I added a statement to the CHANGELOG.
## Version number
* [x] I bumped the version number in `build.properties`.
## Readme and general docs
* [ ] I updated the README (if applicable) and kept the docs up to date.
/cc [Mathias Göbel](https://gitlab.gwdg.de/mgoebel), [Frank Schneider](https://gitlab.gwdg.de/schneider210), [Michelle Weidling](https://gitlab.gwdg.de/mrodzis)Ahikar Version 0.12.0Mathias GoebelMichelle WeidlingMathias Goebelhttps://gitlab.gwdg.de/subugoe/ahiqar/backend/-/merge_requests/45Feature/#58 normalization of txt2020-10-12T11:47:33ZMichelle WeidlingFeature/#58 normalization of txt# Feature
## Summary
This MR provides a module that removes the vocalization and punctuation of the Syriac texts.
## Compliance to “Definition of Done”
* [x] Unit tests passed
* [x] Code reviewed
* [ ] Acceptance criteria met
* [ ] F...# Feature
## Summary
This MR provides a module that removes the vocalization and punctuation of the Syriac texts.
## Compliance to “Definition of Done”
* [x] Unit tests passed
* [x] Code reviewed
* [ ] Acceptance criteria met
* [ ] Functional tests passed
* [ ] Non-Functional requirements met
* [x] Product Owner accepts the User Story
## Documentation
* [ ] I updated the README (if applicable)
* [x] I provided my functions with appropriate documentation
* [ ] I updated existing documentation
## Tests
Are we able to test this new feature?
* [x] Yes, everything can be done via unit tests.
* [ ] Yes, you can test by following these steps: …
* [ ] No, it is not possible.
## Related Tickets
### Closes
#50
/cc [Mathias Göbel](https://gitlab.gwdg.de/mgoebel), [Frank Schneider](https://gitlab.gwdg.de/schneider210), [Michelle Weidling](https://gitlab.gwdg.de/mrodzis)Ahikar Version 0.12.0Michelle WeidlingMichelle Weidlinghttps://gitlab.gwdg.de/subugoe/ahiqar/backend/-/merge_requests/44fix: update overlooked path in Annotation API2020-10-12T13:23:08ZMichelle Weidlingfix: update overlooked path in Annotation API# Bug fix
## Summary
## Compliance to “Definition of Done”
* [x] Unit tests passed
* [x] Code reviewed
* [ ] Acceptance criteria met
* [ ] Functional tests passed
* [ ] Non-Functional requirements met
* [x] Product Owner accepts the U...# Bug fix
## Summary
## Compliance to “Definition of Done”
* [x] Unit tests passed
* [x] Code reviewed
* [ ] Acceptance criteria met
* [ ] Functional tests passed
* [ ] Non-Functional requirements met
* [x] Product Owner accepts the User Story
### Related
### Closes
#48
## Readme and general docs
* [ ] I updated the README (if applicable) and kept the docs up to date.
/cc [Mathias Göbel](https://gitlab.gwdg.de/mgoebel), [Frank Schneider](https://gitlab.gwdg.de/schneider210), [Michelle Weidling](https://gitlab.gwdg.de/mrodzis)Mathias GoebelMichelle WeidlingMathias Goebelhttps://gitlab.gwdg.de/subugoe/ahiqar/backend/-/merge_requests/43Feature/#60 xquery based transformation2020-10-12T11:24:34ZMichelle WeidlingFeature/#60 xquery based transformation# Feature
## Summary
This MR provides a transformation from TEI to XHTML which is explicitly designed for the needs of the Ahiqar projects.
Its outcomes are described in detail at <https://intranet.sub.uni-goettingen.de/display/prjAhi...# Feature
## Summary
This MR provides a transformation from TEI to XHTML which is explicitly designed for the needs of the Ahiqar projects.
Its outcomes are described in detail at <https://intranet.sub.uni-goettingen.de/display/prjAhiqar/Text+Styling+Specification>.
## Compliance to “Definition of Done”
* [x] Unit tests passed
* [x] Code reviewed
* [ ] Acceptance criteria met
* [ ] Functional tests passed
* [ ] Non-Functional requirements met
* [x] Product Owner accepts the User Story
## Use Cases
* As a front end developer I need to adress all elements in the Ahiqar project by their `@class` in order to write a proper project specific CSS.
* As a back end developer I want to reduce my dependencies to other software as far as possible in order to improve performance and get exactly the results that I want.
* As a developer of the SUB schema I appreciate a foundation for transforming a file that has been encoded in the SUB-TEI schema to XHTML in order to expand it all elements of the SUB schema.
## Documentation
* [ ] I updated the README (if applicable)
* [x] I provided my functions with appropriate documentation
* [ ] I updated existing documentation
## Tests
Are we able to test this new feature?
* [x] Yes, everything can be done via unit tests.
* [ ] Yes, you can test by following these steps: …
* [ ] No, it is not possible.
## Changelog
* [x] I added a statement to the CHANGELOG.
## Version number
* [x] I bumped the version number in `build.properties`.
## Related Tickets
### Closes
#60
/cc [Mathias Göbel](https://gitlab.gwdg.de/mgoebel), [Frank Schneider](https://gitlab.gwdg.de/schneider210), [Michelle Weidling](https://gitlab.gwdg.de/mrodzis)Ahikar Version 0.11.0Michelle WeidlingMichelle Weidlinghttps://gitlab.gwdg.de/subugoe/ahiqar/backend/-/merge_requests/42Bugfix/#59 openapi in readme2020-09-24T08:08:26ZMichelle WeidlingBugfix/#59 openapi in readme# Bug fix
## Summary
This MR corrects the README and provides the correct link to the OpenAPI documentation of our RESTXQ endpoints.
## Compliance to “Definition of Done”
* [x] Unit tests passed
* [x] Code reviewed
* [ ] Acceptance c...# Bug fix
## Summary
This MR corrects the README and provides the correct link to the OpenAPI documentation of our RESTXQ endpoints.
## Compliance to “Definition of Done”
* [x] Unit tests passed
* [x] Code reviewed
* [ ] Acceptance criteria met
* [ ] Functional tests passed
* [ ] Non-Functional requirements met
* [ ] Product Owner accepts the User Story
### Related
### Closes
#59
## Changelog
* [x] I added a statement to the CHANGELOG.
## Version number
* [x] I bumped the version number in `build.properties`.
## Readme and general docs
* [x] I updated the README (if applicable) and kept the docs up to date.
/cc [Mathias Göbel](https://gitlab.gwdg.de/mgoebel), [Frank Schneider](https://gitlab.gwdg.de/schneider210), [Michelle Weidling](https://gitlab.gwdg.de/mrodzis)Ahikar Version 0.11.0Michelle WeidlingMichelle Weidlinghttps://gitlab.gwdg.de/subugoe/ahiqar/backend/-/merge_requests/41feat: refactor TextAPI (cf. #50)2020-10-09T06:31:49ZMichelle Weidlingfeat: refactor TextAPI (cf. #50)# Feature
## Summary
This MR moves most of the functionality out of `tapi.xqm` into separate designated modules. As a result, `tapi.xqm` mainly contains the RESTXQ endpoints.
In detail, the following modules have been created:
- `tap...# Feature
## Summary
This MR moves most of the functionality out of `tapi.xqm` into separate designated modules. As a result, `tapi.xqm` mainly contains the RESTXQ endpoints.
In detail, the following modules have been created:
- `tapi-collection.xqm`: creating all information necessary for the TextAPI collection endpoint (`/collection.json`)
- `tapi-manifest.xqm`: creating all information necessary for the TextAPI collection endpoint (`/manifest.json`)
- `tapi-item.xqm`: creating all information necessary for the TextAPI collection endpoint (`/latest/item.json`)
- `tapi-html.xqm`: handling the creation of the HTML presentation of a given page (`/content/xxxx.html`)
- `tapi-txt.xqm`: handling the creation of the TXT presentation of a given page (`/content/xxxx.txt`) which is needed for the collation
All modules have been provided with extensive tests. The module functions and expected parameters aim to be descriptive to such a degree that additional documentation can be kept to a minimum (following Robert Martin's and Martin Fowler's advice).
---
Furthermore, several testsuites are considered and inspected during the `unit_test` stage of the CI/CD since every module of the ones mentioned above has its own unit testing module.
## Compliance to “Definition of Done”
* [x] Unit tests passed
* [x] Code reviewed
* [ ] Acceptance criteria met
* [ ] Functional tests passed
* [ ] Non-Functional requirements met
* [x] Product Owner accepts the User Story
## Use Cases
As a developer, having clean and separate modules speeds up my work, and more tests assure my that everything is working fine.
## Documentation
* [ ] I updated the README (if applicable)
* [x] I provided my functions with appropriate documentation
* [x] I updated existing documentation
## Tests
Are we able to test this new feature?
* [x] Yes, everything can be done via unit tests
## Changelog
* [x] I added a statement to the CHANGELOG.
## Version number
* [x] I bumped the version number in `build.properties`.
## Related Tickets
#50, #57
/cc [Mathias Göbel](https://gitlab.gwdg.de/mgoebel), [Frank Schneider](https://gitlab.gwdg.de/schneider210), [Michelle Weidling](https://gitlab.gwdg.de/mrodzis)Ahikar Version 0.11.0Mathias GoebelMichelle WeidlingMathias Goebelhttps://gitlab.gwdg.de/subugoe/ahiqar/backend/-/merge_requests/40Feature/#56 section wise collation2020-09-28T07:37:25ZMichelle WeidlingFeature/#56 section wise collation# Feature
## Summary
This MR provides
- a new module, `collate.xqm`, which takes care of the collation process. Only passages following `tei:milestone` are considered for extracting text nodes.
- a new module, `commons.xqm`, which hol...# Feature
## Summary
This MR provides
- a new module, `collate.xqm`, which takes care of the collation process. Only passages following `tei:milestone` are considered for extracting text nodes.
- a new module, `commons.xqm`, which holds variables and functions used in several modules.
- a refactored version of the RESTAPI endpoint returning `*.txt` files.
## Compliance to “Definition of Done”
* [x] Unit tests passed
* [ ] Code reviewed
* [ ] Acceptance criteria met
* [ ] Functional tests passed
* [ ] Non-Functional requirements met
* [x] Product Owner accepts the User Story
## Use Cases
If you can, please provide use cases for this feature.
## Documentation
* [ ] I updated the README (if applicable)
* [x] I provided my functions with appropriate documentation
* [ ] I updated existing documentation
## Tests
Are we able to test this new feature?
* [x] Yes, everything can be done via unit tests.
## Changelog
* [x] I added a statement to the CHANGELOG.
## Version number
* [x] I bumped the version number in `build.properties`.
## Related Tickets
### Closes
#56
/cc [Mathias Göbel](https://gitlab.gwdg.de/mgoebel), [Frank Schneider](https://gitlab.gwdg.de/schneider210), [Michelle Weidling](https://gitlab.gwdg.de/mrodzis)Ahikar Version 0.11.0Michelle WeidlingMichelle Weidlinghttps://gitlab.gwdg.de/subugoe/ahiqar/backend/-/merge_requests/39Bugfix/#55 reduce memory needed by docker2020-09-18T07:26:47ZMichelle WeidlingBugfix/#55 reduce memory needed by docker# Bug fix
## Summary
This MR aims to reduce the memory needed by the eXist-db Docker to 1 GB.
It also switches eXist's data storage from a bind mount to a volume.
## Compliance to “Definition of Done”
* [x] Unit tests passed
* [ ] C...# Bug fix
## Summary
This MR aims to reduce the memory needed by the eXist-db Docker to 1 GB.
It also switches eXist's data storage from a bind mount to a volume.
## Compliance to “Definition of Done”
* [x] Unit tests passed
* [ ] Code reviewed
* [ ] Acceptance criteria met
* [x] Functional tests passed
* [ ] Non-Functional requirements met
* [x] Product Owner accepts the User Story
### Related
### Closes
## Changelog
* [x] I added a statement to the CHANGELOG.
## Version number
* [x] I bumped the version number in `build.properties`.
## Readme and general docs
* [x] I updated the README (if applicable) and kept the docs up to date.
/cc [Mathias Göbel](https://gitlab.gwdg.de/mgoebel), [Frank Schneider](https://gitlab.gwdg.de/schneider210), [Michelle Weidling](https://gitlab.gwdg.de/mrodzis)Michelle WeidlingdindigalaMichelle Weidling