databasium 0.1.0

data/app/services/databasium/schema.rb

@@ -0,0 +1,146 @@
+class Databasium::Schema
+  attr_reader :schema, :tables
+  def initialize
+    @conn = ActiveRecord::Base.connection
+    @tables = @conn.data_sources - %w[ar_internal_metadata schema_migrations]
+    @schema = nil
+  end
+
+  def sync!(schema: nil)
+    path = Rails.root.join("storage")
+    FileUtils.mkdir_p(path) unless Dir.exist?(path)
+    File.write(path.join("schema_graph.json"), schema || build_schema.to_json)
+  end
+
+  def get_associations(table)
+    model =
+      ActiveRecord::Base.descendants.find { |m| m.table_name == table } ||
+        table.classify.safe_constantize
+    if model
+      model.reflect_on_all_associations.map do |r|
+        {
+          name: r.name.to_s.pluralize,
+          macro: r.macro,
+          class_name: r.class_name,
+          foreign_key: r.foreign_key
+        }
+      end
+    else
+      []
+    end
+  end
+
+  def schema
+    return @schema unless @schema.nil?
+    if File.exist?(Rails.root.join("storage/schema_graph.json"))
+      @schema = JSON.parse(File.read(Rails.root.join("storage/schema_graph.json")))
+    else
+      @schema = build_schema.deep_stringify_keys
+      sync!(schema: @schema)
+      @schema
+    end
+  end
+
+  def get_model_and_layers_BFS(model, layers)
+    queue = Queue.new()
+    queue.push([ table_name_for(model), 0 ])
+    result = {}
+
+    until queue.empty?
+      table, layer = queue.pop
+      next if (layers.present? && layer > layers) || result[table].present?
+      result[table] = get_schema_for_model(table)
+
+      model_associations = result[table].fetch("associations", nil)
+      model_associations&.each { |a| queue << [ a["name"], layer + 1 ] }
+    end
+    result
+  end
+
+  def get_schema_for_model(model)
+    schema[table_name_for(model)]
+  end
+
+  def get_foreign_keys(table)
+    @conn
+      .foreign_keys(table)
+      .map do |fk|
+        { from: fk.from_table, to: fk.to_table, column: fk.column, primary_key: fk.primary_key }
+      end
+  end
+
+  def get_columns_from_table(table)
+    @conn
+      .columns(table)
+      .map { |c| { name: c.name, sql_type: c.sql_type, null: c.null, default: c.default } }
+  end
+
+  def get_columns_names(table)
+    @conn.columns(table_name_for(table)).map { |c| c.name }
+  end
+
+  def get_tables(search)
+    @tables = @tables.select { |table| table =~ /#{search}/i } if search
+    @tables
+  end
+
+  def get_columns(model)
+    return if model.nil?
+    model.columns.map do |column|
+      {
+        name: column.name,
+        type: column.type.to_s,
+        used: false,
+        foreign_key: is_column_foreign_key?(model.table_name, column.name),
+        to_table: get_foreign_key_to_table(model.table_name, column.name)
+      }
+    end
+  end
+
+  def get_model_from_table(table)
+    return nil, "Select a table to view its records." if table.nil?
+    table_name = table_name_for(table)
+    unless ActiveRecord::Base.connection.table_exists?(table_name)
+      return nil, "Table #{table} does not exist"
+    end
+    begin
+      # If there is no model for this table it will raise a NameError
+      @model =
+        ActiveRecord::Base.descendants.find { |model| model.table_name == table_name } ||
+          table_name.classify.constantize
+      @error = nil
+    rescue NameError
+      @model = nil
+      @error =
+        "No model found for this table,
+        if you would like to interact with this table, you need to create a model for it."
+    end
+    [ @model, @error ]
+  end
+
+  private
+
+  def build_schema
+    @schema = {}
+    @tables.each do |table|
+      @schema[table] = {
+        columns: get_columns_from_table(table),
+        foreign_keys: get_foreign_keys(table),
+        associations: get_associations(table)
+      }
+    end
+    @schema
+  end
+
+  def table_name_for(name)
+    name.to_s.tableize
+  end
+
+  def is_column_foreign_key?(table, column_name)
+    get_foreign_keys(table).any? { |fk| fk[:column] == column_name }
+  end
+
+  def get_foreign_key_to_table(table, column_name)
+    get_foreign_keys(table).find { |fk| fk[:column] == column_name }&.fetch(:to)
+  end
+end

data/app/views/base.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Databasium
+  class Views::Base < Components::Base
+    # The `Views::Base` is an abstract class for all your views.
+    # By default, it inherits from `Components::Base`, but you
+    # can change that to `Phlex::HTML` if you want to keep views and
+    # components independent.
+
+    # More caching options at https://www.phlex.fun/components/caching
+    #
+  end
+end

data/app/views/databasium/errors/non_development.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Views
+  module Databasium
+    class Errors::NonDevelopment < Views::Base
+      include Phlex::Rails::Helpers::ContentFor
+
+      def view_template
+        content_for(:title) { "Non Development Environment" }
+        div(class: "w-full h-full p-4") do
+          h1(class: "text-2xl font-bold") do
+            "You are not allowed to access this page in non development environment"
+          end
+          p(class: "text-red-500 bg-white w-fit px-4 py-2 rounded-md my-2") do
+            "DATABASIUM IS NOT MEANT TO BE USED IN PRODUCTION, ALWAYS BE SURE TO NEVER EXPOSE IT TO THE PUBLIC."
+          end
+        end
+      end
+    end
+  end
+end

data/app/views/databasium/homepage/index.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Views
+  module Databasium
+    class Homepage::Index < Views::Base
+      include Phlex::Rails::Helpers::ContentFor
+
+      def view_template
+        content_for(:title) { "Homepage" }
+        div(class: "w-full h-full p-4") do
+          h1(class: "text-2xl font-bold") { "Hello world!" }
+          section(class: "p-4 text-base text-gray-300 flex flex-col gap-1") do
+            h2(class: "text-xl font-semibold") { "Welcome to Databasium" }
+            p { "Databasium is a developer tool for managing your database." }
+            p { "Its features are:" }
+            ul(class: "list-disc list-inside") do
+              li { "Create, read, update and delete(CRUD) data in your database." }
+              li { "Generate models and migrations for your database." }
+              li { "Generate schema for your database." }
+            end
+            p(class: "text-red-500 bg-white w-fit px-4 py-2 rounded-md my-2") do
+              "DATABASIUM IS NOT MEANT TO BE USED IN PRODUCTION, ALWAYS BE SURE TO NEVER EXPOSE IT TO THE PUBLIC."
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/app/views/databasium/migrations/index.rb

@@ -0,0 +1,33 @@
+module Views
+  module Databasium
+    class Migrations::Index < Views::Base
+      include Phlex::Rails::Helpers::FormWith
+      include Phlex::Rails::Helpers::TurboFrameTag
+      include Phlex::Rails::Helpers::LinkTo
+      include Phlex::Rails::Helpers::ButtonTo
+      include Phlex::Rails::Helpers::ContentFor
+
+      def initialize
+      end
+
+      def view_template
+        content_for(:title) { "Migrations" }
+        content_for(:sidebar) { render Components::Databasium::Migrations::Sidebar.new }
+        content_for(:header_actions) do
+          render Components::Databasium::Migrations::HeaderActions.new(migration: nil)
+        end
+        render_migration_frame
+      end
+
+      private
+
+      def render_migration_frame
+        turbo_frame_tag "migration", class: "flex-1" do
+          render Components::Databasium::Global::Suggestion.new(
+                   suggestions: [ "Select a migration to see the file" ]
+                 )
+        end
+      end
+    end
+  end
+end

data/app/views/databasium/migrations/new.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Views
+  module Databasium
+    class Migrations::New < Views::Base
+      include Phlex::Rails::Helpers::FormWith
+      include Phlex::Rails::Helpers::TurboFrameTag
+      include Phlex::Rails::Helpers::ContentFor
+
+      def initialize(tables:)
+        @tables = tables
+      end
+
+      def view_template
+        content_for(:title) { "New Migration" }
+        content_for(:sidebar) { render Components::Databasium::Migrations::Sidebar.new }
+        content_for(:header_actions) do
+          render Components::Databasium::Migrations::HeaderActions.new(migration: nil)
+        end
+        div(class: "flex p-4 gap-4") do
+          render Components::Databasium::Migrations::Form.new(tables: @tables, content: nil)
+          div(class: "flex-1 pe-4") do
+            render Components::Databasium::Migrations::Preview.new(content: nil)
+          end
+        end
+      end
+    end
+  end
+end

data/app/views/databasium/models/index.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Views
+  module Databasium
+    class Models::Index < Views::Base
+      include Phlex::Rails::Helpers::ContentFor
+
+      def initialize(models:)
+        @models = models
+      end
+
+      def view_template
+        content_for(:title) { "Models" }
+
+        div(class: "w-full h-full p-4") { render_models }
+      end
+
+      private
+
+      def render_models
+        div do
+          @models.each do |model|
+            div(class: "border-1 border-border rounded-xl p-4") do
+              h2(class: "text-lg font-semibold mb-2") { model.name }
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/app/views/databasium/models/new.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Views
+  module Databasium
+    class Models::New < Views::Base
+      include Phlex::Rails::Helpers::ContentFor
+      include Phlex::Rails::Helpers::TurboFrameTag
+
+      def initialize(content:, model: nil, attributes: nil, models: nil)
+        @model = model
+        @content = content
+        @attributes = attributes
+        @models = models
+      end
+
+      def view_template
+        content_for(:title) { "New Model" }
+        content_for(:sidebar) { render Components::Databasium::Models::Sidebar.new }
+        content_for(:header_actions) do
+          render Components::Databasium::Models::HeaderActions.new(model: @model)
+        end
+        div(class: "flex gap-4 p-4 overflow-y-hidden flex-1") do
+          div(class: "w-1/2 overflow-y-auto") do
+            render Components::Databasium::Models::Form.new(
+                     attributes: @attributes,
+                     model: @model,
+                     models: @models
+                   )
+          end
+          div(class: "flex-1 overflow-y-auto") do
+            render Components::Databasium::Models::ModelPreview.new(content: @content)
+          end
+        end
+      end
+    end
+  end
+end

data/app/views/databasium/records/index.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Views
+  module Databasium
+    class Records::Index < Views::Base
+      include Phlex::Rails::Helpers::ContentFor
+      include Phlex::Rails::Helpers::TurboFrameTag
+      include Phlex::Rails::Helpers::FormWith
+      include Phlex::Rails::Helpers::LinkTo
+
+      def initialize
+      end
+
+      def view_template
+        content_for(:title) { "Records" }
+        content_for(:sidebar) { render Components::Databasium::Records::Sidebar.new }
+        div(class: "flex min-h-0 min-w-0 flex-1") do
+          render Components::Databasium::Records::TableTurboFrame.new
+          render Components::Databasium::Records::Table::RecordPanel.new
+        end
+      end
+    end
+  end
+end

data/app/views/databasium/schemas/index.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Views
+  module Databasium
+    class Schemas::Index < Views::Base
+      include Phlex::Rails::Helpers::ContentFor
+      include Phlex::Rails::Helpers::LinkTo
+
+      def initialize(schema:, models:, pagy:, model:, layers:)
+        @schema = schema
+        @models = models
+        @pagy = pagy
+        @model = model
+        @layers = layers
+      end
+
+      def view_template
+        content_for(:title) { "Schema" }
+        content_for(:sidebar) { render Components::Databasium::Schemas::Sidebar.new }
+        content_for(:header_actions) do
+          render Components::Databasium::Schemas::HeaderActions.new(model: @model, layers: @layers)
+        end
+        div(class: "w-full h-full p-4") { render_schema }
+      end
+
+      private
+
+      def render_schema
+        div(
+          class: "w-full h-full border-1 border-border rounded-2xl p-4 overflow-x-auto",
+          data: {
+            controller: "graph",
+            graph_tables_value: @schema.to_json
+          }
+        ) { }
+      end
+    end
+  end
+end

data/app/views/layouts/databasium/application.rb

@@ -0,0 +1,56 @@
+module Views
+  module Layouts
+    class Databasium::Application < Views::Base
+      include Phlex::Rails::Layout
+      include Phlex::Rails::Helpers::ContentFor
+      include Phlex::Rails::Helpers::StylesheetLinkTag
+      include Phlex::Rails::Helpers::JavascriptImportmapTags
+      include Phlex::Rails::Helpers::TurboFrameTag
+      include Phlex::Rails::Helpers::Flash
+
+      def view_template(&block)
+        doctype
+
+        html do
+          head do
+            title { content_for?(:title) ? yield(:title) : "Databasium" }
+            meta charset: "utf-8"
+            csrf_meta_tags
+            csp_meta_tag
+            yield :head
+            stylesheet_link_tag "databasium",
+                                "data-turbo-track": Rails.env.production? ? "reload" : ""
+            javascript_importmap_tags "databasium/application"
+          end
+          body(
+            class: "flex h-dvh overflow-hidden bg-background text-main-text scrollbar-thin",
+            data: {
+              controller: "layout"
+            }
+          ) do
+            render Components::Databasium::Global::Error.new
+            render Components::Databasium::Global::Flash.new(
+                     success: flash[:success],
+                     error: flash[:error]
+                   )
+            render Components::Databasium::Global::Sidebar.new(sidebar: content_for(:sidebar))
+            turbo_frame_tag(
+              "main",
+              class: "flex flex-1 flex-col overflow-hidden",
+              data: {
+                controller: "toggle model table"
+              }
+            ) do
+              render Components::Databasium::Global::HeaderActions.new(
+                       actions: content_for(:header_actions)
+                     )
+              div(class: "flex min-h-0 min-w-0 flex-1 flex-col") do
+                yield block_given? ? block : block.call
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/config/importmap.rb

@@ -0,0 +1,12 @@
+pin "databasium/application", to: "databasium/application.js"
+pin "@hotwired/turbo-rails", to: "turbo.min.js", preload: true
+pin "@hotwired/stimulus", to: "stimulus.min.js", preload: true
+pin "@hotwired/stimulus-loading", to: "stimulus-loading.js", preload: true
+pin "@maxgraph/core", to: "https://esm.sh/@maxgraph/core@0.21.0"
+
+# Pin the controllers index so `import "controllers"` resolves
+pin "databasium/controllers", to: "databasium/controllers/index.js"
+
+# Auto-pin all Stimulus controllers under the namespace
+pin_all_from Databasium::Engine.root.join("app/assets/javascript/databasium/controllers"), under: "databasium/controllers"
+pin_all_from Databasium::Engine.root.join("app/assets/javascript/databasium/shapes"), under: "databasium/shapes"

data/config/initializers/heroicon.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "heroicon"
+
+Heroicon.configure do |config|
+  config.variant = :solid # Options are :solid, :outline and :mini
+
+  ##
+  # You can set a default class, which will get applied to every icon with
+  # the given variant. To do so, un-comment the line below.
+  # config.default_class = {solid: "h-5 w-5", outline: "h-6 w-6", mini: "h-4 w-4"}
+end

data/config/initializers/pagy.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+# Pagy initializer file (43.2.4)
+# See https://ddnexus.github.io/pagy/resources/initializer/
+
+############ Global Options ################################################################
+# See https://ddnexus.github.io/pagy/toolbox/options/ for details.
+# Add your global options below. They will be applied globally.
+# For example:
+#
+# Pagy.options[:limit] = 10               # Limit the items per page
+# Pagy.options[:client_max_limit] = 100   # The client can request a limit up to 100
+# Pagy.options[:max_pages] = 200          # Allow only 200 pages
+# Pagy.options[:jsonapi] = true           # Use JSON:API compliant URLs
+
+
+############ JavaScript ####################################################################
+# See https://ddnexus.github.io/pagy/resources/javascript/ for details.
+# Examples for Rails:
+# For apps with an assets pipeline
+# Rails.application.config.assets.paths << Pagy::ROOT.join('javascripts')
+#
+# For apps with a javascript builder (e.g. esbuild, webpack, etc.)
+# javascript_dir = Rails.root.join('app/javascript')
+# Pagy.sync_javascript(javascript_dir, 'pagy.mjs') if Rails.env.development?
+
+
+############# Overriding Pagy::I18n Lookup #################################################
+# Refer to https://ddnexus.github.io/pagy/resources/i18n/ for details.
+# Override the I18n lookup by dropping your custom dictionary in some pagy dir.
+# Example for Rails:
+#
+# Pagy::I18n.pathnames << Rails.root.join('config/locales/pagy')
+
+
+############# I18n Gem Translation #########################################################
+# See https://ddnexus.github.io/pagy/resources/i18n/ for details.
+#
+# Pagy.translate_with_the_slower_i18n_gem!
+
+
+############# Calendar Localization for non-en locales ####################################
+# See https://ddnexus.github.io/pagy/toolbox/paginators/calendar#localization for details.
+# Add your desired locales to the list and uncomment the following line to enable them,
+# regardless of whether you use the I18n gem for translations or not, whether with
+# Rails or not.
+#
+# Pagy::Calendar.localize_with_rails_i18n_gem(*your_locales)

data/config/initializers/phlex.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Views
+end
+
+module Components
+  extend Phlex::Kit
+end
+
+engine_views_path = Databasium::Engine.root.join("app/views")
+engine_components_path = Databasium::Engine.root.join("app/components")
+
+if engine_views_path.directory?
+  Rails.autoloaders.main.push_dir(engine_views_path, namespace: Views)
+end
+
+if engine_components_path.directory?
+  Rails.autoloaders.main.push_dir(engine_components_path, namespace: Components)
+end

data/config/routes.rb

@@ -0,0 +1,31 @@
+Databasium::Engine.routes.draw do
+  root to: "homepage#index"
+  resources :homepage, only: [ :index ]
+
+  resources :records, only: [ :index, :create, :update ] do
+    collection do
+      get :sidebar
+      delete :bulk_destroy
+      get :records
+    end
+  end
+  resources :migrations, only: [ :index, :new, :create, :show ] do
+    collection do
+      get :sidebar
+      post :run_pending_migrations
+      post :run_migration
+      post :rollback_migration
+    end
+  end
+  resources :models, only: [ :new, :create, :show ] do
+    collection do
+      get :sidebar
+    end
+  end
+  resources :schemas, only: [ :index, :new, :create ] do
+    collection do
+      get :sidebar
+      put :sync_schema
+    end
+  end
+end

data/config/tailwind.config.js

@@ -0,0 +1,10 @@
+module.exports = {
+  prefix: 'databasium-',
+  content: [
+    "./app/views/**/*.{erb,html}",
+    "./app/helpers/**/*.rb",
+    './config/initializers/heroicon.rb',
+  ],
+  theme: { extend: {} },
+  plugins: []
+}

data/lib/databasium/engine.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require "databasium/engine_mount"
+require "databasium/middleware/conditional_check_pending"
+
+module Databasium
+  class Engine < ::Rails::Engine
+    isolate_namespace Databasium
+
+    config.databasium = ActiveSupport::OrderedOptions.new
+
+    initializer "databasium.development_only" do
+      if Rails.env.production?
+        abort "
+          Databasium gem must not be loaded in production.
+          Add databasium only to the :development group.
+          It will not even allow you to load your application in production or when you run RAILS_ENV=production locally.
+          Do not add it to the default group."
+      end
+    end
+
+    initializer "databasium.configuration" do |app|
+      app.config.databasium ||= ActiveSupport::OrderedOptions.new
+    end
+
+    initializer "databasium.clear_mount_path_cache" do |app|
+      app.config.to_prepare { Databasium::EngineMount.clear_mount_path_cache! }
+    end
+
+    # Prevent the default global middleware; we insert a scoped version below.
+    initializer "databasium.skip_global_pending_migration_check",
+                before: "active_record.migration_error" do |app|
+      app.config.active_record.migration_error = :ignore if Rails.env.development?
+    end
+
+    initializer "databasium.conditional_check_pending",
+                after: "active_record.migration_error" do |app|
+      next unless Rails.env.development?
+
+      app.middleware.insert_after(
+        ActionDispatch::Callbacks,
+        Databasium::Middleware::ConditionalCheckPending,
+        file_watcher: app.config.file_watcher
+      )
+    end
+
+    initializer "databasium.assets" do |app|
+      app.config.assets.precompile += %w[ databasium_manifest.js ]
+    end
+
+    initializer "databasium.importmap", before: "importmap" do |app|
+      if app.respond_to?(:config) && app.config.respond_to?(:importmap)
+        app.config.importmap.paths << root.join("config/importmap.rb")
+      end
+    end
+  end
+end