routes-analyzer 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f58db787f3f902a902e91e34159d5f3faec5df6716e2003f643228d322effad
-  data.tar.gz: 07ddd074b8305ac9af28a058c5ed718ea1016829047a725f1f74628e26ea83c6
+  metadata.gz: d59454435cfcca8978b29560a38ecd2457cdfd1ac6486be5a71fa9c9b24ea443
+  data.tar.gz: 9c15d8ccb50eb9a2acc1a70c525deede37594200aca4b2bc1f08f9ab857a36ec
 SHA512:
-  metadata.gz: a186755509cd04163bb0c58140970e23613c8f8fae77191f6061c412a5aa479fc99ead4a83f79a5a05178aca51c746973eb8bd51b965fba2c48c8f08c4b0a990
-  data.tar.gz: 2b6fe9f6d24e3937bbab1ebbebe1db3043dbe0af90705a717e0a6507c19d78d39363812a6f3c3d48459e5ef577bb947edc70f893b63fe954d8ae52cd38309b95
+  metadata.gz: a85f24d238c05674ae36a97c30f36aa2d2913c77d53a2907c39a99203c2c1d77e93f86533c8cbbcbad7abbf0b56835e468906e04548075d609a0716ac42132bd
+  data.tar.gz: bded888809fdda525cf230a50a9bad7fce9e705716d325257f931f2882524a10e6338d46ec820e1cb67e5c9f674ec89011cfde4ea19283edce0795fba943448e

data/README.md

@@ -1,5 +1,7 @@
 # Routes::Analyzer
 
+[![Gem Version](https://badge.fury.io/rb/routes-analyzer.svg)](https://badge.fury.io/rb/routes-analyzer)
+
 A Ruby on Rails plugin that tracks and analyzes route usage in your application. It uses Redis to store route access patterns and provides insights into which routes are being used and which are not.
 
 ## Features
@@ -109,12 +111,26 @@ Displays current configuration and tests Redis connectivity.
 ## How It Works
 
 1. **Middleware Integration**: The plugin automatically adds middleware to your Rails application
-2. **Request Tracking**: Each HTTP request is analyzed to extract route information
-3. **Redis Storage**: Usage data is stored in Redis with the following structure:
+2. **Route Filtering**: Only routes explicitly defined in `routes.rb` are tracked. This ensures that:
+   - Undefined routes (404 errors) are not tracked
+   - Catch-all routes that handle unknown paths don't pollute the data
+   - Only legitimate application routes are analyzed
+3. **Request Tracking**: Each valid HTTP request is analyzed to extract route information
+4. **Redis Storage**: Usage data is stored in Redis with the following structure:
    - Route path and HTTP method
    - Access count within the timeframe
    - Last access timestamp
-4. **Data Expiration**: Redis keys automatically expire after the configured timeframe plus a buffer period
+5. **Data Expiration**: Redis keys automatically expire after the configured timeframe plus a buffer period
+
+## Route Detection
+
+The middleware uses Rails' routing system to determine if a route is valid:
+
+- **Path Parameters Check**: Verifies that Rails recognized the route and set path parameters
+- **Route Recognition**: Uses `Rails.application.routes.recognize_path` to confirm the route exists in `routes.rb`
+- **Error Handling**: Gracefully handles routing errors and invalid requests without tracking them
+
+This approach ensures that only routes you've intentionally defined are included in the usage analysis.
 
 ## Data Structure
 
@@ -142,6 +158,30 @@ For each tracked route, the following data is stored in Redis:
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a Pull Request
 
+## Testing
+
+Run the test suite to ensure everything is working correctly:
+
+```bash
+ruby bin/test
+```
+
+## Rubocop check
+
+Run Rubocop to check code style:
+
+```bash
+ruby bin/rubocop
+```
+
+## Publishing
+
+To publish a new version of the gem, update the version number in `lib/routes/analyzer/version.rb` and run:
+
+```bash
+ruby bin/publish
+```
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/routes/analyzer/middleware.rb

@@ -23,6 +23,9 @@ module Routes
         return false unless Routes::Analyzer.track_usage?
         return false unless env["action_controller.instance"]
 
+        # Check if the route is actually defined in routes.rb
+        return false unless route_defined_in_rails?(env)
+
         true
       rescue => e
         Rails.logger.warn "Routes::Analyzer: Failed to check tracking conditions: #{e.message}"
@@ -57,6 +60,32 @@ module Routes
         Rails.logger.warn "Routes::Analyzer: Failed to track route usage: #{e.message}"
       end
 
+      def route_defined_in_rails?(env)
+        request = Rack::Request.new(env)
+
+        # First check: if Rails didn't set path_parameters, it means the route wasn't recognized
+        # This happens when Rails can't match the request to any defined route
+        path_params = env["action_dispatch.request.path_parameters"]
+        return false unless path_params
+
+        # Second check: verify that Rails can recognize this path/method combination
+        # This ensures the route is actually defined in routes.rb and not just handled by a catch-all
+        route_exists = Rails.application.routes.recognize_path(
+          request.path_info,
+          method: request.request_method.downcase.to_sym
+        )
+
+        return true if route_exists
+        false
+      rescue ActionController::RoutingError, NoMethodError
+        # If recognize_path raises RoutingError, the route is not defined in routes.rb
+        # NoMethodError can occur if the controller/action doesn't exist
+        false
+      rescue => e
+        Rails.logger.warn "Routes::Analyzer: Error checking route definition: #{e.message}"
+        false
+      end
+
       def extract_route_info(env, request)
         # Get the matched route from Rails
         if env["action_controller.instance"]

data/lib/routes/analyzer/version.rb

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

metadata

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