RubyGems - backstage - Versions diffs - 0.1.0 - Mend

backstage 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (44) hide show

checksums.yaml +7 -0
data/CHANGELOG.md +27 -0
data/CONTRIBUTING.md +70 -0
data/LICENSE +21 -0
data/README.md +195 -0
data/app/assets/stylesheets/backstage/backstage.css +5 -0
data/app/controllers/backstage/actions_controller.rb +27 -0
data/app/controllers/backstage/application_controller.rb +21 -0
data/app/controllers/backstage/dashboards_controller.rb +15 -0
data/app/controllers/backstage/home_controller.rb +14 -0
data/app/controllers/backstage/resources_controller.rb +94 -0
data/app/views/backstage/dashboards/show.html.erb +36 -0
data/app/views/backstage/fields/_belongs_to.html.erb +7 -0
data/app/views/backstage/fields/_boolean.html.erb +1 -0
data/app/views/backstage/fields/_date.html.erb +1 -0
data/app/views/backstage/fields/_datetime.html.erb +1 -0
data/app/views/backstage/fields/_enum.html.erb +4 -0
data/app/views/backstage/fields/_has_many.html.erb +19 -0
data/app/views/backstage/fields/_image_url.html.erb +5 -0
data/app/views/backstage/fields/_integer.html.erb +1 -0
data/app/views/backstage/fields/_string.html.erb +1 -0
data/app/views/backstage/fields/_text.html.erb +1 -0
data/app/views/backstage/fields/_thumbnails.html.erb +13 -0
data/app/views/backstage/home/index.html.erb +24 -0
data/app/views/backstage/resources/edit.html.erb +18 -0
data/app/views/backstage/resources/index.html.erb +54 -0
data/app/views/backstage/resources/new.html.erb +13 -0
data/app/views/layouts/backstage/backstage.html.erb +59 -0
data/config/routes.rb +15 -0
data/lib/backstage/association_config.rb +31 -0
data/lib/backstage/auto_discovery.rb +58 -0
data/lib/backstage/configuration.rb +31 -0
data/lib/backstage/dashboard_config.rb +15 -0
data/lib/backstage/engine.rb +11 -0
data/lib/backstage/field.rb +39 -0
data/lib/backstage/registry.rb +32 -0
data/lib/backstage/resource_config.rb +91 -0
data/lib/backstage/sidebar_config.rb +15 -0
data/lib/backstage/version.rb +3 -0
data/lib/backstage.rb +56 -0
data/lib/generators/backstage/install/install_generator.rb +29 -0
data/lib/generators/backstage/install/templates/SKILL.md +221 -0
data/lib/generators/backstage/install/templates/backstage.yml +16 -0
metadata +95 -0

data/app/views/backstage/resources/index.html.erb ADDED Viewed

@@ -0,0 +1,54 @@
+<h1><%= @resource_config.model_class.model_name.human.pluralize %></h1>
+<form method="get" action="">
+  <input type="search" name="q" value="<%= params[:q] %>" placeholder="Search…">
+  <button type="submit">Search</button>
+</form>
+<% @resource_config.index_fields.select(&:enum?).each do |field| %>
+  <nav class="enum-filters">
+    <%= link_to "All", url_for(params.permit!.except(:status, :page)) %>
+    <% field.enum_values.each do |label, value| %>
+      <%= link_to label, url_for(params.permit!.merge(field.name => value, page: nil)) %>
+    <% end %>
+  </nav>
+<% end %>
+<%= link_to "New #{@resource_config.model_class.model_name.human}", new_resource_path(resource: params[:resource]) %>
+<table>
+  <thead>
+    <tr>
+      <% @resource_config.index_fields.each do |field| %>
+        <% col = field.name.to_s
+           next_dir = (@sort == col && @dir == "asc") ? "desc" : "asc" %>
+        <th><%= link_to field.name.to_s.humanize, url_for(sort: col, dir: next_dir) %></th>
+      <% end %>
+      <th>Actions</th>
+    </tr>
+  </thead>
+  <tbody>
+    <% @records.each do |record| %>
+      <tr>
+        <% @resource_config.index_fields.each do |field| %>
+          <td>
+            <% if field.enum? %>
+              <%= record.public_send(field.name).to_s.humanize %>
+            <% else %>
+              <%= record.public_send(field.name) %>
+            <% end %>
+          </td>
+        <% end %>
+        <td><%= link_to "Edit", edit_resource_path(resource: params[:resource], id: record.id) %></td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>
+<% if @total_pages > 1 %>
+  <nav>
+    <% (1..@total_pages).each do |p| %>
+      <%= link_to p, url_for(page: p), class: (p == @page ? "current" : nil) %>
+    <% end %>
+  </nav>
+<% end %>

data/app/views/backstage/resources/new.html.erb ADDED Viewed

@@ -0,0 +1,13 @@
+<h1>New <%= @resource_config.model_class.model_name.human %></h1>
+<%= form_with model: @record, url: resources_path(resource: params[:resource]), method: :post do |f| %>
+  <% @resource_config.edit_fields.each do |field| %>
+    <div>
+      <%= f.label field.name %>
+      <%= render partial: field.partial_path, locals: { f: f, field: field, record: @record } %>
+    </div>
+  <% end %>
+  <%= f.submit "Create" %>
+<% end %>
+<%= link_to "Cancel", resources_path(resource: params[:resource]) %>

data/app/views/layouts/backstage/backstage.html.erb ADDED Viewed

@@ -0,0 +1,59 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <title>Backstage</title>
+    <%= csrf_meta_tags %>
+    <%= stylesheet_link_tag "backstage/backstage", media: "all" %>
+    <script>
+      document.addEventListener("DOMContentLoaded", function() {
+        document.querySelectorAll("[data-confirm-message]").forEach(function(btn) {
+          btn.addEventListener("click", function(e) {
+            if (!window.confirm(btn.dataset.confirmMessage)) {
+              e.preventDefault()
+            }
+          })
+        })
+        document.querySelectorAll("[data-multi-select-search]").forEach(function(input) {
+          input.addEventListener("input", function() {
+            var q = input.value.toLowerCase()
+            input.closest("[data-multi-select]")
+                 .querySelectorAll("[data-multi-select-item]")
+                 .forEach(function(item) {
+                   item.hidden = q.length > 0 && !item.textContent.toLowerCase().includes(q)
+                 })
+          })
+        })
+      })
+    </script>
+  </head>
+  <body>
+    <header>
+      <%= link_to "Backstage", root_path %>
+    </header>
+    <nav>
+      <ul>
+        <% nav_resources.each do |config| %>
+          <li><%= link_to config.model_class.model_name.human.pluralize,
+                          resources_path(resource: config.model_name_param) %></li>
+        <% end %>
+      </ul>
+    </nav>
+    <main>
+      <%= yield %>
+    </main>
+    <% sidebar = defined?(@resource_config) && @resource_config&.sidebar_config
+       record  = defined?(@record) ? @record : nil %>
+    <% if sidebar&.links&.any? %>
+      <aside>
+        <ul>
+          <% sidebar.links.each do |link| %>
+            <% url = link.url_or_proc.respond_to?(:call) ? link.url_or_proc.call(record) : link.url_or_proc %>
+            <li><%= link_to link.label, url %></li>
+          <% end %>
+        </ul>
+      </aside>
+    <% end %>
+  </body>
+</html>

data/config/routes.rb ADDED Viewed

@@ -0,0 +1,15 @@
+Backstage::Engine.routes.draw do
+  root to: "home#index"
+  get "dashboards/:name", to: "dashboards#show", as: :dashboard
+  scope ":resource" do
+    get "/", to: "resources#index", as: :resources
+    get "/new", to: "resources#new", as: :new_resource
+    post "/", to: "resources#create"
+    get "/:id/edit", to: "resources#edit", as: :edit_resource
+    patch "/:id", to: "resources#update", as: :resource
+    delete "/:id", to: "resources#destroy"
+    post "/:id/:action_name", to: "actions#create", as: :resource_action
+  end
+end

data/lib/backstage/association_config.rb ADDED Viewed

@@ -0,0 +1,31 @@
+module Backstage
+  class AssociationConfig
+    attr_reader :name, :kind, :options
+    def initialize(name, kind, options = {})
+      @name = name.to_sym
+      @kind = kind.to_sym
+      @options = options
+    end
+    def display_column
+      options[:display_column] || :id
+    end
+    def foreign_key
+      options[:foreign_key] || :"#{name}_id"
+    end
+    def class_name
+      options[:class_name] || name.to_s.classify
+    end
+    def associated_class
+      class_name.constantize
+    end
+    def image_col
+      options[:image_col] || :url
+    end
+  end
+end

data/lib/backstage/auto_discovery.rb ADDED Viewed

@@ -0,0 +1,58 @@
+module Backstage
+  class AutoDiscovery
+    SYSTEM_COLUMNS = %i[id created_at updated_at].freeze
+    COLUMN_TYPE_MAP = {
+      string: :string,
+      text: :text,
+      integer: :integer,
+      decimal: :integer,
+      float: :integer,
+      boolean: :boolean,
+      date: :date,
+      datetime: :datetime
+    }.freeze
+    def self.build(model_class)
+      new(model_class).build
+    end
+    def initialize(model_class)
+      @model_class = model_class
+    end
+    def build
+      config = ResourceConfig.new(@model_class)
+      config.display_column = detect_display_column
+      fields = column_fields + enum_fields
+      config.index_fields = fields
+      config.edit_fields = fields
+      config
+    end
+    private
+    def column_fields
+      @model_class.columns
+        .reject { |col| SYSTEM_COLUMNS.include?(col.name.to_sym) }
+        .reject { |col| enum_column_names.include?(col.name.to_sym) }
+        .map { |col| Field.new(col.name, COLUMN_TYPE_MAP.fetch(col.type, :string)) }
+    end
+    def enum_fields
+      @model_class.defined_enums.map do |name, values|
+        enum_values = values.keys.map { |k| [k.humanize, k] }
+        Field.new(name, :enum, enum_values: enum_values)
+      end
+    end
+    def enum_column_names
+      @enum_column_names ||= @model_class.defined_enums.keys.map(&:to_sym)
+    end
+    def detect_display_column
+      column_names = @model_class.column_names.map(&:to_sym)
+      %i[name title email id].find { |col| column_names.include?(col) }
+    end
+  end
+end

data/lib/backstage/configuration.rb ADDED Viewed

@@ -0,0 +1,31 @@
+require "yaml"
+module Backstage
+  class ConfigurationError < StandardError; end
+  class Configuration
+    attr_reader :admin_user_method, :redirect_on_failure, :per_page,
+      :model_names, :dashboard_configs
+    def initialize(hash)
+      @admin_user_method = (hash["admin_user_method"] || "is_admin?").to_sym
+      @redirect_on_failure = hash["redirect_on_failure"] || "/"
+      @per_page = hash["per_page"] || 25
+      @model_names = hash["models"] || []
+      @dashboard_configs = hash["dashboards"] || []
+      validate!
+    end
+    private
+    def validate!
+      unless @model_names.is_a?(Array)
+        raise ConfigurationError, "config/backstage.yml: 'models' must be a list, got #{@model_names.inspect}"
+      end
+      unless @per_page.is_a?(Integer)
+        raise ConfigurationError, "config/backstage.yml: 'per_page' must be an integer, got #{@per_page.inspect}"
+      end
+    end
+  end
+end

data/lib/backstage/dashboard_config.rb ADDED Viewed

@@ -0,0 +1,15 @@
+module Backstage
+  class DashboardConfig
+    attr_reader :name, :model_name, :scope
+    def initialize(hash)
+      @name = hash["name"]
+      @model_name = hash["model"]
+      @scope = hash["scope"] || {}
+    end
+    def resource_config
+      Backstage.registry.resource_for(model_name)
+    end
+  end
+end

data/lib/backstage/engine.rb ADDED Viewed

@@ -0,0 +1,11 @@
+module Backstage
+  class Engine < ::Rails::Engine
+    isolate_namespace Backstage
+    initializer "backstage.configuration" do |app|
+      app.config.to_prepare do
+        Backstage.load_configuration!(app.root)
+      end
+    end
+  end
+end

data/lib/backstage/field.rb ADDED Viewed

@@ -0,0 +1,39 @@
+module Backstage
+  class Field
+    attr_reader :name, :type, :options
+    def initialize(name, type, options = {})
+      @name = name.to_sym
+      @type = type.to_sym
+      @options = options
+    end
+    def partial_path
+      options[:partial] || "backstage/fields/#{type}"
+    end
+    def readonly?
+      options.fetch(:readonly, false)
+    end
+    def enum?
+      type == :enum
+    end
+    def enum_values
+      options[:enum_values] || []
+    end
+    def belongs_to?
+      type == :belongs_to
+    end
+    def has_many?
+      type == :has_many
+    end
+    def association
+      options[:association]
+    end
+  end
+end

data/lib/backstage/registry.rb ADDED Viewed

@@ -0,0 +1,32 @@
+module Backstage
+  class Registry
+    def initialize
+      @resources = {}
+      @dashboards = {}
+    end
+    def register(model_name, resource_config)
+      @resources[model_name] = resource_config
+    end
+    def resource_for(model_name)
+      @resources.fetch(model_name) { raise KeyError, "Backstage: no resource registered for '#{model_name}'" }
+    end
+    def all_resources
+      @resources.values
+    end
+    def register_dashboard(dashboard_config)
+      @dashboards[dashboard_config.name] = dashboard_config
+    end
+    def dashboard_for(name)
+      @dashboards.fetch(name) { raise KeyError, "Backstage: no dashboard registered for '#{name}'" }
+    end
+    def all_dashboards
+      @dashboards.values
+    end
+  end
+end

data/lib/backstage/resource_config.rb ADDED Viewed

@@ -0,0 +1,91 @@
+module Backstage
+  class ResourceConfig
+    attr_accessor :model_class, :index_fields, :edit_fields,
+      :associations, :sidebar_links, :custom_actions, :excluded_columns
+    attr_writer :display_column
+    def initialize(model_class)
+      @model_class = model_class
+      @index_fields = []
+      @edit_fields = []
+      @associations = []
+      @sidebar_links = []
+      @custom_actions = []
+      @excluded_columns = []
+    end
+    def display_column(value = nil)
+      value ? @display_column = value.to_sym : @display_column
+    end
+    def model_name_param
+      model_class.model_name.plural
+    end
+    def sidebar(&block)
+      @sidebar_config ||= SidebarConfig.new
+      block&.call(@sidebar_config)
+      @sidebar_config
+    end
+    attr_reader :sidebar_config
+    def fields(*names)
+      @index_fields = names.map { |n| find_or_build_field(n) }
+    end
+    def exclude(*names)
+      names.map!(&:to_sym)
+      @index_fields = @index_fields.reject { |f| names.include?(f.name) }
+      @edit_fields = @edit_fields.reject { |f| names.include?(f.name) }
+    end
+    def has_many(name, **opts)
+      display_as = opts.delete(:as) || :has_many
+      assoc = AssociationConfig.new(name, :has_many, opts)
+      @associations << assoc
+      if display_as == :thumbnails
+        field_obj = Field.new(name.to_sym, :thumbnails, association: assoc, readonly: true)
+        @edit_fields.reject! { |f| f.name == field_obj.name }
+        @edit_fields << field_obj
+      else
+        ids_field = Field.new(:"#{name.to_s.singularize}_ids", :has_many, association: assoc)
+        @edit_fields.reject! { |f| f.name == ids_field.name }
+        @edit_fields << ids_field
+      end
+    end
+    def belongs_to(name, **opts)
+      assoc = AssociationConfig.new(name, :belongs_to, opts)
+      @associations << assoc
+      fk_field = Field.new(assoc.foreign_key, :belongs_to, association: assoc)
+      @edit_fields.reject! { |f| f.name == fk_field.name }
+      @index_fields.reject! { |f| f.name == fk_field.name }
+      @edit_fields << fk_field
+    end
+    def field(name, **opts)
+      type = opts.delete(:as) || opts.delete(:type)
+      sym = name.to_sym
+      existing = find_field(sym)
+      if existing
+        existing.options.merge!(opts)
+        existing.instance_variable_set(:@type, type.to_sym) if type
+      else
+        new_field = Field.new(sym, type || :string, opts)
+        @edit_fields << new_field
+        @index_fields << new_field
+      end
+    end
+    private
+    def find_field(name)
+      (@index_fields + @edit_fields).uniq.find { |f| f.name == name }
+    end
+    def find_or_build_field(name)
+      find_field(name.to_sym) || Field.new(name.to_sym, :string)
+    end
+  end
+end

data/lib/backstage/sidebar_config.rb ADDED Viewed

@@ -0,0 +1,15 @@
+module Backstage
+  class SidebarConfig
+    SidebarLink = Struct.new(:label, :url_or_proc)
+    attr_reader :links
+    def initialize
+      @links = []
+    end
+    def link(label, url_or_proc)
+      @links << SidebarLink.new(label, url_or_proc)
+    end
+  end
+end

data/lib/backstage/version.rb ADDED Viewed

@@ -0,0 +1,3 @@
+module Backstage
+  VERSION = "0.1.0"
+end

data/lib/backstage.rb ADDED Viewed

@@ -0,0 +1,56 @@
+require "backstage/version"
+require "backstage/configuration"
+require "backstage/field"
+require "backstage/association_config"
+require "backstage/resource_config"
+require "backstage/auto_discovery"
+require "backstage/dashboard_config"
+require "backstage/sidebar_config"
+require "backstage/registry"
+require "backstage/engine"
+module Backstage
+  class << self
+    attr_accessor :configuration, :registry
+    def load_configuration!(root)
+      path = File.join(root, "config", "backstage.yml")
+      hash = File.exist?(path) ? YAML.safe_load_file(path) || {} : {}
+      self.configuration = Configuration.new(hash)
+      self.registry = Registry.new
+      configuration.model_names.each do |name|
+        begin
+          model_class = name.constantize
+        rescue NameError
+          raise ConfigurationError, "config/backstage.yml: unknown model '#{name}'"
+        end
+        registry.register(name, AutoDiscovery.build(model_class))
+      end
+      load_dsl_files!(root)
+      configuration.dashboard_configs.each do |hash|
+        registry.register_dashboard(DashboardConfig.new(hash))
+      end
+      configuration
+    end
+    def resource(model_name)
+      name = model_name.to_s
+      config = registry.resource_for(name)
+      yield config if block_given?
+    rescue KeyError
+      raise ConfigurationError, "config/backstage/*.rb: no registered model '#{name}'"
+    end
+    private
+    def load_dsl_files!(root)
+      dir = File.join(root, "config", "backstage")
+      return unless File.directory?(dir)
+      Dir.glob(File.join(dir, "*.rb")).sort.each { |f| load f }
+    end
+  end
+end

data/lib/generators/backstage/install/install_generator.rb ADDED Viewed

@@ -0,0 +1,29 @@
+require "rails/generators/base"
+module Backstage
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+      def copy_config
+        copy_file "backstage.yml", "config/backstage.yml"
+      end
+      def copy_skill
+        copy_file "SKILL.md", ".claude/skills/backstage-install.md"
+      end
+      def mount_engine
+        route 'mount Backstage::Engine, at: "/admin"'
+      end
+      def print_instructions
+        say "\nBackstage installed!", :green
+        say "  1. Edit config/backstage.yml to list your models"
+        say "  2. Wire up current_user in config/initializers/backstage.rb"
+        say "  3. Visit /admin"
+        say "\n  Tip: run /backstage-install in Claude Code for a guided setup walkthrough\n"
+      end
+    end
+  end
+end