swagger_docs_generator 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6671b4df077b9fb55feda1f126ee870194a31bd6
-  data.tar.gz: 31a02536ca38fc3c076c1c77af0a6d9634a1a045
+  metadata.gz: 88cb5ca367ad15e76eb3c350fd799a9463b14ebd
+  data.tar.gz: 7fe85ae4081c3e680a69c66c36b4b8833c359a07
 SHA512:
-  metadata.gz: 972e8e0407cd1b40c3121f46abd3ddb3434a77c330cbab22aef9304248a7a47b19471ee39443cfe0b4cbd8031703cb5f943c375e5df4f7c083b2d43bb94b59d7
-  data.tar.gz: 151b024e6714eac2b4a323865e8891a08c1b11af978bddbcef5c385e7c3367304cf8439ab891df255fe30dd990e324e328b51fb02aecf6fe3d18bf0ae543ce6c
+  metadata.gz: 433a1104b08265a7bbd596243523a6dac7bd19ae48f872821f3bd70892fffa547743fa071f1c367464655b87f7effc60dbee2293f3603f456ebcba287e3d326c
+  data.tar.gz: d1dda1c6e3d952e331d09a58dcca9c5750ebf49b2a753892ce4fc7602b5551a6596c66029e1170c6fec3faa73c11387a1cb896978c0170a64d2610072721f918

data/lib/swagger_docs_generator/configuration/configuration.rb

@@ -19,13 +19,14 @@ module SwaggerDocsGenerator
   class Configuration
     attr_accessor :swagger, :base_path, :schemes, :consumes, :produces,
                   :host, :paths, :definitions, :security_definitions,
-                  :security, :tags, :external_docs
+                  :security, :tags, :external_docs, :base_controller
 
     SWAGGER = '2.0'
 
     # Initalize default value (and requried) for json swagger file
     def initialize
       @swagger = SWAGGER
+      @base_controller = ''
     end
   end
 

data/lib/swagger_docs_generator/extractor.rb

@@ -34,7 +34,7 @@ module SwaggerDocsGenerator
     end
 
     def controller_name
-      @controller.controller_name
+      @controller.controller_path
     end
 
     def router

data/lib/swagger_docs_generator/generator.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'json'
-
 module SwaggerDocsGenerator
   # # Generate JSON file
   #
@@ -16,19 +14,19 @@ module SwaggerDocsGenerator
       @file = 'swagger.json'
       @path = File.join(Dir.pwd, '/public')
       @swagger_file = File.join(@path, @file)
+      @version = File.join(@path, SwaggerDocsGenerator.configure_info.version)
+      create_version_folder
     end
 
     # Open or create a swagger.json file
     def generate_swagger_file
       delete_file_before
-      create_version_folder
       File.open(@swagger_file, 'a+') { |file| file.puts agregate_metadata }
     end
 
     # Delete files temporary
-    def delete_emporary_files
-      version = File.join(@path, SwaggerDocsGenerator.configure_info.version)
-      Dir.delete(File.join(@path, version))
+    def delete_temporary_files
+      FileUtils.rm_rf(@version)
     end
 
     private
@@ -40,8 +38,7 @@ module SwaggerDocsGenerator
     end
 
     def create_version_folder
-      version = File.join(@path, SwaggerDocsGenerator.configure_info.version)
-      FileUtils.mkdir_p(version) unless File.directory?(version)
+      FileUtils.mkdir_p(@version) unless File.directory?(@version)
     end
 
     # :reek:UtilityFunction

data/lib/swagger_docs_generator/info.rb

@@ -5,7 +5,7 @@ module SwaggerDocsGenerator
   # Name to gem
   GEM =           'swagger_docs_generator'
   # Version to gem
-  VERSION =       '0.1.0'
+  VERSION =       '0.1.1'
   # Authors contributed to gem
   AUTHORS =       ['VAILLANT Jeremy'].freeze
   # Email to ahuthors

data/lib/swagger_docs_generator/metadata/controller.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'json'
-
 module SwaggerDocsGenerator
   # # Metadata generated
   #
@@ -9,11 +7,14 @@ module SwaggerDocsGenerator
   #   Abstract class for metadata provide to controlloer in Rails application
   class MetadataController < Metadata
     def initialize
-      # Reload all controller before parsing
-      Rails.application.eager_load!
       @path = File.join(Dir.pwd, 'public',
                         SwaggerDocsGenerator.configure_info.version)
-      @controllers = ApplicationController.subclasses
+      conf = SwaggerDocsGenerator.configure.base_controller
+      @controllers = if conf.is_a?(String)
+                       ApplicationController.subclasses
+                     else
+                       conf.subclasses
+                     end
     end
 
     private

data/lib/swagger_docs_generator/parser/action.rb

@@ -27,10 +27,10 @@ module SwaggerDocsGenerator
       old_route = json['paths']
 
       keys_new = hash.keys[0]
-      keys_old = old_route.keys[0]
+      index = keys_new.to_s
 
-      if keys_new.to_s.eql?(keys_old.to_s)
-        old_route[keys_old].merge!(hash[keys_new])
+      if !old_route.blank? && old_route.keys.include?(index)
+        old_route[index].merge!(hash[keys_new])
       else
         old_route.merge!(hash)
       end

data/lib/swagger_docs_generator.rb

@@ -1,4 +1,8 @@
 # frozen_string_literal: true
+
+# Dependencies
+require 'json'
+
 # Information for this gem
 require 'swagger_docs_generator/info'
 

data/lib/tasks/swagger.rake

@@ -3,6 +3,11 @@ namespace :swagger do
   desc 'Generate Swagger Documentation files'
   task docs: :environment do
     puts 'Create Swagger File in public/swagger.json'
-    SwaggerDocsGenerator::Generator.new.generate_swagger_file
+    swag = SwaggerDocsGenerator::Generator.new
+    # Reload all controller before parsing
+    Rails.application.eager_load!
+    # Generates files
+    swag.generate_swagger_file
+    swag.delete_temporary_files
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: swagger_docs_generator
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - VAILLANT Jeremy