SWAMPy

✎ CARVE FLESH

EDITING: README.md

# Gems

This folder is a place to extract modular functionality from
canvas.  Canvas's Gemfile arrangement is enabled to read gems
from this path locally without installing from a remote source. This is valuable for a few reasons:
  - it prevents circular dependencies (bundler won't allow it)
  - modularized code cannot bind to specific domain concepts on canvas models
  - gems can have their specs run independently, without needing to load all
     of canvas, saving iteration time
  - it allows for eventual build optimization via only running specs for the
    transitive closure of parents depending on a gem where a change is.

There are some tradeoffs:
  - spreads canvas over more subdirectories, giving some mental overhad to traversing
     the entire codebase.
  - modular tests necessarily don't test integration with canvas concepts, so solid        integration tests in the app are still a requirement.
  - total SERIALIZED build time goes up because each gem loads it's specs in a new process rather than all running within an already booted canvas process.

[TODO] eventually write more on whether we feel like those tradeoffs are good ones,
and what the best practices are to leverage this pattern for max-gain/min-pain.

## Testing

To test all the gems:
```
cd gems
./test_all_gems.sh
```

### To test an individual gem

Run `./test.sh` inside the gem's folder. This is _basically_ the same as:

```bash
cd gems/google_drive
bundle
rspec
```

CANCEL

Name	Type	Size	Modified	Actions
↩ ..	DIR	—	—
📁 activesupport-suspend_callbacks/	DIR	—	2023-09-24 03:39
📁 acts_as_list/	DIR	—	2023-09-24 03:39
📁 adheres_to_policy/	DIR	—	2023-09-24 03:39
📁 attachment_fu/	DIR	—	2023-09-24 03:39
📁 autoextend/	DIR	—	2023-09-24 03:39
📁 bookmarked_collection/	DIR	—	2023-09-24 03:39
📁 broadcast_policy/	DIR	—	2023-09-24 03:39
📁 bundler_lockfile_extensions/	DIR	—	2023-09-24 03:39
📁 canvas_breach_mitigation/	DIR	—	2023-09-24 03:39
📁 canvas_cache/	DIR	—	2023-09-24 03:39
📁 canvas_cassandra/	DIR	—	2023-09-24 03:39
📁 canvas_color/	DIR	—	2023-09-24 03:39
📁 canvas_crummy/	DIR	—	2023-09-24 03:39
📁 canvas_dynamodb/	DIR	—	2023-09-24 03:39
📁 canvas_errors/	DIR	—	2023-09-24 03:39
📁 canvas_ext/	DIR	—	2023-09-24 03:39
📁 canvas_http/	DIR	—	2023-09-24 03:39
📁 canvas_kaltura/	DIR	—	2023-09-24 03:39
📁 canvas_mimetype_fu/	DIR	—	2023-09-24 03:39
📁 canvas_panda_pub/	DIR	—	2023-09-24 03:39
📁 canvas_partman/	DIR	—	2023-09-24 03:39
📁 canvas_quiz_statistics/	DIR	—	2023-09-24 03:39
📁 canvas_sanitize/	DIR	—	2023-09-24 03:39
📁 canvas_security/	DIR	—	2023-09-24 03:39
📁 canvas_slug/	DIR	—	2023-09-24 03:39
📁 canvas_sort/	DIR	—	2023-09-24 03:39
📁 canvas_stringex/	DIR	—	2023-09-24 03:39
📁 canvas_text_helper/	DIR	—	2023-09-24 03:39
📁 canvas_time/	DIR	—	2023-09-24 03:39
📁 canvas_unzip/	DIR	—	2023-09-24 03:39
📁 config_file/	DIR	—	2023-09-24 03:39
📁 csv_diff/	DIR	—	2023-09-24 03:39
📁 diigo/	DIR	—	2023-09-24 03:39
📁 dr_diff/	DIR	—	2023-09-24 03:39
📁 dynamic_settings/	DIR	—	2023-09-24 03:39
📁 event_stream/	DIR	—	2023-09-24 03:39
📁 google_drive/	DIR	—	2023-09-24 03:39
📁 html_text_helper/	DIR	—	2023-09-24 03:39
📁 i18n_extraction/	DIR	—	2023-09-24 03:39
📁 i18n_tasks/	DIR	—	2023-09-24 03:39
📁 incoming_mail_processor/	DIR	—	2023-09-24 03:39
📁 json_token/	DIR	—	2023-09-24 03:39
📁 linked_in/	DIR	—	2023-09-24 03:39
📁 live_events/	DIR	—	2023-09-24 03:39
📁 lti-advantage/	DIR	—	2023-09-24 03:39
📁 lti_outbound/	DIR	—	2023-09-24 03:39
📁 multipart/	DIR	—	2023-09-24 03:39
📁 paginated_collection/	DIR	—	2023-09-24 03:39
📁 plugins/	DIR	—	2023-09-24 03:36
📁 request_context/	DIR	—	2023-09-24 03:39
📁 rubocop-canvas/	DIR	—	2023-09-24 03:39
📁 stringify_ids/	DIR	—	2023-09-24 03:39
📁 tatl_tael/	DIR	—	2023-09-24 03:39
📁 turnitin_api/	DIR	—	2023-09-24 03:39
📁 twitter/	DIR	—	2023-09-24 03:39
📁 utf8_cleaner/	DIR	—	2023-09-24 03:39
📁 workflow/	DIR	—	2023-09-24 03:39
📄 README.md	MD	1.4 KB	2023-09-24 03:36	EDIT
📄 test_all_gems.sh	SH	610 B	2023-09-24 03:36	EDIT