jdoc 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 272ba27b2c8096ee1cd29cf122bc4a3ad0ab1ce7
-  data.tar.gz: 132c4ab5391930817097b13e3e98a66fbe8c7ff6
+  metadata.gz: caa1e9494adadf0a14d5697e39c49856d0fc78b0
+  data.tar.gz: d79c705955a92c5e28b586ffd79abb797644c4ff
 SHA512:
-  metadata.gz: 9366989f68722a5a3cbe9f1b43ae5dc1b59453e461d7196f46a85feacdd1318e3a7cb2f1abfca5550bc0991fe1b48588ac3d6272a98f709368c50f7c71667859
-  data.tar.gz: 07e0d09dc49e06766e90a3066698a3ce8def4f1e8956906cb5d666a1d1d7b6c9c003d40b6d7cc7122e245a9f8449d4741505a94f04c333835f151ed6e738e1b1
+  metadata.gz: 03930f9cf0de98043b16cdbeb6ebbef9025e1f68d6d6f5892928147aa23846cfb6c4b15d92d737bb3c21f570a6a77de685215b5b53531ebf00972cb43ddfdb9e
+  data.tar.gz: a1c9263e15fe42ce0cf3355b730bcacfb6c8122c852a3275242b34fb468f419875a217e177c0e30e8c6b86a44af8c66b7e3337540a71dc46bed31411033f09f1

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 0.1.4
+* Provide :html option to render docs in HTML
+
 ## 0.1.3
 * Use its pointer name if a resource has no title property
 

data/jdoc.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "activesupport"
   spec.add_dependency "erubis"
   spec.add_dependency "json_schema"
+  spec.add_dependency "redcarpet"
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "rake"

data/lib/jdoc/generator.rb

@@ -1,6 +1,37 @@
 module Jdoc
   class Generator
-    TEMPLATE_PATH = File.expand_path("../../../template.md.erb", __FILE__)
+    HTML_TEMPLATE_PATH = File.expand_path("../../../template.html.erb", __FILE__)
+    MARKDOWN_TEMPLATE_PATH = File.expand_path("../../../template.md.erb", __FILE__)
+
+    class << self
+      # @return [Erubis::Eruby]
+      def markdown_renderer
+        @markdown_renderer ||= Erubis::Eruby.new(markdown_template)
+      end
+
+      # @return [Erubis::Eruby]
+      def html_renderer
+        @html_renderer ||= Erubis::Eruby.new(html_template)
+      end
+
+      def redcarpet
+        @redcarpet ||= Redcarpet::Markdown.new(
+          Redcarpet::Render::HTML.new(hard_wrap: true, filter_html: true),
+          autolink: true,
+          fenced_code_blocks: true,
+        )
+      end
+
+      # @return [String] ERB template
+      def markdown_template
+        File.read(MARKDOWN_TEMPLATE_PATH)
+      end
+
+      # @return [String] ERB template
+      def html_template
+        File.read(HTML_TEMPLATE_PATH)
+      end
+    end
 
     # Utility wrapper for Jdoc::Generator#call
     # @return [String]
@@ -9,37 +40,26 @@ module Jdoc
     end
 
     # @param schema [Hash] JSON Schema represented as a Hash
-    def initialize(schema)
+    # @param html [true, false] Pass true to render HTML docs
+    def initialize(schema, html: false)
       @raw_schema = schema
+      @html = html
     end
 
-    # Generates documentation in Markdown format from JSON schema
-    # @return [String] Text of generated markdown document
+    # Generates Markdown or HTML documentation from JSON schema
+    # @return [String]
     def call
-      eruby.result(context)
+      result = self.class.markdown_renderer.result(schema: schema)
+      result = self.class.html_renderer.result(body: self.class.redcarpet.render(result)) if @html
+      result
     end
 
     private
 
-    # @return [Hash] Context object used as a set of local variables for rendering template
-    def context
-      { schema: schema }
-    end
-
     # @return [Jdoc::Schema]
     # @raise [JsonSchema::SchemaError] Raises if given invalid JSON Schema
     def schema
       @schema ||= Jdoc::Schema.new(@raw_schema)
     end
-
-    # @return [Erubis::Eruby]
-    def eruby
-      Erubis::Eruby.new(template)
-    end
-
-    # @return [String] ERB template
-    def template
-      File.read(TEMPLATE_PATH)
-    end
   end
 end

data/lib/jdoc/version.rb

@@ -1,3 +1,3 @@
 module Jdoc
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

data/lib/jdoc.rb

@@ -2,6 +2,7 @@ require "active_support/core_ext/string/inflections"
 require "cgi"
 require "erubis"
 require "json_schema"
+require "redcarpet"
 require "uri"
 
 require "jdoc/generator"

data/template.html.erb

@@ -0,0 +1,43 @@
+<!DOCTYPE HTML>
+<html>
+<head>
+  <meta charset="UTF-8">
+  <title>API Docs</title>
+  <style>
+    body {
+      width: 920px;
+      margin: 0 auto;
+      font-size: 14px;
+    }
+
+    a {
+      color: #4183C4;
+    }
+
+    pre {
+      color: #393939;
+      background-color: #fafafb;
+      padding: 10px;
+      margin: 2em 0;
+      border: 1px solid #cacaca;
+      border-radius: 3px;
+      font: 12px/1.4em Consolas, 'Liberation Mono', Courier, monospace;
+      overflow: auto;
+    }
+
+    ol code,
+    ul code,
+    p code {
+      font-size: 12px;
+      margin: 0;
+      border: 1px solid #ddd;
+      background-color: #f8f8f8;
+      border-radius: 3px;
+      padding: 0;
+    }
+  </style>
+</head>
+<body>
+<%= body %>
+</body>
+</html>

data/template.md.erb

@@ -1,4 +1,4 @@
-# <%= schema.title %>
+# <%= schema.title || "API" %>
 <% schema.resources.each do |resource| %>
 * <%= resource.hyperlink %>
 <% resource.links.each do |link| %>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jdoc
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Ryo Nakamura
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -135,6 +149,7 @@ files:
 - spec/fixtures/schema.yml
 - spec/jdoc/generator_spec.rb
 - spec/spec_helper.rb
+- template.html.erb
 - template.md.erb
 homepage: https://github.com/r7kamura/jdoc
 licenses: