rails_devtools 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d185839dcc19c72b18c2f20b4be8846054d829f8b6d0b517b512fc8c17ea5c99
+  data.tar.gz: b9af4f7560bb0ad748e35db0aaf3566f49bd4d020cc3bdf99564da79251d1156
+SHA512:
+  metadata.gz: 9f5311dd1591a436c7d0e81b6545a1131a014affb8e9b94cdecea219d42d33974e25d54dabb4243f21ac93d4c64000410f0ed0447de82498d5c68f7c30b984a2
+  data.tar.gz: 70286d2e5bb2ab8ca7670deb7335a941b3ec549ca70e00f801a490d5d900e821ba06d8ae6f53551b75406fa71932c546e02b1426746d1a0f6b0ca5d9bb3837ed

data/README.md

@@ -0,0 +1,92 @@
+# Rails Devtools
+
+Rails Devtools is a set of "quality of life" tools for your rails project, distributed as a rails engine.
+This is inspired by the likes of Nuxt Devtools, Laravel Telescope...
+
+This gem is meant to be only used in development, and cannot work at all in production.
+
+> [!IMPORTANT]
+> The gem is an alpha version. Is has been tested on several Rails projects from Rails 7.1 to Rails 8.0. It should work on many projects but it could also break easily if your project has some tricky stuff I didn't think about.
+> If you encounter a bug, please create an issue, I'll do my best to fix it.
+
+<br />
+
+## Installation
+
+- Add the gem to your Gemfile
+```ruby
+  gem 'rails-devtools, group: :development'
+````
+
+- Mount the engine in your routes
+```ruby
+ mount RailsDevtools::Engine => "/devtools"
+```
+
+- Update the bundle
+ ```sh
+bundle install
+```
+- Go to `http://localhost:3000/devtools`
+
+<br /><br />
+
+ ## Screenshots
+<details>
+<summary> Expand to see more screnshots
+ <br /><br />
+<img width="1187" alt="devtools_database_tables" src="https://github.com/user-attachments/assets/a5289293-c8c1-475c-abb2-b3c3f322c281" />
+</summary>
+<img width="1191" alt="devtools_gems" src="https://github.com/user-attachments/assets/204293e5-3eaf-400d-99e9-74e493571997" />
+<img width="1194" alt="devtools_image_assets" src="https://github.com/user-attachments/assets/f6b41437-9ea4-4d0e-b1d5-3aff9c156730" />
+<img width="1188" alt="devtools_routes" src="https://github.com/user-attachments/assets/9bcd8435-cc7e-48a3-8a71-83b2ee99afd7" />
+<img width="459" alt="devtools_routes_responsive" src="https://github.com/user-attachments/assets/e3e3ff2d-a54e-4e45-9618-1653d4291d0c" />
+<img width="474" alt="devtools_routes_details_responsive" src="https://github.com/user-attachments/assets/a245e2d0-23d1-4a19-b871-a738a68cd83a" />
+</details>
+<br /><br />
+
+## Features
+
+Rails Devtools are fully responsive. I think of them as a companion to my editing efforts and I want to be able to put them next to my IDE.
+
+#### Database tables
+- List all your database tables along with their columns and indexes.
+- Search for tables or columns
+
+#### Routes
+- List all your application routes
+- Display details about it, along with helpful actions and snippets
+- Warn if a route is not linked to a controller / action (details provide more information)
+- Search for routes by name
+
+#### Image assets
+Since there are quite a few asset pipelines in the rails ecosystem, Rails Devtools detects which one is used and adapts its behavior to it. It supports Propshaft, Sprockets, Shakapacker, JS-Bundling-Rails and Vite-Rails.
+
+- list image assets in your codebase
+- Display information about them, along with helpful actions and snippets
+- Search for images by name
+
+#### Gems
+- list gems in your bundle
+- display their summary
+- display links to their code source, website...
+- display outdated gems along with information about the last version
+- search for gems by name
+<br /><br />
+> [!NOTE]
+> Most of those features are starting points. There are many ways to get a better grasp of a rails codebase. I have some in mind but if you happen to have ideas, feel free to share them in the discussions!
+
+<br /><br />
+## Philosophy
+
+As developers, we spend much of our time looking at walls of text. Our codebase does not provide any information architecture, besides classes or methods. There is no high level view of the project, and most of the tooling is either a bunch of commands to run or a script found on stackoverflow.
+
+Rails, as a framework, knows many things about our project. This might seem obvious but it knows how to match a route and a controller, what path you need to write to use an image, or what scopes are defined on a model.
+
+When you run `rails s`, all those informations are available. But they are hidden behind the mysteries of ActiveRecord, Rails.application and so on.
+
+This is why I believe that it makes a lot of sense to provide tools that surface these informations when needed, in a friendly way.
+
+<br /><br />
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/app/assets/config/devtools_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/devtools .css

data/app/assets/stylesheets/devtools/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/rails_devtools/application_controller.rb

@@ -0,0 +1,4 @@
+module RailsDevtools
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/rails_devtools/base_controller.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module RailsDevtools
+  class BaseController < ApplicationController
+    layout -> { ApplicationLayout }
+  end
+end

data/app/controllers/rails_devtools/database_tables_controller.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module RailsDevtools
+  class DatabaseTablesController < BaseController
+    def index
+      form = DatabaseTableSearchForm.new(search: form_params[:search])
+      render DatabaseTables::Index.new(tables: form.results, form: form)
+    end
+
+    private
+
+    def form_params
+      params[:database_table_search_form] || { search: "" }
+    end
+  end
+end

data/app/controllers/rails_devtools/frontend/modules_controller.rb

@@ -0,0 +1,18 @@
+module RailsDevtools
+  module Frontend
+    class ModulesController < ApplicationController
+      protect_from_forgery except: :show
+
+      def show
+        file = RailsDevtools.importmap.find(params[:path]).file_path
+        return head :not_found unless file
+
+        send_file(
+          file,
+          type: "application/javascript",
+          disposition: "inline"
+        )
+      end
+    end
+  end
+end

data/app/controllers/rails_devtools/gems_controller.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module RailsDevtools
+  class GemsController < BaseController
+    def index
+      form = GemSearchForm.new(search: form_params[:search])
+      render Gems::Index.new(gems: form.results, form: form)
+    end
+
+    private
+
+    def form_params
+      params[:gem_search_form] || { search: "" }
+    end
+  end
+end

data/app/controllers/rails_devtools/host_app_images_controller.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module RailsDevtools
+  class HostAppImagesController < BaseController
+    def show
+      return head :not_found unless image?
+
+      image_path = find_source_image
+      return head :not_found unless image_path
+
+      mime_type = Mime::Type.lookup_by_extension(params[:format])
+
+      send_file image_path, type: mime_type, disposition: "inline"
+    end
+
+    private
+
+    def image?
+      ImageAssets::ImageInfo::IMAGE_EXTENSIONS.include?(".#{params[:format]}")
+    end
+
+    def find_source_image
+      filename = CGI.unescape(File.basename(params[:path]))
+      found = nil
+
+      RailsDevtools.asset_config.paths.each do |base_path|
+        paths = Dir.glob("#{base_path}/**/*#{filename}*")
+        found = paths.find { |file_path| File.file?(file_path) }
+        break if found
+      end
+
+      found
+    end
+  end
+end

data/app/controllers/rails_devtools/image_assets_controller.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module RailsDevtools
+  class ImageAssetsController < BaseController
+    def show
+      image_info = ImageAssets::ImageInfo.new(params[:image_path])
+      render ImageAssets::ImageDetails.new(image_info: image_info)
+    end
+
+    def index
+      form = ImageSearchForm.new(search: form_params[:search])
+      render ImageAssets::Index.new(images_by_folder: form.results, form: form)
+    end
+
+    def destroy
+      image_info = ImageAssets::ImageInfo.new(params[:image_path])
+      raise "This is a not an image" unless image_info.valid?
+
+      File.delete(image_info.full_path)
+
+      respond_to do |format|
+        format.html { redirect_to image_assets_path, notice: "Image was successfully destroyed." }
+        format.turbo_stream {
+          render turbo_stream: [
+            turbo_stream.remove(image_info.full_path),
+            turbo_stream.append(
+              "flash_messages",
+              Components::FlashMessage.new(
+                message: "Image was successfully destroyed."
+              )
+            )
+          ]
+        }
+      end
+    end
+
+    private
+
+    def form_params
+      params[:image_search_form] || { search: "" }
+    end
+  end
+end

