rails_map 1.1.0 → 1.2.0

data/README.md

@@ -1,5 +1,11 @@
 # Rails Map
 
+[![Gem Version](https://badge.fury.io/rb/rails_map.svg)](https://badge.fury.io/rb/rails_map)
+[![Downloads](https://img.shields.io/gem/dt/rails_map.svg)](https://rubygems.org/gems/rails_map)
+[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+[![Ruby](https://img.shields.io/badge/ruby-%3E%3D%202.7.0-ruby.svg)](https://www.ruby-lang.org)
+[![Rails](https://img.shields.io/badge/rails-%3E%3D%205.0-red.svg)](https://rubyonrails.org)
+
 🌐 **[Homepage](https://rails-map.netlify.app)** | 📦 **[RubyGems](https://rubygems.org/gems/rails_map)** | 🐙 **[GitHub](https://github.com/ArshdeepGrover/rails-map)**
 
 Automatically generates interactive API documentation for Rails by mapping routes, controllers, and models. Zero configuration—just install and go.
@@ -47,11 +53,11 @@ RAILS_MAP_PASSWORD=your_secure_password
 This automatically:
 
 - ✅ Creates `config/initializers/rails_map.rb` with authentication enabled
-- ✅ Mounts the engine at `/api-doc`
+- ✅ Mounts the engine at `/rails-map`
 - ✅ Adds `/doc/api` to `.gitignore`
 - ✅ Uses default credentials (admin/password) if ENV variables not set
 
-Start your server and visit `http://localhost:3000/api-doc` - you'll be prompted to login!
+Start your server and visit `http://localhost:3000/rails-map` - you'll be prompted to login!
 
 ### Setup Without Authentication
 
@@ -64,10 +70,10 @@ rails g rails_map:install --skip-auth
 This will:
 
 - ✅ Create the configuration file (auth disabled)
-- ✅ Mount the engine at `/api-doc`
+- ✅ Mount the engine at `/rails-map`
 - ✅ Add `/doc/api` to `.gitignore`
 
-Start your server and visit `/api-doc` - no login required!
+Start your server and visit `/rails-map` - no login required!
 
 ## Usage
 
@@ -76,10 +82,10 @@ Start your server and visit `/api-doc` - no login required!
 Mount the engine in your `config/routes.rb`:
 
 ```ruby
-mount RailsMap::Engine, at: '/api-doc'
+mount RailsMap::Engine, at: '/rails-map'
 ```
 
-Then visit `http://localhost:3000/api-doc` in your browser to see live documentation.
+Then visit `http://localhost:3000/rails-map` in your browser to see live documentation.
 
 ### Static HTML Generation
 

data/RELEASE_QUICK_REFERENCE.md

@@ -0,0 +1,114 @@
+# Release Script Quick Reference
+
+## Quick Start
+
+```bash
+./release.sh
+```
+
+## What It Does
+
+1. ✅ Asks for new version number
+2. ✅ Updates `lib/rails_map/version.rb`
+3. ✅ Updates `CHANGELOG.md` (if has `[Unreleased]`)
+4. ✅ Commits changes (optional)
+5. ✅ Runs tests
+6. ✅ Builds gem
+7. ✅ Pushes to RubyGems
+8. ✅ Creates git tag (optional)
+9. ✅ Cleans up
+
+## Version Format
+
+```
+MAJOR.MINOR.PATCH
+```
+
+Examples: `1.2.0`, `1.2.1`, `2.0.0`
+
+## When to Bump
+
+| Type      | When                               | Example       |
+| --------- | ---------------------------------- | ------------- |
+| **PATCH** | Bug fixes, security patches        | 1.2.0 → 1.2.1 |
+| **MINOR** | New features (backward compatible) | 1.2.0 → 1.3.0 |
+| **MAJOR** | Breaking changes                   | 1.2.0 → 2.0.0 |
+
+## Pre-Release Checklist
+
+```bash
+# 1. Update CHANGELOG.md
+vim CHANGELOG.md  # Add changes under [Unreleased]
+
+# 2. Run tests
+bundle exec rake spec
+
+# 3. Commit changes
+git add .
+git commit -m "Prepare for release"
+
+# 4. Run release script
+./release.sh
+```
+
+## Prompts You'll See
+
+```
+Current version: 1.2.0
+Enter the new version number: 1.2.1
+Is this correct? (y/n) y
+Commit version changes? (y/n) y
+Push to remote? (y/n) y
+Continue with tests? (y/n) y
+Push to RubyGems? (y/n) y
+Create git tag? (y/n) y
+Push tag to remote? (y/n) y
+Delete local gem file? (y/n) y
+```
+
+## Common Commands
+
+```bash
+# Make script executable
+chmod +x release.sh
+
+# Run release
+./release.sh
+
+# Check RubyGems auth
+gem signin
+
+# View gem versions
+gem list rails_map --remote --all
+
+# Manual push (if needed)
+gem push rails_map-1.2.1.gem
+```
+
+## Rollback
+
+If push fails, script offers rollback:
+
+- Reverts version.rb
+- Reverts CHANGELOG.md
+- Undoes git commit
+
+## Post-Release
+
+1. Verify: https://rubygems.org/gems/rails_map
+2. Test: `gem install rails_map`
+3. Create GitHub release
+4. Announce on social media
+
+## Troubleshooting
+
+| Problem             | Solution             |
+| ------------------- | -------------------- |
+| Invalid version     | Use X.Y.Z format     |
+| Push failed         | Run `gem signin`     |
+| Tests failed        | Fix tests or skip    |
+| Not in project root | `cd` to project root |
+
+## Full Documentation
+
+See `RELEASE_SCRIPT_GUIDE.md` for complete documentation.

data/RELEASE_SCRIPT_GUIDE.md

@@ -0,0 +1,405 @@
+# Release Script Guide
+
+## Overview
+
+The `release.sh` script automates the entire gem release process, including version management, building, and publishing to RubyGems.
+
+## Features
+
+✅ **Interactive Version Management** - Prompts for new version number
+✅ **Automatic Version Updates** - Updates `lib/rails_map/version.rb`
+✅ **CHANGELOG Integration** - Updates CHANGELOG.md automatically
+✅ **Git Integration** - Commits and pushes version changes
+✅ **Pre-flight Checks** - Validates version format and runs tests
+✅ **Rollback Support** - Reverts changes if push fails
+✅ **Old Gem Cleanup** - Removes previous gem files
+✅ **Git Tagging** - Creates and pushes version tags
+✅ **Post-install Summary** - Shows next steps
+
+## Usage
+
+### Basic Usage
+
+```bash
+./release.sh
+```
+
+The script will guide you through the entire process with prompts.
+
+### Step-by-Step Process
+
+#### 1. Version Input
+
+```
+Current version: 1.2.0
+
+Enter the new version number (e.g., 1.2.0, 1.2.1, 2.0.0):
+Version: 1.2.1
+```
+
+**Version Format:**
+
+- Must follow semantic versioning: `MAJOR.MINOR.PATCH`
+- Examples: `1.2.1`, `2.0.0`, `1.3.0`
+
+#### 2. Version Confirmation
+
+```
+Version change: 1.2.0 → 1.2.1
+Is this correct? (y/n)
+```
+
+#### 3. Automatic Updates
+
+The script automatically updates:
+
+- `lib/rails_map/version.rb` - Sets VERSION constant
+- `CHANGELOG.md` - Replaces `[Unreleased]` with `[1.2.1] - 2026-02-12`
+
+#### 4. Git Commit (Optional)
+
+```
+Would you like to commit the version changes?
+Commit version changes? (y/n)
+```
+
+If yes:
+
+```
+✓ Version changes committed
+Push to remote? (y/n)
+```
+
+#### 5. Pre-flight Checks
+
+- Runs test suite (if available)
+- Validates gemspec
+- Checks for errors
+
+#### 6. Build Gem
+
+```
+Building gem: rails_map-1.2.1.gem...
+✓ Gem built successfully: rails_map-1.2.1.gem
+```
+
+#### 7. Final Confirmation
+
+```
+═══════════════════════════════════════════════════════
+  READY TO PUSH TO RUBYGEMS
+═══════════════════════════════════════════════════════
+Gem: rails_map
+Version: 1.2.1
+File: rails_map-1.2.1.gem
+Size: 45K
+
+This will publish the gem to RubyGems.org
+Are you sure you want to continue? (y/n)
+```
+
+#### 8. Push to RubyGems
+
+```
+Pushing gem to RubyGems...
+✓ Gem pushed successfully to RubyGems!
+```
+
+#### 9. Git Tag (Optional)
+
+```
+Git tag: v1.2.1
+Create and push git tag? (y/n)
+```
+
+#### 10. Cleanup
+
+```
+Local gem file: rails_map-1.2.1.gem
+Delete local gem file? (y/n)
+```
+
+## Rollback Feature
+
+If the push to RubyGems fails, the script offers to rollback:
+
+```
+✗ Failed to push gem to RubyGems
+
+Would you like to rollback the version changes?
+Rollback to version 1.2.0? (y/n)
+```
+
+If you choose yes, it will:
+
+1. Revert `lib/rails_map/version.rb` to previous version
+2. Revert `CHANGELOG.md` to `[Unreleased]`
+3. Undo the git commit (if made)
+
+## Version Numbering Guide
+
+Follow [Semantic Versioning](https://semver.org/):
+
+### MAJOR version (X.0.0)
+
+Increment when you make incompatible API changes
+
+```
+1.2.0 → 2.0.0
+```
+
+**Examples:**
+
+- Removing public methods
+- Changing method signatures
+- Removing configuration options
+- Breaking backward compatibility
+
+### MINOR version (x.Y.0)
+
+Increment when you add functionality in a backward compatible manner
+
+```
+1.2.0 → 1.3.0
+```
+
+**Examples:**
+
+- Adding new features
+- Adding new configuration options
+- Adding new methods
+- Deprecating features (but not removing)
+
+### PATCH version (x.y.Z)
+
+Increment when you make backward compatible bug fixes
+
+```
+1.2.0 → 1.2.1
+```
+
+**Examples:**
+
+- Bug fixes
+- Security patches
+- Documentation updates
+- Performance improvements
+
+## Pre-Release Checklist
+
+Before running the script:
+
+- [ ] All changes committed to git
+- [ ] Tests passing locally
+- [ ] CHANGELOG.md updated with changes (under `[Unreleased]`)
+- [ ] Documentation updated
+- [ ] Breaking changes documented
+- [ ] Migration guide written (if needed)
+- [ ] RubyGems credentials configured
+
+## RubyGems Authentication
+
+Ensure you're authenticated with RubyGems:
+
+```bash
+# First time setup
+gem signin
+
+# Or set API key
+gem signin --key rubygems
+```
+
+## Troubleshooting
+
+### "Invalid version format"
+
+**Problem:** Version doesn't match semantic versioning
+**Solution:** Use format `X.Y.Z` (e.g., `1.2.1`)
+
+### "Failed to push gem to RubyGems"
+
+**Possible causes:**
+
+1. Not authenticated with RubyGems
+2. Version already exists
+3. Network issues
+4. Insufficient permissions
+
+**Solutions:**
+
+```bash
+# Check authentication
+gem signin
+
+# Check existing versions
+gem list rails_map --remote --all
+
+# Try manual push
+gem push rails_map-1.2.1.gem
+```
+
+### "Tests failed"
+
+**Problem:** Test suite not passing
+**Solution:** Fix tests before releasing, or skip with 'y' when prompted
+
+### "Can't find version.rb"
+
+**Problem:** Script not run from project root
+**Solution:** Run from project root directory:
+
+```bash
+cd /path/to/rails-map
+./release.sh
+```
+
+## Manual Release (Without Script)
+
+If you need to release manually:
+
+```bash
+# 1. Update version
+vim lib/rails_map/version.rb
+
+# 2. Update CHANGELOG
+vim CHANGELOG.md
+
+# 3. Commit changes
+git add lib/rails_map/version.rb CHANGELOG.md
+git commit -m "Bump version to 1.2.1"
+git push
+
+# 4. Build gem
+gem build rails_map.gemspec
+
+# 5. Push to RubyGems
+gem push rails_map-1.2.1.gem
+
+# 6. Create tag
+git tag -a v1.2.1 -m "Release version 1.2.1"
+git push origin v1.2.1
+
+# 7. Create GitHub release
+# Go to: https://github.com/ArshdeepGrover/rails-map/releases/new
+```
+
+## Post-Release Tasks
+
+After successful release:
+
+1. **Verify on RubyGems**
+
+   ```
+   https://rubygems.org/gems/rails_map
+   ```
+
+2. **Test installation**
+
+   ```bash
+   gem install rails_map
+   ```
+
+3. **Create GitHub Release**
+   - Go to: https://github.com/ArshdeepGrover/rails-map/releases/new
+   - Tag: v1.2.1
+   - Title: RailsMap v1.2.1
+   - Description: Copy from CHANGELOG.md
+
+4. **Announce Release**
+   - Twitter/X
+   - Reddit (r/rails, r/ruby)
+   - Dev.to
+   - Ruby Weekly
+
+5. **Update Documentation**
+   - Homepage
+   - Wiki
+   - README (if needed)
+
+## Script Customization
+
+### Change Default Behavior
+
+Edit `release.sh` to customize:
+
+```bash
+# Skip tests automatically
+# Comment out the test section
+
+# Auto-commit without asking
+# Change the commit prompt section
+
+# Skip git tagging
+# Comment out the tagging section
+
+# Keep gem file by default
+# Change the cleanup section
+```
+
+## Safety Features
+
+The script includes several safety features:
+
+1. **Version Validation** - Ensures proper semantic versioning
+2. **Confirmation Prompts** - Multiple confirmations before pushing
+3. **Rollback Support** - Can undo changes if push fails
+4. **Pre-flight Checks** - Validates before building
+5. **Error Handling** - Exits gracefully on errors
+
+## Examples
+
+### Patch Release (Bug Fix)
+
+```bash
+./release.sh
+# Enter: 1.2.1
+# Commit: y
+# Push: y
+# Continue: y
+# Tag: y
+```
+
+### Minor Release (New Feature)
+
+```bash
+./release.sh
+# Enter: 1.3.0
+# Commit: y
+# Push: y
+# Continue: y
+# Tag: y
+```
+
+### Major Release (Breaking Changes)
+
+```bash
+./release.sh
+# Enter: 2.0.0
+# Commit: y
+# Push: y
+# Continue: y
+# Tag: y
+```
+
+## Best Practices
+
+1. **Always update CHANGELOG.md first** - Add changes under `[Unreleased]`
+2. **Run tests locally** - Ensure everything works
+3. **Review changes** - Double-check what's being released
+4. **Use semantic versioning** - Follow the guidelines
+5. **Create GitHub releases** - Document each release
+6. **Announce releases** - Let the community know
+7. **Monitor issues** - Watch for problems after release
+
+## Support
+
+If you encounter issues with the release script:
+
+1. Check this guide
+2. Review error messages
+3. Try manual release process
+4. Open an issue on GitHub
+
+---
+
+**Happy Releasing! 🚀**