rails_map 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d05313cead9a321ab471d6732ef4bda483d19d84e85c1f0b89df54de78a73923
-  data.tar.gz: 55e1770e212c073d23a7cc4e7d6a621d30cff0b27eedb1a698953c23cc480101
+  metadata.gz: 48342f6fbf73d56fd547dfd0565604fc58165a331b4890d2e22c4abc31838498
+  data.tar.gz: 32163fbc27d52a6615d639008f38dada8f16c64da83e80c8679b899db6003e68
 SHA512:
-  metadata.gz: 45b4aa87d511bb5465f6aad25c283f6102798498181326fe76f91d94f4cf72d1fe1ad6a6e9d22dcaaf51d4523a82d863604e88a158d1aec8c2ab9da3935b0ab3
-  data.tar.gz: 3e12e56d5b06dd8ddce1c18881fdda137022359a8eb39715ca1b73d1bd7481e0c55188a23ca53edd779e869d78b9a82772ca49d77539850cc1c1e9146611ef0a
+  metadata.gz: 9d779878c8463a756d8817102cacb2c8c2f494f41247893aad4e450be8fd3a6800984d76286e7e701c48247e3ec2e12498ef8df2e06c01f88fd7c6c3f64bec47
+  data.tar.gz: 3d01c86330c56e2fd4d3b620d69ad1e068749ad3c1e1d3105cee1b2f4d5d2478bf765ffdb016aab08f205dbc4f394ea464dcb894962adf2feb1611eb068ffb43

data/.vscode/settings.json

@@ -0,0 +1,2 @@
+{
+}

data/AUTHENTICATION.md

@@ -9,7 +9,7 @@ This guide shows you how to protect your Rails documentation with authentication
 In your `config/routes.rb`:
 
 ```ruby
-mount RailsMap::Engine, at: '/api-doc'
+mount RailsMap::Engine, at: '/rails-map'
 ```
 
 ### 2. Create Configuration File
@@ -20,7 +20,7 @@ Create `config/initializers/rails_map.rb` in your Rails application:
 RailsMap.configure do |config|
   config.app_name = 'Your App Name'
   config.theme_color = '#3B82F6'
-  
+
   # Add authentication
   config.authenticate_with = proc {
     # Your authentication logic here
@@ -37,12 +37,14 @@ If you don't use Devise, use the built-in authentication system.
 **Setup:**
 
 1. Install with authentication:
+
 ```bash
 rails g rails_map:install
 rails db:migrate
 ```
 
 2. Create admin user(s):
+
 ```bash
 rails c
 RailsMap::User.create!(username: 'admin', password: 'your_secure_password')
@@ -50,13 +52,14 @@ RailsMap::User.create!(username: 'developer', password: 'another_password')
 ```
 
 3. Enable in configuration:
+
 ```ruby
 config.authenticate_with = proc {
   RailsMap::Auth.authenticate(self)
 }
 ```
 
-4. Restart server and visit `/api-doc` - you'll be prompted for username/password
+4. Restart server and visit `/rails-map` - you'll be prompted for username/password
 
 **Managing Users:**
 
@@ -141,7 +144,7 @@ config.authenticate_with = proc {
     redirect_to login_path
     return
   end
-  
+
   # Check user role
   unless current_user&.has_role?(:developer)
     render plain: 'Unauthorized', status: :unauthorized
@@ -156,7 +159,7 @@ Restrict by IP address:
 ```ruby
 config.authenticate_with = proc {
   allowed_ips = ['127.0.0.1', '::1', '10.0.0.0/8']
-  
+
   unless allowed_ips.any? { |ip| IPAddr.new(ip).include?(request.remote_ip) }
     render plain: 'Forbidden', status: :forbidden
   end
@@ -168,7 +171,7 @@ config.authenticate_with = proc {
 After configuring authentication:
 
 1. Restart your Rails server
-2. Visit `http://localhost:3000/api-doc`
+2. Visit `http://localhost:3000/rails-map`
 3. You should be prompted to authenticate
 
 ## No Authentication (Development Only)
@@ -210,6 +213,7 @@ config.authenticate_with = proc {
 ### Helper Methods Not Available
 
 The authentication block runs in the controller context, so you have access to:
+
 - `request`
 - `session`
 - `cookies`

data/CHANGELOG.md

@@ -5,7 +5,7 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [1.1.1] - 2026-02-12
+## [1.2.0] - 2026-02-12
 
 ### Added
 
@@ -22,18 +22,44 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Support for simple permit pattern (`params.permit()`)
 - Support for direct parameter access pattern (`params[:key]`)
 - Parameter documentation in both live and static HTML documentation
+- Enhanced release script with interactive version management
+- Automatic version and CHANGELOG updates in release script
+- Rollback support in release script if push fails
+- Comprehensive community health files (CODE_OF_CONDUCT.md, CONTRIBUTING.md, SECURITY.md)
+- GitHub issue and PR templates
+- CI/CD workflow for automated testing across Ruby 2.7-3.3 and Rails 6.0-7.1
+- Enhanced gemspec with detailed description and post-install message
+- README badges for gem version, downloads, license, Ruby, and Rails versions
 
 ### Changed
 
+- **BREAKING:** Default mount path changed from `/api-doc` to `/rails-map` for better branding
 - Routes page now displays "Parameters" column instead of "Route Name" column
 - Controller page now displays "Parameters" column instead of "Constraints" column
 - Enhanced user experience with expandable parameter details
+- Improved gemspec metadata with additional URIs (wiki, funding, documentation)
+- Better Rails dependency specification (>= 5.0, < 8.0)
+
+### Migration Guide
+
+If upgrading from v1.1.x, update your routes file:
+
+```ruby
+# config/routes.rb
+# Old:
+mount RailsMap::Engine, at: '/api-doc'
+
+# New:
+mount RailsMap::Engine, at: '/rails-map'
+```
+
+Then visit `http://localhost:3000/rails-map` instead of `/api-doc`.
 
 ## [1.1.0] - 2026-02-10
 
 ### Added
 
-- Live documentation via Rails Engine mounting at `/api-doc`
+- Live documentation via Rails Engine mounting at `/rails-map`
 - Built-in authentication system (no Devise required) with `RailsMap::User` model
 - Generator for easy installation: `rails g rails_map:install [--skip-auth]`
 - Authentication enabled by default for security

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,129 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+arsh199820@gmail.com.
+
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

data/CONTRIBUTING.md

@@ -0,0 +1,211 @@
+# Contributing to RailsMap
+
+First off, thank you for considering contributing to RailsMap! 🎉
+
+It's people like you that make RailsMap such a great tool for the Rails community.
+
+## Table of Contents
+
+- [Code of Conduct](#code-of-conduct)
+- [How Can I Contribute?](#how-can-i-contribute)
+- [Development Setup](#development-setup)
+- [Pull Request Process](#pull-request-process)
+- [Style Guidelines](#style-guidelines)
+- [Reporting Bugs](#reporting-bugs)
+- [Suggesting Enhancements](#suggesting-enhancements)
+
+## Code of Conduct
+
+This project and everyone participating in it is governed by our [Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.
+
+## How Can I Contribute?
+
+### Reporting Bugs
+
+Before creating bug reports, please check the [issue tracker](https://github.com/ArshdeepGrover/rails-map/issues) as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible:
+
+- **Use a clear and descriptive title**
+- **Describe the exact steps to reproduce the problem**
+- **Provide specific examples to demonstrate the steps**
+- **Describe the behavior you observed and what behavior you expected**
+- **Include screenshots if relevant**
+- **Include your environment details:**
+  - Rails version
+  - Ruby version
+  - RailsMap version
+  - Operating system
+
+### Suggesting Enhancements
+
+Enhancement suggestions are tracked as GitHub issues. When creating an enhancement suggestion, please include:
+
+- **Use a clear and descriptive title**
+- **Provide a detailed description of the suggested enhancement**
+- **Explain why this enhancement would be useful**
+- **List any similar features in other tools**
+
+### Pull Requests
+
+We actively welcome your pull requests:
+
+1. Fork the repo and create your branch from `main`
+2. If you've added code that should be tested, add tests
+3. Ensure the test suite passes
+4. Make sure your code follows the existing style
+5. Write a clear commit message
+6. Submit your pull request!
+
+## Development Setup
+
+1. **Fork and clone the repository**
+
+   ```bash
+   git clone https://github.com/YOUR_USERNAME/rails-map.git
+   cd rails-map
+   ```
+
+2. **Install dependencies**
+
+   ```bash
+   bundle install
+   ```
+
+3. **Run tests**
+
+   ```bash
+   bundle exec rake spec
+   ```
+
+4. **Test locally in a Rails app**
+
+   ```bash
+   # In your gemfile
+   gem 'rails_map', path: '/path/to/your/local/rails-map'
+
+   # Then
+   bundle install
+   rails g rails_map:install
+   rails server
+   ```
+
+## Pull Request Process
+
+1. **Update documentation** - Update the README.md with details of changes if applicable
+2. **Update CHANGELOG.md** - Add your changes under the "Unreleased" section
+3. **Follow the style guidelines** - Ensure your code follows Ruby and Rails conventions
+4. **Write tests** - Add tests for new features or bug fixes
+5. **Keep commits clean** - Use clear, descriptive commit messages
+6. **One feature per PR** - Keep pull requests focused on a single feature or fix
+
+### Commit Message Guidelines
+
+- Use the present tense ("Add feature" not "Added feature")
+- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
+- Limit the first line to 72 characters or less
+- Reference issues and pull requests liberally after the first line
+
+Examples:
+
+```
+Add parameter detection for nested routes
+
+- Extract nested parameters from controller actions
+- Add tests for nested parameter detection
+- Update documentation
+
+Fixes #123
+```
+
+## Style Guidelines
+
+### Ruby Style Guide
+
+- Follow the [Ruby Style Guide](https://rubystyle.guide/)
+- Use 2 spaces for indentation (no tabs)
+- Keep lines under 120 characters
+- Use meaningful variable and method names
+- Add comments for complex logic
+
+### Code Organization
+
+- Keep methods small and focused
+- Follow Single Responsibility Principle
+- Use descriptive names for classes and modules
+- Organize code logically within files
+
+### Testing
+
+- Write tests for new features
+- Ensure existing tests pass
+- Aim for good test coverage
+- Use descriptive test names
+
+## Project Structure
+
+```
+rails-map/
+├── app/                    # Rails engine views and controllers
+│   ├── controllers/
+│   ├── models/
+│   └── views/
+├── lib/                    # Core library code
+│   ├── generators/         # Rails generators
+│   ├── rails_map/
+│   │   ├── parsers/       # Route and model parsers
+│   │   └── generators/    # HTML generators
+│   └── rails_map.rb
+├── templates/              # HTML templates
+├── spec/                   # Tests
+└── docs/                   # Documentation
+```
+
+## Areas for Contribution
+
+We especially welcome contributions in these areas:
+
+### High Priority
+
+- [ ] Additional parameter detection patterns
+- [ ] Support for more Rails versions
+- [ ] Performance improvements
+- [ ] Better error handling
+- [ ] More comprehensive tests
+
+### Medium Priority
+
+- [ ] Additional themes and customization options
+- [ ] Export to different formats (JSON, Markdown, etc.)
+- [ ] Integration with API documentation tools
+- [ ] Internationalization (i18n)
+
+### Nice to Have
+
+- [ ] Interactive API testing
+- [ ] Request/response examples
+- [ ] API versioning support
+- [ ] GraphQL support
+- [ ] WebSocket documentation
+
+## Questions?
+
+Feel free to:
+
+- Open an issue with the "question" label
+- Reach out to the maintainers
+- Check existing issues and discussions
+
+## Recognition
+
+Contributors will be recognized in:
+
+- The CHANGELOG.md file
+- GitHub contributors page
+- Project documentation
+
+## License
+
+By contributing, you agree that your contributions will be licensed under the MIT License.
+
+---
+
+Thank you for contributing to RailsMap! 🚀

data/QUICKSTART.md

@@ -23,18 +23,21 @@ bundle install
 ### Default Installation (With Authentication - Recommended)
 
 1. Run the generator:
+
 ```bash
 rails g rails_map:install
 rails db:migrate
 ```
 
 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`
 
 2. Create an admin user:
+
 ```bash
 rails c
 RailsMap::User.create!(username: 'admin', password: 'your_secure_password')
@@ -42,11 +45,12 @@ exit
 ```
 
 3. Start your server:
+
 ```bash
 rails s
 ```
 
-4. Visit `http://localhost:3000/api-doc` and login with your credentials
+4. Visit `http://localhost:3000/rails-map` and login with your credentials
 
 **That's it!** 🎉 Secure by default!
 
@@ -55,16 +59,18 @@ rails s
 ### Skip Authentication (Development Only)
 
 1. Run the generator with --skip-auth flag:
+
 ```bash
 rails g rails_map:install --skip-auth
 ```
 
 2. Start your server:
+
 ```bash
 rails s
 ```
 
-3. Visit: `http://localhost:3000/api-doc`
+3. Visit: `http://localhost:3000/rails-map`
 
 **No authentication required!** Use only in development.
 
@@ -95,22 +101,26 @@ config.include_timestamps = false
 ## Managing Users (Built-in Auth)
 
 ### Create User
+
 ```ruby
 RailsMap::User.create!(username: 'developer', password: 'password123')
 ```
 
 ### Change Password
+
 ```ruby
 user = RailsMap::User.find_by(username: 'developer')
 user.update!(password: 'new_password')
 ```
 
 ### Delete User
+
 ```ruby
 RailsMap::User.find_by(username: 'developer').destroy
 ```
 
 ### List All Users
+
 ```ruby
 RailsMap::User.all.pluck(:username)
 ```
@@ -129,16 +139,19 @@ Files are generated in `doc/api/` by default.
 
 ## Troubleshooting
 
-### Can't access /api-doc
+### Can't access /rails-map
+
 - Make sure you've mounted the engine in `config/routes.rb`
 - Restart your Rails server
 
 ### Authentication not working
+
 - Verify you've run migrations: `rails db:migrate`
 - Check that you've created a user
 - Ensure authentication is enabled in the initializer
 
 ### Controllers with slashes not showing
+
 - Update the gem to the latest version
 - The route constraint issue has been fixed
 

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