rest_framework 0.9.0 → 0.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e2e028b70ec7cad48ee82a18f8e7b68b6c5d2c3d79bf058ab9a9dfc9f1b428b6
-  data.tar.gz: 70f703c74d2e2d7228f0bf09c8510958a6860bf9a7cc2d7e6f586a8975e0374a
+  metadata.gz: b18de6060f0b8d4182b8bd7aac3edf3f6b8b2543892d205713f96a7cb3951b4e
+  data.tar.gz: 688299d1ee295d805745b365dfde9dc75c6d866855e94c4505513ff40ee214b8
 SHA512:
-  metadata.gz: 659e40f0cd59dfc249a3799baca4c9a6b0109302904d4874d998c4d656c1ffdd1e0d11f4e463d92cc9006bcb174b7fe72f61bc01e914ed57428616aa56e662bd
-  data.tar.gz: a172ab0072d67e52280f058ea38694ffd22d543697bcae1a73fc5fc9ec595101d606b4ff681e1f11ba27beca86d3376eda40907b95ae8bf213a6a86c2eb6e3ae
+  metadata.gz: f9767ad1b2714143b6746724e26f2a66846db38998d484472735cb21342c780c0ea396ca372b4a7f206597040a415a4097cbdc8a6a4d004aef41665b564e2549
+  data.tar.gz: c6230e7917d490d319905e9bbcd661a52005fcf697406ef36747479593d7884951d1a0655964f74b7edeaddc97ebf26769f7193dfa8fac95cf99b98667734628

data/VERSION

@@ -1 +1 @@
-0.9.0
+0.9.2

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

@@ -64,7 +64,7 @@
         <div>
           <h1 class="m-0"><%= (@header_text if defined? @header_text) || @title %></h1>
           <div style="float: right">
-            <% if @route_groups.values[0].any? { |r| r[:matches_path] && r[:verb] == "DELETE" } %>
+            <% if @route_groups.values[0].any? { |r| r[:matches_path] && r[:verb] == "DELETE" && r[:action] == "destroy" } %>
               <button type="button" class="btn btn-danger" onclick="rrfDelete(this)">DELETE</button>
             <% end %>
             <% if @route_groups.values[0].any? { |r| r[:matches_path] && r[:verb] == "OPTIONS" } %>
@@ -150,22 +150,28 @@
                   Routes
                 </a>
               </li>
-              <% @_rrf_form_routes = @route_groups.values[0].select { |r|
+              <% @_rrf_form_routes_raw = @route_groups.values[0].select { |r|
+                r[:matches_params] && (
+                  r[:verb].in?(["POST", "PUT", "PATCH"]) ||
+                  (r[:verb] == "DELETE" && r[:action] == "destroy_all")
+                )
+              } %>
+              <% @_rrf_form_routes_html = @route_groups.values[0].select { |r|
                 r[:matches_params] && r[:verb].in?(["POST", "PUT", "PATCH"])
               } %>
-              <% unless @_rrf_form_routes.empty? %>
+              <% if @_rrf_form_routes_raw.present? %>
                 <li class="nav-item">
-                  <a class="nav-link" href="#tab-raw-form" data-bs-toggle="tab" role="tab">
+                  <a class="nav-link" href="#tabRawForm" data-bs-toggle="tab" role="tab">
                     Raw Form
                   </a>
                 </li>
-                <% if @is_model_controller %>
-                  <li class="nav-item">
-                    <a class="nav-link" href="#tab-html-form" data-bs-toggle="tab" role="tab">
-                      HTML Form
-                    </a>
-                  </li>
-                <% end %>
+              <% end %>
+              <% if @_rrf_form_routes_html.present? && @is_model_controller %>
+                <li class="nav-item">
+                  <a class="nav-link" href="#tabHtmlForm" data-bs-toggle="tab" role="tab">
+                    HTML Form
+                  </a>
+                </li>
               <% end %>
             </ul>
           </div>
@@ -173,15 +179,15 @@
             <div class="tab-pane fade show active" id="tab-routes" role="tabpanel">
               <%= render partial: "rest_framework/routes" %>
             </div>
-            <% unless @_rrf_form_routes.empty? %>
-              <div class="tab-pane fade" id="tab-raw-form" role="tabpanel">
+            <% if @_rrf_form_routes_raw.present? %>
+              <div class="tab-pane fade" id="tabRawForm" role="tabpanel">
                 <%= render partial: "rest_framework/raw_form" %>
               </div>
-              <% if @is_model_controller %>
-                <div class="tab-pane fade" id="tab-html-form" role="tabpanel">
-                  <%= render partial: "rest_framework/html_form" %>
-                </div>
-              <% end %>
+            <% end %>
+            <% if @_rrf_form_routes_html.present? && @is_model_controller %>
+              <div class="tab-pane fade" id="tabHtmlForm" role="tabpanel">
+                <%= render partial: "rest_framework/html_form" %>
+              </div>
             <% end %>
           </div>
         </div>

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

@@ -303,6 +303,24 @@ document.addEventListener("DOMContentLoaded", (event) => {
       event.preventDefault()
     })
   })
+
+  // Check if `rawFilesFormWrapper` should be displayed when media type is changed.
+  const rawFormRouteSelect = document.getElementById("rawFormRoute")
+  const rawFormMediaTypeSelect = document.getElementById("rawFormMediaType")
+  const rawFilesFormWrapper = document.getElementById("rawFilesFormWrapper")
+  if (rawFilesFormWrapper) {
+    const rawFormFilesHandler = () => {
+      const selectedRouteOption = rawFormRouteSelect.options[rawFormRouteSelect.selectedIndex]
+      if (rawFormMediaTypeSelect.value === "multipart/form-data" && selectedRouteOption.dataset.supportsFiles) {
+        rawFilesFormWrapper.style.display = "block"
+      } else {
+        rawFilesFormWrapper.style.display = "none"
+      }
+    }
+
+    rawFormRouteSelect.addEventListener("change", rawFormFilesHandler)
+    rawFormMediaTypeSelect.addEventListener("change", rawFormFilesHandler)
+  }
 })
 
 // Convert plain-text links to anchor tag links.
@@ -391,17 +409,4 @@ function rrfAPICall(path, method, kwargs={}) {
     .then((response) => response.text())
     .then((body) => { rrfReplaceDocument(body) })
 }
-
-// Check if `rawFilesFormWrapper` should be displayed when media type is changed.
-function rrfCheckRawFilesFormDisplay(el) {
-  const rawFilesFormWrapper = document.getElementById("rawFilesFormWrapper")
-
-  if (rawFilesFormWrapper) {
-    if (el.value === "multipart/form-data") {
-      rawFilesFormWrapper.style.display = "block"
-    } else {
-      rawFilesFormWrapper.style.display = "none"
-    }
-  }
-}
 </script>

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

@@ -2,7 +2,7 @@
   <div class="mb-2">
     <label class="form-label w-100">Route
       <select class="form-control form-control-sm" id="htmlFormRoute">
-        <% @_rrf_form_routes.each do |route| %>
+        <% @_rrf_form_routes_html.each do |route| %>
           <% path = @route_props[:with_path_args].call(route[:route]) %>
           <option value="<%= route[:verb] %>:<%= path %>"><%= route[:verb] %> <%= route[:relative_path] %></option>
         <% end %>

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

@@ -2,9 +2,12 @@
   <div class="mb-2">
     <label class="form-label w-100">Route
       <select class="form-control form-control-sm" id="rawFormRoute">
-        <% @_rrf_form_routes.each do |route| %>
+        <% @_rrf_form_routes_raw.each do |route| %>
           <% path = @route_props[:with_path_args].call(route[:route]) %>
-          <option value="<%= route[:verb] %>:<%= path %>"><%= route[:verb] %> <%= route[:relative_path] %></option>
+          <option
+            value="<%= route[:verb] %>:<%= path %>"
+            data-supports-files="<%= !route[:action].in?(["update_all", "destroy", "destroy_all"]) ? "true" : "" %>"
+          ><%= route[:verb] %> <%= route[:relative_path] %></option>
         <% end %>
       </select>
     </label>
@@ -12,7 +15,7 @@
 
   <div class="mb-2">
     <label class="form-label w-100">Media Type
-      <select class="form-control form-control-sm" id="rawFormMediaType" onchange="rrfCheckRawFilesFormDisplay(this)">
+      <select class="form-control form-control-sm" id="rawFormMediaType">
         <% ["application/json", "application/x-www-form-urlencoded", "multipart/form-data"].each do |t| %>
           <option value="<%= t %>"><%= t %></option>
         <% end %>

data/lib/rest_framework/controller_mixins/bulk.rb

@@ -2,43 +2,31 @@ require_relative "models"
 
 # Mixin for creating records in bulk. This is unique compared to update/destroy because we overload
 # the existing `create` action to support bulk creation.
-# :nocov:
 module RESTFramework::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
+    return super.merge({bulk_create: true})
+  end
+
   def create
-    status, payload = self.create_all!
-    return api_response(payload, status: status)
+    if params[:_json].is_a?(Array)
+      records = self.create_all!
+      serialized_records = self.bulk_serialize(records)
+      return api_response(serialized_records)
+    end
+
+    return super
   end
 
-  # Perform the `create` or `insert_all` call and return the created records with any errors. The
-  # result should be of the form: `(status, payload)`, and `payload` should be of the form:
-  # `[{success:, record: | errors:}]`, unless batch mode is enabled, in which case `payload` is
-  # blank with a status of `202`.
+  # Perform the `create` call, and return the collection of (possibly) created records.
   def create_all!
-    if self.class.bulk_batch_mode
-      insert_from = if self.get_recordset.respond_to?(:insert_all) && self.create_from_recordset
-        # Create with any properties inherited from the recordset. We exclude any `select` clauses
-        # in case model callbacks need to call `count` on this collection, which typically raises a
-        # SQL `SyntaxError`.
-        self.get_recordset.except(:select)
-      else
-        # Otherwise, perform a "bare" insert_all.
-        self.class.get_model
-      end
+    create_data = self.get_create_params(bulk_mode: true)[:_json]
 
-      insert_from
-    end
-
-    # Perform bulk creation, possibly in a transaction.
-    self.class._rrf_bulk_transaction do
-      if self.get_recordset.respond_to?(:insert_all) && self.create_from_recordset
-        # Create with any properties inherited from the recordset. We exclude any `select` clauses
-        # in case model callbacks need to call `count` on this collection, which typically raises a
-        # SQL `SyntaxError`.
-        return self.get_recordset.except(:select).create!(self.get_create_params)
-      else
-        # Otherwise, perform a "bare" insert_all.
-        return self.class.get_model.insert_all(self.get_create_params)
-      end
+    # Perform bulk create in a transaction.
+    return ActiveRecord::Base.transaction do
+      next self.get_create_from.create(create_data)
     end
   end
 end
@@ -46,24 +34,52 @@ end
 # Mixin for updating records in bulk.
 module RESTFramework::BulkUpdateModelMixin
   def update_all
-    raise NotImplementedError, "TODO"
+    records = self.update_all!
+    serialized_records = self.bulk_serialize(records)
+    return api_response(serialized_records)
   end
 
-  # Perform the `update!` call and return the updated record.
+  # Perform the `update` call and return the collection of (possibly) updated records.
   def update_all!
-    raise NotImplementedError, "TODO"
+    pk = self.class.get_model.primary_key
+    update_data = if params[:_json].is_a?(Array)
+      self.get_create_params(bulk_mode: :update)[:_json].index_by { |r| r[pk] }
+    else
+      create_params = self.get_create_params
+      {create_params[pk] => create_params}
+    end
+
+    # Perform bulk update in a transaction.
+    return ActiveRecord::Base.transaction do
+      next self.get_recordset.update(update_data.keys, update_data.values)
+    end
   end
 end
 
 # Mixin for destroying records in bulk.
 module RESTFramework::BulkDestroyModelMixin
   def destroy_all
-    raise NotImplementedError, "TODO"
+    if params[:_json].is_a?(Array)
+      records = self.destroy_all!
+      serialized_records = self.bulk_serialize(records)
+      return api_response(serialized_records)
+    end
+
+    return api_response(
+      {message: "Bulk destroy requires an array of primary keys as input."},
+      status: 400,
+    )
   end
 
   # Perform the `destroy!` call and return the destroyed (and frozen) record.
   def destroy_all!
-    raise NotImplementedError, "TODO"
+    pk = self.class.get_model.primary_key
+    destroy_data = self.request.request_parameters[:_json]
+
+    # Perform bulk destroy in a transaction.
+    return ActiveRecord::Base.transaction do
+      next self.get_recordset.where(pk => destroy_data).destroy_all
+    end
   end
 end
 
@@ -79,4 +95,3 @@ module RESTFramework::BulkModelControllerMixin
     RESTFramework::ModelControllerMixin.included(base)
   end
 end
-# :nocov:

data/lib/rest_framework/controller_mixins/models.rb

@@ -66,14 +66,6 @@ module RESTFramework::BaseModelControllerMixin
 
     # Control if filtering is done before find.
     filter_recordset_before_find: true,
-
-    # Control if bulk operations are done in a transaction and rolled back on error, or if all bulk
-    # operations are attempted and errors simply returned in the response.
-    bulk_transactional: false,
-
-    # Control if bulk operations should be done in "batch" mode, using efficient queries, but also
-    # skipping model validations/callbacks.
-    bulk_batch_mode: false,
   }
 
   module ClassMethods
@@ -264,7 +256,7 @@ module RESTFramework::BaseModelControllerMixin
             foreign_key: ref.foreign_key,
             primary_key: pk,
             polymorphic: ref.polymorphic?,
-            table_name: ref.table_name,
+            table_name: ref.polymorphic? ? nil : ref.table_name,
             options: ref.options.as_json.presence,
           }.compact
         end
@@ -502,15 +494,22 @@ module RESTFramework::BaseModelControllerMixin
   end
 
   # Use strong parameters to filter the request body using the configured allowed parameters.
-  def get_body_params(data: nil)
-    data ||= request.request_parameters
-
-    # Filter the request body with strong params.
-    body_params = ActionController::Parameters.new(data).permit(*self.get_allowed_parameters)
+  def get_body_params(data: nil, bulk_mode: nil)
+    data ||= self.request.request_parameters
+    pk = self.class.get_model&.primary_key
+
+    # Filter the request body with strong params. If `bulk` is true, then we apply allowed
+    # parameters to the `_json` key of the request body.
+    body_params = if bulk_mode
+      pk = bulk_mode == :update ? [pk] : []
+      ActionController::Parameters.new(data).permit({_json: self.get_allowed_parameters + pk})
+    else
+      ActionController::Parameters.new(data).permit(*self.get_allowed_parameters)
+    end
 
     # Filter primary key if configured.
-    if self.class.filter_pk_from_request_body
-      body_params.delete(self.class.get_model&.primary_key)
+    if self.class.filter_pk_from_request_body && bulk_mode != :update
+      body_params.delete(pk)
     end
 
     # Filter fields in `exclude_body_fields`.
@@ -593,6 +592,7 @@ module RESTFramework::BaseModelControllerMixin
 
     recordset = self.get_recordset
     find_by_key = self.class.get_model.primary_key
+    is_pk = true
 
     # Find by another column if it's permitted.
     if find_by_param = self.class.find_by_query_param.presence
@@ -600,6 +600,7 @@ module RESTFramework::BaseModelControllerMixin
         find_by_fields = self.get_find_by_fields&.map(&:to_s)
 
         if !find_by_fields || find_by.in?(find_by_fields)
+          is_pk = false unless find_by_key == find_by
           find_by_key = find_by
         end
       end
@@ -611,18 +612,41 @@ module RESTFramework::BaseModelControllerMixin
     end
 
     # Return the record. Route key is always `:id` by Rails convention.
-    return @record = recordset.find_by!(find_by_key => request.path_parameters[:id])
+    if is_pk
+      return @record = recordset.find(request.path_parameters[:id])
+    else
+      return @record = recordset.find_by!(find_by_key => request.path_parameters[:id])
+    end
   end
 
-  # Create a transaction around the passed block, if configured. This is used primarily for bulk
-  # actions, but we include it here so it's always available.
-  def self._rrf_bulk_transaction(&block)
-    if self.bulk_transactional
-      ActiveRecord::Base.transaction(&block)
+  # Determine what collection to call `create` on.
+  def get_create_from
+    if self.class.create_from_recordset
+      # Create with any properties inherited from the recordset. We exclude any `select` clauses
+      # in case model callbacks need to call `count` on this collection, which typically raises a
+      # SQL `SyntaxError`.
+      self.get_recordset.except(:select)
     else
-      yield
+      # Otherwise, perform a "bare" insert_all.
+      self.class.get_model
     end
   end
+
+  # Serialize the records, but also include any errors that might exist. This is used for bulk
+  # actions, however we include it here so the helper is available everywhere.
+  def bulk_serialize(records)
+    # This is kinda slow, so perhaps we should eventually integrate `errors` serialization into
+    # the serializer directly. This would fail for active model serializers, but maybe we don't
+    # care?
+    serializer_class = self.get_serializer_class
+    serialized_records = records.map do |record|
+      serializer_class.new(record, controller: self).serialize.merge!(
+        {errors: record.errors.presence}.compact,
+      )
+    end
+
+    return serialized_records
+  end
 end
 
 # Mixin for listing records.
@@ -668,17 +692,7 @@ module RESTFramework::CreateModelMixin
 
   # Perform the `create!` call and return the created record.
   def create!
-    create_from = if self.create_from_recordset && self.get_recordset.respond_to?(:create!)
-      # Create with any properties inherited from the recordset. We exclude any `select` clauses in
-      # case model callbacks need to call `count` on this collection, which typically raises a SQL
-      # `SyntaxError`.
-      self.get_recordset.except(:select)
-    else
-      # Otherwise, perform a "bare" create.
-      self.class.get_model
-    end
-
-    return create_from.create!(self.get_create_params)
+    return self.get_create_from.create!(self.get_create_params)
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rest_framework
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.2
 platform: ruby
 authors:
 - Gregory N. Schmit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-06 00:00:00.000000000 Z
+date: 2023-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -94,7 +94,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
+rubygems_version: 3.4.10
 signing_key: 
 specification_version: 4
 summary: A framework for DRY RESTful APIs in Ruby on Rails.