https://github.com/manosbatsis/csvtxcompare
Demo project for CSV transaction files comparison
https://github.com/manosbatsis/csvtxcompare
Last synced: 3 months ago
JSON representation
Demo project for CSV transaction files comparison
- Host: GitHub
- URL: https://github.com/manosbatsis/csvtxcompare
- Owner: manosbatsis
- License: apache-2.0
- Created: 2017-09-11T11:28:25.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2024-08-26T16:07:18.000Z (about 1 year ago)
- Last Synced: 2024-12-28T05:23:03.474Z (10 months ago)
- Language: JavaScript
- Size: 4.16 MB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# CSV transaction files comparison [](https://travis-ci.org/manosbatsis/csvtxcompare)
Implementation of trial project for CSV transaction markoff files comparison
- [Screen Shots](#screen-shots)
- [Complete with Suggestions Report](#complete-with-suggestions-report)
- [Scores Report](#scores-report)
- [Data Diff Report](#data-diff-report)
- [Notes](#notes)
- [Effort](#effort)
- [Prerequisites](#prerequisites)
- [Assumptions](#assumptions)
- [Architecture](#architecture)
- [Frontend](#frontend)
- [Backend](#backend)
- [HOWTO](#howto)
- [Build and Run](#build-and-run)
- [Testing](#testing)
- [REST API Documentation](#rest-api-documentation)
- [Database Console](#database-console)
## Screen Shots
This section provides UI deliverable screenshots.
### Complete with Suggestions Report
### Scores Report
A scores report is accessible by clicking the corresponding tab in the report section.
The scores report demonstrates the scoring of suggested results as that results from
field-by-field comparisons bewteen markoff records.
### Data Diff Report
A data diff (daff) report is accessible by clicking the corresponding tab in the report section.
The daff report demonstrates additions, deletions and other changes at record data level.
## Notes
This section includes some informative items regarding the codebase.
### Effort
This repo took about three and a half man-days to setup in it's current form.
### Prerequisites
- A recent Firefox or Chrome browser, I've tested with FF 55.0.2 (64-bit) and Chromium 60.0.3112.113. The application has not been tested with any version of IE.
- JDK 8 is required to build. Either Oracle or OpenJDK will do just fine, I've used the latter, v1.8.0_131
- Apache Maven 3.3+ should be fine, I've used 3.3.9
### Assumptions
- The mockups are loosely followed in many ways, e.g. bootstrapo cards are used VS HTML fieldsets and an additional report is provided to demonstrate the logic between the suggested matches.
- Comma is assumed to be the CSV field delimiter
- Date strings, when present, are always given as `yyyy-MM-dd HH:mm:ss`
- Field values are already normalized/regular as string representations of their typed values
- Non-unique records may exist, those are allowed in case they are useful as close (mis)matches
- All possible matches are calculated by comparing records field-by-field for plain equality. The only exception is the record number, as that allows some points within a threshold relevant to any unbalanced records in either side.
- Close matches are avaluated field-by-field, the code does not try to recover misplaced values
- The (integration) tests assume the sample files have 306/18 and 305/17 records/mismatches for the client and tutuka markoffs respectively. The files are in [src/main/resources/static](src/main/resources/static)
### Architecture
#### Frontend
The font-end is a simple ember-based SPA, loosely following the mockup. The SPA also adds a comparison table component where client and tutuka
markoffs are given the x and y axis respectively. The table cells show the overall match score between the records and
provide a tooltip for visual comparison (pending)
The client UI project can be found in [src/main/web](src/main/web). The build is mainly based on NPM. Main components:
- [src/main/web/app/models/comparison.js](src/main/web/app/models/comparison.js) the leading entity model, also features computed properties used for cclose match suggestions
- [src/main/web/app/components](src/main/web/app/components) UI components providinge the main UI widjets
- [src/main/web/app/templates](src/main/web/app/templates) handlebars templates
The client UI's dist folder is included in the Spring app for it to serve the corresponding resources.
#### Backend
The project is a vanilla 3 tier (Controller, Service, Repository), RESTful Spring app without my usual model-driven
libs. An embedded, in-memory H2 database is used for convenience and can be replaced by any other mainstream RDBMS without
code changes.
The main components are:
- [ComparisonsController](src/main/java/com/tutuka/manosbatsis/csvtxcompare/controller/ComparisonsController.java) provides a RESTful API to extract, persist and query markoff file comparisons. In case of any error, an ErrorModel object is provided as the JSON response. Documentation on the relevant endpoints is available in the [REST API Documentation](#rest-api-documentation)
- [MarkoffFilesComparisonService](src/main/java/com/tutuka/manosbatsis/csvtxcompare/service/MarkoffFilesComparisonService.java) is the business component for persisting and quering the relevant data models
- [Util](src/main/java/com/tutuka/manosbatsis/csvtxcompare/Util.java) is a utility class used for type conversion and mismatch discovery
## HOWTO
This section includes some quick guides for common dev tasks and resources.
### Build and Run
1) Clone the source:
```
git clone https://github.com/manosbatsis/csvtxcompare.git
```
2) Navigate to the project folder
```
cd csvtxcompare
```
3) Build and run
```
mvn clean install spring-boot:run
```
4) Browse the app at [http://localhost:8080](http://localhost:8080)
### Testing
(Integration) Tests are skipped by default. To enable them, build using the `ci` profile:
```
mvn clean install -P ci
```
This will build the code, launch a tomcat server and execute the tests against it.
### REST API Documentation
To view the API documentation run the application and browse to
[http://localhost:8080/swagger-ui.html](http://localhost:8080/swagger-ui.html) to visit the
embedded Swagger UI:
### Database Console
To review the database run the application and browse to
[http://localhost:8080/h2-console](http://localhost:8080/h2-console) to visit the
embedded H2 console. In the login screen, just leave everything as-is and submit:
