model_explorer 0.1.0

data/app/assets/stylesheets/model_explorer/models.css

@@ -0,0 +1,45 @@
+pre#json-pre {
+  border: 1px solid #d0d0d0;
+  border-radius: 3px;
+  margin-bottom: 0px;
+  margin-top: 0px;
+  padding: 10px;
+  height: 80vh;
+}
+
+.overflow-unset {
+  overflow: unset !important;
+}
+
+.was-validated .ts-wrapper.invalid .ts-control {
+  border: 1px solid #dc3545;
+  padding-right: calc(1.5em + .75rem)!important;
+  background-image: url("data:image/svg+xml,%3csvg xmlns='http://www.w3.org/2000/svg' width='12' height='12' fill='none' stroke='%23dc3545' viewBox='0 0 12 12'%3e%3ccircle cx='6' cy='6' r='4.5'/%3e%3cpath stroke-linejoin='round' d='M5.8 3.6h.4L6 6.5z'/%3e%3ccircle cx='6' cy='8.2' r='.6' fill='%23dc3545' stroke='none'/%3e%3c/svg%3e");
+  background-repeat: no-repeat;
+  background-position: right calc(.375em + .1875rem) center;
+  background-size: calc(.75em + .375rem) calc(.75em + .375rem)
+}
+
+.was-validated .form-control:valid {
+  border: 1px solid #dee2e6;
+  padding-right: calc(1.5em + .75rem)!important;
+  background-image: none;
+  background-repeat: no-repeat;
+  background-position: auto auto;
+  background-size: auto auto
+}
+
+.was-validated .form-control:valid:focus {
+  border-color: #86b7fe;
+  box-shadow: 0 0 0 0.2rem rgba(13, 110, 253, 0.25)
+}
+
+.ts-control input {
+  line-height: 1.5 !important;
+  padding: 0.01rem .75rem !important;
+}
+
+.ts-control {
+  border: var(--bs-border-width) solid var(--bs-border-color);
+  border-radius: var(--bs-border-radius);
+}

data/app/controllers/model_explorer/application_controller.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module ModelExplorer
+  class ApplicationController < ActionController::Base
+    layout "model_explorer/application"
+
+    before_action :verify_access
+
+    http_basic_authenticate_with(
+      name: ModelExplorer.basic_auth_username.to_s,
+      password: ModelExplorer.basic_auth_password.to_s,
+      if: -> { ModelExplorer.basic_auth_enabled }
+    )
+
+    protected
+
+    def render_not_found(error)
+      render json: {error: error.message}, status: :not_found
+    end
+
+    def render_bad_request(error)
+      render json: {error: error.message}, status: :bad_request
+    end
+
+    def ensure_valid_model_name(model_name = nil)
+      return if ModelExplorer.models.map(&:name).include?(model_name)
+
+      raise "Model '#{model_name}' not found"
+    end
+
+    private
+
+    def verify_access
+      return if ModelExplorer.verify_access_proc.call(self)
+
+      flash[:error] = t("unauthorized", scope: "model_explorer")
+
+      redirect_to "/"
+    end
+  end
+end

data/app/controllers/model_explorer/exports_controller.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module ModelExplorer
+  class ExportsController < ApplicationController
+    # Warning: all parameters are permitted.
+    # Associations must not be called directly on the record.
+    def show
+      ensure_valid_model_name(params[:model])
+
+      render_export
+    rescue => error
+      render_bad_request(error)
+    end
+
+    private
+
+    def render_export
+      render json: {
+        export: build_export,
+        path: exports_path(params.except(:controller, :action))
+      }.to_json
+    rescue ActiveRecord::RecordNotFound => error
+      render_not_found(error)
+    end
+
+    def build_export
+      export = ModelExplorer::Export.new(
+        record: build_record(params[:model].constantize),
+        associations: ModelExplorer::Associations.build_from_params(params.permit!.to_h)
+      )
+
+      export.data
+    end
+
+    def build_record(model)
+      select = ModelExplorer::Select.new(model, params[:columns]).to_a
+      record = model.select(select).find(params[:record_id])
+
+      attributes =
+        if params[:columns].present?
+          record.attributes.slice(*params[:columns])
+        else
+          record.attributes
+        end
+
+      ModelExplorer::Record.new(
+        record.attributes[model.primary_key],
+        attributes,
+        model
+      )
+    end
+  end
+end

data/app/controllers/model_explorer/models_controller.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module ModelExplorer
+  class ModelsController < ApplicationController
+    def index
+      @models = ModelExplorer.models.map(&:name).sort
+    end
+
+    def show
+      model_name = params[:id]
+
+      ensure_valid_model_name(model_name)
+
+      render json: ModelSerializer.new(
+        model: model_name.constantize,
+        macro: params[:macro],
+        parent: params[:parent]
+      ).to_json
+    rescue => error
+      render_bad_request(error)
+    end
+  end
+end

data/app/serializers/application_serializer.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class ApplicationSerializer
+  def to_h
+    raise NotImplementedError
+  end
+
+  def to_json(*)
+    to_h.to_json
+  end
+end

data/app/serializers/association_serializer.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+class AssociationSerializer < ApplicationSerializer
+  attr_reader :association
+
+  def initialize(association)
+    @association = association
+  end
+
+  def to_h
+    {
+      name: association_name,
+      macro: association.macro,
+      model: association.class_name || association_name.classify
+    }
+  end
+
+  private
+
+  delegate :name, to: :association, prefix: true
+end

data/app/serializers/model_serializer.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+class ModelSerializer < ApplicationSerializer
+  attr_reader :model, :macro, :parent
+
+  def initialize(model:, macro:, parent: nil)
+    @model = model
+    @macro = macro
+    @parent = parent
+  end
+
+  def to_h
+    {
+      model: model.name,
+      columns: model.column_names,
+      scopes: build_scopes,
+      associations: build_associations
+    }
+  end
+
+  private
+
+  def build_scopes
+    case macro
+    when "has_many"
+      model.model_explorer_scopes.map(&:to_s)
+    else
+      []
+    end
+  end
+
+  def build_associations
+    model.reflect_on_all_associations.filter_map do |association|
+      next if association.options[:through] || association.name.to_s == parent
+
+      AssociationSerializer.new(association).to_h
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+<!DOCTYPE html>
+<html lang="<%= I18n.locale %>">
+  <head>
+    <title>
+      <%= t(".title") %>
+    </title>
+
+    <%= csrf_meta_tags %>
+    <%= csp_meta_tag %>
+
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+
+    <%= stylesheet_link_tag("model_explorer/application", media: "all") %>
+    <%= javascript_include_tag("model_explorer/application") %>
+  </head>
+
+  <body>
+    <nav class="navbar navbar-expand-lg bg-primary navbar-dark">
+      <div class="container">
+        <a class="navbar-brand" href="<%= model_explorer.models_path %>">
+          <%= t(".title") %>
+        </a>
+      </div>
+    </nav>
+
+    <%= yield %>
+  </body>
+</html>

data/app/views/model_explorer/models/index.html.erb

@@ -0,0 +1,14 @@
+<div class="container">
+  <div class="row g-4">
+    <div class="col-12 col-md-6">
+      <%= render(
+        partial: "model_explorer/models/partials/form",
+        locals: {models: @models}
+      ) %>
+    </div>
+
+    <div class="col-12 col-md-6">
+      <%= render(partial: "model_explorer/models/partials/record_details") %>
+    </div>
+  </div>
+</div>

data/app/views/model_explorer/models/partials/_form.html.erb

@@ -0,0 +1,49 @@
+<span class="h4 my-3 d-block">
+  <%= t(".select_model") %>
+</span>
+
+<%= form_with(
+  url: exports_path,
+  method: :get,
+  local: false,
+  html: {
+    id: "export-form",
+    class: "needs-validation",
+    novalidate: true
+  }
+) do |f| %>
+  <div class="row">
+    <div class="col-9">
+      <%= f.select(
+        :model,
+        models,
+        {prompt: t(".select_prompt"), include_blank: true},
+        {id: "association-select", class: "p-0", required: true}
+      ) %>
+      <div class="invalid-feedback">
+        <%= t(".required_field") %>
+      </div>
+    </div>
+
+    <div class="col-3 pl-0">
+      <%= f.text_field(
+        :record_id,
+        placeholder: t(".record_id_placeholder"),
+        class: "form-control",
+        required: true
+      ) %>
+
+      <div class="invalid-feedback">
+        <%= t(".required_field") %>
+      </div>
+    </div>
+  </div>
+
+  <div id="associations-container" class="my-3"></div>
+
+  <%= render(partial: "model_explorer/models/partials/select_template") %>
+
+  <div class="w-100 my-3">
+    <%= f.submit(t(".submit"), class: "btn btn-primary w-100") %>
+  </div>
+<% end %>

