swagger_docs_generator 0.3.5 → 0.3.6.pre.34

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 27fde121cf7c356443ed2dae43ad719e059a1f50
-  data.tar.gz: bbe30b62e53b12fba3327d8ed37d6f7c9e281897
+  metadata.gz: b0d5baad818850dbd3ff75f23ffb8560e5063521
+  data.tar.gz: 2832ad4e8d604d6517ae8983df8d07a3baf8e8e0
 SHA512:
-  metadata.gz: c9e2423b38ecbe6b5e36f2d4103e0a6c569636688d97ae4ee7bbc4b01330f798cd7748f3284502171fbd4706d38ba4360e7fa16da0f0006c39324185f2becb1f
-  data.tar.gz: aa0815acac4205505fe4a235a7cf03bd7819ac7bc8a65bc7d6ddc87da29283a596a5bf5b38f943fec31b9b47f663936b244b63d9dd6bee30f2678ead0cdc7ffe
+  metadata.gz: cd0c15b13abb397a8437fdef01f55448c8b9cde9689faa7e34b26709d12b1c08ec5a1c5f2f97d8f8deae141808131f234739eb656743a713e7ab17ea532fcefa
+  data.tar.gz: 16e02dfd9f2431c26d7d4c7788a80d725b9aa125624c9ad036b72da3d840b2965bc4e8029bbaea9d6911e533a604a687fd773f8a0724c7ad70e736b03e910229

data/lib/generators/swagger_docs_generator/environment_generator.rb

@@ -7,12 +7,12 @@ module SwaggerDocsGenerator
   class EnvironmentGenerator < Rails::Generators::Base
     desc 'Generate a Environment `doc` for Swagger Docs Generator'
     ENVIRONMENT = <<-INIT
-# frozen_string_literal: true
+  # frozen_string_literal: true
 
-Rails.application.configure do
-  # Do not eader load code on boot.
-  config.eager_load = false
-end
+  Rails.application.configure do
+    # Do not eader load code on boot.
+    config.eager_load = false
+  end
     INIT
 
     # Create a new environment

data/lib/generators/swagger_docs_generator/initializer_generator.rb

@@ -7,20 +7,20 @@ module SwaggerDocsGenerator
   class InitializerGenerator < Rails::Generators::Base
     desc 'Generate a initializer for Swagger Docs Generator'
     INITIALIZER = <<-INIT
-# frozen_string_literal: true
+  # frozen_string_literal: true
 
-if Rails.env.doc?
-  SwaggerDocsGenerator.configure do |config|
-    config.swagger = '2.2.4'        # Swagger version used
-    config.base_path = '/'          # Base to API
-    config.host = 'localhost:3000'  # Host api
-  end
+  if Rails.env.doc?
+    SwaggerDocsGenerator.configure do |config|
+      config.swagger = '2.2.4'        # Swagger version used
+      config.base_path = '/'          # Base to API
+      config.host = 'localhost:3000'  # Host api
+    end
 
-  SwaggerDocsGenerator.configure_info do |info|
-    info.title = 'API example.com'  # Title to API
-    info.version = 'v1'             # Version to API
+    SwaggerDocsGenerator.configure_info do |info|
+      info.title = 'API example.com'  # Title to API
+      info.version = 'v1'             # Version to API
+    end
   end
-end
     INIT
 
     # Create initializer

data/lib/swagger_docs_generator/extractor.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 # :reek:NestedIterators
+# :reek:TooManyStatements
+# :reek:UtilityFunction
 
 module SwaggerDocsGenerator
   # # Extractor routes info
@@ -22,12 +24,14 @@ module SwaggerDocsGenerator
 
     # Extract path to routes and change format to parameter path
     def path
+      temporary = []
+      actual_route = nil
       router do |route|
-        route.path.spec.to_s.gsub('(.:format)',
-                                  '.json').gsub(/:[a-z1-9_A-Z]*/) do |word|
-          "{#{word.delete(':')}}"
-        end
+        actual_route = extract_and_format_route(route)
+        temporary.push(actual_route) unless temporary.include?(actual_route)
+        actual_route
       end
+      temporary
     end
 
     private
@@ -52,5 +56,12 @@ module SwaggerDocsGenerator
       end
       data.downcase
     end
+
+    def extract_and_format_route(route)
+      route.path.spec.to_s.gsub('(.:format)',
+                                '.json').gsub(/:[a-z1-9_A-Z]*/) do |word|
+        "{#{word.delete(':')}}"
+      end
+    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.3.5'
+  VERSION =       '0.3.6'
   # Authors contributed to gem
   AUTHORS =       ['VAILLANT Jeremy'].freeze
   # Email to ahuthors

data/lib/swagger_docs_generator/metadata/metadata.rb

@@ -5,8 +5,8 @@ module SwaggerDocsGenerator
   #
   # Metadata generated in swagger json file
   class Metadata
-    ACCEPT = %i(title version contact description host schemes base_path
-                swagger).freeze
+    ACCEPT = %i[title version contact description host schemes base_path
+                swagger].freeze
 
     def initialize
       @config = nil

data/lib/swagger_docs_generator/parser/action.rb

@@ -6,9 +6,15 @@ require 'swagger_docs_generator/parser/actions/actions'
 # :reek:InstanceVariableAssumption
 # :reek:TooManyInstanceVariables
 # :reek:TooManyStatements
+# :reek:DuplicateMethodCall
+# :reek:FeatureEnvy
+# :reek:TooManyMethods
+# :reek:LongParameterList
 
 # rubocop:disable Metrics/AbcSize
 # rubocop:disable Metrics/CyclomaticComplexity
+# rubocop:disable Style/MultilineIfModifier
+# rubocop:disable Metrics/ClassLength
 module SwaggerDocsGenerator
   # # Parse action in controller classe to Rails application. It's adding
   # paths to swagger docs file.
@@ -36,26 +42,52 @@ module SwaggerDocsGenerator
       old_route = json['paths']
 
       keys_new = hash.keys[0]
-      index = keys_new.to_s
+      paths = hash.keys.split.first
 
+      test_tags(paths, hash)
+      merge_hashes(old_route, keys_new.to_s, paths, hash)
+    end
+
+    def test_tags(paths, hash)
+      paths.each do |path|
+        tag = extract_tag(path)
+        next unless path.downcase.include?(tag.downcase) &&
+                    !hash[path][@verb][:tags].include?(tag) &&
+                    !tag.include?('.json')
+        add_tag(hash, path, tag)
+      end if paths.count <= 2
+    end
+
+    def add_tag(hash, path, tag)
+      hash[path][@verb][:tags].push(tag)
+      hash[path]['patch'][:tags].push(tag) if @verb.eql?('put')
+    end
+
+    def merge_hashes(old_route, index, paths, hash)
       if !old_route.blank? && old_route.keys.include?(index)
-        old_route[index].merge!(hash[keys_new])
+        paths.each do |path|
+          old_route[path].merge!(hash[path])
+        end
       else
         old_route.merge!(hash)
       end
     end
 
     def construct_routes
+      yop = {}
       extract = Extractor.new(controller, @action)
       @verb = extract.verb
       @route = extract.path
-      @verb.eql?('put') ? route_update : route
+      @route.each do |rte|
+        yop.merge!(@verb.eql?('put') ? route_update(rte) : route(rte))
+      end
+      yop
     end
 
     def construct_path
       element = {}
-      summary_text = @summary.present? ? @summary : @action.to_s.humanize
-      element.merge!(summary: summary_text)
+      summary_text = @summary.present? ? @summary : @action.to_s
+      element.merge!(summary: summary_text.humanize)
       element.merge!(description: @description)   if @description.present?
       element.merge!(parameters: @parameter)      if @parameter.present?
       element.merge!(consumes: @consume)          if @consume.present?
@@ -65,16 +97,20 @@ module SwaggerDocsGenerator
       element.merge!(tags: write_tag)
     end
 
-    def route
-      { @route => { @verb => construct_path } }
+    def route(rte)
+      { rte => { @verb => construct_path } }
     end
 
-    def route_update
-      { @route => { @verb => construct_path }.merge!(patch: construct_path) }
+    def route_update(rte)
+      { rte => { @verb => construct_path }.merge!('patch' => construct_path) }
     end
 
     def write_tag
-      [@tag_name]
+      [@tag_name.humanize]
+    end
+
+    def extract_tag(route)
+      route.split('/').reject(&:empty?).first.humanize
     end
 
     def summary(text)
@@ -110,3 +146,5 @@ module SwaggerDocsGenerator
 end
 # rubocop:enable Metrics/AbcSize
 # rubocop:enable Metrics/CyclomaticComplexity
+# rubocop:enable Style/MultilineIfModifier
+# rubocop:enable Metrics/ClassLength

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swagger_docs_generator
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.3.6.pre.34
 platform: ruby
 authors:
 - VAILLANT Jeremy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-28 00:00:00.000000000 Z
+date: 2017-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.42.0
+        version: 0.48.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.42.0
+        version: 0.48.1
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -325,9 +325,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