rails_route_finder 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4e9e56607bae548dfe2480790c9f5e28c2ba5915dd9c7604b7ea9954f4830a78
+  data.tar.gz: 97149337b3ea9d995444881567fdd2ffe487750e39b0a6ed78faadf042585e15
+SHA512:
+  metadata.gz: 0a953132a650e26da8ab071279bf4898242aae3b6b702a82e5f94c8aace255c722ff913408bf002575909e62091a740ae89d206775f1208692318c79c536e443
+  data.tar.gz: 2eb8ed2e42a20e5f79456dd7cf275a3f3cc00e747290f3e4ccd56b3ce6d35c438bc7a0b60beabf0258783d9425c9d693e52114a6279ba78fe4386fd47d1f4ba2

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-03-31
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 gagegolden00
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,45 @@
+# RailsRouteFinder
+
+RailsRouteFinder is a gem designed to help Rails developers visualize and analyze the routes of their application. The gem allows you to list, filter, and analyze routes based on various parameters such as path, HTTP verb, controller#action, required parameters, and namespaces.
+
+## Installation
+
+Download the gem and note its location.
+Add Rails Route Finder to your gemfile like so.
+
+> ` gem 'rails_route_finder', path: 'absolute/path/to/rails_route_finder' `
+
+Then run `bundle install`
+
+### Inject Routes into Your Application
+
+After installing the gem, you'll need to inject the routes provided by `RailsRouteFinder` into your application. To do this, add the following snippet to your `config/routes.rb` file:
+
+# In config/routes.rb
+RailsRouteFinder::Engine.routes.draw do
+  get 'index', to: 'routes#index', as: :index
+  root to: 'routes#index'
+end
+
+This will add a new route (`/rails_route_finder`) to your application that you can visit to visualize your application's routes.
+
+## Usage
+
+Once installed, you can access the `/rails_route_finder` route to see an overview of all your application's routes. The routes will be displayed with details like:
+
+- Path
+- HTTP verb
+- Controller#action
+- Required parameters
+- Namespace
+
+You can filter, sort, and analyze these routes based on the provided parameters.
+
+## Development
+TO DO
+
+## Contributing
+TO DO
+
+## License
+TO DO 

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+task default: :test

data/app/assets/stylesheets/rails_route_finder/rails_route_finder_index.css

