brick 1.0.228 → 1.0.230

data/lib/generators/brick/airtable_api_caller.rb

@@ -0,0 +1,171 @@
+# frozen_string_literal: true
+
+module Brick
+  class AirtableApiCaller
+    class << self
+      include FancyGets
+
+      def pick_tables(usage = :migrations)
+        puts "In order to reference Airtable data you will need a Personal Access Token (PAT) which can be generated by referencing this URL:
+  https://airtable.com/create/tokens
+You need only #{usage == :migrations ? 'this scope:' : "these three scopes:
+  data.records:read
+  data.recordComments:read"}
+  schema.bases:read
+
+Please provide your Airtable PAT:"
+        pat = gets_password
+        require 'net/http'
+        # Generate a list of bases that can be chosen
+        bases = https_get('https://api.airtable.com/v0/meta/bases', pat)
+        base = gets_list(bases.fetch('bases', nil)&.map { |z| AirtableTable.new(z['id'], z['name']) })
+        puts
+        # Generate a list of tables that can be chosen
+        objects = https_get("https://api.airtable.com/v0/meta/bases/#{base.id}/tables", pat).fetch('tables', nil)
+        if objects.blank?
+          puts "No tables found in base #{base.name}."
+          return
+        end
+
+        tables = objects.map { |z| AirtableTable.new(z['id'], z['name'], z['primaryFieldId'], z['fields'], z['views'], base.id) }
+        chosen = gets_list(tables, tables.dup)
+        puts
+
+        # Build out a '::Brick.relations' hash that represents this Airtable schema
+        fks = []
+        associatives = {}
+        relations = chosen.each_with_object({}) do |table, s|
+                      tbl_name = sane_table_name(table.name)
+                      # Build out columns and foreign keys
+                      cols = {}
+                      table.fields.each do |col|
+                        col_name = sane_name(col['name'])
+                        # This is like a has_many or has_many through
+                        if col['type'] == 'multipleRecordLinks'
+                          # binding.pry if col['options']['isReversed']
+                          if (frn_tbl = sane_table_name(
+                                          chosen.find { |t| t.id == col['options']['linkedTableId'] }&.name
+                                        ))
+                            if col['options']['prefersSingleRecordLink'] # 1:M
+                              fks << [frn_tbl, "#{col_name}_id", tbl_name, col_name]
+                            else # N:M
+                              # Queue up to build associative table with two foreign keys
+                              camelized = (assoc_name = "#{tbl_name}_#{col_name}_#{frn_tbl}").camelize
+                              if associatives.keys.any? { |a| a.camelize == camelized }
+                                puts "Strangely have found two columns in \"#{table.name}\" with a name similar to \"#{col_name}\".  Skipping this to avoid a conflict."
+                                next
+
+                              end
+                              associatives[assoc_name] = [col_name, frn_tbl, tbl_name]
+                              fks << [assoc_name, frn_tbl, frn_tbl, col_name.underscore, tbl_name]
+                            end
+                          end
+                        else
+                          # puts col['type']
+                          dt = case col['type']
+                          when 'singleLineText', 'url', 'singleSelect'
+                            'string'
+                          when 'multilineText'
+                            'text'
+                          when 'number'
+                            'decimal'
+                          when 'checkbox'
+                            'boolean'
+                          when 'date'
+                            'date'
+                          when 'multipleSelects'
+                            # Sqlite3 can do json
+                            'json'
+                          when 'formula', 'count', 'rollup', 'multipleAttachments'
+                            next
+                          # else
+                          #   binding.pry
+                          end
+                          cols[col_name] = [dt, nil, true, false] # true is the col[:nillable]
+                        end
+                      end
+                      # Put it all into a relation entry, named the same as the table
+                      pkey = table.fields.find { |f| f['id'] == table.primary_key }['name']
+                      s[tbl_name] = {
+                        pkey: { "#{tbl_name}_pkey" => [sane_name(pkey)] },
+                        cols: cols,
+                        fks: {},
+                        airtable_table: table
+                      }
+                    end
+        associatives.each do |k, v|
+          pri_pk_col = relations[v[1]][:pkey]&.first&.last&.first
+          frn_pk_col = relations[v[2]][:pkey]&.first&.last&.first
+          pri_fk_name = "#{v[1]}_id"
+          frn_fk_name = (frn_fk_name == pri_fk_name) ?
+            "#{v[2]}_2_id" # Self-referencing N:M
+            : "#{v[2]}_id" # Standard N:M
+          relations[k] = {
+            pkey: { "#{k}_pkey" => ['id'] },
+            cols: { 'id' => ['integer', nil, false, false] }
+          }
+          fks << [v[1], pri_fk_name, k, pri_fk_name.underscore]
+          fks << [v[2], frn_fk_name, k, frn_fk_name.underscore]
+        end
+        fk_idx = 0
+        fks.each do |pri_tbl, fk_col, frn_tbl, airtable_col, assoc_tbl|
+          pri_pk_col = relations[pri_tbl][:pkey].first.last.first
+          # binding.pry unless relations.key?(frn_tbl) && relations[pri_tbl][:cols][pri_pk_col]
+          unless assoc_tbl # It's a 1:M -- make a FK column
+            relations[frn_tbl][:cols][fk_col] = [relations[pri_tbl][:cols][pri_pk_col][0], nil, true, false]
+          end
+          # And the actual relation
+          frn_fks = ((relations[frn_tbl] ||= {})[:fks] ||= {})
+          this_fk = frn_fks["fk_airtable_#{fk_idx += 1}"] = {
+            is_bt: !assoc_tbl, # Normal foreign key is true, and N:M is really a has_many, so false
+            fk: fk_col,
+            assoc_name: airtable_col,
+            inverse_table: pri_tbl
+          }
+          this_fk[:assoc_tbl] = assoc_tbl if assoc_tbl
+        end
+
+        relations
+      end
+
+      def https_get(uri, pat = nil)
+        uri = URI(uri) unless uri.is_a?(URI)
+        https = Net::HTTP.new(uri.host, uri.port)
+        request = Net::HTTP::Get.new("#{uri.path}?#{uri.query}")
+        request['Authorization'] = "Bearer #{@bearer ||= pat}"
+        response = Net::HTTP.start(uri.hostname, uri.port, { use_ssl: true }) do |http|
+          http.request(request)
+        end
+        # if response.code&.to_i > 299
+        # end
+        JSON.parse(response.body)
+      end
+
+      def sane_name(col_name)
+        sane_table_name(col_name.gsub('&', 'and').tr('()?', ''))
+      end
+
+      def sane_table_name(tbl_name)
+        tbl_name&.downcase&.tr(': -', '_')
+      end
+
+      class AirtableTable
+        attr_accessor :id, :name, :primary_key, :fields, :views, :base_id, :objects
+        def initialize(id, name,
+                       primary_key = nil, fields = nil, views = nil, base_id = nil)
+          self.id = id
+          self.name = name
+          self.primary_key = primary_key
+          self.fields = fields
+          self.views = views
+          self.base_id = base_id
+          self.objects = {}
+        end
+
+        def to_s
+          name
+        end
+      end
+    end
+  end
+end

data/lib/generators/brick/airtable_migrations_generator.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'brick'
+require 'rails/generators'
+require 'rails/generators/active_record'
+require 'fancy_gets'
+require 'generators/brick/migrations_builder'
+require 'generators/brick/airtable_api_caller'
+
+module Brick
+  # Auto-generates Airtable migration files
+  class AirtableMigrationsGenerator < ::Rails::Generators::Base
+    desc 'Auto-generates migration files for an existing Airtable "base".'
+
+    def airtable_migrations
+      mig_path, is_insert_versions, is_delete_versions = ::Brick::MigrationsBuilder.check_folder
+      return unless mig_path &&
+                    (relations = ::Brick::AirtableApiCaller.pick_tables)
+
+      ::Brick::MigrationsBuilder.generate_migrations(relations.keys, mig_path, is_insert_versions, is_delete_versions, relations,
+                                                     do_fks_last: 'Separate', do_schema_migrations: false)
+    end
+  end
+end

data/lib/generators/brick/airtable_seeds_generator.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'brick'
+require 'rails/generators'
+require 'rails/generators/active_record'
+require 'generators/brick/seeds_builder'
+require 'generators/brick/airtable_api_caller'
+
+module Brick
+  class AirtableSeedsGenerator < ::Rails::Generators::Base
+    desc 'Auto-generates a seeds file from existing data in an Airtable "base".'
+
+    def airtable_seeds
+      return unless (relations = ::Brick::AirtableApiCaller.pick_tables(:seeds))
+
+      ::Brick::SeedsBuilder.generate_seeds(relations)
+    end
+  end
+end

data/lib/generators/brick/install_generator.rb

@@ -346,7 +346,18 @@ if ActiveRecord::Base.respond_to?(:brick_select) && !::Brick.initializer_loaded
   # Brick.model_descrips = { 'User' => '[profile.firstname] [profile.lastname]' }
 
   # # FULL TEXT SEARCH
+  # # You can enable Elasticsearch support by adding the elasticsearch-model and elasticsearch-rails gems, and either
+  # # having a copy of Opensearch or Elasticsearch locally installed on the same machine listening on port 9200, or by
+  # # setting the ELASTICSEARCH_URL environment variable to point to the URI of a search machine.
+  # # With that configured, you can pick specific table names and permissions for search and update by putting them in
+  # # a hash like this:
+  # Brick.elasticsearch_models = { 'notes' => 'crud', 'issues' => 'cru', 'orders' => 'r' }
+  # # or to blanketly enable all models to have auto-updating CRUD behaviour when there are ActiveRecord changes, use:
   # Brick.elasticsearch_models = :all
+  # # As well there is another permission available -- the 'i' permission -- which will auto-create an index if it
+  # # is missing.  If you set 'icrud' for a model it will auto-create an index, or to always do this for all models
+  # # then you can specify \"full control\" like this:
+  # Brick.elasticsearch_models = :full
 
   # # ERD SETTINGS
 
@@ -377,18 +388,19 @@ if ActiveRecord::Base.respond_to?(:brick_select) && !::Brick.initializer_loaded
 
   # # Polymorphic associations are set up by providing a model name and polymorphic association name#{poly}
 
-  # # For multi-tenant databases that use a separate schema for each tenant, a single representative database schema
-  # # can be analysed to determine the range of polymorphic classes that can be used for each association.  Hopefully
-  # # the schema chosen is one loaded with existing data that is representative of all possible polymorphic
-  # # associations.
+  # # MULTITENANCY VIA THE ROS-APARTMENT GEM
+
+  # # If you are using the ros-apartment gem along with Postgres then you can have automatic detection of polymorphic
+  # # type names (model class names listed in a column such as imageable_type) by choosing a schema that is loaded up
+  # # with data that represents the full range of the various polymorphic has_many classes that should be associated.
   # Brick.schema_behavior = :namespaced
 #{Brick.config.schema_behavior.present? ? "  Brick.schema_behavior = { multitenant: { schema_to_analyse: #{
   Brick.config.schema_behavior[:multitenant]&.fetch(:schema_to_analyse, nil).inspect}" :
 "  # Brick.schema_behavior = { multitenant: { schema_to_analyse: 'engineering'"
 } } }
 #{"
-  # # Note that if you have a real polymorphic model configured then it is better to set the list of classes up in the
-  # # model file itself with a line like:
+  # # Note that for each polymorphic model configured then it is better to set the list of classes up in the model
+  # # file itself with a line like:
   # delegated_type :commentable, type: ['Post', 'Comment']" if ActiveRecord::Base.respond_to?(:delegated_type)}
 
   # # DEFAULT ROOT ROUTE

data/lib/generators/brick/{migration_builder.rb → migrations_builder.rb}

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Brick
-  module MigrationBuilder
+  module MigrationsBuilder
     # Many SQL types are the same as their migration data type name:
     #   text, integer, bigint, date, boolean, decimal, float
     # These however are not:
@@ -147,7 +149,7 @@ module Brick
                                         key_type, is_4x_rails, ar_version, do_fks_last, versions_to_create)
             after_fks.concat(add_fks) if do_fks_last
             current_mig_time[0] += 1.minute
-            versions_to_create << migration_file_write(mig_path, "create_#{::Brick._brick_index(tbl, nil, separator)}", current_mig_time, ar_version, mig)
+            versions_to_create << migration_file_write(mig_path, "create_#{::Brick._brick_index(tbl, nil, separator, relations[tbl])}", current_mig_time, ar_version, mig)
           end
           done.concat(fringe)
           chosen -= done
@@ -160,7 +162,9 @@ module Brick
                                         key_type, is_4x_rails, ar_version, do_fks_last, versions_to_create)
             after_fks.concat(add_fks)
             current_mig_time[0] += 1.minute
-            versions_to_create << migration_file_write(mig_path, "create_#{::Brick._brick_index(tbl, :migration, separator)}", current_mig_time, ar_version, mig)
+            versions_to_create << migration_file_write(mig_path, "create_#{
+              ::Brick._brick_index(tbl, :migration, separator, relations[tbl])
+            }", current_mig_time, ar_version, mig)
           end
           done.concat(chosen)
           chosen.clear

data/lib/generators/brick/migrations_generator.rb

@@ -4,12 +4,12 @@ require 'brick'
 require 'rails/generators'
 require 'rails/generators/active_record'
 require 'fancy_gets'
-require 'generators/brick/migration_builder'
+require 'generators/brick/migrations_builder'
 
 module Brick
   # Auto-generates migration files
   class MigrationsGenerator < ::Rails::Generators::Base
-    include ::Brick::MigrationBuilder
+    include ::Brick::MigrationsBuilder
     include FancyGets
 
     desc 'Auto-generates migration files for an existing database.'
@@ -25,13 +25,13 @@ module Brick
         return
       end
 
-      mig_path, is_insert_versions, is_delete_versions = ::Brick::MigrationBuilder.check_folder
+      mig_path, is_insert_versions, is_delete_versions = ::Brick::MigrationsBuilder.check_folder
       return unless mig_path
 
       # Generate a list of tables that can be chosen
       chosen = gets_list(list: tables, chosen: tables.dup)
 
-      ::Brick::MigrationBuilder.generate_migrations(chosen, mig_path, is_insert_versions, is_delete_versions)
+      ::Brick::MigrationsBuilder.generate_migrations(chosen, mig_path, is_insert_versions, is_delete_versions)
     end
   end
 end

data/lib/generators/brick/salesforce_migrations_generator.rb

@@ -3,7 +3,7 @@
 require 'brick'
 require 'rails/generators'
 require 'fancy_gets'
-require 'generators/brick/migration_builder'
+require 'generators/brick/migrations_builder'
 require 'generators/brick/salesforce_schema'
 
 module Brick
@@ -23,7 +23,7 @@ module Brick
       relations = nil
       end_document_proc = lambda do |salesforce_tables|
         # p [:end_document]
-        mig_path, is_insert_versions, is_delete_versions = ::Brick::MigrationBuilder.check_folder
+        mig_path, is_insert_versions, is_delete_versions = ::Brick::MigrationsBuilder.check_folder
         return unless mig_path
 
         # Generate a list of tables that can be chosen
@@ -73,7 +73,7 @@ module Brick
                       }
                     end
         # Build but do not have foreign keys established yet, and do not put version entries info the schema_migrations table
-        ::Brick::MigrationBuilder.generate_migrations(chosen, mig_path, is_insert_versions, is_delete_versions, relations,
+        ::Brick::MigrationsBuilder.generate_migrations(chosen, mig_path, is_insert_versions, is_delete_versions, relations,
                                                       do_fks_last: 'Separate', do_schema_migrations: false)
       end
       parser = Nokogiri::XML::SAX::Parser.new(::Brick::SalesforceSchema.new(end_document_proc))

data/lib/generators/brick/salesforce_schema.rb

@@ -2,7 +2,7 @@
 
 module Brick
   class SalesforceSchema < Nokogiri::XML::SAX::Document
-    include ::Brick::MigrationBuilder
+    include ::Brick::MigrationsBuilder
 
     attr_reader :end_document_proc