diff --git a/Gemfile b/Gemfile index 52045dd..1b6704e 100644 --- a/Gemfile +++ b/Gemfile @@ -66,6 +66,7 @@ group :development do gem 'letter_opener' gem 'letter_opener_web' gem 'faker' + gem 'solargraph' end group :test do diff --git a/Gemfile.lock b/Gemfile.lock index 7c655ba..2d92414 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -68,7 +68,10 @@ GEM tzinfo (~> 2.0) addressable (2.8.1) public_suffix (>= 2.0.2, < 6.0) + ast (2.4.2) + backport (1.2.0) bcrypt (3.1.18) + benchmark (0.2.1) bindex (0.8.1) builder (3.2.4) byebug (11.1.3) @@ -109,6 +112,7 @@ GEM dotenv-rails (2.8.1) dotenv (= 2.8.1) railties (>= 3.2) + e2mmap (0.1.0) erubi (1.11.0) et-orbi (1.2.7) tzinfo @@ -135,9 +139,15 @@ GEM importmap-rails (1.1.5) actionpack (>= 6.0.0) railties (>= 6.0.0) + jaro_winkler (1.5.4) jbuilder (2.11.5) actionview (>= 5.0.0) activesupport (>= 5.0.0) + json (2.6.3) + kramdown (2.4.0) + rexml + kramdown-parser-gfm (1.1.0) + kramdown (~> 2.0) launchy (2.5.0) addressable (~> 2.7) letter_opener (1.8.1) @@ -179,6 +189,9 @@ GEM racc (~> 1.4) orm_adapter (0.5.0) pagy (6.0.2) + parallel (1.22.1) + parser (3.2.1.1) + ast (~> 2.4.1) pg (1.2.3) public_suffix (5.0.0) puma (4.3.12) @@ -217,6 +230,7 @@ GEM rake (>= 12.2) thor (~> 1.0) zeitwerk (~> 2.5) + rainbow (3.1.1) rake (13.0.6) rb-fsevent (0.11.2) rb-inotify (0.10.1) @@ -229,6 +243,8 @@ GEM responders (3.1.0) actionpack (>= 5.2) railties (>= 5.2) + reverse_markdown (2.1.1) + nokogiri rexml (3.2.5) rqrcode (2.1.2) chunky_png (~> 1.0) @@ -251,6 +267,19 @@ GEM rspec-mocks (~> 3.11) rspec-support (~> 3.11) rspec-support (3.12.0) + rubocop (1.48.1) + json (~> 2.3) + parallel (~> 1.10) + parser (>= 3.2.0.0) + rainbow (>= 2.2.2, < 4.0) + regexp_parser (>= 1.8, < 3.0) + rexml (>= 3.2.5, < 4.0) + rubocop-ast (>= 1.26.0, < 2.0) + ruby-progressbar (~> 1.7) + unicode-display_width (>= 2.4.0, < 3.0) + rubocop-ast (1.28.0) + parser (>= 3.2.1.0) + ruby-progressbar (1.13.0) ruby2_keywords (0.0.5) rufus-scheduler (3.8.2) fugit (~> 1.1, >= 1.1.6) @@ -268,6 +297,21 @@ GEM rufus-scheduler (~> 3.2) sidekiq (>= 4, < 7) tilt (>= 1.4.0) + solargraph (0.48.0) + backport (~> 1.2) + benchmark + bundler (>= 1.17.2) + diff-lcs (~> 1.4) + e2mmap + jaro_winkler (~> 1.5) + kramdown (~> 2.3) + kramdown-parser-gfm (~> 1.1) + parser (~> 3.0) + reverse_markdown (>= 1.0.5, < 3) + rubocop (>= 0.52) + thor (~> 1.0) + tilt (~> 2.0) + yard (~> 0.9, >= 0.9.24) sprockets (4.1.1) concurrent-ruby (~> 1.0) rack (> 1, < 3) @@ -289,6 +333,7 @@ GEM railties (>= 6.0.0) tzinfo (2.0.5) concurrent-ruby (~> 1.0) + unicode-display_width (2.4.2) view_component (2.78.0) activesupport (>= 5.0.0, < 8.0) concurrent-ruby (~> 1.0) @@ -304,11 +349,14 @@ GEM addressable (>= 2.8.0) crack (>= 0.3.2) hashdiff (>= 0.4.0, < 2.0.0) + webrick (1.7.0) websocket-driver (0.7.5) websocket-extensions (>= 0.1.0) websocket-extensions (0.1.5) xpath (3.2.0) nokogiri (~> 1.8) + yard (0.9.28) + webrick (~> 1.7.0) zeitwerk (2.6.6) PLATFORMS @@ -344,6 +392,7 @@ DEPENDENCIES sentry-ruby sidekiq (< 7) sidekiq-scheduler + solargraph sprockets-rails sqlite3 (~> 1.4) stimulus-rails diff --git a/README.md b/README.md index 6ff6c17..6e55882 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,6 @@ so: After these steps, you should have a working Rails app with a handful of test users running on [http://localhost:3000](http://localhost:3000). - Log in with username "admin" and password "admin is admin". All users listed on [http://localhost:3000/admin/ldap_users](http://localhost:3000/admin/ldap_users) have the password "user is user". @@ -79,6 +78,15 @@ The setup task will first delete any existing entries in the directory tree Note that all 389ds data is stored in `tmp/389ds`. So if you want to start over with a fresh installation, delete both that directory as well as the container. +#### Solargraph + +[Solargraph](https://solargraph.org/) is a Ruby language server, which you may +use with your editor to add features like auto-completion and syntax +validation. You can add inline documentation for bundled gems with this +command: + + bundle exec yard gems + ## Documentation ### Rails