brick 1.0.32 → 1.0.33

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8483d9a50013e440cce28f648d09d5322985702f952520cb83c69ad0e5742ce4
-  data.tar.gz: 40072d0504f4d2b1cc9a59e62fef305b939dd977da0e794445adf003dbfb8b7e
+  metadata.gz: 7bd78c8878b1ce8e8e58fb4d8463322269d2ac065c5ed12079dcc64360dc30d5
+  data.tar.gz: e6926fdc0ec59ad609be39361dbfe0ccea24c1b08a01ccf0a4ae8eb1aa9e2ba2
 SHA512:
-  metadata.gz: 9740778159acb464652322ef36eff763a55b38c6579fe0a7550a5797db44928ad6832a8bccc0d924a4d4c5a14dc02658e61bf4220cecff08fc348d540b67e41c
-  data.tar.gz: 1b09db07a284512821b604f1d82f64c4be0c11db7f8a8973f36ab3f78b21804a7fec1eb641bcf1ac5c2ec118cb477c8086c124017c66550753ec4f9beddbd413
+  metadata.gz: 5b6ac439519209c3097c2b2651ed66f319b9c04072d2cee7262aad6c4d9907d61b5b45ee1812c1f6cea1e5e1eed2082eb15953e4e3097c9c12b4f35a1f3af703
+  data.tar.gz: 5bb559ada7035abb062b0441578d5406e64f87b9f11fde1d5b3b880179098bafe9507a1a6cdd8e1af1cd1fb4defc1d339e0054896ca0e9c507ea831f24a0cb96

data/lib/brick/extensions.rb

@@ -86,7 +86,11 @@ module ActiveRecord
         descrip_col = (columns.map(&:name) - _brick_get_fks -
                       (::Brick.config.metadata_columns || []) -
                       [primary_key]).first
