canvas-lms/gems
Cody Cutrer 2d7a070910 RuboCop: Bundler and Gemspec
Change-Id: I3077a90ba421f5996bb7ef2d4b7d85c2134b4c11
Reviewed-on: https://gerrit.instructure.com/c/canvas-lms/+/274193
Reviewed-by: Simon Williams <simon@instructure.com>
Tested-by: Service Cloud Jenkins <svc.cloudjenkins@instructure.com>
QA-Review: Cody Cutrer <cody@instructure.com>
Product-Review: Cody Cutrer <cody@instructure.com>
2021-09-22 20:02:32 +00:00
..
activesupport-suspend_callbacks RuboCop: Layout gems 2021-09-22 15:35:24 +00:00
acts_as_list RuboCop: Bundler and Gemspec 2021-09-22 20:02:32 +00:00
adheres_to_policy RuboCop: Layout gems 2021-09-22 15:35:24 +00:00
attachment_fu RuboCop: Layout gems 2021-09-22 15:35:24 +00:00
autoextend RuboCop: Bundler and Gemspec 2021-09-22 20:02:32 +00:00
bookmarked_collection RuboCop: Bundler and Gemspec 2021-09-22 20:02:32 +00:00
broadcast_policy RuboCop: Bundler and Gemspec 2021-09-22 20:02:32 +00:00
canvas_breach_mitigation RuboCop: Layout gems 2021-09-22 15:35:24 +00:00
canvas_cache RuboCop: Bundler and Gemspec 2021-09-22 20:02:32 +00:00
canvas_cassandra RuboCop: Bundler and Gemspec 2021-09-22 20:02:32 +00:00
canvas_color RuboCop: Layout gems 2021-09-22 15:35:24 +00:00
canvas_crummy RuboCop: Layout gems 2021-09-22 15:35:24 +00:00
canvas_dynamodb RuboCop: Bundler and Gemspec 2021-09-22 20:02:32 +00:00
canvas_errors RuboCop: Bundler and Gemspec 2021-09-22 20:02:32 +00:00
canvas_ext RuboCop: Bundler and Gemspec 2021-09-22 20:02:32 +00:00
canvas_http RuboCop: Bundler and Gemspec 2021-09-22 20:02:32 +00:00
canvas_i18nliner Add typescript support 2021-08-18 18:21:17 +00:00
canvas_kaltura RuboCop: Bundler and Gemspec 2021-09-22 20:02:32 +00:00
canvas_mimetype_fu RuboCop: Layout gems 2021-09-22 15:35:24 +00:00
canvas_panda_pub RuboCop: Layout gems 2021-09-22 15:35:24 +00:00
canvas_partman RuboCop: Bundler and Gemspec 2021-09-22 20:02:32 +00:00
canvas_quiz_statistics RuboCop: Bundler and Gemspec 2021-09-22 20:02:32 +00:00
canvas_sanitize RuboCop: Layout gems 2021-09-22 15:35:24 +00:00
canvas_security RuboCop: Bundler and Gemspec 2021-09-22 20:02:32 +00:00
canvas_slug RuboCop: Layout gems 2021-09-22 15:35:24 +00:00
canvas_sort RuboCop: Layout gems 2021-09-22 15:35:24 +00:00
canvas_stringex RuboCop: Bundler and Gemspec 2021-09-22 20:02:32 +00:00
canvas_text_helper RuboCop: Layout gems 2021-09-22 15:35:24 +00:00
canvas_time RuboCop: Layout gems 2021-09-22 15:35:24 +00:00
canvas_unzip RuboCop: Layout gems 2021-09-22 15:35:24 +00:00
config_file RuboCop: Bundler and Gemspec 2021-09-22 20:02:32 +00:00
csv_diff RuboCop: Layout gems 2021-09-22 15:35:24 +00:00
diigo RuboCop: Layout gems 2021-09-22 15:35:24 +00:00
dr_diff RuboCop: Bundler and Gemspec 2021-09-22 20:02:32 +00:00
dynamic_settings RuboCop: Bundler and Gemspec 2021-09-22 20:02:32 +00:00
event_stream RuboCop: Layout gems 2021-09-22 15:35:24 +00:00
google_drive RuboCop: Bundler and Gemspec 2021-09-22 20:02:32 +00:00
html_text_helper RuboCop: Bundler and Gemspec 2021-09-22 20:02:32 +00:00
i18n_extraction RuboCop: Bundler and Gemspec 2021-09-22 20:02:32 +00:00
i18n_tasks RuboCop: Bundler and Gemspec 2021-09-22 20:02:32 +00:00
incoming_mail_processor RuboCop: Bundler and Gemspec 2021-09-22 20:02:32 +00:00
inst_access RuboCop: Bundler and Gemspec 2021-09-22 20:02:32 +00:00
json_token RuboCop: Layout gems 2021-09-22 15:35:24 +00:00
linked_in RuboCop: Bundler and Gemspec 2021-09-22 20:02:32 +00:00
live_events RuboCop: Bundler and Gemspec 2021-09-22 20:02:32 +00:00
lti-advantage RuboCop: Bundler and Gemspec 2021-09-22 20:02:32 +00:00
lti_outbound RuboCop: Layout gems 2021-09-22 15:35:24 +00:00
multipart RuboCop: Bundler and Gemspec 2021-09-22 20:02:32 +00:00
paginated_collection RuboCop: Layout gems 2021-09-22 15:35:24 +00:00
plugins RuboCop: Bundler and Gemspec 2021-09-22 20:02:32 +00:00
request_context RuboCop: Bundler and Gemspec 2021-09-22 20:02:32 +00:00
rubocop-canvas RuboCop: Bundler and Gemspec 2021-09-22 20:02:32 +00:00
stringify_ids RuboCop: Layout gems 2021-09-22 15:35:24 +00:00
tatl_tael RuboCop: Bundler and Gemspec 2021-09-22 20:02:32 +00:00
turnitin_api RuboCop: Bundler and Gemspec 2021-09-22 20:02:32 +00:00
twitter RuboCop: Bundler and Gemspec 2021-09-22 20:02:32 +00:00
utf8_cleaner RuboCop: Layout gems 2021-09-22 15:35:24 +00:00
workflow RuboCop: Layout gems 2021-09-22 15:35:24 +00:00
README.md extract ConfigFile to gem 2021-02-23 21:18:20 +00:00
test_all_gems.sh remove broken vendored gems html reports 2021-06-15 16:53:17 +00:00

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.
  • it gives ENGINES extracted from canvas (see the "engines" directory) a place to reference code shared with canvas without it being packaged into the canvas monolith directly.

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:

cd gems/google_drive
bundle
rspec