rest_framework 0.0.9 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce317c05e27ab6421b18f37595dbb846a747c8616d19fc9a1927a9ecc30fefc7
-  data.tar.gz: b8f88631bfca835f395677af0e0c0079b40c079aa8d9a6cc8c8ee46dc5d589c2
+  metadata.gz: a3ed68df38881608ec5cc6c66c286624a600398a745ab730e6cef89513f0138f
+  data.tar.gz: 7f2654b29027aa24357b14082e0e0236d9024521fe47e3ae90be7fdeda535b5f
 SHA512:
-  metadata.gz: abd9fc1e83d61c60af77d834d3a3e03a4a904863f3ad4bb851d8cf35a5a563a322eef508a273764ce727303e3e25f526cca03a643127957a7d9952e4988de743
-  data.tar.gz: 8aadf4ba5467c645da2404df61880bd741a491eea0c14a09b20e7056726022f7fc7bd4b8a3f90e9ac068b578e63870c85cfaa813296245cf8c4fddfb7d002a66
+  metadata.gz: 460fd09cc0b375e5509a83ff64bf5ffb87f864cb53e5cb51aa1027bce3a39bbd12a8f692a3c621ad93ac200f98bb095b369610b2953eedb9a47a181568fea948
+  data.tar.gz: 03c6ec7c3d910dac783e2ddb927ea53212e066246dcf1b2673d95e703754a9295a5e792d9daeb3c40fd5d334491e489e076b4740f766ab7880eaf3d731344bda

data/app/views/layouts/rest_framework.html.erb

@@ -19,7 +19,7 @@
     <div class="container py-3">
       <div class="container">
         <div class="row">
-          <h1><%= @title %></h1>
+          <h1><%= (@header_text if defined? @header_text) || @title %></h1>
         </div>
         <hr/>
         <% if @json_payload || @xml_payload %>

data/lib/rest_framework/VERSION_STAMP

@@ -1 +1 @@
-0.0.9
+0.0.10

data/lib/rest_framework/controller_mixins/base.rb

@@ -75,7 +75,7 @@ module RESTFramework
     end
 
     # Helper alias for `respond_to`/`render`, and replace nil responses with blank ones. `payload`
-    # must be already serialized to Ruby primitives.
+    # should be already serialized to Ruby primitives.
     def api_response(payload, html_kwargs: nil, json_kwargs: nil, xml_kwargs: nil, **kwargs)
       html_kwargs ||= {}
       json_kwargs ||= {}

data/lib/rest_framework/controller_mixins/models.rb

@@ -31,43 +31,37 @@ module RESTFramework
       return self.class.serializer_class || NativeModelSerializer
     end
 
-    # Get a list of fields for an action (or the current action if none given).
-    def get_fields(action: nil)
+    # Get a list of fields for the current action.
+    def get_fields
       action_fields = self.class.action_fields || {}
-
-      # action will, by default, be the current action name
-      action = action_name.to_sym unless action
+      action = self.action_name.to_sym
 
       # index action should use :list fields if :index is not provided
       action = :list if action == :index && !action_fields.key?(:index)
 
-      return action_fields[action] || self.class.fields || []
+      return (action_fields[action] if action) || self.class.fields || []
     end
 
-    # Get a native serializer config for an action (or the current action if none given).
-    def get_native_serializer_config(action: nil)
-      native_serializer_action_config = self.class.native_serializer_action_config || {}
-
-      # action will, by default, be the current action name
-      action = action_name.to_sym unless action
+    # Get a native serializer config for the current action.
+    def get_native_serializer_config
+      action_serializer_config = self.class.native_serializer_action_config || {}
+      action = self.action_name.to_sym
 
       # index action should use :list serializer config if :index is not provided
-      action = :list if action == :index && !native_serializer_action_config.key?(:index)
+      action = :list if action == :index && !action_serializer_config.key?(:index)
 
-      return native_serializer_action_config[action] || self.class.native_serializer_config
+      return (action_serializer_config[action] if action) || self.class.native_serializer_config
     end
 
-    # Get a list of parameters allowed for an action (or the current action if none given).
-    def get_allowed_parameters(action: nil)
+    # Get a list of parameters allowed for the current action.
+    def get_allowed_parameters
       allowed_action_parameters = self.class.allowed_action_parameters || {}
-
-      # action will, by default, be the current action name
-      action = action_name.to_sym unless action
+      action = self.action_name.to_sym
 
       # index action should use :list allowed parameters if :index is not provided
       action = :list if action == :index && !allowed_action_parameters.key?(:index)
 
-      return allowed_action_parameters[action] || self.class.allowed_parameters
+      return (allowed_action_parameters[action] if action) || self.class.allowed_parameters
     end
 
     # Filter the request body for keys in current action's allowed_parameters/fields config.

data/lib/rest_framework/serializers.rb

@@ -7,28 +7,58 @@ module RESTFramework
       @data = data
       @controller = controller
     end
-
-    def is_valid
-      return true
-    end
   end
 
   # This serializer uses `.as_json` to serialize objects. Despite the name, `.as_json` is a Rails
   # method which converts objects to Ruby primitives (with the top-level being either an array or a
   # hash).
   class NativeModelSerializer < BaseSerializer
-    def initialize(model: nil, **kwargs)
+    class_attribute :config
+    class_attribute :singular_config
+    class_attribute :plural_config
+    class_attribute :action_config
+
+    def initialize(model: nil, many: nil, **kwargs)
       super(**kwargs)
-      @model = model || @controller.send(:get_model)
+      @many = many
+      @model = model || (@controller ? @controller.send(:get_model) : nil)
+    end
+
+    # Get controller action, if possible.
+    def get_action
+      return @controller&.action_name&.to_sym
+    end
+
+    # Get a locally defined configuration, if one is defined.
+    def get_local_serializer_config
+      action = self.get_action
+
+      if action && self.action_config
+        # index action should use :list serializer config if :index is not provided
+        action = :list if action == :index && !self.action_config.key?(:index)
+
+        return self.action_config[action] if self.action_config[action]
+      end
+
+      # no action_config, so try singular/plural config
+      return self.plural_config if @many && self.plural_config
+      return self.singular_config if !@many && self.singular_config
+
+      # lastly, try the default config
+      return self.config
     end
 
     # Get a configuration passable to `as_json` for the model.
-    def get_native_serializer_config
+    def get_serializer_config
+      # return a locally defined serializer config if one is defined
+      local_config = self.get_local_serializer_config
+      return local_config if local_config
+
       # return a serializer config if one is defined
       serializer_config = @controller.send(:get_native_serializer_config)
       return serializer_config if serializer_config
 
-      # build serializer config from fields
+      # otherwise, build a serializer config from fields
       fields = @controller.send(:get_fields)
       unless fields.blank?
         columns, methods = fields.partition { |f| f.to_s.in?(@model.column_names) }
@@ -38,10 +68,52 @@ module RESTFramework
       return {}
     end
 
+    # Recursive method for traversing a config and evaluating nested serializers.
+    def _resolve_serializer_config(node: nil)
+      # First base case: found a serializer, so evaluate it and return it.
+      if node.is_a?(Class) && (node < BaseSerializer)
+        return node.new(controller: @controller).get_resolved_serializer_config
+      end
+
+      # Second base case: found a serializer instance, so evaluate it and return it.
+      if node.is_a?(BaseSerializer)
+        return node.get_resolved_serializer_config
+      end
+
+      # Third base case: node is not iterable, so return it.
+      unless node.respond_to?(:each)
+        return node
+      end
+
+      # Recursive case: node is iterable, so iterate and recursively resolve serializers.
+      if node.is_a? Hash
+        node.each do |k,v|
+          node[k] = self._resolve_serializer_config(node: v)
+        end
+      else
+        node.map! do |v|
+          self._resolve_serializer_config(node: v)
+        end
+      end
+
+      return node
+    end
+
+    # Get a serializer config and resolve any nested serializers into configs.
+    def get_resolved_serializer_config
+      config = self.get_serializer_config
+
+      # traverse the config, resolving nested serializers
+      return _resolve_serializer_config(node: config)
+    end
+
     # Convert the object(s) to Ruby primitives.
     def serialize
       if @object
-        return @object.as_json(self.get_native_serializer_config)
+        @many = @object.respond_to?(:each) if @many.nil?
+        return @object.as_json(
+          self.get_resolved_serializer_config
+        )
       end
       return nil
     end

metadata

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