rails_devtools 0.1.1

data/app/views/rails_devtools/image_assets/index.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module RailsDevtools
+  class ImageAssets::Index < ApplicationView
+    def initialize(form:, images_by_folder: {})
+      @images_by_folder = images_by_folder
+      @form = form
+    end
+
+    def view_template
+      render Components::PageContent.new do |page|
+        page.page_title { "Image assets" }
+        page.search_form(form: @form, path: helpers.image_assets_path)
+        page.results { results }
+      end
+    end
+
+    private
+
+    def results
+      if @images_by_folder.empty?
+        div(class: "text-neutral") { "No results found" }
+      else
+        div(class: "flex flex-col gap-12") do
+          @images_by_folder.each do |folder, images|
+            div do
+              h3(class: "text-lg font-bold mb-4 truncate") { folder }
+              div(class: "flex gap-4 flex-wrap w-full items-start") do
+                images.each do |image_info|
+                  render ImageAssets::ImageCard.new(image_info: image_info)
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/app/views/rails_devtools/routes/index.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module RailsDevtools
+  module Routes
+    class Index < ApplicationView
+      def initialize(form: nil, routes: [])
+        @routes = routes
+        @form = form
+      end
+
+      def view_template
+        render Components::PageContent.new do |page|
+          page.page_title { "Routes" }
+          page.search_form(form: @form, path: helpers.routes_path, method: :get)
+          page.results { results }
+        end
+      end
+
+      private
+
+      def results
+        if @routes.values.all? { |routes| routes.empty? }
+          div(class: "text-neutral") { "No results found" }
+        else
+          div(class: "flex gap-2 flex-wrap w-full items-start") do
+            @routes.each do |engine, routes|
+              h3(class: "first:mt-0 mt-4 text-neutral opacity-75 text-lg") { engine }
+              routes.each do |route|
+                render Routes::RouteCard.new(route: route, engine: engine)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/app/views/rails_devtools/routes/route_card.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module RailsDevtools
+  class Routes::RouteCard < Components::ApplicationComponent
+    def initialize(route:, engine:)
+      @route = route
+      @engine = engine
+    end
+
+    def view_template
+      a(
+        href: helpers.route_path(
+          @route.id
+        ),
+        data: { turbo_frame: "drawer_content", action: "click->checkbox#toggle" },
+        class: "group flex w-full"
+      ) do
+        div(class: "card card-compact bg-white text-sm w-full shadow-sm") do
+          div(class: "card-body") do
+            div(class: "flex flex-col sm:flex-row justify-between sm:items-center gap-y-2 sm:gap-x-2") do
+              div(class: "flex items-center") do
+                h2(class: "inline-flex card-title !mb-0 leading-none text-base items-center") do
+                  route_name
+                end
+                redirection_badge
+                no_matching_controller_alert
+                engine_badge
+              end
+              div(class: "flex gap-2 items-center justify-between sm:justify-normal") do
+                div(class: "truncate") { @route.path.gsub("(.:format)", "") }
+                div(class: "badge badge-sm ml-1") { @route.verb }
+              end
+            end
+          end
+        end
+      end
+    end
+
+    private
+
+    def route_name
+      if @route.inline?
+        @route.name
+      else
+        "#{@route.name}_path"
+      end
+    end
+
+    def no_matching_controller_alert
+      return unless @route.kind == "controller"
+      return if @route.controller_info.action_exists?
+
+      span(class: "text-error ml-1") do
+        render Components::Lucide::TriangleAlert.new(width: 16, height: 16)
+      end
+    end
+
+    def engine_badge
+      return unless @route.engine?
+
+      span(class: "badge badge-sm badge-accent ml-1") { "engine" }
+    end
+
+    def redirection_badge
+      return unless @route.redirection?
+
+      span(class: "badge badge-sm badge-accent ml-1") { @route.redirection_info.status }
+    end
+  end
+end

data/app/views/rails_devtools/routes/route_details/controller_card.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module RailsDevtools
+  module Routes
+    class RouteDetails::ControllerCard < Components::ApplicationComponent
+      def initialize(controller_info:)
+        @controller_info = controller_info
+      end
+
+      delegate(
+        :full_class_name,
+        :action,
+        :controller,
+        :action_exists?,
+        :file_path,
+        to: :@controller_info
+      )
+
+      def view_template
+        div(class: card_class) do
+          div(class: "card-body") do
+            div(class: [
+                  "text-base flex justify-between gap-4 items-center",
+                  error? && "text-error"
+                ]) do
+              div(class: "flex items-center ") do
+                if error?
+                  span(class: "mr-1") do
+                    render Components::Lucide::TriangleAlert.new(width: 16, height: 16)
+                  end
+                end
+                h4(class: "font-bold") { full_class_name }
+              end
+              span(class: "italic") { action }
+            end
+
+            if error?
+              ul(class: "text-sm text-error mt-2") do
+                if controller.nil?
+                  li { "No controller found for this route." }
+                else
+                  li { "No action ##{action} found in associated controller." }
+                end
+              end
+            end
+
+            div(class: "card-actions justify-end mt-8") do
+              controller_file_path_input
+            end
+          end
+        end
+      end
+
+      private
+
+      def card_class
+        [
+          "card card-compact bg-white text-sm w-full shadow-sm mb-4",
+          error? ? "border border-error" : "border border-base-300"
+        ].compact.join(" ")
+      end
+
+      def error?
+        !action_exists?
+      end
+
+      def controller_file_path_input
+        div(
+          class: "",
+          data_controller: "clipboard",
+          data_clipboard_success_content_value: "Copied!"
+        ) do
+          input(
+            value: file_path,
+            class: "hidden",
+            data_clipboard_target: "source"
+          )
+          button(
+            class: ["btn  btn-outline btn-xs", error? ? "btn-error" : "btn-primary"],
+            data_action: "clipboard#copy",
+            data_clipboard_target: "button"
+          ) { "Copy file path" }
+        end
+      end
+    end
+  end
+end

data/app/views/rails_devtools/routes/route_details/route_path_input.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module RailsDevtools
+  module Routes
+    class RouteDetails::RoutePathInput < Components::ApplicationComponent
+      def initialize(route:, prefix: "", suffix: "path")
+        @route = route
+        @prefix = prefix
+        @suffix = suffix
+      end
+
+      def view_template
+        turbo_frame_tag("route_path_input") do
+          div(
+            class: "join w-full",
+            data_controller: "clipboard",
+            data_clipboard_success_content_value: "Copied!"
+          ) do
+            input(
+              value: input_value,
+              class: "input input-bordered input-primary input-sm w-full join-item",
+              data_clipboard_target: "source"
+            )
+            button(
+              class: "btn btn-primary btn-outline btn-sm join-item",
+              data_action: "clipboard#copy",
+              data_clipboard_target: "button"
+            ) { "Copy" }
+          end
+        end
+      end
+
+      private
+
+      def input_value
+        "#{prefix}#{@route.name}_#{@suffix}()"
+      end
+
+      def prefix
+        return "" if @prefix.blank?
+
+        "#{@prefix}."
+      end
+    end
+  end
+end

data/app/views/rails_devtools/routes/route_details.rb