@@ -0,0 +1,202 @@
+body {
+  background-color: #1e1e1e;
+  color: #e0e0e0;
+  font-family: Arial, sans-serif;
+  display: flex;
+  flex-direction: column;
+}
+
+.page {
+  margin-top: 20px;
+  display: flex;
+  flex-direction: column;
+  width: 100%;
+}
+
+.search-header {
+  display: flex;
+  justify-content: space-between;
+  align-items: center;
+  width: 100%;
+  margin-bottom: 20px;
+}
+
+h1 {
+  font-size: 28px;
+  color: #d9534f;
+  flex-shrink: 0;
+  width: 7%;
+}
+
+.filtering-form {
+  display: flex;
+  align-items: center;
+  justify-content: flex-start;
+  gap: 15px;
+  padding: 10px;
+  width: 90%;
+  border: 2px solid #444;
+  background-color: #333;
+  border-radius: 6px;
+  flex-wrap: wrap;
+}
+
+.sort-filter-form {
+  display: flex;
+  flex-wrap: wrap;
+  align-items: center;
+  width: 100%;
+  gap: 10px;
+}
+
+.filter-fields {
+  display: flex;
+  gap: 10px;
+  align-items: center;
+  flex-wrap: wrap;
+}
+
+.filter-submit {
+  margin-left: auto;
+}
+
+select,
+input[type="submit"] {
+  padding: 6px 10px;
+  font-size: 14px;
+  border: 1px solid #666;
+  border-radius: 4px;
+  background-color: #444;
+  color: #ddd;
+  height: 41px;
+  max-width: 160px;
+}
+
+input[type="submit"] {
+  background-color: #d9534f;
+  color: white;
+  cursor: pointer;
+  border: none;
+  padding: 8px 16px;
+}
+
+.search-bar {
+  height: 41px;
+  width: auto;
+  border: 1px solid #666;
+  border-radius: 4px;
+  background-color: #444;
+  padding: 8px; /* Adjust padding as needed */
+}
+
+input[type="submit"]:hover {
+  background-color: #c9302c;
+}
+
+.multi-select {
+  position: relative;
+  display: inline-block;
+  width: 140px;
+  background-color: #444;
+  border: 1px solid #666;
+  border-radius: 4px;
+  cursor: pointer;
+}
+
+.select-box {
+  display: flex;
+  justify-content: space-between;
+  align-items: center;
+  padding: 8px 12px;
+  color: #ddd;
+  width: 140px;
+}
+
+.select-box .arrow {
+  width: 0;
+  height: 0;
+  border-left: 5px solid transparent;
+  border-right: 5px solid transparent;
+  border-top: 6px solid #ddd;
+  transition: transform 0.2s;
+}
+
+.multi-select.active .arrow {
+  transform: rotate(180deg);
+}
+
+.checkbox-dropdown {
+  display: none;
+  position: absolute;
+  width: 100%;
+  background-color: #333;
+  border: 1px solid #666;
+  border-radius: 4px;
+  padding: 5px 0;
+  max-height: 150px;
+  overflow-y: auto;
+  z-index: 10;
+}
+
+.multi-select.active .checkbox-dropdown {
+  display: block;
+}
+
+.checkbox-dropdown label {
+  display: block;
+  padding: 8px;
+  color: #ddd;
+  cursor: pointer;
+}
+
+.checkbox-dropdown label:hover {
+  background-color: #555;
+}
+
+.checkbox-dropdown input {
+  margin-right: 8px;
+}
+
+.routes-grid {
+  display: grid;
+  grid-template-columns: 2fr 1fr 2fr 1fr 1fr;
+  width: 100%;
+  border-collapse: collapse;
+  font-size: 14px;
+  box-sizing: border-box;
+  margin-top: 5px;
+  border-radius: 6px;
+  border: 2px solid #444;
+}
+
+.route-header {
+  padding: 12px 10px;
+  border: 1px solid #333;
+  background-color: #333;
+  color: #fff;
+  font-weight: bold;
+  text-transform: uppercase;
+  text-align: left;
+}
+
+.route-item {
+  display: contents;
+}
+
+.route-item div {
+  padding: 12px 10px;
+  border: 1px solid #444;
+  text-align: left;
+  background-color: #2a2a2a;
+  color: #ddd;
+  white-space: normal;
+  overflow-wrap: break-word;
+}
+
+.route-item div:nth-child(odd) {
+  background-color: #3a3a3a;
+}
+
+.routes-grid div {
+  overflow-x: auto;
+}

data/app/controllers/rails_route_finder/routes_controller.rb

@@ -0,0 +1,39 @@
+module RailsRouteFinder
+  class RoutesController < ApplicationController
+    def index
+      @routes = RailsRouteFinder::Route.all.uniq do |route|
+        [route.path, route.verb, route.controller, route.required_params, route.namespace]
+      end
+
+      if params[:search].present? && !params[:search].blank?
+        query = params[:search].downcase
+        @routes.select! do |route|
+          route.path.downcase.include?(query)
+        end
+      end
+
+      if params[:verb].present? && !params[:verb].blank?
+        @routes.select! do |route|
+          route.verb.casecmp?(params[:verb])
+        end
+      end
+
+      if params[:namespace].present? && !params[:namespace].blank?
+        @routes.select! { |route| route.namespace&.casecmp?(params[:namespace]) }
+      end
+
+      if params[:quick_filters].present? && params[:quick_filters].include?('omit_rails_defaults')
+        @routes.reject! { |route| route.path.start_with?('/rails') }
+      end
+
+      case params[:sort]
+      when 'path'
+        @routes.sort_by! { |route| route.path.downcase }
+      when 'namespace'
+        @routes.sort_by! { |route| route.namespace.to_s.downcase }
+      when 'verb'
+        @routes.sort_by! { |route| route.verb.to_s.downcase }
+      end
+    end
+  end
+end

