avocado 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 393630ca933c51e34b00e2fe86bbcfb5caa4ea7764fc34882c21ef4f604bb938
-  data.tar.gz: bfc5362c53ecee86c6369a1318c68fddf2bbd7e457287cb5b9c6b57970ded8aa
+  metadata.gz: e9ec8adfbc4563b5bbcddd5d5406963b4a9fe7d5a38765e35a86c9a3d35a09a0
+  data.tar.gz: 6db1dfa3a370661017533e44f2278a09daeece5c145267f05f0bced8943ea910
 SHA512:
-  metadata.gz: efbe7bfe5b298b207e65e7958e3167be69d6612bd50e8a4a880483ec1a1d9e2c30d45fdae86e0516d34bb00442c0cd16416ad77a00a50ac31c707295d1538709
-  data.tar.gz: b96ba925c445b78c92c560a01c395697dab736363a847c766e310879ded4ad58b97b7dae052a73ed1a267f7315bedd171d9f0097978760cb3de6a1e9b3c02969
+  metadata.gz: 9761662e0cf44fab571f6f6003aed2c0be2ae56424afbc1cc4b3ccb2f0d856a3e4d3b7a67c8a9e82b7d408977ebb30b4f1f61d9af0fd24db17c3fcb5c944cd89
+  data.tar.gz: a8021001d0f4864a36c981b2c5d18b71bca432f4f4b6fcde4ff6f07c38e7fc39f766dd39670041582cacb9a80526423eafd8156b5d8fc0580189679a1b67d144

data/CHANGELOG.md

@@ -1,39 +1,78 @@
+# Changelog
+
 ## [Unreleased]
 
+## [0.7.0] - 2023-08-10
+
+### Added
+
+- An `avocado:views` generator copies engine views into application
+
+### Changed
+
+- Flash messages for controllers moved to i18n yml
+- View forms updated to use `_form` partials
+- Move the reset phase of password recovery to a `Credentials` controller
+
 ## [0.6.0] - 2023-07-25
 
-- Change affirmations and verifications to require user action
-- Use session token instead of id for signed cookie value
-- Add migration generators
+### Added
+
+- Migration generator
+
+### Changed
+
+- Affirmation and Verification paths require user action
+- Use session `token` instead of `id` for signed cookie value
 
 ## [0.5.0] - 2023-07-21
 
-- Add controller for "passwordless" email-link sign-in
-- Add event class to log user auth events
-- Add user-facing email and password edit pages
-- Add various event logging callbacks
-- Sign out all non current sessions when password changes
+### Added
+
+- Controller for "passwordless" email-link sign-in
+- `Event` class to log user auth events
+- User-facing email and password edit pages
+- Misc event logging callbacks
+
+### Changed
+
+- Sign out all non-current sessions when password changes
 
 ## [0.4.0] - 2023-07-19
 
+### Added
+
+- Controllers for signing up, signing in, password reset and email verification
+
+### Changed
+
 - Convert the `Avocado::Mailer` module into a class
-- Add controllers for signing up, signing in, password reset and email
-  verification
 
 ## [0.3.0] - 2023-07-17
 
-- Add an `Avocado::Mailer` which generates each of the signed ids
+### Added
+
+- `Avocado::Mailer` which generates each of the signed ids
+
+### Changed
+
 - Rename `password_recovery` to `password_reset`
 
 ## [0.2.0] - 2023-07-15
 
-- Validate presence, uniqueness, and format on `email` attribute
-- Normalize email value during save
-- Validate password format and length
-- Include a token generator for password recovery
+### Added
+
+- Validations for presence, uniqueness, and format on `email` attribute
+- Normalizer for email value during save
+- Validations on password format and length
+- Token generator for password recovery
+
+### Changed
+
 - Rename `Avocado::UserConcern` to `Avocado::User`
 
 ## [0.1.0] - 2023-07-14
 
-- Initial release
-- Add `Avocado::UserConcern` which calls `has_secure_password`
+### Added
+
+- `Avocado::UserConcern` which calls `has_secure_password`

data/Rakefile

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 

data/app/controllers/avocado/affirmations_controller.rb

@@ -1,18 +1,19 @@
-# frozen_string_literal: true
-
 module Avocado
   class AffirmationsController < BaseController
     skip_before_action :authenticate
 
-    before_action :set_user, only: %i[edit update]
-    before_action :verify_user, only: :create
+    before_action :set_user,
+      only: %i[edit update]
+    before_action :verify_user,
+      only: :create
 
     def new
     end
 
     def create
       send_affirmation_email
-      redirect_to new_session_path, notice: "Check your email for sign in instructions"
+      redirect_to new_session_path,
+        notice: t(".success")
     end
 
     def edit
@@ -20,7 +21,8 @@ module Avocado
 
     def update
       sign_in(@user)
-      redirect_to(root_path, notice: "Signed in successfully")
+      redirect_to root_path,
+        notice: t(".success")
     end
 
     private
@@ -28,7 +30,8 @@ module Avocado
     def set_user
       @user = user_from_signed_affirmation_token
     rescue ActiveSupport::MessageVerifier::InvalidSignature
-      redirect_to new_affirmation_path, alert: "That sign in link is invalid"
+      redirect_to new_affirmation_path,
+        alert: t(".errors.invalid_token")
     end
 
     def user_from_signed_affirmation_token
@@ -37,7 +40,8 @@ module Avocado
 
     def verify_user
       unless requested_verified_user
-        redirect_to new_affirmation_path, alert: "You can't sign in until you verify your email"
+        redirect_to new_affirmation_path,
+          alert: t(".errors.unverified_email")
       end
     end
 

data/app/controllers/avocado/base_controller.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module Avocado
   class BaseController < ApplicationController
     FINDER_PARAMETERS = %i[email]
@@ -8,16 +6,20 @@ module Avocado
 
     def verify_password_challenge
       unless current_user.authenticate(params_password_challenge)
-        redirect_back alert: "Password challenge failed.", fallback_location: root_path
+        redirect_back fallback_location: root_path,
+          alert: t("avocado.filters.invalid_password_challenge")
       end
     end
 
     def params_password_challenge
-      params.dig(:user, :password_challenge)
+      params
+        .dig(:user, :password_challenge)
     end
 
     def requested_verified_user
-      ::User.verified.find_by(email: finder_parameters[:email])
+      ::User
+        .verified
+        .find_by(email: finder_parameters[:email])
     end
 
     def finder_parameters
@@ -27,7 +29,14 @@ module Avocado
     end
 
     def mailer_for(user)
-      Avocado::Mailer.with(user: user)
+      Avocado::Mailer
+        .with(user: user)
+    end
+
+    def send_email_verification(user)
+      mailer_for(user)
+        .email_verification
+        .deliver_later
     end
   end
 end

data/app/controllers/avocado/credentials_controller.rb

@@ -0,0 +1,41 @@
+module Avocado
+  class CredentialsController < BaseController
+    UPDATE_PARAMETERS = %i[password password_confirmation]
+
+    skip_before_action :authenticate
+
+    before_action :set_user
+
+    def edit
+    end
+
+    def update
+      if @user.update(update_parameters)
+        redirect_to new_session_path,
+          notice: t(".success")
+      else
+        render :edit, status: :unprocessable_entity
+      end
+    end
+
+    private
+
+    def set_user
+      @user = user_from_signed_password_reset_token
+    rescue ActiveSupport::MessageVerifier::InvalidSignature
+      redirect_to new_recovery_path,
+        alert: t(".errors.invalid_token")
+    end
+
+    def user_from_signed_password_reset_token
+      ::User
+        .find_by_token_for!(:password_reset, params[:id])
+    end
+
+    def update_parameters
+      params
+        .require(:user)
+        .permit(UPDATE_PARAMETERS)
+    end
+  end
+end

data/app/controllers/avocado/emails_controller.rb

@@ -1,11 +1,10 @@
-# frozen_string_literal: true
-
 module Avocado
   class EmailsController < BaseController
     UPDATE_PARAMETERS = %i[email]
 
     before_action :set_user
-    before_action :verify_password_challenge, only: :update
+    before_action :verify_password_challenge,
+      only: :update
 
     def edit
     end
@@ -13,6 +12,8 @@ module Avocado
     def update
       if @user.update(update_parameters)
         process_email_update
+        redirect_to root_path,
+          notice: t(".success")
       else
         render :edit, status: :unprocessable_entity
       end
@@ -32,17 +33,8 @@ module Avocado
 
     def process_email_update
       if @user.email_previously_changed?
-        resend_email_verification
-        redirect_to root_path, notice: "Your email has been changed"
-      else
-        redirect_to root_path
+        send_email_verification(@user)
       end
     end
-
-    def resend_email_verification
-      mailer_for(@user)
-        .email_verification
-        .deliver_later
-    end
   end
 end

data/app/controllers/avocado/events_controller.rb

@@ -1,9 +1,9 @@
-# frozen_string_literal: true
-
 module Avocado
   class EventsController < BaseController
     def index
-      @events = current_user.events.newest_first
+      @events = current_user
+        .events
+        .newest_first
     end
   end
 end

data/app/controllers/avocado/passwords_controller.rb

@@ -1,18 +1,18 @@
-# frozen_string_literal: true
-
 module Avocado
   class PasswordsController < BaseController
     UPDATE_PARAMETERS = %i[password password_confirmation password_challenge]
 
     before_action :set_user
-    before_action :verify_password_challenge, only: :update
+    before_action :verify_password_challenge,
+      only: :update
 
     def edit
     end
 
     def update
       if @user.update(update_parameters)
-        redirect_to root_path, notice: "Your password has been changed"
+        redirect_to root_path,
+          notice: t(".success")
       else
         render :edit, status: :unprocessable_entity
       end

data/app/controllers/avocado/recoveries_controller.rb

@@ -1,57 +1,28 @@
-# frozen_string_literal: true
-
 module Avocado
   class RecoveriesController < BaseController
-    UPDATE_PARAMETERS = %i[password password_confirmation]
-
     skip_before_action :authenticate
 
-    before_action :set_user, only: %i[edit update]
-    before_action :verify_user, only: :create
+    before_action :verify_user,
+      only: :create
 
     def new
     end
 
     def create
       send_password_reset_email
-      redirect_to new_session_path, notice: "Check your email for reset instructions."
-    end
-
-    def edit
-    end
-
-    def update
-      if @user.update(update_parameters)
-        redirect_to new_session_path, notice: "Password reset successfully. Please sign in."
-      else
-        render :edit, status: :unprocessable_entity
-      end
+      redirect_to new_session_path,
+        notice: t(".success")
     end
 
     private
 
-    def set_user
-      @user = user_from_signed_password_reset_token
-    rescue ActiveSupport::MessageVerifier::InvalidSignature
-      redirect_to new_recovery_path, alert: "Password reset link is invalid."
-    end
-
-    def user_from_signed_password_reset_token
-      ::User.find_by_token_for!(:password_reset, params[:id])
-    end
-
     def verify_user
       unless requested_verified_user
-        redirect_to new_recovery_path, alert: "Verify email first before resetting password."
+        redirect_to new_recovery_path,
+          alert: t(".errors.unverified_email")
       end
     end
 
-    def update_parameters
-      params
-        .require(:user)
-        .permit(UPDATE_PARAMETERS)
-    end
-
     def send_password_reset_email
       mailer_for(requested_verified_user)
         .password_reset

data/app/controllers/avocado/registrations_controller.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module Avocado
   class RegistrationsController < BaseController
     INITIALIZATION_PARAMETERS = %i[email password password_confirmation]
@@ -16,8 +14,9 @@ module Avocado
       if @user.save
         sign_in(@user)
 
-        send_email_verification
-        redirect_to root_path, notice: "Registration successful"
+        send_email_verification(@user)
+        redirect_to root_path,
+          notice: t(".success")
       else
         render :new, status: :unprocessable_entity
       end
@@ -30,11 +29,5 @@ module Avocado
         .require(:user)
         .permit(INITIALIZATION_PARAMETERS)
     end
-
-    def send_email_verification
-      mailer_for(@user)
-        .email_verification
-        .deliver_later
-    end
   end
 end

data/app/controllers/avocado/sessions_controller.rb

@@ -1,19 +1,21 @@
-# frozen_string_literal: true
-
 module Avocado
   class SessionsController < BaseController
     AUTHENTICATION_PARAMETERS = %i[email password]
 
-    skip_before_action :authenticate, only: %i[new create]
+    skip_before_action :authenticate,
+      only: %i[new create]
 
     with_options only: :create do
       before_action :verify_authentication_attempt
     end
 
-    before_action :set_session, only: :destroy
+    before_action :set_session,
+      only: :destroy
 
     def index
-      @sessions = current_user.sessions.newest_first
+      @sessions = current_user
+        .sessions
+        .newest_first
     end
 
     def new
@@ -23,12 +25,14 @@ module Avocado
     def create
       sign_in(authenticated_user)
 
-      redirect_to root_path, notice: "Session created"
+      redirect_to root_path,
+        notice: t(".success")
     end
 
     def destroy
       @session.destroy
-      redirect_to sessions_path, notice: "Session destroyed"
+      redirect_to sessions_path,
+        notice: t(".success")
     end
 
     private
@@ -41,17 +45,21 @@ module Avocado
     end
 
     def authenticated_user
-      @_authenticated_user ||= ::User.authenticate_by(authentication_parameters)
+      @_authenticated_user ||= ::User
+        .authenticate_by(authentication_parameters)
     end
 
     def verify_authentication_attempt
       if authenticated_user.blank?
-        redirect_to new_session_path, alert: "Authentication failed"
+        redirect_to new_session_path,
+          alert: t(".errors.authentication")
       end
     end
 
     def set_session
-      @session = current_user.sessions.find(params[:id])
+      @session = current_user
+        .sessions
+        .find(params[:id])
     end
   end
 end

data/app/controllers/avocado/verifications_controller.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module Avocado
   class VerificationsController < BaseController
     with_options only: %i[edit update] do
@@ -12,12 +10,14 @@ module Avocado
 
     def update
       @user.update! verified: true
-      redirect_to root_path, notice: "Email address verified."
+      redirect_to root_path,
+        notice: t(".success")
     end
 
     def create
-      send_email_verification
-      redirect_to root_path, notice: "Verification email sent to your address."
+      send_email_verification(current_user)
+      redirect_to root_path,
+        notice: t(".success")
     end
 
     private
@@ -25,17 +25,13 @@ module Avocado
     def set_user
       @user = user_from_signed_email_verification_token
     rescue ActiveSupport::MessageVerifier::InvalidSignature
-      redirect_to root_path, alert: "Email verification link is invalid."
+      redirect_to root_path,
+        alert: t(".errors.invalid_token")
     end
 
     def user_from_signed_email_verification_token
-      ::User.find_by_token_for!(:email_verification, params[:id])
-    end
-
-    def send_email_verification
-      mailer_for(current_user)
-        .email_verification
-        .deliver_later
+      ::User
+        .find_by_token_for!(:email_verification, params[:id])
     end
   end
 end

data/app/views/avocado/affirmations/_form.html.erb

@@ -0,0 +1,4 @@
+<div>
+  <%= form.label :email %>
+  <%= form.email_field :email, autofocus: true, autocomplete: "email", required: true %>
+</div>

data/app/views/avocado/affirmations/new.html.erb

@@ -7,8 +7,6 @@
 </p>
 
 <%= form_with url: affirmations_path, scope: :user do |form| %>
-  <%= form.label :email %>
-  <%= form.email_field :email, autofocus: true, autocomplete: "email", required: true %>
-
+  <%= render form %>
   <%= form.button "Submit", name: nil %>
 <% end -%>

data/app/views/avocado/{recoveries/edit.html.erb → credentials/_form.html.erb}

@@ -1,17 +1,8 @@
-<h2>
-  Change your password
-</h2>
-
-<p>
-  <%= link_to "Sign in to your account" %>
-</p>
-
-<%= form_with model: @user, url: recovery_path(id: params[:id]), method: :patch do |form| %>
+<div>
   <%= form.label :password %>
   <%= form.password_field :password, autocomplete: "new-password", required: true %>
-
+</div>
+<div>
   <%= form.label :password_confirmation %>
   <%= form.password_field :password_confirmation, autocomplete: "new-password", required: true %>
-
-  <%= form.button "Submit", name: nil %>
-<% end %>
+</div>

data/app/views/avocado/credentials/edit.html.erb

@@ -0,0 +1,12 @@
+<h2>
+  Change your password
+</h2>
+
+<p>
+  <%= link_to "Sign in to your account" %>
+</p>
+
+<%= form_with model: @user, url: credential_path(id: params[:id]), method: :patch do |form| %>
+  <%= render form %>
+  <%= form.button "Submit", name: nil %>
+<% end %>

data/app/views/avocado/emails/_form.html.erb

@@ -0,0 +1,8 @@
+<div>
+  <%= form.label :email %>
+  <%= form.email_field :email, autocomplete: "email", required: true %>
+</div>
+<div>
+  <%= form.label :password_challenge, "Current password" %>
+  <%= form.password_field :password_challenge, autocomplete: "current-password", required: true %>
+</div>

data/app/views/avocado/emails/edit.html.erb

@@ -10,11 +10,6 @@
 <% end %>
 
 <%= form_with model: @user, url: email_path, method: :patch do |form| %>
-  <%= form.label :email %>
-  <%= form.email_field :email, autocomplete: "email", required: true %>
-
-  <%= form.label :password_challenge, "Current password" %>
-  <%= form.password_field :password_challenge, autocomplete: "current-password", required: true %>
-
+  <%= render form %>
   <%= form.button "Submit", name: nil %>
 <% end %>

data/app/views/avocado/mailer/password_reset.text.erb

@@ -1,3 +1,3 @@
 Reset your password by following this link:
 
-<%= edit_recovery_url(id: @signed_id) %>
+<%= edit_credential_url(id: @signed_id) %>

data/app/views/avocado/passwords/_form.html.erb

@@ -0,0 +1,12 @@
+<div>
+  <%= form.label :password_challenge, "Current password" %>
+  <%= form.password_field :password_challenge, autocomplete: "current-password", required: true %>
+</div>
+<div>
+  <%= form.label :password %>
+  <%= form.password_field :password, autocomplete: "new-password", required: true %>
+</div>
+<div>
+  <%= form.label :password_confirmation %>
+  <%= form.password_field :password_confirmation, autocomplete: "new-password", required: true %>
+</div>

data/app/views/avocado/passwords/edit.html.erb

@@ -3,14 +3,6 @@
 </h2>
 
 <%= form_with model: @user, url: password_path, method: :patch do |form| %>
-  <%= form.label :password_challenge, "Current password" %>
-  <%= form.password_field :password_challenge, autocomplete: "current-password", required: true %>
-
-  <%= form.label :password %>
-  <%= form.password_field :password, autocomplete: "new-password", required: true %>
-
-  <%= form.label :password_confirmation %>
-  <%= form.password_field :password_confirmation, autocomplete: "new-password", required: true %>
-
+  <%= render form %>
   <%= form.button "Submit", name: nil %>
 <% end %>

data/app/views/avocado/recoveries/_form.html.erb

@@ -0,0 +1,4 @@
+<div>
+  <%= form.label :email %>
+  <%= form.email_field :email, autofocus: true, autocomplete: "email", required: true %>
+</div>

data/app/views/avocado/recoveries/new.html.erb

@@ -7,8 +7,6 @@
 </p>
 
 <%= form_with url: recoveries_path, scope: :user do |form| %>
-  <%= form.label :email %>
-  <%= form.email_field :email, autofocus: true, autocomplete: "email", required: true %>
-
+  <%= render form %>
   <%= form.button "Submit", name: nil %>
 <% end -%>

data/app/views/avocado/registrations/_form.html.erb

@@ -0,0 +1,12 @@
+<div>
+  <%= form.label :email %>
+  <%= form.email_field :email, autofocus: true, autocomplete: "email", required: true %>
+</div>
+<div>
+  <%= form.label :password %>
+  <%= form.password_field :password, autocomplete: "new-password", required: true %>
+</div>
+<div>
+  <%= form.label :password_confirmation %>
+  <%= form.password_field :password_confirmation, autocomplete: "new-password", required: true %>
+</div>

data/app/views/avocado/registrations/new.html.erb

@@ -7,17 +7,6 @@
 </p>
 
 <%= form_with model: @user, url: registrations_path do |form| %>
-  <div>
-    <%= form.label :email %>
-    <%= form.email_field :email, autofocus: true, autocomplete: "email", required: true %>
-  </div>
-  <div>
-    <%= form.label :password %>
-    <%= form.password_field :password, autocomplete: "new-password", required: true %>
-  </div>
-  <div>
-    <%= form.label :password_confirmation %>
-    <%= form.password_field :password_confirmation, autocomplete: "new-password", required: true %>
-  </div>
+  <%= render form %>
   <%= form.button "Submit", name: nil %>
 <% end %>

data/app/views/avocado/sessions/_form.html.erb

@@ -0,0 +1,8 @@
+<div>
+  <%= form.label :email %>
+  <%= form.email_field :email, autofocus: true, autocomplete: "email", required: true %>
+</div>
+<div>
+  <%= form.label :password %>
+  <%= form.password_field :password, autocomplete: "current-password", required: true %>
+</div>

data/app/views/avocado/sessions/new.html.erb

@@ -7,9 +7,6 @@
 </p>
 
 <%= form_with model: @session do |form| %>
-  <%= form.label :email %>
-  <%= form.email_field :email, autofocus: true, autocomplete: "email", required: true %>
-  <%= form.label :password %>
-  <%= form.password_field :password, autocomplete: "current-password", required: true %>
+  <%= render form %>
   <%= form.button "Submit", name: nil %>
 <% end -%>

data/config/locales/en.yml

@@ -0,0 +1,45 @@
+en:
+  avocado:
+    affirmations:
+      create:
+        success: Check email for sign in instructions.
+      errors:
+        invalid_token: Sign in link is invalid.
+        unverified_email: Verify email first before signing in.
+      update:
+        success: Signed in successfully.
+    credentials:
+      update:
+        success: Password reset successfully.
+      errors:
+        invalid_token: Password reset link is invalid.
+    emails:
+      update:
+        success: Email has been changed.
+    filters:
+      invalid_password_challenge: Password challenge failed.
+    passwords:
+      update:
+        success: Password has been changed.
+    recoveries:
+      create:
+        success: Check email for reset instructions.
+      errors:
+        unverified_email: Verify email first before resetting password.
+    registrations:
+      create:
+        success: Registration successful.
+    sessions:
+      create:
+        success: Session created.
+      destroy:
+        success: Session destroyed.
+      errors:
+        authentication: Authentication failed.
+    verifications:
+      create:
+        success: Verification email sent.
+      errors:
+        invalid_token: Email verification link is invalid.
+      update:
+        success: Email address verified.

data/config/routes/avocado.rb

@@ -2,8 +2,9 @@ scope module: :avocado do
   resource :email, only: %i[edit update]
   resource :password, only: %i[edit update]
   resources :affirmations, only: %i[new create edit update]
+  resources :credentials, only: %i[edit update]
   resources :events, only: %i[index]
-  resources :recoveries, only: %i[new create edit update]
+  resources :recoveries, only: %i[new create]
   resources :registrations, only: %i[new create]
   resources :sessions, only: %i[index new create destroy]
   resources :verifications, only: %i[create edit update]

data/config.ru

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 require "rubygems"
 require "bundler"
 

data/docs/USAGE.md

@@ -8,8 +8,8 @@ scenarios, and can be subclassed and overridden for special cases.
 ## Requirements
 
 Apps must be running Rails 7.1 or newer. The 🥑 gem uses features like
-`authenticate_by`, `has_secure_password`, `generates_token_for`, and
-`normalizes` which don't exist in earlier versions.
+`authenticate_by`, the `password_challenge` feature of `has_secure_password`,
+`generates_token_for`, and `normalizes` which don't exist in earlier versions.
 
 The database schema must have columns that match the `users`, `sessions`, and
 `events` tables from the [demo app schema]. More columns in each table are
@@ -21,9 +21,12 @@ Run `bin/rails g avocado:migrations` to generate migrations for the tables.
 
 The application must also have:
 
-- An `ApplicationController` base controller class
-- An `ApplicationMailer` base mailer class
-- A `root_path` method (typically generated by application routes)
+- An `ApplicationController` base controller class for the controllers to
+  inherit from.
+- An `ApplicationMailer` base mailer class which sets a layout and default
+  `from` value.
+- A `root_path` route helper method (typically generated by routes configured in
+  the application).
 
 ## Usage
 
@@ -60,11 +63,11 @@ end
 
 ### Routes
 
-The 🥑 gem does not add any routes to the application when initialized. To hook
-up the controllers to routes, they must be added to the `config/routes.rb` of
-the application. It's possible to add all of the routes, or just a subset.
+By defalt, 🥑 does not add any routes to the application when initialized. To
+hook up the controllers to routes, they must be added to the `config/routes.rb`
+of the application. It's possible to add all of the routes, or just a subset.
 
-Example that defines a root route and also pulls in every feature route:
+This example defines a `root` route and also pulls in every feature route:
 
 ```ruby
 Rails.application.routes.draw do
@@ -73,12 +76,12 @@ Rails.application.routes.draw do
 end
 ```
 
