pg_multitenant_schemas 0.2.0 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb953481e57f8425d7a272414d51e9225d224f6975f7e519051566f8e6c58406
-  data.tar.gz: 3512040a1448b3a8cca8f829717ecc373510234bc53e2d84243272ea16903846
+  metadata.gz: f362436f339eb06d63f3c54a928054b0dd454eb0c6165f219d57ad1658476b50
+  data.tar.gz: 150c105745e09f419168145f57a70c856241fea231cf20d87d01d8cce1da60a6
 SHA512:
-  metadata.gz: c4e77e04b02112a32d8ac953ab0c88a662cc599ec1fc498f6c3205c3a4596ba74e26c514add5de50df58414ff4dfd62a65241e2dbe26f1dbfcdd3093eab25426
-  data.tar.gz: 267b65ce20ab82f817c1ecd959dcd3781ad7f0b00434a381cf3a7968cf1e5363bf57519d26e07cf3bc9d75b90797f2b394c2a3bca8ef060b52e01768ce8c10e4
+  metadata.gz: 228d2da53051f03e48dd828eec5817987b4029c850026a58493cec6a7877a126cf5b632722bcc5607c686b704e87555bfad583d364895a314182317f6ce0f9c8
+  data.tar.gz: c891689fabcd8b3ee54752f9dc3a7bd54c37eabf9a081a4696f23ec0bb01cf0439a98899c8a51ba90661ca92929719f3fd1c3e63d63b54b8b9a56393f418fc4e

data/.actrc

@@ -0,0 +1,17 @@
+# act configuration file
+# This configures act to run GitHub Actions locally
+
+# Use Linux AMD64 architecture for compatibility
+--container-architecture linux/amd64
+
+# Set artifact server path
+--artifact-server-path /tmp/act-artifacts
+
+# Load environment variables from local file
+--env-file .env.local
+
+# Use medium size runner image
+--platform ubuntu-latest=catthehacker/ubuntu:act-latest
+
+# Show more verbose output
+--verbose

data/.env.local.example

@@ -0,0 +1,21 @@
+# Local environment variables for testing with act
+# Copy this to .env.local and fill in your actual values
+
+# GitHub token (create at https://github.com/settings/tokens)
+# Needs repo and workflow permissions
+GITHUB_TOKEN=your_github_token_here
+
+# RubyGems API key (get from https://rubygems.org/profile/edit)
+# Only needed for testing release workflow
+RUBYGEMS_API_KEY=your_rubygems_api_key_here
+
+# Repository information
+GITHUB_REPOSITORY=rubenpazch/pg_multitenant_schemas
+GITHUB_ACTOR=your_github_username
+
+# PostgreSQL configuration for local testing
+PGDATABASE=pg_multitenant_test
+PGUSER=postgres
+PGPASSWORD=
+PGHOST=localhost
+PGPORT=5432

data/CHANGELOG.md

@@ -5,7 +5,39 @@ 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.2.3] - 2025-01-17
+
+### 🔧 **Developer Experience & Testing**
+- **NEW: Local Workflow Testing**: Complete solution for testing GitHub Actions locally before push
+- **NEW: Pre-Push Validation**: `pre-push-check.sh` script validates CI components locally  
+- **NEW: GitHub Actions Testing**: `act` tool integration with configuration files
+- **NEW: Validation Scripts**: `validate-github-commands.sh` and `test-github-setup.sh`
+
+### 🚀 **CI/CD Improvements**
+- **FIXED: GitHub Actions Permissions**: Resolved permission issues with release workflow
+- **FIXED: RSpec Command**: Corrected `--exclude-pattern` usage for unit test isolation
+- **IMPROVED: Release Automation**: Enhanced release workflow with proper bot identity
+- **IMPROVED: Documentation**: Comprehensive guides for CI/CD setup and troubleshooting
+
+### 📚 **Documentation Enhancements**
+- **NEW: Local Testing Guide**: `TESTING_LOCALLY.md` and `LOCAL_TESTING_SUMMARY.md`
+- **NEW: CI/CD Setup Guide**: `docs/github_actions_setup.md` with step-by-step instructions
+- **NEW: Permissions Fix Guide**: `docs/github_actions_permissions_fix.md`
+- **NEW: Workflow Testing Guide**: `docs/local_workflow_testing.md`
+- **IMPROVED: Core Documentation**: Updated `docs/README.md` with local testing references
+
+### 🧪 **Testing Infrastructure**
+- **ENHANCED: RuboCop Compliance**: Fixed all code style violations across test suite
+- **ENHANCED: Test Organization**: Improved test structure and mocking patterns
+- **ENHANCED: Integration Testing**: Better PostgreSQL integration test support
+- **ENHANCED: Security Auditing**: Bundle audit integration in CI pipeline
+
+### 🔧 **Configuration Files**
+- **NEW: `.actrc`**: Configuration for local GitHub Actions testing
+- **NEW: `.env.local.example`**: Template for local environment variables
+- **IMPROVED: `.gitignore`**: Added local testing files to ignore list
+
+## [0.2.1] - 2025-09-06
 
 ### 🚀 **Migration System Overhaul** 
 - **NEW: Automated Migration Management**: Complete migration system for multi-tenant schemas
@@ -94,3 +126,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Initial release
 - Basic schema switching functionality
 - PostgreSQL multitenancy support
+
+[Unreleased]: https://github.com/rubenpazch/pg_multitenant_schemas/compare/v0.2.2...HEAD
+[0.2.2]: https://github.com/rubenpazch/pg_multitenant_schemas/compare/v0.2.1...v0.2.2
+[0.2.1]: https://github.com/rubenpazch/pg_multitenant_schemas/compare/v0.2.0...v0.2.1
+[0.2.0]: https://github.com/rubenpazch/pg_multitenant_schemas/compare/v0.1.0...v0.2.0
+[0.1.0]: https://github.com/rubenpazch/pg_multitenant_schemas/releases/tag/v0.1.0

data/LOCAL_TESTING_SUMMARY.md

@@ -0,0 +1,141 @@
+# 🧪 Summary: How to Test GitHub Workflows Locally
+
+## ✅ What You Can Do Right Now
+
+### 1. **Pre-Push Script (Recommended)**## 📁 **Files Created**
+
+- **`pre-push-check.sh`** - Main testing script
+- **`validate-github-commands.sh`** - Test exact GitHub Actions commands
+- **`TESTING_LOCALLY.md`** - Quick start guide
+- **`docs/local_workflow_testing.md`** - Complete documentation
+- **`.actrc`** - act configuration
+- **`.env.local.example`** - Environment templateh
+# Run this before every push
+./pre-push-check.sh
+```
+This validates everything that runs in CI:
+- ✅ RuboCop (code style)
+- ✅ RSpec (tests)
+- ✅ Bundle audit (security)
+- ✅ Gem building
+- ✅ Integration tests (if PostgreSQL available)
+
+### 2. **Manual Component Testing**
+```bash
+```bash
+# Test each CI component individually
+bundle install
+bundle exec rubocop              # Code style check
+bundle exec rspec               # Run all tests
+bundle exec rspec --tag integration  # Integration tests only
+bundle exec rspec --exclude-pattern '**/integration/**/*_spec.rb'  # Unit tests only
+bundle audit                    # Security audit
+gem build pg_multitenant_schemas.gemspec  # Test gem build
+```
+```
+
+### 3. **act Tool (Partial Support)**
+```bash
+# List workflows
+act -l
+
+# Dry run (shows what would execute)
+act -n push
+
+# Note: Currently has issues with PostgreSQL services
+# Better for simple workflows without database dependencies
+```
+
+## 🎯 **Before Every Push Checklist**
+
+1. ✅ Run `./pre-push-check.sh`
+2. ✅ Fix any issues found
+3. ✅ Commit your changes
+4. ✅ Push to GitHub
+
+## 📋 **Component Status**
+
+| Component | Local Testing | Status |
+|-----------|---------------|---------|
+| RuboCop | ✅ `bundle exec rubocop` | Working |
+| Unit Tests | ✅ `bundle exec rspec` | Working |
+| Integration Tests | ✅ With local PostgreSQL | Working |
+| Security Audit | ✅ `bundle audit` | Working |
+| Gem Building | ✅ `gem build *.gemspec` | Working |
+| Release Workflow | ⚠️ Manual simulation only | Partial |
+| Full CI with act | ⚠️ PostgreSQL service issues | Limited |
+
+## 🔧 **Quick Setup**
+
+1. **Make pre-push script executable:**
+   ```bash
+   chmod +x pre-push-check.sh
+   ```
+
+2. **Install act (optional):**
+   ```bash
+   brew install act
+   ```
+
+3. **Create environment file (for act):**
+   ```bash
+   cp .env.local.example .env.local
+   # Edit .env.local with your tokens if needed
+   ```
+
+## 🚀 **Recommended Workflow**
+
+```bash
+# 1. Make your changes
+git add .
+
+# 2. Test locally
+./pre-push-check.sh
+
+# 3. If all passes, commit and push
+git commit -m "Your changes"
+git push
+```
+
+## 🛠️ **Troubleshooting**
+
+### PostgreSQL Issues
+```bash
+# Check if PostgreSQL is running
+pg_isready
+
+# Start PostgreSQL (macOS)
+brew services start postgresql@15
+
+# Create test database
+createdb pg_multitenant_test
+```
+
+### Ruby Issues
+```bash
+# Install correct Ruby version
+rbenv install 3.3.0
+rbenv local 3.3.0
+bundle install
+```
+
+### act Issues
+```bash
+# Try without services (simpler)
+act -j security  # Just run security audit job
+
+# Check Docker is running
+docker ps
+```
+
+## 📚 **Files Created**
+
+- **`pre-push-check.sh`** - Main testing script
+- **`TESTING_LOCALLY.md`** - Quick start guide
+- **`docs/local_workflow_testing.md`** - Complete documentation
+- **`.actrc`** - act configuration
+- **`.env.local.example`** - Environment template
+
+---
+
+**💡 Bottom Line**: Use `./pre-push-check.sh` for reliable local testing. It covers 95% of what CI does and catches issues early!

data/README.md

@@ -3,14 +3,14 @@
 [![Gem Version](https://badge.fury.io/rb/pg_multitenant_schemas.svg)](https://badge.fury.io/rb/pg_multitenant_schemas)
 [![Ruby](https://github.com/yourusername/pg_multitenant_schemas/actions/workflows/main.yml/badge.svg)](https://github.com/yourusername/pg_multitenant_schemas/actions/workflows/main.yml)
 
-A modern Ruby gem that provides PostgreSQL schema-based multitenancy with automatic tenant resolution and schema switching. Built for Rails 8+ and Ruby 3.3+, focusing on security, performance, and developer experience.
+A modern Ruby gem that provides PostgreSQL schema-based multitenancy with automatic tenant resolution and schema switching. Compatible with Rails 7+ and Ruby 3.0+, with optimizations for Rails 8, focusing on security, performance, and developer experience.
 
 ## ✨ Features
 
 - 🏢 **Schema-based multitenancy** - Complete tenant isolation using PostgreSQL schemas
 - 🔄 **Automatic schema switching** - Seamlessly switch between tenant schemas  
 - 🌐 **Subdomain resolution** - Extract tenant from request subdomains
-- � **Rails 8+ optimized** - Built for modern Rails applications
+- 🔄 **Rails 7+ compatible** - Works with Rails 7 and optimized for Rails 8
 - �️ **Security-first design** - Database-level tenant isolation
 - 🧵 **Thread-safe** - Safe for concurrent operations
 - 📝 **Comprehensive logging** - Track schema operations
@@ -20,8 +20,8 @@ A modern Ruby gem that provides PostgreSQL schema-based multitenancy with automa
 
 ## Requirements
 
-- Ruby 3.4+
-- Rails 8.0+
+- Ruby 3.0+
+- Rails 7.0+
 - PostgreSQL 12+
 - **pg gem**: 1.5 or higher
 

data/TESTING_LOCALLY.md

@@ -0,0 +1,208 @@
+# 🚀 Quick Start: Testing GitHub Workflows Locally
+
+This guide gets you up and running quickly with local GitHub Actions testing.
+
+## 🎯 TL;DR - Quick Commands
+
+```bash
+# 1. Run pre-push checks (recommended before every push)
+./pre-push-check.sh
+
+# 2. Test GitHub Actions locally with act
+act -l                    # List all workflows
+act push                  # Test CI workflow
+act pull_request         # Test PR workflow
+
+# 3. Manual component testing
+bundle exec rubocop      # Code style check
+bundle exec rspec        # Run tests
+gem build *.gemspec     # Test gem building
+```
+
+## 🔧 One-Time Setup
+
+### 1. Install act (if not already installed)
+
+```bash
+# macOS
+brew install act
+
+# Linux
+curl https://raw.githubusercontent.com/nektos/act/master/install.sh | sudo bash
+
+# Windows
+choco install act-cli
+```
+
+### 2. Create local environment file
+
+```bash
+# Copy the example and fill in your values
+cp .env.local.example .env.local
+
+# Edit with your actual tokens (optional, only needed for release testing)
+nano .env.local
+```
+
+## 🧪 Testing Strategies
+
+### Strategy 1: Pre-Push Script (Recommended)
+
+Run this before every push:
+
+```bash
+./pre-push-check.sh
+```
+
+This runs:
+- ✅ RuboCop (code style)
+- ✅ RSpec (unit tests)  
+- ✅ Security audit
+- ✅ Gem build test
+- ✅ Integration tests (if PostgreSQL available)
+
+### Strategy 2: act - GitHub Actions Locally
+
+```bash
+# Test the main CI workflow
+act push
+
+# Test pull request workflow
+act pull_request
+
+# Dry run (see what would execute)
+act -n
+
+# Test specific job
+act -j test
+
+# List all available workflows and jobs
+act -l
+```
+
+### Strategy 3: Manual Component Testing
+
+```bash
+# Test each component individually
+bundle install
+bundle exec rubocop
+bundle exec rspec
+bundle exec rspec --exclude-pattern '**/integration/**/*_spec.rb'  # Unit tests only
+bundle exec rspec --tag integration  # Integration tests only
+bundle audit
+gem build pg_multitenant_schemas.gemspec
+```
+
+## 🎯 Workflow-Specific Testing
+
+### Testing CI Workflow (.github/workflows/main.yml)
+
+```bash
+# With act
+act push
+
+# Manual simulation
+bundle install
+bundle exec rubocop
+bundle exec rspec --exclude-pattern '**/integration/**/*_spec.rb'
+bundle audit
+```
+
+### Testing Release Workflow (.github/workflows/release.yml)
+
+```bash
+# With act (simulates main branch push)
+act push --env GITHUB_REF=refs/heads/main
+
+# Manual simulation (WITHOUT publishing)
+# 1. Update version in lib/pg_multitenant_schemas/version.rb
+# 2. Build gem locally
+gem build pg_multitenant_schemas.gemspec
+# 3. Check gem contents
+gem contents pg_multitenant_schemas-*.gem
+```
+
+## 🐛 Troubleshooting
+
+### act Issues
+
+```bash
+# Docker not running
+# → Start Docker Desktop
+
+# Permission denied
+# → Fix Docker permissions or use sudo
+
+# Platform issues
+act --container-architecture linux/amd64
+
+# Secrets not found
+# → Check .env.local file exists and has correct values
+```
+
+### PostgreSQL Issues
+
+```bash
+# Check if PostgreSQL is running
+pg_isready
+
+# Start PostgreSQL (macOS)
+brew services start postgresql@15
+
+# Create test database
+createdb pg_multitenant_test
+```
+
+### Ruby/Bundle Issues
+
+```bash
+# Install correct Ruby version
+rbenv install 3.3.0
+rbenv local 3.3.0
+
+# Clean and reinstall gems
+bundle clean --force
+bundle install
+```
+
+## 🔄 Typical Workflow
+
+1. **Make changes** to your code
+2. **Run pre-push checks**: `./pre-push-check.sh`
+3. **Fix any issues** found
+4. **Test with act** (optional): `act push`
+5. **Commit and push** when everything passes
+
+## 📋 Integration with Git
+
+Add to `.git/hooks/pre-push` to run checks automatically:
+
+```bash
+#!/bin/bash
+./pre-push-check.sh
+```
+
+Make it executable:
+```bash
+chmod +x .git/hooks/pre-push
+```
+
+## 🎉 Success Indicators
+
+You're ready to push when you see:
+
+- ✅ Pre-push script passes all checks
+- ✅ `act push` completes without errors
+- ✅ All tests pass locally
+- ✅ RuboCop shows no violations
+- ✅ Gem builds successfully
+
+## 🔗 More Information
+
+- [Complete Guide](docs/local_workflow_testing.md) - Detailed documentation
+- [GitHub Actions Docs](https://docs.github.com/en/actions)
+- [act Documentation](https://github.com/nektos/act)
+
+---
+
+**💡 Pro Tip**: Run `./pre-push-check.sh` before every commit to catch issues early!

data/docs/README.md

@@ -15,6 +15,8 @@ This directory contains detailed documentation for each core component of the PG
 | **Errors** | Custom exception classes | [errors.md](errors.md) |
 | **Testing** | RSpec test suite and testing guide | [testing.md](testing.md) |
 | **Integration Testing** | PostgreSQL integration testing guide | [integration_testing.md](integration_testing.md) |
+| **CI/CD & Releases** | GitHub Actions automation setup | [github_actions_setup.md](github_actions_setup.md) |
+| **Local Workflow Testing** | Test GitHub Actions locally before push | [local_workflow_testing.md](local_workflow_testing.md) |
 
 ## 🏗️ Architecture Flow
 
@@ -60,7 +62,9 @@ Rails Application (executes in tenant schema)
 
 - **[Testing Guide](testing.md)**: Comprehensive RSpec test suite documentation
 - **[Integration Testing](integration_testing.md)**: PostgreSQL integration testing guide
+- **[Local Workflow Testing](local_workflow_testing.md)**: Test GitHub Actions locally before push
 - **Test Execution**: `bundle exec rspec` (unit tests) and `bundle exec rspec --tag integration` (integration tests)
+- **Pre-Push Testing**: `./pre-push-check.sh` (validates CI components locally)
 
 ## 🔍 Debug and Troubleshooting
 

data/docs/github_actions_permissions_fix.md

@@ -0,0 +1,136 @@
+# 🔧 Fixing GitHub Actions Permissions Issues
+
+## 🚨 Problem
+```
+remote: Permission to rubenpazch/pg_multitenant_schemas.git denied to github-actions[bot].
+fatal: unable to access 'https://github.com/rubenpazch/pg_multitenant_schemas/': The requested URL returned error: 403
+```
+
+## ✅ Solutions Applied
+
+### 1. Updated Release Workflow Permissions
+Added explicit permissions to `.github/workflows/release.yml`:
+```yaml
+permissions:
+  contents: write
+  issues: write
+  pull-requests: write
+```
+
+### 2. Fixed GitHub Actions Bot Identity
+Changed Git configuration to use proper GitHub Actions bot identity:
+```yaml
+git config --local user.email "41898282+github-actions[bot]@users.noreply.github.com"
+git config --local user.name "github-actions[bot]"
+```
+
+## 🔧 Repository Settings to Check
+
+### On GitHub.com:
+
+1. **Go to your repository settings**
+   - Navigate to: `https://github.com/rubenpazch/pg_multitenant_schemas/settings`
+
+2. **Actions > General**
+   - Scroll down to "Workflow permissions"
+   - Select: **"Read and write permissions"**
+   - Check: **"Allow GitHub Actions to create and approve pull requests"**
+   - Click **Save**
+
+3. **Actions > General > Actions permissions**
+   - Ensure: **"Allow all actions and reusable workflows"** is selected
+   - Or at least: **"Allow actions created by GitHub"**
+
+## 🧪 Alternative Testing Approach
+
+If you want to test the release workflow without actual releases:
+
+### Create a Test Branch Release Workflow
+
+```yaml
+# .github/workflows/test-release.yml
+name: Test Release Workflow
+
+on:
+  workflow_dispatch:  # Manual trigger only
+  
+permissions:
+  contents: write
+  issues: write
+  pull-requests: write
+
+jobs:
+  test-release:
+    runs-on: ubuntu-latest
+    
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          token: ${{ secrets.GITHUB_TOKEN }}
+          
+      - name: Test Git config
+        run: |
+          git config --local user.email "41898282+github-actions[bot]@users.noreply.github.com"
+          git config --local user.name "github-actions[bot]"
+          echo "Git config successful"
+          
+      - name: Test Git operations (dry run)
+        run: |
+          echo "Would create tag: v0.2.1"
+          echo "Would push to origin"
+          # Don't actually push in test
+          
+      - name: Test gem build
+        run: |
+          gem build pg_multitenant_schemas.gemspec
+          ls -la *.gem
+```
+
+## 🔍 Troubleshooting Steps
+
+### 1. Check Token Permissions
+```bash
+# In GitHub Actions, this should show the permissions
+echo "GITHUB_TOKEN permissions:"
+echo "Contents: ${{ github.token }}"
+```
+
+### 2. Verify Repository Access
+```bash
+# Test if the bot can access the repo
+git ls-remote origin
+```
+
+### 3. Check Branch Protection Rules
+- Go to Settings > Branches
+- Check if `main` branch has protection rules that block force pushes
+- Ensure "Restrict pushes that create files" is not enabled
+
+## 🎯 Quick Fix Summary
+
+1. **✅ Updated workflow permissions** (already done)
+2. **✅ Fixed bot identity** (already done)
+3. **🔧 Check repository settings** (manual step on GitHub.com)
+4. **🧪 Test with manual trigger** (if needed)
+
+## 📋 Manual Steps Required
+
+1. Go to your repository on GitHub.com
+2. Navigate to Settings > Actions > General
+3. Set "Workflow permissions" to "Read and write permissions"
+4. Enable "Allow GitHub Actions to create and approve pull requests"
+5. Save the settings
+
+After making these changes, the release workflow should work properly!
+
+## 🚀 Testing the Fix
+
+After updating repository settings, you can test by:
+
+1. **Making a small version bump**
+2. **Pushing to main branch**  
+3. **Watching the Actions tab** for successful execution
+
+Or create the test workflow above and trigger it manually first.