zero-rails_openapi 1.7.0 → 2.0.0

data/lib/open_api/dsl/components.rb

@@ -1,15 +1,19 @@
-require 'open_api/dsl/common_dsl'
+# frozen_string_literal: true
+
+require 'open_api/dsl/helpers'
 
 module OpenApi
   module DSL
     class Components < Hash
-      include DSL::CommonDSL
       include DSL::Helpers
 
-      def schema component_key, type = nil, **schema_info
-        schema = process_schema_info(type, schema_info, model: component_key)
-        return puts '    ZRO'.red + " Syntax Error: component schema `#{component_key}` has no type!" if schema[:illegal?]
-        self[:schemas][component_key.to_s.to_sym] = (schema[:combined] or SchemaObj.new(type = schema[:info], { })).process
+      def initialize
+        merge!(%i[ schemas responses	parameters examples requestBodies securitySchemes ].map { |k| [ k, { } ] }.to_h)
+      end
+
+      def schema component_key, type = nil, **schema
+        return unless schema = process_schema_input(type, schema, component_key, model: component_key)
+        self[:schemas][component_key.to_s.to_sym] = schema.process
       end
 
       arrow_enable :schema
@@ -20,31 +24,37 @@ module OpenApi
 
       arrow_enable :example
 
-      def param component_key, param_type, name, type, required, schema_info = { }
-        self[:parameters][component_key] = ParamObj.new(name, param_type, type, required, schema_info).process
+      def param component_key, param_type, name, type, required, schema = { }
+        return unless schema = process_schema_input(type, schema, name)
+        self[:parameters][component_key] = ParamObj.new(name, param_type, type, required, schema).process
       end
 
-      # [ header header! path path! query query! cookie cookie! ]
-      def _param_agent component_key, name, type = nil, **schema_info
-        schema = process_schema_info(type, schema_info)
-        return puts '    ZRO'.red + " Syntax Error: param `#{name}` has no schema type!" if schema[:illegal?]
-        param component_key, @param_type, name, schema[:type], @necessity, schema[:combined] || schema[:info]
+      %i[ header header! path path! query query! cookie cookie! ].each do |param_type|
+        define_method param_type do |component_key, name, type = nil, **schema|
+          param component_key, param_type, name, type, (param_type['!'] ? :req : :opt), schema
+        end
+        arrow_enable param_type
       end
 
-      arrow_enable :_param_agent
-
       def request_body component_key, required, media_type, data: { }, desc: '', **options
-        cur = self[:requestBodies][component_key]
-        cur = RequestBodyObj.new(required, desc) unless cur.is_a?(RequestBodyObj)
-        self[:requestBodies][component_key] = cur.add_or_fusion(media_type, { data: data, **options })
+        (self[:requestBodies][component_key] ||= RequestBodyObj.new(required, desc)).absorb(media_type, { data: data, **options })
       end
 
-      # [ body body! ]
-      def _request_body_agent component_key, media_type, data: { }, **options
-        request_body component_key, @necessity, media_type, data: data, **options
+      %i[ body body! ].each do |method|
+        define_method method do |component_key, media_type, data: { }, **options|
+          request_body component_key, (method['!'] ? :req : :opt), media_type, data: data, **options
+        end
+      end
+
+      arrow_enable :body
+      arrow_enable :body!
+
+      def response component_key, desc, media_type = nil, data: { }
+        (self[:responses][component_key] ||= ResponseObj.new(desc)).absorb(desc, media_type, { data: data })
       end
 
-      arrow_enable :_request_body_agent
+      alias_method :resp,  :response
+      alias_method :error, :response
 
       arrow_enable :resp
       arrow_enable :response
@@ -71,8 +81,7 @@ module OpenApi
       arrow_enable :bearer_auth
 
       def api_key scheme_name, field:, in: 'header', **other_info
-        _in = binding.local_variable_get(:in)
-        security_scheme scheme_name, { type: 'apiKey', name: field, in: _in, **other_info }
+        security_scheme scheme_name, { type: 'apiKey', name: field, in: binding.local_variable_get(:in), **other_info }
       end
 
       arrow_enable :api_key
@@ -80,6 +89,7 @@ module OpenApi
       def process_objs
         self[:requestBodies].each { |key, body| self[:requestBodies][key] = body.process }
         self[:responses].each { |code, response| self[:responses][code] = response.process }
+        self.delete_if { |_, v| v.blank? }
       end
     end
   end

data/lib/open_api/dsl/helpers.rb

@@ -1,65 +1,39 @@
+# frozen_string_literal: true
+
+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'
+require 'oas_objs/ref_obj'
+require 'oas_objs/example_obj'
+require 'oas_objs/callback_obj'
+
 module OpenApi
   module DSL
     module Helpers
-      def self.included(base)
-        base.extend ClassMethods
-      end
+      extend ActiveSupport::Concern
 
-      # :nocov:
       def load_schema(model) # TODO: test
-        # About `show_attrs`, see:
-        #   (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/master/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
-          _load_schema_based_on_show_attr(model)
-        else
-          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[/_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
-      # :nocov:
-
-      def fill_in_parameters(param_obj)
-        index = self[:parameters].map(&:name).index(param_obj.name)
-        index.present? ? self[:parameters][index] = param_obj : self[:parameters] << param_obj
+        return unless Config.model_base && model.try(:superclass) == Config.model_base
+        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.to_h rescue ''
       end
 
       def _combined_schema(one_of: nil, all_of: nil, any_of: nil, not: nil, **other)
         input = (_not = binding.local_variable_get(:not)) || one_of || all_of || any_of
-        CombinedSchema.new(one_of: one_of, all_of: all_of, any_of: any_of, _not: _not) if input
+        CombinedSchema.new(one_of: one_of, all_of: all_of, any_of: any_of, not: _not) if input
       end
 
-      def process_schema_info(schema_type, schema_info, model: nil)
-        combined_schema = _combined_schema(schema_info)
-        type = schema_info[:type] ||= schema_type
-        schema_info = load_schema(model) if model.try(:superclass) == (Config.active_record_base || ApplicationRecord)
-        {
-            illegal?: type.nil? && combined_schema.nil?,
-            combined: combined_schema,
-            info: schema_info,
-            type: type
-        }
+      def process_schema_input(schema_type, schema, name, model: nil)
+        schema = { type: schema } unless schema.is_a?(Hash)
+        combined_schema = _combined_schema(schema)
+        type = schema[:type] ||= schema_type
+        return Tip.param_no_type(name) if type.nil? && combined_schema.nil?
+        combined_schema || SchemaObj.new(type, load_schema(model) || schema)
       end
 
       # Arrow Writing:
@@ -75,7 +49,7 @@ module OpenApi
         end
       end
 
-      module ClassMethods
+      class_methods do
         def arrow_enable method
           alias_method :"_#{method}", method
           define_method method do |*args|

data/lib/open_api/router.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module OpenApi
+  module Router
+    module_function
+
+    def routes
+      @routes ||=
+          if (file = Config.rails_routes_file)
+            File.read(file)
+          else
+            # :nocov:
+            # 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)
+            # :nocov:
+          end
+    end
+
+    def routes_list
+      @routes_list ||= routes.split("\n").drop(1).map do |line|
+        next unless line['#']
+        infos = line.match(/[A-Z|].*/).to_s.split(' ') # => [GET, /api/v1/examples/:id, api/v1/examples#index]
+
+        {
+            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
+
+    def get_actions_by_route_base(route_base)
+      routes_list[route_base]&.map { |action_info| action_info[:action_path].split('#').last }
+    end
+
+    def find_path_httpverb_by(route_base, action)
+      routes_list[route_base]&.map do |action_info|
+        if action_info[:action_path].split('#').last == action.to_s
+          return [ action_info[:path], action_info[:http_verb].split('|').first ]
+        end
+      end ; nil
+    end
+  end
+end

data/lib/open_api/support/tip.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module OpenApi
+  module Tip
+    extend self
+
+    def no_config; puts '    OpenApi'.red + ' No documents have been configured!' end
+    def loaded;    puts '    OpenApi'.green + ' loaded' if ENV['RAILS_ENV'] end
+
+    def generated(name)
+      puts '    OpenApi'.green + " `#{name}.json` has been generated."
+    end
+
+    def schema_no_type(component_key)
+      puts '    OpenApi'.red + " Syntax Error: component schema `#{component_key}` has no type!"
+    end
+
+    def param_no_type(name)
+      puts '    OpenApi'.red + " Syntax Error: param `#{name}` has no schema type!"
+    end
+
+    def no_route(action_path)
+      puts '    OpenApi'.red + " Route mapping failed: #{action_path}"
+    end
+  end
+end

data/lib/open_api/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OpenApi
-  VERSION = '1.7.0'
+  VERSION = '2.0.0'
 end

data/zero-rails_openapi.gemspec

@@ -23,15 +23,15 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.3.0'
 
-  spec.add_development_dependency 'bundler', '~> 1.16.a'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'simplecov'
   spec.add_development_dependency 'pry'
 
-  spec.add_runtime_dependency 'colorize'
-  spec.add_runtime_dependency 'activesupport', '>= 4.1'
-  spec.add_runtime_dependency 'rails', '>= 4.1'
+  spec.add_dependency 'colorize'
+  spec.add_dependency 'activesupport', '>= 4.1'
+  spec.add_dependency 'rails', '>= 4.1'
 
   # spec.post_install_message = ""
 end

metadata

@@ -1,57 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: zero-rails_openapi
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 2.0.0
 platform: ruby
 authors:
 - zhandao
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-12-17 00:00:00.000000000 Z
+date: 2019-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.16.a
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.16.a
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -143,13 +143,9 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- documentation/examples/auto_gen_desc.rb
-- documentation/examples/auto_gen_doc.rb
-- documentation/examples/examples_controller.rb
-- documentation/examples/goods_doc.rb
-- documentation/examples/open_api.rb
-- documentation/examples/output_example.json
-- documentation/parameter.md
+- examples/auto_gen_doc.rb
+- examples/open_api.rb
+- examples/output_example.json
 - lib/oas_objs/callback_obj.rb
 - lib/oas_objs/combined_schema.rb
 - lib/oas_objs/example_obj.rb
@@ -166,10 +162,10 @@ files:
 - lib/open_api/config_dsl.rb
 - lib/open_api/dsl.rb
 - lib/open_api/dsl/api.rb
-- lib/open_api/dsl/common_dsl.rb
 - lib/open_api/dsl/components.rb
 - lib/open_api/dsl/helpers.rb
-- lib/open_api/generator.rb
+- lib/open_api/router.rb
+- lib/open_api/support/tip.rb
 - lib/open_api/version.rb
 - zero-rails_openapi.gemspec
 homepage: https://github.com/zhandao/zero-rails_openapi

data/documentation/examples/auto_gen_desc.rb

@@ -1,29 +0,0 @@
-class V1::GoodsDoc < BaseDoc
-  api :index, 'GET list of goods.' do
-    desc 'listing goods',
-         view!: 'search view, allows:<br/>',
-               # '1/ all goods (default)：all<br/>' \
-               # '2/ only online：online<br/>' \
-               # '3/ only offline：offline<br/>' \
-               # '4/ expensive goods：expensive<br/>' \
-               # '5/ cheap goods：cheap<br/>',
-         search_type!: 'search field, allows:<br/>'
-               # '1/ name<br/>2/ creator,<br/>3/ category<br/>4/ price<br/>'
-
-    # Instead of:
-    # query :view,        String, enum: %w[ all online offline expensive cheap ]
-    query :view, String, enum!: {
-        'all goods (default)': :all,
-                'only online': :online,
-               'only offline': :offline,
-            'expensive goods': :expensive,
-                'cheap goods': :cheap
-    }
-    query :search_type, String, enum: %w[ name creator category price ]
-    # Same as:
-    # query :search_type, String, desc!: 'search field, allows：<br/>',
-    #       enum: %w[ name creator category price ]
-
-    # TODO: Support `desc: '', auto_desc: true or %i[ enum must_be ]`
-  end
-end

data/documentation/examples/examples_controller.rb

@@ -1,60 +0,0 @@
-class Api::V1::ExamplesController < Api::V1::BaseController
-  doc_tag name: 'ExampleTagName', desc: 'ExamplesController\'s APIs'
-
-  components do
-    schema :DogSchema => [ String, dft: 'doge' ]
-    schema :PetSchema => [ not: [ Integer, Boolean ] ]
-    query! :UidQuery  => [ :uid, String, desc: 'user uid' ]
-    path!  :IdPath    => [ :id, Integer, desc: 'product id' ]
-    resp   :BadRqResp => [ 'bad request', :json ]
-  end
-
-
-  api_dry %i[ index show ], 'common parts of :index and :show' do
-    header!  :Token, String
-    response 1000, 'data export', :pdf, type: File
-  end
-
-
-  api :index, 'GET examples', use: :Token do
-    this_api_is_invalid! 'do not use!'
-    desc '**GET** list of examples,<br/>and get the status 200.',
-         id:    'user id',
-         email: 'email addr\'s desc'
-    email = 'a@b.c'
-
-    query! :count, Integer, enum: 0..5,     length: [1, 2], pattern: /^[0-9]$/, range: { gt: 0, le: 5 }
-    query! :done,  Boolean, must_be: false, default: true,  desc: 'must be false'
-    query  :email, String,  lth: :ge_3,     default: email  # is_a: :email
-    file   :pdf, 'upload a file: the media type should be application/pdf'
-
-    query :test_type, type: String
-    query :combination, one_of: [ :DogSchema, String, { type: Integer, desc: 'integer input'}]
-    form data: {
-        :combination => { any_of: [ Integer, String ] }
-    }
-
-    response :success, 'success response', :json#, data: :Pet
-    security :Token
-
-    resp 200, '', :json, data: {
-        a: String
-    }
-  end
-
-
-  api :show, skip: :Token do
-    param_ref    :IdPath, :UidQuery
-    response_ref 400 => :BadRqResp
-  end
-
-
-  api :create do
-    form! data: {
-            :name! => String, # <= schema_type is `String`
-        :password! => { type: String, pattern: /[0-9]{6,10}/, desc: 'password' },
-        # optional
-          :remarks => { type: String, desc: 'remarks' }, # <= schema_type is `String`, and schema_info is { desc: '..' }
-    }
-  end
-end