swagger_docs_generator 0.4.0 → 0.5.0.pre.38

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b1acc55b2ce3bf7a00dd5181f202f40639ee86ae
-  data.tar.gz: baba1e428c1cf9df4195ff207cda25e94eab922a
+  metadata.gz: 99671fbfa13e6100c95d70456f4bd7e68a91665e
+  data.tar.gz: a239e809a764c71c7be6951bf9711e1a90b105fb
 SHA512:
-  metadata.gz: 93ea4e3b522dcf2d842f20a9a7f90ba809566abe4f1b63d7e93d3942310c2c6b95446402b71957a1c845f3f53ad121aa94e9e4358c945f8bb62d24424ee2eee1
-  data.tar.gz: ae86e26cf7d4a46915ca71d290c6b929f92bef02da20252bfc9d1cc17ef3fbcd431ac97b43b2cd72ced90eb8fabf84c866c8337395a627577be87b66b051cbc2
+  metadata.gz: 9d71ec8f62af085153f19b39f9683926de3373e1316ca2dd9e9511d3895a03275a609122ea5199d8ed891f6cc9c7f1ddfefe3ca14964a7fb61eca8034e153fbb
+  data.tar.gz: 07b1283f91640ba7002ab53518e2a8fc57d304afa6708a748f7f15e2b5d8ca8967a3e69e15b272e05d802d452113c7b86755cbddbac0afe8ee8b583f32c4e364

data/lib/swagger_docs_generator/configuration/configuration.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 # :reek:Attribute
+# :reek:TooManyInstanceVariables
 module SwaggerDocsGenerator
   # # Configuration to swagger json file
   #
@@ -18,7 +19,7 @@ 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_path, :compress
+    attr_accessor :swagger, :cleanning, :base_path, :compress, :sort
 
     # Accessors without default value
     attr_accessor :schemes, :consumes, :produces, :host, :external_docs,
@@ -30,6 +31,7 @@ module SwaggerDocsGenerator
       @base_path = '/'
       @cleanning = true
       @compress = false
+      @sort = 'tag'
     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.4.0'
+  VERSION =       '0.5.0'
   # Authors contributed to gem
   AUTHORS =       ['VAILLANT Jeremy'].freeze
   # Email to ahuthors

data/lib/swagger_docs_generator/metadata/jsons.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'swagger_docs_generator/metadata/sort'
+
 module SwaggerDocsGenerator
   # Parse temporary json files
   class MetadataJsons
@@ -14,7 +16,7 @@ module SwaggerDocsGenerator
         @paths[:paths].merge!(read_part_json(file, 'paths'))
         @tags_array.push read_part_json(file, 'tags')
       end
-      hash.merge(@paths).merge(tags: @tags_array)
+      hash.merge(sort_paths).merge(tags: @tags_array)
     end
 
     private
@@ -28,5 +30,15 @@ module SwaggerDocsGenerator
     def read_part_json(file, key)
       JSON.parse(File.read(file))[key]
     end
+
+    def sort_paths
+      order = Sort.new(@paths)
+      case SwaggerDocsGenerator.configure.sort
+      when 'path' then order.sort_by_path
+      when 'tag' then order.sort_by_tag
+      else
+        @paths
+      end
+    end
   end
 end

data/lib/swagger_docs_generator/metadata/sort.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+# :reek:FeatureEnvy
+
+module SwaggerDocsGenerator
+  # Sort routes in hash before writing in JSON file
+  class Sort
+    def initialize(hash)
+      @routes = hash
+      @readme = { README: @routes[:paths]['README'] }
+    end
+
+    # Sort routes by path
+    def sort_by_path
+      by_path = Hash[@routes[:paths].sort]
+      place_readme_first(by_path)
+    end
+
+    # Sort routes by tags
+    def sort_by_tag
+      by_tag = Hash[@routes[:paths].sort_by do |_key, value|
+        value.first[1]['tags']
+      end]
+      place_readme_first(by_tag)
+    end
+
+    private
+
+    def place_readme_first(hash)
+      if hash.key?('README')
+        hash.delete('README')
+        { paths: @readme.merge!(hash) }
+      else
+        { paths: hash }
+      end
+    end
+  end
+end

data/lib/swagger_docs_generator/methods.rb

@@ -26,8 +26,15 @@ module SwaggerDocsGenerator
       parse.adding_definition
     end
 
+    # Create section for display a README in top to documentation
+    def swagger_readme(readme_file)
+      parse = ParserReadme.new(readme_file)
+      parse.adding_readme
+    end
+
     alias scontroller   swagger_controller
     alias sdoc          swagger_doc
     alias sdefinition   swagger_definition
+    alias sreadme       swagger_readme
   end
 end

data/lib/swagger_docs_generator/parser/action.rb

@@ -44,7 +44,7 @@ module SwaggerDocsGenerator
       keys_new = hash.keys[0]
       paths = hash.keys.split.first
 
-      test_tags(paths, hash)
+      # test_tags(paths, hash)
       merge_hashes(old_route, keys_new.to_s, paths, hash)
     end
 

data/lib/swagger_docs_generator/parser/parser.rb

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

data/lib/swagger_docs_generator/parser/readme.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module SwaggerDocsGenerator
+  # # Parse Readme information
+  #
+  # Parse block code for display basic information for this API Doc
+  class ParserReadme < Parser
+    def initialize(readme_file)
+      @tag_name = 'README'
+      @readme = readme_file
+      create_file
+    end
+
+    def adding_readme
+      json = JSON.parse(File.read(temporary_file))
+      File.open(temporary_file, 'w') do |file|
+        json['paths'].merge!(complete_path)
+        json['tags'].merge!(complete_tag)
+        file.puts(JSON.pretty_generate(json))
+      end
+    end
+
+    private
+
+    def complete_path
+      {
+        @tag_name => {
+          get: {
+            summary: 'Introduction',
+            description: @readme,
+            tags: [@tag_name]
+          }
+        }
+      }
+    end
+
+    def complete_tag
+      {
+        name: @tag_name,
+        description: 'Display basic information to this API documentation'
+      }
+    end
+
+    def create_file
+      File.delete(temporary_file) if File.exist?(temporary_file)
+      base_file = { paths: {}, tags: {}, definitions: {} }
+      File.open(temporary_file, 'a+') { |file| file.puts(base_file.to_json) }
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swagger_docs_generator
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0.pre.38
 platform: ruby
 authors:
 - VAILLANT Jeremy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-11 00:00:00.000000000 Z
+date: 2017-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -255,6 +255,7 @@ files:
 - lib/swagger_docs_generator/metadata/info.rb
 - lib/swagger_docs_generator/metadata/jsons.rb
 - lib/swagger_docs_generator/metadata/metadata.rb
+- lib/swagger_docs_generator/metadata/sort.rb
 - lib/swagger_docs_generator/methods.rb
 - lib/swagger_docs_generator/models/active_record.rb
 - lib/swagger_docs_generator/models/mongo.rb
@@ -272,6 +273,7 @@ files:
 - lib/swagger_docs_generator/parser/definition.rb
 - lib/swagger_docs_generator/parser/model.rb
 - lib/swagger_docs_generator/parser/parser.rb
+- lib/swagger_docs_generator/parser/readme.rb
 - lib/swagger_docs_generator/parser/sub_definition.rb
 - lib/swagger_docs_generator/railtie.rb
 - lib/tasks/swagger.rake
@@ -326,9 +328,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.4.5