brick 1.0.58 → 1.0.59

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 508d41fa8b75089e0467ece56ab53fc78b651f3951eabe62d108a62fa8b0f35e
-  data.tar.gz: dcd419560d850fb2014aab3076a6a80f5a555320ac2c2183e3381a916d94dbc8
+  metadata.gz: db41c2288f8bba8f3cb9c5d2d87bacd4806d1f2401ca9709f85de1886b0db377
+  data.tar.gz: 42b0a7b285a3328ce922daa442e15bf994a382ad0bfc5ed8fe4370ae6b779fbb
 SHA512:
-  metadata.gz: 49c90c7fbb1845e151f91b9df7f3b639d587e6239dae5e7f31306807a2b4dc7ac83436d78d46839accfea7c614fd2a94f2460443ea3daae424d280fae17cac77
-  data.tar.gz: 7dd02fd9ab902cfe6359b6be95101ec3a89c47d8b7bc71692ab4537f5ffeb3a24a4ee73063fc10b3d4197ce59fd5c94380f7534f66647d8c03dd512c6ef0c334
+  metadata.gz: b8baacad02f8ba5c0d9bfe11182d8297c817ba46bef250e172f55a0ff949591abcadda790aecc2614515468a4da468415a8a0e62fd2a60232177dcd3cd63ca03
+  data.tar.gz: e84d2573ec0f95b01dfebf681cec409ec66a1e6052abbb59ebd3130728cad71015c51087f484c55e8e30f3b9a3736d3d9262b7d8cdebf23e5ab702035c0dcbfa

data/lib/brick/config.rb

@@ -230,6 +230,11 @@ module Brick
       @mutex.synchronize { @not_nullables = columns }
     end
 
+    # Add status page showing all resources and what files have been built out for them
+    def add_status
+      true
+    end
+
     # Add a special page to show references to non-existent records ("orphans")
     def add_orphans
       true

data/lib/brick/extensions.rb

@@ -646,7 +646,7 @@ Module.class_exec do
                full_class_name << "::#{self.name}" unless self == Object
                full_class_name << "::#{plural_class_name.underscore.singularize.camelize}"
                if (plural_class_name == 'BrickSwagger' ||
-                  (::Brick.config.add_orphans && plural_class_name == 'BrickGem') ||
+                  ((::Brick.config.add_status || ::Brick.config.add_orphans) && plural_class_name == 'BrickGem') ||
                   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)
@@ -667,45 +667,11 @@ Module.class_exec do
              elsif ::Brick.enable_models?
                # Custom inheritable Brick base model?
                class_name = (inheritable_name = class_name)[5..-1] if class_name.start_with?('Brick')
-               # See if a file is there in the same way that ActiveSupport::Dependencies#load_missing_constant
-               # checks for it in ~/.rvm/gems/ruby-2.7.5/gems/activesupport-5.2.6.2/lib/active_support/dependencies.rb
-
-               if (base_model = ::Brick.config.sti_namespace_prefixes&.fetch("::#{base_module.name}::", nil)&.constantize) || # Are we part of an auto-STI namespace? ...
-                  base_module != Object # ... or otherwise already in some namespace?
-                 schema_name = [(singular_schema_name = name.underscore),
-                                (schema_name = singular_schema_name.pluralize),
-                                name,
-                                name.pluralize].find { |s| Brick.db_schemas.include?(s) }
-               end
-               plural_class_name = ActiveSupport::Inflector.pluralize(model_name = class_name)
-               # If it's namespaced then we turn the first part into what would be a schema name
-               singular_table_name = ActiveSupport::Inflector.underscore(model_name).gsub('/', '.')
-
-               if base_model
-                 schema_name = name.underscore # For the auto-STI namespace models
-                 table_name = base_model.table_name
-                 Object.send(:build_model, base_module, inheritable_name, model_name, singular_table_name, table_name, relations, table_name)
-               else
-                 # Adjust for STI if we know of a base model for the requested model name
-                 # %%% Does not yet work with namespaced model names.  Perhaps prefix with plural_class_name when doing the lookups here.
-                 table_name = if (base_model = ::Brick.sti_models[model_name]&.fetch(:base, nil) || ::Brick.existing_stis[model_name]&.constantize)
-                                base_model.table_name
-                              else
-                                ActiveSupport::Inflector.pluralize(singular_table_name)
-                              end
-                 if ::Brick.apartment_multitenant &&
-                    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, inheritable_name, model_name, singular_table_name, table_name, relations, matching)
-                 end
-               end
+               Object.send(:build_model, relations, base_module, name, class_name, inheritable_name)
              end
     if result
       built_class, code = result
-      puts "\n#{code}"
+      puts "\n#{code}\n"
       built_class
     elsif ::Brick.config.sti_namespace_prefixes&.key?("::#{class_name}") && !schema_name
 #         module_prefixes = type_name.split('::')
@@ -727,7 +693,42 @@ class Object
 
   private
 
-    def build_model(schema_name, inheritable_name, model_name, singular_table_name, table_name, relations, matching)
+    def build_model(relations, base_module, base_name, class_name, inheritable_name = nil)
+      if (base_model = ::Brick.config.sti_namespace_prefixes&.fetch("::#{base_module.name}::", nil)&.constantize) || # Are we part of an auto-STI namespace? ...
+         base_module != Object # ... or otherwise already in some namespace?
+        schema_name = [(singular_schema_name = base_name.underscore),
+                       (schema_name = singular_schema_name.pluralize),
+                       base_name,
+                       base_name.pluralize].find { |s| Brick.db_schemas.include?(s) }
+      end
+      plural_class_name = ActiveSupport::Inflector.pluralize(model_name = class_name)
+      # If it's namespaced then we turn the first part into what would be a schema name
+      singular_table_name = ActiveSupport::Inflector.underscore(model_name).gsub('/', '.')
+
+      if base_model
+        schema_name = base_name.underscore # For the auto-STI namespace models
+        table_name = base_model.table_name
+        build_model_worker(base_module, inheritable_name, model_name, singular_table_name, table_name, relations, table_name)
+      else
+        # Adjust for STI if we know of a base model for the requested model name
+        # %%% Does not yet work with namespaced model names.  Perhaps prefix with plural_class_name when doing the lookups here.
+        table_name = if (base_model = ::Brick.sti_models[model_name]&.fetch(:base, nil) || ::Brick.existing_stis[model_name]&.constantize)
+                       base_model.table_name
+                     else
+                       ActiveSupport::Inflector.pluralize(singular_table_name)
+                     end
+        if ::Brick.apartment_multitenant &&
+           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) })
+          build_model_worker(schema_name, inheritable_name, model_name, singular_table_name, table_name, relations, matching)
+        end
+      end
+    end
+
+    def build_model_worker(schema_name, inheritable_name, model_name, singular_table_name, table_name, relations, matching)
       if ::Brick.apartment_multitenant &&
          schema_name == Apartment.default_schema
         relation = relations["#{schema_name}.#{matching}"]
@@ -893,7 +894,7 @@ class Object
             end
           end
         end
-        code << "end # model #{full_name}\n\n"
+        code << "end # model #{full_name}\n"
       [built_model, code]
     end
 
@@ -1002,6 +1003,9 @@ class Object
         # Brick-specific pages
         case plural_class_name
         when 'BrickGem'
+          self.define_method :status do
+            instance_variable_set(:@resources, ::Brick.get_status_of_resources)
+          end
           self.define_method :orphans do
             instance_variable_set(:@orphans, ::Brick.find_orphans(::Brick.set_db_schema(params)))
           end
@@ -1255,7 +1259,7 @@ class Object
             # Get column names for params from relations[model.table_name][:cols].keys
           end
         # end
-        code << "end # #{namespace_name}#{class_name}\n\n"
+        code << "end # #{namespace_name}#{class_name}\n"
       end # class definition
       [built_controller, code]
     end
@@ -1680,6 +1684,59 @@ module Brick
       assoc_bt[:inverse] = assoc_hm
     end
 
+    # Identify built out routes, migrations, models,
+    # (and also soon controllers and views!)
+    # for each resource
+    def get_status_of_resources
+      rails_root = ::Rails.root.to_s
+      migrations = if Dir.exist?(mig_path = ActiveRecord::Migrator.migrations_paths.first || "#{rails_root}/db/migrate")
+                     Dir["#{mig_path}/**/*.rb"].each_with_object(Hash.new { |h, k| h[k] = [] }) do |v, s|
+                       File.read(v).split("\n").each do |line|
+                         # For all non-commented lines, look for any that have "create_table", "alter_table", or "drop_table"
+                         if !line.lstrip.start_with?('#') &&
+                            (idx = (line.index('create_table ') || line.index('create_table('))&.+(13)) ||
+                            (idx = (line.index('alter_table ') || line.index('alter_table('))&.+(12)) ||
+                            (idx = (line.index('drop_table ') || line.index('drop_table('))&.+(11))
+                           tbl = line[idx..-1].match(/([:'"\w\.]+)/)&.captures&.first
+                           if tbl
+                             s[tbl.tr(':\'"', '').pluralize] << v
+                             break
+                           end
+                         end
+                       end
+                     end
+                   end
+      if ::ActiveSupport.version < ::Gem::Version.new('6') ||
+         ::Rails.configuration.instance_variable_get(:@autoloader) == :classic
+        Rails.configuration.eager_load_namespaces.select { |ns| ns < Rails::Application }.each(&:eager_load!)
+      else
+        Zeitwerk::Loader.eager_load_all
+      end
+      abstract_activerecord_bases = ActiveRecord::Base.descendants.select { |ar| ar.abstract_class? }.map(&:name)
+      # abstract_activerecord_bases << ActiveRecord::Base
+      models = if Dir.exist?(model_path = "#{rails_root}/app/models")
+                 Dir["#{model_path}/**/*.rb"].each_with_object({}) do |v, s|
+                   File.read(v).split("\n").each do |line|
+                     # For all non-commented lines, look for any that start with "class " and also "< ApplicationRecord"
+                     if line.lstrip.start_with?('class') && (idx = line.index('class'))
+                       model = line[idx + 5..-1].match(/[\s:]+([\w:]+)/)&.captures&.first
+                       if model && abstract_activerecord_bases.exclude?(model)
+                         klass = begin
+                                   model.constantize
+                                 rescue
+                                 end
+                         s[model.underscore.tr('/', '.').pluralize] = [
+                           v.start_with?(rails_root) ? v[rails_root.length + 1..-1] : v,
+                           klass
+                         ]
+                       end
+                     end
+                   end
+                 end
+               end
+      ::Brick.relations.keys.map { |v| [(r = v.pluralize), (model = models[r])&.last&.table_name || v, migrations&.fetch(r, nil), model&.first] }
+    end
+
     # Locate orphaned records
     def find_orphans(multi_schema)
       is_default_schema = multi_schema&.==(Apartment.default_schema)

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

@@ -56,6 +56,7 @@ module Brick
             # Used by Rails 5.0 and above
             alias :_brick_template_exists? :template_exists?
             def template_exists?(*args, **options)
+              (::Brick.config.add_status && args.first == 'status') ||
               (::Brick.config.add_orphans && args.first == 'orphans') ||
               _brick_template_exists?(*args, **options) ||
               # Do not auto-create a template when it's searching for an application.html.erb, which comes in like:  ["edit", ["games", "application"]]
@@ -96,11 +97,12 @@ module Brick
                        @_brick_model ||
                        (ActionView.version < ::Gem::Version.new('5.0') && args[1].is_a?(Array) ? set_brick_model(args) : nil)
                      )&.name) ||
+                     (is_status = ::Brick.config.add_status && args[0..1] == ['status', ['brick_gem']]) ||
                      (is_orphans = ::Brick.config.add_orphans && args[0..1] == ['orphans', ['brick_gem']])
                 return _brick_find_template(*args, **options)
               end
 
-              unless is_orphans
+              unless is_status || is_orphans
                 pk = @_brick_model._brick_primary_key(::Brick.relations.fetch(model_name, nil))
                 obj_name = model_name.split('::').last.underscore
                 path_obj_name = model_name.underscore.tr('/', '_')
@@ -708,6 +710,53 @@ if (headerTop) {
 
 #{"<hr><%= link_to \"New #{obj_name}\", new_#{path_obj_name}_path %>" unless @_brick_model.is_view?}
 #{script}"
+
+                       when 'status'
+# Status page - list of all resources and 5 things they do or don't have present, and what is turned on and off
+# Must load all models, and then find what table names are represented
+# Easily could be multiple files involved (STI for instance)
++"#{css}
+<p style=\"color: green\"><%= notice %></p>#{"
+<select id=\"schema\">#{schema_options}</select>" if ::Brick.config.schema_behavior[:multitenant] && ::Brick.db_schemas.length > 1}
+<select id=\"tbl\">#{table_options}</select>
+<h1>Status</h1>
+<table id=\"status\"><thead><tr>
+  <th>Resource</th>
+  <th>Table</th>
+  <th>Migration</th>
+  <th>Model</th>
+  <th>Route</th>
+  <th>Controller</th>
+  <th>Views</th>
+</tr></thead>
+<tbody>
+<% # (listing in schema.rb)
+   # Solid colour if file or route entry is present
+  @resources.each do |r|
+  %>
+  <tr>
+  <td><%= link_to(r[0], \"/#\{r[0].tr('.', '/')}\") %></td>
+  <td<%= if r[1]
+           ' class=\"orphan\"' unless ::Brick.relations.key?(r[1])
+         else
+           ' class=\"dimmed\"'
+         end&.html_safe %>><%= # Table
+          r[1] %></td>
+  <td<%= ' class=\"dimmed\"'.html_safe unless r[2] %>><%= # Migration
+          r[2]&.join('<br>')&.html_safe %></td>
+  <td<%= ' class=\"dimmed\"'.html_safe unless r[3] %>><%= # Model
+          r[3] %></td>
+  <td<%= ' class=\"dimmed\"'.html_safe unless r[4] %>><%= # Route
+               %></td>
+  <td<%= ' class=\"dimmed\"'.html_safe unless r[5] %>><%= # Controller
+               %></td>
+  <td<%= ' class=\"dimmed\"'.html_safe unless r[6] %>><%= # Views
+               %></td>
+  <tr>
+<% end %>
+</tbody><table>
+#{script}"
+
                        when 'orphans'
                          if is_orphans
 +"#{css}

data/lib/brick/version_number.rb

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

data/lib/brick.rb

@@ -484,6 +484,9 @@ In config/initializers/brick.rb appropriate entries would look something like:
               send(:resources, controller_name.to_sym, **options)
             end
           end
+          if ::Brick.config.add_status && instance_variable_get(:@set).named_routes.names.exclude?(:brick_status)
+            get('/brick_status', to: 'brick_gem#status', as: 'brick_status')
+          end
           if ::Brick.config.add_orphans && instance_variable_get(:@set).named_routes.names.exclude?(:brick_orphans)
             get('/brick_orphans', to: 'brick_gem#orphans', as: 'brick_orphans')
           end

data/lib/generators/brick/migrations_generator.rb

@@ -85,10 +85,9 @@ module Brick
       # 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|
-        schema = if v.split('.').length > 1
-                   v.first
-                 end
-        s[schema] = nil if schema && [::Brick.default_schema, 'public'].exclude?(schema)
+        if (v_parts = v.split('.')).length > 1
+          s[v_parts.first] = nil unless [::Brick.default_schema, 'public'].include?(v_parts.first)
+        end
       end
       # Start the timestamps back the same number of minutes from now as expected number of migrations to create
       current_mig_time = Time.now - (schemas.length + chosen.length).minutes
@@ -130,7 +129,7 @@ module Brick
                        tbl_parts.first
                      end
                    end
-          unless built_schemas.key?(schema)
+          unless schema.blank? || built_schemas.key?(schema)
             mig = +"  def change\n    create_schema(:#{schema}) unless schema_exists?(:#{schema})\n  end\n"
             migration_file_write(mig_path, "create_db_schema_#{schema}", current_mig_time += 1.minute, ar_version, mig)
             built_schemas[schema] = nil

data/lib/generators/brick/{model_generator.rb → models_generator.rb}

@@ -6,63 +6,71 @@ require 'fancy_gets'
 
 module Brick
   # Auto-generates models, controllers, or views
-  class ModelGenerator < ::Rails::Generators::Base
+  class ModelsGenerator < ::Rails::Generators::Base
     include FancyGets
     # include ::Rails::Generators::Migration
 
-    # # source_root File.expand_path('templates', __dir__)
-    # class_option(
-    #   :with_changes,
-    #   type: :boolean,
-    #   default: false,
-    #   desc: 'Add IMPORT_TEMPLATE to model'
-    # )
-
     desc 'Auto-generates models, controllers, or views.'
 
-    def brick_model
-      # %%% If Apartment is active, ask which schema they want
+    def brick_models
+      # %%% If Apartment is active and there's no schema_to_analyse, ask which schema they want
 
       # Load all models
-      Rails.configuration.eager_load_namespaces.select { |ns| ns < Rails::Application }.each(&:eager_load!)
+      if ::ActiveSupport.version < ::Gem::Version.new('6') ||
+        ::Rails.configuration.instance_variable_get(:@autoloader) == :classic
+        Rails.configuration.eager_load_namespaces.select { |ns| ns < Rails::Application }.each(&:eager_load!)
+      else
+        Zeitwerk::Loader.eager_load_all
+      end
 
       # Generate a list of viable models that can be chosen
       longest_length = 0
       model_info = Hash.new { |h, k| h[k] = {} }
       tableless = Hash.new { |h, k| h[k] = [] }
-      models = ActiveRecord::Base.descendants.reject do |m|
-        trouble = if m.abstract_class?
-                    true
-                  elsif !m.table_exists?
-                    tableless[m.table_name] << m.name
-                    ' (No Table)'
-                  else
-                    this_f_keys = (model_info[m][:f_keys] = m.reflect_on_all_associations.select { |a| a.macro == :belongs_to }) || []
-                    column_names = (model_info[m][:column_names] = m.columns.map(&:name) - [m.primary_key, 'created_at', 'updated_at', 'deleted_at'] - this_f_keys.map(&:foreign_key))
-                    if column_names.empty? && this_f_keys && !this_f_keys.empty?
-                      fk_message = ", although #{this_f_keys.length} foreign keys"
-                      " (No columns#{fk_message})"
-                    end
-                  end
-        # puts "#{m.name}#{trouble}" if trouble&.is_a?(String)
-        trouble
+      existing_models = ActiveRecord::Base.descendants.reject do |m|
+        m.abstract_class? || !m.table_exists? || ::Brick.relations.key?(m.table_name)
       end
+      models = ::Brick.relations.keys.map do |tbl|
+        tbl_parts = tbl.split('.')
+        tbl_parts[-1] = tbl_parts[-1].singularize
+        tbl_parts.join('/').camelize
+      end - existing_models.map(&:name)
       models.sort! do |a, b| # Sort first to separate namespaced stuff from the rest, then alphabetically
-        is_a_namespaced = a.name.include?('::')
-        is_b_namespaced = b.name.include?('::')
+        is_a_namespaced = a.include?('::')
+        is_b_namespaced = b.include?('::')
         if is_a_namespaced && !is_b_namespaced
           1
         elsif !is_a_namespaced && is_b_namespaced
           -1
         else
-          a.name <=> b.name
+          a <=> b
         end
       end
       models.each do |m| # Find longest name in the list for future use to show lists on the right side of the screen
-        if longest_length < (len = m.name.length)
+        if longest_length < (len = m.length)
           longest_length = len
         end
       end
+      chosen = gets_list(list: models, chosen: models.dup)
+      relations = ::Brick.relations
+      chosen.each do |model_name|
+        # If we're in a schema then make sure the module file exists
+        base_module = if (model_parts = model_name.split('::')).length > 1
+                        "::#{model_parts.first}".constantize
+                      else
+                        Object
+                      end
+        _built_model, code = Object.send(:build_model, relations, base_module, base_module.name, model_parts.last)
+        path = ['models']
+        path.concat(model_parts.map(&:underscore))
+        dir = +"#{::Rails.root}/app"
+        path[0..-2].each do |path_part|
+          dir << "/#{path_part}"
+          Dir.mkdir(dir) unless Dir.exists?(dir)
+        end
+        File.open("#{dir}/#{path.last}.rb", 'w') { |f| f.write code }
+      end
+      puts "\n*** Created #{chosen.length} model files under app/models ***"
     end
 
   private

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: brick
 version: !ruby/object:Gem::Version
-  version: 1.0.58
+  version: 1.0.59
 platform: ruby
 authors:
 - Lorin Thwaits
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-12 00:00:00.000000000 Z
+date: 2022-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -239,7 +239,7 @@ files:
 - lib/generators/brick/USAGE
 - lib/generators/brick/install_generator.rb
 - lib/generators/brick/migrations_generator.rb
-- lib/generators/brick/model_generator.rb
+- lib/generators/brick/models_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