@@ -0,0 +1,171 @@
+# frozen_string_literal: true
+
+module RailsDevtools
+  class Routes::RouteDetails < Components::ApplicationComponent
+    include Phlex::Rails::Helpers::FormWith
+
+    def initialize(route:)
+      @route = route
+    end
+
+    def view_template
+      turbo_frame_tag("drawer_content") do
+        div(class: "mt-4 w-full sm:min-w-80") do
+          engine_name
+          div(class: "flex justify-between gap-x-2 items-center") do
+            h3(class: "text-lg font-bold mb-2") { route_name }
+            div(class: "badge badge-lg bg-base-300 text-sm") { @route.verb }
+          end
+          p(class: "text-sm text-neutral") { only_path }
+          open_link
+          segments
+          div(class: "mt-4 pt-4 border-t-2 border-base-300 mt-2 text-sm text-neutral") do
+            more_info_card
+          end
+          route_path_input
+        end
+      end
+    end
+
+    private
+
+    def more_info_card
+      case @route.kind
+      when "controller"
+        controller_card
+      when "redirection"
+        redirection_card
+      when "rack_app"
+        rack_app_card
+      when "inline"
+        inline_card
+      when "engine"
+        engine_card
+      end
+    end
+
+    def route_name
+      if @route.inline?
+        @route.endpoint
+      else
+        "#{@route.name}_path"
+      end
+    end
+
+    def redirection_card
+      div(class: "card card-compact bg-white text-sm w-full shadow-sm mb-4 border border-base-300") do
+        div(class: "card-body flex flex-col lg:flex-row lg:justify-between lg:items-center gap-4") do
+          h3(class: "block text-lg font-bold mb-2") { "Redirection #{@route.redirection_info.status}" }
+          div(class: "text-sm text-neutral") { @route.redirection_info.block }
+        end
+      end
+    end
+
+    def rack_app_card
+      div(class: "card card-compact bg-white text-sm w-full shadow-sm mb-4 border border-base-300") do
+        div(class: "card-body flex flex-col lg:flex-row lg:justify-between lg:items-center gap-4") do
+          h3(class: "block text-lg font-bold mb-2") { "Custom rack app #{@route.name}" }
+        end
+      end
+    end
+
+    def engine_card
+      div(class: "card card-compact bg-white text-sm w-full shadow-sm mb-4 border border-base-300") do
+        div(class: "card-body flex flex-col lg:flex-row lg:justify-between lg:items-center gap-4") do
+          h3(class: "block text-lg font-bold mb-2") { "Mounted engine #{@route.name}" }
+        end
+      end
+    end
+
+    def controller_card
+      render Routes::RouteDetails::ControllerCard.new(
+        controller_info: @route.controller_info
+      )
+    end
+
+    def inline_card
+      div(class: "card card-compact bg-white text-sm w-full shadow-sm mb-4 border border-base-300") do
+        div(class: "card-body flex flex-col lg:flex-row lg:justify-between lg:items-center gap-4") do
+          h3(class: "block text-lg font-bold mb-2") { @route.endpoint }
+        end
+      end
+    end
+
+    def engine_name
+      return unless @route.engine_info.engine?
+
+      div(class: "text-neutral opacity-75") do
+        @route.engine_info.name
+      end
+    end
+
+    def only_path
+      @route.path.gsub("(.:format)", "")
+    end
+
+    def open_link
+      return unless @route.controller_info.action_exists?
+      return if @route.segments.any? || @route.verb != "GET"
+
+      div(class: "mt-2 flex justify-end") do
+        a(href: only_path, target: "_blank", class: "btn btn-xs btn-outline btn-neutral opacity-75") do
+          render RailsDevtools::Components::Lucide::ExternalLink.new(width: 16, height: 16)
+          span { "Open" }
+        end
+      end
+    end
+
+    def segments
+      return unless @route.segments.any?
+
+      div(class: "mt-4 pt-4 border-t-2 border-base-300 mt-2 text-sm text-neutral") do
+        h3(class: "text-lg font-bold mb-2") { "Segments" }
+        ul(class: "flex gap-x-2") do
+          @route.segments.each do |segment|
+            li(class: "badge badge-md badge-outline badge-neutral opacity-75") { segment }
+          end
+        end
+      end
+    end
+
+    def route_path_input
+      return if @route.inline?
+
+      turbo_frame_tag("route_path_input_form") do
+        div(data_controller: "turbo-form") do
+          form_with(
+            url: helpers.routes_route_path_input_path(@route.id),
+            method: :patch,
+            data: { turbo_frame: "route_path_input", turbo_form_target: "form" }
+          ) do |form|
+            div(class: "flex gap-2") do
+              engine_checkbox(form)
+              div do
+                label(class: "label cursor-pointer justify-normal gap-1") do
+                  span(class: "label-text") { "URL" }
+                  form.check_box(
+                    :url_suffix,
+                    class: "checkbox checkbox-xs",
+                    data: { action: "change->turbo-form#submit" }
+                  )
+                end
+              end
+            end
+          end
+        end
+      end
+      render Routes::RouteDetails::RoutePathInput.new(route: @route)
+    end
+
+    def engine_checkbox(form)
+      return unless @route.engine_info.engine?
+
+      div do
+        label(class: "label cursor-pointer justify-normal gap-1") do
+          span(class: "label-text") { "engine" }
+          form.check_box(:engine_prefix, class: "checkbox checkbox-xs", data: { action: "change->turbo-form#submit" })
+        end
+      end
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+RailsDevtools::Engine.routes.draw do
+  root to: "database_tables#index"
+  get "*path.js.map", to: proc { [204, {}, [""]] }
+
+  resources :image_assets, only: [:show, :index, :destroy]
+  resources :database_tables, only: [:show, :index]
+  resources :gems, only: [:show, :index]
+
+  resources :routes, only: [:show, :index]
+  namespace :routes do
+    resources :route_path_inputs, only: :update
+  end
+
+  namespace :frontend do
+    get "modules/*path", to: "modules#show", format: :js, constraints: ->(request) { request.path.end_with?(".js") }
+  end
+
+  get "host_app_images/*path", as: :host_app_image, to: "host_app_images#show",
+                               constraints: lambda { |request|
+                                 request.path.end_with?(*RailsDevtools::ImageAssets::ImageInfo::IMAGE_EXTENSIONS.to_a)
+                               }
+end

data/lib/rails_devtools/asset_config.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module RailsDevtools
+  class AssetConfig
+    def self.find
+      providers = AssetProvider.new.list
+      new(providers)
+    end
+
+    def initialize(providers)
+      @providers = providers
+    end
+
+    def paths
+      @paths ||= @providers.flat_map(&:paths)
+    end
+
+    def helper_snippet
+      if vite_rails?
+        "vite_image_tag"
+      else
+        "image_tag"
+      end
+    end
+
+    def implicit_path
+      if vite_rails?
+        ""
+      else
+        "images/"
+      end
+    end
+
+    def vite_rails?
+      @providers.any? { |p| p.provider == :vite_rails }
+    end
+  end
+
+  class AssetProvider
+    PROVIDERS = [
+      AssetProviders::SprocketConfig,
+      AssetProviders::ViteRailsConfig,
+      AssetProviders::JsbundlingRailsConfig,
+      AssetProviders::ShakapackerConfig,
+      AssetProviders::PropshaftConfig
+    ].freeze
+
+    def list
+      @list ||= PROVIDERS.select { |config| config.new.used? }.map(&:new)
+    end
+  end
+end

data/lib/rails_devtools/asset_providers/jsbundling_rails_config.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module RailsDevtools
+  module AssetProviders
+    class JsbundlingRailsConfig
+      def provider
+        :jsbundling_rails
+      end
+
+      def paths
+        [Rails.root.join("app/javascript").to_s]
+      end
+
+      def used?
+        Bundler.definition.dependencies.any? do |dep|
+          dep.name == "jsbundling-rails"
+        end
+      end
+    end
+  end
+end

data/lib/rails_devtools/asset_providers/propshaft_config.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module RailsDevtools
+  module AssetProviders
+    class PropshaftConfig
+      def provider
+        :propshaft
+      end
+
+      def paths
+        Rails.application.config.assets.paths.select { |p| p.to_s.end_with?("images") }
+      end
+
+      def used?
+        defined?(Propshaft)
+      end
+    end
+  end
+end

data/lib/rails_devtools/asset_providers/shakapacker_config.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module RailsDevtools
+  module AssetProviders
+    class ShakapackerConfig
+      def provider
+        :shakapacker
+      end
+
+      def paths
+        return @paths if defined?(@paths)
+
+        shakapacker_config_path = Rails.root.join("config", "shakapacker.yml")
+        shakapacker_config = YAML.load_file(shakapacker_config_path, aliases: true)
+
+        @paths = Set.new([shakapacker_config["source_path"]])
+        additional_paths = Set.new(shakapacker_config["additional_paths"])
+        @paths = @paths.merge(additional_paths).to_a.compact
+      end
+
+      def used?
+        Rails.root.join("config", "shakapacker.yml").exist?
+      end
+    end
+  end
+end

data/lib/rails_devtools/asset_providers/sprocket_config.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module RailsDevtools
+  module AssetProviders
+    class SprocketConfig
+      def provider
+        :sprockets
+      end
+
+      def paths
+        Rails.application.config.assets.paths.select { |p| p.to_s.end_with?("images") }
+      end
+
+      def used?
+        Rails.application.config.respond_to?(:assets)
+      end
+    end
+  end
+end

data/lib/rails_devtools/asset_providers/vite_rails_config.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module RailsDevtools
+  module AssetProviders
+    class ViteRailsConfig
+      def provider
+        :vite_rails
+      end
+
+      def paths
+        [Rails.root.join("app/frontend").to_s]
+      end
+
+      def used?
+        Rails.root.join("config/vite.json").exist?
+      end
+    end
+  end
+end

data/lib/rails_devtools/engine.rb

@@ -0,0 +1,22 @@
+require "fastimage"
+require "phlex-rails"
+require "turbo-rails"
+
+module RailsDevtools
+  class Engine < ::Rails::Engine
+    isolate_namespace RailsDevtools
+
+    # rubocop:disable Layout/LineLength
+    initializer "rails_devtools.environment_check" do
+      unless Rails.env.local?
+        raise "Rails Devtools can only be used in your local environment. Please make sure that it is not included in production environment in your gemfile."
+      end
+    end
+    # rubocop:enable Layout/LineLength
+
+    # Add views to autoload paths for Phlex
+    config.autoload_paths << "#{root}/app/views"
+    config.autoload_paths << "#{root}/app/views/layouts"
+    config.autoload_paths << "#{root}/app/views/components"
+  end
+end

data/lib/rails_devtools/importmap.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module RailsDevtools
+  class Importmap < Importmaps::Base
+    pin "@hotwired/turbo-rails", to: "turbo.min.js", vendor: true
+    pin "@hotwired/stimulus", to: "stimulus.min.js", vendor: true
+    pin "@hotwired/stimulus-loading", to: "stimulus-loading.js", vendor: true
+    pin "@stimulus-components/reveal", to: "@stimulus-components--reveal.js", vendor: true # @5.0.0
+    pin "@stimulus-components/clipboard", to: "@stimulus-components--clipboard.js", vendor: true # @5.0.0
+    pin "@stimulus-components/notification", to: "@stimulus-components--notification.js", vendor: true # @3.0.0
+    pin "stimulus-use", vendor: true # @0.52.2
+
+    pin "application"
+    pin_all_from RailsDevtools::Engine.root.join("app/javascript/controllers"), under: "controllers"
+  end
+end