brick 1.0.208 → 1.0.210

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b119de0df1fa94e7c3a07315295c2d5fcf2871ec01e44986db6ddee784b82cf3
-  data.tar.gz: ba567e471502273780baeb78ed456e3b81319ce63560ccd7eaaf7ec15cb0ea21
+  metadata.gz: 803d4790408a0b789ff8086b5b81346581071b260cbc528039fd8cfa8894b7ac
+  data.tar.gz: 4503e1b9feba62d33e83f3fadc25a34b70bf9c661dc750187a3c391e3b24d5e8
 SHA512:
-  metadata.gz: 6f0e173346e205727f94e1e33d182f2a783cc20d3496a8acb7592da9c931a1c4a9e6f32da540d78647f75b00b504df03845e17816cfd589a6dc69d73a81f56b5
-  data.tar.gz: 02b36babcf6958b35cf38ad8caf2147fffaf5a438f2674a541f46f0b9813ec46df05a5fe1fafcbaba96ad63a654db429d4dc245d1a1cb688b1e20070b197a374
+  metadata.gz: 1fe28c2a9ca30ef663f28fe79e65e1b2787686c6fce6d5738d9b6addd6070437411d5210e1ba641b28eae5215fb37756f3faa80f246d823d5d553c9db990a427
+  data.tar.gz: daa9bb88c21467075717062c1ede0ab38af4207bf96d9a2495ce84f99850a4d0cb09f4c1c95017cb3862ef915fab85036397375d43518f7bee2d7bd6f1255aed

data/lib/brick/extensions.rb

@@ -72,7 +72,7 @@ module ActiveRecord
 
       def real_model(params)
         if params && (sub_model = params.fetch(type_col = inheritance_column, nil))
-          sub_model = sub_model.first if sub_model.is_a?(Array) # Support the params style that gets returned from #brick_select
+          sub_model = sub_model.first if sub_model.is_a?(Array) # Support the params style that gets returned from #_brick_querying
           # Make sure the chosen model is really the same or a subclass of this model
           (possible_model = sub_model.constantize) <= self ? possible_model : self
         else
@@ -491,17 +491,12 @@ module ActiveRecord
       [order_by, order_by_txt]
     end
 
-    def self.brick_select(*args, params: {}, brick_col_names: false, **kwargs)
-      selects = if args[0].is_a?(Array)
-                  other_args = args[1..-1]
-                  args[0]
-                else
-                  other_args = []
-                  args
-                end
-      (relation = all).brick_select(selects, *other_args,
-                                    params: params, brick_col_names: brick_col_names, **kwargs)
-      relation.select(selects)
+    def self.brick_select(*args, **kwargs)
+      all.brick_select(*args, **kwargs)
+    end
+
+    def self.brick_pluck(*args, withhold_ids: true, **kwargs)
+      all.brick_pluck(*args, withhold_ids: withhold_ids, **kwargs)
     end
 
     def self.brick_where(*args)
@@ -542,33 +537,47 @@ module ActiveRecord
 
     # Links from ActiveRecord association pathing names over to the real table
     # correlation names that get chosen when the AREL AST tree is walked.
-    def brick_links
+    def brick_links(do_dup = true)
       # Touching AREL AST walks the JoinDependency tree, and in that process uses our
       # "brick_links" patch to find how every AR chain of association names relates to exact
-      # table correlation names chosen by AREL.  We use a duplicate relation object for this
-      # because an important side-effect of referencing the AST is that the @arel instance
-      # variable gets set, and this is a signal to ActiveRecord that a relation has now
-      # become immutable.  (We aren't quite ready for our "real deal" relation object to be
-      # set in stone ... still need to add .select(), and possibly .where() and .order()
-      # things ... also if there are any HM counts then an OUTER JOIN for each of them out
-      # to a derived table to do that counting.  All of these things need to know proper
-      # table correlation names, which will now become available from brick_links on the
-      # rel_dupe object.)
+      # table correlation names chosen by AREL.  Unless a relation has already had its AST
+      # tree built out, we will use a duplicate relation object for this, because an important
+      # side-effect of referencing the AST is that the @arel instance variable gets set.  This
+      # is a signal to ActiveRecord that a relation has now become immutable.  (When Brick is
+      # still in the middle of calculating its query, we aren't quite ready for the relation
+      # object to be set in stone ... still need to add .select(), and possibly .where() and
+      # .order() things ... also if there are any HM counts then an OUTER JOIN for each of
+      # them out to a derived table to do that counting.  All of these things need to know
+      # proper table correlation names, which will now become available from brick_links on
+      # the rel_dupe object.)
       @_brick_links ||= begin
                           # If it's a CollectionProxy (which inherits from Relation) then need to dig
                           # out the core Relation object which is found in the association scope.
-                          rel_dupe = (is_a?(ActiveRecord::Associations::CollectionProxy) ? scope : self).dup
+                          brick_rel = is_a?(ActiveRecord::Associations::CollectionProxy) ? scope : self
+                          brick_rel = (@_brick_rel_dup ||= brick_rel.dup) if do_dup
                           # Start out with a hash that has only the root table name
-                          rel_dupe.instance_variable_set(:@_brick_links, bl = { '' => table_name })
-                          rel_dupe.arel.ast # Walk the AST tree in order to capture all the other correlation names
+                          brick_rel.instance_variable_set(:@_brick_links, bl = { '' => table_name })
+                          brick_rel.arel.ast if do_dup # Walk the AST tree in order to capture all the other correlation names
                           bl
                         end
     end
 
-    def brick_select(*args, params: {}, order_by: nil, translations: {},
-                     join_array: ::Brick::JoinArray.new,
-                     cust_col_override: nil,
-                     brick_col_names: true)
+    def brick_select(*args, **kwargs)
+      selects = args[0].is_a?(Array) ? args[0] : args
+      _brick_querying(selects, **kwargs)
+      select(selects)
+    end
+
+    def brick_pluck(*args, withhold_ids: true, **kwargs)
+      selects = args[0].is_a?(Array) ? args[0] : args
+      _brick_querying(selects, withhold_ids: withhold_ids, **kwargs)
+      pluck(selects)
+    end
+
+    def _brick_querying(*args, withhold_ids: nil, params: {}, order_by: nil, translations: {},
+                        join_array: ::Brick::JoinArray.new,
+                        cust_col_override: nil,
+                        brick_col_names: nil)
       selects = args[0].is_a?(Array) ? args[0] : args
       if selects.present? && cust_col_override.nil? # See if there's any fancy ones in the select list
         idx = 0
@@ -652,13 +661,13 @@ module ActiveRecord
                        "'<#{typ.end_with?('_TYP') ? typ[0..-5] : typ}>' AS #{col.name}"
                      end
         end
-      else # Having some select columns chosen, add any missing always_load_fields for this model ...
+      elsif !withhold_ids # Having some select columns chosen, add any missing always_load_fields for this model ...
         this_model = klass
         loop do
           ::Brick.config.always_load_fields.fetch(this_model.name, nil)&.each do |alf|
             selects << alf unless selects.include?(alf)
           end
-          # ... plus any and all STI superclasses it may inherit from
+          # ... plus ALF fields from any and all STI superclasses it may inherit from
           break if (this_model = this_model.superclass).abstract_class? || this_model == ActiveRecord::Base
         end
       end
@@ -671,15 +680,16 @@ module ActiveRecord
         end
       end
 
-      core_selects = selects.dup
+      # core_selects = selects.dup
       id_for_tables = Hash.new { |h, k| h[k] = [] }
       field_tbl_names = Hash.new { |h, k| h[k] = {} }
       used_col_aliases = {} # Used to make sure there is not a name clash
 
       # CUSTOM COLUMNS
       # ==============
-      (cust_col_override || klass._br_cust_cols).each do |k, cc|
-        if respond_to?(k) # Name already taken?
+      (cust_col_override || (!withhold_ids && klass._br_cust_cols))&.each do |k, cc|
+        brick_links # Intentionally create a relation duplicate
+        if @_brick_rel_dup.respond_to?(k) # Name already taken?
           # %%% Use ensure_unique here in this kind of fashion:
           # cnstr_name = ensure_unique(+"(brick) #{for_tbl}_#{pri_tbl}", nil, bts, hms)
           # binding.pry
@@ -728,12 +738,14 @@ module ActiveRecord
           selects << "#{_br_quoted_name(tbl_name)}.#{_br_quoted_name(cc_part.last)} AS #{_br_quoted_name(col_alias)}"
           cc_part << col_alias
         end
-        # Add a key column unless we've already got it
-        if key_alias && !used_col_aliases.key?(key_alias)
-          selects << "#{_br_quoted_name(key_tbl_name)}.#{_br_quoted_name(dest_pk)} AS #{_br_quoted_name(key_alias)}"
-          used_col_aliases[key_alias] = nil
+        unless withhold_ids
+          # Add a key column unless we've already got it
+          if key_alias && !used_col_aliases.key?(key_alias)
+            selects << "#{_br_quoted_name(key_tbl_name)}.#{_br_quoted_name(dest_pk)} AS #{_br_quoted_name(key_alias)}"
+            used_col_aliases[key_alias] = nil
+          end
+          cc[2] = key_alias ? [key_klass, key_alias] : nil
         end
-        cc[2] = key_alias ? [key_klass, key_alias] : nil
       end
 
       # LEFT OUTER JOINs
@@ -749,7 +761,7 @@ module ActiveRecord
               # %%% Strangely in Rails 7.1 on a slower system then very rarely brick_link comes back nil...
               brick_link = brick_links[sel_col.first]
               field_tbl_name = brick_link&.split('.')&.last ||
-                # ... so here's a best-effort guess for what the table name might be.
+                # ... so if it is nil then here's a best-effort guess as to what the table name might be.
                 klass.reflect_on_association(sel_col.first)&.klass&.table_name
               # If it's Oracle, quote any AREL aliases that had been applied
               field_tbl_name = "\"#{field_tbl_name}\"" if ::Brick.is_oracle && brick_links.values.include?(field_tbl_name)
@@ -1020,9 +1032,10 @@ JOIN (SELECT #{hm_selects.map { |s| _br_quoted_name("#{'br_t0.' if from_clause}#
       selects << 'customer_id' if klass.name == 'Pay::Subscription' && Pay::Subscription.columns_hash.key?('customer_id')
 
       pieces, my_dsl = klass.brick_parse_dsl(join_array = ::Brick::JoinArray.new, [], translations = {}, false, nil, true)
-      brick_select(
+      _brick_querying(
         selects, where_values_hash, nil, translations: translations, join_array: join_array,
-        cust_col_override: { '_br' => (descrip_cols = [pieces, my_dsl]) }
+        cust_col_override: { '_br' => (descrip_cols = [pieces, my_dsl]) },
+        brick_col_names: true
       )
       order_values = "#{_br_quoted_name(klass.table_name)}.#{_br_quoted_name(klass.primary_key)}"
       [self.select(selects), descrip_cols]
@@ -2244,9 +2257,10 @@ class Object
 
             ar_relation = ActiveRecord.version < Gem::Version.new('4') ? real_model.preload : real_model.all
             params['_brick_is_api'] = true if (is_api = request.format == :js || current_api_root)
-            @_brick_params = ar_relation.brick_select((selects ||= []), params: params, order_by: order_by,
-                                                      translations: (translations = {}),
-                                                      join_array: (join_array = ::Brick::JoinArray.new))
+            @_brick_params = ar_relation._brick_querying((selects ||= []), params: params, order_by: order_by,
+                                                         translations: (translations = {}),
+                                                         join_array: (join_array = ::Brick::JoinArray.new),
+                                                         brick_col_names: true)
 
             if is_api # Asking for JSON?
               # Apply column renaming
@@ -2340,7 +2354,7 @@ class Object
           _, order_by_txt = model._brick_calculate_ordering(default_ordering(table_name, pk, true)) if pk
           code << "  def index\n"
           code << "    @#{plural_table_name} = #{model.name}#{pk&.present? ? ".order(#{order_by_txt.join(', ')})" : '.all'}\n"
-          code << "    @#{plural_table_name}.brick_select(params)\n"
+          code << "    @#{plural_table_name}._brick_querying(params, brick_col_names: true)\n"
           code << "  end\n"
 
           is_pk_string = nil

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

@@ -57,7 +57,7 @@ module Brick::Rails::FormBuilder
           out << ::Brick::Rails.hide_bcrypt(val, nil, 1000)
         elsif col_type == :string
           if model.respond_to?(:uploaders) && model.uploaders.key?(col.name&.to_sym) &&
-            (url = self.object.send(col.name)&.url) # Carrierwave image?
+             (url = self.object.send(col.name)&.url) # Carrierwave image?
             out << "<img src=\"#{url}\" title=\"#{val}\">"
           elsif model.respond_to?(:enumerized_attributes) && (opts = (attr = model.enumerized_attributes[method])&.options).present?
             enum_html_options = attr.kind_of?(Enumerize::Multiple) ? html_options.merge({ multiple: true, size: opts.length + 1 }) : html_options

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

@@ -232,15 +232,15 @@ module Brick::Rails::FormTags
           out << if klass._brick_monetized_attributes&.include?(col_name)
                    val ? Money.new(val.to_i).format : ''
                  elsif klass.respond_to?(:uploaders) && klass.uploaders.key?(col_name.to_sym) &&
-                    (url = obj.send(col.name)&.url) && # Carrierwave image?
-                    # And either not restricting Carrierwave, or under the defined Carrierwave image limit?
-                    (!(limit_carrierwave = ::Brick.config.limit_carrierwave) ||
-                      (limit_carrierwave.is_a?(Numeric) &&
-                       (carrierwave_count = instance_variable_get(:@_carrierwave_count) || 0) &&
-                       ((carrierwave_count += 1) < limit_carrierwave) &&
-                       instance_variable_set(:@_carrierwave_count, carrierwave_count)
-                      )
-                    )
+                       (url = obj.send(col.name)&.url) && # Has a Carrierwave URL? ...
+                       # ... and either not restricting Carrierwave, or under the defined Carrierwave attachment limit?
+                       (!(limit_carrierwave = ::Brick.config.limit_carrierwave) ||
+                         (limit_carrierwave.is_a?(Numeric) &&
+                         (carrierwave_count = instance_variable_get(:@_carrierwave_count) || 0) &&
+                         ((carrierwave_count += 1) < limit_carrierwave) &&
+                         instance_variable_set(:@_carrierwave_count, carrierwave_count)
+                         )
+                       )
                    "<img class=\"thumbImg\" src=\"#{url}\" title=\"#{val}\">"
                  else
                    lat_lng = if [:float, :decimal].include?(col.type) &&

data/lib/brick/version_number.rb

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

data/lib/brick.rb

@@ -1512,7 +1512,7 @@ module ActiveRecord
   module QueryMethods
   private
 
-    if private_instance_methods.include?(:build_join_query)
+    if private_instance_methods.include?(:build_join_query) # AR 5.0 - 6.0
       alias _brick_build_join_query build_join_query
       def build_join_query(manager, buckets, *args) # , **kwargs)
         # %%% Better way to bring relation into the mix
@@ -1523,7 +1523,7 @@ module ActiveRecord
         _brick_build_join_query(manager, buckets, *args) # , **kwargs)
       end
 
-    elsif private_instance_methods.include?(:select_association_list)
+    elsif private_instance_methods.include?(:select_association_list) # AR >= 6.1
       alias _brick_select_association_list select_association_list
       def select_association_list(associations, stashed_joins = nil)
         result = _brick_select_association_list(associations, stashed_joins)
@@ -1531,7 +1531,7 @@ module ActiveRecord
         result
       end
 
-    # else # Rails 4.1 ? and older
+    # else # AR 4.2 and older
     #   alias _brick_build_joins build_joins
     #   def build_joins(manager, joins)
     #     result = _brick_build_joins(manager, joins)
@@ -1551,12 +1551,12 @@ module ActiveRecord
           # Capture the table alias name that was chosen
           # if (relation = node.instance_variable_get(:@assocs)&.instance_variable_get(:@relation))
           #   link_path = node.instance_variable_get(:@link_path)
-          #   relation.brick_links[link_path] = result.first.table_alias || result.first.table_name
+          #   relation.brick_links(false)[link_path] = result.first.table_alias || result.first.table_name
           # end
           result
         end
       end
-    else # For AR >= 4.2
+    else # For AR >= 4.1
       class JoinDependency
         # An intelligent .eager_load() and .includes() that creates t0_r0 style aliases only for the columns
         # used in .select().  To enable this behaviour, include the flag :_brick_eager_load as the first
@@ -1652,7 +1652,7 @@ module ActiveRecord
             # Capture the table alias name that was chosen
             if (relation = node.instance_variable_get(:@assocs)&.instance_variable_get(:@relation))
               link_path = node.instance_variable_get(:@link_path)
-              relation.brick_links[link_path] = result.first.table_alias || result.first.table_name
+              relation.brick_links(false)[link_path] = result.first.table_alias || result.first.table_name
             end
             result
           end
@@ -1663,7 +1663,7 @@ module ActiveRecord
             # Capture the table alias name that was chosen
             if (relation = child.instance_variable_get(:@assocs)&.instance_variable_get(:@relation))
               link_path = child.instance_variable_get(:@link_path)
-              relation.brick_links[link_path] = if child.table.is_a?(Arel::Nodes::TableAlias)
+              relation.brick_links(false)[link_path] = if child.table.is_a?(Arel::Nodes::TableAlias)
                                                   child.table.right
                                                 else
                                                   # Was:  result.first&.left&.table_alias || child.table_name

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: brick
 version: !ruby/object:Gem::Version
-  version: 1.0.208
+  version: 1.0.210
 platform: ruby
 authors:
 - Lorin Thwaits
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-17 00:00:00.000000000 Z
+date: 2024-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord