rest_framework 0.6.3 → 0.6.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9310e248327d207a68953d1f629bb9c094c860ee7fe50f1ada4cb87e88e1da43
-  data.tar.gz: c7ffe0f8ef8bf0c0f26b7d918cccbd91c9b1650f144c7ba071d9f9db0c2b4a2b
+  metadata.gz: 68ebf30c14f9f70796c6963505e7b45421ee838d076784073505feb9b05c3ddb
+  data.tar.gz: 71918c4b2b2eeaed10833d84cb54f6bbb860ea3205895bc75abf9a543d0bedc9
 SHA512:
-  metadata.gz: 49c1bd1aa35b97b3543ffe3a66b1eb8a19fe339f996483071be1cb6817aa3f8d4848ff90f0b5bd7e20769c9c1c028f605de1e8251cb80bd2fcfb979ec10de2bd
-  data.tar.gz: 1c5e9ef47b970fd883023ac2eb11b3febabfb83d929908de28553b46a668c2136286bef4873f489e5fa263959cbf33a8b8cecef6bce7ace29926983566cad94a
+  metadata.gz: d909e86567107d2565a65e9c99f67b771e462a2bd9dae04289c9846cc0ba68bfe3728b63d1b8a154c532e7a5cb1aeac1f593401a98bbc0b1f405f474aabb8527
+  data.tar.gz: abe06a65bb999c4926e6a54295afc4c55e254fba1276b0257eb2af765bbc3f367fe5ebc5d9fe1d6181c45157369440de13a7f4aed331a49271426d2468110a99

data/VERSION

@@ -1 +1 @@
-0.6.3
+0.6.5

data/lib/rest_framework/controller_mixins/base.rb

@@ -51,6 +51,10 @@ module RESTFramework::BaseControllerMixin
         serialize_to_xml: true,
         singleton_controller: nil,
         skip_actions: nil,
+
+        # Helper to disable serializer adapters by default, mainly introduced because Active Model
+        # Serializers will do things like serialize `[]` into `{"":[]}`.
+        disable_adapters_by_default: true,
       }.each do |a, default|
         next if base.respond_to?(a)
 
@@ -86,6 +90,12 @@ module RESTFramework::BaseControllerMixin
   def get_serializer_class
     return nil unless serializer_class = self.class.serializer_class
 
+    # Support dynamically resolving serializer given a symbol or string.
+    serializer_class = serializer_class.to_s if serializer_class.is_a?(Symbol)
+    if serializer_class.is_a?(String)
+      serializer_class = self.class.const_get(serializer_class)
+    end
+
     # Wrap it with an adapter if it's an active_model_serializer.
     if defined?(ActiveModel::Serializer) && (serializer_class < ActiveModel::Serializer)
       serializer_class = RESTFramework::ActiveModelSerializerAdapterFactory.for(serializer_class)
@@ -138,6 +148,11 @@ module RESTFramework::BaseControllerMixin
     json_kwargs = kwargs.delete(:json_kwargs) || {}
     xml_kwargs = kwargs.delete(:xml_kwargs) || {}
 
+    # Do not use any adapters by default, if configured.
+    if self.class.disable_adapters_by_default && !kwargs.key?(:adapter)
+      kwargs[:adapter] = nil
+    end
+
     # Raise helpful error if payload is nil. Usually this happens when a record is not found (e.g.,
     # when passing something like `User.find_by(id: some_id)` to `api_response`). The caller should
     # actually be calling `find_by!` to raise ActiveRecord::RecordNotFound and allowing the REST

data/lib/rest_framework/controller_mixins/models.rb

@@ -114,6 +114,11 @@ module RESTFramework::BaseModelControllerMixin
     return super || RESTFramework::NativeSerializer
   end
 
+  # Helper to serialize data using the `serializer_class`.
+  def serialize(data, **kwargs)
+    return self.get_serializer_class.new(data, controller: self, **kwargs).serialize
+  end
+
   # Helper to get filtering backends, defaulting to using `ModelFilter` and `ModelOrderingFilter`.
   def get_filter_backends
     return self.class.filter_backends || [
@@ -232,10 +237,10 @@ module RESTFramework::ListModelMixin
     if self.class.paginator_class
       paginator = self.class.paginator_class.new(data: @records, controller: self)
       page = paginator.get_page
-      serialized_page = self.get_serializer_class.new(page, controller: self).serialize
+      serialized_page = self.serialize(page)
       return paginator.get_paginated_response(serialized_page)
     else
-      return self.get_serializer_class.new(@records, controller: self).serialize
+      return self.serialize(@records)
     end
   end
 end
@@ -248,7 +253,7 @@ module RESTFramework::ShowModelMixin
 
   def show!
     @record ||= self.get_record
-    return self.get_serializer_class.new(@record, controller: self).serialize
+    return self.serialize(@record)
   end
 end
 
@@ -269,7 +274,7 @@ module RESTFramework::CreateModelMixin
       @record ||= self.get_model.create!(self.get_create_params)
     end
 
-    return self.get_serializer_class.new(@record, controller: self).serialize
+    return self.serialize(@record)
   end
 end
 
@@ -282,7 +287,7 @@ module RESTFramework::UpdateModelMixin
   def update!
     @record ||= self.get_record
     @record.update!(self.get_update_params)
-    return self.get_serializer_class.new(@record, controller: self).serialize
+    return self.serialize(@record)
   end
 end
 

data/lib/rest_framework/serializers.rb

@@ -177,14 +177,13 @@ class RESTFramework::NativeSerializer < RESTFramework::BaseSerializer
       only = only.split(",").map(&:strip).map(&:to_sym)
 
       unless only.empty?
-        # For the `except` part of the serializer, we need to append any columns not in `only`.
-        model = @controller.get_model
-        except_cols = model&.column_names&.map(&:to_sym)&.reject { |c| c.in?(only) }
-
         # Filter `only`, `except` (additive), `include`, and `methods`.
         if cfg[:only]
           cfg[:only] = self.class.filter_subcfg(cfg[:only], fields: only, only: true)
         elsif cfg[:except]
+          # For the `except` part of the serializer, we need to append any columns not in `only`.
+          model = @controller.get_model
+          except_cols = model&.column_names&.map(&:to_sym)&.reject { |c| c.in?(only) }
           cfg[:except] = self.class.filter_subcfg(cfg[:except], fields: except_cols, add: true)
         else
           cfg[:only] = only
@@ -283,21 +282,6 @@ class RESTFramework::NativeSerializer < RESTFramework::BaseSerializer
   end
 end
 
-# :nocov:
-# Alias NativeModelSerializer -> NativeSerializer.
-class RESTFramework::NativeModelSerializer < RESTFramework::NativeSerializer
-  def initialize(**kwargs)
-    super
-    ActiveSupport::Deprecation.warn(
-      <<~MSG.split("\n").join(" "),
-        RESTFramework::NativeModelSerializer is deprecated and will be removed in future versions of
-        REST Framework; you should use RESTFramework::NativeSerializer instead.
-      MSG
-    )
-  end
-end
-# :nocov:
-
 # This is a helper factory to wrap an ActiveModelSerializer to provide a `serialize` method which
 # accepts both collections and individual records. Use `.for` to build adapters.
 class RESTFramework::ActiveModelSerializerAdapterFactory

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rest_framework
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.6.5
 platform: ruby
 authors:
 - Gregory N. Schmit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-09-16 00:00:00.000000000 Z
+date: 2022-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails