swagger_docs_generator 0.2.0 → 0.3.0.pre.18

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

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
 # :reek:UtilityFunction
+# :reek:InstanceVariableAssumption
+# :reek:TooManyStatements
+# :reek:TooManyInstanceVariables
 
 module SwaggerDocsGenerator
   module Actions
@@ -50,65 +53,6 @@ module SwaggerDocsGenerator
       def schema(&block)
         @schema = SwaggerDocsGenerator::Actions::Schema.new(&block).to_hash
       end
-=begin
-      def complete_hash(data)
-        raw = data[key]
-        hash[key] = raw.present? ? each_response(raw) : no_response
-      end
-
-      def each_response(raw)
-        sh = {}
-        raw.each do |code|
-          case code
-          when Array
-            sh.merge!(one_response_with_schema(code))
-          when Integer
-            sh.merge!(one_response(code))
-          end
-        end
-        sh
-      end
-
-      def no_response
-        one_response(200)
-      end
-
-      def one_response(code)
-        response = ActionDispatch::Response.new(code)
-        { response.code => { description: response.message } }
-      end
-
-      # :reek:FeatureEnvy
-      def one_response_with_schema(code)
-        key = code[0]
-        response = ActionDispatch::Response.new(key)
-        {
-          response.code => {
-            'description' => response.message,
-            'schema' => type_or_not(code)
-          }
-        }
-      end
-
-      def type_or_not(code)
-        code.length.eql?(3) ? include_type(code) : no_type(code)
-      end
-
-      def include_type(code)
-        {
-          'type' => code[1],
-          'items' => {
-            '$ref' => code[2]
-          }
-        }
-      end
-
-      def no_type(code)
-        {
-          '$ref' => code[1]
-        }
-      end
-=end
     end
   end
 end

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

@@ -1,7 +1,11 @@
 # frozen_string_literal: true
 
+# :reek:InstanceVariableAssumption
 module SwaggerDocsGenerator
   module Actions
+    # Object Schema
+    #
+    # Parse repsonse and create schema swagger object
     class Schema
       def initialize(&block)
         instance_eval(&block) if block_given?

data/lib/swagger_docs_generator/parser/controller.rb

@@ -7,14 +7,14 @@ module SwaggerDocsGenerator
   # and adding automaticaly tags element.
   class ParserController < Parser
     def initialize(description)
-      super(binding.of_callers[1].klass::CONTROLLER)
-      prepare_file
+      super(binding.of_callers[1].klass)
       @description = description
+      prepare_file
     end
 
     def adding_tag
-      json = JSON.parse(File.read(controller_file))
-      File.open(controller_file, 'w') do |file|
+      json = JSON.parse(File.read(temporary_file))
+      File.open(temporary_file, 'w') do |file|
         json['tags'].merge!(construct_tags)
         file.puts(JSON.pretty_generate(json))
       end
@@ -25,15 +25,15 @@ module SwaggerDocsGenerator
     def prepare_file
       delete_file
       base_file = { paths: {}, tags: {}, definitions: {} }
-      File.open(controller_file, 'a+') { |file| file.puts(base_file.to_json) }
+      File.open(temporary_file, 'a+') { |file| file.puts(base_file.to_json) }
     end
 
     def delete_file
-      File.delete(controller_file) if File.exist?(controller_file)
+      File.delete(temporary_file) if File.exist?(temporary_file)
     end
 
     def construct_tags
-      { name: controller_name, description: @description }
+      { name: tag_name, description: @description }
     end
   end
 end

data/lib/swagger_docs_generator/parser/definition.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+# :reek:InstanceVariableAssumption
 module SwaggerDocsGenerator
   # # Parse Controller classes
   #
@@ -7,14 +8,14 @@ module SwaggerDocsGenerator
   # and adding automaticaly tags element.
   class ParserDefinition < Parser
     def initialize(name, &block)
-      super(binding.of_callers[1].klass::CONTROLLER)
+      super(binding.of_callers[1].klass)
       @name = name
       instance_eval(&block)
     end
 
     def adding_defintion
-      json = JSON.parse(File.read(controller_file))
-      File.open(controller_file, 'w') do |file|
+      json = JSON.parse(File.read(temporary_file))
+      File.open(temporary_file, 'w') do |file|
         json['definitions'].merge!(construct_definition)
         file.puts(JSON.pretty_generate(json))
       end
@@ -39,10 +40,11 @@ module SwaggerDocsGenerator
     end
 
     def construct
-      element = {}
-      element.merge!(type: @type || 'object')
-      element.merge!(required: @required)       if @required.present?
-      element.merge!(properties: @properties)   if @properties.present?
+      {
+        type: @type || 'object',
+        required: @required || [],
+        properties: @properties
+      }
     end
 
     def format_name

data/lib/swagger_docs_generator/parser/model.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require 'swagger_docs_generator/parser/models/mongo'
-require 'swagger_docs_generator/parser/models/active_record'
-
 module SwaggerDocsGenerator
   # Parser models
   class Model

data/lib/swagger_docs_generator/parser/parser.rb

@@ -7,21 +7,18 @@ module SwaggerDocsGenerator
   #
   # @!attribute [r] controller
   #   It's a name of controller parsed
-  # @!attribute [r] path
-  #   It's a path to temporary file
-  # @!attribute [r] version
-  #   It's a version to API documentation parsed
+  # @!attribute [r] tag_name
+  #   It's a tag attaching to controller
   class Parser
-    attr_reader :controller, :path, :version
+    attr_reader :controller, :tag_name
 
-    def initialize(controller)
-      @controller = controller
-      @path = File.join(Dir.pwd, 'public')
-      @version = SwaggerDocsGenerator.configure_info.version
+    def initialize(klass)
+      @controller = klass::CONTROLLER
+      @tag_name = defined?(klass::TAG) ? klass::TAG : controller_name
     end
 
-    def controller_file
-      File.join(@path, @version, "#{controller_name}.json")
+    def temporary_file
+      File.join(SwaggerDocsGenerator.temporary_folder, tmp_json)
     end
 
     private
@@ -29,6 +26,10 @@ module SwaggerDocsGenerator
     def controller_name
       @controller.controller_name
     end
+
+    def tmp_json
+      "#{@tag_name}.json"
+    end
   end
 end
 

data/lib/swagger_docs_generator.rb

@@ -13,6 +13,12 @@ require 'swagger_docs_generator/configuration/configuration_info'
 
 # Modules methods in a controller
 require 'swagger_docs_generator/methods'
+
+# Models reader (ORM)
+require 'swagger_docs_generator/models/mongo'
+require 'swagger_docs_generator/models/active_record'
+
+# Parser class
 require 'swagger_docs_generator/parser/parser'
 
 # Extractor verb

data/lib/tasks/swagger.rake

@@ -2,18 +2,19 @@
 
 namespace :swagger do
   desc 'Generate Swagger Documentation files'
+  # Execute task just for environment 'doc'
   task docs: :environment do
     swag = SwaggerDocsGenerator::Generator.new
 
+    puts 'Imports documentation file...'
+    swag.import_documentations
+
     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 :'
+    puts 'Aggregate documentation data in `swagger.json` :'
+    swag.info_controller_parser { |info| puts info }
     swag.generate_swagger_file
 
     puts

data/spec/spec_helper.rb

@@ -7,6 +7,7 @@ require 'bundler/setup'
 require 'swagger_docs_generator'
 require 'json-schema-rspec'
 require 'pry'
+require 'faker'
 
 Dir['spec/supporrt/**/*.rb'].each do |f|
   require File.expand_path(f)

data/spec/support/examples/parameters.rb

@@ -0,0 +1,154 @@
+# frozen_string_literal: true
+
+# Test for parameter BODY
+RSpec.shared_examples 'parameters body haves' do
+  let(:test) { param.instance_variable_get(:@param) }
+
+  include_examples 'parameters haves'
+
+  context 'schema' do
+    let(:result) { param_schema }
+    include_examples 'parameter equal', :@schema
+  end
+
+  it do
+    name = param_name.nil? ? 'body' : param_name
+    description = param_description.nil? ? '' : param_description
+    required = param_required.nil? ? true : param_required
+    schema = param_schema.nil? ? '' : "#/definitions/#{param_schema.humanize}"
+
+    expect(param.to_hash).to eql(
+      in: :body,
+      name: name,
+      description: description,
+      required: required,
+      schema: { '$ref': schema }
+    )
+  end
+end
+
+# Test for parameter FORM
+RSpec.shared_examples 'parameters form haves' do
+  let(:test) { param.instance_variable_get(:@param) }
+
+  include_examples 'parameters haves'
+
+  it do
+    name = param_name.nil? ? 'form' : param_name
+    description = param_description.nil? ? '' : param_description
+    required = param_required.nil? ? true : param_required
+
+    expect(param.to_hash).to eql(
+      in: :form,
+      name: name,
+      description: description,
+      required: required
+    )
+  end
+end
+
+# Test for parameter HEADER
+RSpec.shared_examples 'parameters header haves' do
+  let(:test) { param.instance_variable_get(:@param) }
+
+  include_examples 'parameters haves'
+
+  context 'type' do
+    let(:result) { param_type }
+    include_examples 'parameter equal', :@type
+  end
+
+  it do
+    name = param_name.nil? ? 'header' : param_name
+    description = param_description.nil? ? '' : param_description
+    required = param_required.nil? ? true : param_required
+    type = param_type.nil? ? '' : param_type
+
+    expect(param.to_hash).to eql(
+      in: :header,
+      name: name,
+      description: description,
+      required: required,
+      type: type
+    )
+  end
+end
+
+# Test for parameter PATH
+RSpec.shared_examples 'parameters path haves' do
+  let(:test) { param.instance_variable_get(:@param) }
+
+  include_examples 'parameters haves'
+
+  context 'type' do
+    let(:result) { param_type }
+    include_examples 'parameter equal', :@type
+  end
+
+  it do
+    name = param_name.nil? ? 'path' : param_name
+    description = param_description.nil? ? '' : param_description
+    required = param_required.nil? ? true : param_required
+    type = param_type.nil? ? '' : param_type
+
+    expect(param.to_hash).to eql(
+      in: :path,
+      name: name,
+      description: description,
+      required: required,
+      type: type
+    )
+  end
+end
+
+# Test for parameter QUERY
+RSpec.shared_examples 'parameters query haves' do
+  let(:test) { param.instance_variable_get(:@param) }
+
+  include_examples 'parameters haves'
+
+  context 'type' do
+    let(:result) { param_type }
+    include_examples 'parameter equal', :@type
+  end
+
+  it do
+    name = param_name.nil? ? 'query' : param_name
+    description = param_description.nil? ? '' : param_description
+    required = param_required.nil? ? true : param_required
+    type = param_type.nil? ? 'array' : param_type
+
+    expect(param.to_hash).to eql(
+      in: :query,
+      name: name,
+      description: description,
+      required: required,
+      type: type,
+      items: { type: 'string' }
+    )
+  end
+end
+
+# Test for ALL parameters
+RSpec.shared_examples 'parameters haves' do
+  it { expect(param.to_hash).to be_kind_of Hash }
+
+  context 'name' do
+    let(:result) { param_name }
+    include_examples 'parameter equal', :@name
+  end
+
+  context 'description' do
+    let(:result) { param_description }
+    include_examples 'parameter equal', :@description
+  end
+
+  context 'required' do
+    let(:result) { param_required }
+    include_examples 'parameter equal', :@required
+  end
+end
+
+RSpec.shared_examples 'parameter equal' do |parameter|
+  it { expect(test.instance_variable_get(parameter)).to eql(result) }
+end

data/spec/swagger_docs_generator/configuration/configuration_customize_spec.rb

@@ -13,7 +13,7 @@ describe SwaggerDocsGenerator::Configuration, type: :gem,
       config.host = 'http://example.com'
       config.swagger = '2.2.4'
       config.cleanning = false
-      config.base_controller = []
+      config.doc_class = 'base.rb'
     end
   end
 
@@ -28,16 +28,16 @@ describe SwaggerDocsGenerator::Configuration, type: :gem,
       it_behaves_like 'variable exist', false
     end
 
-    context 'base_controller' do
-      let(:variable) { SwaggerDocsGenerator.config.base_controller }
-      it_behaves_like 'variable exist', []
-    end
-
     context 'base_path' do
       let(:variable) { SwaggerDocsGenerator.config.base_path }
       it_behaves_like 'variable exist', '/'
     end
 
+    context 'doc_class' do
+      let(:variable) { SwaggerDocsGenerator.config.doc_class }
+      it_behaves_like 'variable exist', 'base.rb'
+    end
+
     context 'schemes' do
       let(:variable) { SwaggerDocsGenerator.config.schemes }
       it_behaves_like 'variable exist', ['http']

data/spec/swagger_docs_generator/configuration/configuration_default_spec.rb

@@ -15,9 +15,14 @@ describe SwaggerDocsGenerator::Configuration, type: :gem,
       it_behaves_like 'variable exist', true
     end
 
-    context 'base_controller' do
-      let(:variable) { SwaggerDocsGenerator.config.base_controller }
-      it_behaves_like 'variable exist', ''
+    context 'doc_class' do
+      let(:variable) { SwaggerDocsGenerator.config.doc_class }
+      it_behaves_like 'variable does not exist'
+    end
+
+    context 'doc_folder' do
+      let(:variable) { SwaggerDocsGenerator.config.doc_folder }
+      it_behaves_like 'variable does not exist'
     end
 
     context 'base_path' do

data/spec/swagger_docs_generator/parser/parameters/param_body_spec.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe SwaggerDocsGenerator::Actions::Body, type: :parser,
+                                              name: :params_body do
+  let(:param_name) { nil }
+  let(:param_description) { nil }
+  let(:param_required) { nil }
+  let(:param_schema) { nil }
+  let(:param) do
+    pname = param_name
+    pdescription = param_description
+    prequired = param_required
+    pschema = param_schema
+    SwaggerDocsGenerator::Actions::Parameter.new do
+      body do
+        name pname
+        description pdescription
+        required prequired
+        schema pschema
+      end
+    end
+  end
+
+  context 'when attribute complete' do
+    let(:param_name) { Faker::Color.color_name }
+    let(:param_description) { Faker::Beer.name }
+    let(:param_required) { Faker::Boolean.boolean }
+    let(:param_schema) { Faker::Name.first_name }
+
+    it_behaves_like 'parameters body haves'
+  end
+
+  context 'when attribute is incomplete' do
+    it_behaves_like 'parameters body haves'
+  end
+
+  context 'when name attribute alone' do
+    let(:param_name) { Faker::Color.color_name }
+
+    it_behaves_like 'parameters body haves'
+  end
+
+  context 'when description attribute alone' do
+    let(:param_description) { Faker::Beer.name }
+
+    it_behaves_like 'parameters body haves'
+  end
+
+  context 'when required attribute alone' do
+    let(:param_required) { Faker::Boolean.boolean }
+
+    it_behaves_like 'parameters body haves'
+  end
+
+  context 'when schema attribute alone' do
+    let(:param_schema) { Faker::Name.first_name }
+
+    it_behaves_like 'parameters body haves'
+  end
+end

data/spec/swagger_docs_generator/parser/parameters/param_form_spec.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe SwaggerDocsGenerator::Actions::Form, type: :parser,
+                                              name: :params_form do
+  let(:param_name) { nil }
+  let(:param_description) { nil }
+  let(:param_required) { nil }
+  let(:param) do
+    pname = param_name
+    pdescription = param_description
+    prequired = param_required
+    SwaggerDocsGenerator::Actions::Parameter.new do
+      form do
+        name pname
+        description pdescription
+        required prequired
+      end
+    end
+  end
+
+  context 'when attribute complete' do
+    let(:param_name) { Faker::Color.color_name }
+    let(:param_description) { Faker::Beer.name }
+    let(:param_required) { Faker::Boolean.boolean }
+
+    it_behaves_like 'parameters form haves'
+  end
+
+  context 'when attribute is incomplete' do
+    it_behaves_like 'parameters form haves'
+  end
+
+  context 'when name attribute alone' do
+    let(:param_name) { Faker::Color.color_name }
+
+    it_behaves_like 'parameters form haves'
+  end
+
+  context 'when description attribute alone' do
+    let(:param_description) { Faker::Beer.name }
+
+    it_behaves_like 'parameters form haves'
+  end
+
+  context 'when required attribute alone' do
+    let(:param_required) { Faker::Boolean.boolean }
+
+    it_behaves_like 'parameters form haves'
+  end
+end

data/spec/swagger_docs_generator/parser/parameters/param_header_spec.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe SwaggerDocsGenerator::Actions::Header, type: :parser,
+                                                name: :params_header do
+  let(:param_name) { nil }
+  let(:param_description) { nil }
+  let(:param_required) { nil }
+  let(:param_type) { nil }
+  let(:param) do
+    pname = param_name
+    pdescription = param_description
+    prequired = param_required
+    ptype = param_type
+    SwaggerDocsGenerator::Actions::Parameter.new do
+      header do
+        name pname
+        description pdescription
+        required prequired
+        type ptype
+      end
+    end
+  end
+
+  context 'when attribute complete' do
+    let(:param_name) { Faker::Color.color_name }
+    let(:param_description) { Faker::Beer.name }
+    let(:param_required) { Faker::Boolean.boolean }
+    let(:param_type) { Faker::Name.first_name }
+
+    it_behaves_like 'parameters header haves'
+  end
+
+  context 'when attribute is incomplete' do
+    it_behaves_like 'parameters header haves'
+  end
+
+  context 'when name attribute alone' do
+    let(:param_name) { Faker::Color.color_name }
+
+    it_behaves_like 'parameters header haves'
+  end
+
+  context 'when description attribute alone' do
+    let(:param_description) { Faker::Beer.name }
+
+    it_behaves_like 'parameters header haves'
+  end
+
+  context 'when required attribute alone' do
+    let(:param_required) { Faker::Boolean.boolean }
+
+    it_behaves_like 'parameters header haves'
+  end
+
+  context 'when type attribute alone' do
+    let(:param_type) { Faker::Name.first_name }
+
+    it_behaves_like 'parameters header haves'
+  end
+end