rails_warp 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab3733aafa1562776836bf91b43064fdab855491260010034b2faab2a2699e39
-  data.tar.gz: e579ab5ead54f90e831268289a4645ca87baa179ffaaa08e08340692bcf67732
+  metadata.gz: 1f452c034dbc05ef83d21fd52ff01303300853afae27de972ac371ad8d103fd1
+  data.tar.gz: 81cfb7742946d346711609acc8ab6eb6709d15c92f8d827a2f220b3f3ac67e55
 SHA512:
-  metadata.gz: 3dc9ba11879051394341dd4ec8174958ccb11a4ac8f8915dc9bdd3aa3809ff3a0eea8710ceb68698ba60d4fcfe51892d3977d8517303e3cabe62d7e092eedeb9
-  data.tar.gz: 5862d5a4b814260cf654fab8a0680e91319637b46ee7e5b9ab40b9d0d289f95df1409e663ba0a50cf3a0262dc4829e383a6ec1dec9dd31c426447b969a9d95aa
+  metadata.gz: e2a0e7d7f2bf27813840b88d1ee983fc21bc40a07a62529cdabe45d8a3f2474db87b59032cad08d5d16d7e956c844845b926bf6ed29acf8302462e5deb338109
+  data.tar.gz: fe0c8e021d1012fe84e61636a42a0f7962bdb46b58e13eca820a3453fd98e0651feb602e68620350c1f72a0ce54d565ea45a3affe60eb172bf25505470767ef3

data/README.md

@@ -2,7 +2,75 @@
 > A Rails plugin for elegant, hash-based response wrapper for clean Rails API responses.
 
 ## Usage
-How to use my plugin.
+
+RailsWarp is automatically included into ActionController and Jbuilder. You don\u2019t need to include any module manually.
+
+- Controllers: call ok and fail directly.
+
+Basic controller examples:
+
+```ruby
+class UsersController < ApplicationController
+  def show
+    user = User.find(params[:id])
+    ok data: { user: user }
+  end
+
+  def create
+    user = User.new(user_params)
+    if user.save
+      ok data: { user: user }, message: "created", code: 201
+    else
+      fail message: "validation error", code: 422, data: { errors: user.errors.full_messages }
+    end
+  end
+end
+```
+
+Add extra fields (merged into the response):
+
+```ruby
+ok data: { user: user }, meta: { request_id: request.request_id }
+```
+
+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
+
+Global error handling example:
+
+```ruby
+class ApplicationController < ActionController::Base
+  rescue_from ActiveRecord::RecordNotFound do |e|
+    fail message: e.message, code: 404
+  end
+
+  rescue_from StandardError do |e|
+    fail message: "internal error", code: 500, data: { error: e.class.name }
+  end
+end
+```
+
+Jbuilder usage (already mixed in, call ok/fail inside templates):
+
+```ruby
+# app/views/users/show.json.jbuilder
+json.ok data: { user: { id: @user.id, name: @user.name } }, message: "ok"
+
+# app/views/shared/error.json.jbuilder
+json.fail message: "not found", code: 404, data: { resource: "User" }
+
+# extra fields
+json.ok data: { list: @items.map { |i| { id: i.id, name: i.name } } }, meta: { total: @items.count }
+```
+
+Aliases in Jbuilder: you can also use `json.warp_ok` and `json.warp_fail`.
+
 
 ## Installation
 Add this line to your application's Gemfile:

data/lib/rails_warp/engine.rb

@@ -11,16 +11,29 @@ module RailsWarp
     end
 
     # 将 Jbuilder 扩展模块包含到 Jbuilder 类中
-    config.after_initialize do |app|
-      # Jbuilder 的上下文类通常是 Jbuilder 或 JbuilderTemplate
-      # 尝试混入到 Jbuilder 类
+    initializer "rails_warp.jbuilder", before: :eager_load! do |app|
+      # 显式 require jbuilder 以确保 handler 被注册
+      require 'jbuilder'
+
+      # 确保 jbuilder handler 被注册
+      if defined?(JbuilderHandler) && !ActionView::Template.registered_template_handler(:jbuilder)
+        ActionView::Template.register_template_handler(:jbuilder, JbuilderHandler)
+      end
+
+      # 将 JbuilderExtension 包含到 Jbuilder 类
       if defined?(Jbuilder)
-        Jbuilder.include RailsWarp::JbuilderExtension
+        Jbuilder.include(RailsWarp::JbuilderExtension)
       end
-      # 如果 JbuilderTemplate 存在，也混入它 (在某些 Jbuilder 版本中可能需要)
-      if defined?(JbuilderTemplate)
-        JbuilderTemplate.include RailsWarp::JbuilderExtension
+
+      # 某些版本的 jbuilder 使用 Jbuilder::Template
+      if defined?(Jbuilder::Template)
+        Jbuilder::Template.include(RailsWarp::JbuilderExtension)
+      end
+
+      # 兼容旧版本的 JbuilderTemplate
+      if defined?(JbuilderTemplate) && defined?(JbuilderTemplate) != defined?(Jbuilder::Template)
+        JbuilderTemplate.include(RailsWarp::JbuilderExtension)
       end
     end
   end
-end
+end

data/lib/rails_warp/jbuilder_extension.rb

@@ -1,58 +1,45 @@
 # lib/rails_warp/jbuilder_extension.rb
 module RailsWarp
   module JbuilderExtension
-    # 成功响应结构，用于 jbuilder 模板
-    def warp_ok(**options)
-      data = options[:data]
+    # 忽略方法_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"
       code = options[:code] || 200
-      # 构建响应哈希
-      response_hash = build_response(true, data, message, code, **options.except(:data, :message, :code))
-      # 将响应哈希的内容合并到当前 jbuilder 对象
-      merge!(response_hash)
+
+      set! :success, true
+      set! :code, code
+      set! :message, message
+
+      yield if block_given?
     end
 
-    # 失败响应结构，用于 jbuilder 模板
-    def warp_fail(**options)
+    def _warp_fail(**options)
       message = options[:message] || "error"
       code = options[:code] || 500
-      data = options[:data]
-      # 构建响应哈希
-      response_hash = build_response(false, data, message, code, **options.except(:data, :message, :code))
-      # 将响应哈希的内容合并到当前 jbuilder 对象
-      merge!(response_hash)
-    end
 
-    # 为 jbuilder 提供别名方法
-    alias_method :ok, :warp_ok
-    alias_method :fail, :warp_fail
+      set! :success, false
+      set! :code, code
+      set! :message, message
 
-    private
-
-    # 内部构建响应体的辅助方法
-    def build_response(success, data, message, code, **extra)
-      response_hash = {
-        success: success,
-        code: code,
-        message: message,
-        data: data # <--- 修改这里：明确写成 data: data
-      }
-      # 合并额外的字段
-      response_hash.merge!(extra) if extra.present?
-      response_hash
+      yield if block_given?
     end
   end
 end
-
-# Rails 应用启动时，将 JbuilderExtension 混入到 Jbuilder 的上下文
-# Rails.application.config.after_initialize do
-#   # Jbuilder 的上下文类通常是 Jbuilder 或 JbuilderTemplate
-#   # 尝试混入到 Jbuilder 类
-#   if defined?(Jbuilder)
-#     Jbuilder.include RailsWarp::JbuilderExtension
-#   end
-#   # 如果 JbuilderTemplate 存在，也混入它 (在某些 Jbuilder 版本中可能需要)
-#   if defined?(JbuilderTemplate)
-#     JbuilderTemplate.include RailsWarp::JbuilderExtension
-#   end
-# end

data/lib/rails_warp/version.rb

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

data/lib/rails_warp.rb

@@ -2,7 +2,7 @@
 require "rails_warp/version"
 require "rails_warp/engine"
 require "rails_warp/response_wrapper"
-require "rails_warp/jbuilder_extension" # 引入 jbuilder 扩展
+require "rails_warp/jbuilder_extension"
 
 module RailsWarp
   # 你的插件逻辑可以在这里定义

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_warp
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - aric.zheng
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-11-08 00:00:00.000000000 Z
+date: 2026-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jbuilder
@@ -35,20 +35,11 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
-- app/assets/stylesheets/rails_warp/application.css
-- app/controllers/rails_warp/application_controller.rb
-- app/helpers/rails_warp/application_helper.rb
-- app/jobs/rails_warp/application_job.rb
-- app/mailers/rails_warp/application_mailer.rb
-- app/models/rails_warp/application_record.rb
-- app/views/layouts/rails_warp/application.html.erb
-- config/routes.rb
 - lib/rails_warp.rb
 - lib/rails_warp/engine.rb
 - lib/rails_warp/jbuilder_extension.rb
 - lib/rails_warp/response_wrapper.rb
 - lib/rails_warp/version.rb
-- lib/tasks/rails_warp_tasks.rake
 homepage: https://github.com/afeiship/rails_warp
 licenses:
 - MIT

data/app/assets/stylesheets/rails_warp/application.css

@@ -1,15 +0,0 @@
-/*
- * This is a manifest file that'll be compiled into application.css, which will include all the files
- * listed below.
- *
- * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
- * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
- *
- * You're free to add application-wide styles to this file and they'll appear at the bottom of the
- * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
- * files in this directory. Styles in this file should be added after the last require_* statement.
- * It is generally better to create a new file per style scope.
- *
- *= require_tree .
- *= require_self
- */

data/app/controllers/rails_warp/application_controller.rb

@@ -1,4 +0,0 @@
-module RailsWarp
-  class ApplicationController < ActionController::Base
-  end
-end

data/app/helpers/rails_warp/application_helper.rb

@@ -1,4 +0,0 @@
-module RailsWarp
-  module ApplicationHelper
-  end
-end

data/app/jobs/rails_warp/application_job.rb

@@ -1,4 +0,0 @@
-module RailsWarp
-  class ApplicationJob < ActiveJob::Base
-  end
-end

data/app/mailers/rails_warp/application_mailer.rb

@@ -1,6 +0,0 @@
-module RailsWarp
-  class ApplicationMailer < ActionMailer::Base
-    default from: "from@example.com"
-    layout "mailer"
-  end
-end

data/app/models/rails_warp/application_record.rb

@@ -1,5 +0,0 @@
-module RailsWarp
-  class ApplicationRecord < ActiveRecord::Base
-    self.abstract_class = true
-  end
-end

data/app/views/layouts/rails_warp/application.html.erb

@@ -1,17 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-  <title>Rails warp</title>
-  <%= csrf_meta_tags %>
-  <%= csp_meta_tag %>
-
-  <%= yield :head %>
-
-  <%= stylesheet_link_tag    "rails_warp/application", media: "all" %>
-</head>
-<body>
-
-<%= yield %>
-
-</body>
-</html>

data/config/routes.rb

@@ -1,2 +0,0 @@
-RailsWarp::Engine.routes.draw do
-end

data/lib/tasks/rails_warp_tasks.rake

@@ -1,4 +0,0 @@
-# desc "Explaining what the task does"
-# task :rails_warp do
-#   # Task goes here
-# end