swagger_docs_generator 0.2.0.pre.10 → 0.2.0.pre.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6db6476d8a74fb1036694844728c899992a59ab5
-  data.tar.gz: 4e076fb6834a2a24c733393118efad97dd8e2c42
+  metadata.gz: 0e45753803dd76bb3478784c1b0fe4d9d84a8812
+  data.tar.gz: c0963b4195cb065a63cdef9262128b0ef339826b
 SHA512:
-  metadata.gz: 68ee2e3c1904de34c1ad42da475a6f9af5526ff66ec0e623564ac9dbc372d824d3ece0f78a44acaaa2e2d5a9c3b67a9b1c2eb1fdcdd53170daf1cd9369142f16
-  data.tar.gz: 906d679e89ca512f47fc290540f5e3b44f8e14652fce4add4f09720e3d8915d00272a4450246c7dd9c0e8a64125ad27172ca4cca081c81ae83c6c3bf951ce0f6
+  metadata.gz: c146f8a0015cd59c8a8ad53e991cb1551ebf5338d67b23536f536318721e4a0c5a52e0e6ea213698d763e7d86f7d9e097856eafe4c674dd2b5484b13a994e80d
+  data.tar.gz: 1089f0afbd625f7f98cb87422998b53f102d33b3c71cf5a7e2732e12e0f97885f064fe01d7df23801e8629efa4561f7ab0db37d75757565d0b706179d6e6bec0

data/README.md

@@ -1,4 +1,4 @@
-# Swagger::Docs::Generator | [![Build Status](https://travis-ci.org/Dev-Crea/swagger-docs-generator.svg?branch=master)](https://travis-ci.org/Dev-Crea/swagger-docs-generator) [![Gem Version](https://badge.fury.io/rb/swagger_docs_generator.svg)](https://badge.fury.io/rb/swagger_docs_generator) [![Inline docs](https://inch-ci.org/github/Dev-Crea/swagger-docs-generator.svg)](https://inch-ci.org/github/Dev-Crea/swagger-docs-generator)
+# Swagger::Docs::Generator | [![Travis][1]][2] [![Gem][21]][22] [![Docs][11]][12]
 
 Generator for Swagger Apps ([Example with theme](https://github.com/Dev-Crea/swagger-ui))
 
@@ -10,7 +10,6 @@ Generator for Swagger Apps ([Example with theme](https://github.com/Dev-Crea/swa
 * [Development](#development)
 * [Contributing](#contributing)
 
-
 ## How to use
 
 ### Installation
@@ -24,13 +23,13 @@ gem 'swagger-docs-generator'
 And then execute :
 
 ```linux
-$ bundle
+bundle
 ```
 
 Or install it yourself as :
 
 ```linux
-$ gem install swagger-docs-generator
+gem install swagger_docs_generator
 ```
 
 ### Usage
@@ -62,7 +61,16 @@ push git commits and tags, and push the `.gem` file to
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at
-https://github.com/Dev-Crea/swagger-docs-generator. This project is intended to
+<https://github.com/Dev-Crea/swagger-docs-generator>. This project is intended to
 be a safe, welcoming space for collaboration, and contributors are expected to
 adhere to the [Contributor Covenant](http://contributor-covenant.org)
 code of conduct.
+
+[1]: https://travis-ci.org/Dev-Crea/swagger-docs-generator.svg?branch=master
+[2]: https://travis-ci.org/Dev-Crea/swagger-docs-generator
+
+[11]: https://badge.fury.io/rb/swagger_docs_generator.svg
+[12]: https://badge.fury.io/rb/swagger_docs_generator
+
+[21]: https://inch-ci.org/github/Dev-Crea/swagger-docs-generator.svg
+[22]: https://inch-ci.org/github/Dev-Crea/swagger-docs-generator

data/lib/swagger_docs_generator/configuration/configuration.rb

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

data/lib/swagger_docs_generator/generator.rb

@@ -25,15 +25,30 @@ module SwaggerDocsGenerator
     end
 
     # Delete files temporary
-    # @todo necessary ?
     def delete_temporary_files
-      # FileUtils.rm_rf(@version)
+      FileUtils.remove_dir(@version) if SwaggerDocsGenerator.configure.cleanning
+    end
+
+    def info_swagger_file
+      create_info_text(@swagger_file)
+    end
+
+    def info_swagger_temporary
+      create_info_text(@version)
     end
 
     private
 
     attr_reader :meta
 
+    def prefix_info
+      '->'
+    end
+
+    def create_info_text(message)
+      "#{prefix_info} #{message}"
+    end
+
     # :reek:UtilityFunction
     def path
       File.join(Dir.pwd, '/public')

data/lib/swagger_docs_generator/metadata/controller.rb

@@ -9,17 +9,32 @@ module SwaggerDocsGenerator
     def initialize
       @file_path = File.join(Dir.pwd, 'public',
                              SwaggerDocsGenerator.configure_info.version)
-      conf = SwaggerDocsGenerator.configure.base_controller
-      @controllers = if conf.is_a?(String)
-                       ApplicationController.subclasses
-                     else
-                       conf.subclasses
+      @conf = SwaggerDocsGenerator.configure.base_controller
+      @controllers = case @conf
+                     when String then string_controller
+                     when Array then array_controller
+                     when Class then class_controller
                      end
     end
 
     private
 
     attr_accessor :controllers, :file_path
+
+    # :reek:UtilityFunction
+    def string_controller
+      ApplicationController.subclasses
+    end
+
+    def array_controller
+      array = []
+      @conf.map { |controller| array |= controller.subclasses }
+      array
+    end
+
+    def class_controller
+      @conf.subclasses
+    end
   end
 end
 

data/lib/tasks/swagger.rake

@@ -1,13 +1,24 @@
 # frozen_string_literal: true
+
 namespace :swagger do
   desc 'Generate Swagger Documentation files'
   task docs: :environment do
-    puts 'Create Swagger File in public/swagger.json'
     swag = SwaggerDocsGenerator::Generator.new
+
+    puts 'Create Swagger File in :'
+    puts swag.info_swagger_file
+
     # Reload all controller before parsing
     Rails.application.eager_load!
+
     # Generates files
+    puts
+    puts 'Generate doc file :'
     swag.generate_swagger_file
+
+    puts
+    puts 'Delete temporary file :'
+    puts swag.info_swagger_temporary
     swag.delete_temporary_files
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swagger_docs_generator
 version: !ruby/object:Gem::Version
-  version: 0.2.0.pre.10
+  version: 0.2.0.pre.11
 platform: ruby
 authors:
 - VAILLANT Jeremy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-13 00:00:00.000000000 Z
+date: 2017-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler