rdoc-generator-solarfish 0.0.2

data/docs/example_output/index.json

@@ -0,0 +1,428 @@
+{
+  "title": "RDoc::Generator::SolarFish Example",
+  "theme": {
+    "head": {
+      "styles": [
+        {
+          "url": "onelight.css"
+        },
+        {
+          "url": "main.css"
+        }
+      ],
+      "fonts": [
+        {
+          "url": "Roboto-Regular.ttf",
+          "family": "RobotoRegular"
+        },
+        {
+          "url": "Raleway-Regular.ttf",
+          "family": "RalewayRegular"
+        },
+        {
+          "url": "Raleway-SemiBold.ttf",
+          "family": "RalewaySemiBold"
+        }
+      ],
+      "scripts": [
+
+      ],
+      "html": [
+
+      ]
+    },
+    "body": {
+      "header": [
+
+      ],
+      "footer": [
+
+      ]
+    }
+  },
+  "classes": [
+    {
+      "id": "Bird",
+      "title": "Bird",
+      "kind": "class",
+      "comment": "<p>The base class for all birds.</p>",
+      "groups": [
+        {
+          "title": "Instance Methods",
+          "type": "InstanceMethods",
+          "kind": "method",
+          "level": "instance",
+          "id": "Bird::InstanceMethods",
+          "members": [
+            {
+              "id": "Bird::fly",
+              "title": "fly",
+              "signature": "Bird.fly(symbol, number) -> bool\nBird.fly(string, number) -> bool\n",
+              "comment": "<p>Fly somewhere.</p>\n\n<p>Flying is the most critical feature of birds.</p>\n\n<h1 id=\"method-i-fly-label-Example\">Example<span><a href=\"#method-i-fly-label-Example\">&para;</a> <a href=\"#top\">&uarr;</a></span></h1>\n\n<pre class=\"ruby\"><span class=\"ruby-identifier\">fly</span>(:<span class=\"ruby-identifier\">south</span>, <span class=\"ruby-value\">70</span>)\n</pre>",
+              "code": "<span class=\"ruby-comment\"># File example.rb, line 51</span>\n<span class=\"ruby-keyword\">def</span> <span class=\"ruby-identifier\">fly</span>(<span class=\"ruby-identifier\">direction</span>, <span class=\"ruby-identifier\">velocity</span>)\n  <span class=\"ruby-identifier\">_fly_impl</span>(<span class=\"ruby-identifier\">direction</span>, <span class=\"ruby-identifier\">velocity</span>)\n<span class=\"ruby-keyword\">end</span>",
+              "level": "instance",
+              "visibility": "public",
+              "kind": "method",
+              "labels": [
+                {
+                  "id": "InstanceMethod",
+                  "title": "instance method"
+                },
+                {
+                  "id": "Public",
+                  "title": "public"
+                }
+              ]
+            },
+            {
+              "id": "Bird::speak",
+              "title": "speak",
+              "signature": "speak() { |text| ... }",
+              "comment": "<p>Produce some noise.</p>",
+              "code": "<span class=\"ruby-comment\"># File example.rb, line 32</span>\n<span class=\"ruby-keyword\">def</span> <span class=\"ruby-identifier\">speak</span> <span class=\"ruby-comment\"># :yields: text</span>\n  <span class=\"ruby-identifier\">puts</span> <span class=\"ruby-string\">&#39;generic tweeting&#39;</span>\n  <span class=\"ruby-keyword\">yield</span> <span class=\"ruby-string\">&#39;tweet&#39;</span>\n  <span class=\"ruby-keyword\">yield</span> <span class=\"ruby-string\">&#39;tweet&#39;</span>\n<span class=\"ruby-keyword\">end</span>",
+              "level": "instance",
+              "visibility": "public",
+              "kind": "method",
+              "labels": [
+                {
+                  "id": "InstanceMethod",
+                  "title": "instance method"
+                },
+                {
+                  "id": "Public",
+                  "title": "public"
+                }
+              ]
+            }
+          ]
+        }
+      ],
+      "labels": [
+        {
+          "id": "Class",
+          "title": "class"
+        }
+      ]
+    },
+    {
+      "id": "Duck",
+      "title": "Duck",
+      "kind": "class",
+      "comment": "<p>A duck is a <a href=\"Waterfowl.html\">Waterfowl</a> <a\nhref=\"Bird.html\">Bird</a>.</p>\n\n<p>Features:</p>\n\n<pre>bird::\n\n  * speak\n  * fly\n\nwaterfowl::\n\n  * swim</pre>",
+      "groups": [
+        {
+          "title": "Extended Classes",
+          "type": "ExtendedClasses",
+          "kind": "extended",
+          "id": "Duck::ExtendedClasses",
+          "members": [
+            {
+              "id": "Duck::Animal",
+              "title": "Animal",
+              "signature": "",
+              "comment": "",
+              "kind": "extended",
+              "labels": [
+                {
+                  "id": "Extended",
+                  "title": "extended"
+                }
+              ]
+            }
+          ]
+        },
+        {
+          "title": "Included Modules",
+          "type": "IncludedModules",
+          "kind": "included",
+          "id": "Duck::IncludedModules",
+          "members": [
+            {
+              "id": "Duck::Waterfowl",
+              "title": "Waterfowl",
+              "signature": "",
+              "comment": "",
+              "kind": "included",
+              "labels": [
+                {
+                  "id": "Included",
+                  "title": "included"
+                }
+              ]
+            }
+          ]
+        },
+        {
+          "title": "Constants",
+          "type": "Constants",
+          "kind": "constant",
+          "id": "Duck::Constants",
+          "members": [
+            {
+              "id": "Duck::MAX_VELOCITY",
+              "title": "MAX_VELOCITY",
+              "signature": "",
+              "comment": "",
+              "kind": "constant",
+              "labels": [
+                {
+                  "id": "Constant",
+                  "title": "constant"
+                }
+              ]
+            }
+          ]
+        },
+        {
+          "title": "Class Methods",
+          "type": "ClassMethods",
+          "kind": "method",
+          "level": "class",
+          "id": "Duck::ClassMethods",
+          "members": [
+            {
+              "id": "Duck::new",
+              "title": "new",
+              "signature": "new(domestic, rubber)",
+              "comment": "<p>Creates a new duck.</p>",
+              "code": "<span class=\"ruby-comment\"># File example.rb, line 114</span>\n<span class=\"ruby-keyword\">def</span> <span class=\"ruby-identifier\">initialize</span>(<span class=\"ruby-identifier\">domestic</span>, <span class=\"ruby-identifier\">rubber</span>)\n  <span class=\"ruby-ivar\">@domestic</span> = <span class=\"ruby-identifier\">domestic</span>\n  <span class=\"ruby-ivar\">@rubber</span> = <span class=\"ruby-identifier\">rubber</span>\n  <span class=\"ruby-identifier\">@@rubber_ducks</span> <span class=\"ruby-operator\">&lt;&lt;</span> <span class=\"ruby-keyword\">self</span> <span class=\"ruby-keyword\">if</span> <span class=\"ruby-identifier\">rubber</span>\n<span class=\"ruby-keyword\">end</span>",
+              "level": "class",
+              "visibility": "public",
+              "kind": "method",
+              "labels": [
+                {
+                  "id": "ClassMethod",
+                  "title": "class method"
+                },
+                {
+                  "id": "Public",
+                  "title": "public"
+                }
+              ]
+            },
+            {
+              "id": "Duck::rubber_ducks",
+              "title": "rubber_ducks",
+              "signature": "rubber_ducks()",
+              "comment": "<p>Returns list of all rubber ducks.</p>",
+              "code": "<span class=\"ruby-comment\"># File example.rb, line 109</span>\n<span class=\"ruby-keyword\">def</span> <span class=\"ruby-keyword\">self</span>.<span class=\"ruby-identifier\">rubber_ducks</span>\n  <span class=\"ruby-identifier\">@@rubber_ducks</span>\n<span class=\"ruby-keyword\">end</span>",
+              "level": "class",
+              "visibility": "public",
+              "kind": "method",
+              "labels": [
+                {
+                  "id": "ClassMethod",
+                  "title": "class method"
+                },
+                {
+                  "id": "Public",
+                  "title": "public"
+                }
+              ]
+            }
+          ]
+        },
+        {
+          "title": "Instance Attributes",
+          "type": "InstanceAttributes",
+          "kind": "attribute",
+          "level": "instance",
+          "id": "Duck::InstanceAttributes",
+          "members": [
+            {
+              "id": "Duck::domestic",
+              "title": "domestic",
+              "signature": "",
+              "comment": "<p>True for domestic ducks.</p>",
+              "level": "instance",
+              "visibility": "public",
+              "kind": "attribute",
+              "labels": [
+                {
+                  "id": "InstanceAttribute",
+                  "title": "instance attribute"
+                },
+                {
+                  "id": "Public",
+                  "title": "public"
+                }
+              ]
+            },
+            {
+              "id": "Duck::rubber",
+              "title": "rubber",
+              "signature": "",
+              "comment": "<p>True for rubber ducks.</p>",
+              "level": "instance",
+              "visibility": "public",
+              "kind": "attribute",
+              "labels": [
+                {
+                  "id": "InstanceAttribute",
+                  "title": "instance attribute"
+                },
+                {
+                  "id": "Public",
+                  "title": "public"
+                }
+              ]
+            }
+          ]
+        },
+        {
+          "title": "Instance Methods",
+          "type": "InstanceMethods",
+          "kind": "method",
+          "level": "instance",
+          "id": "Duck::InstanceMethods",
+          "members": [
+            {
+              "id": "Duck::quack",
+              "title": "quack",
+              "signature": "quack()",
+              "comment": "<p>Implements quacking</p>",
+              "code": "<span class=\"ruby-comment\"># File example.rb, line 86</span>\n<span class=\"ruby-keyword\">def</span> <span class=\"ruby-identifier\">quack</span>\n  <span class=\"ruby-string\">&#39;quack&#39;</span>\n<span class=\"ruby-keyword\">end</span>",
+              "level": "instance",
+              "visibility": "private",
+              "kind": "method",
+              "labels": [
+                {
+                  "id": "InstanceMethod",
+                  "title": "instance method"
+                },
+                {
+                  "id": "Private",
+                  "title": "private"
+                }
+              ]
+            },
+            {
+              "id": "Duck::speak",
+              "title": "speak",
+              "signature": "speak() { |speech| ... }",
+              "comment": "<p><a href=\"Duck.html\">Duck</a> overrides generic implementation.</p>",
+              "code": "<span class=\"ruby-comment\"># File example.rb, line 80</span>\n<span class=\"ruby-keyword\">def</span> <span class=\"ruby-identifier\">speak</span>\n  <span class=\"ruby-identifier\">speech</span> = <span class=\"ruby-identifier\">quack</span>\n  <span class=\"ruby-keyword\">yield</span> <span class=\"ruby-identifier\">speech</span>\n<span class=\"ruby-keyword\">end</span>",
+              "level": "instance",
+              "visibility": "public",
+              "kind": "method",
+              "labels": [
+                {
+                  "id": "InstanceMethod",
+                  "title": "instance method"
+                },
+                {
+                  "id": "Public",
+                  "title": "public"
+                }
+              ]
+            },
+            {
+              "id": "Duck::useful?",
+              "title": "useful?",
+              "signature": "Bird.useful? -> bool",
+              "comment": "<p>Checks if this duck is a useful one.</p>",
+              "code": "<span class=\"ruby-comment\"># File example.rb, line 124</span>\n<span class=\"ruby-keyword\">def</span> <span class=\"ruby-identifier\">useful?</span>\n  <span class=\"ruby-ivar\">@domestic</span> <span class=\"ruby-operator\">||</span> <span class=\"ruby-ivar\">@rubber</span>\n<span class=\"ruby-keyword\">end</span>",
+              "level": "instance",
+              "visibility": "public",
+              "kind": "method",
+              "labels": [
+                {
+                  "id": "InstanceMethod",
+                  "title": "instance method"
+                },
+                {
+                  "id": "Public",
+                  "title": "public"
+                }
+              ]
+            }
+          ]
+        }
+      ],
+      "labels": [
+        {
+          "id": "Class",
+          "title": "class"
+        }
+      ]
+    },
+    {
+      "id": "Object",
+      "title": "Object",
+      "kind": "class",
+      "comment": "",
+      "groups": [
+        {
+          "title": "Constants",
+          "type": "Constants",
+          "kind": "constant",
+          "id": "Object::Constants",
+          "members": [
+            {
+              "id": "Object::DEFAULT_DUCK_VELOCITY",
+              "title": "DEFAULT_DUCK_VELOCITY",
+              "signature": "",
+              "comment": "<p>Default velocity for a flying duck.</p>",
+              "kind": "constant",
+              "labels": [
+                {
+                  "id": "Constant",
+                  "title": "constant"
+                }
+              ]
+            }
+          ]
+        }
+      ],
+      "labels": [
+        {
+          "id": "Class",
+          "title": "class"
+        }
+      ]
+    },
+    {
+      "id": "Waterfowl",
+      "title": "Waterfowl",
+      "kind": "module",
+      "comment": "<p>A mixin for waterfowl creatures.</p>",
+      "groups": [
+        {
+          "title": "Instance Methods",
+          "type": "InstanceMethods",
+          "kind": "method",
+          "level": "instance",
+          "id": "Waterfowl::InstanceMethods",
+          "members": [
+            {
+              "id": "Waterfowl::swim",
+              "title": "swim",
+              "signature": "swim()",
+              "comment": "<p>Swimming helper.</p>",
+              "code": "<span class=\"ruby-comment\"># File example.rb, line 19</span>\n<span class=\"ruby-keyword\">def</span> <span class=\"ruby-identifier\">swim</span>\n  <span class=\"ruby-identifier\">puts</span> <span class=\"ruby-string\">&#39;swimming around&#39;</span>\n<span class=\"ruby-keyword\">end</span>",
+              "level": "instance",
+              "visibility": "public",
+              "kind": "method",
+              "labels": [
+                {
+                  "id": "InstanceMethod",
+                  "title": "instance method"
+                },
+                {
+                  "id": "Public",
+                  "title": "public"
+                }
+              ]
+            }
+          ]
+        }
+      ],
+      "labels": [
+        {
+          "id": "Module",
+          "title": "module"
+        }
+      ]
+    }
+  ]
+}

data/docs/example_output/main.css

@@ -0,0 +1,210 @@
+@charset "UTF-8";
+body {
+  margin: 0 10px 10px 2px;
+  font-family: RobotoRegular;
+  font-size: 16px; }
+body header {
+  font-family: RalewaySemiBold; }
+body a {
+  color: black;
+  text-decoration: none; }
+body summary {
+  outline: none;
+  display: inline-block; }
+body summary::-webkit-details-marker {
+  display: none; }
+body .label {
+  display: inline-block;
+  margin: 0 2px 0 2px; }
+body .labelModule {
+  background-color: #dff0d8;
+  color: #3c763d;
+  font-size: 12px;
+  padding: 3px 5px;
+  border-radius: 8px; }
+body .labelClass {
+  background-color: #dff0d8;
+  color: #3c763d;
+  font-size: 12px;
+  padding: 3px 5px;
+  border-radius: 8px; }
+body .labelIncluded {
+  background-color: #dff0d8;
+  color: #3c763d;
+  font-size: 12px;
+  padding: 3px 5px;
+  border-radius: 8px; }
+body .labelExtended {
+  background-color: #dff0d8;
+  color: #3c763d;
+  font-size: 12px;
+  padding: 3px 5px;
+  border-radius: 8px; }
+body .labelConstant {
+  background-color: #dff0d8;
+  color: #3c763d;
+  font-size: 12px;
+  padding: 3px 5px;
+  border-radius: 8px; }
+body .labelClassMethod {
+  background-color: #dff0d8;
+  color: #3c763d;
+  font-size: 12px;
+  padding: 3px 5px;
+  border-radius: 8px; }
+body .labelInstanceMethod {
+  background-color: #d9edf7;
+  color: #31708f;
+  font-size: 12px;
+  padding: 3px 5px;
+  border-radius: 8px; }
+body .labelClassAttribute {
+  background-color: #d9edf7;
+  color: #31708f;
+  font-size: 12px;
+  padding: 3px 5px;
+  border-radius: 8px; }
+body .labelInstanceAttribute {
+  background-color: #dff0d8;
+  color: #3c763d;
+  font-size: 12px;
+  padding: 3px 5px;
+  border-radius: 8px; }
+body .labelPublic {
+  background-color: #fcf8e3;
+  color: #8a6d3b;
+  font-size: 12px;
+  padding: 3px 5px;
+  border-radius: 8px; }
+body .labelPrivate {
+  background-color: #fcf8e3;
+  color: #8a6d3b;
+  font-size: 12px;
+  padding: 3px 5px;
+  border-radius: 8px; }
+body .labelProtected {
+  background-color: #fcf8e3;
+  color: #8a6d3b;
+  font-size: 12px;
+  padding: 3px 5px;
+  border-radius: 8px; }
+body .mainHeader {
+  font-size: 32px;
+  font-weight: 600;
+  padding: 10px 0;
+  margin: 10px 0 10px 350px; }
+body aside {
+  float: left;
+  width: 325px;
+  overflow: hidden;
+  position: fixed;
+  overflow-y: scroll;
+  bottom: 0;
+  top: 0;
+  padding-top: 10px;
+  padding-right: 8px; }
+body aside a {
+  display: inline-block; }
+body aside .tocClassBlock {
+  border: 1px solid rgba(136, 136, 136, 0.12);
+  background-color: #fafafa;
+  border-radius: 3px;
+  margin: 7px;
+  width: 300px;
+  position: relative;
+  padding: 0px 2px 0px 2px; }
+body aside .tocClassBlock:first-child {
+  margin-top: 0; }
+body aside .tocClassBlock summary {
+  display: flex;
+  align-items: center;
+  justify-content: center; }
+body aside .tocClassBlock summary:after {
+  content: "+";
+  color: #000;
+  font-size: 20px;
+  text-align: center;
+  width: 20px;
+  position: absolute;
+  width: 40px;
+  top: 9%;
+  right: 0px; }
+body aside .tocClassBlock[open] summary:after {
+  content: "−"; }
+body aside .tocClassBlock .tocClass {
+  flex-grow: 1;
+  width: 190px;
+  word-wrap: break-word;
+  padding: 5px 3px 5px 3px; }
+body aside .tocClassBlock .tocGroupBlock {
+  background-color: white; }
+body aside .tocClassBlock .tocGroupBlock .tocGroup {
+  display: block;
+  padding: 5px 20px;
+  border-bottom: 1px solid #f2f2f2;
+  border-left: 3px solid transparent; }
+body aside .tocClassBlock .tocGroupBlock .tocGroup:hover {
+  border-left: 3px solid #d0e7f2; }
+body aside .tocClassBlock .tocGroupBlock .tocGroup:last-child {
+  border-bottom: none; }
+body main {
+  margin-left: 340px; }
+body main .classBlock {
+  border: 1px solid #d9d9d9;
+  border-radius: 5px;
+  margin-top: 15px; }
+body main .classBlock .classHeader {
+  display: flex;
+  align-items: center;
+  justify-content: center;
+  background: #f3f3f3;
+  color: black;
+  padding: 5px;
+  font-size: 22px; }
+body main .classBlock .classHeader .className {
+  flex-grow: 1;
+  padding-left: 4px; }
+body main .classBlock .classComment {
+  padding: 5px 5px 0 13px; }
+body main .classBlock .groupBlock {
+  border-top: 1px solid #d9d9d9;
+  padding: 5px 5px 0 5px;
+  border-radius: 5px; }
+body main .classBlock .groupBlock .groupHeader {
+  background: none;
+  color: black;
+  padding: 7px;
+  font-size: 18px; }
+body main .classBlock .groupBlock .memberBlock {
+  padding-bottom: 15px;
+  border-bottom: 1px solid #d9d9d9;
+  margin: 10px 30px 0 30px; }
+body main .classBlock .groupBlock .memberBlock:last-child {
+  border-bottom: none; }
+body main .classBlock .groupBlock .memberBlock .memberHeader {
+  display: flex;
+  align-items: center;
+  justify-content: center; }
+body main .classBlock .groupBlock .memberBlock .memberHeader .memberName {
+  flex-grow: 1;
+  font-weight: bolder;
+  padding-left: 4px; }
+body main .classBlock .groupBlock .memberBlock .memberSignature {
+  font-size: 15px; }
+body main .classBlock .groupBlock .memberBlock .memberComment {
+  font-size: 16px; }
+body main .classBlock .groupBlock .memberBlock .memberCode {
+  border: 1px solid #d9d9d9;
+  border-radius: 6px; }
+body main .classBlock .groupBlock .memberBlock .memberCode summary:before {
+  display: inline-block;
+  vertical-align: middle;
+  padding: 0 8px 0 8px;
+  content: "+";
+  font-size: 20px;
+  color: #000; }
+body main .classBlock .groupBlock .memberBlock .memberCode[open] summary:before {
+  content: "−"; }
+body main .classBlock .groupBlock .memberBlock .memberCode pre {
+  padding: 0 8px 0 8px;
+  font-size: 14px; }

data/docs/example_output/onelight.css

@@ -0,0 +1,22 @@
+.memberCode {
+  background: #fafafa; }
+.memberCode .ruby-constant {
+  color: #986801; }
+.memberCode .ruby-keyword {
+  color: #a626a4; }
+.memberCode .ruby-ivar {
+  color: #e45649; }
+.memberCode .ruby-operator {
+  color: #4078f2; }
+.memberCode .ruby-identifier {
+  color: #986801; }
+.memberCode .ruby-node {
+  color: #c18401; }
+.memberCode .ruby-comment {
+  color: #0120bc; }
+.memberCode .ruby-regexp {
+  color: #0184bc; }
+.memberCode .ruby-value {
+  color: #ca1243; }
+.memberCode .ruby-string {
+  color: #50a14f; }

data/lib/rdoc/discover.rb

@@ -0,0 +1 @@
+require 'solarfish'