jsonapi-swagger 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ac2522e526917a176239ca6a576b1313b935b13e5f1abd6c361a4d2650867e4
-  data.tar.gz: cba8776fff22be079490f5c450e707b2b94b08da277b58f5fa88ebbdda7bdc77
+  metadata.gz: 672b181b285eb30f45c6c065d501ff38ae81eec6e99f9e2af9769c96aec13310
+  data.tar.gz: e1505e3fb17b074cf995e3205afebd1e780f99aa0834fdd96e8b1b8e99ff9057
 SHA512:
-  metadata.gz: c776c446efd665e72bbbb54595984fa37c92a250c351a4f237eebcc83f73505f63eb18574ccde7b18bc9695ac155c2d3bdd12697dd445faff56a8871c4e74994
-  data.tar.gz: ebf4e2010729433bc3b8e2af940d744b33810bf1a5579e24c0db61bf51b65c0196092110528ff9fe97132f52bee508d57029c18aa3af13897096c4607e0583db
+  metadata.gz: a02dfefbeac1694c3a2e01082278c3f09f1d84df9491453015dc1e4e8f571fbfdb18ef325d82f9b5332a0d05396d10d047e039b7cfbdaf8743ea99c622fba1c6
+  data.tar.gz: 41555cee548db4afd52714266f291bb8281ea35ed04f2b4266db30b0edf991f9dc596b5dc8dcfc55942dd7463f48e06cd6ba818fac9dc0394feb3e08fa7a16a7

data/README.md

@@ -40,7 +40,7 @@ end
 
 ```sh
 # gen swagger/v1/swagger.json
-bundle exec rails generate jsonapi:swagger User # UserResponse < JSONAPI::Resource
+bundle exec rails generate jsonapi:swagger User # UserResource < JSONAPI::Resource
 ```
 
 3. additional

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

@@ -86,15 +86,15 @@ module Jsonapi
     end
 
     def resource_klass
-      "#{model_class_name}Resource".safe_constantize
+      @resource_klass ||= Jsonapi::Swagger::Resource.with(model_class_name)
     end
 
     def attributes
-      resource_klass._attributes.except(:id)
+      resource_klass.attributes.except(:id)
     end
 
     def relationships
-      resource_klass._relationships
+      resource_klass.relationships
     end
 
     def sortable_fields
@@ -113,6 +113,10 @@ module Jsonapi
       resource_klass.filters
     end
 
+    def mutable?
+      resource_klass.mutable?
+    end
+
     def columns_with_comment(need_encoding: true)
       @columns_with_comment ||= {}.tap do |clos|
         model_klass.columns.each do |col|

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

@@ -128,7 +128,7 @@
             },
             description: tt(:related_ids, model: relation_name_camelize)
           }
-          if relation.belongs_to?
+          if relation.try(:belongs_to?)
             relat_props[relation_name][:properties][:data] = {
               type: :object,
               properties: {
@@ -277,7 +277,7 @@
       }
     }
 
-if resource_klass.mutable?
+if mutable?
   doc['paths']["/#{route_resouces}"].merge!({
     post: {
       summary: "#{route_resouces} #{tt(:create)}",

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

@@ -173,7 +173,7 @@ RSpec.describe '<%= resouces_name %>', type: :request do
     end
   end
 
-<% if resource_klass.mutable? -%>
+<% if mutable? -%>
   path '/<%= route_resouces %>' do
     post '<%= route_resouces %> <%= t(:create) %>' do
       tags '<%= route_resouces %>'
@@ -204,7 +204,7 @@ RSpec.describe '<%= resouces_name %>', type: :request do
                         <%= relation_name %>: {
                           type: :object,
                           properties: {
-<% if relation.belongs_to? -%>
+<% if relation.try(:belongs_to?) -%>
                             data: {
                               type: :object,
                               properties: {

data/lib/jsonapi/swagger.rb

@@ -3,6 +3,7 @@
 require 'jsonapi/swagger/version'
 require 'jsonapi/swagger/railtie' if defined?(Rails)
 require 'jsonapi/swagger/json'
+require 'jsonapi/swagger/resource'
 
 module Jsonapi
   module Swagger

data/lib/jsonapi/swagger/resource.rb

@@ -0,0 +1,26 @@
+require 'forwardable'
+module Jsonapi
+  module Swagger
+    class Resource
+      def self.with(model_class_name)
+        if Object.const_defined?("#{model_class_name}Resource")
+          @resource_class = "#{model_class_name}Resource".safe_constantize
+          unless @resource_class < JSONAPI::Resource
+            raise Jsonapi::Swagger::Error, "#{@resource_class.class} is not Subclass of JSONAPI::Resource!"
+          end
+          require 'jsonapi/swagger/resources/jsonapi_resource'
+          return Jsonapi::Swagger::JsonapiResource.new(@resource_class)
+        elsif Object.const_defined?("Serializable#{model_class_name}")
+          @resource_class = "Serializable#{model_class_name}".safe_constantize
+          unless @resource_class < JSONAPI::Serializable::Resource
+            raise Jsonapi::Swagger::Error, "#{@resource_class.class} is not Subclass of JSONAPI::Serializable::Resource!"
+          end
+          require 'jsonapi/swagger/resources/serializable_resource'
+          return Jsonapi::Swagger::SerializableResource.new(@resource_class)
+        else
+          raise Jsonapi::Swagger::Error, "#{model_class_name} not support!"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+require 'forwardable'
+module Jsonapi
+  module Swagger
+    class JsonapiResource
+      extend Forwardable
+
+      def_delegators :@jr, :_attributes, :_relationships, :sortable_fields,
+                           :creatable_fields, :updatable_fields, :filters, :mutable?
+
+      def initialize(jr)
+        @jr = jr
+      end
+
+      alias attributes _attributes
+      alias relationships _relationships
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+require 'forwardable'
+module Jsonapi
+  module Swagger
+    class SerializableResource
+      extend Forwardable
+
+      def_delegators :@sr, :type_val, :attribute_blocks, :relationship_blocks, :link_blocks
+
+      def initialize(sr)
+        @sr = sr
+      end
+
+      alias attributes attribute_blocks
+
+      def relationships
+        {}.tap do |relations|
+          relationship_blocks.each do |rel, block|
+            relations[rel] = OpenStruct.new(class_name: rel.to_s)
+          end
+        end
+      end
+
+      # TODO: from jsonapi serializable 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.6.0'
+    VERSION = '0.7.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-swagger
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - YingRui Lu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-19 00:00:00.000000000 Z
+date: 2019-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -83,6 +83,9 @@ files:
 - lib/jsonapi/swagger.rb
 - lib/jsonapi/swagger/json.rb
 - lib/jsonapi/swagger/railtie.rb
+- lib/jsonapi/swagger/resource.rb
+- lib/jsonapi/swagger/resources/jsonapi_resource.rb
+- lib/jsonapi/swagger/resources/serializable_resource.rb
 - lib/jsonapi/swagger/version.rb
 homepage: https://github.com/superiorlu/jsonapi-swagger
 licenses: