WIP Add notifications preferences page

Use resources instead of custom controllers, following the Rails way
and making things much cleaner in the process.

Gemfile

@@ -66,6 +66,7 @@ group :development do
   gem 'letter_opener'
   gem 'letter_opener_web'
   gem 'faker'
+  gem 'solargraph'
 end
 
 group :test do

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

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

app/components/form_elements/fieldset_component.html.erb

@@ -1,4 +1,5 @@
 <%= tag.public_send(@tag, class: "mb-6 last:mb-0") do %>
+  <% if @positioning == :vertical %>
   <label class="block">
     <p class="font-bold <%= @descripton.present? ? "mb-1" : "mb-2" %>">
       <%= @title %>
@@ -10,4 +11,19 @@
     <% end %>
     <%= content %>
   </label>
+  <% elsif @positioning == :horizontal %>
+  <label class="block flex items-center justify-between">
+    <div class="flex flex-col">
+      <label class="font-bold mb-1"><%= @title %></label>
+      <% if @descripton.present? %>
+      <p class="text-gray-500"><%= @descripton %></p>
+      <% end %>
+    </div>
+    <div class="relative ml-4 inline-flex flex-shrink-0">
+      <%= content %>
+    </div>
+  </label>
+  <% else %>
+  <p>Invalid <code>positioning<code> argument for <code>FieldsetComponent</code>.</p>
+  <% end %>
 <% end %>

app/components/form_elements/fieldset_component.rb

@@ -2,10 +2,11 @@
 
 module FormElements
   class FieldsetComponent < ViewComponent::Base
-    def initialize(tag: "li", title:, description: nil)
-      @tag = tag
-      @title = title
-      @descripton = description
+    def initialize(tag: "li", positioning: :vertical, title:, description: nil)
+      @tag         = tag
+      @positioning = positioning
+      @title       = title
+      @descripton  = description
     end
   end
 end

app/controllers/settings/account_controller.rb

@@ -1,13 +0,0 @@
-class Settings::AccountController < SettingsController
-
-  def index
-  end
-
-  def reset_password
-    current_user.send_reset_password_instructions
-    sign_out current_user
-    msg = "We have sent you an email with a link to reset your password."
-    redirect_to check_your_email_path, notice: msg
-  end
-
-end

app/controllers/settings/profile_controller.rb

@@ -1,11 +0,0 @@
-class Settings::ProfileController < SettingsController
-
-  def index
-    @user = current_user
-  end
-
-  def update
-
-  end
-
-end

app/controllers/settings_controller.rb

@@ -1,13 +1,38 @@
 class SettingsController < ApplicationController
-  before_action :require_user_signed_in
-  before_action :set_current_section
+  before_action :authenticate_user!
+  before_action :set_main_nav_section
+  before_action :set_settings_section, only: ['show', 'update']
 
   def index
+    redirect_to setting_path(:profile)
+  end
+
+  def show
+    @user = current_user
+  end
+
+  def update
+  end
+
+  def reset_password
+    current_user.send_reset_password_instructions
+    sign_out current_user
+    msg = "We have sent you an email with a link to reset your password."
+    redirect_to check_your_email_path, notice: msg
   end
 
   private
 
-  def set_current_section
+  def set_main_nav_section
     @current_section = :settings
   end
+
+  def set_settings_section
+    @settings_section = params[:section]
+    allowed_sections  = [:profile, :account, :notifications]
+
+    unless allowed_sections.include?(@settings_section.to_sym)
+      redirect_to setting_path(:profile)
+    end
+  end
 end

app/views/icons/_bell.html.erb

@@ -1 +1 @@
-<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-bell"><path d="M18 8A6 6 0 0 0 6 8c0 7-3 9-3 9h18s-3-2-3-9"></path><path d="M13.73 21a2 2 0 0 1-3.46 0"></path></svg>
+<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-bell <%= custom_class %>"><path d="M18 8A6 6 0 0 0 6 8c0 7-3 9-3 9h18s-3-2-3-9"></path><path d="M13.73 21a2 2 0 0 1-3.46 0"></path></svg>

app/views/settings/_account.html.erb

