swagger-serializer 0.6.1 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da9cac70a15262e0347ae5505044169f3e9a6f80aec1f604d8f7ff7bf431cc94
-  data.tar.gz: c6e8270890b50456e51a27423a9c55fca437e60363fe43ad3b14ae4adae377cc
+  metadata.gz: 2db9e6f2be15977410edbebc03527173bb0fdd180c086b599f18065044a26a96
+  data.tar.gz: 0a27a92bd4be55bdfb246b3f31f4ed6b561e54a69b68a26489fb0514c3f0850a
 SHA512:
-  metadata.gz: 5aab9030106681ed9f9807d04d15d79d0353bbc3d8655304db2f433b56623db466e8ac74e1bc8efcdfcafd2edae374d701631153c67f995dca0317905d50ff0b
-  data.tar.gz: 6579c2a177c3b8790de0672119d69514397f755a37488078017baa5f8ac02f2090c455f1cb972c88aeac4ba5598b8b808f74d6643029ddab644e8082ed58dee5
+  metadata.gz: 524e018e98512e7b4382b4d10b52bf065caaa330584de8a667a10922be1b78efea19f64f3c8979587ef201dda7ccae0c1c20ce5a4c719ff0ec6d2b634af13634
+  data.tar.gz: f930d17e8bbfd2ae84bfd7c76d658aa456d1776c1e667dac20010e3f8beb09db658b887a61deb66c9bfe89155828113c615f23fab9b40f1454b0b827d90bba28

data/README.md

@@ -33,12 +33,16 @@ Load it in initializer.
 # config/initializers/swagger_serializer.rb
 
 if Rails.application.config.eager_load
+  Swagger::DSL.current.config.lazy_define_paths = true
   Rails.application.config.after_initialize do
+    Rails.application.reload_routes!
+    Swagger::DSL.current.define_paths!
     Swagger::Schema.current = Swagger::Schema.new(Swagger::DSL.current.resolved)
   end
 else
   Swagger::Schema.current = Swagger::Schema.new(Swagger::DSL.current)
-  Swagger::Serializer::Store.current.options[:resolver] = Swagger::DSL.current.resolver
+  Swagger::Serializer::Store.current.serialize_options[:resolver] = Swagger::DSL.current.resolver
+  Swagger::Serializer::Store.current.deserialize_options[:resolver] = Swagger::DSL.current.resolver
 end
 ```
 
@@ -50,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
 ```
@@ -186,7 +190,8 @@ The key is configurable by
 
 ```ruby
 # in config/initializers/swagger_serializer.rb
-Swagger::Serializer::Store.current.options[:inject_key] = "my_inject_key"
+Swagger::Serializer::Store.current.serialize_options[:inject_key] = "my_inject_key"
+Swagger::Serializer::Store.current.deserialize_options[:inject_key] = "my_inject_key"
 Swagger::DSL.current.config.inject_key = "my_inject_key"
 ```
 
@@ -260,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
 ```
@@ -299,10 +304,6 @@ end
 
 Now you can get `{ "id" => 42, "name" => "me!!!!" }`.
 
-This serializer class detection uses the schema's `title` key.
-If you want to use `Foo::BarSerializer`, set `Foo::Bar` to `title` key.
-The key is configurable by `Swagger::Serializer::Store.current.options[:inject_key] = "my_inject_key"`.
-
 Sometimes model needs direct serialize.
 
 ```ruby
@@ -316,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)
@@ -24,5 +25,9 @@ module Swagger
     def method_missing(name, *args)
       @model.public_send(name, *args)
     end
+
+    def nil?
+      @model.nil?
+    end
   end
 end

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.1".freeze
+    VERSION = "0.8.2".freeze
   end
 end

data/swagger-serializer.gemspec

@@ -27,10 +27,10 @@ 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", "~> 10.5"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.9"
   spec.add_development_dependency "rspec-power_assert", "~> 1.1"
   spec.add_development_dependency "rubocop", "~> 0.76"

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: swagger-serializer
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.8.2
 platform: ruby
 authors:
 - Narazaka
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-03 00:00:00.000000000 Z
+date: 2020-11-06 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
@@ -58,14 +64,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.5'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.5'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -234,7 +240,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.1
+  documentation_uri: https://www.rubydoc.info/gems/swagger-serializer/0.8.2
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -250,8 +256,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Swagger (OpenAPI 3) schema based Serializer