recourse 5.1.0 → 5.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc89ed83bcbaae940eaed20f48be082dc774898d05f74482b356b4eaf6ccdaa2
-  data.tar.gz: 6d12db3c10f106031e448badb96ae965e8ec4135d7f6bd85b78dd151ac039743
+  metadata.gz: 70333646b284ff615c653da393325f5ea94bb7bd04f73f46b9bff27e5d693a1c
+  data.tar.gz: 1b386bf8262585fa5d3d5493e4297ea3521bac6105f8f9fffba64ecbdc7bd12d
 SHA512:
-  metadata.gz: c7ef41021c4e0abd0211de0b2cceb10fd731ef1193b52f816417243263b51865c46135a6104a0daa7d17f6e57e57dfdeecf64b457f0229f3f2d66ea07bd90dbc
-  data.tar.gz: 30722d3d332f26c81bfe6327bfe51f5952fd2af2bb5dace8419f3f39daa3a8b72ea9f4f3000e7b0e15b33b79067f591a430a19ed3ef1707d61f64b5ab43f477e
+  metadata.gz: 88b168334941dfe01535414620b28dffea6ceedf1583e023f586b71f33c5f6eda669c900a45bd293b28c0d2b2f262c89bfd276f6bc396f08f05bc1c9a2e062c9
+  data.tar.gz: b890abc1502680ad0fcbf1ba27bfcbca86743bbb051d2e30bc9ea171cc87f495885baa8158c3b672efb7549b64370fc2e9068883a9ecbc2c2f522d8d2ffe6c86

data/CHANGELOG.md

@@ -7,6 +7,23 @@ For more information about changelogs, check [Keep a Changelog](http://keepachan
 
 ## [Unreleased]
 
+## 5.2.0 - 2026-09-14
+
+* [Feature] A table of places can be read as a map
+
+  A model keeping a `google_place_id`, or a `latitude` and a `longitude`, earns a second
+  shape for its index: `/counties.map` draws the page on a Google map, in the frame and
+  over the footer the table has, so the search, the sort and the pages work the same on
+  either. The footer under the table offers `Display as map` and the one under the map
+  `Display as table`, each keeping the page the other was on. A place ID is filled in as
+  an area where the model is a geography Google draws boundaries for — a `State`, a `County`,
+  a `City` or a `ZIP`, by name — and pinned at the place for any other model; a point is
+  pinned as it is. The key and the map style, with those
+  layers turned on, are read from the host's credentials under `google_maps` as `api_key`
+  and `map_id`. `.map` is registered as a name for HTML, and the index renders its HTML
+  templates for it. The design bundle is pinned at v0.5.0, which carries the `map`
+  controller.
+
 ## 5.1.0 - 2026-09-14
 
 * [Feature] The head past the gem's own tags is the host's, through a `recourses/head` partial

data/README.md

@@ -144,6 +144,24 @@ Recourse.bookmarks = -> { Keepsake.where agent: Current.agent }
 
 <img width="3824" height="1220" alt="Image" src="https://github.com/user-attachments/assets/d1db4adb-0b5c-4e41-8bb6-cf72a35288f0" />
 
+A table whose model keeps a `google_place_id`, or a `latitude` and a `longitude`, can be
+read as a Google map of the same page: the footer under it offers `Display as map`, and
+`/counties.map` draws this page's rows in the frame and over the footer the table has, so
+search, sort and pages work the same on either shape. A place ID is filled in as an area
+where the model is a geography Google draws boundaries for — a `State`, a `County`, a `City`
+or a `ZIP`, by name — and pinned at the place for any other model; a point is a pin. The key
+and the map ID are the host's credentials, and the map's style has the matching **Feature
+layers** turned on in the Cloud console — Postal code for ZIPs, Administrative area level 2
+for counties. A host with a Content Security Policy allows `maps.googleapis.com` for scripts
+and connections and Google's tile hosts for images.
+
+```yaml
+# config/credentials.yml.enc
+google_maps:
+  api_key: AIza…
+  map_id: 4f2a…
+```
+
 
 ## Development
 

data/app/controllers/recourse/base_controller.rb

@@ -24,6 +24,8 @@ module Recourse
       search = Search.new recourse_relation, params[:q]
       @q = search.query
       @pagy, @resources = pagy search.scope, limit: recourse_limit
+      # A map is the same page in another shape, so the HTML templates draw it.
+      render :index, formats: :html if request.format.map?
     end
 
     # Builds a blank record under the name Rails would use: @contact for contacts, with

data/app/views/layouts/recourses.html.erb

@@ -25,7 +25,7 @@
         over. -%>
     <link rel='preconnect' href='https://design.houseaccount.com'>
     <link rel='preconnect' href='https://design.houseaccount.com' crossorigin>
-    <link rel='stylesheet' href='https://design.houseaccount.com/v0.3.1/css/houseaccount.css'>
+    <link rel='stylesheet' href='https://design.houseaccount.com/v0.5.0/css/houseaccount.css'>
     <%# The one thing these screens set that the house's stylesheet does not: system faces
         at a compact size, for pages dense with figures. 14px as rem, so a browser's own
         text-size setting still scales it. After the stylesheet, since both are `:root`. -%>
@@ -49,7 +49,7 @@
     <%# Turbo, Bootstrap and a Stimulus application with every controller this markup
         names, started once under `window.Stimulus`. In the head, so a controller exists
         before the body's first `data-controller`. -%>
-    <script type='module' src='https://design.houseaccount.com/v0.3.1/js/houseaccount.js'></script>
+    <script type='module' src='https://design.houseaccount.com/v0.5.0/js/houseaccount.js'></script>
   </head>
 
   <%# The reader's zone is told to the server here rather than from a page of its

data/app/views/recourses/_footer.html.erb

@@ -18,6 +18,12 @@
       <% else %>
         <%= t 'recourse.displaying', count: pagy.count %>
       <% end %>
+      <%# And the other shape the same rows can take, where the model keeps a place or
+          a point: a table becomes a map of this page's rows, and a map a table again. -%>
+      <% if (other = view_link) %>
+        <span class='fg-2'>&middot;</span>
+        <%= other %>
+      <% end %>
     </div>
     <%# Centered on the row of their own a phone gives them, and at the end of the shared row from `sm` up. -%>
     <div class='px-2 mt-2 sm:mt-0 d-flex justify-content-center sm:justify-content-end'><%== pagy.series_nav(:bootstrap, classes: 'pagination mb-0') if pagy.last > 1 %></div>

data/app/views/recourses/_map.html.erb

@@ -0,0 +1,13 @@
+<%# locals: (recourses:, pagy:) %>
+<%# This page of the rows on a Google map, each place's area filled in or pinned, in the
+    frame and over the footer the table has — so the search, the sort and the pages all
+    work the same on either shape. Never cached: the map is drawn by the browser. In a
+    card, which gives it the border and the corners the page's other card has —
+    `overflow` since the map is a canvas that would otherwise square the corners off —
+    and under it the margin a table keeps, so the footer stands as far from the map as
+    it does from the rows. -%>
+<div class='card overflow-hidden mb-3'>
+  <div class='recourse-map' <%= tag.attributes data: map_data(recourses) %>></div>
+</div>
+
+<%= render 'footer', pagy: pagy %>

data/app/views/recourses/_results.html.erb

@@ -5,6 +5,6 @@
   <% if resources.blank? %>
     <%= render 'none' %>
   <% else %>
-    <%= render 'table', recourses: resources, pagy: pagy %>
+    <%= render map_view? ? 'map' : 'table', recourses: resources, pagy: pagy %>
   <% end %>
 </turbo-frame>

data/config/locales/recourse.en.yml

@@ -11,6 +11,8 @@ en:
     ago: "%{distance} ago"
     all: All %{models}
     all_values: All
+    as_map: Display as map
+    as_table: Display as table
     blank: "—"
     bookmark: Bookmark
     bookmark_added: Bookmark added

data/lib/recourse/engine.rb

@@ -14,5 +14,11 @@ module Recourse
     initializer 'recourse.routes' do
       ActionDispatch::Routing::Mapper.include Scopes, Routes
     end
+
+    # `/counties.map` is the same page in another shape, so the format is a name for
+    # HTML: without it Rails has no type for the extension and answers 406.
+    initializer 'recourse.formats' do
+      Mime::Type.register_alias 'text/html', :map
+    end
   end
 end

data/lib/recourse/helpers/maps.rb

@@ -0,0 +1,52 @@
+module Recourse
+  module Helpers
+    # The map a table of places is read as, and the link under either that leads to
+    # the other.
+    module Maps
+    private
+
+      # Whether this page is the map rather than the table.
+      def map_view? = request.format.map?
+
+      # The link under the rows to the other shape of the page, or nothing where the
+      # model keeps neither a place nor a point to draw one by. The query goes with it —
+      # the search, the sort and the page — so the map shows the rows the table did.
+      def view_link
+        return unless Recourse.mappable? resource_model
+
+        params = request.query_parameters
+        return link_to t('recourse.as_table'), url_for(params.merge(format: nil)) if map_view?
+
+        link_to t('recourse.as_map'), url_for(params.merge(format: :map))
+      end
+
+      # What the map controller needs: the key and the map from the host's credentials,
+      # and this page's rows as the places or the points they keep.
+      def map_data(recourses)
+        keys = Recourse.google_maps
+
+        { controller: 'map', map_key_value: keys[:api_key], map_id_value: keys[:map_id] }
+          .merge map_rows(recourses)
+      end
+
+      # The places, with the layer they are areas on — pins where the model is no geography
+      # — or the points, where a model keeps no place.
+      def map_rows(recourses)
+        return { map_points_value: map_points(recourses) } unless Recourse.placed? resource_model
+
+        {
+          map_boundary_value: Recourse.boundary(resource_model)&.to_s&.upcase,
+          map_places_value: recourses.filter_map { |one| one.attributes[Recourse::PLACE_COLUMN] },
+        }
+      end
+
+      # Only a row with both halves is a point; one with either missing is nowhere.
+      def map_points(recourses)
+        recourses.filter_map do |one|
+          point = one.attributes.values_at(*Recourse::POINT_COLUMNS)
+          point.map(&:to_f) if point.all?
+        end
+      end
+    end
+  end
+end

data/lib/recourse/helpers.rb

@@ -19,6 +19,7 @@ require_relative 'helpers/formats'
 require_relative 'helpers/inputs'
 require_relative 'helpers/kinds'
 require_relative 'helpers/limits'
+require_relative 'helpers/maps'
 require_relative 'helpers/names'
 require_relative 'helpers/navigation'
 require_relative 'helpers/parents'
@@ -44,7 +45,7 @@ module Recourse
     include Actions, Bookmarks, Buttons, Cards,
             Cells, Choices, Colors, Comboboxes, Constraints, Counters, Deletions, Densities,
             Details,
-            Examples, Fields, Filters, Flashes, Formats, Inputs, Kinds, Limits,
+            Examples, Fields, Filters, Flashes, Formats, Inputs, Kinds, Limits, Maps,
             Names, Navigation, Parents, Pictures, References, Refreshes,
             Routing,
             Resources, Rows, Searches, Shortcuts, Sidebars, Sorts, Tabs, Themes,

data/lib/recourse/maps.rb

@@ -0,0 +1,31 @@
+# Reopened for the map a table of places can be read as.
+module Recourse
+  # The column a row is drawn on a Google map by: the ID Google gives a place.
+  PLACE_COLUMN = 'google_place_id'
+
+  # The two a row is pinned by where it keeps no place: a point needs no lookup.
+  POINT_COLUMNS = %w[latitude longitude].freeze
+
+  # The boundary layer a model's places are areas on, by the name the model goes by —
+  # the four geographies a host is likely to keep, in Google's words for each. A model
+  # named otherwise has its places pinned.
+  BOUNDARIES = {
+    state: :administrative_area_level_1, county: :administrative_area_level_2,
+    city: :locality, zip: :postal_code,
+  }.freeze
+
+  # Whether a model's rows can be drawn on a map: by the place each keeps, or its point.
+  def self.mappable?(model) = placed?(model) || (POINT_COLUMNS - model.column_names).empty?
+
+  # The layer a model's places are drawn on, or nil for a model that is no geography.
+  def self.boundary(model) = BOUNDARIES[model.model_name.singular.to_sym]
+
+  # Whether a model's rows keep a place ID, which an area or a pin at a place is drawn from.
+  def self.placed?(model) = model.column_names.include? PLACE_COLUMN
+
+  # The key the Maps API is called with and the map the rows are drawn on, read from the
+  # host's own credentials under `google_maps` as `api_key` and `map_id`.
+  def self.google_maps
+    Rails.application.credentials[:google_maps] || {}
+  end
+end

data/lib/recourse/themes.rb

@@ -25,7 +25,7 @@ module Recourse
   # Where the palettes are served from, named once: the layout links one, the layout's
   # own script puts back the one a reader chose, and the sidebar's controller swaps it.
   # The version is the one the layout links its stylesheet and script at.
-  THEMES_PATH = 'https://design.houseaccount.com/v0.3.1/theme'
+  THEMES_PATH = 'https://design.houseaccount.com/v0.5.0/theme'
 
   # Where a reader's chosen palette and mode are kept in their browser. Named once for
   # the same reason: the sidebar's controller writes it and the layout reads it back.

data/lib/recourse/version.rb

@@ -1,4 +1,4 @@
 module Recourse
   # Version of the gem, read by the gemspec and by hosts checking compatibility.
-  VERSION = '5.1.0'
+  VERSION = '5.2.0'
 end

data/lib/recourse.rb

@@ -13,6 +13,7 @@ require_relative 'recourse/controllers'
 require_relative 'recourse/densities'
 require_relative 'recourse/helpers'
 require_relative 'recourse/limits'
+require_relative 'recourse/maps'
 require_relative 'recourse/orders'
 require_relative 'recourse/writes'
 require_relative 'recourse/zones'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: recourse
 version: !ruby/object:Gem::Version
-  version: 5.1.0
+  version: 5.2.0
 platform: ruby
 authors:
 - claudiob
@@ -141,6 +141,7 @@ files:
 - app/views/recourses/_flash.html.erb
 - app/views/recourses/_footer.html.erb
 - app/views/recourses/_form.html.erb
+- app/views/recourses/_map.html.erb
 - app/views/recourses/_none.html.erb
 - app/views/recourses/_results.html.erb
 - app/views/recourses/_row.html.erb
@@ -184,6 +185,7 @@ files:
 - lib/recourse/helpers/inputs.rb
 - lib/recourse/helpers/kinds.rb
 - lib/recourse/helpers/limits.rb
+- lib/recourse/helpers/maps.rb
 - lib/recourse/helpers/names.rb
 - lib/recourse/helpers/navigation.rb
 - lib/recourse/helpers/parents.rb
@@ -204,6 +206,7 @@ files:
 - lib/recourse/helpers/zones.rb
 - lib/recourse/icons.rb
 - lib/recourse/limits.rb
+- lib/recourse/maps.rb
 - lib/recourse/orders.rb
 - lib/recourse/recoursive.rb
 - lib/recourse/registry.rb