swagger_docs_generator 0.2.0 → 0.3.0.pre.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 46d2c397e8fe3a149b506e49911b3d683d1a79d9
-  data.tar.gz: be8306cee8bc3607fbb48b064150234aa5b4fad3
+  metadata.gz: b051b9f9b3126e0dfde300b94560f20a5960cbfd
+  data.tar.gz: 9cb75ad8328e271617bbb2a0bfa5f5b1b5971588
 SHA512:
-  metadata.gz: c4eb8d811e9a3c2f511219a8fa8dd064f12671988301b1f066e12fdfb11886d4a0b79e086ae0c3c4a9294c0f85ce27e2f44ca59acd24b35d1f7c9473cabb9dc1
-  data.tar.gz: 4976b9e2392805348b93bf5bed8f06d1bdba469ccf6c017ad7612adb6de0f3c757d67bba6c0c7de7f9920810ab0639f47b7383bdd7b3ba793273e5802147cc22
+  metadata.gz: 2f8aef3acd286a908de1e73a170f9f67c8dd9ef2f401d17c77580014bf84a28ff0777181202437064b547c1c19271ad3671c2f014055b9c8261023954b5e579d
+  data.tar.gz: d7c2943197818158acf799cfd96e11cd0feeff52254171a72d5fde516c70003cd18f2177c4602bc6cf55037eccdc751b30b93d70ca2a4ad4b274d9abb43a7f5b

data/lib/swagger_docs_generator/configuration/configuration.rb

@@ -18,18 +18,15 @@ module SwaggerDocsGenerator
   # @see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md
   class Configuration
     # Accessors with default value
-    attr_accessor :swagger, :cleanning, :base_controller, :base_path
+    attr_accessor :swagger, :cleanning, :base_path
 
     # Accessors without default value
     attr_accessor :schemes, :consumes, :produces, :host, :external_docs,
-                  :security, :definitions
-    # :external_docs, :security_definitions, :security
-    # :paths, :tags, :host
+                  :security, :definitions, :doc_class, :doc_folder
 
     # Initalize default value (and requried) for json swagger file
     def initialize
       @swagger = '2.0'
-      @base_controller = ''
       @base_path = '/'
       @cleanning = true
     end
@@ -43,5 +40,17 @@ module SwaggerDocsGenerator
     def config
       @config ||= Configuration.new
     end
+
+    def file_base
+      File.join(@config.doc_folder, @config.doc_class)
+    end
+
+    def file_docs
+      Dir[File.join(@config.doc_folder, '*.rb')]
+    end
+
+    def temporary_folder
+      Rails.root.join('tmp', SwaggerDocsGenerator::GEM)
+    end
   end
 end

data/lib/swagger_docs_generator/configuration/configuration_info.rb

@@ -26,5 +26,9 @@ module SwaggerDocsGenerator
     def info
       @info ||= ConfigurationInfo.new
     end
+
+    def version_ruby
+      @info.version.humanize
+    end
   end
 end

data/lib/swagger_docs_generator/generator.rb

@@ -11,30 +11,44 @@ module SwaggerDocsGenerator
     attr_reader :swagger_file
 
     def initialize
-      @hash = {}
       @file = 'swagger.json'
-      @swagger_file = File.join(path, @file)
-      @version = File.join(path, SwaggerDocsGenerator.configure_info.version)
-      create_version_folder
+      @swagger_file = File.join(Dir.pwd, 'public', @file)
+      @temp = FileUtils.mkdir_p(SwaggerDocsGenerator.temporary_folder)
+    end
+
+    # Import documentation file
+    def import_documentations
+      require SwaggerDocsGenerator.file_base
+      SwaggerDocsGenerator.file_docs.each { |rb| require rb }
     end
 
     # Open or create a swagger.json file
     def generate_swagger_file
       delete_file_before
-      File.open(@swagger_file, 'a+') { |file| file.puts agregate_metadata }
+      File.open(@swagger_file, 'a+') do |file|
+        # file.puts write_in_swagger_file.to_json
+        file.puts JSON.pretty_generate write_in_swagger_file
+      end
     end
 
     # Delete files temporary
     def delete_temporary_files
-      FileUtils.remove_dir(@version) if SwaggerDocsGenerator.configure.cleanning
+      FileUtils.rm_rf(@temp[0]) if SwaggerDocsGenerator.configure.cleanning
     end
 
     def info_swagger_file
-      create_info_text(@swagger_file)
+      "#{prefix_info} #{@swagger_file}"
     end
 
     def info_swagger_temporary
-      create_info_text(@version)
+      "#{prefix_info} #{SwaggerDocsGenerator.temporary_folder}"
+    end
+
+    def info_controller_parser
+      klasses = "#{SwaggerDocsGenerator.version_ruby}::BaseDoc".constantize
+      klasses.subclasses.each do |controller|
+        yield("#{prefix_info} [Controller] #{controller::CONTROLLER}")
+      end
     end
 
     private
@@ -45,50 +59,19 @@ module SwaggerDocsGenerator
       '->'
     end
 
-    def create_info_text(message)
-      "#{prefix_info} #{message}"
-    end
-
-    # :reek:UtilityFunction
-    def path
-      File.join(Dir.pwd, '/public')
-    end
-
     def delete_file_before
       File.delete(@swagger_file) if File.exist?(@swagger_file)
     end
 
-    def create_version_folder
-      FileUtils.mkdir_p(@version) unless File.directory?(@version)
-    end
-
+    # :reek:UtilityFunction
     def write_in_swagger_file
-      write_in_swagger_file_configurations
-      write_in_swagger_file_controllers
-      write_in_swagger_file_models
-    end
-
-    def write_in_swagger_file_configurations
-      @hash.merge!(MetadataConfiguration.new.construct_swagger_file)
-      @hash.merge!(MetadataInfo.new.construct_swagger_file)
-    end
-
-    def write_in_swagger_file_controllers
-      @hash.merge!(MetadataPath.new.construct_swagger_file)
-      @hash.merge!(MetadataTag.new.construct_swagger_file)
-    end
-
-    def write_in_swagger_file_models
-      @hash.merge!(MetadataDefinition.new.construct_swagger_file)
-    end
-
-    def agregate_metadata
-      case defined?(Rails) && Rails.env
-      when 'production' || 'test'
-        write_in_swagger_file.to_json
-      else
-        JSON.pretty_generate write_in_swagger_file
-      end
+      # Parse option to this gem
+      hash = MetadataConfiguration.new.construct_swagger_file
+      hash.merge!(MetadataInfo.new.construct_swagger_file)
+      # Parse temporary file (controller - actions)
+      hash.merge!(MetadataJsons.new.construct_swagger_file)
+      # Parse Model
+      hash.merge!(MetadataDefinition.new.construct_swagger_file)
     end
   end
 end

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.2.0'
+  VERSION =       '0.3.0'
   # Authors contributed to gem
   AUTHORS =       ['VAILLANT Jeremy'].freeze
   # Email to ahuthors

data/lib/swagger_docs_generator/metadata/controller.rb

@@ -6,40 +6,12 @@ module SwaggerDocsGenerator
   # @abstract
   #   Abstract class for metadata provide to controlloer in Rails application
   class MetadataController < Metadata
-    def initialize
-      @file_path = File.join(Dir.pwd, 'public',
-                             SwaggerDocsGenerator.configure_info.version)
-      @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 |= search_subclasses(controller) }
-      array
-    end
-
-    def class_controller
-      search_subclasses(@conf.subclasses)
-    end
-
     # :reek:UtilityFunction
-    def search_subclasses(controller)
-      ctrl = controller.subclasses
-      ctrl.count.zero? ? [controller] : ctrl
+    def temporary_file(controller)
+      File.join(SwaggerDocsGenerator.temporary_folder,
+                "#{controller.controller_name}.json")
     end
   end
 end

