bkinnightskytw
/
pdf_signature
mirror of https://github.com/existedinnettw/pdf_signature.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
pdf_signature/docs/meta-arch.md

4.0 KiB
Raw Blame History

meta archietecture

  • MVVM
    • Data layer
      • View ⇆ ViewModel ⇆ Repository ⇆ Service
        • Model is used across.

Package structure

The repo structure follows official Package structure.

lib
├─┬─ ui
│ ├─┬─ core
│ │ ├─┬─ ui
│ │ │ └─── <shared widgets>
│ │ └─── themes
│ └─┬─ <FEATURE NAME>
│   ├─┬─ view_model
│   │ └─── <view_model class>.dart
│   └─┬─ widgets
│     ├── <feature name>_screen.dart
│     └── <other widgets>
├─┬─ domain
│ └─┬─ models
│   └─── <model name>.dart
├─┬─ data
│ ├─┬─ repositories
│ │ └─── <repository class>.dart
│ ├─┬─ services
│ │ └─── <service class>.dart
│ └─┬─ model
│   └─── <api model class>.dart
├─── config
├─── utils
├─── routing
├─── main_staging.dart
├─── main_development.dart
└─── main.dart

// The test folder contains unit and widget tests
test
├─── data
├─── domain
├─── ui
└─── utils

// The testing folder contains mocks other classes need to execute tests
testing
├─── fakes
└─── models

But with slight modifications.

  • put each <FEATURE NAME>/s in features/ sub-directory under ui/.
  • test/features/ contains BDD unit tests for each feature. It focuses on pure logic, therefore will not access View but ViewModel and Model.
  • test/widget/ contains UI widget(component) tests which focus on View from MVVM of each component.
  • integration_test/ for integration tests. They should be volatile to follow UI layout changes.

Some rule of thumb:

  • global provider
    • <object>RepositoryProvider only placed in /lib/data/repositories/, provide data to /lib/ui.
      • lib/data/services/* should be stateless, and should only accessible by Repository.

Abstraction

terminology

  • signature asset
    • image file of a signature, stored in the device or cloud storage
      • can drawing from canvas
  • signature card
    • template of signature placement
    • It will include modifications such as brightness, contrast, background removal, rotation of the signature asset.
  • signature placement
    • placed modified signature asset from signature card on a specific position on a specific page of a specific PDF document
  • document
    • PDF document to be signed

key dependencies