Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: Invoice registry #1749

Closed
11 tasks
sfount opened this issue Jun 2, 2017 · 1 comment
Closed
11 tasks

refactor: Invoice registry #1749

sfount opened this issue Jun 2, 2017 · 1 comment
Assignees
Labels

Comments

@sfount
Copy link
Contributor

sfount commented Jun 2, 2017

References issue #1737

The patient registry should be updated to meet the latest standards in order to reduce technical debt and give clients required features:

  • Use the latest FilterService in favour of the hardcoded deprecated method
    • Update the InvoiceService to use FIilterService
    • Update the search modal to use 'default' and 'custom' filters
  • Integrate grid save state ((refactor) Journal module grid state #1738)
    • Save configuration
    • Load default configuration
  • "Menu" dropdown for core utilities
    • Column configuration
    • Download view as CSV
    • Download view as PDF
  • Remove bhRenderer dropdown
  • Use bhClear on search modal (refactor: use bhClear for all grid search modals #1702)
  • Remove 'Print' action favouring the 'Download as PDF'
  • Ensure links to other registries work correctly
@sfount sfount added the Refactor label Jun 2, 2017
@jniles
Copy link
Contributor

jniles commented Jun 2, 2017

I'll take this one!

@jniles jniles self-assigned this Jun 2, 2017
jniles added a commit to jniles/bhima that referenced this issue Jun 2, 2017
This commit migrates the client side of the Invoice Registry to use the
FilterService.  To do this, the logic is heavily changed in the Invoice
Registry controller, removing the old DeprecatedFilterService and
replacing it completely.  The InvoiceService now manages caching
filters.  Additionally, the form is separated in two tabs with default
filters and specialized filters.

I've also taken the liberty to remove some style hacks and implemented a
search-modal class in bhima-bootstrap.less.  This class simply
transplants the styles to a location where they can be shared.

Progress towards IMA-WorldHealth#1749.
jniles added a commit to jniles/bhima that referenced this issue Jun 2, 2017
This commit adds a dropdown menu with two links - the CSV downloader and
the PDF downloader.  Both of these use the server-side download at the
moment.  We could easily switch the CSV exporter to use the client-side
exporter.  It also removes the bhPrintButton in doing so.

Partially addresses IMA-WorldHealth#1749.
jniles added a commit to jniles/bhima that referenced this issue Jun 2, 2017
This commit implements ui-grid's save-state feature on the invoice
registry, and compliments it with a column configuration service.  This
service is slightly buggy, but that is outside the scope of these
changes.

Closes IMA-WorldHealth#1749.
jniles added a commit to jniles/bhima that referenced this issue Jun 5, 2017
This commit migrates the client side of the Invoice Registry to use the
FilterService.  To do this, the logic is heavily changed in the Invoice
Registry controller, removing the old DeprecatedFilterService and
replacing it completely.  The InvoiceService now manages caching
filters.  Additionally, the form is separated in two tabs with default
filters and specialized filters.

I've also taken the liberty to remove some style hacks and implemented a
search-modal class in bhima-bootstrap.less.  This class simply
transplants the styles to a location where they can be shared.

Progress towards IMA-WorldHealth#1749.
jniles added a commit to jniles/bhima that referenced this issue Jun 5, 2017
This commit adds a dropdown menu with two links - the CSV downloader and
the PDF downloader.  Both of these use the server-side download at the
moment.  We could easily switch the CSV exporter to use the client-side
exporter.  It also removes the bhPrintButton in doing so.

Partially addresses IMA-WorldHealth#1749.
jniles added a commit to jniles/bhima that referenced this issue Jun 5, 2017
This commit implements ui-grid's save-state feature on the invoice
registry, and compliments it with a column configuration service.  This
service is slightly buggy, but that is outside the scope of these
changes.

Closes IMA-WorldHealth#1749.
jniles added a commit to jniles/bhima that referenced this issue Jun 5, 2017
This commit migrates the client side of the Invoice Registry to use the
FilterService.  To do this, the logic is heavily changed in the Invoice
Registry controller, removing the old DeprecatedFilterService and
replacing it completely.  The InvoiceService now manages caching
filters.  Additionally, the form is separated in two tabs with default
filters and specialized filters.

I've also taken the liberty to remove some style hacks and implemented a
search-modal class in bhima-bootstrap.less.  This class simply
transplants the styles to a location where they can be shared.

Progress towards IMA-WorldHealth#1749.
jniles added a commit to jniles/bhima that referenced this issue Jun 5, 2017
This commit adds a dropdown menu with two links - the CSV downloader and
the PDF downloader.  Both of these use the server-side download at the
moment.  We could easily switch the CSV exporter to use the client-side
exporter.  It also removes the bhPrintButton in doing so.

Partially addresses IMA-WorldHealth#1749.
jniles added a commit to jniles/bhima that referenced this issue Jun 5, 2017
This commit implements ui-grid's save-state feature on the invoice
registry, and compliments it with a column configuration service.  This
service is slightly buggy, but that is outside the scope of these
changes.

Closes IMA-WorldHealth#1749.
bors bot added a commit that referenced this issue Jun 5, 2017
1760: refactor: update invoice registry to latest standards r=sfount
This PR updates the Invoice Registry to the latest standard.  It should help developers of other registries figure out how to update their registries as well.

~~**Note**: The 5K+ line change is because I've committed a package-lock.json file that comes by default with npm v5+.  You can find it in the [release notes](https://github.com/npm/npm/releases/tag/v5.0.0).  If you would prefer me to remove it and us to ignore it, that's cool.~~ I've removed the `package-lock.json` as it appears to cause issues with previous NPM versions.

For reference of what changed, all components of #1749 were tackled here.

#### Code Changes
 1. I've refined the `FilterParser` implementation on the server by turning off `autoParseStatements` (see #1454).  Every filter must be specified.  I've also changed cashReference comparison statement to convert the binary uuid in JS, since this is what most other modules do.
 2. I've migrated the filters to using the client `FilterService`.
 3. I've ensured the filter modal to latest standards.  This includes using `bhClear` (see #1702).
 4. The end-to-end tests have been updated to reflect these changes.  They now use a combined `SearchModal` service, shared with the Cash Payments Registry.  It provides simple control of the filters.
 5. Two options for downloading have been added: PDF and CSV.  For uniformity, they both use the server to serve files to an HTML `<a href download>` tag.  If needed, I can try to implement the CSV rendering with the Exporter service ... but I worry about the difference in UX.  I'll look to review for guidance.
 6. I've implemented the GridState service on this grid.  It works as the Journal's works.
 7. I've implemented the Grid Column service.  It also uses the GridState as described above... however, there is a bug in the Grid Column service reported in #1759.

#### A Note on End to End Tests
I've combined the Cash Payment Registry's `SearchModal` page object with the Invoice Registry's `SearchModal`.  Basically, any search form should be able to leverage this page object without writing their own massive test suite.  It prefers convention over configuration though, so you'll have to name your controllers `$ctrl`, your search parameters `searchQueries` (as done in the Journal and Cash Payments registry) and your default search paramters `defaultQueries`.

#### Screenshots
Pics or it didn't happen, right?

**New User Interface**
![invoiceregistrynewui](https://cloud.githubusercontent.com/assets/896472/26746668/ef0bcfa8-47e8-11e7-8bd7-819f9a4e1dea.png)

**New Menu Demo**
![invoiceregistrydropdownmenu](https://cloud.githubusercontent.com/assets/896472/26746674/f928966a-47e8-11e7-9026-2fe054b33142.png)

**Download as CSV Option**
![invoiceregistrydownloadascsv png](https://cloud.githubusercontent.com/assets/896472/26746727/42f4b8e6-47e9-11e7-8e63-fabd55f071fa.png)

**Column Configuration Modal**
![invoiceregistrycolumnconfigurationmodal](https://cloud.githubusercontent.com/assets/896472/26746763/7fb6e542-47e9-11e7-8669-2eb8536517f8.png)

**Column Changes Saved in Save State**
![invoiceregistrycolumnconfigurationsaved](https://cloud.githubusercontent.com/assets/896472/26746774/9109f7da-47e9-11e7-98b6-d01faf5ca512.png)

Closes #1749.

----
Thank you for contributing!

Before submitting this pull request, please verify that you have:
 - [x] Run your code through ESLint.  [Check out our styleguide](https://github.com/IMA-WorldHealth/bhima-2.X/blob/master/docs/STYLEGUIDE.md).
 - [x] Run integration tests.
 - [x] Run end-to-end tests.
 - [x] Accurately described the changes your are making in this pull request.

For a more detailed checklist, [see the official review checklist](https://docs.google.com/document/d/1nupLVLRXgSZJQo_acLgrwvPnN8RukfSiwRhSToj81uU/pub) that this PR will be evaluated against.

Ensuring that the above checkboxes are completed will help speed the review process and help build a stronger application.  Thanks!
@bors bors bot closed this as completed in #1760 Jun 5, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants