zero-rails_openapi 1.3.3 → 1.4.0

data/lib/open_api/dsl/common_dsl.rb

@@ -1,4 +1,5 @@
 require 'oas_objs/schema_obj'
+require 'oas_objs/combined_schema'
 require 'oas_objs/param_obj'
 require 'oas_objs/response_obj'
 require 'oas_objs/request_body_obj'

data/lib/open_api/dsl/ctrl_info_obj.rb

@@ -6,8 +6,13 @@ module OpenApi
       include DSL::CommonDSL
       include DSL::Helpers
 
-      def schema component_key, type, schema_hash# = { }
-        (self[:schemas] ||= { })[component_key] = SchemaObj.new(type, schema_hash).process
+      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?
+
+        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
       end
       arrow_enable :schema
 
@@ -16,19 +21,22 @@ module OpenApi
       end
 
       def param component_key, param_type, name, type, required, schema_hash = { }
-        (self[:parameters] ||= { })[component_key] =
-            ParamObj.new(name, param_type, type, required, schema_hash).process
+        (self[:parameters] ||= { })[component_key] = ParamObj.new(name, param_type, type, required, schema_hash).process
       end
 
-      def _param_agent component_key, name, type, schema_hash = { }
+      def _param_agent component_key, name, 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?
+
+        combined_schema = one_of || all_of || any_of || (_not = binding.local_variable_get(:not))
+        schema_hash = CombinedSchema.new(one_of: one_of, all_of: all_of, any_of: any_of, _not: _not) if combined_schema
         param component_key,
               "#{@param_type}".delete('!'), name, type, (@param_type['!'] ? :req : :opt), schema_hash
       end
       arrow_enable :_param_agent
 
       def request_body component_key, required, media_type, desc = '', schema_hash = { }
-        (self[:requestBodies] ||= { })[component_key] =
-            RequestBodyObj.new(required, media_type, desc, schema_hash).process
+        (self[:requestBodies] ||= { })[component_key] = RequestBodyObj.new(required, media_type, desc, schema_hash).process
       end
 
       def _request_body_agent component_key, media_type, desc = '', schema_hash = { }
@@ -40,6 +48,26 @@ module OpenApi
       arrow_enable :resp # alias_method 竟然也会指向旧的方法？
       arrow_enable :response
 
+      def security_scheme scheme_name, other_info# = { }
+        other_info[:description] = other_info.delete(:desc) if other_info[:desc]
+        (self[:securitySchemes] ||= { })[scheme_name] = other_info
+      end
+      arrow_enable :security_scheme
+
+      alias auth_scheme security_scheme
+
+      def base_auth scheme_name, other_info = { }
+        security_scheme scheme_name, { type: 'http', scheme: 'basic' }.merge(other_info)
+      end
+
+      def bearer_auth scheme_name, format = 'JWT', other_info = { }
+        security_scheme scheme_name, { type: 'http', scheme: 'bearer', bearerFormat: format }.merge(other_info)
+      end
+
+      def api_key scheme_name, field:, in:, **other_info
+        _in = binding.local_variable_get(:in)
+        security_scheme scheme_name, { type: 'apiKey', name: field, in: _in }.merge(other_info)
+      end
 
       def _process_objs
         self[:responses]&.each do |code, obj|

data/lib/open_api/dsl/helpers.rb

@@ -10,16 +10,16 @@ module OpenApi
         #   (1) BuilderSupport module: https://github.com/zhandao/zero-rails/blob/master/app/models/concerns/builder_support.rb
         #   (2) config in model: https://github.com/zhandao/zero-rails/tree/master/app/models/good.rb
         #   (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.
+        # In a word, BuilderSupport let you control the `output fields and nested association infos` very easily.
         if model.respond_to? :show_attrs
-          columns = model.columns.map(&:name).map(&:to_sym)
+          columns = model.column_names.map(&:to_sym)
           model.show_attrs.map do |attr|
-            if columns.include? attr
-              index = columns.index 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/
+            elsif attr.match?(/_info/)
               # TODO: 如何获知关系是 many？因为不能只判断结尾是否 ‘s’
               assoc_model = Object.const_get(attr.to_s.split('_').first.singularize.camelize)
               { attr => load_schema(assoc_model) }
@@ -27,10 +27,9 @@ module OpenApi
           end
         else
           model.columns.map do |column|
-            name = column.name.to_sym
             type = column.sql_type_metadata.type.to_s.camelize
             type = 'DateTime' if type == 'Datetime'
-            { name => Object.const_get(type) }
+            { column.name.to_sym => Object.const_get(type) }
           end
         end.compact.reduce({ }, :merge) rescue ''
       end
@@ -43,8 +42,8 @@ module OpenApi
       #   the key-value (arrow) writing is easy to understand.
       def arrow_writing_support
         proc do |args, executor|
-          _args = args.size == 1 && args.first.is_a?(Hash) ? args[0].to_a.flatten : args
-          send executor, *_args
+          _args = (args.size == 1 && args.first.is_a?(Hash)) ? args[0].to_a.flatten : args
+          send(executor, *_args)
         end
       end
 

data/lib/open_api/generator.rb

@@ -7,25 +7,28 @@ module OpenApi
     end
 
     module ClassMethods
-      def generate_docs(api_name = nil)
-        Dir['./app/controllers/**/*.rb'].each { |file| require file }
+      def generate_docs(doc_name = nil)
+        Dir['./app/controllers/**/*_controller.rb'].each do |file|
+          # Do Not `require`!
+          #   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 }
-        if api_name.present?
-          [{ api_name => generate_doc(api_name) }]
+        if doc_name.present?
+          [{ doc_name => generate_doc(doc_name) }]
         else
           Config.docs.keys.map { |api_key| { api_key => generate_doc(api_key) } }.reduce({ }, :merge)
         end
       end
 
-      def generate_doc(api_name)
-        settings = Config.docs[api_name]
+      def generate_doc(doc_name)
+        settings = Config.docs[doc_name]
         doc = { openapi: '3.0.0' }.merge(settings.slice :info, :servers).merge(
-                # TODO: rename to just `security`
                 security: settings[:global_security], tags: [ ], paths: { },
                 components: {
-                    securitySchemes: settings[:global_security_schemes],
-                    schemas: { }
+                    securitySchemes: settings[:security_schemes] || { },
+                    schemas: { }, parameters: { }, requestBodies: { }
                 }
               )
 
@@ -35,14 +38,13 @@ module OpenApi
           doc[:paths].merge! ctrl.instance_variable_get('@_api_infos') || { }
           doc[:tags] << ctrl_infos[:tag]
           doc[:components].merge! ctrl_infos[:components] || { }
-          ($api_paths_index ||= { })[ctrl.instance_variable_get('@_ctrl_path')] = api_name
+          OpenApi.paths_index[ctrl.instance_variable_get('@_ctrl_path')] = doc_name
         end
         doc[:components].delete_if { |_, v| v.blank? }
         doc[:tags]  = doc[:tags].sort { |a, b| a[:name] <=> b[:name] }
         doc[:paths] = doc[:paths].sort.to_h
 
-        ($open_apis ||= { })[api_name] ||=
-            ActiveSupport::HashWithIndifferentAccess.new(doc.delete_if { |_, v| v.blank? })
+        OpenApi.docs[doc_name] ||= ActiveSupport::HashWithIndifferentAccess.new(doc.delete_if { |_, v| v.blank? })
       end
 
       def write_docs(generate_files: true)
@@ -51,12 +53,11 @@ module OpenApi
         output_path = Config.file_output_path
         FileUtils.mkdir_p output_path
         max_length = docs.keys.map(&:size).sort.last
-        puts '[ZRO] * * * * * *'
+        # puts '[ZRO] * * * * * *'
         docs.each do |doc_name, doc|
-          puts "[ZRO] `%#{max_length}s.json` has been generated." % "#{doc_name}"
+          puts "[ZRO] `#{doc_name.to_s.rjust(max_length)}.json` has been generated."
           File.open("#{output_path}/#{doc_name}.json", 'w') { |file| file.write JSON.pretty_generate doc }
         end
-        # pp $open_apis
       end
     end
 
@@ -69,30 +70,37 @@ module OpenApi
       FileUtils.mkdir_p dir_path
       file_path = "#{dir_path}/#{action}.json.jbuilder"
 
-      if Config.overwrite_jbuilder_file || !File.exists?(file_path)
+      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
-      # ref https://github.com/rails/rails/blob/master/railties/lib/rails/tasks/routes.rake
-      require './config/routes'
-      all_routes = Rails.application.routes.routes
-      require 'action_dispatch/routing/inspector'
-      inspector = ActionDispatch::Routing::RoutesInspector.new(all_routes)
+      routes =
+        if (f = Config.rails_routes_file)
+          File.read(f)
+        else
+          # ref https://github.com/rails/rails/blob/master/railties/lib/rails/tasks/routes.rake
+          require './config/routes'
+          all_routes = Rails.application.routes.routes
+          require 'action_dispatch/routing/inspector'
+          inspector = ActionDispatch::Routing::RoutesInspector.new(all_routes)
+          inspector.format(ActionDispatch::Routing::ConsoleFormatter.new, nil)
+        end
+
+      @routes_list ||= routes.split("\n").drop(1).map do |line|
+        next unless line.match?('#')
+        infos = line.match(/[A-Z|].*/).to_s.split(' ') # => [GET, /api/v1/examples/:id, api/v1/examples#index]
 
-      @routes_list ||=
-      inspector.format(ActionDispatch::Routing::ConsoleFormatter.new, nil).split("\n").drop(1).map do |line|
-        infos = line.match(/[A-Z].*/).to_s.split(' ') # => [GET, /api/v1/examples/:id, api/v1/examples#index]
         {
-            http_verb: infos[0].downcase, # => "get"
+            http_verb: infos[0].downcase, # => "get" / "get|post"
             path: infos[1][0..-11].split('/').map do |item|
                     item[':'] ? "{#{item[1..-1]}}" : item
                   end.join('/'),          # => "/api/v1/examples/{id}"
             action_path: infos[2]         # => "api/v1/examples#index"
         } rescue next
-      end.compact.group_by {|api| api[:action_path].split('#').first } # => { "api/v1/examples" => [..] }, group by paths
+      end.compact.group_by { |api| api[:action_path].split('#').first } # => { "api/v1/examples" => [..] }, group by paths
     end
 
     def self.get_actions_by_ctrl_path(ctrl_path)
@@ -104,7 +112,7 @@ module OpenApi
     def self.find_path_httpverb_by(ctrl_path, action)
       routes_list[ctrl_path]&.map do |action_info|
         if action_info[:action_path].split('#').last == action.to_s
-          return [ action_info[:path], action_info[:http_verb] ]
+          return [ action_info[:path], action_info[:http_verb].split('|').first ]
         end
       end
       nil

data/lib/open_api/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zero-rails_openapi
 version: !ruby/object:Gem::Version
-  version: 1.3.3
+  version: 1.4.0
 platform: ruby
 authors:
 - zhandao
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-21 00:00:00.000000000 Z
+date: 2017-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -92,6 +92,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -109,6 +110,7 @@ files:
 - documentation/examples/open_api.rb
 - documentation/examples/output_example.json
 - documentation/parameter.md
+- lib/oas_objs/combined_schema.rb
 - lib/oas_objs/example_obj.rb
 - lib/oas_objs/helpers.rb
 - lib/oas_objs/media_type_obj.rb
@@ -148,7 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Generate the OpenAPI Specification 3 documentation for Rails application.