data/lib/swagger_docs_generator/metadata/definition.rb

@@ -8,7 +8,7 @@ module SwaggerDocsGenerator
   # Generate metadata for block definition in swagger file
   #
   # @see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#definitions-object
-  class MetadataDefinition < MetadataController
+  class MetadataDefinition < Metadata
     def initialize
       super
       @model = nil
@@ -24,20 +24,19 @@ module SwaggerDocsGenerator
       find_models.merge!(find_in_controller)
     end
 
-    # :reek:NilCheck
     def find_models
       hash = {}
-      controllers.each do |controller|
-        data = each_controller(controller)
-        hash.merge!(data) unless data.nil?
+      all_class_documentation.each do |controller|
+        data = each_controller(controller::CONTROLLER)
+        hash.merge!(data) unless data.empty?
       end
       hash
     end
 
     def find_in_controller
       hash = {}
-      controllers.each do |controller|
-        file = File.join(file_path, "#{controller.controller_name}.json")
+      all_class_documentation.each do |controller|
+        file = temporary_file(controller::CONTROLLER)
         hash.merge!(read_file(file)) if File.exist?(file)
       end
       hash
@@ -49,11 +48,15 @@ module SwaggerDocsGenerator
       json.key?('definitions') ? json['definitions'] : {}
     end
 
-    def each_controller(controller)
-      @model = Model.new(controller)
+    def each_controller(model_name)
+      read_model(model_name) || {}
+    end
+
+    def read_model(model_name)
+      @model = Model.new(model_name)
       contruct_hash
     rescue NameError => message
-      puts "Error model name : #{message.name}"
+      puts "-> [Model] #{message.name} -- doesn't exist"
     end
 
     def contruct_hash
@@ -64,5 +67,11 @@ module SwaggerDocsGenerator
         }
       }
     end
+
+    # :reek:UtilityFunction
+    def temporary_file(controller)
+      File.join(SwaggerDocsGenerator.temporary_folder,
+                "#{controller.controller_name}.json")
+    end
   end
 end

data/lib/swagger_docs_generator/metadata/jsons.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module SwaggerDocsGenerator
+  # Parse temporary json files
+  class MetadataJsons
+    def initialize
+      @paths = { paths: {} }
+      @tags_array = []
+    end
+
+    def construct_swagger_file
+      hash = {}
+      files_tmp.each do |file|
+        @paths[:paths].merge!(read_part_json(file, 'paths'))
+        @tags_array.push read_part_json(file, 'tags')
+      end
+      hash.merge(@paths).merge(tags: @tags_array)
+    end
+
+    private
+
+    # :reek:UtilityFunction
+    def files_tmp
+      Dir[Rails.root.join(SwaggerDocsGenerator.temporary_folder, '*.json')]
+    end
+
+    # :reek:UtilityFunction
+    def read_part_json(file, key)
+      JSON.parse(File.read(file))[key]
+    end
+  end
+end

data/lib/swagger_docs_generator/metadata/metadata.rb

@@ -24,10 +24,20 @@ module SwaggerDocsGenerator
 
     private
 
+    # :reek:UtilityFunction
+    def base_class_documentation
+      "#{SwaggerDocsGenerator.version_ruby}::BaseDoc".constantize
+    end
+
+    def all_class_documentation
+      base_class_documentation.subclasses
+    end
+
     attr_reader :config
   end
 end
 
 require 'swagger_docs_generator/metadata/configuration'
 require 'swagger_docs_generator/metadata/info'
-require 'swagger_docs_generator/metadata/controller'
+require 'swagger_docs_generator/metadata/jsons'
+require 'swagger_docs_generator/metadata/definition'

data/lib/swagger_docs_generator/parser/action.rb

@@ -2,12 +2,19 @@
 
 require 'swagger_docs_generator/parser/actions/actions'
 
+# :reek:UtilityFunction
+# :reek:InstanceVariableAssumption
+# :reek:TooManyInstanceVariables
+# :reek:TooManyStatements
+
+# rubocop:disable Metrics/AbcSize
+# rubocop:disable Metrics/CyclomaticComplexity
 module SwaggerDocsGenerator
   # # Parse action in controller classe to Rails application. It's adding
   # paths to swagger docs file.
   class ParserAction < Parser
     def initialize(action, &block)
-      super(binding.of_callers[1].klass::CONTROLLER)
+      super(binding.of_callers[1].klass)
       @action = action
       @parameter = []
       @response = {}
@@ -15,9 +22,8 @@ module SwaggerDocsGenerator
     end
 
     def adding_path
-      json = JSON.parse(File.read(controller_file))
-      File.open(controller_file, 'w') do |file|
-        # json['paths'].merge!(construct_routes(json))
+      json = JSON.parse(File.read(temporary_file))
+      File.open(temporary_file, 'w') do |file|
         path_exist(json, construct_routes)
         file.puts(JSON.pretty_generate(json))
       end
@@ -54,7 +60,7 @@ module SwaggerDocsGenerator
       element.merge!(deprecated: @deprecated)     if @deprecated.present?
       element.merge!(produces: @produce)          if @produce.present?
       element.merge!(responses: @response)
-      element.merge!(tags: @tag || default_tag)
+      element.merge!(tags: write_tag)
     end
 
     def route
@@ -65,8 +71,8 @@ module SwaggerDocsGenerator
       { @route => { @verb => construct_path }.merge!(patch: construct_path) }
     end
 
-    def default_tag
-      [controller_name]
+    def write_tag
+      [@tag_name]
     end
 
     def summary(text)
@@ -100,3 +106,5 @@ module SwaggerDocsGenerator
     end
   end
 end
+# rubocop:enable Metrics/AbcSize
+# rubocop:enable Metrics/CyclomaticComplexity

data/lib/swagger_docs_generator/parser/actions/parameters/body.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# :reek:InstanceVariableAssumption
+# :reek:NilCheck
+
+module SwaggerDocsGenerator
+  module Actions
+    # Write parameter type :body
+    class Body < Parameter
+      def to_hash
+        {
+          in:               :body,
+          name:             @name.nil? ? 'body' : @name,
+          description:      @description.nil? ? '' : @description,
+          required:         @required.nil? ? true : @required,
+          schema: { '$ref': @schema.nil? ? '' : format_name }
+        }
+      end
+
+      private
+
+      def schema(text)
+        @schema = text
+      end
+
+      def format_name
+        "#/definitions/#{@schema.tr(' ', '_').camelize}"
+      end
+    end
+  end
+end

data/lib/swagger_docs_generator/parser/actions/parameters/form.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# :reek:InstanceVariableAssumption
+# :reek:NilCheck
+
+module SwaggerDocsGenerator
+  module Actions
+    # Write parameter type :form
+    class Form < Parameter
+      def to_hash
+        {
+          in:               :form,
+          name:             @name.nil? ? 'form' : @name,
+          description:      @description.nil? ? '' : @description,
+          required:         @required.nil? ? true : @required
+        }
+      end
+    end
+  end
+end

data/lib/swagger_docs_generator/parser/actions/parameters/header.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+# :reek:InstanceVariableAssumption
+# :reek:NilCheck
+
+module SwaggerDocsGenerator
+  module Actions
+    # Write parameter type :header
+    class Header < Parameter
+      def to_hash
+        {
+          in:               :header,
+          name:             @name.nil? ? 'header' : @name,
+          description:      @description.nil? ? '' : @description,
+          required:         @required.nil? ? true : @required,
+          type:             @type.nil? ? '' : @type
+        }
+      end
+
+      private
+
+      def type(text)
+        @type = text
+      end
+    end
+  end
+end

data/lib/swagger_docs_generator/parser/actions/parameters/path.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+# :reek:InstanceVariableAssumption
+# :reek:NilCheck
+
+module SwaggerDocsGenerator
+  module Actions
+    # Write parameter type :path
+    class Path < Parameter
+      def to_hash
+        {
+          in:               :path,
+          name:             @name.nil? ? 'path' : @name,
+          description:      @description.nil? ? '' : @description,
+          required:         @required.nil? ? true : @required,
+          type:             @type.nil? ? '' : @type
+        }
+      end
+
+      private
+
+      def type(text)
+        @type = text
+      end
+    end
+  end
+end

data/lib/swagger_docs_generator/parser/actions/parameters/query.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+# :reek:InstanceVariableAssumption
+# :reek:NilCheck
+
+module SwaggerDocsGenerator
+  module Actions
+    # Write parameter type :query
+    class Query < Parameter
+      def to_hash
+        {
+          in:               :query,
+          name:             @name.nil? ? 'query' : @name,
+          description:      @description.nil? ? '' : @description,
+          required:         @required.nil? ? true : @required,
+          type:             @type.nil? ? 'array' : @type,
+          items: { type: 'string' }
+        }
+      end
+
+      private
+
+      def type(text)
+        @type = text
+      end
+    end
+  end
+end

data/lib/swagger_docs_generator/parser/actions/parameters.rb

@@ -1,6 +1,11 @@
 # frozen_string_literal: true
 
 # :reek:UtilityFunction
+# :reek:InstanceVariableAssumption
+# :reek:TooManyInstanceVariables
+# :reek:DuplicateMethodCall
+# :reek:TooManyStatements
+
 module SwaggerDocsGenerator
   module Actions
     # # Test :parameters
@@ -8,88 +13,57 @@ module SwaggerDocsGenerator
     # Complete parameters field for action
     class Parameter
       def initialize(&block)
+        @param = nil
         instance_eval(&block) if block_given?
       end
 
       def to_hash
-        case @in
-        when :path then path_hash
-        when :header then header_hash
-        when :query then query_hash
-        when :body then body_hash
-        when :form then form_hash
-        end
+        @param.to_hash
       end
 
       private
 
-      def path(data)
-        @in = :path
-        @name = data[0]
-        @description = data[1]
-        @type = data[2]
-        @required = data[3]
+      def name(text)
+        @name = text
       end
 
-      def path_hash
-        {
-          name: @name,
-          in: @in,
-          description: @description,
-          required: @required,
-          type: @type
-        }
+      def description(text)
+        @description = text
       end
 
-      def header(data)
-        @in = :header
-        @name = data[0]
-        @description = data[1]
-        @type = data[2]
-        @required = data[3]
-        @enum = data[4]
+      def required(text)
+        @required = text
       end
 
-      def header_hash
-        {
-          name: @name,
-          in: @in,
-          description: @description,
-          required: @required,
-          type: @type,
-          enum: @enum
-        }
+      def body(&block)
+        @param = Body.new(&block)
       end
 
-      def query(data)
-        @in = :query
+      def form(&block)
+        @param = Form.new(&block)
       end
 
-      alias query_hash path_hash
-
-      def body(data)
-        @in = :body
-        @name = data[1]
-        @description = data[0]
-        @definition = data[1]
+      def header(&block)
+        @param = Header.new(&block)
       end
 
-      def body_hash
-        {
-          name: @name,
-          in: @in,
-          description: @description,
-          required: true,
-          schema: { type: :object, items: { '$ref': @definition.tr(' ', '_').camelize } }
-        }
+      def path(&block)
+        @param = Path.new(&block)
       end
 
-      def form(data)
-        @in = :form
+      def query(&block)
+        @param = Query.new(&block)
       end
 
-      def form_hash
+      def test_value(value, default)
+        value.empty? ? default : value
       end
     end
   end
 end
+
+require 'swagger_docs_generator/parser/actions/parameters/body'
+require 'swagger_docs_generator/parser/actions/parameters/form'
+require 'swagger_docs_generator/parser/actions/parameters/header'
+require 'swagger_docs_generator/parser/actions/parameters/path'
+require 'swagger_docs_generator/parser/actions/parameters/query'