rails_map 1.1.1 → 1.3.0

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)"
@@ -21,7 +18,7 @@ module RailsMap
       
       def add_route_mount
         unless options[:skip_routes]
-          route "mount RailsMap::Engine, at: '/api-doc'"
+          route "mount RailsMap::Engine, at: '/rails-map'"
         end
       end
       
@@ -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

@@ -3,45 +3,47 @@
 RailsMap has been installed!
 
 ✓ Configuration file created at:
-    config/initializers/rails_map.rb
+config/initializers/rails_map.rb
 
 <% unless options[:skip_routes] %>
 ✓ Route mounted in config/routes.rb:
-    mount RailsMap::Engine, at: '/api-doc'
+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)
 
 Next steps:
+
 1. Set environment variables:
-     export RAILS_MAP_USERNAME=admin
-     export RAILS_MAP_PASSWORD=your_secure_password
+   export RAILS_MAP_USERNAME=admin
+   export RAILS_MAP_PASSWORD=your_secure_password
 
    Or add to .env file:
-     RAILS_MAP_USERNAME=admin
-     RAILS_MAP_PASSWORD=your_secure_password
+   RAILS_MAP_USERNAME=admin
+   RAILS_MAP_PASSWORD=your_secure_password
 
-2. Restart your server and visit /api-doc
+2. Restart your server and visit /rails-map
    You'll be prompted to login with your credentials
 
 To disable authentication, run:
-  rails destroy rails_map:install
-  rails g rails_map:install --skip-auth
+rails destroy rails_map:install
+rails g rails_map:install --skip-auth
 <% else %>
 Authentication has been DISABLED (--skip-auth flag used)
 
 To enable authentication:
+
 1. Set RAILS_MAP_USERNAME and RAILS_MAP_PASSWORD environment variables
 2. Uncomment authentication in config/initializers/rails_map.rb
-<% end %>
+   <% end %>
 
 Documentation:
-  Visit http://localhost:3000/api-doc after starting your server
+Visit http://localhost:3000/rails-map after starting your server
 
 For more information, see:
-  https://rails-map.netlify.app
+https://rails-map.netlify.app
 
 ===============================================================================

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.1.1"
+  VERSION = "1.3.0"
 end

data/release.sh

@@ -0,0 +1,338 @@
+#!/bin/bash
+
+# RailsMap Release Script
+# This script builds, pushes the gem to RubyGems, and cleans up old gem files
+
+set -e  # Exit on error
+
+# Colors for output
+RED='\033[0;31m'
+GREEN='\033[0;32m'
+YELLOW='\033[1;33m'
+BLUE='\033[0;34m'
+NC='\033[0m' # No Color
+
+# Function to print colored output
+print_info() {
+    echo -e "${BLUE}ℹ ${NC}$1"
+}
+
+print_success() {
+    echo -e "${GREEN}✓${NC} $1"
+}
+
+print_warning() {
+    echo -e "${YELLOW}⚠${NC} $1"
+}
+
+print_error() {
+    echo -e "${RED}✗${NC} $1"
+}
+
+# Get the current version from version.rb
+CURRENT_VERSION=$(ruby -r ./lib/rails_map/version.rb -e "puts RailsMap::VERSION")
+GEM_NAME="rails_map"
+
+echo ""
+print_info "═══════════════════════════════════════════════════════"
+print_info "  RailsMap Release Script"
+print_info "═══════════════════════════════════════════════════════"
+echo ""
+
+# Show current version
+print_info "Current version: ${CURRENT_VERSION}"
+echo ""
+
+# Ask for new version
+print_warning "Enter the new version number (e.g., 1.2.0, 1.2.1, 2.0.0):"
+read -p "Version: " NEW_VERSION
+
+# Validate version format
+if [[ ! $NEW_VERSION =~ ^[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
+    print_error "Invalid version format. Please use semantic versioning (e.g., 1.2.0)"
+    exit 1
+fi
+
+# Check if version is different
+if [ "$NEW_VERSION" == "$CURRENT_VERSION" ]; then
+    print_warning "New version is the same as current version"
+    read -p "Continue anyway? (y/n) " -n 1 -r
+    echo ""
+    if [[ ! $REPLY =~ ^[Yy]$ ]]; then
+        print_error "Release cancelled"
+        exit 1
+    fi
+fi
+
+# Confirm version change
+echo ""
+print_info "Version change: ${CURRENT_VERSION} → ${NEW_VERSION}"
+read -p "Is this correct? (y/n) " -n 1 -r
+echo ""
+if [[ ! $REPLY =~ ^[Yy]$ ]]; then
+    print_error "Release cancelled"
+    exit 1
+fi
+
+# Update version in version.rb
+print_info "Updating version in lib/rails_map/version.rb..."
+sed -i.bak "s/VERSION = \".*\"/VERSION = \"${NEW_VERSION}\"/" lib/rails_map/version.rb
+rm -f lib/rails_map/version.rb.bak
+print_success "Version updated to ${NEW_VERSION}"
+
+# Update version in CHANGELOG.md if it has Unreleased section
+if grep -q "\[Unreleased\]" CHANGELOG.md; then
+    print_info "Updating CHANGELOG.md..."
+    TODAY=$(date +%Y-%m-%d)
+    sed -i.bak "s/\[Unreleased\]/[${NEW_VERSION}] - ${TODAY}/" CHANGELOG.md
+    rm -f CHANGELOG.md.bak
+    print_success "CHANGELOG.md updated"
+fi
+
+# Set VERSION and GEM_FILE for the rest of the script
+VERSION=$NEW_VERSION
+GEM_FILE="${GEM_NAME}-${VERSION}.gem"
+
+echo ""
+print_info "Preparing to release version ${VERSION}"
+echo ""
+
+# Pre-flight checks
+print_info "Running pre-flight checks..."
+
+# Check if version.rb exists
+if [ ! -f "lib/rails_map/version.rb" ]; then
+    print_error "lib/rails_map/version.rb not found!"
+    exit 1
+fi
+
+# Check if gemspec exists
+if [ ! -f "${GEM_NAME}.gemspec" ]; then
+    print_error "${GEM_NAME}.gemspec not found!"
+    exit 1
+fi
+
+# Check if CHANGELOG.md has the current version
+if ! grep -q "\[${VERSION}\]" CHANGELOG.md; then
+    print_warning "CHANGELOG.md doesn't contain version ${VERSION}"
+    read -p "Continue anyway? (y/n) " -n 1 -r
+    echo ""
+    if [[ ! $REPLY =~ ^[Yy]$ ]]; then
+        print_error "Release cancelled"
+        exit 1
+    fi
+fi
+
+print_success "Pre-flight checks passed"
+echo ""
+
+# Step 1: Show current status
+CURRENT_BRANCH=$(git branch --show-current 2>/dev/null || echo "unknown")
+print_info "Current branch: ${CURRENT_BRANCH}"
+print_info "Version to release: ${VERSION}"
+echo ""
+
+# Step 2: Check for uncommitted changes
+print_info "Checking git status..."
+if [[ -n $(git status -s 2>/dev/null) ]]; then
+    print_warning "You have uncommitted changes:"
+    git status -s
+    echo ""
+    
+    # Ask if user wants to commit version changes
+    print_info "Would you like to commit the version changes?"
+    read -p "Commit version changes? (y/n) " -n 1 -r
+    echo ""
+    if [[ $REPLY =~ ^[Yy]$ ]]; then
+        git add lib/rails_map/version.rb
+        if grep -q "\[${VERSION}\]" CHANGELOG.md; then
+            git add CHANGELOG.md
+        fi
+        git commit -m "Bump version to ${VERSION}"
+        print_success "Version changes committed"
+        
+        read -p "Push to remote? (y/n) " -n 1 -r
+        echo ""
+        if [[ $REPLY =~ ^[Yy]$ ]]; then
+            CURRENT_BRANCH=$(git branch --show-current 2>/dev/null || echo "main")
+            if git push origin "$CURRENT_BRANCH" 2>/dev/null; then
+                print_success "Changes pushed to remote"
+            else
+                print_warning "Failed to push (may need to set remote)"
+            fi
+        fi
+    else
+        print_warning "Continuing with uncommitted changes"
+    fi
+    echo ""
+fi
+
+# Step 3: Run tests (if available)
+if [ -f "Rakefile" ]; then
+    print_info "Running tests..."
+    if bundle exec rake spec 2>/dev/null; then
+        print_success "Tests passed"
+    else
+        print_warning "Tests failed or not configured"
+        read -p "Continue anyway? (y/n) " -n 1 -r
+        echo ""
+        if [[ ! $REPLY =~ ^[Yy]$ ]]; then
+            print_error "Release cancelled"
+            exit 1
+        fi
+    fi
+    echo ""
+fi
+
+# Step 4: Delete old gem files
+print_info "Cleaning up old gem files..."
+OLD_GEMS=$(ls ${GEM_NAME}-*.gem 2>/dev/null || true)
+if [ -n "$OLD_GEMS" ]; then
+    for gem_file in $OLD_GEMS; do
+        rm -f "$gem_file"
+        print_success "Deleted: $gem_file"
+    done
+else
+    print_info "No old gem files found"
+fi
+echo ""
+
+# Step 5: Build the gem
+print_info "Building gem: ${GEM_FILE}..."
+echo ""
+if gem build ${GEM_NAME}.gemspec; then
+    echo ""
+    print_success "Gem built successfully: ${GEM_FILE}"
+else
+    echo ""
+    print_error "Failed to build gem"
+    exit 1
+fi
+echo ""
+
+# Step 6: Verify the gem file exists
+if [ ! -f "$GEM_FILE" ]; then
+    print_error "Gem file not found: ${GEM_FILE}"
+    exit 1
+fi
+
+# Step 7: Show gem size
+GEM_SIZE=$(ls -lh "$GEM_FILE" | awk '{print $5}')
+print_info "Gem size: ${GEM_SIZE}"
+echo ""
+
+# Step 8: Final confirmation before pushing
+print_warning "═══════════════════════════════════════════════════════"
+print_warning "  READY TO PUSH TO RUBYGEMS"
+print_warning "═══════════════════════════════════════════════════════"
+print_info "Gem: ${GEM_NAME}"
+print_info "Version: ${VERSION}"
+print_info "File: ${GEM_FILE}"
+print_info "Size: ${GEM_SIZE}"
+echo ""
+print_warning "This will publish the gem to RubyGems.org"
+read -p "Are you sure you want to continue? (y/n) " -n 1 -r
+echo ""
+if [[ ! $REPLY =~ ^[Yy]$ ]]; then
+    print_error "Release cancelled"
+    print_info "Gem file ${GEM_FILE} has been built but not pushed"
+    print_info "You can manually push it later with: gem push ${GEM_FILE}"
+    exit 0
+fi
+echo ""
+
+# Step 9: Push to RubyGems
+print_info "Pushing gem to RubyGems..."
+if gem push $GEM_FILE; then
+    echo ""
+    print_success "Gem pushed successfully to RubyGems!"
+else
+    echo ""
+    print_error "Failed to push gem to RubyGems"
+    print_info "Gem file ${GEM_FILE} is still available locally"
+    print_info "You can try pushing manually with: gem push ${GEM_FILE}"
+    echo ""
+    
+    # Ask if user wants to rollback version changes
+    print_warning "Would you like to rollback the version changes?"
+    read -p "Rollback to version ${CURRENT_VERSION}? (y/n) " -n 1 -r
+    echo ""
+    if [[ $REPLY =~ ^[Yy]$ ]]; then
+        # Rollback version.rb
+        sed -i.bak "s/VERSION = \".*\"/VERSION = \"${CURRENT_VERSION}\"/" lib/rails_map/version.rb
+        rm -f lib/rails_map/version.rb.bak
+        print_success "Version rolled back to ${CURRENT_VERSION}"
+        
+        # Rollback CHANGELOG.md if it was updated
+        if grep -q "\[${VERSION}\]" CHANGELOG.md; then
+            sed -i.bak "s/\[${VERSION}\] - [0-9-]*/[Unreleased]/" CHANGELOG.md
+            rm -f CHANGELOG.md.bak
+            print_success "CHANGELOG.md rolled back"
+        fi
+        
+        # Rollback git commit if it was made
+        if git log -1 --pretty=%B 2>/dev/null | grep -q "Bump version to ${VERSION}"; then
+            git reset --soft HEAD~1
+            print_success "Git commit rolled back"
+        fi
+    fi
+    
+    exit 1
+fi
+echo ""
+
+# Step 10: Create git tag
+TAG_NAME="v${VERSION}"
+print_info "Git tag: ${TAG_NAME}"
+read -p "Create and push git tag? (y/n) " -n 1 -r
+echo ""
+if [[ $REPLY =~ ^[Yy]$ ]]; then
+    if git tag -a "$TAG_NAME" -m "Release version ${VERSION}" 2>/dev/null; then
+        print_success "Tag created: ${TAG_NAME}"
+        
+        read -p "Push tag to remote? (y/n) " -n 1 -r
+        echo ""
+        if [[ $REPLY =~ ^[Yy]$ ]]; then
+            if git push origin "$TAG_NAME" 2>/dev/null; then
+                print_success "Tag pushed to remote"
+            else
+                print_warning "Failed to push tag (may need to set remote)"
+            fi
+        fi
+    else
+        print_warning "Tag already exists or failed to create"
+    fi
+    echo ""
+fi
+
+# Step 11: Clean up gem file
+print_info "Local gem file: ${GEM_FILE}"
+read -p "Delete local gem file? (y/n) " -n 1 -r
+echo ""
+if [[ $REPLY =~ ^[Yy]$ ]]; then
+    rm -f "$GEM_FILE"
+    print_success "Deleted: ${GEM_FILE}"
+else
+    print_info "Keeping: ${GEM_FILE}"
+fi
+echo ""
+
+# Step 12: Success summary
+print_success "═══════════════════════════════════════════════════════"
+print_success "  RELEASE COMPLETED SUCCESSFULLY! 🎉"
+print_success "═══════════════════════════════════════════════════════"
+echo ""
+print_info "Gem: ${GEM_NAME} v${VERSION}"
+print_info "RubyGems: https://rubygems.org/gems/${GEM_NAME}"
+print_info "Install: gem install ${GEM_NAME}"
+echo ""
+print_info "Next steps:"
+echo "  1. ✓ Gem published to RubyGems"
+echo "  2. ✓ Version updated to ${VERSION}"
+echo "  3. → Verify gem installation: gem install ${GEM_NAME}"
+echo "  4. → Create a GitHub release"
+echo "  5. → Announce the release"
+echo "  6. → Update documentation if needed"
+echo ""
+print_success "Great work! 🚀"
+echo ""

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>