jdoc 0.4.4 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2985c00f49d908beecf1c19950d19936e6e2cda00d3e252523b5f6c084471c34
-  data.tar.gz: 21cfc1d002fbe5daa43cb72d663fd32f963dfb9538dcabbea251607681b9ef5c
+  metadata.gz: 4ee1b1514622a40fee3e0d8813c610f9f9c0bd31c97367693b2523663028a6f9
+  data.tar.gz: cbea57957aa93be238805ed0e7d6558fbef0405e53cffee35f0140d8a31b7701
 SHA512:
-  metadata.gz: 06ab1757a35ecb7f108cfdcc0d9a67f5c2692bd2b39951bab5b8246c3e65f954f4bf745f35130d5272097cf29f9114ea80f349fad48c48dbe4a8b1a65051158b
-  data.tar.gz: afdf9f5a2f4d24a88948b6eafe8910b12283f0f9df385bca89adeb8263f301dad3bafb97bd0621b63b6827fc1549eb0feebff44c2b678dabb9b4f1ef860e4b38
+  metadata.gz: 00b3b964522b6260e4e6da08fc9eebb409ccb9a52a5cac65f1a80b3f1da8ba2ae3cd4a65d64e58f0365bb035bdf494d07874bb342b94f59a439e13e70b44b255
+  data.tar.gz: 69408fbfdddb4e79f76e266aca7cb5992b12e684fb0258c62983040b2a598ec9397ae33a5b838953e5b15d3957664c416eaff24bf1307d11e026c0e3b44f3824

data/.github/workflows/ci.yml

@@ -14,6 +14,8 @@ jobs:
       matrix:
         ruby:
           - '3.3'
+          - '3.4'
+          - '4.0'
     steps:
     - uses: actions/checkout@v3
     - name: Set up Ruby

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    jdoc (0.4.4)
+    jdoc (0.5.0)
       activesupport
-      erubis
+      erubi
       json_schema
       rack
       redcarpet
@@ -11,17 +11,21 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.1.2)
+    activesupport (7.1.6)
       base64
+      benchmark (>= 0.3)
       bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
       connection_pool (>= 2.2.5)
       drb
       i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
       minitest (>= 5.1)
       mutex_m
+      securerandom (>= 0.3)
       tzinfo (~> 2.0)
     base64 (0.2.0)
+    benchmark (0.5.0)
     bigdecimal (3.1.5)
     coderay (1.1.3)
     concurrent-ruby (1.2.2)
@@ -29,18 +33,22 @@ GEM
     diff-lcs (1.5.0)
     drb (2.2.0)
       ruby2_keywords
-    erubis (2.7.0)
+    erubi (1.13.1)
     i18n (1.14.1)
       concurrent-ruby (~> 1.0)
     json_schema (0.21.0)
+    logger (1.7.0)
     method_source (1.0.0)
-    minitest (5.21.1)
+    minitest (6.0.5)
+      drb (~> 2.0)
+      prism (~> 1.5)
     mutex_m (0.2.0)
+    prism (1.9.0)
     pry (0.14.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
     rack (3.0.8)
-    rake (13.1.0)
+    rake (13.4.2)
     redcarpet (3.6.0)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
@@ -56,6 +64,7 @@ GEM
       rspec-support (~> 3.12.0)
     rspec-support (3.12.1)
     ruby2_keywords (0.0.5)
+    securerandom (0.4.1)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
 
@@ -67,7 +76,7 @@ DEPENDENCIES
   bundler (>= 1.6)
   jdoc!
   pry
-  rake
+  rake (>= 13.2.0)
   rspec (>= 2.14.1)
 
 BUNDLED WITH

data/jdoc.gemspec

@@ -17,12 +17,12 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "activesupport"
-  spec.add_dependency "erubis"
+  spec.add_dependency "erubi"
   spec.add_dependency "json_schema"
   spec.add_dependency "rack"
   spec.add_dependency "redcarpet"
   spec.add_development_dependency "bundler", ">= 1.6"
   spec.add_development_dependency "pry"
-  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rake", ">= 13.2.0"
   spec.add_development_dependency "rspec", ">= 2.14.1"
 end

data/lib/jdoc/generator.rb

@@ -24,10 +24,10 @@ module Jdoc
     # @note Add some fix to adapt to GitHub anchor style
     # @return [String] Generated text
     def call
-      markdown = markdown_renderer.result(schema: schema)
+      markdown = render_erb(markdown_template, schema: schema)
       if @html
         html = markdown_parser.render(markdown)
-        html =  html_renderer.result(body: html)
+        html = render_erb(html_template, body: html)
         html.gsub(/id="(.+)"/) {|text| text.tr("/:", "") }
       else
         markdown
@@ -38,9 +38,11 @@ module Jdoc
 
     private
 
-    # @return [Erubis::Eruby] Renderer to render HTML that takes HTML string
-    def html_renderer
-      Erubis::Eruby.new(html_template)
+    # @return [String]
+    def render_erb(template, **variables)
+      b = binding
+      variables.each { |k, v| b.local_variable_set(k, v) }
+      eval(Erubi::Engine.new(template).src, b)
     end
 
     # @returns [String] Path to ERB template to render HTML
@@ -66,11 +68,6 @@ module Jdoc
       )
     end
 
-    # @return [Erubis::Eruby] Renderer to render Markdown that takes schema data
-    def markdown_renderer
-      Erubis::Eruby.new(markdown_template)
-    end
-
     # @return [String] Content of specified Markdown template
     def markdown_template
       File.read(markdown_template_path)

data/lib/jdoc/version.rb

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

data/lib/jdoc.rb

@@ -1,7 +1,7 @@
 require "active_support/core_ext/object/to_query"
 require "active_support/core_ext/string/inflections"
 require "cgi"
-require "erubis"
+require "erubi"
 require "json_schema"
 require "redcarpet"
 require "rack"

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: jdoc
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.5.0
 platform: ruby
 authors:
 - Ryo Nakamura
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-01-15 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -25,7 +24,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: erubis
+  name: erubi
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -114,14 +113,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 13.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 13.2.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -136,7 +135,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.14.1
-description: 
 email:
 - r7kamura@gmail.com
 executables:
@@ -150,7 +148,6 @@ files:
 - ".github/workflows/github-label-sync.yml"
 - ".github/workflows/release.yml"
 - ".gitignore"
-- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -177,7 +174,6 @@ homepage: https://github.com/r7kamura/jdoc
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -192,8 +188,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Generate API documentation from JSON Schema.
 test_files:

data/CHANGELOG.md

@@ -1,123 +0,0 @@
-## 0.4.3
-
-- Add some CLI options (Thx @k1LoW)
-
-## 0.4.2
-
-- Show reason phrase in response example (Thx @minodisk)
-
-## 0.4.1
-
-- Use 204 for `mediaType: "null"`
-
-## 0.4.0
-
-- Recognize `mediaType: 'null'` as "No response body"
-
-## 0.3.4
-
-- Treat empty request parameters as no request body
-
-## 0.3.3
-
-- Improve pattern format in properties section
-
-## 0.3.2
-
-- Add generator options to change template
-- Add request parameters for each endpoint
-
-## 0.3.1
-
-- Add error handling for ExampleNotFound
-
-## 0.3.0
-
-- Change example response status and body to PUT & DELETE requests
-- Improve request path example by resolving variable in path
-
-## 0.2.1
-
-- Support multipart/form-data
-
-## 0.2.0
-
-- Show schema description on docs if exists
-
-## 0.1.9
-
-- Support property that has no type
-
-## 0.1.8
-
-- Support property that is an array of primitive values
-
-## 0.1.7
-
-- Support query string example in GET request
-- Improve the description property visibility
-
-## 0.1.6
-
-- Disable `<em>` feature of Redcarpet
-
-## 0.1.5
-
-- Fix ToC link on HTML docs
-
-## 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
-
-## 0.1.2
-
-- Use .schema property for request body if exists
-- Improve array resource handling
-
-## 0.1.1
-
-- Support has-one relation
-
-## 0.1.0
-
-- Show resources which have no links
-
-## 0.0.9
-
-- Support array property
-
-## 0.0.8
-
-- Fix resource equality
-
-## 0.0.7
-
-- Support `false` & `null` example value
-
-## 0.0.6
-
-- Use root API endpoint at example response
-
-## 0.0.5
-
-- Remove dependency on multi_json
-
-## 0.0.4
-
-- Support whitespace and multiple templates in href
-
-## 0.0.3
-
-- Fix missing gem dependencies
-
-## 0.0.2
-
-- Remove dependency on rack-spec
-
-## 0.0.1
-
-- 1st Release