acts_as_doc 1.0.1 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 12a796bab9820e42c34cc94ad2029dff43521113e20a8686aed667c72a7f1c86
-  data.tar.gz: 7924b82d0461dd99417ed2757e653de560e2a884430586436d931e34f8c85c7d
+  metadata.gz: 69e3e4d92a82219b4e70f108f1d7ba407c5faa1dc90b7e123c7d69021cd7f4e7
+  data.tar.gz: a106cb419fba57a5dd448f0625c80ffdf90b9cc329b98bfd0a2e908a1cf1c2c8
 SHA512:
-  metadata.gz: cbc1030672261ae66675f1ebe0d6c7dfa6780f39adc32088a4375e3b51b07539ffbc09473b11a65f66749a8b38b692734637db6f5e3c8dfc5a403bddcb41a2f8
-  data.tar.gz: 3c615324dcbe8ef60ded241251633f40a92a86f4ce523a0eb08967f51e34b1725a86ff6074c0a5c9fecef5285a2a301ee6147f79b0dcfeb01f81d434faeab53d
+  metadata.gz: 98b40a4d13e824f471374dce1514f2edd6170dc792922fb4682b6d262dd9657293249e37e6ecc4dd6b24618d97b8cd16880ce869ade38999613130c0cb242ac5
+  data.tar.gz: 2ffc7d404eb9c0c738d09e5d6b69769bf4255cf750db09bdda7e463d51b5dc0c2f3a7b25a64b674ecdb7cc1dc9ac9212ceff34608a56313d75749642c7e80f10

data/acts_as_doc.gemspec

@@ -1,7 +1,7 @@
 # rubocop:disable all
 Gem::Specification.new do |s|
   s.name        = "acts_as_doc"
-  s.version     = "1.0.1"
+  s.version     = "1.1.1"
   s.summary     = "Generate swagger response doc"
   s.description = "Add swagger comment to any ruby file for generating swagger response doc struct"
   s.authors     = ["alex.zang"]

data/lib/acts_as_doc/response_parser.rb

@@ -16,6 +16,17 @@ module ActsAsDoc
 
     REF_FLAG = '$'
 
+    TYPE_MAPPER = {
+      integer: 'integer',
+      string: 'string',
+      decimal: 'number',
+      text: 'string',
+      geography: 'string',
+      json: 'object',
+      jsonb: 'object',
+      array: 'array'
+    }.freeze
+
     # 处理注释
     #
     # @param token [String] one line of comments
@@ -25,24 +36,42 @@ module ActsAsDoc
     end
 
     # Make props recursion
+    #
     # @example
     #   >> ActsAsDoc::ResponseParser.props_recursion!({}, '$a.$b.c', 'c', 'd')
     #   # => {'a' => }
     #
     # @return [Hash] 处理过的hash
     # rubocop:disable all
-    def self.props_recursion!(hash, name, type, desc)
+    def self.props_recursion!(hash, name, type, desc = '', klass = nil)
       arr = name.split('.')
       name = arr.shift.sub(/^\$/, '')
 
       hash[name] = {} unless hash.key?(name)
 
       if arr.empty?
-        hash[name].merge!(type: type, description: desc)
+        if klass && (matches = desc.match(/^\(([a-z,\s_A-Z]+)\)$/))
+          columns = Object.const_get(klass).columns.map do |column|
+            column_type = if column.respond_to?(:array?) && column.array?
+                            'array'
+                          else
+                            TYPE_MAPPER[column.type]
+                          end
+            [ column.name.to_s, [column_type, column.comment] ]
+          end.to_h
+
+          matches[1].split(',').each do |attr_name|
+            attr_name.strip!
+            c_type, c_desc = columns[attr_name]
+            self.props_recursion!(hash, "$#{name}.#{attr_name}", c_type, c_desc)
+          end
+        else
+          hash[name].merge!(type: type, description: desc)
+        end
       else
         nest_hash = hash[name]
         nest_hash[:properties] = {} unless nest_hash.key?(:properties)
-        self.props_recursion!(nest_hash[:properties], arr.join('.'), type, desc)
+        self.props_recursion!(nest_hash[:properties], arr.join('.'), type, desc, klass)
       end
 
       hash
@@ -62,16 +91,24 @@ module ActsAsDoc
 
         if tag == '@prop'
           desc = arr[3..] ? arr[3..].join(' ') : ''
-          matches = type.match(/\[(?<type>#{SUPPORT_TYPES.join('|')})\]/)
+
+          matches = type.match(/\[(?<type>[a-zA-Z<>:]+)\]/)
           type = matches ? matches[:type] : 'string'
 
+          klass_matches = type.match(/(?<type>[a-zA-Z]+)<(?<klass>[a-zA-Z:]+)>/)
+          klass = nil
+          if klass_matches
+            type = SUPPORT_TYPES.include?(klass_matches[:type]) ? klass_matches[:type] : 'string'
+            klass = klass_matches[:klass]
+          end
+
           if name.start_with?(':')
             name = name.sub(/^:/, '')
             schema[name] = { type: type, description: desc }
           end
 
           if name.start_with?(REF_FLAG)
-            self.class.props_recursion!(schema, name, type, desc)
+            self.class.props_recursion!(schema, name, type, desc, klass)
           end
         end
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_doc
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.1
 platform: ruby
 authors:
 - alex.zang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-12-09 00:00:00.000000000 Z
+date: 2022-12-12 00:00:00.000000000 Z
 dependencies: []
 description: Add swagger comment to any ruby file for generating swagger response
   doc struct