propel_rails 0.3.2 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3101c0f6052e304dc4f52c6a21e51fc10744711bc09514656a11f9134b2ce147
-  data.tar.gz: f41e6bebbcc98e969c4dc862097a37f32c655507c41eafb7ebe882365385cc74
+  metadata.gz: 64e52f4ae9d9b07f9fe598734b83d45adae9c7f9beb94306a18dd04c755ffa46
+  data.tar.gz: 80d00b55f061bfb2790f62d4fb3a19e13a35a8f4d0d2ee86db7eb2c04a17d755
 SHA512:
-  metadata.gz: 27bf3602f37029cf5c3040c99ec706060734c67a7f33cc5eae3f78ce38a686643df9f1749e1bd46fca4baaa57e7ee69163dd6278e1a04c16b56762af510b3e07
-  data.tar.gz: 59490ca2d5cb467352193bc504b6ec1f39f0241d9e4a21b0d296acbfb93c03684d1286eeaef87e826a4295d23ac95f2cb849dcf6f8c0bf3025491353eb029409
+  metadata.gz: 4877ef5c47fb0ee805c3ab6955bdfdf28915a13d4f05454e58dc794bbf50926a29fda728755d26d957f911812d10d93d739befb90757286fe21492b31a235503
+  data.tar.gz: cea170f3a883093c170915d02d7cb9ad6a7c0c8ed561ccbda1c80554b71339173ea64cbe8567f4eb8014bb7ee4387303027cb068640b6ad7a9c60e062ff9f53b

data/CHANGELOG.md

@@ -12,6 +12,65 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Cross-component integration patterns
 - Advanced orchestration features
 
+## [0.3.4] - 2025-09-29
+
+### Added
+- **New `propel_integration` gem**: Initial release of the `propel_integration` gem, which provides tools for integrating with third-party services.
+
+### Fixed
+- **Custom `has_scope` definitions**: The dynamic scope generator in `propel_api` no longer overrides custom `has_scope` definitions.
+- **`has_scope` parameter filtering**: All declared `has_scope` parameters are now automatically permitted.
+
+### Changed
+- All Propel gems have been updated to version `0.3.4` for consistency.
+
+## [0.3.3] - 2025-01-XX
+
+### 🎉 Major Features Added
+- **Comprehensive Dynamic Filtering System**: Complete orchestration of PropelApi's new filtering capabilities across the entire Propel Rails ecosystem
+  - **Zero-Configuration Filtering**: Automatic filtering support for all generated API resources
+  - **Database-Agnostic Implementation**: Seamless filtering across SQLite, PostgreSQL, and MySQL
+  - **Multi-Component Integration**: PropelApi, PropelFacets, and PropelAuthentication work together for complete filtering solution
+
+### 🔍 Advanced Filtering Capabilities
+- **Multi-Type Filtering Support**: Complete filtering support across all data types (string, numeric, boolean, datetime, date, time)
+- **Intelligent Facet Integration**: PropelFacets automatically includes filterable fields in JSON responses
+- **Security-First Filtering**: PropelAuthentication provides multi-tenancy scoping for all filtered queries
+- **Performance-Optimized**: Efficient queries with proper indexing support and database-agnostic implementation
+
+### 🛠️ Framework Orchestration Improvements
+- **Enhanced Component Coordination**: Better coordination of filtering features across all Propel components
+  - PropelApi provides the core filtering infrastructure with dynamic scope generation
+  - PropelFacets ensures filterable fields are included in API responses
+  - PropelAuthentication maintains security and multi-tenancy across all filtered queries
+- **Template System Integration**: Enhanced template coordination for filtering support
+  - Improved facet model templates with smart field inclusion
+  - Enhanced test templates for comprehensive filtering coverage
+  - Better integration test templates for filtering scenarios
+
+### 🔧 Dependency Updates
+- **PropelApi 0.3.3**: Comprehensive dynamic filtering system with multi-type support
+- **PropelAuthentication 0.3.3**: Enhanced test integration and filtering compatibility
+- **PropelFacets 0.3.3**: Enhanced facet system for filtering with smart field inclusion
+
+### 🧪 Testing & Quality Assurance
+- **Comprehensive Test Coverage**: Complete test suite with 992 tests covering all filtering scenarios
+- **Multi-Component Testing**: Tests verify filtering works across all Propel components
+- **Database Compatibility**: Tests pass across SQLite, PostgreSQL, and MySQL
+- **Security Testing**: Multi-tenancy and authentication integration testing
+
+### 📖 Documentation & Examples
+- **Comprehensive API Documentation**: Complete filtering documentation with examples for all operators
+- **Framework Integration Guide**: How filtering works across all Propel components
+- **Performance Guidelines**: Optimization recommendations for large datasets
+- **Security Best Practices**: Multi-tenancy and authentication considerations
+
+### 🔒 Security & Performance
+- **Multi-Tenant Filtering**: All filtered queries automatically scoped to user's organization
+- **Input Validation**: Comprehensive validation of filter parameters across all components
+- **SQL Injection Protection**: All parameters properly escaped and parameterized
+- **Performance Optimization**: Efficient queries with proper indexing support
+
 ## [0.3.2] - 2025-09-15
 
 ### 🐛 Enhanced Generator Reliability

data/README.md

@@ -1,6 +1,51 @@
 # Propel Rails
 
-A modular Ruby framework meta gem that orchestrates the installation of Propel components for building modern web applications.
+A modular Ruby framework meta gem that orchestrates the installation of Propel components for building modern web applications with **comprehensive dynamic filtering capabilities**.
+
+## 🎉 NEW in v0.3.3: Dynamic Filtering System
+
+Propel Rails now orchestrates a complete automatic URL query string filtering and scoping system across all components. This provides powerful, database-agnostic filtering 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
 
 ## Overview
 

data/lib/generators/propel/install_generator.rb

@@ -80,7 +80,7 @@ module Propel
       
       install_components(components)
       run_migrations unless options[:skip_migrations]
-      copy_secure_api_explorer if components.include?(:api)
+      # copy_api_explorer if components.include?(:api)  # TODO: Re-enable for future release when API Explorer is ready
       show_completion_message
     end
 
@@ -204,44 +204,38 @@ module Propel
       end
     end
 
-    def copy_secure_api_explorer
-      say "\n🔒 Installing Secure API Explorer...", :blue
-      
-      # Find the gem root directory and secure distribution files
-      gem_root = File.expand_path("../../../..", __dir__)
-      dist_dir = File.join(gem_root, "dist")
-      api_explorer_dest = File.join(destination_root, "api-explorer")
-      
-      if Dir.exist?(dist_dir)
-        # Create the api-explorer directory
-        empty_directory "api-explorer"
-        
-        # Copy each file from dist to api-explorer using absolute paths
-        Dir.glob(File.join(dist_dir, "*")).each do |file|
-          if File.file?(file)
-            dest_file = File.join(api_explorer_dest, File.basename(file))
-            FileUtils.cp(file, dest_file)
-            say "      create  api-explorer/#{File.basename(file)}", :green
-          end
-        end
-        
-        say "   ✅ Secure API Explorer installed at ./api-explorer/", :green
-        show_api_explorer_usage
-      else
-        say "   ⚠️  Secure API Explorer distribution not found", :yellow
-        say "   Run './scripts/build_secure_api_explorer.sh' first", :yellow
-      end
-    end
-
-    def show_api_explorer_usage
-      say "\n🚀 API Explorer Usage:", :cyan
-      say "   1. cd api-explorer", :white
-      say "   2. yarn install", :white
-      say "   3. yarn start", :white
-      say "   4. Open http://localhost:8080", :white
-      
-      say "\n🔒 Secure & Obfuscated", :green
-    end
+    # TODO: Re-enable this method for future release when API Explorer is ready
+    # def copy_api_explorer
+    #   say "\n📋 Installing API Explorer...", :blue
+    #   
+    #   # Find the api-explorer source directory (in the gem root, not propel_rails subdirectory)
+    #   # __dir__ is: propel_rails/lib/generators/propel/
+    #   # We need to go up 4 levels to reach the gem root
+    #   gem_root = File.expand_path("../../../../", __dir__)
+    #   api_explorer_source = File.join(gem_root, "api-explorer")
+    #   api_explorer_dest = File.join(destination_root, "api-explorer")
+    #   
+    #   begin
+    #     if Dir.exist?(api_explorer_source)
+    #       # Use FileUtils to copy the entire directory
+    #       FileUtils.cp_r(api_explorer_source, api_explorer_dest)
+    #       
+    #       say "✅ API Explorer installed at ./api-explorer/", :green
+    #       say "\n🚀 To use the API Explorer:", :cyan
+    #       say "   1. cd api-explorer", :white  
+    #       say "   2. yarn install (or npm install)", :white
+    #       say "   3. yarn start (or npm start)", :white
+    #       say "   4. Open http://localhost:3000 in your browser", :white
+    #       say "   5. Configure API endpoints in api-explorer/api-cache/", :white
+    #     else
+    #       say "⚠️  API Explorer source not found at #{api_explorer_source}", :yellow
+    #       say "   Skipping API Explorer installation", :yellow
+    #     end
+    #   rescue => e
+    #     say "⚠️  Could not install API Explorer: #{e.message}", :yellow
+    #     say "   Please copy the api-explorer folder manually from the gem", :yellow
+    #   end
+    # end
 
     def show_completion_message
       say "\n" + "="*70, :green

data/lib/propel_rails.rb

@@ -4,7 +4,7 @@ require "pathname"
 
 module Propel
   module Rails
-    VERSION = "0.3.2"
+    VERSION = "0.3.4"
     
     class Error < StandardError; end
     

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: propel_rails
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.4
 platform: ruby
 authors:
 - Propel Team
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-09-15 00:00:00.000000000 Z
+date: 2025-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -136,10 +136,11 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.10'
-description: |
-  Propel Rails is a modular framework built as a collection of independent gems
-  that work together seamlessly. It provides authentication, API generation, access control,
-  AI integration, and more - all designed to work individually or as a cohesive framework.
+description: "Propel Rails is a modular framework built as a collection of independent
+  gems\nthat work together seamlessly. It provides authentication, API generation
+  with automatic\nURL query string filtering and scoping, access control, AI integration,
+  and more - all \ndesigned to work individually or as a cohesive framework with zero-configuration
+  filtering.\n"
 email:
 - admin@propel-hq.dev
 executables: []
@@ -176,5 +177,5 @@ requirements: []
 rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
-summary: A modular Ruby framework for building modern web applications
+summary: A modular Ruby framework with comprehensive dynamic filtering system
 test_files: []