rest_framework 0.9.2 → 0.9.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b18de6060f0b8d4182b8bd7aac3edf3f6b8b2543892d205713f96a7cb3951b4e
-  data.tar.gz: 688299d1ee295d805745b365dfde9dc75c6d866855e94c4505513ff40ee214b8
+  metadata.gz: f87930fef1ded3809f2c37a80ac0553bac65ce9982a6cab7f124efada7456670
+  data.tar.gz: e32641840931ae691de4eb247416a40d89c80c591250bce18b69146520832e31
 SHA512:
-  metadata.gz: f9767ad1b2714143b6746724e26f2a66846db38998d484472735cb21342c780c0ea396ca372b4a7f206597040a415a4097cbdc8a6a4d004aef41665b564e2549
-  data.tar.gz: c6230e7917d490d319905e9bbcd661a52005fcf697406ef36747479593d7884951d1a0655964f74b7edeaddc97ebf26769f7193dfa8fac95cf99b98667734628
+  metadata.gz: 272804b24fe4f0c2f7ab7b21953955991d250dd6f156a7180f524f83b1a211511b8bc94962ed60dac6de8d8fb286b6f4c1acc9077d2270a0736c5e61463d7ec1
+  data.tar.gz: 83ea4be1c4889b84942e8662ff3478cea0d3cb96fcf230239af9c423b79d15600fb72d92f7ea53efd9926ba06cc499805e887df7e3c8d1a97c29148f50224244

data/VERSION

@@ -1 +1 @@
-0.9.2
+0.9.3

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

@@ -0,0 +1,13 @@
+<% if RESTFramework.config.use_vendored_assets %>
+  <% RESTFramework::EXTERNAL_ASSETS.each do |name, cfg| %>
+    <% if cfg[:place] == "javascripts" %>
+      <%= javascript_include_tag "rest_framework/#{name}", defer: true, **cfg[:extra_tag_attrs] %>
+    <% else %>
+      <%= stylesheet_link_tag "rest_framework/#{name}", **cfg[:extra_tag_attrs] %>
+    <% end %>
+  <% end %>
+<% else %>
+  <% RESTFramework::EXTERNAL_ASSETS.each do |name, cfg| %>
+    <%= cfg[:tag] %>
+  <% end %>
+<% end %>

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

@@ -3,96 +3,10 @@
 <%= csrf_meta_tags %>
 <%= csp_meta_tag rescue nil %>
 
-<!-- Bootstrap -->
-<link href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.0-alpha2/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-aFq/bzH65dt+w6FI2ooMVUpc+21e0SRygnTpmBvdBgSdnuTN7QbdgL+OapgHtvPp" crossorigin="anonymous">
-<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.0-alpha2/dist/js/bootstrap.bundle.min.js" integrity="sha384-qKXV1j0HvMUeCBQ+QVp7JcfGl760yU08IQ+GpUo5hlbpg51QRiuqHAJz8+BrxE/N" crossorigin="anonymous"></script>
-<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap-icons@1.10.4/font/bootstrap-icons.css">
+<%= render partial: "rest_framework/external" %>
+<%= render partial: "rest_framework/shared" %>
 
-<!-- Highlight.js -->
-<link rel="stylesheet" class="rrf-light-mode" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.7.0/styles/a11y-light.min.css" integrity="sha512-WDk6RzwygsN9KecRHAfm9HTN87LQjqdygDmkHSJxVkVI7ErCZ8ZWxP6T8RvBujY1n2/E4Ac+bn2ChXnp5rnnHA==" crossorigin="anonymous" referrerpolicy="no-referrer" />
-<link rel="stylesheet" class="rrf-dark-mode" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.7.0/styles/a11y-dark.min.css" integrity="sha512-Vj6gPCk8EZlqnoveEyuGyYaWZ1+jyjMPg8g4shwyyNlRQl6d3L9At02ZHQr5K6s5duZl/+YKMnM3/8pDhoUphg==" crossorigin="anonymous" referrerpolicy="no-referrer" />
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.7.0/highlight.min.js" integrity="sha512-bgHRAiTjGrzHzLyKOnpFvaEpGzJet3z4tZnXGjpsCcqOnAH6VGUx9frc5bcIhKTVLEiCO6vEhNAgx5jtLUYrfA==" crossorigin="anonymous" referrerpolicy="no-referrer"></script>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.7.0/languages/json.min.js" integrity="sha512-0xYvyncS9OLE7GOpNBZFnwyh9+bq4HVgk4yVVYI678xRvE22ASicF1v6fZ1UiST+M6pn17MzFZdvVCI3jTHSyw==" crossorigin="anonymous" referrerpolicy="no-referrer"></script>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.7.0/languages/xml.min.js" integrity="sha512-5zBcw+OKRkaNyvUEPlTSfYylVzgpi7KpncY36b0gRudfxIYIH0q0kl2j26uCUB3YBRM6ytQQEZSgRg+ZlBTmdA==" crossorigin="anonymous" referrerpolicy="no-referrer"></script>
-
-<!-- NeatJSON -->
-<script src="https://cdn.jsdelivr.net/npm/neatjson@0.10.5/javascript/neatjson.min.js"></script>
-
-<!-- Trix -->
-<link rel="stylesheet" type="text/css" href="https://unpkg.com/trix@2.0.0/dist/trix.css">
-<script type="text/javascript" src="https://unpkg.com/trix@2.0.0/dist/trix.umd.min.js"></script>
-
-<!-- Custom Style -->
 <style>
-/********************************
- * START OF LIB/DOCS COMMON CSS *
- ********************************/
-
- :root {
-  --rrf-red: #900;
-  --rrf-red-hover: #5f0c0c;
-  --rrf-light-red: #db2525;
-  --rrf-light-red-hover: #b80404;
-}
-#rrfAccentBar {
-  background-color: var(--rrf-red);
-  height: .3em;
-}
-header nav { background-color: black; }
-
-/* Header adjustments. */
-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; }
-h1, h2, h3, h4, h5, h6 {
-  color: var(--rrf-red);
-}
-html[data-bs-theme="dark"] h1,
-html[data-bs-theme="dark"] h2,
-html[data-bs-theme="dark"] h3,
-html[data-bs-theme="dark"] h4,
-html[data-bs-theme="dark"] h5,
-html[data-bs-theme="dark"] h6 {
-  color: var(--rrf-light-red);
-}
-
-/* Improve code and code blocks. */
-pre code {
-  display: block;
-  overflow-x: auto;
-}
-code, .trix-content pre {
-  padding: .5em !important;
-  background-color: #eee !important;
-  border: 1px solid #aaa;
-  border-radius: 3px;
-}
-p code {
-  padding: .1em .3em !important;
-}
-html[data-bs-theme="dark"] code, html[data-bs-theme="dark"] .trix-content pre {
-  background-color: #2b2b2b !important;
-}
-
-/* Anchors */
-a:not(.nav-link) {
-  text-decoration: none;
-  color: var(--rrf-red);
-}
-a:hover:not(.nav-link) {
-  text-decoration: underline;
-  color: var(--rrf-red-hover);
-}
-html[data-bs-theme="dark"] a:not(.nav-link) { color: var(--rrf-light-red); }
-html[data-bs-theme="dark"] a:hover:not(.nav-link) { color: var(--rrf-light-red-hover); }
-
-/******************************
- * END OF LIB/DOCS COMMON CSS *
- ******************************/
-
 /* Header adjustments. */
 h1,h2,h3,h4,h5,h6 { display: inline-block; font-weight: normal; margin-bottom: 0; }
 
@@ -148,111 +62,7 @@ html[data-bs-theme="dark"] .rrf-routes .rrf-route-group-header:hover {
 }
 </style>
 
-<!-- Custom JavaScript -->
 <script>
-/*******************************
- * START OF LIB/DOCS COMMON JS *
- *******************************/
-
-;(() => {
-  // Get the real mode from a selected mode. Anything other than "light" or "dark" is treated as
-  // "system" mode.
-  const rrfGetRealMode = (selectedMode) => {
-    if (selectedMode === "light" || selectedMode === "dark") {
-      return selectedMode
-    }
-
-    if (window.matchMedia && window.matchMedia("(prefers-color-scheme: dark)").matches) {
-      return "dark"
-    }
-
-    return "light"
-  }
-
-  // Set the mode, given a "selected" mode.
-  const rrfSetSelectedMode = (selectedMode) => {
-    // Anything except "light" or "dark" is casted to "system".
-    if (selectedMode !== "light" && selectedMode !== "dark") {
-      selectedMode = "system"
-    }
-
-    // Store selected mode in `localStorage`.
-    localStorage.setItem("rrfMode", selectedMode)
-
-    // Set the mode selector to the selected mode.
-    const modeComponent = document.getElementById("rrfModeComponent")
-    if (modeComponent) {
-      let labelHTML
-      modeComponent.querySelectorAll("button[data-rrf-mode-value]").forEach((el) => {
-        if (el.getAttribute("data-rrf-mode-value") === selectedMode) {
-          el.classList.add("active")
-          labelHTML = el.querySelector("i").outerHTML.replace("ms-2", "me-1")
-        } else {
-          el.classList.remove("active")
-        }
-      })
-      modeComponent.querySelector("button[data-bs-toggle]").innerHTML = labelHTML
-    }
-
-    // Get the real mode to use.
-    realMode = rrfGetRealMode(selectedMode)
-
-    // Set the `realMode` effects.
-    if (realMode === "light") {
-      document.querySelectorAll(".rrf-light-mode").forEach((el) => {
-        el.disabled = false
-      })
-      document.querySelectorAll(".rrf-dark-mode").forEach((el) => {
-        el.disabled = true
-      })
-      document.querySelectorAll(".rrf-mode").forEach((el) => {
-        el.setAttribute("data-bs-theme", "light")
-      })
-    } else if (realMode === "dark") {
-      document.querySelectorAll(".rrf-light-mode").forEach((el) => {
-        el.disabled = true
-      })
-      document.querySelectorAll(".rrf-dark-mode").forEach((el) => {
-        el.disabled = false
-      })
-      document.querySelectorAll(".rrf-mode").forEach((el) => {
-        el.setAttribute("data-bs-theme", "dark")
-      })
-    } else {
-      console.log(`RRF: Unknown mode: ${mode}`)
-    }
-  }
-
-  // Initialize dark/light mode before page fully loads to prevent flash.
-  rrfSetSelectedMode(localStorage.getItem("rrfMode"))
-
-  // Initialize dark/light mode after page load (mostly so mode component is updated).
-  document.addEventListener("DOMContentLoaded", (event) => {
-    rrfSetSelectedMode(localStorage.getItem("rrfMode"))
-
-    // Also set up mode selector.
-    document.querySelectorAll("#rrfModeComponent button[data-rrf-mode-value]").forEach((el) => {
-      el.addEventListener("click", (event) => {
-        rrfSetSelectedMode(event.target.getAttribute("data-rrf-mode-value"))
-      })
-    })
-  })
-
-  // Handle case where user changes system theme.
-  if (window.matchMedia) {
-    window.matchMedia("(prefers-color-scheme: dark)").addEventListener("change", () => {
-      const selectedMode = localStorage.getItem("rrfMode")
-      if (selectedMode !== "light" && selectedMode !== "dark") {
-        rrfSetSelectedMode("system")
-      }
-    })
-  }
-})()
-
-/*****************************
- * END OF LIB/DOCS COMMON JS *
- *****************************/
-
 document.addEventListener("DOMContentLoaded", (event) => {
   // Pretty-print JSON.
   document.querySelectorAll(".language-json").forEach((el) => {

data/{docs/assets/js/rest_framework.js → app/views/rest_framework/_shared.html}

@@ -1,7 +1,71 @@
-/*******************************
- * START OF LIB/DOCS COMMON JS *
- *******************************/
-
+<!--
+AUTOGENERATED
+Updates must be written to `shared.{css,js}` and synced with `rake maintain_assets`.
+-->
+<style>
+:root {
+  --rrf-red: #900;
+  --rrf-red-hover: #5f0c0c;
+  --rrf-light-red: #db2525;
+  --rrf-light-red-hover: #b80404;
+}
+#rrfAccentBar {
+  background-color: var(--rrf-red);
+  height: .3em;
+}
+header nav { background-color: black; }
+
+/* Header adjustments. */
+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; }
+h1, h2, h3, h4, h5, h6 {
+  color: var(--rrf-red);
+}
+html[data-bs-theme="dark"] h1,
+html[data-bs-theme="dark"] h2,
+html[data-bs-theme="dark"] h3,
+html[data-bs-theme="dark"] h4,
+html[data-bs-theme="dark"] h5,
+html[data-bs-theme="dark"] h6 {
+  color: var(--rrf-light-red);
+}
+
+/* Improve code and code blocks. */
+pre code, .trix-content pre {
+  display: block;
+  overflow-x: auto;
+  padding: .5em !important;
+}
+code, .trix-content pre {
+  --bs-code-color: black;
+  background-color: #eee !important;
+  border: 1px solid #aaa;
+  border-radius: 3px;
+  padding: .1em .3em;
+}
+html[data-bs-theme="dark"] code, html[data-bs-theme="dark"] .trix-content pre {
+  --bs-code-color: white;
+  background-color: #2b2b2b !important;
+}
+
+/* Anchors */
+a:not(.nav-link) {
+  text-decoration: none;
+  color: var(--rrf-red);
+}
+a:hover:not(.nav-link) {
+  text-decoration: underline;
+  color: var(--rrf-red-hover);
+}
+html[data-bs-theme="dark"] a:not(.nav-link) { color: var(--rrf-light-red); }
+html[data-bs-theme="dark"] a:hover:not(.nav-link) { color: var(--rrf-light-red-hover); }
+
+</style>
+<script>
 ;(() => {
   // Get the real mode from a selected mode. Anything other than "light" or "dark" is treated as
   // "system" mode.
@@ -97,41 +161,4 @@
   }
 })()
 
-/*****************************
- * END OF LIB/DOCS COMMON JS *
- *****************************/
-
-document.addEventListener("DOMContentLoaded", () => {
-  // Initialize `Highlight.js`.
-  hljs.configure({ ignoreUnescapedHTML: true })
-  hljs.highlightAll()
-
-  // Setup the floating table of contents.
-  let table = "<ul>"
-  let hlevel = 2
-  let hprevlevel = 2
-  document.querySelectorAll("h2, h3, h4").forEach((header) => {
-    hlevel = parseInt(header.tagName[1])
-
-    if (hlevel > hprevlevel) {
-      table += "<ul>"
-    } else if (hlevel < hprevlevel) {
-      Array(hprevlevel - hlevel)
-        .fill(0)
-        .forEach(function () {
-          table += "</ul>"
-        })
-    }
-    table += `<li><a href="${
-      header.querySelectorAll("a")[0].href
-    }">${header.childNodes[0].nodeValue.trim()}</a></li>`
-    hprevlevel = hlevel
-  })
-  if (hlevel > hprevlevel) {
-    table += "</ul>"
-  }
-  table += "</ul>"
-  if (table != "<ul></ul>") {
-    document.getElementById("headersTable").innerHTML = table
-  }
-})
+</script>

data/docs/Gemfile

@@ -2,3 +2,4 @@ source "https://rubygems.org"
 
 gem "github-pages"
 gem "yard"
+gem "webrick"

data/docs/Gemfile.lock

@@ -1,22 +1,22 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.4.3)
+    activesupport (7.0.5)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
-    addressable (2.8.2)
+    addressable (2.8.4)
       public_suffix (>= 2.0.2, < 6.0)
     coffee-script (2.4.1)
       coffee-script-source
       execjs
     coffee-script-source (1.11.1)
     colorator (1.1.0)
-    commonmarker (0.23.8)
+    commonmarker (0.23.9)
     concurrent-ruby (1.2.2)
-    dnsruby (1.61.9)
-      simpleidn (~> 0.1)
+    dnsruby (1.70.0)
+      simpleidn (~> 0.2.1)
     em-websocket (0.5.3)
       eventmachine (>= 0.12.9)
       http_parser.rb (~> 0)
@@ -24,7 +24,7 @@ GEM
       ffi (>= 1.15.0)
     eventmachine (1.2.7)
     execjs (2.8.1)
-    faraday (2.7.4)
+    faraday (2.7.6)
       faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
     faraday-net_http (3.0.2)
@@ -86,7 +86,7 @@ GEM
       activesupport (>= 2)
       nokogiri (>= 1.4)
     http_parser.rb (0.8.0)
-    i18n (1.12.0)
+    i18n (1.14.1)
       concurrent-ruby (~> 1.0)
     jekyll (3.9.3)
       addressable (~> 2.4)
@@ -205,14 +205,14 @@ GEM
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
     mercenary (0.3.6)
-    mini_portile2 (2.8.1)
+    mini_portile2 (2.8.2)
     minima (2.5.1)
       jekyll (>= 3.5, < 5.0)
       jekyll-feed (~> 0.9)
       jekyll-seo-tag (~> 2.1)
     minitest (5.18.0)
-    nokogiri (1.14.2)
-      mini_portile2 (~> 2.8.0)
+    nokogiri (1.15.2)
+      mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
     octokit (4.25.1)
       faraday (>= 1, < 3)
@@ -220,7 +220,7 @@ GEM
     pathutil (0.16.2)
       forwardable-extended (~> 2.6)
     public_suffix (4.0.7)
-    racc (1.6.2)
+    racc (1.7.0)
     rb-fsevent (0.11.2)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
@@ -249,15 +249,15 @@ GEM
       unf_ext
     unf_ext (0.0.8.2)
     unicode-display_width (1.8.0)
-    webrick (1.7.0)
-    yard (0.9.28)
-      webrick (~> 1.7.0)
+    webrick (1.8.1)
+    yard (0.9.34)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   github-pages
+  webrick
   yard
 
 BUNDLED WITH

data/docs/_config.yml

@@ -7,11 +7,13 @@ collections:
     output: true
     permalink: /:collection/:slug/
 
-# Build settings
+# Build settings.
 markdown: kramdown
+highlighter: none
 
 defaults:
   - scope:
-      path: ""  # All files.
+      # All files.
+      path: ""
     values:
       layout: default