-        dsl = ::Brick.config.model_descrips[name] = "[#{descrip_col}]" if descrip_col
+        dsl = ::Brick.config.model_descrips[name] = if descrip_col
+                                                      "[#{descrip_col}]"
+                                                    elsif (pk_parts = self.primary_key.is_a?(Array) ? self.primary_key : [self.primary_key])
+                                                      "#{name} ##{pk_parts.map { |pk_part| "[#{pk_part}]" }.join(', ')}"
+                                                    end
       end
       dsl
     end
@@ -129,7 +133,7 @@ module ActiveRecord
         end
       else # With no DSL available, still put this prefix into the JoinArray so we can get primary key (ID) info from this table
         x = prefix.each_with_object(build_array) { |v, s| s[v.to_sym] }
-        x[prefix[-1]] = nil unless prefix.empty? # Using []= will "hydrate" any missing part(s) in our whole series
+        x[prefix.last] = nil unless prefix.empty? # Using []= will "hydrate" any missing part(s) in our whole series
       end
       members
     end
@@ -252,13 +256,12 @@ module ActiveRecord
           names << [piece.right._arel_table_type, (piece.right.table_alias || piece.right.name)]
         else # "Normal" setup, fed from a JoinSource which has an array of JOINs
           # The left side is the "JOIN" table
-          names += _recurse_arel(piece.left)
+          names += _recurse_arel(table = piece.left)
           # The expression on the right side is the "ON" clause
           # on = piece.right.expr
           # # Find the table which is not ourselves, and thus must be the "path" that led us here
           # parent = piece.left == on.left.relation ? on.right.relation : on.left.relation
           # binding.pry if piece.left.is_a?(Arel::Nodes::TableAlias)
-          table = piece.left
           if table.is_a?(Arel::Nodes::TableAlias)
             alias_name = table.right
             table = table.left
@@ -277,7 +280,8 @@ module ActiveRecord
         @_brick_chains = {}
         # The left side is the "FROM" table
         # names += _recurse_arel(piece.left)
-        names << [piece.left._arel_table_type, (piece.left.table_alias || piece.left.name)]
+        names << (this_name = [piece.left._arel_table_type, (piece.left.table_alias || piece.left.name)])
+        (_brick_chains[this_name.first] ||= []) << this_name.last
         # The right side is an array of all JOINs
         piece.right.each { |join| names << _recurse_arel(join) }
       end
@@ -399,6 +403,7 @@ module ActiveRecord
       hm_counts.each do |k, hm|
         associative = nil
         count_column = if hm.options[:through]
+          # binding.pry if associatives[hm.name].nil?
                          fk_col = (associative = associatives[hm.name]).foreign_key
                          hm.foreign_key
                        else
@@ -548,7 +553,7 @@ Module.class_exec do
                full_class_name = +''
                full_class_name << "::#{self.name}" unless self == Object
                full_class_name << "::#{plural_class_name.underscore.singularize.camelize}"
-               if (model = self.const_get(full_class_name))
+               if (plural_class_name == 'BrickSwagger' || model = self.const_get(full_class_name))
                  # if it's a controller and no match or a model doesn't really use the same table name, eager load all models and try to find a model class of the right name.
                  Object.send(:build_controller, self, class_name, plural_class_name, model, relations)
                end
@@ -592,7 +597,10 @@ Module.class_exec do
                               else
                                 ActiveSupport::Inflector.pluralize(singular_table_name)
                               end
-
+                 if ::Brick.config.schema_behavior[:multitenant] && Object.const_defined?('Apartment') &&
+                    Apartment.excluded_models.include?(table_name.singularize.camelize)
+                   schema_name = Apartment.default_schema
+                 end
                  # Maybe, just maybe there's a database table that will satisfy this need
                  if (matching = [table_name, singular_table_name, plural_class_name, model_name].find { |m| relations.key?(schema_name ? "#{schema_name}.#{m}" : m) })
                    Object.send(:build_model, schema_name, model_name, singular_table_name, table_name, relations, matching)
@@ -624,7 +632,10 @@ class Object
   private
 
     def build_model(schema_name, model_name, singular_table_name, table_name, relations, matching)
-      full_name = if schema_name.blank?
+      full_name = if (::Brick.config.schema_behavior[:multitenant] && Object.const_defined?('Apartment') && schema_name == Apartment.default_schema)
+                    relation = relations["#{schema_name}.#{matching}"]
+                    model_name
+                  elsif schema_name.blank?
                     model_name
                   else # Prefix the schema to the table name + prefix the schema namespace to the class name
                     schema_module = if schema_name.instance_of?(Module) # from an auto-STI namespace?
@@ -636,7 +647,7 @@ class Object
                     "#{schema_module&.name}::#{model_name}"
                   end
 
-      return if ((is_view = (relation = relations[matching]).key?(:isView)) && ::Brick.config.skip_database_views) ||
+      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"?
@@ -685,6 +696,9 @@ class Object
             code << "  self.primary_key = #{pk_sym.inspect}\n"
           end
           _brick_primary_key(relation) # Set the newly-found PK in the instance variable
+        elsif (possible_pk = ActiveRecord::Base.get_primary_key(base_class.name)) && relation[:cols][possible_pk]
+          new_model_class.primary_key = (possible_pk = possible_pk.to_sym)
+          code << "  self.primary_key = #{possible_pk.inspect}\n"
         else
           code << "  # Could not identify any column(s) to use as a primary key\n" unless is_view
         end
@@ -725,7 +739,8 @@ class Object
           hmts&.each do |hmt_fk, fks|
             hmt_fk = hmt_fk.tr('.', '_')
             fks.each do |fk|
-              through = fk.first[:assoc_name]
+              # %%% Will not work with custom has_many name
+              through = ::Brick.config.schema_behavior[:multitenant] ? fk.first[:assoc_name] : fk.first[:inverse_table].tr('.', '_').pluralize
               hmt_name = if fks.length > 1
                            if fks[0].first[:inverse][:assoc_name] == fks[1].first[:inverse][:assoc_name] # Same BT names pointing back to us? (Most common scenario)
                              "#{hmt_fk}_through_#{fk.first[:assoc_name]}"
@@ -740,6 +755,7 @@ class Object
               options = { through: through.to_sym }
               if relation[:fks].any? { |k, v| v[:assoc_name] == hmt_name }
                 hmt_name = "#{hmt_name.singularize}_#{fk.first[:assoc_name]}"
+                # binding.pry if relation[:fks].any? { |k, v| v[:assoc_name] == hmt_name }
                 options[:class_name] = fk.first[:inverse_table].singularize.camelize
                 options[:foreign_key] = fk.first[:fk].to_sym
               end
@@ -843,19 +859,70 @@ class Object
     def build_controller(namespace, class_name, plural_class_name, model, relations)
       table_name = ActiveSupport::Inflector.underscore(plural_class_name)
       singular_table_name = ActiveSupport::Inflector.singularize(table_name)
-      pk = model._brick_primary_key(relations.fetch(table_name, nil))
+      pk = model&._brick_primary_key(relations.fetch(table_name, nil))
 
       namespace_name = "#{namespace.name}::" if namespace
       code = +"class #{namespace_name}#{class_name} < ApplicationController\n"
       built_controller = Class.new(ActionController::Base) do |new_controller_class|
         (namespace || Object).const_set(class_name.to_sym, new_controller_class)
 
-        code << "  def index\n"
-        code << "    @#{table_name} = #{model.name}#{pk&.present? ? ".order(#{pk.inspect})" : '.all'}\n"
-        code << "    @#{table_name}.brick_select(params)\n"
-        code << "  end\n"
+        unless (is_swagger = plural_class_name == 'BrickSwagger') # && request.format == :json)
+          code << "  def index\n"
+          code << "    @#{table_name} = #{model.name}#{pk&.present? ? ".order(#{pk.inspect})" : '.all'}\n"
+          code << "    @#{table_name}.brick_select(params)\n"
+          code << "  end\n"
+        end
         self.protect_from_forgery unless: -> { self.request.format.js? }
         self.define_method :index do
+          if is_swagger
+            json = { 'openapi': '3.0.1', 'info': { 'title': 'API V1', 'version': 'v1' },
+                     'servers': [
+                       { 'url': 'https://{defaultHost}', 'variables': { 'defaultHost': { 'default': 'www.example.com' } } }
+                     ]
+                   }
+            json['paths'] = relations.each_with_object({}) do |v, s|
+              # next if v.last[:is_view]
+
+              s["/api/v1/#{v.first}"] = {
+                'get': {
+                  'summary': 'list #{v.first}',
+                  'parameters': v.last[:cols].map { |k, v| { 'name' => k, 'schema': { 'type': v.first } } },
+                  'responses': { '200': { 'description': 'successful' } }
+                }
+              }
+              s["/api/v1/#{v.first}/{id}"] = {
+                'patch': {
+                  'summary': 'update a #{v.first.singularize}',
+                  'parameters': v.last[:cols].reject { |k, v| Brick.config.metadata_columns.include?(k) }.map do |k, v|
+                    { 'name' => k, 'schema': { 'type': v.first } }
+                  end,
+                  'responses': { '200': { 'description': 'successful' } }
+                }
+                # "/api/v1/books/{id}": {
+                #   "parameters": [
+                #     {
+                #       "name": "id",
+                #       "in": "path",
+                #       "description": "id",
+                #       "required": true,
+                #       "schema": {
+                #         "type": "string"
+                #       }
+                #     },
+                #     {
+                #       "name": "Authorization",
+                #       "in": "header",
+                #       "schema": {
+                #         "type": "string"
+                #       }
+                #     }
+                #   ],
+              }
+            end
+            # binding.pry
+            render inline: json.to_json, content_type: request.format
+            return
+          end
           ::Brick.set_db_schema(params)
           if request.format == :csv # Asking for a template?
             require 'csv'
@@ -884,7 +951,7 @@ class Object
           @_brick_join_array = join_array
         end
 
-        if model.primary_key
+        if model&.primary_key
           code << "  def show\n"
           code << (find_by_id = "    id = params[:id]&.split(/[\\/,_]/)
     id = id.first if id.is_a?(Array) && id.length == 1
@@ -899,7 +966,7 @@ class Object
         end
 
         # By default, views get marked as read-only
-        unless false # model.readonly # (relation = relations[model.table_name]).key?(:isView)
+        unless is_swagger # model.readonly # (relation = relations[model.table_name]).key?(:isView)
           code << "  # (Define :new, :create)\n"
 
           if model.primary_key
@@ -958,10 +1025,23 @@ class Object
 
     def _brick_get_hm_assoc_name(relation, hm_assoc)
       if relation[:hm_counts][hm_assoc[:assoc_name]]&.> 1
+        # binding.pry if (same_name = relation[:fks].find { |x| x.last[:assoc_name] == hm_assoc[:assoc_name] && x.last != hm_assoc }) #&&
+                                    # x.last[:alternate_name] == hm_assoc[:alternate_name] })
+        # relation[:fks].any? { |k, v| v[:assoc_name] == new_alt_name }
         plural = ActiveSupport::Inflector.pluralize(hm_assoc[:alternate_name])
-        [hm_assoc[:alternate_name] == name.underscore ? "#{hm_assoc[:assoc_name].singularize}_#{plural}" : plural, true]
+        # binding.pry if hm_assoc[:assoc_name] == 'issue_issue_duplicates'
+        new_alt_name = (hm_assoc[:alternate_name] == name.underscore) ? "#{hm_assoc[:assoc_name].singularize}_#{plural}" : plural
+        # uniq = 1
+        # while same_name = relation[:fks].find { |x| x.last[:assoc_name] == hm_assoc[:assoc_name] && x.last != hm_assoc }
+        #   hm_assoc[:assoc_name] = "#{hm_assoc_name}_#{uniq += 1}"
+        # end
+        # puts new_alt_name
+        # binding.pry if new_alt_name == 'issue_duplicates'
+        # hm_assoc[:assoc_name] = new_alt_name
+        [new_alt_name, true]
       else
         assoc_name = hm_assoc[:inverse_table].pluralize
+        # hm_assoc[:assoc_name] = assoc_name
         [assoc_name, assoc_name.include?('.')]
       end
     end
@@ -989,6 +1069,12 @@ module ActiveRecord::ConnectionHandling
       if File.exist?(brick_initializer = Rails.root.join('config/initializers/brick.rb'))
         initializer_loaded = load brick_initializer
       end
+      # Load the initializer for the Apartment gem a little early so that if .excluded_models and
+      # .default_schema are specified then we can work with non-tenanted models more appropriately
+      if Object.const_defined?('Apartment') && File.exist?(apartment_initializer = Rails.root.join('config/initializers/apartment.rb'))
+        load apartment_initializer
+        apartment_excluded = Apartment.excluded_models
+      end
       # Only for Postgres?  (Doesn't work in sqlite3)
       # puts ActiveRecord::Base.execute_sql("SELECT current_setting('SEARCH_PATH')").to_a.inspect
 
@@ -1065,11 +1151,14 @@ module ActiveRecord::ConnectionHandling
       when 'PostgreSQL', 'SQLite' # These bring back a hash for each row because the query uses column aliases
         # schema ||= 'public' if ActiveRecord::Base.connection.adapter_name == 'PostgreSQL'
         ActiveRecord::Base.execute_sql(sql).each do |r|
-          relation_name = if ![schema, 'public'].include?(r['schema']) && !::Brick.config.schema_behavior[:multitenant]
-                            "#{schema_name = r['schema']}.#{r['relation_name']}"
-                          else
-                            r['relation_name']
-                          end
+          # If Apartment gem lists the table as being associated with a non-tenanted model then use whatever it thinks
+          # is the default schema, usually 'public'.
+          schema_name = if ::Brick.config.schema_behavior[:multitenant]
+                          Apartment.default_schema if apartment_excluded&.include?(r['relation_name'].singularize.camelize)
+                        elsif ![schema, 'public'].include?(r['schema'])
+                          r['schema']
+                        end
+          relation_name = schema_name ? "#{schema_name}.#{r['relation_name']}" : r['relation_name']
           relation = relations[relation_name]
           relation[:isView] = true if r['table_type'] == 'VIEW'
           col_name = r['column_name']
@@ -1154,9 +1243,17 @@ module ActiveRecord::ConnectionHandling
         # ::Brick.default_schema ||= schema ||= 'public' if ActiveRecord::Base.connection.adapter_name == 'PostgreSQL'
         ActiveRecord::Base.execute_sql(sql).each do |fk|
           fk = fk.values unless fk.is_a?(Array)
-          # Multitenancy makes things a little more general overall
-          fk[0] = nil if fk[0] == 'public' || (is_multitenant && fk[0] == schema)
-          fk[3] = nil if fk[3] == 'public' || (is_multitenant && fk[3] == schema)
+          # Multitenancy makes things a little more general overall, except for non-tenanted tables
+          if apartment_excluded&.include?(fk[1].singularize.camelize)
+            fk[0] = Apartment.default_schema
+          elsif fk[0] == 'public' || (is_multitenant && fk[0] == schema)
+            fk[0] = nil
+          end
+          if apartment_excluded&.include?(fk[4].singularize.camelize)
+            fk[3] = Apartment.default_schema
+          elsif fk[3] == 'public' || (is_multitenant && fk[3] == schema)
+            fk[3] = nil
+          end
           ::Brick._add_bt_and_hm(fk, relations)
         end
       end
@@ -1209,16 +1306,30 @@ module Brick
       end
       # %%% Temporary schema patch
       for_tbl = fk[1]
+      fk[0] = Apartment.default_schema if Object.const_defined?('Apartment') && Apartment.excluded_models.include?(for_tbl.singularize.camelize)
       fk[1] = "#{fk[0]}.#{fk[1]}" if fk[0] # && fk[0] != ::Brick.default_schema
       bts = (relation = relations.fetch(fk[1], nil))&.fetch(:fks) { relation[:fks] = {} }
+
       # %%% Do we miss out on has_many :through or even HM based on constantizing this model early?
       # Maybe it's already gotten this info because we got as far as to say there was a unique class
       primary_table = if (is_class = fk[4].is_a?(Hash) && fk[4].key?(:class))
                         pri_tbl = (primary_class = fk[4][:class].constantize).table_name
+                        if (pri_tbl_parts = pri_tbl.split('.')).length > 1
+                          fk[3] = pri_tbl_parts.first
+                        end
                       else
-                        is_schema = fk[3] != ::Brick.default_schema && (::Brick.config.schema_behavior[:multitenant] || fk[3] != 'public')
+                        is_schema = if ::Brick.config.schema_behavior[:multitenant]
+                                      # If Apartment gem lists the primary table as being associated with a non-tenanted model
+                                      # then use 'public' schema for the primary table
+                                      if Object.const_defined?('Apartment') && Apartment.excluded_models.include?(fk[4].singularize.camelize)
+                                        fk[3] = Apartment.default_schema
+                                        true
+                                      end
+                                    else
+                                      fk[3] && fk[3] != ::Brick.default_schema && fk[3] != 'public'
+                                    end
                         pri_tbl = fk[4]
-                        fk[3] && is_schema ? "#{fk[3]}.#{pri_tbl}" : pri_tbl
+                        is_schema ? "#{fk[3]}.#{pri_tbl}" : pri_tbl
                       end
       hms = (relation = relations.fetch(primary_table, nil))&.fetch(:fks) { relation[:fks] = {} } unless is_class
 
@@ -1287,7 +1398,14 @@ module Brick
         assoc_hm[:alternate_name] = "#{assoc_hm[:alternate_name]}_#{bt_assoc_name}" unless assoc_hm[:alternate_name] == bt_assoc_name
         assoc_hm[:inverse] = assoc_bt
       else
-        assoc_hm = hms[hm_cnstr_name] = { is_bt: false, fk: fk[2], assoc_name: for_tbl.pluralize, alternate_name: bt_assoc_name, inverse_table: fk[1], inverse: assoc_bt }
+        inv_tbl = if ::Brick.config.schema_behavior[:multitenant] && Object.const_defined?('Apartment') && fk[0] == Apartment.default_schema
+                    for_tbl
+                  else
+                    fk[1]
+                  end
+                  # binding.pry if inv_tbl == 'issue_issue_duplicates' # inverse_table goofed?
+        assoc_hm = hms[hm_cnstr_name] = { is_bt: false, fk: fk[2], assoc_name: for_tbl.pluralize, alternate_name: bt_assoc_name,
+                                          inverse_table: inv_tbl, inverse: assoc_bt }
         assoc_hm[:polymorphic] = true if is_polymorphic
         hm_counts = relation.fetch(:hm_counts) { relation[:hm_counts] = {} }
         hm_counts[fk[1]] = hm_counts.fetch(fk[1]) { 0 } + 1

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

@@ -407,7 +407,7 @@ function changeout(href, param, value) {
        origin = (key_parts = k.split('.')).length == 1 ? #{model_name} : #{model_name}.reflect_on_association(key_parts.first).klass
       #  binding.pry
        if (destination_fk = Brick.relations[origin.table_name][:fks].values.find { |fk| puts fk.inspect; fk[:fk] == key_parts.last }) &&
-         (obj = (destination = origin.reflect_on_association(destination_fk[:assoc_name])&.klass)&.find(id)) %>
+          (obj = (destination = origin.reflect_on_association(destination_fk[:assoc_name])&.klass)&.find(id)) %>
          <h3>for <%= link_to \"#{"#\{obj.brick_descrip\} (#\{destination.name\})\""}, send(\"#\{destination.name.underscore.tr('/', '_')\}_path\".to_sym, id) %></h3><%
        end
      end %>

data/lib/brick/version_number.rb

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

data/lib/brick.rb

@@ -132,6 +132,7 @@ module Brick
       associatives = hms.each_with_object({}) do |hmt, s|
         if (through = hmt.last.options[:through])
           skip_hms[through] = nil
+          # binding.pry if hmt.first == :issue_issues
           s[hmt.first] = hms[through] # End up with a hash of HMT names pointing to join-table associations
         elsif hmt.last.inverse_of.nil?
           puts "SKIPPING #{hmt.last.name.inspect}"
@@ -409,6 +410,7 @@ In config/initializers/brick.rb appropriate entries would look something like:
         ::Brick.relations.each do |rel_name, v|
           rel_name = rel_name.split('.').map(&:underscore)
           schema_names = rel_name[0..-2]
+          schema_names.shift if ::Brick.config.schema_behavior[:multitenant] && Object.const_defined?('Apartment') && schema_names.first == Apartment.default_schema
           k = rel_name.last
           unless existing_controllers.key?(controller_name = k.pluralize)
             options = {}
@@ -422,6 +424,7 @@ In config/initializers/brick.rb appropriate entries would look something like:
             end
           end
         end
+        send(:get, '/api-docs/v1/swagger.json', { to: 'brick_swagger#index' }) if Object.const_defined?('Rswag::Ui')
       end
       super
     end

data/lib/generators/brick/install_generator.rb

@@ -28,7 +28,7 @@ module Brick
             col_down = col.downcase
 
             if (is_possible_poly = ['character varying', 'text'].include?(type.first))
-              if col_down.end_with?('_type') &&
+              if col_down.end_with?('_type')
                 poly_type_cut_length = -6
                 col_down = col_down[0..-6]
               elsif col_down.end_with?('type')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: brick
 version: !ruby/object:Gem::Version
-  version: 1.0.32
+  version: 1.0.33
 platform: ruby
 authors:
 - Lorin Thwaits
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-08 00:00:00.000000000 Z
+date: 2022-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord