swagger_docs_generator 0.3.0.pre.18 → 0.3.0.pre.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b051b9f9b3126e0dfde300b94560f20a5960cbfd
-  data.tar.gz: 9cb75ad8328e271617bbb2a0bfa5f5b1b5971588
+  metadata.gz: e90f590a98d7160ff707934cffefbba3ec044944
+  data.tar.gz: 086ba2cb5900b201a2a3b9d328203a37f41fd85e
 SHA512:
-  metadata.gz: 2f8aef3acd286a908de1e73a170f9f67c8dd9ef2f401d17c77580014bf84a28ff0777181202437064b547c1c19271ad3671c2f014055b9c8261023954b5e579d
-  data.tar.gz: d7c2943197818158acf799cfd96e11cd0feeff52254171a72d5fde516c70003cd18f2177c4602bc6cf55037eccdc751b30b93d70ca2a4ad4b274d9abb43a7f5b
+  metadata.gz: 4832c1a5bd858f5c1833a3de24418ea6de110404d034820900e071c3714fdcb1e093444f92408865a00a04d1aca8d23d35591e16dec7feebe12ceb5345ec796b
+  data.tar.gz: 47761d497315d39cb9a061a4b2173b3ea2204a89966e977b86db6f4ea9e2bfbf52d4059cac63ab3b5a368f5452af23f622b7f7bb871e84a1461337cc3c5c8bdb

data/lib/swagger_docs_generator/info.rb

@@ -18,4 +18,23 @@ module SwaggerDocsGenerator
   HOMEPAGE =      'https://github.com/Dev-Crea/swagger-docs-generator'
   # License
   LICENSE =       'MIT'
+  # Define a post install message
+  POST_INSTALL = \
+    "# ====================================================== #\n" \
+    "# Thanks for installing SwaggerDocsGenerator !           #\n" \
+    "# #{HOMEPAGE}.    #\n" \
+    "# ;;;;;;;;;;;:.                                          #\n" \
+    "# ;;;;;;;;;;;;;;;;;;                                     #\n" \
+    "# ;;;;;;;;;;;:;;;;;;;;                                   #\n" \
+    "# ;;;;;;;;;;` ;;;;;;;;                                   #\n" \
+    "# ;;;;;;;;;  :;;;;;;;;.                                  #\n" \
+    "# ;;;;;;;;   :::::;;;;;                                  #\n" \
+    "# ;;;;;;,       ,;;;;;;                                  #\n" \
+    "# ;;;;;        ;;;;;;;;                                  #\n" \
+    "# ;;;;;;;;;   ;;;;;;;;,                                  #\n" \
+    "# ;;;;;;;;; `;;;;;;;;;     A    ZZZZZZZ ZZZZZZZ LL       #\n" \
+    "# ;;;;;;;;.:;;;;;;;;;;    A A      ZZZ     ZZZ  LL       #\n" \
+    "# ;;;;;;;;;;;;;;;;;      AAAAA   ZZ      ZZ     LL       #\n" \
+    "# ;;;;;;;;;;;;;,        A     A ZZZZZZZ ZZZZZZZ LLLLLLL  #\n" \
+    '# ====================================================== #'
 end

data/lib/swagger_docs_generator/metadata/definition.rb

@@ -21,7 +21,7 @@ module SwaggerDocsGenerator
     private
 
     def search_definition
-      find_models.merge!(find_in_controller)
+      find_models.merge!(find_in_jsons)
     end
 
     def find_models
@@ -33,11 +33,10 @@ module SwaggerDocsGenerator
       hash
     end
 
-    def find_in_controller
+    def find_in_jsons
       hash = {}
-      all_class_documentation.each do |controller|
-        file = temporary_file(controller::CONTROLLER)
-        hash.merge!(read_file(file)) if File.exist?(file)
+      files_tmp.each do |file|
+        hash.merge!(read_part_json(file, 'definitions'))
       end
       hash
     end
