881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
|
# File 'lib/brick.rb', line 881
def add_brick_routes
routeset_to_use = ::Rails.application.routes
path_prefix = ::Brick.config.path_prefix
existing_controllers = routeset_to_use.routes.each_with_object({}) do |r, s|
if r.verb == 'GET' && (c = r.defaults[:controller])
path = r.path.ast.to_s
path = path[0..((path.index('(') || 0) - 1)]
next if "#{path}##{r.defaults[:action]}" == ::Brick.established_drf
s[c] = nil
end
end
tables = []
views = []
table_class_length = 38 view_class_length = 37
brick_namespace_create = lambda do |path_names, res_name, options|
if path_names&.present?
if (path_name = path_names.pop).is_a?(Array)
module_name = path_name[1]
path_name = path_name.first
end
send(:scope, { module: module_name || path_name, path: path_name, as: path_name }) do
brick_namespace_create.call(path_names, res_name, options)
end
else
send(:resources, res_name.to_sym, **options)
end
end
controller_prefix = (path_prefix ? "#{path_prefix}/" : '')
sti_subclasses = ::Brick.config.sti_namespace_prefixes.each_with_object(Hash.new { |h, k| h[k] = [] }) do |v, s|
s[v.last] << v.first[2..-1] unless v.first.end_with?('::')
end
versioned_views = {} ::Brick.relations.each do |k, v|
next if k.is_a?(Symbol)
if (schema_name = v.fetch(:schema, nil))
schema_prefix = "#{schema_name}."
end
resource_name = v.fetch(:resource, nil)
next if !resource_name ||
existing_controllers.key?(
controller_prefix + (resource_name = "#{schema_prefix&.tr('.', '/')}#{resource_name}".pluralize)
)
object_name = k.split('.').last
full_schema_prefix = if (full_aps = aps = v.fetch(:auto_prefixed_schema, nil))
aps = aps[0..-2] if aps[-1] == '_'
(schema_prefix&.dup || +'') << "#{aps}."
else
schema_prefix
end
if (class_name = v.fetch(:class_name, nil))
if v.key?(:isView)
view_class_length = class_name.length if class_name.length > view_class_length
views
else
table_class_length = class_name.length if class_name.length > table_class_length
tables
end << [class_name, aps, k.tr('.', '/')[full_aps&.length || 0 .. -1]]
end
options = {}
options[:only] = [:index, :show] if v.key?(:isView)
prefixes = []
prefixes << [aps, v[:class_name]&.split('::')[-2]&.underscore] if aps
prefixes << schema_name if schema_name
prefixes << path_prefix if path_prefix
brick_namespace_create.call(prefixes, v[:resource], options)
sti_subclasses.fetch(class_name, nil)&.each do |sc| brick_namespace_create.call(prefixes, sc.underscore.tr('/', '_').pluralize, options)
end
full_resource = nil
::Brick.api_roots&.each do |api_root|
api_done_views = (versioned_views[api_root] ||= {})
found = nil
test_ver_num = nil
view_relation = nil
if v.key?(:isView)
if (ver = object_name.match(/^v([\d_]*)/)&.captures&.first) && ver[-1] == '_'
core_object_name = object_name[ver.length + 1..-1]
next if api_done_views.key?(unversioned = "#{schema_prefix}v_#{core_object_name}")
api_ver = api_root.split('/')[-1]&.gsub('_', '.')
vn_idx = api_ver.rindex(/[^\d._]/) test_ver_num = api_ver_num = api_ver[vn_idx + 1..-1].gsub('_', '.').to_i
next if ver.to_i > api_ver_num
test_ver_num -= 1 until test_ver_num.zero? ||
(view_relation = ::Brick.relations.fetch(
found = "#{schema_prefix}v#{test_ver_num}_#{core_object_name}", nil
))
api_done_views[unversioned] = nil
no_v_prefix_name = "#{schema_prefix}#{core_object_name}"
standard_prefix = 'v_'
else
core_object_name = object_name
end
if (rvp = ::Brick.config.api_remove_view_prefix) && core_object_name.start_with?(rvp)
core_object_name.slice!(0, rvp.length)
end
no_prefix_name = "#{schema_prefix}#{core_object_name}"
unversioned = "#{schema_prefix}#{standard_prefix}#{::Brick.config.api_add_view_prefix}#{core_object_name}"
else
unversioned = k
end
view_relation ||= ::Brick.relations.fetch(found = unversioned, nil) ||
(no_v_prefix_name && ::Brick.relations.fetch(found = no_v_prefix_name, nil)) ||
(no_prefix_name && ::Brick.relations.fetch(found = no_prefix_name, nil))
if view_relation
actions = view_relation.key?(:isView) ? [:index, :show] : ::Brick::ALL_API_ACTIONS proc_result = if (filter = ::Brick.config.api_filter).is_a?(Proc)
begin
num_args = filter.arity.negative? ? 6 : filter.arity
filter.call(*[unversioned, k, view_relation, actions, api_ver_num, found, test_ver_num][0...num_args])
rescue StandardError => e
puts "::Brick.api_filter Proc error: #{e.message}"
end
end
case proc_result
when NilClass
when FalseClass view_relation[:api][api_ver_num] = nil
next
when Array unless proc_result.any? { |pr| ::Brick::ALL_API_ACTIONS.exclude?(pr) }
proc_result = [unversioned, to_relation, proc_result]
end
when String
proc_result = [proc_result] else
puts "::Brick.api_filter Proc warning: Unable to parse this result returned: \n #{proc_result.inspect}"
proc_result = nil end
if proc_result&.present?
if proc_result[1] if (new_view_relation = ::Brick.relations.fetch(proc_result[1], nil))
k = proc_result[1] view_relation = new_view_relation
else
puts "::Brick.api_filter Proc warning: Unable to find new suggested relation with name #{proc_result[1]} -- sticking with #{k} instead."
end
end
if proc_result.first&.!=(k) found = proc_result.first
end
actions &= proc_result[2] if proc_result[2] end
(view_relation[:api][api_ver_num] ||= {})[unversioned] = actions
controller_name = if (last = view_relation.fetch(:resource, nil)&.pluralize)
"#{full_schema_prefix}#{last}"
else
found
end.tr('.', '/')
{ :index => 'get', :create => 'post' }.each do |action, method|
if actions.include?(action)
send(method, "#{api_root}#{unversioned.tr('.', '/')}", { to: "#{controller_prefix}#{controller_name}##{action}" })
end
end
if (id_col = view_relation[:pk]&.first) { :update => ['put', 'patch'], :destroy => ['delete'] }.each do |action, methods|
if actions.include?(action)
methods.each do |method|
send(method, "#{api_root}#{unversioned.tr('.', '/')}/:#{id_col}", { to: "#{controller_prefix}#{controller_name}##{action}" })
end
end
end
end
end
end
if Object.const_defined?('Trestle') && ::Trestle.config.options&.key?(:site_title) &&
!Object.const_defined?("#{(res_name = resource_name.tr('/', '_')).camelize}Admin")
begin
::Trestle.resource(res_sym = res_name.to_sym, model: class_name&.constantize) do
{ item res_sym, icon: "fa fa-star" }
end
rescue
end
end
end
if (named_routes = instance_variable_get(:@set).named_routes).respond_to?(:find)
if ::Brick.config.add_status && (status_as = "#{controller_prefix.tr('/', '_')}brick_status".to_sym)
(
!(status_route = instance_variable_get(:@set).named_routes.find { |route| route.first == status_as }&.last) ||
!status_route.ast.to_s.include?("/#{controller_prefix}brick_status/")
)
get("/#{controller_prefix}brick_status", to: 'brick_gem#status', as: status_as.to_s)
end
if (schema_as = "#{controller_prefix.tr('/', '_')}brick_schema".to_sym)
(
!(schema_route = instance_variable_get(:@set).named_routes.find { |route| route.first == schema_as }&.last) ||
!schema_route.ast.to_s.include?("/#{controller_prefix}brick_schema/")
)
post("/#{controller_prefix}brick_schema", to: 'brick_gem#schema_create', as: schema_as.to_s)
end
if ::Brick.config.add_orphans && (orphans_as = "#{controller_prefix.tr('/', '_')}brick_orphans".to_sym)
(
!(orphans_route = instance_variable_get(:@set).named_routes.find { |route| route.first == orphans_as }&.last) ||
!orphans_route.ast.to_s.include?("/#{controller_prefix}brick_orphans/")
)
get("/#{controller_prefix}brick_orphans", to: 'brick_gem#orphans', as: 'brick_orphans')
end
end
if instance_variable_get(:@set).named_routes.names.exclude?(:brick_crosstab)
get("/#{controller_prefix}brick_crosstab", to: 'brick_gem#crosstab', as: 'brick_crosstab')
get("/#{controller_prefix}brick_crosstab/data", to: 'brick_gem#crosstab_data')
end
if ((rswag_ui_present = Object.const_defined?('Rswag::Ui')) &&
(rswag_path = routeset_to_use.routes.find { |r| r.app.app == ::Rswag::Ui::Engine }
&.instance_variable_get(:@path_formatter)
&.instance_variable_get(:@parts)&.join) &&
(doc_endpoints = ::Rswag::Ui.config.config_object[:urls])) ||
(doc_endpoints = ::Brick.instance_variable_get(:@swagger_endpoints))
last_endpoint_parts = nil
doc_endpoints.each do |doc_endpoint|
puts "Mounting OpenApi 3.0 documentation endpoint for \"#{doc_endpoint[:name]}\" on #{doc_endpoint[:url]}" unless ::Brick.routes_done
send(:get, doc_endpoint[:url], { to: 'brick_openapi#index' })
endpoint_parts = doc_endpoint[:url]&.split('/')
last_endpoint_parts = endpoint_parts
end
end
return if ::Brick.routes_done
if doc_endpoints.present?
if rswag_ui_present
if rswag_path
puts "API documentation now available when navigating to: /#{last_endpoint_parts&.find(&:present?)}/index.html"
else
puts "In order to make documentation available you can put this into your routes.rb:"
puts " mount Rswag::Ui::Engine => '/#{last_endpoint_parts&.find(&:present?) || 'api-docs'}'"
end
else
puts "Having this exposed, one easy way to leverage this to create HTML-based API documentation is to use Scalar.
It will jump to life when you put these two lines into a view template or other HTML resource:
<script id=\"api-reference\" data-url=\"#{last_endpoint_parts.join('/')}\"></script>
<script src=\"https://cdn.jsdelivr.net/@scalar/api-reference\"></script>
Alternatively you can add the rswag-ui gem."
end
elsif rswag_ui_present
sample_path = rswag_path || '/api-docs'
puts
puts "Brick: rswag-ui gem detected -- to make OpenAPI 3.0 documentation available from a path such as '#{sample_path}/v1/swagger.json',"
puts ' put code such as this in an initializer:'
puts ' Rswag::Ui.configure do |config|'
puts " config.swagger_endpoint '#{sample_path}/v1/swagger.json', 'API V1 Docs'"
puts ' end'
unless rswag_path
puts
puts ' and put this into your routes.rb:'
puts " mount Rswag::Ui::Engine => '/api-docs'"
end
end
puts "\n" if tables.present? || views.present?
if tables.present?
puts "Classes that can be built from tables:#{' ' * (table_class_length - 38)} Path:"
puts "======================================#{' ' * (table_class_length - 38)} ====="
::Brick.display_classes(controller_prefix, tables, table_class_length)
end
if views.present?
puts "Classes that can be built from views:#{' ' * (view_class_length - 37)} Path:"
puts "=====================================#{' ' * (view_class_length - 37)} ====="
::Brick.display_classes(controller_prefix, views, view_class_length)
end
::Brick.routes_done = true
end
|