json-schema-docs 0.1.1 → 0.2.0

data/lib/json-schema-docs/layouts/links.html.erb

@@ -0,0 +1,73 @@
+<h1 class="resource-name"><a name="resource-<%= schemata['title'].downcase %>"><%= schemata['title'] %></a></h1>
+
+<% schemata['links'].each do |link, datum| %>
+
+<h2 class="link-name"><a name="link-<%= link['method'] %>-<%= link['title'] %>"><%= link['title'] %></a></h2>
+
+<p class=link-description">
+<%= markdownify.(schemata['description']) %>
+</p>
+
+<pre>
+<%= link['method'] %> <%= link['link_path'] %>
+</pre>
+
+<div class="link-copy-wrapper">
+  <div class="link-properties">
+  <% if (link['required_properties'] && !link['required_properties'].empty?) || (link['optional_properties'] && !link['optional_properties'].empty?) %>
+    <h2 class="link-properties-title">Arguments</h2>
+    <ul class="link-properties-list">
+    <%- link['required_properties'].each do |property_ref| -%>
+    <li class="link-properties-item">
+      <h3 class="link-properties-item-label">
+        <span class="link-properties-item-name">
+          <%= property_ref[:name] %>
+        </span>
+        <span class="link-properties-item-type">
+          <%= property_ref[:type] %>
+        </span>
+        <span class="link-properties-required">
+          Required
+        </span>
+      </h3>
+      <div class="link-properties-item-description-and-children">
+        <p class="link-properties-item-description">
+          <span><%= markdownify.(property_ref[:description]) %></span>
+        </p>
+      </div>
+    </li>
+    <%- end -%>
+    <%- link['optional_properties'].each do |property_ref| -%>
+    <li class="link-properties-item">
+      <h3 class="link-properties-item-label">
+        <span class="link-properties-item-name">
+          <%= property_ref[:name] %>
+        </span>
+        <span class="link-properties-item-type">
+          <%= property_ref[:type] %>
+        </span>
+        <span class="link-properties-optional">
+          Optional
+        </span>
+      </h3>
+      <div class="link-properties-item-description-and-children">
+        <p class="link-properties-item-description">
+          <span><%= markdownify.(property_ref[:description]) %></span>
+        </p>
+      </div>
+    </li>
+    <%- end -%>
+    </ul>
+  <%- end -%>
+  </div>
+
+  <div class="link-example">
+
+  <%= include.('curl_example.html.erb', example: link['example']) %>
+
+  <%= include.('response.html.erb', response: link['response']) %>
+
+  </div>
+</div>
+
+<%- end -%>

data/lib/json-schema-docs/layouts/resource.html.erb

@@ -0,0 +1,42 @@
+<h1 class="resource-name"><a name="resource-<%= schemata['title'].downcase %>"><%= schemata['title'] %></a></h1>
+
+<% if schemata['stability'] && !schemata['stability'].empty? %>
+<p class="stability-info">Stability: <code class="stability-type"><%= schemata['stability'] %></code></p>
+<% end %>
+
+<p class=resource-description">
+<%= markdownify.(schemata['description']) %>
+</p>
+
+<% if schemata['property_refs'] && !schemata['property_refs'].empty? %>
+
+<div class="resource-copy-wrapper">
+  <div class="resource-attributes">
+    <h2 class="resource-attributes-title">Attributes</h2>
+    <ul class="resource-attributes-list">
+    <%- schemata['property_refs'].each do |property_ref| -%>
+    <li class="resource-attributes-item">
+      <h3 class="resource-attributes-item-label">
+        <span class="resource-attributes-item-name">
+          <%= property_ref[:name] %>
+        </span>
+        <span class="resource-attributes-item-type">
+          <%= property_ref[:type] %>
+        </span>
+      </h3>
+      <div class="resource-attributes-item-description-and-children">
+        <p class="resource-attributes-item-description">
+          <span><%= markdownify.(property_ref[:description]) %></span>
+        </p>
+      </div>
+    </li>
+    <%- end -%>
+    </ul>
+  </div>
+
+  <div class="resource-example">
+  <%= include.('resource_example.html.erb', example: schemata['example']) %>
+  </div>
+</div>
+
+<% end %>

data/lib/json-schema-docs/parser.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 require 'prmd'
+require 'neatjson'
 
 module JsonSchemaDocs
   class Parser
@@ -41,6 +42,7 @@ module JsonSchemaDocs
                 property_ref[:name] = key
               end
               schemata['property_refs'].push(property_ref)
+              schemata['example'] = pretty_json(@schema.schemata_example(resource))
             end
           end
 
@@ -68,8 +70,8 @@ module JsonSchemaDocs
             end
 
             link['link_path'] = link_path
-            link['required_properties'] = link_schema_required_properties
-            link['optional_properties'] = link_schema_optional_properties
+            link['required_properties'] = link_schema_required_properties || []
+            link['optional_properties'] = link_schema_optional_properties || []
             link['example'] = generate_example(link, link_path)
             link['response'] = {
               header: generate_response_header(response_example, link),
@@ -320,7 +322,7 @@ module JsonSchemaDocs
 
       # add data, if present
       if !data.nil? && link['method'].upcase != 'GET'
-        data = "-d '#{JSON.pretty_generate(data)}' \\"
+        data = "-d '#{pretty_json(data)}' \\"
       elsif !get_params.empty? && link['method'].upcase == 'GET'
         data = "-G #{get_params.join(" ss\\\n  -d ")} \\"
       end
@@ -350,16 +352,20 @@ module JsonSchemaDocs
         else
           if link['rel'] == 'empty'
           elsif link.has_key?('targetSchema')
-            JSON.pretty_generate(@schema.schema_example(link['targetSchema']))
+            pretty_json(@schema.schema_example(link['targetSchema']))
           elsif link['rel'] == 'instances'
-            JSON.pretty_generate([@schema.schemata_example(resource)])
+            pretty_json([@schema.schemata_example(resource)])
           else
-            JSON.pretty_generate(@schema.schemata_example(resource))
+            pretty_json(@schema.schemata_example(resource))
           end
         end
       else
         nil
       end
     end
+
+    def pretty_json(json)
+      JSON.neat_generate(json, wrap: true, sort: true)
+    end
   end
 end

data/lib/json-schema-docs/renderer.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+require 'html/pipeline'
+require 'yaml'
+require 'extended-markdown-filter'
+
+module JsonSchemaDocs
+  class Renderer
+    include Helpers
+
+    attr_reader :options
+
+    def initialize(parsed_schema, options)
+      @parsed_schema = parsed_schema
+      @options = options
+
+      unless @options[:templates][:default].nil?
+        @default_layout = ERB.new(File.read(@options[:templates][:default]))
+      end
+
+      @pipeline_config = @options[:pipeline_config] || {}
+      pipeline = @pipeline_config[:pipeline] || {}
+      context = @pipeline_config[:context] || {}
+
+      filters = pipeline.map do |f|
+        if filter?(f)
+          f
+        else
+          key = filter_key(f)
+          filter = HTML::Pipeline.constants.find { |c| c.downcase == key }
+          # possibly a custom filter
+          if filter.nil?
+            Kernel.const_get(f)
+          else
+            HTML::Pipeline.const_get(filter)
+          end
+        end
+      end
+
+      @pipeline = HTML::Pipeline.new(filters, context)
+    end
+
+    def render(contents, meta: {})
+      opts = meta.merge({ base_url: @options[:base_url], output_dir: @options[:output_dir] }).merge(helper_methods)
+
+      contents = to_html(contents, context: opts)
+      return contents if @default_layout.nil?
+      opts[:content] = contents
+      @default_layout.result(OpenStruct.new(opts).instance_eval { binding })
+    end
+
+    def to_html(string, context: {})
+      @pipeline.to_html(string, context)
+    end
+
+    private
+
+    def filter_key(s)
+      s.downcase
+    end
+
+    def filter?(f)
+      f < HTML::Pipeline::Filter
+    rescue LoadError, ArgumentError
+      false
+    end
+  end
+end

data/lib/json-schema-docs/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module JsonSchemaDocs
-  VERSION = '0.1.1'.freeze
+  VERSION = '0.2.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json-schema-docs
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Garen Torikian
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-04 00:00:00.000000000 Z
+date: 2019-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prmd
@@ -24,6 +24,132 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: commonmarker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: gemoji
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: html-pipeline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+- !ruby/object:Gem::Dependency
+  name: escape_utils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: extended-markdown-filter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: neatjson
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: page-toc-filter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: rouge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: sass
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
 - !ruby/object:Gem::Dependency
   name: awesome_print
   requirement: !ruby/object:Gem::Requirement
@@ -169,11 +295,23 @@ files:
 - lib/json-schema-docs/configuration.rb
 - lib/json-schema-docs/generator.rb
 - lib/json-schema-docs/helpers.rb
-- lib/json-schema-docs/layouts/endpoint.md.erb
-- lib/json-schema-docs/layouts/includes/example.md.erb
-- lib/json-schema-docs/layouts/includes/response.md.erb
-- lib/json-schema-docs/layouts/object.md.erb
+- lib/json-schema-docs/landing_pages/index.md
+- lib/json-schema-docs/layouts/assets/_sass/_content.scss
+- lib/json-schema-docs/layouts/assets/_sass/_header.scss
+- lib/json-schema-docs/layouts/assets/_sass/_links.scss
+- lib/json-schema-docs/layouts/assets/_sass/_normalize.scss
+- lib/json-schema-docs/layouts/assets/_sass/_resource.scss
+- lib/json-schema-docs/layouts/assets/_sass/_sidebar.scss
+- lib/json-schema-docs/layouts/assets/css/screen.scss
+- lib/json-schema-docs/layouts/default.html.erb
+- lib/json-schema-docs/layouts/includes/curl_example.html.erb
+- lib/json-schema-docs/layouts/includes/resource_example.html.erb
+- lib/json-schema-docs/layouts/includes/response.html.erb
+- lib/json-schema-docs/layouts/includes/sidebar.html.erb
+- lib/json-schema-docs/layouts/links.html.erb
+- lib/json-schema-docs/layouts/resource.html.erb
 - lib/json-schema-docs/parser.rb
+- lib/json-schema-docs/renderer.rb
 - lib/json-schema-docs/version.rb
 - script/bootstrap
 - script/console

data/lib/json-schema-docs/layouts/endpoint.md.erb

@@ -1,39 +0,0 @@
-# <a class="header-link" name="resource-<%= slugify.(schemata['title']) %>"><%= schemata['title'] %></a>
-
-<% schemata['links'].each do |link, datum| %>
-
-## <a class="header-link" name="link-<%= link['method'] %>-<%= resource %>-<%= link['href'] %>"><%= schemata['title'] %> <%= link['title'] %></a>
-
-<%= link['description'] %>
-
-```
-<%= link['method'] %> <%= link['link_path'] %>
-```
-
-<% if link['required_properties'] && !link['required_properties'].empty? %>
-## Required Parameters
-
-| Name | Type | Description | Example |
-| ------- | ------- | ------- | ------- |
-<%- link['required_properties'].each do |property_ref| -%>
-| **<%= property_ref[:name] %>** | *<%= property_ref[:type] %>* | <%= property_ref[:description] %> | <%= property_ref[:example] %> |
-<%- end -%>
-
-<% end %>
-
-<% if link['optional_properties'] && !link['optional_properties'].empty? %>
-## Optional Parameters
-
-| Name | Type | Description | Example |
-| ------- | ------- | ------- | ------- |
-<%- link['optional_properties'].each do |property_ref| -%>
-| **<%= property_ref[:name] %>** | *<%= property_ref[:type] %>* | <%= property_ref[:description] %> | <%= property_ref[:example] %> |
-<%- end -%>
-
-<% end %>
-
-<%= include.('example.md.erb', example: link['example']) %>
-
-<%= include.('response.md.erb', response: link['response']) %>
-
-<% end %>