@@ -73,5 +72,15 @@ module SwaggerDocsGenerator
       File.join(SwaggerDocsGenerator.temporary_folder,
                 "#{controller.controller_name}.json")
     end
+
+    # :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/methods.rb

@@ -23,7 +23,7 @@ module SwaggerDocsGenerator
     # Complete definitions objects for each controller.
     def swagger_definition(name, &block)
       parse = ParserDefinition.new(name, &block)
-      parse.adding_defintion
+      parse.adding_definition
     end
 
     alias scontroller   swagger_controller

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

@@ -1,44 +1,11 @@
 # frozen_string_literal: true
 
 module SwaggerDocsGenerator
+  # Contains all actions in parser
   module Actions
-    # # Test value in actions
-    #
-    # @abstract classes for all actions class
-    # @see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#operation-object
-    class Actions
-      attr_reader :hash, :key
-
-      def initialize(key)
-        @key = key
-        @hash = { @key => {} }
-      end
-
-      def hash
-        @hash[@key] ? @hash : {}
-      end
-
-      # List to all childrens
-      def self.descendants
-        ObjectSpace.each_object(Class).select { |klass| klass < self }
-      end
-
-      private
-
-      def complete_hash(data)
-        raw ||= data[@key]
-        @hash[@key] = raw
-      end
-    end
   end
 end
 
-require 'swagger_docs_generator/parser/actions/tags'
-require 'swagger_docs_generator/parser/actions/summary'
-require 'swagger_docs_generator/parser/actions/description'
 require 'swagger_docs_generator/parser/actions/response'
-require 'swagger_docs_generator/parser/actions/consumes'
-require 'swagger_docs_generator/parser/actions/produces'
-require 'swagger_docs_generator/parser/actions/deprecated'
 require 'swagger_docs_generator/parser/actions/parameters'
 require 'swagger_docs_generator/parser/actions/schema'

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

@@ -1,23 +1,24 @@
 # frozen_string_literal: true
 
-# :reek:InstanceVariableAssumption
 module SwaggerDocsGenerator
   module Actions
-    # Object Schema
-    #
-    # Parse repsonse and create schema swagger object
+    # Create object swagger Schema
     class Schema
       def initialize(&block)
+        @definition = nil
+        @type = 'array'
         instance_eval(&block) if block_given?
       end
 
       def to_hash
-        element = { type: @type || 'array' }
-        element.merge!(items: { '$ref': @definition }) if @definition.present?
+        element = { type: @type }
+        element.merge!(items: { '$ref': @definition })
       end
 
       private
 
+      attr_reader :type, :definition
+
       def type(text)
         @type = text
       end

data/lib/swagger_docs_generator/parser/definition.rb

@@ -13,7 +13,7 @@ module SwaggerDocsGenerator
       instance_eval(&block)
     end
 
-    def adding_defintion
+    def adding_definition
       json = JSON.parse(File.read(temporary_file))
       File.open(temporary_file, 'w') do |file|
         json['definitions'].merge!(construct_definition)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: swagger_docs_generator
 version: !ruby/object:Gem::Version
-  version: 0.3.0.pre.18
+  version: 0.3.0.pre.19
 platform: ruby
 authors:
 - VAILLANT Jeremy
@@ -260,20 +260,14 @@ files:
 - lib/swagger_docs_generator/models/mongo.rb
 - lib/swagger_docs_generator/parser/action.rb
 - lib/swagger_docs_generator/parser/actions/actions.rb
-- lib/swagger_docs_generator/parser/actions/consumes.rb
-- lib/swagger_docs_generator/parser/actions/deprecated.rb
-- lib/swagger_docs_generator/parser/actions/description.rb
 - lib/swagger_docs_generator/parser/actions/parameters.rb
 - lib/swagger_docs_generator/parser/actions/parameters/body.rb
 - lib/swagger_docs_generator/parser/actions/parameters/form.rb
 - lib/swagger_docs_generator/parser/actions/parameters/header.rb
 - lib/swagger_docs_generator/parser/actions/parameters/path.rb
 - lib/swagger_docs_generator/parser/actions/parameters/query.rb
-- lib/swagger_docs_generator/parser/actions/produces.rb
 - lib/swagger_docs_generator/parser/actions/response.rb
 - lib/swagger_docs_generator/parser/actions/schema.rb
-- 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
@@ -302,7 +296,24 @@ homepage: https://github.com/Dev-Crea/swagger-docs-generator
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message: |-
+  # ====================================================== #
+  # Thanks for installing SwaggerDocsGenerator !           #
+  # https://github.com/Dev-Crea/swagger-docs-generator.    #
+  # ;;;;;;;;;;;:.                                          #
+  # ;;;;;;;;;;;;;;;;;;                                     #
+  # ;;;;;;;;;;;:;;;;;;;;                                   #
+  # ;;;;;;;;;;` ;;;;;;;;                                   #
+  # ;;;;;;;;;  :;;;;;;;;.                                  #
+  # ;;;;;;;;   :::::;;;;;                                  #
+  # ;;;;;;,       ,;;;;;;                                  #
+  # ;;;;;        ;;;;;;;;                                  #
+  # ;;;;;;;;;   ;;;;;;;;,                                  #
+  # ;;;;;;;;; `;;;;;;;;;     A    ZZZZZZZ ZZZZZZZ LL       #
+  # ;;;;;;;;.:;;;;;;;;;;    A A      ZZZ     ZZZ  LL       #
+  # ;;;;;;;;;;;;;;;;;      AAAAA   ZZ      ZZ     LL       #
+  # ;;;;;;;;;;;;;,        A     A ZZZZZZZ ZZZZZZZ LLLLLLL  #
+  # ====================================================== #
 rdoc_options: []
 require_paths:
 - lib

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

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-module SwaggerDocsGenerator
-  module Actions
-    # # Test :consumes
-    #
-    # Complete consume field for action
-    class Consumes < Actions
-      VALUE = :consumes
-
-      def initialize(data)
-        super(VALUE)
-        complete_hash(data)
-      end
-
-      private
-
-      def complete_hash(data)
-        default = ['application/json']
-        raw = data.key?(key) ? data[key] : default
-        hash[key] = raw
-      end
-    end
-  end
-end

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

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-module SwaggerDocsGenerator
-  module Actions
-    # # Test :deprecated
-    #
-    # Complete deprected field for action
-    class Deprecated < Actions
-      VALUE = :deprecated
-
-      def initialize(data)
-        super(VALUE)
-        complete_hash(data)
-      end
-    end
-  end
-end

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

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-module SwaggerDocsGenerator
-  module Actions
-    # # Test :description
-    #
-    # Complete description field for action
-    class Description < Actions
-      VALUE = :description
-
-      def initialize(data)
-        super(VALUE)
-        complete_hash(data)
-      end
-    end
-  end
-end

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

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-module SwaggerDocsGenerator
-  module Actions
-    # # Test :produces
-    #
-    # Complete consume field for action
-    class Produces < Actions
-      VALUE = :produces
-
-      def initialize(data)
-        super(VALUE)
-        complete_hash(data)
-      end
-
-      private
-
-      def complete_hash(data)
-        default = ['application/json']
-        raw = data.key?(key) ? data[key] : default
-        hash[key] = raw
-      end
-    end
-  end
-end

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

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-module SwaggerDocsGenerator
-  module Actions
-    # # Test :summary
-    #
-    # Complete summary field for action
-    class Summary < Actions
-      VALUE = :summary
-
-      def initialize(data)
-        super(VALUE)
-        complete_hash(data)
-      end
-    end
-  end
-end

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

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-module SwaggerDocsGenerator
-  module Actions
-    # # Test :tags
-    #
-    # Complete tags field for action
-    class Tags < Actions
-      VALUE = :tags
-
-      def initialize(data)
-        super(VALUE)
-        complete_hash(data)
-      end
-
-      private
-
-      def complete_hash(data)
-        hash[key] = [data]
-      end
-    end
-  end
-end