rtfdoc 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 93d5fa719f81ab8e2a7c7796e9c982d46b789e9865fff3fa845df311983efdf8
-  data.tar.gz: 6494491a42493a3da01be644f21b2785c4095991a7336fd34cc7814e1b25b42b
+  metadata.gz: a6fe3681c1ed97593bf930b2affe79ce710f8e02ba25220fc2568eb259819907
+  data.tar.gz: 1987316da892c9fafc03b7d541cd772cb767c51730729a2063108048d8bec032
 SHA512:
-  metadata.gz: f440ca29a0788b8314ea0c3ae94babf016e773482853b2c6ffd0d347cc3fc92782557ee11dd1b090ba1107095bd1a45f78f79bf22c3835fb28f35a38768b548b
-  data.tar.gz: b54bc1e8acdecbb93d23464c8733c487e4f8bb21c186d27039d588522b8b3051dcb1a7118852037232b7d704c03da4c2d0c435c66121a8cf208f8b7d02730da1
+  metadata.gz: c0993193c6965352819b9e435b3333b5890a98bc685cfc293bc613e97ffc8e72489b4898471ad2e9537d0ab6334e191c30e864deaa17f5a1917baaf3b41d830d
+  data.tar.gz: 449972e46595c02fdda34c6957e7a37ec7e6222ca88dbbbd96e3d3d246438e33d39da704b8df9dbddbbc231964bbce32aa9957fcc823ba28643e265522730448

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rtfdoc (0.1.0)
+    rtfdoc (0.1.2)
       erubi (~> 1.9.0)
       redcarpet (~> 3.5.0)
       rouge (~> 3.20.0)

data/lib/rtfdoc.rb

@@ -91,14 +91,23 @@ module RTFDoc
       if language == 'attributes' || language == 'parameters'
         AttributesComponent.new(code, language).output
       elsif language == 'response'
-        <<-HTML
-        <div class="section-response">
-          <div class="response-topbar">RESPONSE</div>
-          <pre><code>#{rouge_formatter.format(rouge_lexer.lex(code.strip))}</code></pre>
-        </div>
-        HTML
+        format_code('RESPONSE', code)
+      elsif language == 'title_and_code'
+        title, _code = code.split("\n", 2)
+        title ||= 'RESPONSE'
+        format_code(title, _code)
       end
     end
+
+    private def format_code(title, code)
+      <<-HTML
+      <div class="section-response">
+        <div class="response-topbar">#{title}</div>
+        <pre><code>#{rouge_formatter.format(rouge_lexer.lex(code.strip))}</code></pre>
+      </div>
+      HTML
+    end
+
   end
 
   class Template
@@ -157,7 +166,7 @@ module RTFDoc
         parse_metadata(YAML.load(raw_content.slice!(0, idx + 3)))
       end
 
-      raise 'missing metadata' if resource && !@path && !@method
+      raise 'missing metadata' if resource && !meta_section? && !@path && !@method
 
       @content, @example = raw_content.split('$$$')
     end
@@ -179,17 +188,28 @@ module RTFDoc
     end
 
     def signature
-      sig = <<-HTML.strip!
+      anchor(sig)
+    end
+
+    def example_to_html
+      res = super
+      @resource && res && !meta_section? ? res.sub('RESPONSE', sig) : res
+    end
+
+    private
+
+    def sig
+      @sig ||= <<-HTML.strip!
         <div class="endpoint-def">
           <div class="method method__#{method.downcase}">#{method.upcase}</div>
           <div class="path">#{path}</div>
         </div>
       HTML
-
-      anchor(sig)
     end
 
-    private
+    def meta_section?
+      name == 'desc' || name == 'object'
+    end
 
     def menu_title
       @menu_title || name.capitalize

data/lib/rtfdoc/version.rb

@@ -1,3 +1,3 @@
 module RTFDoc
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/src/css/application.scss

@@ -29,14 +29,19 @@
   --endpoints-line-height: 22px;
   --table-font-size: 14px;
   --table-line-height: 18px;
-  --code-font-size: 14px; }
+  --code-font-size: 14px;
+}
 
 * {
   box-sizing: border-box;
-  word-wrap: break-word; }
+  word-wrap: break-word;
+  -moz-osx-font-smoothing: grayscale;
+  -webkit-font-smoothing: antialiased;
+}
 
 html {
-  overflow: auto; }
+  overflow: auto;
+}
 
 body {
   margin: 0;
@@ -46,7 +51,9 @@ body {
   overflow-y: scroll;
   max-width: 100%;
   -moz-osx-font-smoothing: grayscale;
-  background-color: var(--background-color); }
+  -webkit-font-smoothing: antialiased;
+  background-color: var(--background-color);
+}
 
 body[data-theme="dark"] {
   --background-color: var(--sail-gray900);
@@ -79,7 +86,8 @@ body[data-theme="dark"] {
   --code-numbers: #56b6c2;
   --code-booleans: #d19a66;
   --child-list-title-color: var(--sail-gray500);
-  --child-list-title-hover-color: var(--sail-gray100); }
+  --child-list-title-hover-color: var(--sail-gray100);
+}
 
 body[data-theme="light"] {
   --background-color: #fff;
@@ -112,7 +120,8 @@ body[data-theme="light"] {
   --code-numbers: #005cc5;
   --code--booleans: #e36209;
   --child-list-title-color: #586069;
-  --child-list-title-hover-color: #24292e; }
+  --child-list-title-hover-color: #24292e;
+}
 
 #sidebar {
   width: var(--sidebar-width);
@@ -122,20 +131,24 @@ body[data-theme="light"] {
   left: 0;
   bottom: 0;
   z-index: 10;
-  box-shadow: -1px 0 0 0 var(--divider-color) inset; }
+  box-shadow: -1px 0 0 0 var(--divider-color) inset;
+}
 
 .sidebar-header {
   color: var(--nav-header-color);
   padding: 16px;
   display: flex;
   flex-direction: row;
-  justify-content: space-between; }
-  .sidebar-header .sidebar-title {
+  justify-content: space-between;
+  .sidebar-title {
     font-size: 15px;
-    line-height: 20px; }
-  .sidebar-header .api {
+    line-height: 20px;
+  }
+  .api {
     text-transform: uppercase;
-    color: var(--brand-color); }
+    color: var(--brand-color);
+  }
+}
 
 .sidebar-nav {
   margin-top: 16px; }
@@ -330,59 +343,81 @@ ul {
 .section-response {
   background: var(--response-background-color);
   border-radius: 8px;
-  box-shadow: 0 0 0 1px var(--response-shadow-color); }
-  .section-response .response-topbar {
+  box-shadow: 0 0 0 1px var(--response-shadow-color);
+  max-height: 83vh;
+  overflow-y: auto;
+
+  .response-topbar {
     background: var(--block-header-background-color);
     padding: 10px 12px;
     font-weight: 500;
     font-size: 12px;
     color: var(--response-header-color);
-    border-radius: 8px 8px 0 0; }
-  .section-response p {
+    border-radius: 8px 8px 0 0;
+    text-transform: uppercase;
+
+    .endpoint-def .method { width: auto }
+  }
+
+  p {
     margin: 0;
-    padding: 12px var(--sp20); }
-  .section-response pre {
+    padding: 12px var(--sp20);
+  }
+
+  pre {
     margin: 0;
     padding: 12px;
     color: var(--code-color);
     font-family: var(--monospace-font);
     font-size: var(--code-font-size);
     font-weight: 400;
-    line-height: 18px; }
+    line-height: 18px;
+  }
+}
 
-.section-endpoints {
-  padding: 12px 22px; }
-  .section-endpoints .endpoint-def {
-    display: flex;
-    flex-direction: row;
-    font-family: var(--monospace-font);
-    font-size: var(--code-font-size);
-    font-weight: 500;
-    line-height: 22px;
-    color: var(--endpoints-def-color); }
-  .section-endpoints .method {
+.endpoint-def {
+  display: flex;
+  flex-direction: row;
+  font-family: var(--monospace-font);
+  font-size: var(--code-font-size);
+  font-weight: 500;
+  line-height: 22px;
+  color: var(--endpoints-def-color);
+
+  .method {
     text-align: right;
     width: 55px;
-    margin-right: 7px; }
-  .section-endpoints .method__get {
-    color: var(--sail-blue400); }
-  .section-endpoints .method__post {
-    color: #50b573; }
-  .section-endpoints .method__patch,
-  .section-endpoints .method__put {
-    color: #50b573; }
-  .section-endpoints .method__delete {
-    color: var(--redish); }
-  .section-endpoints a {
-    text-decoration: none; }
-  .section-endpoints a:hover .method {
-    filter: brightness(calc(100% + var(--filter-ratio))); }
-  .section-endpoints a:hover .path {
-    color: var(--endpoints-def-hover-color); }
+    margin-right: 7px;
+    text-transform: uppercase;
+  }
+
+  .path { text-transform: none }
+
+  .method__get  { color: var(--sail-blue400); }
+  .method__post { color: #50b573; }
+  .method__patch,
+  .method__put {
+    color: #50b573;
+  }
+  .method__delete { color: var(--redish); }
+}
+
+.section-endpoints {
+  padding: 12px 22px;
+
+  a { text-decoration: none; }
+  a:hover .method {
+    filter: brightness(calc(100% + var(--filter-ratio)));
+  }
+  a:hover .path {
+    color: var(--endpoints-def-hover-color);
+  }
+}
 
 h3 {
   margin-top: 20px;
-  padding-top: 16px; }
+  padding-top: 16px;
+}
 
 h3,
 .section-list .section-list-title {

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rtfdoc
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - ccocchi