TWM-524 new sales rep region needed (#1475)

* add new region model to apply to agencies and people

* add new rights_designation value

* update deprecating enums for rails 8 compatibility

* update tests/code for passing

* update migration for text correction

* switch to new region_id rather than name for grouping (belongs to/has many)

* rubocop corrections

Author: cdoyle-temple

app/controllers/admin/regions_controller.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Admin
+  class RegionsController < Admin::ApplicationController
+  end
+end

app/controllers/agencies_controller.rb

@@ -3,10 +3,15 @@
 class AgenciesController < ApplicationController
   def index
     @default_agency = Agency.find_by(region: "All Other Territories")
-    @agencies = Agency.where.not(region: "All Other Territories")
-                      .group_by(&:region)
-                      .sort
-                      .map { |region, agencies| [region, agencies] }
-                      .sort
+    scoped = Agency.where.not(region: "All Other Territories").includes(:region_ref)
+    grouped = scoped.group_by do |agency|
+      record = agency.region_record
+      designation = record&.rights_designation || agency.send(:parsed_rights_designation)
+      name = record&.name || agency.region
+      [name, designation]
+    end
+
+    @agencies = grouped.sort_by { |(name, designation), _| [name.to_s, designation.to_s] }
+                       .map { |(name, _designation), agencies| [name, agencies] }
   end
 end

app/dashboards/agency_dashboard.rb

@@ -19,7 +19,10 @@ class AgencyDashboard < Administrate::BaseDashboard
     fax: Field::String,
     email: Field::String,
     website: Field::String,
-    region: Field::Select.with_options(collection: I18n.t("tupress.admin.collections.agencies.regions")),
+    region_ref: Field::BelongsTo.with_options(
+      class_name: "Region",
+      order: "name ASC"
+    ),
     created_at: Field::DateTime,
     updated_at: Field::DateTime
   }.freeze
@@ -31,7 +34,7 @@ class AgencyDashboard < Administrate::BaseDashboard
   # Feel free to add, remove, or rearrange items.
   COLLECTION_ATTRIBUTES = %i[
     title
-    region
+    region_ref
     contact
   ].freeze
 
@@ -45,7 +48,7 @@ class AgencyDashboard < Administrate::BaseDashboard
     fax
     email
     website
-    region
+    region_ref
   ].freeze
 
   # FORM_ATTRIBUTES
@@ -54,7 +57,7 @@ class AgencyDashboard < Administrate::BaseDashboard
   FORM_ATTRIBUTES = %i[
     title
     slug
-    region
+    region_ref
     contact
     address
     phone

app/dashboards/person_dashboard.rb

@@ -22,7 +22,10 @@ class PersonDashboard < Administrate::BaseDashboard
     coverage: Field::String,
     company: Field::String,
     region: Field::Select.with_options(
-      collection: I18n.t("tupress.admin.people.regions")
+      collection: -> {
+        Region.order(:name, :rights_designation).map { |r| [r.display_name, r.name] }
+      },
+      include_blank: true
     ),
     website: Field::String,
     created_at: Field::DateTime,

app/dashboards/region_dashboard.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require "administrate/base_dashboard"
+
+class RegionDashboard < Administrate::BaseDashboard
+  # ATTRIBUTE_TYPES
+  # a hash that describes the type of each of the model's fields.
+  #
+  # Each different type represents an Administrate::Field object,
+  # which determines how the attribute is displayed
+  # on pages throughout the dashboard.
+  ATTRIBUTE_TYPES = {
+    id: Field::Number,
+    name: Field::String,
+    display_name: Field::String,
+    slug: Field::String,
+    description: Field::Text,
+    rights_designation: Field::Select.with_options(
+      collection: Region.rights_designations.keys.map { |k| [k.titleize, k] }
+    ),
+    agencies: Field::HasMany,
+    people: Field::HasMany,
+    created_at: Field::DateTime,
+    updated_at: Field::DateTime
+  }.freeze
+
+  # COLLECTION_ATTRIBUTES
+  # an array of attributes that will be displayed on the model's index page.
+  #
+  # By default, it's limited to four items to reduce clutter on index pages.
+  # Feel free to add, remove, or rearrange items.
+  COLLECTION_ATTRIBUTES = %i[
+    display_name
+    description
+    agencies
+  ].freeze
+
+  # SHOW_PAGE_ATTRIBUTES
+  # an array of attributes that will be displayed on the model's show page.
+  SHOW_PAGE_ATTRIBUTES = %i[
+    display_name
+    slug
+    description
+    rights_designation
+    agencies
+    people
+    created_at
+    updated_at
+  ].freeze
+
+  # FORM_ATTRIBUTES
+  # an array of attributes that will be displayed
+  # on the model's form (`new` and `edit`) pages.
+  FORM_ATTRIBUTES = %i[
+    name
+    slug
+    description
+    rights_designation
+  ].freeze
+
+  # COLLECTION_FILTERS
+  # a hash that defines filters that can be used while searching via the search
+  # field of the dashboard.
+  #
+  # For example to add an option to search for open resources by typing "open:"
+  # in the search field:
+  #
+  #   COLLECTION_FILTERS = {
+  #     open: ->(resources) { resources.where(open: true) }
+  #   }.freeze
+  COLLECTION_FILTERS = {}.freeze
+
+  # Overwrite this method to customize how regions are displayed
+  # across all pages of the admin dashboard.
+  #
+  def display_resource(region)
+    region.display_name
+  end
+end

app/helpers/agencies_helper.rb

@@ -1,12 +1,13 @@
 # frozen_string_literal: true
 
 module AgenciesHelper
-  def rights_coverage(region)
-    case region
-    when "Turkey", "Spanish & Portuguese languages, World"
-      "Exclusive Rights"
-    else
-      "Non-exclusive Rights"
-    end
+  def rights_coverage(agency)
+    return if agency.blank?
+
+    text = agency.rights_type.to_s
+    return if text.blank?
+
+    clean_text = text.gsub(/\A\((.*)\)\z/, '\1').strip
+    content_tag(:span, content_tag(:em, clean_text), style: "font-size:65%;")
   end
 end

app/models/agency.rb

@@ -3,7 +3,48 @@
 class Agency < ApplicationRecord
   include Friendable
 
+  belongs_to :region_ref, class_name: "Region", foreign_key: :region_id, optional: true, inverse_of: :agencies
+
   validates :title, :region, presence: true
 
   has_rich_text :address
+
+  before_validation :sync_region_from_ref
+
+  scope :by_region, ->(region) { where(region: region) }
+
+  def region_record
+    return region_ref if region_ref.present?
+    return nil if region.blank?
+
+    @region_record ||= begin
+      normalized = region.to_s.sub(/\s*\(.*\)\s*\z/, "").strip
+      base_name = normalized.gsub(/\b(world\s+exclusive|non[-\s]?exclusive|exclusive)\b(\s+rights?)?/i, "").strip
+      scope = Region.where(name: [normalized, base_name].uniq)
+
+      designation = parsed_rights_designation
+      scoped_scope = designation ? scope.where(rights_designation: Region.rights_designations[designation]) : scope
+
+      scoped_scope.first || scope.first
+    end
+  end
+
+  def rights_type
+    region_record&.rights_type
+  end
+
+  private
+
+    def sync_region_from_ref
+      self.region = region_ref.name if region_ref.present?
+    end
+
+    def parsed_rights_designation
+      label = region.to_s.downcase
+      return :world_exclusive if label.include?("world exclusive")
+      return :non_exclusive if label.include?("non-exclusive") || label.include?("non exclusive")
+      return :exclusive if label.include?("exclusive")
+      return :unspecified if label.include?("unspecified")
+      nil
+    end
 end

app/models/concerns/friendable.rb

@@ -8,32 +8,41 @@ module Friendable
   end
 
   def title_and_sequence
-    case self.class
-    when "Review"
-      slug = [cleanup(book.sort_title)]
-    when "Book"
-      slug = [cleanup(sort_title)]
-    else
-      slug = title.parameterize if title.present?
-    end
+    base_slug =
+      case self
+      when Review
+        cleanup(book.sort_title)
+      when Book
+        cleanup(sort_title)
+      else
+        title&.parameterize
+      end
+
+    return if base_slug.blank?
+
     if self.class.count > 1
-      sequence = self.class.where("slug like ?", "%#{slug}%").count
-      "#{slug}--#{sequence}"
+      sequence = self.class.where("slug like ?", "%#{base_slug}%").count
+      "#{base_slug}--#{sequence}"
     end
   end
 
   def slug_candidates
-    case self.class
-    when "Review"
+    case self
+    when Review
       [
         [cleanup(book.sort_title)],
         [:title_and_sequence]
       ]
-    when "Book"
+    when Book
       [
         [cleanup(sort_title)],
         [:title_and_sequence]
       ]
+    when Region
+      [
+        [cleanup(title), rights_check],
+        [:title_and_sequence]
+      ]
     else
       [
         [cleanup(title)],
@@ -45,4 +54,17 @@ def slug_candidates
   def cleanup(html)
     ActionController::Base.helpers.strip_tags(html)
   end
+
+  def rights_check
+    case rights_designation
+    when "exclusive", 2
+      "exclusive-rights"
+    when "non_exclusive", 1
+      "non-exclusive-rights"
+    when "world_exclusive", 3
+      "world-exclusive-rights"
+    else
+      ""
+    end
+  end
 end

app/models/person.rb

@@ -17,6 +17,25 @@ def name
     title
   end
 
+  def region_record
+    return nil if region.blank?
+
+    @region_record ||= begin
+      normalized = region.to_s.sub(/\s*\(.*\)\s*\z/, "").strip
+      base_name = normalized.gsub(/\b(world\s+exclusive|non[-\s]?exclusive|exclusive)\b(\s+rights?)?/i, "").strip
+      scope = Region.where(name: [normalized, base_name].uniq)
+
+      designation = parsed_rights_designation
+      scoped_scope = designation ? scope.where(rights_designation: Region.rights_designations[designation]) : scope
+
+      scoped_scope.first || scope.first
+    end
+  end
+
+  def rights_type
+    region_record&.rights_type
+  end
+
   def self.search(q)
     if q
       q = q.last.present? ? q : q[0...-1]
@@ -25,4 +44,15 @@ def self.search(q)
             .sort
     end
   end
+
+  private
+
+    def parsed_rights_designation
+      label = region.to_s.downcase
+      return :world_exclusive if label.include?("world exclusive")
+      return :non_exclusive if label.include?("non-exclusive") || label.include?("non exclusive")
+      return :exclusive if label.include?("exclusive")
+      return :unspecified if label.include?("unspecified")
+      nil
+    end
 end