rest_framework 0.6.2 → 0.6.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 207b074408e0f95dd2d289abdd7d048f66f44d38f795b45b51245af28376a1c4
-  data.tar.gz: 67729758c21dd7627419248801d85f929188c64f2b20dba9095938a9650259da
+  metadata.gz: 58fa867a9eed508be6ef78687d445cb5f3c0dc8cf0c004d8a8eab7f003f622cb
+  data.tar.gz: da285af9bf75273dcd864362d57ada399cc876e0e28767e546a89d1a8f280d28
 SHA512:
-  metadata.gz: 8dd2c8c6209b04ffa77fe1506906332c9beb3e87ee60bad2f348ab5331258b46fe66fc3ced5048b66472c424b84132746fbca650b82faa87415c1a36b41c16c2
-  data.tar.gz: d04ceada0800c54161cfaeccb3d43251c3ae3bd5c629a937da058c0be640c0287453ac3338744d36e0290aea536b4987f56e76b0ace999580bd90adbd14d85c1
+  metadata.gz: 480e49357afb571538b0f5ec730eff04a0dc326ca4d9e93e9bbba7a60571c3dc2b09ddd3cbfa4ca2dec734e4de5de6faec542e5d06d5e9674e2c492575d2b450
+  data.tar.gz: 138e532ede2fdd207a557edf0cc8fd89f24eceb782b251adf107c3e445ad2e0a32d69fa66475d1215321f6085a953cce98f586284e39d207d453727e66f8a714

data/VERSION

@@ -1 +1 @@
-0.6.2
+0.6.4

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)
 
@@ -138,6 +142,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/serializers.rb

@@ -101,53 +101,48 @@ class RESTFramework::NativeSerializer < RESTFramework::BaseSerializer
     return controller_serializer || @controller.class.try(:native_serializer_config)
   end
 
-  # Helper to filter (mutate) a single subconfig for specific keys.
-  def self.filter_subcfg(subcfg, except: nil, only: nil, additive: false)
-    return subcfg unless except || only
-    return subcfg unless subcfg || additive
-    raise "Cannot pass `only` and `additive` to filter_subcfg." if only && additive
+  # Helper to filter a single subconfig for specific keys. By default, keys from `fields` are
+  # removed from the provided `subcfg`. There are two (mutually exclusive) options to adjust the
+  # behavior:
+  #
+  #  `add`: Add any `fields` to the `subcfg` which aren't already in the `subcfg`.
+  #  `only`: Remove any values found in the `subcfg` not in `fields`.
+  def self.filter_subcfg(subcfg, fields:, add: false, only: false)
+    raise "`add` and `only` conflict with one another" if add && only
+
+    # Don't process nil `subcfg`s.
+    return subcfg unless subcfg
 
     if subcfg.is_a?(Array)
-      subcfg = subcfg.map(&:to_sym)
-      if except
-        if additive
-          # Only add fields which are not already included.
-          subcfg += except - subcfg
-        else
-          subcfg -= except
-        end
+      subcfg = subcfg.transform_values(&:to_sym)
+
+      if add
+        # Only add fields which are not already included.
+        subcfg += fields - subcfg
       elsif only
-        # Ignore `additive` in an `only` context, since it could causing data leaking.
-        unless additive
-          subcfg.select! { |c| c.in?(only) }
-        end
+        subcfg.select! { |c| c.in?(fields) }
+      else
+        subcfg -= fields
       end
     elsif subcfg.is_a?(Hash)
-      # Additive doesn't make sense in a hash context since we wouldn't know the values.
-      unless additive
-        if except
-          subcfg.symbolize_keys!
-          subcfg.reject! { |k, _v| k.in?(except) }
-        elsif only
-          subcfg.symbolize_keys!
-          subcfg.select! { |k, _v| k.in?(only) }
-        end
-      end
-    elsif !subcfg
-      if additive && except
-        subcfg = except
+      subcfg = subcfg.symbolize_keys
+
+      if add
+        # Add doesn't make sense in a hash context since we wouldn't know the values.
+      elsif only
+        subcfg.select! { |k, _v| k.in?(fields) }
+      else
+        subcfg.reject! { |k, _v| k.in?(fields) }
       end
     else  # Subcfg is a single element (assume string/symbol).
       subcfg = subcfg.to_sym
 
-      if except
-        if subcfg.in?(except)
-          subcfg = [] unless additive
-        elsif additive
-          subcfg = [subcfg, *except]
-        end
-      elsif only && !additive && !subcfg.in?(only)  # Protect only/additive data-leaking.
-        subcfg = []
+      if add
+        subcfg = subcfg.in?(fields) ? fields : [subcfg, *fields]
+      elsif only
+        subcfg = subcfg.in?(fields) ? subcfg : []
+      else
+        subcfg = subcfg.in?(fields) ? [] : subcfg
       end
     end
 
@@ -166,33 +161,38 @@ class RESTFramework::NativeSerializer < RESTFramework::BaseSerializer
       unless except.empty?
         # Filter `only`, `except` (additive), `include`, `methods`, and `serializer_methods`.
         if cfg[:only]
-          cfg[:only] = self.class.filter_subcfg(cfg[:only], except: except)
+          cfg[:only] = self.class.filter_subcfg(cfg[:only], fields: except)
+        elsif cfg[:except]
+          cfg[:except] = self.class.filter_subcfg(cfg[:except], fields: except, add: true)
         else
-          cfg[:except] = self.class.filter_subcfg(cfg[:except], except: except, additive: true)
+          cfg[:except] = except
         end
-        cfg[:include] = self.class.filter_subcfg(cfg[:include], except: except)
-        cfg[:methods] = self.class.filter_subcfg(cfg[:methods], except: except)
+        cfg[:include] = self.class.filter_subcfg(cfg[:include], fields: except)
+        cfg[:methods] = self.class.filter_subcfg(cfg[:methods], fields: except)
         cfg[:serializer_methods] = self.class.filter_subcfg(
-          cfg[:serializer_methods], except: except
+          cfg[:serializer_methods], fields: except
         )
       end
     elsif only_param && only = @controller.request.query_parameters[only_param].presence
       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], only: 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[:except] = self.class.filter_subcfg(cfg[:except], except: except_cols, additive: true)
+          cfg[:only] = only
         end
-        cfg[:include] = self.class.filter_subcfg(cfg[:include], only: only)
-        cfg[:methods] = self.class.filter_subcfg(cfg[:methods], only: only)
-        cfg[:serializer_methods] = self.class.filter_subcfg(cfg[:serializer_methods], only: only)
+        cfg[:include] = self.class.filter_subcfg(cfg[:include], fields: only, only: true)
+        cfg[:methods] = self.class.filter_subcfg(cfg[:methods], fields: only, only: true)
+        cfg[:serializer_methods] = self.class.filter_subcfg(
+          cfg[:serializer_methods], fields: only, only: true
+        )
       end
     end
 

metadata

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