rtfdoc 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6cf4dfb3f18bf5958f797ccf1ee055c96befecb7cf2df7a1b7256412f254ff5f
+  data.tar.gz: 39bb4ecdb1f6279084be35ed1c6dc41ac73e596c7a442ed3f37a9817858387f5
+SHA512:
+  metadata.gz: a343b4d4783ff8e42b53298de89340a9472dcb6ded881d69bf34dee7c7fdfd5aa6879795a26c38ea5e535313ea7718082a99be2b77c41958529b35271674b4ae
+  data.tar.gz: 2c7cdf91e981af582f8c14569d86c3a74ef91bc3f9070e1c640db828d4ada8d47224451b31833f44017e6515c748109d910f09ad8555822816e3841ef205dff7

data/.gitignore

@@ -0,0 +1,6 @@
+.sass-cache/
+.byebug_history
+node_modules/
+yarn.lock
+dist/
+build/

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+before_install: gem install bundler -v 1.17.3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at cocchi.c@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'benchmark-ips'
+  gem 'byebug'
+  gem 'irb'
+end

data/Gemfile.lock

@@ -0,0 +1,40 @@
+PATH
+  remote: .
+  specs:
+    rtfdoc (0.1.0)
+      erubi (~> 1.9.0)
+      redcarpet (~> 3.5.0)
+      rouge (~> 3.20.0)
+      thor (~> 1.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    benchmark-ips (2.8.2)
+    byebug (11.1.3)
+    erubi (1.9.0)
+    io-console (0.5.6)
+    irb (1.2.4)
+      reline (>= 0.0.1)
+    minitest (5.14.1)
+    rake (10.5.0)
+    redcarpet (3.5.0)
+    reline (0.1.4)
+      io-console (~> 0.5)
+    rouge (3.20.0)
+    thor (1.0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  benchmark-ips
+  bundler (~> 1.17)
+  byebug
+  irb
+  minitest (~> 5.0)
+  rake (~> 10.0)
+  rtfdoc!
+
+BUNDLED WITH
+   1.17.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 ccocchi
+
+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,35 @@
+# RTFDoc
+
+Generate beautiful static documentation for your APIs.
+
+## Installation
+
+You can install the gem globally using the following command. It will install the `rtfdoc` binary for generating new projects from scratch.
+
+```
+$ gem install rtfdoc
+```
+
+## Usage
+
+You can scaffold a new project using `rtfdoc bootstrap <project_name>`. It will create a skeleton for your project, and generate needed configuration files.
+
+Once in your project directory, you can install ruby dependencies using `bundle install` and javascript dependencies using `yarn install`.
+
+By convention, you should put your documentation content under the `content/` directory. If you don't follow this convention, don't forget to modify the configuration file as well.
+
+When you're done writing your documentation, you can define the order they will appear on your page using the ` config.yml` file (see `examples/`).
+
+Finally, you can use `yarn run build` to generate the HTML/CSS/JS files.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ccocchi/rtfdoc. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the RTFDoc project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ccocchi/rtfdoc/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/rtfdoc

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/rtfdoc'
+require 'rtfdoc/cli'
+
+RTFDoc::CLI.start

data/lib/rtfdoc.rb

@@ -0,0 +1,354 @@
+require 'erubi'
+require 'rouge'
+require 'redcarpet'
+require 'tmpdir'
+
+module RTFDoc
+  class AttributesComponent
+    def initialize(raw_attrs, title)
+      @attributes = YAML.load(raw_attrs)
+      @title      = title
+    end
+
+    template = Erubi::Engine.new(File.read(File.expand_path('../src/attributes.erb', __dir__)))
+    class_eval <<-RUBY
+      define_method(:output) { #{template.src} }
+    RUBY
+  end
+
+  class Renderer < Redcarpet::Render::Base
+    attr_reader :rouge_formatter, :rouge_lexer
+
+    def initialize(*args)
+      super
+      @rouge_formatter  = Rouge::Formatters::HTML.new
+      @rouge_lexer      = Rouge::Lexers::JSON.new
+    end
+
+    def emphasis(text)
+      "<em>#{text}</em>"
+    end
+
+    def double_emphasis(text)
+      "<strong>#{text}</strong>"
+    end
+
+    def paragraph(text)
+      "<p>#{text}</p>"
+    end
+
+    def header(text, level)
+      if level == 4
+        %(<div class="header-table">#{text}</div>)
+      else
+        "<h#{level}>#{text}</h#{level}>"
+      end
+    end
+
+    def table(header, body)
+      <<-HTML
+        <div class="table-wrapper">
+          <div class="header-table">#{@table_title}</div>
+          <table>
+            <thead></thead>
+            <tbody>#{body}</tbody>
+          </table>
+        </div>
+      HTML
+    ensure
+      @table_title = nil
+    end
+
+    def table_row(content)
+      content.empty? ? nil : "<tr>#{content}</tr>"
+    end
+
+    def table_cell(content, alignment)
+      if !alignment
+        @table_title = content unless content.empty?
+        return
+      end
+
+      c = case alignment
+      when 'left'   then 'definition'.freeze
+      when 'right'  then 'property'.freeze
+      end
+
+      "<td class=\"cell-#{c}\">#{content}</td>"
+    end
+
+    def block_html(raw_html)
+      raw_html
+    end
+
+    def codespan(code)
+      "<code>#{code}</code>"
+    end
+
+    def block_code(code, language)
+      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
+      end
+    end
+  end
+
+  class Template
+    def initialize(sections)
+      @content = sections.map(&:output).join
+      @menu_content = sections.map(&:menu_output).join
+    end
+
+    def output
+      template = Erubi::Engine.new(File.read(File.expand_path('../src/index.html.erb', __dir__)))
+      eval(template.src)
+    end
+  end
+
+  module RenderAsSection
+    def self.included(other)
+      other.attr_accessor(:include_show_button)
+    end
+
+    template = Erubi::Engine.new(File.read(File.expand_path('../src/section.erb', __dir__)))
+    module_eval <<-RUBY
+      define_method(:output) { #{template.src} }
+    RUBY
+
+    def content_to_html
+      RTFDoc.markdown_to_html(@content)
+    end
+
+    def example_to_html
+      @example ? RTFDoc.markdown_to_html(@example) : nil
+    end
+  end
+
+  module Anchorable
+    def anchor(content, class_list: nil)
+      %(<a href="##{anchor_id}") <<
+        (class_list ? %( class="#{class_list}") : '') <<
+        "><span>#{content}</span></a>"
+    end
+  end
+
+  class Section
+    include RenderAsSection
+    include Anchorable
+
+    attr_reader :name, :method, :path
+
+    def initialize(name, raw_content, resource: nil)
+      @name     = name
+      @resource = resource
+      metadata  = nil
+
+      if raw_content.start_with?('---')
+        idx = raw_content.index('---', 4)
+        raise 'bad format' unless idx
+        parse_metadata(YAML.load(raw_content.slice!(0, idx + 3)))
+      end
+
+      raise 'missing metadata' if resource && !@path && !@method
+
+      @content, @example = raw_content.split('$$$')
+    end
+
+    def id
+      @id ||= name
+    end
+
+    def anchor_id
+      @resource ? "#{@resource}-#{id}" : id
+    end
+
+    def resource_name
+      @resource
+    end
+
+    def menu_output
+      "<li>#{anchor(menu_title)}</li>"
+    end
+
+    def signature
+      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 menu_title
+      @menu_title || name.capitalize
+    end
+
+    def parse_metadata(hash)
+      @id           = hash['id']
+      @menu_title   = hash['menu_title']
+      @path         = hash['path']
+      @method       = hash['method']
+    end
+  end
+
+  class ResourceDesc
+    include RenderAsSection
+    include Anchorable
+
+    attr_reader :resource_name
+
+    def initialize(resource_name, content)
+      @resource_name  = resource_name
+      @content        = content
+    end
+
+    def name
+      'desc'
+    end
+
+    def anchor_id
+      "#{resource_name}-desc"
+    end
+
+    def generate_example(sections)
+      endpoints   = sections.reject { |s| s.name == 'desc' || s.name == 'object' }
+      signatures  = endpoints.each_with_object("") do |e, res|
+        res << %(<div class="resource-sig">#{e.signature}</div>)
+      end
+
+      @example = <<-HTML
+      <div class="section-response">
+        <div class="response-topbar">ENDPOINTS</div>
+        <div class="section-endpoints">#{signatures}</div>
+      </div>
+      HTML
+    end
+
+    def example_to_html
+      @example
+    end
+  end
+
+  class Resource
+    DEFAULT = %w[desc object index show create update destroy]
+
+    def self.build(name, paths, endpoints: nil)
+      endpoints ||= DEFAULT
+      desc = nil
+
+      sections = endpoints.each_with_object([]) do |endpoint, res|
+        filename = paths[endpoint]
+        next unless filename
+
+        content = File.read(filename)
+
+        if endpoint == 'desc'
+          desc = ResourceDesc.new(name, content)
+          res << desc
+        else
+          res << Section.new(endpoint, content, resource: name)
+        end
+      end
+
+      desc&.generate_example(sections)
+      Resource.new(name, sections)
+    end
+
+    attr_reader :name, :sections
+
+    def initialize(name, sections)
+      @name, @sections = name, sections
+    end
+
+    def output
+      head, *tail = sections
+      head.include_show_button = true
+
+      inner = sections.map(&:output).join("\n")
+      %(<section class="head-section">#{inner}</section>)
+    end
+
+    def menu_output
+      head, *tail = sections
+      <<-HTML
+        <li data-anchor="#{name}">
+          #{head.anchor(name.capitalize, class_list: 'expandable')}
+          <ul>#{tail.map(&:menu_output).join}</ul>
+        </li>
+      HTML
+    end
+  end
+
+  class Generator
+    attr_reader :renderer, :config
+
+    def initialize(config_path)
+      @config       = YAML.load_file(config_path)
+      @content_dir  = @config['content_dir']
+      @parts        = {}
+    end
+
+    def run
+      tree = build_content_tree
+
+      nodes = config['resources'].map do |rs|
+        if rs.is_a?(Hash)
+          name, endpoints = rs.each_pair.first
+          paths = tree[name]
+          Resource.build(name, paths, endpoints: endpoints)
+        else
+          paths = tree[rs]
+          paths.is_a?(Hash) ? Resource.build(rs, paths) : Section.new(rs, File.read(paths))
+        end
+      end
+
+      out = File.new("#{Dir.tmpdir}/rtfdoc_output.html", 'w')
+      out.write(Template.new(nodes).output)
+      out.close
+    end
+
+    private
+
+    def build_content_tree
+      tree        = {}
+      slicer      = (@content_dir.length + 1)..-1
+      ext_slicer  = -3..-1
+
+      Dir.glob("#{@content_dir}/**/*.md").each do |path|
+        str       = path.slice(slicer)
+        parts     = str.split('/')
+        filename  = parts.pop
+        filename.slice!(ext_slicer)
+
+        leaf = parts.reduce(tree) { |h, part| h[part] || h[part] = {} }
+        leaf[filename] = path
+      end
+
+      tree
+    end
+  end
+
+  def self.renderer
+    @renderer ||= Redcarpet::Markdown.new(Renderer, {
+      underline:            true,
+      space_after_headers:  true,
+      fenced_code_blocks:   true,
+      no_intra_emphasis:    true,
+      tables:               true
+    })
+  end
+
+  def self.markdown_to_html(text)
+    renderer.render(text)
+  end
+end