route_tracker_arsh 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ae7c11b9eccf7b7252838339a71dc568ab56066b46644c0d07a08304d04ff94f
+  data.tar.gz: '059f525633c107fb4b9c0306ca762ab6eff286e41344c5809b50100d20f3e491'
+SHA512:
+  metadata.gz: 94547dd940dbff733918178248110addd57b1593cd5a8a8dd08629eb09ca8fb2388e24709809f6f48cc80d9e3b501c7f6c57cb79977630485266b346b4973b66
+  data.tar.gz: 1038606f9169d765b916659eb2ceed47ab130c4558062fa5e604b54a1cffaf7c48394692841659c7473fb2ebdb71424e810263a1f02652dba517415e9af57ab1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright TODO: Write your name
+
+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,28 @@
+# Routetracker
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "routetracker"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install routetracker
+```
+
+## Contributing
+Contribution directions go here.
+
+## 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,6 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("spec/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+require "bundler/gem_tasks"

data/app/assets/stylesheets/routetracker/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/routetracker/application_controller.rb

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

data/app/controllers/routetracker/dashboard_controller.rb

@@ -0,0 +1,45 @@
+module Routetracker
+  class DashboardController < ApplicationController
+    def index
+      @routes = []
+      
+      # Pre-fetch all hits to minimize queries
+      # Grouping by controller#action allows us to aggregate multiple hits (e.g. different verbs for same action if applicable)
+      all_hits = Routetracker::RouteHit.all
+      hits_map = all_hits.group_by { |h| "#{h.controller}##{h.action}" }
+
+      Rails.application.routes.routes.each do |route|
+        # wrapper = ActionDispatch::Routing::RouteWrapper.new(route)
+        # next if wrapper.internal? # internal? might not exist on raw route
+
+        # requirements gives us the controller/action
+        reqs = route.requirements
+        controller = reqs[:controller]
+        action = reqs[:action]
+        
+        next unless controller && action
+
+        # Normalize data
+        verb = route.verb.to_s
+        path = route.path.spec.to_s
+        # Remove (.:format) for cleaner display
+        path = path.sub('(.:format)', '')
+
+        key = "#{controller}##{action}"
+        related_hits = hits_map[key] || []
+
+        @routes << {
+          verb: verb,
+          path: path,
+          controller: controller,
+          action: action,
+          hit_count: related_hits.sum(&:hit_count),
+          last_hit_at: related_hits.map(&:last_hit_at).compact.max
+        }
+      end
+
+      # Sort: Never hit first, then alphabetical
+      @routes.sort_by! { |r| [r[:hit_count] == 0 ? 0 : 1, r[:controller], r[:action]] }
+    end
+  end
+end

data/app/helpers/routetracker/application_helper.rb

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

data/app/jobs/routetracker/application_job.rb

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

data/app/mailers/routetracker/application_mailer.rb

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

data/app/models/routetracker/application_record.rb

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

data/app/models/routetracker/route_hit.rb

@@ -0,0 +1,4 @@
+module Routetracker
+  class RouteHit < ApplicationRecord
+  end
+end

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

@@ -0,0 +1,17 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Routetracker</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= yield :head %>
+
+  <%= stylesheet_link_tag    "routetracker/application", media: "all" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/app/views/routetracker/dashboard/index.html.erb

@@ -0,0 +1,44 @@
+<h1>Route Usage Tracker</h1>
+
+<div style="margin-bottom: 20px;">
+  <strong>Stats:</strong> <%= @routes.count %> Total Routes | 
+  <%= @routes.count { |r| r[:hit_count] == 0 } %> potentially unused.
+</div>
+
+<table border="1" cellpadding="5" cellspacing="0" style="border-collapse: collapse; width: 100%; font-family: monospace;">
+  <thead>
+    <tr style="background-color: #f0f0f0; text-align: left;">
+      <th>Verb</th>
+      <th>Path</th>
+      <th>Controller#Action</th>
+      <th>Hits</th>
+      <th>Last Accessed</th>
+      <th>Status</th>
+    </tr>
+  </thead>
+  <tbody>
+    <% @routes.each do |route| %>
+      <% is_unused = route[:hit_count] == 0 %>
+      <tr style="<%= is_unused ? 'background-color: #fff0f0; color: #d00;' : '' %>">
+        <td><%= route[:verb].presence || 'ALL' %></td>
+        <td><%= route[:path] %></td>
+        <td><%= route[:controller] %>#<%= route[:action] %></td>
+        <td><%= route[:hit_count] %></td>
+        <td>
+          <% if route[:last_hit_at] %>
+            <span title="<%= route[:last_hit_at] %>"><%= time_ago_in_words(route[:last_hit_at]) %> ago</span>
+          <% else %>
+            <span style="color: #999;">Never</span>
+          <% end %>
+        </td>
+        <td>
+          <% if is_unused %>
+            <strong>UNUSED</strong>
+          <% else %>
+            <span style="color: green;">Active</span>
+          <% end %>
+        </td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>

data/config/routes.rb

@@ -0,0 +1,3 @@
+Routetracker::Engine.routes.draw do
+  root to: "dashboard#index"
+end

data/db/migrate/20251231173342_create_routetracker_route_hits.rb

@@ -0,0 +1,15 @@
+class CreateRoutetrackerRouteHits < ActiveRecord::Migration[8.1]
+  def change
+    create_table :routetracker_route_hits do |t|
+      t.string :verb
+      t.string :path
+      t.string :controller
+      t.string :action
+      t.datetime :last_hit_at
+      t.integer :hit_count, default: 0
+
+      t.timestamps
+    end
+    add_index :routetracker_route_hits, [:controller, :action, :verb], name: 'index_routetracker_hits_on_ids', unique: true
+  end
+end

data/lib/routetracker/engine.rb

@@ -0,0 +1,11 @@
+require_relative "middleware"
+
+module Routetracker
+  class Engine < ::Rails::Engine
+    isolate_namespace Routetracker
+
+    initializer "routetracker.add_middleware" do |app|
+      app.middleware.use Routetracker::Middleware
+    end
+  end
+end

data/lib/routetracker/middleware.rb

@@ -0,0 +1,61 @@
+module Routetracker
+  class Middleware
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      status, headers, body = @app.call(env)
+
+      begin
+        record_hit(env)
+      rescue => e
+        # Failsafe: Don't break the app if tracking fails
+        # Using a raw logger if Rails logger isn't available, but it should be.
+        (Rails.logger || Logger.new($stdout)).error "[Routetracker] Error: #{e.message}"
+      end
+
+      [status, headers, body]
+    end
+
+    private
+
+    def record_hit(env)
+      # We rely on path_parameters which are set by the router
+      params = env['action_dispatch.request.path_parameters']
+      return unless params
+
+      controller = params[:controller]
+      action = params[:action]
+      return unless controller && action
+
+      request = ActionDispatch::Request.new(env)
+      verb = request.request_method
+      path = request.path
+
+      # Basic retry logic for race conditions on creation
+      retries = 0
+      begin
+        hit = Routetracker::RouteHit.find_or_create_by(
+          controller: controller,
+          action: action,
+          verb: verb
+        )
+        
+        # Atomically increment and update timestamp/path
+        # We update 'path' to the latest one seen (sample)
+        hit.with_lock do
+          hit.hit_count += 1
+          hit.last_hit_at = Time.current
+          hit.path = path # Update to latest sample path
+          hit.save
+        end
+
+      rescue ActiveRecord::RecordNotUnique
+        if (retries += 1) < 3
+          retry
+        end
+      end
+    end
+  end
+end

data/lib/routetracker/version.rb

@@ -0,0 +1,3 @@
+module Routetracker
+  VERSION = "0.1.0"
+end

data/lib/routetracker.rb

@@ -0,0 +1,6 @@
+require "routetracker/version"
+require "routetracker/engine"
+
+module Routetracker
+  # Your code goes here...
+end

data/lib/tasks/routetracker_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :routetracker do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: route_tracker_arsh
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- RouteTracker Contributor
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-12-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.1.1
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: RouteTracker provides middleware to log when routes are accessed and
+  a dashboard to visualize usage stats, helping you safely delete dead code.
+email:
+- contributor@example.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/stylesheets/routetracker/application.css
+- app/controllers/routetracker/application_controller.rb
+- app/controllers/routetracker/dashboard_controller.rb
+- app/helpers/routetracker/application_helper.rb
+- app/jobs/routetracker/application_job.rb
+- app/mailers/routetracker/application_mailer.rb
+- app/models/routetracker/application_record.rb
+- app/models/routetracker/route_hit.rb
+- app/views/layouts/routetracker/application.html.erb
+- app/views/routetracker/dashboard/index.html.erb
+- config/routes.rb
+- db/migrate/20251231173342_create_routetracker_route_hits.rb
+- lib/routetracker.rb
+- lib/routetracker/engine.rb
+- lib/routetracker/middleware.rb
+- lib/routetracker/version.rb
+- lib/tasks/routetracker_tasks.rake
+homepage: https://github.com/example/routetracker
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/example/routetracker
+  source_code_uri: https://github.com/example/routetracker
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.16
+signing_key:
+specification_version: 4
+summary: Track unused routes in your Rails application.
+test_files: []