rdoc-generator-solarfish 0.0.2

data/data/rdoc-generator-solarfish/themes/common/fonts/LICENSE.Roboto

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/data/rdoc-generator-solarfish/themes/common/syntax/LICENSE

@@ -0,0 +1,3 @@
+one-light-syntax:
+    Homepage: https://github.com/atom/one-light-syntax
+    License: LICENSE.onelight

data/data/rdoc-generator-solarfish/themes/common/syntax/LICENSE.onelight

@@ -0,0 +1,20 @@
+Copyright (c) 2016 GitHub Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/data/rdoc-generator-solarfish/themes/common/syntax/onelight.sass

@@ -0,0 +1,47 @@
+$bg:      hsl(230, 1%, 98%)
+
+$hue-0:   hsl(230, 99%, 37%)
+
+$hue-1:   hsl(198, 99%, 37%)
+$hue-2:   hsl(221, 87%, 60%)
+$hue-3:   hsl(301, 63%, 40%)
+$hue-4:   hsl(119, 34%, 47%)
+
+$hue-5:   hsl(  5, 74%, 59%)
+$hue-5-2: hsl(344, 84%, 43%)
+
+$hue-6:   hsl(41, 99%, 30%)
+$hue-6-2: hsl(41, 99%, 38%)
+
+.memberCode
+  background: $bg
+
+  .ruby-constant
+    color: $hue-6
+
+  .ruby-keyword
+    color: $hue-3
+
+  .ruby-ivar
+    color: $hue-5
+
+  .ruby-operator
+    color: $hue-2
+
+  .ruby-identifier
+    color: $hue-6
+
+  .ruby-node
+    color: $hue-6-2
+
+  .ruby-comment
+    color: $hue-0
+
+  .ruby-regexp
+    color: $hue-1
+
+  .ruby-value
+    color: $hue-5-2
+
+  .ruby-string
+    color: $hue-4

data/data/rdoc-generator-solarfish/themes/light/main.sass

@@ -0,0 +1,215 @@
+@mixin label($bgColor, $textColor)
+  background-color: $bgColor
+  color: $textColor
+  font-size: 12px
+  padding: 3px 5px
+  border-radius: 8px
+
+body
+  margin: 0 10px 10px 2px
+  font-family: RobotoRegular
+  font-size: 16px
+
+  header
+    font-family: RalewaySemiBold
+
+  a
+    color: black
+    text-decoration: none
+
+  summary
+    outline: none
+    display: inline-block
+
+    &::-webkit-details-marker
+      display: none
+
+  .label
+    display: inline-block
+    margin: 0 2px 0 2px
+
+    &Module
+      @include label(#dff0d8, #3c763d)
+
+    &Class
+      @include label(#dff0d8, #3c763d)
+
+    &Included
+      @include label(#dff0d8, #3c763d)
+
+    &Extended
+      @include label(#dff0d8, #3c763d)
+
+    &Constant
+      @include label(#dff0d8, #3c763d)
+
+    &ClassMethod
+      @include label(#dff0d8, #3c763d)
+
+    &InstanceMethod
+      @include label(#d9edf7, #31708f)
+
+    &ClassAttribute
+      @include label(#d9edf7, #31708f)
+
+    &InstanceAttribute
+      @include label(#dff0d8, #3c763d)
+
+    &Public
+      @include label(#fcf8e3, #8a6d3b)
+
+    &Private
+      @include label(#fcf8e3, #8a6d3b)
+
+    &Protected
+      @include label(#fcf8e3, #8a6d3b)
+
+  .mainHeader
+    font-size: 32px
+    font-weight: 600
+    padding: 10px 0
+    margin: 10px 0 10px 350px
+
+  aside
+    float: left
+    width: 325px
+    overflow: hidden
+    position: fixed
+    overflow-y: scroll
+    bottom: 0
+    top: 0
+    padding-top: 10px
+    padding-right: 8px
+
+    a
+      display: inline-block
+
+    .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
+
+      &:first-child
+        margin-top: 0
+
+      summary
+        display: flex
+        align-items: center
+        justify-content: center
+
+        &:after
+          content: "+"
+          color: #000
+          font-size: 20px
+          text-align: center
+          width: 20px
+          position: absolute
+          width: 40px
+          top: 9%
+          right: 0px
+
+      &[open] summary:after
+        content: "−"
+
+      .tocClass
+        flex-grow: 1
+        width: 190px
+        word-wrap: break-word
+        padding: 5px 3px 5px 3px
+
+      .tocGroupBlock
+        background-color: white
+
+        .tocGroup
+          display: block
+          padding: 5px 20px
+          border-bottom: 1px solid #f2f2f2
+          border-left: 3px solid transparent
+
+          &:hover
+            border-left: 3px solid #d0e7f2
+
+          &:last-child
+            border-bottom: none
+
+  main
+    margin-left: 340px
+
+    .classBlock
+      border: 1px solid #d9d9d9
+      border-radius: 5px
+      margin-top: 15px
+
+      .classHeader
+        display: flex
+        align-items: center
+        justify-content: center
+        background: #f3f3f3
+        color: black
+        padding: 5px
+        font-size: 22px
+
+        .className
+          flex-grow: 1
+          padding-left: 4px
+
+      .classComment
+        padding: 5px 5px 0 13px
+
+      .groupBlock
+        border-top: 1px solid #d9d9d9
+        padding: 5px 5px 0 5px
+        border-radius: 5px
+
+        .groupHeader
+          background: none
+          color: black
+          padding: 7px
+          font-size: 18px
+
+        .memberBlock
+          padding-bottom: 15px
+          border-bottom: 1px solid #d9d9d9
+          margin: 10px 30px 0 30px
+
+          &:last-child
+            border-bottom: none
+
+          .memberHeader
+            display: flex
+            align-items: center
+            justify-content: center
+
+            .memberName
+              flex-grow: 1
+              font-weight: bolder
+              padding-left: 4px
+
+          .memberSignature
+            font-size: 15px
+
+          .memberComment
+            font-size: 16px
+
+          .memberCode
+            border: 1px solid #d9d9d9
+            border-radius: 6px
+
+            summary:before
+              display: inline-block
+              vertical-align: middle
+              padding: 0 8px 0 8px
+              content: "+"
+              font-size: 20px
+              color: #000
+
+            &[open] summary:before
+              content: "−"
+
+            pre
+              padding: 0 8px 0 8px
+              font-size: 14px

data/data/rdoc-generator-solarfish/themes/light.yml

@@ -0,0 +1,16 @@
+head:
+  styles:
+    -
+      file: common/syntax/onelight.sass
+    -
+      file: light/main.sass
+  fonts:
+    -
+      file: common/fonts/Roboto-Regular.ttf
+      family: RobotoRegular
+    -
+      file: common/fonts/Raleway-Regular.ttf
+      family: RalewayRegular
+    -
+      file: common/fonts/Raleway-SemiBold.ttf
+      family: RalewaySemiBold

data/docs/example.rb

@@ -0,0 +1,142 @@
+##
+# === RDoc::Generator::SolarFish example.
+#
+# This example employs variois RDoc features to demonstrate
+# generator output.
+#
+# ---
+#
+# Links:
+#
+#  1. {Project Home Page}[https://github.com/rbdoc/rdoc-generator-solarfish)
+#  2. {RDoc Documentation}[http://ruby-doc.org/stdlib-2.0.0/libdoc/rdoc/rdoc/RDoc/Markup.html]
+#
+
+##
+# A mixin for waterfowl creatures.
+module Waterfowl
+  # Swimming helper.
+  def swim
+    puts 'swimming around'
+  end
+end
+
+##
+# The base class for all birds.
+class Bird
+  ##
+  # Produce some noise.
+  #--
+  # FIXME: maybe extract this to a base class +Animal+?
+  #++
+  def speak # :yields: text
+    puts 'generic tweeting'
+    yield 'tweet'
+    yield 'tweet'
+  end
+
+  # Fly somewhere.
+  #
+  # Flying is the most critical feature of birds.
+  #
+  # :args: direction, velocity
+  #
+  # :call-seq:
+  #   Bird.fly(symbol, number) -> bool
+  #   Bird.fly(string, number) -> bool
+  #
+  # = Example
+  #
+  #   fly(:south, 70)
+  def fly(direction, velocity)
+    _fly_impl(direction, velocity)
+  end
+
+  def _fly_impl(_direction, _velocity) # :nodoc:
+    puts "flying away: direction=#{direction}, velocity=#{velocity}"
+  end
+end
+
+##
+# A duck is a Waterfowl Bird.
+#
+# Features:
+#
+#  bird::
+#
+#    * speak
+#    * fly
+#
+#  waterfowl::
+#
+#    * swim
+class Duck
+  extend Animal
+  include Waterfowl
+
+  # :section: Bird overrides
+
+  # Duck overrides generic implementation.
+  def speak
+    speech = quack
+    yield speech
+  end
+
+  # Implements quacking
+  def quack
+    'quack'
+  end
+
+  private :quack
+
+  # :section: Duck extensions
+
+  # True for domestic ducks.
+  attr_accessor :domestic
+
+  # True for rubber ducks.
+  attr_reader :rubber
+
+  MAX_VELOCITY = 130 # Maximum velocity for a flying duck.
+
+  ##
+  # Global list of all rubber ducks.
+  #
+  # Use when in trouble.
+  @@rubber_ducks = []
+
+  # Returns list of all rubber ducks.
+  def self.rubber_ducks
+    @@rubber_ducks
+  end
+
+  # Creates a new duck.
+  def initialize(domestic, rubber)
+    @domestic = domestic
+    @rubber = rubber
+    @@rubber_ducks << self if rubber
+  end
+
+  # Checks if this duck is a useful one.
+  #
+  # :call-seq:
+  #   Bird.useful? -> bool
+  def useful?
+    @domestic || @rubber
+  end
+end
+
+# Default velocity for a flying duck.
+DEFAULT_DUCK_VELOCITY = 70
+
+# Default rubber duck.
+#
+# *Note:*
+#  Global variables are evil, but rubber ducks are worth it.
+$default_rubber_duck = Duck.new(false, true)
+
+# Domestic rubber duck.
+#
+# *Note:*
+#  This is weird... Thus not making it global.
+domestic_rubber_duck = Duck.new(true, true)

data/docs/example_output/created.rid

@@ -0,0 +1,2 @@
+Fri, 07 Jun 2019 16:14:23 +0300
+./example.rb	Fri, 07 Jun 2019 16:03:00 +0300