data/app/controllers/rails_devtools/routes/route_path_inputs_controller.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module RailsDevtools
+  module Routes
+    class RoutePathInputsController < ApplicationController
+      def update
+        route = Routes::Collection.find(params[:id])
+
+        input_params = { route: route }
+
+        if params[:engine_prefix].present? && params[:engine_prefix] == "1"
+          input_params.merge!(prefix: route.engine_info.helper_prefix)
+        end
+
+        if params[:url_suffix].present? && params[:url_suffix] == "1"
+          input_params.merge!(suffix: "url")
+        end
+
+        render Routes::RouteDetails::RoutePathInput.new(**input_params)
+      end
+    end
+  end
+end

data/app/controllers/rails_devtools/routes_controller.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module RailsDevtools
+  class RoutesController < BaseController
+    def index
+      form = RouteSearchForm.new(search: form_params[:search])
+      render Routes::Index.new(routes: form.results, form: form)
+    end
+
+    def show
+      route = Routes::Collection.find(params[:id])
+      render Routes::RouteDetails.new(route: route)
+    end
+
+    private
+
+    def form_params
+      params[:route_search_form] || { search: "" }
+    end
+  end
+end

data/app/forms/rails_devtools/database_table_search_form.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module RailsDevtools
+  class DatabaseTableSearchForm
+    include ActiveModel::Model
+
+    DatabaseTable = Data.define(:table_name, :columns, :indexes)
+
+    def initialize(search: "")
+      @search = search.downcase
+    end
+
+    def results
+      table_names = ActiveRecord::Base.connection.tables - ["schema_migrations", "ar_internal_metadata"]
+
+      tables = table_names.map do |table|
+        DatabaseTable.new(
+          table_name: table,
+          columns: ActiveRecord::Base.connection.columns(table),
+          indexes: indexes(table)
+        )
+      end
+
+      return tables if @search.empty?
+
+      tables.select do |table|
+        table.table_name.include?(@search) ||
+          table.columns.any? { |column| column.name.include?(@search) }
+      end
+    end
+
+    private
+
+    ShortIndex = Data.define(:name, :columns, :unique)
+
+    def indexes(table)
+      indexes = ActiveRecord::Base.connection.indexes(table)
+      indexes.map do |index|
+        long_name = index.name
+        prefix = "index_#{table}_on_"
+        short_name = long_name.gsub(prefix, "").humanize
+
+        ShortIndex.new(
+          name: short_name,
+          columns: index.columns,
+          unique: index.unique
+        )
+      end
+    end
+  end
+end

data/app/forms/rails_devtools/gem_search_form.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module RailsDevtools
+  class GemSearchForm
+    include ActiveModel::Model
+
+    GemInfo = Data.define(
+      :name,
+      :required_version,
+      :actual_version,
+      :homepage,
+      :summary,
+      :source_code,
+      :documentation,
+      :groups,
+      :date,
+      :latest_version,
+      :changelog
+    ) do
+      def outdated?
+        return false if latest_version.nil?
+
+        actual_version < latest_version.version
+      end
+    end
+
+    def initialize(search: "")
+      @search = search.downcase
+    end
+
+    def results
+      specs = ask_bundler_for_specs
+      gems_list = specs.map { |gem_spec| GemInfo.new(**gem_spec) }
+
+      return order(gems_list) if @search.empty?
+
+      order(
+        gems_list.select { |gem| gem.name.include?(@search) }
+      )
+    end
+
+    private
+
+    GROUP_PRIORITY = {
+      "default" => 0,
+      "production" => 1,
+      "development" => 2,
+      "development-test" => 3,
+      "test" => 4
+    }.freeze
+
+    def order(gems)
+      gems.sort_by do |item|
+        [GROUP_PRIORITY.fetch(item.groups.join("-"), 5), item.name]
+      end
+    end
+
+    LatestSpec = Data.define(:version, :date)
+
+    def ask_bundler_for_specs
+      bundle = Bundler.load
+
+      dependencies = bundle.dependencies.map { |dep| [dep.name, dep.groups] }.to_h
+      specs = bundle.specs.select do |spec|
+        dependencies.keys.include?(spec.name)
+      end
+
+      specs.map do |spec|
+        latest_spec = Gem.latest_spec_for(spec.name)
+        {
+          name: spec.name,
+          latest_version: latest_spec ? LatestSpec.new(version: latest_spec.version, date: latest_spec.date) : nil,
+          date: spec.date,
+          required_version: spec.requirements.to_s,
+          actual_version: spec.version.to_s,
+          homepage: spec.homepage,
+          summary: spec.summary,
+          source_code: spec.metadata["source_code_uri"],
+          documentation: spec.metadata["documentation_uri"],
+          changelog: spec.metadata["changelog_uri"],
+          groups: dependencies[spec.name]
+        }
+      end
+    end
+  end
+end

data/app/forms/rails_devtools/image_search_form.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module RailsDevtools
+  class ImageSearchForm
+    include ActiveModel::Model
+
+    def initialize(search: "")
+      @search = search
+    end
+
+    def results
+      folders = RailsDevtools.asset_config.paths
+
+      images_by_folder = Hash.new { |hash, key| hash[key] = [] }
+      extensions = ImageAssets::ImageInfo::IMAGE_EXTENSIONS.map { |ext| ext.delete_prefix(".") }.join(",")
+
+      folders.each do |dir|
+        Dir.glob("#{dir}/**/*{#{@search.upcase}, #{@search.downcase}}*.{#{extensions}}").each do |path|
+          image_info = ImageAssets::ImageInfo.new(path)
+          next unless image_info.valid?
+
+          dir = File.dirname(path).gsub(Rails.root.to_s, "")
+          images_by_folder[dir] << image_info
+        end
+      end
+
+      images_by_folder
+    end
+  end
+end

data/app/forms/rails_devtools/route_search_form.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module RailsDevtools
+  class RouteSearchForm
+    include ActiveModel::Model
+
+    def initialize(search: "")
+      @search = search.downcase
+    end
+
+    def results
+      Routes::Collection.all
+        .select { |route| route.name.downcase.include?(@search) }
+        .group_by { |route| route.engine_info.name }
+    end
+  end
+end

data/app/helpers/rails_devtools/application_helper.rb

@@ -0,0 +1,4 @@
+module RailsDevtools
+  module ApplicationHelper
+  end
+end

data/app/javascript/application.js

@@ -0,0 +1,4 @@
+import "@hotwired/turbo-rails"
+import "controllers"
+
+console.log("Hello from application.js")

data/app/javascript/controllers/application.js

@@ -0,0 +1,10 @@
+import { Application } from "@hotwired/stimulus"
+
+const application = Application.start()
+
+// Configure Stimulus development experience
+application.debug = true
+window.Stimulus = application
+
+console.log("Hello from controllers/application.js")
+export { application }

data/app/javascript/controllers/checkbox_controller.js

@@ -0,0 +1,9 @@
+import { Controller } from "@hotwired/stimulus"
+
+export default class extends Controller {
+  static targets = ["checkbox"]
+
+  toggle() {
+    this.checkboxTarget.checked = !this.checkboxTarget.checked
+  }
+}

data/app/javascript/controllers/index.js

@@ -0,0 +1,11 @@
+import { application } from "controllers/application";
+import RevealController from '@stimulus-components/reveal'
+import Clipboard from '@stimulus-components/clipboard'
+import Notification from '@stimulus-components/notification'
+import { eagerLoadControllersFrom } from "@hotwired/stimulus-loading"
+
+application.register('reveal', RevealController)
+application.register('clipboard', Clipboard)
+application.register('notification', Notification)
+
+eagerLoadControllersFrom("controllers", application)

data/app/javascript/controllers/search_reset_controller.js

@@ -0,0 +1,7 @@
+import { Controller } from '@hotwired/stimulus'
+
+export default class extends Controller {
+  reset() {
+    this.dispatch("search.reset")
+  }
+}

data/app/javascript/controllers/turbo_form_controller.js

@@ -0,0 +1,9 @@
+import { Controller } from "@hotwired/stimulus"
+
+export default class extends Controller {
+  static targets = ["form"]
+
+  submit() {
+    this.formTarget.requestSubmit()
+  }
+}

data/app/jobs/rails_devtools/application_job.rb

@@ -0,0 +1,4 @@
+module RailsDevtools
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/rails_devtools/application_mailer.rb

@@ -0,0 +1,6 @@
+module RailsDevtools
+  class ApplicationMailer < ActionMailer::Base
+    default from: "from@example.com"
+    layout "mailer"
+  end
+end

data/app/models/rails_devtools/application_record.rb

@@ -0,0 +1,5 @@
+module RailsDevtools
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end