Configurable roles: Owner, Mechanic, Pilot, Viewer and custom roles

What people can do on an aircraft now comes from their role there, and
administrators set what each role allows (Admin → Roles).

- Roles are installation-wide sets of permissions (31, grouped as flying,
  squawks and notes, maintenance records, imports and exports, the
  aircraft, notifications). Seeing an aircraft's records needs none.
- Built in: Owner (always every permission, so an aircraft can always be
  managed), Mechanic (shop maintenance: logbook, signing, components,
  inspections, ADs, squawks, reminders), Pilot (what pilots could do
  before) and Viewer (view only). Administrators can change all but
  Owner's, and add their own; a role can be deleted once nobody has it.
- Existing owners and pilots keep exactly what they could do.
- Admin → Users → a user lists their role on every aircraft, to change,
  remove or add. On the aircraft's Access page, anyone who manages people
  hands out roles, but only an Owner can give or take away Owner, nobody
  changes their own (except administrators), and an aircraft always
  keeps an Owner (AircraftAccess).
- Controllers declare the permission each action needs; a request that
  changes something with none declared is refused (and raises in
  development and tests), and a test walks every route to check.
- Weekly reminders and overdue alerts go to roles that get reminders;
  the DRS reminder also needs Manage ADs. The API follows the person's
  role; its owners_only error is now not_permitted.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
rickyandClaude Opus 5.5 committed 2026-11-15 17:43:38 -05:00
1 parent d2cd60c6a7
commit d8cd462194
101 files changed
+1032 -232

No files matched your search

+14 -4
View File
@@ -1,11 +1,21 @@
# Someone's role on an aircraft (Role), which decides what they can do there.
class AircraftRole < ApplicationRecord
ROLES = LabelSet.new("aircraft_role.roles", %w[owner pilot])
belongs_to :aircraft
belongs_to :user
belongs_to :role
validates :role, inclusion: { in: ROLES.keys }
validates :user_id, uniqueness: { scope: :aircraft_id, message: "already has a role on this aircraft" }
scope :owners, -> { where(role: "owner") }
scope :owners, -> { joins(:role).where(roles: { key: "owner" }) }
# Whose role includes a permission (Owner always does).
scope :with_permission, ->(permission) {
joins(:role).where("roles.key = 'owner' OR EXISTS (SELECT 1 FROM json_each(roles.permissions) WHERE json_each.value = ?)", permission.to_s)
}
# A Role, or a built-in role's key ("owner", "pilot").
def role=(value)
super(value.is_a?(Role) || value.nil? ? value : Role.for_key(value))
end
def owner? = role&.owner?
end
-5
View File
@@ -36,11 +36,6 @@ class FlightLog < ApplicationRecord
aircraft.flight_logs.maximum(:id) == id && (tach_in.nil? || tach_in == aircraft.tach_time)
end
# Owners can correct any flight; a pilot, the flights they logged.
def editable_by?(user, role:)
role.in?(%w[admin owner]) || (user_id.present? && user_id == user.id)
end
private
# Reject files the engine data parser can't read, before they're stored.
+34
View File
@@ -0,0 +1,34 @@
# What a role on an aircraft can do (Role#permissions). Grouped the way the
# app is laid out; labels and descriptions are in config/locales
# (permissions.<key>.label / .description). Seeing an aircraft's records
# needs no permission: every role can view everything on its aircraft.
module Permission
GROUPS = {
flying: %w[log_flights update_hours import_flights edit_own_flights edit_any_flight delete_flights],
squawks_and_notes: %w[report_squawks defer_squawks manage_squawks write_notes manage_notes record_consumables manage_consumables],
maintenance: %w[write_logbook sign_logbook manage_components manage_inspections manage_ads manage_major_records
manage_weight_balance manage_documents record_oil_analyses manage_oil_analyses],
data: %w[import_records export_data restore_history],
aircraft: %w[edit_aircraft delete_aircraft manage_people manage_sharing],
notifications: %w[receive_reminders]
}.freeze
ALL = GROUPS.values.flatten.freeze
# The built-in roles' permissions when first created (admins can change all
# but Owner's, which always has every permission). Pilot is what pilots
# could do before roles were configurable.
DEFAULTS = {
"pilot" => %w[log_flights update_hours edit_own_flights report_squawks defer_squawks write_notes record_consumables
record_oil_analyses sign_logbook],
"mechanic" => %w[update_hours report_squawks defer_squawks manage_squawks write_notes manage_notes record_consumables
manage_consumables write_logbook sign_logbook manage_components manage_inspections manage_ads
manage_major_records manage_weight_balance manage_documents record_oil_analyses manage_oil_analyses
receive_reminders],
"viewer" => []
}.freeze
def self.label(key) = I18n.t("permissions.#{key}.label")
def self.description(key) = I18n.t("permissions.#{key}.description")
def self.group_label(group) = I18n.t("permissions.groups.#{group}")
end
+40
View File
@@ -0,0 +1,40 @@
# A role someone can have on an aircraft: a name and a set of permissions
# (Permission). Installation-wide; administrators manage them (Admin → Roles).
# Four are built in (key set): Owner, which always has every permission so an
# aircraft can always be managed, and Mechanic, Pilot and Viewer, whose
# permissions can be changed. Administrators can add their own.
class Role < ApplicationRecord
BUILT_IN = %w[owner mechanic pilot viewer].freeze
has_many :aircraft_roles, dependent: :restrict_with_error
normalizes :name, with: ->(name) { name.squish }
validates :name, presence: true, uniqueness: { case_sensitive: false }, length: { maximum: 40 }
validates :description, length: { maximum: 200 }
validates :key, inclusion: { in: BUILT_IN }, uniqueness: true, allow_nil: true
before_validation { self.permissions = Array(permissions).map(&:to_s) & Permission::ALL }
before_destroy { throw :abort if built_in? }
scope :ordered, -> { order(Arel.sql("CASE WHEN key IS NULL THEN 1 ELSE 0 END"), :position, :name) }
# The built-in roles, created when first needed (a new installation, tests).
def self.ensure_built_in!
BUILT_IN.each_with_index do |key, i|
find_or_create_by!(key: key) do |role|
role.name = I18n.t("roles.#{key}.name")
role.description = I18n.t("roles.#{key}.description")
role.permissions = Permission::DEFAULTS.fetch(key, [])
role.position = i
end
end
end
def self.for_key(key) = find_by(key: key.to_s) || (ensure_built_in! && find_by!(key: key.to_s))
def self.owner = for_key("owner")
def built_in? = key.present?
def owner? = key == "owner"
def permissions = owner? ? Permission::ALL : super
def can?(permission) = permissions.include?(permission.to_s)
end
+7 -3
View File
@@ -114,10 +114,14 @@ class User < ApplicationRecord
admin? ? Aircraft.all : aircraft
end
# 'admin' | 'owner' | 'pilot' | nil
# Their Role on the aircraft (nil for none; administrators may have none).
def role_for(aircraft)
return "admin" if admin?
aircraft_roles.find_by(aircraft: aircraft)&.role
aircraft_roles.includes(:role).find_by(aircraft: aircraft)&.role
end
# Administrators can do everything on every aircraft.
def can?(permission, aircraft)
admin? || role_for(aircraft)&.can?(permission) || false
end
def display_name