Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions Gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,9 @@ gem 'importmap-rails'
# Build JSON APIs with ease [https://github.com/rails/jbuilder]
gem 'jbuilder'

gem 'mitlibraries-theme', git: 'https://github.com/mitlibraries/mitlibraries-theme', tag: 'v1.4'
gem 'mitlibraries-theme',
git: 'https://github.com/mitlibraries/mitlibraries-theme',
tag: 'v1.5'

# Use OmniAuth as Touchstone middleware and include the OIDC strategy and CSRF protection gems
gem 'omniauth'
Expand All @@ -52,7 +54,7 @@ gem 'puma', '>= 5.0'
gem 'scout_apm'

# Bundle edge Rails instead: gem "rails", github: "rails/rails", branch: "main"
gem 'rails', '~> 7.2.2'
gem 'rails', '~> 8.1.0'

# The original asset pipeline for Rails [https://github.com/rails/sprockets-rails]
gem 'sprockets-rails'
Expand Down Expand Up @@ -87,7 +89,7 @@ gem 'stringex'
# gem "image_processing", "~> 1.2"

group :production do
gem 'connection_pool', '< 3'
gem 'connection_pool'
# Use postgres as the database for Active Record
gem 'pg'
end
Expand All @@ -107,7 +109,7 @@ end

group :development do
# Add annotations to model, test, fixtures when run
gem 'annotate'
gem 'annotaterb'

# RuboCop is a Ruby static code analyzer (a.k.a. linter) and code formatter.
gem 'rubocop', require: false
Expand All @@ -129,7 +131,7 @@ group :test do
# Use system testing [https://guides.rubyonrails.org/testing.html#system-testing]
gem 'capybara'
gem 'climate_control'
gem 'minitest', '< 6'
gem 'minitest'
gem 'mocha'
gem 'selenium-webdriver'
gem 'simplecov'
Expand Down
173 changes: 83 additions & 90 deletions Gemfile.lock
Original file line number Diff line number Diff line change
@@ -1,88 +1,89 @@
GIT
remote: https://github.com/mitlibraries/mitlibraries-theme
revision: ba5bdc9840ef817ba0b92e522b92da3f52669fc3
tag: v1.4
revision: 135390daff870937212f1d9020abb6aea53c87d9
tag: v1.5
specs:
mitlibraries-theme (1.0.2)
rails (>= 6, < 8)
mitlibraries-theme (1.1.0)
rails (>= 6, < 9)
sassc-rails (~> 2)

GEM
remote: https://rubygems.org/
specs:
actioncable (7.2.3.2)
actionpack (= 7.2.3.2)
activesupport (= 7.2.3.2)
action_text-trix (2.1.19)
railties
actioncable (8.1.3.1)
actionpack (= 8.1.3.1)
activesupport (= 8.1.3.1)
nio4r (~> 2.0)
websocket-driver (>= 0.6.1)
zeitwerk (~> 2.6)
actionmailbox (7.2.3.2)
actionpack (= 7.2.3.2)
activejob (= 7.2.3.2)
activerecord (= 7.2.3.2)
activestorage (= 7.2.3.2)
activesupport (= 7.2.3.2)
actionmailbox (8.1.3.1)
actionpack (= 8.1.3.1)
activejob (= 8.1.3.1)
activerecord (= 8.1.3.1)
activestorage (= 8.1.3.1)
activesupport (= 8.1.3.1)
mail (>= 2.8.0)
actionmailer (7.2.3.2)
actionpack (= 7.2.3.2)
actionview (= 7.2.3.2)
activejob (= 7.2.3.2)
activesupport (= 7.2.3.2)
actionmailer (8.1.3.1)
actionpack (= 8.1.3.1)
actionview (= 8.1.3.1)
activejob (= 8.1.3.1)
activesupport (= 8.1.3.1)
mail (>= 2.8.0)
rails-dom-testing (~> 2.2)
actionpack (7.2.3.2)
actionview (= 7.2.3.2)
activesupport (= 7.2.3.2)
cgi
actionpack (8.1.3.1)
actionview (= 8.1.3.1)
activesupport (= 8.1.3.1)
nokogiri (>= 1.8.5)
racc
rack (>= 2.2.4, < 3.3)
rack (>= 2.2.4)
rack-session (>= 1.0.1)
rack-test (>= 0.6.3)
rails-dom-testing (~> 2.2)
rails-html-sanitizer (~> 1.6)
useragent (~> 0.16)
actiontext (7.2.3.2)
actionpack (= 7.2.3.2)
activerecord (= 7.2.3.2)
activestorage (= 7.2.3.2)
activesupport (= 7.2.3.2)
actiontext (8.1.3.1)
action_text-trix (~> 2.1.15)
actionpack (= 8.1.3.1)
activerecord (= 8.1.3.1)
activestorage (= 8.1.3.1)
activesupport (= 8.1.3.1)
globalid (>= 0.6.0)
nokogiri (>= 1.8.5)
actionview (7.2.3.2)
activesupport (= 7.2.3.2)
actionview (8.1.3.1)
activesupport (= 8.1.3.1)
builder (~> 3.1)
cgi
erubi (~> 1.11)
rails-dom-testing (~> 2.2)
rails-html-sanitizer (~> 1.6)
activejob (7.2.3.2)
activesupport (= 7.2.3.2)
activejob (8.1.3.1)
activesupport (= 8.1.3.1)
globalid (>= 0.3.6)
activemodel (7.2.3.2)
activesupport (= 7.2.3.2)
activerecord (7.2.3.2)
activemodel (= 7.2.3.2)
activesupport (= 7.2.3.2)
activemodel (8.1.3.1)
activesupport (= 8.1.3.1)
activerecord (8.1.3.1)
activemodel (= 8.1.3.1)
activesupport (= 8.1.3.1)
timeout (>= 0.4.0)
activestorage (7.2.3.2)
actionpack (= 7.2.3.2)
activejob (= 7.2.3.2)
activerecord (= 7.2.3.2)
activesupport (= 7.2.3.2)
activestorage (8.1.3.1)
actionpack (= 8.1.3.1)
activejob (= 8.1.3.1)
activerecord (= 8.1.3.1)
activesupport (= 8.1.3.1)
marcel (~> 1.0)
activesupport (7.2.3.2)
activesupport (8.1.3.1)
base64
benchmark (>= 0.3)
bigdecimal
concurrent-ruby (~> 1.0, >= 1.3.1)
connection_pool (>= 2.2.5)
drb
i18n (>= 1.6, < 2)
json
logger (>= 1.4.2)
minitest (>= 5.1, < 6)
minitest (>= 5.1)
securerandom (>= 0.3)
tzinfo (~> 2.0, >= 2.0.5)
uri (>= 0.13.1)
addressable (2.9.0)
public_suffix (>= 2.0.2, < 8.0)
administrate (1.0.0)
Expand All @@ -91,9 +92,9 @@ GEM
activerecord (>= 6.0, < 9.0)
kaminari (~> 1.2.2)
aes_key_wrap (1.1.0)
annotate (3.2.0)
activerecord (>= 3.2, < 8.0)
rake (>= 10.4, < 14.0)
annotaterb (4.24.0)
activerecord (>= 6.0.0)
activesupport (>= 6.0.0)
ast (2.4.3)
attr_required (1.0.2)
awesome_print (1.9.2)
Expand All @@ -103,7 +104,6 @@ GEM
ostruct
base64 (0.3.0)
bcrypt (3.1.22)
benchmark (0.5.0)
bigdecimal (4.1.2)
bindata (3.0.0)
bindex (0.8.1)
Expand All @@ -120,10 +120,9 @@ GEM
rack-test (>= 0.6.3)
regexp_parser (>= 1.5, < 3.0)
xpath (~> 3.2)
cgi (0.5.2)
climate_control (1.2.0)
concurrent-ruby (1.3.8)
connection_pool (2.5.5)
connection_pool (3.0.2)
crack (1.0.1)
bigdecimal
rexml
Expand All @@ -139,14 +138,13 @@ GEM
railties (>= 7.0)
responders
warden (~> 1.2.3)
docile (1.4.1)
domain_name (0.6.20240107)
dotenv (3.2.0)
dotenv-rails (3.2.0)
dotenv (= 3.2.0)
railties (>= 6.1)
drb (2.2.3)
erb (6.0.6)
erb (6.0.7)
erubi (1.13.1)
faraday (2.14.3)
faraday-net_http (>= 2.0, < 3.5)
Expand Down Expand Up @@ -230,7 +228,9 @@ GEM
marcel (1.2.1)
matrix (0.4.3)
mini_mime (1.1.5)
minitest (5.27.0)
minitest (6.0.6)
drb (~> 2.0)
prism (~> 1.5)
mocha (3.1.0)
ruby2_keywords (>= 0.0.5)
msgpack (1.8.4)
Expand Down Expand Up @@ -332,31 +332,30 @@ GEM
rack (>= 1.3)
rackup (2.3.1)
rack (>= 3)
rails (7.2.3.2)
actioncable (= 7.2.3.2)
actionmailbox (= 7.2.3.2)
actionmailer (= 7.2.3.2)
actionpack (= 7.2.3.2)
actiontext (= 7.2.3.2)
actionview (= 7.2.3.2)
activejob (= 7.2.3.2)
activemodel (= 7.2.3.2)
activerecord (= 7.2.3.2)
activestorage (= 7.2.3.2)
activesupport (= 7.2.3.2)
rails (8.1.3.1)
actioncable (= 8.1.3.1)
actionmailbox (= 8.1.3.1)
actionmailer (= 8.1.3.1)
actionpack (= 8.1.3.1)
actiontext (= 8.1.3.1)
actionview (= 8.1.3.1)
activejob (= 8.1.3.1)
activemodel (= 8.1.3.1)
activerecord (= 8.1.3.1)
activestorage (= 8.1.3.1)
activesupport (= 8.1.3.1)
bundler (>= 1.15.0)
railties (= 7.2.3.2)
railties (= 8.1.3.1)
rails-dom-testing (2.3.0)
activesupport (>= 5.0.0)
minitest
nokogiri (>= 1.6)
rails-html-sanitizer (1.7.1)
loofah (~> 2.25, >= 2.25.2)
nokogiri (>= 1.15.7, != 1.16.7, != 1.16.6, != 1.16.5, != 1.16.4, != 1.16.3, != 1.16.2, != 1.16.1, != 1.16.0.rc1, != 1.16.0)
railties (7.2.3.2)
actionpack (= 7.2.3.2)
activesupport (= 7.2.3.2)
cgi
railties (8.1.3.1)
actionpack (= 8.1.3.1)
activesupport (= 8.1.3.1)
irb (~> 1.13)
rackup (>= 1.0.0)
rake (>= 12.2)
Expand Down Expand Up @@ -435,20 +434,15 @@ GEM
rexml (~> 3.2, >= 3.2.5)
rubyzip (>= 1.2.2, < 4.0)
websocket (~> 1.0)
sentry-rails (6.6.2)
sentry-rails (6.7.0)
railties (>= 5.2.0)
sentry-ruby (~> 6.6.2)
sentry-ruby (6.6.2)
sentry-ruby (~> 6.7.0)
sentry-ruby (6.7.0)
bigdecimal
concurrent-ruby (~> 1.0, >= 1.0.2)
logger
simplecov (0.22.0)
docile (~> 1.1)
simplecov-html (~> 0.11)
simplecov_json_formatter (~> 0.1)
simplecov-html (0.13.2)
simplecov (1.0.3)
simplecov-lcov (0.9.0)
simplecov_json_formatter (0.1.4)
sprockets (4.2.2)
concurrent-ruby (~> 1.0)
logger
Expand Down Expand Up @@ -493,11 +487,10 @@ GEM
vcr (6.4.0)
warden (1.2.9)
rack (>= 2.0.9)
web-console (4.2.1)
actionview (>= 6.0.0)
activemodel (>= 6.0.0)
web-console (4.3.0)
actionview (>= 8.0.0)
bindex (>= 0.4.0)
railties (>= 6.0.0)
railties (>= 8.0.0)
webfinger (2.1.3)
activesupport
faraday (~> 2.0)
Expand Down Expand Up @@ -531,14 +524,14 @@ PLATFORMS

