rest_framework 0.6.5 → 0.6.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68ebf30c14f9f70796c6963505e7b45421ee838d076784073505feb9b05c3ddb
-  data.tar.gz: 71918c4b2b2eeaed10833d84cb54f6bbb860ea3205895bc75abf9a543d0bedc9
+  metadata.gz: 88e17bbb8855d22fd7f73d637059d35bd12cc3fc9d982fbde73e11097b66af17
+  data.tar.gz: 8fe97e8557a9c957b3a31b51b89c4a7623e97c2fbc75c9c8b80bb23b54dc8429
 SHA512:
-  metadata.gz: d909e86567107d2565a65e9c99f67b771e462a2bd9dae04289c9846cc0ba68bfe3728b63d1b8a154c532e7a5cb1aeac1f593401a98bbc0b1f405f474aabb8527
-  data.tar.gz: abe06a65bb999c4926e6a54295afc4c55e254fba1276b0257eb2af765bbc3f367fe5ebc5d9fe1d6181c45157369440de13a7f4aed331a49271426d2468110a99
+  metadata.gz: 5362740a21ef0ef6248c36783da74ff5ad0b142ea9d2de7e228d5052d9badc7af3f78e259dba1015112c04379fd17c16265b0843c26cc2654e89a1742f53e051
+  data.tar.gz: 61d6ac5dca5113be086b9e3232e1e7c2e3fa26d45634764993c474cffcc62403f5285b9da0ebdcfd69b4dbe0b9fedaaa5f9d30d2366286a71c458fdbc9fe4ef7

data/README.md

@@ -0,0 +1 @@
+docs/index.md

data/VERSION

@@ -1 +1 @@
-0.6.5
+0.6.6

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

@@ -19,22 +19,70 @@
     <div class="container py-3">
       <div class="container">
         <div class="row">
-          <h1><%= (@header_text if defined? @header_text) || @title %></h1>
+          <nav>
+            <ol class="breadcrumb">
+              <%
+                breadcrumbs = request.path.split("/").inject([["/", "(root)"]]) { |breadcrumbs, part|
+                  # Ignore blank parts of the path (leading slash or double-slashes).
+                  next breadcrumbs if part.blank?
+
+                  last_path = breadcrumbs[-1][0]
+                  breadcrumbs << [
+                    [last_path, part].join(last_path[-1] == "/" ? "" : "/"),
+                    part,
+                  ]
+                  breadcrumbs
+                }
+              %>
+              <% breadcrumbs.each_with_index do |(path, label), i| %>
+                <% if i != breadcrumbs.size - 1 %>
+                  <li class="breadcrumb-item"><a href="<%= path %>"><%= label %></a></li>
+                <% else %>
+                  <li class="breadcrumb-item active"><%= label %></li>
+                <% end %>
+              <% end %>
+            </ol>
+          </nav>
+        </div>
+        <div class="row">
+          <div>
+            <h1><%= (@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" } %>
+                <button type="button" class="btn btn-danger" onclick="rrfDelete(this)">DELETE</button>
+              <% end %>
+              <button type="button" class="btn btn-primary" onclick="rrfRefresh(this)">GET</button>
+            </div>
+          </div>
         </div>
         <hr/>
-        <% if @json_payload || @xml_payload %>
+        <div class="row">
+          <div>
+            <pre style="white-space: normal">
+              <code class="language-plaintext">
+                <strong><%= request.method %></strong> <%= request.path %><br>
+              </code>
+            </pre>
+            <pre style="white-space: normal">
+              <code class="language-plaintext">
+                <strong>HTTP <%= response.status %> <%= response.message %></strong><br>
+                <strong>Content-Type:</strong> <%= response.content_type %>
+              </code>
+            </pre>
+          </div>
+        </div>
+        <% if @json_payload.present? || @xml_payload.present? %>
           <div class="row">
-            <h2>Payload</h2>
             <div class="w-100">
               <ul class="nav nav-tabs">
-                <% if @json_payload %>
+                <% if @json_payload.present? %>
                   <li class="nav-item">
                     <a class="nav-link active" href="#tab-json" data-bs-toggle="tab" role="tab">
                       .json
                     </a>
                   </li>
                 <% end %>
-                <% if @xml_payload %>
+                <% if @xml_payload.present? %>
                   <li class="nav-item">
                     <a class="nav-link" href="#tab-xml" data-bs-toggle="tab" role="tab">
                       .xml
@@ -45,22 +93,51 @@
             </div>
             <div class="tab-content w-100 pt-3">
               <div class="tab-pane fade show active" id="tab-json" role="tab">
-                <% if @json_payload %>
-                  <div><pre><code class="language-json"><%= JSON.pretty_generate(JSON.parse(@json_payload)) unless @json_payload == '' %></code></pre></div>
+                <% if @json_payload.present? %>
+                  <div>
+                    <pre class="rrf-copy"><code class="language-json"><%= JSON.pretty_generate(JSON.parse(@json_payload)) unless @json_payload == '' %></code></pre>
+                  </div>
                 <% end %>
               </div>
               <div class="tab-pane fade" id="tab-xml" role="tab">
-                <% if @xml_payload %>
-                  <div><pre><code class="language-xml"><%= @xml_payload %></code></pre></div>
+                <% if @xml_payload.present? %>
+                  <div><pre class="rrf-copy"><code class="language-xml"><%= @xml_payload %></code></pre></div>
                 <% end %>
               </div>
             </div>
           </div>
         <% end %>
-        <% unless @route_groups.blank? %>
+        <% if @route_groups.present? %>
           <div class="row">
-            <h2>Routes</h2>
-            <%= render partial: 'rest_framework/routes' %>
+            <div class="w-100">
+              <ul class="nav nav-tabs">
+                <li class="nav-item">
+                  <a class="nav-link active" href="#tab-routes" data-bs-toggle="tab" role="tab">
+                    Routes
+                  </a>
+                </li>
+                <% raw_form_routes = @route_groups.values[0].select { |r|
+                  r[:matches_params] && r[:verb].in?(["POST", "PUT", "PATCH"])
+                } %>
+                <% unless raw_form_routes.empty? %>
+                  <li class="nav-item">
+                    <a class="nav-link" href="#tab-raw-form" data-bs-toggle="tab" role="tab">
+                      Raw Form
+                    </a>
+                  </li>
+                <% end %>
+              </ul>
+            </div>
+            <div class="tab-content w-100 pt-3">
+              <div class="tab-pane fade show active" id="tab-routes" role="tab">
+                <%= render partial: 'rest_framework/routes' %>
+              </div>
+              <% unless raw_form_routes.empty? %>
+                <div class="tab-pane fade" id="tab-raw-form" role="tab">
+                  <%= render partial: 'rest_framework/raw_form', locals: {raw_form_routes: raw_form_routes} %>
+                </div>
+              <% end %>
+            </div>
           </div>
         <% end %>
       </div>

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

@@ -6,36 +6,135 @@
 <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap@5.1.1/dist/css/bootstrap.min.css" integrity="sha384-F3w7mX95PdgyTmZZMECAngseQB83DfGTowi0iMjiWaeVhAn4FJkqJByhZMI3AhiU" crossorigin="anonymous">
 <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.2.0/styles/vs.min.css" integrity="sha512-aWjgJTbdG4imzxTxistV5TVNffcYGtIQQm2NBNahV6LmX14Xq9WwZTL1wPjaSglUuVzYgwrq+0EuI4+vKvQHHw==" crossorigin="anonymous">
 <style>
-  /* Adjust headers to always take up their entire row, and tweak the sizing. */
-  h1,h2,h3,h4,h5,h6 { width: 100%; font-weight: normal; }
-  h1 { font-size: 2rem; }
-  h2 { font-size: 1.7rem; }
-  h3 { font-size: 1.5rem; }
-  h4 { font-size: 1.3rem; }
-  h5 { font-size: 1.1rem; }
-  h6 { font-size: 1rem; }
-
-  /* Make route group expansion obvious to the user. */
-  .rrf-routes .rrf-route-group-header {
-    background-color: #f8f8f8;
-  }
-  .rrf-routes .rrf-route-group-header:hover {
-    background-color: #f0f0f0;
-  }
-  .rrf-routes .rrf-route-group-header td {
-    cursor: pointer;
-  }
+/* Adjust headers to always take up their entire row, and tweak the sizing. */
+h1,h2,h3,h4,h5,h6 { display: inline-block; font-weight: normal; margin-bottom: 0; }
+h1 { font-size: 2rem; }
+h2 { font-size: 1.7rem; }
+h3 { font-size: 1.5rem; }
+h4 { font-size: 1.3rem; }
+h5 { font-size: 1.1rem; }
+h6 { font-size: 1rem; }
 
-  /* Disable bootstrap's collapsing animation because in tables it causes delayed jerkiness. */
-  .rrf-routes .collapsing {
-    -webkit-transition: none;
-    transition: none;
-    display: none;
-  }
+/* Make code and code blocks a little nicer looking. */
+code {
+  padding: 0 .35em;
+  background-color: #eee !important;
+  border: 1px solid #aaa;
+  border-radius: 3px;
+}
+
+/* Make route group expansion obvious to the user. */
+.rrf-routes .rrf-route-group-header {
+  background-color: #f8f8f8;
+}
+.rrf-routes .rrf-route-group-header:hover {
+  background-color: #f0f0f0;
+}
+.rrf-routes .rrf-route-group-header td {
+  cursor: pointer;
+}
+
+/* Disable bootstrap's collapsing animation because in tables it causes delayed jerkiness. */
+.rrf-routes .collapsing {
+  -webkit-transition: none;
+  transition: none;
+  display: none;
+}
+
+/* Copy-to-clipboard styles. */
+.rrf-copy {
+  position: relative;
+}
+.rrf-copy .rrf-copy-link {
+  position: absolute;
+  top: .5em;
+  right: .5em;
+  transition: 0.3s ease;
+}
+.rrf-copy .rrf-copy-link.rrf-clicked{
+  color: green;
+}
 </style>
 
 <script src="https://cdn.jsdelivr.net/npm/bootstrap@5.1.1/dist/js/bootstrap.bundle.min.js" integrity="sha384-/bQdsTh/da6pkI1MST/rWKFNjaCP5gBSY4sEBT38Q/9RBh9AH40zEOg7Hlq2THRZ" crossorigin="anonymous"></script>
 <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.2.0/highlight.min.js" integrity="sha512-TDKKr+IvoqZnPzc3l35hdjpHD0m+b2EC2SrLEgKDRWpxf2rFCxemkgvJ5kfU48ip+Y+m2XVKyOCD85ybtlZDmw==" crossorigin="anonymous"></script>
 <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.2.0/languages/json.min.js" integrity="sha512-FoN8JE+WWCdIGXAIT8KQXwpiavz0Mvjtfk7Rku3MDUNO0BDCiRMXAsSX+e+COFyZTcDb9HDgP+pM2RX12d4j+A==" crossorigin="anonymous"></script>
 <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.2.0/languages/xml.min.js" integrity="sha512-dICltIgnUP+QSJrnYGCV8943p3qSDgvcg2NU4W8IcOZP4tdrvxlXjbhIznhtVQEcXow0mOjLM0Q6/NvZsmUH4g==" crossorigin="anonymous"></script>
-<script>hljs.initHighlightingOnLoad();</script>
+<script>hljs.initHighlightingOnLoad()</script>
+<script>
+// Helper to replace the document when doing form submission (mainly to support PUT/PATCH/DELETE).
+function rrfReplaceDocument(content) {
+  // Replace the document with provided content.
+  document.open()
+  document.write(content)
+  document.close()
+
+  // Trigger `DOMContentLoaded` manually so our custom JavaScript works.
+  document.dispatchEvent(new Event("DOMContentLoaded", {bubbles: true, cancelable: true}))
+}
+
+// Helper to copy the element's next `<code>` sibling's content to the clipboard.
+function rrfCopyToClipboard(element) {
+  let range = document.createRange()
+  range.selectNode(element.nextSibling)
+  window.getSelection().removeAllRanges()
+  window.getSelection().addRange(range)
+  if (document.execCommand("copy")) {
+    // Trigger clicked animation.
+    element.classList.add("rrf-clicked")
+    element.innerText = "Copied!"
+    setTimeout(() => {
+      element.classList.remove("rrf-clicked")
+      element.innerText = "Copy to Clipboard"
+    }, 700)
+  }
+
+  // Return false to prevent normal link behavior.
+  return false
+}
+
+// Insert copy link and callback to copy contents of `<code>` element.
+document.addEventListener("DOMContentLoaded", (event) => {
+  [...document.getElementsByClassName("rrf-copy")].forEach((element, index) => {
+    element.insertAdjacentHTML(
+      "afterbegin",
+      "<a class=\"rrf-copy-link\" onclick=\"return rrfCopyToClipboard(this)\" href=\"#\">Copy to Clipboard</a>",
+    )
+  })
+})
+
+// Helper to refresh the window.
+function rrfRefresh(button) {
+  button.disabled = true
+  window.location.reload()
+}
+
+// Helper to call `DELETE` on the current path.
+function rrfDelete(button) {
+  button.disabled = true
+  rrfAPICall(window.location.pathname, "DELETE")
+}
+
+// Helper to submit the raw form.
+function rrfSubmitRawForm(button) {
+  button.disabled = true
+
+  // Grab the selected route/method, media type, and the body.
+  const [method, path] = document.getElementById("rawFormRoute").value.split(":")
+  const media_type = document.getElementById("rawFormMediaType").value
+  const body = document.getElementById("rawFormContent").value
+
+  // Perform the API call.
+  rrfAPICall(path, method, {body, headers: {"Content-Type": media_type}})
+}
+
+// Helper to make an HTML API call and replace the document with the response.
+function rrfAPICall(path, method, kwargs={}) {
+  const headers = kwargs.headers || {}
+  delete kwargs.headers
+
+  fetch(path, {method, headers: {"Accept": "text/html", ...headers}, ...kwargs})
+    .then((response) => response.text())
+    .then((body) => { rrfReplaceDocument(body) })
+}
+</script>

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

@@ -0,0 +1,30 @@
+<div style="max-width: 60em; margin: auto">
+  <div class="mb-2">
+    <label class="form-label w-100">Route
+      <select class="form-control" id="rawFormRoute">
+        <% raw_form_routes.each do |route| %>
+          <% path = @route_props[:with_path_args].call(route[:route]) %>
+          <option value="<%= route[:verb] %>:<%= path %>"><%= route[:verb] %> <%= route[:relative_path] %></option>
+        <% end %>
+      </select>
+    </label>
+  </div>
+
+  <div class="mb-2">
+    <label class="form-label w-100">Media Type
+      <select class="form-control" id="rawFormMediaType">
+        <% ["application/json", "application/x-www-form-urlencoded", "multipart/form-data"].each do |t| %>
+          <option value="<%= t %>"><%= t %></option>
+        <% end %>
+      </select>
+    </label>
+  </div>
+
+  <div class="mb-2">
+    <label class="form-label w-100">Content
+      <textarea class="form-control" style="font-family: monospace" id="rawFormContent" rows="8" cols="60"></textarea>
+    </label>
+  </div>
+
+  <button type="button" class="btn btn-primary" style="float: right" onclick="rrfSubmitRawForm(this)">Submit</button>
+</div>

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

@@ -1,7 +1,7 @@
 <tr>
   <td>
-    <% if route[:route].name && link_args = route[:show_link_args] %>
-      <%= link_to route[:relative_path], self.send("#{route[:route].name}_path", *link_args) %>
+    <% if route[:route].name && route[:verb] == "GET" && route[:matches_params] %>
+      <%= link_to route[:relative_path], @route_props[:with_path_args].call(route[:route]) %>
     <% else %>
       <%= route[:relative_path] %>
     <% end %>

data/lib/rest_framework/controller_mixins/base.rb

@@ -104,6 +104,11 @@ module RESTFramework::BaseControllerMixin
     return serializer_class
   end
 
+  # Helper to serialize data using the `serializer_class`.
+  def serialize(data, **kwargs)
+    return self.get_serializer_class.new(data, controller: self, **kwargs).serialize
+  end
+
   # Helper to get filtering backends, defaulting to no backends.
   def get_filter_backends
     return self.class.filter_backends || []
@@ -148,11 +153,6 @@ 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
@@ -161,14 +161,24 @@ module RESTFramework::BaseControllerMixin
       raise RESTFramework::NilPassedToAPIResponseError
     end
 
+    # If `payload` is an `ActiveRecord::Relation` or `ActiveRecord::Base`, then serialize it.
+    if payload.is_a?(ActiveRecord::Base) || payload.is_a?(ActiveRecord::Relation)
+      payload = self.serialize(payload)
+    end
+
+    # Do not use any adapters by default, if configured.
+    if self.class.disable_adapters_by_default && !kwargs.key?(:adapter)
+      kwargs[:adapter] = nil
+    end
+
     # Flag to track if we had to rescue unknown format.
     already_rescued_unknown_format = false
 
     begin
       respond_to do |format|
         if payload == ""
-          format.json { head(:no_content) } if self.class.serialize_to_json
-          format.xml { head(:no_content) } if self.class.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 {
             jkwargs = kwargs.merge(json_kwargs)
@@ -191,11 +201,13 @@ module RESTFramework::BaseControllerMixin
           end
           @template_logo_text ||= "Rails REST Framework"
           @title ||= self.controller_name.camelize
-          @route_groups ||= RESTFramework::Utils.get_routes(Rails.application.routes, request)
+          @route_props, @route_groups = RESTFramework::Utils.get_routes(
+            Rails.application.routes, request
+          )
           hkwargs = kwargs.merge(html_kwargs)
           begin
             render(**hkwargs)
-          rescue ActionView::MissingTemplate  # fallback to rest_framework layout
+          rescue ActionView::MissingTemplate  # Fallback to `rest_framework` layout.
             hkwargs[:layout] = "rest_framework"
             hkwargs[:html] = ""
             render(**hkwargs)

data/lib/rest_framework/controller_mixins/models.rb

@@ -114,11 +114,6 @@ module RESTFramework::BaseModelControllerMixin
     return super || RESTFramework::NativeSerializer
   end
 
-  # Helper to serialize data using the `serializer_class`.
-  def serialize(data, **kwargs)
-    return self.get_serializer_class.new(data, controller: self, **kwargs).serialize
-  end
-
   # Helper to get filtering backends, defaulting to using `ModelFilter` and `ModelOrderingFilter`.
   def get_filter_backends
     return self.class.filter_backends || [
@@ -128,35 +123,33 @@ module RESTFramework::BaseModelControllerMixin
 
   # Filter the request body for keys in current action's allowed_parameters/fields config.
   def get_body_params
-    return @_get_body_params ||= begin
-      # Filter the request body and map to strings. Return all params if we cannot resolve a list of
-      # allowed parameters or fields.
-      body_params = if allowed_params = self.get_allowed_parameters&.map(&:to_s)
-        request.request_parameters.select { |p| allowed_params.include?(p) }
-      else
-        request.request_parameters
-      end
+    # Filter the request body and map to strings. Return all params if we cannot resolve a list of
+    # allowed parameters or fields.
+    body_params = if allowed_params = self.get_allowed_parameters&.map(&:to_s)
+      request.request_parameters.select { |p| allowed_params.include?(p) }
+    else
+      request.request_parameters
+    end
 
-      # Add query params in place of missing body params, if configured. If fields are not defined,
-      # fallback to using columns for this particular feature.
-      if self.class.accept_generic_params_as_body_params
-        (self.get_fields(fallback: true) - body_params.keys).each do |k|
-          if (value = params[k])
-            body_params[k] = value
-          end
+    # Add query params in place of missing body params, if configured. If fields are not defined,
+    # fallback to using columns for this particular feature.
+    if self.class.accept_generic_params_as_body_params
+      (self.get_fields(fallback: true) - body_params.keys).each do |k|
+        if (value = params[k])
+          body_params[k] = value
         end
       end
+    end
 
-      # Filter primary key if configured.
-      if self.class.filter_pk_from_request_body
-        body_params.delete(self.get_model&.primary_key)
-      end
+    # Filter primary key if configured.
+    if self.class.filter_pk_from_request_body
+      body_params.delete(self.get_model&.primary_key)
+    end
 
-      # Filter fields in exclude_body_fields.
-      (self.class.exclude_body_fields || []).each { |f| body_params.delete(f) }
+    # Filter fields in exclude_body_fields.
+    (self.class.exclude_body_fields || []).each { |f| body_params.delete(f) }
 
-      body_params
-    end
+    return body_params
   end
   alias_method :get_create_params, :get_body_params
   alias_method :get_update_params, :get_body_params
@@ -182,9 +175,10 @@ module RESTFramework::BaseModelControllerMixin
     return nil
   end
 
-  # Get the set of records this controller has access to.
+  # Get the set of records this controller has access to. The return value is cached and exposed to
+  # the view as the `@recordset` instance variable.
   def get_recordset
-    return @recordset if instance_variable_defined?(:@recordset) && @recordset
+    return @recordset if instance_variable_defined?(:@recordset)
     return (@recordset = self.class.recordset) if self.class.recordset
 
     # If there is a model, return that model's default scope (all records by default).
@@ -192,13 +186,21 @@ module RESTFramework::BaseModelControllerMixin
       return @recordset = model.all
     end
 
-    return nil
+    return @recordset = nil
   end
 
-  # Get a single record by primary key or another column, if allowed.
+  # Helper to get the records this controller has access to *after* any filtering is applied.
+  def get_records
+    return @records if instance_variable_defined?(:@records)
+
+    return @records = self.get_filtered_data(self.get_recordset)
+  end
+
+  # Get a single record by primary key or another column, if allowed. The return value is cached and
+  # exposed to the view as the `@record` instance variable.
   def get_record
     # Cache the result.
-    return @_get_record if @_get_record
+    return @record if instance_variable_defined?(:@record)
 
     recordset = self.get_recordset
     find_by_key = self.get_model.primary_key
@@ -216,78 +218,74 @@ module RESTFramework::BaseModelControllerMixin
 
     # Filter recordset, if configured.
     if self.filter_recordset_before_find
-      recordset = self.get_filtered_data(recordset)
+      recordset = self.get_records
     end
 
-    # Return the record. Route key is always :id by Rails convention.
-    return @_get_record = recordset.find_by!(find_by_key => params[:id])
+    # Return the record. Route key is always `:id` by Rails convention.
+    return @record = recordset.find_by!(find_by_key => params[:id])
   end
 end
 
 # Mixin for listing records.
 module RESTFramework::ListModelMixin
   def index
-    api_response(self.index!)
+    return api_response(self.get_index_records)
   end
 
-  def index!
-    @records ||= self.get_filtered_data(self.get_recordset)
+  # Helper to get records with both filtering and pagination applied.
+  def get_index_records
+    records = self.get_records
 
     # Handle pagination, if enabled.
     if self.class.paginator_class
-      paginator = self.class.paginator_class.new(data: @records, controller: self)
+      paginator = self.class.paginator_class.new(data: records, controller: self)
       page = paginator.get_page
       serialized_page = self.serialize(page)
       return paginator.get_paginated_response(serialized_page)
-    else
-      return self.serialize(@records)
     end
+
+    return records
   end
 end
 
 # Mixin for showing records.
 module RESTFramework::ShowModelMixin
   def show
-    api_response(self.show!)
-  end
-
-  def show!
-    @record ||= self.get_record
-    return self.serialize(@record)
+    return api_response(self.get_record)
   end
 end
 
 # Mixin for creating records.
 module RESTFramework::CreateModelMixin
   def create
-    api_response(self.create!)
+    return api_response(self.create!, status: :created)
   end
 
+  # Helper to perform the `create!` call and return the created record.
   def create!
     if self.get_recordset.respond_to?(:create!) && 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`.
-      @record ||= self.get_recordset.except(:select).create!(self.get_create_params)
+      return self.get_recordset.except(:select).create!(self.get_create_params)
     else
       # Otherwise, perform a "bare" create.
-      @record ||= self.get_model.create!(self.get_create_params)
+      return self.get_model.create!(self.get_create_params)
     end
-
-    return self.serialize(@record)
   end
 end
 
 # Mixin for updating records.
 module RESTFramework::UpdateModelMixin
   def update
-    api_response(self.update!)
+    return api_response(self.update!)
   end
 
+  # Helper to perform the `update!` call and return the updated record.
   def update!
-    @record ||= self.get_record
-    @record.update!(self.get_update_params)
-    return self.serialize(@record)
+    record = self.get_record
+    record.update!(self.get_update_params)
+    return record
   end
 end
 
@@ -295,12 +293,12 @@ end
 module RESTFramework::DestroyModelMixin
   def destroy
     self.destroy!
-    api_response("")
+    return api_response("")
   end
 
+  # Helper to perform the `destroy!` call and return the destroyed (and frozen) record.
   def destroy!
-    @record ||= self.get_record
-    @record.destroy!
+    return self.get_record.destroy!
   end
 end
 

data/lib/rest_framework/utils.rb

@@ -42,11 +42,6 @@ module RESTFramework::Utils
     application_routes.router.recognize(request) { |route, _| return route }
   end
 
-  # Helper to get the route pattern for a route, stripped of the `(:format)` segment.
-  def self.get_route_pattern(route)
-    return route.path.spec.to_s.gsub(/\(\.:format\)$/, "")
-  end
-
   # Helper to normalize a path pattern by replacing URL params with generic placeholder, and
   # removing the `(.:format)` at the end.
   def self.comparable_path(path)
@@ -56,47 +51,52 @@ module RESTFramework::Utils
   # Helper for showing routes under a controller action; used for the browsable API.
   def self.get_routes(application_routes, request, current_route: nil)
     current_route ||= self.get_request_route(application_routes, request)
-    current_path = current_route.path.spec.to_s
+    current_path = current_route.path.spec.to_s.gsub("(.:format)", "")
     current_levels = current_path.count("/")
     current_comparable_path = self.comparable_path(current_path)
 
+    # Add helpful properties of the current route.
+    path_args = current_route.required_parts.map { |n| request.path_parameters[n] }
+    route_props = {
+      with_path_args: ->(r) {
+        r.format(r.required_parts.each_with_index.map { |p, i| [p, path_args[i]] }.to_h)
+      },
+    }
+
     # Return routes that match our current route subdomain/pattern, grouped by controller. We
     # precompute certain properties of the route for performance.
-    return application_routes.routes.map { |r|
-      path = r.path.spec.to_s
+    return route_props, application_routes.routes.select { |r|
+      # We `select` first to avoid unnecessarily calculating metadata for routes we don't even want
+      # to show.
+      (
+        (r.defaults[:subdomain].blank? || r.defaults[:subdomain] == request.subdomain) &&
+        self.comparable_path(r.path.spec.to_s).start_with?(current_comparable_path) &&
+        r.defaults[:controller].present? &&
+        r.defaults[:action].present?
+      )
+    }.map { |r|
+      path = r.path.spec.to_s.gsub("(.:format)", "")
       levels = path.count("/")
-
-      # Show link if the route is GET and our current route has all required URL params.
-      if r.verb == "GET" && r.path.required_names.length == current_route.path.required_names.length
-        show_link_args = current_route.path.required_names.map { |n| request.params[n] }.compact
-      else
-        show_link_args = nil
-      end
+      matches_path = current_path == path
+      matches_params = r.required_parts.length == current_route.required_parts.length
 
       {
         route: r,
         verb: r.verb,
         path: path,
-        comparable_path: self.comparable_path(path),
         # Starts at the number of levels in current path, and removes the `(.:format)` at the end.
-        relative_path: path.split("/")[current_levels..]&.join("/")&.gsub("(.:format)", ""),
+        relative_path: path.split("/")[current_levels..]&.join("/"),
         controller: r.defaults[:controller].presence,
         action: r.defaults[:action].presence,
-        subdomain: r.defaults[:subdomain].presence,
-        levels: levels,
-        show_link_args: show_link_args,
+        matches_path: matches_path,
+        matches_params: matches_params,
+        # The following options are only used in subsequent processing in this method.
+        _levels: levels,
       }
-    }.select { |r|
-      (
-        (!r[:subdomain] || r[:subdomain] == request.subdomain.presence) &&
-        r[:comparable_path].start_with?(current_comparable_path) &&
-        r[:controller] &&
-        r[:action]
-      )
     }.sort_by { |r|
       # Sort by levels first, so the routes matching closely with current request show first, then
       # by the path, and finally by the HTTP verb.
-      [r[:levels], r[:path], HTTP_METHOD_ORDERING.index(r[:verb]) || 99]
+      [r[:_levels], r[:_path], HTTP_METHOD_ORDERING.index(r[:verb]) || 99]
     }.group_by { |r| r[:controller] }.sort_by { |c, _r|
       # Sort the controller groups by current controller first, then depth, then alphanumerically.
       [request.params[:controller] == c ? 0 : 1, c.count("/"), c]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rest_framework
 version: !ruby/object:Gem::Version
-  version: 0.6.5
+  version: 0.6.6
 platform: ruby
 authors:
 - Gregory N. Schmit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-02 00:00:00.000000000 Z
+date: 2022-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -36,6 +36,7 @@ files:
 - VERSION
 - app/views/layouts/rest_framework.html.erb
 - app/views/rest_framework/_head.html.erb
+- app/views/rest_framework/_raw_form.html.erb
 - app/views/rest_framework/_route.html.erb
 - app/views/rest_framework/_routes.html.erb
 - lib/rest_framework.rb
@@ -74,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.2.33
 signing_key: 
 specification_version: 4
 summary: A framework for DRY RESTful APIs in Ruby on Rails.

data/README.md

@@ -1,128 +0,0 @@
-# Rails REST Framework
-
-[![Gem Version](https://badge.fury.io/rb/rest_framework.svg)](https://badge.fury.io/rb/rest_framework)
-[![Build Status](https://travis-ci.com/gregschmit/rails-rest-framework.svg?branch=master)](https://travis-ci.com/gregschmit/rails-rest-framework)
-[![Coverage Status](https://coveralls.io/repos/github/gregschmit/rails-rest-framework/badge.svg?branch=master)](https://coveralls.io/github/gregschmit/rails-rest-framework?branch=master)
-[![Maintainability](https://api.codeclimate.com/v1/badges/ba5df7706cb544d78555/maintainability)](https://codeclimate.com/github/gregschmit/rails-rest-framework/maintainability)
-
-A framework for DRY RESTful APIs in Ruby on Rails.
-
-**The Problem**: Building controllers for APIs usually involves writing a lot of redundant CRUD
-logic, and routing them can be obnoxious. Building and maintaining features like ordering,
-filtering, and pagination can be tedious.
-
-**The Solution**: This framework implements browsable API responses, CRUD actions for your models,
-and features like ordering/filtering/pagination, so you can focus on building awesome APIs.
-
-Website/Guide: [https://rails-rest-framework.com](https://rails-rest-framework.com)
-
-Source: [https://github.com/gregschmit/rails-rest-framework](https://github.com/gregschmit/rails-rest-framework)
-
-YARD Docs: [https://rubydoc.info/gems/rest_framework](https://rubydoc.info/gems/rest_framework)
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'rest_framework'
-```
-
-And then execute:
-
-```shell
-$ bundle install
-```
-
-Or install it yourself with:
-
-```shell
-$ gem install rest_framework
-```
-
-## Quick Usage Tutorial
-
-### Controller Mixins
-
-To transform a controller into a RESTful controller, you can either include `BaseControllerMixin`,
-`ReadOnlyModelControllerMixin`, or `ModelControllerMixin`. `BaseControllerMixin` provides a `root`
-action and a simple interface for routing arbitrary additional actions:
-
-```ruby
-class ApiController < ApplicationController
-  include RESTFramework::BaseControllerMixin
-  self.extra_actions = {test: [:get]}
-
-  def test
-    render inline: "Test successful!"
-  end
-end
-```
-
-`ModelControllerMixin` assists with providing the standard model CRUD for your controller.
-
-```ruby
-class Api::MoviesController < ApiController
-  include RESTFramework::ModelControllerMixin
-
-  self.recordset = Movie.where(enabled: true)
-end
-```
-
-`ReadOnlyModelControllerMixin` only enables list/show actions, but since we're naming this
-controller in a way that doesn't make the model obvious, we can set that explicitly:
-
-```ruby
-class Api::ReadOnlyMoviesController < ApiController
-  include RESTFramework::ReadOnlyModelControllerMixin
-
-  self.model = Movie
-end
-```
-
-Note that you can also override the `get_recordset` instance method to override the API behavior
-dynamically per-request.
-
-### Routing
-
-You can use Rails' `resource`/`resources` routers to route your API, however if you want
-`extra_actions` / `extra_member_actions` to be routed automatically, then you can use `rest_route`
-for non-resourceful controllers, or `rest_resource` / `rest_resources` resourceful routers. You can
-also use `rest_root` to route the root of your API:
-
-```ruby
-Rails.application.routes.draw do
-  rest_root :api  # will find `api_controller` and route the `root` action to '/api'
-  namespace :api do
-    rest_resources :movies
-    rest_resources :users
-  end
-end
-```
-
-Or if you want the API root to be routed to `Api::RootController#root`:
-
-```ruby
-Rails.application.routes.draw do
-  namespace :api do
-    rest_root  # will route `Api::RootController#root` to '/' in this namespace ('/api')
-    rest_resources :movies
-    rest_resources :users
-  end
-end
-```
-
-## Development/Testing
-
-After you clone the repository, cd'ing into the directory should create a new gemset if you are
-using RVM. Then run `bundle install` to install the appropriate gems.
-
-To run the test suite:
-
-```shell
-$ rails test
-```
-
-The top-level `bin/rails` proxies all Rails commands to the test project, so you can operate it via
-the usual commands. Ensure you run `rails db:setup` before running `rails server` or
-`rails console`.