rails_map 1.1.0 → 1.2.0

data/lib/generators/rails_map/install_generator.rb

@@ -21,7 +21,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
       

data/lib/generators/rails_map/templates/README

@@ -3,11 +3,11 @@
 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
@@ -16,32 +16,34 @@ RailsMap has been installed!
 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/rails_map/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RailsMap
-  VERSION = "1.1.0"
+  VERSION = "1.2.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 ""

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_map
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Arshdeep Singh
@@ -17,6 +17,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -24,6 +27,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -66,8 +72,21 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: Automatically generates interactive API documentation for Rails by mapping
-  routes, controllers, and models. Zero configuration—just install and go.
+description: |
+  RailsMap automatically generates beautiful, interactive API documentation for your Rails application.
+
+  Features:
+  • Live documentation via Rails Engine at /rails-map
+  • Static HTML generation for offline use
+  • Automatic parameter detection (path, query, body)
+  • Route documentation with HTTP methods and paths
+  • Controller documentation with actions and parameters
+  • Model documentation with columns, associations, validations, and scopes
+  • Built-in authentication support
+  • Customizable themes and colors
+  • Zero configuration - just install and go!
+
+  Perfect for API development, team collaboration, and maintaining up-to-date documentation.
 email:
 - arsh199820@gmail.com
 executables: []
@@ -76,13 +95,21 @@ extra_rdoc_files: []
 files:
 - ".idea/.gitignore"
 - ".idea/material_theme_project_new.xml"
+- ".vscode/settings.json"
 - AUTHENTICATION.md
 - CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE.txt
 - QUICKSTART.md
 - README.md
+- RELEASE_QUICK_REFERENCE.md
+- RELEASE_SCRIPT_GUIDE.md
+- RUBYGEMS_IMPROVEMENTS.md
 - Rakefile
+- SECURITY.md
+- URL_CHANGE_SUMMARY.md
 - app/controllers/rails_map/docs_controller.rb
 - app/models/rails_map/user.rb
 - app/views/rails_map/docs/_styles.html.erb
@@ -106,6 +133,7 @@ files:
 - lib/rails_map/parsers/route_parser.rb
 - lib/rails_map/railtie.rb
 - lib/rails_map/version.rb
+- release.sh
 - templates/controller.html.erb
 - templates/index.html.erb
 - templates/layout.html.erb
@@ -117,11 +145,23 @@ licenses:
 metadata:
   homepage_uri: https://rails-map.netlify.app
   source_code_uri: https://github.com/ArshdeepGrover/rails-map
-  changelog_uri: https://github.com/ArshdeepGrover/rails-map/blob/main/CHANGELOG.md
+  changelog_uri: https://github.com/ArshdeepGrover/rails-map/blob/release/deploy/CHANGELOG.md
   bug_tracker_uri: https://github.com/ArshdeepGrover/rails-map/issues
-  documentation_uri: https://rails-map.netlify.app
+  documentation_uri: https://github.com/ArshdeepGrover/rails-map#readme
+  wiki_uri: https://github.com/ArshdeepGrover/rails-map/wiki
+  funding_uri: https://github.com/sponsors/ArshdeepGrover
   rubygems_mfa_required: 'true'
-post_install_message:
+  allowed_push_host: https://rubygems.org
+  github_repo: ssh://github.com/ArshdeepGrover/rails-map
+post_install_message: "\n╔═══════════════════════════════════════════════════════════════╗\n║
+  \                                                              ║\n║   Thanks for
+  installing RailsMap! \U0001F389                          ║\n║                                                               ║\n║
+  \  Get started:                                                ║\n║   $ rails g
+  rails_map:install                                 ║\n║                                                               ║\n║
+  \  Then visit: http://localhost:3000/rails-map                 ║\n║                                                               ║\n║
+  \  Documentation: https://rails-map.netlify.app                ║\n║   GitHub: https://github.com/ArshdeepGrover/rails-map
+  \        ║\n║                                                               ║\n║
+  \  New in v1.2.0: Automatic API parameter detection! \U0001F680        ║\n║                                                               ║\n╚═══════════════════════════════════════════════════════════════╝\n\n"
 rdoc_options: []
 require_paths:
 - lib