swagger_docs_generator 0.2.0.pre.11 → 0.2.0.pre.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0e45753803dd76bb3478784c1b0fe4d9d84a8812
-  data.tar.gz: c0963b4195cb065a63cdef9262128b0ef339826b
+  metadata.gz: 9009aea8fd6b52d2b41879fc5cf447cd1249a3c1
+  data.tar.gz: e2cc9ae0b640d99f00709ae593f2b40309c2a84d
 SHA512:
-  metadata.gz: c146f8a0015cd59c8a8ad53e991cb1551ebf5338d67b23536f536318721e4a0c5a52e0e6ea213698d763e7d86f7d9e097856eafe4c674dd2b5484b13a994e80d
-  data.tar.gz: 1089f0afbd625f7f98cb87422998b53f102d33b3c71cf5a7e2732e12e0f97885f064fe01d7df23801e8629efa4561f7ab0db37d75757565d0b706179d6e6bec0
+  metadata.gz: 7b5ca89476be2063bfbd8adaa803ac202513c2eafebe8f66b4bfc1b2169c0780c523e252a184b2a66167f77bdba289b2ba3b744a3c1eef22a0d4437e82a29c04
+  data.tar.gz: 1ce5c6e6a13a1512ab5af25e08f0df314c125e16afdbc9c9f5d9fc5e8569cb8b741cc4316af015686865ea5054812ef272d982a84e586c6baec17d0fa027ebbc

data/lib/swagger_docs_generator/configuration/configuration.rb

@@ -17,18 +17,21 @@ module SwaggerDocsGenerator
   #
   # @see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md
   class Configuration
-    attr_accessor :swagger, :base_path, :schemes, :consumes, :produces,
-                  :host, :paths, :definitions, :security_definitions,
-                  :security, :tags, :external_docs, :base_controller, :cleanning
+    # Accessors with default value
+    attr_accessor :swagger, :cleanning, :base_controller, :base_path
 
-    SWAGGER = '2.0'
-    CLEANNING = true
+    # Accessors without default value
+    attr_accessor :schemes, :consumes, :produces, :host, :external_docs,
+                  :security, :definitions
+    # :external_docs, :security_definitions, :security
+    # :paths, :tags, :host
 
     # Initalize default value (and requried) for json swagger file
     def initialize
-      @swagger = SWAGGER
+      @swagger = '2.0'
       @base_controller = ''
-      @cleanning = CLEANNING
+      @base_path = '/'
+      @cleanning = true
     end
   end
 

data/lib/swagger_docs_generator/configuration/configuration_info.rb

@@ -11,13 +11,10 @@ module SwaggerDocsGenerator
     attr_accessor :title, :description, :terms_of_service, :contact, :license,
                   :version
 
-    TITLE = 'Title Example API'
-    VERSION = '1.0.0'
-
     # Initialize required element
     def initialize
-      @title = TITLE
-      @version = VERSION
+      @title = 'Title Example API'
+      @version = '1.0.0'
     end
   end
 

data/lib/swagger_docs_generator/metadata/definition.rb

@@ -15,11 +15,15 @@ module SwaggerDocsGenerator
     end
 
     def construct_swagger_file
-      { definitions: find_models }
+      { definitions: search_definition }
     end
 
     private
 
+    def search_definition
+      find_models.merge!(find_in_controller)
+    end
+
     # :reek:NilCheck
     def find_models
       hash = {}
@@ -30,6 +34,21 @@ module SwaggerDocsGenerator
       hash
     end
 
+    def find_in_controller
+      hash = {}
+      controllers.each do |controller|
+        file = File.join(file_path, "#{controller.controller_name}.json")
+        hash.merge!(read_file(file)) if File.exist?(file)
+      end
+      hash
+    end
+
+    # :reek:UtilityFunction
+    def read_file(file)
+      json = JSON.parse(File.read(file))
+      json.key?('definitions') ? json['definitions'] : {}
+    end
+
     def each_controller(controller)
       @model = Model.new(controller)
       contruct_hash

data/lib/swagger_docs_generator/metadata/info.rb

@@ -30,7 +30,7 @@ module SwaggerDocsGenerator
     end
 
     def terms_of_service
-      { terms_of_service: @config.terms_of_service }
+      { termsOfService: @config.terms_of_service }
     end
 
     def contact

data/lib/swagger_docs_generator/methods.rb

@@ -17,5 +17,14 @@ module SwaggerDocsGenerator
       parse = ParserAction.new(controller, action, data)
       parse.adding_path
     end
+
+    def swagger_definition(controller, name, parameters)
+      parse = ParserDefinition.new(controller, name, parameters)
+      parse.adding_defintion
+    end
+
+    alias scontroller swagger_controller
+    alias sdoc swagger_doc
+    alias sdefinition swagger_definition
   end
 end

data/lib/swagger_docs_generator/parser/controller.rb

@@ -15,8 +15,7 @@ module SwaggerDocsGenerator
     def adding_tag
       json = JSON.parse(File.read(controller_file))
       File.open(controller_file, 'w') do |file|
-        hash = construct_tags(@description)
-        json['tags'].merge!(hash)
+        json['tags'].merge!(construct_tags)
         file.puts(JSON.pretty_generate(json))
       end
     end
@@ -33,8 +32,8 @@ module SwaggerDocsGenerator
       File.delete(controller_file) if File.exist?(controller_file)
     end
 
-    def construct_tags(description)
-      { name: controller_name, description: description }
+    def construct_tags
+      { name: controller_name, description: @description }
     end
   end
 end

data/lib/swagger_docs_generator/parser/definition.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module SwaggerDocsGenerator
+  # # Parse Controller classes
+  #
+  # Parse controller classes in Rails application. It's create temporary file
+  # and adding automaticaly tags element.
+  class ParserDefinition < Parser
+    def initialize(controller, name, parameters)
+      super(controller)
+      @name = name
+      @parameters = parameters
+    end
+
+    def adding_defintion
+      json = JSON.parse(File.read(controller_file))
+      File.open(controller_file, 'w') do |file|
+        if json.key?('definitions')
+          json['definitions'].merge!(construct_definition)
+        else
+          json['definitions'] = construct_definition
+        end
+        file.puts(JSON.pretty_generate(json))
+      end
+    end
+
+    private
+
+    def construct_definition
+      { format_name => { type: 'object', properties: @parameters } }
+    end
+
+    def format_name
+      @name.tr(' ', '_').camelize
+    end
+  end
+end

data/lib/swagger_docs_generator/parser/parser.rb

@@ -34,3 +34,4 @@ end
 
 require 'swagger_docs_generator/parser/controller'
 require 'swagger_docs_generator/parser/action'
+require 'swagger_docs_generator/parser/definition'

data/spec/spec_helper.rb

@@ -2,9 +2,19 @@
 
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 
+require 'rails'
 require 'bundler/setup'
 require 'swagger_docs_generator'
 require 'json-schema-rspec'
+require 'pry'
+
+Dir['spec/supporrt/**/*.rb'].each do |f|
+  require File.expand_path(f)
+end
+
+::Dir.glob(::File.expand_path('../support/**/*.rb', __FILE__)).each do |f|
+  require_relative f
+end
 
 RSpec.configure do |config|
   # Configure RSpec

data/spec/support/examples/configuration.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
-RSpec.shared_examples 'variable exist' do |name|
-  it name do
-    expect(variable).not_to be nil
-  end
+RSpec.shared_examples 'variable exist' do |default|
+  it { expect(variable).to eql(default) }
+end
+
+RSpec.shared_examples 'variable does not exist' do
+  it { expect(variable).to be nil }
 end

data/spec/support/examples/metadata.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+RSpec.shared_examples 'configuration metadata is' do |method|
+  key = method.to_s.camelize(:lower).to_sym
+
+  include_examples 'metadata type is hash', method
+  it { expect(metadata.send(method)).to include(key) }
+end
+
+RSpec.shared_examples 'metadata type is hash' do |method|
+  it { expect(metadata.send(method)).to be_kind_of Hash }
+end
+
+RSpec.shared_examples 'metadata type is array' do |method|
+  it { expect(metadata.send(method)).to be_kind_of Array }
+end

data/spec/swagger_docs_generator/configuration/configuration_customize_spec.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe SwaggerDocsGenerator::Configuration, type: :gem,
+                                              broken: true,
+                                              name: :configuration do
+  before(:example) do
+    SwaggerDocsGenerator.configure do |config|
+      config.schemes = ['http']
+      config.consumes = 'application/vnd.github.v3.full+json'
+      config.produces = 'application/vnd.github+json'
+      config.host = 'http://example.com'
+      config.swagger = '2.2.4'
+      config.cleanning = false
+      config.base_controller = []
+    end
+  end
+
+  describe 'with customize value' do
+    context 'swagger' do
+      let(:variable) { SwaggerDocsGenerator.config.swagger }
+      it_behaves_like 'variable exist', '2.2.4'
+    end
+
+    context 'cleanning' do
+      let(:variable) { SwaggerDocsGenerator.config.cleanning }
+      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 'schemes' do
+      let(:variable) { SwaggerDocsGenerator.config.schemes }
+      it_behaves_like 'variable exist', ['http']
+    end
+
+    context 'consumes' do
+      let(:variable) { SwaggerDocsGenerator.config.consumes }
+      it_behaves_like 'variable exist', 'application/vnd.github.v3.full+json'
+    end
+
+    context 'produces' do
+      let(:variable) { SwaggerDocsGenerator.config.produces }
+      it_behaves_like 'variable exist', 'application/vnd.github+json'
+    end
+
+    context 'host' do
+      let(:variable) { SwaggerDocsGenerator.config.host }
+      it_behaves_like 'variable exist', 'http://example.com'
+    end
+  end
+end

data/spec/swagger_docs_generator/configuration/configuration_default_spec.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe SwaggerDocsGenerator::Configuration, type: :gem,
+                                              name: :configuration do
+  describe 'with value default' do
+    context 'swagger' do
+      let(:variable) { SwaggerDocsGenerator.config.swagger }
+      it_behaves_like 'variable exist', '2.0'
+    end
+
+    context 'cleanning' do
+      let(:variable) { SwaggerDocsGenerator.config.cleanning }
+      it_behaves_like 'variable exist', true
+    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 'schemes' do
+      let(:variable) { SwaggerDocsGenerator.config.schemes }
+      it_behaves_like 'variable does not exist'
+    end
+
+    context 'consumes' do
+      let(:variable) { SwaggerDocsGenerator.config.consumes }
+      it_behaves_like 'variable does not exist'
+    end
+
+    context 'produces' do
+      let(:variable) { SwaggerDocsGenerator.config.produces }
+      it_behaves_like 'variable does not exist'
+    end
+
+    context 'host' do
+      let(:variable) { SwaggerDocsGenerator.config.host }
+      it_behaves_like 'variable does not exist'
+    end
+  end
+end

data/spec/swagger_docs_generator/configuration/configuration_info_spec.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'support/examples/configuration'
+
+describe SwaggerDocsGenerator::ConfigurationInfo, type: :gem,
+                                                  name: :configuration_info do
+  describe 'with valie default' do
+    context 'title' do
+      let(:variable) { SwaggerDocsGenerator.info.title }
+      it_behaves_like 'variable exist', 'Title Example API'
+    end
+
+    context 'version' do
+      let(:variable) { SwaggerDocsGenerator.info.version }
+      it_behaves_like 'variable exist', '1.0.0'
+    end
+  end
+end

data/spec/swagger_docs_generator/generator_spec.rb

@@ -4,7 +4,8 @@ require 'spec_helper'
 require 'support/examples/generator'
 
 describe SwaggerDocsGenerator::Generator, type: :gem,
-                                          name: :generator, broken: true do
+                                          broken: true,
+                                          name: :generator do
   before(:context) do
     @swag = SwaggerDocsGenerator::Generator.new
     @swagger_file = @swag.swagger_file

data/spec/swagger_docs_generator/metadata/configuration_spec.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe SwaggerDocsGenerator::MetadataConfiguration, type: :metadata,
+                                                      name: :configuration do
+  let(:metadata) { SwaggerDocsGenerator::MetadataConfiguration.new }
+
+  include_examples 'configuration metadata is', :swagger
+  include_examples 'configuration metadata is', :base_path
+  include_examples 'configuration metadata is', :schemes
+  include_examples 'configuration metadata is', :host
+  include_examples 'configuration metadata is', :definitions
+  include_examples 'configuration metadata is', :external_docs
+  include_examples 'configuration metadata is', :security
+end

data/spec/swagger_docs_generator/metadata/controller_spec.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe SwaggerDocsGenerator::MetadataController, type: :metadata,
+                                                   broken: true,
+                                                   name: :configuration do
+  let(:metadata) { SwaggerDocsGenerator::MetadataController.new }
+
+  before(:context) do
+    class ApplicationController < ::ApplicationController
+    end
+  end
+
+  it { expect(metadata.send(:class_controller)).to be_kind_of Array }
+  it { expect(metadata.send(:array_controller)).to be_kind_of Array }
+  it { expect(metadata.send(:string_controller)).to be_kind_of String }
+end

data/spec/swagger_docs_generator/metadata/info_spec.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe SwaggerDocsGenerator::MetadataInfo, type: :metadata,
+                                             name: :info do
+  let(:metadata) { SwaggerDocsGenerator::MetadataInfo.new }
+
+  include_examples 'configuration metadata is', :title
+  include_examples 'configuration metadata is', :version
+  include_examples 'configuration metadata is', :description
+  include_examples 'configuration metadata is', :terms_of_service
+  include_examples 'configuration metadata is', :contact
+  include_examples 'configuration metadata is', :license
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swagger_docs_generator
 version: !ruby/object:Gem::Version
-  version: 0.2.0.pre.11
+  version: 0.2.0.pre.12
 platform: ruby
 authors:
 - VAILLANT Jeremy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-16 00:00:00.000000000 Z
+date: 2017-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -202,6 +202,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.7.3
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
 description: Generates swagger-ui json file for rails-api
 email:
 - jeremy@dazzl.tv
@@ -239,6 +253,7 @@ files:
 - lib/swagger_docs_generator/parser/actions/summary.rb
 - lib/swagger_docs_generator/parser/actions/tags.rb
 - lib/swagger_docs_generator/parser/controller.rb
+- lib/swagger_docs_generator/parser/definition.rb
 - lib/swagger_docs_generator/parser/model.rb
 - lib/swagger_docs_generator/parser/models/active_record.rb
 - lib/swagger_docs_generator/parser/models/mongo.rb
@@ -248,10 +263,16 @@ files:
 - spec/spec_helper.rb
 - spec/support/examples/configuration.rb
 - spec/support/examples/generator.rb
+- spec/support/examples/metadata.rb
 - spec/support/schemas/swagger.json
-- spec/swagger_docs_generator/configuration_spec.rb
+- spec/swagger_docs_generator/configuration/configuration_customize_spec.rb
+- spec/swagger_docs_generator/configuration/configuration_default_spec.rb
+- spec/swagger_docs_generator/configuration/configuration_info_spec.rb
 - spec/swagger_docs_generator/gem_spec.rb
 - spec/swagger_docs_generator/generator_spec.rb
+- spec/swagger_docs_generator/metadata/configuration_spec.rb
+- spec/swagger_docs_generator/metadata/controller_spec.rb
+- spec/swagger_docs_generator/metadata/info_spec.rb
 homepage: https://github.com/Dev-Crea/swagger-docs-generator
 licenses:
 - MIT

data/spec/swagger_docs_generator/configuration_spec.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-require 'support/examples/configuration'
-
-describe SwaggerDocsGenerator::Configuration, type: :gem,
-                                              name: :configuration do
-  specify do
-    expect { |config| SwaggerDocsGenerator.configure(&config) }.to yield_control
-  end
-
-  let(:conf) { SwaggerDocsGenerator.configure }
-  let(:variable) { conf.swagger }
-  it_behaves_like 'variable exist', 'swagger'
-end
-
-describe SwaggerDocsGenerator::ConfigurationInfo, type: :gem,
-                                                  name: :configuration_info do
-  let(:conf) { SwaggerDocsGenerator.configure_info }
-  let(:variable) { conf.title }
-  it_behaves_like 'variable exist', 'title'
-  let(:variable) { conf.version }
-  it_behaves_like 'variable exist', 'version'
-end