janela 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2079a652eafc71edc8c31227d2c09ef8e795a38da68b8ec6c18de89732a54f97
-  data.tar.gz: b024b3337cd75f63619ff8cb844a6887e2b4ecb0bf7cb510ceb2fea789537b03
+  metadata.gz: 2416bb876bf67b3cda96853cc4cee216fd8c153a0ec4930d8243512be5c8c163
+  data.tar.gz: 1b4a35484a9d04d696771376389ab35dc17b76469ce772de54e48ed7017f5cc5
 SHA512:
-  metadata.gz: 949892c698668e8a170d5c2dedadeff080f62aee007cf86a89537c62eb304fd75fa479e4d4eb9635e18619794e3003541d90035711e6aa1304771d4f84a1d954
-  data.tar.gz: e445c3469c68b7f9b5e20d384bbd0589b0ec98f5beeacdbbb48b0f371e0f67771448d42b8240dc859c5fe11e5459d66b57f7652cb2106e56346adb49fd453693
+  metadata.gz: 6f20d48d6dfcb473861d0e20b9116e135498d6879a79f9c5720a184b35a66be4189d7e74bc51431d116f4955c73b458af59ff428062e237ee0a2421564436ad0
+  data.tar.gz: 5b9c28323e356a9c6833ea25d0c0e3ef8c92225848ef7611fb4c3aeafb95bd75e7c0087d9b3957d819c161fedd1bfacd915b3731382ae78cf6874dca94202645

data/CHANGELOG.md

@@ -5,6 +5,28 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.12.0] - 2026-10-01
+
+### Added
+
+- **A table can carry companion columns.** `janela_pane Order, :expedited_rate, by: :customer, companions: [:orders, :region]`, or the same on a stored pane from the pane form, adds up to three columns beside the label, each a measure or a dimension the model declares, under a new header row. A measure companion is its own number, formatted as it declares: a rate can sit beside the count behind it, which answers whether 75% came from four reviews or forty. A dimension companion shows a value only where every row of that label's group shares one and is blank where they differ, because the alternatives were measured and wrong: grouping by it showed a label twice, and picking one showed an arbitrary value as fact. Order, limit, filters and clicking a label stay the primary measure's; only a table draws companions, a stored snapshot shows the base table, and a time pane may carry measures but not dimensions. Each companion is one more query, hence at most three. It travels in the pane URL as `companions[]=`. Stored panes need a migration; see `UPGRADING.md` (ADR 051, #34).
+
+- **A single value can say how prominent it is.** `janela_pane Order, :orders, prominence: 3`, or the same on a stored pane from the pane form, takes one of three steps: 1 is a footnote at `1.25rem`, 2 is what every value already is at `2rem`, and 3 is the hero number at `3.5rem`. The label stays small at every step. Until now every headline number was the same size, so a host that wanted one count larger wrote CSS against `janela-value-number` for each pane, and a stored pane could not say it at all. (The issue also asked for default typography and a hideable label; both had already shipped, with #15 and #26.) With none set nothing changes, and a table, a chart and a ring ignore one. The step travels in the pane URL as `?prominence=`. Stored panes need a migration; see `UPGRADING.md` (ADR 050, #31).
+
+- **A `ratio:` measure, for the share of rows where a boolean column is true.** `measure :expedited_rate, ratio: :expedited` reads as `31.2%` in a table cell, a single value and a chart tooltip, and orders, gap fills, cross-filters and snapshots like any other measure. Averaging a boolean column never worked: ActiveRecord casts the answer back to `true`, and it does so for 0% as well, so no rate could read as anything else. Janela refused that, correctly, and the refusal had nowhere to point; it now names `ratio:`. A row where the column is null is left out of the average, as SQL's `AVG` leaves it, and is not counted as a no. The number stored, ordered and compared is the fraction (`0.3119`); only the text is a percentage, to one decimal place unless you declare `precision:`. A ratio takes no `prefix:` or `suffix:` (it raises, so `31.2%%` cannot happen) and no condition form (ADR 038, #27).
+
+- **A value and (none) can be selected together.** With a chart or table of A, B and (none), Ctrl or Cmd click on (none) beside A now shows the rows that are A or have nothing, where before selecting (none) cleared A. A plain click still replaces the selection, and Ctrl or Cmd click on (none) again takes it out. It is the union of the two in the URL you already have, `q[channel_in][]=web&q[channel_null]=1`, and the same for a `where:` or `default_where` naming both. That pair used to return no rows at all, because Ransack ANDs what it is given, so nothing that worked depended on it. Two exclusions, `not_in` with `not_null`, still mean neither (ADR 049, #69).
+
+- **A chart pane can say how tall it is.** `janela_pane Order, :revenue, by: :placed_on, as: :line, height: 2`, or the same on a stored pane from the pane form, takes one of five steps from about 96px to about 448px, drawn as a box of that height around the chart with the chart filling it. Until now a chart was twice its width up to a cap of 20rem, and a host could lower it from outside but not set it, so a stored frame's only way to a shorter row of charts was to swap them for tables. With no height nothing changes, and a ring, a table or a single value ignores one, so switching a pane's renderer never invalidates it. The step travels in the pane URL as `?height=`. Stored panes need a migration; see `UPGRADING.md` (ADR 047, #24).
+
+### Changed
+
+- `Measure#sql_alias` is now `Measure#order_by`, because a ratio has no column alias to name and is ordered by its expression. Internal, with one call site in the gem, so nothing a host declares changes; a fork that called it will need the new name (ADR 038).
+
+### Fixed
+
+- **A Sprockets host on importmap-rails no longer gets a 500 from `javascript_importmap_tags`.** Janela declared its stylesheets precompilable and never its JavaScript, so on Sprockets the first page that rendered the importmap raised `AssetNotPrecompiledError: Asset janela/frame_controller.js was not declared to be precompiled in production`, in development as much as production, and no setting turns it into a warning. The engine now declares the four assets its importmap pins, for a host that uses importmap: a Sprockets host that bundles its own JavaScript is untouched, and so is a Propshaft one. If you worked around it with a manifest entry of your own, you can delete it, and nothing breaks if you leave it (ADR 004, #14).
+
 ## [0.11.0] - 2026-09-30
 
 ### Added
@@ -234,6 +256,7 @@ First alpha, installed from GitHub for testing in a single host application.
 - Only models that declare a `janela` block are addressable over HTTP.
 - ADRs 001 to 004 in `docs/decisions/`, shipped inside the gem.
 
+[0.12.0]: https://github.com/retail-tasker/janela/releases/tag/v0.12.0
 [0.11.0]: https://github.com/retail-tasker/janela/releases/tag/v0.11.0
 [0.10.0]: https://github.com/retail-tasker/janela/releases/tag/v0.10.0
 [0.9.0]: https://github.com/retail-tasker/janela/releases/tag/v0.9.0

data/README.md

@@ -27,7 +27,7 @@ Janela is an alpha on [rubygems.org](https://rubygems.org/gems/janela). It has t
 
 ```ruby
 # Gemfile
-gem "janela", "~> 0.11"
+gem "janela", "~> 0.12"
 ```
 
 ```ruby
@@ -55,7 +55,7 @@ The chart controller imports `chart.js`, which is a peer dependency: add `chart.
 
 **With importmap-rails:**
 
-Nothing to install. The engine pins `janela/frame_controller`, `janela/chart_controller` and a vendored `chart.js` for you (your own `chart.js` pin wins if you have one). Register the controllers:
+Nothing to install. The engine pins `janela/frame_controller`, `janela/chart_controller` and a vendored `chart.js` for you (your own `chart.js` pin wins if you have one), and declares them precompilable, so it works the same on Propshaft and on Sprockets. Register the controllers:
 
 ```js
 // app/javascript/application.js
@@ -158,6 +158,14 @@ Precision defaults to what the schema already says. Counting rows has no decimal
 
 Formatting is rendering, never rounding. The number itself reaches a snapshot and an order clause at full precision, so a snapshot taken last month reads back under a format you declare today.
 
+**The share of rows where something is true** is a ratio, and it has a measure of its own, because averaging a boolean column does not work: ActiveRecord casts the answer back to `true` (so even 0% reads as `true`), and Janela refuses it.
+
+```ruby
+measure :expedited_rate, ratio: :expedited                       # 31.2%
+```
+
+It takes a boolean column, leaves rows where the column is null out of the average (as SQL's `AVG` does) rather than counting them as no, and orders, gap fills, cross-filters and snapshots like any other measure. The number it stores is the fraction, `0.3119`, and only the text a reader sees is a percentage, to one decimal place unless you declare `precision:`. It takes no `prefix:` or `suffix:`, since it is always a percentage, and it takes no condition (`ratio: { status: "paid" }`): where a column is not already a yes or no fact, a dimension gives you the split (ADR 038).
+
 Then query them:
 
 ```ruby
@@ -211,6 +219,12 @@ A pane with no `by:` is the measure's single total, the KPI tile. `limit: 10` ke
 
 A doughnut or a pie is drawn on the server as SVG with a legend of buttons beside it, so it is in the page before any JavaScript runs and can be operated from the keyboard through the legend. Bars, doughnut slices and pie slices are drawn in a palette of eight colours by position, first to eighth, and every value after the eighth in one neutral, so a ring suits a handful of values: `limit: 8` keeps it readable. A ring cannot show a negative value, so a pane with one is drawn as a table and says so. The palette is `--janela-series-1` to `--janela-series-8` and `--janela-series-other` in [docs/theming.md](docs/theming.md) (ADR 046).
 
+**Height.** A bar or line chart is drawn at twice its width, up to 20rem, unless the pane says how tall it is: `height: 1` to `height: 5`, from about 96px to about 448px at the default spacing (`janela_pane Order, :revenue, by: :placed_on, as: :line, height: 2`). Five steps rather than pixels, the same as `span` and `gap`, so a stored pane takes it too, from the pane form, and a host that wants an exact figure sets it against `janela-h-2` in its own CSS. With no height nothing changes. A ring, a table and a single value ignore one (ADR 047).
+
+**Prominence.** A single value is `2rem` unless the pane says how much it matters: `prominence: 1` is a footnote at `1.25rem`, `2` is what it already is, and `3` is the hero number at `3.5rem` (`janela_pane Order, :orders, prominence: 3`). Three steps rather than a length, the same as `span` and `height`, so a stored pane takes it too, from the pane form. The label stays small at every step. With none set nothing changes, and a table, a chart and a ring ignore one (ADR 050).
+
+**Companion columns.** A table can carry up to three more columns beside its label, each a measure or a dimension the model declares: `janela_pane Order, :expedited_rate, by: :customer, companions: [:orders, :region]` reads as customer, expedited rate, orders and region, under a header row. A measure companion is its own number, formatted as it declares, so a rate can sit beside the count behind it: 75% of four and 75% of forty are different things to act on. A dimension companion shows a value only where every row of that label's group shares one, and is blank where they differ, since grouping by it would show a label twice and picking one would show an arbitrary value as fact. Order, limit, filters and clicking a label are the primary measure's and are unchanged. Only a table draws companions, a stored snapshot shows the base table, and a time pane may carry measures but not dimensions. Each companion is one more query, which is why it is three at most (ADR 051).
+
 **Reconfiguring a pane in place**, a renderer toggle, a granularity switcher, a "show top 20" control, takes two things: name the pane with `id:`, then ask the frame to repoint it.
 
 ```erb
@@ -349,9 +363,9 @@ A host with no tenancy defines nothing, gets a nil owner, and is correct: nothin
 
 ### Filters and clicks
 
-The dashboard's filters live in the page URL as the same `q[...]` parameters, so a reload keeps them and a filtered dashboard is a link you can send: `/reports/orders?q[status_in][]=paid` renders filtered before any JavaScript runs. A pane ignores filters on its own dimension, so clicking a value re-scopes the rest of the dashboard rather than collapsing the pane you clicked. Time panes re-scope with the others but are not click sources yet; drill-down is the next decision. Every selected value is marked `aria-pressed="true"` on tables and drawn solid against faded siblings on charts, so it can be styled and read.
+The dashboard's filters live in the page URL as the same `q[...]` parameters, so a reload keeps them and a filtered dashboard is a link you can send: `/reports/orders?q[status_in][]=paid` renders filtered before any JavaScript runs. A pane ignores filters on its own dimension, so clicking a value re-scopes the rest of the dashboard rather than collapsing the pane you clicked. Clicking a bucket on a time pane filters the others to the range it covers. Every selected value is marked `aria-pressed="true"` on tables and drawn solid against faded siblings on charts, so it can be styled and read.
 
-**Selecting more than one.** Ctrl or Cmd click adds a value to the selection and takes it out again, leaving the rest alone, which is how every list in every operating system already behaves. A plain click selects one value and replaces whatever was selected, or clears the dimension if that value was the only one. It works the same on a chart. All of it works from the keyboard too: a value is a real `<button>`, so Enter is a click and Ctrl or Cmd with Enter adds. `Escape` clears the frame's filters, and those are the only two keys Janela binds, both only while focus is inside the frame, because a single letter belongs to your application and to any text field on the page (ADR 024). A pane with no matching rows renders a `.janela-empty` paragraph. A group whose dimension is null is labelled `(none)` and filters with Ransack's null predicate rather than an empty string. Only models that declare a `janela` block can be requested over HTTP.
+**Selecting more than one.** Ctrl or Cmd click adds a value to the selection and takes it out again, leaving the rest alone, which is how every list in every operating system already behaves. A plain click selects one value and replaces whatever was selected, or clears the dimension if that value was the only one. It works the same on a chart. The (none) group, the rows that have nothing there, is a member of the selection like any value: Ctrl or Cmd click it beside a value and the panes show the rows that have that value or nothing (`q[channel_in][]=web&q[channel_null]=1`), where `not_in` and `not_null` together still mean neither (ADR 049). All of it works from the keyboard too: a value is a real `<button>`, so Enter is a click and Ctrl or Cmd with Enter adds. `Escape` clears the frame's filters, and those are the only two keys Janela binds, both only while focus is inside the frame, because a single letter belongs to your application and to any text field on the page (ADR 024). A pane with no matching rows renders a `.janela-empty` paragraph. A group whose dimension is null is labelled `(none)` and filters with Ransack's null predicate rather than an empty string. Only models that declare a `janela` block can be requested over HTTP.
 
 ### Pane URLs
 
@@ -544,7 +558,7 @@ Deliberately out of scope: natural-language query, a separate data warehouse, a
 
 ## Status
 
-**v0.11.0 alpha.** The measures/dimensions DSL, time dimensions, cross-filtering with multi-selection, bar, line, doughnut and pie charts, pane URLs, shareable dashboard URLs, snapshots, database-backed frames found by owner and key, panes that hold words or a host partial as well as a query, a host-fixed filter no click can remove and a frame's own permanent one beside it, STI subclasses, the engine's own pages for reading and editing them and the optional vitral theme work and are covered by unit and real-browser tests, with the classes a theme may target documented in [Theming Janela](docs/theming.md). Not yet built: a visual editor, drill-down on time panes, other chart types. [Vista](docs/roadmap.md), the roadmap, says what 1.0 means and which of these are in it; open work is in [GitHub Issues](https://github.com/retail-tasker/janela/issues).
+**v0.12.0 alpha.** The measures/dimensions DSL, time dimensions, cross-filtering with multi-selection, bar, line, doughnut and pie charts, pane URLs, shareable dashboard URLs, snapshots, database-backed frames found by owner and key, panes that hold words or a host partial as well as a query, a host-fixed filter no click can remove and a frame's own permanent one beside it, STI subclasses, the engine's own pages for reading and editing them and the optional vitral theme work and are covered by unit and real-browser tests, with the classes a theme may target documented in [Theming Janela](docs/theming.md). Not yet built: a visual editor, drill-down on time panes, other chart types. [Vista](docs/roadmap.md), the roadmap, says what 1.0 means and which of these are in it; open work is in [GitHub Issues](https://github.com/retail-tasker/janela/issues).
 
 ## Development
 
@@ -561,7 +575,13 @@ bin/rails console     # console inside the dummy app, engine loaded
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/retail-tasker/janela. Pull requests are reviewed on the merits of the diff, whether a person or an agent wrote them. Contributors are expected to adhere to the [code of conduct](https://github.com/retail-tasker/janela/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/retail-tasker/janela. Pull requests are reviewed on the merits of the diff, whether a person or an agent wrote them. [CONTRIBUTING.md](CONTRIBUTING.md) says how to run the tests, when a change needs a decision record first, and what to write down for the people who upgrade. Contributors are expected to adhere to the [code of conduct](https://github.com/retail-tasker/janela/blob/main/CODE_OF_CONDUCT.md).
+
+## Support and security
+
+Janela is pre-1.0 and its public surface can still move between releases, with an upgrade note each time. Issues and pull requests are read when the maintainers can get to them; there is no support contract and no promised response time.
+
+To report a vulnerability, use the private form described in [SECURITY.md](SECURITY.md) and not a public issue. Releases are cut by the two maintainers and published from a protected workflow; the steps are in [RELEASING.md](RELEASING.md).
 
 ## License
 

data/UPGRADING.md

@@ -12,6 +12,25 @@ bin/rails janela:doctor
 
 It reads your application and lists what still needs changing.
 
+## 0.11.0 to 0.12.0
+
+One migration step, if you use stored frames.
+
+**Take the pane migrations.**
+
+A pane can now carry a chart height (ADR 047), a single value a
+prominence (ADR 050) and a table companion columns (ADR 051).
+`janela_panes` gains a nullable `height`, a nullable `prominence` and a
+nullable JSON `companions`:
+
+```bash
+bin/rails janela:install:migrations
+bin/rails db:migrate
+```
+
+Every existing pane keeps all three nil and is drawn exactly as before. If you
+never use stored frames, there is nothing to do.
+
 ## 0.10.0 to 0.11.0
 
 No migration. Two things you may see.

data/app/assets/javascripts/janela/chart_controller.js

@@ -9,7 +9,7 @@ Chart.register(...registerables)
 // chart is destroyed on disconnect and rebuilt on connect.
 export default class extends Controller {
   static values = { type: String, labels: Array, values: Array, filters: Object, title: String,
-                    selected: Array, formatted: Array }
+                    selected: Array, formatted: Array, fixedHeight: Boolean }
 
   connect() {
     this.chart = new Chart(this.element, {
@@ -26,6 +26,11 @@ export default class extends Controller {
       },
       options: {
         animation: false,
+        // A pane with a height is drawn into a box of that height, and the
+        // aspect ratio has to be off for the chart to fill it (ADR 047). It
+        // is decided here, when the chart is made: patched onto a chart built
+        // with it on, it draws at the wrong size.
+        maintainAspectRatio: !this.fixedHeightValue,
         scales: { y: { beginAtZero: true } },
         // A line is clicked anywhere along its x position rather than on
         // the exact pixel of a point, which on a dense series is a few

data/app/assets/javascripts/janela/frame_controller.js

@@ -81,22 +81,32 @@ export default class extends Controller {
     if (range) return this.toggleRange(range)
 
     const additive = event.ctrlKey || event.metaKey || event.detail?.additive === true
-    const filters = { ...this.filtersValue }
-    const selected = this.valuesFor(filters, key).includes(String(value))
+    const held = this.filtersValue
+    const filters = { ...held }
+    const isNone = key.endsWith("_null")
+    const base = key.replace(/_(in|null|eq)$/, "")
+    const valueKey = isNone ? `${base}_in` : key
+    const heldValues = this.valuesFor(held, valueKey)
+    const holdsNone = this.valuesFor(held, `${base}_null`).length > 0
+    const selected = isNone ? holdsNone : heldValues.includes(String(value))
 
-    // The null group asks for rows that have nothing there, so it cannot be
-    // combined with a value: Ransack ands its conditions, and the pair matches
-    // no row at all. It is exclusive within its dimension instead.
     this.clearDimension(filters, key)
 
-    if (key.endsWith("_null")) {
-      if (!selected) filters[key] = "1"
+    // The null group is one more member of the selection, so a plain click
+    // replaces all of it and Ctrl or Cmd adds to it, values and null alike.
+    // Read together the two mean the union, which is the server's to say
+    // (ADR 049). Until then it was exclusive, because ANDed they match no row.
+    let values = additive ? heldValues : []
+    let none = additive ? holdsNone : false
+    if (isNone) {
+      none = !selected
     } else {
-      let values = additive ? this.valuesFor(this.filtersValue, key) : []
       values = selected ? values.filter((each) => each !== String(value)) : [ ...values, String(value) ]
-      if (values.length) filters[key] = [ ...new Set(values) ].sort()
     }
 
+    if (values.length) filters[valueKey] = [ ...new Set(values) ].sort()
+    if (none) filters[`${base}_null`] = "1"
+
     this.filtersValue = filters
   }
 

data/app/assets/stylesheets/janela.css

@@ -82,6 +82,11 @@
 .janela-value { margin: 0; display: flex; flex-direction: column; gap: calc(var(--janela-space) * 1); }
 .janela-value-label { font-size: 0.85rem; opacity: 0.7; }
 .janela-value-number { font-size: 2rem; font-weight: 600; font-variant-numeric: tabular-nums; }
+/* How prominent a single value is (ADR 050). Step 2 is what every value is
+   without one. The label stays the same small size at every step. */
+.janela-prominence-1 .janela-value-number { font-size: 1.25rem; }
+.janela-prominence-2 .janela-value-number { font-size: 2rem; }
+.janela-prominence-3 .janela-value-number { font-size: 3.5rem; }
 
 /* Words in a stored frame (ADR 039). A heading and paragraphs, spaced by the
    same unit as everything else and otherwise left to the page. */
@@ -92,7 +97,12 @@
 table.janela-pane { width: 100%; border-collapse: collapse; }
 table.janela-pane caption { text-align: left; font-weight: 600; margin-bottom: calc(var(--janela-space) * 2); }
 table.janela-pane td { padding: calc(var(--janela-space) * 1.5) 0; border-top: 1px solid var(--janela-line); }
-table.janela-pane td:last-child { text-align: right; font-variant-numeric: tabular-nums; }
+table.janela-pane td:not(:first-child) { text-align: right; font-variant-numeric: tabular-nums; }
+/* A companion column (ADR 051): a header row names the columns, a measure's
+   numbers sit right like the primary's, and a dimension's fact is a word and
+   sits left. */
+table.janela-pane th { text-align: right; font-size: 0.85rem; font-weight: 600; opacity: 0.7; padding-bottom: calc(var(--janela-space) * 1); }
+table.janela-pane th:first-child, table.janela-pane th.janela-fact, table.janela-pane td.janela-fact { text-align: left; font-variant-numeric: normal; }
 table.janela-pane button {
   font: inherit;
   color: inherit;
@@ -108,6 +118,18 @@ table.janela-pane button[aria-pressed="true"] { background: var(--janela-accent)
 .janela-chart-title { font-weight: 600; margin-bottom: calc(var(--janela-space) * 2); }
 canvas.janela-chart { width: 100% !important; max-height: 20rem; }
 
+/* A pane with a height draws its chart into a box of fixed size (ADR 047), five
+   steps of the spacing unit so a theme that moves the unit moves them. Step 4
+   is the 20rem the cap allows a chart anyway. The cap stops applying inside a
+   box, where the box is the size. */
+.janela-chart-box { position: relative; }
+.janela-chart-box canvas.janela-chart { max-height: none; }
+.janela-h-1 { height: calc(var(--janela-space) * 24); }
+.janela-h-2 { height: calc(var(--janela-space) * 40); }
+.janela-h-3 { height: calc(var(--janela-space) * 56); }
+.janela-h-4 { height: calc(var(--janela-space) * 80); }
+.janela-h-5 { height: calc(var(--janela-space) * 112); }
+
 /* A chart pane is a <figure>, and a browser gives a figure 40px of margin
    either side. Harmless in a wide column and most of a narrow one. */
 figure.janela-pane { margin: 0; }

data/app/controllers/janela/panes_controller.rb

@@ -76,8 +76,8 @@ module Janela
       end
 
       def pane_params
-        params.expect(pane: [ :kind, :model, :measure, :dimension, :renderer, :granularity, :limit, :span, :title,
-                              :heading, :body, :link, :partial ])
+        params.expect(pane: [ :kind, :model, :measure, :dimension, :renderer, :granularity, :limit, :height, :prominence, :span, :title,
+                              :heading, :body, :link, :partial, { companions: [] } ])
       end
 
       def build_pane(choice)

data/app/controllers/janela/queries_controller.rb

@@ -8,6 +8,9 @@ module Janela
         renderer: params.fetch(:as, "table"),
         granularity: params[:granularity],
         limit: params[:limit],
+        height: params[:height],
+        prominence: params[:prominence],
+        companions: params[:companions],
         filters: filters,
         fixed: fixed_filters
       )

data/app/controllers/janela/snapshot_queries_controller.rb

@@ -13,6 +13,9 @@ module Janela
         renderer: params.fetch(:as, "table"),
         granularity: params[:granularity],
         limit: params[:limit],
+        height: params[:height],
+        prominence: params[:prominence],
+        companions: params[:companions],
         snapshot: snapshot
       )
 

data/app/helpers/janela/frames_helper.rb

@@ -26,8 +26,15 @@ module Janela
     # so a host that changes the query in place (a renderer, granularity or
     # limit control) keeps one stable frame for Turbo to reconcile into
     # rather than a different id every time the query changes (ADR 029).
-    def janela_pane(model, measure, by: nil, as: :table, granularity: nil, limit: nil, id: nil)
-      query = { as: (as unless as.to_s == "table"), granularity: granularity, limit: limit,
+    #
+    # prominence: is one of three steps for a single value, and height: one of
+    # five for a chart. Both travel in the pane's URL for the same reason.
+    # height: is one of five steps, and travels in the pane's URL because the
+    # server draws the pane from it again on every cross-filter. It is not part
+    # of the frame's id: how tall a pane is does not say which query it is
+    # (ADR 047, ADR 029).
+    def janela_pane(model, measure, by: nil, as: :table, granularity: nil, limit: nil, height: nil, prominence: nil, companions: nil, id: nil)
+      query = { as: (as unless as.to_s == "table"), granularity: granularity, limit: limit, height: height, prominence: prominence, companions: companions.presence,
                 where: @janela_fixed_filters.presence }.compact
       base = janela_routes.pane_path(model.model_name.route_key, measure, by, **query)
 
@@ -39,8 +46,9 @@ module Janela
 
     # A pane as it was when the snapshot was taken: same shape as janela_pane,
     # not part of the live frame's filter state (ADR 009).
-    def janela_snapshot_pane(snapshot, model, measure, by: nil, as: :table, granularity: nil, limit: nil)
-      query = { as: (as unless as.to_s == "table"), granularity: granularity, limit: limit }.compact
+    def janela_snapshot_pane(snapshot, model, measure, by: nil, as: :table, granularity: nil, limit: nil, height: nil, prominence: nil, companions: nil)
+      query = { as: (as unless as.to_s == "table"), granularity: granularity, limit: limit, height: height,
+                prominence: prominence, companions: companions.presence }.compact
       src = janela_routes.snapshot_pane_path(snapshot, model.model_name.route_key, measure, by, **query)
 
       turbo_frame_tag Query.turbo_frame_id(model: model, measure: measure, by: by, as: as, granularity: granularity, limit: limit, snapshot: snapshot),

data/app/models/janela/pane.rb

@@ -5,6 +5,14 @@ module Janela
   # invent a query or reach a model nobody exposed.
   class Pane < ActiveRecord::Base
     SPANS = (1..12).freeze
+
+    # How tall a bar or line chart is drawn, or nil for what it always was
+    # (ADR 047). Five steps rather than pixels: a stored integer selects a class
+    # that is already written (ADR 016).
+    HEIGHTS = Query::HEIGHTS
+
+    # How prominent a single value is drawn (ADR 050).
+    PROMINENCES = Query::PROMINENCES
     LIMITS = (1..1000).freeze
     # A form cannot offer a thousand options, and these are the row counts a
     # dashboard actually asks for. Any limit inside LIMITS is still valid.
@@ -30,6 +38,10 @@ module Janela
     validates :kind, inclusion: { in: KINDS }
     validates :span, inclusion: { in: SPANS }
     validates :limit, inclusion: { in: LIMITS }, allow_nil: true
+    validates :height, inclusion: { in: HEIGHTS }, allow_nil: true
+    validates :prominence, inclusion: { in: PROMINENCES }, allow_nil: true
+    before_validation :normalise_companions
+    validate :companions_are_declared
     validates :measure, presence: true, if: :query?
     validate :declared_by_a_janela_block, if: :query?
     validate :holds_no_query, unless: :query?
@@ -72,7 +84,7 @@ module Janela
     # instead (ADR 018).
     def query(filters: {}, fixed: {}, renderer: self.renderer)
       Query.new(definition: definition, measure: measure.to_sym, dimension: dimension.presence&.to_sym,
-                renderer: renderer, granularity: granularity, limit: limit, filters: filters, fixed: fixed,
+                renderer: renderer, granularity: granularity, limit: limit, height: height, prominence: prominence, companions: companions, filters: filters, fixed: fixed,
                 default: frame.default_for(definition.model), title: title)
     end
 
@@ -107,6 +119,25 @@ module Janela
     end
 
     private
+      # A multiple select sends an empty string beside its choices, and an empty
+      # selection is nothing rather than an empty list.
+      def normalise_companions
+        self.companions = Array(companions).map(&:to_s).reject(&:blank?).presence
+      end
+
+      # The same rules a URL is held to, from the same place, so a row cannot
+      # name what a request could not (ADR 051).
+      def companions_are_declared
+        return if companions.blank? || !query? || measure.blank? || Query::RENDERERS.exclude?(renderer.to_s)
+
+        Query.new(definition: definition, measure: measure.to_sym, dimension: dimension.presence&.to_sym,
+                  renderer: renderer, companions: companions)
+      rescue Janela::BadRequest => error
+        errors.add(:companions, error.message)
+      rescue Janela::Error
+        nil # an unknown model is reported by its own validation
+      end
+
       def panes_above
         frame.panes.where(position: ...position).order(:position)
       end

data/app/models/janela/query.rb

@@ -18,7 +18,22 @@ module Janela
     # categories the same beside a legend that says they differ (ADR 046).
     SERIES = 8
 
-    attr_reader :definition, :measure, :dimension, :renderer, :limit, :filters, :fixed, :default, :snapshot
+    # The steps a chart's height may take (ADR 047). Pane::HEIGHTS is the same
+    # range for a stored row, and a test holds the two together.
+    HEIGHTS = (1..5).freeze
+
+    # The steps a single value's prominence may take (ADR 050).
+    PROMINENCES = (1..3).freeze
+
+    # Each companion column is a query of its own, so how many a pane may run
+    # is bounded, as what one query may ask for is (ADR 051, ADR 025).
+    MAX_COMPANIONS = 3
+
+    # A column beside a table's label: a measure's formatted numbers, or a
+    # dimension's shared fact, by label.
+    Companion = Struct.new(:name, :header, :fact, :cells, keyword_init: true)
+
+    attr_reader :definition, :measure, :dimension, :renderer, :limit, :height, :prominence, :companions, :filters, :fixed, :default, :snapshot
 
     # The helper renders the turbo frame and the controller renders its
     # replacement, so both derive the id the same way from the same parameters.
@@ -28,7 +43,7 @@ module Janela
       parts.compact.join("_")
     end
 
-    def initialize(definition:, measure:, dimension: nil, renderer: "table", granularity: nil, limit: nil, filters: {}, fixed: {}, default: {}, snapshot: nil, title: nil)
+    def initialize(definition:, measure:, dimension: nil, renderer: "table", granularity: nil, limit: nil, height: nil, prominence: nil, companions: nil, filters: {}, fixed: {}, default: {}, snapshot: nil, title: nil)
       @definition = definition
       @title = title
       @measure = measure
@@ -42,6 +57,9 @@ module Janela
       raise BadRequest, "unknown pane renderer #{renderer.inspect}" unless RENDERERS.include?(@renderer)
       @granularity = Dimension.granularity!(granularity) if granularity.present?
       @limit = definition.limit!(limit) if limit.present?
+      @height = height!(height) if height.present?
+      @prominence = prominence!(prominence) if prominence.present?
+      @companions = companions!(companions)
     end
 
     def model
@@ -82,6 +100,20 @@ module Janela
       !single_value? && CANVAS.include?(renderer)
     end
 
+    # A height means a box only where there is a canvas to fill it. A ring, a
+    # table and a single value ignore one, so switching a pane between
+    # renderers never invalidates it (ADR 047).
+    # Only a single value has a headline number to make more or less of. A
+    # table, a chart and a ring ignore one, so a pane switched between renderers
+    # keeps what it had (ADR 050).
+    def prominent?
+      single_value? && !prominence.nil?
+    end
+
+    def boxed?
+      chart? && !height.nil?
+    end
+
     def ring?
       !single_value? && RINGS.include?(renderer)
     end
@@ -188,9 +220,30 @@ module Janela
       # selection, which this pane shows the alternatives to (ADR 040, 043).
       on = definition.narrow(on || model.all, default) if default.present?
       on = definition.narrow(on || model.all, fixed) if fixed.present?
-      return time_result(on) if time?
+      primary = time? ? time_result(on) : definition.query(measure, by: dimension, where: applicable_filters, on: on, granularity: granularity, limit: limit)
+      @companion_columns = companions? ? fetch_companions(primary, on) : []
+      primary
+    end
+
+    # Only a table draws companion columns, and a stored pane is the record of
+    # a moment that holds none (ADR 051).
+    def companions?
+      renderer == "table" && !single_value? && !frozen? && companions.any?
+    end
+
+    # The columns beside the label, once a result has been read. Kept from the
+    # same read as the result, with the same scope and filters, the way a time
+    # pane keeps its buckets.
+    def companion_columns
+      @companion_columns || []
+    end
+
+    def dimension_header
+      dimension.to_s.humanize
+    end
 
-      definition.query(measure, by: dimension, where: applicable_filters, on: on, granularity: granularity, limit: limit)
+    def measure_header
+      measure.to_s.humanize
     end
 
     # The two filters a click on this label writes, for a time pane: the start
@@ -290,6 +343,65 @@ module Janela
         }.keys
       end
 
+      def companions!(value)
+        return [] if value.blank?
+        raise BadRequest, "companions must be a list of measure and dimension names, got #{value.class}" unless value.is_a?(Array) && value.all? { |each| each.is_a?(String) || each.is_a?(Symbol) }
+
+        names = value.map(&:to_sym)
+        raise BadRequest, "a pane may carry at most #{MAX_COMPANIONS} companions, got #{names.size}" if names.size > MAX_COMPANIONS
+        raise BadRequest, "companions must each be named once, got #{names.map(&:inspect).join(', ')}" unless names == names.uniq
+
+        names.each { |name| companion!(name) }
+      end
+
+      # Only what the model declared, by the name it declared it under: no
+      # column, no expression, nothing that becomes SQL (ADR 025, ADR 051).
+      def companion!(name)
+        declared = definition.measures.keys + definition.dimensions.keys
+        raise BadRequest, "#{name.inspect} is not a declared measure or dimension of #{model}. Declared: #{declared.join(', ')}" unless declared.include?(name)
+        raise BadRequest, "#{name.inspect} is this pane's own #{name == measure ? 'measure' : 'dimension'}" if name == measure || name == dimension
+        return if definition.measures.key?(name)
+
+        fact = definition.dimensions.fetch(name)
+        raise BadRequest, "#{name.inspect} is a time dimension, and a bucket is not a fact about a label" if fact.time?
+        raise BadRequest, "#{name.inspect} is a dimension, which a time pane has no shared fact to show" if dimension && definition.dimension!(dimension).time?
+      end
+
+      # Ordering and the limit belong to the primary measure. The companions are
+      # fetched for the labels it chose, one grouped query for each measure and
+      # one for all the dimensions (ADR 051).
+      def fetch_companions(primary, on)
+        keys = time? ? nil : primary.keys
+        facts = companions.reject { |name| definition.measures.key?(name) }
+        shared = facts.any? ? definition.facts(facts, by: dimension, where: applicable_filters, on: on, keys: keys) : {}
+
+        companions.map do |name|
+          if definition.measures.key?(name)
+            values = definition.query(name, by: dimension, where: applicable_filters, on: on, granularity: granularity, keys: keys)
+            formatted = definition.measure!(name)
+            Companion.new(name: name, header: name.to_s.humanize, fact: false,
+                          cells: primary.keys.to_h { |label| [ label, formatted.format(values[label]) ] })
+          else
+            Companion.new(name: name, header: name.to_s.humanize, fact: true,
+                          cells: primary.keys.to_h { |label| [ label, shared.dig(label, name).to_s ] })
+          end
+        end
+      end
+
+      def prominence!(value)
+        step = Integer(value.to_s, exception: false)
+        raise BadRequest, "prominence must be a whole number from #{PROMINENCES.first} to #{PROMINENCES.last}, got #{value.inspect}" unless PROMINENCES.cover?(step)
+
+        step
+      end
+
+      def height!(value)
+        step = Integer(value.to_s, exception: false)
+        raise BadRequest, "height must be a whole number from #{HEIGHTS.first} to #{HEIGHTS.last}, got #{value.inspect}" unless HEIGHTS.cover?(step)
+
+        step
+      end
+
       def applicable_filters
         return filters if single_value?
 

data/app/views/janela/panes/_form.html.erb

@@ -41,6 +41,31 @@
     <%= form.select :limit, Janela::Pane::OFFERED_LIMITS, include_blank: t("janela.panes.no_limit") %>
   </div>
 
+  <%# What may sit beside the label: this model's other measures and its
+      categorical dimensions. The pane's own choices are left out when they are
+      already made (ADR 051). %>
+  <%
+    companion_choices = {
+      t("janela.companions.measures") => definition.measures.keys.reject { |name| name.to_s == pane.measure }.map { |name| [ name.to_s.humanize, name ] },
+      t("janela.companions.dimensions") => definition.dimensions.values.reject { |each| each.time? || each.name.to_s == pane.dimension }.map { |each| [ each.name.to_s.humanize, each.name ] }
+    }
+  %>
+  <div class="janela-field">
+    <%= form.label :companions %>
+    <%= form.select :companions, companion_choices, {}, multiple: true %>
+    <span class="janela-hint"><%= t("janela.companions.hint") %></span>
+  </div>
+
+  <div class="janela-field">
+    <%= form.label :height %>
+    <%= form.select :height, Janela::Pane::HEIGHTS.map { |step| [ t("janela.heights.#{step}"), step ] }, include_blank: t("janela.heights.automatic") %>
+  </div>
+
+  <div class="janela-field">
+    <%= form.label :prominence %>
+    <%= form.select :prominence, Janela::Pane::PROMINENCES.map { |step| [ t("janela.prominences.#{step}"), step ] }, include_blank: t("janela.prominences.automatic") %>
+  </div>
+
   <div class="janela-field">
     <%= form.label :span %>
     <%= form.select :span, Janela::Pane::SPANS.to_a %>