data/app/views/rails_route_finder/routes/index.html.erb

@@ -0,0 +1,74 @@
+<%= stylesheet_link_tag "rails_route_finder/rails_route_finder_index" %>
+<div class='page'>
+  <div class="search-header">
+    <h1>Route Finder</h1>
+    <div class="filtering-form">
+      <%= form_with url: '/rails_route_finder', method: :get, class: 'sort-filter-form', local: true do |f| %>
+        <div class="filter-fields">
+          <%= f.select :sort, [["Sort by", ""], ["Path", "path"], ["Namespace", "namespace"], ["Verb", "verb"]] %>
+          <%= f.select :verb, options_for_select([["Filter Verb", ""]] + @routes.map(&:verb).uniq.compact.reject(&:blank?).map { |verb| [verb, verb] }), include_blank: false %>
+          <%= f.select :namespace, options_for_select(@routes.map(&:namespace).uniq.compact), include_blank: "Filter Namespace" %>
+          <!-- Custom Multi-Select with Checkboxes -->
+          <div class="multi-select">
+            <div class="select-box" onclick="toggleDropdown()">
+              <span id="selected-filters">Quick Filters</span>
+              <div class="arrow"></div>
+            </div>
+            <div class="checkbox-dropdown" id="checkbox-dropdown">
+              <label><input type="checkbox" name="quick_filters[]" value="omit_rails_defaults"> Omit Rails Defaults</label>
+            </div>
+          </div>
+          <%= f.text_field :search, placeholder: "Search routes...", class: "search-bar" %>
+
+        </div>
+        <div class="filter-submit">
+          <%= f.submit "Sort & Filter" %>
+        </div>
+      <% end %>
+    </div>
+  </div>
+  <div class="routes-grid">
+    <div class="route-header">Path</div>
+    <div class="route-header">Verb</div>
+    <div class="route-header">Controller#Action</div>
+    <div class="route-header">Required Params</div>
+    <div class="route-header">Namespace</div>
+    <% @routes.each do |route| %>
+      <div class="route-item">
+        <div><%= route.path %></div>
+        <div><%= route.verb || "ANY" %></div>
+        <div><%= "#{route.controller}##{route.action}" if route.controller %></div>
+        <div>
+          <% if route.required_params.any? %>
+            <% route.required_params.each do |param| %>
+              <div><%= param.values.first %></div>
+            <% end %>
+          <% else %>
+            <div>None</div>
+          <% end %>
+        </div>
+        <div><%= route.namespace || "None" %></div>
+      </div>
+    <% end %>
+  </div>
+</div>
+<script>
+  function toggleDropdown() {
+  document.querySelector(".multi-select").classList.toggle("active");
+  }
+
+  document.addEventListener("click", function(event) {
+  const multiSelect = document.querySelector(".multi-select");
+  if (!multiSelect.contains(event.target)) {
+    multiSelect.classList.remove("active");
+  }
+  });
+
+  document.querySelectorAll(".checkbox-dropdown input").forEach((checkbox) => {
+  checkbox.addEventListener("change", function () {
+    const selectedFilters = Array.from(document.querySelectorAll(".checkbox-dropdown input:checked"))
+      .map((cb) => cb.parentElement.textContent.trim());
+    document.getElementById("selected-filters").textContent = selectedFilters.length ? selectedFilters.join(", ") : "Quick Filters";
+  });
+  });
+</script>

data/lib/rails_route_finder/engine.rb