-Example that adds only the sign-up, sign-in, and sign-out actions:
+This example defines a `root` route and adds only a subset of feature routes:
 
 ```ruby
 Rails.application.routes.draw do
   root to: "records#index"
-  scope module: :avocado do
+  scope module: 🥑 do
     resources :registrations, only: %i[new create]
     resources :sessions, only: %i[new create destroy]
   end
@@ -94,18 +97,19 @@ app initialization.
 
 These external (unauthenticated) features are available:
 
-- `Registrations` -- Fill out new form and create users
-- `Sessions` -- Sign in and sign out features
-- `Recoveries` -- Trigger password reset, click link, confirm
-- `Verifications` -- Email confirmation on account creation or email change
-- `Affirmations` -- Provides a "passwordless" auth via emailed link
+- `Registrations` -- Fill out new user form and create users
+- `Sessions` -- Sign in and sign out
+- `Recoveries` -- Triggers password reset via emailed expiring link
+- `Credentials` -- Use expiring token link from recovery to update password
+- `Verifications` -- Confirm email address on account creation or email change
+- `Affirmations` -- "Passwordless" authentication via emailed expiring link
 
 These internal (authenticated) features are available:
 
-- `Sessions` -- List active sessions, click to destroy untrusted ones
-- `Events` -- List view of user activity audit log
-- `Passwords` -- Edit and update user password
-- `Emails` -- Edit and update user email
+- `Sessions` -- Index view of active sessions, ability to destroy sessions
+- `Events` -- Index view of the user activity audit log
+- `Passwords` -- Edit and update a user password
+- `Emails` -- Edit and update a user email
 
 Linking to any of these internal pages is optional. Apps can use them as-is,
 override their views, or even ignore them entirely and make local versions.
@@ -118,14 +122,15 @@ within `app/views/avocado/mailer/` to make this happen.
 
 ### Before actions
 
-There is an `authenticate` method installed as a default `before_action`. Any
-actions which do not need to be authenticated should disable this with
-`skip_before_action`.
+There is an `authenticate` method installed as default controller behavior using
+`before_action :authenticate`. Any actions which do not need to be authenticated
+should disable this with `skip_before_action :authenticate`, or inherit from a
+controller which performs the skip.
 
-There is a `set_current_request_details` method installed as a default
-`before_action` which takes some loggable request meta information (user agent,
-IP address) and sets its value in `Current` so that its accesible to code
-elsewhere in the 🥑 gem.
+There is also a `set_current_request_details` method installed as a default
+`before_action` which takes some loggable request meta information (User Agent,
+IP Address) and sets their values in `Current` so that they are accesible to
+code elsewhere in the 🥑 gem.
 
 ### Helpers
 
@@ -144,7 +149,11 @@ There is not any configuration. To override functionality:
 
 - Redefine a method created in one of the models by the included module
 - Subclass a controller and update the routing to go to the subclass
-- Place views in the app where avocado expects them to override the defaults
+- Place views in the app where avocado expects (`app/views/avocado`) them to
+  override the defaults
+
+There is an `avocado:views` generator which will copy all the views as a
+starting point for further modification.
 
 ## Examples
 
@@ -152,4 +161,4 @@ There is a [demo app] used by the specs which has some example usage.
 
 [demo app schema]: https://github.com/tcuwp/avocado/blob/main/spec/internal/db/schema.rb
 [demo app]: https://github.com/tcuwp/avocado/blob/main/spec/internal
-[Rails Engine]: https://guides.rubyonrails.org/engines.html#what-are-engines-questionmark
+[Rails Engine]: https://guides.rubyonrails.org/engines.html#what-are-engines-questionmark

data/lib/avocado/authentication.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module Avocado
   module Authentication
     extend ActiveSupport::Concern

data/lib/avocado/current.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module Avocado
   class Current < ActiveSupport::CurrentAttributes
     attribute :session,

data/lib/avocado/engine.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 require "avocado"
 require "rails/engine"
 
@@ -7,7 +5,7 @@ module Avocado
   class Engine < Rails::Engine
     initializer :avocado_routing do
       ActiveSupport.on_load(:action_dispatch_request) do
-        ActionDispatch::Routing::Mapper.define_method(:🥑) { :🥑 }
+        ActionDispatch::Routing::Mapper.define_method(:🥑) { :avocado }
       end
     end
   end

data/lib/avocado/event.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module Avocado
   module Event
     extend ActiveSupport::Concern

data/lib/avocado/mailer.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module Avocado
   class Mailer < ApplicationMailer
     before_action :set_user

data/lib/avocado/session.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module Avocado
   module Session
     extend ActiveSupport::Concern

data/lib/avocado/session_callbacks.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module Avocado
   module SessionCallbacks
     extend ActiveSupport::Concern

data/lib/avocado/user.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module Avocado
   module User
     extend ActiveSupport::Concern

data/lib/avocado/user_callbacks.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module Avocado
   module UserCallbacks
     extend ActiveSupport::Concern

data/lib/avocado/user_tokens.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module Avocado
   module UserTokens
     extend ActiveSupport::Concern

data/lib/avocado/user_validations.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module Avocado
   module UserValidations
     extend ActiveSupport::Concern

data/lib/avocado/version.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module Avocado
-  VERSION = "0.6.0"
+  VERSION = "0.7.0"
 end

data/lib/avocado.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 require "active_support"
 require_relative "avocado/engine"
 

data/lib/generators/avocado/migrations/migrations_generator.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 require "rails/generators/base"
 require "rails/generators/active_record"
 

data/lib/generators/avocado/views/views_generator.rb

@@ -0,0 +1,21 @@
+require "rails/generators/base"
+
+module Avocado
+  class ViewsGenerator < Rails::Generators::Base
+    source_root File.expand_path("../../../..", __dir__)
+
+    def create_views
+      directory source_directory, target_directory
+    end
+
+    private
+
+    def source_directory
+      "app/views/avocado"
+    end
+
+    def target_directory
+      Rails.root.join("app/views/avocado")
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: avocado
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Matt Jankowski
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-25 00:00:00.000000000 Z
+date: 2023-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bcrypt
@@ -40,7 +40,7 @@ dependencies:
         version: 7.1.0.alpha
 description:
 email:
-- matt@jankowski.online
+- info@tcuwp.co
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -54,6 +54,7 @@ files:
 - Rakefile
 - app/controllers/avocado/affirmations_controller.rb
 - app/controllers/avocado/base_controller.rb
+- app/controllers/avocado/credentials_controller.rb
 - app/controllers/avocado/emails_controller.rb
 - app/controllers/avocado/events_controller.rb
 - app/controllers/avocado/passwords_controller.rb
@@ -61,25 +62,32 @@ files:
 - app/controllers/avocado/registrations_controller.rb
 - app/controllers/avocado/sessions_controller.rb
 - app/controllers/avocado/verifications_controller.rb
+- app/views/avocado/affirmations/_form.html.erb
 - app/views/avocado/affirmations/edit.html.erb
 - app/views/avocado/affirmations/new.html.erb
+- app/views/avocado/credentials/_form.html.erb
+- app/views/avocado/credentials/edit.html.erb
+- app/views/avocado/emails/_form.html.erb
 - app/views/avocado/emails/edit.html.erb
 - app/views/avocado/events/_event.html.erb
 - app/views/avocado/events/index.html.erb
 - app/views/avocado/mailer/email_affirmation.text.erb
 - app/views/avocado/mailer/email_verification.text.erb
 - app/views/avocado/mailer/password_reset.text.erb
+- app/views/avocado/passwords/_form.html.erb
 - app/views/avocado/passwords/edit.html.erb
-- app/views/avocado/recoveries/edit.html.erb
+- app/views/avocado/recoveries/_form.html.erb
 - app/views/avocado/recoveries/new.html.erb
+- app/views/avocado/registrations/_form.html.erb
 - app/views/avocado/registrations/new.html.erb
+- app/views/avocado/sessions/_form.html.erb
 - app/views/avocado/sessions/_session.html.erb
 - app/views/avocado/sessions/index.html.erb
 - app/views/avocado/sessions/new.html.erb
 - app/views/avocado/verifications/edit.html.erb
 - config.ru
+- config/locales/en.yml
 - config/routes/avocado.rb
-- "config/routes/\U0001F951.rb"
 - docs/USAGE.md
 - lib/avocado.rb
 - lib/avocado/authentication.rb
@@ -98,6 +106,7 @@ files:
 - lib/generators/avocado/migrations/templates/create_events.rb.tt
 - lib/generators/avocado/migrations/templates/create_sessions.rb.tt
 - lib/generators/avocado/migrations/templates/create_users.rb.tt
+- lib/generators/avocado/views/views_generator.rb
 - sig/avocado.rbs
 homepage: https://github.com/tcuwp/avocado
 licenses:
@@ -121,7 +130,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.15
+rubygems_version: 3.4.18
 signing_key:
 specification_version: 4
 summary: Simple authentication for Rails (7.1+) applications

data/config/routes//360/237/245/221.rb

@@ -1 +0,0 @@
-avocado.rb