brick 1.0.40 → 1.0.41

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf29d4af64b65c01ae68df45762b816403a1ebc0035e1221552f249ff3ba2ce9
-  data.tar.gz: 076cdb672d7c2137cc74421467d72491e9ea89751fab32015f427158fc367b45
+  metadata.gz: 4455ebfde80fe8a4bd51f19438171abae2614e0740adba98ab39184952843a01
+  data.tar.gz: d5157748c37564156fc2f823cc3c4753b536491aa2cf81175683c8241fb2a2b9
 SHA512:
-  metadata.gz: ce17038567ddd9d6d9d9dce6eb71fd50612d167b56351898ef9b3f9441d1a7ef3ee4ec3a57f3f24e613829e6c8a2f59517fc0d4e9266f11166b92821310b0c06
-  data.tar.gz: 6a7bb38b009853594a8bf1ab28489bbc92d6300fcd0f8497c7950e81c6a62a4c6da2bd65840f93bd7afea40153727cb93914529120ecf9b0dceca39b21fef880
+  metadata.gz: 2a649c78c3e597004b36d6c33f1cd812a712fcfd561dfe94994de28e489de81508f9fea30b0896b4447c4ce0ffd0877fb8c5d7e20a34011212fd797a3cbd02ca
+  data.tar.gz: 58ecdc4acb12abb77169a8fda8cb8146fceaedeacdf77f1cec992008f98b05412e3a9e2f5b6a9721880caa710ba94792a187d3587248eea4d9946d309c91be56

data/lib/brick/config.rb

@@ -205,5 +205,10 @@ module Brick
     def not_nullables=(columns)
       @mutex.synchronize { @not_nullables = columns }
     end
+
+    # Add a special page to show references to non-existent records ("orphans")
+    def add_orphans
+      true
+    end
   end
 end

data/lib/brick/extensions.rb

@@ -415,14 +415,16 @@ module ActiveRecord
       hm_counts.each do |k, hm|
         associative = nil
         count_column = if hm.options[:through]
-                         fk_col = (associative = associatives[hm.name]).foreign_key
-                         hm.foreign_key
+                         fk_col = (associative = associatives[hm.name])&.foreign_key
+                         hm.foreign_key if fk_col
                        else
                          fk_col = hm.foreign_key
                          poly_type = hm.inverse_of.foreign_type if hm.options.key?(:as)
                          pk = hm.klass.primary_key
                          (pk.is_a?(Array) ? pk.first : pk) || '*'
                        end
+        next unless count_column # %%% Would be able to remove this when multiple foreign keys to same destination becomes bulletproof
+
         tbl_alias = "_br_#{hm.name}"
         pri_tbl = hm.active_record
         on_clause = []
@@ -565,7 +567,9 @@ Module.class_exec do
                full_class_name = +''
                full_class_name << "::#{self.name}" unless self == Object
                full_class_name << "::#{plural_class_name.underscore.singularize.camelize}"
-               if (plural_class_name == 'BrickSwagger' || model = self.const_get(full_class_name))
+               if (plural_class_name == 'BrickSwagger' ||
+                  (::Brick.config.add_orphans && plural_class_name == 'BrickGem') ||
+                  model = self.const_get(full_class_name))
                  # if it's a controller and no match or a model doesn't really use the same table name, eager load all models and try to find a model class of the right name.
                  Object.send(:build_controller, self, class_name, plural_class_name, model, relations)
                end
@@ -897,6 +901,16 @@ class Object
       built_controller = Class.new(ActionController::Base) do |new_controller_class|
         (namespace || Object).const_set(class_name.to_sym, new_controller_class)
 
+        # Brick-specific pages
+        if plural_class_name == 'BrickGem'
+          self.define_method :orphans do
+            instance_variable_set(:@orphans, ::Brick.find_orphans(::Brick.set_db_schema(params)))
+            puts "BrickGemController #{action_name} #{params.inspect}"
+            # render inline: 'Brick gem!'
+          end
+          return [new_controller_class, code + ' # BrickGem controller!']
+        end
+
         unless (is_swagger = plural_class_name == 'BrickSwagger') # && request.format == :json)
           code << "  def index\n"
           code << "    @#{table_name} = #{model.name}#{pk&.present? ? ".order(#{pk.inspect})" : '.all'}\n"
@@ -1475,5 +1489,72 @@ module Brick
       end
       assoc_bt[:inverse] = assoc_hm
     end
+
+    # Locate orphaned records
+    def find_orphans(multi_schema)
+      is_default_schema = multi_schema&.==(Apartment.default_schema)
+      relations.each_with_object([]) do |v, s|
+        frn_tbl = v.first
+        next if (relation = v.last).key?(:isView) || config.exclude_tables.include?(frn_tbl) ||
+                !(for_pk = (relation[:pkey].values.first&.first))
+
+        is_default_frn_schema = !is_default_schema && multi_schema &&
+                                ((frn_parts = frn_tbl.split('.')).length > 1 && frn_parts.first)&.==(Apartment.default_schema)
+        relation[:fks].select { |_k, assoc| assoc[:is_bt] }.each do |_k, bt|
+          begin
+            if bt.key?(:polymorphic)
+              pri_pk = for_pk
+              pri_tables = Brick.config.polymorphics["#{frn_tbl}.#{bt[:fk]}"]
+                                .each_with_object(Hash.new { |h, k| h[k] = [] }) do |pri_class, s|
+                s[Object.const_get(pri_class).table_name] << pri_class
+              end
+              fk_id_col = "#{bt[:fk]}_id"
+              fk_type_col = "#{bt[:fk]}_type"
+              selects = []
+              pri_tables.each do |pri_tbl, pri_types|
+                # Skip if database is multitenant, we're not focused on "public", and the foreign and primary tables
+                # are both in the "public" schema
+                next if is_default_frn_schema &&
+                        ((pri_parts = pri_tbl&.split('.'))&.length > 1 && pri_parts.first)&.==(Apartment.default_schema)
+
+                selects << "SELECT '#{pri_tbl}' AS pri_tbl, frn.#{fk_type_col} AS pri_type, frn.#{fk_id_col} AS pri_id, frn.#{for_pk} AS frn_id
+                FROM #{frn_tbl} AS frn
+                  LEFT OUTER JOIN #{pri_tbl} AS pri ON pri.#{pri_pk} = frn.#{fk_id_col}
+                WHERE frn.#{fk_type_col} IN (#{
+                  pri_types.map { |pri_type| "'#{pri_type}'" }.join(', ')
+                }) AND frn.#{bt[:fk]}_id IS NOT NULL AND pri.#{pri_pk} IS NULL\n"
+              end
+              ActiveRecord::Base.execute_sql(selects.join("UNION ALL\n")).each do |o|
+                entry = [frn_tbl, o['frn_id'], o['pri_type'], o['pri_id'], fk_id_col]
+                entry << o['pri_tbl'] if (pri_class = Object.const_get(o['pri_type'])) != pri_class.base_class
+                s << entry
+              end
+            else
+              # Skip if database is multitenant, we're not focused on "public", and the foreign and primary tables
+              # are both in the "public" schema
+              pri_tbl = bt.key?(:inverse_table) && bt[:inverse_table]
+              next if is_default_frn_schema &&
+                      ((pri_parts = pri_tbl&.split('.'))&.length > 1 && pri_parts.first)&.==(Apartment.default_schema)
+
+              pri_pk = relations[pri_tbl].fetch(:pkey, nil)&.values&.first&.first ||
+                       _class_pk(pri_tbl, multi_schema)
+              ActiveRecord::Base.execute_sql(
+                "SELECT frn.#{bt[:fk]} AS pri_id, frn.#{for_pk} AS frn_id
+                FROM #{frn_tbl} AS frn
+                  LEFT OUTER JOIN #{pri_tbl} AS pri ON pri.#{pri_pk} = frn.#{bt[:fk]}
+                WHERE frn.#{bt[:fk]} IS NOT NULL AND pri.#{pri_pk} IS NULL
+                ORDER BY 1, 2"
+              ).each { |o| s << [frn_tbl, o['frn_id'], pri_tbl, o['pri_id'], bt[:fk]] }
+            end
+          rescue StandardError => err
+            puts "Strange -- #{err.inspect}"
+          end
+        end
+      end
+    end
+
+    def _class_pk(dotted_name, multitenant)
+      Object.const_get((multitenant ? [dotted_name.split('.').last] : dotted_name.split('.')).map { |nm| "::#{nm.singularize.camelize}" }.join).primary_key
+    end
   end
 end

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

@@ -53,7 +53,9 @@ module Brick
             # Used by Rails 5.0 and above
             alias :_brick_template_exists? :template_exists?
             def template_exists?(*args, **options)
-              _brick_template_exists?(*args, **options) || set_brick_model(args)
+              (::Brick.config.add_orphans && args.first == 'orphans') ||
+              _brick_template_exists?(*args, **options) ||
+              set_brick_model(args)
             end
 
             def set_brick_model(find_args)
@@ -88,44 +90,55 @@ module Brick
               unless (model_name = (
                        @_brick_model ||
                        (ActionView.version < ::Gem::Version.new('5.0') && args[1].is_a?(Array) ? set_brick_model(args) : nil)
-                     )&.name)
+                     )&.name) ||
+                     (is_orphans = ::Brick.config.add_orphans && args[0..1] == ['orphans', ['brick_gem']])
                 return _brick_find_template(*args, **options)
               end
 
-              pk = @_brick_model._brick_primary_key(::Brick.relations.fetch(model_name, nil))
-              obj_name = model_name.split('::').last.underscore
-              path_obj_name = model_name.underscore.tr('/', '_')
-              table_name = obj_name.pluralize
-              template_link = nil
-              bts, hms, associatives = ::Brick.get_bts_and_hms(@_brick_model) # This gets BT and HM and also has_many :through (HMT)
-              hms_columns = [] # Used for 'index'
-              skip_klass_hms = ::Brick.config.skip_index_hms[model_name] || {}
-              hms_headers = hms.each_with_object([]) do |hm, s|
-                hm_stuff = [(hm_assoc = hm.last), "H#{hm_assoc.macro == :has_one ? 'O' : 'M'}#{'T' if hm_assoc.options[:through]}", (assoc_name = hm.first)]
-                hm_fk_name = if hm_assoc.options[:through]
-                               associative = associatives[hm_assoc.name]
-                               "'#{associative.name}.#{associative.foreign_key}'"
-                             else
-                               hm_assoc.foreign_key
-                             end
-                if args.first == 'index'
-                  hms_columns << if hm_assoc.macro == :has_many
-                                   set_ct = if skip_klass_hms.key?(assoc_name.to_sym)
-                                              'nil'
-                                            else
-                                              # Postgres column names are limited to 63 characters
-                                              attrib_name = "_br_#{assoc_name}_ct"[0..62]
-                                              "#{obj_name}.#{attrib_name} || 0"
-                                            end
+              unless is_orphans
+                pk = @_brick_model._brick_primary_key(::Brick.relations.fetch(model_name, nil))
+                obj_name = model_name.split('::').last.underscore
+                path_obj_name = model_name.underscore.tr('/', '_')
+                table_name = obj_name.pluralize
+                template_link = nil
+                bts, hms, associatives = ::Brick.get_bts_and_hms(@_brick_model) # This gets BT and HM and also has_many :through (HMT)
+                hms_columns = [] # Used for 'index'
+                skip_klass_hms = ::Brick.config.skip_index_hms[model_name] || {}
+                hms_headers = hms.each_with_object([]) do |hm, s|
+                  hm_stuff = [(hm_assoc = hm.last), "H#{hm_assoc.macro == :has_one ? 'O' : 'M'}#{'T' if hm_assoc.options[:through]}", (assoc_name = hm.first)]
+                  hm_fk_name = if hm_assoc.options[:through]
+                                associative = associatives[hm_assoc.name]
+                                associative && "'#{associative.name}.#{associative.foreign_key}'"
+                              else
+                                hm_assoc.foreign_key
+                              end
+                  if args.first == 'index'
+                    hms_columns << if hm_assoc.macro == :has_many
+                                     set_ct = if skip_klass_hms.key?(assoc_name.to_sym)
+                                                'nil'
+                                              else
+                                                # Postgres column names are limited to 63 characters
+                                                attrib_name = "_br_#{assoc_name}_ct"[0..62]
+                                                "#{obj_name}.#{attrib_name} || 0"
+                                              end
+                                     if hm_fk_name
 "<%= ct = #{set_ct}
      link_to \"#\{ct || 'View'\} #{assoc_name}\", #{hm_assoc.klass.name.underscore.tr('/', '_').pluralize}_path({ #{path_keys(hm_assoc, hm_fk_name, obj_name, pk)} }) unless ct&.zero? %>\n"
-                                 else # has_one
+                                     else
+"#{assoc_name}\n"
+                                     end
+                                   else # has_one
 "<%= obj = #{obj_name}.#{hm.first}; link_to(obj.brick_descrip, obj) if obj %>\n"
