rails_map 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 48342f6fbf73d56fd547dfd0565604fc58165a331b4890d2e22c4abc31838498
-  data.tar.gz: 32163fbc27d52a6615d639008f38dada8f16c64da83e80c8679b899db6003e68
+  metadata.gz: a917f534a942aae52659013098e9a87a86092ca89c78c0759698282bc79d4793
+  data.tar.gz: be81c66e4763e7684840e2b4231d18123d32949c42a05f22ab7a3f44f082c25b
 SHA512:
-  metadata.gz: 9d779878c8463a756d8817102cacb2c8c2f494f41247893aad4e450be8fd3a6800984d76286e7e701c48247e3ec2e12498ef8df2e06c01f88fd7c6c3f64bec47
-  data.tar.gz: 3d01c86330c56e2fd4d3b620d69ad1e068749ad3c1e1d3105cee1b2f4d5d2478bf765ffdb016aab08f205dbc4f394ea464dcb894962adf2feb1611eb068ffb43
+  metadata.gz: a03362eb156c285cd3404ba16a68ede65fe91f923b9887a902bef8745af066bfa98d51b356a3efe43a62c77d0a06e083aeba30bf27e9fa41a97b213df2541209
+  data.tar.gz: fcf7e3cb1e9db8bfeee79986324b541eb221a4b1dcaa26681f8bbb47ed4bb927a7038021388780a9c8b2d1cea196e0d4d0e2e89a83162de22a055b5c68b27082

data/CHANGELOG.md

@@ -67,7 +67,7 @@ Then visit `http://localhost:3000/rails-map` instead of `/api-doc`.
 - Automatic configuration file creation
 - Automatic engine mounting in routes
 - Automatic user migration creation (unless `--skip-auth`)
-- Automatic addition of `/doc/api` to `.gitignore`
+- Automatic addition of `/doc/rails-map` to `.gitignore`
 - Authentication support with `authenticate_with` configuration option
 - `RailsMap::Auth` helper module for authentication
 - Example configuration file with authentication examples

data/QUICKSTART.md

@@ -34,7 +34,7 @@ This automatically:
 - ✅ Creates `config/initializers/rails_map.rb` with auth enabled
 - ✅ Mounts the engine in `config/routes.rb`
 - ✅ Creates user migration
-- ✅ Adds `/doc/api` to `.gitignore`
+- ✅ Adds `/doc/rails-map` to `.gitignore`
 
 2. Create an admin user:
 
@@ -135,7 +135,7 @@ rails doc:open      # Open in browser
 rails doc:clean     # Remove generated files
 ```
 
-Files are generated in `doc/api/` by default.
+Files are generated in `doc/rails-map/` by default.
 
 ## Troubleshooting
 

data/README.md

@@ -54,7 +54,7 @@ This automatically:
 
 - ✅ Creates `config/initializers/rails_map.rb` with authentication enabled
 - ✅ Mounts the engine at `/rails-map`
-- ✅ Adds `/doc/api` to `.gitignore`
+- ✅ Adds `/doc/rails-map` to `.gitignore`
 - ✅ Uses default credentials (admin/password) if ENV variables not set
 
 Start your server and visit `http://localhost:3000/rails-map` - you'll be prompted to login!
@@ -71,7 +71,7 @@ This will:
 
 - ✅ Create the configuration file (auth disabled)
 - ✅ Mount the engine at `/rails-map`
-- ✅ Add `/doc/api` to `.gitignore`
+- ✅ Add `/doc/rails-map` to `.gitignore`
 
 Start your server and visit `/rails-map` - no login required!
 
@@ -95,7 +95,7 @@ Run the following rake task to generate static HTML documentation:
 rails doc:generate
 ```
 
-This will generate HTML documentation in `doc/api/` directory.
+This will generate HTML documentation in `doc/rails-map/` directory.
 
 ### Open Documentation in Browser
 
@@ -116,7 +116,7 @@ Create an initializer `config/initializers/rails_map.rb`:
 ```ruby
 RailsMap.configure do |config|
   # Output directory for generated documentation
-  config.output_dir = Rails.root.join('doc', 'api').to_s
+  config.output_dir = Rails.root.join('doc', 'rails-map').to_s
 
   # Application name displayed in the documentation
   config.app_name = 'My Application'

data/SECURITY.md

@@ -94,7 +94,7 @@ For production, consider using static HTML generation instead of live documentat
 
 ```bash
 rails doc:generate
-# Deploy the doc/api folder to a secure location
+# Deploy the doc/rails-map folder to a secure location
 ```
 
 ### 6. Keep Updated

data/config/initializers/rails_map.example.rb

@@ -11,7 +11,7 @@ RailsMap.configure do |config|
   config.theme_color = '#3B82F6'
   
   # Output directory for static HTML generation
-  config.output_dir = Rails.root.join('doc', 'api').to_s
+  config.output_dir = Rails.root.join('doc', 'rails-map').to_s
   
   # Include timestamp columns (created_at, updated_at) in model documentation
   config.include_timestamps = true

data/lib/generators/rails_map/install_generator.rb

@@ -1,13 +1,10 @@
 # frozen_string_literal: true
 
 require 'rails/generators'
-require 'rails/generators/migration'
 
 module RailsMap
   module Generators
     class InstallGenerator < Rails::Generators::Base
-      include Rails::Generators::Migration
-      
       source_root File.expand_path('templates', __dir__)
       
       desc "Installs RailsMap with environment-based authentication (use --skip-auth to disable)"
@@ -31,13 +28,13 @@ module RailsMap
         if File.exist?(gitignore_path)
           gitignore_content = File.read(gitignore_path)
           
-          unless gitignore_content.include?('doc/api')
+          unless gitignore_content.include?('doc/rails-map')
             append_to_file gitignore_path do
-              "\n# Ignore generated documentation\n/doc/api\n"
+              "\n# Ignore generated documentation\n/doc/rails-map\n"
             end
           end
         else
-          create_file gitignore_path, "# Ignore generated documentation\n/doc/api\n"
+          create_file gitignore_path, "# Ignore generated documentation\n/doc/rails-map\n"
         end
       end
       

data/lib/generators/rails_map/templates/README

@@ -10,7 +10,7 @@ config/initializers/rails_map.rb
 mount RailsMap::Engine, at: '/rails-map'
 <% end %>
 
-✓ Added /doc/api to .gitignore
+✓ Added /doc/rails-map to .gitignore
 
 <% unless options[:skip_auth] %>
 Authentication has been ENABLED (default)

data/lib/generators/rails_map/templates/initializer.rb

@@ -2,13 +2,13 @@
 
 RailsMap.configure do |config|
   # Application name displayed in the documentation
-  config.app_name = '<%= Rails.application.class.module_parent_name %>'
+  config.app_name = '<%= Rails.application.class.respond_to?(:module_parent_name) ? Rails.application.class.module_parent_name : Rails.application.class.parent_name %>'
   
   # Theme color (any valid CSS color)
   config.theme_color = '#3B82F6'
   
   # Output directory for static HTML generation
-  config.output_dir = Rails.root.join('doc', 'api').to_s
+  config.output_dir = Rails.root.join('doc', 'rails-map').to_s
   
   # Include timestamp columns (created_at, updated_at) in model documentation
   config.include_timestamps = true

data/lib/generators/rails_map/templates/migration.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class CreateRailsMapUsers < ActiveRecord::Migration[7.0]
+class CreateRailsMapUsers < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
   def change
     create_table :rails_map_users do |t|
       t.string :username, null: false

data/lib/rails_map/configuration.rb

@@ -18,15 +18,20 @@ module RailsMap
 
     def default_output_dir
       if defined?(Rails)
-        Rails.root.join("doc", "api").to_s
+        Rails.root.join("doc", "rails-map").to_s
       else
-        File.join(Dir.pwd, "doc", "api")
+        File.join(Dir.pwd, "doc", "rails-map")
       end
     end
 
     def default_app_name
       if defined?(Rails)
-        Rails.application.class.module_parent_name
+        app_class = Rails.application.class
+        if app_class.respond_to?(:module_parent_name)
+          app_class.module_parent_name
+        else
+          app_class.parent_name
+        end
       else
         "Rails Application"
       end

data/lib/rails_map/parsers/model_parser.rb

@@ -42,7 +42,7 @@ module RailsMap
         if defined?(Rails.root)
           Dir[Rails.root.join('app/models/**/*.rb')].each do |file|
             begin
-              require_dependency file
+              require file
             rescue => e
               # Ignore errors, file might already be loaded
             end

data/lib/rails_map/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RailsMap
-  VERSION = "1.2.0"
+  VERSION = "1.3.0"
 end

data/templates/controller.html.erb

@@ -33,8 +33,7 @@
             <th>Method</th>
             <th>Path</th>
             <th>Action</th>
-            <th>Route Name</th>
-            <th>Constraints</th>
+            <th>Parameters</th>
           </tr>
         </thead>
         <tbody>
@@ -48,19 +47,41 @@
               <td><code><%= route.path %></code></td>
               <td><code><%= route.action %></code></td>
               <td>
-                <% if route.name %>
-                  <code><%= route.name %></code>
-                <% else %>
-                  <span style="color: var(--text-muted);">—</span>
+                <% all_params = [] %>
+                <% all_params += route.path_params if route.path_params&.any? %>
+                <% verb = route.verb.to_s.upcase %>
+                <% if %w[GET DELETE].include?(verb) %>
+                  <% all_params += route.query_params if route.query_params&.any? %>
+                <% elsif %w[POST PUT PATCH].include?(verb) %>
+                  <% all_params += route.request_body_params if route.request_body_params&.any? %>
                 <% end %>
-              </td>
-              <td>
-                <% if route.constraints.any? %>
-                  <% route.constraints.each do |key, value| %>
-                    <code><%= key %>: <%= value %></code><br>
-                  <% end %>
+                
+                <% if all_params.any? %>
+                  <details style="cursor: pointer;">
+                    <summary style="color: var(--primary-color); font-weight: 500;">
+                      <%= all_params.size %> parameter<%= all_params.size > 1 ? 's' : '' %>
+                    </summary>
+                    <div style="margin-top: 0.5rem; padding: 0.75rem; background: var(--bg-color); border-radius: 6px; font-size: 0.875rem;">
+                      <% all_params.each do |param| %>
+                        <div style="margin-bottom: 0.5rem; padding-bottom: 0.5rem; border-bottom: 1px solid var(--border-color);">
+                          <div style="display: flex; align-items: center; gap: 0.5rem; margin-bottom: 0.25rem;">
+                            <code style="font-weight: 600; color: var(--primary-color);"><%= param[:name] %></code>
+                            <span class="badge" style="font-size: 0.75rem; padding: 0.125rem 0.375rem;"><%= param[:type] %></span>
+                            <% if param[:required] %>
+                              <span style="color: #dc2626; font-size: 0.75rem; font-weight: 600;">required</span>
+                            <% else %>
+                              <span style="color: #6b7280; font-size: 0.75rem;">optional</span>
+                            <% end %>
+                          </div>
+                          <div style="color: #6b7280; font-size: 0.75rem;">
+                            Location: <%= param[:location] %>
+                          </div>
+                        </div>
+                      <% end %>
+                    </div>
+                  </details>
                 <% else %>
-                  <span style="color: var(--text-muted);">—</span>
+                  <span style="color: var(--text-muted);">No parameters</span>
                 <% end %>
               </td>
             </tr>

data/templates/layout.html.erb

@@ -283,7 +283,7 @@
   </main>
 
   <footer style="text-align: center; padding: 2rem; color: var(--text-muted); font-size: 0.875rem;">
-    Generated by RailsDocGenerator on <%= Time.now.strftime('%Y-%m-%d %H:%M:%S') %>
+    Generated by <a href="https://github.com/ArshdeepGrover/rails-map" target="_blank">RailsMap</a> on <%= Time.now.strftime('%Y-%m-%d %H:%M:%S') %>
   </footer>
 </body>
 </html>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_map
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Arshdeep Singh
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-02-12 00:00:00.000000000 Z
+date: 2026-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -133,6 +133,7 @@ files:
 - lib/rails_map/parsers/route_parser.rb
 - lib/rails_map/railtie.rb
 - lib/rails_map/version.rb
+- rails-map-gem.png
 - release.sh
 - templates/controller.html.erb
 - templates/index.html.erb