acos_jekyll_openapi_helper 1.4.0 → 1.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a476f2e49f239cb44b14d518fa996e8ac1526d8aed78bd8492013ced5f3168b
-  data.tar.gz: bbb1182273672c521c182c4bbcccd2cdee6d9672b0639a77e48943df7897ef4f
+  metadata.gz: d00cea2080b6f56489bd291fc1f99f40b15d24fb4239069eeb1cac49ad3e80d4
+  data.tar.gz: f9f43ac742804cf156780fc0c9b728f6aa552783067c680d5955efb45578c67e
 SHA512:
-  metadata.gz: 46758cefc2a3cc5c067115f73f1c0861f3f1c8ecadffacd2946634b25c3f825754344fd655dfa65f77a2b2659085b434b3e436647c517513fd0886b40574e0ce
-  data.tar.gz: 3f252cb117ff922b4877e0e6cfc894bb026652d6f5f692b7aa220db6793dc72192b0419e4ed51efb24f993304a8fa303ac235cdfa802282454bd868fe1045238
+  metadata.gz: 690fb0719009b4690a8173b4fa4c23ab6bc644f536fbc3f58210b5694e8d4e474bb6d549699fc1f56d77705b9b5ea1b5dbfb428d4132cf6854babee6c02d2b82
+  data.tar.gz: 5e5ae160424c995101aa7efb7e0fe9a85a45eb0cc53998a049f5127357cadd0eb2858d40b5cc92fdc26657bd1751465080c074d3d67baa7d8f5630a35d7ae6e8

data/lib/acos_jekyll_openapi.rb

@@ -46,7 +46,6 @@ class AcosOpenApiHelper::PageEngine
     def initialize(data, basePath, output_path, swaggerfile)
         @data = data
         @output_path = output_path
-        #@sidebar = sidebar
         @swaggerfile = swaggerfile
         @basePath = basePath
     end        
@@ -54,39 +53,34 @@ class AcosOpenApiHelper::PageEngine
     def generate
         puts "Generating pages..."
         cnt = 0
-        puts "Open API version %s in .json file" % @data['openapi']
-        docTitle = @data["info"]["title"]
-        sidebar =  "%s_sidebar" % docTitle.gsub(/\s+|{|}|\//, "_").downcase
+        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()
         @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)
+            writer =  AcosOpenApiHelper::PageCreator.new(_path, @basePath, @output_path, @swaggerfile, sidebar, docFile)
             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 
@@ -132,9 +126,9 @@ class AcosOpenApiHelper::SidebarMenu
                 _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
@@ -142,6 +136,8 @@ class AcosOpenApiHelper::SidebarMenu
         File.open("%s/%s.%s" % [output_path, name, "yml"], "w+") do | f |
             f.puts(_standardLines)
         end
+
+        @@entries.clear
     end
     
 end
@@ -174,24 +170,38 @@ 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)
         # 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 = [
             "---",
             "# THIS PAGE IS GENERATED. ANY CHANGES TO PAGE WILL POTENTIALLY BE OVERWRITTEN.",
-            "title: User API %s" % path,
+            "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",
@@ -204,9 +214,37 @@ class AcosOpenApiHelper::PageCreator
     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
+
+    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.4.0
+  version: 1.4.3
 platform: ruby
 authors:
 - Acos AS
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-24 00:00:00.000000000 Z
+date: 2019-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json