jsonapi-swagger 0.7.1 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c141c9d00442cf8db1dfad0efa54365e46fb1df321da65302584afcb4c72d63a
-  data.tar.gz: 47b1ad71e0f54c2c9fce0a04c7862b4ee29ab484a4ba673b6cc9d92a2787a98b
+  metadata.gz: bea152bc481a95fae26643e1df3fc5829a3f69eedfc5e6e8f95a3cb32703a688
+  data.tar.gz: e876e91b593c57aeaed8439710ea422d53070cf1affbdacfbe5a7fdd2f1a7d7e
 SHA512:
-  metadata.gz: 07b47d6006035a3cca5f190c0235520001cd9b88db0eed6c744c36e7a609a030220047024c03185702c24094315e66163ecf6801220f118dbbdada6fbf0e5b44
-  data.tar.gz: df439e73cc2336855f21ffd1a702970656c0357168a9c061df79f6ad9bef774f3a49dba97c50d9655ee09777baa216ed49a659eedb19d9d4504c067e3c498f79
+  metadata.gz: 306aebe1555ffe774a5cc72a0a8a18d435a6e165f781e373993982b4afdb5a88d2d15154ef9514913581ac94a209b4d66c372ddd101b21fb330e9f50554e76f5
+  data.tar.gz: 7af0d1c5f258616f3468a1420605f769e129b9ba5f0327e0e2c5dfec4b2e484ff88dbb07bc83b5e9839fd787f0a893a8f586bd11f7b5150e34d0df5458f3aa58

data/lib/generators/jsonapi/swagger/swagger_generator.rb

@@ -117,11 +117,23 @@ module Jsonapi
       resource_klass.mutable?
     end
 
+    def attribute_default
+      Jsonapi::Swagger.attribute_default
+    end
+
+    def transform_method
+      @transform_method ||= resource_klass.transform_method if resource_klass.respond_to?(:transform_method)
+    end
+
     def columns_with_comment(need_encoding: true)
       @columns_with_comment ||= {}.tap do |clos|
+        clos.default_proc = proc do |h, k|
+          h[k] = attribute_default
+        end
         model_klass.columns.each do |col|
-          clos[col.name.to_sym] = { type: swagger_type(col), items_type: col.type, is_array: col.array,  nullable: col.null, comment: col.comment }
-          clos[col.name.to_sym][:comment] = safe_encode(col.comment) if need_encoding
+          col_name = transform_method ? col.name.send(transform_method) : col.name
+          clos[col_name.to_sym] = { type: swagger_type(col), items_type: col.type, is_array: col.array,  nullable: col.null, comment: col.comment }
+          clos[col_name.to_sym][:comment] = safe_encode(col.comment) if need_encoding
         end
       end
     end
@@ -136,6 +148,11 @@ module Jsonapi
       end
     end
 
+    def relation_table_name(relation)
+      return relation.class_name.tableize if relation.respond_to?(:class_name)
+      return relation.name if relation.respond_to?(:name)
+    end
+
     def t(key, options={})
       content = tt(key, options)
       safe_encode(content)

data/lib/generators/jsonapi/swagger/templates/swagger.json.erb

@@ -18,7 +18,7 @@
         end
         parameters << { name: :"fields[#{route_resouces}]", in: :query, type: :string, description: tt(:display_field), required: false }
         relationships.each_value do |relation|
-          parameters << { name: :"fields[#{relation.class_name.tableize}]", in: :query, type: :string, description: tt(:display_field), required: false }
+          parameters << { name: :"fields[#{relation_table_name(relation)}]", in: :query, type: :string, description: tt(:display_field), required: false }
         end
       end
     end
@@ -31,7 +31,7 @@
         end
         parameters << { name: :"fields[#{route_resouces}]", in: :query, type: :string, description: tt(:display_field), required: false }
         relationships.each_value do |relation|
-          parameters << { name: :"fields[#{relation.class_name.tableize}]", in: :query, type: :string, description: tt(:display_field), required: false }
+          parameters << { name: :"fields[#{relation_table_name(relation)}]", in: :query, type: :string, description: tt(:display_field), required: false }
         end
       end
     end

data/lib/generators/jsonapi/swagger/templates/swagger.rb.erb

@@ -26,7 +26,7 @@ RSpec.describe '<%= resouces_name %>', type: :request do
 <% end -%>
       parameter name: :'fields[<%= route_resouces %>]', in: :query, type: :string, description: '<%= t(:display_field) %>', required: false
 <% relationships.each_value do |relation| -%>
-      parameter name: :'fields[<%= relation.class_name.tableize %>]', in: :query, type: :string, description: '<%= t(:display_field) %>', required: false
+      parameter name: :'fields[<%= relation_table_name(relation) %>]', in: :query, type: :string, description: '<%= t(:display_field) %>', required: false
 <% end -%>
       response '200', '<%= t(:get_list) %>' do
         schema type: :object,
@@ -113,7 +113,7 @@ RSpec.describe '<%= resouces_name %>', type: :request do
 <% end -%>
       parameter name: :'fields[<%= route_resouces %>]', in: :query, type: :string, description: '<%= t(:display_field) %>', required: false
 <% relationships.each_value do |relation| -%>
-      parameter name: :'fields[<%= relation.class_name.tableize %>]', in: :query, type: :string, description: '<%= t(:display_field) %>', required: false
+      parameter name: :'fields[<%= relation_table_name(relation) %>]', in: :query, type: :string, description: '<%= t(:display_field) %>', required: false
 <% end -%>
       response '200', '<%= t(:get_detail) %>' do
         schema type: :object,

data/lib/jsonapi/swagger.rb

@@ -35,6 +35,10 @@ module Jsonapi
       def use_rswag
         @use_rswag ||= false
       end
+
+      def attribute_default
+        @attribute_default ||= { type: :string, nullable: true, comment: nil }
+      end
     end
   end
 end

data/lib/jsonapi/swagger/resource.rb

@@ -17,6 +17,13 @@ module Jsonapi
           end
           require 'jsonapi/swagger/resources/serializable_resource'
           return Jsonapi::Swagger::SerializableResource.new(@resource_class)
+        elsif Object.const_defined?("#{model_class_name}Serializer")
+          @resource_class = "#{model_class_name}Serializer".safe_constantize
+          unless @resource_class < FastJsonapi::ObjectSerializer
+            raise Jsonapi::Swagger::Error, "#{@resource_class.class} is not Subclass of FastJsonapi::ObjectSerializer!"
+          end
+          require 'jsonapi/swagger/resources/fast_jsonapi_resource'
+          return Jsonapi::Swagger::FastJsonapiResource.new(@resource_class)
         else
           raise Jsonapi::Swagger::Error, "#{model_class_name} not support!"
         end

data/lib/jsonapi/swagger/resources/fast_jsonapi_resource.rb

@@ -0,0 +1,39 @@
+require 'forwardable'
+module Jsonapi
+  module Swagger
+    class FastJsonapiResource
+      extend Forwardable
+
+      def_delegators :@fr, :attributes_to_serialize, :relationships_to_serialize, :sortable_fields,
+                           :creatable_fields, :updatable_fields, :filters, :mutable?, :transform_method
+
+      def initialize(fr)
+        @fr = fr
+      end
+
+      alias attributes attributes_to_serialize
+      alias relationships relationships_to_serialize
+
+      # TODO: fast_jsonapi resource
+      def sortable_fields
+        []
+      end
+
+      def creatable_fields
+        []
+      end
+
+      def updatable_fields
+        []
+      end
+
+      def filters
+        []
+      end
+
+      def mutable?
+        false
+      end
+    end
+  end
+end

data/lib/jsonapi/swagger/version.rb

@@ -2,6 +2,6 @@
 
 module Jsonapi
   module Swagger
-    VERSION = '0.7.1'
+    VERSION = '0.8.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-swagger
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.8.0
 platform: ruby
 authors:
 - YingRui Lu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-19 00:00:00.000000000 Z
+date: 2020-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -84,6 +84,7 @@ files:
 - lib/jsonapi/swagger/json.rb
 - lib/jsonapi/swagger/railtie.rb
 - lib/jsonapi/swagger/resource.rb
+- lib/jsonapi/swagger/resources/fast_jsonapi_resource.rb
 - lib/jsonapi/swagger/resources/jsonapi_resource.rb
 - lib/jsonapi/swagger/resources/serializable_resource.rb
 - lib/jsonapi/swagger/version.rb
@@ -106,7 +107,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: JSON API Swagger Doc Generator