brick 1.0.185 → 1.0.186

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d930911e6903179271b74220c325ba024dfebe26f87eec06111772bfe1dd6b39
-  data.tar.gz: fb0767bf7e59c56dffbe1999ee86ca3cefe66040dd26387019f2d45b8776fcd3
+  metadata.gz: e5a41639892f2e1b8c16c55334cd7cb50f9bfd3a5bffd1eb093764deaad606d1
+  data.tar.gz: 4a18ba9341e71fb00bbc6dde1686b561de8cdd9b898905c680ba85f83cabf394
 SHA512:
-  metadata.gz: d03584188eaf7ba5a41b37fd80470f6eeb8c166949f4e19f1e2a9ccf958b94d0864c25f16363fbaae1980c36d8e82ec0eacf731cd5bdee97ec819a68be4b9836
-  data.tar.gz: 5fc2966228117b7d35e5370ff64f2f46e85e8bfa8a1a4a4df8732e91fe0e0f4c0a5050cc7b77d44217538a7bc46681a24ebd03d0fc6ff69f483f7a7861f74a38
+  metadata.gz: c30f5f19ca9f5fe716d32d5efc5b0bc3a7d8addeeb9a8798cb34dc23efcc6abb92391854e899269875ccc2319b36b7361068e9ad17ad5d6245b16bf4ac7aaa89
+  data.tar.gz: d66d5544a948ad006294c654f8b7333b67b1a630c718c525a5fe40032414e4d307c0fe0aab70fcec47add3cd1feaed389ae3af75f69e3b480dbd4be3fc50a0a0

data/lib/brick/extensions.rb

@@ -317,10 +317,15 @@ module ActiveRecord
         tbl_parts[-1] = aps
         tbl_parts << last_part
       end
-      tbl_parts.unshift(::Brick.config.path_prefix) if ::Brick.config.path_prefix
+      path_prefix = []
+      if ::Brick.config.path_prefix
+        tbl_parts.unshift(::Brick.config.path_prefix)
+        path_prefix << ::Brick.config.path_prefix
+      end
       index = tbl_parts.map(&:underscore).join(separator)
-      # Rails applies an _index suffix to that route when the resource name is singular
-      index << '_index' if mode != :singular && separator == '_' && index == index.singularize
+      # Rails applies an _index suffix to that route when the resource name isn't something plural
+      index << '_index' if mode != :singular && separator == '_' &&
+                           index == (path_prefix + [name&.underscore&.tr('/', '_') || '_']).join(separator)
       index
     end
 
@@ -2044,9 +2049,10 @@ class Object
             _schema, @_is_show_schema_list = ::Brick.set_db_schema(params || api_params)
 
             if is_openapi
-              api_name = Rswag::Ui.config.config_object[:urls].find do |api_url|
-                api_url[:url] == request.path
-              end&.fetch(:name, 'API documentation')
+              doc_endpoints = (Object.const_defined?('Rswag::Ui') &&
+                               (::Rswag::Ui.config.config_object[:urls])) ||
+                              ::Brick.instance_variable_get(:@swagger_endpoints)
+              api_name = doc_endpoints&.find { |api_url| api_url[:url] == request.path }&.fetch(:name, 'API documentation')
               current_api_ver = current_api_root.split('/').last&.[](1..-1).to_i
               json = { 'openapi': '3.0.1', 'info': { 'title': api_name, 'version': request_ver },
                        'servers': [

data/lib/brick/version_number.rb

@@ -5,7 +5,7 @@ module Brick
   module VERSION
     MAJOR = 1
     MINOR = 0
-    TINY = 185
+    TINY = 186
 
     # PRE is nil unless it's a pre-release (beta, RC, etc.)
     PRE = nil

data/lib/brick.rb

@@ -210,7 +210,10 @@ module Brick
           puts "Based on inclusion in ::Brick.polymorphics, marking association #{full_assoc_name} as being polymorphic."
           a.options[:polymorphic] = true
         end
-        if !a.polymorphic? && (a.belongs_to? || (through = a.options[:through])) &&
+        if (through = a.options[:through]) && !a.through_reflection
+          puts "WARNING:  In model #{model.name}, unable to utilise:  has_many #{a.name}, through: #{through.inspect}"
+        end
+        if !a.polymorphic? && (a.belongs_to? || (through && a.through_reflection)) &&
            !(a.klass && ::Brick.config.exclude_tables.exclude?(a.klass.table_name) &&
               (!a.belongs_to? ||
                 ((fk_type = a.foreign_key.is_a?(Array) ? a.foreign_key.map { |fk_part| model_cols[fk_part.to_s].type } : model_cols[a.foreign_key.to_s].type) &&
@@ -280,7 +283,7 @@ module Brick
               is_invalid_source = true
             end
             if is_invalid_source
-              puts "WARNING:  HMT relationship :#{a.name} in model #{model.name} has invalid source :#{a.source_reflection_name}."
+              puts "  due to invalid source #{a.source_reflection_name.inspect}."
               next
             end
           else
@@ -323,6 +326,12 @@ module Brick
       true
     end
 
+    # Add a swagger endpoint in the same kind of way that RSwag UI does
+    def swagger_endpoint(url, name)
+      @swagger_endpoints ||= []
+      @swagger_endpoints << { url: url, name: name }
+    end
+
     def is_geography?(val)
       val.length < 31 && (val.length - 6) % 8 == 0 && val[0..5].bytes == [230, 16, 0, 0, 1, 12]
     end
@@ -1132,39 +1141,45 @@ In config/initializers/brick.rb appropriate entries would look something like:
         get("/#{controller_prefix}brick_crosstab/data", to: 'brick_gem#crosstab_data')
       end
 
-      if 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
-        first_endpoint_parts = nil
-        (doc_endpoints = Rswag::Ui.config.config_object[:urls])&.each do |doc_endpoint|
+      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('/')
-          first_endpoint_parts ||= endpoint_parts
+          last_endpoint_parts = endpoint_parts
         end
       end
       return if ::Brick.routes_done
 
-      if Object.const_defined?('Rswag::Ui')
-        if doc_endpoints.present?
-          if rswag_path && first_endpoint_parts
-            puts "API documentation now available when navigating to:  /#{first_endpoint_parts&.find(&:present?)}/index.html"
+      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 => '/#{first_endpoint_parts&.find(&:present?) || 'api-docs'}'"
+            puts "  mount Rswag::Ui::Engine => '/#{last_endpoint_parts&.find(&:present?) || 'api-docs'}'"
           end
         else
-          sample_path = rswag_path || '/api-docs'
+          puts 'A couple easy ways to create compelling documentation from this are to use Scalar API, or to 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 "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
+          puts '        and put this into your routes.rb:'
+          puts "  mount Rswag::Ui::Engine => '/api-docs'"
         end
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: brick
 version: !ruby/object:Gem::Version
-  version: 1.0.185
+  version: 1.0.186
 platform: ruby
 authors:
 - Lorin Thwaits
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-25 00:00:00.000000000 Z
+date: 2023-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord