rest_framework 0.9.4 → 0.9.6

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

@@ -0,0 +1,52 @@
+<%
+  @is_model_controller = controller.class.included_modules.include?(RESTFramework::ModelControllerMixin)
+%>
+<div class="row">
+  <div>
+    <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>
+      <% @_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"])
+      } %>
+      <% if @_rrf_form_routes_raw.present? %>
+        <li class="nav-item">
+          <a class="nav-link" href="#tabRawForm" data-bs-toggle="tab" role="tab">
+            Raw Form
+          </a>
+        </li>
+      <% 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>
+  <div class="tab-content pt-2">
+    <div class="tab-pane fade show active" id="tab-routes" role="tabpanel">
+      <%= render partial: "rest_framework/routes_and_forms/routes" %>
+    </div>
+    <% if @_rrf_form_routes_raw.present? %>
+      <div class="tab-pane fade" id="tabRawForm" role="tabpanel">
+        <%= render partial: "rest_framework/routes_and_forms/raw_form" %>
+      </div>
+    <% end %>
+    <% if @_rrf_form_routes_html.present? && @is_model_controller %>
+      <div class="tab-pane fade" id="tabHtmlForm" role="tabpanel">
+        <%= render partial: "rest_framework/routes_and_forms/html_form" %>
+      </div>
+    <% end %>
+  </div>
+</div>

data/app/views/rest_framework/head/_external.html.erb

@@ -1,9 +1,14 @@
 <% if RESTFramework.config.use_vendored_assets %>
-  <% RESTFramework::EXTERNAL_ASSETS.each do |name, cfg| %>
+  <%= javascript_include_tag RESTFramework::EXTERNAL_JS_NAME, defer: true %>
+  <%= stylesheet_link_tag RESTFramework::EXTERNAL_CSS_NAME %>
+
+  <% RESTFramework::EXTERNAL_UNSUMMARIZED_ASSETS.each do |name, cfg| %>
     <% if cfg[:place] == "javascripts" %>
       <%= javascript_include_tag "rest_framework/#{name}", defer: true, **cfg[:extra_tag_attrs] %>
-    <% else %>
+    <% elsif cfg[:place] == "stylesheets" %>
       <%= stylesheet_link_tag "rest_framework/#{name}", **cfg[:extra_tag_attrs] %>
+    <% else %>
+      <% raise "Unknown asset place." %>
     <% end %>
   <% end %>
 <% else %>

data/app/views/rest_framework/header/_mode.html.erb

@@ -0,0 +1,14 @@
+<div class="dropdown float-end" id="rrfModeComponent">
+  <button class="btn btn-dark dropdown-toggle rounded-0 bg-black" style="border-color: black" data-bs-toggle="dropdown"></button>
+  <div class="rrf-mode dropdown-menu dropdown-menu-end py-0 rounded-0" style="font-size: .8em; min-width: 0">
+    <button class="dropdown-item text-end" data-rrf-mode-value="system">
+      System<i class="bi bi-circle-half ms-2"></i>
+    </button>
+    <button class="dropdown-item text-end" data-rrf-mode-value="light">
+      Light<i class="bi bi-sun-fill ms-2"></i>
+    </button>
+    <button class="dropdown-item text-end" data-rrf-mode-value="dark">
+      Dark<i class="bi bi-moon-stars-fill ms-2"></i>
+    </button>
+  </div>
+</div>

data/app/views/rest_framework/heading/_actions.html.erb

@@ -0,0 +1,9 @@
+<div style="float: right">
+  <% 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" } %>
+    <button type="button" class="btn btn-primary" onclick="rrfOptions(this)">OPTIONS</button>
+  <% end %>
+  <button type="button" class="btn btn-primary" onclick="rrfGet(this)">GET</button>
+</div>

data/app/views/rest_framework/{_routes.html.erb → routes_and_forms/_routes.html.erb}

@@ -10,7 +10,7 @@
     <%# Render first group of routes directly. %>
     <tbody>
       <% @route_groups.values[0].each do |route| %>
-        <%= render partial: "rest_framework/route", locals: {route: route} %>
+        <%= render partial: "rest_framework/routes_and_forms/routes/route", locals: {route: route} %>
       <% end %>
     </tbody>
     <%# Render any other groups under dropdowns. %>
@@ -20,7 +20,7 @@
       </tr>
       <tbody id="route-group-<%= index %>" class="collapse">
         <% route_group.each do |route| %>
-          <%= render partial: "rest_framework/route", locals: {route: route} %>
+          <%= render partial: "rest_framework/routes_and_forms/routes/route", locals: {route: route} %>
         <% end %>
       </tbody>
     <% end %>

data/lib/rest_framework/controller_mixins/base.rb

@@ -146,6 +146,9 @@ module RESTFramework::BaseControllerMixin
 
     base.extend(ClassMethods)
 
+    # By default, the layout should be set to `rest_framework`.
+    base.layout("rest_framework")
+
     # Add class attributes (with defaults) unless they already exist.
     RRF_BASE_CONFIG.each do |a, default|
       next if base.respond_to?(a)
@@ -267,8 +270,8 @@ module RESTFramework::BaseControllerMixin
 
   # Render a browsable API for `html` format, along with basic `json`/`xml` formats, and with
   # support or passing custom `kwargs` to the underlying `render` calls.
-  def api_response(payload, html_kwargs: nil, **kwargs)
-    html_kwargs ||= {}
+  def api_response(payload, **kwargs)
+    html_kwargs = kwargs.delete(:html_kwargs) || {}
     json_kwargs = kwargs.delete(:json_kwargs) || {}
     xml_kwargs = kwargs.delete(:xml_kwargs) || {}
 
@@ -300,12 +303,10 @@ module RESTFramework::BaseControllerMixin
           format.xml { head(kwargs[:status] || :no_content) } if self.serialize_to_xml
         else
           format.json {
-            jkwargs = kwargs.merge(json_kwargs)
-            render(json: payload, layout: false, **jkwargs)
+            render(json: payload, **kwargs.merge(json_kwargs))
           } if self.serialize_to_json
           format.xml {
-            xkwargs = kwargs.merge(xml_kwargs)
-            render(xml: payload, layout: false, **xkwargs)
+            render(xml: payload, **kwargs.merge(xml_kwargs))
           } if self.serialize_to_xml
           # TODO: possibly support more formats here if supported?
         end
@@ -323,13 +324,11 @@ module RESTFramework::BaseControllerMixin
           @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.
-            hkwargs[:layout] = "rest_framework"
-            hkwargs[:html] = ""
-            render(**hkwargs)
+            render(**kwargs.merge(html_kwargs))
+          rescue ActionView::MissingTemplate
+            # A view is not required, so just use `html: ""`.
+            render(html: "", layout: true, **kwargs.merge(html_kwargs))
           end
         }
       end

data/lib/rest_framework/engine.rb

@@ -2,9 +2,11 @@ class RESTFramework::Engine < Rails::Engine
   initializer "rest_framework.assets" do
     config.after_initialize do |app|
       if RESTFramework.config.use_vendored_assets
-        app.config.assets.precompile += RESTFramework::EXTERNAL_ASSETS.keys.map do |name|
-          "rest_framework/#{name}"
-        end
+        app.config.assets.precompile += [
+          RESTFramework::EXTERNAL_CSS_NAME,
+          RESTFramework::EXTERNAL_JS_NAME,
+          *RESTFramework::EXTERNAL_UNSUMMARIZED_ASSETS.keys.map { |name| "rest_framework/#{name}" },
+        ]
       end
     end
   end

data/lib/rest_framework/filters/ransack.rb

@@ -9,15 +9,15 @@ class RESTFramework::RansackFilter < RESTFramework::BaseFilter
 
       # Determine if `distinct` is determined by query param.
       if distinct_query_param = @controller.ransack_distinct_query_param
-        distinct_from_query = ActiveRecord::Type::Boolean.new.cast(
-          @controller.request.query_parameters[distinct_query_param],
-        )
-        unless distinct_from_query.nil?
-          distinct = distinct_from_query
+        if distinct_query = @controller.request.query_parameters[distinct_query_param].presence
+          distinct_from_query = ActiveRecord::Type::Boolean.new.cast(distinct_query)
+          unless distinct_from_query.nil?
+            distinct = distinct_from_query
+          end
         end
       end
 
-      return data.ransack(q, @controller.ransack_options).result(distinct: distinct)
+      return data.ransack(q, @controller.ransack_options || {}).result(distinct: distinct)
     end
 
     return data

data/lib/rest_framework/version.rb

@@ -17,12 +17,6 @@ module RESTFramework
       rescue SystemCallError
       end
 
-      # If that fails, then try to get a plain commit SHA from git.
-      unless skip_git
-        version = `git describe --dirty --always`&.strip
-        return "0.#{version}" unless !version || version.empty?
-      end
-
       # No VERSION file, so version is unknown.
       return "0.unknown"
     end

data/lib/rest_framework.rb

@@ -20,65 +20,73 @@ module RESTFramework
     destroy_all: :delete,
   }.freeze
 
+  # We put most vendored external assets into these files to make precompilation and serving faster.
+  EXTERNAL_CSS_NAME = "rest_framework/external.min.css"
+  EXTERNAL_JS_NAME = "rest_framework/external.min.js"
+
+  # We should always add the `.min` extension prefix even if the assets are not minified, to avoid
+  # sprockets minifying the assets. We target propshaft, so we want these assets to just be passed
+  # through.
   # rubocop:disable Layout/LineLength
   EXTERNAL_ASSETS = {
     # Bootstrap
-    "bootstrap.css" => {
+    "bootstrap.min.css" => {
       url: "https://cdn.jsdelivr.net/npm/bootstrap@5.3.0-alpha2/dist/css/bootstrap.min.css",
       sri: "sha384-aFq/bzH65dt+w6FI2ooMVUpc+21e0SRygnTpmBvdBgSdnuTN7QbdgL+OapgHtvPp",
     },
-    "bootstrap.js" => {
+    "bootstrap.min.js" => {
       url: "https://cdn.jsdelivr.net/npm/bootstrap@5.3.0-alpha2/dist/js/bootstrap.bundle.min.js",
       sri: "sha384-qKXV1j0HvMUeCBQ+QVp7JcfGl760yU08IQ+GpUo5hlbpg51QRiuqHAJz8+BrxE/N",
     },
 
     # Bootstrap Icons
-    "bootstrap-icons.css" => {
+    "bootstrap-icons.min.css" => {
       url: "https://cdn.jsdelivr.net/npm/bootstrap-icons@1.10.4/font/bootstrap-icons.min.css",
       inline_fonts: true,
     },
 
     # Highlight.js
-    "highlight.js" => {
+    "highlight.min.js" => {
       url: "https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.7.0/highlight.min.js",
       sri: "sha512-bgHRAiTjGrzHzLyKOnpFvaEpGzJet3z4tZnXGjpsCcqOnAH6VGUx9frc5bcIhKTVLEiCO6vEhNAgx5jtLUYrfA==",
     },
-    "highlight-json.js" => {
+    "highlight-json.min.js" => {
       url: "https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.7.0/languages/json.min.js",
       sri: "sha512-0xYvyncS9OLE7GOpNBZFnwyh9+bq4HVgk4yVVYI678xRvE22ASicF1v6fZ1UiST+M6pn17MzFZdvVCI3jTHSyw==",
     },
-    "highlight-xml.js" => {
+    "highlight-xml.min.js" => {
       url: "https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.7.0/languages/xml.min.js",
       sri: "sha512-5zBcw+OKRkaNyvUEPlTSfYylVzgpi7KpncY36b0gRudfxIYIH0q0kl2j26uCUB3YBRM6ytQQEZSgRg+ZlBTmdA==",
     },
-    "highlight-a11y-dark.css" => {
+    "highlight-a11y-dark.min.css" => {
       url: "https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.7.0/styles/a11y-dark.min.css",
       sri: "sha512-Vj6gPCk8EZlqnoveEyuGyYaWZ1+jyjMPg8g4shwyyNlRQl6d3L9At02ZHQr5K6s5duZl/+YKMnM3/8pDhoUphg==",
       extra_tag_attrs: {class: "rrf-dark-mode"},
     },
-    "highlight-a11y-light.css" => {
+    "highlight-a11y-light.min.css" => {
       url: "https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.7.0/styles/a11y-light.min.css",
       sri: "sha512-WDk6RzwygsN9KecRHAfm9HTN87LQjqdygDmkHSJxVkVI7ErCZ8ZWxP6T8RvBujY1n2/E4Ac+bn2ChXnp5rnnHA==",
       extra_tag_attrs: {class: "rrf-light-mode"},
     },
 
     # NeatJSON
-    "neatjson.js" => {
+    "neatjson.min.js" => {
       url: "https://cdn.jsdelivr.net/npm/neatjson@0.10.5/javascript/neatjson.min.js",
       exclude_from_docs: true,
     },
 
     # Trix
-    "trix.css" => {
+    "trix.min.css" => {
       url: "https://unpkg.com/trix@2.0.0/dist/trix.css",
       exclude_from_docs: true,
     },
-    "trix.js" => {
+    "trix.min.js" => {
       url: "https://unpkg.com/trix@2.0.0/dist/trix.umd.min.js",
       exclude_from_docs: true,
     },
   }.map { |name, cfg|
-    if File.extname(name) == ".js"
+    ext = File.extname(name)
+    if ext == ".js"
       cfg[:place] = "javascripts"
       cfg[:extra_tag_attrs] ||= {}
       cfg[:tag_attrs] = {
@@ -90,7 +98,7 @@ module RESTFramework
         **cfg[:extra_tag_attrs],
       }
       cfg[:tag] = ActionController::Base.helpers.tag.script(**cfg[:tag_attrs])
-    else
+    elsif ext == ".css"
       cfg[:place] = "stylesheets"
       cfg[:extra_tag_attrs] ||= {}
       cfg[:tag_attrs] = {
@@ -101,12 +109,16 @@ module RESTFramework
         **cfg[:extra_tag_attrs],
       }
       cfg[:tag] = ActionController::Base.helpers.tag.link(**cfg[:tag_attrs])
+    else
+      raise "Unknown asset extension: #{ext}."
     end
 
     [name, cfg]
   }.to_h.freeze
   # rubocop:enable Layout/LineLength
 
+  EXTERNAL_UNSUMMARIZED_ASSETS = EXTERNAL_ASSETS.select { |_, cfg| cfg[:extra_tag_attrs].present? }
+
   # Global configuration should be kept minimal, as controller-level configurations allows multiple
   # APIs to be defined to behave differently.
   class Config