propel_api 0.3.1.6 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 379048f58a88602b2417f539dc866ec9ba5464a76d0e96f0da699e6b51e5e3c6
-  data.tar.gz: 7db7da9523b014f4ee297d7dd652ae5b273dadad23ad5eda0fceddbfd0fb1938
+  metadata.gz: ab74f199f5f59a6a62a0f39a8c63960a7b1339b46bd32701219a6249f6cdb5a3
+  data.tar.gz: c4aa9676d91f4400cd54f0aa6d5ce0a022f9b6c893ec7b3124da057f679d8770
 SHA512:
-  metadata.gz: 36ae5f3ab7dfd0c7a8f08ca2d6271da061aefc1046cc4304d8b99a47645cccc5448d2c7186d6861f1424af81934e9f313d6eed0152a8545eaa7a7cb99791faf0
-  data.tar.gz: 49aa423413e2b78a7d98c027b4c507dab997c3effca2b289ac3ad856272afb6ca133a9fa1556838dc749b529e412303794ce0e1e1667f6b19787f85ed70a0294
+  metadata.gz: 27513e98749a5b837f3f7c1e10280e49155ec5a8113c8319c1b8994e17efaf79cba9c549f74a82982a386fa30d2505d62aeadb84d7bd1af9e0debc9576a52d80
+  data.tar.gz: 8d1c4bc5f35ac31d8d42570c7d0829e488242512631ab5d883a382fddc77bb12f3c94daa36645b6fefbc92ab50ccad455a4464225749b047ca1dbbcc27f53fb0

data/CHANGELOG.md

@@ -10,6 +10,89 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Planned Features
 - GraphQL adapter support
 
+## [0.3.3] - 2025-01-XX
+
+### 🎉 Major Features Added
+- **Comprehensive Dynamic Filtering System**: Complete implementation of automatic URL query string filtering and scoping using the `has_scope` gem
+  - **Multi-Type Filtering Support**: Full filtering support across all data types (string, numeric, boolean, datetime, date, time)
+  - **Database-Agnostic Implementation**: Works seamlessly across SQLite, PostgreSQL, and MySQL without database-specific code
+  - **Automatic Scope Generation**: Dynamic scope generation based on model column types and filter operators
+  - **Intelligent Facet Integration**: Automatic inclusion of filterable fields in JSON facets for API responses
+
+### 🔍 Advanced Filtering Capabilities
+- **String Filtering**: Exact match (`_eq`), contains (`_contains`), starts with (`_starts_with`), ends with (`_ends_with`), in list (`_in`)
+- **Numeric Filtering**: Comparison operators (`_gt`, `_lt`, `_gte`, `_lte`), range filtering (`_range`), in list (`_in`)
+- **Boolean Filtering**: Multiple value format support (`true`/`false`, `1`/`0`, `yes`/`no`, `on`/`off`)
+- **DateTime Filtering**: Temporal comparisons (`_before`, `_after`), date extraction (`_year`, `_month`, `_day`), date matching (`_date`)
+- **Range Filtering**: Support for both array and string formats (e.g., `"150,350"` or `[150, 350]`)
+
+### 🛠️ Technical Implementation
+- **PropelDynamicScopeGenerator**: New generator class for automatic scope creation based on model columns
+- **PropelModelFiltersConcern**: Model concern for dynamic scope generation and filter parameter validation
+- **PropelControllerFiltersConcern**: Controller concern for has_scope integration and security validation
+- **PropelFilterOperators**: Configuration class defining available operators for each data type
+- **Database-Agnostic Datetime Parsing**: Ruby-based datetime parsing instead of SQL extraction functions
+
+### 🔒 Security & Performance
+- **Input Validation**: Comprehensive validation of filter parameters against allowed field names and operators
+- **SQL Injection Protection**: All parameters properly escaped and parameterized
+- **Multi-Tenancy Integration**: Automatic organization scoping for all filtered queries
+- **Sensitive Field Filtering**: Automatic exclusion of sensitive fields (passwords, tokens, etc.) from filtering
+- **Performance Optimization**: Efficient range queries and indexed field prioritization
+
+### 📊 Enhanced JSON Facet System
+- **Smart Field Inclusion**: Automatic inclusion of boolean and datetime fields in `:short` facets
+- **Exclusion Lists**: Configurable exclusion of specific fields (e.g., `created_at`, `updated_at`, `internal_flag`)
+- **Consistent Serialization**: Ensures filterable fields are available in API responses for client-side filtering
+
+### 🧪 Comprehensive Testing
+- **Test-Driven Development**: Complete test suite with 992 tests covering all filtering scenarios
+- **Fixture-Aware Testing**: Unique test data values to avoid conflicts with fixture data
+- **Multi-Tenancy Testing**: Proper testing of organization-scoped filtering
+- **Edge Case Coverage**: Testing of invalid inputs, empty values, and error conditions
+- **Database Compatibility**: Tests pass across SQLite, PostgreSQL, and MySQL
+
+### 📖 Documentation & Examples
+- **Comprehensive API Documentation**: Complete filtering documentation with examples for all operators
+- **Postman Collection Ready**: Detailed query parameter examples for testing
+- **Error Handling Guide**: Common error scenarios and troubleshooting tips
+- **Performance Guidelines**: Optimization recommendations for large datasets
+
+### 🔧 Configuration & Customization
+- **Flexible Operator Configuration**: Easy addition of new filter operators via `PropelFilterOperators`
+- **Customizable Field Exclusions**: Configurable lists for fields to exclude from facets
+- **Template-Based Generation**: All filtering code generated via ERB templates for easy customization
+- **Backward Compatibility**: Existing applications continue to work without changes
+
+### 🐛 Bug Fixes
+- **Template Syntax Errors**: Fixed ERB template syntax issues with `next` vs `return` in select blocks
+- **Scope Generation Caching**: Resolved issues with cached scopes not updating after template changes
+- **Datetime Parsing Errors**: Fixed datetime scope generation to handle multiple input formats
+- **SQL Compatibility**: Resolved SQLite `EXTRACT` function compatibility issues
+
+## [0.3.2] - 2025-09-15
+
+### 🐛 Critical Bug Fixes
+- **Generator Destroy/Rollback Functionality**: Fixed critical issues with resource generator destroy and rollback operations
+  - Fixed `propel_api:resource` generator to properly handle destroy operations and rollbacks
+  - Enhanced controller generator with improved destroy and rollback logic
+  - Completely rebuilt and improved `named_base.rb` core infrastructure with comprehensive destroy/rollback support
+  - Added robust error handling and cleanup procedures for failed generator operations
+  - Fixed edge cases where incomplete generator runs could leave orphaned files or partial configurations
+  - Enhanced generator infrastructure to properly track and reverse all file operations and modifications
+
+### 🛠️ Generator Infrastructure Improvements
+- **Enhanced Core Named Base**: Major improvements to the core generator infrastructure
+  - Comprehensive rebuild of generator tracking and rollback mechanisms
+  - Better state management for complex generator operations
+  - Improved error recovery and cleanup procedures
+  - Enhanced file operation tracking for reliable rollbacks
+- **Resource Generator Robustness**: Significantly improved resource generator reliability
+  - Better handling of partial generation scenarios
+  - Enhanced error reporting and recovery mechanisms
+  - Improved coordination between controller, model, migration, and test generation
+  - More reliable cleanup of generated artifacts during rollbacks
+
 ## [0.3.1.6] - 2025-09-13
 
 ### 🔧 Enhanced Multi-Tenancy Support

data/README.md

@@ -1,6 +1,51 @@
 # PropelApi
 
-A comprehensive Rails generator that creates complete API resources with models, controllers, tests, and realistic seed data. Supports both PropelFacets (JSON Facet) and Graphiti serialization engines with **fixed route insertion** and proper indentation.
+A comprehensive Rails generator that creates complete API resources with models, controllers, tests, and realistic seed data. Supports both PropelFacets (JSON Facet) and Graphiti serialization engines with **fixed route insertion**, proper indentation, and **comprehensive dynamic filtering system**.
+
+## 🎉 NEW in v0.3.3: Dynamic Filtering System
+
+PropelApi now includes a complete automatic URL query string filtering and scoping system using the `has_scope` gem. This provides powerful, database-agnostic filtering across all data types with zero configuration required.
+
+### Quick Filtering Examples
+
+```bash
+# String filtering
+GET /api/v1/meetings?title_contains=Project&status_in=active,pending
+
+# Numeric filtering  
+GET /api/v1/meetings?max_participants_gte=50&max_participants_lte=200
+
+# Boolean filtering
+GET /api/v1/meetings?recording_enabled_eq=true&ai_research_enabled_eq=false
+
+# DateTime filtering
+GET /api/v1/meetings?start_time_after=2024-01-01T00:00:00Z&start_time_before=2024-12-31T23:59:59Z
+
+# Range filtering
+GET /api/v1/meetings?max_participants_range=150,350
+
+# Combined filtering with sorting and pagination
+GET /api/v1/meetings?title_contains=Project&max_participants_gte=50&order_by=start_time&page=1&limit=20
+```
+
+### Supported Filter Operators
+
+| Data Type | Operators | Examples |
+|-----------|-----------|----------|
+| **String** | `_eq`, `_contains`, `_starts_with`, `_ends_with`, `_in` | `name_eq=Acme`, `title_contains=Project` |
+| **Numeric** | `_eq`, `_gt`, `_lt`, `_gte`, `_lte`, `_range`, `_in` | `max_participants_gte=50`, `price_range=100,500` |
+| **Boolean** | `_eq` (supports `true`/`false`, `1`/`0`, `yes`/`no`, `on`/`off`) | `recording_enabled_eq=true` |
+| **DateTime** | `_before`, `_after`, `_year`, `_month`, `_day`, `_date` | `start_time_after=2024-01-01`, `created_at_year=2024` |
+| **Date** | Same as DateTime | `event_date_after=2024-01-01` |
+| **Time** | Same as DateTime | `start_time_hour=14` |
+
+### Automatic Features
+
+- **Zero Configuration**: Filtering works automatically for all generated resources
+- **Database Agnostic**: Works with SQLite, PostgreSQL, and MySQL
+- **Security Built-in**: SQL injection protection and input validation
+- **Multi-tenancy Ready**: Automatic organization scoping
+- **Performance Optimized**: Efficient queries with proper indexing support
 
 ## Installation
 

data/lib/generators/propel_api/controller/controller_generator.rb

@@ -76,19 +76,25 @@ module PropelApi
       validate_attributes_exist unless should_auto_introspect?
     end
 
+    def check_dependencies_before_destroy
+      # Only check critical dependencies during destroy operations
+      check_for_critical_dependencies if behavior == :revoke
+    end
+
     def create_controller
-      # Use shared method from Base class
-      create_propel_controller
+      create_propel_controller_template
     end
 
-    def create_routes
-      # Use shared method from Base class
+    def add_routes
       create_propel_routes
     end
 
-    def create_tests
-      # Use shared method from Base class with controller and integration tests only
-      create_propel_tests(test_types: [:controller, :integration])
+    def create_controller_test
+      create_propel_controller_test
+    end
+
+    def create_integration_test
+      create_propel_integration_test
     end
 
     def show_completion_message