rails_warp 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f452c034dbc05ef83d21fd52ff01303300853afae27de972ac371ad8d103fd1
-  data.tar.gz: 81cfb7742946d346711609acc8ab6eb6709d15c92f8d827a2f220b3f3ac67e55
+  metadata.gz: f43d7522da9d837b826efa5f3eb654d14d999f1cb22b1e943214cda020eb49e7
+  data.tar.gz: 3216b5a5406cdf1153f586087f318188e55ad95b13ff17654c3616995cef1cbb
 SHA512:
-  metadata.gz: e2a0e7d7f2bf27813840b88d1ee983fc21bc40a07a62529cdabe45d8a3f2474db87b59032cad08d5d16d7e956c844845b926bf6ed29acf8302462e5deb338109
-  data.tar.gz: fe0c8e021d1012fe84e61636a42a0f7962bdb46b58e13eca820a3453fd98e0651feb602e68620350c1f72a0ce54d565ea45a3affe60eb172bf25505470767ef3
+  metadata.gz: c913ce6dd4b9b5f42529b33ff9534f80ace2c505b23a22d20130f25a78c26b7ed0692c233b102035d712e0230495b36d08a808459a7338e8e62d412206964f9e
+  data.tar.gz: 31202d15b9d3b74f0fc28908f69c290e61f4be140025e3d2f8b4fea5f9f162c1ea966b4c514da5123a5c7083e5882bc124e07487e1abfbdacac20da5d2e63be0

data/README.md

@@ -3,11 +3,11 @@
 
 ## Usage
 
-RailsWarp is automatically included into ActionController and Jbuilder. You don\u2019t need to include any module manually.
+RailsWarp is automatically included into ActionController and Jbuilder. You don't need to include any module manually.
 
-- Controllers: call ok and fail directly.
+### Controllers
 
-Basic controller examples:
+Call `ok` and `fail` directly in your controllers:
 
 ```ruby
 class UsersController < ApplicationController
@@ -27,22 +27,35 @@ class UsersController < ApplicationController
 end
 ```
 
-Add extra fields (merged into the response):
+#### Parameters
 
-```ruby
-ok data: { user: user }, meta: { request_id: request.request_id }
+- `data` - The response data (any JSON-serializable object)
+- `message` - Custom message (default: "success" for ok, "error" for fail)
+- `code` - HTTP status code (default: 200 for ok, 500 for fail)
+- Additional keyword arguments are merged into the response
+
+#### Response Format
+
+```json
+{
+  "success": true,
+  "code": 200,
+  "message": "success",
+  "data": { ... }
+}
 ```
 
-HTTP status mapping:
-- 200, 201, 204: returned as-is
-- 400: bad_request
-- 401: unauthorized
-- 403: forbidden
-- 404: not_found
-- 422: unprocessable_entity
-- 500: internal_server_error
+#### HTTP Status Mapping
 
-Global error handling example:
+- `200`, `201`, `204`: returned as-is
+- `400`: bad_request
+- `401`: unauthorized
+- `403`: forbidden
+- `404`: not_found
+- `422`: unprocessable_entity
+- `500`: internal_server_error
+
+#### Global Error Handling
 
 ```ruby
 class ApplicationController < ActionController::Base
@@ -56,23 +69,49 @@ class ApplicationController < ActionController::Base
 end
 ```
 
-Jbuilder usage (already mixed in, call ok/fail inside templates):
+### Jbuilder Templates
+
+Use `json.ok` and `json.fail` in your Jbuilder templates:
 
 ```ruby
 # app/views/users/show.json.jbuilder
-json.ok data: { user: { id: @user.id, name: @user.name } }, message: "ok"
+json.ok message: "User found", code: 200
+json.data do
+  json.id @user.id
+  json.name @user.name
+end
 
 # app/views/shared/error.json.jbuilder
-json.fail message: "not found", code: 404, data: { resource: "User" }
+json.fail message: "not found", code: 404
+json.data do
+  json.resource "User"
+end
+```
+
+#### With Partials
+
+```ruby
+# app/views/users/index.json.jbuilder
+json.ok message: "Users retrieved", code: 200
+json.data do
+  json.array! @users, partial: "users/user", as: :user
+end
+```
+
+#### Extra Fields
+
+Additional keyword arguments are merged into the response root:
 
-# extra fields
-json.ok data: { list: @items.map { |i| { id: i.id, name: i.name } } }, meta: { total: @items.count }
+```ruby
+json.ok data: { list: @items }, meta: { total: @items.count }
 ```
 
-Aliases in Jbuilder: you can also use `json.warp_ok` and `json.warp_fail`.
+#### Aliases
 
+You can also use `json.warp_ok` and `json.warp_fail` as aliases.
 
 ## Installation
+
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -89,11 +128,10 @@ Or install it yourself as:
 $ gem install rails_warp
 ```
 
-## Resources
-- https://chat.qwen.ai/c/a6cd0b11-a440-4595-9f8b-0352b416a145
-
 ## Contributing
+
 Contribution directions go here.
 
 ## License
+
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/rails_warp/jbuilder_extension.rb

@@ -1,27 +1,8 @@
 # lib/rails_warp/jbuilder_extension.rb
 module RailsWarp
   module JbuilderExtension
-    # 忽略方法_missing 中的特定方法名
-    # 我们需要覆盖 method_missing 来拦截这些调用
-    def method_missing(method_name, *args, &block)
-      if method_name == :warp_ok || method_name == :ok
-        _warp_ok(*args, &block)
-      elsif method_name == :warp_fail || method_name == :fail
-        _warp_fail(*args, &block)
-      else
-        super
-      end
-    end
-
-    def respond_to_missing?(method_name, include_private = false)
-      method_name == :warp_ok || method_name == :ok ||
-      method_name == :warp_fail || method_name == :fail || super
-    end
-
-    private
-
-    def _warp_ok(**options)
-      message = options[:message] || "success"
+    def ok(**options)
+      message = options[:message].nil? ? "success" : options[:message]
       code = options[:code] || 200
 
       set! :success, true
@@ -31,8 +12,8 @@ module RailsWarp
       yield if block_given?
     end
 
-    def _warp_fail(**options)
-      message = options[:message] || "error"
+    def fail(**options)
+      message = options[:message].nil? ? "error" : options[:message]
       code = options[:code] || 500
 
       set! :success, false
@@ -41,5 +22,9 @@ module RailsWarp
 
       yield if block_given?
     end
+
+    # 别名方法
+    alias_method :warp_ok, :ok
+    alias_method :warp_fail, :fail
   end
 end

data/lib/rails_warp/version.rb

@@ -1,3 +1,3 @@
 module RailsWarp
-  VERSION = "1.0.2"
+  VERSION = "1.0.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_warp
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - aric.zheng