brick 1.0.1 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b4733a804fae7a4759eae48690541f1873cb81fd1b2a9986f849202c1c76c5d
-  data.tar.gz: d721f215cfed0473804f82969fd3c89dd7a94671d24b0f44b0e03cc73d787754
+  metadata.gz: fe6bf3e38aef34261d9398b25f804504e7152721673b0534253c4284c9018013
+  data.tar.gz: 766af0df2edc3dc8c8c73a5d1ecd99c8d738ed7cd00fc21c79c38ac3db991819
 SHA512:
-  metadata.gz: b73c787a9c7aa6804d2cfce77921252dd77ce3e6e3710bd30875436d0f66011e6043e0ae4cbdaaeff6f4abb725d8051b5c1be139ee28b80648314f124ff7204f
-  data.tar.gz: 000b467728db85565d793df6e22429e3ff804bb7d39e5c4d6346becc24bc940ec9476fe00758d1e4a4fad868239e755ba7bdef596ecb115f358332656fd1be5e
+  metadata.gz: 40f2eacaf7fada3056f5bfc701b01441ad02e34e76e87dc8e53b36a546c87216e8a319c3f0763b8fecff49344224d5660ff5b875937a3e30e2e7c80c662f684c
+  data.tar.gz: 7901020af2ec1759c27c16a0c3a3ffbcddcd09691c652c14c02781823964e36409533afc562fb0d9beb508cc3329b601d6fe8c266c101f6db6d93aad5e055a3e

data/lib/brick/config.rb

@@ -57,12 +57,36 @@ module Brick
     end
 
     # Additional table associations to use (Think of these as virtual foreign keys perhaps)
+    def additional_references
+      @mutex.synchronize { @additional_references }
+    end
+
     def additional_references=(references)
       @mutex.synchronize { @additional_references = references }
     end
 
-    def additional_references
-      @mutex.synchronize { @additional_references }
+    def skip_database_views
+      @mutex.synchronize { @skip_database_views }
+    end
+
+    def skip_database_views=(disable)
+      @mutex.synchronize { @skip_database_views = disable }
+    end
+
+    def exclude_tables
+      @mutex.synchronize { @exclude_tables }
+    end
+
+    def exclude_tables=(value)
+      @mutex.synchronize { @exclude_tables = value }
+    end
+
+    def metadata_columns
+      @mutex.synchronize { @metadata_columns }
+    end
+
+    def metadata_columns=(columns)
+      @mutex.synchronize { @metadata_columns = columns }
     end
   end
 end

data/lib/brick/extensions.rb

@@ -26,16 +26,58 @@
 
 # colour coded origins
 
-# Drag TmfModel#name onto the rows and have it automatically add five columns -- where type=zone / where type = sectionn / etc
+# Drag something like TmfModel#name onto the rows and have it automatically add five columns -- where type=zone / where type = section / etc
+
+# Support for Postgres / MySQL enums (add enum to model, use model enums to make a drop-down in the UI)
+
+# Currently quadrupling up routes
 
 # ==========================================================
 # Dynamically create model or controller classes when needed
 # ==========================================================
 
 # By default all models indicate that they are not views
-class ActiveRecord::Base
-  def self.is_view?
-    false
+module ActiveRecord
+  class Base
+    def self.is_view?
+      false
+    end
+
+    # Used to show a little prettier name for an object
+    def brick_descrip
+      klass = self.class
+      klass.primary_key ? "#{klass.name} ##{send(klass.primary_key)}" : to_s
+    end
+
+  private
+
+    def self._brick_get_fks
+      @_brick_get_fks ||= reflect_on_all_associations.select { |a2| a2.macro == :belongs_to }.map(&:foreign_key)
+    end
+  end
+
+  class Relation
+    def brick_where(params)
+      wheres = {}
+      rel_joins = []
+      params.each do |k, v|
+        if (ks = k.split('.')).length > 1
+          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
+      unless wheres.empty?
+        where!(wheres)
+        joins!(rel_joins) unless rel_joins.empty?
+        wheres # Return the specific parameters that we did use
+      end
+    end
   end
 end
 
@@ -88,6 +130,9 @@ class Object
   private
 
     def build_model(model_name, singular_table_name, table_name, relations, matching)
+      return if ((is_view = (relation = relations[matching]).key?(:isView)) && ::Brick.config.skip_database_views) ||
+                ::Brick.config.exclude_tables.include?(matching)
+
       # 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)
         raise NameError.new("Class name for a model that references table \"#{matching}\" should be \"#{ActiveSupport::Inflector.singularize(model_name)}\".")
@@ -100,7 +145,7 @@ class Object
 
         # 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)
-        if (is_view = (relation = relations[matching]).key?(:isView))
+        if is_view
           new_model_class.define_singleton_method :'is_view?' do
             true
           end
@@ -129,15 +174,6 @@ class Object
           code << "  # Could not identify any column(s) to use as a primary key\n" unless is_view
         end
 
-        # if relation[:cols].key?('last_update')
-        #   define_method :updated_at do
-        #     last_update
-        #   end
-        #   define_method :'updated_at=' do |val|
-        #     last_update=(val)
-        #   end
-        # end
-
         fks = relation[:fks] || {}
         fks.each do |_constraint_name, assoc|
           assoc_name = assoc[:assoc_name]
@@ -153,7 +189,7 @@ class Object
                     # need_class_name = ActiveSupport::Inflector.singularize(assoc_name) == ActiveSupport::Inflector.singularize(table_name.underscore)
                     # Are there multiple foreign keys out to the same table?
                     assoc_name, need_class_name = _brick_get_hm_assoc_name(relation, assoc)
-                    need_fk = "#{singular_table_name}_id" != assoc[:fk]
+                    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
                   end
@@ -183,7 +219,6 @@ class Object
       [built_model, code]
     end
 
-
     def build_controller(class_name, plural_class_name, model, relations)
       table_name = ActiveSupport::Inflector.underscore(plural_class_name)
       singular_table_name = ActiveSupport::Inflector.singularize(table_name)
@@ -193,10 +228,12 @@ class Object
         Object.const_set(class_name.to_sym, new_controller_class)
 
         code << "  def index\n"
-        code << "    @#{table_name} = #{model.name}#{model.primary_key ? ".order(#{model.primary_key.inspect}" : '.all'})\n"
+        code << "    @#{table_name} = #{model.name}#{model.primary_key ? ".order(#{model.primary_key.inspect})" : '.all'}\n"
+        code << "    @#{table_name}.brick_where(params)\n"
         code << "  end\n"
         self.define_method :index do
           ar_relation = model.primary_key ? model.order(model.primary_key) : model.all
+          instance_variable_set(:@_brick_params, ar_relation.brick_where(params))
           instance_variable_set("@#{table_name}".to_sym, ar_relation)
         end
 
@@ -234,19 +271,36 @@ end
 # ==========================================================
 
 module ActiveRecord::ConnectionHandling
-  alias old_establish_connection establish_connection
+  alias _brick_establish_connection establish_connection
   def establish_connection(*args)
-    # puts connections.inspect
-    x = old_establish_connection(*args)
+    x = _brick_establish_connection(*args)
 
     if (relations = ::Brick.relations).empty?
-      schema = 'public'
-      puts ActiveRecord::Base.connection.execute("SELECT current_setting('SEARCH_PATH')").to_a.inspect
-      sql = ActiveRecord::Base.send(:sanitize_sql_array, [
+      # Only for Postgres?  (Doesn't work in sqlite3)
+      # puts ActiveRecord::Base.connection.execute("SELECT current_setting('SEARCH_PATH')").to_a.inspect
+
+      case ActiveRecord::Base.connection.adapter_name
+      when 'PostgreSQL'
+        schema = 'public'
+      when 'Mysql2'
+        schema = ActiveRecord::Base.connection.current_database
+      when 'SQLite'
+        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')
+        ORDER BY m.name, p.cid"
+      else
+        puts "Unfamiliar with connection adapter #{ActiveRecord::Base.connection.adapter_name}"
+      end
+
+      sql ||= ActiveRecord::Base.send(:sanitize_sql_array, [
         "SELECT t.table_name AS relation_name, t.table_type,
           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
+          tc.constraint_type AS const, kcu.constraint_name AS \"key\"
         FROM INFORMATION_SCHEMA.tables AS t
           LEFT OUTER JOIN INFORMATION_SCHEMA.columns AS c ON t.table_schema = c.table_schema
             AND t.table_name = c.table_name
@@ -258,66 +312,92 @@ module ActiveRecord::ConnectionHandling
             AND kcu.ordinal_position = c.ordinal_position
           LEFT OUTER JOIN INFORMATION_SCHEMA.table_constraints AS tc
             ON kcu.CONSTRAINT_SCHEMA = tc.CONSTRAINT_SCHEMA
+            AND kcu.TABLE_NAME = tc.TABLE_NAME
             AND kcu.CONSTRAINT_NAME = tc.constraint_name
         WHERE t.table_schema = ? -- COALESCE(current_setting('SEARCH_PATH'), 'public')
   --          AND t.table_type IN ('VIEW') -- 'BASE TABLE', 'FOREIGN TABLE'
           AND t.table_name NOT IN ('pg_stat_statements', 'ar_internal_metadata', 'schema_migrations')
         ORDER BY 1, t.table_type DESC, c.ordinal_position", schema
       ])
-      ActiveRecord::Base.connection.execute(sql).each do |r|
-        # next if internal_views.include?(r['relation_name']) # Skip internal views such as v_all_assessments
-
-        relation = relations[r['relation_name']]
-        relation[:index] = r['relation_name'].underscore
-        relation[:show] = relation[:index].singularize
-        relation[:index] = relation[:index].pluralize
-        relation[:isView] = true if r['table_type'] == 'VIEW'
-        col_name = r['column_name']
-        cols = relation[:cols] # relation.fetch(:cols) { relation[:cols] = [] }
-        key = case r['const']
-              when 'PRIMARY KEY'
-                relation[:pkey][r['key']] ||= []
-              when 'UNIQUE'
-                relation[:ukeys][r['key']] ||= []
-                # key = (relation[:ukeys] = Hash.new { |h, k| h[k] = [] }) if key.is_a?(Array)
-                # key[r['key']]
-              end
-        key << col_name if key
-        cols[col_name] = [r['data_type'], r['max_length'], r['measures']&.include?(col_name)]
-        # puts "KEY! #{r['relation_name']}.#{col_name} #{r['key']} #{r['const']}" if r['key']
-      end
 
-      sql = ActiveRecord::Base.send(:sanitize_sql_array, [
-        "SELECT kcu1.TABLE_NAME, kcu1.COLUMN_NAME, kcu2.TABLE_NAME, 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
-            AND kcu1.CONSTRAINT_SCHEMA = rc.CONSTRAINT_SCHEMA
-            AND kcu1.CONSTRAINT_NAME = rc.CONSTRAINT_NAME
-          INNER JOIN INFORMATION_SCHEMA.KEY_COLUMN_USAGE AS kcu2
-            ON kcu2.CONSTRAINT_CATALOG = rc.UNIQUE_CONSTRAINT_CATALOG
-            AND kcu2.CONSTRAINT_SCHEMA = rc.UNIQUE_CONSTRAINT_SCHEMA
-            AND kcu2.CONSTRAINT_NAME = rc.UNIQUE_CONSTRAINT_NAME
-            AND kcu2.ORDINAL_POSITION = kcu1.ORDINAL_POSITION
-        WHERE kcu1.CONSTRAINT_SCHEMA = ? -- COALESCE(current_setting('SEARCH_PATH'), 'public')", schema
-        # AND kcu2.TABLE_NAME = ?;", Apartment::Tenant.current, table_name
-      ])
-      ActiveRecord::Base.connection.execute(sql).values.each { |fk| ::Brick._add_bt_and_hm(fk, relations) }
-
-      # Find associative tables that can be set up for has_many :through
-      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 created_at, updated_at,This table has only foreign keys?
-        if fks.length > 1 && (tbl_cols - fks.keys - ['created_at', 'updated_at', 'deleted_at', 'last_update'] - tbl[:pkey].values.first).length.zero?
-          fks.each { |fk| tbl[:hmt_fks][fk.first] = fk.last }
+      measures = []
+      case ActiveRecord::Base.connection.adapter_name
+      when 'PostgreSQL', 'SQLite' # These bring back a hash for each row because the query uses column aliases
+        ActiveRecord::Base.connection.execute(sql).each do |r|
+          # next if internal_views.include?(r['relation_name']) # Skip internal views such as v_all_assessments
+          relation = relations[(relation_name = r['relation_name'])]
+          relation[:isView] = true if r['table_type'] == 'VIEW'
+          col_name = r['column_name']
+          key = case r['const']
+                when 'PRIMARY KEY'
+                  relation[:pkey][r['key'] || relation_name] ||= []
+                when 'UNIQUE'
+                  relation[:ukeys][r['key'] || "#{relation_name}.#{col_name}"] ||= []
+                  # key = (relation[:ukeys] = Hash.new { |h, k| h[k] = [] }) if key.is_a?(Array)
+                  # key[r['key']]
+                end
+          key << col_name if key
+          cols = relation[:cols] # relation.fetch(:cols) { relation[:cols] = [] }
+          cols[col_name] = [r['data_type'], r['max_length'], measures&.include?(col_name)]
+          # puts "KEY! #{r['relation_name']}.#{col_name} #{r['key']} #{r['const']}" if r['key']
         end
+      else # MySQL2 acts a little differently, bringing back an array for each row
+        ActiveRecord::Base.connection.execute(sql).each do |r|
+          # next if internal_views.include?(r['relation_name']) # Skip internal views such as v_all_assessments
+          relation = relations[(relation_name = r[0])] # here relation represents a table or view from the database
+          relation[:isView] = true if r[1] == 'VIEW' # table_type
+          col_name = r[2]
+          key = case r[5] # constraint type
+                when 'PRIMARY KEY'
+                  # key
+                  relation[:pkey][r[6] || relation_name] ||= []
+                when 'UNIQUE'
+                  relation[:ukeys][r[6] || "#{relation_name}.#{col_name}"] ||= []
+                  # key = (relation[:ukeys] = Hash.new { |h, k| h[k] = [] }) if key.is_a?(Array)
+                  # key[r['key']]
+                end
+          key << col_name if key
+          cols = relation[:cols] # relation.fetch(:cols) { relation[:cols] = [] }
+          # 'data_type', 'max_length'
+          cols[col_name] = [r[3], r[4], measures&.include?(col_name)]
+          # puts "KEY! #{r['relation_name']}.#{col_name} #{r['key']} #{r['const']}" if r['key']
+        end
+      end
+
+      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
+          FROM INFORMATION_SCHEMA.REFERENTIAL_CONSTRAINTS AS rc
+            INNER JOIN INFORMATION_SCHEMA.KEY_COLUMN_USAGE AS kcu1
+              ON kcu1.CONSTRAINT_CATALOG = rc.CONSTRAINT_CATALOG
+              AND kcu1.CONSTRAINT_SCHEMA = rc.CONSTRAINT_SCHEMA
+              AND kcu1.CONSTRAINT_NAME = rc.CONSTRAINT_NAME
+            INNER JOIN INFORMATION_SCHEMA.KEY_COLUMN_USAGE AS kcu2
+              ON kcu2.CONSTRAINT_CATALOG = rc.UNIQUE_CONSTRAINT_CATALOG
+              AND kcu2.CONSTRAINT_SCHEMA = rc.UNIQUE_CONSTRAINT_SCHEMA
+              AND kcu2.CONSTRAINT_NAME = rc.UNIQUE_CONSTRAINT_NAME
+              AND kcu2.ORDINAL_POSITION = kcu1.ORDINAL_POSITION
+          WHERE kcu1.CONSTRAINT_SCHEMA = ? -- COALESCE(current_setting('SEARCH_PATH'), 'public')", schema
+          # AND kcu2.TABLE_NAME = ?;", Apartment::Tenant.current, table_name
+        ])
+      when 'SQLite'
+        sql = "SELECT m.name, fkl.\"from\", fkl.\"table\", m.name || '_' || fkl.\"from\" AS constraint_name
+        FROM sqlite_master m
+          INNER JOIN pragma_foreign_key_list(m.name) fkl ON m.type = 'table'
+        ORDER BY m.name, fkl.seq"
+      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) }
       end
     end
 
-    puts "Classes built from tables:"
+    puts "Classes that can be built from tables:"
     relations.select { |_k, v| !v.key?(:isView) }.keys.each { |k| puts ActiveSupport::Inflector.singularize(k).camelize }
-    puts "Classes built from views:"
+    puts "Classes that can be built from views:"
     relations.select { |_k, v| v.key?(:isView) }.keys.each { |k| puts ActiveSupport::Inflector.singularize(k).camelize }
     # pp relations; nil
 

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

@@ -5,67 +5,219 @@ 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|
-        Brick.enable_models = app.config.brick.fetch(:enable_models, true)
-        Brick.enable_controllers = app.config.brick.fetch(:enable_controllers, true)
+      # 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)
+        ::Brick.enable_routes = app.config.brick.fetch(:enable_routes, true)
+        ::Brick.skip_database_views = app.config.brick.fetch(:skip_database_views, false)
 
-        # ====================================
-        # Dynamically create generic templates
-        # ====================================
-        if (Brick.enable_views = app.config.brick.fetch(:enable_views, true))
-          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))
+        # Specific database tables and views to omit when auto-creating models
+        ::Brick.exclude_tables = app.config.brick.fetch(:exclude_tables, [])
+
+        # Columns to treat as being metadata for purposes of identifying associative tables for has_many :through
+        ::Brick.metadata_columns = app.config.brick.fetch(:metadata_columns, ['created_at', 'updated_at', 'deleted_at'])
+
+        # 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)
+                    instance_variable_set(:@_brick_model, model)
+                  end
+                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
+                  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} }) %>
+</td>\n"
+                  end
+
+                  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 %>
+
+<table id=\"#{table_name}\">
+  <tr>
+  <% is_first = true; is_need_id_col = nil
+     bts = { #{bts.each_with_object([]) { |v, s| s << "#{v.first.inspect} => [#{v.last.first.inspect}, #{v.last.last.name}, #{v.last.last.primary_key.inspect}]"}.join(', ')} }
+     @#{table_name}.columns.map(&:name).each do |col| %>
+    <% next if col == '#{pk}' || ::Brick.config.metadata_columns.include?(col) %>
+    <th>
+    <% if bt = bts[col]
+        if is_first
+          is_first = false
+          is_need_id_col = true %>
+          </th><th>
+        <% end %>
+      BT <%= \"#\{bt.first\}-\" unless bt[1].name.underscore == bt.first.to_s %><%= bt[1].name %>
+    <% else
+        is_first = false %>
+      <%= col %>
+    <% end %>
+    </th>
+  <% end %>
+  <% if is_first # STILL haven't been able to write a first non-key / non-metadata column?
+    is_first = false
+    is_need_id_col = true %>
+    <th></th>
+  <% end %>
+#{hms_headers}
+  </tr>
+
+  <% @#{table_name}.each do |#{obj_name}| %>
+  <tr>
+    <% is_first = true
+       if is_need_id_col
+         is_first = false %>
+      <td><%= link_to \"#\{#{obj_name}.class.name\} ##\{#{obj_name}.id\}\", #{obj_name} %></td>
+    <% end %>
+    <% #{obj_name}.attributes.each do |k, val| %>
+      <% next if k == '#{pk}' || ::Brick.config.metadata_columns.include?(k) %>
+      <td>
+      <% if (bt = bts[k]) %>
+        <%= obj = bt[1].find_by(bt.last => val); link_to obj.brick_descrip, obj %>
+      <% elsif is_first %>
+        <%= is_first = false; link_to val, #{obj_name} %>
+      <% else %>
+        <%= val %>
+      <% end %>
+      </td>
+    <% end %>
+#{hms_columns}
+    <!-- td>X</td -->
+  </tr>
+  <% end %>
+</table>
+
+#{"<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)
                 end
               end
-              is_template_exists
             end
+          end
 
-            alias :_brick_find_template :find_template
-            def find_template(*args, **options)
-              if @_brick_model
-                inline = case args.first
-                when 'index'
-                  # Something like:  <%= @categories.inspect %>
-                  "<%= @#{@_brick_model.name.underscore.pluralize}.inspect %>"
-                when 'show'
-                  "<%= @#{@_brick_model.name.underscore}.inspect %>"
+          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
+                    end
+                  end
                 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)
+                _brick_finalize_routeset!(*args, **options)
               end
             end
           end
-        end
 
-        # Auto-routing behaviour
-        if (::Brick.enable_routes = app.config.brick.fetch(:enable_routes, true))
-          ::Brick.append_routes
-        end
-        # Additional references (virtual foreign keys)
-        if (ars = (::Brick.additional_references = app.config.brick.fetch(:additional_references, nil)))
-          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])
+          # 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
+          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
       end

data/lib/brick/version_number.rb

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

data/lib/brick.rb

@@ -76,20 +76,12 @@ end
 # is first established), and then automatically creates models, controllers, views,
 # and routes based on those available relations.
 require 'brick/config'
-require 'brick/frameworks/rails'
+if Gem::Specification.all_names.any? { |g| g.start_with?('rails-') }
+  require 'rails'
+  require 'brick/frameworks/rails'
+end
 module Brick
   class << self
-    def append_routes
-      ::Rails.application.routes.append do
-        relations = (::Brick.instance_variable_get(:@relations) || {})[ActiveRecord::Base.connection_pool.object_id] || {}
-        relations.each do |k, v|
-          options = {}
-          options[:only] = [:index, :show] if v.key?(:isView)
-          send(:resources, k.underscore.pluralize.to_sym, **options)
-        end
-      end
-    end
-
     # All tables and views (what Postgres calls "relations" including column and foreign key info)
     def relations
       connections = Brick.instance_variable_get(:@relations) ||
@@ -150,6 +142,21 @@ module Brick
       !!Brick.config.enable_routes
     end
 
+    # @api public
+    def skip_database_views=(value)
+      Brick.config.skip_database_views = value
+    end
+
+    # @api public
+    def exclude_tables=(value)
+      Brick.config.exclude_tables = value
+    end
+
+    # @api public
+    def metadata_columns=(value)
+      Brick.config.metadata_columns = value
+    end
+
     # Additional table associations to use (Think of these as virtual foreign keys perhaps)
     # @api public
     def additional_references=(value)
@@ -193,10 +200,7 @@ module Brick
   end
 end
 
-require 'brick/extensions'
 require 'brick/version_number'
-# require 'brick/serializers/json'
-# require 'brick/serializers/yaml'
 
 require 'active_record'
 # Major compatibility fixes for ActiveRecord < 4.2
@@ -422,18 +426,18 @@ ActiveSupport.on_load(:active_record) do
     end
   end
 
-  include ::Brick::Extensions
-
-  unless ::Brick::Extensions::IS_AMOEBA
-    # Add amoeba-compatible support
-    module ActiveRecord
-      class Base
-        def self.amoeba(*args)
-          puts "Amoeba called from #{name} with #{args.inspect}"
-        end
-      end
-    end
-  end
+  # include ::Brick::Extensions
+
+  # unless ::Brick::Extensions::IS_AMOEBA
+  #   # Add amoeba-compatible support
+  #   module ActiveRecord
+  #     class Base
+  #       def self.amoeba(*args)
+  #         puts "Amoeba called from #{name} with #{args.inspect}"
+  #       end
+  #     end
+  #   end
+  # end
 end
 
 # Do this earlier because stuff here gets mixed into JoinDependency::JoinAssociation and AssociationScope
@@ -522,3 +526,5 @@ if ActiveRecord.version < ::Gem::Version.new('5.2')
   end # module ActiveRecord
   # rubocop:enable Style/CommentedKeyword
 end
+
+require 'brick/extensions'

data/lib/generators/brick/install_generator.rb

@@ -1,12 +1,11 @@
 # frozen_string_literal: true
 
 require 'rails/generators'
-require 'rails/generators/active_record'
+# require 'rails/generators/active_record'
 
 module Brick
-  # Auto-generates an IMPORT_TEMPLATE entry for one or more models
   class InstallGenerator < ::Rails::Generators::Base
-    include ::Rails::Generators::Migration
+    # include ::Rails::Generators::Migration
 
     source_root File.expand_path('templates', __dir__)
     class_option(
@@ -16,81 +15,128 @@ module Brick
       desc: 'Store changeset (diff) with each version'
     )
 
-    desc 'Generates (but does not run) a migration to add a versions table.' \
-         '  Also generates an initializer file for configuring Brick'
+    desc 'Generates an initializer file for configuring Brick'
 
-    def create_migration_file
-      add_brick_migration('create_versions')
-      add_brick_migration('add_object_changes_to_versions') if options.with_changes?
-    end
+    def create_initializer_file
+      unless File.exists?(filename = 'config/initializers/brick.rb')
+        create_file filename, "# frozen_string_literal: true
 
-    def self.next_migration_number(dirname)
-      ::ActiveRecord::Generators::Base.next_migration_number(dirname)
-    end
+# # Settings for the Brick gem
+# # (By default this auto-creates models, controllers, views, and routes on-the-fly.)
 
-  protected
+# # Normally these all start out as being enabled, but can be selectively disabled:
+# Brick.enable_routes = false
+# Brick.enable_models = false
+# Brick.enable_controllers = false
+# Brick.enable_views = false
+
+# # By default models are auto-created from database views, and set to be read-only.  This can be skipped.
+# Brick.skip_database_views = true
+
+# # Any tables or views you'd like to skip when auto-creating models
+# Brick.exclude_tables = ['custom_metadata', 'version_info']
 
-    def add_brick_migration(template)
-      migration_dir = File.expand_path('db/migrate')
-      if self.class.migration_exists?(migration_dir, template)
-        ::Kernel.warn "Migration already exists: #{template}"
-      else
-        migration_template(
-          "#{template}.rb.erb",
-          "db/migrate/#{template}.rb",
-          item_type_options: item_type_options,
-          migration_version: migration_version,
-          versions_table_options: versions_table_options
-        )
+# # Additional table references which are used to create has_many / belongs_to associations inside auto-created
+# # models.  (You can consider these to be \"virtual foreign keys\" if you wish)...  You only have to add these
+# # in cases where your database for some reason does not have foreign key constraints defined.  Sometimes for
+# # performance reasons or just out of sheer laziness these might be missing.
+# # Each of these virtual foreign keys is defined as an array having three values:
+# #   foreign table name / foreign key column / primary table name.
+# # (We boldly expect that the primary key identified by ActiveRecord on the primary table will be accurate,
+# # usually this is \"id\" but there are some good smarts that are used in case some other column has been set
+# # to be the primary key.
+# Brick.additional_references = [['orders', 'customer_id', 'customer'],
+#                                ['customer', 'region_id', 'regions']]
+
+# # 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
+# # then this setting resets that list.  For instance, here is the override for the Sakila sample database:
+# Brick.metadata_columns = ['last_updated']
+
+# # If a default route is not supplied, Brick attempts to find the most \"central\" table and wires up the default
+# # route to go to the :index action for what would be a controller for that table.  You can specify any controller
+# # name and action you wish in order to override this and have that be the default route when none other has been
+# # specified in routes.rb or elsewhere.  (Or just use an empty string in order to disable this behaviour.)
+# Brick.default_route_fallback = 'customers' # This defaults to \"customers/index\"
+# Brick.default_route_fallback = 'orders/outstanding' # Example of a non-RESTful route
+# Brick.default_route_fallback = '' # Omits setting a default route in the absence of any other
+"
       end
     end
 
+    # def create_migration_file
+    #   add_brick_migration('create_versions')
+    #   add_brick_migration('add_object_changes_to_versions') if options.with_changes?
+    # end
+
+    # def self.next_migration_number(dirname)
+    #   ::ActiveRecord::Generators::Base.next_migration_number(dirname)
+    # end
+
+  protected
+
+    # def add_brick_migration(template)
+    #   migration_dir = File.expand_path('db/migrate')
+    #   if self.class.migration_exists?(migration_dir, template)
+    #     ::Kernel.warn "Migration already exists: #{template}"
+    #   else
+    #     migration_template(
+    #       "#{template}.rb.erb",
+    #       "db/migrate/#{template}.rb",
+    #       item_type_options: item_type_options,
+    #       migration_version: migration_version,
+    #       versions_table_options: versions_table_options
+    #     )
+    #   end
+    # end
+
   private
 
-    # MySQL 5.6 utf8mb4 limit is 191 chars for keys used in indexes.
-    def item_type_options
-      opt = { null: false }
-      opt[:limit] = 191 if mysql?
-      ", #{opt}"
-    end
+    # # MySQL 5.6 utf8mb4 limit is 191 chars for keys used in indexes.
+    # def item_type_options
+    #   opt = { null: false }
+    #   opt[:limit] = 191 if mysql?
+    #   ", #{opt}"
+    # end
 
-    def migration_version
-      return unless (major = ActiveRecord::VERSION::MAJOR) >= 5
+    # def migration_version
+    #   return unless (major = ActiveRecord::VERSION::MAJOR) >= 5
 
-      "[#{major}.#{ActiveRecord::VERSION::MINOR}]"
-    end
+    #   "[#{major}.#{ActiveRecord::VERSION::MINOR}]"
+    # end
 
-    # Class names of MySQL adapters.
-    # - `MysqlAdapter` - Used by gems: `mysql`, `activerecord-jdbcmysql-adapter`.
-    # - `Mysql2Adapter` - Used by `mysql2` gem.
-    def mysql?
-      [
-        'ActiveRecord::ConnectionAdapters::MysqlAdapter',
-        'ActiveRecord::ConnectionAdapters::Mysql2Adapter'
-      ].freeze.include?(ActiveRecord::Base.connection.class.name)
-    end
+    # # Class names of MySQL adapters.
+    # # - `MysqlAdapter` - Used by gems: `mysql`, `activerecord-jdbcmysql-adapter`.
+    # # - `Mysql2Adapter` - Used by `mysql2` gem.
+    # def mysql?
+    #   [
+    #     'ActiveRecord::ConnectionAdapters::MysqlAdapter',
+    #     'ActiveRecord::ConnectionAdapters::Mysql2Adapter'
+    #   ].freeze.include?(ActiveRecord::Base.connection.class.name)
+    # end
 
-    # Even modern versions of MySQL still use `latin1` as the default character
-    # encoding. Many users are not aware of this, and run into trouble when they
-    # try to use Brick in apps that otherwise tend to use UTF-8. Postgres, by
-    # comparison, uses UTF-8 except in the unusual case where the OS is configured
-    # with a custom locale.
-    #
-    # - https://dev.mysql.com/doc/refman/5.7/en/charset-applications.html
-    # - http://www.postgresql.org/docs/9.4/static/multibyte.html
-    #
-    # Furthermore, MySQL's original implementation of UTF-8 was flawed, and had
-    # to be fixed later by introducing a new charset, `utf8mb4`.
-    #
-    # - https://mathiasbynens.be/notes/mysql-utf8mb4
-    # - https://dev.mysql.com/doc/refman/5.5/en/charset-unicode-utf8mb4.html
-    #
-    def versions_table_options
-      if mysql?
-        ', { options: "ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_general_ci" }'
-      else
-        ''
-      end
-    end
+    # # Even modern versions of MySQL still use `latin1` as the default character
+    # # encoding. Many users are not aware of this, and run into trouble when they
+    # # try to use Brick in apps that otherwise tend to use UTF-8. Postgres, by
+    # # comparison, uses UTF-8 except in the unusual case where the OS is configured
+    # # with a custom locale.
+    # #
+    # # - https://dev.mysql.com/doc/refman/5.7/en/charset-applications.html
+    # # - http://www.postgresql.org/docs/9.4/static/multibyte.html
+    # #
+    # # Furthermore, MySQL's original implementation of UTF-8 was flawed, and had
+    # # to be fixed later by introducing a new charset, `utf8mb4`.
+    # #
+    # # - https://mathiasbynens.be/notes/mysql-utf8mb4
+    # # - https://dev.mysql.com/doc/refman/5.5/en/charset-unicode-utf8mb4.html
+    # #
+    # def versions_table_options
+    #   if mysql?
+    #     ', { options: "ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_general_ci" }'
+    #   else
+    #     ''
+    #   end
+    # end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: brick
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.4
 platform: ruby
 authors:
 - Lorin Thwaits
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-13 00:00:00.000000000 Z
+date: 2022-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -156,6 +156,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.42.0
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement