mat_views 0.2.0 → 0.3.0

data/app/views/mat_views/admin/mat_view_definitions/show.html.erb

@@ -0,0 +1,40 @@
+<% humanize_attr = ->(attr) { MatViews::MatViewDefinition.human_attribute_name(attr) } %>
+<% humanize_enum_attr = ->(col, val) { MatViews::MatViewDefinition.human_enum_name(col, val) } %>
+
+<input type="hidden" id="mv-drawer-title-text" value="<%= mv_t("view_var", name: @definition.name) %>"/>
+<input type="hidden" id="mv-drawer-open-url-identifier" value="definitions_view_<%= @definition.id %>"/>
+<%= render "mat_views/admin/ui/card" do %>
+  <div class="mv-field">
+    <div class="mv-label"><%= humanize_attr.call(:refresh_strategy) %></div>
+    <div><%= humanize_enum_attr.call(:refresh_strategy, @definition.refresh_strategy) %></div>
+  </div>
+  <div class="mv-field">
+    <div class="mv-label"><%= humanize_attr.call(:schedule_cron) %></div>
+    <div><%= @definition.schedule_cron.presence || "-" %></div>
+  </div>
+  <div class="mv-field">
+    <div class="mv-label"><%= humanize_attr.call(:unique_index_columns) %></div>
+    <div><%= Array(@definition.unique_index_columns).join(", ").presence || "-" %></div>
+  </div>
+  <div class="mv-field">
+    <div class="mv-label"><%= humanize_attr.call(:dependencies) %></div>
+    <div><%= Array(@definition.dependencies).join(", ").presence || "-" %></div>
+  </div>
+  <div class="mv-field">
+    <div class="mv-label"><%= humanize_attr.call(:last_run) %></div>
+    <div><%= @definition.last_run ? l(@definition.last_run.started_at.in_time_zone, format: :datetime12hour) : "-" %></div>
+  </div>
+  <div class="mv-field">
+    <%= render "mat_views/admin/ui/details",
+               tooltip_text: mv_t("mat_view_definition.sql_summary_tooltip"),
+               title: content_tag(:div, humanize_attr.call(:sql), class: "mv-label") do %>
+      <pre><%= @definition.sql -%></pre>
+    <% end %>
+  </div>
+
+  <% content_for :footer do %>
+    <div class="mv-header-row even">
+      <%= render "definition_actions", defn: @definition, mv_exists: @mv_exists, frame_id: "mv-drawer" %>
+    </div>
+  <% end %>
+<% end %>

data/app/views/mat_views/admin/preferences/show.html.erb

@@ -0,0 +1,50 @@
+<input type="hidden" id="mv-drawer-open-url-identifier" value="preferences_edit" %>
+<div class="mv-card">
+  <div class="mv-card-b">
+    <%= form_with url: admin_preferences_path(frame_id: 'mv-drawer', frame_action: "window-reload"), method: :put, data: { turbo_frame: :"mv-drawer" } do %>
+      <!-- Theme -->
+      <div class="mv-field">
+        <div class="mv-label"><%= mv_t("settings.theme") %></div>
+        <p class="mv-label mv-label--sublabel">
+          <%= mv_t("settings.theme_hint") %>
+        </p>
+        <div class="mv-actions" style="justify-content:flex-start">
+          <% [["auto", mv_t("settings.auto")], ["light", mv_t("settings.light")], ["dark", mv_t("settings.dark")]].each do |value, label| %>
+            <label for="lang-<%= label %>" class="mv-btn mv-btn--secondary mv-btn--sm" style="gap:.4rem;">
+              <input id="lang-<%= label %>" type="radio" name="theme" value="<%= value %>" <%= "checked" if @theme == value %> style="margin:0"/>
+              <span><%= label %></span>
+            </label>
+          <% end %>
+        </div>
+      </div>
+      <br/>
+      <!-- Language -->
+      <div class="mv-field">
+        <label for="locale" class="mv-label"><%= mv_t("settings.language") %></label>
+        <p class="mv-label mv-label--sublabel">
+          <%= mv_t("settings.language_hint") %>
+        </p>
+        <select name="locale" id="locale" class="mv-select">
+          <% @locales.each do |loc| %>
+            <% label = MatViews::Engine.locale_code_mapping[loc.to_sym] %>
+            <option value="<%= loc %>" <%= "selected" if @locale == loc %>>
+              <%= label %>
+            </option>
+          <% end %>
+        </select>
+      </div>
+      <div class="mv-actions">
+        <%= mv_submit_button class: "mv-btn mv-btn--primary mv-btn--md",
+                             testid: 'PREFERENCES_SAVE_BUTTON' do %>
+          <%= mv_t("save_changes") %>
+        <% end %>
+
+        <%= mv_cancel_button variant: :ghost, data: { action: "click->drawer#close" },
+                             class: 'mv-btn mv-btn--ghost mv-btn--md', 
+                             testid: 'PREFERENCES_CANCEL_BUTTON' do %>
+          <%= mv_t("cancel") %>
+        <% end %>
+      </div>
+    <% end %>
+  </div>
+</div>

data/app/views/mat_views/admin/runs/_table.html.erb

@@ -0,0 +1,61 @@
+<% humanize_attr = ->(attr) { MatViews::MatViewRun.human_attribute_name(attr) } %>
+<% humanize_enum_attr = ->(col, val) { MatViews::MatViewRun.human_enum_name(col, val) } %>
+
+<table class="mv-table">
+  <thead>
+    <tr class="mv-tr">
+      <th class="mv-th"><%= humanize_attr.call(:operation) %></th>
+      <th class="mv-th"><%= humanize_attr.call(:mat_view_definition) %></th>
+      <th class="mv-th"><%= humanize_attr.call(:started_at) %></th>
+      <th class="mv-th"><%= humanize_attr.call(:status) %></th>
+      <th class="mv-th"><%= humanize_attr.call(:duration_ms) %></th>
+      <th class="mv-th"><%= humanize_attr.call(:rows_before_after) %></th>
+      <th class="mv-th"><%= humanize_attr.call(:details) %></th>
+    </tr>
+  </thead>
+  <tbody>
+    <% if runs.any? %>
+      <% runs.each do |run| %>
+        <tr class="mv-tr" data-testid="RUN_ROW_<%= run.id %>">
+          <td class="mv-td"><%= humanize_enum_attr.call(:operation, run.operation) %></td>
+          <td class="mv-td">
+            <%= mv_drawer_link(admin_mat_view_definition_path(run.mat_view_definition, frame_id: "mv-drawer"), mv_t("view_var", name: run.mat_view_definition.name),
+                             variant: :ghost,
+                             underline: true,
+                             testid: 'VIEW_LINK',
+                             testid_identifier: "defn-#{run.mat_view_definition.id}",
+                             tooltip: mv_t("mat_view_definition.view_tooltip")) do %>
+              <%= run.mat_view_definition.name %>
+            <% end %>
+          </td>
+          <td class="mv-td"><%= l(run.started_at.in_time_zone, format: :datetime12hour) %></td>
+          <td class="mv-td"><%= mv_badge(run.status, humanize_enum_attr.call(:status, run.status)) %></td>
+          <td class="mv-td"><%= run.duration_ms ? "#{run.duration_ms} ms" : "-" %></td>
+          <td class="mv-td"><%= run.row_count_before || "-" %>/<%= run.row_count_after || "-" %></td>
+          <td class="mv-td">
+            <%= mv_drawer_link(admin_run_path(id: run.id, frame_id: 'mv-drawer'), mv_t('mat_view_run.view_details'),
+                             variant: :ghost,
+                             underline: true,
+                             testid: 'VIEW_LINK',
+                             testid_identifier: "run-#{run.id}",
+                             tooltip: mv_t("mat_view_run.view_tooltip")) do %>
+              <%= mv_t("mat_view_run.view_details") %>
+            <% end %>
+          </td>
+        </tr>
+      <% end %>
+    <% else %>
+      <tr class="mv-tr">
+        <td class="mv-td" colspan="7">
+          <% filter_present = params[:mat_view_definition_id].present? || params[:operation].present? || params[:status].present? %>
+
+          <% if filter_present %>
+            <%= mv_t("mat_view_run.no_runs_if_filtered") %>
+          <% else %>
+            <%= mv_t("mat_view_run.no_runs") %>
+          <% end %>
+        </td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>

data/app/views/mat_views/admin/runs/index.html.erb

@@ -0,0 +1,38 @@
+<% data = { controller: "filter", query_params: %w[mat_view_definition_id operation status].join(","), turbo_frame: @frame_id } %>
+<% humanize_attr = ->(attr) { MatViews::MatViewRun.human_attribute_name(attr) } %>
+<% operation_options = [[mv_t("all_operations"), ""]].concat(MatViews::MatViewRun.human_enum_options(:operation)) %>
+<% status_options = [[mv_t("all_statuses"), ""]].concat(MatViews::MatViewRun.human_enum_options(:status)) %>
+<% definition_options = [[mv_t("all_definitions"), ""]] + @definitions.map { |d| [d.name, d.id] } %>
+<%= form_with url: admin_runs_path, method: :get, data: data, class: "mv-form mv-form--no-pad" do %>
+  <div class="mv-field-inline-row">
+    <div class="mv-field-inline">
+      <%= mv_t("filter_by") %>
+    </div>
+    <div class="mv-field-inline">
+      <%= label_tag :mat_view_definition_id, humanize_attr.call(:mat_view_definition), class: "mv-label" %>
+      <%= select_tag :mat_view_definition_id,
+      options_for_select(definition_options, params[:mat_view_definition_id]),
+      class: "mv-select",
+      data: {
+        action: "change->filter#autoSubmit",
+      } %>
+    </div>
+    <div class="mv-field-inline">
+      <%= label_tag :operation, humanize_attr.call(:operation), class: "mv-label" %>
+      <%= select_tag :operation, options_for_select(operation_options, params[:operation]), class: "mv-select", data: { action: "change->filter#autoSubmit" } %>
+    </div>
+    <div class="mv-field-inline">
+      <%= label_tag :status, humanize_attr.call(:status), class: "mv-label" %>
+      <%= select_tag :status, options_for_select(status_options, params[:status]), class: "mv-select", data: { action: "change->filter#autoSubmit" } %>
+    </div>
+    <div class="mv-field-inline">
+      <%= hidden_field_tag :frame_id, @frame_id %>
+      <%= hidden_field_tag :frame_action, @frame_action %>
+      <%= mv_button_link "#", variant: :ghost, data: { action: "click->filter#reset" }, testid: 'RESET_FILTERS_LINK' do %>
+        <%= mv_icon(:x_circle) %>
+        <%= mv_t("reset") %>
+      <% end %>
+    </div>
+  </div>
+<% end %>
+<%= render "mat_views/admin/runs/table", runs: @runs %>

data/app/views/mat_views/admin/runs/show.html.erb

@@ -0,0 +1,64 @@
+<% humanize_attr = ->(attr) { MatViews::MatViewRun.human_attribute_name(attr) } %>
+<% humanize_enum_attr = ->(col, val) { MatViews::MatViewRun.human_enum_name(col, val) } %>
+<input type="hidden" id="mv-drawer-open-url-identifier" value="runs_view_<%= @run.id %>"/>
+<div class="mv-card">
+  <div class="mv-card-b">
+    <div class="mv-field">
+      <div class="mv-label"><%= mv_t("definition") %></div>
+      <div>
+        <%= mv_drawer_link(admin_mat_view_definition_path(@run.mat_view_definition, frame_id: "mv-drawer"), mv_t("view_var", name: @run.mat_view_definition.name),
+                           variant: :ghost,
+                           underline: true,
+                           tooltip: mv_t("mat_view_definition.view_tooltip")) do %>
+          <%= @run.mat_view_definition.name %>
+        <% end %>
+      </div>
+    </div>
+    <div class="mv-field">
+      <div class="mv-label"><%= humanize_attr.call(:operation) %></div>
+      <div><%= humanize_enum_attr.call(:operation, @run.operation) %></div>
+    </div>
+    <div class="mv-field">
+      <div class="mv-label"><%= humanize_attr.call(:started_at) %></div>
+      <div><%= l(@run.started_at.in_time_zone, format: :datetime12hour) %></div>
+    </div>
+    <div class="mv-field">
+      <div class="mv-label"><%= humanize_attr.call(:finished_at) %></div>
+      <div><%= l(@run.finished_at&.in_time_zone, format: :datetime12hour) || "-" %></div>
+    </div>
+    <div class="mv-field">
+      <div class="mv-label"><%= humanize_attr.call(:status) %></div>
+      <div><%= mv_badge(@run.status, humanize_enum_attr.call(:status, @run.status)) %></div>
+    </div>
+    <div class="mv-field">
+      <div class="mv-label"><%= humanize_attr.call(:duration_ms) %></div>
+      <div><%= @run.duration_ms ? "#{@run.duration_ms} ms" : "-" %></div>
+    </div>
+    <div class="mv-field">
+      <div class="mv-label"><%= humanize_attr.call(:row_count_before) %></div>
+      <div><%= @run.row_count_before || "-" %></div>
+    </div>
+    <div class="mv-field">
+      <div class="mv-label"><%= humanize_attr.call(:row_count_after) %></div>
+      <div><%= @run.row_count_after || "-" %></div>
+    </div>
+
+    <div class="mv-field">
+      <%= render "mat_views/admin/ui/details",
+                 tooltip_text: mv_t("mat_view_run.meta_tooltip"),
+                 title: content_tag(:div, humanize_attr.call(:meta), class: "mv-label") do %>
+        <pre><%= JSON.pretty_generate(@run.meta || {}).strip -%></pre>
+      <% end %>
+    </div>
+
+    <% if @run.try(:error).present? %>
+      <div class="mv-field">
+        <%= render "mat_views/admin/ui/details",
+                   tooltip_text: mv_t("mat_view_run.error_tooltip"),
+                   title: content_tag(:div, humanize_attr.call(:error), class: "mv-label") do %>
+          <pre><%= JSON.pretty_generate(@run.error || {}).strip -%></pre>
+        <% end %>
+      </div>
+    <% end %>
+  </div>
+</div>

data/app/views/mat_views/admin/ui/_card.html.erb

@@ -0,0 +1,15 @@
+<% body = capture { yield } %>
+<div class="mv-card">
+  <% if content_for?(:title) %>
+    <div class="mv-card-h">
+      <%= yield :title %>
+    </div>
+  <% end %>
+
+  <div class="mv-card-b"><%= body %></div>
+  <% if content_for?(:footer) %>
+    <div class="mv-card-f">
+      <%= yield :footer %>
+    </div>
+  <% end %>
+</div>

data/app/views/mat_views/admin/ui/_details.html.erb

@@ -0,0 +1,10 @@
+<% body = capture { yield } %>
+<details data-controller="details" data-details-duration-value="200" class="mv-details"
+         open>
+  <summary data-action="click->details#toggle" data-controller="tooltip" data-tooltip-text-value="<%= tooltip_text %>">
+    <%= mv_icon(:arrow_right, class_name: "mv-chevron") %>
+    <%= title %>
+  </summary>
+
+  <div data-details-target="content" class="mv-details__content"><%= body -%></div>
+</details>

data/app/views/mat_views/admin/ui/_flash.html.erb

@@ -0,0 +1,6 @@
+<% if notice %>
+  <div class="mv-flash mv-flash--ok" data-controller="flash"><%= notice %></div>
+<% end %>
+<% if alert %>
+  <div class="mv-flash mv-flash--err" data-controller="flash"><%= alert %></div>
+<% end %>

data/app/views/mat_views/admin/ui/_table.html.erb

@@ -0,0 +1,8 @@
+<table class="mv-table">
+  <% if local_assigns[:head].present? %>
+    <thead>
+    <tr class="mv-tr"><%= head %></tr>
+    </thead>
+  <% end %>
+  <tbody><%= yield %></tbody>
+</table>

data/config/importmap.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+enable_integrity!
+pin 'mat_views/application'
+pin '@hotwired/turbo-rails',                  to: 'turbo.min.js'
+pin '@hotwired/stimulus',                     to: 'stimulus.min.js'
+pin '@hotwired/stimulus-loading',             to: 'stimulus-loading.js'
+
+pin_all_from MatViews::Engine.root.join('app/javascript/mat_views/controllers'), under: 'mat_views/controllers'

data/config/locales/en-AU-ocker.yml

@@ -0,0 +1,187 @@
+en-AU-ocker:
+  activerecord:
+    attributes:
+      mat_views/mat_view_definition:
+        created_at: "Cooked up at"
+        dependencies: "Mates it leans on"
+        name: "Name"
+        refresh_strategy: "Refresh trick"
+        schedule_cron: "Roster (cron)"
+        sql: "SQL (SELECT ...)"
+        unique_index_columns: "Unique index columns"
+        updated_at: "Spruced up at"
+      mat_views/mat_view_run:
+        created_at: "Cooked up at"
+        details: "The nitty-gritty"
+        duration_ms: "How long (ms)"
+        error: "Stuff-up"
+        finished_at: "Wrapped up at"
+        mat_view_definition: "Definition"
+        meta: "Extra bits"
+        operation: "What we did"
+        row_count_after: "Row count after"
+        row_count_before: "Row count before"
+        rows_before_after: "Rows (before/after)"
+        started_at: "Kicked off at"
+        status: "Status"
+        updated_at: "Spruced up at"
+    enums:
+      mat_views/mat_view_definition:
+        refresh_strategy:
+          concurrent: "All at once"
+          regular: "The usual"
+          swap: "Quick swap"
+      mat_views/mat_view_run:
+        operation:
+          create: "Spin up"
+          drop: "Chuck out"
+          refresh: "Give it a tickle"
+        status:
+          failed: "Gone bung"
+          running: "Flat out"
+          success: "All good"
+    errors:
+      models:
+        mat_views/mat_view_definition:
+          attributes:
+            name:
+              blank: "ya gotta give it a name"
+              invalid: "nah mate, that's not a fair dinkum PostgreSQL name"
+              taken: "someone's already nabbed that"
+            sql:
+              blank: "chuck in some SQL, mate"
+              invalid: "has to start with SELECT, no muckin' about"
+            unique_index_columns:
+              at_least_one: "need at least one column when usin' the concurrent trick"
+    hints:
+      mat_views/mat_view_definition:
+        dependencies: "List the tables or views it leans on, comma separated."
+        name: "What we call the materialised view in the DB."
+        refresh_strategy: "How you wanna give it a tickle."
+        schedule_cron: "Use cron format. Leave it blank if ya can't be bothered."
+        sql: "Has to be a proper SELECT statement."
+        unique_index_columns: "Columns for a unique index. Needed for the all-at-once trick."
+      mat_views/mat_view_run:
+        error: "Stuff-up if it went bung."
+        meta: "Extra bits in JSON."
+        operation: "What sort of job we ran."
+        status: "Where it's at."
+    models:
+      mat_views/mat_view_definition: "Mat View Def'n"
+      mat_views/mat_view_run: "Mat View Run"
+    placeholders:
+      mat_views/mat_view_definition:
+        dependencies: "Chuck in dependencies (comma separated, optional)"
+        name: "Give it a name, mate"
+        refresh_strategy: "Pick how to refresh"
+        schedule_cron: "0 0 * * * for midnight daily, leave blank otherwise"
+        sql: "Type in ya SQL (SELECT ...)"
+        unique_index_columns: "Unique index columns (comma separated, optional)"
+      mat_views/mat_view_run:
+        error: "Error msg"
+        mat_view_definition: "Pick a mat view"
+        meta: "Extra bits (JSON)"
+        operation: "Pick what to do"
+        status: "Pick a status"
+  i18n:
+    name: Aussie (Ocker)
+  mat_views:
+    actions: "Stuff ya can do"
+    all_definitions: "Every def'n"
+    all_operations: "Every job"
+    all_statuses: "Every status"
+    cancel: "Nah, cancel"
+    close: "Shut it"
+    close_window: "Shut the window"
+    create: "Knock one up"
+    dashboard:
+      metrics:
+        title: "Stats & that"
+      title: "Dashy board"
+    definition: "Def'n"
+    definitions: "Def'ns"
+    delete: "Chuck it"
+    details: "The nitty-gritty"
+    edit: "Tweak it"
+    edit_var: "Tweak %{name}"
+    errors:
+      frame_only: "Oi, only works in a frame. Back to the dashy board."
+      prevented_saving:
+        one: "1 stuff-up stopped savin':"
+        other: "%{count} stuff-ups stopped savin':"
+    filter_by: "Filter by:"
+    footer:
+      copyright: "© %{year} %{company} — all rights, mate."
+      documentation: "The manual"
+      need_help: "Need a hand, cobber?"
+      open_issue: "Yell out (open issue)"
+      project_homepage: "Project home"
+      support: "Fair dinkum support →"
+      tagline: "Built with ❤️ by battlers, for battlers."
+      tooltip:
+        documentation: "Have a squiz at the docs"
+        gem_version: "Hop over to RubyGems"
+        open_issue: "Report a bug or ask for somethin'"
+        project_homepage: "Check the repo"
+        support: "Paid help if ya keen"
+      version: "v%{version}"
+    header:
+      signed_in_as: "Signed in as %{email}"
+    history: "Back story"
+    loading: "Hang on..."
+    loading_definitions: "Grabbin' the defs..."
+    loading_runs: "Grabbin' the runs..."
+    mat_view_definition:
+      create_mv: "Spin up MV"
+      create_mv_tooltip: "Makes the MV in the DB."
+      delete_confirm: "Sure ya wanna chuck %{name}? (Does NOT drop MV)"
+      delete_tooltip: "Deletes the def'n but leaves the MV."
+      drop_mv: "Drop MV"
+      drop_mv_cascade: "Drop MV (Cascade)"
+      drop_mv_cascade_confirm: "Drop the MV and all the tag-alongs for %{name}?"
+      drop_mv_cascade_tooltip: "Drops MV + mates, but keeps def'n."
+      drop_mv_confirm: "Drop the MV for %{name}?"
+      drop_mv_tooltip: "Drops the MV but keeps def'n."
+      edit_tooltip: "Tweak the mat view def'n."
+      materialized_view: "Mat View"
+      materialized_view_exists: "Mat view's there"
+      materialized_view_not_exists: "Mat view's not made yet!"
+      new_definition: "New def'n"
+      new_definition_tooltip: "Knock up a new mat view def'n."
+      no_definitions: "No defs found. Knock one up to start."
+      refresh_tooltip: "Give the mat view a tickle."
+      sql_summary_tooltip: "Click to open/close SQL"
+      view_tooltip: "See the mat view def'n."
+    mat_view_run:
+      error_tooltip: "Error if it went bung."
+      meta_tooltip: "Extra bits in JSON."
+      no_runs: "No runs yet."
+      no_runs_if_filtered: "No runs for that filter."
+      view_details: "See the deets"
+      view_tooltip: "See the run deets."
+    project_author: "Codevedas Inc."
+    project_description: "Admin UI for bossin' around Postgres mat views in Rails apps."
+    project_tags: "rails, ruby, mat views, admin, dashy, ui, managing stuff"
+    refresh: "Give it a tickle"
+    refresh_contents: "Tickle contents"
+    reloading: "Reloadin'..."
+    reset: "Start over"
+    run: "Run"
+    runs: "Runs"
+    save_changes: "Save it"
+    settings:
+      auto: "Auto"
+      dark: "Dark"
+      language: "Lingo"
+      language_hint: "Pick ya lingo for the UI."
+      light: "Light"
+      theme: "Theme"
+      theme_hint: "Auto follows system, light/dark overrides."
+      title: "Prefs"
+    title: "MatViews Admin"
+    view_var: "See %{name}"
+  time:
+    am: "AM"
+    formats:
+      datetime12hour: "%Y-%m-%d %I:%M:%S %p"
+    pm: "PM"