brick 1.0.33 → 1.0.36

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7bd78c8878b1ce8e8e58fb4d8463322269d2ac065c5ed12079dcc64360dc30d5
-  data.tar.gz: e6926fdc0ec59ad609be39361dbfe0ccea24c1b08a01ccf0a4ae8eb1aa9e2ba2
+  metadata.gz: 6ef930474d4e1496812af0a626f57a2db1b05396c2dc46eb8f117c6fbf2f4df5
+  data.tar.gz: 8847971321e1a6178b340ef6929298d2d33edb1a1918584c43d67edc5b844a39
 SHA512:
-  metadata.gz: 5b6ac439519209c3097c2b2651ed66f319b9c04072d2cee7262aad6c4d9907d61b5b45ee1812c1f6cea1e5e1eed2082eb15953e4e3097c9c12b4f35a1f3af703
-  data.tar.gz: 5bb559ada7035abb062b0441578d5406e64f87b9f11fde1d5b3b880179098bafe9507a1a6cdd8e1af1cd1fb4defc1d339e0054896ca0e9c507ea831f24a0cb96
+  metadata.gz: cba480c932d00067c122b99d22f2633d8b26795295a4039a4c6ac014893ed0e4313ac33571cad06a880d9cbf426627e766c2b13514e7bf7b81093acc723aa425
+  data.tar.gz: 75aa1e29cd0619bf9654df74a4f36625b1b703bd307b9f72439e4ce9e25f0b80bd9fb10b4fe6f2eadf70effcf28849e1a513c1745d48b31000d33e8948ab555c

data/lib/brick/compatibility.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'active_record/version'
+
+# ActiveRecord before 4.0 didn't have #version
+unless ActiveRecord.respond_to?(:version)
+  module ActiveRecord
+    def self.version
+      ::Gem::Version.new(ActiveRecord::VERSION::STRING)
+    end
+  end
+end
+
+# In ActiveSupport older than 5.0, the duplicable? test tries to new up a BigDecimal,
+# and Ruby 2.6 and later deprecates #new.  This removes the warning from BigDecimal.
+# This compatibility needs to be put into place in the application's "config/boot.rb"
+# file by having the line "require 'brick/compatibility'" to be the last line in that
+# file.
+require 'bigdecimal'
+if ::Gem::Version.new(RUBY_VERSION) >= ::Gem::Version.new('2.6') &&
+   ActiveRecord.version < ::Gem::Version.new('5.0')
+  def BigDecimal.new(*args, **kwargs)
+    BigDecimal(*args, **kwargs)
+  end
+end

data/lib/brick/extensions.rb

@@ -163,6 +163,7 @@ module ActiveRecord
                         bracket_name.split('.').each do |part|
                           obj_name += ".#{part}"
                           this_obj = caches.fetch(obj_name) { caches[obj_name] = this_obj&.send(part.to_sym) }
+                          break if this_obj.nil?
                         end
                         this_obj&.to_s || ''
                       end
@@ -202,7 +203,9 @@ module ActiveRecord
       model_underscore = name.underscore
       assoc_name = CGI.escapeHTML(assoc_name.to_s)
       model_path = Rails.application.routes.url_helpers.send("#{model_underscore.tr('/', '_').pluralize}_path".to_sym)
-      link = Class.new.extend(ActionView::Helpers::UrlHelper).link_to(name, model_path)
+      av_class = Class.new.extend(ActionView::Helpers::UrlHelper)
+      av_class.extend(ActionView::Helpers::TagHelper) if ActionView.version < ::Gem::Version.new('6.1')
+      link = av_class.link_to(name, model_path)
       model_underscore == assoc_name ? link : "#{assoc_name}-#{link}".html_safe
     end
 
@@ -308,6 +311,23 @@ module ActiveRecord
       # , is_add_bts, is_add_hms
     )
       is_add_bts = is_add_hms = true
+      is_distinct = nil
+      wheres = {}
+      params.each do |k, v|
+        case (ks = k.split('.')).length
+        when 1
+          next unless klass._brick_get_fks.include?(k)
+        when 2
+          assoc_name = ks.first.to_sym
+          # Make sure it's a good association name and that the model has that column name
+          next unless klass.reflect_on_association(assoc_name)&.klass&.column_names&.any?(ks.last)
+
+          join_array[assoc_name] = nil # Store this relation name in our special collection for .joins()
+          is_distinct = true
+          distinct!
+        end
+        wheres[k] = v.split(',')
+      end
 
       # %%% Skip the metadata columns
       if selects&.empty? # Default to all columns
@@ -316,7 +336,9 @@ module ActiveRecord
           if (col_name = col.name) == 'class'
             col_alias = ' AS _class'
           end
-          selects << "\"#{tbl_no_schema}\".\"#{col_name}\"#{col_alias}"
+          # Postgres can not use DISTINCT with any columns that are XML, so for any of those just convert to text
+          cast_as_text = '::text' if is_distinct && Brick.relations[klass.table_name]&.[](:cols)&.[](col.name)&.first&.start_with?('xml')
+          selects << "\"#{tbl_no_schema}\".\"#{col_name}\"#{cast_as_text}#{col_alias}"
         end
       end
 
@@ -342,22 +364,6 @@ module ActiveRecord
         end
       end
 
-      wheres = {}
-      params.each do |k, v|
-        case (ks = k.split('.')).length
-        when 1
-          next unless klass._brick_get_fks.include?(k)
-        when 2
-          assoc_name = ks.first.to_sym
-          # Make sure it's a good association name and that the model has that column name
-          next unless klass.reflect_on_association(assoc_name)&.klass&.column_names&.any?(ks.last)
-
-          join_array[assoc_name] = nil # Store this relation name in our special collection for .joins()
-          distinct!
-        end
-        wheres[k] = v.split(',')
-      end
-
       if join_array.present?
         left_outer_joins!(join_array)
         # Without working from a duplicate, touching the AREL ast tree sets the @arel instance variable, which causes the relation to be immutable.
@@ -375,7 +381,9 @@ module ActiveRecord
             v1.map { |x| [translations[x[0..-2].map(&:to_s).join('.')], x.last] }.each_with_index do |sel_col, idx|
               field_tbl_name = (field_tbl_names[v.first][sel_col.first] ||= shift_or_first(chains[sel_col.first])).split('.').last
 
-              selects << "#{"\"#{field_tbl_name}\".\"#{sel_col.last}\""} AS \"#{(col_alias = "_brfk_#{v.first}__#{sel_col.last}")}\""
+              # Postgres can not use DISTINCT with any columns that are XML, so for any of those just convert to text
+              is_xml = is_distinct && Brick.relations[sel_col.first.table_name]&.[](:cols)&.[](sel_col.last)&.first&.start_with?('xml')
+              selects << "\"#{field_tbl_name}\".\"#{sel_col.last}\"#{'::text' if is_xml} AS \"#{(col_alias = "_brfk_#{v.first}__#{sel_col.last}")}\""
               v1[idx] << col_alias
             end
 
@@ -403,7 +411,6 @@ module ActiveRecord
       hm_counts.each do |k, hm|
         associative = nil
         count_column = if hm.options[:through]
-          # binding.pry if associatives[hm.name].nil?
                          fk_col = (associative = associatives[hm.name]).foreign_key
                          hm.foreign_key
                        else
@@ -494,8 +501,9 @@ if ActiveSupport::Dependencies.respond_to?(:autoload_module!) # %%% Only works w
       alias _brick_autoload_module! autoload_module!
       def autoload_module!(*args)
         into, const_name, qualified_name, path_suffix = args
-        base_class_name = ::Brick.config.sti_namespace_prefixes&.fetch("::#{into.name}::", nil)
-        base_class_name = "::#{base_class_name}" unless base_class_name.start_with?('::')
+        if (base_class_name = ::Brick.config.sti_namespace_prefixes&.fetch("::#{into.name}::", nil))
+          base_class_name = "::#{base_class_name}" unless base_class_name.start_with?('::')
+        end
         if (base_class = base_class_name&.constantize)
           ::Brick.sti_models[qualified_name] = { base: base_class }
           # Build subclass and place it into the specially STI-namespaced module
@@ -571,11 +579,13 @@ Module.class_exec do
                [built_module, "module #{schema_name}; end\n"]
                #  # %%% Perhaps an option to use the first module just as schema, and additional modules as namespace with a table name prefix applied
              elsif ::Brick.enable_models?
+               # Custom inheritable Brick base model?
+               class_name = (inheritable_name = class_name)[5..-1] if class_name.start_with?('Brick')
                # See if a file is there in the same way that ActiveSupport::Dependencies#load_missing_constant
                # checks for it in ~/.rvm/gems/ruby-2.7.5/gems/activesupport-5.2.6.2/lib/active_support/dependencies.rb
 
-               if self != Object || # Are we in some namespace? ...
-                  (base_model = ::Brick.config.sti_namespace_prefixes&.fetch("::#{name}::", nil)&.constantize) # ... or part of an auto-STI namespace?
+               if (base_model = ::Brick.config.sti_namespace_prefixes&.fetch("::#{name}::", nil)&.constantize) || # Are we part of an auto-STI namespace? ...
+                  self != Object # ... or otherwise already in some namespace?
                  schema_name = [(singular_schema_name = name.underscore),
                                 (schema_name = singular_schema_name.pluralize),
                                 name,
@@ -588,7 +598,7 @@ Module.class_exec do
                if base_model
                  schema_name = name.underscore # For the auto-STI namespace models
                  table_name = base_model.table_name
-                 Object.send(:build_model, self, model_name, singular_table_name, table_name, relations, table_name)
+                 Object.send(:build_model, self, inheritable_name, model_name, singular_table_name, table_name, relations, table_name)
                else
                  # Adjust for STI if we know of a base model for the requested model name
                  # %%% Does not yet work with namespaced model names.  Perhaps prefix with plural_class_name when doing the lookups here.
@@ -603,7 +613,7 @@ Module.class_exec do
                  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].find { |m| relations.key?(schema_name ? "#{schema_name}.#{m}" : m) })
-                   Object.send(:build_model, schema_name, model_name, singular_table_name, table_name, relations, matching)
+                   Object.send(:build_model, schema_name, inheritable_name, model_name, singular_table_name, table_name, relations, matching)
                  end
                end
              end
@@ -631,12 +641,12 @@ class Object
 
   private
 
-    def build_model(schema_name, model_name, singular_table_name, table_name, relations, matching)
+    def build_model(schema_name, inheritable_name, model_name, singular_table_name, table_name, relations, matching)
       full_name = if (::Brick.config.schema_behavior[:multitenant] && Object.const_defined?('Apartment') && schema_name == Apartment.default_schema)
                     relation = relations["#{schema_name}.#{matching}"]
-                    model_name
+                    inheritable_name || model_name
                   elsif schema_name.blank?
-                    model_name
+                    inheritable_name || model_name
                   else # Prefix the schema to the table name + prefix the schema namespace to the class name
                     schema_module = if schema_name.instance_of?(Module) # from an auto-STI namespace?
                                       schema_name
@@ -644,7 +654,7 @@ class Object
                                       matching = "#{schema_name}.#{matching}"
                                       (Brick.db_schemas[schema_name] ||= self.const_get(schema_name.singularize.camelize))
                                     end
-                    "#{schema_module&.name}::#{model_name}"
+                    "#{schema_module&.name}::#{inheritable_name || model_name}"
                   end
 
       return if ((is_view = (relation ||= relations[matching]).key?(:isView)) && ::Brick.config.skip_database_views) ||
@@ -653,12 +663,14 @@ class Object
       # Are they trying to use a pluralised class name such as "Employees" instead of "Employee"?
       if table_name == singular_table_name && !ActiveSupport::Inflector.inflections.uncountable.include?(table_name)
         unless ::Brick.config.sti_namespace_prefixes&.key?("::#{singular_table_name.camelize}::")
-          puts "Warning: Class name for a model that references table \"#{matching}\" should be \"#{ActiveSupport::Inflector.singularize(model_name)}\"."
+          puts "Warning: Class name for a model that references table \"#{matching
+               }\" should be \"#{ActiveSupport::Inflector.singularize(inheritable_name || model_name)}\"."
         end
         return
       end
 
-      if (base_model = ::Brick.sti_models[full_name]&.fetch(:base, nil) || ::Brick.existing_stis[full_name]&.constantize)
+      full_model_name = full_name.split('::').tap { |fn| fn[-1] = model_name }.join('::')
+      if (base_model = ::Brick.sti_models[full_model_name]&.fetch(:base, nil) || ::Brick.existing_stis[full_model_name]&.constantize)
         is_sti = true
       else
         base_model = ::Brick.config.models_inherit_from || ActiveRecord::Base
@@ -666,9 +678,21 @@ class Object
       hmts = nil
       code = +"class #{full_name} < #{base_model.name}\n"
       built_model = Class.new(base_model) do |new_model_class|
-        (schema_module || Object).const_set(model_name.to_sym, new_model_class)
+        (schema_module || Object).const_set((inheritable_name || model_name).to_sym, new_model_class)
+        if inheritable_name
+          new_model_class.define_singleton_method :inherited do |subclass|
+            super(subclass)
+            if subclass.name == model_name
+              puts "#{full_model_name} properly extends from #{full_name}"
+            else
+              puts "should be \"class #{model_name} < #{inheritable_name}\"\n           (not \"#{subclass.name} < #{inheritable_name}\")"
+            end
+          end
+          self.abstract_class = true
+          code << "  self.abstract_class = true\n"
+        end
         # Accommodate singular or camel-cased table names such as "order_detail" or "OrderDetails"
-        code << "  self.table_name = '#{self.table_name = matching}'\n" unless table_name == matching
+        code << "  self.table_name = '#{self.table_name = matching}'\n" if inheritable_name || table_name != matching
 
         # Override models backed by a view so they return true for #is_view?
         # (Dynamically-created controllers and view templates for such models will then act in a read-only way)
@@ -755,9 +779,12 @@ class Object
               options = { through: through.to_sym }
               if relation[:fks].any? { |k, v| v[:assoc_name] == hmt_name }
                 hmt_name = "#{hmt_name.singularize}_#{fk.first[:assoc_name]}"
-                # binding.pry if relation[:fks].any? { |k, v| v[:assoc_name] == hmt_name }
-                options[:class_name] = fk.first[:inverse_table].singularize.camelize
-                options[:foreign_key] = fk.first[:fk].to_sym
+                # Was:
+                # options[:class_name] = fk.first[:inverse_table].singularize.camelize
+                # options[:foreign_key] = fk.first[:fk].to_sym
+                far_assoc = relations[fk.first[:inverse_table]][:fks].find { |_k, v| v[:assoc_name] == fk.last }
+                options[:class_name] = far_assoc.last[:inverse_table].singularize.camelize
+                options[:foreign_key] = far_assoc.last[:fk].to_sym
               end
               options[:source] = fk.last.to_sym unless hmt_name.singularize == fk.last
               code << "  has_many :#{hmt_name}#{options.map { |opt| ", #{opt.first}: #{opt.last.inspect}" }.join}\n"
@@ -880,19 +907,19 @@ class Object
                        { 'url': 'https://{defaultHost}', 'variables': { 'defaultHost': { 'default': 'www.example.com' } } }
                      ]
                    }
-            json['paths'] = relations.each_with_object({}) do |v, s|
-              # next if v.last[:is_view]
-
+            json['paths'] = relations.inject({}) do |s, v|
               s["/api/v1/#{v.first}"] = {
                 'get': {
-                  'summary': 'list #{v.first}',
+                  'summary': "list #{v.first}",
                   'parameters': v.last[:cols].map { |k, v| { 'name' => k, 'schema': { 'type': v.first } } },
                   'responses': { '200': { 'description': 'successful' } }
                 }
               }
+              # next if v.last[:isView]
+
               s["/api/v1/#{v.first}/{id}"] = {
                 'patch': {
-                  'summary': 'update a #{v.first.singularize}',
+                  'summary': "update a #{v.first.singularize}",
                   'parameters': v.last[:cols].reject { |k, v| Brick.config.metadata_columns.include?(k) }.map do |k, v|
                     { 'name' => k, 'schema': { 'type': v.first } }
                   end,
@@ -918,8 +945,8 @@ class Object
                 #     }
                 #   ],
               }
+              s
             end
-            # binding.pry
             render inline: json.to_json, content_type: request.format
             return
           end
@@ -936,7 +963,8 @@ class Object
             return
           end
 
-          order = pk.each_with_object([]) { |pk_part, s| s << "#{model.table_name}.#{pk_part}" }
+          quoted_table_name = model.table_name.split('.').map { |x| "\"#{x}\"" }.join('.')
+          order = pk.each_with_object([]) { |pk_part, s| s << "#{quoted_table_name}.\"#{pk_part}\"" }
           ar_relation = order.present? ? model.order("#{order.join(', ')}") : model.all
           @_brick_params = ar_relation.brick_select(params, (selects = []), (bt_descrip = {}), (hm_counts = {}), (join_array = ::Brick::JoinArray.new))
           # %%% Add custom HM count columns
@@ -951,7 +979,8 @@ class Object
           @_brick_join_array = join_array
         end
 
-        if model&.primary_key
+        is_pk_string = nil
+        if (pk_col = model&.primary_key)
           code << "  def show\n"
           code << (find_by_id = "    id = params[:id]&.split(/[\\/,_]/)
     id = id.first if id.is_a?(Array) && id.length == 1
@@ -959,7 +988,12 @@ class Object
           code << "  end\n"
           self.define_method :show do
             ::Brick.set_db_schema(params)
-            id = params[:id]&.split(/[\/,_]/)
+            id = if model.columns_hash[pk_col]&.type == :string
+                   is_pk_string = true
+                   params[:id]
+                 else
+                   params[:id]&.split(/[\/,_]/)
+                 end
             id = id.first if id.is_a?(Array) && id.length == 1
             instance_variable_set("@#{singular_table_name}".to_sym, model.find(id))
           end
@@ -998,7 +1032,7 @@ class Object
               #   return
               end
 
-              id = params[:id]&.split(/[\/,_]/)
+              id = is_pk_string ? params[:id] : params[:id]&.split(/[\/,_]/)
               id = id.first if id.is_a?(Array) && id.length == 1
               instance_variable_set("@#{singular_table_name}".to_sym, (obj = model.find(id)))
               obj = obj.first if obj.is_a?(Array)
@@ -1024,19 +1058,15 @@ class Object
     end
 
     def _brick_get_hm_assoc_name(relation, hm_assoc)
-      if relation[:hm_counts][hm_assoc[:assoc_name]]&.> 1
-        # binding.pry if (same_name = relation[:fks].find { |x| x.last[:assoc_name] == hm_assoc[:assoc_name] && x.last != hm_assoc }) #&&
-                                    # x.last[:alternate_name] == hm_assoc[:alternate_name] })
-        # relation[:fks].any? { |k, v| v[:assoc_name] == new_alt_name }
+      if (relation[:hm_counts][hm_assoc[:assoc_name]]&.> 1) &&
+         hm_assoc[:alternate_name] != hm_assoc[:inverse][:assoc_name]
         plural = ActiveSupport::Inflector.pluralize(hm_assoc[:alternate_name])
-        # binding.pry if hm_assoc[:assoc_name] == 'issue_issue_duplicates'
         new_alt_name = (hm_assoc[:alternate_name] == name.underscore) ? "#{hm_assoc[:assoc_name].singularize}_#{plural}" : plural
         # uniq = 1
         # while same_name = relation[:fks].find { |x| x.last[:assoc_name] == hm_assoc[:assoc_name] && x.last != hm_assoc }
         #   hm_assoc[:assoc_name] = "#{hm_assoc_name}_#{uniq += 1}"
         # end
         # puts new_alt_name
-        # binding.pry if new_alt_name == 'issue_duplicates'
         # hm_assoc[:assoc_name] = new_alt_name
         [new_alt_name, true]
       else
@@ -1078,9 +1108,11 @@ module ActiveRecord::ConnectionHandling
       # Only for Postgres?  (Doesn't work in sqlite3)
       # puts ActiveRecord::Base.execute_sql("SELECT current_setting('SEARCH_PATH')").to_a.inspect
 
+      is_postgres = nil
       schema_sql = 'SELECT NULL AS table_schema;'
       case ActiveRecord::Base.connection.adapter_name
       when 'PostgreSQL'
+        is_postgres = true
         if (is_multitenant = (multitenancy = ::Brick.config.schema_behavior[:multitenant]) &&
            (sta = multitenancy[:schema_to_analyse]) != 'public')
           ::Brick.default_schema = schema = sta
@@ -1090,12 +1122,14 @@ module ActiveRecord::ConnectionHandling
       when 'Mysql2'
         ::Brick.default_schema = schema = ActiveRecord::Base.connection.current_database
       when 'SQLite'
+        # %%% Retrieve internal ActiveRecord table names like this:
+        # ActiveRecord::Base.internal_metadata_table_name, ActiveRecord::Base.schema_migrations_table_name
         sql = "SELECT m.name AS relation_name, UPPER(m.type) AS table_type,
           p.name AS column_name, p.type AS data_type,
           CASE p.pk WHEN 1 THEN 'PRIMARY KEY' END AS const
         FROM sqlite_master AS m
           INNER JOIN pragma_table_info(m.name) AS p
-        WHERE m.name NOT IN ('ar_internal_metadata', 'schema_migrations')
+        WHERE m.name NOT IN (?, ?)
         ORDER BY m.name, p.cid"
       else
         puts "Unfamiliar with connection adapter #{ActiveRecord::Base.connection.adapter_name}"
@@ -1123,7 +1157,11 @@ module ActiveRecord::ConnectionHandling
         end
       end
 
-      sql ||= "SELECT t.table_schema AS schema, t.table_name AS relation_name, t.table_type,
+      # %%% Retrieve internal ActiveRecord table names like this:
+      # ActiveRecord::Base.internal_metadata_table_name, ActiveRecord::Base.schema_migrations_table_name
+      # For if it's not SQLite -- so this is the Postgres and MySQL version
+      sql ||= "SELECT t.table_schema AS schema, t.table_name AS relation_name, t.table_type,#{"
+          pg_catalog.obj_description((t.table_schema || '.' || t.table_name)::regclass, 'pg_class') AS table_description," if is_postgres}
           c.column_name, c.data_type,
           COALESCE(c.character_maximum_length, c.numeric_precision) AS max_length,
           tc.constraint_type AS const, kcu.constraint_name AS \"key\",
@@ -1144,13 +1182,14 @@ module ActiveRecord::ConnectionHandling
         WHERE t.table_schema NOT IN ('information_schema', 'pg_catalog')#{"
           AND t.table_schema = COALESCE(current_setting('SEARCH_PATH'), 'public')" if schema }
   --          AND t.table_type IN ('VIEW') -- 'BASE TABLE', 'FOREIGN TABLE'
-          AND t.table_name NOT IN ('pg_stat_statements', 'ar_internal_metadata', 'schema_migrations')
+          AND t.table_name NOT IN ('pg_stat_statements', ?, ?)
         ORDER BY 1, t.table_type DESC, c.ordinal_position"
       measures = []
       case ActiveRecord::Base.connection.adapter_name
       when 'PostgreSQL', 'SQLite' # These bring back a hash for each row because the query uses column aliases
         # schema ||= 'public' if ActiveRecord::Base.connection.adapter_name == 'PostgreSQL'
-        ActiveRecord::Base.execute_sql(sql).each do |r|
+        ar_imtn = ActiveRecord.version >= ::Gem::Version.new('5.0') ? ActiveRecord::Base.internal_metadata_table_name : ''
+        ActiveRecord::Base.execute_sql(sql, ActiveRecord::Base.schema_migrations_table_name, ar_imtn).each do |r|
           # If Apartment gem lists the table as being associated with a non-tenanted model then use whatever it thinks
           # is the default schema, usually 'public'.
           schema_name = if ::Brick.config.schema_behavior[:multitenant]
@@ -1161,6 +1200,7 @@ module ActiveRecord::ConnectionHandling
           relation_name = schema_name ? "#{schema_name}.#{r['relation_name']}" : r['relation_name']
           relation = relations[relation_name]
           relation[:isView] = true if r['table_type'] == 'VIEW'
+          relation[:description] = r['table_description'] if r['table_description']
           col_name = r['column_name']
           key = case r['const']
                 when 'PRIMARY KEY'
@@ -1259,11 +1299,25 @@ module ActiveRecord::ConnectionHandling
       end
     end
 
-    puts "\nClasses that can be built from tables:"
-    relations.select { |_k, v| !v.key?(:isView) }.keys.each { |k| puts ActiveSupport::Inflector.singularize(k).camelize }
-    unless (views = relations.select { |_k, v| v.key?(:isView) }).empty?
+    apartment = Object.const_defined?('Apartment') && Apartment
+    tables = []
+    views = []
+    relations.each do |k, v|
+      name_parts = k.split('.')
+      if v.key?(:isView)
+        views
+      else
+        name_parts.shift if apartment && name_parts.length > 1 && name_parts.first == Apartment.default_schema
+        tables
+      end << name_parts.map { |x| x.singularize.camelize }.join('::')
+    end
+    unless tables.empty?
+      puts "\nClasses that can be built from tables:"
+      tables.sort.each { |x| puts x }
+    end
+    unless views.empty?
       puts "\nClasses that can be built from views:"
-      views.keys.each { |k| puts ActiveSupport::Inflector.singularize(k).camelize }
+      views.sort.each { |x| puts x }
     end
 
     ::Brick.load_additional_references if initializer_loaded
@@ -1306,7 +1360,8 @@ module Brick
       end
       # %%% Temporary schema patch
       for_tbl = fk[1]
-      fk[0] = Apartment.default_schema if Object.const_defined?('Apartment') && Apartment.excluded_models.include?(for_tbl.singularize.camelize)
+      apartment = Object.const_defined?('Apartment') && Apartment
+      fk[0] = Apartment.default_schema if apartment && apartment.excluded_models.include?(for_tbl.singularize.camelize)
       fk[1] = "#{fk[0]}.#{fk[1]}" if fk[0] # && fk[0] != ::Brick.default_schema
       bts = (relation = relations.fetch(fk[1], nil))&.fetch(:fks) { relation[:fks] = {} }
 
@@ -1321,7 +1376,7 @@ module Brick
                         is_schema = if ::Brick.config.schema_behavior[:multitenant]
                                       # If Apartment gem lists the primary table as being associated with a non-tenanted model
                                       # then use 'public' schema for the primary table
-                                      if Object.const_defined?('Apartment') && Apartment.excluded_models.include?(fk[4].singularize.camelize)
+                                      if apartment && apartment&.excluded_models.include?(fk[4].singularize.camelize)
                                         fk[3] = Apartment.default_schema
                                         true
                                       end
@@ -1398,12 +1453,11 @@ module Brick
         assoc_hm[:alternate_name] = "#{assoc_hm[:alternate_name]}_#{bt_assoc_name}" unless assoc_hm[:alternate_name] == bt_assoc_name
         assoc_hm[:inverse] = assoc_bt
       else
-        inv_tbl = if ::Brick.config.schema_behavior[:multitenant] && Object.const_defined?('Apartment') && fk[0] == Apartment.default_schema
+        inv_tbl = if ::Brick.config.schema_behavior[:multitenant] && apartment && fk[0] == Apartment.default_schema
                     for_tbl
                   else
                     fk[1]
                   end
-                  # binding.pry if inv_tbl == 'issue_issue_duplicates' # inverse_table goofed?
         assoc_hm = hms[hm_cnstr_name] = { is_bt: false, fk: fk[2], assoc_name: for_tbl.pluralize, alternate_name: bt_assoc_name,
                                           inverse_table: inv_tbl, inverse: assoc_bt }
         assoc_hm[:polymorphic] = true if is_polymorphic

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

@@ -124,8 +124,15 @@ module Brick
               schema_options = ::Brick.db_schemas.keys.each_with_object(+'') { |v, s| s << "<option value=\"#{v}\">#{v}</option>" }.html_safe
               # %%% If we are not auto-creating controllers (or routes) then omit by default, and if enabled anyway, such as in a development
               # environment or whatever, then get either the controllers or routes list instead
-              table_options = (::Brick.relations.keys - ::Brick.config.exclude_tables).sort
-                              .each_with_object(+'') { |v, s| s << "<option value=\"#{v.underscore.gsub('.', '/').pluralize}\">#{v}</option>" }.html_safe
+              apartment_default_schema = ::Brick.config.schema_behavior[:multitenant] && Object.const_defined?('Apartment') && Apartment.default_schema
+              table_options = (::Brick.relations.keys - ::Brick.config.exclude_tables).map do |tbl|
+                                if (tbl_parts = tbl.split('.')).first == apartment_default_schema
+                                  tbl = tbl_parts.last
+                                end
+                                tbl
+                              end.sort.each_with_object(+'') do |v, s|
+                                s << "<option value=\"#{v.underscore.gsub('.', '/').pluralize}\">#{v}</option>"
+                              end.html_safe
               css = +"<style>
 #dropper {
   background-color: #eee;
@@ -209,12 +216,17 @@ input[type=submit] {
 <% def is_bcrypt?(val)
   val.is_a?(String) && val.length == 60 && val.start_with?('$2a$')
 end
-def hide_bcrypt(val)
+def hide_bcrypt(val, max_len = 200)
   if is_bcrypt?(val)
     '(hidden)'
-  elsif val.is_a?(String) && val.encoding.name != 'UTF-8'
-    val[0..1000].force_encoding('UTF-8')
   else
+    if val.is_a?(String)
+      if val.length > max_len
+        val = val[0...max_len]
+        val << '...'
+      end
+      val.force_encoding('UTF-8') unless val.encoding.name == 'UTF-8'
+    end
     val
   end
 end %>"
@@ -238,46 +250,51 @@ end %>"
                 poly_cols = #{poly_cols.inspect} %>"
               end
 
-              # %%% When doing schema select, if there's an ID then remove it, or if we're on a new page go to index
+              # %%% When doing schema select, if we're on a new page go to index
               script = "<script>
 var schemaSelect = document.getElementById(\"schema\");
+var tblSelect = document.getElementById(\"tbl\");
 var brickSchema;
-if (schemaSelect) {
-  brickSchema = changeout(location.href, \"_brick_schema\");
-  if (brickSchema) {
-    [... document.getElementsByTagName(\"A\")].forEach(function (a) { a.href = changeout(a.href, \"_brick_schema\", brickSchema); });
+
+// This PageTransitionEvent fires when the page first loads, as well as after any other history
+// transition such as when using the browser's Back and Forward buttons.
+window.addEventListener(\"pageshow\", function() {
+  if (schemaSelect) { // First drop-down is only present if multitenant
+    brickSchema = changeout(location.href, \"_brick_schema\");
+    if (brickSchema) {
+      [... document.getElementsByTagName(\"A\")].forEach(function (a) { a.href = changeout(a.href, \"_brick_schema\", brickSchema); });
+    }
+    schemaSelect.value = brickSchema || \"public\";
+    schemaSelect.focus();
+    schemaSelect.addEventListener(\"change\", function () {
+      // If there's an ID then remove it (trim after selected table)
+      location.href = changeout(location.href, \"_brick_schema\", this.value, tblSelect.value);
+    });
   }
-  schemaSelect.value = brickSchema || \"public\";
-  schemaSelect.focus();
-  schemaSelect.addEventListener(\"change\", function () {
-    location.href = changeout(location.href, \"_brick_schema\", this.value);
-  });
-}
-[... document.getElementsByTagName(\"FORM\")].forEach(function (form) {
-  if (brickSchema)
-    form.action = changeout(form.action, \"_brick_schema\", brickSchema);
-  form.addEventListener('submit', function (ev) {
-    [... ev.target.getElementsByTagName(\"SELECT\")].forEach(function (select) {
-      if (select.value === \"^^^brick_NULL^^^\")
-        select.value = null;
+  [... document.getElementsByTagName(\"FORM\")].forEach(function (form) {
+    if (brickSchema)
+      form.action = changeout(form.action, \"_brick_schema\", brickSchema);
+    form.addEventListener('submit', function (ev) {
+      [... ev.target.getElementsByTagName(\"SELECT\")].forEach(function (select) {
+        if (select.value === \"^^^brick_NULL^^^\")
+          select.value = null;
+      });
+      return true;
     });
-    return true;
   });
-});
 
-var tblSelect = document.getElementById(\"tbl\");
-if (tblSelect) {
-  tblSelect.value = changeout(location.href)[0];
-  if (tblSelect.selectedIndex < 0) tblSelect.value = changeout(location.href)[1];
-  tblSelect.addEventListener(\"change\", function () {
-    var lhr = changeout(location.href, null, this.value);
-    if (brickSchema)
-      lhr = changeout(lhr, \"_brick_schema\", schemaSelect.value);
-    location.href = lhr;
-  });
-}
+  if (tblSelect) { // Always present
+    tblSelect.value = changeout(location.href)[schemaSelect ? 1 : 0];
+    tblSelect.addEventListener(\"change\", function () {
+      var lhr = changeout(location.href, null, this.value);
+      if (brickSchema)
+        lhr = changeout(lhr, \"_brick_schema\", schemaSelect.value);
+      location.href = lhr;
+    });
+  }
+});
 
-function changeout(href, param, value) {
+function changeout(href, param, value, trimAfter) {
   var hrefParts = href.split(\"?\");
   if (param === undefined || param === null) {
     hrefParts = hrefParts[0].split(\"://\");
@@ -288,6 +305,11 @@ function changeout(href, param, value) {
     else
       return hrefParts[0] + \"://\" + pathParts[0] + \"/\" + value;
   }
+  if (trimAfter) {
+    var pathParts = hrefParts[0].split(\"/\");
+    while (pathParts.lastIndexOf(trimAfter) != pathParts.length - 1) pathParts.pop();
+    hrefParts[0] = pathParts.join(\"/\");
+  }
   var params = hrefParts.length > 1 ? hrefParts[1].split(\"&\") : [];
   params = params.reduce(function (s, v) { var parts = v.split(\"=\"); s[parts[0]] = parts[1]; return s; }, {});
   if (value === undefined) return params[param];
@@ -353,7 +375,6 @@ function changeout(href, param, value) {
 
   async function updateSignInStatus(isSignedIn) {
     if (isSignedIn) {
-      console.log(\"turds!\");
       await gapi.client.sheets.spreadsheets.create({
         properties: {
           title: #{table_name.inspect},
@@ -394,18 +415,19 @@ function changeout(href, param, value) {
                          end
 # %%% Instead of our current "for Janet Leverling (Employee)" kind of link we previously had this code that did a "where x = 123" thing:
 #   (where <%= @_brick_params.each_with_object([]) { |v, s| s << \"#\{v.first\} = #\{v.last.inspect\}\" }.join(', ') %>)
-"#{css}
+x = "#{css}
 <p style=\"color: green\"><%= notice %></p>#{"
 <select id=\"schema\">#{schema_options}</select>" if ::Brick.config.schema_behavior[:multitenant] && ::Brick.db_schemas.length > 1}
 <select id=\"tbl\">#{table_options}</select>
-<h1>#{model_plural = model_name.pluralize}</h1>#{template_link}
-
-<% if @_brick_params&.present? %>
+<h1>#{model_plural = model_name.pluralize}</h1>#{template_link}<%
+   if (relation = Brick.relations[#{model_name}.table_name])[:description] %><%=
+     relation.fetch(:description, nil) %><br><%
+   end
+   if @_brick_params&.present? %>
   <% if @_brick_params.length == 1 # %%% Does not yet work with composite keys
        k, id = @_brick_params.first
        id = id.first if id.is_a?(Array) && id.length == 1
        origin = (key_parts = k.split('.')).length == 1 ? #{model_name} : #{model_name}.reflect_on_association(key_parts.first).klass
-      #  binding.pry
        if (destination_fk = Brick.relations[origin.table_name][:fks].values.find { |fk| puts fk.inspect; fk[:fk] == key_parts.last }) &&
           (obj = (destination = origin.reflect_on_association(destination_fk[:assoc_name])&.klass)&.find(id)) %>
          <h3>for <%= link_to \"#{"#\{obj.brick_descrip\} (#\{destination.name\})\""}, send(\"#\{destination.name.underscore.tr('/', '_')\}_path\".to_sym, id) %></h3><%
@@ -415,19 +437,23 @@ function changeout(href, param, value) {
 <% end %>
 <table id=\"#{table_name}\">
   <thead><tr>#{'<th></th>' if pk.present?}
-  <% @#{table_name}.columns.map(&:name).each do |col| %>
-    <% next if (#{(pk || []).inspect}.include?(col) && #{model_name}.column_for_attribute(col).type == :integer && !bts.key?(col)) ||
-               ::Brick.config.metadata_columns.include?(col) || poly_cols.include?(col) %>
-    <th>
-    <% if (bt = bts[col]) %>
+  <% col_order = []
+     @#{table_name}.columns.each do |col|
+       col_name = col.name
+       next if (#{(pk || []).inspect}.include?(col_name) && col.type == :integer && !bts.key?(col_name)) ||
+               ::Brick.config.metadata_columns.include?(col_name) || poly_cols.include?(col_name)
+
+       col_order << col_name %>
+    <th<%= \" title = \\\"#\{col.comment}\\\"\".html_safe unless col.comment.blank? %>><%
+       if (bt = bts[col_name]) %>
          BT <%
          bt[1].each do |bt_pair| %><%=
            bt_pair.first.bt_link(bt.first) %> <%
          end %><%
        else %><%=
-         col %><%
-       end %>
-    </th>
+         col_name %><%
+       end
+  %></th>
   <% end %>
   <%# Consider getting the name from the association -- h.first.name -- if a more \"friendly\" alias should be used for a screwy table name %>
   #{hms_headers.map { |h| "<th>#{h[1]} <%= link_to('#{h[2]}', #{h.first.klass.name.underscore.tr('/', '_').pluralize}_path) %></th>\n" }.join}
@@ -437,12 +463,10 @@ function changeout(href, param, value) {
   <% @#{table_name}.each do |#{obj_name}| %>
   <tr>#{"
     <td><%= link_to '⇛', #{path_obj_name}_path(#{obj_pk}), { class: 'big-arrow' } %></td>" if obj_pk}
-    <% #{obj_name}.attributes.each do |k, val| %>
-      <% next if (#{(obj_pk || []).inspect}.include?(k) && #{model_name}.column_for_attribute(k).type == :integer && !bts.key?(k)) ||
-                 ::Brick.config.metadata_columns.include?(k) || poly_cols.include?(k) || k.start_with?('_brfk_') || (k.start_with?('_br_') && (k.length == 63 || k.end_with?('_ct'))) %>
+    <% col_order.each do |col_name|
+         val = #{obj_name}.attributes[col_name] %>
       <td>
-      <% if (bt = bts[k]) %>
-        <%# binding.pry # Postgres column names are limited to 63 characters %>
+      <% if (bt = bts[col_name]) %>
         <% if bt[2] # Polymorphic?
              bt_class = #{obj_name}.send(\"#\{bt.first\}_type\")
              base_class = (::Brick.existing_stis[bt_class] || bt_class).constantize.base_class.name.underscore
@@ -451,6 +475,7 @@ function changeout(href, param, value) {
                            send(\"#\{base_class\}_path\".to_sym, poly_id)) if poly_id %><%
            else
              bt_txt = (bt_class = bt[1].first.first).brick_descrip(
+               # 0..62 because Postgres column names are limited to 63 characters
                #{obj_name}, (descrips = @_brick_bt_descrip[bt.first][bt_class])[0..-2].map { |z| #{obj_name}.send(z.last[0..62]) }, (bt_id_col = descrips.last)
              )
              bt_id = #{obj_name}.send(*bt_id_col) if bt_id_col&.present? %>
@@ -470,13 +495,18 @@ function changeout(href, param, value) {
 
 #{"<hr><%= link_to \"New #{obj_name}\", new_#{path_obj_name}_path %>" unless @_brick_model.is_view?}
 #{script}"
+puts x
+x
                        when 'show', 'update'
 "#{css}
 <p style=\"color: green\"><%= notice %></p>#{"
 <select id=\"schema\">#{schema_options}</select>" if ::Brick.config.schema_behavior[:multitenant] && ::Brick.db_schemas.length > 1}
 <select id=\"tbl\">#{table_options}</select>
-<h1>#{model_name}: <%= (obj = @#{obj_name})&.brick_descrip || controller_name %></h1>
-<%= link_to '(See all #{obj_name.pluralize})', #{path_obj_name.pluralize}_path %>
+<h1>#{model_name}: <%= (obj = @#{obj_name})&.brick_descrip || controller_name %></h1><%
+if (relation = Brick.relations[#{model_name}.table_name])[:description] %><%=
+  relation.fetch(:description, nil) %><br><%
+end
+%><%= link_to '(See all #{obj_name.pluralize})', #{path_obj_name.pluralize}_path %>
 <% if obj %>
   <%= # path_options = [obj.#{pk}]
     # path_options << { '_brick_schema':  } if
@@ -484,11 +514,12 @@ function changeout(href, param, value) {
     form_for(obj.becomes(#{model_name})) do |f| %>
   <table>
   <% has_fields = false
-    @#{obj_name}.attributes.each do |k, val| %>
+    @#{obj_name}.attributes.each do |k, val|
+      col = #{model_name}.columns_hash[k] %>
     <tr>
     <% next if (#{(pk || []).inspect}.include?(k) && !bts.key?(k)) ||
                ::Brick.config.metadata_columns.include?(k) %>
-    <th class=\"show-field\">
+    <th class=\"show-field\"<%= \" title = \\\"#\{col.comment}\\\"\".html_safe unless col.comment.blank? %>>
     <% has_fields = true
       if (bt = bts[k])
         # Add a final member in this array with descriptive options to be used in <select> drop-downs
@@ -533,7 +564,7 @@ function changeout(href, param, value) {
     <% else case #{model_name}.column_for_attribute(k).type
       when :string, :text %>
         <% if is_bcrypt?(val) # || .readonly? %>
-          <%= hide_bcrypt(val) %>
+          <%= hide_bcrypt(val, 1000) %>
         <% else %>
           <div class=\"wide-input\"><%= f.text_field k.to_sym %></div>
         <% end %>
@@ -566,7 +597,7 @@ function changeout(href, param, value) {
       s << "<table id=\"#{hm_name}\">
         <tr><th>#{hm[3]}</th></tr>
         <% collection = @#{obj_name}.#{hm_name}
-        collection = collection.is_a?(ActiveRecord::Associations::CollectionProxy) ? collection.order(#{pk.inspect}) : [collection]
+        collection = collection.is_a?(ActiveRecord::Associations::CollectionProxy) ? collection.order(#{pk.inspect}) : [collection].compact
         if collection.empty? %>
           <tr><td>(none)</td></tr>
         <% else %>
@@ -600,6 +631,7 @@ function changeout(href, param, value) {
 
         # Just in case it hadn't been done previously when we tried to load the brick initialiser,
         # go make sure we've loaded additional references (virtual foreign keys and polymorphic associations).
+        # (This should only happen if for whatever reason the initializer file was not exactly config/initializers/brick.rb.)
         ::Brick.load_additional_references
       end
     end

data/lib/brick/version_number.rb

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

data/lib/brick.rb

@@ -1,25 +1,6 @@
 # frozen_string_literal: true
 
-require 'active_record/version'
-
-# ActiveRecord before 4.0 didn't have #version
-unless ActiveRecord.respond_to?(:version)
-  module ActiveRecord
-    def self.version
-      ::Gem::Version.new(ActiveRecord::VERSION::STRING)
-    end
-  end
-end
-
-# In ActiveSupport older than 5.0, the duplicable? test tries to new up a BigDecimal,
-# and Ruby 2.6 and later deprecates #new.  This removes the warning from BigDecimal.
-require 'bigdecimal'
-if (ruby_version = ::Gem::Version.new(RUBY_VERSION)) >= ::Gem::Version.new('2.6') &&
-   ActiveRecord.version < ::Gem::Version.new('5.0')
-  def BigDecimal.new(*args, **kwargs)
-    BigDecimal(*args, **kwargs)
-  end
-end
+require 'brick/compatibility'
 
 # Allow ActiveRecord 4.0 and 4.1 to work with newer Ruby (>= 2.4) by avoiding a "stack level too deep"
 # error when ActiveSupport tries to smarten up Numeric by messing with Fixnum and Bignum at the end of:
@@ -45,8 +26,8 @@ end
 require 'brick/util'
 
 # Allow ActiveRecord < 3.2 to work with Ruby 2.7 and later
-if ActiveRecord.version < ::Gem::Version.new('3.2') &&
-   ruby_version >= ::Gem::Version.new('2.7')
+if (ruby_version = ::Gem::Version.new(RUBY_VERSION)) >= ::Gem::Version.new('2.7') &&
+   ActiveRecord.version < ::Gem::Version.new('3.2')
   # Remove circular reference for "now"
   ::Brick::Util._patch_require(
     'active_support/values/time_zone.rb', '/activesupport',
@@ -132,7 +113,6 @@ module Brick
       associatives = hms.each_with_object({}) do |hmt, s|
         if (through = hmt.last.options[:through])
           skip_hms[through] = nil
-          # binding.pry if hmt.first == :issue_issues
           s[hmt.first] = hms[through] # End up with a hash of HMT names pointing to join-table associations
         elsif hmt.last.inverse_of.nil?
           puts "SKIPPING #{hmt.last.name.inspect}"

data/lib/generators/brick/install_generator.rb

@@ -18,7 +18,8 @@ module Brick
     desc 'Generates an initializer file for configuring Brick'
 
     def create_initializer_file
-      unless File.exist?(filename = 'config/initializers/brick.rb')
+      is_brick_file = File.exist?(filename = 'config/initializers/brick.rb')
+      if is_brick_file && ::Brick.config.schema_behavior[:multitenant] || !is_brick_file
         # See if we can make suggestions for additional_references and polymorphic associations
         resembles_fks = Hash.new { |h, k| h[k] = [] }
         possible_polymorphics = {}
@@ -223,7 +224,10 @@ module Brick
 # # Database schema to use when analysing existing data, such as deriving a list of polymorphic classes in the case that
 # # it wasn't originally specified.
 # Brick.schema_behavior = :namespaced
-# Brick.schema_behavior = { multitenant: { schema_to_analyse: 'engineering' } }
+#{Brick.config.schema_behavior ? "Brick.schema_behavior = { multitenant: { schema_to_analyse: #{
+  Brick.config.schema_behavior[:multitenant][:schema_to_analyse].inspect}" :
+"# Brick.schema_behavior = { multitenant: { schema_to_analyse: 'engineering'"
+} } }
 
 # # Polymorphic associations are set up by providing a model name and polymorphic association name#{poly}
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: brick
 version: !ruby/object:Gem::Version
-  version: 1.0.33
+  version: 1.0.36
 platform: ruby
 authors:
 - Lorin Thwaits
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-21 00:00:00.000000000 Z
+date: 2022-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -214,6 +214,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/brick.rb
+- lib/brick/compatibility.rb
 - lib/brick/config.rb
 - lib/brick/extensions.rb
 - lib/brick/frameworks/cucumber.rb