geopolitical 2.0.0 → 3.2.0

data/app/models/region.rb

@@ -1,32 +1,60 @@
+# frozen_string_literal: true
+
+# Represents a region, province, or state within a nation.
 #
-# Region/Province/Estado
-#
+# Regions belong to a nation and can have multiple cities. They can also have
+# a designated capital city. Regions inherit common geopolitical attributes
+# from the `Geopolitocracy` concern (like `name`, `abbr`, `slug`, `pop`, `phone`, `postal`).
 class Region
   include Mongoid::Document
-  include Geopolitocracy
+  include Geopolitocracy # Provides common geopolitical fields like name, abbr, slug, etc.
 
+  # @!attribute [rw] timezone
+  #   @return [String, nil] The primary IANA timezone identifier for the region (e.g., "America/New_York").
   field :timezone, type: String
 
+  # @!attribute [rw] nation
+  #   @return [Nation] The nation this region belongs to. Required.
   belongs_to :nation
 
+  # @!attribute [rw] cities
+  #   @return [Mongoid::Relations::Targets::Enumerable<City>] The cities within this region.
+  #   Cities are destroyed if the region is destroyed.
   has_many :cities, dependent: :destroy
 
-  belongs_to :capital, inverse_of: :region_capital, class_name: 'City',
-                       optional: true
+  # @!attribute [rw] capital
+  #   @return [City, nil] The capital city of this region. Optional.
+  belongs_to :capital, inverse_of: :region_governancy, class_name: 'City', optional: true
 
   validates :nation, presence: true
-  validates :name,   uniqueness: { scope: :nation_id }
-  validates :abbr,   uniqueness: { scope: :nation_id, allow_nil: true }
-
-  index abbr: 1
-  index nation_id: 1, name: 1
-
-  # National dialing code / or International
+  validates :name, uniqueness: { scope: :nation_id, message: 'must be unique within its nation' }
+  # `abbr` (from Geopolitocracy) should also be unique within its nation if present.
+  validates :abbr,
+            uniqueness: { scope: :nation_id, allow_nil: true, message: 'must be unique within its nation if provided' }
+  # Slug (from Geopolitocracy) should be unique within its nation. Presence is already validated by Geopolitocracy.
+  validates :slug, uniqueness: { scope: :nation_id, message: 'must be unique within its nation' }
+
+  index({ slug: 1 }) # For .search; global uniqueness is not required, see the compound index below
+  index({ abbr: 1 }, { sparse: true }) # Sparse index as abbr can be nil
+  index({ nation_id: 1, name: 1 }, { unique: true }) # Enforce uniqueness of name within nation
+  index({ nation_id: 1, abbr: 1 }, { unique: true, sparse: true }) # Enforce uniqueness of abbr within nation
+  index({ nation_id: 1, slug: 1 }, { unique: true }) # Enforce uniqueness of slug within nation
+
+  # Retrieves the phone dialing code for the region.
+  # Falls back to the nation's phone code if the region's is not set.
+  # Assumes `phone` field is provided by `Geopolitocracy`.
+  #
+  # @return [String, nil] The phone dialing code.
   def phone
-    self[:phone] || nation.phone
+    self[:phone] || nation&.phone
   end
 
+  # Retrieves the primary postal code scheme or prefix for the region.
+  # Falls back to the nation's postal code scheme if the region's is not set.
+  # Assumes `postal` field is provided by `Geopolitocracy`.
+  #
+  # @return [String, nil] The postal code scheme or prefix.
   def postal
-    self[:postal] || nation.postal
+    self[:postal] || nation&.postal
   end
 end

data/app/views/geopolitical/cities/_city.html.haml

@@ -1,7 +1,4 @@
 .city
-  %h4= link_to city.name, city
-  %span.gray
+  %h4= link_to city.name, city_path(city)
   .right
-    = link_to "Editar", edit_city_path(city) if admin?
-  .right
-    .gray= time_ago_in_words city.created_at
+    = link_to t('geopolitical.actions.edit'), edit_city_path(city)

data/app/views/geopolitical/cities/_form.html.haml

@@ -1,31 +1,28 @@
 .container
   .row
     .page-header
-      %h1= @city.new_record? ? "Nova Cidade" : "Editando Cidade"
-  .container_16
-    .box.secondary.shadow
-      = form_for(@city, :html => {:class => "form"}) do |f|
-        - f.object.errors.each do |err|
-          = err
-        .grid_3
-          =# hidden_field_tag 'city_geom_xy', @city.ll, :name => "city[xy]", :class => "geom_xy"
-          =# hidden_field_tag 'city_geom_y', @city.y, :name => "city[y]", :class => "geom_y"
-          =# hidden_field_tag 'city_geom_z', @city.z, :name => "city[z]", :class => "geom_z"
-
-          .forms_btns
-            .citydata
-              .field{"data-role" => "fieldcontain"}
-                = f.label :region
-                = f.select :region_id, @regions
-              .group
-                = f.label :name
-                = f.text_field :name, :size => 30
-              .group
-                = f.label :slug
-                = f.text_field :slug, :size => 30
-              .field
-                = f.label :souls
-                = f.text_field :souls, :size => 30
-              = f.submit
-        .grid_8
-          #map=# gmaps(@map, false, false)
+      %h1
+        - key = @city.new_record? ? 'new' : 'edit'
+        = t("geopolitical.forms.#{key}", model: City.model_name.human)
+  .row
+    = form_with model: @city, url: (@city.persisted? ? city_path(@city) : cities_path), html: { class: 'form' } do |f|
+      - if @city.errors.any?
+        %ul
+          - @city.errors.full_messages.each do |message|
+            %li= message
+      .form-group
+        = f.label :nation_id
+        = f.select :nation_id, @nations, include_blank: true
+      .form-group
+        = f.label :region_id
+        = f.select :region_id, @regions, include_blank: true
+      .form-group
+        = f.label :name
+        = f.text_field :name
+      .form-group
+        = f.label :slug
+        = f.text_field :slug
+      .form-group
+        = f.label :souls
+        = f.number_field :souls
+      = f.submit t('geopolitical.actions.save')

data/app/views/geopolitical/cities/edit.html.haml

@@ -0,0 +1 @@
+= render 'form'

data/app/views/geopolitical/cities/index.html.haml

@@ -1,35 +1,32 @@
 .container
   .row
     .page-header
-      %h1.title Cities
-      =# render "shared/filter"
-      = link_to "New City", new_city_path
+      %h1.title= City.model_name.human(count: 2)
+      = link_to t('geopolitical.actions.new', model: City.model_name.human), new_city_path
   .row
     .content
       %table.table
         %thead
           %tr
-            %th Nome
-            %th ZIP
-            %th Region
-            %th Nation
-            %th Population
+            %th= City.human_attribute_name(:name)
+            %th= City.human_attribute_name(:postal)
+            %th= City.human_attribute_name(:region_id)
+            %th= City.human_attribute_name(:nation_id)
+            %th= City.human_attribute_name(:souls)
             %th
         %tbody
-          - for city in @cities
+          - @cities.each do |city|
             %tr
               %td
                 = city.name
-                = link_to city.slug , city
-              %td= city.zip
-              %td= city.region.name if city.region
-              %td= city.nation.name
+                = link_to city.slug, city_path(city)
+              %td= city.postal
+              %td= city.region&.name
+              %td= city.nation&.name
               %td= city.souls
-              %td{:align => 'right'}
-                = link_to 'Edit', edit_city_path(city)
-                = link_to 'Destroy', city, :confirm => 'Destroy city?', :method => :delete
-
+              %td{align: 'right'}
+                = link_to t('geopolitical.actions.edit'), edit_city_path(city)
+                = button_to t('geopolitical.actions.destroy'), city_path(city), method: :delete,
+                  data: { turbo_confirm: t('geopolitical.actions.confirm_destroy', model: City.model_name.human) }
   .row
-    .pagination= paginate @cities
-  .row
-    = link_to 'Back', root_path
+    = link_to t('geopolitical.actions.back'), root_path

data/app/views/geopolitical/cities/new.html.haml

@@ -0,0 +1 @@
+= render 'form'

data/app/views/geopolitical/cities/show.html.haml

@@ -3,15 +3,15 @@
     %h1= @city.name
   .row
     %p
-      %b Slug:
+      %b #{City.human_attribute_name(:slug)}:
       = @city.slug
     %p
-      %b Nation:
-      = link_to @city.nation, @city.nation
+      %b #{City.human_attribute_name(:nation_id)}:
+      = link_to @city.nation, nation_path(@city.nation) if @city.nation
     %p
-      %b Region:
-      = link_to @city.region, @city.region
+      %b #{City.human_attribute_name(:region_id)}:
+      = link_to @city.region, region_path(@city.region) if @city.region
   .row
-    = link_to 'Edit', edit_city_path(@city)
+    = link_to t('geopolitical.actions.edit'), edit_city_path(@city)
     |
-    = link_to 'Back', cities_path
+    = link_to t('geopolitical.actions.back'), cities_path

data/app/views/geopolitical/geopolitical/index.html.haml

@@ -1,21 +1,19 @@
-%h1 Geopolitical
+%h1= t('geopolitical.title')
 %hr
 
 - [Nation, Region, City, Hood].each do |klass|
   .block
     %h3.title
-      = link_to klass.model_name.human.pluralize, send("#{klass.to_s.downcase.pluralize}_path")
+      = link_to klass.model_name.human(count: 2), send("#{klass.to_s.downcase.pluralize}_path")
       %small= klass.count
     .right.links
-      = link_to "+ #{klass.model_name.human}", send("new_#{klass.to_s.downcase}_path"), :class => "small blue nice button radius"
-
+      = link_to t('geopolitical.actions.new', model: klass.model_name.human),
+        send("new_#{klass.to_s.downcase}_path")
 
 %br
 %h4
-  Use Geonames_local to populate data easily!
-  %small= link_to "geonames_local", "http://github.com/nofxx/geonames_local"
+  = t('geopolitical.dashboard.populate')
+  %small= link_to 'geonames_local', 'https://github.com/nofxx/geonames_local'
 
 %hr
-%p Minimalist layout by NoCSS Co.
-%p= link_to "fireho/geopolitical", "http://github.com/fireho/geopolitical"
-%p= link_to "< Back", "/"
+%p= link_to 'fireho/geopolitical', 'https://github.com/fireho/geopolitical'

data/app/views/geopolitical/hoods/_city.html.haml

@@ -1,7 +1,4 @@
 .hood
-  %h4= link_to hood.name, hood
-  %span.gray
+  %h4= link_to hood.name, hood_path(hood)
   .right
-    = link_to "Editar", edit_hood_path(hood) if admin?
-  .right
-    .gray= time_ago_in_words hood.created_at
+    = link_to t('geopolitical.actions.edit'), edit_hood_path(hood)

data/app/views/geopolitical/hoods/_form.html.haml

@@ -1,27 +1,26 @@
 .container
   .row
     .page-header
-      %h1= @hood.new_record? ? "New Hood" : "Editing Hood"
+      %h1
+        - key = @hood.new_record? ? 'new' : 'edit'
+        = t("geopolitical.forms.#{key}", model: Hood.model_name.human)
   .row
     .content
-      = form_for(@hood, :html => {:class => "form"}) do |f|
-        - f.object.errors.each do |err|
-          = err
-        .grid_3
-          .forms_btns
-            .hooddata
-              .field{"data-role" => "fieldcontain"}
-                = f.label :city
-                = f.select :city_id, @cities
-              .group
-                = f.label :name
-                = f.text_field :name, :size => 30
-              .group
-                = f.label :slug
-                = f.text_field :slug, :size => 30
-              .field
-                = f.label :souls
-                = f.text_field :souls, :size => 30
-              = f.submit
-        .grid_8
-          #map=# gmaps(@map, false, false)
+      = form_with model: @hood, url: (@hood.persisted? ? hood_path(@hood) : hoods_path), html: { class: 'form' } do |f|
+        - if @hood.errors.any?
+          %ul
+            - @hood.errors.full_messages.each do |message|
+              %li= message
+        .form-group
+          = f.label :city_id
+          = f.select :city_id, @cities, include_blank: true
+        .form-group
+          = f.label :name
+          = f.text_field :name
+        .form-group
+          = f.label :slug
+          = f.text_field :slug
+        .form-group
+          = f.label :souls
+          = f.number_field :souls
+        = f.submit t('geopolitical.actions.save')

data/app/views/geopolitical/hoods/edit.html.haml

@@ -0,0 +1 @@
+= render 'form'

data/app/views/geopolitical/hoods/index.html.haml

@@ -1,33 +1,28 @@
 .container
   .row
     .page-header
-      %h1.title Hoods
-      =# render "shared/filter"
-      = link_to "New Hood", new_hood_path
+      %h1.title= Hood.model_name.human(count: 2)
+      = link_to t('geopolitical.actions.new', model: Hood.model_name.human), new_hood_path
   .row
     .content
       %table.table
         %thead
           %tr
-            %th Nome
-            %th Region
-            %th Nation
-            %th Population
+            %th= Hood.human_attribute_name(:name)
+            %th= Hood.human_attribute_name(:city_id)
+            %th= Hood.human_attribute_name(:souls)
             %th
         %tbody
-          - for hood in @hoods
+          - @hoods.each do |hood|
             %tr
               %td
                 = hood.name
-                = link_to hood.slug , hood
-              %td= hood.city.name if hood.city
-              %td= hood.city.name
+                = link_to hood.slug, hood_path(hood)
+              %td= hood.city&.name
               %td= hood.souls
-              %td{:align => 'right'}
-                = link_to 'Edit', edit_hood_path(hood)
-                = link_to 'Destroy', hood, :confirm => 'Destroy hood?', :method => :delete
-
+              %td{align: 'right'}
+                = link_to t('geopolitical.actions.edit'), edit_hood_path(hood)
+                = button_to t('geopolitical.actions.destroy'), hood_path(hood), method: :delete,
+                  data: { turbo_confirm: t('geopolitical.actions.confirm_destroy', model: Hood.model_name.human) }
   .row
-    .pagination= paginate @hoods
-  .row
-    = link_to 'Back', root_path
+    = link_to t('geopolitical.actions.back'), root_path

data/app/views/geopolitical/hoods/new.html.haml

@@ -0,0 +1 @@
+= render 'form'

data/app/views/geopolitical/hoods/show.html.haml

@@ -3,12 +3,12 @@
     %h1= @hood.name
   .row
     %p
-      %b Slug:
+      %b #{Hood.human_attribute_name(:slug)}:
       = @hood.slug
     %p
-      %b City:
-      = link_to @hood.city, @hood.city
+      %b #{Hood.human_attribute_name(:city_id)}:
+      = link_to @hood.city, city_path(@hood.city) if @hood.city
   .row
-    = link_to 'Edit', edit_hood_path(@hood)
+    = link_to t('geopolitical.actions.edit'), edit_hood_path(@hood)
     |
-    = link_to 'Back', hood_path
+    = link_to t('geopolitical.actions.back'), hoods_path

data/app/views/geopolitical/nations/_form.html.haml

@@ -1,11 +1,15 @@
 .container
   .row
     .page-header
-      %h1= @nation.new_record? ? "New Nation" : "Editing '#{@nation}'"
+      %h1
+        - key = @nation.new_record? ? 'new' : 'edit'
+        = t("geopolitical.forms.#{key}", model: Nation.model_name.human)
   .row
-
-    = form_for(@nation) do |f|
-      =# f.error_messages
+    = form_with model: @nation, url: (@nation.persisted? ? nation_path(@nation) : nations_path) do |f|
+      - if @nation.errors.any?
+        %ul
+          - @nation.errors.full_messages.each do |message|
+            %li= message
       .form-group
         = f.label :name
         = f.text_field :name
@@ -19,8 +23,7 @@
         = f.label :lang
         = f.text_field :lang
       .form-group
-        = f.label :abbr
-        = f.text_field :abbr
-
+        = f.label :cash
+        = f.text_field :cash
       .forms-buttons
-        = f.submit
+        = f.submit t('geopolitical.actions.save')

data/app/views/geopolitical/nations/_nation.html.haml

@@ -0,0 +1,5 @@
+.nation
+  %h4= link_to nation.name, nation_path(nation)
+  %span.gray= nation.abbr
+  .right
+    = link_to t('geopolitical.actions.edit'), edit_nation_path(nation)

data/app/views/geopolitical/nations/edit.html.haml

@@ -0,0 +1 @@
+= render 'form'

data/app/views/geopolitical/nations/index.html.haml

@@ -1,36 +1,32 @@
 .container
   .row
     .page-header
-      %h1.title Nations
-      =# render "shared/filter"
-      = link_to "New Nation", new_nation_path
+      %h1.title= Nation.model_name.human(count: 2)
+      = link_to t('geopolitical.actions.new', model: Nation.model_name.human), new_nation_path
   .row
     .content
       %table.table
         %thead
           %tr
-            %th Abbr
-            %th ISO
-            %th Name
-            %th Postal
-            %th Lang
-            %th Cash
+            %th= Nation.human_attribute_name(:abbr)
+            %th= Nation.human_attribute_name(:code3)
+            %th= Nation.human_attribute_name(:name)
+            %th= Nation.human_attribute_name(:postal)
+            %th= Nation.human_attribute_name(:lang)
+            %th= Nation.human_attribute_name(:cash)
             %th
         %tbody
-          - for nation in @nations
+          - @nations.each do |nation|
             %tr
-              %td
-                =# image_tag nation.flag.nano if nation.flag?
-                = nation.abbr
-              %td= nation.code
+              %td= nation.abbr
+              %td= nation.code3.presence || nation.code
               %td
                 = nation.name
-                = link_to nation.slug, nation
-              %td= nation.zip
-              %td= truncate(nation.lang)
+                = link_to nation.slug, nation_path(nation)
+              %td= nation.postal
+              %td= truncate(nation.lang.to_s)
               %td= nation.cash
               %td.last
-                =# link_to "Destroy!", nation_path(nation), :method => :delete
-                = link_to "Edit", edit_nation_path(nation)
+                = link_to t('geopolitical.actions.edit'), edit_nation_path(nation)
   .row
-    = link_to 'Voltar', root_path
+    = link_to t('geopolitical.actions.back'), root_path

data/app/views/geopolitical/nations/new.html.haml

@@ -0,0 +1 @@
+= render 'form'

data/app/views/geopolitical/nations/show.html.haml

@@ -3,18 +3,18 @@
     %h1= @nation.name
   .row
     %p
-      %b Abbr:
-      #{@nation.abbr} #{@nation.code}
+      %b #{Nation.human_attribute_name(:abbr)}:
+      #{@nation.abbr} #{@nation.code3}
     %p
-      %b Slug:
+      %b #{Nation.human_attribute_name(:slug)}:
       = @nation.slug
     %p
-      %b Lang:
+      %b #{Nation.human_attribute_name(:lang)}:
       = @nation.lang
     %p
-      %b Cash:
+      %b #{Nation.human_attribute_name(:cash)}:
       = @nation.cash
   .row
-    = link_to 'Edit', edit_nation_path(@nation)
+    = link_to t('geopolitical.actions.edit'), edit_nation_path(@nation)
     |
-    = link_to 'Back', nations_path
+    = link_to t('geopolitical.actions.back'), nations_path

data/app/views/geopolitical/regions/_form.html.haml

@@ -1,12 +1,15 @@
 .container
   .row
     .page-header
-      %h1= @region.new_record? ? "New Region" : "Editing '#{@region}'"
+      %h1
+        - key = @region.new_record? ? 'new' : 'edit'
+        = t("geopolitical.forms.#{key}", model: Region.model_name.human)
   .row
-
-    = form_for(@region) do |f|
-      - f.object.errors.each do |err|
-        = err
+    = form_with model: @region, url: (@region.persisted? ? region_path(@region) : regions_path) do |f|
+      - if @region.errors.any?
+        %ul
+          - @region.errors.full_messages.each do |message|
+            %li= message
       .form-group
         = f.label :name
         = f.text_field :name
@@ -18,7 +21,6 @@
         = f.text_field :slug
       .form-group
         = f.label :nation_id
-        = f.select :nation_id, @nations
-
+        = f.select :nation_id, @nations, include_blank: true
       .forms-buttons
-        = f.submit
+        = f.submit t('geopolitical.actions.save')

data/app/views/geopolitical/regions/_region.html.haml

@@ -1,7 +1,4 @@
 .region
-  %h4= link_to region.name, region
-  %span.gray
+  %h4= link_to region.name, region_path(region)
   .right
-    .gray= time_ago_in_words region.created_at
-  .right
-    = link_to "Editar", edit_region_path(region) if admin?
+    = link_to t('geopolitical.actions.edit'), edit_region_path(region)

data/app/views/geopolitical/regions/edit.html.haml

@@ -0,0 +1 @@
+= render 'form'

data/app/views/geopolitical/regions/index.html.haml

@@ -1,31 +1,28 @@
 .container
   .row
     .page-header
-      %h1.title Regions
-      =# render "shared/filter"
-      = link_to "New Regions", new_region_path
+      %h1.title= Region.model_name.human(count: 2)
+      = link_to t('geopolitical.actions.new', model: Region.model_name.human), new_region_path
   .row
     .content
       %table.table
         %thead
           %tr
-            %th Abbr
-            %th Name
-            %th Country
-            %th Cities
+            %th= Region.human_attribute_name(:abbr)
+            %th= Region.human_attribute_name(:name)
+            %th= Region.human_attribute_name(:nation_id)
+            %th= Region.human_attribute_name(:cities)
             %th
         %tbody
-          - for region in @regions
+          - @regions.each do |region|
             %tr
-              %td
-                = region.abbr
+              %td= region.abbr
               %td
                 = region.name
-                = link_to region.slug, region
-              %td= region.nation.try(:name)
+                = link_to region.slug, region_path(region)
+              %td= region.nation&.name
               %td= region.cities.count
               %td.last
-                =# link_to "Destroy!", nation_path(nation), :method => :delete
-                = link_to  'Edit', edit_region_path(region)
+                = link_to t('geopolitical.actions.edit'), edit_region_path(region)
   .row
-    = link_to 'Back', root_path
+    = link_to t('geopolitical.actions.back'), root_path

data/app/views/geopolitical/regions/new.html.haml

@@ -0,0 +1 @@
+= render 'form'

data/app/views/geopolitical/regions/show.html.haml

@@ -3,15 +3,15 @@
     %h1= @region.name
   .row
     %p
-      %b Slug:
+      %b #{Region.human_attribute_name(:slug)}:
       = @region.slug
     %p
-      %b Nation:
+      %b #{Region.human_attribute_name(:nation_id)}:
       = link_to @region.nation, @region.nation
     %p
-      %b Sigla:
+      %b #{Region.human_attribute_name(:abbr)}:
       = @region.abbr
   .row
-    = link_to 'Edit', edit_region_path(@region)
+    = link_to t('geopolitical.actions.edit'), edit_region_path(@region)
     |
-    = link_to 'Back', regions_path
+    = link_to t('geopolitical.actions.back'), regions_path