Compare commits

...

2 Commits

12 changed files with 200 additions and 134 deletions

34
DESIGN.md Normal file
View File

@@ -0,0 +1,34 @@
DESIGN
======
Below is a list of design decisions. The justification is to be consulted
whenever a change is considered, to avoid regressions.
### Data type for DB storage of numeric values (`decimal` vs `float`)
* among database engines supported (by Rails), SQLite offers storage of
`decimal` data type with the lowest precision, equal to the precision of
`REAL` type (double precision float value, IEEE 754), but in a floating point
format,
* decimal types in other database engines offer greater precision, but store
data in a fixed point format,
* biology-related values differ by several orders of magnitude; storing them in
fixed point format would only make sense if required precision would be
greater than that offered by floating point format,
* even then, fixed point would mean either bigger memory requirements or
worse precision for numbers close to scale limit,
* for a fixed point format to use the same 8 bytes of storage as IEEE
754, precision would need to be limited to 18 digits (4 bytes/9 digits)
and scale approximately half of that - 9,
* double precision floating point guarantees 15 digits of precision, which
is more than enough for all expected use cases,
* single precision floating point only guarntees 6 digits of precision,
which is estimated to be too low for some use cases (e.g. storing
latitude/longitude with a resolution grater than 100m)
* double precision floating point (IEEE 754) is a standard that ensures
compatibility with all database engines,
* the same data format is used internally by Ruby as a `Float`; it
guarantees no conversions between storage and computation,
* as a standard with hardware implementations ensures both: computing
efficiency and hardware/3rd party library compatibility as opposed to Ruby
custom `BigDecimal` type

View File

@@ -58,16 +58,18 @@
outline: none;
}
/* NOTE: move to higher priority layer instead of using !important? */
/* TODO: add CSS @layer requirements in README */
[disabled] {
border-color: var(--color-border-gray) !important;
color: var(--color-border-gray) !important;
/* NOTE: cannot set cursor with `pointer-events: none`; can be fixed by setting
/* NOTE: cannot set cursor when `pointer-events: none`; can be fixed by setting
* `cursor` on wrapping element.
cursor: not-allowed; */
fill: var(--color-border-gray) !important;
pointer-events: none !important;
}
/* [hidden] submit elements cannot have `display` set as it makes them visible. */
/* Styles set `display` without distinguishing between [hidden] elements, making
* them visible. */
[hidden] {
display: none !important;
}
@@ -122,6 +124,7 @@ input[type=checkbox]:checked {
input[type=number] {
appearance: textfield;
-moz-appearance: textfield;
text-align: end;
}
input::-webkit-inner-spin-button {
-webkit-appearance: none;
@@ -130,6 +133,26 @@ input::-webkit-outer-spin-button {
-webkit-appearance: none;
margin: 0;
}
/* Text color of table form controls:
* - black for row/table forms,
* - inherited for internal (column specific) buttons/forms. */
table input,
table select,
table summary,
table textarea {
border-color: var(--color-border-gray);
}
table input,
table select,
table textarea {
padding-block: 0.375em;
}
table form input,
table form select,
table form summary,
table form textarea {
color: inherit;
}
input:focus-visible,
select:focus-visible,
select:focus-within,
@@ -138,6 +161,7 @@ summary:focus-visible,
textarea:focus-visible {
accent-color: var(--color-dark-blue);
background-color: var(--color-focus-gray);
color: black;
}
input:hover,
select:hover,
@@ -148,8 +172,15 @@ textarea:hover {
}
select:hover,
summary:hover {
color: black;
cursor: pointer;
}
/* TODO: style <details>/<summary> focus to match <select> as much as possible.
summary:focus-visible::before,
summary:hover::before {
background-color: black;
}
*/
input:invalid,
select:invalid,
textarea:invalid {
@@ -213,9 +244,17 @@ textarea:invalid {
background-color: var(--color-red);
border-color: var(--color-red);
}
table .button {
border-color: var(--color-border-gray);
color: var(--color-table-gray);
font-weight: normal;
height: 100%;
padding: 0.4em;
}
/* TODO: move normal, non-button links (<a>:hover/:focus) styling here (i.e.
* page-wide, top-level) and remove from `table.items` - as the style should be
* same everywhere. */
/* TODO: apply link class to non-button/-tab links. Add light underscore for links? */
input[type=text]:read-only,
textarea:read-only {
border: none;
@@ -390,79 +429,87 @@ header {
padding-block: 0;
}
.tabular-form table {
border: none;
}
.tabular-form table td {
border: none;
text-align: left;
vertical-align: middle;
}
.tabular-form table td:first-child {
color: inherit;
}
/* TODO: remove `.items` class (?) and make `form table` work properly. */
table.items {
.items-table {
border-spacing: 0;
border: 1px solid var(--color-border-gray);
border-radius: 0.25em;
font-size: 0.85rem;
text-align: left;
}
table:not(:has(tr)) {
display: none;
}
table.items thead {
.items-table thead {
font-size: 0.8rem;
}
table.items thead,
table.items tbody tr:hover {
.items-table thead,
.items-table tbody tr:hover {
background-color: var(--color-focus-gray);
}
table.items th {
.items-table th {
padding-block: 0.75em;
text-align: center;
}
table.items th,
table.items td {
.items-table th,
.items-table td {
padding-inline: 1em 0;
}
/* For <a> to fill <td> completely, we use an `::after` pseudoelement. */
table.items td.link {
.items-table td.link {
padding: 0;
position: relative;
}
table.items td.link a {
.items-table td.link a {
color: inherit;
font: inherit;
}
table.items td.link a::after {
.items-table td.link a::after {
content: '';
inset: 0;
position: absolute;
}
table.items td:first-child {
.items-table td:first-child {
padding-inline-start: calc(1em + var(--depth) * 0.8em);
}
table.items td:has(input, select, textarea) {
.items-table td:has(input, select, textarea) {
padding-inline-start: calc(0.6em - 0.9px);
}
table.items td:first-child:has(input, select, textarea) {
.items-table td:first-child:has(input, select, textarea) {
padding-inline-start: calc(0.6em + var(--depth) * 0.8em - 0.9px);
}
table.items th:last-child {
.items-table th:last-child {
padding-inline-end: 0.4em;
}
table.items td:last-child {
.items-table td:last-child {
padding-inline-end: 0.1em;
}
table.items td {
.items-table td {
border-top: 1px solid var(--color-border-gray);
height: 2.4em;
padding-block: 0.1em;
}
table.items .actions {
.items-table .actions {
display: flex;
gap: 0.4em;
justify-content: end;
}
table.items .actions.centered {
.items-table .actions.centered {
justify-content: center;
}
table.items tr.dropzone {
.items-table tr.dropzone {
position: relative;
}
table.items tr.dropzone::after {
.items-table tr.dropzone::after {
content: '';
inset: 1px 0 0 0;
position: absolute;
@@ -470,96 +517,52 @@ table.items tr.dropzone::after {
outline-offset: -1px;
z-index: var(--z-index-table-row-outline);
}
table.items td.handle {
.items-table td.handle {
cursor: move;
}
table.items tr.form td {
.items-table tr.form td {
vertical-align: top;
}
/* TODO: replace `:hover:focus-visible` combos with proper LOVE style order. */
/* TODO: update table styling: simplify selectors, deduplicate, remove non-font rem. */
table.items td.link a:hover,
table.items td.link a:focus-visible,
table.items td.link a:hover:focus-visible {
.items-table td.link a:hover,
.items-table td.link a:focus-visible,
.items-table td.link a:hover:focus-visible {
text-decoration: underline;
text-decoration-thickness: 0.05rem;
text-underline-offset: 0.2rem;
}
table.items td.link a:hover {
.items-table td.link a:hover {
color: var(--color-blue);
}
table.items td.link a:focus-visible {
.items-table td.link a:focus-visible {
text-decoration-color: var(--color-gray);
}
table.items td.link a:hover:focus-visible {
.items-table td.link a:hover:focus-visible {
color: var(--color-dark-blue);
}
table.items td:not(:first-child),
.items-table td:not(:first-child),
.grayed {
color: var(--color-table-gray);
fill: var(--color-table-gray);
}
table.items svg {
.items-table svg {
height: 1rem;
vertical-align: middle;
width: 1rem;
}
table.items svg:last-child {
.items-table svg:last-child {
height: 1.2rem;
width: 1.2rem;
}
table.items td.svg {
.items-table td.svg {
text-align: center;
}
table.items td.number {
.items-table td.number {
text-align: right;
}
table.items .button {
font-weight: normal;
height: 100%;
padding: 0.4em;
}
table.items input:not([type=submit]):not([type=checkbox]),
table.items select,
table.items textarea {
padding-block: 0.375em;
}
table input,
table select,
table summary,
table textarea {
border-color: var(--color-border-gray);
}
table select {
color: var(--color-table-gray);
}
table select:hover,
table select:focus-within,
table select:focus-visible {
color: black;
}
table .button {
border-color: var(--color-border-gray);
color: var(--color-table-gray);
}
form table.items {
border: none;
}
form table.items td {
border: none;
text-align: left;
vertical-align: middle;
}
form table.items td:first-child {
color: inherit;
}
form table select {
color: black;
}
.centered {
@@ -587,6 +590,13 @@ form table select {
font-size: 0.9rem;
text-align: center;
}
.hmin50 {
min-width: 50%;
}
.italic {
color: var(--color-gray);
font-style: italic;
}
.vflex {
display: flex;
gap: 0.8em;
@@ -602,12 +612,12 @@ summary {
align-items: center;
color: var(--color-gray);
display: flex;
gap: 0.2em;
gap: 0.4em;
height: 100%;
white-space: nowrap;
}
summary::before {
background-color: #000;
background-color: currentColor;
content: "";
height: 1em;
mask-image: url('pictograms/chevron-down.svg');
@@ -630,7 +640,7 @@ summary span {
width: 100%;
}
details[open] summary::before {
transform: rotate(180deg);
transform: scaleY(-1);
}
summary::marker {
padding-left: 0.25em;
@@ -660,6 +670,11 @@ li input[type=checkbox] {
li::marker {
content: '';
}
#measurement_form {
min-width: 66%;
width: max-content;
}
/*
* TODO:
* * disable <label> containing disabled checkbox: `label:has(input[disabled])`,

View File

@@ -102,13 +102,17 @@ module ApplicationHelper
def number_field(method, options = {})
attr_type = object.type_for_attribute(method)
if attr_type.type == :decimal
case attr_type.type
when :decimal
options[:value] = object.public_send(method)&.to_scientific
options[:step] ||= BigDecimal(10).power(-attr_type.scale)
options[:max] ||= BigDecimal(10).power(attr_type.precision - attr_type.scale) -
options[:step]
options[:min] = options[:min] == :step ? options[:step] : options[:min]
options[:min] ||= -options[:max]
options[:size] ||= attr_type.precision / 2
when :float
options[:size] ||= 6
end
super
end
@@ -148,7 +152,8 @@ module ApplicationHelper
end
def tabular_form_with(**options, &block)
extra_options = {builder: TabularFormBuilder, html: {autocomplete: 'off'}}
extra_options = {builder: TabularFormBuilder, class: 'tabular-form',
html: {autocomplete: 'off'}}
form_with(**merge_attributes(options, extra_options), &block)
end

View File

@@ -1,9 +1,9 @@
module QuantitiesHelper
def quantities_check_boxes
def quantities_check_boxes(quantities)
# Closing <details> on focusout event depends on relatedTarget for internal
# actions being non-null. To ensure this, all top-layer elements of
# ::details-content must accept focus, e.g. <label> needs tabindex="-1" */
collection_check_boxes(nil, :quantity, @quantities, :id, :to_s_with_depth,
collection_check_boxes(nil, :quantity, quantities, :id, :to_s_with_depth,
include_hidden: false) do |b|
content_tag :li, b.label(tabindex: -1) { b.check_box + b.text }
end

View File

@@ -8,7 +8,7 @@
class: 'tools-area' %>
</div>
<table class="main-area items">
<table class="main-area items-table">
<thead>
<tr>
<th><%= Unit.human_attribute_name(:symbol) %></th>

View File

@@ -1,28 +1,37 @@
<%= tabular_form_with model: Measurement.new, id: :measurement_form,
class: 'topside-area vflex', html: {onkeydown: 'formProcessKey(event)'} do |form| %>
<table class="items centered">
<tbody id="readouts"></tbody>
class: 'topside-area vflex centered',
html: {onkeydown: 'formProcessKey(event)'} do |form| %>
<table class="items-table centered">
<tbody id="readouts">
<%= tabular_fields_for @measurement do |form| %>
<tr class="italic">
<td class="hexpand hmin50"><%= t '.taken_at_html' %></td>
<td colspan="3" class="number">
<%= form.datetime_field :taken_at, required: true %>
</td>
</tr>
<% end %>
</tbody>
</table>
<div class="hflex">
<%# TODO: right-click selection %>
<details id="quantity_select" class="hexpand" open
onkeydown="detailsProcessKey(event)">
<summary autofocus>
<!-- TODO: Set content with CSS when span empty to avoid duplication -->
<span data-prompt="<%= t('.select_quantity') %>">
<%= t('.select_quantity') %>
</span>
<%= image_button_tag t(:apply), "update", name: nil, disabled: true,
formaction: new_readout_path, formmethod: :get, formnovalidate: true,
data: {turbo_stream: true} %>
</summary>
<ul><%= quantities_check_boxes %></ul>
</details>
<%= form.button id: :create_measurement_button, disabled: true -%>
</div>
<%# TODO: right-click selection; unnecessary with hierarchical tags? %>
<details id="quantity_select" class="centered hexpand" open
onkeydown="detailsProcessKey(event)">
<summary autofocus>
<!-- TODO: Set content with CSS when span empty to avoid duplication -->
<span data-prompt="<%= t('.select_quantity') %>">
<%= t('.select_quantity') %>
</span>
<%= image_button_tag t(:apply), "update", name: nil, disabled: true,
formaction: new_readout_path, formmethod: :get, formnovalidate: true,
data: {turbo_stream: true} %>
</summary>
<ul><%= quantities_check_boxes(@quantities) %></ul>
</details>
<div class="hflex reverse">
<%= form.button id: :create_measurement_button, disabled: true -%>
<%= image_link_to t(:cancel), "close-outline", measurements_path, name: :cancel,
class: 'dangerous', onclick: render_turbo_stream('form_close') %>
</div>

View File

@@ -8,9 +8,10 @@
class: 'tools-area' %>
</div>
<%# TODO: remove? form can be inserted directly, e.g. at the end of index %>
<%= tag.div class: 'main-area', id: :quantity_form %>
<table class="main-area items">
<table class="main-area items-table">
<thead>
<tr>
<th><%= Quantity.human_attribute_name(:name) %></th>

View File

@@ -1,25 +1,24 @@
<%# TODO: add readout reordering by dragging %>
<%= tabular_fields_for 'readouts[]', readout do |form| %>
<%- tag.tr id: dom_id(readout.quantity, :new, :readout) do %>
<td>
<%# TODO: add grayed readout index (in separate column?) %>
<%= readout.quantity.relative_pathname(@superquantity) %>
</td>
<td>
<%= form.number_field :value, required: true, autofocus: readout_counter == 0 %>
</td>
<td>
<%= form.hidden_field :quantity_id %>
<%= form.collection_select :unit_id, @user_units, :id,
->(u){ sanitize('&emsp;' * (u.base_id ? 1 : 0) + u.symbol) },
{prompt: '', disabled: '', selected: ''}, required: true %>
</td>
<td class="actions">
<%# TODO: change to _link_ after giving up displaying relative paths %>
<%= image_button_tag '', 'delete-outline', class: 'dangerous', name: nil,
formaction: discard_readouts_path(readout.quantity),
formmethod: :get, formnovalidate: true, data: {turbo_stream: true} %>
</td>
<td>
<%= readout.quantity.relative_pathname(@superquantity) %>
</td>
<td>
<%= form.number_field :value, required: true,
size: readout.type_for_attribute(:value).precision / 2,
autofocus: readout_counter == 0 %>
</td>
<td>
<%= form.hidden_field :quantity_id %>
<%= form.collection_select :unit_id, @user_units, :id,
->(u){ sanitize('&emsp;' * (u.base_id ? 1 : 0) + u.symbol) },
{prompt: t('.select_unit'), disabled: '', selected: ''}, required: true %>
</td>
<% end %>
<% end %>

View File

@@ -7,9 +7,10 @@
class: 'tools-area' %>
</div>
<%# TODO: remove? form can be inserted directly, e.g. at the end of index %>
<%= tag.div id: :unit_form %>
<table class="main-area items">
<table class="main-area items-table">
<thead>
<tr>
<th><%= Unit.human_attribute_name(:symbol) %></th>

View File

@@ -1,4 +1,4 @@
<table class="main-area items" id="users">
<table class="main-area items-table" id="users">
<thead>
<tr>
<th><%= User.human_attribute_name(:email) %></th>

View File

@@ -85,12 +85,10 @@ en:
navigation: Measurements
no_items: There are no measurements taken. You can Add some now.
form:
select_quantity: select the measured quantities...
select_quantity: select quantities...
taken_at_html: Measurement taken at&emsp;
index:
new_measurement: Add measurement
readouts:
form:
select_unit: ...
quantities:
navigation: Quantities
no_items: There are no configured quantities. You can Add some or Import from defaults.

View File

@@ -1,10 +1,14 @@
class CreateReadouts < ActiveRecord::Migration[7.2]
def change
create_table :readouts do |t|
t.references :user, null: false, foreign_key: true
# Reference :user through :quantity (:measurement may be NULL).
t.references :measurement, foreign_key: true
t.references :quantity, null: false, foreign_key: true
# :category + :value + :unit as a separate table? (NumericValue, TextValue)
t.integer :category, null: false, default: 0
t.float :value, null: false, limit: Float::MANT_DIG
t.references :unit, foreign_key: true
t.decimal :value, null: false, precision: 30, scale: 15
# Move to Measurement?
#t.references :collector, foreign_key: true
#t.references :device, foreign_key: true