swagger-serializer 0.6.2 → 0.8.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bda748bb32d9308010609db0d3e86aa515ec85207d8ebba302f90e897139e500
-  data.tar.gz: a32eea14539ec58fcdbf3f9ef491ffc844a18247bf3c812e6e43a0be3e772f3a
+  metadata.gz: 64f8aa131df07ce9de11beb3384f3c8bd94431136b0fd0032b05bc1a102a06cd
+  data.tar.gz: 56b1e7f8f3364a3df476bd12b4e08760c8dd5e8f39ebb079b15bc798a3a64d8c
 SHA512:
-  metadata.gz: e8b3dd2abbbaed3fc208dc38fb5c92033eadce081a6ee031a759654c6ae6711b06d57c5ddab36251d5210e1e21052024b0802fb7a662bfbd25a09b2484626a2a
-  data.tar.gz: 4d313ee5fb65c7de7510f7e6e16143d41deff79e93d7411e78c52acc5d3afe72f30b9bb2c547f273849af3fe3ca8446bfbafb0f134bff60d58c39fa251440fb3
+  metadata.gz: f8c0b337e81158f0384139aca9be740108567bb6c8d3e94ac7d4d6d404a0353bec53505938771a1bd4fab010e7170dcf8659e35d20fe14113b59267477923cd2
+  data.tar.gz: 97c6fc013f5e9339d23f38a1850fe20c4b5b21c0de715d7a5e0f1e019e33a6e95b52372b96503e00f411e194b376491656a0e0e5d5cf41237270c0dbc928b65f

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/schema.rb

@@ -37,6 +37,8 @@ module Swagger
     end
 
     def component(name)
+      # HogeSerializer
+      name = name.name.sub(/Serializer$/, "") if name.class == Class
       component = Util.try_hash(components, name)
       Component.new(component) if component
     end

data/lib/swagger/schema/component.rb

@@ -9,8 +9,9 @@ module Swagger
         @schema = schema
       end
 
-      def serializer(options = {})
-        JSON::Schema::Serializer.new(@schema, options)
+      def serializer(options = {}, store = true)
+        use_options = store ? Swagger::Serializer::Store.current.serialize_options.merge(options) : options
+        JSON::Schema::Serializer.new(@schema, use_options)
       end
     end
   end

data/lib/swagger/schema/media_type.rb

@@ -14,12 +14,14 @@ module Swagger
 
       define_schema_accessor :schema, :example, :examples, :encoding
 
-      def serializer(options = {})
-        JSON::Schema::Serializer.new(schema, options)
+      def serializer(options = {}, store = true)
+        use_options = store ? Swagger::Serializer::Store.current.serialize_options.merge(options) : options
+        JSON::Schema::Serializer.new(schema, use_options)
       end
 
-      def deserializer(options = {})
-        Deserializer.new(schema, options)
+      def deserializer(options = {}, store = true)
+        use_options = store ? Swagger::Serializer::Store.current.deserialize_options.merge(options) : options
+        Deserializer.new(schema, use_options)
       end
 
       def validator

data/lib/swagger/schema/parameter_base.rb

@@ -11,17 +11,17 @@ module Swagger
       end
 
       define_schema_accessor %i[
-                               description
-                               required
-                               deprecated
-                               allowEmptyValue
-                               style
-                               explode
-                               allowReserved
-                               schema
-                               example
-                               examples
-                             ].freeze
+        description
+        required
+        deprecated
+        allowEmptyValue
+        style
+        explode
+        allowReserved
+        schema
+        example
+        examples
+      ].freeze
 
       def to_json_schema
         schema

data/lib/swagger/schema/parameters.rb

@@ -57,12 +57,14 @@ module Swagger
         schema
       end
 
-      def serializer(options = {})
-        JSON::Schema::Serializer.new(to_json_schema, options)
+      def serializer(options = {}, store = true)
+        use_options = store ? Swagger::Serializer::Store.current.serialize_options.merge(options) : options
+        JSON::Schema::Serializer.new(to_json_schema, use_options)
       end
 
-      def deserializer(options = {})
-        Deserializer.new(self, options)
+      def deserializer(options = {}, store = true)
+        use_options = store ? Swagger::Serializer::Store.current.deserialize_options.merge(options) : options
+        Deserializer.new(self, use_options)
       end
 
       def validator

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)
@@ -21,8 +22,8 @@ module Swagger
       end
     end
 
-    def method_missing(name, *args)
-      @model.public_send(name, *args)
+    def method_missing(name, *args, &block)
+      @model.public_send(name, *args, &block)
     end
 
     def nil?

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(inject_context: context)
   end
 
   def swagger_operation
@@ -37,7 +37,7 @@ module Swagger::Serializer::RailsController
 
   def parameter_deserializer
     @parameter_deserializer ||=
-      swagger_operation.parameters.deserializer(Swagger::Serializer::Store.current.deserialize_options)
+      swagger_operation.parameters.deserializer
   end
 
   def body_params
@@ -47,9 +47,7 @@ module Swagger::Serializer::RailsController
   def body_deserializer
     @body_deserializer ||=
       if request.content_type
-        swagger_operation.request_body.content[request.content_type]&.deserializer(
-          Swagger::Serializer::Store.current.deserialize_options,
-        )
+        swagger_operation.request_body.content[request.content_type]&.deserializer
       end
   end
 

data/lib/swagger/serializer/version.rb

@@ -1,5 +1,5 @@
 module Swagger
   module Serializer
-    VERSION = "0.6.2".freeze
+    VERSION = "0.8.3".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", "< 3"]
   spec.add_dependency "snake_camel", "~> 1.1"
   spec.add_development_dependency "bundler", "~> 2"
   spec.add_development_dependency "rake", "~> 13.0"

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: swagger-serializer
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.8.3
 platform: ruby
 authors:
 - Narazaka
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-03-09 00:00:00.000000000 Z
+date: 2021-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json-schema-serializer
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1.6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1.6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: snake_camel
   requirement: !ruby/object:Gem::Requirement
@@ -178,7 +184,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
-description: 
+description:
 email:
 - info@narazaka.net
 executables: []
@@ -234,8 +240,8 @@ 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
-post_install_message: 
+  documentation_uri: https://www.rubydoc.info/gems/swagger-serializer/0.8.3
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -250,9 +256,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Swagger (OpenAPI 3) schema based Serializer
 test_files: []