RubyGems - rest_framework - Versions diffs - 0.9.14 → 0.9.16 - Mend

rest_framework 0.9.14 → 0.9.16

Files changed (22) hide show

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f0a39ff15a5a6714fb7dc52f11e7db3cebe918805a44b0a8486567debebcefac
-  data.tar.gz: 5e2e530f249b567c64bb0d527875b291180052b07d61919bbbf76ae3f5ad7b1b
+  metadata.gz: 59084182eeedcec7d3f1a1a913a99e55a6139bb394e4c712744c5d80778db800
+  data.tar.gz: 552ea8a39833dc6a3ec4c689f120ba549af0db49a3fafa29d63cd4cb17d85a85
 SHA512:
-  metadata.gz: c15b1d0904dc34e2cbc095628b5d642213c0d33b6387e52b38660cf78b6552bc32818dca5ecbc5de710502139c7308fffb67a0a2aa3049749833c5e64a6757b5
-  data.tar.gz: 5656754554aa3bb4acc7ee333b72f21ea848d3e3cc8c06acf9e16d3529b427acfec9e00b3bac3ae67536b39608640146bcaab1459db77a7c6c46e6545e72dbae
+  metadata.gz: cffd1cde2cbf956d46344018c137b723397118f3aa4ea16c2d9abf5c9d9694c8a78d8f706f96e28c637ec4f58d692553da372a832a0bd44cc58154134b733d33
+  data.tar.gz: 1eea97e45fc0f4c47edbdb04a8de05fe6e383e259ea1d3ff48196b6601aeb87341aa6750f8eb4411dd0e16934452c5a02b2d26877a9ec8382ae538312f305603

data/VERSION CHANGED Viewed

	@@ -1 +1 @@
1	- 0.9.14
1	+ 0.9.16

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,16 +11,14 @@ 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,
     serializer_class: nil,
     serialize_to_json: true,
     serialize_to_xml: true,
+  }
+  RRF_BASE_INSTANCE_CONFIG = {
     # Options related to pagination.
     paginator_class: nil,
     page_size: 20,
@@ -35,12 +33,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 +47,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 +55,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 +65,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 +74,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 +87,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 +95,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 +107,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 +116,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 +200,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 +269,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 +303,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 +313,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