raml_doc 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cb509f65b7d5e684ddb654c634e5df1ed362cca9
+  data.tar.gz: 74ae09b07265b376073210822400f525f57e9bad
+SHA512:
+  metadata.gz: 39891942cccebdb7c4f237f45ba9bcf8a10ceac19b7dd272f15891247bb710f96186671910158b3a8c48225fde063df30a5f44ed25e6d6b91e670492d8b7e5bd
+  data.tar.gz: 0c4e9d0972f31c8763bb54200647727fafe540150201e93b69a62308c9967a61d9d2e20221904797754cd905dd11b8a66ca5f606b5bb131da8093cc659a24313

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in raml_doc.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,88 @@
+PATH
+  remote: .
+  specs:
+    raml_doc (0.1.0)
+      kramdown (= 1.11.1)
+      raml_ruby (= 0.1.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.2.6)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    addressable (2.3.8)
+    binding_of_caller (0.7.2)
+      debug_inspector (>= 0.0.1)
+    byebug (9.0.4)
+    coderay (1.1.1)
+    coveralls (0.8.13)
+      json (~> 1.8)
+      simplecov (~> 0.11.0)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.1)
+      tins (~> 1.6.0)
+    debug_inspector (0.0.2)
+    docile (1.1.5)
+    i18n (0.7.0)
+    interception (0.5)
+    json (1.8.3)
+    json-schema (2.6.2)
+      addressable (~> 2.3.8)
+    kramdown (1.11.1)
+    method_source (0.8.2)
+    minitest (5.9.0)
+    os (0.9.6)
+    pry (0.10.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-byebug (3.4.0)
+      byebug (~> 9.0)
+      pry (~> 0.10)
+    pry-rescue (1.4.4)
+      interception (>= 0.5)
+      pry
+    pry-stack_explorer (0.4.9.2)
+      binding_of_caller (>= 0.7)
+      pry (>= 0.9.11)
+    pry-test (0.6.4)
+      os
+      pry
+      pry-byebug
+      pry-rescue
+      pry-stack_explorer
+    rake (11.1.2)
+    raml_ruby (0.1.2)
+      activesupport (>= 4.1)
+      json-schema (~> 2.5)
+      uri_template (~> 0.7)
+    simplecov (0.11.2)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    slop (3.6.0)
+    term-ansicolor (1.3.2)
+      tins (~> 1.0)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    tins (1.6.0)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    uri_template (0.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  coveralls
+  pry-test
+  rake
+  raml_doc!
+
+BUNDLED WITH
+   1.11.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Nathan Hopkins
+
+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,41 @@
+# RamlDoc
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/raml_doc`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'raml_doc'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install raml_doc
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/raml_doc.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "raml_doc"
+require "pry"
+Pry.start

data/bin/ramldoc

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+
+require "optparse"
+require "bundler/setup"
+require "raml_doc"
+
+options = {
+  :template => "default"
+}
+
+option_parser = OptionParser.new do |opts|
+  opts.banner = "Usage: ramldoc [options]"
+
+  opts.on("-f", "--file FILE", "The RAML file used to generate docs") do |f|
+    options[:file] = f
+  end
+
+  opts.on("-t", "--template [default]", "The template used to generate docs") do |t|
+    options[:template] = t
+  end
+end
+
+option_parser.parse!
+
+puts RamlDoc.generate(options[:file], options[:template])
+

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/raml_doc/raml_helper.rb

@@ -0,0 +1,7 @@
+module RamlHelper
+  def max_parameter(method)
+    method.query_parameters.max_by do |name_and_parameter|
+      name_and_parameter.first.size
+    end.last
+  end
+end

data/lib/raml_doc/templates/default.html.erb

@@ -0,0 +1,109 @@
+<!DOCTYPE html>
+<html lang="en" class="">
+  <head>
+    <title><%= @raml.title %></title>
+  </head>
+  <body>
+    <div class="container">
+      <h1>
+        <%= @raml.title %>
+        <small>Version <%= @raml.version %></small>
+      </h1>
+
+      <% @raml.resources.each do |_, resource| %>
+        <h2 id="<%= resource.resource_path_name %>" class="page-header">
+          <i class="fa fa-external-link-square" aria-hidden="true"></i>
+          <%= resource.name %>
+        </h2>
+        <p class="lead">
+          <%= resource.description %>
+        </p>
+        <% resource.methods.each do |_, method| %>
+          <div class="panel panel-default">
+            <div class="panel-heading">
+              <h3 class="panel-title">
+                <span class="label label-info"><%= method.name %></span>
+                <a class="text-muted" href="<%= @raml.base_uri + resource.resource_path %>">
+                  <%= @raml.base_uri + resource.resource_path %>
+                </a>
+                <small class="pull-right">
+                  <var><%= @raml.media_type %></var>
+                </small>
+              </h3>
+            </div>
+            <div class="panel-body">
+              <div>
+                <ul class="nav nav-tabs" role="tablist">
+                  <li role="presentation" class="active">
+                    <a href="#description-<%= resource.resource_path_name %>" aria-controls="home" role="tab" data-toggle="tab">
+                      <i class="fa fa-info-circle" aria-hidden="true"></i>
+                      Description
+                    </a>
+                  </li>
+                  <li role="presentation">
+                    <a href="#headers-<%= resource.resource_path_name %>" aria-controls="home" role="tab" data-toggle="tab">
+                      <i class="fa fa-code" aria-hidden="true"></i>
+                      Headers
+                    </a>
+                  </li>
+                  <li role="presentation">
+                    <a href="#querystring-parameters<%= resource.resource_path_name %>" aria-controls="profile" role="tab" data-toggle="tab">
+                      <i class="fa fa-code" aria-hidden="true"></i>
+                      Querystring Parameters
+                    </a>
+                  </li>
+                  <li role="presentation">
+                    <a href="#responses-<%= resource.resource_path_name %>" aria-controls="home" role="tab" data-toggle="tab">
+                      <i class="fa fa-code" aria-hidden="true"></i>
+                      Responses
+                    </a>
+                  </li>
+                </ul>
+
+                <div class="tab-content">
+                  <div role="tabpanel" class="tab-pane active" id="description-<%= resource.resource_path_name %>">
+                    <p class="lead">
+                      <%= markdown method.description %>
+                    </p>
+                  </div>
+                  <div role="tabpanel" class="tab-pane" id="headers-<%= resource.resource_path_name %>">
+                    <p>...</p>
+                  </div>
+                  <div role="tabpanel" class="tab-pane" id="querystring-parameters<%= resource.resource_path_name %>">
+                    <p>
+                      <ul>
+                      <% method.query_parameters.each do |_, parameter| %>
+                        <li>
+                          <var><strong><%= parameter.required ? "*#{parameter.name}" : "[#{parameter.name}]" %></strong></var>
+                          <% if parameter.example %>
+                            <code><%= parameter.example %></code>
+                          <% end %>
+                          <p><small><%= markdown parameter.description %></small></p>
+                        </li>
+                      <% end %>
+                      </ul>
+                    </p>
+                  </div>
+                  <div role="tabpanel" class="tab-pane" id="responses-<%= resource.resource_path_name %>">
+                    <p>...</p>
+                  </div>
+                </div>
+              </div>
+            </div>
+          </div>
+        <% end %>
+      <% end %>
+    </div>
+
+    <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/css/bootstrap.min.css" integrity="sha384-1q8mTJOASx8j1Au+a5WDVnPi2lkFfwwEAa8hDDdjZlpLegxhjVME1fgjWPGmkzs7" crossorigin="anonymous">
+    <style type="text/css" rel="stylesheet">
+      @import url(https://fonts.googleapis.com/css?family=Raleway:600|Merriweather);
+      h1, h2, h3, h4, h5, h6 { font-family: "Raleway", sans-serif; }
+      p, div { font-family: "Merriweather", serif; }
+      code, pre, kbd, var { font-family: monospace; }
+    </style>
+    <script src="https://code.jquery.com/jquery-2.2.4.min.js" integrity="sha256-BbhdlvQf/xTY9gja0Dq3HiwQF8LaCRTXxZKRutelT44=" crossorigin="anonymous"></script>
+    <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/js/bootstrap.min.js" integrity="sha384-0mSbJDEHialfmuBBQP6A4Qrprq5OVfW37PRR3j5ELqxss1yVqOtnepnHVP9aJ7xS" crossorigin="anonymous"></script>
+    <script src="https://use.fontawesome.com/ff1f204224.js"></script>
+  </body>
+</html>

data/lib/raml_doc/version.rb

@@ -0,0 +1,3 @@
+module RamlDoc
+  VERSION = "0.0.0"
+end

data/lib/raml_doc/view.rb

@@ -0,0 +1,22 @@
+require "kramdown"
+require "raml_doc/raml_helper"
+
+module RamlDoc
+  class View
+    include RamlHelper
+
+    def initialize(raml)
+      @raml = raml
+    end
+
+    def render(template)
+      template_path = File.join(File.expand_path("../templates", __FILE__), "#{template}.html.erb")
+      template = ERB.new(File.read(template_path))
+      template.result binding
+    end
+
+    def markdown(string)
+      Kramdown::Document.new(string).to_html
+    end
+  end
+end

data/lib/raml_doc.rb

@@ -0,0 +1,12 @@
+require "raml"
+require "erb"
+require "raml_doc/version"
+require "raml_doc/view"
+
+module RamlDoc
+  def self.generate(file_path, template)
+    raml = Raml.parse_file(file_path)
+    view = View.new(raml)
+    view.render template
+  end
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: raml_doc
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Nathan Hopkins
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: raml_ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.11.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.11.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- natehop@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/ramldoc
+- bin/setup
+- lib/raml_doc.rb
+- lib/raml_doc/raml_helper.rb
+- lib/raml_doc/templates/default.html.erb
+- lib/raml_doc/version.rb
+- lib/raml_doc/view.rb
+homepage: https://github.com/hopsoft/raml_doc
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Generate API documentation from RAML files
+test_files: []