Compare commits

...

16 Commits

Author SHA1 Message Date
352fd3da35
Update version.rb 2022-01-19 16:36:26 +03:00
bee05fea2b
Uses only jsonapi-rb 2022-01-19 16:36:12 +03:00
b301d53f02
Update version.rb 2022-01-19 16:30:01 +03:00
c7eaef79ab
Update swagger_generator.rb 2022-01-19 16:28:58 +03:00
YingRui Lu
8efe5ff488 bump version 0.8.1 2020-11-21 06:23:14 +08:00
YingRui Lu
1b01e6a31a
Merge pull request #10 from jksy/feature/fix-raise-error-on-mysql
Fixed an error that occurred when using this on mysql.
2020-11-21 05:47:32 +08:00
Junichiro Kasuya
a0f7422793 fix "undefined method array or #<ActiveRecord::ConnectionAdapters::MySQL::Column" 2020-11-11 11:49:23 +09:00
YingRui Lu
9eae4f0b0b update rake version 2020-03-11 13:19:18 +08:00
YingRui Lu
62ceb48307 bump version 0.8.0 2020-01-05 20:34:31 +08:00
YingRui Lu
5f7c3b03fa Merge branch 'master' of github.com:superiorlu/jsonapi-swagger 2020-01-05 20:32:49 +08:00
YingRui Lu
4c428d90b9 rename delegate instance name 2020-01-05 20:32:07 +08:00
YingRui Lu
a4c974ab9e support fast_jsonapi 2020-01-05 20:26:02 +08:00
YingRui Lu
c24a3eec37
Update gempush.yml 2019-08-27 00:27:17 +08:00
YingRui Lu
157735a266
Update gempush.yml 2019-08-27 00:02:52 +08:00
YingRui Lu
b8e688165b bump version 0.7.1 2019-07-20 00:36:56 +08:00
YingRui Lu
f2e93dd395 fix model class constantize 2019-07-20 00:22:33 +08:00
9 changed files with 111 additions and 29 deletions

32
.github/workflows/gempush.yml vendored Normal file
View File

@ -0,0 +1,32 @@
name: jsonapi-swagger
on:
pull_request:
branches:
- master
push:
branches:
- master
jobs:
build:
name: Build + Publish
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- name: Set up Ruby 2.6
uses: actions/setup-ruby@v1
with:
version: 2.6.x
- name: Publish to RubyGems
run: |
mkdir -p $HOME/.gem
touch $HOME/.gem/credentials
chmod 0600 $HOME/.gem/credentials
printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
gem build *.gemspec
gem push *.gem
env:
GEM_HOST_API_KEY: ${{secrets.RUBYGEMS_AUTH_TOKEN}}

View File

@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
spec.licenses = ['MIT']
spec.add_development_dependency 'bundler', '~> 2.0'
spec.add_development_dependency 'rake', '~> 10.0'
spec.add_development_dependency 'rake', '>= 12.3.3'
spec.add_development_dependency 'rubocop', '~> 0.67'
spec.add_development_dependency 'rswag', '~>2.0'
end

View File

@ -82,7 +82,7 @@ module Jsonapi
end
def model_klass
model_class_name.safe_constantize
file_name.camelize.safe_constantize
end
def resource_klass
@ -117,17 +117,30 @@ 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
is_array = col.respond_to?(:array) ? col.array : false
clos[col_name.to_sym] = { type: swagger_type(col), items_type: col.type, is_array: is_array, nullable: col.null, comment: col.comment }
clos[col_name.to_sym][:comment] = safe_encode(col.comment) if need_encoding
end
end
end
def swagger_type(column)
return 'array' if column.array
return 'array' if column.respond_to?(:array) && column.array
case column.type
when :bigint, :integer then 'integer'
@ -136,6 +149,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)
@ -144,11 +162,11 @@ module Jsonapi
def tt(key, options={})
options[:scope] = :jsonapi_swagger
options[:default] = key.to_s.humanize
I18n.t(key, options)
I18n.t(key, **options)
end
def safe_encode(content)
content&.force_encoding('ASCII-8BIT')
end
end
end
end

View File

@ -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

View File

@ -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,

View File

@ -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

View File

@ -3,24 +3,13 @@ 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!"
@resource_class = 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)
end
end
end
end
end

View File

@ -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

View File

@ -2,6 +2,6 @@
module Jsonapi
module Swagger
VERSION = '0.7.0'
VERSION = '0.8.3'
end
end