shaf 1.5.1 → 2.1.0

data/yard_templates/api_doc/html/css/api-doc.css

@@ -0,0 +1,222 @@
+* {
+  box-sizing: border-box;
+}
+
+html {
+  margin: 0;
+  height: 100%;
+}
+
+body {
+  margin: 0;
+  height: 100%;
+}
+
+ul {
+  padding: 0;
+  list-style-type: none;
+}
+
+td {
+  min-width: 20em;
+}
+
+pre {
+  margin: 0;
+}
+
+.sidebar-content.list li {
+  margin-top: 0.4em;
+}
+
+a:link, a:visited {
+  color: black;
+  text-decoration: none;
+  font-weight: 500;
+}
+
+a:hover {
+  color: #008277;
+}
+
+.grid-container {
+  display: grid;
+  grid-template-columns: 320px auto 320px;
+  grid-template-rows: 4em auto 2em;
+  grid-template-areas:
+    "header-sidebar header-main header-none"
+    "sidebar        resource    none"
+    "footer         footer      footer";
+  height: 100%;
+}
+
+.header-sidebar {
+  grid-area: header-sidebar;
+  padding-left: 2em;
+}
+
+.header-sidebar h2 {
+  padding-top: 4px;
+}
+
+.header-main {
+  grid-area: header-main;
+  text-align: center;
+  width: 100%;
+}
+
+.header-none {
+  grid-area: header-none;
+}
+
+.header {
+  background-color: #bdc9d0;
+  font-size: 0.8em;
+}
+
+.sidebar {
+  grid-area: sidebar;
+  border-right: 1px solid;
+  border-color: #d2d2d2;
+  background-color: #e3e9ee;
+  height: 100%;
+}
+
+.sidebar-tabs {
+  overflow: hidden;
+  border-bottom: 1px solid;
+  padding-left: 1em;
+  border-color: #d2d2d2;
+}
+
+.sidebar-tabs button {
+  background-color: inherit;
+  border: none;
+  cursor: pointer;
+  padding: 1em;
+  font-weight: bold;
+  font-size: 1em;
+  transition: 0.5s;
+}
+
+.sidebar-tabs button:hover {
+  background-color: #b3d7d4;
+}
+
+.sidebar-tabs button.active {
+  text-decoration: underline;
+  text-decoration-color: #ff9e22;
+}
+
+/* .sidebar-search { */
+/*   padding: 1em 2em 0 2em; */
+/* } */
+
+.sidebar-content {
+  display: none;
+  padding: 1em 2em 0 2em;
+}
+
+.sidebar-content.active {
+  display: block;
+}
+
+li.sidebar-link.active a {
+  font-weight: bold;
+  text-decoration: underline;
+  text-decoration-color: #ff9e22;
+  text-decoration-style: solid;
+}
+
+.resource {
+  grid-area: resource;
+  padding: 2em;
+  /* background-color: #eeffee; */
+  background-color: #ffffff; 
+}
+
+.footer {
+  grid-area: footer;
+  text-align: right;
+  width: 100%;
+  background-color: #ffffff; 
+  font-size: 0.75em;
+}
+
+.resource-section {
+  margin-top: 4em;
+}
+
+span.resource-title {
+  font-style: italic;
+}
+
+.property-source {
+  padding: 4px;
+  border-radius: 4px;
+  margin-left: 0.5em;
+}
+
+.property-source.profile {
+  background-color: #a0ccf5;
+}
+
+.property-source.iana {
+  background-color: #c5e1a5;
+}
+
+.property-source.unknown {
+  background-color: #ef5350;
+}
+
+.nested-attributes {
+  padding-left: 2em;
+}
+
+.nested-attributes h5, h6 {
+  font-size: 1.0em;
+}
+
+h4.description-list {
+  margin-bottom: 8px;
+}
+
+li.description-item {
+  margin-top: 32px;
+  margin-bottom: 0;
+}
+
+.http-method {
+  margin-left: 0.5em;
+  border-radius: 4px;
+  padding: 4px;
+  background-color: #9e9e9e;
+}
+
+.http-method.head {
+  background-color: #8bc34a;
+}
+
+.http-method.options {
+  background-color: #90a4ae;
+}
+
+.http-method.get {
+  background-color: #42a5fa;
+}
+
+.http-method.put {
+  background-color: #ab47bc;
+}
+
+.http-method.patch {
+  background-color: #7e57c2;
+}
+
+.http-method.post {
+  background-color: #26c6da;
+}
+
+.http-method.delete {
+  background-color: #ff6d00;
+}

data/yard_templates/api_doc/html/js/switch_tab.js

@@ -0,0 +1,17 @@
+function openTab(evt, tabName) {
+  // Declare all variables
+  var i, tabcontent, tablinks;
+
+  tabButtons = document.getElementsByClassName("sidebar-tab-btn");
+  for (i = 0; i < tabButtons.length; i++) {
+    tabButtons[i].className = tabButtons[i].className.replace(" active", "");
+  }
+
+  tabs = document.getElementsByClassName("sidebar-content");
+  for (i = 0; i < tabs.length; i++) {
+    tabs[i].className = tabs[i].className.replace(" active", "");
+  }
+
+  evt.currentTarget.className += " active";
+  document.getElementById(tabName).className += " active";
+} 

data/yard_templates/api_doc/html/setup.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require 'ostruct'
+require 'shaf/yard/profile_object'
+
+def init
+  super
+
+  generate_index
+  generate_assets
+  generate_resources
+  generate_profiles
+end
+
+def generate_index
+  serialize(index_object)
+end
+
+def index_object
+  OpenStruct.new(
+    path: :index,
+    name: :index,
+    type: :doc_index
+  )
+end
+
+def generate_assets
+  Array(assets).each do |asset|
+    content = file(asset)
+    serializer(base_path: public_path).serialize(asset, content)
+  end
+end
+
+def generate_resources
+  options.resources.each do |resource|
+    serialize(resource)
+  end
+end
+
+def generate_profiles
+  options.profiles.each do |profile|
+    serialize(profile)
+  end
+end
+
+def serialize(object)
+  options.object = object
+  Templates::Engine.with_serializer(object, serializer) do
+    T('layout').run(options)
+  end
+end
+
+def assets
+  [
+    'css/api-doc.css',
+    'js/switch_tab.js',
+    'favicon.ico',
+  ]
+end

data/yard_templates/api_doc/layout/html/footer.erb

@@ -0,0 +1,3 @@
+<div class="footer">
+  <p>Icon by <a href="https://freeicons.io/profile/3054">Nine One</a> on <a href="https://freeicons.io">freeicons.io</a></p>
+</div>

data/yard_templates/api_doc/layout/html/header.erb

@@ -0,0 +1,7 @@
+<div class="header header-sidebar">
+  <h2><span><%= sub_title %></span></h2>
+</div>
+<div class="header header-main">
+  <h1><span><%= title %></span></h1>
+</div>
+<div class="header header-none"></div>

data/yard_templates/api_doc/layout/html/layout.erb

@@ -0,0 +1,13 @@
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+    <title><%= title %></title>
+    <link rel="stylesheet" href="/css/api-doc.css" type="text/css" media="screen" charset="utf-8" />
+    <script type="text/javascript" charset="utf-8" src="/js/switch_tab.js"></script>
+  </head>
+  <body>
+    <div class="grid-container">
+      <%= yieldall %>
+    </div>
+  </body>
+</html>

data/yard_templates/api_doc/layout/setup.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+def init
+  super
+  return unless object
+
+  sections :layout, %i[header sidebar main footer]
+end
+
+def sidebar
+  Templates::Engine.render options.merge(type: :sidebar)
+end
+
+def main
+  Templates::Engine.render options
+end
+
+def sub_title
+  'API documentation'
+end
+
+def title
+  Shaf::Settings.project_name
+end

data/yard_templates/api_doc/profile/html/attributes.erb

@@ -0,0 +1,10 @@
+<div class="resource-section attributes">
+  <h3>Attributes</h3>
+  <ul>
+    <% @attributes.each do |attr| %>
+      <li class="description-item">
+        <%= serialize_attribute(attr) %>
+      </li>
+    <% end %>
+  </ul>
+</div>

data/yard_templates/api_doc/profile/html/profile.erb

@@ -0,0 +1,6 @@
+<%# FIXME: make classes more generic %>
+<div class="resource">
+  <h2>The <span class="resource-title"><%= name %></span> profile</h2>
+  <p><%= description %>
+  <%= yieldall %>
+</div>

data/yard_templates/api_doc/profile/html/relations.erb

@@ -0,0 +1,10 @@
+<div class="resource-section relations">
+  <h3>Link relations</h3>
+  <ul>
+    <% @relations.each do |rel| %>
+      <li class="description-item">
+        <%= serialize_relation(rel) %>
+      </li>
+    <% end %>
+  </ul>
+</div>

data/yard_templates/api_doc/profile/setup.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+def init
+  super
+
+  return unless object.profile
+
+  @attributes = object.profile.attributes
+  @relations = object.profile.relations
+
+  sections :profile, [:attributes, :relations]
+end
+
+def serialize_attribute(attr)
+  Templates::Engine.render(
+    template: :api_doc,
+    type: :profile_attribute,
+    object: attr,
+    format: options.format
+  )
+end
+
+def serialize_relation(rel)
+  Templates::Engine.render(
+    template: :api_doc,
+    type: :profile_relation,
+    object: rel,
+    format: options.format
+  )
+end
+
+def name
+  object.profile_name
+end
+
+def description
+  object.description
+end

data/yard_templates/api_doc/profile_attribute/html/attribute.erb

@@ -0,0 +1,23 @@
+<h4 class=description-list>
+    <strong> <%= object.name %></strong>
+    <% value_types.each do |type:, class_name:| %>
+        <span class="property-source <%= class_name %>"><%= type %></span>
+    <% end %>
+</h4>
+<p><%= object.doc %></p>
+<% unless @nested_attributes.empty? %>
+    <div class="nested-attributes">
+        <h5>Nested attributes</h5>
+        <ul>
+        <% @nested_attributes.each do |key, attr| %>
+            <li>
+                <h6>
+                    <strong> <%= key %></strong>
+                    <span class="property-source profile"><%= attr.type %></span>
+                </h6>
+                <p><%= attr.doc %></p>
+            </li>
+        <% end %>
+        </ul>
+    </div>
+<% end %>