jdoc 0.4.3 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: bbc21692c07ab9fe470cc9bb20a30396e5305765
-  data.tar.gz: 3c48d113af68dd3e9b4157f005c16619edc7b1ab
+SHA256:
+  metadata.gz: 2985c00f49d908beecf1c19950d19936e6e2cda00d3e252523b5f6c084471c34
+  data.tar.gz: 21cfc1d002fbe5daa43cb72d663fd32f963dfb9538dcabbea251607681b9ef5c
 SHA512:
-  metadata.gz: 5a8eae9246f34f5cf66827f490ab48a99abf017597280f39269007c981a54b4dd9e062c513cda93ed098a140e03099e09ef880276a132350accabe4b41b5dbe3
-  data.tar.gz: 5e4cd2d1ef3dd61fb3e4d7617806b0c9c0fcf2eddd9f8e45025721690f59aa41366bbbf09f0efa8fc50835ca0c435d4d7c309e6c13301123279531da00825436
+  metadata.gz: 06ab1757a35ecb7f108cfdcc0d9a67f5c2692bd2b39951bab5b8246c3e65f954f4bf745f35130d5272097cf29f9114ea80f349fad48c48dbe4a8b1a65051158b
+  data.tar.gz: afdf9f5a2f4d24a88948b6eafe8910b12283f0f9df385bca89adeb8263f301dad3bafb97bd0621b63b6827fc1549eb0feebff44c2b678dabb9b4f1ef860e4b38

data/.github/release.yml

@@ -0,0 +1,23 @@
+changelog:
+  categories:
+    - title: Added
+      labels:
+        - add
+    - title: Changed
+      labels:
+        - change
+    - title: Deprecated
+      labels:
+        - deprecate
+    - title: Fixed
+      labels:
+        - fix
+    - title: Removed
+      labels:
+        - remove
+    - title: Security
+      labels:
+        - security
+    - title: Others
+      labels:
+        - "*"

data/.github/workflows/bump-request.yml

@@ -0,0 +1,26 @@
+name: bump-request
+
+on:
+  workflow_dispatch:
+    inputs:
+      version:
+        description: Version to change to.
+        required: true
+        type: string
+
+jobs:
+  run:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.3'
+          bundler-cache: true
+      - uses: r7kamura/bump-request@v0
+        with:
+          command: |
+            sed -i -r 's/([0-9]+\.[0-9]+\.[0-9]+)/${{ inputs.version }}/' lib/*/version.rb
+            bundle install
+          version: ${{ inputs.version }}

data/.github/workflows/ci.yml

@@ -0,0 +1,25 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+jobs:
+  rspec:
+    runs-on: ubuntu-latest
+    name: Ruby ${{ matrix.ruby }}
+    strategy:
+      matrix:
+        ruby:
+          - '3.3'
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - name: Run the default task
+      run: bundle exec rake

data/.github/workflows/github-label-sync.yml

@@ -0,0 +1,18 @@
+name: github-label-sync
+
+on:
+  push:
+    branches:
+      - master
+    paths:
+      - .github/workflows/github-label-sync.yml
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: r7kamura/github-label-sync-action@v0
+        with:
+          source_path: labels-keepachangelog.yml
+          source_repository: r7kamura/github-label-presets

data/.github/workflows/release.yml

@@ -0,0 +1,14 @@
+name: release
+
+on:
+  push:
+    tags:
+      - "v*.*.*"
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: softprops/action-gh-release@v1
+        with:
+          generate_release_notes: true

data/.gitignore

@@ -3,7 +3,6 @@
 .bundle
 .config
 .yardoc
-Gemfile.lock
 InstalledFiles
 _yardoc
 coverage

data/Gemfile.lock

@@ -0,0 +1,74 @@
+PATH
+  remote: .
+  specs:
+    jdoc (0.4.4)
+      activesupport
+      erubis
+      json_schema
+      rack
+      redcarpet
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.1.2)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      mutex_m
+      tzinfo (~> 2.0)
+    base64 (0.2.0)
+    bigdecimal (3.1.5)
+    coderay (1.1.3)
+    concurrent-ruby (1.2.2)
+    connection_pool (2.4.1)
+    diff-lcs (1.5.0)
+    drb (2.2.0)
+      ruby2_keywords
+    erubis (2.7.0)
+    i18n (1.14.1)
+      concurrent-ruby (~> 1.0)
+    json_schema (0.21.0)
+    method_source (1.0.0)
+    minitest (5.21.1)
+    mutex_m (0.2.0)
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rack (3.0.8)
+    rake (13.1.0)
+    redcarpet (3.6.0)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    ruby2_keywords (0.0.5)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+
+PLATFORMS
+  ruby
+  x86_64-linux
+
+DEPENDENCIES
+  bundler (>= 1.6)
+  jdoc!
+  pry
+  rake
+  rspec (>= 2.14.1)
+
+BUNDLED WITH
+   2.5.3

data/README.md

@@ -1,4 +1,7 @@
 # Jdoc
+
+[![CI](https://github.com/r7kamura/jdoc/actions/workflows/ci.yml/badge.svg)](https://github.com/r7kamura/jdoc/actions/workflows/ci.yml)
+
 Generate API documentation from JSON Schema.
 
 ## Install

data/Rakefile

@@ -1,2 +1,6 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
 
+RSpec::Core::RakeTask.new(:spec)
+
+task default: %i[spec]

data/example-api-documentation.html

@@ -0,0 +1,364 @@
+<!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>
+<h1 id="example-api">Example API</h1>
+
+<p>A schema for a small example API.</p>
+
+<ul>
+<li><a href="#app">App</a>
+
+<ul>
+<li><a href="#post-apps">POST /apps</a></li>
+<li><a href="#delete-appsid">DELETE /apps/:id</a></li>
+<li><a href="#get-appsid">GET /apps/:id</a></li>
+<li><a href="#get-apps">GET /apps</a></li>
+<li><a href="#patch-appsid">PATCH /apps/:id</a></li>
+<li><a href="#post-appsidfiles">POST /apps/:id/files</a></li>
+</ul></li>
+<li><a href="#recipe">Recipe</a>
+
+<ul>
+<li><a href="#get-recipes">GET /recipes</a></li>
+</ul></li>
+<li><a href="#user">User</a></li>
+</ul>
+
+<h2 id="app">App</h2>
+
+<p>An app is a program to be deployed.</p>
+
+<h3 id="properties">Properties</h3>
+
+<ul>
+<li>id
+
+<ul>
+<li>unique identifier of app</li>
+<li>Example: <code>&quot;01234567-89ab-cdef-0123-456789abcdef&quot;</code></li>
+<li>Type: string</li>
+<li>Format: uuid</li>
+<li>ReadOnly: true</li>
+</ul></li>
+<li>name
+
+<ul>
+<li>unique name of app</li>
+<li>Example: <code>&quot;example&quot;</code></li>
+<li>Type: string</li>
+<li>Pattern: <code>/^[a-z][a-z0-9-]{3,50}$/</code></li>
+</ul></li>
+<li>private
+
+<ul>
+<li>true if this resource is private use</li>
+<li>Example: <code>false</code></li>
+<li>Type: boolean</li>
+</ul></li>
+<li>deleted_at
+
+<ul>
+<li>When this resource was deleted at</li>
+<li>Example: <code>nil</code></li>
+<li>Type: null</li>
+</ul></li>
+<li>user_ids
+
+<ul>
+<li>Type: array</li>
+</ul></li>
+<li>users
+
+<ul>
+<li>Type: array</li>
+</ul></li>
+</ul>
+
+<h3 id="post-apps">POST /apps</h3>
+
+<p>Create a new app.</p>
+
+<ul>
+<li>name
+
+<ul>
+<li>unique name of app</li>
+<li>Example: <code>&quot;example&quot;</code></li>
+<li>Type: string</li>
+<li>Pattern: <code>/^[a-z][a-z0-9-]{3,50}$/</code></li>
+</ul></li>
+</ul>
+
+<pre><code>POST /apps HTTP/1.1
+Content-Type: application/json
+Host: api.example.com
+
+{
+  &quot;name&quot;: &quot;example&quot;
+}
+</code></pre>
+
+<pre><code>HTTP/1.1 201 Created
+Content-Type: application/json
+
+{
+  &quot;id&quot;: &quot;01234567-89ab-cdef-0123-456789abcdef&quot;,
+  &quot;name&quot;: &quot;example&quot;,
+  &quot;private&quot;: false,
+  &quot;deleted_at&quot;: null,
+  &quot;user_ids&quot;: [
+    1
+  ],
+  &quot;users&quot;: [
+    {
+      &quot;name&quot;: &quot;alice&quot;
+    }
+  ]
+}
+</code></pre>
+
+<h3 id="delete-apps-id">DELETE /apps/:id</h3>
+
+<p>Delete an existing app.</p>
+
+<pre><code>DELETE /apps/01234567-89ab-cdef-0123-456789abcdef HTTP/1.1
+Host: api.example.com
+</code></pre>
+
+<pre><code>HTTP/1.1 204 No Content
+</code></pre>
+
+<h3 id="get-apps-id">GET /apps/:id</h3>
+
+<p>Info for existing app.</p>
+
+<pre><code>GET /apps/01234567-89ab-cdef-0123-456789abcdef HTTP/1.1
+Host: api.example.com
+</code></pre>
+
+<pre><code>HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+  &quot;id&quot;: &quot;01234567-89ab-cdef-0123-456789abcdef&quot;,
+  &quot;name&quot;: &quot;example&quot;,
+  &quot;private&quot;: false,
+  &quot;deleted_at&quot;: null,
+  &quot;user_ids&quot;: [
+    1
+  ],
+  &quot;users&quot;: [
+    {
+      &quot;name&quot;: &quot;alice&quot;
+    }
+  ]
+}
+</code></pre>
+
+<h3 id="get-apps">GET /apps</h3>
+
+<p>List existing apps.</p>
+
+<pre><code>GET /apps HTTP/1.1
+Host: api.example.com
+</code></pre>
+
+<pre><code>HTTP/1.1 200 OK
+Content-Type: application/json
+
+[
+  {
+    &quot;id&quot;: &quot;01234567-89ab-cdef-0123-456789abcdef&quot;,
+    &quot;name&quot;: &quot;example&quot;,
+    &quot;private&quot;: false,
+    &quot;deleted_at&quot;: null,
+    &quot;user_ids&quot;: [
+      1
+    ],
+    &quot;users&quot;: [
+      {
+        &quot;name&quot;: &quot;alice&quot;
+      }
+    ]
+  }
+]
+</code></pre>
+
+<h3 id="patch-apps-id">PATCH /apps/:id</h3>
+
+<p>Update an existing app.</p>
+
+<ul>
+<li>name
+
+<ul>
+<li>unique name of app</li>
+<li>Example: <code>&quot;example&quot;</code></li>
+<li>Type: string</li>
+<li>Pattern: <code>/^[a-z][a-z0-9-]{3,50}$/</code></li>
+</ul></li>
+</ul>
+
+<pre><code>PATCH /apps/01234567-89ab-cdef-0123-456789abcdef HTTP/1.1
+Content-Type: application/json
+Host: api.example.com
+
+{
+  &quot;name&quot;: &quot;example&quot;
+}
+</code></pre>
+
+<pre><code>HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+  &quot;id&quot;: &quot;01234567-89ab-cdef-0123-456789abcdef&quot;,
+  &quot;name&quot;: &quot;example&quot;,
+  &quot;private&quot;: false,
+  &quot;deleted_at&quot;: null,
+  &quot;user_ids&quot;: [
+    1
+  ],
+  &quot;users&quot;: [
+    {
+      &quot;name&quot;: &quot;alice&quot;
+    }
+  ]
+}
+</code></pre>
+
+<h3 id="post-apps-id-files">POST /apps/:id/files</h3>
+
+<p>Upload an attachment file for an app</p>
+
+<ul>
+<li>file
+
+<ul>
+<li>an attachment of app</li>
+<li>Example: <code>&quot;... contents of file ...&quot;</code></li>
+<li>Type: string</li>
+</ul></li>
+</ul>
+
+<pre><code>POST /apps/01234567-89ab-cdef-0123-456789abcdef/files HTTP/1.1
+Content-Type: multipart/form-data; boundary=---BoundaryX
+Host: api.example.com
+
+-----BoundaryX
+Content-Disposition: form-data; name=&quot;[file]&quot;
+
+... contents of file ...
+
+-----BoundaryX--
+</code></pre>
+
+<pre><code>HTTP/1.1 201 Created
+Content-Type: application/json
+
+{
+  &quot;id&quot;: &quot;01234567-89ab-cdef-0123-456789abcdef&quot;,
+  &quot;name&quot;: &quot;example&quot;,
+  &quot;private&quot;: false,
+  &quot;deleted_at&quot;: null,
+  &quot;user_ids&quot;: [
+    1
+  ],
+  &quot;users&quot;: [
+    {
+      &quot;name&quot;: &quot;alice&quot;
+    }
+  ]
+}
+</code></pre>
+
+<h2 id="recipe">Recipe</h2>
+
+<h3 id="properties">Properties</h3>
+
+<ul>
+<li>name
+
+<ul>
+<li>Example: <code>&quot;Sushi&quot;</code></li>
+</ul></li>
+<li>user
+
+<ul>
+<li>Type: object</li>
+</ul></li>
+</ul>
+
+<h3 id="get-recipes">GET /recipes</h3>
+
+<p>List recipes</p>
+
+<pre><code>GET /recipes HTTP/1.1
+Host: api.example.com
+</code></pre>
+
+<pre><code>HTTP/1.1 200 OK
+Content-Type: application/json
+
+[
+  {
+    &quot;name&quot;: &quot;Sushi&quot;,
+    &quot;user&quot;: {
+      &quot;name&quot;: &quot;alice&quot;
+    }
+  }
+]
+</code></pre>
+
+<h2 id="user">User</h2>
+
+<h3 id="properties">Properties</h3>
+
+<ul>
+<li>name
+
+<ul>
+<li>Example: <code>&quot;alice&quot;</code></li>
+<li>Type: string</li>
+</ul></li>
+</ul>
+
+</body>
+</html>

data/jdoc.gemspec

@@ -21,8 +21,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency "json_schema"
   spec.add_dependency "rack"
   spec.add_dependency "redcarpet"
-  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "bundler", ">= 1.6"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec", "2.14.1"
+  spec.add_development_dependency "rspec", ">= 2.14.1"
 end

data/lib/jdoc/generator.rb

@@ -5,8 +5,8 @@ module Jdoc
 
     # Utility wrapper for Jdoc::Generator#call
     # @return [String]
-    def self.call(*args)
-      new(*args).call
+    def self.call(*args, **kwargs)
+      new(*args, **kwargs).call
     end
 
     # @param schema [Hash] JSON Schema represented as a Hash

data/lib/jdoc/version.rb

@@ -1,3 +1,3 @@
 module Jdoc
-  VERSION = "0.4.3"
+  VERSION = "0.4.4"
 end

data/spec/jdoc/generator_spec.rb

@@ -19,5 +19,15 @@ describe Jdoc::Generator do
     it "returns a String of API documentation in Markdown from given JSON Schema" do
       should == File.read(File.expand_path("../../../example-api-documentation.md", __FILE__))
     end
+
+    context "with html: true" do
+      subject do
+        described_class.call(schema, html: true)
+      end
+
+      it "returns a String of API documentation in HTML from given JSON Schema" do
+        should == File.read(File.expand_path("../../../example-api-documentation.html", __FILE__))
+      end
+    end
   end
 end

data/spec/spec_helper.rb

@@ -1,7 +1,6 @@
 require "jdoc"
 
 RSpec.configure do |config|
-  config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true
   config.filter_run :focus
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jdoc
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.4.4
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-12 00:00:00.000000000 Z
+date: 2024-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -84,14 +84,14 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.6'
 - !ruby/object:Gem::Dependency
@@ -126,14 +126,14 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.14.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.14.1
 description: 
@@ -144,13 +144,20 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/release.yml"
+- ".github/workflows/bump-request.yml"
+- ".github/workflows/ci.yml"
+- ".github/workflows/github-label-sync.yml"
+- ".github/workflows/release.yml"
 - ".gitignore"
 - CHANGELOG.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/jdoc
+- example-api-documentation.html
 - example-api-documentation.md
 - jdoc.gemspec
 - lib/jdoc.rb
@@ -185,8 +192,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 3.5.3
 signing_key: 
 specification_version: 4
 summary: Generate API documentation from JSON Schema.