brick 1.0.153 → 1.0.155

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc98614593bc4e4931a445801f4f7764c15e6032daf2765f8d78a47f61b7b3a7
-  data.tar.gz: 5b3ae1d718df14101c153b335a66578a5b02771714dedd7ebda1022cadebe482
+  metadata.gz: fceffbcf863eb9c03b64a0cb4420a33ded5eb7f3908b40b263a345ae9bf5c164
+  data.tar.gz: 81f9f96bd1463b8b7e7736ed4716bcf78609bae27485af4de15cb23ae12e27ee
 SHA512:
-  metadata.gz: 15852e3d59a95d5ac8614d98a44a70796c5494610447505abe61dcd02010c3701dc9ba48da951e4639e4fa14694cfee4c7455c2a0bd63fc613738886ca908b26
-  data.tar.gz: bd5cc34b7c004461af1737dbcb4b746889bd7f4da7d5242c3f341793ed4675c33a50bc61108a6f1e24037585298361f8f4f6ac699a25a72c4ec860f1c272e0ba
+  metadata.gz: c41a59ca62c80012166225b0cf80505b81fe57ccdfeb92c4add7f227d6d4a9cc0c664aaf5209c31dabd54c3e471fe140fd3dc75bf1441bbed0fca67e9801ffd9
+  data.tar.gz: 83c874515b230b0b607da32e41366284b15e830ebd7f7022fb318db412fef94a0339495de54c9ab0277425af2635cc8ab235675074cbb50f703082979ebd28b5

data/lib/brick/config.rb

@@ -230,6 +230,14 @@ module Brick
       @mutex.synchronize { @json_columns = cols }
     end
 
+    def sidescroll
+      @mutex.synchronize { @sidescroll ||= {} }
+    end
+
+    def sidescroll=(scroll)
+      @mutex.synchronize { @sidescroll = scroll }
+    end
+
     def model_descrips
       @mutex.synchronize { @model_descrips ||= {} }
     end
@@ -372,6 +380,14 @@ module Brick
       @mutex.synchronize { @always_load_fields = field_set }
     end
 
+    def ignore_migration_fks
+      @mutex.synchronize { @ignore_migration_fks || [] }
+    end
+
+    def ignore_migration_fks=(relations)
+      @mutex.synchronize { @ignore_migration_fks = relations }
+    end
+
     # Add status page showing all resources and what files have been built out for them
     def add_status
       true

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

@@ -864,6 +864,10 @@ tr th {
   color: #fff;
   text-align: left;
 }
+.col-sticky {
+  position: sticky;
+  left: 0;
+}
 #headerTop tr th {
   position: relative;
 }
@@ -902,6 +906,10 @@ tr td.highlight {
   background-color: #B0B0FF;
 }
 
+table tr .col-sticky {
+  background-color: #28B898;
+}
+
 .show-field {
   background-color: #004998;
 }
@@ -916,6 +924,12 @@ table.shadow > tbody > tr {
 table tbody tr:nth-of-type(even) {
   background-color: #f3f3f3;
 }
+table tbody tr:nth-of-type(even) .col-sticky {
+  background-color: #fff;
+}
+table tbody tr:nth-of-type(odd) .col-sticky {
+  background-color: #f3f3f3;
+}
 
 table.shadow > tbody > tr:last-of-type {
   border-bottom: 2px solid #009879;
@@ -1080,18 +1094,30 @@ function setHeaderSizes() {
   // %%% Grab the TRs from headerTop, clear it out, do this stuff, add them back
   headerTop.innerHTML = \"\"; // %%% Would love to not have to clear it out like this every time!  (Currently doing this to support resize events.)
   var isEmpty = headerTop.childElementCount === 0;
+  var numFixed = parseInt(grid.getAttribute(\"x-num-frozen\")) || 0;
+  var fixedColLefts = [0];
+
   // Set up proper sizings of sticky column header
   var node;
   for (var j = 0; j < #{table_name}HtColumns.length; ++j) {
     var row = #{table_name}HtColumns[j];
     var tr = isEmpty ? document.createElement(\"TR\") : headerTop.childNodes[j];
     tr.innerHTML = row.innerHTML.trim();
+    var curLeft = 0.0;
     // Match up widths from the original column headers
     for (var i = 0; i < row.childNodes.length; ++i) {
       node = row.childNodes[i];
       if (node.nodeType === 1) {
         var th = tr.childNodes[i];
         th.style.minWidth = th.style.maxWidth = getComputedStyle(node).width;
+        // Add \"left: __px\" style to the fixed-width column THs
+        if (i <= numFixed) {
+          th.style.position = \"sticky\";
+          th.style.backgroundColor = \"#008061\";
+          th.style.zIndex = \"1\";
+          th.style.left = curLeft + \"px\";
+          fixedColLefts.push(curLeft += node.clientWidth);
+        }
         if (#{pk&.present? ? 'i > 0' : 'true'}) {
           // Add <span> at the end
           var span = document.createElement(\"SPAN\");
@@ -1108,6 +1134,12 @@ function setHeaderSizes() {
     headerCols = tr.childNodes;
     if (isEmpty) headerTop.appendChild(tr);
   }
+  // Add \"left: __px\" style to all fixed-width column TDs
+  [...grid.children[1].children].forEach(function (row) {
+    for (var j = 1; j <= numFixed; ++j) {
+      row.children[j].style.left = fixedColLefts[j] + 'px';
+    }
+  });
   grid.style.marginTop = \"-\" + getComputedStyle(headerTop).height;
   // console.log(\"end\");
 }

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

@@ -24,8 +24,11 @@ module Brick::Rails::FormTags
       end
     end
 
+    nfc = Brick.config.sidescroll.fetch(relation.table_name, nil)&.fetch(:num_frozen_columns, nil) ||
+          Brick.config.sidescroll.fetch(:num_frozen_columns, nil) ||
+          0
     out = "<table id=\"headerTop\"></table>
-<table id=\"#{relation.table_name.split('.').last}\" class=\"shadow\">
+<table id=\"#{relation.table_name.split('.').last}\" class=\"shadow\"#{ " x-num-frozen=\"#{nfc}\"" if nfc.positive? }>
   <thead><tr>"
     pk = (klass = relation.klass).primary_key || []
     pk = [pk] unless pk.is_a?(Array)
@@ -95,12 +98,13 @@ module Brick::Rails::FormTags
     #     (After restarting the server it worked fine again.)
     relation.each do |obj|
       out << "<tr>\n"
-      out << "<td>#{link_to('⇛', send("#{klass._brick_index(:singular)}_path".to_sym,
+      out << "<td class=\"col-sticky\">#{link_to('⇛', send("#{klass._brick_index(:singular)}_path".to_sym,
                                       pk.map { |pk_part| obj.send(pk_part.to_sym) }), { class: 'big-arrow' })}</td>\n" if pk.present?
-      sequence.each do |col_name|
+      sequence.each_with_index do |col_name, idx|
         val = obj.attributes[col_name]
         bt = bts[col_name]
         out << '<td'
+        (classes ||= []) << 'col-sticky' if idx < nfc
         (classes ||= []) << 'dimmed' unless cols.key?(col_name) || (cust_col = cust_cols[col_name]) ||
                                             (col_name.is_a?(Symbol) && bts.key?(col_name)) # HOT
         (classes ||= []) << 'right' if val.is_a?(Numeric) && !bt

data/lib/brick/version_number.rb

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

data/lib/brick.rb

@@ -501,6 +501,11 @@ module Brick
       Brick.config.json_columns = cols
     end
 
+    # @api public
+    def sidescroll=(scroll)
+      Brick.config.sidescroll = scroll
+    end
+
     # DSL templates for individual models to provide prettier descriptions of objects
     # @api public
     def model_descrips=(descrips)
@@ -1159,6 +1164,12 @@ ActiveSupport.on_load(:active_record) do
         mattr_accessor :default_timezone, instance_writer: false
         self.default_timezone = :utc
       end
+
+      unless respond_to?(:primary_abstract_class)
+        def self.primary_abstract_class
+          self.abstract_class = true
+        end
+      end
     end
 
     # Rails < 4.0 cannot do #find_by, #find_or_create_by, or do #pluck on multiple columns, so here are the patches:

data/lib/generators/brick/install_generator.rb

@@ -35,7 +35,7 @@ module Brick
           end
         end
         possible_additional_references = relations.each_with_object(Hash.new { |h, k| h[k] = [] }) do |relation, s|
-          this_tnp = tnps&.keys.find { |tnp| relation.first.start_with?(tnp) }
+          this_tnp = tnps&.keys&.find { |tnp| relation.first.start_with?(tnp) }
           model_filename = "app/models/#{ActiveSupport::Inflector.singularize(relation.first)}.rb"
           relation.last[:cols].each do |col, type|
             col_down = col.downcase
@@ -244,6 +244,14 @@ if ActiveRecord::Base.respond_to?(:brick_select) && !::Brick.initializer_loaded
   # Brick.column_sequence = { 'users' =>   { include: ['email', 'profile.firstname', 'profile.lastname'] },
   #                           'profile' => { exclude: ['birthdate'] } }
 
+  # # When rendering the grid on index pages, a default number of columns to keep as \"sticky\" so that they remain
+  # # at the left of the grid while scrolling.  By default this is 0 extra columns -- only the link to that
+  # # object's show / edit page is sticky.  And this would add one extra column in the mix:
+  # Brick.sidescroll = { num_frozen_columns: 1 }
+  # # As well if you would like to customise this for specific resources, that is possible:
+  # Brick.sidescroll = { num_frozen_columns: 0,
+  #                      'products' => { num_frozen_columns: 2 } }
+
   # # EXTRA FOREIGN KEYS AND OTHER HAS_MANY SETTINGS
 
   # # Additional table references which are used to create has_many / belongs_to associations inside auto-created

data/lib/generators/brick/migrations_generator.rb

@@ -123,21 +123,27 @@ module Brick
       built_schemas = {} # Track all built schemas so we can place an appropriate drop_schema command only in the first
                          # migration in which that schema is referenced, thereby allowing rollbacks to function properly.
       versions_to_create = [] # Resulting versions to be used when updating the schema_migrations table
+      ar_base = Object.const_defined?(:ApplicationRecord) ? ApplicationRecord : Class.new(ActiveRecord::Base)
       # Start by making migrations for fringe tables (those with no foreign keys).
       # Continue layer by layer, creating migrations for tables that reference ones already done, until
       # no more migrations can be created.  (At that point hopefully all tables are accounted for.)
       while (fringe = chosen.reject do |tbl|
+                        snag_fks = []
                         snags = ::Brick.relations.fetch(tbl, nil)&.fetch(:fks, nil)&.select do |_k, v|
                           v[:is_bt] && !v[:polymorphic] &&
                           tbl != v[:inverse_table] && # Ignore self-referencing associations (stuff like "parent_id")
-                          !done.include?(v[:inverse_table])
+                          !done.include?(v[:inverse_table]) &&
+                          ::Brick.config.ignore_migration_fks.exclude?(snag_fk = "#{tbl}.#{v[:fk]}") &&
+                          snag_fks << snag_fk
+                        end
+                        if snags&.present?
+                          # puts snag_fks.inspect
+                          stuck[tbl] = snags
                         end
-                        stuck[tbl] = snags if snags&.present?
                       end).present?
         fringe.each do |tbl|
           next unless (relation = ::Brick.relations.fetch(tbl, nil))&.fetch(:cols, nil)&.present?
 
-          ar_base = Object.const_defined?(:ApplicationRecord) ? ApplicationRecord : Class.new(ActiveRecord::Base)
           pkey_cols = (rpk = relation[:pkey].values.flatten) & (arpk = [ar_base.primary_key].flatten.sort)
           # In case things aren't as standard
           if pkey_cols.empty?
@@ -246,7 +252,8 @@ module Brick
                   suffix << ", index: { name: '#{shorter || idx_name}' }"
                   indexes[shorter || idx_name] = nil
                 end
-                mig << "      t.references :#{fk[:assoc_name]}#{suffix}, foreign_key: { to_table: #{to_table} }\n"
+                primary_key = ::Brick.relations[fk[:inverse_table]][:class_name]&.constantize&.primary_key
+                mig << "      t.references :#{fk[:assoc_name]}#{suffix}, foreign_key: { to_table: #{to_table}#{", primary_key: :#{primary_key}" if primary_key != ar_base.primary_key} }\n"
               end
             else
               next if !id_option&.end_with?('id: false') && pkey_cols&.include?(col)

data/lib/generators/brick/seeds_generator.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+require 'fancy_gets'
+
+module Brick
+  class SeedsGenerator < ::Rails::Generators::Base
+    include FancyGets
+
+    desc 'Auto-generates a seeds file from existing data.'
+
+    def brick_seeds
+      # %%% If Apartment is active and there's no schema_to_analyse, ask which schema they want
+
+      ::Brick.mode = :on
+      ActiveRecord::Base.establish_connection
+
+      if (tables = ::Brick.relations.reject { |k, v| v.key?(:isView) && v[:isView] == true }.map(&:first).sort).empty?
+        puts "No tables found in database #{ActiveRecord::Base.connection.current_database}."
+        return
+      end
+
+      if File.exist?(seed_file_path = "#{::Rails.root}/db/seeds.rb")
+        puts "WARNING: seeds file #{seed_file_path} appears to already be present."
+      end
+
+      # Generate a list of tables that can be chosen
+      chosen = gets_list(list: tables, chosen: tables.dup)
+      schemas = chosen.each_with_object({}) do |v, s|
+        if (v_parts = v.split('.')).length > 1
+          s[v_parts.first] = nil unless [::Brick.default_schema, 'public'].include?(v_parts.first)
+        end
+      end
+      seeds = +"# Seeds file for #{ActiveRecord::Base.connection.current_database}:"
+      done = []
+      fks = {}
+      stuck = {}
+      indexes = {} # Track index names to make sure things are unique
+      ar_base = Object.const_defined?(:ApplicationRecord) ? ApplicationRecord : Class.new(ActiveRecord::Base)
+      # Start by making entries for fringe models (those with no foreign keys).
+      # Continue layer by layer, creating entries for models that reference ones already done, until
+      # no more entries can be created.  (At that point hopefully all models are accounted for.)
+      while (fringe = chosen.reject do |tbl|
+                        snag_fks = []
+                        snags = ::Brick.relations.fetch(tbl, nil)&.fetch(:fks, nil)&.select do |_k, v|
+                          v[:is_bt] && !v[:polymorphic] &&
+                          tbl != v[:inverse_table] && # Ignore self-referencing associations (stuff like "parent_id")
+                          !done.include?(v[:inverse_table]) &&
+                          ::Brick.config.ignore_migration_fks.exclude?(snag_fk = "#{tbl}.#{v[:fk]}") &&
+                          snag_fks << snag_fk
+                        end
+                        if snags&.present?
+                          # puts snag_fks.inspect
+                          stuck[tbl] = snags
+                        end
+                      end).present?
+        seeds << "\n"
+        fringe.each do |tbl|
+          next unless ::Brick.config.exclude_tables.exclude?(tbl) &&
+                      (relation = ::Brick.relations.fetch(tbl, nil))&.fetch(:cols, nil)&.present? &&
+                      (klass = Object.const_get(class_name = relation[:class_name])).table_exists?
+
+          pkey_cols = (rpk = relation[:pkey].values.flatten) & (arpk = [ar_base.primary_key].flatten.sort)
+          # In case things aren't as standard
+          if pkey_cols.empty?
+            pkey_cols = if rpk.empty? # && relation[:cols][arpk.first]&.first == key_type
+                          arpk
+                        elsif rpk.first
+                          rpk
+                        end
+          end
+          schema = if (tbl_parts = tbl.split('.')).length > 1
+                     if tbl_parts.first == (::Brick.default_schema || 'public')
+                       tbl_parts.shift
+                       nil
+                     else
+                       tbl_parts.first
+                     end
+                   end
+
+          # %%% For the moment we're skipping polymorphics
+          fkeys = relation[:fks].values.select { |assoc| assoc[:is_bt] && !assoc[:polymorphic] }
+          # Refer to this table name as a symbol or dotted string as appropriate
+          # tbl_code = tbl_parts.length == 1 ? ":#{tbl_parts.first}" : "'#{tbl}'"
+          seeds << "  # #{class_name}\n"
+
+          is_empty = true
+          klass.order(*pkey_cols).each do |obj|
+            is_empty = false
+            pk_val = obj.send(pkey_cols.first)
+            fk_vals = []
+            data = []
+            relation[:cols].each do |col, col_type|
+              next if !(fk = fkeys.find { |assoc| col == assoc[:fk] }) &&
+                      pkey_cols.include?(col)
+
+              if (val = obj.send(col)) && (val.is_a?(Time) || val.is_a?(Date))
+                val = val.to_s
+              end
+              if fk
+                fk_vals << "#{fk[:assoc_name]}: #{fk[:inverse_table]}_#{val.inspect}" if val
+              else
+                data << "#{col}: #{val.inspect}"
+              end
+            end
+            seeds << "#{tbl}_#{pk_val} = #{class_name}.create(#{(fk_vals + data).join(', ')})\n"
+          end
+          File.open(seed_file_path, "w") { |f| f.write seeds }
+        end
+        done.concat(fringe)
+        chosen -= done
+      end
+      puts "\n*** Created seeds for #{done.length} models in db/seeds.rb ***"
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: brick
 version: !ruby/object:Gem::Version
-  version: 1.0.153
+  version: 1.0.155
 platform: ruby
 authors:
 - Lorin Thwaits
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-24 00:00:00.000000000 Z
+date: 2023-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -257,6 +257,7 @@ files:
 - lib/generators/brick/install_generator.rb
 - lib/generators/brick/migrations_generator.rb
 - lib/generators/brick/models_generator.rb
+- lib/generators/brick/seeds_generator.rb
 - lib/generators/brick/templates/add_object_changes_to_versions.rb.erb
 - lib/generators/brick/templates/create_versions.rb.erb
 homepage: https://github.com/lorint/brick