acos_jekyll_openapi_helper 1.2.0 → 1.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 379d31b769f0d185b71695e2e84022303c7db8593f8514ece50ff643af76bc48
-  data.tar.gz: 60ae793d36db87efa0c18e131a3af1473ad118d4ef94269f60ef9aace0974899
+  metadata.gz: e14565e520d910b4fb71d19d57b32315fdf2ea1592a932fe98c12c8c0e0362fe
+  data.tar.gz: 87e9f0168e68274c41387e1148fa9e60371ff10e15300ca05fde77f2534b5a16
 SHA512:
-  metadata.gz: f60c5bed27fb06a1f58d409bf558472c5bc62b5d13420b793a8df804152d951cd65d6ab565cc8162d15f4b5aa677e223b10764ada92218414b99b66e8b354c79
-  data.tar.gz: 53c6359dafde8abd8c34aa10b72c5285f19f9de4f7bbadb0deb06d98299f7ff8ee74100990407c390776f1450be4560f7c749306866a94a0c659cf4ffa66a7d8
+  metadata.gz: f2b31b4d1e8c4fb37cccaa3924fb1a15341b39bed0d71c9996cb4396f6f151071e188f0d56635d6ddb708669ff2f59aa00e36d8176c3ffcd8686aa06122fc0e8
+  data.tar.gz: e094bbbcef3b62db93109913245944d0940dc8e8689f5ea3a3a20d52fa5d14d8a269a2169ac5086ab1b98e13fe59c668b04b9ee363d1b3ea9191f1783f5d82f7

data/bin/start.rb

@@ -2,7 +2,7 @@
 
 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"
+    "/mnt/c/Kode/github/Acos.Integration.Documentation/_data/swagger", 
+    "/mnt/c/Kode/github/Acos.Integration.Documentation",
+    "/mnt/c/Kode/github/Acos.Integration.Documentation/pages/swagger"
 )

data/lib/acos_jekyll_openapi.rb

@@ -46,47 +46,51 @@ class AcosOpenApiHelper::PageEngine
     def initialize(data, basePath, output_path, swaggerfile)
         @data = data
         @output_path = output_path
-        #@sidebar = sidebar
         @swaggerfile = swaggerfile
         @basePath = basePath
     end        
 
     def generate
-        puts "generating pages..."
+        puts "Generating pages..."
         cnt = 0
-        puts "Open API version %s" % @data['openapi']
-        docTitle = @data["info"]["title"]
-        sidebar =  "%s_sidebar" % docTitle
+        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
+        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|
-            #puts "Prop: %s at counter %s" % [path, cnt]
             _path = path[0] #path of swagger method
             _methods = @data['paths'][_path]
-            #puts "Path: %s has methods: %s " % [_path, _methods]
-            # puts "Methods: %s" % _methods
-            puts "Path: %s" % [_path]
-            #Should not need this. yet...
-            # _methods.each do | _method |
-            #     puts "Method: %s " % _method
-            #     _md = _methods[_method]
-            #     puts "Method description: %s" % [_md]
-            # end
-            #@prop = @data['paths'][cnt]
-            #puts "Found property %s" [@prop]
-            #puts "Constants: %s, %s, %s, %s" % [_path, @output_path, @swaggerfile, @sidebar]
-            writer =  AcosOpenApiHelper::PageCreator.new(_path, @basePath, @output_path, @swaggerfile, sidebar)
+            #(path, basePath, output_path, swaggerfile, sidebar, docFile, component)
+            writer =  AcosOpenApiHelper::PageCreator.new(_path, @basePath, @output_path, @swaggerfile, sidebar, docFile, _components)
             writer.write
-            _permalink =AcosOpenApiHelper::PermalinkGenerator.create(_path, @swaggerfile)
+            _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 
@@ -109,7 +113,11 @@ class AcosOpenApiHelper::SidebarMenu
     end
 
     def write (output_path, name, menuTitle)
+        #no spaces in filename ofr sidebar.yml
+        name = name.gsub(/\s+|{|}|\/|\+/, "_").downcase
+        puts "Name of file %s" % [name]
         _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",
@@ -123,15 +131,15 @@ class AcosOpenApiHelper::SidebarMenu
         ]
         puts "Writing menu with length:  %s" % @@entries.length
         @@entries.each do | item | 
-                puts "Entry: %s, url: %s" % [item.title, item.url]
+                #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"
+        # _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
@@ -139,6 +147,8 @@ class AcosOpenApiHelper::SidebarMenu
         File.open("%s/%s.%s" % [output_path, name, "yml"], "w+") do | f |
             f.puts(_standardLines)
         end
+
+        @@entries.clear
     end
     
 end
@@ -161,7 +171,7 @@ 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
         return @permalink
     end
 
@@ -171,38 +181,81 @@ class AcosOpenApiHelper::PermalinkGenerator
 
 end
 
+class AcosOpenApiHelper::FileNameGenerator
+    def self.create(path, docFile)
+        @docFileBase = "%s_%s" % [docFile, path]
+        @docFileName = @docFileBase.gsub(/\+|\s+|{|}|\//, "_").downcase
+        return @docFileName
+    end
+
+    def fileName
+        @docFileName
+    end
+end
+
 class AcosOpenApiHelper::PageCreator
-    def initialize(path, basePath, output_path, swaggerfile, sidebar)
+    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
         @sidebar = sidebar
+        @docFile = AcosOpenApiHelper::FileNameGenerator.create(@path, docFile)
         @basePath = basePath
         @swaggerfileBase = File.basename(@swaggerfile, ".*")
         @permalink = AcosOpenApiHelper::PermalinkGenerator.create(path, @swaggerfile)
         @lines = [
             "---",
-            "title: User API %s" % path,
+            "# THIS PAGE IS GENERATED. ANY CHANGES TO PAGE WILL POTENTIALLY BE OVERWRITTEN.",
+            "title: %s" % path,
             "keywords: json, openapi",
             "# summary: test med json fil",
-            "sidebars: ",
-            " - name: %s" % @sidebar,
+            " #sidebars: ",
+            " # - name: %s" % @sidebar,
             "permalink: %s.html" % @permalink,
             "folder: swagger",
             "toc: false",
             "swaggerfile: %s" % @swaggerfileBase,
             "swaggerpath: paths",
             "swaggerkey: %s" % @path,
+            "swagger_components: %s" % component, 
+            "components_file: %s" % docFile,
             "---",
             "{\% include swagger_json/get_path.md \%}"
         ]
     end
 
     def write
-        File.open("%s/%s/%s/%s.%s" % [@basePath, "pages", "swagger", @permalink, "md"], "w+") do |f|
+        File.open("%s/%s/%s/%s.%s" % [@basePath, "pages", "swagger", @docFile, "md"], "w+") do |f|
             f.puts(@lines)
           end
     end
-end
 
+    def self.createComponents(basePath, title, sidebar, swaggerfile, docFile, componentsKey)
+        swaggerfileName = File.basename(swaggerfile, ".*")
+        contentLines = [
+            "---",
+            "title: %s Models" % title,
+            "keyword: json, openapi, models, components",
+            "sidebars:",
+            " - name: %s" % sidebar,
+            "folder: swagger",
+            "toc: false",
+            "swaggerfile: %s" % swaggerfileName,
+            "swaggerkey: %s" % componentsKey,
+            "permalink: %s_components.html" % docFile,
+            "link: %s_components.html" % docFile,
+            "---",
+            "{% include swagger_json/get_components.md attribute='page.swaggerkey' %}",
+            "",
+            "{% include links.html %}",
+        ]
+        AcosOpenApiHelper::PageCreator.writeFile("%s/pages/swagger/%s_components.md" % [basePath, docFile], contentLines)
+    end
+
+    def self.writeFile(fullPath, contentLines )
+        File.open("%s" % fullPath, "w+") do | f | 
+            f.puts(contentLines)
+        end
+    end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: acos_jekyll_openapi_helper
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.4.5
 platform: ruby
 authors:
 - Acos AS
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-23 00:00:00.000000000 Z
+date: 2019-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -51,7 +51,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Open API json file helper