RubyGems - rest_framework - Versions diffs - 0.9.15 → 0.10.0 - Mend

rest_framework 0.9.15 → 0.10.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (22) hide show

checksums.yaml +4 -4
data/VERSION +1 -1
data/app/views/layouts/rest_framework.html.erb +1 -2
data/app/views/rest_framework/_head.html.erb +3 -2
data/app/views/rest_framework/_heading.html.erb +1 -1
data/app/views/rest_framework/routes_and_forms/_html_form.html.erb +3 -3
data/app/views/rest_framework/routes_and_forms/_raw_form.html.erb +1 -1
data/lib/rest_framework/filters/base_filter.rb +1 -1
data/lib/rest_framework/filters/{model_ordering_filter.rb → ordering_filter.rb} +6 -3
data/lib/rest_framework/filters/{model_query_filter.rb → query_filter.rb} +10 -7
data/lib/rest_framework/filters/ransack_filter.rb +1 -1
data/lib/rest_framework/filters/{model_search_filter.rb → search_filter.rb} +6 -4
data/lib/rest_framework/filters.rb +3 -3
data/lib/rest_framework/mixins/base_controller_mixin.rb +42 -62
data/lib/rest_framework/mixins/bulk_model_controller_mixin.rb +1 -1
data/lib/rest_framework/mixins/model_controller_mixin.rb +117 -90
data/lib/rest_framework/serializers/native_serializer.rb +16 -5
data/lib/rest_framework/utils.rb +38 -18
data/lib/rest_framework.rb +16 -16
data/vendor/assets/javascripts/rest_framework/external.min.js +618 -575
data/vendor/assets/stylesheets/rest_framework/external.min.css +12 -19
metadata +8 -8

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 734af1c9a436fd842c36503794ef16b94e4b0d3f7ad91d011bcd12d06e4b1e21
-  data.tar.gz: d4c0140985a5405750cdd092c4a70b092be69b3523a3c088d2268711c38e5ad1
+  metadata.gz: 8a916afbf32cf43553b8aa952024011639f311ab80db53685163e607e48e1ad0
+  data.tar.gz: 1cc8aa7aed712a63b1ef9586c37b64a87de62fe5dfdcf659e982a1b77c20fd89
 SHA512:
-  metadata.gz: 4fc442c77a0c8543913ceacd7a7116f9e044ee1d9b0e3e08a5c58ddb6d00ee12b7f719c83e7aed233070075bb031aa8a90cabc7337bd57e28883aca4221d5ea6
-  data.tar.gz: 2f60ffddea13e956a3a0a0ec909d2de533cc0c5b350af75467f7e006b5133c982192cbcc28da7cb566803458c76917ae702f4838c3f0096722a94f5309babb7a
+  metadata.gz: bef1f7c3c52c7a42e8c307ccaf37e4e25f4e663359e26be433f20fd644fca0e59cd3b56613f965b084662046577576728981a320d1d5a5a6517d98556008fc99
+  data.tar.gz: '080f96e20b330a391b896db89a192e415328aa320f8d669260d8d282c0eee709022afa7fa5dd484449eb5bba85544f8974d24764a5e5b45821803d1ccd3c23f0'

data/VERSION CHANGED Viewed

	@@ -1 +1 @@
1	- 0.9.15
1	+ 0.10.0

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

@@ -3,11 +3,10 @@
   <head>
     <title><%= @title %></title>
-    <%# These dynamic tags cannot be cached, so include directly instead of in `head` partial. %>
     <%= csrf_meta_tags %>
     <%= csp_meta_tag rescue nil %>
-    <%= render partial: "rest_framework/head", cached: true %>
+    <%= render partial: "rest_framework/head" %>
     <%= yield :head %>
   </head>

data/app/views/rest_framework/_head.html.erb CHANGED Viewed

@@ -296,8 +296,9 @@
     document.write(content)
     document.close()
-    // Trigger `DOMContentLoaded` manually so our custom JavaScript works.
-    document.dispatchEvent(new Event("DOMContentLoaded", {bubbles: true, cancelable: true}))
+    // It seems that `DOMContentLoaded` is already triggered on `document.close()`.
+    // // Trigger `DOMContentLoaded` manually so our custom JavaScript works.
+    // // document.dispatchEvent(new Event("DOMContentLoaded", {bubbles: true, cancelable: true}))
   }
   // Refresh the window as a `GET` request.

data/app/views/rest_framework/_heading.html.erb CHANGED Viewed

@@ -3,7 +3,7 @@
     <%= render partial: "rest_framework/heading/actions" if @route_groups.present? %>
     <h1 style="margin: 0"><%= @heading_title || @title %></h1>
     <% if @description.present? %>
-      <br><br><p style="display: inline-block; margin-bottom: 0"><%= @description %></p>
+      <p style="display: inline-block; margin-bottom: 0; margin-top: 1em"><%= @description %></p>
     <% end %>
   </div>
 </div>

data/app/views/rest_framework/routes_and_forms/_html_form.html.erb CHANGED Viewed

@@ -26,14 +26,14 @@
       %>
       <div class="mb-2">
         <% if metadata[:kind] == "rich_text" %>
-          <label class="form-label w-100"><%= controller.class.get_label(f) %></label>
+          <label class="form-label w-100"><%= controller.class.label_for(f) %></label>
           <%= form.rich_text_area f %>
         <% elsif metadata[:kind] == "attachment" %>
-          <label class="form-label w-100"><%= controller.class.get_label(f) %>
+          <label class="form-label w-100"><%= controller.class.label_for(f) %>
             <%= form.file_field f, multiple: metadata.dig(:attachment, :macro) == :has_many_attached %>
           </label>
         <% else %>
-          <label class="form-label w-100"><%= controller.class.get_label(f) %>
+          <label class="form-label w-100"><%= controller.class.label_for(f) %>
             <%= form.text_field f, class: "form-control form-control-sm" %>
           </label>
         <% end %>

data/app/views/rest_framework/routes_and_forms/_raw_form.html.erb CHANGED Viewed

@@ -40,7 +40,7 @@
           local: true,
         }.compact) do |form| %>
           <% attachment_reflections.each do |field, ref| %>
-            <label class="form-label w-100"><%= controller.class.get_label(field) %>
+            <label class="form-label w-100"><%= controller.class.label_for(field) %>
               <%= form.file_field field, multiple: ref.macro == :has_many_attached %>
             </label>
           <% end %>

data/lib/rest_framework/filters/base_filter.rb CHANGED Viewed

@@ -3,7 +3,7 @@ class RESTFramework::Filters::BaseFilter
     @controller = controller
   end
-  def get_filtered_data(data)
+  def filter_data(data)
     raise NotImplementedError
   end
 end

data/lib/rest_framework/filters/{model_ordering_filter.rb → ordering_filter.rb} RENAMED Viewed

@@ -1,5 +1,5 @@
 # A filter backend which handles ordering of the recordset.
-class RESTFramework::Filters::ModelOrderingFilter < RESTFramework::Filters::BaseFilter
+class RESTFramework::Filters::OrderingFilter < RESTFramework::Filters::BaseFilter
   # Get a list of ordering fields for the current action.
   def _get_fields
     return @controller.ordering_fields&.map(&:to_s) || @controller.get_fields
@@ -38,7 +38,7 @@ class RESTFramework::Filters::ModelOrderingFilter < RESTFramework::Filters::Base
   end
   # Order data according to the request query parameters.
-  def get_filtered_data(data)
+  def filter_data(data)
     ordering = self._get_ordering
     reorder = !@controller.ordering_no_reorder
@@ -51,4 +51,7 @@ class RESTFramework::Filters::ModelOrderingFilter < RESTFramework::Filters::Base
 end
 # Alias for convenience.
-RESTFramework::ModelOrderingFilter = RESTFramework::Filters::ModelOrderingFilter
+RESTFramework::OrderingFilter = RESTFramework::Filters::OrderingFilter
+# TODO: Compatibility; remove in 1.0.
+RESTFramework::ModelOrderingFilter = RESTFramework::Filters::OrderingFilter

data/lib/rest_framework/filters/{model_query_filter.rb → query_filter.rb} RENAMED Viewed

@@ -1,14 +1,14 @@
 # A simple filtering backend that supports filtering a recordset based on query parameters.
-class RESTFramework::Filters::ModelQueryFilter < RESTFramework::Filters::BaseFilter
+class RESTFramework::Filters::QueryFilter < RESTFramework::Filters::BaseFilter
   NIL_VALUES = ["nil", "null"].freeze
-  # Get a list of filterset fields for the current action.
+  # Get a list of filter fields for the current action.
   def _get_fields
     # Always return a list of strings; `@controller.get_fields` already does this.
-    return @controller.class.filterset_fields&.map(&:to_s) || @controller.get_fields
+    return @controller.class.filter_fields&.map(&:to_s) || @controller.get_fields
   end
-  # Filter params for keys allowed by the current action's filterset_fields/fields config.
+  # Filter params for keys allowed by the current action's filter_fields/fields config.
   def _get_filter_params
     fields = self._get_fields
     includes = []
@@ -22,7 +22,7 @@ class RESTFramework::Filters::ModelQueryFilter < RESTFramework::Filters::BaseFil
         field, sub_field = match[1..2]
         next false unless field.in?(fields)
-        sub_fields = @controller.class.get_field_config(field)[:sub_fields] || []
+        sub_fields = @controller.class.field_config_for(field)[:sub_fields] || []
         if sub_field.in?(sub_fields)
           includes << field.to_sym
           next true
@@ -49,7 +49,7 @@ class RESTFramework::Filters::ModelQueryFilter < RESTFramework::Filters::BaseFil
   end
   # Filter data according to the request query parameters.
-  def get_filtered_data(data)
+  def filter_data(data)
     filter_params, includes = self._get_filter_params
     if filter_params.any?
@@ -65,4 +65,7 @@ class RESTFramework::Filters::ModelQueryFilter < RESTFramework::Filters::BaseFil
 end
 # Alias for convenience.
-RESTFramework::ModelQueryFilter = RESTFramework::Filters::ModelQueryFilter
+RESTFramework::QueryFilter = RESTFramework::Filters::QueryFilter
+# TODO: Compatibility; remove in 1.0.
+RESTFramework::ModelQueryFilter = RESTFramework::Filters::QueryFilter

data/lib/rest_framework/filters/ransack_filter.rb CHANGED Viewed

@@ -1,7 +1,7 @@
 # Adapter for the `ransack` gem.
 class RESTFramework::Filters::RansackFilter < RESTFramework::Filters::BaseFilter
   # Filter data according to the request query parameters.
-  def get_filtered_data(data)
+  def filter_data(data)
     q = @controller.request.query_parameters[@controller.ransack_query_param]
     if q.present?

data/lib/rest_framework/filters/{model_search_filter.rb → search_filter.rb} RENAMED Viewed

@@ -1,5 +1,4 @@
-# Multi-field text searching on models.
-class RESTFramework::Filters::ModelSearchFilter < RESTFramework::Filters::BaseFilter
+class RESTFramework::Filters::SearchFilter < RESTFramework::Filters::BaseFilter
   # Get a list of search fields for the current action.
   def _get_fields
     if search_fields = @controller.search_fields
@@ -13,7 +12,7 @@ class RESTFramework::Filters::ModelSearchFilter < RESTFramework::Filters::BaseFi
   end
   # Filter data according to the request query parameters.
-  def get_filtered_data(data)
+  def filter_data(data)
     search = @controller.request.query_parameters[@controller.search_query_param]
     if search.present?
@@ -41,4 +40,7 @@ class RESTFramework::Filters::ModelSearchFilter < RESTFramework::Filters::BaseFi
 end
 # Alias for convenience.
-RESTFramework::ModelSearchFilter = RESTFramework::Filters::ModelSearchFilter
+RESTFramework::SearchFilter = RESTFramework::Filters::SearchFilter
+# TODO: Compatibility; remove in 1.0.
+RESTFramework::ModelSearchFilter = RESTFramework::Filters::SearchFilter

data/lib/rest_framework/filters.rb CHANGED Viewed

@@ -3,7 +3,7 @@ end
 require_relative "filters/base_filter"
-require_relative "filters/model_ordering_filter"
-require_relative "filters/model_query_filter"
-require_relative "filters/model_search_filter"
+require_relative "filters/ordering_filter"
+require_relative "filters/query_filter"
 require_relative "filters/ransack_filter"
+require_relative "filters/search_filter"

data/lib/rest_framework/mixins/base_controller_mixin.rb CHANGED Viewed

@@ -1,6 +1,6 @@
 # This module provides the common functionality for any controller mixins, a `root` action, and
-# the ability to route arbitrary actions with `extra_actions`. This is also where `api_response`
-# is defined.
+# the ability to route arbitrary actions with `extra_actions`. This is also where `render_api` is
+# implemented.
 module RESTFramework::Mixins::BaseControllerMixin
   RRF_BASE_CONFIG = {
     extra_actions: nil,
@@ -11,9 +11,6 @@ module RESTFramework::Mixins::BaseControllerMixin
     title: nil,
     description: nil,
     inflect_acronyms: ["ID", "IDs", "REST", "API", "APIs"].freeze,
-  }
-  RRF_BASE_INSTANCE_CONFIG = {
-    filter_backends: nil,
     # Options related to serialization.
     rescue_unknown_format_with: :json,
@@ -21,6 +18,11 @@ module RESTFramework::Mixins::BaseControllerMixin
     serialize_to_json: true,
     serialize_to_xml: true,
+    # Custom integrations (reduces serializer performance due to method calls).
+    enable_action_text: false,
+    enable_active_storage: false,
+  }
+  RRF_BASE_INSTANCE_CONFIG = {
     # Options related to pagination.
     paginator_class: nil,
     page_size: 20,
@@ -35,12 +37,12 @@ module RESTFramework::Mixins::BaseControllerMixin
   # Default action for API root.
   def root
-    api_response({message: "This is the API root."})
+    render_api({message: "This is the API root."})
   end
   module ClassMethods
-    # Get the title of this controller. By default, this is the name of the controller class,
-    # titleized and with any custom inflection acronyms applied.
+    # By default, this is the name of the controller class, titleized and with any custom inflection
+    # acronyms applied.
     def get_title
       return self.title || RESTFramework::Utils.inflect(
         self.name.demodulize.chomp("Controller").titleize(keep_id_suffix: true),
@@ -49,7 +51,7 @@ module RESTFramework::Mixins::BaseControllerMixin
     end
     # Get a label from a field/column name, titleized and inflected.
-    def get_label(s)
+    def label_for(s)
       return RESTFramework::Utils.inflect(
         s.to_s.titleize(keep_id_suffix: true),
         self.inflect_acronyms,
@@ -57,7 +59,7 @@ module RESTFramework::Mixins::BaseControllerMixin
     end
     # Collect actions (including extra actions) metadata for this controller.
-    def get_actions_metadata
+    def actions_metadata
       actions = {}
       # Start with builtin actions.
@@ -67,7 +69,7 @@ module RESTFramework::Mixins::BaseControllerMixin
         next unless self.method_defined?(action)
         actions[action] = {
-          path: "", methods: methods, type: :builtin, metadata: {label: self.get_label(action)}
+          path: "", methods: methods, type: :builtin, metadata: {label: self.label_for(action)}
         }
       end
@@ -76,7 +78,7 @@ module RESTFramework::Mixins::BaseControllerMixin
         next unless self.method_defined?(action)
         actions[action] = {
-          path: "", methods: methods, type: :builtin, metadata: {label: self.get_label(action)}
+          path: "", methods: methods, type: :builtin, metadata: {label: self.label_for(action)}
         }
       end
@@ -89,7 +91,7 @@ module RESTFramework::Mixins::BaseControllerMixin
     end
     # Collect member actions (including extra member actions) metadata for this controller.
-    def get_member_actions_metadata
+    def member_actions_metadata
       actions = {}
       # Start with builtin actions.
@@ -97,7 +99,7 @@ module RESTFramework::Mixins::BaseControllerMixin
         next unless self.method_defined?(action)
         actions[action] = {
-          path: "", methods: methods, type: :builtin, metadata: {label: self.get_label(action)}
+          path: "", methods: methods, type: :builtin, metadata: {label: self.label_for(action)}
         }
       end
@@ -109,8 +111,7 @@ module RESTFramework::Mixins::BaseControllerMixin
       return actions
     end
-    # Get a hash of metadata to be rendered in the `OPTIONS` response. Cache the result.
-    def get_options_metadata
+    def options_metadata
       return {
         title: self.get_title,
         description: self.description,
@@ -119,8 +120,8 @@ module RESTFramework::Mixins::BaseControllerMixin
           self.serialize_to_json ? "application/json" : nil,
           self.serialize_to_xml ? "application/xml" : nil,
         ].compact,
-        actions: self.get_actions_metadata,
-        member_actions: self.get_member_actions_metadata,
+        actions: self.actions_metadata,
+        member_actions: self.member_actions_metadata,
       }.compact
     end
@@ -203,47 +204,24 @@ module RESTFramework::Mixins::BaseControllerMixin
     end
   end
-  # Get the configured serializer class.
-  def get_serializer_class
-    return nil unless serializer_class = self.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)
+  def serializer_class
+    # TODO: Compatibility; remove in 1.0.
+    if klass = self.try(:get_serializer_class)
+      return klass
     end
-    return serializer_class
+    return self.class.serializer_class
   end
   # Serialize the given data using the `serializer_class`.
   def serialize(data, **kwargs)
-    return self.get_serializer_class.new(data, controller: self, **kwargs).serialize
+    return RESTFramework::Utils.wrap_ams(self.serializer_class).new(
+      data, controller: self, **kwargs
+    ).serialize
   end
-  # Get filtering backends, defaulting to no backends.
-  def get_filter_backends
-    return self.filter_backends || []
-  end
-  # Filter an arbitrary data set over all configured filter backends.
-  def get_filtered_data(data)
-    # Apply each filter sequentially.
-    self.get_filter_backends.each do |filter_class|
-      filter = filter_class.new(controller: self)
-      data = filter.get_filtered_data(data)
-    end
-    return data
-  end
-  def get_options_metadata
-    return self.class.get_options_metadata
+  def options_metadata
+    return self.class.options_metadata
   end
   def rrf_error_handler(e)
@@ -295,25 +273,25 @@ module RESTFramework::Mixins::BaseControllerMixin
     begin
       respond_to do |format|
         if payload == ""
-          format.json { head(kwargs[:status] || :no_content) } if self.serialize_to_json
-          format.xml { head(kwargs[:status] || :no_content) } if self.serialize_to_xml
+          format.json { head(kwargs[:status] || :no_content) } if self.class.serialize_to_json
+          format.xml { head(kwargs[:status] || :no_content) } if self.class.serialize_to_xml
         else
           format.json {
             render(json: payload, **kwargs.merge(json_kwargs))
-          } if self.serialize_to_json
+          } if self.class.serialize_to_json
           format.xml {
             render(xml: payload, **kwargs.merge(xml_kwargs))
-          } if self.serialize_to_xml
+          } if self.class.serialize_to_xml
           # TODO: possibly support more formats here if supported?
         end
         format.html {
           @payload = payload
           if payload == ""
-            @json_payload = "" if self.serialize_to_json
-            @xml_payload = "" if self.serialize_to_xml
+            @json_payload = "" if self.class.serialize_to_json
+            @xml_payload = "" if self.class.serialize_to_xml
           else
-            @json_payload = payload.to_json if self.serialize_to_json
-            @xml_payload = payload.to_xml if self.serialize_to_xml
+            @json_payload = payload.to_json if self.class.serialize_to_json
+            @xml_payload = payload.to_xml if self.class.serialize_to_xml
           end
           @title ||= self.class.get_title
           @description ||= self.class.description
@@ -329,7 +307,7 @@ module RESTFramework::Mixins::BaseControllerMixin
         }
       end
     rescue ActionController::UnknownFormat
-      if !already_rescued_unknown_format && rescue_format = self.rescue_unknown_format_with
+      if !already_rescued_unknown_format && rescue_format = self.class.rescue_unknown_format_with
         request.format = rescue_format
         already_rescued_unknown_format = true
         retry
@@ -339,9 +317,11 @@ module RESTFramework::Mixins::BaseControllerMixin
     end
   end
-  # Provide a generic `OPTIONS` response with metadata such as available actions.
+  # TODO: Might make this the default render method in the future.
+  alias_method :render_api, :api_response
   def options
-    return api_response(self.get_options_metadata)
+    return api_response(self.options_metadata)
   end
 end

data/lib/rest_framework/mixins/bulk_model_controller_mixin.rb CHANGED Viewed

@@ -6,7 +6,7 @@ module RESTFramework::Mixins::BulkCreateModelMixin
   # While bulk update/destroy are obvious because they create new router endpoints, bulk create
   # overloads the existing collection `POST` endpoint, so we add a special key to the options
   # metadata to indicate bulk create is supported.
-  def get_options_metadata
+  def options_metadata
     return super.merge({bulk_create: true})
   end