-                                 end
-                elsif args.first == 'show'
-                  hm_stuff << "<%= link_to '#{assoc_name}', #{hm_assoc.klass.name.underscore.tr('/', '_').pluralize}_path({ #{path_keys(hm_assoc, hm_fk_name, "@#{obj_name}", pk)} }) %>\n"
+                                   end
+                  elsif args.first == 'show'
+                    hm_stuff << if hm_fk_name
+                                  "<%= link_to '#{assoc_name}', #{hm_assoc.klass.name.underscore.tr('/', '_').pluralize}_path({ #{path_keys(hm_assoc, hm_fk_name, "@#{obj_name}", pk)} }) %>\n"
+                                else
+                                  assoc_name
+                                end
+                  end
+                  s << hm_stuff
                 end
-                s << hm_stuff
               end
 
               schema_options = ::Brick.db_schemas.keys.each_with_object(+'') { |v, s| s << "<option value=\"#{v}\">#{v}</option>" }.html_safe
@@ -140,6 +153,7 @@ module Brick
                               end.sort.each_with_object(+'') do |v, s|
                                 s << "<option value=\"#{v.underscore.gsub('.', '/').pluralize}\">#{v}</option>"
                               end.html_safe
+              table_options << '<option value="brick_orphans">(Orphans)</option>'.html_safe if is_orphans
               css = +"<style>
 #dropper {
   background-color: #eee;
@@ -507,7 +521,13 @@ if (headerTop) {
   %></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>" }.join
+  %>#{hms_headers.map do |h|
+        if h.first.options[:through] && !h.first.through_reflection
+    "<th>#{h[1]} #{h[2]} %></th>"
+        else
+    "<th>#{h[1]} <%= link_to('#{h[2]}', #{h.first.klass.name.underscore.tr('/', '_').pluralize}_path) %></th>"
+        end
+      end.join
   }</tr></thead>
 
   <tbody>
