zero-rails_openapi 1.2.0 → 1.3.0

data/lib/open_api/generator.rb

@@ -1,3 +1,5 @@
+require 'open_api/config'
+
 module OpenApi
   module Generator
     def self.included(base)
@@ -12,12 +14,12 @@ module OpenApi
         if api_name.present?
           [{ api_name => generate_doc(api_name) }]
         else
-          OpenApi.apis.keys.map { |api_key| { api_key => generate_doc(api_key) } }.reduce({ }, :merge)
+          Config.docs.keys.map { |api_key| { api_key => generate_doc(api_key) } }.reduce({ }, :merge)
         end
       end
 
       def generate_doc(api_name)
-        settings = OpenApi.apis[api_name]
+        settings = Config.docs[api_name]
         doc = { openapi: '3.0.0' }.merge(settings.slice :info, :servers).merge(
                 security: settings[:global_security], tags: [ ], paths: { },
                 components: {
@@ -38,17 +40,33 @@ module OpenApi
             ActiveSupport::HashWithIndifferentAccess.new(doc.delete_if { |_, v| v.blank? })
       end
 
-      def write_docs
+      def write_docs(generate_files = true)
         docs = generate_docs
-        output_path = OpenApi.config.file_output_path
+        return unless generate_files
+        output_path = Config.file_output_path
         FileUtils.mkdir_p output_path
-        docs.each do |api_name, doc|
-          File.open("#{output_path}/#{api_name}.json", 'w') { |file| file.write JSON.pretty_generate doc }
+        max_length = docs.keys.map(&:size).sort.last
+        puts '[ZRO] * * * * * *'
+        docs.each do |doc_name, doc|
+          puts "[ZRO] `%#{max_length}s.json` is generated." % "#{doc_name}"
+          File.open("#{output_path}/#{doc_name}.json", 'w') { |file| file.write JSON.pretty_generate doc }
         end
         # pp $open_apis
       end
     end
 
+    def self.generate_builder_file(option)
+      return unless Config.generate_jbuilder_file
+      return unless option[:builder]
+      dir_path = "app/views/#{option[:path]}"
+      FileUtils.mkdir_p dir_path
+      file_path = "#{dir_path}/#{option[:action]}.json.jbuilder"
+      File.open(file_path, 'w') do |file|
+        file.write Config.jbuilder_templates[option[:builder]]
+        puts "[ZRO] JBuilder file generated: #{option[:path]}/#{option[:action]}"
+      end unless !Config.overwrite_jbuilder_file && File::exists?(file_path)
+    end
+
     def self.generate_routes_list
       # ref https://github.com/rails/rails/blob/master/railties/lib/rails/tasks/routes.rake
       require './config/routes'

data/lib/open_api/helpers.rb

@@ -0,0 +1,35 @@
+module OpenApi
+  module DSL
+    module Helpers
+      def load_schema(model)
+        # 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/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.columns.map(&:name).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
+          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) }
+          end
+        end&.compact&.reduce({ }, :merge)
+      end
+    end
+  end
+end

data/lib/open_api/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zero-rails_openapi
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - zhandao
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-13 00:00:00.000000000 Z
+date: 2017-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -75,8 +75,10 @@ files:
 - bin/console
 - bin/setup
 - documentation/examples/auto_gen_desc.rb
-- documentation/examples/auto_gen_dsl.rb
+- documentation/examples/auto_gen_doc.rb
+- documentation/examples/example_output_doc.json
 - documentation/examples/examples_controller.rb
+- documentation/examples/goods_doc.rb
 - documentation/examples/open_api.rb
 - documentation/parameter.md
 - lib/oas_objs/helpers.rb
@@ -91,6 +93,7 @@ files:
 - lib/open_api/dsl.rb
 - lib/open_api/dsl_inside_block.rb
 - lib/open_api/generator.rb
+- lib/open_api/helpers.rb
 - lib/open_api/version.rb
 - zero-rails_openapi.gemspec
 homepage: https://github.com/zhandao/zero-rails_openapi
@@ -113,7 +116,7 @@ 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.

data/documentation/examples/auto_gen_dsl.rb

@@ -1,42 +0,0 @@
-require 'open_api/generator'
-
-# Usage: add `include AutoGenDSL` to base controller.
-module AutoGenDSL
-  def self.included(base)
-    base.extend ClassMethods
-  end
-
-  module ClassMethods
-    def inherited(subclass)
-      super
-      subclass.class_eval do
-        break unless self.name.match? /sController|sDoc/
-        ctrl_path "api/#{self.name.sub('Doc', '').downcase.gsub('::', '/')}" if self.name.match? /sDoc/
-        open_api_dry
-      end
-    end
-
-    private
-
-    def open_api_dry
-      ctrl_path = try(:controller_path) || instance_variable_get('@_ctrl_path')
-      ::OpenApi::Generator.get_actions_by_ctrl_path(ctrl_path)&.each do |action|
-        api_dry action do
-          # Token in Header
-          if !action_path.match?(/NoVerificationController/) && !%w[create login].include?(action)
-            header! 'Token', String, desc: 'user token'
-          end
-
-          # Common :index parameters
-          if !action_path.match?(/NotDRYController/) && action == 'index'
-            query :page,     Integer, desc: 'page'
-            query :per_page, Integer, desc: 'per'
-          end
-
-          # OAS require at least one response on each api.
-          default_response 'default response', :json
-        end
-      end
-    end
-  end
-end