rails_warp 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ab3733aafa1562776836bf91b43064fdab855491260010034b2faab2a2699e39
+  data.tar.gz: e579ab5ead54f90e831268289a4645ca87baa179ffaaa08e08340692bcf67732
+SHA512:
+  metadata.gz: 3dc9ba11879051394341dd4ec8174958ccb11a4ac8f8915dc9bdd3aa3809ff3a0eea8710ceb68698ba60d4fcfe51892d3977d8517303e3cabe62d7e092eedeb9
+  data.tar.gz: 5862d5a4b814260cf654fab8a0680e91319637b46ee7e5b9ab40b9d0d289f95df1409e663ba0a50cf3a0262dc4829e383a6ec1dec9dd31c426447b969a9d95aa

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright aric.zheng
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,31 @@
+# RailsWarp
+> A Rails plugin for elegant, hash-based response wrapper for clean Rails API responses.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "rails_warp"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ 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/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+require "bundler/gem_tasks"

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

@@ -0,0 +1,15 @@
+/*
+ * 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

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

data/app/helpers/rails_warp/application_helper.rb

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

data/app/jobs/rails_warp/application_job.rb

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

data/app/mailers/rails_warp/application_mailer.rb

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

data/app/models/rails_warp/application_record.rb

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

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

@@ -0,0 +1,17 @@
+<!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

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

data/lib/rails_warp/engine.rb

@@ -0,0 +1,26 @@
+# lib/rails_warp/engine.rb
+require 'rails/engine'
+
+module RailsWarp
+  class Engine < ::Rails::Engine
+    # 将控制器响应封装模块包含到 Rails 的 ActionController::Base 中
+    initializer "rails_warp.action_controller" do |app|
+      ActiveSupport.on_load :action_controller do
+        include RailsWarp::ResponseWrapper
+      end
+    end
+
+    # 将 Jbuilder 扩展模块包含到 Jbuilder 类中
+    config.after_initialize do |app|
+      # Jbuilder 的上下文类通常是 Jbuilder 或 JbuilderTemplate
+      # 尝试混入到 Jbuilder 类
+      if defined?(Jbuilder)
+        Jbuilder.include RailsWarp::JbuilderExtension
+      end
+      # 如果 JbuilderTemplate 存在，也混入它 (在某些 Jbuilder 版本中可能需要)
+      if defined?(JbuilderTemplate)
+        JbuilderTemplate.include RailsWarp::JbuilderExtension
+      end
+    end
+  end
+end

data/lib/rails_warp/jbuilder_extension.rb

@@ -0,0 +1,58 @@
+# lib/rails_warp/jbuilder_extension.rb
+module RailsWarp
+  module JbuilderExtension
+    # 成功响应结构，用于 jbuilder 模板
+    def warp_ok(**options)
+      data = options[:data]
+      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)
+    end
+
+    # 失败响应结构，用于 jbuilder 模板
+    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
+
+    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
+    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/response_wrapper.rb

@@ -0,0 +1,51 @@
+# lib/rails_warp/response_wrapper.rb
+module RailsWarp
+  module ResponseWrapper
+    extend ActiveSupport::Concern
+
+    # 成功响应 - 仅支持 Hash 参数
+    def ok(**options)
+      data = options[:data]
+      message = options[:message] || nil
+      code = options[:code] || 200
+      render json: build_response(true, data, message, code, **options.except(:data, :message, :code))
+    end
+
+    # 失败响应 - 仅支持 Hash 参数
+    def fail(**options)
+      message = options[:message] || "error"
+      code = options[:code] || 500
+      data = options[:data]
+      render json: build_response(false, data, message, code, **options.except(:data, :message, :code)), status: get_http_status(code)
+    end
+
+    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
+    end
+
+    # 将 code 映射到 HTTP 状态码
+    def get_http_status(code)
+      case code
+      when 200, 201, 204 then code
+      when 400 then :bad_request
+      when 401 then :unauthorized
+      when 403 then :forbidden
+      when 404 then :not_found
+      when 422 then :unprocessable_entity
+      when 500 then :internal_server_error
+      else code
+      end
+    end
+  end
+end

data/lib/rails_warp/version.rb

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

data/lib/rails_warp.rb

@@ -0,0 +1,9 @@
+# lib/rails_warp.rb
+require "rails_warp/version"
+require "rails_warp/engine"
+require "rails_warp/response_wrapper"
+require "rails_warp/jbuilder_extension" # 引入 jbuilder 扩展
+
+module RailsWarp
+  # 你的插件逻辑可以在这里定义
+end

data/lib/tasks/rails_warp_tasks.rake

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

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: rails_warp
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- aric.zheng
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-11-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jbuilder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.5'
+description: Provides `ok` and `fail` methods in controllers for standardized API
+  responses. Includes jbuilder helpers.
+email:
+- 1290657123@qq.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+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
+metadata:
+  homepage_uri: https://github.com/afeiship/rails_warp
+  source_code_uri: https://github.com/afeiship/rails_warp
+  changelog_uri: https://github.com/afeiship/rails_warp/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: A Rails plugin for elegant, hash-based response wrapper for clean Rails API
+  responses.
+test_files: []