@@ -547,6 +567,22 @@ if (headerTop) {
 
 #{"<hr><%= link_to \"New #{obj_name}\", new_#{path_obj_name}_path %>" unless @_brick_model.is_view?}
 #{script}"
+                       when 'orphans'
+                         if is_orphans
+"#{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>Orphans<%= \" for #\{}\" if false %></h1>
+<% @orphans.each do |o|
+  via = \" (via #\{o[4]})\" unless \"#\{o[2].split('.').last.underscore.singularize}_id\" == o[4] %>
+  <a href=\"/<%= o[0].split('.').last %>/<%= o[1] %>\">
+    <%= \"#\{o[0]} #\{o[1]} refers#\{via} to non-existent #\{o[2]} #\{o[3]}#\{\" (in table \\\"#\{o[5]}\\\")\" if o[5]}\" %>
+  </a><br>
+<% end %>
+#{script}"
+                         end
+
                        when 'show', 'update'
 "#{css}
 <p style=\"color: green\"><%= notice %></p>#{"
@@ -646,6 +682,8 @@ end
   <% end %>
 
   #{hms_headers.each_with_object(+'') do |hm, s|
+    next if hm.first.options[:through] && !hm.first.through_reflection
+
     if (pk = hm.first.klass.primary_key)
       hm_singular_name = (hm_name = hm.first.name.to_s).singularize.underscore
       obj_pk = (pk.is_a?(Array) ? pk : [pk]).each_with_object([]) { |pk_part, s| s << "#{hm_singular_name}.#{pk_part}" }.join(', ')

data/lib/brick/tasks/orphans.rake

@@ -4,53 +4,25 @@ if Object.const_defined?('::Rake::TaskManager')
   namespace :brick do
     desc 'Find any seemingly-orphaned records'
     task orphans: :environment do
-      def class_pk(dotted_name, multitenant)
-        Object.const_get((multitenant ? [dotted_name.split('.').last] : dotted_name.split('.')).map { |nm| "::#{nm.singularize.camelize}" }.join).primary_key
-      end
-
       schema_list = ((multi = ::Brick.config.schema_behavior[:multitenant]) && ::Brick.db_schemas.keys.sort) || []
-      if schema_list.length > 1
-        require 'fancy_gets'
-        include FancyGets
-        schema = gets_list(
-          list: schema_list,
-          chosen: multi[:schema_to_analyse]
-        )
-      elsif schema_list.length.positive?
-        schema = schema_list.first
-      end
+      schema = if schema_list.length == 1
+                 schema_list.first
+               elsif schema_list.length.positive?
+                 require 'fancy_gets'
+                 include FancyGets
+                 gets_list(list: schema_list, chosen: multi[:schema_to_analyse])
+               end
       ActiveRecord::Base.execute_sql("SET SEARCH_PATH = ?", schema) if schema
-      orphans = +''
-      ::Brick.relations.each do |k, v|
-        next if v.key?(:isView) || ::Brick.config.exclude_tables.include?(k) ||
-                !(pri_pk = v[:pkey].values.first&.first) ||
-                !(pri_pk = class_pk(k, multi))
-        v[:fks].each do |k1, v1|
-          next if v1[:is_bt] ||
-                  !(for_rel = ::Brick.relations.fetch(v1[:inverse_table], nil)) ||
-                  v1[:inverse]&.key?(:polymorphic) ||
-                  !(for_pk = for_rel.fetch(:pkey, nil)&.values&.first&.first) ||
-                  !(for_pk = class_pk(v1[:inverse_table], multi))
-          begin
-            ActiveRecord::Base.execute_sql(
-              "SELECT DISTINCT frn.#{v1[:fk]} AS pri_id, frn.#{for_pk} AS fk_id
-              FROM #{v1[:inverse_table]} AS frn
-                LEFT OUTER JOIN #{k} AS pri ON pri.#{pri_pk} = frn.#{v1[:fk]}
-              WHERE frn.#{v1[:fk]} IS NOT NULL AND pri.#{pri_pk} IS NULL
-              ORDER BY 1, 2"
-            ).each do |o|
-              orphans << "#{v1[:inverse_table]} #{o['fk_id']} refers to non-existant #{k} #{o['pri_id']}\n"
-            end
-          rescue StandardError => err
-            puts "Strange -- #{err.inspect}"
-          end
-        end
-      end
-      puts "For #{schema}:\n#{'=' * (schema.length + 5)}" if schema
-      if orphans.blank?
+      orphans = ::Brick.find_orphans(schema)
+      puts "Orphans in #{schema}:\n#{'=' * (schema.length + 12)}" if schema
+      if orphans.empty?
         puts "No orphans!"
       else
-        print orphans
+        orphans.each do |o|
+          via = " (via #{o[4]})" unless "#{o[2].split('.').last.underscore.singularize}_id" == o[4]
+          puts "#{o[0]} #{o[1]} refers#{via} to non-existent #{o[2]} #{o[3]}#{" (in table \"#{o[5]}\")" if o[5]}"
+        end
+        puts
       end
     end
   end

data/lib/brick/version_number.rb

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

data/lib/brick.rb

@@ -128,7 +128,10 @@ module Brick
 
     def set_db_schema(params)
       schema = params['_brick_schema'] || 'public'
-      ActiveRecord::Base.execute_sql("SET SEARCH_PATH = ?;", schema) if schema && ::Brick.db_schemas&.include?(schema)
+      if schema && ::Brick.db_schemas&.include?(schema)
+        ActiveRecord::Base.execute_sql("SET SEARCH_PATH = ?;", schema)
+        schema
+      end
     end
 
     # All tables and views (what Postgres calls "relations" including column and foreign key info)
@@ -457,6 +460,9 @@ In config/initializers/brick.rb appropriate entries would look something like:
               send(:resources, controller_name.to_sym, **options)
             end
           end
+          if ::Brick.config.add_orphans && instance_variable_get(:@set).named_routes.names.exclude?(:brick_orphans)
+            get('/brick_orphans', to: 'brick_gem#orphans', as: 'brick_orphans')
+          end
         end
         send(:get, '/api-docs/v1/swagger.json', { to: 'brick_swagger#index' }) if Object.const_defined?('Rswag::Ui')
       end

data/lib/generators/brick/install_generator.rb

@@ -209,7 +209,7 @@ module Brick
 # # Specify STI subclasses either directly by name or as a general module prefix that should always relate to a specific
 # # parent STI class.  The prefixed :: here for these examples is mandatory.  Also having a suffixed :: means instead of
 # # a class reference, this is for a general namespace reference.  So in this case requests for, say, either of the
-# # non-existant classes Animals::Cat or Animals::Goat (or anything else with the module prefix of \"Animals::\" would
+# # non-existent classes Animals::Cat or Animals::Goat (or anything else with the module prefix of \"Animals::\" would
 # # build a model that inherits from Animal.  And a request specifically for the class Snake would build a new model
 # # that inherits from Reptile, and no other request would do this -- only specifically for Snake.  The ending ::
 # # indicates that it's a module prefix instead of a specific class name.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: brick
 version: !ruby/object:Gem::Version
-  version: 1.0.40
+  version: 1.0.41
 platform: ruby
 authors:
 - Lorin Thwaits
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-02 00:00:00.000000000 Z
+date: 2022-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord