dash_kit 2.0.0

data/lib/dash_kit/widget_registry.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module DashKit
+  class WidgetRegistry
+    BUILT_WIDGET = :built_widget
+    FULL_WIDTH = 12
+    ROWS = 4
+
+    def initialize
+      @dashboards = {}
+    end
+
+    def register(dashboard_type, &block)
+      builder = DashboardBuilder.new
+      block.call(builder)
+      @dashboards[dashboard_type.to_sym] = builder.widgets.freeze
+      register_block_types(dashboard_type)
+    end
+
+    def widgets_for(dashboard_type)
+      @dashboards.fetch(dashboard_type.to_sym)
+    end
+
+    def default_widget_order(dashboard_type)
+      widgets_for(dashboard_type)
+        .sort_by { |_, v| v[:position] }
+        .map { |k, _| k.to_s }
+    end
+
+    def widget_label(dashboard_type, widget_key)
+      widgets_for(dashboard_type).dig(widget_key.to_sym, :label)
+    end
+
+    def widget_partial(dashboard_type, widget_key)
+      widgets_for(dashboard_type).dig(widget_key.to_sym, :partial)
+    end
+
+    def dashboard_types
+      @dashboards.keys
+    end
+
+    private
+
+    def register_block_types(dashboard_type)
+      KsBlocks.block(BUILT_WIDGET, name: "Built widget", kind: dashboard_type.to_sym, width: FULL_WIDTH, height: ROWS, narrow_width: FULL_WIDTH, narrow_height: ROWS)
+
+      widgets_for(dashboard_type).each do |key, widget|
+        KsBlocks.block(key, name: widget[:label], kind: dashboard_type.to_sym,
+                       width: widget.fetch(:width, FULL_WIDTH), height: widget.fetch(:height, ROWS),
+                       narrow_width: widget[:narrow_width], narrow_height: widget[:narrow_height],
+                       once: true, resizable: false)
+      end
+    end
+  end
+
+  class DashboardBuilder
+    attr_reader :widgets
+
+    def initialize
+      @widgets = {}
+      @position = 0
+    end
+
+    def widget(key, label:, partial:, **options)
+      @position += 1
+      @widgets[key.to_sym] = { label: label, partial: partial, position: @position }.merge(options)
+    end
+  end
+end

data/lib/dash_kit.rb

@@ -0,0 +1,72 @@
+require "keystone_ui-blocks"
+require "dash_kit/version"
+require "dash_kit/widget_registry"
+require "dash_kit/renderer_registry"
+require "dash_kit/configuration_backfill"
+
+module DashKit
+  class Error < StandardError; end
+
+  mattr_accessor :parent_controller, default: "DashKit::ApplicationController"
+  mattr_accessor :current_owner_method, default: nil
+  mattr_accessor :current_viewer_method, default: nil
+
+  OWNER_EQUALITY = ->(dashboard, viewer) { dashboard.owner == viewer }
+  NO_SOURCES = ->(_viewer) { [] }
+
+  mattr_accessor :viewable_by, default: OWNER_EQUALITY
+  mattr_accessor :editable_by, default: OWNER_EQUALITY
+  mattr_accessor :shareable_by, default: OWNER_EQUALITY
+  mattr_accessor :available_sources_for, default: NO_SOURCES
+
+  def self.available_sources(viewer)
+    available_sources_for.call(viewer)
+  end
+
+  def self.viewable?(dashboard, viewer)
+    viewable_by.call(dashboard, viewer)
+  end
+
+  def self.editable?(dashboard, viewer)
+    editable_by.call(dashboard, viewer)
+  end
+
+  def self.shareable?(dashboard, viewer)
+    shareable_by.call(dashboard, viewer)
+  end
+
+  def self.registry
+    @registry ||= WidgetRegistry.new
+  end
+
+  def self.configure
+    yield registry
+  end
+
+  def self.reset_registry!
+    @registry = WidgetRegistry.new
+  end
+
+  def self.renderers
+    @renderers ||= RendererRegistry.new
+  end
+
+  def self.register_renderer(visualization, partial:)
+    renderers.register(visualization, partial: partial)
+  end
+
+  def self.renderer_for(visualization)
+    renderers.renderer_for(visualization)
+  end
+
+  def self.visualizations
+    renderers.visualizations
+  end
+
+  def self.reset_renderers!
+    @renderers = RendererRegistry.new
+  end
+end
+
+require "dash_kit/engine" if defined?(Rails::Engine)
+require "dash_kit/the_local"

data/lib/generators/dash_kit/install_generator.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+require "rails/generators/active_record"
+
+module DashKit
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include ActiveRecord::Generators::Migration
+
+      source_root File.expand_path("templates", __dir__)
+
+      desc "Install DashKit dashboard engine"
+
+      def copy_migration
+        migration_template "create_dash_kit_dashboards.rb.tt", "db/migrate/create_dash_kit_dashboards.rb"
+      end
+
+      def copy_widget_definitions_migration
+        migration_template "create_dash_kit_widget_definitions.rb.tt", "db/migrate/create_dash_kit_widget_definitions.rb"
+      end
+
+      def copy_initializer
+        template "dash_kit.rb.tt", "config/initializers/dash_kit.rb"
+      end
+
+      def mount_engine
+        route 'mount DashKit::Engine => "/dash_kit"'
+      end
+
+      IMPORTMAP_PATH = "config/importmap.rb"
+      STIMULUS_INDEX_PATH = "app/javascript/controllers/index.js"
+
+      def register_dash_kit_controllers
+        return unless host_file?(STIMULUS_INDEX_PATH)
+        return if host_file_includes?(STIMULUS_INDEX_PATH, "registerDashKitControllers")
+
+        append_to_file STIMULUS_INDEX_PATH, <<~JS
+
+          import { registerControllers as registerDashKitControllers } from "dash_kit/index"
+          registerDashKitControllers(application)
+        JS
+      end
+
+      def print_instructions
+        say ""
+        say "DashKit installed successfully!", :green
+        say ""
+        say "Registered DashKit's Stimulus controllers for you", :green
+        say "(where app/javascript/controllers/index.js exists)."
+        say ""
+        say "Next steps:", :yellow
+        say ""
+        say "  1. Run migrations:"
+        say "       rails db:migrate"
+        say ""
+        say "  2. Add the association to your owner model (e.g. Account):"
+        say "       has_many :dash_kit_dashboards, class_name: \"DashKit::Dashboard\","
+        say "                as: :owner, dependent: :destroy"
+        say ""
+        say "  3. Configure parent_controller and current_owner_method in"
+        say "     config/initializers/dash_kit.rb"
+        say ""
+        say "  4. Register your dashboards and widgets in the initializer"
+        say ""
+      end
+
+      private
+
+      def host_file?(path)
+        File.exist?(File.expand_path(path, destination_root))
+      end
+
+      def host_file_includes?(path, snippet)
+        File.read(File.expand_path(path, destination_root)).include?(snippet)
+      end
+    end
+  end
+end

data/lib/generators/dash_kit/templates/create_dash_kit_dashboards.rb.tt

@@ -0,0 +1,20 @@
+class CreateDashKitDashboards < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
+  def change
+    create_table :dash_kit_dashboards do |t|
+      t.references :owner, polymorphic: true, null: false
+      t.bigint :account_id
+      t.string :name
+      t.string :dashboard_type, null: false
+      t.jsonb :blocks, default: []
+      t.jsonb :widget_settings, default: {}
+      t.jsonb :filter_state, default: {}
+      t.string :visibility, null: false, default: "private"
+      t.string :role_default_for
+      t.boolean :active, null: false, default: false
+
+      t.timestamps
+    end
+
+    add_index :dash_kit_dashboards, :account_id
+  end
+end

data/lib/generators/dash_kit/templates/create_dash_kit_widget_definitions.rb.tt

@@ -0,0 +1,12 @@
+class CreateDashKitWidgetDefinitions < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
+  def change
+    create_table :dash_kit_widget_definitions do |t|
+      t.references :dashboard, null: false, foreign_key: { to_table: :dash_kit_dashboards }
+      t.string :source
+      t.string :visualization
+      t.jsonb :options, default: {}
+
+      t.timestamps
+    end
+  end
+end

data/lib/generators/dash_kit/templates/dash_kit.rb.tt

@@ -0,0 +1,16 @@
+# Set the parent controller for DashKit's controllers to inherit from.
+# This gives DashKit access to authentication and helper methods.
+DashKit.parent_controller = "ApplicationController"
+
+# Set the method DashKit uses to find the current owner (e.g. account or user).
+# This scopes dashboard configurations to the correct owner.
+DashKit.current_owner_method = :current_account
+
+DashKit.configure do |config|
+  # Register your dashboards and widgets here.
+  #
+  # config.register(:home) do |d|
+  #   d.widget :on_deck,  label: "On Deck",  partial: "widgets/home/on_deck"
+  #   d.widget :tasks,    label: "Tasks",     partial: "widgets/home/tasks"
+  # end
+end

data/lib/tasks/dash_kit_tasks.rake

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+namespace :dash_kit do
+  desc "Backfill a Dashboard for each legacy Configuration"
+  task backfill_dashboards: :environment do
+    DashKit::ConfigurationBackfill.run
+    puts "DashKit backfilled Dashboards from Configurations"
+  end
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: dash_kit
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- Tyler Schneider
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-09-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+- !ruby/object:Gem::Dependency
+  name: turbo-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: keystone_ui
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+- !ruby/object:Gem::Dependency
+  name: keystone_ui-blocks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+description: DashKit provides a presentation layer for building reusable dashboards.
+  Register widgets, persist user configuration, and render dashboards without coupling
+  to any specific data backend.
+email:
+- tylercschneider@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/builds/dash_kit/dashboard_grid.css
+- app/assets/builds/dash_kit/dashboard_grid.js
+- app/assets/javascripts/dash_kit/index.js
+- app/assets/stylesheets/dash_kit/application.css
+- app/controllers/dash_kit/application_controller.rb
+- app/controllers/dash_kit/dashboards_controller.rb
+- app/controllers/dash_kit/widget_definitions_controller.rb
+- app/controllers/dash_kit/widgets_controller.rb
+- app/helpers/dash_kit/application_helper.rb
+- app/helpers/dash_kit/dashboard_helper.rb
+- app/javascript/dash_kit/dashboard_grid.jsx
+- app/models/concerns/dash_kit/widget_management.rb
+- app/models/dash_kit/application_record.rb
+- app/models/dash_kit/dashboard.rb
+- app/models/dash_kit/widget_definition.rb
+- app/views/dash_kit/dashboards/_widgets.html.erb
+- app/views/dash_kit/dashboards/edit.html.erb
+- app/views/dash_kit/dashboards/index.html.erb
+- app/views/dash_kit/dashboards/new.html.erb
+- app/views/dash_kit/widget_definitions/_missing_renderer.html.erb
+- app/views/layouts/dash_kit/application.html.erb
+- config/importmap.rb
+- config/routes.rb
+- lib/dash_kit.rb
+- lib/dash_kit/configuration_backfill.rb
+- lib/dash_kit/engine.rb
+- lib/dash_kit/reference.rb
+- lib/dash_kit/reference/guide.md
+- lib/dash_kit/renderer_registry.rb
+- lib/dash_kit/the_local.rb
+- lib/dash_kit/the_local/agents/dash_kit-develop.md
+- lib/dash_kit/the_local/agents/dash_kit-info.md
+- lib/dash_kit/the_local/agents/dash_kit-install.md
+- lib/dash_kit/version.rb
+- lib/dash_kit/widget_registry.rb
+- lib/generators/dash_kit/install_generator.rb
+- lib/generators/dash_kit/templates/create_dash_kit_dashboards.rb.tt
+- lib/generators/dash_kit/templates/create_dash_kit_widget_definitions.rb.tt
+- lib/generators/dash_kit/templates/dash_kit.rb.tt
+- lib/tasks/dash_kit_tasks.rake
+homepage: https://github.com/DYB-Development/dash_kit
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/DYB-Development/dash_kit
+  source_code_uri: https://github.com/DYB-Development/dash_kit
+  changelog_uri: https://github.com/DYB-Development/dash_kit/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.16
+signing_key:
+specification_version: 4
+summary: A Rails engine for composable, configurable dashboards and widgets.
+test_files: []