@@ -0,0 +1,15 @@
+module RailsRouteFinder
+  class Engine < ::Rails::Engine
+    isolate_namespace RailsRouteFinder
+
+    require 'rails_route_finder/route'
+
+    config.assets.paths << root.join('app', 'assets', 'stylesheets')
+
+    initializer 'rails_route_finder.append_routes' do |app|
+      app.routes.append do
+        mount RailsRouteFinder::Engine => '/rails_route_finder'
+      end
+    end
+  end
+end

data/lib/rails_route_finder/route.rb

@@ -0,0 +1,55 @@
+module RailsRouteFinder
+  class Route
+    attr_reader :path, :verb, :controller, :action, :required_params, :namespace, :base_resource, :other_resource,
+                :required_format
+
+    def initialize(route)
+      @path = route.path.spec.to_s
+      @verb = route.verb&.to_s
+      @controller = route.defaults[:controller]
+      @action = route.defaults[:action]
+      @required_params = extract_required_params(route.path)
+      @namespace = extract_namespace
+      @base_resource, @other_resource = extract_resources
+      @required_format = determine_required_format(@path)
+    end
+
+    def self.all
+      Rails.application.routes.routes.map { |route| new(route) }
+    end
+
+    private
+
+    def extract_required_params(path)
+      path_spec = path.spec.to_s
+      path_spec = path_spec.gsub(/\(.*\)/, '')
+      path_spec.scan(/(:[a-zA-Z0-9_]+)/).flatten
+      resource_params = []
+      segments = path_spec.split('/').reject { |segment| segment.empty? || segment == 'format' }
+
+      segments.each_with_index do |segment, index|
+        resource_params << { segments[index - 1].to_sym => segment.to_sym } if segment.start_with?(':')
+      end
+
+      resource_params
+    end
+
+    def extract_namespace
+      return nil unless controller
+
+      parts = controller.split('/')
+      parts.length > 1 ? parts[0..-2].join('/') : nil
+    end
+
+    def extract_resources
+      segments = path.split('/').reject(&:empty?)
+      base_resource = segments.first if segments.present?
+      other_resource = segments[1] if segments.length > 1
+      [base_resource, other_resource]
+    end
+
+    def determine_required_format(_path)
+      'Dont know that this is necessary since pretty much all routes accept all formats'
+    end
+  end
+end

data/lib/rails_route_finder/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RailsRouteFinder
+  VERSION = "0.1.0"
+end

data/lib/rails_route_finder.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative "rails_route_finder/version"
+require_relative "rails_route_finder/engine" if defined?(Rails)
+
+module RailsRouteFinder
+  class Error < StandardError; end
+  # Your code goes here...
+end
+

data/sig/rails_route_finder.rbs

@@ -0,0 +1,4 @@
+module RailsRouteFinder
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: rails_route_finder
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- gagegolden00
+bindir: exe
+cert_chain: []
+date: 2025-04-01 00:00:00.000000000 Z
+dependencies: []
+email:
+- malcolm.golden0@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/assets/stylesheets/rails_route_finder/rails_route_finder_index.css
+- app/controllers/rails_route_finder/routes_controller.rb
+- app/views/rails_route_finder/routes/index.html.erb
+- lib/rails_route_finder.rb
+- lib/rails_route_finder/engine.rb
+- lib/rails_route_finder/route.rb
+- lib/rails_route_finder/version.rb
+- sig/rails_route_finder.rbs
+homepage: https://github.com/gagegolden00/rails_route_finder
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/gagegolden00/rails_route_finder
+  source_code_uri: https://github.com/gagegolden00/rails_route_finder
+  changelog_uri: https://github.com/gagegolden00/rails_route_finder/blob/main/CHANGELOG.md
+  allowed_push_host: https://rubygems.org
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.6
+specification_version: 4
+summary: A simple engine to help sort and filter rails routes.
+test_files: []