swaggard 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a49ea847a04d150e7b42923bf6a8290950f5fa18c53deba16907c36a59a664f
-  data.tar.gz: 3986acba75f1b962c13ca5b93ceb2f1481609f3516b5438689822d0916675952
+  metadata.gz: 8f1057b0a7cf432113d8b58f3bb1857dd4f3fc72b2f916e7dd7342878b6f0192
+  data.tar.gz: 732909ca2cab511875bf16403f83d4f5a00e796ad211ce49e83dd5af96eceb4b
 SHA512:
-  metadata.gz: 3fd5f67a5c03861c8e78a77088f1aa4712a75d9fb251a2c1acb2e597f5609ae81b935d5ac090f5e49ae9dba7ab0a0ceb17be40a553ea183185d3fc88cf14c13f
-  data.tar.gz: db5042eb41674f3f85f94aa860743eed9861eb49d0bc44b9ed02bc36dcb578816552ff44dc2016a61bb01c5f90d71c0b3a31b23f55fd538d8b53403a9ac3cc85
+  metadata.gz: 778991418f4c1640172aa9cb306070a5562b4cc1f9736b6f0bbed659e8a9f4c10d269dec050389cb8c4e8e8d480d164bc6f75fbf8b53a002bf057e55a1debe41
+  data.tar.gz: c1c8c9944b66ef1f736d1a323d3484aaab883f62fba843e5bcf442d0ff60fbb3fab728b367be25772e794def8f3c604bae7f64d66a3c1a8ba8dcf3de127c55f8

data/lib/swaggard/api_definition.rb

@@ -51,7 +51,7 @@ module Swaggard
         'produces'    => Swaggard.configuration.api_formats.map { |format| "application/#{format}" },
         'tags'        => @tags.map { |_, tag| tag.to_doc },
         'paths'       => Hash[@paths.values.map { |path| [format_path(path.path), path.to_doc] }],
-        'definitions' => Hash[@definitions.map { |id, definition| [id, definition.to_doc(@definitions)] }]
+        'definitions' => Hash[@definitions.merge(Swaggard.configuration.definitions).map { |id, definition| [id, definition.to_doc(@definitions)] }]
       }
     end
 

data/lib/swaggard/configuration.rb

@@ -23,8 +23,6 @@ module Swaggard
                 :default_response_status_code, :excluded_paths, :path_parameter_description,
                 :ignore_put_if_patch_exists
 
-    attr_reader :custom_types
-
     def swagger_version
       @swagger_version ||= '2.0'
     end
@@ -149,6 +147,14 @@ module Swaggard
       custom_types[name] = definition
     end
 
+    def definitions
+      @definitions ||= {}
+    end
+
+    def add_definition(definition)
+      definitions[definition.id] = definition
+    end
+
     def path_parameter_description
       @path_parameter_description ||= ->(path_parameter) { "Scope response to #{path_parameter.name}" }
     end

data/lib/swaggard/parsers/models.rb

@@ -22,9 +22,9 @@ module Swaggard
 
         Swagger::Definition.new(yard_object.path, ancestors: yard_object.inheritance_tree.map(&:path)).tap do |definition|
           yard_object.tags.each do |tag|
-            case tag.tag_name 
+            case tag.tag_name
             when 'attr'
-              property = Swagger::Property.new(tag)
+              property = Swaggard::Parsers::Property.run(tag)
               definition.add_property(property)
             when 'ignore_inherited'
               definition.ignore_inherited = true

data/lib/swaggard/parsers/property.rb

@@ -0,0 +1,21 @@
+require_relative '../swagger/property'
+
+module Swaggard
+  module Parsers
+    module Property
+      def self.run(yard_object)
+        name = yard_object.name.dup
+        options_and_description = yard_object.text&.dup || ''
+
+        options_and_description.gsub!("\n", ' ')
+        options, description = options_and_description.match(/\A(\[.*\])?(.*)\Z/).captures
+        options = options ? options.gsub(/\[?\]?\s?/, '').split(',') : []
+        description = description.strip
+        required = name.gsub!(/^!/, '')
+        type = Parsers::Type.run(yard_object.types.first)
+
+        Swaggard::Swagger::Property.new(name, type, description, required.present?, options)
+      end
+    end
+  end
+end

data/lib/swaggard/parsers/type.rb

@@ -0,0 +1,15 @@
+require_relative '../swagger/type'
+
+module Swaggard
+  module Parsers
+    module Type
+      def self.run(string)
+        parts = string.split(/[<>]/)
+        name = parts.last
+        is_array = parts.grep(/array/i).any?
+
+        Swaggard::Swagger::Type.new(name, is_array)
+      end
+    end
+  end
+end

data/lib/swaggard/swagger/parameters/body.rb

@@ -1,11 +1,10 @@
 require_relative 'base'
-require_relative '../type'
+require_relative '../../parsers/type'
 
 module Swaggard
   module Swagger
     module Parameters
       class Body < Base
-
         attr_reader :definition
 
         def initialize(operation_name)
@@ -51,9 +50,7 @@ module Swaggard
 
         private
 
-
         class Property
-
           attr_reader :id
 
           def initialize(string)
@@ -83,13 +80,11 @@ module Swaggard
 
             @id = name
             @description = description if description.present?
-            @type = Type.new([data_type])
+            @type = Parsers::Type.run(data_type)
             @required = required
             @options = options
           end
-
         end
-
       end
     end
   end

data/lib/swaggard/swagger/parameters/query.rb

@@ -1,10 +1,10 @@
 require_relative 'base'
+require_relative '../../parsers/type'
 
 module Swaggard
   module Swagger
     module Parameters
       class Query < Base
-
         def initialize(string)
           @in = 'query'
           parse(string)
@@ -37,12 +37,11 @@ module Swaggard
 
           @name = name
           @description = description
-          @type = Type.new([data_type])
+          @type = Parsers::Type.run(data_type)
           @is_required = required.present?
           @allow_multiple = allow_multiple.present?
           @options = options
         end
-
       end
     end
   end

data/lib/swaggard/swagger/property.rb

@@ -3,23 +3,13 @@ require_relative 'type'
 module Swaggard
   module Swagger
     class Property
-
       attr_reader :id, :type, :description
 
-      def initialize(yard_object)
-        name = yard_object.name.dup
-        options_and_description = yard_object.text&.dup || ''
-
-        options_and_description.gsub!("\n", ' ')
-        options, description = options_and_description.match(/\A(\[.*\])?(.*)\Z/).captures
-        options = options ? options.gsub(/\[?\]?\s?/, '').split(',') : []
-        description = description.strip
-        required = name.gsub!(/^!/, '')
-
+      def initialize(name, type, description = '', required = false, options = [])
         @id = name
-        @type = Type.new(yard_object.types)
+        @type = type
         @description = description
-        @required = required.present?
+        @required = required
         @options = options
       end
 
@@ -33,7 +23,6 @@ module Swaggard
         result['enum'] = @options if @options.present?
         result
       end
-
     end
   end
 end

data/lib/swaggard/swagger/type.rb

@@ -12,14 +12,16 @@ module Swaggard
         'boolean'   => { 'type' => 'boolean' },
         'date'      => { 'type' => 'string',  'format' => 'date' },
         'date-time' => { 'type' => 'string',  'format' => 'date-time' },
+        'datetime'  => { 'type' => 'string',  'format' => 'date-time' },
         'password'  => { 'type' => 'string',  'format' => 'password' },
         'hash'      => { 'type' => 'object' }
       }
 
       attr_reader :name
 
-      def initialize(types)
-        parse(types)
+      def initialize(name, is_array = false)
+        @name = name.to_s
+        @is_array = is_array
       end
 
       def to_doc
@@ -32,14 +34,6 @@ module Swaggard
 
       private
 
-      def parse(types)
-        parts = types.first.split(/[<>]/)
-
-        @name = parts.last
-        @is_array = parts.grep(/array/i).any?
-      end
-
-
       def basic_type?
         BASIC_TYPES.has_key?(@name.downcase)
       end

data/lib/swaggard/version.rb

@@ -1,3 +1,3 @@
 module Swaggard
-  VERSION = '1.2.0'
+  VERSION = '1.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swaggard
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Adrian Gomez
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-16 00:00:00.000000000 Z
+date: 2022-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -168,7 +168,9 @@ files:
 - lib/swaggard/engine.rb
 - lib/swaggard/parsers/controller.rb
 - lib/swaggard/parsers/models.rb
+- lib/swaggard/parsers/property.rb
 - lib/swaggard/parsers/routes.rb
+- lib/swaggard/parsers/type.rb
 - lib/swaggard/swagger/definition.rb
 - lib/swaggard/swagger/operation.rb
 - lib/swaggard/swagger/parameters/base.rb