swagger_docs_generator 0.2.0.pre.12 → 0.2.0.pre.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9009aea8fd6b52d2b41879fc5cf447cd1249a3c1
-  data.tar.gz: e2cc9ae0b640d99f00709ae593f2b40309c2a84d
+  metadata.gz: b08af150d77b9e052e8e36c629234707b13db339
+  data.tar.gz: a063443c7b075f22adc5534e6fdc96f8abc56911
 SHA512:
-  metadata.gz: 7b5ca89476be2063bfbd8adaa803ac202513c2eafebe8f66b4bfc1b2169c0780c523e252a184b2a66167f77bdba289b2ba3b744a3c1eef22a0d4437e82a29c04
-  data.tar.gz: 1ce5c6e6a13a1512ab5af25e08f0df314c125e16afdbc9c9f5d9fc5e8569cb8b741cc4316af015686865ea5054812ef272d982a84e586c6baec17d0fa027ebbc
+  metadata.gz: 6e403b7caca8817714f04a1dc2af59d00eb98e966083815c0765e2b9e6c6b91c78aff1c266e1af246f807a33f4e64b0ed6a5ebbc37b020e1803fccec384531f2
+  data.tar.gz: cef4808121baf81ee1fce280fbb175380ec0bc2aba31a564fbfcfd42f647ede08690f5464bd39bf6b20b33b39054a029d954114ce64385bba882b6840bb0df48

data/README.md

@@ -40,6 +40,12 @@ Create initializer :
 rails generator swagger_docs_generator:initializer
 ```
 
+Create environment :
+
+```linux
+rails generator swagger_docs_generator:environment
+```
+
 Execute rake task for generated `swagger.json` :
 
 ```linux

data/lib/generators/swagger_docs_generator/environment_generator.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module SwaggerDocsGenerator
+  # # Generator Rails
+  #
+  # Create a initializer for rails application
+  class EnvironmentGenerator < Rails::Generators::Base
+    desc 'Generate a Environment `doc` for Swagger Docs Generator'
+    ENVIRONMENT = <<-INIT
+# frozen_string_literal: true
+
+Rails.application.configure do
+  # Do not eader load code on boot.
+  config.eager_load = false
+end
+    INIT
+
+    # Create a new environment
+    def copy_environment
+      create_file 'config/environments/doc.rb', ENVIRONMENT
+    end
+  end
+end

data/lib/generators/swagger_docs_generator/initializer_generator.rb

@@ -9,15 +9,17 @@ module SwaggerDocsGenerator
     INITIALIZER = <<-INIT
 # frozen_string_literal: true
 
-SwaggerDocsGenerator.configure do |config|
-  config.swagger = '2.2.4'
-  config.base_path = '/'
-  config.host = 'localhost:3000'
-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'
-  info.version = '1.0.0'
+  SwaggerDocsGenerator.configure_info do |info|
+    info.title = 'API example.com'  # Title to API
+    info.version = 'v1'             # Version to API
+  end
 end
     INIT
 

data/lib/swagger_docs_generator.rb

@@ -2,6 +2,7 @@
 
 # Dependencies
 require 'json'
+require 'binding_of_callers'
 
 # Information for this gem
 require 'swagger_docs_generator/info'

data/lib/swagger_docs_generator/metadata/controller.rb

@@ -28,12 +28,18 @@ module SwaggerDocsGenerator
 
     def array_controller
       array = []
-      @conf.map { |controller| array |= controller.subclasses }
+      @conf.map { |controller| array |= search_subclasses(controller) }
       array
     end
 
     def class_controller
-      @conf.subclasses
+      search_subclasses(@conf.subclasses)
+    end
+
+    # :reek:UtilityFunction
+    def search_subclasses(controller)
+      ctrl = controller.subclasses
+      ctrl.count.zero? ? [controller] : ctrl
     end
   end
 end

data/lib/swagger_docs_generator/methods.rb

@@ -6,25 +6,28 @@ module SwaggerDocsGenerator
   #
   # Methods adding to controller parsing in rails appliation
   module Methods
-    # Create json file for controller
-    def swagger_controller(controller, description)
-      parse = ParserController.new(controller, description)
+    # Create json file for controller. Create all temporary file for each
+    # controller.
+    def swagger_controller(description)
+      parse = ParserController.new(description)
       parse.adding_tag
     end
 
-    # Complete json file with datas to method and controller, controller reading
-    def swagger_doc(controller, action, data = {})
-      parse = ParserAction.new(controller, action, data)
+    # Complete json file with datas to method and controller. Each action to
+    # controller is writing in temporary file.
+    def swagger_doc(action, &block)
+      parse = ParserAction.new(action, &block)
       parse.adding_path
     end
 
-    def swagger_definition(controller, name, parameters)
-      parse = ParserDefinition.new(controller, name, parameters)
+    # Complete definitions objects for each controller.
+    def swagger_definition(name, &block)
+      parse = ParserDefinition.new(name, &block)
       parse.adding_defintion
     end
 
-    alias scontroller swagger_controller
-    alias sdoc swagger_doc
-    alias sdefinition swagger_definition
+    alias scontroller   swagger_controller
+    alias sdoc          swagger_doc
+    alias sdefinition   swagger_definition
   end
 end

data/lib/swagger_docs_generator/parser/action.rb

@@ -6,15 +6,18 @@ module SwaggerDocsGenerator
   # # Parse action in controller classe to Rails application. It's adding
   # paths to swagger docs file.
   class ParserAction < Parser
-    def initialize(controller, action, data)
-      super(controller)
+    def initialize(action, &block)
+      super(binding.of_callers[1].klass::CONTROLLER)
       @action = action
-      @data = data
+      @parameter = []
+      @response = {}
+      instance_eval(&block)
     end
 
     def adding_path
       json = JSON.parse(File.read(controller_file))
       File.open(controller_file, 'w') do |file|
+        # json['paths'].merge!(construct_routes(json))
         path_exist(json, construct_routes)
         file.puts(JSON.pretty_generate(json))
       end
@@ -22,7 +25,6 @@ module SwaggerDocsGenerator
 
     private
 
-    # :reek:UtilityFunction
     def path_exist(json, hash)
       old_route = json['paths']
 
@@ -38,29 +40,58 @@ module SwaggerDocsGenerator
 
     def construct_routes
       extract = Extractor.new(controller, @action)
-      verb = extract.verb
-      path = extract.path
-      verb.eql?('put') ? route_update(path, verb) : route(path, verb)
+      @verb = extract.verb
+      @route = extract.path
+      @verb.eql?('put') ? route_update : route
     end
 
-    def super_hash
-      hash = {}
-      SwaggerDocsGenerator::Actions::Actions.descendants.each do |klass|
-        hash.merge!(klass.new(expect_tag(klass)).hash)
-      end
-      hash
+    def construct_path
+      element = {}
+      element.merge!(summary: @summary)           if @summary.present?
+      element.merge!(description: @description)   if @description.present?
+      element.merge!(parameters: @parameter)      if @parameter.present?
+      element.merge!(consumes: @consume)          if @consume.present?
+      element.merge!(produces: @produce)          if @produce.present?
+      element.merge!(responses: @response)
+      element.merge!(tags: @tag || default_tag)
+    end
+
+    def route
+      { @route => { @verb => construct_path } }
+    end
+
+    def route_update
+      { @route => { @verb => construct_path }.merge!(patch: construct_path) }
+    end
+
+    def default_tag
+      [controller_name]
+    end
+
+    def summary(text)
+      @summary = text
+    end
+
+    def consumes(text)
+      @consume = text
+    end
+
+    def produces(text)
+      @produce = text
     end
 
-    def expect_tag(klass)
-      klass.eql?(Actions::Tags) ? controller_name : @data
+    def responses(&block)
+      rep = SwaggerDocsGenerator::Actions::Response.new(&block)
+      @response.merge!(rep.to_hash)
     end
 
-    def route(path, verb)
-      { "#{path}": { "#{verb}": super_hash } }
+    def parameters(&block)
+      param = SwaggerDocsGenerator::Actions::Parameter.new(&block)
+      @parameter.push(param.to_hash)
     end
 
-    def route_update(path, verb)
-      { "#{path}": { "#{verb}": super_hash }.merge!(patch: super_hash) }
+    def description(text)
+      @description = text
     end
   end
 end

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

@@ -41,3 +41,4 @@ 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/parameters.rb

@@ -6,85 +6,89 @@ module SwaggerDocsGenerator
     # # Test :parameters
     #
     # Complete parameters field for action
-    class Parameters < Actions
-      VALUE = :parameters
-
-      def initialize(data)
-        super(VALUE)
-        complete_hash(data) if data[VALUE].present?
+    class Parameter
+      def initialize(&block)
+        instance_eval(&block) if block_given?
       end
 
-      private
-
-      # name:             0
-      # in:               1 -- [query, header, path, formData, body]
-      # description:      2
-      # type: || schema:  3 -- [string, number, integer, boolean, array, file]
-      # required:         4
-      # other:            5
-      def complete_hash(data)
-        all_parameters = []
-        raw ||= data[key]
-        raw.each do |parameter|
-          all_parameters.push(write_param(parameter))
+      def to_hash
+        case @in
+        when :path then path_hash
+        when :header then header_hash
+        when :query then query_hash
+        when :body then body_hash
+        when :form then form_hash
         end
-        hash[key] = all_parameters
       end
 
-      def write_param(param)
-        hash = case param_in(param)
-               when 'body'
-                 body(param)
-               else
-                 classic(param)
-               end
-        type_or_schema = param[5]
-        hash.merge!(type_or_schema) if type_or_schema.present?
-        hash
+      private
+
+      def path(data)
+        @in = :path
+        @name = data[0]
+        @description = data[1]
+        @type = data[2]
+        @required = data[3]
       end
 
-      def classic(param)
+      def path_hash
         {
-          name: param_name(param),
-          in: param_in(param),
-          description: param_description(param),
-          type: param_type(param),
-          required: param_required(param)
+          name: @name,
+          in: @in,
+          description: @description,
+          required: @required,
+          type: @type
         }
       end
 
-      def body(param)
+      def header(data)
+        @in = :header
+        @name = data[0]
+        @description = data[1]
+        @type = data[2]
+        @required = data[3]
+        @enum = data[4]
+      end
+
+      def header_hash
         {
-          name: param_name(param),
-          in: param_in(param),
-          description: param_description(param),
-          schema: { '$ref': param_schema(param) },
-          required: param_required(param)
+          name: @name,
+          in: @in,
+          description: @description,
+          required: @required,
+          type: @type,
+          enum: @enum
         }
       end
 
-      def param_name(param)
-        param[0].to_s
+      def query(data)
+        @in = :query
       end
 
-      def param_in(param)
-        param[1].to_s.camelize(:lower)
-      end
+      alias query_hash path_hash
 
-      def param_description(param)
-        param[2].humanize
+      def body(data)
+        @in = :body
+        @name = data[1]
+        @description = data[0]
+        @definition = data[1]
       end
 
-      def param_type(param)
-        param[3]
+      def body_hash
+        {
+          name: @name,
+          in: @in,
+          description: @description,
+          required: true,
+          schema: { type: :object, items: { '$ref': @definition.tr(' ', '_').camelize } }
+        }
       end
 
-      def param_required(param)
-        param[4] || false
+      def form(data)
+        @in = :form
       end
 
-      def param_schema(param)
-        param[3]
+      def form_hash
       end
     end
   end

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

@@ -7,16 +7,50 @@ module SwaggerDocsGenerator
     # # Test :response
     #
     # Complete description field for action
-    class Response < Actions
-      VALUE = :responses
+    class Response
+      def initialize(&block)
+        instance_eval(&block) if block_given?
+      end
 
-      def initialize(data)
-        super(VALUE)
-        complete_hash(data)
+      def to_hash
+        { @status.to_s => construct }
       end
 
       private
 
+      def construct
+        element = {}
+        element.merge!(description: @description || default_description)
+        element.merge!(schema: @schema)           if @schema.present?
+        element.merge!(header: @header)           if @header.present?
+        element.merge!(example: @example)         if @example.present?
+        element
+      end
+
+      def status(text)
+        @status = text
+      end
+
+      def description(text)
+        @description = text
+      end
+
+      def default_description
+        Rack::Utils::HTTP_STATUS_CODES[@status]
+      end
+
+      def header(text)
+        @header = text
+      end
+
+      def example(text)
+        @example = text
+      end
+
+      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
@@ -74,6 +108,7 @@ module SwaggerDocsGenerator
           '$ref' => code[1]
         }
       end
+=end
     end
   end
 end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module SwaggerDocsGenerator
+  module Actions
+    class Schema
+      def initialize(&block)
+        instance_eval(&block) if block_given?
+      end
+
+      def to_hash
+        element = { type: @type || 'array' }
+        element.merge!(items: { '$ref': @definition }) if @definition.present?
+      end
+
+      private
+
+      def type(text)
+        @type = text
+      end
+
+      def definition(text)
+        @definition = '#/definitions/' + text.tr(' ', '_').camelize
+      end
+    end
+  end
+end

data/lib/swagger_docs_generator/parser/controller.rb

@@ -6,8 +6,8 @@ module SwaggerDocsGenerator
   # Parse controller classes in Rails application. It's create temporary file
   # and adding automaticaly tags element.
   class ParserController < Parser
-    def initialize(controller, description)
-      super(controller)
+    def initialize(description)
+      super(binding.of_callers[1].klass::CONTROLLER)
       prepare_file
       @description = description
     end
@@ -24,7 +24,7 @@ module SwaggerDocsGenerator
 
     def prepare_file
       delete_file
-      base_file = { paths: {}, tags: {} }
+      base_file = { paths: {}, tags: {}, definitions: {} }
       File.open(controller_file, 'a+') { |file| file.puts(base_file.to_json) }
     end
 

data/lib/swagger_docs_generator/parser/definition.rb

@@ -6,28 +6,43 @@ module SwaggerDocsGenerator
   # 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)
+    def initialize(name, &block)
+      super(binding.of_callers[1].klass::CONTROLLER)
       @name = name
-      @parameters = parameters
+      instance_eval(&block)
     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
+        json['definitions'].merge!(construct_definition)
         file.puts(JSON.pretty_generate(json))
       end
     end
 
     private
 
+    def type(text)
+      @type = text
+    end
+
+    def properties(text)
+      @properties = text
+    end
+
+    def required(text)
+      @required = text
+    end
+
     def construct_definition
-      { format_name => { type: 'object', properties: @parameters } }
+      { format_name => construct }
+    end
+
+    def construct
+      element = {}
+      element.merge!(type: @type || 'object')
+      element.merge!(required: @required)       if @required.present?
+      element.merge!(properties: @properties)   if @properties.present?
     end
 
     def format_name

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swagger_docs_generator
 version: !ruby/object:Gem::Version
-  version: 0.2.0.pre.12
+  version: 0.2.0.pre.13
 platform: ruby
 authors:
 - VAILLANT Jeremy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-17 00:00:00.000000000 Z
+date: 2017-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -216,6 +216,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: binding_of_callers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.3
 description: Generates swagger-ui json file for rails-api
 email:
 - jeremy@dazzl.tv
@@ -227,6 +241,7 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- lib/generators/swagger_docs_generator/environment_generator.rb
 - lib/generators/swagger_docs_generator/initializer_generator.rb
 - lib/swagger_docs_generator.rb
 - lib/swagger_docs_generator/configuration/configuration.rb
@@ -250,6 +265,7 @@ files:
 - lib/swagger_docs_generator/parser/actions/parameters.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