acos_jekyll_openapi_helper 1.4.4 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a40bc0f1850def91fb789ae62bab398bab43f3cc726a32b5ff0392c2b33760a
-  data.tar.gz: bf8e2c0fa31c6ffef260e92c49594b5a64a79cbf12deb32293814c0524370d85
+  metadata.gz: 403ad932887e7f941556a76ef2e1e6b6a889f2bc8e3fb82fe6017a5f0bb8e89c
+  data.tar.gz: d72b874f04ec17c65517bacea4d39159c83d2a5141c32dfebaa557491f45c8c1
 SHA512:
-  metadata.gz: c4ac0ef5edb9422156548e2881fd5f0058077d98bd26f7d164cc7627189734b0157a737bd19df8ab5dfd83b69ba067c43e88af9e3818a0160eb37896af257031
-  data.tar.gz: cfd15f06fce7bdcede9032945ace499cd2d7bfe87e8e28d75b982601b178fa33a4ac3716e7010c7f05243d8b358ed90fbe175b964c94fa9e8a931b9ccfca26da
+  metadata.gz: 95b4553ff5b42116de09c47a69caae0e755f826b74929fd66295df68f7ca45400d0b35be78d538ee2a7b196bbf383e0f4599cfa0290c776b10739647a07bb45c
+  data.tar.gz: d3a64d49e31098a179c8e038bbf597c51c81c33faf72e71202cc1a0f3a44f7b4c8ca7b49453d69897ee16f7b2be23a969bffad653288ab350e91bf126aea72c1

data/lib/acos_jekyll_openapi.rb

@@ -11,8 +11,16 @@ class AcosOpenApiHelper
         engine.generate
     end
 
-    def self.generate_pages_from_data(datafolder, basePath, output_path)
+    def self.generate_pages_from_data(datafolder, basePath, output_path, only_files = [])
         json_files = Dir["%s/*.json" % datafolder]
+        wanted = Array(only_files).map { |name| File.basename(name.to_s.strip) }.reject(&:empty?)
+        unless wanted.empty?
+            json_files = json_files.select { |jf| wanted.include?(File.basename(jf)) }
+            missing = wanted - json_files.map { |jf| File.basename(jf) }
+            unless missing.empty?
+                raise "No swagger JSON matched: #{missing.join(', ')} in #{datafolder}"
+            end
+        end
         json_files.each do | jf |
             puts "Generating pages based on: %s" % jf
             generate_pages(jf, basePath, output_path)
@@ -56,113 +64,21 @@ class AcosOpenApiHelper::PageEngine
         puts "Open API version %s in .json file" % (@data.key?("openapi") ? @data['openapi'] : @data['swagger'])
         docTitle = (@data["info"]["title"])    
         _components = @data.key?("components")  ? "components" :"definitions"
-        docFile = docTitle.gsub(/\s+|{|}|\//, "_").downcase
+        docFile = docTitle.gsub(/\+|\s+|{|}|\//, "_").downcase
         puts "Document title : %s" % docTitle
         sidebar =  "%s_sidebar" % docFile
-        menu = AcosOpenApiHelper::SidebarMenu.new()
-
-        if File.exists?("%s/%s_index.md" % [@output_path, docFile] )
-            _indexMenu = AcosOpenApiHelper::MenuItem.new("Overview %s " % docTitle, "%s_index" % docFile)
-            menu.add(_indexMenu)
-            cnt = cnt + 1
-        else
-            puts "No index file found for %s" % docFile
-        end
 
         @data['paths'].each do |path|
-            _path = path[0] #path of swagger method
-            _methods = @data['paths'][_path]
-            #(path, basePath, output_path, swaggerfile, sidebar, docFile, component)
+            _path = path[0]
             writer =  AcosOpenApiHelper::PageCreator.new(_path, @basePath, @output_path, @swaggerfile, sidebar, docFile, _components)
             writer.write
-            _permalink = AcosOpenApiHelper::PermalinkGenerator.create(_path, @swaggerfile)
-            _menuItem = AcosOpenApiHelper::MenuItem.new(_path, _permalink)
-            menu.add(_menuItem)
             cnt = cnt + 1
         end
-        # Adding component page for models
-        #createComponents(basePath, title, sidebar, swaggerfile, docFile)
         AcosOpenApiHelper::PageCreator.createComponents(@basePath, docTitle, sidebar, @swaggerfile, docFile, _components)
-        _componentMenu = AcosOpenApiHelper::MenuItem.new("%s Models" % docTitle, "%s_components" % docFile)
-        menu.add(_componentMenu)
         cnt = cnt + 1
 
         puts "Done generating %s pages..." % cnt
-        puts "Writing menu"
-        menu.write("%s/_data/sidebars" % @basePath, sidebar, docTitle)
-    end
-end
-
-class AcosOpenApiHelper::SidebarMenu 
-    @@entries = Array.new
-    #attr_accessor :title, :url
-
-    def self.all_entries
-            @@entries
-    end
-
-    def add(entry)
-        @@entries.push(entry)
-    end
-
-
-    def initialize()
-        # @title = title
-        # @url = url
-        #@@entries << self
-    end
-
-    def write (output_path, name, menuTitle)
-        #no spaces in filename ofr sidebar.yml
-        name = name.gsub(/\s+|{|}|\//, "_").downcase
-        _standardLines = [
-            "# THIS PAGE IS GENERATED. ANY CHANGES TO PAGE WILL POTENTIALLY BE OVERWRITTEN.",
-            "# This is your sidebar TOC. The sidebar code loops through sections here and provides the appropriate formatting.",
-            "entries:",
-            "- title: sidebar",
-            "  # product: Documentation",
-            "  # version: 1.0",
-            "  folders:",
-            "  - title: %s" % menuTitle,
-            "    output: web",
-            "    type: frontmatter",
-            "    folderitems: "
-        ]
-        puts "Writing menu with length:  %s" % @@entries.length
-        @@entries.each do | item | 
-                #puts "Entry: %s, url: %s" % [item.title, item.url]
-                _standardLines << "    - title: %s" % item.title
-                _standardLines << "      url: /%s.html" % item.url
-                _standardLines << "      output: web, pdf"
-        end
-
-        # _standardLines << "    - title: %s" % "Models"
-        # _standardLines << "      url: /%s.html" % "userapi_components"
-        # _standardLines << "      output: web, pdf"
-        # File.open("%s/%s/%s/%s.%s" % [@basePath, "pages", "swagger", @permalink, "md"], "w+") do |f|
-        #     f.puts(@lines)
-        #   end
-        puts "Writing menu file for %s at %s" % [name, output_path]
-        File.open("%s/%s.%s" % [output_path, name, "yml"], "w+") do | f |
-            f.puts(_standardLines)
-        end
-
-        @@entries.clear
-    end
-    
-end
-
-class AcosOpenApiHelper::MenuItem
-    def initialize(title, url) 
-        @title = title
-        @url = url
-    end
-
-    def title
-        @title
-    end
-    def url
-        @url        
+        puts "Sidebar is owned by overlay compose; gem does not write sidebar YAML."
     end
 end
 
@@ -170,7 +86,10 @@ class AcosOpenApiHelper::PermalinkGenerator
     def self.create(path, swaggerfile)
         @swaggerfileBase = File.basename(swaggerfile, ".*")
         @permalinkBase = "%s_%s" % [@swaggerfileBase, path]
-        @permalink = @permalinkBase.gsub(/\s+|{|}|\//, "_").downcase
+        @permalink = @permalinkBase.gsub(/\+|\s+|{|}|\//, "_").downcase
+        unless @permalink =~ /\A[a-z0-9_-]+\z/
+            raise "Unsafe permalink: #{@permalink}"
+        end
         return @permalink
     end
 
@@ -183,7 +102,10 @@ end
 class AcosOpenApiHelper::FileNameGenerator
     def self.create(path, docFile)
         @docFileBase = "%s_%s" % [docFile, path]
-        @docFileName = @docFileBase.gsub(/\s+|{|}|\//, "_").downcase
+        @docFileName = @docFileBase.gsub(/\+|\s+|{|}|\//, "_").downcase
+        unless @docFileName =~ /\A[a-z0-9_-]+\z/
+            raise "Unsafe generated filename: #{@docFileName}"
+        end
         return @docFileName
     end
 
@@ -194,7 +116,6 @@ end
 
 class AcosOpenApiHelper::PageCreator
     def initialize(path, basePath, output_path, swaggerfile, sidebar, docFile, component)
-        # puts "Initialize intput %s, %s, %s, %s" % [path, output_path, swaggerfile, sidebar]
         @path = path
         @output_path = output_path
         @swaggerfile = swaggerfile
@@ -220,7 +141,8 @@ class AcosOpenApiHelper::PageCreator
             "swagger_components: %s" % component, 
             "components_file: %s" % docFile,
             "---",
-            "{\% include swagger_json/get_path.md \%}"
+            "{\% include swagger_json/get_path.md \%}",
+            "{\% include swagger_json/overlay_slot.md slot=\"after_page\" \%}"
         ]
     end
 
@@ -232,6 +154,9 @@ class AcosOpenApiHelper::PageCreator
 
     def self.createComponents(basePath, title, sidebar, swaggerfile, docFile, componentsKey)
         swaggerfileName = File.basename(swaggerfile, ".*")
+        unless docFile =~ /\A[a-z0-9_-]+\z/
+            raise "Unsafe generated filename: #{docFile}"
+        end
         contentLines = [
             "---",
             "title: %s Models" % title,
@@ -257,4 +182,4 @@ class AcosOpenApiHelper::PageCreator
             f.puts(contentLines)
         end
     end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: acos_jekyll_openapi_helper
 version: !ruby/object:Gem::Version
-  version: 1.4.4
+  version: 1.6.0
 platform: ruby
 authors:
 - Acos AS
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-05-28 00:00:00.000000000 Z
+date: 2026-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -30,13 +30,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- bin/start.rb
 - lib/acos_jekyll_openapi.rb
 homepage: https://rubygems.org/gems/acos_jekyll_openapi_helper
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -51,8 +50,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.4.20
+signing_key:
 specification_version: 4
 summary: Open API json file helper
 test_files: []

data/bin/start.rb

@@ -1,8 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'acos_jekyll_openapi'
-AcosOpenApiHelper.generate_pages_from_data(
-    "/mnt/c/code/github/Acos.Integration.Documentation/_data/swagger", 
-    "/mnt/c/code/github/Acos.Integration.Documentation",
-    "/mnt/c/code/github/Acos.Integration.Documentation/pages/swagger"
-)