brick 1.0.186 → 1.0.187

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e5a41639892f2e1b8c16c55334cd7cb50f9bfd3a5bffd1eb093764deaad606d1
-  data.tar.gz: 4a18ba9341e71fb00bbc6dde1686b561de8cdd9b898905c680ba85f83cabf394
+  metadata.gz: 72ed0bc43d9ca9ae52dd6641bd5ba400bcb9a4fdb4e13953f931f2b7e1f0d46a
+  data.tar.gz: e5e56338e6e980ccfd733697e4cc9efaa8929e38b7f154c8d668ddc784bd55bc
 SHA512:
-  metadata.gz: c30f5f19ca9f5fe716d32d5efc5b0bc3a7d8addeeb9a8798cb34dc23efcc6abb92391854e899269875ccc2319b36b7361068e9ad17ad5d6245b16bf4ac7aaa89
-  data.tar.gz: d66d5544a948ad006294c654f8b7333b67b1a630c718c525a5fe40032414e4d307c0fe0aab70fcec47add3cd1feaed389ae3af75f69e3b480dbd4be3fc50a0a0
+  metadata.gz: 06321d9f6ca977150dcc5458d85cb3a329955bbe961b26a273581392e8219bebbc669ad3373d2c57030b0c9b6df07e5c8cef0bdb6bcb7f14379e3ddf73ddb23e
+  data.tar.gz: d3432a3ba5983e1ac69d9dde0c5fb6a186d838e32007e0db5ca0af2497f4e918c7f58d9c10db23218c2c7fd605a64e86b50ab8002130845f993fae3a6232a08c

data/lib/brick/compatibility.rb

@@ -160,7 +160,7 @@ if ActiveRecord.version < ::Gem::Version.new('5.0') && ::Gem::Version.new(RUBY_V
   if ::Gem::Version.new(RUBY_VERSION) >= ::Gem::Version.new('3.1')
     # @@schemes fix for global_id gem < 1.0
     URI.class_variable_set(:@@schemes, {}) unless URI.class_variables.include?(:@@schemes)
-    if Gem::Specification.all_names.find { |g| g.start_with?('puma-') }
+    if Gem::Dependency.new('puma').matching_specs.present?
       require 'rack/handler/puma'
       module Rack::Handler::Puma
         class << self

data/lib/brick/extensions.rb

@@ -96,38 +96,60 @@ module ActiveRecord
                 end
         columns_hash.keys.map(&:to_sym) + (rtans || [])
       end
-    end
 
-    def self._brick_primary_key(relation = nil)
-      return @_brick_primary_key if instance_variable_defined?(:@_brick_primary_key)
-
-      pk = begin
-             primary_key.is_a?(String) ? [primary_key] : primary_key.dup || []
-           rescue
-             []
-           end
-      pk.map! { |pk_part| pk_part =~ /^[A-Z0-9_]+$/ ? pk_part.downcase : pk_part } unless connection.adapter_name == 'MySQL2'
-      # Just return [] if we're missing any part of the primary key.  (PK is usually just "id")
-      if relation && pk.present?
-        @_brick_primary_key ||= pk.any? { |pk_part| !relation[:cols].key?(pk_part) } ? [] : pk
-      else # No definitive key yet, so return what we can without setting the instance variable
-        pk
+      def _br_quoted_name(name)
+        if name == '*'
+          name
+        elsif is_mysql
+          "`#{name.gsub('.', '`.`')}`"
+        elsif is_postgres || is_mssql
+          "\"#{name.gsub('.', '"."')}\""
+        else
+          name
+        end
       end
-    end
 
-    # Used to show a little prettier name for an object
-    def self.brick_get_dsl
-      # If there's no DSL yet specified, just try to find the first usable column on this model
-      unless (dsl = ::Brick.config.model_descrips[name])
-        skip_columns = _brick_get_fks + (::Brick.config.metadata_columns || []) + [primary_key]
-        dsl = if (descrip_col = columns.find { |c| [:boolean, :binary, :xml].exclude?(c.type) && skip_columns.exclude?(c.name) })
-                "[#{descrip_col.name}]"
-              elsif (pk_parts = self.primary_key.is_a?(Array) ? self.primary_key : [self.primary_key])
-                "#{name} ##{pk_parts.map { |pk_part| "[#{pk_part}]" }.join(', ')}"
-              end
-        ::Brick.config.model_descrips[name] = dsl
+      def is_postgres
+        @is_postgres ||= connection.adapter_name == 'PostgreSQL'
+      end
+      def is_mysql
+        @is_mysql ||= ['Mysql2', 'Trilogy'].include?(connection.adapter_name)
+      end
+      def is_mssql
+        @is_mssql ||= connection.adapter_name == 'SQLServer'
+      end
+
+      def _brick_primary_key(relation = nil)
+        return @_brick_primary_key if instance_variable_defined?(:@_brick_primary_key)
+
+        pk = begin
+              primary_key.is_a?(String) ? [primary_key] : primary_key.dup || []
+            rescue
+              []
+            end
+        pk.map! { |pk_part| pk_part =~ /^[A-Z0-9_]+$/ ? pk_part.downcase : pk_part } unless connection.adapter_name == 'MySQL2'
+        # Just return [] if we're missing any part of the primary key.  (PK is usually just "id")
+        if relation && pk.present?
+          @_brick_primary_key ||= pk.any? { |pk_part| !relation[:cols].key?(pk_part) } ? [] : pk
+        else # No definitive key yet, so return what we can without setting the instance variable
+          pk
+        end
+      end
+
+      # Used to show a little prettier name for an object
+      def brick_get_dsl
+        # If there's no DSL yet specified, just try to find the first usable column on this model
+        unless (dsl = ::Brick.config.model_descrips[name])
+          skip_columns = _brick_get_fks + (::Brick.config.metadata_columns || []) + [primary_key]
+          dsl = if (descrip_col = columns.find { |c| [:boolean, :binary, :xml].exclude?(c.type) && skip_columns.exclude?(c.name) })
+                  "[#{descrip_col.name}]"
+                elsif (pk_parts = self.primary_key.is_a?(Array) ? self.primary_key : [self.primary_key])
+                  "#{name} ##{pk_parts.map { |pk_part| "[#{pk_part}]" }.join(', ')}"
+                end
+          ::Brick.config.model_descrips[name] = dsl
+        end
+        dsl
       end
-      dsl
     end
 
     def self.brick_parse_dsl(join_array = nil, prefix = [], translations = {}, is_polymorphic = false, dsl = nil, emit_dsl = false)
@@ -420,15 +442,18 @@ module ActiveRecord
     end
 
     def self._brick_calculate_ordering(ordering, is_do_txt = true)
-      quoted_table_name = table_name.split('.').map { |x| "\"#{x}\"" }.join('.')
       order_by_txt = [] if is_do_txt
       ordering = [ordering] if ordering && !ordering.is_a?(Array)
       order_by = ordering&.each_with_object([]) do |ord_part, s| # %%% If a term is also used as an eqi-condition in the WHERE clause, it can be omitted from ORDER BY
                    case ord_part
                    when String
-                     ord_expr = ord_part.gsub('^^^', quoted_table_name)
-                     order_by_txt&.<<("Arel.sql(#{ord_expr})")
-                     s << Arel.sql(ord_expr)
+                     if ord_part.index('^^^')
+                       ord_expr = ord_part.gsub('^^^', _br_quoted_name(table_name))
+                       s << Arel.sql(ord_expr)
+                     else
+                      s << Arel.sql(_br_quoted_name(ord_expr))
+                     end
+                     order_by_txt&.<<("Arel.sql(#{ord_expr.inspect})")
                    else # Expecting only Symbol
                      ord_part = ord_part.to_s
                      if ord_part[0] == '-' # First char '-' means descending order
@@ -438,15 +463,14 @@ module ActiveRecord
                      if ord_part[0] == '~' # Char '~' means order NULLs as highest values instead of lowest
                        ord_part.slice!(0)
                        # (Unfortunately SQLServer does not support NULLS FIRST / NULLS LAST, so leave them out.)
-                       is_nulls_switch = case ActiveRecord::Base.connection.adapter_name
-                                         when 'PostgreSQL', 'OracleEnhanced', 'SQLite'
-                                           :pg
-                                         when 'Mysql2', 'Trilogy'
+                       is_nulls_switch = if is_mysql
                                            :mysql
+                                         else # PostgreSQL, OracleEnhanced, SQLite
+                                           :pg
                                          end
                      end
                      if _br_hm_counts.key?(ord_part_sym = ord_part.to_sym)
-                       ord_part = +"\"b_r_#{ord_part}_ct\""
+                       ord_part = _br_quoted_name("b_r_#{ord_part}_ct")
                      elsif _br_bt_descrip.key?(ord_part_sym)
                        ord_part = _br_bt_descrip.fetch(ord_part_sym, nil)&.first&.last&.first&.last&.dup
                      elsif !_br_cust_cols.key?(ord_part_sym) && !column_names.include?(ord_part)
@@ -1080,28 +1104,6 @@ Might want to add this in your brick.rb:
     def shift_or_first(ary)
       ary.length > 1 ? ary.shift : ary.first
     end
-
-    def _br_quoted_name(name)
-      if name == '*'
-        name
-      elsif is_mysql
-        "`#{name.gsub('.', '`.`')}`"
-      elsif is_postgres || is_mssql
-        "\"#{(name).gsub('.', '"."')}\""
-      else
-        name
-      end
-    end
-
-    def is_postgres
-      @is_postgres ||= ActiveRecord::Base.connection.adapter_name == 'PostgreSQL'
-    end
-    def is_mysql
-      @is_mysql ||= ['Mysql2', 'Trilogy'].include?(ActiveRecord::Base.connection.adapter_name)
-    end
-    def is_mssql
-      @is_mssql ||= ActiveRecord::Base.connection.adapter_name == 'SQLServer'
-    end
   end
 
   module Inheritance
@@ -1505,7 +1507,8 @@ class Object
           schema_name = ::Brick.apartment_default_tenant
         end
         # Maybe, just maybe there's a database table that will satisfy this need
-        if (matching = [table_name, singular_table_name, plural_class_name, model_name, table_name.titleize].find { |m| relations.key?(schema_name ? "#{schema_name}.#{m}" : m) })
+        matching = ::Brick.table_name_lookup&.fetch(class_name, nil)
+        if (matching ||= [table_name, singular_table_name, plural_class_name, model_name, table_name.titleize].find { |m| relations.key?(schema_name ? "#{schema_name}.#{m}" : m) })
           build_model_worker(schema_name, inheritable_name, model_name, singular_table_name, table_name, relations, matching)
         end
       end
@@ -1711,7 +1714,7 @@ class Object
               # options[:class_name] = hm.first[:inverse_table].singularize.camelize
               # options[:foreign_key] = hm.first[:fk].to_sym
               far_assoc = relations[hm.first[:inverse_table]][:fks].find { |_k, v| v[:assoc_name] == hm[1] }
-              options[:class_name] = far_assoc.last[:inverse_table].singularize.camelize
+              options[:class_name] = ::Brick.namify(far_assoc.last[:inverse_table], :underscore).camelize
               options[:foreign_key] = far_assoc.last[:fk].to_sym
             end
             options[:source] ||= hm[1].to_sym unless hmt_name.singularize == hm[1]
@@ -1798,7 +1801,9 @@ class Object
          ::Brick.config.schema_behavior[:multitenant] && singular_table_parts.first == 'public'
         singular_table_parts.shift
       end
-      options[:class_name] = "::#{assoc[:primary_class]&.name || singular_table_parts.map(&:camelize).join('::')}" if need_class_name
+      options[:class_name] = "::#{assoc[:primary_class]&.name ||
+                                  singular_table_parts.map { |p| ::Brick.namify(p, :underscore).camelize}.join('::')
+                                 }" if need_class_name
       if need_fk # Funky foreign key?
         options_fk_key = :foreign_key
         if assoc[:fk].is_a?(Array)
@@ -2547,10 +2552,14 @@ class Object
                                   [new_alt_name, true]
                                 else
                                   assoc_name = ::Brick.namify(hm_assoc[:inverse_table]).pluralize
-                                  if (needs_class = assoc_name.include?('.')) # If there is a schema name present, use a downcased version for the :has_many
-                                    assoc_parts = assoc_name.split('.')
+                                  assoc_parts = assoc_name.split('.')
+                                  if (needs_class = assoc_parts.length > 1) # If there is a schema name present, use a downcased version for the :has_many
                                     assoc_parts[0].downcase! if assoc_parts[0] =~ /^[A-Z0-9_]+$/
                                     assoc_name = assoc_parts.join('.')
+                                  else
+                                    class_name_parts = ::Brick.namify(hm_assoc[:inverse_table], :underscore).split('.')
+                                    real_name = class_name_parts.map(&:camelize).join('::')
+                                    needs_class = (real_name != hm_assoc[:inverse_table].camelize)
                                   end
                                   # hm_assoc[:assoc_name] = assoc_name
                                   [assoc_name, needs_class]
@@ -2960,6 +2969,7 @@ ORDER BY 1, 2, c.internal_column_id, acc.position"
       end
     end
 
+    table_name_lookup = (::Brick.table_name_lookup ||= {})
     relations.each do |k, v|
       next if k.is_a?(Symbol)
 
@@ -2981,7 +2991,9 @@ ORDER BY 1, 2, c.internal_column_id, acc.position"
                      v[:resource] = rel_name.last
                      [singular]
                    end
-      v[:class_name] = (schema_names + name_parts).map(&:camelize).join('::')
+      v[:class_name] = (schema_names + name_parts).map { |p| ::Brick.namify(p, :underscore).camelize }.join('::')
+      # Track anything that's out-of-the-ordinary
+      table_name_lookup[v[:class_name]] = k unless v[:class_name].underscore.pluralize == k
     end
     ::Brick.load_additional_references if ::Brick.initializer_loaded
 

data/lib/brick/frameworks/rails/engine.rb

@@ -636,7 +636,7 @@ window.addEventListener(\"popstate\", linkSchemas);
                   resource_parts[-1] = class_name # Make sure the last part, defining the class name, is singular
                   begin
                     resource_parts.shift if resource_parts.first == ::Brick.config.path_prefix
-                    if (model = Object.const_get(resource_parts.map(&:camelize).join('::')))&.is_a?(Class) && (
+                    if (model = Object.const_get(resource_parts.map { |p| ::Brick.namify(p, :underscore).camelize }.join('::')))&.is_a?(Class) && (
                          ['index', 'show'].include?(find_args.first) || # Everything has index and show
                          # Only CUD stuff has create / update / destroy
                          (!model.is_view? && ['new', 'create', 'edit', 'update', 'destroy'].include?(find_args.first))

data/lib/brick/version_number.rb

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

data/lib/brick.rb

@@ -89,7 +89,7 @@ end
 # is first established), and then automatically creates models, controllers, views,
 # and routes based on those available relations.
 require 'brick/config'
-if Gem::Specification.all_names.any? { |g| g.start_with?('rails-') && g[6..-1] =~ /^([0-9]|\.)+(?:|rc1|rc2|beta1)$/ }
+if Gem::Dependency.new('rails').matching_specs.present?
   require 'rails'
   require 'brick/frameworks/rails'
 end
@@ -108,7 +108,8 @@ module Brick
 
     attr_accessor :default_schema, :db_schemas, :test_schema,
                   :routes_done, :established_drf,
-                  :is_oracle, :is_eager_loading, :auto_models, :initializer_loaded
+                  :is_oracle, :is_eager_loading, :auto_models, :initializer_loaded,
+                  :table_name_lookup
     ::Brick.auto_models = []
 
     def get_possible_schemas
@@ -213,12 +214,19 @@ module Brick
         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) &&
+        primary_klass = if a.belongs_to?
+                          a.polymorphic? ? nil : a.klass
+                        else
+                          a.active_record
+                        end
+        a_pk = a.options.fetch(:primary_key, nil)&.to_s ||
+               primary_klass&.primary_key # Was:  a.klass.primary_key
+        if !a.polymorphic? && (a.belongs_to? || (through && (thr = a.through_reflection))) &&
+           !((kls = thr&.klass || a.klass) && ::Brick.config.exclude_tables.exclude?(kls.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) &&
-                 (primary_cols = a.klass.columns_hash) &&
-                 (pk_type = a.klass.primary_key.is_a?(Array) ? a.klass.primary_key.map { |pk_part| primary_cols[pk_part.to_s].type } : primary_cols[a.klass.primary_key].type) &&
+                 (primary_cols = primary_klass.columns_hash) &&
+                 (pk_type = a_pk.is_a?(Array) ? a_pk.map { |pk_part| primary_cols[pk_part.to_s].type } : primary_cols[a_pk].type) &&
                  (same_type = (pk_type == fk_type))
                 )
               )
@@ -229,7 +237,7 @@ module Brick
         #        )
           if same_type == false # We really do want to test specifically for false here, and not nil!
             puts "WARNING:
-  Foreign key column #{a.klass.table_name}.#{a.foreign_key} is #{fk_type}, but the primary key it relates to, #{a.active_record.table_name}.#{a.active_record.primary_key}, is #{pk_type}.
+  Foreign key column #{a.klass.table_name}.#{a.foreign_key} is #{fk_type}, but the primary key it relates to, #{primary_klass.table_name}.#{a_pk}, is #{pk_type}.
   These columns should both be of the same type."
           end
           next
@@ -1166,7 +1174,11 @@ In config/initializers/brick.rb appropriate entries would look something like:
             puts "  mount Rswag::Ui::Engine => '/#{last_endpoint_parts&.find(&:present?) || 'api-docs'}'"
           end
         else
-          puts 'A couple easy ways to create compelling documentation from this are to use Scalar API, or to add the rswag-ui gem.'
+          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'
@@ -1792,7 +1804,7 @@ end
 
 # By default the awesome_nested_set gem from CollectiveIdea does not prefix the ORDER BY column with its table name.
 # You can see this snag in action in the popular Spree project -- check out the Taxonomy model.  Here is a fix:
-if Gem::Specification.all_names.find { |g| g.start_with?('awesome_nested_set-') }
+if Gem::Dependency.new('awesome_nested_set').matching_specs.present?
   require 'awesome_nested_set/columns'
   ::CollectiveIdea::Acts::NestedSet::Columns.class_exec do
     alias _brick_order_column_name order_column_name
@@ -1935,7 +1947,7 @@ module ActiveRecord
         # %%% Pretty much have to flat-out replace this guy (I think anyway)
         # Good with Rails 5.2.4 through 7.1 on this
         # Ransack gem includes Polyamorous which replaces #build in a different way (which we handle below)
-        unless Gem::Specification.all_names.any? { |g| g.start_with?('ransack-') }
+        if Gem::Dependency.new('ransack').matching_specs.empty?
           def build(associations, base_klass, root = nil, path = '')
             root ||= associations
             associations.map do |name, right|
@@ -1991,7 +2003,7 @@ module ActiveRecord
 end
 
 # Now the Ransack Polyamorous version of #build
-if Gem::Specification.all_names.any? { |g| g.start_with?('ransack-') }
+if Gem::Dependency.new('ransack').matching_specs.present?
   require "polyamorous/activerecord_#{::ActiveRecord::VERSION::STRING[0, 3]}_ruby_2/join_dependency"
   module Polyamorous::JoinDependencyExtensions
     def build(associations, base_klass, root = nil, path = '')

data/lib/generators/brick/install_generator.rb

@@ -190,6 +190,10 @@ if ActiveRecord::Base.respond_to?(:brick_select) && !::Brick.initializer_loaded
   #   config.swagger_endpoint '/api-docs/v1/swagger.json', 'API V1 Docs'
   # end
 
+  # # To establish OpenAPI 3.0 documentation endpoints without use of Rswag, such as if you want to use fancier
+  # # tooling such as Scalar API or similar, the Brick also allows you to establish endpoints directly:
+  # ::Brick.swagger_endpoint '/api-docs/v1/swagger.json', 'API V1 Docs'
+
   # # By default models are auto-created for database views, and set to be read-only.  This can be skipped.
   # Brick.skip_database_views = true
 

data/lib/generators/brick/migration_builder.rb

@@ -1,7 +1,5 @@
 module Brick
   module MigrationBuilder
-    include FancyGets
-
     # Many SQL types are the same as their migration data type name:
     #   text, integer, bigint, date, boolean, decimal, float
     # These however are not:
@@ -48,6 +46,7 @@ module Brick
     # (Still need to find what "inet" and "json" data types map to.)
 
     class << self
+      include FancyGets
       def check_folder(is_insert_versions = true, is_delete_versions = false)
         versions_to_delete_or_append = nil
         if Dir.exist?(mig_path = ActiveRecord::Migrator.migrations_paths.first || "#{::Rails.root}/db/migrate")

metadata

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