rails_action_tracker 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4ac49da8b8c381b52b130ff021067565cfc75f0a9ca0ddd33d02d91f6858ffed
+  data.tar.gz: '0097165c635b76cf03054f6b235f49e5b9d237fcd696fcd2617ac22a120b96e0'
+SHA512:
+  metadata.gz: 28e478e066c0a7789ee22ea02fac9cdd622328c71c80bcb5f9ed8e3f31a626645d06ddfd677175d369647cec0986fc726f8559c3d6377190d6d70771ded18917
+  data.tar.gz: a6b6e669e028b166c975744da0dec15071c748a4609f64aa85a64455d1761b069ec53a9d090fddf9b975f62997d63b86ac7060734576c15632ec15ec9c7fcc1b

data/.rubocop.yml

@@ -0,0 +1,61 @@
+AllCops:
+  SuggestExtensions: false
+  TargetRubyVersion: 2.7
+
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: single_quotes
+
+# We want consistent documentation but not strict
+Style/Documentation:
+  Enabled: false
+
+# Allow long lines in some contexts
+Layout/LineLength:
+  Max: 120
+  Exclude:
+    - 'Rakefile'
+    - '**/*.gemspec'
+
+# Disable some metrics that are too strict for test files
+Metrics/BlockLength:
+  Exclude:
+    - 'test/**/*'
+    - 'spec/**/*'
+    - '**/*.gemspec'
+
+Metrics/MethodLength:
+  Exclude:
+    - 'test/**/*'
+    - 'spec/**/*'
+
+# Allow multiple classes in one file for test helpers
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+# Reasonable limits for a gem project
+Metrics/ClassLength:
+  Max: 200
+  Exclude:
+    - 'lib/rails_action_tracker/tracker.rb'
+
+Metrics/MethodLength:
+  Max: 30
+  Exclude:
+    - 'test/**/*'
+    - 'spec/**/*'
+
+Metrics/CyclomaticComplexity:
+  Max: 15
+
+Metrics/PerceivedComplexity:
+  Max: 15
+
+# Disable complex assignment checks in tests
+Metrics/AbcSize:
+  Max: 40
+  Exclude:
+    - 'test/**/*'
+    - 'spec/**/*'

data/Appraisals

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+# Appraisals for testing against Rails versions
+# Starting simple with Rails 6 versions, will expand later
+
+appraise 'rails-6.0' do
+  gem 'activesupport', '~> 6.0.0'
+  gem 'actionpack', '~> 6.0.0'
+  gem 'railties', '~> 6.0.0'
+end
+
+appraise 'rails-6.1' do
+  gem 'activesupport', '~> 6.1.0'
+  gem 'actionpack', '~> 6.1.0'
+  gem 'railties', '~> 6.1.0'
+end

data/CHANGELOG.md

@@ -0,0 +1,41 @@
+# Changelog
+
+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.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - 2025-01-02
+
+### Added
+- Initial release of RailsActionTracker gem
+- ActiveRecord model read/write operation tracking
+- Service usage detection (Redis, Sidekiq, Pusher, HTTP calls, etc.)
+- Configurable logging options:
+  - Rails logger output with colors
+  - Separate log file output (plain text)
+  - Both destinations simultaneously
+- Controller and action name display in output
+- Thread-safe tracking using thread-local storage
+- Automatic Rails middleware integration
+- Ignored tables configuration (PostgreSQL system tables, Rails internals)
+- Custom service detection patterns
+- Rails generator for easy setup (`rails generate rails_action_tracker:install`)
+- Comprehensive test suite with 45 tests, 188 assertions
+- Multi-Rails version support (5.0-8.0) via Appraisal
+- Multi-Ruby version support (2.7-3.4)
+- GitHub Actions CI/CD pipeline
+- Colorized tabular output format
+
+### Features
+- **Model Tracking**: Tracks SELECT, INSERT, UPDATE operations on database tables
+- **Service Detection**: Automatically detects common services from log messages
+- **Flexible Configuration**: Multiple logging destinations and custom patterns
+- **Performance Optimized**: Minimal overhead, skips tracking for assets and test environment
+- **Rails Integration**: Seamless integration via Railtie and middleware
+- **Developer Friendly**: Easy setup with generator and comprehensive documentation
+
+[Unreleased]: https://github.com/deepakmahakale/rails_action_tracker/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/deepakmahakale/rails_action_tracker/releases/tag/v0.1.0

data/CONTRIBUTING.md

@@ -0,0 +1,172 @@
+# Contributing to RailsActionTracker
+
+We welcome contributions to RailsActionTracker! This document provides guidelines for contributing to the project.
+
+## Getting Started
+
+Before contributing, please:
+1. Read this document completely
+2. Check existing issues and pull requests
+3. Set up your development environment (see [DEVELOPMENT.md](DEVELOPMENT.md))
+
+## Types of Contributions
+
+### Bug Reports
+- **Search existing issues** first to avoid duplicates
+- **Use the issue template** if available
+- **Provide clear steps to reproduce** the bug
+- **Include relevant system information** (Ruby version, Rails version, gem version)
+- **Add error messages** and stack traces when applicable
+
+### Feature Requests
+- **Explain the use case** for your proposed feature
+- **Provide examples** of how it would be used
+- **Consider backward compatibility** implications
+- **Discuss implementation approach** if you have ideas
+
+### Code Contributions
+- **Fork the repository** and create a feature branch
+- **Follow coding standards** (see Code Style section below)
+- **Write comprehensive tests** for your changes
+- **Update documentation** when needed
+- **Ensure CI passes** before submitting
+
+## Development Process
+
+### 1. Fork and Clone
+```bash
+git clone https://github.com/YOUR_USERNAME/rails_action_tracker.git
+cd rails_action_tracker
+```
+
+### 2. Create Feature Branch
+```bash
+git checkout -b feature/your-feature-name
+# or
+git checkout -b fix/issue-description
+```
+
+### 3. Make Changes
+- Follow the coding standards outlined below
+- Write or update tests for your changes
+- Update documentation if needed
+
+### 4. Test Your Changes
+```bash
+# Run the full test suite
+bundle exec rake test
+
+# Test against multiple Rails versions
+./script/test-all
+
+# Check code style
+bundle exec rubocop
+```
+
+### 5. Submit Pull Request
+- **Write a clear title** and description
+- **Reference related issues** using keywords like "Closes #123"
+- **Explain your changes** and why they're needed
+- **Include screenshots** for UI changes (if applicable)
+
+## Code Style
+
+### Ruby Style Guide
+We use RuboCop to enforce code style. Key points:
+- **Use single quotes** for string literals
+- **2 spaces** for indentation
+- **Line length**: 120 characters maximum
+- **Follow Ruby community conventions**
+
+### Testing Standards
+- **Write tests** for all new functionality
+- **Update existing tests** when modifying behavior
+- **Use descriptive test names** that explain what is being tested
+- **Follow existing test patterns** in the codebase
+
+### Documentation Standards
+- **Update README.md** for user-facing changes
+- **Add inline comments** for complex logic
+- **Update CHANGELOG.md** for notable changes
+- **Use clear, concise language**
+
+## Commit Guidelines
+
+### Commit Messages
+Follow these guidelines for commit messages:
+- **Use present tense** ("Add feature" not "Added feature")
+- **Use imperative mood** ("Move cursor to..." not "Moves cursor to...")
+- **Limit first line to 72 characters**
+- **Reference issues and pull requests** when applicable
+
+### Examples
+```
+Add support for custom service detection patterns
+
+- Allow users to specify custom regex patterns for service detection
+- Update configuration documentation
+- Add comprehensive tests
+
+Closes #123
+```
+
+## Review Process
+
+### What to Expect
+- **All PRs require review** before merging
+- **Automated tests** must pass
+- **Code style checks** must pass
+- **Maintainer feedback** may require changes
+
+### How to Address Feedback
+- **Respond to all comments** even if just to acknowledge
+- **Make requested changes** in new commits (don't force push)
+- **Ask for clarification** if feedback is unclear
+- **Be patient and respectful** during the review process
+
+## Release Process
+
+Releases are handled by maintainers:
+1. Version bump in `lib/rails_action_tracker/version.rb`
+2. Update `CHANGELOG.md` with changes
+3. Create git tag and push to GitHub
+4. Build and push gem to RubyGems
+
+## Code of Conduct
+
+### Our Pledge
+We are committed to providing a friendly, safe, and welcoming environment for all contributors.
+
+### Expected Behavior
+- **Be respectful** and inclusive
+- **Accept constructive feedback** gracefully
+- **Focus on what's best** for the community
+- **Show empathy** towards other community members
+
+### Unacceptable Behavior
+- **Harassment** of any form
+- **Discriminatory language** or behavior
+- **Personal attacks** or trolling
+- **Publishing private information** without consent
+
+## Getting Help
+
+### Resources
+- **Documentation**: Check README.md and other docs first
+- **Development Setup**: See [DEVELOPMENT.md](DEVELOPMENT.md)
+- **Issues**: Search existing issues for similar problems
+- **Discussions**: Use GitHub Discussions for questions
+
+### Contact
+- **GitHub Issues**: For bugs and feature requests
+- **GitHub Discussions**: For general questions
+- **Email**: For security issues or private matters
+
+## Recognition
+
+Contributors are recognized in:
+- **CHANGELOG.md** for notable contributions
+- **GitHub contributors page** automatically
+- **Release notes** for significant features
+
+Thank you for contributing to RailsActionTracker! 🎉

data/DEVELOPMENT.md

@@ -0,0 +1,191 @@
+# Development Guide
+
+We welcome contributions! Here's how to get started with development and testing.
+
+## Prerequisites
+
+- Ruby 2.7+ (we test against 2.7, 3.0, 3.1, 3.4)
+- Bundler
+- Git
+
+## Setup
+
+1. **Clone the repository**
+   ```bash
+   git clone https://github.com/deepakmahakale/rails_action_tracker.git
+   cd rails_action_tracker
+   ```
+
+2. **Install dependencies**
+   ```bash
+   bundle install
+   ```
+
+3. **Generate Appraisal gemfiles** (for multi-Rails version testing)
+   ```bash
+   bundle exec appraisal install
+   ```
+
+## Testing
+
+### Quick Tests (Current Ruby + Latest Rails)
+```bash
+# Run all tests with current setup
+bundle exec rake test
+
+# Run with verbose output
+bundle exec rake test TESTOPTS="-v"
+```
+
+### Multi-Rails Version Testing
+```bash
+# Test against specific Rails version
+bundle exec appraisal rails-7.1 rake test
+bundle exec appraisal rails-6.1 rake test
+
+# Test all Rails versions (comprehensive)
+./script/test-all
+```
+
+### Multi-Ruby Version Testing
+We use GitHub Actions for multi-Ruby testing, but you can test locally with rbenv/rvm:
+
+```bash
+# Example with rbenv
+rbenv shell 3.1.0
+bundle install
+bundle exec rake test
+
+rbenv shell 2.7.6
+bundle install
+bundle exec rake test
+```
+
+## Code Quality
+
+### Run RuboCop (linting)
+```bash
+# Check for style issues
+bundle exec rubocop
+
+# Auto-fix issues where possible
+bundle exec rubocop -a
+```
+
+### Run Security Checks
+```bash
+# Install and run bundle audit
+gem install bundler-audit
+bundle audit --update
+
+# Install and run Brakeman (if you have a Rails app structure)
+gem install brakeman
+brakeman --rails4 --no-pager
+```
+
+## Testing Your Changes
+
+### Test Different Scenarios
+```bash
+# Test specific functionality
+bundle exec ruby -Ilib:test test/test_tracker.rb
+bundle exec ruby -Ilib:test test/test_middleware.rb
+
+# Test with different configurations
+RAILS_ENV=development bundle exec rake test
+RAILS_ENV=production bundle exec rake test
+```
+
+### Manual Testing in Rails App
+1. Build the gem locally:
+   ```bash
+   gem build rails_action_tracker.gemspec
+   ```
+
+2. In a Rails app, use the local gem:
+   ```ruby
+   # Gemfile
+   gem 'rails_action_tracker', path: '/path/to/local/rails_action_tracker'
+   # or
+   gem 'rails_action_tracker', '~> 0.1.0', path: '/path/to/local/rails_action_tracker'
+   ```
+
+3. Test the functionality:
+   ```bash
+   cd your_rails_app
+   bundle install
+   rails generate rails_action_tracker:install
+   rails server
+   # Make requests and observe the tracking output
+   ```
+
+## Supported Versions
+
+The gem is tested against these combinations:
+
+**Ruby Versions:**
+- 2.7.x
+- 3.0.x
+- 3.1.x
+- 3.4.x
+
+**Rails Versions:**
+- 5.0.x, 5.1.x, 5.2.x (Ruby 2.7 only)
+- 6.0.x (Ruby 2.7, 3.0 only)
+- 6.1.x, 7.0.x, 7.1.x (Ruby 2.7, 3.0, 3.1, 3.4)
+- 8.0.x (Ruby 3.0, 3.1, 3.4 only)
+
+## Debugging
+
+### Enable Verbose Logging
+```ruby
+# In your test or Rails app
+RailsActionTracker::Tracker.configure(
+  print_to_rails_log: true,
+  write_to_file: true,
+  log_file_path: 'debug_tracker.log'
+)
+```
+
+### Test Individual Components
+```bash
+# Test just the tracker
+bundle exec ruby -Ilib -e "require 'rails_action_tracker'; puts 'Loaded successfully'"
+
+# Test SQL parsing
+bundle exec ruby -Ilib:test -e "
+require 'test_helper'
+tracker = RailsActionTracker::Tracker
+tracker.start_tracking
+tracker.send(:log_query, 'SELECT * FROM users WHERE id = 1')
+puts tracker.stop_tracking
+"
+```
+
+## Release Process
+
+To release a new version:
+
+1. Update the version number in `lib/rails_action_tracker/version.rb`
+2. Update `CHANGELOG.md` with new changes
+3. Run the full test suite: `./script/test-all`
+4. Commit changes: `git commit -am 'Release v0.x.x'`
+5. Create git tag: `git tag v0.x.x`
+6. Push changes: `git push origin master --tags`
+7. Build and push gem: `bundle exec rake release`
+
+## Project Structure
+
+```
+├── lib/
+│   ├── rails_action_tracker/
+│   │   ├── tracker.rb          # Core tracking logic
+│   │   ├── middleware.rb       # Rails middleware integration
+│   │   ├── railtie.rb         # Rails engine integration
+│   │   └── version.rb         # Version definition
+│   └── rails_action_tracker.rb # Main entry point
+├── test/                      # Test suite
+├── gemfiles/                  # Appraisal-generated gemfiles
+├── script/test-all           # Multi-version testing script
+└── .github/workflows/ci.yml  # GitHub Actions CI
+```

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Deepak Mahakale
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.