[V2] Add normalised location to Company resource

app/controllers/companies_controller.rb

@@ -4,14 +4,20 @@ class CompaniesController < InertiaController
   include Pagy::Backend
 
   def index
-    pagy, companies = pagy(Company.includes(:technologies).all)
+    pagy, companies = pagy(company_scope.all)
     @companies = CompanySerializer.many(companies)
 
     paginate(pagy)
   end
 
   def show
-    company = Company.includes(:technologies).find(params[:id])
+    company = company_scope.find(params[:id])
     @company = CompanySerializer.one(company)
   end
+
+  private
+
+  def company_scope
+    Company.includes(:technologies, :continent, :country, :region, :city)
+  end
 end

app/frontend/pages/companies/index.tsx

@@ -25,6 +25,10 @@ function Index({ companies, pagination }: Props) {
           </Link>
         ),
       },
+      {
+        accessorKey: "address.short",
+        header: "Location",
+      },
       {
         accessorKey: "website",
         header: "Website",

app/frontend/pages/companies/show.tsx

@@ -11,10 +11,22 @@ interface Props {
 }
 
 function Show({ company }: Props) {
+  const technologies = company.technologies.map((technology) => (
+    <Badge
+      key={technology.id}
+      style={{
+        backgroundColor: technology.backgroundColor,
+        color: technology.textColor,
+      }}
+    >
+      {technology.name}
+    </Badge>
+  ));
+
   return (
     <div className="container mx-auto py-10">
       <h1 className="my-4 text-xl font-bold">{company.name}</h1>
-      <div className="flex space-x-4">
+      <div className="flex space-x-4 my-8">
         {company.website && (
           <ExternalLink href={company.website}>Website</ExternalLink>
         )}
@@ -24,19 +36,22 @@ function Show({ company }: Props) {
           </ExternalLink>
         )}
       </div>
-      <div className="flex space-x-2">
-        {company.technologies.map((technology) => (
-          <Badge
-            key={technology.id}
-            style={{
-              backgroundColor: technology.backgroundColor,
-              color: technology.textColor,
-            }}
-          >
-            {technology.name}
-          </Badge>
-        ))}
-      </div>
+      <dl className="grid grid-cols-1 gap-x-4 gap-y-8 sm:grid-cols-2">
+        <div className="sm:col-span-1">
+          <dt className="font-bold">Location</dt>
+          <dd className="mt-1">{company.address.medium}</dd>
+        </div>
+        <div className="sm:col-span-1">
+          <dt className="font-bold">Work Arrangements</dt>
+          <dd className="mt-1">
+            <span>Not specified</span>
+          </dd>
+        </div>
+        <div className="sm:col-span-2">
+          <dt className="font-bold">Stack</dt>
+          <dd className="mt-1 flex space-x-2">{technologies}</dd>
+        </div>
+      </dl>
       <Separator className="my-4" />
       <p>{company.description}</p>
     </div>

app/frontend/types/company.ts

@@ -1,3 +1,4 @@
+import { GeoFragment } from "./geo_fragment";
 import { Technology } from "./technology";
 
 export interface Company {
@@ -7,4 +8,13 @@ export interface Company {
   careersPage?: string;
   description?: string;
   technologies: Technology[];
+  address: {
+    short: string;
+    medium: string;
+    full: string;
+  };
+  continent: GeoFragment;
+  country: GeoFragment;
+  region: GeoFragment;
+  city: GeoFragment;
 }

app/frontend/types/geo_fragment.ts

@@ -0,0 +1,4 @@
+export interface GeoFragment {
+  id: number;
+  name: string;
+}

app/models/city.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+class City < ApplicationRecord
+  belongs_to :region
+  has_one :country, through: :region
+  has_one :continent, through: :country
+  has_many :companies
+
+  validates :name, presence: true
+end

app/models/company.rb

@@ -5,6 +5,11 @@ class Company < ApplicationRecord
   has_many :company_technologies, dependent: :destroy
   has_many :technologies, through: :company_technologies
 
+  belongs_to :city
+  has_one :region, through: :city
+  has_one :country, through: :region
+  has_one :continent, through: :country
+
   validates :name, presence: true
   validates :website, url: { no_local: true, public_suffix: true }
   validates :careers_page, url: { no_local: true, public_suffix: true }, allow_blank: true

app/models/continent.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+class Continent < ApplicationRecord
+  has_many :cities, through: :regions
+  has_many :regions, through: :countries
+  has_many :countries
+  has_many :companies, through: :cities
+
+  validates :name, presence: true
+end

app/models/country.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+class Country < ApplicationRecord
+  belongs_to :continent
+  has_many :regions
+  has_many :cities, through: :regions
+  has_many :companies, through: :cities
+
+  validates :name, presence: true
+end

app/models/region.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+class Region < ApplicationRecord
+  has_many :cities
+  belongs_to :country
+  has_one :continent, through: :country
+  has_many :companies, through: :cities
+
+  validates :name, presence: true
+end

app/serializers/company_serializer.rb

@@ -1,11 +1,39 @@
 # frozen_string_literal: true
 
 class CompanySerializer < ApplicationSerializer
-  attributes :id,
+  attributes(
+    :id,
     :name,
     :website,
     :careers_page,
-    :description
+    :description,
+  )
+
+  attribute :address do
+    {
+      short: short_address,
+      medium: medium_address,
+      full: full_address,
+    }
+  end
 
   has_many :technologies, serializer: TechnologySerializer
+  has_one :continent, serializer: GeoFragmentSerializer
+  has_one :country, serializer: GeoFragmentSerializer
+  has_one :region, serializer: GeoFragmentSerializer
+  has_one :city, serializer: GeoFragmentSerializer
+
+  private
+
+  def short_address
+    [company.city&.name, company.country&.name].compact.join(", ")
+  end
+
+  def medium_address
+    [company.city&.name, company.region&.name, company.country&.name].compact.join(", ")
+  end
+
+  def full_address
+    [company.city&.name, company.region&.name, company.country&.name, company.continent&.name].compact.join(", ")
+  end
 end

app/serializers/geo_fragment_serializer.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+class GeoFragmentSerializer < ApplicationSerializer
+  attributes(
+    :id,
+    :name,
+  )
+end

app/serializers/pagination_serializer.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
 
 class PaginationSerializer < ApplicationSerializer
-  hash_attributes :scaffold_url,
+  hash_attributes(
+    :scaffold_url,
     :page,
     :pages,
     :prev,
-    :next
+    :next,
+  )
 end

app/serializers/technology_serializer.rb

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
 class TechnologySerializer < ApplicationSerializer
-  attributes :id,
+  attributes(
+    :id,
     :name,
     :background_color,
-    :text_color
+    :text_color,
+  )
 end

db/migrate/20240823144658_create_continents.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class CreateContinents < ActiveRecord::Migration[7.2]
+  def change
+    create_table(:continents) do |t|
+      t.string(:name, null: false)
+
+      t.timestamps
+    end
+  end
+end

db/migrate/20240823144705_create_countries.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+class CreateCountries < ActiveRecord::Migration[7.2]
+  def change
+    create_table(:countries) do |t|
+      t.string(:name, null: false)
+      t.references(:continent, null: false, foreign_key: true)
+
+      t.timestamps
+    end
+  end
+end

db/migrate/20240823144711_create_regions.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+class CreateRegions < ActiveRecord::Migration[7.2]
+  def change
+    create_table(:regions) do |t|
+      t.string(:name, null: false)
+      t.references(:country, null: false, foreign_key: true)
+
+      t.timestamps
+    end
+  end
+end

db/migrate/20240823144715_create_cities.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+class CreateCities < ActiveRecord::Migration[7.2]
+  def change
+    create_table(:cities) do |t|
+      t.string(:name, null: false)
+      t.references(:region, null: false, foreign_key: true)
+
+      t.timestamps
+    end
+  end
+end

db/migrate/20240823144728_add_city_to_companies.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class AddCityToCompanies < ActiveRecord::Migration[7.2]
+  def change
+    add_reference(:companies, :city, null: false, foreign_key: true)
+  end
+end