scarver2 / ehr-portal / 23570424271

78%

push

github

feat: Implement Rails-ERD for automated Entity Relationship Diagrams (#54)

* Revert "improvement: Make Providers and Clinics panels link to their ActiveAdmin pages"

This reverts commit d38c5cba1.

* feat: Implement Rails-ERD for automated Entity Relationship Diagrams

Added Rails-ERD gem and infrastructure for generating and maintaining
Entity Relationship Diagrams as living documentation.

## Changes

### Gems
- Added rails-erd (~> 1.7.2) to development group
- Requires GraphViz for diagram generation (brew install graphviz)

### Scripts
- bin/erd - Custom script to generate ERD diagrams
  - Generates PNG images and DOT source files
  - Located at doc/erd.png and doc/erd.dot
  - Configured with inheritance and polymorphism support

### Configuration
- .erdconfig - Rails-ERD configuration
  - Crow's foot notation for cardinality
  - Include inheritance and polymorphic relationships
  - Show content and timestamp attributes

### Documentation
- doc/ERD.md - Complete ERD guide
  - Setup instructions (GraphViz installation)
  - How to generate and update diagrams
  - Understanding diagram notation and symbols
  - Workflow for keeping diagrams in sync with schema
  - Customization and CI/CD integration
  - Troubleshooting guide

- doc/SCHEMA.md - Database schema reference
  - Complete entity relationship groups documentation
  - All table structures and field descriptions
  - Relationship definitions
  - Enum fields (Patient.gender)
  - Indexes and constraints
  - Common query patterns
  - Performance considerations
  - Future schema enhancement ideas

## Usage

Generate/update ERD diagrams:
```bash
bin/erd
```

This generates:
- doc/erd.png - Visual diagram
- doc/erd.dot - GraphViz source (editable)

## Workflow

When schema changes:
1. Create migration and model
2. Run `bundle exec rails db:migrate`
3. Run `bin/erd`
4. Commit model, migration, and updated doc/erd.*

## Next Steps

After installing GraphViz:
1. Run `bin/e... (continued)

353 of 493 branches covered (71.6%)

Branch coverage included in aggregate %.

509 of 633 relevant lines covered (80.41%)

18.19 hits per line