dash_kit 2.0.0

data/app/controllers/dash_kit/widgets_controller.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module DashKit
+  class WidgetsController < DashKit.parent_controller.constantize
+    def show
+      widget_key = params[:id].to_sym
+      widget_def = find_widget_definition(widget_key)
+
+      if widget_def.nil?
+        head :not_found
+      else
+        render partial: widget_def[:partial], layout: false, locals: { filter_state: filter_state }
+      end
+    end
+
+    private
+
+    def filter_state
+      dashboard = dashboard_scope.find_by(id: params[:dashboard_id])
+      dashboard ? dashboard.filter_state : {}
+    end
+
+    def dashboard_scope
+      if DashKit.current_owner_method
+        DashKit::Dashboard.for_owner(send(DashKit.current_owner_method))
+      else
+        DashKit::Dashboard
+      end
+    end
+
+    def find_widget_definition(key)
+      DashKit.registry.dashboard_types.each do |type|
+        widgets = DashKit.registry.widgets_for(type)
+        return widgets[key] if widgets.key?(key)
+      end
+      nil
+    end
+  end
+end

data/app/helpers/dash_kit/application_helper.rb

@@ -0,0 +1,4 @@
+module DashKit
+  module ApplicationHelper
+  end
+end

data/app/helpers/dash_kit/dashboard_helper.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+require "ks_blocks/layout_helper"
+require "ks_blocks/content_helper"
+require "keystone_ui/react/mount_helper"
+
+module DashKit
+  module DashboardHelper
+    include KsBlocks::LayoutHelper
+    include KsBlocks::ContentHelper
+    include KeystoneUi::React::MountHelper
+
+    def dash_kit_viewable?(config)
+      DashKit.viewable?(config, dash_kit_current_viewer)
+    end
+
+    def dash_kit_editable?(config)
+      DashKit.editable?(config, dash_kit_current_viewer)
+    end
+
+    def dash_kit_shareable?(config)
+      DashKit.shareable?(config, dash_kit_current_viewer)
+    end
+
+    def dash_kit_current_viewer
+      method = DashKit.current_viewer_method || DashKit.current_owner_method
+      method && controller.send(method)
+    end
+
+    def dash_kit_available_sources
+      DashKit.available_sources(dash_kit_current_viewer)
+    end
+
+    def dash_kit_visualizations
+      DashKit.visualizations
+    end
+
+    def dash_kit_widget_label(config, widget_key)
+      config.available_widgets.dig(widget_key.to_sym, :label) || widget_key.to_s.humanize
+    end
+
+    def dash_kit_render_widgets(config:)
+      return content_tag(:div, "", id: "dashboard-widgets") unless config
+
+      content_tag(:div, id: dash_kit_widgets_id(config)) do
+        dash_kit_arrangeable?(config) ? dash_kit_widget_grid(config) : dash_kit_drawn_widgets(config)
+      end
+    end
+
+    def dash_kit_widgets_id(config)
+      "dashboard-widgets-#{config.id}"
+    end
+
+    def dash_kit_arrangeable?(config)
+      DashKit.editable?(config, dash_kit_current_viewer)
+    end
+
+    def dash_kit_widget_grid(config)
+      safe_join([
+        react_ui("dash_kit/dashboard-grid", config.layout_data.merge(base: dash_kit.dashboard_path(config), token: dash_kit_form_token)),
+        block_contents(config.blocks) { |block| dash_kit_block_frame(config, block) }
+      ])
+    end
+
+    def dash_kit_form_token
+      controller.respond_to?(:form_authenticity_token) ? controller.send(:form_authenticity_token) : nil
+    end
+
+    def dash_kit_drawn_widgets(config)
+      block_layout(config.blocks, kind: config.dashboard_type.to_sym) do |block|
+        dash_kit_block_frame(config, block)
+      end
+    end
+
+    def dash_kit_block_frame(config, block)
+      return dash_kit_widget_frame(block["type"], dashboard_id: config.id) unless block["type"] == WidgetRegistry::BUILT_WIDGET.to_s
+
+      dash_kit_widget_definition_frame(config.widget_definitions.find(block.dig("content", "definition_id")))
+    end
+
+    def dash_kit_widget_frame(widget_key, dashboard_id: nil, &block)
+      dash_kit_turbo_frame(
+        id: "widget_#{widget_key}",
+        src: dash_kit.widget_path(widget_key, dashboard_id: dashboard_id),
+        &block
+      )
+    end
+
+    def dash_kit_widget_definition_frame(definition, &block)
+      dash_kit_turbo_frame(
+        id: "widget_definition_#{definition.id}",
+        src: dash_kit.widget_definition_path(definition, dashboard_id: definition.dashboard_id),
+        &block
+      )
+    end
+
+    def dash_kit_turbo_frame(id:, src:, &block)
+      loading_content = block ? capture(&block) : dash_kit_loading_skeleton
+
+      content_tag("turbo-frame", loading_content, id: id, src: src, loading: "lazy", target: "_top", style: "display: block")
+    end
+
+    def dash_kit_filter_select(config:, key:, options:)
+      form_tag dash_kit.save_filters_dashboard_path(config), method: :post do
+        safe_join([
+          hidden_field_tag("filter_key", key),
+          select_tag("filter_value", options_for_select(options, config.filter_state[key.to_s]),
+            onchange: "this.form.requestSubmit()")
+        ])
+      end
+    end
+
+    def dash_kit_loading_skeleton
+      content_tag(:div, class: "rounded-xl bg-white dark:bg-zinc-800 shadow p-4") do
+        content_tag(:div, class: "animate-pulse") do
+          safe_join([
+            content_tag(:div, "", class: "h-5 bg-gray-200 dark:bg-zinc-700 rounded w-1/3 mb-4"),
+            content_tag(:div, class: "space-y-3") do
+              safe_join([
+                content_tag(:div, "", class: "h-4 bg-gray-200 dark:bg-zinc-700 rounded w-full"),
+                content_tag(:div, "", class: "h-4 bg-gray-200 dark:bg-zinc-700 rounded w-5/6"),
+                content_tag(:div, "", class: "h-4 bg-gray-200 dark:bg-zinc-700 rounded w-4/6")
+              ])
+            end
+          ])
+        end
+      end
+    end
+  end
+end

data/app/javascript/dash_kit/dashboard_grid.jsx

@@ -0,0 +1,10 @@
+import { createRoot } from "react-dom/client"
+import "react-grid-layout/css/styles.css"
+import "keystone_ui-blocks/src/block_grid.css"
+import BlockGrid from "keystone_ui-blocks/src/BlockGrid.jsx"
+import { register } from "keystone_ui-react/src/registry.js"
+import { startMounting } from "keystone_ui-react/src/mounting.js"
+
+register("dash_kit/dashboard-grid", BlockGrid)
+
+startMounting(document, createRoot)

data/app/models/concerns/dash_kit/widget_management.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module DashKit
+  module WidgetManagement
+    extend ActiveSupport::Concern
+
+    def available_widgets
+      DashKit.registry.widgets_for(dashboard_type.to_sym)
+    end
+
+    def update_filter(key, value)
+      self.filter_state = filter_state.merge(key.to_s => value)
+      save!
+    end
+  end
+end

data/app/models/dash_kit/application_record.rb

@@ -0,0 +1,5 @@
+module DashKit
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/dash_kit/dashboard.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require "ks_blocks/layout"
+
+module DashKit
+  class Dashboard < ApplicationRecord
+    include WidgetManagement
+    include KsBlocks::Layout
+
+    self.table_name = "dash_kit_dashboards"
+
+    block_layout :blocks, kind: :blocks
+
+    def block_layout_kind
+      dashboard_type.to_sym
+    end
+
+    def add_built_widget(definition, x: nil, y: nil)
+      built = KsBlocks.registry.block_types(kind: block_layout_kind).find { |type| type.key == WidgetRegistry::BUILT_WIDGET }
+      add_block(built, x: x, y: y)
+      fill_block(blocks.last["id"], { "definition_id" => definition.id })
+    end
+
+    VISIBILITIES = %w[private account].freeze
+
+    belongs_to :owner, polymorphic: true
+    belongs_to :account, optional: true
+
+    has_many :widget_definitions, -> { order(:id) }, dependent: :destroy
+
+    validates :name, presence: true
+    validates :dashboard_type, presence: true
+    validates :visibility, inclusion: { in: VISIBILITIES }
+
+    scope :for_account, ->(account) { where(account: account) }
+    scope :for_owner, ->(owner) { where(owner: owner) }
+
+    def activate!
+      transaction do
+        self.class.for_owner(owner).where.not(id: id).update_all(active: false)
+        update!(active: true)
+      end
+    end
+
+    def duplicate!
+      copy = dup
+      copy.name = "#{name} (copy)"
+      copy.active = false
+      copy.save!
+      copy
+    end
+  end
+end

data/app/models/dash_kit/widget_definition.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module DashKit
+  class WidgetDefinition < ApplicationRecord
+    self.table_name = "dash_kit_widget_definitions"
+
+    belongs_to :dashboard
+  end
+end

data/app/views/dash_kit/dashboards/_widgets.html.erb

@@ -0,0 +1 @@
+<%= dash_kit_render_widgets(config: config) %>

data/app/views/dash_kit/dashboards/edit.html.erb

@@ -0,0 +1,21 @@
+<div class="mx-auto max-w-md px-4 py-6">
+  <h1 class="text-xl font-semibold text-gray-900 dark:text-white mb-4">Rename dashboard</h1>
+
+  <%= form_with url: dash_kit.dashboard_path(@dashboard), scope: :dashboard, method: :patch do |form| %>
+    <div class="space-y-4">
+      <div>
+        <%= form.label :name, class: "block text-sm font-medium text-gray-900 dark:text-white mb-1" %>
+        <%= form.text_field :name,
+              value: @dashboard.name,
+              class: "block w-full rounded-lg border border-gray-300 dark:border-zinc-700 bg-white dark:bg-zinc-800 px-3 py-2 text-sm text-gray-900 dark:text-white" %>
+      </div>
+
+      <div class="flex items-center gap-3">
+        <%= form.submit "Save",
+              class: "rounded-md bg-accent-600 px-4 py-2 text-sm font-semibold text-white shadow-sm hover:bg-accent-500" %>
+        <%= link_to "Cancel", dash_kit.dashboards_path,
+              class: "text-sm font-medium text-gray-500 dark:text-gray-400 hover:text-gray-700" %>
+      </div>
+    </div>
+  <% end %>
+</div>

data/app/views/dash_kit/dashboards/index.html.erb

@@ -0,0 +1,34 @@
+<div class="mx-auto max-w-3xl px-4 py-6">
+  <div class="flex items-center justify-between mb-4">
+    <h1 class="text-xl font-semibold text-gray-900 dark:text-white">Dashboards</h1>
+    <%= link_to "New dashboard", dash_kit.new_dashboard_path,
+          class: "rounded-md bg-accent-600 px-3 py-2 text-sm font-semibold text-white shadow-sm hover:bg-accent-500" %>
+  </div>
+
+  <% if @dashboards.any? %>
+    <ul class="space-y-2">
+      <% @dashboards.each do |dashboard| %>
+        <li class="flex items-center justify-between p-3 rounded-lg border border-gray-200 dark:border-zinc-700 bg-white dark:bg-zinc-800">
+          <span class="text-sm font-medium text-gray-900 dark:text-white"><%= dashboard.name %></span>
+          <div class="flex items-center gap-3">
+            <%= link_to "Rename", dash_kit.edit_dashboard_path(dashboard),
+                  class: "text-xs font-semibold text-gray-500 dark:text-gray-400 hover:text-gray-700" %>
+            <%= button_to "Duplicate", dash_kit.duplicate_dashboard_path(dashboard),
+                  class: "text-xs font-semibold text-gray-500 dark:text-gray-400 hover:text-gray-700" %>
+            <%= button_to "Delete", dash_kit.dashboard_path(dashboard), method: :delete,
+                  form: { data: { turbo_confirm: "Delete this dashboard?" } },
+                  class: "text-xs font-semibold text-red-600 dark:text-red-400 hover:text-red-700" %>
+            <% if dashboard.active? %>
+              <span class="text-xs font-semibold text-accent-600 dark:text-accent-400">Active</span>
+            <% else %>
+              <%= button_to "Select", dash_kit.select_dashboard_path(dashboard),
+                    class: "rounded-md border border-gray-300 dark:border-zinc-700 px-3 py-1 text-xs font-semibold text-gray-900 dark:text-white hover:bg-gray-50 dark:hover:bg-zinc-700" %>
+            <% end %>
+          </div>
+        </li>
+      <% end %>
+    </ul>
+  <% else %>
+    <p class="text-sm text-gray-500 dark:text-gray-400">No dashboards yet.</p>
+  <% end %>
+</div>

data/app/views/dash_kit/dashboards/new.html.erb

@@ -0,0 +1,28 @@
+<div class="mx-auto max-w-md px-4 py-6">
+  <h1 class="text-xl font-semibold text-gray-900 dark:text-white mb-4">New dashboard</h1>
+
+  <%= form_with url: dash_kit.dashboards_path, scope: :dashboard, method: :post do |form| %>
+    <div class="space-y-4">
+      <div>
+        <%= form.label :name, class: "block text-sm font-medium text-gray-900 dark:text-white mb-1" %>
+        <%= form.text_field :name,
+              value: @dashboard.name,
+              class: "block w-full rounded-lg border border-gray-300 dark:border-zinc-700 bg-white dark:bg-zinc-800 px-3 py-2 text-sm text-gray-900 dark:text-white" %>
+      </div>
+
+      <div>
+        <%= form.label :dashboard_type, "Type", class: "block text-sm font-medium text-gray-900 dark:text-white mb-1" %>
+        <%= form.text_field :dashboard_type,
+              value: @dashboard.dashboard_type,
+              class: "block w-full rounded-lg border border-gray-300 dark:border-zinc-700 bg-white dark:bg-zinc-800 px-3 py-2 text-sm text-gray-900 dark:text-white" %>
+      </div>
+
+      <div class="flex items-center gap-3">
+        <%= form.submit "Create",
+              class: "rounded-md bg-accent-600 px-4 py-2 text-sm font-semibold text-white shadow-sm hover:bg-accent-500" %>
+        <%= link_to "Cancel", dash_kit.dashboards_path,
+              class: "text-sm font-medium text-gray-500 dark:text-gray-400 hover:text-gray-700" %>
+      </div>
+    </div>
+  <% end %>
+</div>

data/app/views/dash_kit/widget_definitions/_missing_renderer.html.erb

@@ -0,0 +1,3 @@
+<%= ui_panel do %>
+  This widget can't be displayed.
+<% end %>

data/app/views/layouts/dash_kit/application.html.erb

@@ -0,0 +1,17 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dash kit</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= yield :head %>
+
+  <%= stylesheet_link_tag    "dash_kit/application", media: "all" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/importmap.rb

@@ -0,0 +1 @@
+pin "dash_kit/index", to: "dash_kit/index.js"

data/config/routes.rb

@@ -0,0 +1,16 @@
+DashKit::Engine.routes.draw do
+  resources :widgets, only: [ :show ]
+  resources :widget_definitions, only: [ :show ]
+
+  resources :dashboards, only: [ :index, :new, :create, :edit, :update, :destroy ] do
+    member do
+      post :select
+      post :duplicate
+      post :save_filters
+      patch "blocks", to: "dashboards#place_blocks", as: :blocks
+      post :create_definition
+      post :update_definition
+      post :destroy_definition
+    end
+  end
+end

data/lib/dash_kit/configuration_backfill.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module DashKit
+  module ConfigurationBackfill
+    class LegacyConfiguration < ActiveRecord::Base
+      self.table_name = "dash_kit_configurations"
+    end
+
+    def self.run
+      return unless LegacyConfiguration.table_exists?
+
+      LegacyConfiguration.find_each do |config|
+        Dashboard.find_or_create_by!(
+          owner_type: config.owner_type,
+          owner_id: config.owner_id,
+          dashboard_type: config.dashboard_type,
+          name: config.dashboard_type.to_s.humanize
+        ) do |dashboard|
+          dashboard.widget_order = config.widget_order
+          dashboard.hidden_widgets = config.hidden_widgets
+          dashboard.filter_state = config.filter_state
+          dashboard.widget_settings = config.widget_settings
+        end
+      end
+    end
+  end
+end

data/lib/dash_kit/engine.rb

@@ -0,0 +1,19 @@
+module DashKit
+  class Engine < ::Rails::Engine
+    isolate_namespace DashKit
+
+    initializer "dash_kit.tailwind" do
+      next unless Gem.loaded_specs.key?("keystone_ui")
+
+      require "keystone_ui"
+      KeystoneUi.configuration.tailwind_sources << root.join("app/views/**/*.erb").to_s
+      KeystoneUi.configuration.tailwind_sources << root.join("app/assets/builds/dash_kit/*.js").to_s
+    end
+
+    initializer "dash_kit.importmap", before: "importmap" do |app|
+      if app.config.respond_to?(:importmap)
+        app.config.importmap.paths << root.join("config/importmap.rb")
+      end
+    end
+  end
+end