rdoc-generator-solarfish 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 28f7541a023cad2c48f01845b5737d76921a23dc3739bf1866bf9f5f4347b2a7
+  data.tar.gz: 3c6ad8b452343f5315bcb50981533280f79c8427f3e059220e2b3ef607d527e7
+SHA512:
+  metadata.gz: 7a15bebfc2bf46263da39e21c692a92601f4e53b5cdc77e624b7f7cf938f80384880844e821a86b8c86d1c53fb095f9d842db502bbbb84ea643495a992d22aba
+  data.tar.gz: 1b562c560027b34fa74a55841361fa86b03496af5edaedcd63ef07326c46649430c73bd33ea1bf9878291fa7cbe22264c58e90fc872c3934ff5bc0320f23dd91

data/.gitignore

@@ -0,0 +1,13 @@
+Gemfile.lock
+.bundle
+.sass-cache
+pkg
+*.gem
+
+# swap
+[._]*.s[a-w][a-z]
+[._]s[a-w][a-z]
+*~
+
+# auto-generated rdoc output
+doc

data/.rubocop.yml

@@ -0,0 +1,26 @@
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 90

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 2.3.3
+  - 2.6.3
+script:
+    - rake rubocop
+    - rake test
+    - rake install
+    - rake example

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Victor Gaydov
+
+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/README.md

@@ -0,0 +1,175 @@
+# RDoc::Generator::SolarFish [![Gem Version](https://badge.fury.io/rb/rdoc-generator-solarfish.svg)](https://badge.fury.io/rb/rdoc-generator-solarfish) [![Build Status](https://travis-ci.org/rbdoc/rdoc-generator-solarfish.svg?branch=master)](https://travis-ci.org/rbdoc/rdoc-generator-solarfish)
+
+Single page HTML5 generator for Ruby RDoc.
+
+## Features
+
+* Generate single page HTML5 documentation suitable for offline use.
+* Templates support using [Slim](http://slim-lang.com/).
+* Themes support.
+* Out of the box [Sass](http://sass-lang.com/) and SCSS support.
+* Filter classes or members by regex.
+
+## Example
+
+See example output:
+
+* [HTML](https://rbdoc.github.io/rdoc-generator-solarfish/example_output/)
+* [JSON](docs/example_output/index.json)
+
+It was generated from the [`example.rb`](docs/example.rb) in the [`docs`](docs) directory.
+
+Generate locally:
+
+```
+$ rake install
+$ rake example
+```
+
+## Installation
+
+From rubygems:
+
+```
+gem install rdoc-generator-solarfish
+```
+
+From sources:
+
+```
+$ rake install
+```
+
+## Usage
+
+#### From command line
+
+Display all supported command line options:
+
+```
+$ rdoc --help
+```
+
+Generate documentation under the `doc/` directory:
+
+```
+$ rdoc -f solarfish --title "My Project"
+```
+
+Use custom directory and file name:
+
+```
+$ rdoc -f solarfish --output superdoc --sf-htmlfile superdoc.html
+```
+
+Additionally dump JSON:
+
+```
+$ rdoc -f solarfish --output superdoc --sf-htmlfile superdoc.html --sf-jsonfile superdoc.json
+```
+
+Specify template name:
+
+```
+$ rdoc -f solarfish --sf-template onepage
+```
+
+Specify theme name:
+
+```
+$ rdoc -f solarfish --sf-theme light
+```
+
+Specify additional theme that may partially override default one:
+
+```
+$ rdoc -f solarfish --sf-theme light --sf-theme ./custom_theme.yml
+```
+
+Filter classes and members by regex:
+
+```
+$ rdoc -f solarfish --sf-filter-classes '^Test.*' --sf-filter-members '^test_.*'
+```
+
+#### From code
+
+```ruby
+require 'rdoc/rdoc'
+
+options = RDoc::Options.new
+options.setup_generator 'solarfish'
+
+options.files = ['input_file.rb']
+options.op_dir = 'output_dir'
+options.title = 'Page title'
+
+options.sf_htmlfile = 'output_file.html'
+options.sf_jsonfile = 'output_file.json'
+
+options.sf_prefix = '/url_prefix'
+
+options.sf_template = '/path/to/template.slim'
+options.sf_themes = ['/path/to/theme.yml']
+
+options.sf_filter_classes = '^Test.*'
+options.sf_filter_members = '^test_.*'
+
+rdoc = RDoc::RDoc.new
+rdoc.document options
+```
+
+## Configuration
+
+#### Templates
+
+The HTML page layout is defined by a [Slim](http://slim-lang.com/) template.
+
+Only one template is available out of the box:
+
+* ["onepage" template](https://github.com/rbdoc/rdoc-generator-solarfish/blob/master/data/rdoc-generator-solarfish/templates/onepage.slim)
+
+You can configure what template to use with the `--sf-template` option. Its value may be either a path or a name. In the later case, the template is searched in all locally installed gems that provide `data/rdoc-generator-solarfish/templates` directory.
+
+#### Themes
+
+The HTML page style is defined by a YAML theme. A theme file may contain Sass and SCSS stylesheet files and font files.
+
+Only one theme is available out of the box:
+
+* ["light" theme](https://github.com/rbdoc/rdoc-generator-solarfish/blob/master/data/rdoc-generator-solarfish/themes/light.yml)
+
+You can configure what theme to use with the `--sf-theme` option. Its value may be either a path or a name. In the later case, the theme is searched in all locally installed gems that provide `data/rdoc-generator-solarfish/themes` directory.
+
+Multiple themes can be used simultaneously. In this case, each next theme may add more stylesheet or font files and overrides previous themes.
+
+## Development
+
+Install development dependencies:
+
+```
+$ bundle
+```
+
+Run tests:
+
+```
+$ rake test
+```
+
+Run linters:
+
+```
+$ rake rubocop
+```
+
+Automatically fix some linter errors:
+
+```
+$ rake rubocop:auto_correct
+```
+
+## License
+
+* The source code is licensed under [MIT](LICENSE) license.
+* [Fonts](data/rdoc-generator-solarfish/themes/common/fonts) and [syntax themes](data/rdoc-generator-solarfish/themes/common/syntax) have their own licenses.

data/Rakefile

@@ -0,0 +1,28 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'rubocop/rake_task'
+
+Rake::TestTask.new do |t|
+  t.verbose = true
+  t.warning = false
+  t.test_files = FileList['test/test*.rb']
+end
+
+RuboCop::RakeTask.new(:rubocop) do |t|
+  t.patterns = ['lib/**/*.rb']
+  t.fail_on_error = false
+  t.options = [
+    '--display-cop-names'
+  ]
+end
+
+task :example do
+  sh 'cd docs &&' \
+     ' rdoc' \
+     " -t 'RDoc::Generator::SolarFish Example'" \
+     ' -a' \
+     ' -f solarfish' \
+     ' -o example_output' \
+     ' --sf-htmlfile index.html' \
+     ' --sf-jsonfile index.json'
+end

data/data/rdoc-generator-solarfish/templates/onepage.slim

@@ -0,0 +1,110 @@
+doctype html
+html
+  head
+    meta charset="UTF-8"
+
+    title
+      | #{title}
+
+    - theme.head.fonts.each do |file|
+      css:
+        @font-face {
+          font-family: '#{file.family}';
+          src: url('#{file.url}');
+        }
+
+    - theme.head.styles.each do |file|
+      link rel="stylesheet" href="#{file.url}"
+
+    - theme.head.scripts.each do |file|
+      script src="#{file.url}"
+
+    - theme.head.html.each do |file|
+      | #{{file.data}}
+
+  body
+    - theme.body.header.each do |file|
+      | #{{file.data}}
+
+    header class="mainHeader"
+      | #{title}
+
+    aside
+      - classes.each do |klass|
+
+        - if klass.groups.empty?
+          div class="tocClassBlock"
+            - klass.labels.each do |label|
+              div class="label label#{label.id}"
+                | #{label.title}
+
+            a class="tocClass" href="##{klass.id}"
+              | #{klass.title}
+
+        - else
+          details class="tocClassBlock"
+            summary
+              - klass.labels.each do |label|
+                span class="label label#{label.id}"
+                  | #{label.title}
+
+              a class="tocClass" href="##{klass.id}"
+                | #{klass.title}
+
+            div class="tocGroupBlock"
+              - klass.groups.each do |group|
+                a class="tocGroup" href="##{group.id}"
+                  | #{group.title}
+
+    main
+      - classes.each do |klass|
+
+        article class="classBlock" id="#{klass.id}"
+
+          header class="classHeader"
+            - klass.labels.each do |label|
+              div class="label label#{label.id}"
+                | #{label.title}
+
+            span class="className"
+              | #{klass.title}
+
+          - if klass.comment
+            div class="classComment"
+              | #{{klass.comment}}
+
+          - klass.groups.each do |group|
+            section class="groupBlock" id="#{group.id}"
+
+              header class="groupHeader"
+                span class="groupName"
+                  | #{group.title}
+
+              - group.members.each do |member|
+                div class="memberBlock" id="#{member.id}"
+
+                  div class="memberHeader"
+                    - member.labels.each do |label|
+                      div class="label label#{label.id}"
+                        | #{label.title}
+
+                    span class="memberName"
+                      | #{member.title}
+
+                  - if member.signature
+                    pre class="memberSignature"
+                      | #{{member.signature}}
+
+                  - if member.comment
+                    div class="memberComment"
+                      | #{{member.comment}}
+
+                  - if member.code
+                    details class="memberCode"
+                      summary
+                        | Source code
+                      pre
+                        | #{{member.code}}
+
+    - theme.body.footer.each do |file|
+      | #{{file.data}}

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

@@ -0,0 +1,7 @@
+Raleway fonts:
+    Homepage: https://github.com/impallari/Raleway
+    License: LICENSE.Raleway
+
+Roboto fonts:
+    Homepage: https://github.com/google/roboto
+    License: LICENSE.Roboto

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

@@ -0,0 +1,95 @@
+Copyright (c) 2010, Matt McInerney (matt@pixelspread.com),
+Copyright (c) 2011, Pablo Impallari (www.impallari.com|impallari@gmail.com),
+Copyright (c) 2011, Rodrigo Fuenzalida (www.rfuenzalida.com|hello@rfuenzalida.com), with Reserved Font Name Raleway
+
+This Font Software is licensed under the SIL Open Font License, Version 1.1.
+This license is copied below, and is also available with a FAQ at:
+http://scripts.sil.org/OFL
+
+
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font creation
+efforts of academic and linguistic communities, and to provide a free and
+open framework in which fonts may be shared and improved in partnership
+with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded,
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply
+to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as
+distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting -- in part or in whole -- any of the components of the
+Original Version, by changing formats or by porting the Font Software to a
+new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION & CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistribute, and sell modified and unmodified copies of the Font
+Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components,
+in Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the corresponding
+Copyright Holder. This restriction only applies to the primary font name as
+presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created
+using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.