rails_curd_base 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 45ac1efb0de272c8bfc202ab29ec4f216582e23fcd16cfc85dbe1ce3bfbb9534
-  data.tar.gz: 64dcac6b6270ce247d77192370a306f683c3d1b04df6b54fb0b32a86d5c8919b
+  metadata.gz: 9bc05a5c466ae239abb14e9c208cc888d1c0c5c0926e1d8e6060dbbae4bd5b48
+  data.tar.gz: 205db1b08586497ffa8f56de1f8c763a335d298cd20662338f227fd799b02e29
 SHA512:
-  metadata.gz: 9da65048981078282d064ad920534a761a1bd33932571ba74d5cfe89e1726d15d5e9f0cb6a13e7942eea08f2623e058ef955f3f6bdfe2e2c0d17bcf244a65c2b
-  data.tar.gz: e2d92aba652e4a9cb808e3af848666515fbf4a61dc2cb35565ddae0ea10ba5682118b6fe84a5a6b579c93fd21155e80921aa06438ead5b02389d562db4b1cff5
+  metadata.gz: da7a3353202628ddf30765e3bc4c9b0309ba30345e75b2d880ba9c3da2bd444ab3e9cefd7ef61d9dfa92f4a50638f9b026664f9d8d8865cb26013098bb004304
+  data.tar.gz: fd0f70f3ffd9483eb1cdf2418ff8561e7b548e7aac861a7c5e884059195afe485a2db7bdf68141ebc823462d6439529f3a4020544d6d3cca25989690405334f2

data/README.md

@@ -186,6 +186,40 @@ DELETE /api/posts/1
 
 ## 高级用法
 
+### 自定义数据范围
+```ruby
+class Api::PostsController < RailsCurdBase::CurdController
+  # 只返回当前用户的文章
+  def collection
+    current_user.posts
+  end
+end
+```
+
+### 字段过滤
+
+**配置不同 action 返回不同字段**：
+```ruby
+class Api::PostsController < RailsCurdBase::CurdController
+  # index 只返回部分字段
+  index_fields :id, :title, :created_at
+
+  # show 返回完整字段
+  show_fields :id, :title, :content, :status, :created_at, :updated_at
+end
+```
+
+**动态指定返回字段（通过 URL 参数）**：
+```bash
+# 只返回 id 和 title
+GET /api/posts?fields=id,title
+
+# 只返回 id, title, created_at
+GET /api/posts/1?fields=id,title,created_at
+```
+
+**优先级**：URL 参数 > Action 配置 > 全部字段
+
 ### 生命周期钩子
 
 ```ruby
@@ -219,17 +253,6 @@ class Api::PostsController < RailsCurdBase::CurdController
 end
 ```
 
-### 自定义数据范围
-
-```ruby
-class Api::PostsController < RailsCurdBase::CurdController
-  # 只返回当前用户的文章
-  def collection
-    current_user.posts
-  end
-end
-```
-
 ### 嵌套资源
 
 ```ruby
@@ -240,7 +263,7 @@ class Api::UserPostsController < RailsCurdBase::CurdController
 end
 ```
 
-### 自定义序列化
+### 完全自定义序列化
 
 ```ruby
 class Api::PostsController < RailsCurdBase::CurdController

data/app/controllers/rails_curd_base/curd_controller.rb

@@ -5,13 +5,33 @@ module RailsCurdBase
     # === CRUD 基础动作 ===
     before_action :set_resource, only: %i[show update destroy]
 
+    class << self
+      # 配置 index 操作显示的字段
+      def index_fields(*fields)
+        @index_fields = fields
+      end
+
+      # 配置 show 操作显示的字段
+      def show_fields(*fields)
+        @show_fields = fields
+      end
+
+      def get_index_fields
+        @index_fields
+      end
+
+      def get_show_fields
+        @show_fields
+      end
+    end
+
     def index
       result = apply_query_with_meta(collection)
       data = {
         query_config[:meta][:rows_key] => serialize_collection(result[:collection]),
       }
       data.merge!(result[:meta]) if result[:meta]
-      ok data: data, message: "Retrieved successfully"
+      ok data: data
     end
 
     def show
@@ -24,7 +44,7 @@ module RailsCurdBase
       if before_save(@resource) && @resource.save
         after_save(@resource)
         data = serialize_resource(@resource)
-        ok data: data, message: "Created successfully", code: 201
+        ok data: data, code: 201
       else
         fail message: "Validation failed", code: 422, data: { errors: @resource.errors.full_messages }
       end
@@ -34,7 +54,7 @@ module RailsCurdBase
       if before_save(resource) && resource.update(resource_params)
         after_save(resource)
         data = serialize_resource(resource)
-        ok data: data, message: "Updated successfully"
+        ok data: data
       else
         fail message: "Validation failed", code: 422, data: { errors: resource.errors.full_messages }
       end
@@ -58,18 +78,50 @@ module RailsCurdBase
 
     def destroy
       resource.destroy
-      ok message: "Deleted successfully", code: 204
+      ok code: 204
     end
 
     private
 
     # === 序列化逻辑 ===
     def serialize_resource(resource)
-      resource.as_json
+      data = resource.as_json
+
+      # 优先级: 请求参数 > action 配置
+      fields = requested_fields || fields_for_action(action_name)
+      filter_fields(data, fields) if fields
+      data
     end
 
     def serialize_collection(collection)
-      collection.as_json
+      collection.map do |resource|
+        serialize_resource(resource)
+      end
+    end
+
+    # 从请求参数获取指定字段
+    def requested_fields
+      return nil unless params[:fields].present?
+
+      params[:fields].split(',').map(&:to_sym)
+    end
+
+    # 根据 action 获取配置的字段
+    def fields_for_action(action)
+      case action
+      when 'index'
+        self.class.get_index_fields
+      when 'show'
+        self.class.get_show_fields
+      else
+        nil
+      end
+    end
+
+    # 过滤字段
+    def filter_fields(data, fields)
+      fields_sym = fields.map(&:to_sym)
+      data.select! { |key, _| fields_sym.include?(key.to_sym) }
     end
 
     # === 资源推导 ===

data/lib/rails_curd_base/version.rb

@@ -1,3 +1,3 @@
 module RailsCurdBase
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/llms.txt

@@ -1,6 +1,6 @@
 # RailsCurdBase - AI Assistant Guide
 
-> RailsCurdBase is a Ruby on Rails CRUD base controller gem providing ready-to-use Create, Read, Update, Delete functionality with advanced query capabilities including pagination, sorting, searching, and filtering. It integrates RailsWarp for unified JSON responses and Kaminari for pagination.
+> RailsCurdBase is a Ruby on Rails CRUD base controller gem providing ready-to-use Create, Read, Update, Delete functionality with advanced query capabilities including pagination, sorting, searching, and filtering. It uses RailsWarp for unified JSON responses and Kaminari for pagination.
 
 **IMPORTANT NOTES FOR AI ASSISTANTS:**
 - RailsCurdBase inherits from ActionController::API for Rails API applications
@@ -9,10 +9,12 @@
 - Built-in Queryable concern provides pagination, sorting, searching, filtering
 - Four lifecycle hooks: before_create, after_create, before_update, after_update
 - Resource automatically derived: controller_name.singularize.classify.constantize
+- Success responses use default "success" message from RailsWarp (no custom message)
+- Error responses keep custom messages ("Validation failed", "Record not found")
 
 ## DOCUMENTATION LINKS
 
-- Repository: https://github.com/afeiship/rails_curd_base
+- Repository: https://github.com/aferic/rails_curd_base
 - Usage Guide: test/dummy/EXAMPLE_USAGE.md (complete API documentation and examples)
 - Test/Demo App: test/dummy/ directory (fully working example)
 
@@ -20,7 +22,7 @@
 
 ### 1. Zero-Configuration CRUD
 Inherit from CurdController to get complete CRUD:
-- index: List with pagination, sorting, searching, filtering
+- index: List with query capabilities (pagination, sorting, searching, filtering)
 - show: Single record retrieval
 - create: Create new records
 - update: Update existing records
@@ -28,13 +30,13 @@ Inherit from CurdController to get complete CRUD:
 
 ### 2. Queryable Module (supports_query)
 Configure via supports_query:
-- Pagination: page, size parameters (Kaminari)
-- Sorting: sort parameter (supports -field for desc)
-- Searching: q parameter (multi-field LIKE search)
-- Filtering: filter parameter (eq, neq, gt, gte, lt, lte, in, nin operators)
+- **Pagination**: page, size parameters (Kaminari)
+- **Sorting**: sort parameter (supports -field for desc)
+- **Searching**: q parameter (multi-field LIKE search)
+- **Filtering**: filter parameter (eq, neq, gt, gte, lt, lte, in, nin operators)
 
 ### 3. Unified Response Format (RailsWarp)
-- ok: success response with data, message, code
+- ok: success response with data, code
 - fail: error response with message, code, errors data
 
 ### 4. Lifecycle Hooks
@@ -82,33 +84,35 @@ GET /api/posts?page=1&size=10&sort=-created_at&q=rails&filter[status]=published
 # Show single
 GET /api/posts/1
 
-# Create
+# Create (flat format - recommended)
+POST /api/posts
+{"title": "Hello", "content": "World", "status": "published"}
+
+# Create (nested format - also supported)
 POST /api/posts
 {"post": {"title": "Hello", "content": "World", "status": "published"}}
 
-# Update
+# Update (flat format - recommended)
 PUT /api/posts/1
-{"post": {"title": "Updated"}}
+{"title": "Updated"}
 
 # Delete
 DELETE /api/posts/1
 ```
 
-### Response Format
-Success:
+## RESPONSE FORMAT
+
+### Success Response
 ```json
 {
   "success": true,
   "code": 200,
-  "msg": "Retrieved successfully",
-  "data": {
-    "rows": [...],
-    "total": 100
-  }
+  "msg": "success",
+  "data": { ... }
 }
 ```
 
-Error:
+### Error Response
 ```json
 {
   "success": false,
@@ -169,15 +173,18 @@ supports_query(
     filter_param: :filter
   }
 )
-# Usage:
-# ?filter[status]=published (eq)
-# ?filter[status][neq]=draft (not equals)
-# ?filter[views][gte]=100 (greater than or equal)
-# ?filter[views][lte]=1000 (less than or equal)
-# ?filter[category_id][in]=1,2,3 (in array)
-# ?filter[status][nin]=draft,archived (not in array)
 ```
 
+Supported operators:
+- `?filter[field]=value` → Equals (eq)
+- `?filter[field][neq]=value` → Not equals (neq)
+- `?filter[field][gt]=value` → Greater than (gt)
+- `?filter[field][gte]=value` → Greater than or equal (gte)
+- `?filter[field][lt]=value` → Less than (lt)
+- `?filter[field][lte]=value` → Less than or equal (lte)
+- `?filter[field][in]=1,2,3` → In array (in)
+- `?filter[field][nin]=1,2,3` → Not in array (nin)
+
 ## CUSTOMIZATION
 
 ### Override Collection (Scope Data)
@@ -192,8 +199,6 @@ end
 ### Lifecycle Hooks
 ```ruby
 class Api::PostsController < RailsCurdBase::CurdController
-  before_action :authenticate_user!
-
   def before_create(resource)
     resource.author = current_user
     resource.published_at = Time.current if resource.status == 'published'
@@ -247,7 +252,7 @@ class Api::PostsController < RailsCurdBase::CurdController
   end
 
   def set_post
-    @post = current_user.posts.find(params[:id])
+    @post = current_user.posts.find_by(id: params[:id])
   end
 end
 ```
@@ -293,17 +298,9 @@ def not_found
 end
 ```
 
-### Soft Deletes
-```ruby
-def destroy
-  resource.update!(deleted_at: Time.current)
-  ok message: 'Deleted successfully', code: 204
-end
-```
-
 ## TESTING
 
-Run the dummy application:
+Run dummy application:
 ```bash
 cd test/dummy
 bin/rails db:migrate
@@ -320,9 +317,9 @@ curl -X POST http://localhost:3000/api/posts -H 'Content-Type: application/json'
 
 ## DEPENDENCIES
 
-- rails >= 6.0
-- kaminari >= 0.16 (pagination)
-- rails_warp >= 0.1.0 (unified responses)
+- **rails** >= 6.0
+- **kaminari** >= 0.16 - Pagination functionality
+- **rails_warp** >= 0.1.0 - Unified response format
 
 ## IMPORTANT NOTES FOR AI ASSISTANTS
 
@@ -332,18 +329,20 @@ curl -X POST http://localhost:3000/api/posts -H 'Content-Type: application/json'
 4. Resource is auto-derived: controller_name.singularize.classify.constantize
 5. Override collection() to scope data (current_user.posts, etc.)
 6. Use hooks (before_create, after_create, etc.) for callbacks
-7. Parameters via resource_params() method (auto-permits :resource param)
+7. Parameters via resource_params() method (automatically handles strong parameters)
 8. Query parameters: page, size, sort, q, filter[field]
 9. All query features are optional (enable/disable in supports_query)
 10. Filter operators: eq (default), neq, gt, gte, lt, lte, in, nin
+11. Success responses use default "success" message from RailsWarp
+12. Error responses keep custom messages (validation failed, record not found)
+13. Request format: supports both flat {"title":"..."} and nested {"post":{"title":"..."}} formats
 
 ## PERFORMANCE TIPS
 
-- Add database indexes on filtered/sorted fields
-- Use select() to limit fields in queries
-- Override serialize_resource for custom JSON output
-- Use caching in hooks for expensive operations
-- Optimize collection() for complex queries
+1. For large datasets, ensure database fields are indexed (especially on filtered/sorted fields)
+2. Use select() to limit queried fields (by overriding serialize_resource)
+3. Consider caching (in hook methods)
+4. For complex queries, override collection() method to optimize SQL
 
 ## FILE STRUCTURE
 
@@ -356,7 +355,7 @@ app/controllers/concerns/rails_curd_base/
   queryable.rb             # Query functionality
 ```
 
-## CONTRIBUTE
+## CONTRIBUTING
 
 Contributions welcome! Please:
 - Follow existing code style

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_curd_base
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - aric.zheng
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-02-14 00:00:00.000000000 Z
+date: 2026-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails