swagger-serializer 0.6.2 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bda748bb32d9308010609db0d3e86aa515ec85207d8ebba302f90e897139e500
-  data.tar.gz: a32eea14539ec58fcdbf3f9ef491ffc844a18247bf3c812e6e43a0be3e772f3a
+  metadata.gz: c981a97501496cce000677d6bb67c02db75b948d00541c683ef56c0fcf738d47
+  data.tar.gz: 1f53440f04121534346790081311a9e8907ffce11c8244c9bc8ca5dc4c405889
 SHA512:
-  metadata.gz: e8b3dd2abbbaed3fc208dc38fb5c92033eadce081a6ee031a759654c6ae6711b06d57c5ddab36251d5210e1e21052024b0802fb7a662bfbd25a09b2484626a2a
-  data.tar.gz: 4d313ee5fb65c7de7510f7e6e16143d41deff79e93d7411e78c52acc5d3afe72f30b9bb2c547f273849af3fe3ca8446bfbafb0f134bff60d58c39fa251440fb3
+  metadata.gz: 2da0855070adbcaf65cd2e52569bff14fdb30b106af975acbcfbf33c18cd61a37a4e0b934580599c8479dda4de3e0b0c8baf67cd6aef786608ced9991821a9b7
+  data.tar.gz: 56a07032f129c2fa4d624347fd4ce60adff1ff0397afaaeb53a8c04b84afa39fa275b8391d5e13e70e7c49e148f0e4f9becf0621f41a560d9904f2e4979c2806

data/README.md

@@ -54,12 +54,12 @@ class ApplicationController < ActionController::Base
   include Swagger::Serializer::RailsController
   extend Swagger::DSL::RailsController
 
-  def render_ok(data)
-    render_as_schema 200, :json, data
+  def render_ok(data, context = nil)
+    render_as_schema 200, :json, data, context
   end
 
-  def render_bad(data)
-    render_as_schema 400, :json, data
+  def render_bad(data, context = nil)
+    render_as_schema 400, :json, data, context
   end
 end
 ```
@@ -265,8 +265,8 @@ Use it in controllers.
 class ApplicationController < ActionController::Base
   include Swagger::Serializer::RailsController
 
-  def render_ok(data)
-    render_as_schema 200, :json, data
+  def render_ok(data, context = nil)
+    render_as_schema 200, :json, data, context
   end
 end
 ```
@@ -317,6 +317,43 @@ end
 
 Now you can get serialized result by `p User.first.serialize`.
 
+### @context
+
+Collection serialization sometimes needs context data for avoiding N+1 access or some other reason.
+
+`render_as_schema`'s 4th parameter is the context that will be passed to serializers `@context`.
+
+```ruby
+# app/serializers/item_serializer.rb
+class ItemSerializer < BaseSerializer
+  swagger do
+    id :integer
+    rate :integer
+  end
+
+  def rate
+    @context[:rates][id]
+  end
+end
+
+# app/controllers/items_controller.rb
+class ItemsController < ApplicationController
+  swagger :index do
+    render 200 do
+      array! do
+        cref! ItemSerializer
+      end
+    end
+  end
+
+  def index
+    items = Item.all
+    rates = ItemRate.calc_item_rates(items)
+    render_ok items, { rates: rates }
+  end
+end
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/swagger/serializer.rb

@@ -7,8 +7,9 @@ require "yaml"
 
 module Swagger
   module Serializer
-    def initialize(model)
+    def initialize(model, context = nil)
       @model = model
+      @context = context
     end
 
     def respond_to_missing?(name, include_private)

data/lib/swagger/serializer/rails_controller.rb

@@ -3,13 +3,13 @@ module Swagger::Serializer::RailsController
 
   # render
 
-  def render_as_schema(code, format, data)
-    render format => render_serializer(code, format).serialize(data)
+  def render_as_schema(code, format, data, context = nil)
+    render format => render_serializer(code, format, context).serialize(data)
   end
 
-  def render_serializer(code, format)
+  def render_serializer(code, format, context = nil)
     response_obj = swagger_operation.responses[code]
-    response_obj.content.send(format).serializer(Swagger::Serializer::Store.current.serialize_options)
+    response_obj.content.send(format).serializer(Swagger::Serializer::Store.current.serialize_options.merge(inject_context: context))
   end
 
   def swagger_operation

data/lib/swagger/serializer/version.rb

@@ -1,5 +1,5 @@
 module Swagger
   module Serializer
-    VERSION = "0.6.2".freeze
+    VERSION = "0.7.0".freeze
   end
 end

data/swagger-serializer.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = %w[lib]
 
-  spec.add_dependency "json-schema-serializer", "~> 1.4"
+  spec.add_dependency "json-schema-serializer", "~> 1.6"
   spec.add_dependency "snake_camel", "~> 1.1"
   spec.add_development_dependency "bundler", "~> 2"
   spec.add_development_dependency "rake", "~> 13.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swagger-serializer
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.7.0
 platform: ruby
 authors:
 - Narazaka
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-09 00:00:00.000000000 Z
+date: 2020-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json-schema-serializer
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: snake_camel
   requirement: !ruby/object:Gem::Requirement
@@ -234,7 +234,7 @@ metadata:
   homepage_uri: https://github.com/Narazaka/swagger-serializer
   source_code_uri: https://github.com/Narazaka/swagger-serializer.git
   changelog_uri: https://github.com/Narazaka/swagger-serializer/blob/master/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/swagger-serializer/0.6.2
+  documentation_uri: https://www.rubydoc.info/gems/swagger-serializer/0.7.0
 post_install_message: 
 rdoc_options: []
 require_paths: