routes-analyzer 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d59454435cfcca8978b29560a38ecd2457cdfd1ac6486be5a71fa9c9b24ea443
-  data.tar.gz: 9c15d8ccb50eb9a2acc1a70c525deede37594200aca4b2bc1f08f9ab857a36ec
+  metadata.gz: 79618d6dca3b9246b8023943d2863bc985e3d9674fd56e51aec84ad0c10ebf62
+  data.tar.gz: 07043a67f3c6011aacc34097476444e45c7749ed8134bd71b48bb29ffe47cdff
 SHA512:
-  metadata.gz: a85f24d238c05674ae36a97c30f36aa2d2913c77d53a2907c39a99203c2c1d77e93f86533c8cbbcbad7abbf0b56835e468906e04548075d609a0716ac42132bd
-  data.tar.gz: bded888809fdda525cf230a50a9bad7fce9e705716d325257f931f2882524a10e6338d46ec820e1cb67e5c9f674ec89011cfde4ea19283edce0795fba943448e
+  metadata.gz: 86f3904c67a101f44776d2d583c1f818340b5f79218a9ac0297a3eca2045faaff4142218cdb8e8a1bc4ec68ac122918aa237845dd2ad8a068a4ee2a45804058b
+  data.tar.gz: 43bf9d60f739f769efe4bd35a628a30537298226da1b5b8457f98e726168718361f292663eaa47a1d811baac744d489278a0a969bcb0e13f3792c791be5a9b78

data/README.md

@@ -7,6 +7,7 @@ A Ruby on Rails plugin that tracks and analyzes route usage in your application.
 ## Features
 
 - **Route Usage Tracking**: Automatically tracks which routes are accessed and how often
+- **Smart Parameter Handling**: Routes with parameters (like `/users/:id`) are properly grouped under a single pattern instead of creating separate entries for each parameter value
 - **Redis Storage**: Uses Redis to store usage statistics efficiently  
 - **Configurable Timeframe**: Set custom analysis periods (default 30 days)
 - **Comprehensive Reporting**: Shows both used and unused routes
@@ -132,6 +133,27 @@ The middleware uses Rails' routing system to determine if a route is valid:
 
 This approach ensures that only routes you've intentionally defined are included in the usage analysis.
 
+## Parameterized Route Handling
+
+The gem intelligently handles routes with parameters by tracking them under their route pattern rather than individual parameter values:
+
+- **Route Definition**: `/users/:id` in `routes.rb`
+- **Actual Requests**: `/users/123`, `/users/456`, `/users/789`
+- **Tracked As**: Single entry for `/users/:id` with combined statistics
+
+This means that accessing `/users/123` three times and `/users/456` two times will show up as 5 total accesses to the `/users/:id` route pattern, not as separate routes.
+
+**Example Output:**
+```
+COUNT    ROUTE                   METHOD    CONTROLLER#ACTION
+--------------------------------------------------------------
+15       /users/:id             GET       users#show
+8        /users/:id/profile     GET       users#profile
+23       /posts/:id             GET       posts#show
+```
+
+This grouping provides much more meaningful insights into which route patterns are being used in your application.
+
 ## Data Structure
 
 For each tracked route, the following data is stored in Redis:

data/lib/routes/analyzer/middleware.rb

@@ -92,13 +92,17 @@ module Routes
           controller = env["action_controller.instance"]
           action = controller.action_name
           controller_name = controller.controller_name
+          method = request.request_method.upcase
 
-          # Build route pattern from request path, removing query parameters
-          route_path = request.path_info
+          # Find the route pattern instead of using the actual path
+          route_path = find_route_pattern(controller_name, action, method)
+
+          # Fallback to actual path if pattern not found
+          route_path ||= request.path_info
 
           {
             route: route_path,
-            method: request.request_method.upcase,
+            method: method,
             controller: controller_name,
             action: action
           }
@@ -108,6 +112,23 @@ module Routes
         nil
       end
 
+      def find_route_pattern(controller_name, action, method)
+        return nil unless defined?(Rails) && Rails.application
+
+        Rails.application.routes.routes.each do |route|
+          if route.defaults[:controller] == controller_name &&
+             route.defaults[:action] == action &&
+             route.verb == method
+            return route.path.spec.to_s.gsub(/\(\.:format\)$/, "")
+          end
+        end
+
+        nil
+      rescue => e
+        Rails.logger.warn "Routes::Analyzer: Failed to find route pattern: #{e.message}"
+        nil
+      end
+
       def build_redis_key(route, method)
         "#{configuration.redis_key_prefix}:#{method}:#{route.gsub('/', ':')}"
       end

data/lib/routes/analyzer/version.rb

@@ -1,5 +1,5 @@
 module Routes
   module Analyzer
-    VERSION = "0.1.2"
+    VERSION = "0.1.4"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: routes-analyzer
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Gregorio Galante