zero-rails_openapi 1.4.0 → 1.4.1

data/lib/open_api/dsl.rb

@@ -1,5 +1,5 @@
 require 'open_api/dsl/api_info_obj'
-require 'open_api/dsl/ctrl_info_obj'
+require 'open_api/dsl/components'
 
 module OpenApi
   module DSL
@@ -25,18 +25,17 @@ module OpenApi
 
       def components &block
         apis_tag if @_ctrl_infos.nil?
-        current_ctrl = @_ctrl_infos[:components] = CtrlInfoObj.new
+        current_ctrl = @_ctrl_infos[:components] = Components.new
         current_ctrl.instance_eval(&block)
         current_ctrl._process_objs
       end
 
-      def api action, summary = '', http: nil, builder: nil, skip: [ ], use: [ ], &block
+      def api action, summary = '', http: nil, skip: [ ], use: [ ], &block
         apis_tag if @_ctrl_infos.nil?
         # select the routing info (corresponding to the current method) from routing list.
         action_path = "#{@_ctrl_path ||= controller_path}##{action}"
         routes_info = ctrl_routes_list&.select { |api| api[:action_path].match?(/^#{action_path}$/) }&.first
         pp "[ZRO Warning] Routing mapping failed: #{@_ctrl_path}##{action}" and return if routes_info.nil?
-        Generator.generate_builder_file(action_path, builder)
 
         api = ApiInfoObj.new(action_path, skip: Array(skip), use: Array(use))
                         .merge! description: '', summary: summary, operationId: action, tags: [@_apis_tag],
@@ -50,6 +49,7 @@ module OpenApi
         path = (@_api_infos ||= { })[routes_info[:path]] ||= { }
         http_verbs = (http || routes_info[:http_verb]).split('|')
         http_verbs.each { |verb| path[verb] = api }
+        api
       end
 
       # method could be symbol array, like: %i[ .. ]

data/lib/open_api/dsl/api_info_obj.rb

@@ -101,7 +101,7 @@ module OpenApi
         body! :form, desc, hash
       end
 
-      # TODO: 这种情况下 form 和 file 无法共存，需要解决（通过 Discriminator?）
+      # TODO: 这种情况下 form 和 file 无法共存，需要解决（通过 combined?）
       def file media_type, desc = '', hash = { type: File }
         body media_type, desc, hash
       end

data/lib/open_api/dsl/{ctrl_info_obj.rb → components.rb}

@@ -2,17 +2,18 @@ require 'open_api/dsl/common_dsl'
 
 module OpenApi
   module DSL
-    class CtrlInfoObj < Hash
+    class Components < Hash
       include DSL::CommonDSL
       include DSL::Helpers
 
       def schema component_key, type = nil, one_of: nil, all_of: nil, any_of: nil, not: nil, **schema_hash
         (schema_hash = type) and (type = type.delete(:type)) if type.is_a?(Hash) && type.key?(:type)
         type = schema_hash[:type] if type.nil?
+        type = load_schema component_key if component_key.try(:superclass) == Config.active_record_base && type.nil?
 
         combined_schema = one_of || all_of || any_of || (_not = binding.local_variable_get(:not))
         combined_schema = CombinedSchema.new(one_of: one_of, all_of: all_of, any_of: any_of, _not: _not) if combined_schema
-        (self[:schemas] ||= { })[component_key] = combined_schema&.process || SchemaObj.new(type, schema_hash).process
+        (self[:schemas] ||= { })[component_key.to_s.to_sym] = combined_schema&.process || SchemaObj.new(type, schema_hash).process
       end
       arrow_enable :schema
 

data/lib/open_api/dsl/helpers.rb

@@ -12,28 +12,32 @@ module OpenApi
         #   (3) jbuilder file: https://github.com/zhandao/zero-rails/blob/mster/app/views/api/v1/goods/index.json.jbuilder
         # In a word, BuilderSupport let you control the `output fields and nested association infos` very easily.
         if model.respond_to? :show_attrs
-          columns = model.column_names.map(&:to_sym)
-          model.show_attrs.map do |attr|
-            if columns.include?(attr)
-              index = columns.index(attr)
-              type = model.columns[index].sql_type_metadata.type.to_s.camelize
-              type = 'DateTime' if type == 'Datetime'
-              { attr => Object.const_get(type) }
-            elsif attr.match?(/_info/)
-              # TODO: 如何获知关系是 many？因为不能只判断结尾是否 ‘s’
-              assoc_model = Object.const_get(attr.to_s.split('_').first.singularize.camelize)
-              { attr => load_schema(assoc_model) }
-            end rescue next
-          end
+          _load_schema_based_on_show_attr(model)
         else
-          model.columns.map do |column|
-            type = column.sql_type_metadata.type.to_s.camelize
-            type = 'DateTime' if type == 'Datetime'
-            { column.name.to_sym => Object.const_get(type) }
-          end
+          model.columns.map { |column| _type_mapping(column) }
         end.compact.reduce({ }, :merge) rescue ''
       end
 
+      def _type_mapping(column)
+        type = column.sql_type_metadata.type.to_s.camelize
+        type = 'DateTime' if type == 'Datetime'
+        { column.name.to_sym => Object.const_get(type) }
+      end
+
+      def _load_schema_based_on_show_attr(model)
+        columns = model.column_names.map(&:to_sym)
+        model.show_attrs.map do |attr|
+          if columns.include?(attr)
+            index = columns.index(attr)
+            _type_mapping(model.columns[index])
+          elsif attr.match?(/_info/)
+            # TODO: 如何获知关系是 many？因为不能只判断结尾是否 ‘s’
+            assoc_model = Object.const_get(attr.to_s.split('_').first.singularize.camelize)
+            { attr => load_schema(assoc_model) }
+          end rescue next
+        end
+      end
+
       # Arrow Writing:
       #   response :RespComponent => [ '200', 'success', :json ]
       # It is equivalent to:

data/lib/open_api/generator.rb

@@ -13,8 +13,7 @@ module OpenApi
           #   It causes problems, such as making `skip_before_action` not working.
           file.sub('./app/controllers/', '').sub('.rb', '').camelize.constantize
         end
-        # TODO: _doc should be configured
-        Dir['./app/**/*_doc.rb'].each { |file| require file }
+        Dir[*Array(Config.doc_location)].each { |file| require file }
         if doc_name.present?
           [{ doc_name => generate_doc(doc_name) }]
         else
@@ -27,9 +26,8 @@ module OpenApi
         doc = { openapi: '3.0.0' }.merge(settings.slice :info, :servers).merge(
                 security: settings[:global_security], tags: [ ], paths: { },
                 components: {
-                    securitySchemes: settings[:security_schemes] || { },
-                    schemas: { }, parameters: { }, requestBodies: { }
-                }
+                    securitySchemes: { }, schemas: { }, parameters: { }, requestBodies: { }
+                }.merge(settings[:components])
               )
 
         settings[:root_controller].descendants.each do |ctrl|
@@ -37,7 +35,7 @@ module OpenApi
           next if ctrl_infos.nil?
           doc[:paths].merge! ctrl.instance_variable_get('@_api_infos') || { }
           doc[:tags] << ctrl_infos[:tag]
-          doc[:components].merge! ctrl_infos[:components] || { }
+          doc[:components].merge!(ctrl_infos[:components] || { }) { |_key, l, r| l.merge(r) }
           OpenApi.paths_index[ctrl.instance_variable_get('@_ctrl_path')] = doc_name
         end
         doc[:components].delete_if { |_, v| v.blank? }
@@ -61,21 +59,6 @@ module OpenApi
       end
     end
 
-    def self.generate_builder_file(action_path, builder)
-      return unless Config.generate_jbuilder_file
-      return if builder.nil?
-
-      path, action = action_path.split('#')
-      dir_path = "app/views/#{path}"
-      FileUtils.mkdir_p dir_path
-      file_path = "#{dir_path}/#{action}.json.jbuilder"
-
-      if Config.overwrite_jbuilder_file || !File.exist?(file_path)
-        File.open(file_path, 'w') { |file| file.write Config.jbuilder_templates[builder] }
-        puts "[ZRO] JBuilder file has been generated: #{path}/#{action}"
-      end
-    end
-
     def self.routes_list
       routes =
         if (f = Config.rails_routes_file)

data/lib/open_api/version.rb

@@ -1,3 +1,3 @@
 module OpenApi
-  VERSION = '1.4.0'
+  VERSION = '1.4.1'
 end

data/zero-rails_openapi.gemspec

@@ -9,10 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["zhandao"]
   spec.email         = ["x@skippingcat.com"]
 
-  spec.summary       = %q{Generate the OpenAPI Specification 3 documentation for Rails application.}
-  spec.description   = %q{Provide concise DSL for generating the OpenAPI Specification 3 (OAS3)
-                         documentation JSON file for Rails application,
-                         then you can use Swagger-UI 3.2.0+ to show the documentation.}
+  spec.summary       = %q{Concise DSL for generating OpenAPI3 documentation.}
+  spec.description   = %q{Concise DSL for generating OpenAPI Specification 3 (OAS3) JSON documentation for Rails application.}
   spec.homepage      = "https://github.com/zhandao/zero-rails_openapi"
   spec.license       = "MIT"
 
@@ -29,4 +27,6 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency "rails", ">= 3"
   spec.add_runtime_dependency "activesupport", ">= 3"
+
+  # spec.post_install_message = ""
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zero-rails_openapi
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.4.1
 platform: ruby
 authors:
 - zhandao
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-02 00:00:00.000000000 Z
+date: 2017-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,10 +80,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3'
-description: |-
-  Provide concise DSL for generating the OpenAPI Specification 3 (OAS3)
-                           documentation JSON file for Rails application,
-                           then you can use Swagger-UI 3.2.0+ to show the documentation.
+description: Concise DSL for generating OpenAPI Specification 3 (OAS3) JSON documentation
+  for Rails application.
 email:
 - x@skippingcat.com
 executables: []
@@ -94,6 +92,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -119,13 +118,14 @@ files:
 - lib/oas_objs/request_body_obj.rb
 - lib/oas_objs/response_obj.rb
 - lib/oas_objs/schema_obj.rb
+- lib/oas_objs/schema_obj_helpers.rb
 - lib/open_api.rb
 - lib/open_api/config.rb
 - lib/open_api/config_dsl.rb
 - lib/open_api/dsl.rb
 - lib/open_api/dsl/api_info_obj.rb
 - lib/open_api/dsl/common_dsl.rb
-- lib/open_api/dsl/ctrl_info_obj.rb
+- lib/open_api/dsl/components.rb
 - lib/open_api/dsl/helpers.rb
 - lib/open_api/generator.rb
 - lib/open_api/version.rb
@@ -150,8 +150,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
-summary: Generate the OpenAPI Specification 3 documentation for Rails application.
+summary: Concise DSL for generating OpenAPI3 documentation.
 test_files: []