@@ -0,0 +1,19 @@
+<section>
+  <h3>E-Mail</h3>
+  <p class="mb-2">
+    <%= label :email, 'Address', class: 'font-bold' %>
+  </p>
+  <p class="flex gap-1 mb-2 sm:w-3/5">
+    <input type="text" id="email" class="grow"
+           value=<%= current_user.email %> disabled="disabled" />
+  </p>
+</section>
+<section>
+  <h3>Password</h3>
+  <p class="mb-8">Use the following button to request an email with a password reset link:</p>
+  <%= form_with(url: reset_password_settings_path, method: :post) do %>
+    <p>
+      <%= submit_tag("Send me a password reset link", class: 'btn-md btn-gray w-full sm:w-auto') %>
+    </p>
+  <% end %>
+</section>

app/views/settings/_notifications.html.erb

@@ -0,0 +1,16 @@
+<section>
+  <h3>Lightning Wallet</h3>
+
+  <ul role="list">
+    <%= render FormElements::FieldsetComponent.new(
+      positioning: :horizontal,
+      title: "Sats received",
+      description: "Notify when sats are sent to my Lightning Address"
+    ) do %>
+    <%= select_tag :sats_received, options_for_select([
+      ["off", "off"],
+      ["Chat (Jabber)", "xmpp"]
+    ]) %>
+    <% end %>
+  </ul>
+</section>

app/views/settings/_profile.html.erb

@@ -0,0 +1,30 @@
+<section>
+  <h3>Profile</h3>
+  <p class="mb-2">
+    <%= label :user_address, 'User address', class: 'font-bold' %>
+  </p>
+  <p data-controller="clipboard" class="flex gap-1 mb-2 sm:w-3/5">
+    <input type="text" id="user_address" class="grow"
+           value=<%= @user.address %> disabled="disabled"
+           data-clipboard-target="source" />
+    <button id="copy-user-address" class="btn-md btn-icon btn-blue shrink-0"
+            data-clipboard-target="trigger" data-action="clipboard#copy"
+            title="Copy to clipboard">
+      <span class="content-initial">
+        <%= render partial: "icons/copy", locals: { custom_class: "text-white h-4 w-4 inline" } %>
+      </span>
+      <span class="content-active hidden">
+        <%= render partial: "icons/check", locals: { custom_class: "text-white h-4 w-4 inline" } %>
+      </span>
+    </button>
+  </p>
+  <p class="text-sm text-gray-500">
+    Your user address for Chat and Lightning Network.
+  </p>
+
+  <%# <%= form_for(@user, as: "profile", url: settings_profile_path) do |f| %>
+  <%#   <p class="mt-8">
+  <%#     <%= f.submit "Save changes", class: 'btn-md btn-blue w-full sm:w-auto' %>
+  <%#   </p>
+  <%# <% end %>
+</section>

app/views/settings/account/index.html.erb

@@ -1,23 +0,0 @@
-<%= render HeaderComponent.new(title: "Settings") %>
-
-<%= render MainWithSidenavComponent.new(sidenav_partial: 'shared/sidenav_settings') do %>
-  <section>
-    <h3>E-Mail</h3>
-    <p class="mb-2">
-      <%= label :email, 'Address', class: 'font-bold' %>
-    </p>
-    <p class="flex gap-1 mb-2 sm:w-3/5">
-      <input type="text" id="email" class="grow"
-             value=<%= current_user.email %> disabled="disabled" />
-    </p>
-  </section>
-  <section>
-    <h3>Password</h3>
-    <p class="mb-8">Use the following button to request an email with a password reset link:</p>
-    <%= form_with(url: settings_reset_password_path, method: :post) do %>
-      <p>
-        <%= submit_tag("Send me a password reset link", class: 'btn-md btn-gray w-full sm:w-auto') %>
-      </p>
-    <% end %>
-  </section>
-<% end %>

app/views/settings/profile/index.html.erb

@@ -1,34 +0,0 @@
-<%= render HeaderComponent.new(title: "Settings") %>
-
-<%= render MainWithSidenavComponent.new(sidenav_partial: 'shared/sidenav_settings') do %>
-  <section>
-    <h3>Profile</h3>
-    <p class="mb-2">
-      <%= label :user_address, 'User address', class: 'font-bold' %>
-    </p>
-    <p data-controller="clipboard" class="flex gap-1 mb-2 sm:w-3/5">
-      <input type="text" id="user_address" class="grow"
-             value=<%= @user.address %> disabled="disabled"
-             data-clipboard-target="source" />
-      <button id="copy-user-address" class="btn-md btn-icon btn-blue shrink-0"
-              data-clipboard-target="trigger" data-action="clipboard#copy"
-              title="Copy to clipboard">
-        <span class="content-initial">
-          <%= render partial: "icons/copy", locals: { custom_class: "text-white h-4 w-4 inline" } %>
-        </span>
-        <span class="content-active hidden">
-          <%= render partial: "icons/check", locals: { custom_class: "text-white h-4 w-4 inline" } %>
-        </span>
-      </button>
-    </p>
-    <p class="text-sm text-gray-500">
-      Your user address for Chat and Lightning Network.
-    </p>
-
-    <%# <%= form_for(@user, as: "profile", url: settings_profile_path) do |f| %>
-    <%#   <p class="mt-8">
-    <%#     <%= f.submit "Save changes", class: 'btn-md btn-blue w-full sm:w-auto' %>
-    <%#   </p>
-    <%# <% end %>
-  </section>
-<% end %>

app/views/settings/show.html.erb

@@ -0,0 +1,5 @@
+<%= render HeaderComponent.new(title: "Settings") %>
+
+<%= render MainWithSidenavComponent.new(sidenav_partial: 'shared/sidenav_settings') do %>
+  <%= render partial: @settings_section %>
+<% end %>

app/views/shared/_main_nav.html.erb

@@ -6,5 +6,5 @@
       class: main_nav_class(@current_section, :invitations) %>
 <%= link_to "Wallet", wallet_path,
       class: main_nav_class(@current_section, :wallet) %>
-<%= link_to "Settings", settings_profile_path,
+<%= link_to "Settings", settings_path,
       class: main_nav_class(@current_section, :settings) %>

app/views/shared/_sidenav_settings.html.erb

@@ -1,11 +1,12 @@
 <%= render SidenavLinkComponent.new(
-  name: "Profile", path: settings_profile_path, icon: "user",
-  active: current_page?(settings_profile_path)
+  name: "Profile", path: setting_path(:profile), icon: "user",
+  active: current_page?(setting_path(:profile))
 ) %>
 <%= render SidenavLinkComponent.new(
-  name: "Account", path: settings_account_path, icon: "key",
-  active: current_page?(settings_account_path)
+  name: "Account", path: setting_path(:account), icon: "key",
+  active: current_page?(setting_path(:account))
 ) %>
 <%= render SidenavLinkComponent.new(
-  name: "Security", path: "#", icon: "shield", disabled: true
+  name: "Notifications", path: setting_path(:notifications), icon: "bell",
+  active: current_page?(setting_path(:notifications))
 ) %>

config/routes.rb

@@ -10,13 +10,6 @@ Rails.application.routes.draw do
   match 'signup/:step', to: 'signup#steps', as: :signup_steps, via: [:get, :post]
   post 'signup_validate', to: 'signup#validate'
 
-  namespace :settings do
-    get 'profile', to: 'profile#index'
-    post 'profile', to: 'profile#update'
-    get 'account', to: 'account#index'
-    post 'reset_password', to: 'account#reset_password'
-  end
-
   namespace :contributions do
     root to: 'donations#index'
     get 'projects', to: 'projects#index'
@@ -28,6 +21,12 @@ Rails.application.routes.draw do
   get 'wallet', to: 'wallet#index'
   get 'wallet/transactions', to: 'wallet#transactions'
 
+  resources :settings, param: 'section', only: ['index', 'show', 'update'] do
+    collection do
+      post 'reset_password'
+    end
+  end
+
   get 'lnurlpay/:address', to: 'lnurlpay#index',
     as: 'lightning_address', constraints: { address: /[^\/]+/}
   get 'lnurlpay/:address/invoice', to: 'lnurlpay#invoice',