data/app/views/model_explorer/models/partials/_record_details.html.erb

@@ -0,0 +1,43 @@
+<div id="record-details">
+  <span class="h4 my-3 d-block">
+    <%= t(".title") %>
+  </span>
+
+  <div class="vh-50 overflow-auto shadow-sm">
+    <div class="card" id="no-record">
+      <span class="d-block text-center w-100 m-4">
+        <%= t(".no_record") %>
+      </span>
+    </div>
+
+    <div id="json-data" class="position-relative d-none">
+      <div class="d-flex position-absolute top-0 end-0 m-2 gap-2">
+        <button
+          id="copy-record-details"
+          class="btn btn-sm btn-primary"
+          data-text="<%= t(".copy_text") %>"
+        >
+          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 16 16" width="16" height="16" fill="currentColor">
+            <path d="M0 6.75C0 5.784.784 5 1.75 5h1.5a.75.75 0 0 1 0 1.5h-1.5a.25.25 0 0 0-.25.25v7.5c0 .138.112.25.25.25h7.5a.25.25 0 0 0 .25-.25v-1.5a.75.75 0 0 1 1.5 0v1.5A1.75 1.75 0 0 1 9.25 16h-7.5A1.75 1.75 0 0 1 0 14.25Z"></path>
+            <path d="M5 1.75C5 .784 5.784 0 6.75 0h7.5C15.216 0 16 .784 16 1.75v7.5A1.75 1.75 0 0 1 14.25 11h-7.5A1.75 1.75 0 0 1 5 9.25Zm1.75-.25a.25.25 0 0 0-.25.25v7.5c0 .138.112.25.25.25h7.5a.25.25 0 0 0 .25-.25v-7.5a.25.25 0 0 0-.25-.25Z"></path>
+          </svg>
+        </button>
+
+        <a id="view-record-details" class="btn btn-sm btn-primary" target="_blank" rel="noopener noreferrer nofollow">
+          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 16 16" width="16" height="16" fill="currentColor">
+            <path d="M4 1.75C4 .784 4.784 0 5.75 0h5.586c.464 0 .909.184 1.237.513l2.914 2.914c.329.328.513.773.513 1.237v8.586A1.75 1.75 0 0 1 14.25 15h-9a.75.75 0 0 1 0-1.5h9a.25.25 0 0 0 .25-.25V6h-2.75A1.75 1.75 0 0 1 10 4.25V1.5H5.75a.25.25 0 0 0-.25.25v2.5a.75.75 0 0 1-1.5 0Zm1.72 4.97a.75.75 0 0 1 1.06 0l2 2a.75.75 0 0 1 0 1.06l-2 2a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734l1.47-1.47-1.47-1.47a.75.75 0 0 1 0-1.06ZM3.28 7.78 1.81 9.25l1.47 1.47a.751.751 0 0 1-.018 1.042.751.751 0 0 1-1.042.018l-2-2a.75.75 0 0 1 0-1.06l2-2a.751.751 0 0 1 1.042.018.751.751 0 0 1 .018 1.042Zm8.22-6.218V4.25c0 .138.112.25.25.25h2.688l-.011-.013-2.914-2.914-.013-.011Z"></path>
+          </svg>
+        </a>
+
+        <a id="download-record-details" class="btn btn-sm btn-primary" download>
+          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 16 16" width="16" height="16" fill="currentColor">
+            <path d="M2.75 14A1.75 1.75 0 0 1 1 12.25v-2.5a.75.75 0 0 1 1.5 0v2.5c0 .138.112.25.25.25h10.5a.25.25 0 0 0 .25-.25v-2.5a.75.75 0 0 1 1.5 0v2.5A1.75 1.75 0 0 1 13.25 14Z"></path>
+            <path d="M7.25 7.689V2a.75.75 0 0 1 1.5 0v5.689l1.97-1.969a.749.749 0 1 1 1.06 1.06l-3.25 3.25a.749.749 0 0 1-1.06 0L4.22 6.78a.749.749 0 1 1 1.06-1.06l1.97 1.969Z"></path>
+          </svg>
+        </a>
+      </div>
+
+      <pre id="json-pre" class="language-json border-none"></pre>
+    </div>
+  </div>
+</div>

data/app/views/model_explorer/models/partials/_select_template.html.erb

@@ -0,0 +1,53 @@
+<template
+  id="associations-select-template"
+  data-max-items="<%= ModelExplorer.max_items_per_association %>"
+  data-max-scopes="<%= ModelExplorer.max_scopes_per_association %>"
+>
+  <div class="accordion mt-3" id="associations-accordion-TEMP_ID">
+    <div class="card overflow-unset">
+      <button
+        class="card-header btn btn-link btn-block text-decoration-none text-left text-dark"
+        type="button"
+        data-bs-toggle="collapse"
+        data-bs-target="#associations-collapse-TEMP_ID"
+        aria-expanded="false"
+      ></button>
+
+      <div class="collapse show" id="associations-collapse-TEMP_ID">
+        <div class="card-body" id="associations-container-TEMP_ID">
+          <select
+            id="columns-select-TEMP_ID"
+            class="p-0"
+            data-placeholder="<%= t(".select_columns") %>"
+            multiple
+          ></select>
+
+          <% if ModelExplorer.association_scopes_enabled? %>
+            <select
+              id="scopes-select-TEMP_ID"
+              class="mt-3 p-0"
+              data-placeholder="<%= t(".select_scopes") %>"
+              multiple
+            ></select>
+          <% end %>
+
+          <% if ModelExplorer.association_select_enabled? %>
+            <select
+              id="associations-select-TEMP_ID"
+              name="association_attributes[scopes][]"
+              class="mt-3 p-0"
+              data-placeholder="<%= t(".select_associations") %>"
+              multiple
+            ></select>
+          <% end %>
+
+          <input
+            id="associations-input-TEMP_ID"
+            name="association_attributes[name]"
+            type="hidden"
+          >
+        </div>
+      </div>
+    </div>
+  </div>
+</template>

data/config/locales/en.yml

@@ -0,0 +1,3 @@
+en:
+  model_explorer:
+    unauthorized: "You are not authorized to access this page."

data/config/locales/fr.yml

@@ -0,0 +1,3 @@
+fr:
+  model_explorer:
+    unauthorized: "Vous n'êtes pas autorisé à accéder à cette page."

data/config/locales/views/layouts/model_explorer/application.en.yml

@@ -0,0 +1,5 @@
+en:
+  layouts:
+    model_explorer:
+        application:
+          title: "Model Explorer"

data/config/locales/views/layouts/model_explorer/application.fr.yml

@@ -0,0 +1,5 @@
+fr:
+  layouts:
+    model_explorer:
+        application:
+          title: "Model Explorer"

data/config/locales/views/model_explorer/models/partials/form.en.yml

@@ -0,0 +1,10 @@
+en:
+  model_explorer:
+    models:
+      partials:
+        form:
+          select_model: "Select a model to inspect"
+          select_prompt: "Select a model"
+          required_field: "Required field"
+          record_id_placeholder: "ID"
+          submit: "Search"

data/config/locales/views/model_explorer/models/partials/form.fr.yml

@@ -0,0 +1,10 @@
+fr:
+  model_explorer:
+    models:
+      partials:
+        form:
+          select_model: "Sélectionnez un modèle à inspecter"
+          select_prompt: "Sélectionnez un modèle"
+          required_field: "Champ obligatoire"
+          record_id_placeholder: "ID"
+          submit: "Rechercher"

data/config/locales/views/model_explorer/models/partials/record_details.en.yml

@@ -0,0 +1,9 @@
+en:
+  model_explorer:
+    models:
+      partials:
+        record_details:
+          title: "Record Details"
+          no_record: "No record selected"
+          copy: "Copy"
+          copy_text: "Copied!"

data/config/locales/views/model_explorer/models/partials/record_details.fr.yml

@@ -0,0 +1,9 @@
+fr:
+  model_explorer:
+    models:
+      partials:
+        record_details:
+          title: "Détails de l'enregistrement"
+          no_record: "Aucun enregistrement sélectionné"
+          copy: "Copier"
+          copy_text: "Copié !"

data/config/locales/views/model_explorer/models/partials/select_template.en.yml

@@ -0,0 +1,8 @@
+en:
+  model_explorer:
+    models:
+      partials:
+        select_template:
+          select_associations: "Select associations"
+          select_columns: "Select columns"
+          select_scopes: "Select scopes"

data/config/locales/views/model_explorer/models/partials/select_template.fr.yml

@@ -0,0 +1,8 @@
+fr:
+  model_explorer:
+    models:
+      partials:
+        select_template:
+          select_associations: "Sélectionnez les associations"
+          select_columns: "Sélectionnez les colonnes"
+          select_scopes: "Sélectionnez les scopes"

data/config/routes.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+ModelExplorer::Engine.routes.draw do
+  root to: "models#index"
+
+  resources :models, only: [:index, :show]
+  resource :exports, only: [:show]
+end

data/lib/generators/model_explorer/USAGE

@@ -0,0 +1,7 @@
+Description:
+    Generates an initializer to configure ModelExplorer and mount the engine in the routes file.
+
+Example:
+    `bin/rails generate model_explorer:install --routes
+      create  config/initializers/model_explorer.rb
+       route  mount ModelExplorer::Engine, at: "/model_explorer"`

data/lib/generators/model_explorer/install_generator.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "rails/generators/active_record"
+
+module ModelExplorer
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path("templates", __dir__)
+
+    class_option :routes, desc: "Generate routes", type: :boolean, default: false
+
+    def copy_initializer
+      template "model_explorer.rb", "config/initializers/model_explorer.rb"
+    end
+
+    def add_model_explorer_routes
+      return unless options.routes?
+
+      route <<~ROUTE
+        mount ModelExplorer::Engine, at: "/model_explorer"
+
+      ROUTE
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+ModelExplorer.configure do |config|
+  # Enable the basic auth. Disabled by default.
+  # config.basic_auth_enabled = true
+  # config.basic_auth_username = "admin"
+  # config.basic_auth_password = "password"
+
+  # Add a custom proc to verify the access.
+  # config.verify_access_proc = ->(controller) do
+  #   controller.current_admin_user&.super_admin?
+  # end
+
+  # Customize the regular expression for filtering attributes.
+  # config.filter_attributes_regexp = /password|token|secret/i
+
+  # Set the maximum number of items to select per association.
+  # Disable by setting to 0.
+  # config.max_items_per_association = 5
+
+  # Set the maximum number of scopes to select per association.
+  # Disable by setting to 0.
+  # config.max_scopes_per_association = 5
+end

data/lib/model_explorer/associations/base.rb

@@ -0,0 +1,74 @@
+module ModelExplorer
+  module Associations
+    class Base
+      extend Forwardable
+
+      def_delegators :reflection, :name, :macro, :klass
+
+      attr_reader :record, :reflection, :association
+
+      def initialize(record, reflection, association)
+        @record = record
+        @reflection = reflection
+        @association = association
+      end
+
+      def export
+        raise NotImplementedError
+      end
+
+      def records
+        @_records ||=
+          klass
+          .connection
+          .exec_query(query.to_sql)
+          .map { |record_attributes| build_record(record_attributes) }
+      end
+
+      protected
+
+      def query
+        raise NotImplementedError
+      end
+
+      def default_query
+        klass
+          .select(ModelExplorer::Select.new(klass, association[:columns]).to_a)
+          .where(reflection_query)
+      end
+
+      def build_record(record_attributes)
+        attributes =
+          if association[:columns].present?
+            record_attributes.slice(*association[:columns])
+          else
+            record_attributes
+          end
+
+        ModelExplorer::Record.new(
+          record_attributes[klass.primary_key],
+          attributes,
+          klass
+        )
+      end
+
+      def reflection_query
+        foreign_key = reflection.foreign_key
+
+        case reflection.macro
+        when :has_many, :has_one then {foreign_key => record[klass.primary_key]}
+        when :belongs_to then {"#{reflection.table_name}.id" => record[klass.primary_key]}
+        end
+      end
+
+      def export_records
+        records.map do |relation_record|
+          ModelExplorer::Export.new(
+            record: relation_record,
+            associations: association[:associations]
+          ).data
+        end
+      end
+    end
+  end
+end