DEPENDENCIES
administrate (~> 1.0.0)
annotate
annotaterb
awesome_print
barnes
bootsnap
cancancan
capybara
climate_control
connection_pool (< 3)
connection_pool
csv
debug
devise
Expand All @@ -547,7 +540,7 @@ DEPENDENCIES
http
importmap-rails
jbuilder
minitest (< 6)
minitest
mitlibraries-theme!
mocha
omniauth
Expand All @@ -558,7 +551,7 @@ DEPENDENCIES
pg
puma (>= 5.0)
rack-cors
rails (~> 7.2.2)
rails (~> 8.1.0)
rubocop
rubocop-capybara
rubocop-graphql
Expand Down
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ coverage: test # Run tests and open coverage report in default web browser
#######################

annotate: # update Rails models documentation header
bundle exec annotate --models
bundle exec annotaterb models

docserver: # runs local documentation server
rm -rf .yardoc # Clears cache as it's sketchy af
Expand Down
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,12 @@ apps; it should never be manually set or overridden in any environment.

[Pattern Detection and Enhancement](docs/explanation/pattern_detection_and_enhancement.md)

### Annotations

`make annotate` will ensure that models have current internal documentation. This uses the [annotaterb](https://rubygems.org/gems/annotaterb) gem.

Other options provided by this gem can be explored via `bundle exec annotaterb help`.

### Reference

`make docserver` will start a `yard` server using the RDoc comments from the codebase. RDoc in this application is a work-in-progress and should improve over time. As of this writing, the index page generated contains broken links to our markdown documentation, but they "files" navigation displays them properly.
Expand Down
Loading