brick 1.0.4 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe6bf3e38aef34261d9398b25f804504e7152721673b0534253c4284c9018013
-  data.tar.gz: 766af0df2edc3dc8c8c73a5d1ecd99c8d738ed7cd00fc21c79c38ac3db991819
+  metadata.gz: 9cd49783dae6701760920fe007cbde7382fd3dbaf5e8f7472d475c0fe8aaf660
+  data.tar.gz: d2330f28e87dde00b1377f6cbca31cbbfe2dd3b2c495f1fbd0aebc0f8a951504
 SHA512:
-  metadata.gz: 40f2eacaf7fada3056f5bfc701b01441ad02e34e76e87dc8e53b36a546c87216e8a319c3f0763b8fecff49344224d5660ff5b875937a3e30e2e7c80c662f684c
-  data.tar.gz: 7901020af2ec1759c27c16a0c3a3ffbcddcd09691c652c14c02781823964e36409533afc562fb0d9beb508cc3329b601d6fe8c266c101f6db6d93aad5e055a3e
+  metadata.gz: 2a3c7ba47d32f3a6ab6c9be838006826f5266efb1349d90ce7d53b5e8f89ea078bdcb699a7db8084176e2de444a27931ce8e0216af666c25704c0568b59ac827
+  data.tar.gz: 41fccf3387315cd54fd596955c3f07760941cd4aa51959dc99f87d0b6fb38de742ad11fe7dabb084a3e72167c340b8aafce838c7704626359ccb41878e202ae2

data/lib/brick/config.rb

@@ -65,6 +65,15 @@ module Brick
       @mutex.synchronize { @additional_references = references }
     end
 
+    # Associations to treat has a has_one
+    def has_ones
+      @mutex.synchronize { @has_ones }
+    end
+
+    def has_ones=(references)
+      @mutex.synchronize { @has_ones = references }
+    end
+
     def skip_database_views
       @mutex.synchronize { @skip_database_views }
     end

data/lib/brick/extensions.rb

@@ -61,14 +61,15 @@ module ActiveRecord
       wheres = {}
       rel_joins = []
       params.each do |k, v|
-        if (ks = k.split('.')).length > 1
+        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&.columns&.map(&:name)&.include?(ks.last)
 
           rel_joins << assoc_name unless rel_joins.include?(assoc_name)
-        else
-          next unless klass._brick_get_fks.include?(k)
         end
         wheres[k] = v.split(',')
       end
@@ -184,6 +185,14 @@ class Object
                     need_class_name = singular_table_name.underscore != assoc_name
                     need_fk = "#{assoc_name}_id" != assoc[:fk]
                     inverse_assoc_name, _x = _brick_get_hm_assoc_name(relations[assoc[:inverse_table]], assoc[:inverse])
+                    if (has_ones = ::Brick.config.has_ones.fetch(assoc[:inverse][:alternate_name].camelize, nil))&.key?(singular_inv_assoc_name = ActiveSupport::Inflector.singularize(inverse_assoc_name))
+                      inverse_assoc_name = if has_ones[singular_inv_assoc_name]
+                                             need_inverse_of = true
+                                             has_ones[singular_inv_assoc_name]
+                                           else
+                                             singular_inv_assoc_name
+                                           end
+                    end
                     :belongs_to
                   else
                     # need_class_name = ActiveSupport::Inflector.singularize(assoc_name) == ActiveSupport::Inflector.singularize(table_name.underscore)
@@ -191,14 +200,23 @@ class Object
                     assoc_name, need_class_name = _brick_get_hm_assoc_name(relation, assoc)
                     need_fk = "#{ActiveSupport::Inflector.singularize(assoc[:inverse][:inverse_table])}_id" != assoc[:fk]
                     # fks[table_name].find { |other_assoc| other_assoc.object_id != assoc.object_id && other_assoc[:assoc_name] == assoc[assoc_name] }
-                    :has_many
+                    if (has_ones = ::Brick.config.has_ones&.fetch(model_name, nil))&.key?(singular_assoc_name = ActiveSupport::Inflector.singularize(assoc_name))
+                      assoc_name = if has_ones[singular_assoc_name]
+                                     need_class_name = true
+                                     has_ones[singular_assoc_name]
+                                   else
+                                     singular_assoc_name
+                                   end
+                      :has_one
+                    else
+                      :has_many
+                    end
                   end
+          # Figure out if we need to specially call out the class_name and/or foreign key
+          # (and if either of those then definitely also a specific inverse_of)
           options[:class_name] = singular_table_name.camelize if need_class_name
-          # Figure out if we need to specially call out the foreign key
-          if need_fk # Funky foreign key?
-            options[:foreign_key] = assoc[:fk].to_sym
-          end
-          options[:inverse_of] = inverse_assoc_name.to_sym if need_class_name || need_fk
+          options[:foreign_key] = assoc[:fk].to_sym if need_fk # Funky foreign key?
+          options[:inverse_of] = inverse_assoc_name.to_sym if need_class_name || need_fk || need_inverse_of
           assoc_name = assoc_name.to_sym
           code << "  #{macro} #{assoc_name.inspect}#{options.map { |k, v| ", #{k}: #{v.inspect}" }.join}\n"
           self.send(macro, assoc_name, **options)
@@ -273,9 +291,13 @@ end
 module ActiveRecord::ConnectionHandling
   alias _brick_establish_connection establish_connection
   def establish_connection(*args)
-    x = _brick_establish_connection(*args)
+    conn = _brick_establish_connection(*args)
+    _brick_reflect_tables
+    conn
+  end
 
-    if (relations = ::Brick.relations).empty?
+  def _brick_reflect_tables
+      if (relations = ::Brick.relations).empty?
       # Only for Postgres?  (Doesn't work in sqlite3)
       # puts ActiveRecord::Base.connection.execute("SELECT current_setting('SEARCH_PATH')").to_a.inspect
 
@@ -367,7 +389,7 @@ module ActiveRecord::ConnectionHandling
       case ActiveRecord::Base.connection.adapter_name
       when 'PostgreSQL', 'Mysql2'
         sql = ActiveRecord::Base.send(:sanitize_sql_array, [
-          "SELECT kcu1.TABLE_NAME, kcu1.COLUMN_NAME, kcu2.TABLE_NAME, kcu1.CONSTRAINT_NAME
+          "SELECT kcu1.TABLE_NAME, kcu1.COLUMN_NAME, kcu2.TABLE_NAME AS primary_table, kcu1.CONSTRAINT_NAME
           FROM INFORMATION_SCHEMA.REFERENTIAL_CONSTRAINTS AS rc
             INNER JOIN INFORMATION_SCHEMA.KEY_COLUMN_USAGE AS kcu1
               ON kcu1.CONSTRAINT_CATALOG = rc.CONSTRAINT_CATALOG
@@ -389,9 +411,10 @@ module ActiveRecord::ConnectionHandling
       else
       end
       if sql
-        result = ActiveRecord::Base.connection.execute(sql)
-        result = result.values unless result.is_a?(Array)
-        result.each { |fk| ::Brick._add_bt_and_hm(fk, relations) }
+        ActiveRecord::Base.connection.execute(sql).each do |fk|
+          fk = fk.values unless fk.is_a?(Array)
+          ::Brick._add_bt_and_hm(fk, relations)
+        end
       end
     end
 
@@ -403,7 +426,6 @@ module ActiveRecord::ConnectionHandling
 
     # relations.keys.each { |k| ActiveSupport::Inflector.singularize(k).camelize.constantize }
     # Layout table describes permissioned hierarchy throughout
-    x
   end
 end
 

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

@@ -5,11 +5,8 @@ module Brick
     # See http://guides.rubyonrails.org/engines.html
     class Engine < ::Rails::Engine
       # paths['app/models'] << 'lib/brick/frameworks/active_record/models'
-      puts "BEFORE - engine set config"
       config.brick = ActiveSupport::OrderedOptions.new
-      # initializer 'brick.initialisation' do |app|
       ActiveSupport.on_load(:before_initialize) do |app|
-        puts "BEFORE - engine initialisation"
         ::Brick.enable_models = app.config.brick.fetch(:enable_models, true)
         ::Brick.enable_controllers = app.config.brick.fetch(:enable_controllers, true)
         ::Brick.enable_views = app.config.brick.fetch(:enable_views, true)
@@ -25,83 +22,66 @@ module Brick
         # Additional references (virtual foreign keys)
         ::Brick.additional_references = app.config.brick.fetch(:additional_references, nil)
 
-        # After we're initialized and before running the rest of stuff, put our configuration in place
-        ActiveSupport.on_load(:after_initialize) do |xyz|
-          puts "AFTER - engine initialisation"
-          # ====================================
-          # Dynamically create generic templates
-          # ====================================
-          if ::Brick.enable_views?
-            ActionView::LookupContext.class_exec do
-              alias :_brick_template_exists? :template_exists?
-              def template_exists?(*args, **options)
-                unless (is_template_exists = _brick_template_exists?(*args, **options))
-                  # Need to return true if we can fill in the blanks for a missing one
-                  # args will be something like:  ["index", ["categories"]]
-                  model = args[1].map(&:camelize).join('::').singularize.constantize
-                  if (
-                       is_template_exists = model && (
-                         ['index', 'show'].include?(args.first) || # Everything has index and show
-                         # Only CRU stuff has create / update / destroy
-                         (!model.is_view? && ['new', 'create', 'edit', 'update', 'destroy'].include?(args.first))
-                       )
-                     )
-                    instance_variable_set(:@_brick_model, model)
-                  end
+        # Has one relationships
+        ::Brick.has_ones = app.config.brick.fetch(:has_ones, nil)
+      end
+
+      # After we're initialized and before running the rest of stuff, put our configuration in place
+      ActiveSupport.on_load(:after_initialize) do
+        # ====================================
+        # Dynamically create generic templates
+        # ====================================
+        if ::Brick.enable_views?
+          ActionView::LookupContext.class_exec do
+            alias :_brick_template_exists? :template_exists?
+            def template_exists?(*args, **options)
+              unless (is_template_exists = _brick_template_exists?(*args, **options))
+                # Need to return true if we can fill in the blanks for a missing one
+                # args will be something like:  ["index", ["categories"]]
+                model = args[1].map(&:camelize).join('::').singularize.constantize
+                if (
+                      is_template_exists = model && (
+                        ['index', 'show'].include?(args.first) || # Everything has index and show
+                        # Only CRU stuff has create / update / destroy
+                        (!model.is_view? && ['new', 'create', 'edit', 'update', 'destroy'].include?(args.first))
+                      )
+                    )
+                  instance_variable_set(:@_brick_model, model)
                 end
-                is_template_exists
               end
+              is_template_exists
+            end
 
-              alias :_brick_find_template :find_template
-              def find_template(*args, **options)
-                if @_brick_model
-                  model_name = @_brick_model.name
-                  pk = @_brick_model.primary_key
-                  obj_name = model_name.underscore
-                  table_name = model_name.pluralize.underscore
-                  # This gets has_many as well as has_many :through
-                  # %%% weed out ones that don't have an available model to reference
-                  bts, hms = @_brick_model.reflect_on_all_associations.each_with_object([{}, {}]) do |a, s|
-                    case a.macro
-                    when :belongs_to
-                      # Build #brick_descrip if needed
-                      unless a.klass.instance_methods(false).include?(:brick_descrip)
-                        descrip_col = (a.klass.columns.map(&:name) - a.klass._brick_get_fks -
-                                      (::Brick.config.metadata_columns || []) -
-                                      [a.klass.primary_key]).first&.to_sym
-                        if descrip_col
-                          a.klass.define_method :brick_descrip do
-                            send(descrip_col)
-                          end
-                        end
-                      end
-
-                      s.first[a.foreign_key] = [a.name, a.klass]
-                    when :has_many
-                      s.last[a.name] = a
-                    end
-                    s
-                  end
-                  # Weed out has_manys that go to an associative table
-                  associatives = hms.select { |k, v| v.options[:through] }.each_with_object({}) do |hmt, s|
-                    s[hmt.first] = hms.delete(hmt.last.options[:through]) # End up with a hash of HMT names pointing to join-table associations
+            alias :_brick_find_template :find_template
+            def find_template(*args, **options)
+              if @_brick_model
+                model_name = @_brick_model.name
+                pk = @_brick_model.primary_key
+                obj_name = model_name.underscore
+                table_name = model_name.pluralize.underscore
+                # This gets has_many as well as has_many :through
+                # %%% weed out ones that don't have an available model to reference
+                bts, hms = ::Brick.get_bts_and_hms(@_brick_model)
+                # Weed out has_manys that go to an associative table
+                associatives = hms.select { |k, v| v.options[:through] }.each_with_object({}) do |hmt, s|
+                  s[hmt.first] = hms.delete(hmt.last.options[:through]) # End up with a hash of HMT names pointing to join-table associations
+                end
+                hms_headers = hms.each_with_object(+'') { |hm, s| s << "<th>HM#{'T' if hm.last.options[:through]} #{hm.first}</th>\n" }
+                hms_columns = hms.each_with_object(+'') do |hm, s|
+                  hm_fk_name = if hm.last.options[:through]
+                    associative = associatives[hm.last.name]
+                    "'#{associative.name}.#{associative.foreign_key}'"
+                  else
+                    hm.last.foreign_key
                   end
-                  hms_headers = hms.each_with_object(+'') { |hm, s| s << "<th>HM#{'T' if hm.last.options[:through]} #{hm.first}</th>\n" }
-                  hms_columns = hms.each_with_object(+'') do |hm, s|
-                    hm_fk_name = if hm.last.options[:through]
-                      associative = associatives[hm.last.name]
-                      "'#{associative.name}.#{associative.foreign_key}'"
-                    else
-                      hm.last.foreign_key
-                    end
-                    s << "<td>
-  <%= link_to \"#\{#{obj_name}.#{hm.first}.count\} #{hm.first}\", #{hm.last.klass.name.underscore.pluralize}_path({ #{hm_fk_name}: #{obj_name}.#{pk} }) %>
+                  s << "<td>
+  <%= link_to \"#\{#{obj_name}.#{hm.first}.count\} #{hm.first}\", #{hm.last.klass.name.underscore.pluralize}_path({ #{hm_fk_name}: #{obj_name}.#{pk} }) unless #{obj_name}.#{hm.first}.count.zero? %>
 </td>\n"
-                  end
+                end
 
-                  inline = case args.first
-                  when 'index'
-                    "<p style=\"color: green\"><%= notice %></p>
+                inline = case args.first
+                when 'index'
+                  "<p style=\"color: green\"><%= notice %></p>
 
 <h1>#{model_name.pluralize}</h1>
 <% if @_brick_params&.present? %><h3>where <%= @_brick_params.each_with_object([]) { |v, s| s << \"#\{v.first\} = #\{v.last.inspect\}\" }.join(', ') %></h3><% end %>
@@ -161,63 +141,58 @@ module Brick
 
 #{"<hr><%= link_to \"New #{obj_name}\", new_#{obj_name}_path %>" unless @_brick_model.is_view?}
 "
-                  when 'show'
-                    "<%= @#{@_brick_model.name.underscore}.inspect %>"
-                  end
-                  # As if it were an inline template (see #determine_template in actionview-5.2.6.2/lib/action_view/renderer/template_renderer.rb)
-                  keys = options.has_key?(:locals) ? options[:locals].keys : []
-                  handler = ActionView::Template.handler_for_extension(options[:type] || 'erb')
-                  ActionView::Template.new(inline, "auto-generated #{args.first} template", handler, locals: keys)
-                else
-                  _brick_find_template(*args, **options)
+                when 'show'
+                  "<%= @#{@_brick_model.name.underscore}.inspect %>"
                 end
+                # As if it were an inline template (see #determine_template in actionview-5.2.6.2/lib/action_view/renderer/template_renderer.rb)
+                keys = options.has_key?(:locals) ? options[:locals].keys : []
+                handler = ActionView::Template.handler_for_extension(options[:type] || 'erb')
+                ActionView::Template.new(inline, "auto-generated #{args.first} template", handler, locals: keys)
+              else
+                _brick_find_template(*args, **options)
               end
             end
           end
+        end
 
-          if ::Brick.enable_routes?
-            ActionDispatch::Routing::RouteSet.class_exec do
-              alias _brick_finalize_routeset! finalize!
-              def finalize!(*args, **options)
-                unless @finalized
-                  existing_controllers = routes.each_with_object({}) { |r, s| c = r.defaults[:controller]; s[c] = nil if c }
-                  ::Rails.application.routes.append do
-                    # %%% TODO: If no auto-controllers then enumerate the controllers folder in order to build matching routes
-                    # If auto-controllers and auto-models are both enabled then this makes sense:
-                    relations = (::Brick.instance_variable_get(:@relations) || {})[ActiveRecord::Base.connection_pool.object_id] || {}
-                    relations.each do |k, v|
-                      unless existing_controllers.key?(controller_name = k.underscore.pluralize)
-                        options = {}
-                        options[:only] = [:index, :show] if v.key?(:isView)
-                        send(:resources, controller_name.to_sym, **options)
-                      end
+        if ::Brick.enable_routes?
+          ActionDispatch::Routing::RouteSet.class_exec do
+            alias _brick_finalize_routeset! finalize!
+            def finalize!(*args, **options)
+              unless @finalized
+                existing_controllers = routes.each_with_object({}) { |r, s| c = r.defaults[:controller]; s[c] = nil if c }
+                ::Rails.application.routes.append do
+                  # %%% TODO: If no auto-controllers then enumerate the controllers folder in order to build matching routes
+                  # If auto-controllers and auto-models are both enabled then this makes sense:
+                  ::Brick.relations.each do |k, v|
+                    unless existing_controllers.key?(controller_name = k.underscore.pluralize)
+                      options = {}
+                      options[:only] = [:index, :show] if v.key?(:isView)
+                      send(:resources, controller_name.to_sym, **options)
                     end
                   end
                 end
-                _brick_finalize_routeset!(*args, **options)
               end
+              _brick_finalize_routeset!(*args, **options)
             end
           end
+        end
 
-          # Additional references (virtual foreign keys)
-          if (ars = ::Brick.config.additional_references)
-            ars = ars.call if ars.is_a?(Proc)
-            ars = ars.to_a unless ars.is_a?(Array)
-            ars = [ars] unless ars.empty? || ars.first.is_a?(Array)
-            ars.each do |fk|
-              ::Brick._add_bt_and_hm(fk[0..2])
-            end
+        # Additional references (virtual foreign keys)
+        if (ars = ::Brick.config.additional_references)
+          ars.each do |fk|
+            ::Brick._add_bt_and_hm(fk[0..2])
           end
+        end
 
-          # Find associative tables that can be set up for has_many :through
-          ::Brick.relations.each do |_key, tbl|
-            tbl_cols = tbl[:cols].keys
-            fks = tbl[:fks].each_with_object({}) { |fk, s| s[fk.last[:fk]] = fk.last[:inverse_table] if fk.last[:is_bt]; s }
-            # Aside from the primary key and the metadata columns created_at, updated_at, and deleted_at, if this table only has
-            # foreign keys then it can act as an associative table and thus be used with has_many :through.
-            if fks.length > 1 && (tbl_cols - fks.keys - (::Brick.config.metadata_columns || []) - tbl[:pkey].values.first).length.zero?
-              fks.each { |fk| tbl[:hmt_fks][fk.first] = fk.last }
-            end
+        # Find associative tables that can be set up for has_many :through
+        ::Brick.relations.each do |_key, tbl|
+          tbl_cols = tbl[:cols].keys
+          fks = tbl[:fks].each_with_object({}) { |fk, s| s[fk.last[:fk]] = fk.last[:inverse_table] if fk.last[:is_bt]; s }
+          # Aside from the primary key and the metadata columns created_at, updated_at, and deleted_at, if this table only has
+          # foreign keys then it can act as an associative table and thus be used with has_many :through.
+          if fks.length > 1 && (tbl_cols - fks.keys - (::Brick.config.metadata_columns || []) - (tbl[:pkey].values.first || [])).length.zero?
+            fks.each { |fk| tbl[:hmt_fks][fk.first] = fk.last }
           end
         end
       end

data/lib/brick/version_number.rb

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

data/lib/brick.rb

@@ -90,6 +90,30 @@ module Brick
       (connections[ActiveRecord::Base.connection_pool.object_id] ||= Hash.new { |h, k| h[k] = Hash.new { |h, k| h[k] = {} } })
     end
 
+    def get_bts_and_hms(model)
+      model.reflect_on_all_associations.each_with_object([{}, {}]) do |a, s|
+        case a.macro
+        when :belongs_to
+          # Build #brick_descrip if needed
+          if a.klass.instance_methods(false).exclude?(:brick_descrip)
+            descrip_col = (a.klass.columns.map(&:name) - a.klass._brick_get_fks -
+                          (::Brick.config.metadata_columns || []) -
+                          [a.klass.primary_key]).first&.to_sym
+            if descrip_col
+              a.klass.define_method :brick_descrip do
+                send(descrip_col)
+              end
+            end
+          end
+
+          s.first[a.foreign_key] = [a.name, a.klass]
+        when :has_many
+          s.last[a.name] = a
+        end
+        s
+      end
+    end
+
     # Switches Brick auto-models on or off, for all threads
     # @api public
     def enable_models=(value)
@@ -159,8 +183,28 @@ module Brick
 
     # Additional table associations to use (Think of these as virtual foreign keys perhaps)
     # @api public
-    def additional_references=(value)
-      Brick.config.additional_references = value
+    def additional_references=(ars)
+      if ars
+        ars = ars.call if ars.is_a?(Proc)
+        ars = ars.to_a unless ars.is_a?(Array)
+        ars = [ars] unless ars.empty? || ars.first.is_a?(Array)
+        Brick.config.additional_references = ars
+      end
+    end
+
+    # Associations to treat has a has_one
+    # @api public
+    def has_ones=(hos)
+      if hos
+        hos = hos.call if hos.is_a?(Proc)
+        hos = hos.to_a unless hos.is_a?(Array)
+        hos = [hos] unless hos.empty? || hos.first.is_a?(Array)
+        # Translate to being nested hashes
+        Brick.config.has_ones = hos&.each_with_object(Hash.new { |h, k| h[k] = {} }) do |v, s|
+          s[v.first][v[1]] = v[2] if v[1]
+          s
+        end
+      end
     end
 
 

data/lib/generators/brick/install_generator.rb

@@ -48,6 +48,14 @@ module Brick
 # Brick.additional_references = [['orders', 'customer_id', 'customer'],
 #                                ['customer', 'region_id', 'regions']]
 
+# # By default primary tables involved in a foreign key relationship will indicate a \"has_many\" relationship pointing
+# # back to the foreign table.  In order to represent a \"has_one\" association instead, an override can be provided
+# # using the primary model name and the association name which you instead want to have treated as a \"has_one\":
+# Brick.has_ones = [['User', 'user_profile']]
+# # If you want to use an alternate name for the \"has_one\", such as in the case above calling the association \"profile\"
+# # instead of \"user_profile\", then apply that as a third parameter like this:
+# Brick.has_ones = [['User', 'user_profile', 'profile']]
+
 # # We normally don't consider the timestamp columns \"created_at\", \"updated_at\", and \"deleted_at\" to count when
 # # finding tables which can serve as associative tables in an N:M association.  That is, ones that can be a
 # # part of a has_many :through association.  If you want to use different exclusion columns than our defaults

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: brick
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors:
 - Lorin Thwaits
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-16 00:00:00.000000000 Z
+date: 2022-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord